mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-12 01:24:17 +00:00
Laurens Valk
238204d280
The doc/api is a legacy name, which is confusing in the current use, since all build targets are now APIs. Today we have: doc/common: Common configuration and settings between all targets. doc/main: Main Pybricks documentation at docs.pybricks.com. doc/ide: Documentation shipped with the Pybricks Code IDE.
51 lines
1.6 KiB
ReStructuredText
51 lines
1.6 KiB
ReStructuredText
Generic I2C Device
|
|
^^^^^^^^^^^^^^^^^^
|
|
|
|
.. note::
|
|
|
|
This class is **only supported on the EV3** at this time. It could be added
|
|
to Powered Up hubs in a future release. If you'd like to see this happen, be
|
|
sure to ask us on our `support page`_.
|
|
|
|
.. _support page: https://github.com/pybricks/support/issues/
|
|
|
|
|
|
.. figure:: ../../main/images/sensor_rj12_bluegreen.png
|
|
:width: 25 %
|
|
|
|
.. autoclass:: pybricks.iodevices.I2CDevice
|
|
|
|
**Example: Read and write to an I2C device**
|
|
|
|
.. literalinclude:: ../../../examples/ev3/i2c_basics/main.py
|
|
|
|
.. _i2caddress:
|
|
|
|
I2C Addresses
|
|
---------------
|
|
I2C addresses are 7-bit values. However, most vendors who make LEGO compatible
|
|
sensors provide an 8-bit address in their documentation.
|
|
To use those addresses, you must shift them by 1 bit.
|
|
For example, if the documented address is ``0xD2``, you can do
|
|
``address = 0xD2 >> 1``.
|
|
|
|
Advanced I2C Commands
|
|
---------------------
|
|
Some rudimentary I2C devices do not require a register argument or even any
|
|
data. You can achieve this behavior as shown in the examples below.
|
|
|
|
**Example: Advanced I2C read and write techniques**
|
|
|
|
.. literalinclude:: ../../../examples/ev3/i2c_extra/main.py
|
|
|
|
**Additional technical resources**
|
|
|
|
The ``I2CDevice`` class methods call functions from the Linux SMBus driver.
|
|
To find out which commands are called under the hood, check the
|
|
`Pybricks source code`_.
|
|
More details about using I2C without MicroPython can be found on
|
|
the `ev3dev I2C`_ page.
|
|
|
|
.. _ev3dev I2C: http://docs.ev3dev.org/projects/lego-linux-drivers/en/ev3dev-stretch/i2c.html
|
|
.. _Pybricks source code: https://github.com/pybricks/pybricks-micropython
|