aboutsummaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
2017-05-29docs/machine.Pin: Add on() and off() methods.Paul Sokolovsky
2017-05-29docs/machine.Pin: Remove out_value() method.Paul Sokolovsky
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-29various: Spelling fixesVille Skyttä
2017-05-21library/machine.Pin: Remove .id() method and .board class attr.Paul Sokolovsky
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-19docs/library/machine.UART: Update and improve uart.any() docs.Damien George
2017-05-18docs/library/micropython: Document the newer micropython functions.Damien George
2017-05-17drivers/display/lcd160cr: Fix get_line method and enhance screen_dump.Damien George
The docs are updated and describe the new behaviour of these methods.
2017-05-15docs/library/index: Add important summary of the intro section as warning.Paul Sokolovsky
To make them harder to miss.
2017-05-14docs/machine.Signal: Add initial draft description of Signal class.Paul Sokolovsky
2017-05-14docs/machine.Pin: There's no toggle() method in MicroPython hardware API.Paul Sokolovsky
May be a port-specific method, not portable, not part of the official specification.
2017-05-10docs/library/uos: Add description of uos.ilistdir() function.Damien George
2017-04-18docs/library/machine.SPI: Fix formatting of bullet list to stop warning.Damien George
2017-04-18docs/library/machine.I2C: Remove WiPy-specific return values.Damien George
cc3200 has been updated to conform to the API and now returns None.
2017-04-18docs/library/machine.*: Add cross-reference label to individual classes.Damien George
2017-04-18docs/library/machine.I2C: Deconditionalise all methods.Damien George
The cc3200 port is now similar enough to the standard machine.I2C API so that all conditionals can be removed.
2017-04-18docs/library/machine.UART: Remove pyboard-specific section.Damien George
stmhal doesn't have a machine.UART class so this section is not needed.
2017-04-16docs/library/machine: Typo fix in machine_callbacks section.Paul Sokolovsky
2017-04-16docs/machine: Move machine.main() misnomer to wipy's known issues.Paul Sokolovsky
2017-04-16docs/machine.UART: Deconditionalize normal methods.Paul Sokolovsky
2017-04-16docs/library/ussl: Deconditionalize, wipy notes moved to its documentation.Paul Sokolovsky
2017-04-16docs/library/uos: urandom: Generalize description.Paul Sokolovsky
Don't give a guarantee of HW RNG, only a possibility of its usage.
2017-04-16docs/library/micropython: Deconditionalize.Paul Sokolovsky
2017-04-09docs/uhashlib: Deconditionalize.Paul Sokolovsky
Notes on WiPy incompatibilities with the standard module API are moved under "Known issues" to its documentation.
2017-04-09docs/usocket: Deconditionalize.Paul Sokolovsky
Notes on WiPy incompatibilities with the standard socket module API are moved under "Known issues" to its documentation.
2017-04-09docs/utime: Deconditionalize description of sleep().Paul Sokolovsky
2017-04-09docs/library/machine.UART: Remove some conditionals.Paul Sokolovsky
2017-04-09docs/library/builtins: int: Add notice on byteorder param for to/from_bytes.Paul Sokolovsky
2017-04-05docs/machine.Pin: Move wipy-specific methods to its docs.Paul Sokolovsky
2017-04-05docs/machine.Pin: Move wipy-specific details to its own docs.Paul Sokolovsky
2017-04-05cc3200/modmachine: Return frequency value directly, like other ports.Paul Sokolovsky
2017-04-05docs/machine.SPI: Remove outdated wipy chunk.Paul Sokolovsky
2017-04-05docs/uos: De-conditionalize statvfs() description.Paul Sokolovsky
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-05docs/utime: De-conditionalize description of sleep_ms() and friends.Paul Sokolovsky
These are basic MicroPython API, and all ports should implement them.
2017-04-04extmod/modframebuf: Make monochrome bitmap formats start with MONO_.Peter Hinch
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-04docs/library/btree: Add btree module docs.Paul Sokolovsky
2017-03-20docs/library/machine.I2C: Fix scan() doc to match implementation.transistortim
Since eaef6b5324fa2ff425802d4abeea45aa945bfc14 writes are used instead of reads.
2017-03-17utime module documentation fixes and cleanup:Christopher Arndt
* 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-15docs/library/framebuf: Fix typo in bit-width for MVLSB description.Damien George
2017-03-07docs/library/lcd160cr: Add link to framebuf page.Rami Ali
2017-03-07docs/library: Add framebuf documentation.Rami Ali
2017-02-28docs/library/lcd160cr: Add note about supported JPEG format/encodings.Peter Hinch
2017-02-28docs/machine: Fix formatting of Constants section.Paul Sokolovsky
Render related constants grouped together, with common description.
2017-02-26docs/uhashlib: Provide port-neutral description.Paul Sokolovsky
TODO: Remove WiPy-specific chunks.
2017-02-17docs/library/lcd160cr: Mention the valid values for set_power() method.Damien George
2017-02-14docs/uos: Remove mention of uos.sep.Paul Sokolovsky
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-13docs/library/machine: Make separate TOC for WiPy vs non-WiPy.Damien George
WiPy is the only port with ADC and SD, so they shouldn't be included in other ports' documentation.
2017-02-13docs/library/pyb.Pin: Minor typo fix, B6 should be A0.Dave Hylands
On the PYBv1.0, X1 maps to A0, not B6.
2017-02-06stmhal: Add pyb.fault_debug() function, to control hard-fault behaviour.Damien George
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-05extmod/machine_pulse: Make time_pulse_us() not throw exceptions.Paul Sokolovsky
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-03docs: For LCD160CR driver and tutorial, add link to positioning image.Damien George