diff --git a/.gitignore b/.gitignore index 89cc49c..fb3ca12 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .vscode/c_cpp_properties.json .vscode/launch.json .vscode/ipch +.vscode/settings.json diff --git a/data/tracker.json b/data/tracker.json index a940672..174af42 100644 --- a/data/tracker.json +++ b/data/tracker.json @@ -1,24 +1,29 @@ { - "callsign": "NOCALL-7", "debug": false, - "enhance_precision": true, - "beacon": { - "message": "LoRa Tracker", - "path": "WIDE1-1", - "timeout": 1, - "button_tx": false, - "symbol": "[", - "overlay": "/" - }, - "smart_beacon": { - "active": true, - "turn_min": 25, - "slow_rate": 300, - "slow_speed": 10, - "fast_rate": 60, - "fast_speed": 100, - "min_tx_dist": 100, - "min_bcn": 5 + "beacons": [ + { + "callsign": "NOCALL-7", + "path": "WIDE1-1", + "message": "LoRa Tracker", + "timeout": 1, + "symbol": "[", + "overlay": "/", + "smart_beacon": { + "active": true, + "turn_min": 25, + "slow_rate": 300, + "slow_speed": 10, + "fast_rate": 60, + "fast_speed": 100, + "min_tx_dist": 100, + "min_bcn": 5 + }, + "enhance_precision": true + } + ], + "button": { + "tx": true, + "alt_message": true }, "lora": { "frequency_rx": 433775000, diff --git a/platformio.ini b/platformio.ini index a1880c0..b761817 100644 --- a/platformio.ini +++ b/platformio.ini @@ -1,3 +1,5 @@ +[platformio] +default_envs = ttgo-t-beam-v1 [env] platform = espressif32 @ 3.0.0 diff --git a/src/BeaconManager.cpp b/src/BeaconManager.cpp new file mode 100644 index 0000000..97d537b --- /dev/null +++ b/src/BeaconManager.cpp @@ -0,0 +1,23 @@ +#include "BeaconManager.h" + +BeaconManager::BeaconManager() : _currentBeaconConfig(_beacon_config.end()) { +} + +// cppcheck-suppress unusedFunction +void BeaconManager::loadConfig(const std::list &beacon_config) { + _beacon_config = beacon_config; + _currentBeaconConfig = _beacon_config.begin(); +} + +// cppcheck-suppress unusedFunction +std::list::iterator BeaconManager::getCurrentBeaconConfig() const { + return _currentBeaconConfig; +} + +// cppcheck-suppress unusedFunction +void BeaconManager::loadNextBeacon() { + ++_currentBeaconConfig; + if (_currentBeaconConfig == _beacon_config.end()) { + _currentBeaconConfig = _beacon_config.begin(); + } +} diff --git a/src/BeaconManager.h b/src/BeaconManager.h new file mode 100644 index 0000000..702f499 --- /dev/null +++ b/src/BeaconManager.h @@ -0,0 +1,20 @@ +#ifndef BEACON_MANAGER_H_ +#define BEACON_MANAGER_H_ + +#include "configuration.h" + +class BeaconManager { +public: + BeaconManager(); + + void loadConfig(const std::list &beacon_config); + + std::list::iterator getCurrentBeaconConfig() const; + void loadNextBeacon(); + +private: + std::list _beacon_config; + std::list::iterator _currentBeaconConfig; +}; + +#endif diff --git a/src/LoRa_APRS_Tracker.cpp b/src/LoRa_APRS_Tracker.cpp index 6fa814c..361b82a 100644 --- a/src/LoRa_APRS_Tracker.cpp +++ b/src/LoRa_APRS_Tracker.cpp @@ -7,12 +7,14 @@ #include #include +#include "BeaconManager.h" #include "configuration.h" #include "display.h" #include "pins.h" #include "power_management.h" Configuration Config; +BeaconManager BeaconMan; PowerManagement powerManagement; OneButton userButton = OneButton(BUTTON_PIN, true, true); @@ -40,6 +42,11 @@ static void handle_tx_click() { send_update = true; } +static void handle_next_beacon() { + BeaconMan.loadNextBeacon(); + show_display(BeaconMan.getCurrentBeaconConfig()->callsign, BeaconMan.getCurrentBeaconConfig()->message, 2000); +} + // cppcheck-suppress unusedFunction void setup() { Serial.begin(115200); @@ -76,11 +83,15 @@ void setup() { WiFi.mode(WIFI_OFF); btStop(); - if (Config.beacon.button_tx) { + if (Config.button.tx) { // attach TX action to user button (defined by BUTTON_PIN) userButton.attachClick(handle_tx_click); } + if (Config.button.alt_message) { + userButton.attachLongPressStart(handle_next_beacon); + } + logPrintlnI("Smart Beacon is " + getSmartBeaconState()); show_display("INFO", "Smart Beacon is " + getSmartBeaconState(), 1000); logPrintlnI("setup done..."); @@ -118,13 +129,13 @@ void loop() { if (gps_loc_update && nextBeaconTimeStamp <= now()) { send_update = true; - if (Config.smart_beacon.active) { + if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) { currentHeading = gps.course.deg(); // enforce message text on slowest Config.smart_beacon.slow_rate rate_limit_message_text = 0; } else { // 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; } } @@ -151,7 +162,7 @@ void loop() { } #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; currentHeading = gps.course.deg(); lastTxdistance = TinyGPSPlus::distanceBetween(gps.location.lat(), gps.location.lng(), lastTxLat, lastTxLng); @@ -167,9 +178,9 @@ void loop() { // Get headings and heading delta 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 - 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; } } @@ -177,19 +188,20 @@ void loop() { } if (send_update && gps_loc_update) { - send_update = false; - nextBeaconTimeStamp = now() + (Config.smart_beacon.active ? Config.smart_beacon.slow_rate : (Config.beacon.timeout * SECS_PER_MIN)); + send_update = false; + + nextBeaconTimeStamp = now() + (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active ? BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_rate : (BeaconMan.getCurrentBeaconConfig()->timeout * SECS_PER_MIN)); APRSMessage msg; String lat; String lng; String dao; - msg.setSource(Config.callsign); + msg.setSource(BeaconMan.getCurrentBeaconConfig()->callsign); + msg.setPath(BeaconMan.getCurrentBeaconConfig()->path); 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()); lng = create_long_aprs(gps.location.rawLng()); } else { @@ -233,19 +245,19 @@ void loop() { } 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 // 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. // static rate 10 -> every third packet) if (!(rate_limit_message_text++ % 10)) { - aprsmsg += Config.beacon.message; + aprsmsg += BeaconMan.getCurrentBeaconConfig()->message; } if (BatteryIsConnected) { aprsmsg += " - _Bat.: " + batteryVoltage + "V - Cur.: " + batteryChargeCurrent + "mA"; } - if (Config.enhance_precision) { + if (BeaconMan.getCurrentBeaconConfig()->enhance_precision) { aprsmsg += " " + dao; } @@ -268,7 +280,7 @@ void loop() { LoRa.write((const uint8_t *)data.c_str(), data.length()); LoRa.endPacket(); - if (Config.smart_beacon.active) { + if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) { lastTxLat = gps.location.lat(); lastTxLng = gps.location.lng(); previousHeading = currentHeading; @@ -283,15 +295,16 @@ void loop() { } 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 int curr_speed = (int)gps.speed.kmph(); - if (curr_speed < Config.smart_beacon.slow_speed) { - txInterval = Config.smart_beacon.slow_rate * 1000; - } else if (curr_speed > Config.smart_beacon.fast_speed) { - txInterval = Config.smart_beacon.fast_rate * 1000; + if (curr_speed < BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_speed) { + txInterval = BeaconMan.getCurrentBeaconConfig()->smart_beacon.slow_rate * 1000; + } else if (curr_speed > BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_speed) { + txInterval = BeaconMan.getCurrentBeaconConfig()->smart_beacon.fast_rate * 1000; } else { /* Interval inbetween low and high 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 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() { ConfigurationManagement confmg("/tracker.json"); 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 " "upload it via \"Upload File System image\"!"); 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() { - if (Config.smart_beacon.active) { + if (BeaconMan.getCurrentBeaconConfig()->smart_beacon.active) { return "On"; } return "Off"; diff --git a/src/configuration.cpp b/src/configuration.cpp index 5077d3f..e69d263 100644 --- a/src/configuration.cpp +++ b/src/configuration.cpp @@ -33,30 +33,41 @@ Configuration ConfigurationManagement::readConfiguration() { file.close(); Configuration conf; - if (data.containsKey("callsign")) - conf.callsign = data["callsign"].as(); - 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(); - if (data.containsKey("beacon") && data["beacon"].containsKey("path")) - conf.beacon.path = data["beacon"]["path"].as(); - conf.beacon.timeout = data["beacon"]["timeout"] | 1; - if (data.containsKey("beacon") && data["beacon"].containsKey("symbol")) - conf.beacon.symbol = data["beacon"]["symbol"].as(); - if (data.containsKey("beacon") && data["beacon"].containsKey("overlay")) - conf.beacon.overlay = data["beacon"]["overlay"].as(); - 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.smart_beacon.turn_min = data["smart_beacon"]["turn_min"] | 25; - conf.smart_beacon.slow_rate = data["smart_beacon"]["slow_rate"] | 300; - conf.smart_beacon.slow_speed = data["smart_beacon"]["slow_speed"] | 10; - conf.smart_beacon.fast_rate = data["smart_beacon"]["fast_rate"] | 60; - conf.smart_beacon.fast_speed = data["smart_beacon"]["fast_speed"] | 100; - conf.smart_beacon.min_tx_dist = data["smart_beacon"]["min_tx_dist"] | 100; - conf.smart_beacon.min_bcn = data["smart_beacon"]["min_bcn"] | 5; + conf.debug = data["debug"] | false; + + JsonArray beacons = data["beacons"].as(); + for (JsonVariant v : beacons) { + Configuration::Beacon beacon; + + if (v.containsKey("callsign")) + beacon.callsign = v["callsign"].as(); + if (v.containsKey("path")) + beacon.path = v["path"].as(); + if (v.containsKey("message")) + beacon.message = v["message"].as(); + beacon.timeout = v["timeout"] | 1; + if (v.containsKey("symbol")) + beacon.symbol = v["symbol"].as(); + if (v.containsKey("overlay")) + beacon.overlay = v["overlay"].as(); + + 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.frequencyTx = data["lora"]["frequency_tx"] | 433775000; @@ -83,23 +94,32 @@ void ConfigurationManagement::writeConfiguration(Configuration conf) { } DynamicJsonDocument data(2048); - data["callsign"] = conf.callsign; - data["debug"] = conf.debug; - data["enhance_precision"] = conf.enhance_precision; - data["beacon"]["message"] = conf.beacon.message; - data["beacon"]["path"] = conf.beacon.path; - 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; + 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["button"]["tx"] = conf.button.tx; + data["button"]["alt_message"] = conf.button.alt_message; data["lora"]["frequency_rx"] = conf.lora.frequencyRx; data["lora"]["frequency_tx"] = conf.lora.frequencyTx; diff --git a/src/configuration.h b/src/configuration.h index 7196f59..c7dae47 100644 --- a/src/configuration.h +++ b/src/configuration.h @@ -1,6 +1,7 @@ #ifndef CONFIGURATION_H_ #define CONFIGURATION_H_ +#include #include #include @@ -9,30 +10,32 @@ class Configuration { public: class Beacon { public: - Beacon() : message("LoRa Tracker"), path("WIDE1-1"), timeout(1), symbol("["), overlay("/"), button_tx(false) { + class Smart_Beacon { + 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) { + } + + bool active; + int turn_min; + int slow_rate; + int slow_speed; + int fast_rate; + int fast_speed; + int min_tx_dist; + int min_bcn; + }; + + Beacon() : callsign("NOCALL-10"), path("WIDE1-1"), message("LoRa Tracker"), timeout(1), symbol("["), overlay("/"), enhance_precision(true) { } - String message; - String path; - int timeout; - String symbol; - String overlay; - bool button_tx; - }; - - class Smart_Beacon { - 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) { - } - - bool active; - int turn_min; - int slow_rate; - int slow_speed; - int fast_rate; - int fast_speed; - int min_tx_dist; - int min_bcn; + String callsign; + String path; + String message; + int timeout; + String symbol; + String overlay; + Smart_Beacon smart_beacon; + bool enhance_precision; }; class LoRa { @@ -60,15 +63,23 @@ public: bool reverse; }; - Configuration() : callsign("NOCALL-10"), debug(false), enhance_precision(true){}; + class Button { + public: + Button() : tx(false), alt_message(false) { + } - String callsign; - bool debug; - bool enhance_precision; - Beacon beacon; - Smart_Beacon smart_beacon; - LoRa lora; - PTT ptt; + bool tx; + int alt_message; + }; + + Configuration() : debug(false) { + } + + bool debug; + std::list beacons; + LoRa lora; + PTT ptt; + Button button; }; class ConfigurationManagement {