A library for interacting with the Texas Instruments INA219 high side current and power monitoring chip via I2C using Elixir ALE.

I'm using the Adafruit INA219 breakout for prototyping, so am using their calibrations straight from their Arduino library, but you can do the maths and calibrate it yourself if you're using a different shunt resistor value.

This library uses the Wafer project to connect to the I2C device - this allows you to bring your own driver.

Example using Elixir Circuits

iex> {:ok, conn} = Wafer.Driver.CircuitsI2C.acquire(bus: "i2c-1", address: 0x41)
...> {:ok, conn} = INA219.acquire(conn: conn, current_divisor: 10, power_divisor: 2)
...> :ok = INA219.calibrate_32V_2A(conn)
...> INA219.bus_voltage(conn)
{:ok, 12.0}

Calibrating these wee chips is a bit of a pain in the donkey, but is easily achieved by following the equation in the data sheet. Once you have the calibration and divisor values you wish to use you can configure the device manually. For example:

iex> {:ok, conn} = Wafer.Driver.CircuitsI2C.acquire(bus: "i2c-1", address: 0x41)
...> {:ok, conn} = INA219.acquire(conn: conn, current_divisor: 10, power_divisor: 2)
...> INA219.calibrate(conn, 4096)
...> INA219.bus_voltage_range(conn, 32)
...> INA219.shunt_voltage_pga(conn, 8)
...> INA219.bus_adc_resolution_and_averaging(conn, {1, 12})
...> INA219.shunt_adc_resolution_and_averaging(conn, {1, 12})
...> INA219.mode(conn, :shunt_and_bus_voltage_continuous)

The current_divisor and power_divisor values are stored in the connection struct because there's no way to store them in the device's registers. You can alter them as required.

The ina219 package is available on hex so it can be installed by adding ina219 to your list of dependencies in mix.exs. You'll also need to install an appropriate connection driver.

def deps do
  [
    {:ina219, "~> 2.0.1"}
  ]
end

Documentation for the latest release is always available on HexDocs and for the main branch on docs.harton.nz.

This repository is mirrored on Github from it's primary location on my Forgejo instance. Feel free to raise issues and open PRs on Github.

This software is licensed under the terms of the HL3-FULL, see the LICENSE.md file included with this package for the terms.

This license actively proscribes this software being used by and for some industries, countries and activities. If your usage of this software doesn't comply with the terms of this license, then contact me with the details of your use-case to organise the purchase of a license - the cost of which may include a donation to a suitable charity or NGO.