adafruit-circuitpython-ina260


Nameadafruit-circuitpython-ina260 JSON
Version 1.3.16 PyPI version JSON
download
home_pageNone
SummaryCircuitPython driver for the TI INA260 current and power sensor
upload_time2024-10-07 22:01:12
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython ina260 power current voltage
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina260/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/ina260/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_INA260/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_INA260/actions/
    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: Code Style: Black

CircuitPython driver for the TI INA260 current and power sensor


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
--------------------
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!
   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
   On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
   PyPI <https://pypi.org/project/adafruit-circuitpython-ina260/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ina260

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ina260

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .venv/bin/activate
    pip3 install adafruit-circuitpython-ina260

Usage Example
=============
::

    import time
    import board
    import adafruit_ina260

    i2c = board.I2C()
    ina260 = adafruit_ina260.INA260(i2c)
    while True:
        print("Current: %.2f Voltage: %.2f Power:%.2f"
            %(ina260.current, ina260.voltage, ina260.power))
        time.sleep(1)

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

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-ina260",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, ina260, power, current, voltage",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/c8/d8/770fcf6aa2e6bb616db5b4e060a14526cc54aa827d792e24cf4a4ead32dc/adafruit_circuitpython_ina260-1.3.16.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ina260/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/ina260/en/latest/\n    :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_INA260/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_INA260/actions/\n    :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nCircuitPython driver for the TI INA260 current and power sensor\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\n.. note:: This library is not available on PyPI yet. Install documentation is included\n   as a standard element. Stay tuned for PyPI availability!\n   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.\n   On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\n   PyPI <https://pypi.org/project/adafruit-circuitpython-ina260/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-ina260\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-ina260\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 .venv/bin/activate\n    pip3 install adafruit-circuitpython-ina260\n\nUsage Example\n=============\n::\n\n    import time\n    import board\n    import adafruit_ina260\n\n    i2c = board.I2C()\n    ina260 = adafruit_ina260.INA260(i2c)\n    while True:\n        print(\"Current: %.2f Voltage: %.2f Power:%.2f\"\n            %(ina260.current, ina260.voltage, ina260.power))\n        time.sleep(1)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ina260/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_INA260/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython driver for the TI INA260 current and power sensor",
    "version": "1.3.16",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_INA260"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " ina260",
        " power",
        " current",
        " voltage"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96eae5422c6ac0e7c0045b6348db8c8e5f9556695002cd0f395b1a490d011177",
                "md5": "6d6658271949986ce3ef05abd6344eed",
                "sha256": "3d89c9252683d67ccc97b8da0a68b738a01a337b501c5ac125f130abaad68dd2"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ina260-1.3.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6d6658271949986ce3ef05abd6344eed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7230,
            "upload_time": "2024-10-07T22:01:11",
            "upload_time_iso_8601": "2024-10-07T22:01:11.318515Z",
            "url": "https://files.pythonhosted.org/packages/96/ea/e5422c6ac0e7c0045b6348db8c8e5f9556695002cd0f395b1a490d011177/adafruit_circuitpython_ina260-1.3.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c8d8770fcf6aa2e6bb616db5b4e060a14526cc54aa827d792e24cf4a4ead32dc",
                "md5": "880c5cb53f8b3724e1af11c8be224adc",
                "sha256": "318167e76014f2dc4e92383af5037e0082a06f83b954cdfe9ae16cf935ebe785"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ina260-1.3.16.tar.gz",
            "has_sig": false,
            "md5_digest": "880c5cb53f8b3724e1af11c8be224adc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 29497,
            "upload_time": "2024-10-07T22:01:12",
            "upload_time_iso_8601": "2024-10-07T22:01:12.188078Z",
            "url": "https://files.pythonhosted.org/packages/c8/d8/770fcf6aa2e6bb616db5b4e060a14526cc54aa827d792e24cf4a4ead32dc/adafruit_circuitpython_ina260-1.3.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:01:12",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_INA260",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-ina260"
}
        
Elapsed time: 0.33096s