Skip to content

Commit

Permalink
fixes for sphinx
Browse files Browse the repository at this point in the history
  • Loading branch information
barbudor committed May 11, 2019
1 parent fba124b commit bc85429
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 22 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@ Product page at `ti.com <http://www.ti.com/product/INA3221>`_.

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
=============
Expand Down
19 changes: 10 additions & 9 deletions barbudor_ina3221/full.py
Original file line number Diff line number Diff line change
Expand Up @@ -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>` - 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 <http://www.ti.com/product/INA3221>`_ Triple, Low-/High-Side, I2C Out
Current/Voltage Monitor.
Current/Voltage Monitor.
**Software and Dependencies:**
Expand Down
19 changes: 10 additions & 9 deletions barbudor_ina3221/lite.py
Original file line number Diff line number Diff line change
Expand Up @@ -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>` - 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 <http://www.ti.com/product/INA3221>`_ Triple, Low-/High-Side, I2C Out
Current/Voltage Monitor.
Current/Voltage Monitor.
**Software and Dependencies:**
Expand Down

0 comments on commit bc85429

Please sign in to comment.