Damien George
d4675e7674
docs/library/machine.*: Add cross-reference label to individual classes.
8 years ago
Damien George
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
Damien George
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
Paul Sokolovsky
a78703f188
docs/library/machine: Typo fix in machine_callbacks section.
8 years ago
Paul Sokolovsky
9ef6bb5480
docs/machine: Move machine.main() misnomer to wipy's known issues.
8 years ago
Paul Sokolovsky
a8ece0358f
docs/machine.UART: Deconditionalize normal methods.
8 years ago
Paul Sokolovsky
ac8843ceec
docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.
8 years ago
Paul Sokolovsky
a0fb360f1b
docs/library/uos: urandom: Generalize description.
Don't give a guarantee of HW RNG, only a possibility of its usage.
8 years ago
Paul Sokolovsky
ae831ec0a8
docs/library/micropython: Deconditionalize.
8 years ago
Paul Sokolovsky
b87432b8fb
docs/uhashlib: Deconditionalize.
Notes on WiPy incompatibilities with the standard module API are
moved under "Known issues" to its documentation.
8 years ago
Paul Sokolovsky
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
Paul Sokolovsky
3acace588a
docs/utime: Deconditionalize description of sleep().
8 years ago
Paul Sokolovsky
1d74559b6b
docs/library/machine.UART: Remove some conditionals.
8 years ago
Paul Sokolovsky
bcf3c8bf17
docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.
8 years ago
Paul Sokolovsky
390d5a3bf1
docs/machine.Pin: Move wipy-specific methods to its docs.
8 years ago
Paul Sokolovsky
d46899626e
docs/machine.Pin: Move wipy-specific details to its own docs.
8 years ago
Paul Sokolovsky
9a38b7afe0
cc3200/modmachine: Return frequency value directly, like other ports.
8 years ago
Paul Sokolovsky
4333b2fb53
docs/machine.SPI: Remove outdated wipy chunk.
8 years ago
Paul Sokolovsky
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
Paul Sokolovsky
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
Peter Hinch
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
Paul Sokolovsky
bb296482c3
docs/library/btree: Add btree module docs.
8 years ago
transistortim
fb981107eb
docs/library/machine.I2C: Fix scan() doc to match implementation.
Since eaef6b5324
writes are used instead of
reads.
8 years ago
Christopher Arndt
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
Damien George
fcab435607
docs/library/framebuf: Fix typo in bit-width for MVLSB description.
8 years ago
Rami Ali
2646b9e022
docs/library/lcd160cr: Add link to framebuf page.
8 years ago
Rami Ali
f9d18d96b7
docs/library: Add framebuf documentation.
8 years ago
Peter Hinch
1f549a3496
docs/library/lcd160cr: Add note about supported JPEG format/encodings.
8 years ago
Paul Sokolovsky
ed81574fe9
docs/machine: Fix formatting of Constants section.
Render related constants grouped together, with common description.
8 years ago
Paul Sokolovsky
e2f1a8a7ee
docs/uhashlib: Provide port-neutral description.
TODO: Remove WiPy-specific chunks.
8 years ago
Damien George
d80df91ef2
docs/library/lcd160cr: Mention the valid values for set_power() method.
8 years ago
Paul Sokolovsky
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).
8 years ago
Damien George
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.
8 years ago
Dave Hylands
2f76c3ca0a
docs/library/pyb.Pin: Minor typo fix, B6 should be A0.
On the PYBv1.0, X1 maps to A0, not B6.
8 years ago
Damien George
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.
8 years ago
Paul Sokolovsky
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.
8 years ago
Damien George
50a9dd59f5
docs: For LCD160CR driver and tutorial, add link to positioning image.
8 years ago
Paul Sokolovsky
0ddeedfc73
docs/uio: Typo fixes/lexical improvements.
8 years ago
Paul Sokolovsky
ef6fb66d23
docs/uio: Describe differences between uPy an CPy stream hierarchy.
8 years ago
Paul Sokolovsky
6947a7f6a9
docs/usocket: Dedent Methods section.
This was apparently of an ::only directive which was later removed.
8 years ago
Paul Sokolovsky
f23c47fea7
docs/usocket: Clarify description of various methods.
8 years ago
Paul Sokolovsky
74fcb122f0
docs/usocket: Elaborate "Constants" section.
8 years ago
Paul Sokolovsky
59540dccf1
docs/usocket: Clarify exceptions used.
8 years ago
Paul Sokolovsky
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.
8 years ago
Paul Sokolovsky
56e7ebf07a
docs/machine.Timer: Move WiPy adhoc parts to its documentation.
8 years ago
Damien George
c707668d9e
docs/library/lcd160cr: Fix set_brightness range, should be 0..31.
8 years ago
Damien George
e72e343908
docs: Add documentation for lcd160cr module.
8 years ago
Mike Causer
a79f6676c3
docs: Fix some minor spelling mistakes.
paramter -> parameter
send a receive -> send and receive
repsonse -> response
particualr -> particular
constructore -> constructor
8 years ago
Paul Sokolovsky
a1a8f01799
docs/usocket: Clarify that socket timeout raises OSError exception.
8 years ago
Damien George
36ec5c8f27
docs/library/esp: Remove para and add further warning about flash.
There is no longer space reserved by default for native code.
8 years ago