aboutsummaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
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
2017-01-29docs/uio: Typo fixes/lexical improvements.Paul Sokolovsky
2017-01-28docs/uio: Describe differences between uPy an CPy stream hierarchy.Paul Sokolovsky
2017-01-28docs/usocket: Dedent Methods section.Paul Sokolovsky
This was apparently of an ::only directive which was later removed.
2017-01-28docs/usocket: Clarify description of various methods.Paul Sokolovsky
2017-01-28docs/usocket: Elaborate "Constants" section.Paul Sokolovsky
2017-01-28docs/usocket: Clarify exceptions used.Paul Sokolovsky
2017-01-28docs/machine: Add explicit note on machine module level and scope.Paul Sokolovsky
It's very low, hardware level, with associated constraints on operations and callbacks.
2017-01-28docs/machine.Timer: Move WiPy adhoc parts to its documentation.Paul Sokolovsky
2017-01-24docs/library/lcd160cr: Fix set_brightness range, should be 0..31.Damien George
2017-01-23docs: Add documentation for lcd160cr module.Damien George
2017-01-18docs: Fix some minor spelling mistakes.Mike Causer
paramter -> parameter send a receive -> send and receive repsonse -> response particualr -> particular constructore -> constructor
2017-01-07docs/usocket: Clarify that socket timeout raises OSError exception.Paul Sokolovsky
2017-01-06docs/library/esp: Remove para and add further warning about flash.Damien George
There is no longer space reserved by default for native code.
2017-01-04docs/library/esp: Document esp.set_native_code_location() function.Damien George
2016-12-30docs/library/machine.I2C: Fix I2C constructor docs to match impl.Damien George
2016-12-15docs/library/pyb.UART: Moved writechar doc to sit with other writes.Lorenz Schmid
2016-12-15docs/library/pyb.UART: Added clarification about timeouts.Lorenz Schmid
2016-12-02docs/library/pyb.Accel: Add hardware note about pins used by accel.Peter Hinch
2016-11-23docs/library/machine.I2C: Refine definitions of I2C methods.Damien George
2016-11-16docs/library/index: Elaborate on u-modules.Paul Sokolovsky
Also, remove an "only" directive in u-modules description.
2016-11-14docs: Remove references to readall() and update stream read() docs.Damien George
2016-11-11stmhal/i2c: Add option to I2C to enable/disable use of DMA transfers.Damien George
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-09docs/library/machine.Pin: Update Pin docs to align with new HW API.Damien George
2016-11-01docs/utime: Add docs for ticks_add(), improvements for other ticks_*().Paul Sokolovsky
2016-11-01docs/utime: Remove only:: for ticks_diff().Paul Sokolovsky
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-10-31docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).Paul Sokolovsky
2016-10-30docs/utime: Document ticks_cpu() in more detail.Paul Sokolovsky
Also, drop ::only directive.
2016-10-30docs/library/index: Update TOCs so builtins sorted before modules.Paul Sokolovsky
2016-10-28docs/library/network: Typo fixes, consistent acronym capitalization.Paul Sokolovsky
2016-10-28docs/library/network: Reword intro paragraph.Paul Sokolovsky
2016-10-25docs/machine.SPI.rst: Fix typos and formatting, clarify.Paul Sokolovsky
Clarify the class implements master side of the protocol, also put adhoc WiPy paramter after the generic, described in the current Hardware API version.
2016-10-25docs/library/builtins: Add docs for delattr and slice.Damien George
2016-10-24docs/library/machine.SPI: Remove spurious "of".Damien George
2016-10-18docs/machine.SPI: Improve descriptions of xfer methods.Damien George
In particular remove the "*" because not all ports support keyword arguments.
2016-10-17docs/machine.SPI: Bring up to date with Hardware API, make vendor-neutral.Paul Sokolovsky