Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina3221/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ina3221/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_INA3221/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_INA3221/actions
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for the INA3221 Triple 0-26 VDC, ±3.2 Amp Power Monitor
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6062>`_
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-ina3221/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ina3221
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ina3221
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-ina3221
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_ina3221
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
from adafruit_ina3221 import INA3221
i2c = board.I2C()
ina = INA3221(i2c)
while True:
for i in range(3):
bus_voltage = ina[i].bus_voltage
shunt_voltage = ina[i].shunt_voltage
current = ina[i].current_amps * 1000
print(f"Channel {i + 1}:")
print(f" Bus Voltage: {bus_voltage:.6f} V")
print(f" Shunt Voltage: {shunt_voltage:.6f} V")
print(f" Current: {current:.6f} mA")
print("-" * 30)
time.sleep(2)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ina3221/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_INA3221/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ina3221",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ina3221, power, monitor, , i2c",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/9f/bb/eecaac0d4c7e8fe9d8c041f9b5fb06de707fc3ed8a3d285cbe06bba11bbd/adafruit_circuitpython_ina3221-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina3221/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ina3221/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_INA3221/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_INA3221/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython driver for the INA3221 Triple 0-26 VDC, \u00b13.2 Amp Power Monitor\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/6062>`_\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ina3221/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ina3221\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ina3221\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install adafruit-circuitpython-ina3221\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_ina3221\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n from adafruit_ina3221 import INA3221\n\n i2c = board.I2C()\n ina = INA3221(i2c)\n\n while True:\n for i in range(3):\n bus_voltage = ina[i].bus_voltage\n shunt_voltage = ina[i].shunt_voltage\n current = ina[i].current_amps * 1000\n print(f\"Channel {i + 1}:\")\n print(f\" Bus Voltage: {bus_voltage:.6f} V\")\n print(f\" Shunt Voltage: {shunt_voltage:.6f} V\")\n print(f\" Current: {current:.6f} mA\")\n print(\"-\" * 30)\n time.sleep(2)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ina3221/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_INA3221/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython driver for the INA3221 Triple 0-26 VDC, \u00b13.2 Amp Power Monitor",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_INA3221"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ina3221",
" power",
" monitor",
" ",
" i2c"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd813478d5028268bb5842803bce1c4c211f02f3080c484e9380b2aeb576f305",
"md5": "703d0a536084e2343ee9320d23d10182",
"sha256": "34fff599db533b200fbd03daa62d1becc24826554e19a661bd20609099f1e8d8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ina3221-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "703d0a536084e2343ee9320d23d10182",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8073,
"upload_time": "2024-10-22T18:18:02",
"upload_time_iso_8601": "2024-10-22T18:18:02.215420Z",
"url": "https://files.pythonhosted.org/packages/dd/81/3478d5028268bb5842803bce1c4c211f02f3080c484e9380b2aeb576f305/adafruit_circuitpython_ina3221-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9fbbeecaac0d4c7e8fe9d8c041f9b5fb06de707fc3ed8a3d285cbe06bba11bbd",
"md5": "2440ed444a2ff49cef15e59075565985",
"sha256": "2eefd506ecadc6273bfac2996bc45922aeb8ce1c3053513ab7b4682b3ac6801b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ina3221-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2440ed444a2ff49cef15e59075565985",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26113,
"upload_time": "2024-10-22T18:18:04",
"upload_time_iso_8601": "2024-10-22T18:18:04.105224Z",
"url": "https://files.pythonhosted.org/packages/9f/bb/eecaac0d4c7e8fe9d8c041f9b5fb06de707fc3ed8a3d285cbe06bba11bbd/adafruit_circuitpython_ina3221-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:18:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_INA3221",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ina3221"
}
JSON
