94696973a0
docs/select: Rename to uselect, to match the actual module name.
Also, add ipoll() documentation and markup changes to comply with CPython
usage.
8 years ago
fd860dc552
stmhal: Add .value() method to Switch object, to mirror Pin and Signal.
8 years ago
08c73d9734
docs/btree: Typo/wording fixes.
8 years ago
6ca086a89a
docs/btree: Add hints about opening db file and need to flush db.
8 years ago
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.
8 years ago
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.
8 years ago
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.
8 years ago
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).
8 years ago
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.
8 years ago
d5b8825d5f
docs/machine.Pin: Add on() and off() methods.
8 years ago
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).
8 years ago
ca16c38210
various: Spelling fixes
8 years ago
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.
8 years ago
436d97b3f9
docs/library/machine.UART: Update and improve uart.any() docs.
8 years ago
d007351b33
docs/library/micropython: Document the newer micropython functions.
8 years ago
f351c6db5e
drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.
The docs are updated and describe the new behaviour of these methods.
8 years ago
d5713c8618
docs/library/index: Add important summary of the intro section as warning.
To make them harder to miss.
8 years ago
0ba136fbe9
docs/machine.Signal: Add initial draft description of Signal class.
8 years ago
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.
8 years ago
6d221fe284
docs/library/uos: Add description of uos.ilistdir() function.
8 years ago
29b26f3922
docs/library/machine.SPI: Fix formatting of bullet list to stop warning.
8 years ago
850f79e552
docs/library/machine.I2C: Remove WiPy-specific return values.
cc3200 has been updated to conform to the API and now returns None.
8 years ago
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
8 years ago
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.
8 years ago
fabaa61437
docs/library/machine.UART: Remove pyboard-specific section.
stmhal doesn't have a machine.UART class so this section is not needed.
8 years ago
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
8 years ago
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
8 years ago
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
8 years ago
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
8 years ago
a0fb360f1b
docs/library/uos: urandom: Generalize description.
Don't give a guarantee of HW RNG, only a possibility of its usage.
8 years ago
ae831ec0a8
docs/library/micropython: Deconditionalize.
8 years ago
b87432b8fb
docs/uhashlib: Deconditionalize.
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
8 years ago
2e58474580
docs/usocket: Deconditionalize.
Notes on WiPy incompatibilities with the standard socket module API are
moved under "Known issues" to its documentation.
8 years ago
3acace588a
docs/utime: Deconditionalize description of sleep().
8 years ago
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
8 years ago
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
8 years ago
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
8 years ago
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
8 years ago
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
8 years ago
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
8 years ago
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.
8 years ago
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
These are basic MicroPython API, and all ports should implement them.
8 years ago
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.
8 years ago
bb296482c3
docs/library/btree: Add btree module docs.
8 years ago
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
Since eaef6b5324
8 years ago
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>
8 years ago
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
8 years ago
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
8 years ago
f9d18d96b7
docs/library: Add framebuf documentation.
8 years ago
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
8 years ago
Paul Sokolovsky
Damien George
Ville Skyttä
Peter Hinch
transistortim
Christopher Arndt
Rami Ali