Skip to main content

CircuitPython driver for the INA237 and INA238 DC Current Voltage Power Monitor

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython driver for the INA237 and INA238 DC Current Voltage Power Monitor

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 or individual libraries can be installed using circup.

Purchase INA237 from the Adafruit shop

Purchase INA238 from the Adafruit shop

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ina23x

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

sudo pip3 install adafruit-circuitpython-ina23x

To install in a virtual environment in your current project:

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

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_ina23x

Or the following command to update an existing version:

circup update

Usage Example

import time
import board
import adafruit_ina23x

i2c = board.I2C()
ina23x = adafruit_ina23x.INA23X(i2c)

while True:
    print(f"Current: {ina23x.current * 1000:.2f} mA")
    print(f"Bus Voltage: {ina23x.bus_voltage:.2f} V")
    print(f"Shunt Voltage: {ina23x.shunt_voltage * 1000:.2f} mV")
    print(f"Power: {ina23x.power * 1000:.2f} mW")
    print(f"Temperature: {ina23x.die_temperature:.2f} °C")
    print()

    time.sleep(2)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ina23x-1.0.0.tar.gz (24.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_ina23x-1.0.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ina23x-1.0.0.tar.gz
Algorithm Hash digest
SHA256 c7314ce62c49359193ec24b0dd9abdc73569f129c979139801ad7db62d7fabf8
MD5 a318dfa6ed39ef9c9f430c0c93bc4d3c
BLAKE2b-256 6ae0c1bfdecbac6be51c166b5b88cfbcd1f25c76351e960fdb9f4bd5591ddfc7

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ina23x-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ina23x-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22acf399991df5c53080efdbbb443355bb2203eb221b352d5b3eeb707c2c754e
MD5 bfa3c1e3160f1c198acc90e6ba7c99f2
BLAKE2b-256 a6334c833e51e0620e7bcf8501e82b199780365328e1c7a6e97e3974fe71539c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page