aboutsummaryrefslogtreecommitdiff
path: root/docs/library/machine.I2C.rst
AgeCommit message (Collapse)Author
2020-10-01docs: Update I2C and SPI docs to add reference to SoftI2C and SoftSPI.Damien George
Signed-off-by: Damien George <damien@micropython.org>
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.
2020-01-06docs/library/machine.I2C.rst: Use positional-only arguments syntax.Jason Neal
Addresses issue #5196.
2019-05-20docs/machine.I2C: Add writevto method to write a vector of byte bufs.Damien George
This allows to efficiently send to an I2C slave data that is made up of more than one buffer. Instead of needing to allocate temporary memory to combine buffers together this new method allows to pass in a tuple or list of buffers. The name is based on the POSIX function writev() which has similar intentions and signature. The reasons for taking this approach (compared to having an interface with separate start/write/stop methods) are: - It's a backwards compatible extension. - It's convenient for the user. - It's efficient because there is only one Python call, then the C code can do everything in one go. - It's efficient on the I2C bus because the implementation can do everything in one go without pauses between blocks of bytes. - It should be possible to implement this extension in all ports, for hardware and software I2C. Further discussion is found in issue #3482, PR #4020 and PR #4763.
2018-08-04docs/library/machine.I2C.rst: Clarify availability of primitive I2C ops.Peter Hinch
2017-06-25docs/machine*: Use markup adhering to the latest docs conventions.Paul Sokolovsky
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-03-20docs/library/machine.I2C: Fix scan() doc to match implementation.transistortim
Since eaef6b5324fa2ff425802d4abeea45aa945bfc14 writes are used instead of reads.
2016-12-30docs/library/machine.I2C: Fix I2C constructor docs to match impl.Damien George
2016-11-23docs/library/machine.I2C: Refine definitions of I2C methods.Damien George
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-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-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.*: Add "currentmodule:: machine" directive.Paul Sokolovsky
Makes sure that classes described in these separate files are properly designated as belonging to "machine" module in indexes.
2016-05-02docs/library/machine.I2C: Update to reflect ESP8266 implementation.Damien George
This machine.I2C documentation is now closer to a more port-neutral description, although there are still differences between WiPy and ESP8266.
2016-05-02stmhal, cc3200: Change i2c.scan() method to scan addresses 0x08-0x77.Damien George
A standard I2C address is 7 bits but addresses 0b0000xxx and 0b1111xxx are reserved. The scan() method is changed to reflect this, along with the docs.
2015-10-17docs: Update all WiPy docs to reflect the new API.danicampora