MyMesh.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. #pragma once
  2. #include <Arduino.h> // needed for PlatformIO
  3. #include <Mesh.h>
  4. #if defined(NRF52_PLATFORM)
  5. #include <InternalFileSystem.h>
  6. #elif defined(RP2040_PLATFORM)
  7. #include <LittleFS.h>
  8. #elif defined(ESP32)
  9. #include <SPIFFS.h>
  10. #endif
  11. #include <helpers/ArduinoHelpers.h>
  12. #include <helpers/StaticPoolPacketManager.h>
  13. #include <helpers/SimpleMeshTables.h>
  14. #include <helpers/IdentityStore.h>
  15. #include <helpers/AdvertDataHelpers.h>
  16. #include <helpers/TxtDataHelpers.h>
  17. #include <helpers/CommonCLI.h>
  18. #include <RTClib.h>
  19. #include <target.h>
  20. /* ------------------------------ Config -------------------------------- */
  21. #ifndef FIRMWARE_BUILD_DATE
  22. #define FIRMWARE_BUILD_DATE "1 Sep 2025"
  23. #endif
  24. #ifndef FIRMWARE_VERSION
  25. #define FIRMWARE_VERSION "v1.8.1"
  26. #endif
  27. #ifndef LORA_FREQ
  28. #define LORA_FREQ 915.0
  29. #endif
  30. #ifndef LORA_BW
  31. #define LORA_BW 250
  32. #endif
  33. #ifndef LORA_SF
  34. #define LORA_SF 10
  35. #endif
  36. #ifndef LORA_CR
  37. #define LORA_CR 5
  38. #endif
  39. #ifndef LORA_TX_POWER
  40. #define LORA_TX_POWER 20
  41. #endif
  42. #ifndef ADVERT_NAME
  43. #define ADVERT_NAME "Test BBS"
  44. #endif
  45. #ifndef ADVERT_LAT
  46. #define ADVERT_LAT 0.0
  47. #endif
  48. #ifndef ADVERT_LON
  49. #define ADVERT_LON 0.0
  50. #endif
  51. #ifndef ADMIN_PASSWORD
  52. #define ADMIN_PASSWORD "password"
  53. #endif
  54. #ifndef MAX_CLIENTS
  55. #define MAX_CLIENTS 32
  56. #endif
  57. #ifndef MAX_UNSYNCED_POSTS
  58. #define MAX_UNSYNCED_POSTS 32
  59. #endif
  60. #ifndef SERVER_RESPONSE_DELAY
  61. #define SERVER_RESPONSE_DELAY 300
  62. #endif
  63. #ifndef TXT_ACK_DELAY
  64. #define TXT_ACK_DELAY 200
  65. #endif
  66. #define FIRMWARE_ROLE "room_server"
  67. #define PACKET_LOG_FILE "/packet_log"
  68. enum RoomPermission {
  69. ADMIN,
  70. GUEST,
  71. READ_ONLY
  72. };
  73. struct ClientInfo {
  74. mesh::Identity id;
  75. uint32_t last_timestamp; // by THEIR clock
  76. uint32_t last_activity; // by OUR clock
  77. uint32_t sync_since; // sync messages SINCE this timestamp (by OUR clock)
  78. uint32_t pending_ack;
  79. uint32_t push_post_timestamp;
  80. unsigned long ack_timeout;
  81. RoomPermission permission;
  82. uint8_t push_failures;
  83. uint8_t secret[PUB_KEY_SIZE];
  84. int out_path_len;
  85. uint8_t out_path[MAX_PATH_SIZE];
  86. };
  87. #define MAX_POST_TEXT_LEN (160-9)
  88. struct PostInfo {
  89. mesh::Identity author;
  90. uint32_t post_timestamp; // by OUR clock
  91. char text[MAX_POST_TEXT_LEN+1];
  92. };
  93. class MyMesh : public mesh::Mesh, public CommonCLICallbacks {
  94. FILESYSTEM* _fs;
  95. unsigned long next_local_advert, next_flood_advert;
  96. bool _logging;
  97. NodePrefs _prefs;
  98. CommonCLI _cli;
  99. uint8_t reply_data[MAX_PACKET_PAYLOAD];
  100. int num_clients;
  101. ClientInfo known_clients[MAX_CLIENTS];
  102. unsigned long next_push;
  103. uint16_t _num_posted, _num_post_pushes;
  104. int next_client_idx; // for round-robin polling
  105. int next_post_idx;
  106. PostInfo posts[MAX_UNSYNCED_POSTS]; // cyclic queue
  107. CayenneLPP telemetry;
  108. unsigned long set_radio_at, revert_radio_at;
  109. float pending_freq;
  110. float pending_bw;
  111. uint8_t pending_sf;
  112. uint8_t pending_cr;
  113. int matching_peer_indexes[MAX_CLIENTS];
  114. ClientInfo* putClient(const mesh::Identity& id);
  115. void evict(ClientInfo* client);
  116. void addPost(ClientInfo* client, const char* postData);
  117. void pushPostToClient(ClientInfo* client, PostInfo& post);
  118. uint8_t getUnsyncedCount(ClientInfo* client);
  119. bool processAck(const uint8_t *data);
  120. mesh::Packet* createSelfAdvert();
  121. File openAppend(const char* fname);
  122. int handleRequest(ClientInfo* sender, uint32_t sender_timestamp, uint8_t* payload, size_t payload_len);
  123. protected:
  124. float getAirtimeBudgetFactor() const override {
  125. return _prefs.airtime_factor;
  126. }
  127. void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override;
  128. void logRx(mesh::Packet* pkt, int len, float score) override;
  129. void logTx(mesh::Packet* pkt, int len) override;
  130. void logTxFail(mesh::Packet* pkt, int len) override;
  131. int calcRxDelay(float score, uint32_t air_time) const override;
  132. const char* getLogDateTime() override;
  133. uint32_t getRetransmitDelay(const mesh::Packet* packet) override;
  134. uint32_t getDirectRetransmitDelay(const mesh::Packet* packet) override;
  135. int getInterferenceThreshold() const override {
  136. return _prefs.interference_threshold;
  137. }
  138. int getAGCResetInterval() const override {
  139. return ((int)_prefs.agc_reset_interval) * 4000; // milliseconds
  140. }
  141. uint8_t getExtraAckTransmitCount() const override {
  142. return _prefs.multi_acks;
  143. }
  144. bool allowPacketForward(const mesh::Packet* packet) override;
  145. void onAnonDataRecv(mesh::Packet* packet, const uint8_t* secret, const mesh::Identity& sender, uint8_t* data, size_t len) override;
  146. int searchPeersByHash(const uint8_t* hash) override ;
  147. void getPeerSharedSecret(uint8_t* dest_secret, int peer_idx) override;
  148. void onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender_idx, const uint8_t* secret, uint8_t* data, size_t len) override;
  149. 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;
  150. void onAckRecv(mesh::Packet* packet, uint32_t ack_crc) override;
  151. public:
  152. MyMesh(mesh::MainBoard& board, mesh::Radio& radio, mesh::MillisecondClock& ms, mesh::RNG& rng, mesh::RTCClock& rtc, mesh::MeshTables& tables);
  153. void begin(FILESYSTEM* fs);
  154. const char* getFirmwareVer() override { return FIRMWARE_VERSION; }
  155. const char* getBuildDate() override { return FIRMWARE_BUILD_DATE; }
  156. const char* getRole() override { return FIRMWARE_ROLE; }
  157. const char* getNodeName() { return _prefs.node_name; }
  158. NodePrefs* getNodePrefs() {
  159. return &_prefs;
  160. }
  161. void savePrefs() override {
  162. _cli.savePrefs(_fs);
  163. }
  164. void applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) override;
  165. bool formatFileSystem() override;
  166. void sendSelfAdvertisement(int delay_millis) override;
  167. void updateAdvertTimer() override;
  168. void updateFloodAdvertTimer() override;
  169. void setLoggingOn(bool enable) override { _logging = enable; }
  170. void eraseLogFile() override {
  171. _fs->remove(PACKET_LOG_FILE);
  172. }
  173. void dumpLogFile() override;
  174. void setTxPower(uint8_t power_dbm) override;
  175. void formatNeighborsReply(char *reply) override {
  176. strcpy(reply, "not supported");
  177. }
  178. mesh::LocalIdentity& getSelfId() override { return self_id; }
  179. void saveIdentity(const mesh::LocalIdentity& new_id) override;
  180. void clearStats() override;
  181. void handleCommand(uint32_t sender_timestamp, char* command, char* reply);
  182. void loop();
  183. };