mirror of
https://github.com/meshtastic/firmware.git
synced 2025-12-22 02:32:23 +00:00
47524d58d7
* Update protos * Removed battery level from position packets * Send internal metrics * Handle telemetry on node info for now * Fixes * Default telemetry to enabled and same interval as position * Fixes for lots of interval issues * Fixed interval * Regen * Cleanup * Newline * Update proto ref * Fixed missing metric and updated power level to uint * Regen
277 lines
11 KiB
C++
277 lines
11 KiB
C++
#include "Telemetry.h"
|
|
#include "../mesh/generated/telemetry.pb.h"
|
|
#include "PowerFSM.h"
|
|
#include "MeshService.h"
|
|
#include "NodeDB.h"
|
|
#include "RTC.h"
|
|
#include "Router.h"
|
|
#include "configuration.h"
|
|
#include "main.h"
|
|
#include <OLEDDisplay.h>
|
|
#include <OLEDDisplayUi.h>
|
|
|
|
// Sensors
|
|
#include "Sensor/BME280Sensor.h"
|
|
#include "Sensor/BME680Sensor.h"
|
|
#include "Sensor/DHTSensor.h"
|
|
#include "Sensor/DallasSensor.h"
|
|
#include "Sensor/MCP9808Sensor.h"
|
|
|
|
BME280Sensor bme280Sensor;
|
|
BME680Sensor bme680Sensor;
|
|
DHTSensor dhtSensor;
|
|
DallasSensor dallasSensor;
|
|
MCP9808Sensor mcp9808Sensor;
|
|
|
|
#define FAILED_STATE_SENSOR_READ_MULTIPLIER 10
|
|
#define DISPLAY_RECEIVEID_MEASUREMENTS_ON_SCREEN true
|
|
|
|
#ifdef HAS_EINK
|
|
// The screen is bigger so use bigger fonts
|
|
#define FONT_SMALL ArialMT_Plain_16
|
|
#define FONT_MEDIUM ArialMT_Plain_24
|
|
#define FONT_LARGE ArialMT_Plain_24
|
|
#else
|
|
#define FONT_SMALL ArialMT_Plain_10
|
|
#define FONT_MEDIUM ArialMT_Plain_16
|
|
#define FONT_LARGE ArialMT_Plain_24
|
|
#endif
|
|
|
|
#define fontHeight(font) ((font)[1] + 1) // height is position 1
|
|
|
|
#define FONT_HEIGHT_SMALL fontHeight(FONT_SMALL)
|
|
#define FONT_HEIGHT_MEDIUM fontHeight(FONT_MEDIUM)
|
|
|
|
int32_t TelemetryModule::runOnce()
|
|
{
|
|
#ifndef PORTDUINO
|
|
/*
|
|
Uncomment the preferences below if you want to use the module
|
|
without having to configure it from the PythonAPI or WebUI.
|
|
*/
|
|
/*
|
|
radioConfig.preferences.telemetry_module_screen_enabled = 1;
|
|
radioConfig.preferences.telemetry_module_read_error_count_threshold = 5;
|
|
radioConfig.preferences.telemetry_module_update_interval = 600;
|
|
radioConfig.preferences.telemetry_module_recovery_interval = 60;
|
|
radioConfig.preferences.telemetry_module_sensor_pin = 13; // If one-wire
|
|
radioConfig.preferences.telemetry_module_sensor_type = RadioConfig_UserPreferences_TelemetrySensorType::RadioConfig_UserPreferences_TelemetrySensorType_BME280;
|
|
*/
|
|
|
|
if (firstTime) {
|
|
// This is the first time the OSThread library has called this function, so do some setup
|
|
firstTime = 0;
|
|
DEBUG_MSG("Telemetry: Initializing\n");
|
|
// therefore, we should only enable the sensor loop if measurement is also enabled
|
|
switch (radioConfig.preferences.telemetry_module_sensor_type) {
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT11:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT12:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT21:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT22:
|
|
dhtSensor.runOnce();
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DS18B20:
|
|
dallasSensor.runOnce();
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_BME280:
|
|
bme280Sensor.runOnce();
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_BME680:
|
|
bme680Sensor.runOnce();
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_MCP9808:
|
|
mcp9808Sensor.runOnce();
|
|
default:
|
|
DEBUG_MSG("Telemetry: No external sensor types selected;");
|
|
break;
|
|
}
|
|
} else {
|
|
// this is not the first time OSThread library has called this function
|
|
// so just do what we intend to do on the interval
|
|
if (sensor_read_error_count > radioConfig.preferences.telemetry_module_read_error_count_threshold) {
|
|
if (getPref_telemetry_module_update_interval() > 0) {
|
|
DEBUG_MSG("Telemetry: TEMPORARILY DISABLED; The "
|
|
"telemetry_module_read_error_count_threshold has been exceed: %d. Will retry reads in "
|
|
"%d seconds\n",
|
|
radioConfig.preferences.telemetry_module_read_error_count_threshold,
|
|
getPref_telemetry_module_update_interval());
|
|
sensor_read_error_count = 0;
|
|
return (getPref_telemetry_module_update_interval() * 1000);
|
|
}
|
|
DEBUG_MSG("Telemetry: DISABLED; The telemetry_module_read_error_count_threshold has "
|
|
"been exceed: %d. Reads will not be retried until after device reset\n",
|
|
radioConfig.preferences.telemetry_module_read_error_count_threshold);
|
|
return (INT32_MAX);
|
|
|
|
} else if (sensor_read_error_count > 0) {
|
|
DEBUG_MSG("Telemetry: There have been %d sensor read failures. Will retry %d more times\n",
|
|
sensor_read_error_count, sensor_read_error_count, sensor_read_error_count,
|
|
radioConfig.preferences.telemetry_module_read_error_count_threshold -
|
|
sensor_read_error_count);
|
|
}
|
|
sendOurTelemetry();
|
|
}
|
|
// OSThread library. Multiply the preference value by 1000 to convert seconds to miliseconds
|
|
return (getPref_telemetry_module_update_interval() * 1000);
|
|
#endif
|
|
}
|
|
|
|
bool TelemetryModule::wantUIFrame()
|
|
{
|
|
return radioConfig.preferences.telemetry_module_screen_enabled;
|
|
}
|
|
|
|
String GetSenderName(const MeshPacket &mp)
|
|
{
|
|
String sender;
|
|
|
|
auto node = nodeDB.getNode(getFrom(&mp));
|
|
if (node) {
|
|
sender = node->user.short_name;
|
|
} else {
|
|
sender = "UNK";
|
|
}
|
|
return sender;
|
|
}
|
|
|
|
uint32_t GetTimeSinceMeshPacket(const MeshPacket *mp)
|
|
{
|
|
uint32_t now = getTime();
|
|
|
|
uint32_t last_seen = mp->rx_time;
|
|
int delta = (int)(now - last_seen);
|
|
if (delta < 0) // our clock must be slightly off still - not set from GPS yet
|
|
delta = 0;
|
|
|
|
return delta;
|
|
}
|
|
|
|
float TelemetryModule::CelsiusToFahrenheit(float c)
|
|
{
|
|
return (c * 9) / 5 + 32;
|
|
}
|
|
|
|
void TelemetryModule::drawFrame(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y)
|
|
{
|
|
display->setTextAlignment(TEXT_ALIGN_LEFT);
|
|
display->setFont(FONT_MEDIUM);
|
|
display->drawString(x, y, "Environment");
|
|
if (lastMeasurementPacket == nullptr) {
|
|
display->setFont(FONT_SMALL);
|
|
display->drawString(x, y += fontHeight(FONT_MEDIUM), "No measurement");
|
|
return;
|
|
}
|
|
|
|
Telemetry lastMeasurement;
|
|
|
|
uint32_t agoSecs = GetTimeSinceMeshPacket(lastMeasurementPacket);
|
|
String lastSender = GetSenderName(*lastMeasurementPacket);
|
|
|
|
auto &p = lastMeasurementPacket->decoded;
|
|
if (!pb_decode_from_bytes(p.payload.bytes, p.payload.size, Telemetry_fields, &lastMeasurement)) {
|
|
display->setFont(FONT_SMALL);
|
|
display->drawString(x, y += fontHeight(FONT_MEDIUM), "Measurement Error");
|
|
DEBUG_MSG("Telemetry: unable to decode last packet");
|
|
return;
|
|
}
|
|
|
|
display->setFont(FONT_SMALL);
|
|
String last_temp = String(lastMeasurement.temperature, 0) + "°C";
|
|
if (radioConfig.preferences.telemetry_module_display_fahrenheit) {
|
|
last_temp = String(CelsiusToFahrenheit(lastMeasurement.temperature), 0) + "°F";
|
|
}
|
|
display->drawString(x, y += fontHeight(FONT_MEDIUM) - 2, "From: " + lastSender + "(" + String(agoSecs) + "s)");
|
|
display->drawString(x, y += fontHeight(FONT_SMALL) - 2,"Temp/Hum: " + last_temp + " / " + String(lastMeasurement.relative_humidity, 0) + "%");
|
|
if (lastMeasurement.barometric_pressure != 0)
|
|
display->drawString(x, y += fontHeight(FONT_SMALL),"Press: " + String(lastMeasurement.barometric_pressure, 0) + "hPA");
|
|
}
|
|
|
|
bool TelemetryModule::handleReceivedProtobuf(const MeshPacket &mp, Telemetry *t)
|
|
{
|
|
String sender = GetSenderName(mp);
|
|
|
|
DEBUG_MSG("-----------------------------------------\n");
|
|
DEBUG_MSG("Telemetry: Received data from %s\n", sender);
|
|
DEBUG_MSG("Telemetry->time: %i\n", t->time);
|
|
DEBUG_MSG("Telemetry->air_util_tx: %f\n", t->air_util_tx);
|
|
DEBUG_MSG("Telemetry->barometric_pressure: %f\n", t->barometric_pressure);
|
|
DEBUG_MSG("Telemetry->battery_level: %i\n", t->battery_level);
|
|
DEBUG_MSG("Telemetry->channel_utilization: %f\n", t->channel_utilization);
|
|
DEBUG_MSG("Telemetry->current: %f\n", t->current);
|
|
DEBUG_MSG("Telemetry->gas_resistance: %f\n", t->gas_resistance);
|
|
DEBUG_MSG("Telemetry->relative_humidity: %f\n", t->relative_humidity);
|
|
DEBUG_MSG("Telemetry->router_heartbeat: %i\n", t->router_heartbeat);
|
|
DEBUG_MSG("Telemetry->temperature: %f\n", t->temperature);
|
|
DEBUG_MSG("Telemetry->voltage: %f\n", t->voltage);
|
|
|
|
lastMeasurementPacket = packetPool.allocCopy(mp);
|
|
|
|
nodeDB.updateTelemetry(getFrom(&mp), *t, RX_SRC_RADIO);
|
|
|
|
return false; // Let others look at this message also if they want
|
|
}
|
|
|
|
bool TelemetryModule::sendOurTelemetry(NodeNum dest, bool wantReplies)
|
|
{
|
|
Telemetry m;
|
|
m.time = getTime();
|
|
|
|
m.air_util_tx = myNodeInfo.air_util_tx;
|
|
m.barometric_pressure = 0;
|
|
m.battery_level = powerStatus->getBatteryChargePercent();
|
|
m.channel_utilization = myNodeInfo.channel_utilization;
|
|
m.current = 0;
|
|
m.gas_resistance = 0;
|
|
m.relative_humidity = 0;
|
|
m.router_heartbeat = 0;
|
|
m.temperature = 0;
|
|
m.voltage = 0;
|
|
|
|
DEBUG_MSG("-----------------------------------------\n");
|
|
DEBUG_MSG("Telemetry: Read data\n");
|
|
|
|
switch (radioConfig.preferences.telemetry_module_sensor_type) {
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DS18B20:
|
|
if (!dallasSensor.getMeasurement(&m))
|
|
sensor_read_error_count++;
|
|
break;
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT11:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT12:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT21:
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_DHT22:
|
|
if (!dhtSensor.getMeasurement(&m))
|
|
sensor_read_error_count++;
|
|
break;
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_BME280:
|
|
bme280Sensor.getMeasurement(&m);
|
|
break;
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_BME680:
|
|
bme680Sensor.getMeasurement(&m);
|
|
break;
|
|
case RadioConfig_UserPreferences_TelemetrySensorType_MCP9808:
|
|
mcp9808Sensor.getMeasurement(&m);
|
|
break;
|
|
default:
|
|
DEBUG_MSG("Telemetry: No external sensor type selected; Only sending internal metrics\n");
|
|
}
|
|
|
|
DEBUG_MSG("Telemetry->time: %i\n", m.time);
|
|
DEBUG_MSG("Telemetry->air_util_tx: %f\n", m.air_util_tx);
|
|
DEBUG_MSG("Telemetry->barometric_pressure: %f\n", m.barometric_pressure);
|
|
DEBUG_MSG("Telemetry->battery_level: %i\n", m.battery_level);
|
|
DEBUG_MSG("Telemetry->channel_utilization: %f\n", m.channel_utilization);
|
|
DEBUG_MSG("Telemetry->current: %f\n", m.current);
|
|
DEBUG_MSG("Telemetry->gas_resistance: %f\n", m.gas_resistance);
|
|
DEBUG_MSG("Telemetry->relative_humidity: %f\n", m.relative_humidity);
|
|
DEBUG_MSG("Telemetry->router_heartbeat: %f\n", m.router_heartbeat);
|
|
DEBUG_MSG("Telemetry->temperature: %f\n", m.temperature);
|
|
DEBUG_MSG("Telemetry->voltage: %f\n", m.voltage);
|
|
|
|
sensor_read_error_count = 0;
|
|
|
|
MeshPacket *p = allocDataProtobuf(m);
|
|
p->to = dest;
|
|
p->decoded.want_response = wantReplies;
|
|
|
|
lastMeasurementPacket = packetPool.allocCopy(*p);
|
|
DEBUG_MSG("Telemetry: Sending packet to mesh");
|
|
service.sendToMesh(p);
|
|
return true;
|
|
}
|