summaryrefslogtreecommitdiff
path: root/docs/library
AgeCommit message (Collapse)Author
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
2016-10-07docs/uos: Add uos.statvfs() documentation.Alex March
2016-10-04stmhal/usb: Add support to receive USB HID messages from host.Philip Potter
2016-09-28extmod/machine_i2c: Add support for the addrsize parameter in mem xfers.Radomir Dopieralski
The memory read/write I2C functions now take an optional keyword-only parameter that specifies the number of bits in the memory address. Only mem-addrs that are a multiple of 8-bits are supported (otherwise the behaviour is undefined). Due to the integer type used for the address, for values larger than 32 bits, only 32 bits of address will be sent, and the rest will be padded with 0s. Right now no exception is raised when that happens. For values smaller than 8, no address is sent. Also no exception then. Tested with a VL6180 sensor, which has 16-bit register addresses. Due to code refactoring, this patch reduces stmhal and esp8266 builds by about 50 bytes.
2016-09-23docs/library/machine: Update description of disable/enable IRQ funcs.Damien George
2016-09-18docs/library/pyb.SPI: init(): Describe "bits" argument.Paul Sokolovsky
Based on https://github.com/micropython/micropython/pull/2210 .
2016-09-08stmhal,cc3200,esp8266: Consistently use PWRON_RESET constant.Damien George
machine.POWER_ON is renamed to machine.PWRON_RESET to match other reset-cause constants that all end in _RESET. The cc3200 port keeps a legacy definition of POWER_ON for backwards compatibility.
2016-09-06docs/library/machine.WDT: Add that WDT is available on pyboard.Damien George
2016-08-29docs/library: Add reference for pyb.usb_mode and pyb.USB_HID.Philip Potter
2016-08-17docs/library/machine.WDT: Add note that WDT is only available on WiPy.Damien George
2016-08-09docs/uio: Mention seek()/flush() support for io.BytesIO.Paul Sokolovsky
2016-08-07docs/library/index: Include array module in ToC.Paul Sokolovsky
2016-08-07docs/array: Document array module.Paul Sokolovsky
2016-08-02docs: Spelling mistakesMike Causer
2016-06-26docs/library: Fix typo in docs for usocket.listen().Martin Müller
2016-06-18docs/sys: print_exception: Fixes/clarifications.Paul Sokolovsky
2016-06-18docs/select: Add an article.Paul Sokolovsky
2016-06-10docs/sys: Detailed description of print_exception() diff from traceback module.Paul Sokolovsky
2016-06-09docs/uctypes: Improve documentation.Paul Sokolovsky
Seealso and Limitations sectiosn added, better formatting and grammar.
2016-06-09docs/machine*: Remove explicit targets and "machine." prefixes on classes.Paul Sokolovsky
With currentmodule:: set properly, none are needed. Extra "machine." prefix produces wrong indexing data.
2016-06-09docs/machine.Pin: Disambiguate object call method.Paul Sokolovsky
2016-06-09docs/library/index: Add builtins.rst.Paul Sokolovsky
2016-06-09docs/builtins: Enumerate all builtin functions implemented.Paul Sokolovsky
Based on unix version. No descriptions so far.
2016-06-08docs/pyb.Pin: Sort .af() and .af_list() methods together.Paul Sokolovsky
2016-06-08docs/pyb.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/pyb.ExtInt,pyb.Pin: Mark up class methods as such.Paul Sokolovsky
2016-06-08docs/pyb.Pin: af_list() is a normal method, not a class method.Paul Sokolovsky
2016-06-08docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.Paul Sokolovsky
2016-06-08docs/machine.Pin: Add class designator to all constants.Paul Sokolovsky
This makes rendered docs to not provide incorrect information and consistent with how it's down for other machine classes.
2016-06-08docs/machine.*: Use proper class case in method headers.Paul Sokolovsky
Class designator will be used as is in indexes, so must match actual class name.
2016-06-08docs/machine.UART: Cleanup pyboard section.Paul Sokolovsky