f8ac28964d
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
2017-06-28 00:37:47 +03:00
fbd252b77c
docs/{esp,pyb,ubinascii}: Use markup adhering to the latest docs conventions.
2017-06-27 00:38:05 +03:00
7a4694fc4e
docs/library/gc: Fix grammar and improve readability of gc.threshold().
2017-06-26 15:25:51 +10:00
dd16e21562
docs/network: Use markup adhering to the latest docs conventions.
2017-06-26 00:37:30 +03:00
7c0e1f1a08
docs/machine*: Use markup adhering to the latest docs conventions.
2017-06-25 13:30:29 +03:00
cfce7d784e
docs/lcd160cr: Group related constants together. Use full sentences.
...
Per the latest docs conventions.
2017-06-25 13:28:23 +03:00
6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
2017-06-25 00:54:38 +03:00
1e31d4bdf6
docs/lcd160cr: Use markup adhering to the latest conventions.
2017-06-25 00:46:07 +03:00
7f2bc83dbc
docs/btree: Use markup adhering to the latest conventions.
2017-06-25 00:17:18 +03:00
bc790b5145
docs/builtins: List builtin exceptions.
...
If for nothing else, then at least to cross-reference them.
2017-06-24 23:45:38 +03:00
c4e3a03fa5
docs/gc: Document gc.threshold() function.
2017-06-24 13:35:41 +03:00
4cdddfed8e
docs/gc: Mark mem_alloc()/mem_free() as uPy-specific.
2017-06-24 13:12:09 +03:00
94696973a0
docs/select: Rename to uselect, to match the actual module name.
...
Also, add ipoll() documentation and markup changes to comply with CPython
usage.
2017-06-16 11:28:06 +03:00
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
2017-06-15 17:34:51 +10:00
08c73d9734
docs/btree: Typo/wording fixes.
2017-06-11 18:23:13 +03:00
6ca086a89a
docs/btree: Add hints about opening db file and need to flush db.
2017-06-11 17:44:11 +03:00
cd64b3082e
docs/network: First step to describe standard network class interface.
...
This adds description of implied AbstractNIC base class, which should be
"subclasses" and implemented by a particular network device class.
This is just an initial step in that direction, the API and description
will be elabotated further.
2017-06-04 21:25:23 +03:00
f245f5d7cc
docs/machine: Sort machine classes in logical order, not alphabetically.
...
The list starts with the simplest functionality - GPIO, proceeds to
communication interfaces (UART, SPI, I2C), the to time(r) related
things, then everything else.
2017-06-03 14:50:54 +03:00
e91b1cdae3
docs/uos: Move cc3200 port legacy VFS mounting functions to its ref doc.
...
This patch also unconditionalizes uos.dupterm(), though exact interface
and semantics is yet to be defined.
2017-06-03 14:19:53 +03:00
1ce44f3046
docs/uos: Deconditionalize, remove minor port-specific details.
...
For a couple of ports, there was information which directory is set
as current after boot. This information doesn't belong to "uos" module,
and is moved to boards' references (which actually already contained
information on which directory is chosen for boot, even if without
explicit mentioning that it becomes current directory, which is now
done).
2017-06-03 13:51:13 +03:00
92206a78ae
docs/network: Move confusingly-named cc3200 Server class to its reference.
...
cc3200 port has network.Server class to control behavior of builtin
Telnet/FTP server of that port.
2017-06-03 13:34:28 +03:00
d5b8825d5f
docs/machine.Pin: Add on() and off() methods.
2017-05-29 20:56:13 +03:00
3496d9e4bd
docs/machine.Pin: Remove out_value() method.
...
This method isn't implemented in any port. It seemed to have originated
in cc3200 port, but actually never was implemented there either. In
general case, it's impossible to implement this method (for example, for
a perfect GPO, which has only output latch without any feedback look
into a CPU).
2017-05-29 20:51:30 +03:00
ca16c38210
various: Spelling fixes
2017-05-29 11:36:05 +03:00
3ebd67fc09
library/machine.Pin: Remove .id() method and .board class attr.
...
Both aren't part of generic Hardware API: It's impossible to implement
.id() method in a generic case (e.g., when Pin is instantiated by the
underlying OS/RTOS). .board attribute is an obvious space hog which
instead can be implemented on Python level if needed.
2017-05-21 15:50:16 +03:00
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
2017-05-19 15:48:22 +10:00
d007351b33
docs/library/micropython: Document the newer micropython functions.
2017-05-18 00:25:09 +10:00
f351c6db5e
drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.
...
The docs are updated and describe the new behaviour of these methods.
2017-05-17 19:53:13 +10:00
d5713c8618
docs/library/index: Add important summary of the intro section as warning.
...
To make them harder to miss.
2017-05-15 00:26:44 +03:00
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
2017-05-14 23:12:06 +03:00
c19f07bd52
docs/machine.Pin: There's no toggle() method in MicroPython hardware API.
...
May be a port-specific method, not portable, not part of the official
specification.
2017-05-14 22:52:16 +03:00
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
2017-05-10 12:44:21 +10:00
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
2017-04-18 15:40:04 +10:00
850f79e552
docs/library/machine.I2C: Remove WiPy-specific return values.
...
cc3200 has been updated to conform to the API and now returns None.
2017-04-18 15:39:27 +10:00
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
2017-04-18 15:27:37 +10:00
1f1a03d0c3
docs/library/machine.I2C: Deconditionalise all methods.
...
The cc3200 port is now similar enough to the standard machine.I2C API so
that all conditionals can be removed.
2017-04-18 15:04:51 +10:00
fabaa61437
docs/library/machine.UART: Remove pyboard-specific section.
...
stmhal doesn't have a machine.UART class so this section is not needed.
2017-04-18 12:13:51 +10:00
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
2017-04-16 10:14:05 +03:00
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
2017-04-16 10:12:01 +03:00
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
2017-04-16 09:54:55 +03:00
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
2017-04-16 09:41:32 +03:00
a0fb360f1b
docs/library/uos: urandom: Generalize description.
...
Don't give a guarantee of HW RNG, only a possibility of its usage.
2017-04-16 09:22:47 +03:00
ae831ec0a8
docs/library/micropython: Deconditionalize.
2017-04-16 09:18:47 +03:00
b87432b8fb
docs/uhashlib: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
2017-04-09 00:57:54 +03:00
2e58474580
docs/usocket: Deconditionalize.
...
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
2017-04-09 00:48:28 +03:00
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
2017-04-09 00:25:27 +03:00
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
2017-04-09 00:06:54 +03:00
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
2017-04-05 13:05:04 +03:00
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
2017-04-05 12:09:36 +03:00
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
2017-04-05 11:58:17 +03:00
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
2017-04-05 11:47:15 +03:00
906d58f6f2
docs/uos: De-conditionalize statvfs() description.
...
It's a standard function, and it's already described (in the library
intro) that for any given port, any function may be missing.
2017-04-05 11:44:10 +03:00
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
...
These are basic MicroPython API, and all ports should implement them.
2017-04-05 11:40:47 +03:00
468c6f9da1
extmod/modframebuf: Make monochrome bitmap formats start with MONO_.
...
MONO_xxx is much easier to read if you're not familiar with the code.
MVLSB is deprecated but kept for backwards compatibility, for the time
being.
This patch also updates the associated docs and tests.
2017-04-04 17:38:33 +10:00
bb296482c3
docs/library/btree: Add btree module docs.
2017-04-04 00:29:23 +03:00
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
...
Since eaef6b5324
2017-03-20 15:30:41 +11:00
9b80a1e3e9
utime module documentation fixes and cleanup:
...
* Fix mis-spelling of `ticks_add` in code examples.
* Be consistent about parentheses after function names.
* Be consistent about formatting of function, variable and constant names.
* Be consistent about spaces and punctuation.
* Fix some language errors (missing or wrong words, wrong word order).
* Keep line length under 90 chars.
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
2017-03-17 20:45:08 +03:00
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
2017-03-15 21:54:56 +11:00
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
2017-03-07 18:17:40 +11:00
f9d18d96b7
docs/library: Add framebuf documentation.
2017-03-07 18:16:46 +11:00
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
2017-02-28 17:45:24 +11:00
ed81574fe9
docs/machine: Fix formatting of Constants section.
...
Render related constants grouped together, with common description.
2017-02-28 00:38:15 +03:00
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
...
TODO: Remove WiPy-specific chunks.
2017-02-26 00:55:33 +03:00
d80df91ef2
docs/library/lcd160cr: Mention the valid values for set_power() method.
2017-02-17 16:57:22 +11:00
ee3615d800
docs/uos: Remove mention of uos.sep.
...
MicroPython guarantees '/' to be a path separator, so extra constant taking
precious ROM space are not needed. MicroPython never had such constant, only
one vendor port had it (now unmaintained).
2017-02-14 13:14:46 +03:00
0c821f7def
docs/library/machine: Make separate TOC for WiPy vs non-WiPy.
...
WiPy is the only port with ADC and SD, so they shouldn't be included in
other ports' documentation.
2017-02-13 13:06:51 +11:00
2f76c3ca0a
docs/library/pyb.Pin: Minor typo fix, B6 should be A0.
...
On the PYBv1.0, X1 maps to A0, not B6.
2017-02-13 11:52:44 +11:00
27c149efe0
stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.
...
This new function controls what happens on a hard-fault:
- debugging disabled: board will do a reset
- debugging enabled: board will print registers and stack and flash LEDs
The default is disabled, ie to do a reset. This is different to previous
behaviour which flashed the LEDs and waited indefinitely.
2017-02-06 13:22:17 +11:00
d5e9ab6e61
extmod/machine_pulse: Make time_pulse_us() not throw exceptions.
...
machine.time_pulse_us() is intended to provide very fine timing, including
while working with signal bursts, where each transition is tracked in row.
Throwing and handling an exception may take too much time and "signal loss".
So instead, in case of a timeout, just return negative value. Cases of
timeout while waiting for initial signal stabilization, and during actual
timing, are recognized.
The documentation is updated accordingly, and rewritten somewhat to clarify
the function behavior.
2017-02-05 14:20:17 +03:00
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
2017-02-03 12:48:54 +11:00
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
2017-01-29 16:18:33 +03:00
ef6fb66d23
docs/uio: Describe differences between uPy an CPy stream hierarchy.
2017-01-28 16:35:40 +03:00
6947a7f6a9
docs/usocket: Dedent Methods section.
...
This was apparently of an ::only directive which was later removed.
2017-01-28 15:49:54 +03:00
f23c47fea7
docs/usocket: Clarify description of various methods.
2017-01-28 15:39:18 +03:00
74fcb122f0
docs/usocket: Elaborate "Constants" section.
2017-01-28 14:46:58 +03:00
59540dccf1
docs/usocket: Clarify exceptions used.
2017-01-28 13:55:51 +03:00
0aa83142a4
docs/machine: Add explicit note on machine module level and scope.
...
It's very low, hardware level, with associated constraints on operations
and callbacks.
2017-01-28 12:08:25 +03:00
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
2017-01-28 12:08:00 +03:00
c707668d9e
docs/library/lcd160cr: Fix set_brightness range, should be 0..31.
2017-01-24 00:17:39 +11:00
e72e343908
docs: Add documentation for lcd160cr module.
2017-01-23 14:37:10 +11:00
a79f6676c3
docs: Fix some minor spelling mistakes.
...
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
2017-01-18 15:30:31 +11:00
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
2017-01-07 14:23:33 +03:00
36ec5c8f27
docs/library/esp: Remove para and add further warning about flash.
...
There is no longer space reserved by default for native code.
2017-01-06 18:32:49 +11:00
c3f70c603e
docs/library/esp: Document esp.set_native_code_location() function.
2017-01-04 23:48:19 +11:00
d377c83794
docs/library/machine.I2C: Fix I2C constructor docs to match impl.
2016-12-30 15:25:48 +11:00
a5b3c7e7f9
docs/library/pyb.UART: Moved writechar doc to sit with other writes.
2016-12-15 09:59:45 +11:00
0caac94b98
docs/library/pyb.UART: Added clarification about timeouts.
2016-12-15 09:59:32 +11:00
46e59c52af
docs/library/pyb.Accel: Add hardware note about pins used by accel.
2016-12-02 17:39:13 +11:00
63a5df3cb4
docs/library/machine.I2C: Refine definitions of I2C methods.
2016-11-23 17:05:02 +11:00
64db4080ce
docs/library/index: Elaborate on u-modules.
...
Also, remove an "only" directive in u-modules description.
2016-11-16 01:18:19 +03:00
a392b3aa75
docs: Remove references to readall() and update stream read() docs.
2016-11-14 23:31:40 +11:00
c4e58eaa98
stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers.
...
New keyword option in constructor and init() method is "dma=<bool>".
DMA is now disabled by default for I2C transfers because it currently does
not handle I2C bus errors very well (eg if slave device doesn't ACK or
NACK correctly during a transfer).
2016-11-11 17:36:19 +11:00
3e5e4f95b2
docs/library/machine.Pin: Update Pin docs to align with new HW API.
2016-11-09 11:08:01 +11:00
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
8679d9e6a6
docs/utime: Remove only:: for ticks_diff().
...
It's mandatory function which should be present in every port. Even if
it's not, in the stdlib intro we waarn users that a particular port can
lack anything of described in the docs.
2016-11-01 00:03:40 +03:00
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
7219a18d17
docs/library/index: Update TOCs so builtins sorted before modules.
2016-10-30 23:13:52 +03:00
c28f9df63a
docs/library/network: Typo fixes, consistent acronym capitalization.
2016-10-28 12:03:35 +03:00
Paul Sokolovsky
Damien George
Ville Skyttä
Peter Hinch
transistortim
Christopher Arndt
Rami Ali
Dave Hylands
Mike Causer
Lorenz Schmid