SensorMesh.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137
  1. #pragma once
  2. #include <Arduino.h> // needed for PlatformIO
  3. #include <Mesh.h>
  4. #include "TimeSeriesData.h"
  5. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  6. #include <InternalFileSystem.h>
  7. #elif defined(RP2040_PLATFORM)
  8. #include <LittleFS.h>
  9. #elif defined(ESP32)
  10. #include <SPIFFS.h>
  11. #endif
  12. #include <helpers/ArduinoHelpers.h>
  13. #include <helpers/StaticPoolPacketManager.h>
  14. #include <helpers/SimpleMeshTables.h>
  15. #include <helpers/IdentityStore.h>
  16. #include <helpers/AdvertDataHelpers.h>
  17. #include <helpers/TxtDataHelpers.h>
  18. #include <helpers/CommonCLI.h>
  19. #include <RTClib.h>
  20. #include <target.h>
  21. struct ContactInfo {
  22. mesh::Identity id;
  23. uint8_t type; // 1 = admin, 0 = guest
  24. uint8_t flags;
  25. int8_t out_path_len;
  26. uint8_t out_path[MAX_PATH_SIZE];
  27. uint8_t shared_secret[PUB_KEY_SIZE];
  28. uint32_t last_timestamp; // by THEIR clock (transient)
  29. uint32_t last_activity; // by OUR clock (transient)
  30. bool isAdmin() const { return type != 0; }
  31. };
  32. #ifndef FIRMWARE_BUILD_DATE
  33. #define FIRMWARE_BUILD_DATE "2 Jul 2025"
  34. #endif
  35. #ifndef FIRMWARE_VERSION
  36. #define FIRMWARE_VERSION "v1.7.2"
  37. #endif
  38. #define FIRMWARE_ROLE "sensor"
  39. #ifndef MAX_CONTACTS
  40. #define MAX_CONTACTS 32
  41. #endif
  42. #define MAX_SEARCH_RESULTS 8
  43. class SensorMesh : public mesh::Mesh, public CommonCLICallbacks {
  44. public:
  45. SensorMesh(mesh::MainBoard& board, mesh::Radio& radio, mesh::MillisecondClock& ms, mesh::RNG& rng, mesh::RTCClock& rtc, mesh::MeshTables& tables);
  46. void begin(FILESYSTEM* fs);
  47. CommonCLI* getCLI() { return &_cli; }
  48. void loop();
  49. // CommonCLI callbacks
  50. const char* getFirmwareVer() override { return FIRMWARE_VERSION; }
  51. const char* getBuildDate() override { return FIRMWARE_BUILD_DATE; }
  52. const char* getRole() override { return FIRMWARE_ROLE; }
  53. const char* getNodeName() { return _prefs.node_name; }
  54. NodePrefs* getNodePrefs() { return &_prefs; }
  55. void savePrefs() override { _cli.savePrefs(_fs); }
  56. bool formatFileSystem() override;
  57. void sendSelfAdvertisement(int delay_millis) override;
  58. void updateAdvertTimer() override;
  59. void updateFloodAdvertTimer() override;
  60. void setLoggingOn(bool enable) override { }
  61. void eraseLogFile() override { }
  62. void dumpLogFile() override { }
  63. void setTxPower(uint8_t power_dbm) override;
  64. void formatNeighborsReply(char *reply) override {
  65. strcpy(reply, "not supported");
  66. }
  67. const uint8_t* getSelfIdPubKey() override { return self_id.pub_key; }
  68. void clearStats() override { }
  69. protected:
  70. // telemetry data queries
  71. float getVoltage(uint8_t channel) { return 0.0f; } // TODO: extract from curr telemetry buffer
  72. // alerts
  73. struct Trigger {
  74. bool triggered;
  75. uint32_t time;
  76. Trigger() { triggered = false; time = 0; }
  77. };
  78. void alertIf(bool condition, Trigger& t, const char* text);
  79. virtual void onSensorDataRead() = 0; // for app to implement
  80. virtual int querySeriesData(uint32_t start_secs_ago, uint32_t end_secs_ago, MinMaxAvg dest[], int max_num) = 0; // for app to implement
  81. // Mesh overrides
  82. float getAirtimeBudgetFactor() const override;
  83. bool allowPacketForward(const mesh::Packet* packet) override;
  84. int calcRxDelay(float score, uint32_t air_time) const override;
  85. uint32_t getRetransmitDelay(const mesh::Packet* packet) override;
  86. uint32_t getDirectRetransmitDelay(const mesh::Packet* packet) override;
  87. int getInterferenceThreshold() const override;
  88. int getAGCResetInterval() const override;
  89. void onAnonDataRecv(mesh::Packet* packet, const uint8_t* secret, const mesh::Identity& sender, uint8_t* data, size_t len) override;
  90. int searchPeersByHash(const uint8_t* hash) override;
  91. void getPeerSharedSecret(uint8_t* dest_secret, int peer_idx) override;
  92. void onAdvertRecv(mesh::Packet* packet, const mesh::Identity& id, uint32_t timestamp, const uint8_t* app_data, size_t app_data_len) override;
  93. void onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender_idx, const uint8_t* secret, uint8_t* data, size_t len) override;
  94. bool onPeerPathRecv(mesh::Packet* packet, int sender_idx, const uint8_t* secret, uint8_t* path, uint8_t path_len, uint8_t extra_type, uint8_t* extra, uint8_t extra_len) override;
  95. private:
  96. FILESYSTEM* _fs;
  97. unsigned long next_local_advert, next_flood_advert;
  98. NodePrefs _prefs;
  99. CommonCLI _cli;
  100. uint8_t reply_data[MAX_PACKET_PAYLOAD];
  101. ContactInfo contacts[MAX_CONTACTS];
  102. int num_contacts;
  103. unsigned long dirty_contacts_expiry;
  104. CayenneLPP telemetry;
  105. uint32_t last_read_time;
  106. int matching_peer_indexes[MAX_SEARCH_RESULTS];
  107. void loadContacts();
  108. void saveContacts();
  109. uint8_t handleLoginReq(const mesh::Identity& sender, const uint8_t* secret, uint32_t sender_timestamp, const uint8_t* data);
  110. uint8_t handleRequest(bool is_admin, uint32_t sender_timestamp, uint8_t req_type, uint8_t* payload, size_t payload_len);
  111. mesh::Packet* createSelfAdvert();
  112. ContactInfo* putContact(const mesh::Identity& id);
  113. void sendAlert(const char* text);
  114. };