aboutsummaryrefslogtreecommitdiff
path: root/docs/library/pyb.I2C.rst
AgeCommit message (Collapse)Author
2020-08-21docs: Change `\*` to `*` in argument lists.Zenix27
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and will render the `\` in the output if it is there, so remove it. Fixes issue #6209.
2018-07-18docs/library: Remove "only" directive from all pyb module docs.Damien George
By virtue of its name, the pyb module would only be available on a pyboard and so does not need to have conditional "only" directives throughout its documentation. These conditionals were added mostly in cfcf47c0644952358e1a260db159e807872a37e6 in the initial development of the cc3200 port, which had the pyb module before it switched to the machine module. And wipy only conditionals were removed from the pyb module documentation in 4542643025c77a7272bde348b89d5039aea28d23, so there's no need to retain any more conditionals.
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-08-02docs: Spelling mistakesMike Causer
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.*: Add "currentmodule:: pyb" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "pyb" module in indexes.
2016-03-17docs: Update pyb.I2C constructor to reflect changes in Pyboard Lite.Peter Hinch
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora
2015-09-16docs/wipy: Add pins to the I2C constructor.Daniel Campora
2015-09-16docs: Update I2C and UART docs to match the new API.Daniel Campora
2015-08-09docs: Add i2c keywork arguments only indication.Daniel Campora
2015-08-02cc3200: Make I2C and SPI API the same as in stmhal.Daniel Campora
2015-06-10docs: Add initial draft documentation for the WiPy.Daniel Campora
This makes all common files "port-aware" using the .. only directive.
2014-11-15Document parameter "data" of i2c.mem_read() more clearMatthias
Hi, i would like to add a little clarification to the parameter "data" of i2c.mem_read(): I misunderstood ``data`` can be an integer or a buffer to read into as "i can give a integer variable to read a integer into" . This pull-request adds the following clarification: ``data`` can be an integer (number of bytes to read) or a buffer to read into Thanks for your great work! Best wishes, Matthias
2014-11-04docs: Add links from quickref to pyb classes.Damien George
2014-10-31docs: Cleanup and update some docs.Damien George
2014-10-31docs: Import documentation from source-code inline comments.Damien George
The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.