diff --git a/README.rst b/README.rst index a1f3bc4..26846f6 100644 --- a/README.rst +++ b/README.rst @@ -19,12 +19,12 @@ Product page at `ti.com `_. 2 version are available: -* full includes all constants for low-level register access + API for alarms -* lite only basic API and no constants - use less memory +* ``barbudor_ina3221.full`` includes all constants for low-level register access + API for alarms +* ``barbudor_ina3221.lite`` only basic API and no constants - use less memory Pick only one depending your needs. On processors with limited amount of memory (SAMD21), the -lite version is recommended. You may want to use `mpy-cross` to precompile the library to an -`.mpy` file for lower memory footprint. +lite version is recommended. You may want to use ``mpy-cross`` to precompile the library to an +``.mpy`` file for lower memory footprint. Dependencies ============= diff --git a/barbudor_ina3221/full.py b/barbudor_ina3221/full.py index 79a2f7a..ec66ba4 100644 --- a/barbudor_ina3221/full.py +++ b/barbudor_ina3221/full.py @@ -20,29 +20,30 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`barbudor_INA3221` -==================================================== +`barbudor_INA3221.full ` - Full version library +===================================================== -CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor. +CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor -* Author : Barbudor (Jean-Michel Mercier) +Author : Barbudor (Jean-Michel Mercier) Implementation Notes -------------------- -**Important Note:** In order to be coherent with the datasheet, the channel index in the below API start at 1. Value of ``channel`` parameter must be ``1``, ``2`` or ``3``. **Do not use** ``0`` -Memory usage (tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express): +**Memory usage:** -* from barbudor_ina3221 import INA3221 --> 6704 bytes -* ina3221 = INA3221(i2c_bus) --> 112 bytes +Tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express: + +* ``from barbudor_ina3221 import INA3221`` => 6704 bytes +* ``ina3221 = INA3221(i2c_bus)`` => 112 bytes **Hardware:** * Device: `INA3221 `_ Triple, Low-/High-Side, I2C Out - Current/Voltage Monitor. + Current/Voltage Monitor. **Software and Dependencies:** diff --git a/barbudor_ina3221/lite.py b/barbudor_ina3221/lite.py index a6a8082..25b9db4 100644 --- a/barbudor_ina3221/lite.py +++ b/barbudor_ina3221/lite.py @@ -20,29 +20,30 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`barbudor_INA3221` -- lite version -==================================================== +`barbudor_INA3221.lite ` - Lite version library +===================================================== -CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor. +CircuitPython driver for the Texas Instruments INA3221 3 channels current sensor -* Author : Barbudor (Jean-Michel Mercier) +Author : Barbudor (Jean-Michel Mercier) Implementation Notes -------------------- -**Important Note** In order to be coherent with the datasheet, the channel index in the below API start at 1. Value of ``channel`` parameter must be ``1``, ``2`` or ``3``. **Do not use** ``0`` -Memory usage (tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express): +**Memory usage:** -* from barbudor_ina3221 import INA3221 --> 3200 bytes -* ina3221 = INA3221(i2c_bus) --> 112 bytes +Tested with CircuitPython 4.0.0-rc.1 on CircuitPlayground Express: + +* ``from barbudor_ina3221 import INA3221`` => 3200 bytes +* ``ina3221 = INA3221(i2c_bus)`` => 112 bytes **Hardware:** * Device: `INA3221 `_ Triple, Low-/High-Side, I2C Out - Current/Voltage Monitor. + Current/Voltage Monitor. **Software and Dependencies:**