Merge pull request #305 from ngavars/dev

Telemetry: Create sensor classes that can be shared across variants
This commit is contained in:
ripplebiz
2025-05-22 15:46:28 +10:00
committed by GitHub
5 changed files with 135 additions and 165 deletions

View File

@@ -0,0 +1,90 @@
#include "EnvironmentSensorManager.h"
static Adafruit_AHTX0 AHTX0;
static Adafruit_BME280 BME280;
static Adafruit_INA3221 INA3221;
static Adafruit_INA219 INA219(TELEM_INA219_ADDRESS);
bool EnvironmentSensorManager::begin() {
if (INA3221.begin(TELEM_INA3221_ADDRESS, &Wire)) {
MESH_DEBUG_PRINTLN("Found INA3221 at address: %02X", TELEM_INA3221_ADDRESS);
MESH_DEBUG_PRINTLN("%04X %04X", INA3221.getDieID(), INA3221.getManufacturerID());
for(int i = 0; i < 3; i++) {
INA3221.setShuntResistance(i, TELEM_INA3221_SHUNT_VALUE);
}
INA3221_initialized = true;
} else {
INA3221_initialized = false;
MESH_DEBUG_PRINTLN("INA3221 was not found at I2C address %02X", TELEM_INA3221_ADDRESS);
}
if (INA219.begin(&Wire)) {
MESH_DEBUG_PRINTLN("Found INA219 at address: %02X", TELEM_INA219_ADDRESS);
INA219_initialized = true;
} else {
INA219_initialized = false;
MESH_DEBUG_PRINTLN("INA219 was not found at I2C address %02X", TELEM_INA219_ADDRESS);
}
if (AHTX0.begin(&Wire, 0, TELEM_AHTX_ADDRESS)) {
MESH_DEBUG_PRINTLN("Found AHT10/AHT20 at address: %02X", TELEM_AHTX_ADDRESS);
AHTX0_initialized = true;
} else {
AHTX0_initialized = false;
MESH_DEBUG_PRINTLN("AHT10/AHT20 was not found at I2C address %02X", TELEM_AHTX_ADDRESS);
}
if (BME280.begin(TELEM_BME280_ADDRESS, &Wire)) {
MESH_DEBUG_PRINTLN("Found BME280 at address: %02X", TELEM_BME280_ADDRESS);
MESH_DEBUG_PRINTLN("BME sensor ID: %02X", BME280.sensorID);
BME280_initialized = true;
} else {
BME280_initialized = false;
MESH_DEBUG_PRINTLN("BME280 was not found at I2C address %02X", TELEM_BME280_ADDRESS);
}
return true;
}
bool EnvironmentSensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) {
next_available_channel = TELEM_CHANNEL_SELF + 1;
if (requester_permissions & TELEM_PERM_ENVIRONMENT) {
if (INA3221_initialized) {
for(int i = 0; i < TELEM_INA3221_NUM_CHANNELS; i++) {
// add only enabled INA3221 channels to telemetry
if (INA3221.isChannelEnabled(i)) {
float voltage = INA3221.getBusVoltage(i);
float current = INA3221.getCurrentAmps(i);
telemetry.addVoltage(next_available_channel, voltage);
telemetry.addCurrent(next_available_channel, current);
telemetry.addPower(next_available_channel, voltage * current);
next_available_channel++;
}
}
}
if (INA219_initialized) {
telemetry.addVoltage(next_available_channel, INA219.getBusVoltage_V());
telemetry.addCurrent(next_available_channel, INA219.getCurrent_mA() / 1000);
telemetry.addPower(next_available_channel, INA219.getPower_mW() / 1000);
next_available_channel++;
}
if (AHTX0_initialized) {
sensors_event_t humidity, temp;
AHTX0.getEvent(&humidity, &temp);
telemetry.addTemperature(TELEM_CHANNEL_SELF, temp.temperature);
telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, humidity.relative_humidity);
}
if (BME280_initialized) {
telemetry.addTemperature(TELEM_CHANNEL_SELF, BME280.readTemperature());
telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, BME280.readHumidity());
telemetry.addBarometricPressure(TELEM_CHANNEL_SELF, BME280.readPressure());
telemetry.addAltitude(TELEM_CHANNEL_SELF, BME280.readAltitude(TELEM_BME280_SEALEVELPRESSURE_HPA));
}
}
return true;
}

View File

@@ -0,0 +1,32 @@
#pragma once
#include <helpers/SensorManager.h>
#include <Mesh.h>
#include <Adafruit_INA3221.h>
#include <Adafruit_INA219.h>
#include <Adafruit_AHTX0.h>
#include <Adafruit_BME280.h>
#define TELEM_AHTX_ADDRESS 0x38 // AHT10, AHT20 temperature and humidity sensor I2C address
#define TELEM_BME280_ADDRESS 0x76 // BME280 environmental sensor I2C address
#define TELEM_INA3221_ADDRESS 0x42 // INA3221 3 channel current sensor I2C address
#define TELEM_INA219_ADDRESS 0x40 // INA219 single channel current sensor I2C address
#define TELEM_INA3221_SHUNT_VALUE 0.100 // most variants will have a 0.1 ohm shunts
#define TELEM_INA3221_NUM_CHANNELS 3
#define TELEM_BME280_SEALEVELPRESSURE_HPA (1013.25) // Athmospheric pressure at sea level
class EnvironmentSensorManager : public SensorManager {
protected:
int next_available_channel = TELEM_CHANNEL_SELF + 1;
bool INA3221_initialized = false;
bool INA219_initialized = false;
bool BME280_initialized = false;
bool AHTX0_initialized = false;
public:
EnvironmentSensorManager(){};
bool begin() override;
bool querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) override;
};

View File

@@ -15,12 +15,14 @@ build_flags = ${nrf52840_base.build_flags}
-D PIN_USER_BTN=6
build_src_filter = ${nrf52840_base.build_src_filter}
+<helpers/nrf52/PromicroBoard.cpp>
+<helpers/sensors>
+<../variants/promicro>
lib_deps= ${nrf52840_base.lib_deps}
adafruit/Adafruit SSD1306 @ ^2.5.13
robtillaart/INA3221 @ ^0.4.1
robtillaart/INA219 @ ^0.4.1
adafruit/Adafruit AHTX0@^2.0.5
adafruit/Adafruit INA3221 Library @ ^1.0.1
adafruit/Adafruit INA219 @ ^1.2.3
adafruit/Adafruit AHTX0 @ ^2.0.5
adafruit/Adafruit BME280 Library @ ^2.3.0
[env:Faketec_Repeater]
extends = Faketec
@@ -120,11 +122,13 @@ build_flags = ${nrf52840_base.build_flags}
build_src_filter =
${nrf52840_base.build_src_filter}
+<helpers/nrf52/PromicroBoard.cpp>
+<helpers/sensors>
+<../variants/promicro>
lib_deps= ${nrf52840_base.lib_deps}
robtillaart/INA3221 @ ^0.4.1
robtillaart/INA219 @ ^0.4.1
adafruit/Adafruit AHTX0@^2.0.5
adafruit/Adafruit INA3221 Library @ ^1.0.1
adafruit/Adafruit INA219 @ ^1.2.3
adafruit/Adafruit AHTX0 @ ^2.0.5
adafruit/Adafruit BME280 Library @ ^2.3.0
[env:ProMicroLLCC68_Repeater]
extends = ProMicroLLCC68

View File

@@ -10,7 +10,7 @@ WRAPPER_CLASS radio_driver(radio, board);
VolatileRTCClock fallback_clock;
AutoDiscoverRTCClock rtc_clock(fallback_clock);
PromicroSensorManager sensors;
EnvironmentSensorManager sensors;
#ifdef DISPLAY_CLASS
DISPLAY_CLASS display;
@@ -79,120 +79,3 @@ mesh::LocalIdentity radio_new_identity() {
return mesh::LocalIdentity(&rng); // create new random identity
}
static INA3221 INA_3221(TELEM_INA3221_ADDRESS, &Wire);
static INA219 INA_219(TELEM_INA219_ADDRESS, &Wire);
static Adafruit_AHTX0 AHTX;
bool PromicroSensorManager::begin() {
initINA3221();
initINA219();
initAHTX();
return true;
}
bool PromicroSensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) {
int nextAvalableChannel = TELEM_CHANNEL_SELF + 1;
if (requester_permissions & TELEM_PERM_ENVIRONMENT) {
if (INA3221initialized) {
for(int i = 0; i < 3; i++) {
// add only enabled INA3221 channels to telemetry
if (INA3221_CHANNEL_ENABLED[i]) {
telemetry.addVoltage(nextAvalableChannel, INA_3221.getBusVoltage(i));
telemetry.addCurrent(nextAvalableChannel, INA_3221.getCurrent(i));
telemetry.addPower(nextAvalableChannel, INA_3221.getPower(i));
nextAvalableChannel++;
}
}
}
if (INA219initialized) {
telemetry.addVoltage(nextAvalableChannel, INA_219.getBusVoltage());
telemetry.addCurrent(nextAvalableChannel, INA_219.getCurrent());
telemetry.addPower(nextAvalableChannel, INA_219.getPower());
nextAvalableChannel++;
}
if (AHTXinitialized) {
sensors_event_t humidity, temp;
AHTX.getEvent(&humidity, &temp);
telemetry.addTemperature(TELEM_CHANNEL_SELF, temp.temperature);
telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, humidity.relative_humidity);
}
}
return true;
}
int PromicroSensorManager::getNumSettings() const {
return NUM_SENSOR_SETTINGS;
}
const char* PromicroSensorManager::getSettingName(int i) const {
if (i >= 0 && i < NUM_SENSOR_SETTINGS) {
return INA3221_CHANNEL_NAMES[i];
}
return NULL;
}
const char* PromicroSensorManager::getSettingValue(int i) const {
if (i >= 0 && i < NUM_SENSOR_SETTINGS) {
return INA3221_CHANNEL_ENABLED[i] ? "1" : "0";
}
return NULL;
}
bool PromicroSensorManager::setSettingValue(const char* name, const char* value) {
for (int i = 0; i < NUM_SENSOR_SETTINGS; i++) {
if (strcmp(name, INA3221_CHANNEL_NAMES[i]) == 0) {
int channelEnabled = INA_3221.getEnableChannel(i);
if (strcmp(value, "1") == 0) {
INA3221_CHANNEL_ENABLED[i] = true;
if (!channelEnabled) {
INA_3221.enableChannel(i);
}
} else {
INA3221_CHANNEL_ENABLED[i] = false;
if (channelEnabled) {
INA_3221.disableChannel(i);
}
}
return true;
}
}
return false;
}
void PromicroSensorManager::initINA3221() {
if (INA_3221.begin()) {
MESH_DEBUG_PRINTLN("Found INA3221 at address: %02X", INA_3221.getAddress());
MESH_DEBUG_PRINTLN("%04X %04X %04X", INA_3221.getDieID(), INA_3221.getManufacturerID(), INA_3221.getConfiguration());
for(int i = 0; i < 3; i++) {
INA_3221.setShuntR(i, TELEM_INA3221_SHUNT_VALUE);
}
INA3221initialized = true;
} else {
INA3221initialized = false;
MESH_DEBUG_PRINTLN("INA3221 was not found at I2C address %02X", TELEM_INA3221_ADDRESS);
}
}
void PromicroSensorManager::initINA219() {
if (INA_219.begin()) {
MESH_DEBUG_PRINTLN("Found INA219 at address: %02X", INA_219.getAddress());
INA_219.setMaxCurrentShunt(TELEM_INA219_MAX_CURRENT, TELEM_INA219_SHUNT_VALUE);
INA219initialized = true;
} else {
INA219initialized = false;
MESH_DEBUG_PRINTLN("INA219 was not found at I2C address %02X", TELEM_INA219_ADDRESS);
}
}
void PromicroSensorManager::initAHTX() {
if (AHTX.begin(&Wire, 0, TELEM_AHTX_ADDRESS)) {
MESH_DEBUG_PRINTLN("Found AHT10/AHT20 at address: %02X", TELEM_AHTX_ADDRESS);
AHTXinitialized = true;
} else {
AHTXinitialized = false;
MESH_DEBUG_PRINTLN("AHT10/AHT20 was not found at I2C address %02X", TELEM_AHTX_ADDRESS);
}
}

View File

@@ -7,19 +7,16 @@
#include <helpers/CustomSX1262Wrapper.h>
#include <helpers/CustomLLCC68Wrapper.h>
#include <helpers/AutoDiscoverRTCClock.h>
#include <helpers/SensorManager.h>
#include <INA3221.h>
#include <INA219.h>
#include <Adafruit_AHTX0.h>
#ifdef DISPLAY_CLASS
#include <helpers/ui/SSD1306Display.h>
#endif
#define NUM_SENSOR_SETTINGS 3
#include <helpers/sensors/EnvironmentSensorManager.h>
extern PromicroBoard board;
extern WRAPPER_CLASS radio_driver;
extern AutoDiscoverRTCClock rtc_clock;
extern EnvironmentSensorManager sensors;
#ifdef DISPLAY_CLASS
extern DISPLAY_CLASS display;
@@ -31,39 +28,3 @@ void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr);
void radio_set_tx_power(uint8_t dbm);
mesh::LocalIdentity radio_new_identity();
#define TELEM_INA3221_ADDRESS 0x42 // INA3221 3 channel current sensor I2C address
#define TELEM_INA219_ADDRESS 0x40 // INA219 single channel current sensor I2C address
#define TELEM_AHTX_ADDRESS 0x38 // AHT10, AHT20 temperature and humidity sensor I2C address
#define TELEM_INA3221_SHUNT_VALUE 0.100 // most variants will have a 0.1 ohm shunts
#define TELEM_INA3221_SETTING_CH1 "INA3221-1"
#define TELEM_INA3221_SETTING_CH2 "INA3221-2"
#define TELEM_INA3221_SETTING_CH3 "INA3221-3"
#define TELEM_INA219_SHUNT_VALUE 0.100 // shunt value in ohms (may differ between manufacturers)
#define TELEM_INA219_MAX_CURRENT 5
class PromicroSensorManager: public SensorManager {
bool INA3221initialized = false;
bool INA219initialized = false;
bool AHTXinitialized = false;
// INA3221 channels in telemetry
const char * INA3221_CHANNEL_NAMES[NUM_SENSOR_SETTINGS] = { TELEM_INA3221_SETTING_CH1, TELEM_INA3221_SETTING_CH2, TELEM_INA3221_SETTING_CH3};
bool INA3221_CHANNEL_ENABLED[NUM_SENSOR_SETTINGS] = {true, true, true};
void initINA3221();
void initINA219();
void initAHTX();
public:
PromicroSensorManager(){};
bool begin() override;
bool querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) override;
int getNumSettings() const override;
const char* getSettingName(int i) const override;
const char* getSettingValue(int i) const override;
bool setSettingValue(const char* name, const char* value) override;
};
extern PromicroSensorManager sensors;