Merge pull request #47 from tekk/alternative-messages

Added support for multiple alternative messages/callsigns
This commit is contained in:
Peter Buchegger 2021-12-19 23:44:42 +01:00 committed by GitHub
commit 64cfd3a0be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 209 additions and 113 deletions

1
.gitignore vendored
View file

@ -3,3 +3,4 @@
.vscode/c_cpp_properties.json .vscode/c_cpp_properties.json
.vscode/launch.json .vscode/launch.json
.vscode/ipch .vscode/ipch
.vscode/settings.json

View file

@ -1,15 +1,13 @@
{ {
"callsign": "NOCALL-7",
"debug": false, "debug": false,
"enhance_precision": true, "beacons": [
"beacon": { {
"message": "LoRa Tracker", "callsign": "NOCALL-7",
"path": "WIDE1-1", "path": "WIDE1-1",
"message": "LoRa Tracker",
"timeout": 1, "timeout": 1,
"button_tx": false,
"symbol": "[", "symbol": "[",
"overlay": "/" "overlay": "/",
},
"smart_beacon": { "smart_beacon": {
"active": true, "active": true,
"turn_min": 25, "turn_min": 25,
@ -20,6 +18,13 @@
"min_tx_dist": 100, "min_tx_dist": 100,
"min_bcn": 5 "min_bcn": 5
}, },
"enhance_precision": true
}
],
"button": {
"tx": true,
"alt_message": true
},
"lora": { "lora": {
"frequency_rx": 433775000, "frequency_rx": 433775000,
"frequency_tx": 433775000, "frequency_tx": 433775000,

View file

@ -1,3 +1,5 @@
[platformio]
default_envs = ttgo-t-beam-v1
[env] [env]
platform = espressif32 @ 3.0.0 platform = espressif32 @ 3.0.0

23
src/BeaconManager.cpp Normal file
View file

@ -0,0 +1,23 @@
#include "BeaconManager.h"
BeaconManager::BeaconManager() : _currentBeaconConfig(_beacon_config.end()) {
}
// cppcheck-suppress unusedFunction
void BeaconManager::loadConfig(const std::list<Configuration::Beacon> &beacon_config) {
_beacon_config = beacon_config;
_currentBeaconConfig = _beacon_config.begin();
}
// cppcheck-suppress unusedFunction
std::list<Configuration::Beacon>::iterator BeaconManager::getCurrentBeaconConfig() const {
return _currentBeaconConfig;
}
// cppcheck-suppress unusedFunction
void BeaconManager::loadNextBeacon() {
++_currentBeaconConfig;
if (_currentBeaconConfig == _beacon_config.end()) {
_currentBeaconConfig = _beacon_config.begin();
}
}

20
src/BeaconManager.h Normal file
View file

@ -0,0 +1,20 @@
#ifndef BEACON_MANAGER_H_
#define BEACON_MANAGER_H_
#include "configuration.h"
class BeaconManager {
public:
BeaconManager();
void loadConfig(const std::list<Configuration::Beacon> &beacon_config);
std::list<Configuration::Beacon>::iterator getCurrentBeaconConfig() const;
void loadNextBeacon();
private:
std::list<Configuration::Beacon> _beacon_config;
std::list<Configuration::Beacon>::iterator _currentBeaconConfig;
};
#endif

View file

@ -7,12 +7,14 @@
#include <WiFi.h> #include <WiFi.h>
#include <logger.h> #include <logger.h>
#include "BeaconManager.h"
#include "configuration.h" #include "configuration.h"
#include "display.h" #include "display.h"
#include "pins.h" #include "pins.h"
#include "power_management.h" #include "power_management.h"
Configuration Config; Configuration Config;
BeaconManager BeaconMan;
PowerManagement powerManagement; PowerManagement powerManagement;
OneButton userButton = OneButton(BUTTON_PIN, true, true); OneButton userButton = OneButton(BUTTON_PIN, true, true);
@ -40,6 +42,11 @@ static void handle_tx_click() {
send_update = true; send_update = true;
} }
static void handle_next_beacon() {
BeaconMan.loadNextBeacon();
show_display(BeaconMan.getCurrentBeaconConfig()->callsign, BeaconMan.getCurrentBeaconConfig()->message, 2000);
}
// cppcheck-suppress unusedFunction // cppcheck-suppress unusedFunction
void setup() { void setup() {
Serial.begin(115200); Serial.begin(115200);
@ -76,11 +83,15 @@ void setup() {
WiFi.mode(WIFI_OFF); WiFi.mode(WIFI_OFF);
btStop(); btStop();
if (Config.beacon.button_tx) { if (Config.button.tx) {
// attach TX action to user button (defined by BUTTON_PIN) // attach TX action to user button (defined by BUTTON_PIN)
userButton.attachClick(handle_tx_click); userButton.attachClick(handle_tx_click);
} }
if (Config.button.alt_message) {
userButton.attachLongPressStart(handle_next_beacon);
}
logPrintlnI("Smart Beacon is " + getSmartBeaconState()); logPrintlnI("Smart Beacon is " + getSmartBeaconState());
show_display("INFO", "Smart Beacon is " + getSmartBeaconState(), 1000); show_display("INFO", "Smart Beacon is " + getSmartBeaconState(), 1000);
logPrintlnI("setup done..."); logPrintlnI("setup done...");
@ -118,13 +129,13 @@ void loop() {
if (gps_loc_update && nextBeaconTimeStamp <= now()) { if (gps_loc_update && nextBeaconTimeStamp <= now()) {
send_update = true; send_update = true;
if (Config.smart_beacon.active) { if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) {
currentHeading = gps.course.deg(); currentHeading = gps.course.deg();
// enforce message text on slowest Config.smart_beacon.slow_rate // enforce message text on slowest Config.smart_beacon.slow_rate
rate_limit_message_text = 0; rate_limit_message_text = 0;
} else { } else {
// enforce message text every n's Config.beacon.timeout frame // enforce message text every n's Config.beacon.timeout frame
if (Config.beacon.timeout * rate_limit_message_text > 30) { if (BeaconMan.getCurrentBeaconConfig()->timeout * rate_limit_message_text > 30) {
rate_limit_message_text = 0; rate_limit_message_text = 0;
} }
} }
@ -151,7 +162,7 @@ void loop() {
} }
#endif #endif
if (!send_update && gps_loc_update && Config.smart_beacon.active) { if (!send_update && gps_loc_update && BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) {
uint32_t lastTx = millis() - lastTxTime; uint32_t lastTx = millis() - lastTxTime;
currentHeading = gps.course.deg(); currentHeading = gps.course.deg();
lastTxdistance = TinyGPSPlus::distanceBetween(gps.location.lat(), gps.location.lng(), lastTxLat, lastTxLng); lastTxdistance = TinyGPSPlus::distanceBetween(gps.location.lat(), gps.location.lng(), lastTxLat, lastTxLng);
@ -167,9 +178,9 @@ void loop() {
// Get headings and heading delta // Get headings and heading delta
double headingDelta = abs(previousHeading - currentHeading); double headingDelta = abs(previousHeading - currentHeading);
if (lastTx > Config.smart_beacon.min_bcn * 1000) { if (lastTx > BeaconMan.getCurrentBeaconConfig()->smart_beacon.min_bcn * 1000) {
// Check for heading more than 25 degrees // Check for heading more than 25 degrees
if (headingDelta > Config.smart_beacon.turn_min && lastTxdistance > Config.smart_beacon.min_tx_dist) { if (headingDelta > BeaconMan.getCurrentBeaconConfig()->smart_beacon.turn_min && lastTxdistance > BeaconMan.getCurrentBeaconConfig()->smart_beacon.min_tx_dist) {
send_update = true; send_update = true;
} }
} }
@ -178,18 +189,19 @@ void loop() {
if (send_update && gps_loc_update) { if (send_update && gps_loc_update) {
send_update = false; send_update = false;
nextBeaconTimeStamp = now() + (Config.smart_beacon.active ? Config.smart_beacon.slow_rate : (Config.beacon.timeout * SECS_PER_MIN));
nextBeaconTimeStamp = now() + (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active ? BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_rate : (BeaconMan.getCurrentBeaconConfig()->timeout * SECS_PER_MIN));
APRSMessage msg; APRSMessage msg;
String lat; String lat;
String lng; String lng;
String dao; String dao;
msg.setSource(Config.callsign); msg.setSource(BeaconMan.getCurrentBeaconConfig()->callsign);
msg.setPath(BeaconMan.getCurrentBeaconConfig()->path);
msg.setDestination("APLT00-1"); msg.setDestination("APLT00-1");
msg.setPath(Config.beacon.path);
if (!Config.enhance_precision) { if (!BeaconMan.getCurrentBeaconConfig()->enhance_precision) {
lat = create_lat_aprs(gps.location.rawLat()); lat = create_lat_aprs(gps.location.rawLat());
lng = create_long_aprs(gps.location.rawLng()); lng = create_long_aprs(gps.location.rawLng());
} else { } else {
@ -233,19 +245,19 @@ void loop() {
} }
String aprsmsg; String aprsmsg;
aprsmsg = "!" + lat + Config.beacon.overlay + lng + Config.beacon.symbol + course_and_speed + alt; aprsmsg = "!" + lat + BeaconMan.getCurrentBeaconConfig()->overlay + lng + BeaconMan.getCurrentBeaconConfig()->symbol + course_and_speed + alt;
// message_text every 10's packet (i.e. if we have beacon rate 1min at high // message_text every 10's packet (i.e. if we have beacon rate 1min at high
// speed -> every 10min). May be enforced above (at expirey of smart beacon // speed -> every 10min). May be enforced above (at expirey of smart beacon
// rate (i.e. every 30min), or every third packet on static rate (i.e. // rate (i.e. every 30min), or every third packet on static rate (i.e.
// static rate 10 -> every third packet) // static rate 10 -> every third packet)
if (!(rate_limit_message_text++ % 10)) { if (!(rate_limit_message_text++ % 10)) {
aprsmsg += Config.beacon.message; aprsmsg += BeaconMan.getCurrentBeaconConfig()->message;
} }
if (BatteryIsConnected) { if (BatteryIsConnected) {
aprsmsg += " - _Bat.: " + batteryVoltage + "V - Cur.: " + batteryChargeCurrent + "mA"; aprsmsg += " - _Bat.: " + batteryVoltage + "V - Cur.: " + batteryChargeCurrent + "mA";
} }
if (Config.enhance_precision) { if (BeaconMan.getCurrentBeaconConfig()->enhance_precision) {
aprsmsg += " " + dao; aprsmsg += " " + dao;
} }
@ -268,7 +280,7 @@ void loop() {
LoRa.write((const uint8_t *)data.c_str(), data.length()); LoRa.write((const uint8_t *)data.c_str(), data.length());
LoRa.endPacket(); LoRa.endPacket();
if (Config.smart_beacon.active) { if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) {
lastTxLat = gps.location.lat(); lastTxLat = gps.location.lat();
lastTxLng = gps.location.lng(); lastTxLng = gps.location.lng();
previousHeading = currentHeading; previousHeading = currentHeading;
@ -283,15 +295,16 @@ void loop() {
} }
if (gps_time_update) { if (gps_time_update) {
show_display(Config.callsign, createDateString(now()) + " " + createTimeString(now()), String("Sats: ") + gps.satellites.value() + " HDOP: " + gps.hdop.hdop(), String("Nxt Bcn: ") + (Config.smart_beacon.active ? "~" : "") + createTimeString(nextBeaconTimeStamp), BatteryIsConnected ? (String("Bat: ") + batteryVoltage + "V, " + batteryChargeCurrent + "mA") : "Powered via USB", String("Smart Beacon: " + getSmartBeaconState()));
if (Config.smart_beacon.active) { show_display(BeaconMan.getCurrentBeaconConfig()->callsign, createDateString(now()) + " " + createTimeString(now()), String("Sats: ") + gps.satellites.value() + " HDOP: " + gps.hdop.hdop(), String("Nxt Bcn: ") + (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active ? "~" : "") + createTimeString(nextBeaconTimeStamp), BatteryIsConnected ? (String("Bat: ") + batteryVoltage + "V, " + batteryChargeCurrent + "mA") : "Powered via USB", String("Smart Beacon: " + getSmartBeaconState()));
if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) {
// Change the Tx internal based on the current speed // Change the Tx internal based on the current speed
int curr_speed = (int)gps.speed.kmph(); int curr_speed = (int)gps.speed.kmph();
if (curr_speed < Config.smart_beacon.slow_speed) { if (curr_speed < BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_speed) {
txInterval = Config.smart_beacon.slow_rate * 1000; txInterval = BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_rate * 1000;
} else if (curr_speed > Config.smart_beacon.fast_speed) { } else if (curr_speed > BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_speed) {
txInterval = Config.smart_beacon.fast_rate * 1000; txInterval = BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_rate * 1000;
} else { } else {
/* Interval inbetween low and high speed /* Interval inbetween low and high speed
min(slow_rate, ..) because: if slow rate is 300s at slow speed <= min(slow_rate, ..) because: if slow rate is 300s at slow speed <=
@ -303,7 +316,7 @@ void loop() {
would lead to decrease of beacon rate in between 5 to 20 km/h. what would lead to decrease of beacon rate in between 5 to 20 km/h. what
is even below the slow speed rate. is even below the slow speed rate.
*/ */
txInterval = min(Config.smart_beacon.slow_rate, Config.smart_beacon.fast_speed * Config.smart_beacon.fast_rate / curr_speed) * 1000; txInterval = min(BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_rate, BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_speed * BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_rate / curr_speed) * 1000;
} }
} }
} }
@ -318,7 +331,8 @@ void loop() {
void load_config() { void load_config() {
ConfigurationManagement confmg("/tracker.json"); ConfigurationManagement confmg("/tracker.json");
Config = confmg.readConfiguration(); Config = confmg.readConfiguration();
if (Config.callsign == "NOCALL-10") { BeaconMan.loadConfig(Config.beacons);
if (BeaconMan.getCurrentBeaconConfig()->callsign == "NOCALL-10") {
logPrintlnE("You have to change your settings in 'data/tracker.json' and " logPrintlnE("You have to change your settings in 'data/tracker.json' and "
"upload it via \"Upload File System image\"!"); "upload it via \"Upload File System image\"!");
show_display("ERROR", "You have to change your settings in 'data/tracker.json' and " show_display("ERROR", "You have to change your settings in 'data/tracker.json' and "
@ -463,7 +477,7 @@ String createTimeString(time_t t) {
} }
String getSmartBeaconState() { String getSmartBeaconState() {
if (Config.smart_beacon.active) { if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) {
return "On"; return "On";
} }
return "Off"; return "Off";

View file

@ -33,30 +33,41 @@ Configuration ConfigurationManagement::readConfiguration() {
file.close(); file.close();
Configuration conf; Configuration conf;
if (data.containsKey("callsign"))
conf.callsign = data["callsign"].as<String>();
conf.debug = data["debug"] | false;
conf.enhance_precision = data["enhance_precision"] | false;
if (data.containsKey("beacon") && data["beacon"].containsKey("message"))
conf.beacon.message = data["beacon"]["message"].as<String>();
if (data.containsKey("beacon") && data["beacon"].containsKey("path"))
conf.beacon.path = data["beacon"]["path"].as<String>();
conf.beacon.timeout = data["beacon"]["timeout"] | 1;
if (data.containsKey("beacon") && data["beacon"].containsKey("symbol"))
conf.beacon.symbol = data["beacon"]["symbol"].as<String>();
if (data.containsKey("beacon") && data["beacon"].containsKey("overlay"))
conf.beacon.overlay = data["beacon"]["overlay"].as<String>();
if (data.containsKey("beacon") && data["beacon"].containsKey("button_tx"))
conf.beacon.button_tx = data["beacon"]["button_tx"] | false;
conf.smart_beacon.active = data["smart_beacon"]["active"] | false; conf.debug = data["debug"] | false;
conf.smart_beacon.turn_min = data["smart_beacon"]["turn_min"] | 25;
conf.smart_beacon.slow_rate = data["smart_beacon"]["slow_rate"] | 300; JsonArray beacons = data["beacons"].as<JsonArray>();
conf.smart_beacon.slow_speed = data["smart_beacon"]["slow_speed"] | 10; for (JsonVariant v : beacons) {
conf.smart_beacon.fast_rate = data["smart_beacon"]["fast_rate"] | 60; Configuration::Beacon beacon;
conf.smart_beacon.fast_speed = data["smart_beacon"]["fast_speed"] | 100;
conf.smart_beacon.min_tx_dist = data["smart_beacon"]["min_tx_dist"] | 100; if (v.containsKey("callsign"))
conf.smart_beacon.min_bcn = data["smart_beacon"]["min_bcn"] | 5; beacon.callsign = v["callsign"].as<String>();
if (v.containsKey("path"))
beacon.path = v["path"].as<String>();
if (v.containsKey("message"))
beacon.message = v["message"].as<String>();
beacon.timeout = v["timeout"] | 1;
if (v.containsKey("symbol"))
beacon.symbol = v["symbol"].as<String>();
if (v.containsKey("overlay"))
beacon.overlay = v["overlay"].as<String>();
beacon.smart_beacon.active = v["smart_beacon"]["active"] | false;
beacon.smart_beacon.turn_min = v["smart_beacon"]["turn_min"] | 25;
beacon.smart_beacon.slow_rate = v["smart_beacon"]["slow_rate"] | 300;
beacon.smart_beacon.slow_speed = v["smart_beacon"]["slow_speed"] | 10;
beacon.smart_beacon.fast_rate = v["smart_beacon"]["fast_rate"] | 60;
beacon.smart_beacon.fast_speed = v["smart_beacon"]["fast_speed"] | 100;
beacon.smart_beacon.min_tx_dist = v["smart_beacon"]["min_tx_dist"] | 100;
beacon.smart_beacon.min_bcn = v["smart_beacon"]["min_bcn"] | 5;
beacon.enhance_precision = v["enhance_precision"] | false;
conf.beacons.push_back(beacon);
}
conf.button.tx = data["button"]["tx"] | false;
conf.button.alt_message = data["button"]["alt_message"] | false;
conf.lora.frequencyRx = data["lora"]["frequency_rx"] | 433775000; conf.lora.frequencyRx = data["lora"]["frequency_rx"] | 433775000;
conf.lora.frequencyTx = data["lora"]["frequency_tx"] | 433775000; conf.lora.frequencyTx = data["lora"]["frequency_tx"] | 433775000;
@ -83,23 +94,32 @@ void ConfigurationManagement::writeConfiguration(Configuration conf) {
} }
DynamicJsonDocument data(2048); DynamicJsonDocument data(2048);
data["callsign"] = conf.callsign; JsonArray beacons = data.createNestedArray("beacons");
for (Configuration::Beacon beacon : conf.beacons) {
JsonObject v = beacons.createNestedObject();
v["callsign"] = beacon.callsign;
v["path"] = beacon.path;
v["message"] = beacon.message;
v["timeout"] = beacon.timeout;
v["symbol"] = beacon.symbol;
v["overlay"] = beacon.overlay;
v["smart_beacon"]["active"] = beacon.smart_beacon.active;
v["smart_beacon"]["turn_min"] = beacon.smart_beacon.turn_min;
v["smart_beacon"]["slow_rate"] = beacon.smart_beacon.slow_rate;
v["smart_beacon"]["slow_speed"] = beacon.smart_beacon.slow_speed;
v["smart_beacon"]["fast_rate"] = beacon.smart_beacon.fast_rate;
v["smart_beacon"]["fast_speed"] = beacon.smart_beacon.fast_speed;
v["smart_beacon"]["min_tx_dist"] = beacon.smart_beacon.min_tx_dist;
v["smart_beacon"]["min_bcn"] = beacon.smart_beacon.min_bcn;
v["enhance_precision"] = beacon.enhance_precision;
}
data["debug"] = conf.debug; data["debug"] = conf.debug;
data["enhance_precision"] = conf.enhance_precision;
data["beacon"]["message"] = conf.beacon.message; data["button"]["tx"] = conf.button.tx;
data["beacon"]["path"] = conf.beacon.path; data["button"]["alt_message"] = conf.button.alt_message;
data["beacon"]["timeout"] = conf.beacon.timeout;
data["beacon"]["symbol"] = conf.beacon.symbol;
data["beacon"]["overlay"] = conf.beacon.overlay;
data["beacon"]["button_tx"] = conf.beacon.button_tx;
data["smart_beacon"]["active"] = conf.smart_beacon.active;
data["smart_beacon"]["turn_min"] = conf.smart_beacon.turn_min;
data["smart_beacon"]["slow_rate"] = conf.smart_beacon.slow_rate;
data["smart_beacon"]["slow_speed"] = conf.smart_beacon.slow_speed;
data["smart_beacon"]["fast_rate"] = conf.smart_beacon.fast_rate;
data["smart_beacon"]["fast_speed"] = conf.smart_beacon.fast_speed;
data["smart_beacon"]["min_tx_dist"] = conf.smart_beacon.min_tx_dist;
data["smart_beacon"]["min_bcn"] = conf.smart_beacon.min_bcn;
data["lora"]["frequency_rx"] = conf.lora.frequencyRx; data["lora"]["frequency_rx"] = conf.lora.frequencyRx;
data["lora"]["frequency_tx"] = conf.lora.frequencyTx; data["lora"]["frequency_tx"] = conf.lora.frequencyTx;

View file

@ -1,6 +1,7 @@
#ifndef CONFIGURATION_H_ #ifndef CONFIGURATION_H_
#define CONFIGURATION_H_ #define CONFIGURATION_H_
#include <iterator>
#include <list> #include <list>
#include <Arduino.h> #include <Arduino.h>
@ -9,17 +10,6 @@ class Configuration {
public: public:
class Beacon { class Beacon {
public: public:
Beacon() : message("LoRa Tracker"), path("WIDE1-1"), timeout(1), symbol("["), overlay("/"), button_tx(false) {
}
String message;
String path;
int timeout;
String symbol;
String overlay;
bool button_tx;
};
class Smart_Beacon { class Smart_Beacon {
public: public:
Smart_Beacon() : active(false), turn_min(25), slow_rate(300), slow_speed(10), fast_rate(60), fast_speed(100), min_tx_dist(100), min_bcn(5) { Smart_Beacon() : active(false), turn_min(25), slow_rate(300), slow_speed(10), fast_rate(60), fast_speed(100), min_tx_dist(100), min_bcn(5) {
@ -35,6 +25,19 @@ public:
int min_bcn; int min_bcn;
}; };
Beacon() : callsign("NOCALL-10"), path("WIDE1-1"), message("LoRa Tracker"), timeout(1), symbol("["), overlay("/"), enhance_precision(true) {
}
String callsign;
String path;
String message;
int timeout;
String symbol;
String overlay;
Smart_Beacon smart_beacon;
bool enhance_precision;
};
class LoRa { class LoRa {
public: public:
LoRa() : frequencyRx(433775000), frequencyTx(433775000), power(20), spreadingFactor(12), signalBandwidth(125000), codingRate4(5) { LoRa() : frequencyRx(433775000), frequencyTx(433775000), power(20), spreadingFactor(12), signalBandwidth(125000), codingRate4(5) {
@ -60,15 +63,23 @@ public:
bool reverse; bool reverse;
}; };
Configuration() : callsign("NOCALL-10"), debug(false), enhance_precision(true){}; class Button {
public:
Button() : tx(false), alt_message(false) {
}
bool tx;
int alt_message;
};
Configuration() : debug(false) {
}
String callsign;
bool debug; bool debug;
bool enhance_precision; std::list<Beacon> beacons;
Beacon beacon;
Smart_Beacon smart_beacon;
LoRa lora; LoRa lora;
PTT ptt; PTT ptt;
Button button;
}; };
class ConfigurationManagement { class ConfigurationManagement {