Skip to content
circuit python driver for INA219 current sensor
Branch: master
Clone or download
Latest commit a75e35a Jul 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs PyPi setup. Aug 3, 2018
examples
.gitignore
.pylintrc ignore the board module imports in .pylintrc Aug 25, 2018
.readthedocs.yml updated .travis & .readthedocs yml Feb 26, 2018
.travis.yml
CODE_OF_CONDUCT.md updated CoC Aug 1, 2018
LICENSE DM: use cookiecutter Oct 18, 2017
README.rst change 'travis-ci.org' to 'travis-ci.com' Dec 21, 2018
adafruit_ina219.py Fixes #10, fix found by @barbudor, tested and committed by @siddacious Jul 12, 2019
requirements.txt Clean-up and improvements Mar 17, 2019
setup.py Clean-up and improvements Mar 17, 2019

README.rst

Introduction

Documentation Status Discord Build Status

CircuitPython driver for the INA219 current sensor.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

see example

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ina219 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.