Fix docs and attribution

Author: tyeth

README.md

@@ -5,6 +5,11 @@ sensor drivers. For details, please read the package description in
 [README.rst](README.rst).
 
 
+## Attribution ** FORK **
+
+This library is a fork of the official python library from Sensirion, to 
+add support for CircuitPython on embedded devices and linux SBCs.
+
 ## Usage
 
 See package description in [README.rst](README.rst) and user manual at

README.rst

@@ -19,3 +19,10 @@ Installation and Usage
 ----------------------
 
 The user manual is available at https://sensirion.github.io/python-i2c-driver/.
+
+
+Attribution
+-----------
+
+This library is a fork of the official python library from Sensirion, to 
+add support for CircuitPython on embedded devices and linux SBCs.

docs/index.rst

@@ -5,6 +5,11 @@ This package contains the base driver for Sensirion I²C devices. It provides
 a hardware-independent interface to allow writing device drivers which work
 with various I²C transceivers.
 
+Attribution
+-----------
+
+This library is a fork of the official python library from Sensirion, to 
+add support for CircuitPython on embedded devices and linux SBCs.
 
 Contents
 --------

docs/logging_debugging.rst

@@ -2,7 +2,10 @@ Logging / Debugging
 ===================
 
 Every module of this package uses the `Python Logging Facility`_ to log debug
-messages, warnings etc. This page gives a quick overview how it works.
+messages, warnings etc when run on a Single Board Computer (SBC).
+It uses the `adafruit_logging` library for CircuitPython when run on embedded
+hardware, which is a CPython compatible alternative.
+This page gives a quick overview how the logging works.
 
 Usage
 -----
@@ -69,6 +72,8 @@ only critical messages will be logged):
     # Make connection less verbose
     sensirion_i2c_driver.connection.log.setLevel(level=logging.CRITICAL)
 
+    # or, assuming import board
+    # with CircuitPythonI2cTransceiver(board.I2C()) as transceiver:
     with LinuxI2cTransceiver('/dev/i2c-1') as transceiver:
         device = I2cDevice(I2cConnection(transceiver), slave_address=0x69)
         response = device.execute(I2cCommand(tx_data=b"\x80\x04", rx_length=6,

docs/quickstart.rst

@@ -13,7 +13,7 @@ Following example code shows how the driver is intended to use:
 .. sourcecode:: python
 
     from struct import pack
-    from sensirion_i2c_driver import LinuxI2cTransceiver, I2cConnection, \
+    from sensirion_i2c_driver import I2cTransceiver, I2cConnection, \
         I2cDevice, SensirionI2cCommand, CrcCalculator
 
 
@@ -44,6 +44,7 @@ Following example code shows how the driver is intended to use:
 
 
     # Usage
-    with LinuxI2cTransceiver('/dev/i2c-1') as transceiver:
+    # I2cTransceiver import is Automatically switched between Linux/CircuitPython
+    with I2cTransceiver('/dev/i2c-1') as transceiver:
         device = MyI2cDevice(I2cConnection(transceiver))
         print("Serial Number: {}".format(device.read_serial_number()))

docs/transceivers.rst

@@ -13,6 +13,13 @@ transceivers, i.e. the low level code which controls the I²C hardware:
   to use an I²C device file provided by the Linux Kernel (e.g. "/dev/i2c-1").
   This transceiver allows to use for example the I²C pins of a Raspberry Pi.
 
+- :py:class:`~sensirion_i2c_driver.circuitpython_i2c_transceiver.CircuitPythonI2cTransceiver`
+  to use an I²C bus provided by adafruit_bus_device (e.g. board.I2C()).
+  This transceiver allows to use for example the I²C pins of an ESP32.
+
+- :py:class:`~sensirion_i2c_driver.I2cTransceiver`
+  An alias to Linux/CircuitPython I2cTransceiver, based on if embedded device.
+
 Other implementations are provided in separate Python packages (for
 architecture reasons). But to avoid having dependencies from those Packages
 to this one just to implement the transceiver interface, we define a backward