adafruit-circuitpython-ina228


Nameadafruit-circuitpython-ina228 JSON
Version 2.0.2 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for the INA228 I2C 85V, 20-bit High or Low Side Power Monitor
upload_time2025-10-20 16:47:49
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython ina228 power monitor
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-register
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina228/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ina228/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_INA228/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_INA228/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 INA228 I2C 85V, 20-bit High or Low Side Power Monitor


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://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/5832>`_

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-ina228/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ina228

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ina228

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-ina228

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_ina228

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

.. code-block:: python

    import time
    import board
    import adafruit_ina228

    i2c = board.I2C()
    ina228 = adafruit_ina228.INA228(i2c)

    while True:
        print(f"Current: {ina228.current:.2f} mA")
        print(f"Bus Voltage: {ina228.bus_voltage:.2f} V")
        print(f"Shunt Voltage: {ina228.shunt_voltage*1000:.2f} mV")
        print(f"Power: {ina228.power:.2f} mW")
        print(f"Energy: {ina228.energy:.2f} J")
        print(f"Temperature: {ina228.die_temperature:.2f} °C")
        time.sleep(1)

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ina228/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_INA228/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-ina228",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, ina228, power, monitor",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/ff/05/5b8cde994d1351f26c6cbdc23a1fabdde8d8adb78bf80132c6960bb950ac/adafruit_circuitpython_ina228-2.0.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina228/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ina228/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_INA228/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_INA228/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 INA228 I2C 85V, 20-bit High or Low Side 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* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\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/5832>`_\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-ina228/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-ina228\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-ina228\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-ina228\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_ina228\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    import adafruit_ina228\n\n    i2c = board.I2C()\n    ina228 = adafruit_ina228.INA228(i2c)\n\n    while True:\n        print(f\"Current: {ina228.current:.2f} mA\")\n        print(f\"Bus Voltage: {ina228.bus_voltage:.2f} V\")\n        print(f\"Shunt Voltage: {ina228.shunt_voltage*1000:.2f} mV\")\n        print(f\"Power: {ina228.power:.2f} mW\")\n        print(f\"Energy: {ina228.energy:.2f} J\")\n        print(f\"Temperature: {ina228.die_temperature:.2f} \u00b0C\")\n        time.sleep(1)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ina228/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_INA228/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 INA228 I2C 85V, 20-bit High or Low Side Power Monitor",
    "version": "2.0.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_INA228"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " ina228",
        " power",
        " monitor"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ef717f8205c2be4b99671409d9a1687d147b28523b9a64ff65d297b82f3db720",
                "md5": "1441912ca089e95b96ca601d3df764a2",
                "sha256": "15720403cc810f8ed492c76afa87a9193f5c64967f284dd9806eb0ba6076b7cf"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ina228-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1441912ca089e95b96ca601d3df764a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8973,
            "upload_time": "2025-10-20T16:47:47",
            "upload_time_iso_8601": "2025-10-20T16:47:47.923152Z",
            "url": "https://files.pythonhosted.org/packages/ef/71/7f8205c2be4b99671409d9a1687d147b28523b9a64ff65d297b82f3db720/adafruit_circuitpython_ina228-2.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ff055b8cde994d1351f26c6cbdc23a1fabdde8d8adb78bf80132c6960bb950ac",
                "md5": "9c07cba2fa3422446c83cd8ba8b9ad07",
                "sha256": "08cd6166fe245dd894212a9287ab074c02f4f071b39078563a6cff9d1c2806a5"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ina228-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9c07cba2fa3422446c83cd8ba8b9ad07",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 27431,
            "upload_time": "2025-10-20T16:47:49",
            "upload_time_iso_8601": "2025-10-20T16:47:49.689345Z",
            "url": "https://files.pythonhosted.org/packages/ff/05/5b8cde994d1351f26c6cbdc23a1fabdde8d8adb78bf80132c6960bb950ac/adafruit_circuitpython_ina228-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-10-20 16:47:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_INA228",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-register",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-ina228"
}
        
Elapsed time: 1.23825s