jepler/Adafruit_CircuitPython_INA219
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
No description
75 commits 2 branches 16 tags 175 KiB
Python 100%
Find a file
Kattni 7d2b3b42a5
Merge pull request #24 from nvtkaszpir/patch-1 
Update ina219_simpletest.py
2020-08-17 16:08:09 -04:00
.github/workflows build.yml: add black formatting check 2020-04-07 16:07:06 -05:00
docs Black reformatting with Python 3 target. 2020-04-08 16:38:04 -04:00
examples Update examples/ina219_simpletest.py 2020-08-17 21:06:36 +02:00
.gitignore Moved repository from Travis to GitHub Actions 2020-01-01 14:57:34 -05:00
.pylintrc Ran black, updated to pylint 2.x 2020-03-16 16:34:57 -04:00
.readthedocs.yml updated .travis & .readthedocs yml 2018-02-25 23:07:14 -06:00
adafruit_ina219.py Fix docstrings for adafruit_ina219.py 2020-08-13 22:48:43 +02:00
CODE_OF_CONDUCT.md update code of coduct: discord moderation contact section 2020-03-15 18:23:13 -05:00
LICENSE DM: use cookiecutter 2017-10-18 17:49:21 -04:00
README.rst Update README.rst 2020-08-13 22:45:26 +02:00
requirements.txt Clean-up and improvements 2019-03-17 18:37:54 +01:00
setup.py Ran black, updated to pylint 2.x 2020-03-16 16:34:57 -04:00

README.rst 

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina219/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/ina219/en/latest/
    :alt: Documentation Status

.. image :: https://img.shields.io/discord/327254708534116352.svg
    :target: https://adafru.it/discord
    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_INA219/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_INA219/actions/
    :alt: Build Status

CircuitPython driver for the `INA219 current sensor <https://www.adafruit.com/product/904>`_.

Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ina219/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ina219

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ina219

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-ina219
    
Usage Example
=============

see `example <https://github.com/adafruit/Adafruit_CircuitPython_INA219/blob/master/examples/ina219_simpletest.py>`_

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_ina219/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Documentation
=============

For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.