add new i2c example ina228 to pico examples

Author: Louis31423142

README.md

@@ -159,6 +159,7 @@ App|Description
 [ht16k33_i2c](i2c/ht16k33_i2c) | Drive a 4 digit 14 segment LED with an HT16K33.
 [slave_mem_i2c](i2c/slave_mem_i2c) | i2c slave example where the slave implements a 256 byte memory.
 [slave_mem_i2c_burst](i2c/slave_mem_i2c) | i2c slave example where the slave implements a 256 byte memory. This version inefficiently writes each byte in a separate call to demonstrate read and write burst mode.
+[ina228_i2c](i2c/ina228) | Read voltage, current, temperature, power, energy and charge from INA228 sensor, via I2C.
 
 ### Interpolator
 

examples_tests.json

@@ -12,6 +12,8 @@ if (TARGET hardware_i2c)
     add_subdirectory_exclude_platforms(pcf8523_i2c)
     add_subdirectory_exclude_platforms(ht16k33_i2c)
     add_subdirectory_exclude_platforms(slave_mem_i2c)
+    add_subdirectory_exclude_platforms(ina228_i2c)
+else()
 else()
     message("Skipping I2C examples as hardware_i2c is unavailable on this platform")
 endif()

i2c/CMakeLists.txt

@@ -0,0 +1,13 @@
+add_executable(ina228_i2c ina228_i2c.c)
+
+# pull in common dependencies and additional i2c hardware support
+target_link_libraries(ina228_i2c
+        pico_stdlib
+        hardware_i2c)
+
+# create map/bin/hex file etc.
+pico_add_extra_outputs(ina228_i2c)
+
+# add url via pico_set_program_url
+example_auto_set_url(lcd_1602_i2c)
+

i2c/ina228_i2c/CMakeLists.txt

@@ -0,0 +1,37 @@
+= Reading an INA228 power sensor via I2C
+
+This example code shows how to interface the Raspberry Pi Pico with the INA228 current/voltage/power/temperature/energy/charge sensor. The sensor features a 20 bit ADC and supports up to 85V DC, making it a great choice for high preccision measurments. It is capable of high-side and low-side measurments (which can be configured by soldering the jumper on the back of the board), but this example focuses on low-side measurments.
+
+The sensor breakout board has an integrated 0.015 ohm, high precision shunt resistor, which is used for measuring voltage drop, which also gives current since the resistor value is known. This current, combined with the load voltage vbus, allows load power and energy to be calculated. 
+
+[TIP]
+======
+The INA228 is highly configurable. Find the datasheet online (https://www.ti.com/lit/ds/symlink/ina228.pdf) to explore all of its capabilities beyond the simple example given here.
+======
+
+== Wiring information
+
+[[bmp280_i2c_wiring]]
+[pdfwidth=75%]
+.Wiring Diagram for BMP280 sensor via I2C.
+image::bmp280_i2c_bb.png[]
+
+== List of Files
+
+CMakeLists.txt:: CMake file to incorporate the example into the examples build tree.
+ina228_i2c.c:: The example code.
+
+== Bill of Materials
+
+.A list of materials required for the example
+[[ina228_i2c-bom-table]]
+[cols=3]
+|===
+| *Item* | *Quantity* | Details
+| Breadboard | 1 | generic part
+| Raspberry Pi Pico 2 | 1 | https://www.raspberrypi.com/products/raspberry-pi-pico-2/
+| INA228-based breakout board | 1 | https://www.adafruit.com/product/5832?srsltid=AfmBOoq8cjiUxn01ClOriCxHK3rMMtswYVhzd2tTkiLdjysj2CJZE-RX[from Adafruit]
+| M/M Jumper wires | 9 | generic part
+| LED | 1 | generic part
+| 330 ohm resistor | 1 | generic part
+|===

i2c/ina228_i2c/README.md

@@ -0,0 +1,122 @@
+#include <stdio.h>
+#include "pico/stdlib.h"
+#include "hardware/i2c.h"
+#include <math.h>
+
+// GPIOs, see circuit diagram
+#define I2C_SDA 8
+#define I2C_SCL 9
+#define EXT_LED_GPIO 2
+
+// Shunt resistor  values in ohms
+#define R_SHUNT 0.015
+
+// Max expected current through shunt resistor
+#define MAX_EXPECTED_CURRENT 0.1
+#define I2C_ADDR 0x40
+
+// ina228 registers (see datasheet)
+uint8_t VSHUNT_REG = 0x04;
+uint8_t VBUS_REG = 0x05;
+uint8_t DIETEMP_REG = 0x06;
+uint8_t CURRENT_REG = 0x07;
+uint8_t POWER_REG = 0x08;
+uint8_t ENERGY_REG = 0x09;
+uint8_t CHARGE_REG = 0x0A;
+
+uint8_t ADC_CONFIG_REG = 0x01;
+uint8_t SHUNT_CAL_REG = 0x02;
+
+// conversion factors (see datasheet)
+// note: VSHUNT_FACTOR assumes ADCRANGE = 0 
+const double VSHUNT_FACTOR = 312.5 * 1e-9;
+const double VBUS_FACTOR = 195.3125 * 1e-6;
+const double DIETEMP_FACTOR  = 7.8125 * 1e-3;
+const double CURRENT_FACTOR = MAX_EXPECTED_CURRENT / (1<<19);
+const double POWER_FACTOR = 3.2 * CURRENT_FACTOR ;
+const double ENERGY_FACTOR  = 16 * 3.2 * CURRENT_FACTOR;
+const double CHARGE_FACTOR = CURRENT_FACTOR;
+
+const uint16_t SHUNT_CAL = 13107.2 * 1e6 * CURRENT_FACTOR * R_SHUNT;
+
+float vshunt, vbus, dietemp, current, power, energy, charge;
+
+static void ina228_init() {
+    // Write to shunt register 
+    uint8_t shunt_msb = (SHUNT_CAL >> 8) & 0xFF;
+    uint8_t shunt_lsb = SHUNT_CAL & 0xff;
+    uint8_t shunt_buf[3] = {SHUNT_CAL_REG, shunt_msb, shunt_lsb};
+    i2c_write_blocking(i2c_default, I2C_ADDR, shunt_buf, 3, false);
+
+    // Write to ADC config register (need to enable continuous mode to access accumilation variables energy and charge)
+    // To enable contintinuous vbus, vshunt and temp, write 0x0F to bits 15-12
+    uint8_t adc_msb = 0xF1;
+    uint8_t adc_lsb = 0x11;
+    uint8_t adc_buf[3] = {ADC_CONFIG_REG, adc_msb, adc_lsb};
+    i2c_write_blocking(i2c_default, I2C_ADDR, adc_buf, 3, false);
+}
+
+static void ina228_read(float *vshunt, float *vbus, float *dietemp, float *current, float *power, float *energy, float *charge) {
+    // Buffers for writing register measurments to
+    // Some registers are 2 byte, some are 3 byte, the accumilation registers are 5 byte
+    uint8_t buffer_2[2];
+    uint8_t buffer_3[3];
+    uint8_t buffer_5[5];
+
+    // For some of the registers the 4 least significant bits are reserved and always read zero, which is why we shift right 12, 4, then left 4 for vshunt, vbus and current
+    i2c_write_blocking(i2c_default, I2C_ADDR, &VSHUNT_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_3, 3, false);
+    *vshunt = ((buffer_3[0] << 12) | (buffer_3[1] << 4) | (buffer_3[2] >> 4)) * VSHUNT_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &VBUS_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_3, 3, false);
+    *vbus = ((buffer_3[0] << 12) | (buffer_3[1] << 4) | (buffer_3[2] >> 4)) * VBUS_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &DIETEMP_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_2, 2, false);
+    *dietemp = ((buffer_2[0] << 8) + buffer_2[1]) * DIETEMP_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &CURRENT_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_3, 3, false);
+    *current = ((buffer_3[0] << 12) | (buffer_3[1] << 4) | (buffer_3[2] >> 4)) * CURRENT_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &POWER_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_3, 3, false);
+    *power = ((buffer_3[0] << 16) | (buffer_3[1] << 8) | buffer_3[2]) * POWER_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &ENERGY_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_5, 5, false);
+    *energy = (((uint64_t) buffer_5[0] << 32) | (buffer_5[1] << 24) | (buffer_5[2] << 16) | (buffer_5[3] << 8) | buffer_5[4]) * ENERGY_FACTOR;
+
+    i2c_write_blocking(i2c_default, I2C_ADDR, &CHARGE_REG, 1, true);
+    i2c_read_blocking(i2c_default, I2C_ADDR, buffer_5, 5, false);
+    *charge = (((uint64_t) buffer_5[0] << 32) | (buffer_5[1] << 24) | (buffer_5[2] << 16) | (buffer_5[3] << 8) | buffer_5[4]) * CHARGE_FACTOR;
+}
+
+int main()
+{
+    stdio_init_all();
+
+    // Initialise external LED and turn it on (so we can measure some current)
+    gpio_init(EXT_LED_GPIO);
+    gpio_set_dir(EXT_LED_GPIO, GPIO_OUT);
+    gpio_put(EXT_LED_GPIO, true);
+
+    // I2C initialisation
+    i2c_init(i2c_default, 400*1000);
+    
+    // GPIO initialisiation
+    gpio_set_function(I2C_SDA, GPIO_FUNC_I2C);
+    gpio_set_function(I2C_SCL, GPIO_FUNC_I2C);
+    gpio_pull_up(I2C_SDA);
+    gpio_pull_up(I2C_SCL);
+
+    // Initialise ina228
+    ina228_init();
+
+    while (true) {
+        ina228_read(&vshunt, &vbus, &dietemp, &current, &power, &energy, &charge);
+        printf("INA228 Measurments:\nVSHUNT: %f\nVBUS: %f\nDIETEMP: %f\nCURRENT: %f\nPOWER: %f\nENERGY: %.9f\nCHARGE: %.9f\n-----------------\n", vshunt, vbus, dietemp, current, power, energy, charge);
+        sleep_ms(3000);
+    }
+}