Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eindiran committed Jun 13, 2024
1 parent bb3227f commit dfe25aa
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,20 @@ shared for backwards compatibility with ``smbus2``.

Currently supported features are:

- Get i2c capabilities (``I2C_FUNCS``)
- Context manager-like control of ``SMBus`` objects
- SMBus Packet Error Checking (PEC) support

- ``enable_pec()``

- 10bit addressing support

- ``enable_tenbit()``

- Manual control over retries and timeouts

- ``set_retries()``
- ``set_timeout()``

- Create raw ``i2c_msg`` messages
- ``read_byte()``
- ``write_byte()``
Expand All @@ -69,6 +79,7 @@ Currently supported features are:
start*
- ``i2c_rd()`` - single read via ``i2c_rdwr``
- ``i2c_wr()`` - single write via ``i2c_rdwr``
- Get i2c capabilities (``I2C_FUNCS``)

It is developed for Python 3.9+.

Expand All @@ -82,7 +93,7 @@ never be supported.

OSes leveraging the Linux kernel are the primary testbed for the
library, but if you try it out on \*BSD and find a bug or problem,
please open an issue.
please `open an issue <https://github.com/eindiran/smbus3/issues>`__.

SMBus code examples
-------------------
Expand Down
5 changes: 5 additions & 0 deletions doc/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Changelog
Notable changes to `smbus3 <https://github.com/eindiran/smbus3>`__ are
recorded here.

[0.5.1] - 2024-06-13
--------------------

- Documentation updates.

[0.5.0] - 2024-06-13
--------------------

Expand Down

0 comments on commit dfe25aa

Please sign in to comment.