MyMesh.cpp 72 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979
  1. #include "MyMesh.h"
  2. #include <Arduino.h> // needed for PlatformIO
  3. #include <Mesh.h>
  4. #define CMD_APP_START 1
  5. #define CMD_SEND_TXT_MSG 2
  6. #define CMD_SEND_CHANNEL_TXT_MSG 3
  7. #define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync)
  8. #define CMD_GET_DEVICE_TIME 5
  9. #define CMD_SET_DEVICE_TIME 6
  10. #define CMD_SEND_SELF_ADVERT 7
  11. #define CMD_SET_ADVERT_NAME 8
  12. #define CMD_ADD_UPDATE_CONTACT 9
  13. #define CMD_SYNC_NEXT_MESSAGE 10
  14. #define CMD_SET_RADIO_PARAMS 11
  15. #define CMD_SET_RADIO_TX_POWER 12
  16. #define CMD_RESET_PATH 13
  17. #define CMD_SET_ADVERT_LATLON 14
  18. #define CMD_REMOVE_CONTACT 15
  19. #define CMD_SHARE_CONTACT 16
  20. #define CMD_EXPORT_CONTACT 17
  21. #define CMD_IMPORT_CONTACT 18
  22. #define CMD_REBOOT 19
  23. #define CMD_GET_BATT_AND_STORAGE 20 // was CMD_GET_BATTERY_VOLTAGE
  24. #define CMD_SET_TUNING_PARAMS 21
  25. #define CMD_DEVICE_QEURY 22
  26. #define CMD_EXPORT_PRIVATE_KEY 23
  27. #define CMD_IMPORT_PRIVATE_KEY 24
  28. #define CMD_SEND_RAW_DATA 25
  29. #define CMD_SEND_LOGIN 26
  30. #define CMD_SEND_STATUS_REQ 27
  31. #define CMD_HAS_CONNECTION 28
  32. #define CMD_LOGOUT 29 // 'Disconnect'
  33. #define CMD_GET_CONTACT_BY_KEY 30
  34. #define CMD_GET_CHANNEL 31
  35. #define CMD_SET_CHANNEL 32
  36. #define CMD_SIGN_START 33
  37. #define CMD_SIGN_DATA 34
  38. #define CMD_SIGN_FINISH 35
  39. #define CMD_SEND_TRACE_PATH 36
  40. #define CMD_SET_DEVICE_PIN 37
  41. #define CMD_SET_OTHER_PARAMS 38
  42. #define CMD_SEND_TELEMETRY_REQ 39 // can deprecate this
  43. #define CMD_GET_CUSTOM_VARS 40
  44. #define CMD_SET_CUSTOM_VAR 41
  45. #define CMD_GET_ADVERT_PATH 42
  46. #define CMD_GET_TUNING_PARAMS 43
  47. // NOTE: CMD range 44..49 parked, potentially for WiFi operations
  48. #define CMD_SEND_BINARY_REQ 50
  49. #define CMD_FACTORY_RESET 51
  50. #define CMD_SEND_PATH_DISCOVERY_REQ 52
  51. #define CMD_SET_FLOOD_SCOPE 54 // v8+
  52. #define CMD_SEND_CONTROL_DATA 55 // v8+
  53. #define CMD_GET_STATS 56 // v8+, second byte is stats type
  54. #define CMD_SEND_ANON_REQ 57
  55. #define CMD_SET_AUTOADD_CONFIG 58
  56. #define CMD_GET_AUTOADD_CONFIG 59
  57. // Stats sub-types for CMD_GET_STATS
  58. #define STATS_TYPE_CORE 0
  59. #define STATS_TYPE_RADIO 1
  60. #define STATS_TYPE_PACKETS 2
  61. #define RESP_CODE_OK 0
  62. #define RESP_CODE_ERR 1
  63. #define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS
  64. #define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS)
  65. #define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS
  66. #define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START
  67. #define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG
  68. #define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3)
  69. #define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3)
  70. #define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME
  71. #define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE
  72. #define RESP_CODE_EXPORT_CONTACT 11
  73. #define RESP_CODE_BATT_AND_STORAGE 12 // a reply to a CMD_GET_BATT_AND_STORAGE
  74. #define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY
  75. #define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY
  76. #define RESP_CODE_DISABLED 15
  77. #define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3)
  78. #define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3)
  79. #define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL
  80. #define RESP_CODE_SIGN_START 19
  81. #define RESP_CODE_SIGNATURE 20
  82. #define RESP_CODE_CUSTOM_VARS 21
  83. #define RESP_CODE_ADVERT_PATH 22
  84. #define RESP_CODE_TUNING_PARAMS 23
  85. #define RESP_CODE_STATS 24 // v8+, second byte is stats type
  86. #define RESP_CODE_AUTOADD_CONFIG 25
  87. #define SEND_TIMEOUT_BASE_MILLIS 500
  88. #define FLOOD_SEND_TIMEOUT_FACTOR 16.0f
  89. #define DIRECT_SEND_PERHOP_FACTOR 6.0f
  90. #define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250
  91. #define LAZY_CONTACTS_WRITE_DELAY 5000
  92. #define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg=="
  93. // these are _pushed_ to client app at any time
  94. #define PUSH_CODE_ADVERT 0x80
  95. #define PUSH_CODE_PATH_UPDATED 0x81
  96. #define PUSH_CODE_SEND_CONFIRMED 0x82
  97. #define PUSH_CODE_MSG_WAITING 0x83
  98. #define PUSH_CODE_RAW_DATA 0x84
  99. #define PUSH_CODE_LOGIN_SUCCESS 0x85
  100. #define PUSH_CODE_LOGIN_FAIL 0x86
  101. #define PUSH_CODE_STATUS_RESPONSE 0x87
  102. #define PUSH_CODE_LOG_RX_DATA 0x88
  103. #define PUSH_CODE_TRACE_DATA 0x89
  104. #define PUSH_CODE_NEW_ADVERT 0x8A
  105. #define PUSH_CODE_TELEMETRY_RESPONSE 0x8B
  106. #define PUSH_CODE_BINARY_RESPONSE 0x8C
  107. #define PUSH_CODE_PATH_DISCOVERY_RESPONSE 0x8D
  108. #define PUSH_CODE_CONTROL_DATA 0x8E // v8+
  109. #define PUSH_CODE_CONTACT_DELETED 0x8F // used to notify client app of deleted contact when overwriting oldest
  110. #define PUSH_CODE_CONTACTS_FULL 0x90 // used to notify client app that contacts storage is full
  111. #define ERR_CODE_UNSUPPORTED_CMD 1
  112. #define ERR_CODE_NOT_FOUND 2
  113. #define ERR_CODE_TABLE_FULL 3
  114. #define ERR_CODE_BAD_STATE 4
  115. #define ERR_CODE_FILE_IO_ERROR 5
  116. #define ERR_CODE_ILLEGAL_ARG 6
  117. #define MAX_SIGN_DATA_LEN (8 * 1024) // 8K
  118. // Auto-add config bitmask
  119. // Bit 0: If set, overwrite oldest non-favourite contact when contacts file is full
  120. // Bits 1-4: these indicate which contact types to auto-add when manual_contact_mode = 0x01
  121. #define AUTO_ADD_OVERWRITE_OLDEST (1 << 0) // 0x01 - overwrite oldest non-favourite when full
  122. #define AUTO_ADD_CHAT (1 << 1) // 0x02 - auto-add Chat (Companion) (ADV_TYPE_CHAT)
  123. #define AUTO_ADD_REPEATER (1 << 2) // 0x04 - auto-add Repeater (ADV_TYPE_REPEATER)
  124. #define AUTO_ADD_ROOM_SERVER (1 << 3) // 0x08 - auto-add Room Server (ADV_TYPE_ROOM)
  125. #define AUTO_ADD_SENSOR (1 << 4) // 0x10 - auto-add Sensor (ADV_TYPE_SENSOR)
  126. void MyMesh::writeOKFrame() {
  127. uint8_t buf[1];
  128. buf[0] = RESP_CODE_OK;
  129. _serial->writeFrame(buf, 1);
  130. }
  131. void MyMesh::writeErrFrame(uint8_t err_code) {
  132. uint8_t buf[2];
  133. buf[0] = RESP_CODE_ERR;
  134. buf[1] = err_code;
  135. _serial->writeFrame(buf, 2);
  136. }
  137. void MyMesh::writeDisabledFrame() {
  138. uint8_t buf[1];
  139. buf[0] = RESP_CODE_DISABLED;
  140. _serial->writeFrame(buf, 1);
  141. }
  142. void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) {
  143. int i = 0;
  144. out_frame[i++] = code;
  145. memcpy(&out_frame[i], contact.id.pub_key, PUB_KEY_SIZE);
  146. i += PUB_KEY_SIZE;
  147. out_frame[i++] = contact.type;
  148. out_frame[i++] = contact.flags;
  149. out_frame[i++] = contact.out_path_len;
  150. memcpy(&out_frame[i], contact.out_path, MAX_PATH_SIZE);
  151. i += MAX_PATH_SIZE;
  152. StrHelper::strzcpy((char *)&out_frame[i], contact.name, 32);
  153. i += 32;
  154. memcpy(&out_frame[i], &contact.last_advert_timestamp, 4);
  155. i += 4;
  156. memcpy(&out_frame[i], &contact.gps_lat, 4);
  157. i += 4;
  158. memcpy(&out_frame[i], &contact.gps_lon, 4);
  159. i += 4;
  160. memcpy(&out_frame[i], &contact.lastmod, 4);
  161. i += 4;
  162. _serial->writeFrame(out_frame, i);
  163. }
  164. void MyMesh::updateContactFromFrame(ContactInfo &contact, uint32_t& last_mod, const uint8_t *frame, int len) {
  165. int i = 0;
  166. uint8_t code = frame[i++]; // eg. CMD_ADD_UPDATE_CONTACT
  167. memcpy(contact.id.pub_key, &frame[i], PUB_KEY_SIZE);
  168. i += PUB_KEY_SIZE;
  169. contact.type = frame[i++];
  170. contact.flags = frame[i++];
  171. contact.out_path_len = frame[i++];
  172. memcpy(contact.out_path, &frame[i], MAX_PATH_SIZE);
  173. i += MAX_PATH_SIZE;
  174. memcpy(contact.name, &frame[i], 32);
  175. i += 32;
  176. memcpy(&contact.last_advert_timestamp, &frame[i], 4);
  177. i += 4;
  178. if (len >= i + 8) { // optional fields
  179. memcpy(&contact.gps_lat, &frame[i], 4);
  180. i += 4;
  181. memcpy(&contact.gps_lon, &frame[i], 4);
  182. i += 4;
  183. if (len >= i + 4) {
  184. memcpy(&last_mod, &frame[i], 4);
  185. }
  186. }
  187. }
  188. bool MyMesh::Frame::isChannelMsg() const {
  189. return buf[0] == RESP_CODE_CHANNEL_MSG_RECV || buf[0] == RESP_CODE_CHANNEL_MSG_RECV_V3;
  190. }
  191. void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) {
  192. if (offline_queue_len >= OFFLINE_QUEUE_SIZE) {
  193. MESH_DEBUG_PRINTLN("WARN: offline_queue is full!");
  194. int pos = 0;
  195. while (pos < offline_queue_len) {
  196. if (offline_queue[pos].isChannelMsg()) {
  197. for (int i = pos; i < offline_queue_len - 1; i++) { // delete oldest channel msg from queue
  198. offline_queue[i] = offline_queue[i + 1];
  199. }
  200. MESH_DEBUG_PRINTLN("INFO: removed oldest channel message from queue.");
  201. offline_queue[offline_queue_len - 1].len = len;
  202. memcpy(offline_queue[offline_queue_len - 1].buf, frame, len);
  203. return;
  204. }
  205. pos++;
  206. }
  207. MESH_DEBUG_PRINTLN("INFO: no channel messages to remove from queue.");
  208. } else {
  209. offline_queue[offline_queue_len].len = len;
  210. memcpy(offline_queue[offline_queue_len].buf, frame, len);
  211. offline_queue_len++;
  212. }
  213. }
  214. int MyMesh::getFromOfflineQueue(uint8_t frame[]) {
  215. if (offline_queue_len > 0) { // check offline queue
  216. size_t len = offline_queue[0].len; // take from top of queue
  217. memcpy(frame, offline_queue[0].buf, len);
  218. offline_queue_len--;
  219. for (int i = 0; i < offline_queue_len; i++) { // delete top item from queue
  220. offline_queue[i] = offline_queue[i + 1];
  221. }
  222. return len;
  223. }
  224. return 0; // queue is empty
  225. }
  226. float MyMesh::getAirtimeBudgetFactor() const {
  227. return _prefs.airtime_factor;
  228. }
  229. int MyMesh::getInterferenceThreshold() const {
  230. return 0; // disabled for now, until currentRSSI() problem is resolved
  231. }
  232. int MyMesh::calcRxDelay(float score, uint32_t air_time) const {
  233. if (_prefs.rx_delay_base <= 0.0f) return 0;
  234. return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time);
  235. }
  236. uint8_t MyMesh::getExtraAckTransmitCount() const {
  237. return _prefs.multi_acks;
  238. }
  239. void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) {
  240. if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) {
  241. int i = 0;
  242. out_frame[i++] = PUSH_CODE_LOG_RX_DATA;
  243. out_frame[i++] = (int8_t)(snr * 4);
  244. out_frame[i++] = (int8_t)(rssi);
  245. memcpy(&out_frame[i], raw, len);
  246. i += len;
  247. _serial->writeFrame(out_frame, i);
  248. }
  249. }
  250. bool MyMesh::isAutoAddEnabled() const {
  251. return (_prefs.manual_add_contacts & 1) == 0;
  252. }
  253. bool MyMesh::shouldAutoAddContactType(uint8_t contact_type) const {
  254. if ((_prefs.manual_add_contacts & 1) == 0) {
  255. return true;
  256. }
  257. uint8_t type_bit = 0;
  258. switch (contact_type) {
  259. case ADV_TYPE_CHAT:
  260. type_bit = AUTO_ADD_CHAT;
  261. break;
  262. case ADV_TYPE_REPEATER:
  263. type_bit = AUTO_ADD_REPEATER;
  264. break;
  265. case ADV_TYPE_ROOM:
  266. type_bit = AUTO_ADD_ROOM_SERVER;
  267. break;
  268. case ADV_TYPE_SENSOR:
  269. type_bit = AUTO_ADD_SENSOR;
  270. break;
  271. default:
  272. return false; // Unknown type, don't auto-add
  273. }
  274. return (_prefs.autoadd_config & type_bit) != 0;
  275. }
  276. bool MyMesh::shouldOverwriteWhenFull() const {
  277. return (_prefs.autoadd_config & AUTO_ADD_OVERWRITE_OLDEST) != 0;
  278. }
  279. void MyMesh::onContactOverwrite(const uint8_t* pub_key) {
  280. if (_serial->isConnected()) {
  281. out_frame[0] = PUSH_CODE_CONTACT_DELETED;
  282. memcpy(&out_frame[1], pub_key, PUB_KEY_SIZE);
  283. _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE);
  284. }
  285. }
  286. void MyMesh::onContactsFull() {
  287. if (_serial->isConnected()) {
  288. out_frame[0] = PUSH_CODE_CONTACTS_FULL;
  289. _serial->writeFrame(out_frame, 1);
  290. }
  291. }
  292. void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new, uint8_t path_len, const uint8_t* path) {
  293. if (_serial->isConnected()) {
  294. if (is_new) {
  295. writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact);
  296. } else {
  297. out_frame[0] = PUSH_CODE_ADVERT;
  298. memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE);
  299. _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE);
  300. }
  301. } else {
  302. #ifdef DISPLAY_CLASS
  303. if (_ui) _ui->notify(UIEventType::newContactMessage);
  304. #endif
  305. }
  306. // add inbound-path to mem cache
  307. if (path && path_len <= sizeof(AdvertPath::path)) { // check path is valid
  308. AdvertPath* p = advert_paths;
  309. uint32_t oldest = 0xFFFFFFFF;
  310. for (int i = 0; i < ADVERT_PATH_TABLE_SIZE; i++) { // check if already in table, otherwise evict oldest
  311. if (memcmp(advert_paths[i].pubkey_prefix, contact.id.pub_key, sizeof(AdvertPath::pubkey_prefix)) == 0) {
  312. p = &advert_paths[i]; // found
  313. break;
  314. }
  315. if (advert_paths[i].recv_timestamp < oldest) {
  316. oldest = advert_paths[i].recv_timestamp;
  317. p = &advert_paths[i];
  318. }
  319. }
  320. memcpy(p->pubkey_prefix, contact.id.pub_key, sizeof(p->pubkey_prefix));
  321. strcpy(p->name, contact.name);
  322. p->recv_timestamp = getRTCClock()->getCurrentTime();
  323. p->path_len = path_len;
  324. memcpy(p->path, path, p->path_len);
  325. }
  326. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  327. }
  328. static int sort_by_recent(const void *a, const void *b) {
  329. return ((AdvertPath *) b)->recv_timestamp - ((AdvertPath *) a)->recv_timestamp;
  330. }
  331. int MyMesh::getRecentlyHeard(AdvertPath dest[], int max_num) {
  332. if (max_num > ADVERT_PATH_TABLE_SIZE) max_num = ADVERT_PATH_TABLE_SIZE;
  333. qsort(advert_paths, ADVERT_PATH_TABLE_SIZE, sizeof(advert_paths[0]), sort_by_recent);
  334. for (int i = 0; i < max_num; i++) {
  335. dest[i] = advert_paths[i];
  336. }
  337. return max_num;
  338. }
  339. void MyMesh::onContactPathUpdated(const ContactInfo &contact) {
  340. out_frame[0] = PUSH_CODE_PATH_UPDATED;
  341. memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE);
  342. _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected
  343. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  344. }
  345. ContactInfo* MyMesh::processAck(const uint8_t *data) {
  346. // see if matches any in a table
  347. for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) {
  348. if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient
  349. out_frame[0] = PUSH_CODE_SEND_CONFIRMED;
  350. memcpy(&out_frame[1], data, 4);
  351. uint32_t trip_time = _ms->getMillis() - expected_ack_table[i].msg_sent;
  352. memcpy(&out_frame[5], &trip_time, 4);
  353. _serial->writeFrame(out_frame, 9);
  354. // NOTE: the same ACK can be received multiple times!
  355. expected_ack_table[i].ack = 0; // clear expected hash, now that we have received ACK
  356. return expected_ack_table[i].contact;
  357. }
  358. }
  359. return checkConnectionsAck(data);
  360. }
  361. void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt,
  362. uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) {
  363. int i = 0;
  364. if (app_target_ver >= 3) {
  365. out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3;
  366. out_frame[i++] = (int8_t)(pkt->getSNR() * 4);
  367. out_frame[i++] = 0; // reserved1
  368. out_frame[i++] = 0; // reserved2
  369. } else {
  370. out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV;
  371. }
  372. memcpy(&out_frame[i], from.id.pub_key, 6);
  373. i += 6; // just 6-byte prefix
  374. uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF;
  375. out_frame[i++] = txt_type;
  376. memcpy(&out_frame[i], &sender_timestamp, 4);
  377. i += 4;
  378. if (extra_len > 0) {
  379. memcpy(&out_frame[i], extra, extra_len);
  380. i += extra_len;
  381. }
  382. int tlen = strlen(text); // TODO: UTF-8 ??
  383. if (i + tlen > MAX_FRAME_SIZE) {
  384. tlen = MAX_FRAME_SIZE - i;
  385. }
  386. memcpy(&out_frame[i], text, tlen);
  387. i += tlen;
  388. addToOfflineQueue(out_frame, i);
  389. if (_serial->isConnected()) {
  390. uint8_t frame[1];
  391. frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle'
  392. _serial->writeFrame(frame, 1);
  393. }
  394. #ifdef DISPLAY_CLASS
  395. // we only want to show text messages on display, not cli data
  396. bool should_display = txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_SIGNED_PLAIN;
  397. if (should_display && _ui) {
  398. _ui->newMsg(path_len, from.name, text, offline_queue_len);
  399. if (!_serial->isConnected()) {
  400. _ui->notify(UIEventType::contactMessage);
  401. }
  402. }
  403. #endif
  404. }
  405. bool MyMesh::filterRecvFloodPacket(mesh::Packet* packet) {
  406. // REVISIT: try to determine which Region (from transport_codes[1]) that Sender is indicating for replies/responses
  407. // if unknown, fallback to finding Region from transport_codes[0], the 'scope' used by Sender
  408. return false;
  409. }
  410. void MyMesh::sendFloodScoped(const ContactInfo& recipient, mesh::Packet* pkt, uint32_t delay_millis) {
  411. // TODO: dynamic send_scope, depending on recipient and current 'home' Region
  412. if (send_scope.isNull()) {
  413. sendFlood(pkt, delay_millis);
  414. } else {
  415. uint16_t codes[2];
  416. codes[0] = send_scope.calcTransportCode(pkt);
  417. codes[1] = 0; // REVISIT: set to 'home' Region, for sender/return region?
  418. sendFlood(pkt, codes, delay_millis);
  419. }
  420. }
  421. void MyMesh::sendFloodScoped(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t delay_millis) {
  422. // TODO: have per-channel send_scope
  423. if (send_scope.isNull()) {
  424. sendFlood(pkt, delay_millis);
  425. } else {
  426. uint16_t codes[2];
  427. codes[0] = send_scope.calcTransportCode(pkt);
  428. codes[1] = 0; // REVISIT: set to 'home' Region, for sender/return region?
  429. sendFlood(pkt, codes, delay_millis);
  430. }
  431. }
  432. void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp,
  433. const char *text) {
  434. markConnectionActive(from); // in case this is from a server, and we have a connection
  435. queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text);
  436. }
  437. void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp,
  438. const char *text) {
  439. markConnectionActive(from); // in case this is from a server, and we have a connection
  440. queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text);
  441. }
  442. void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp,
  443. const uint8_t *sender_prefix, const char *text) {
  444. markConnectionActive(from);
  445. // from.sync_since change needs to be persisted
  446. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  447. queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text);
  448. }
  449. void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp,
  450. const char *text) {
  451. int i = 0;
  452. if (app_target_ver >= 3) {
  453. out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3;
  454. out_frame[i++] = (int8_t)(pkt->getSNR() * 4);
  455. out_frame[i++] = 0; // reserved1
  456. out_frame[i++] = 0; // reserved2
  457. } else {
  458. out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV;
  459. }
  460. uint8_t channel_idx = findChannelIdx(channel);
  461. out_frame[i++] = channel_idx;
  462. uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF;
  463. out_frame[i++] = TXT_TYPE_PLAIN;
  464. memcpy(&out_frame[i], &timestamp, 4);
  465. i += 4;
  466. int tlen = strlen(text); // TODO: UTF-8 ??
  467. if (i + tlen > MAX_FRAME_SIZE) {
  468. tlen = MAX_FRAME_SIZE - i;
  469. }
  470. memcpy(&out_frame[i], text, tlen);
  471. i += tlen;
  472. addToOfflineQueue(out_frame, i);
  473. if (_serial->isConnected()) {
  474. uint8_t frame[1];
  475. frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle'
  476. _serial->writeFrame(frame, 1);
  477. } else {
  478. #ifdef DISPLAY_CLASS
  479. if (_ui) _ui->notify(UIEventType::channelMessage);
  480. #endif
  481. }
  482. #ifdef DISPLAY_CLASS
  483. // Get the channel name from the channel index
  484. const char *channel_name = "Unknown";
  485. ChannelDetails channel_details;
  486. if (getChannel(channel_idx, channel_details)) {
  487. channel_name = channel_details.name;
  488. }
  489. if (_ui) _ui->newMsg(path_len, channel_name, text, offline_queue_len);
  490. #endif
  491. }
  492. uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data,
  493. uint8_t len, uint8_t *reply) {
  494. if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) {
  495. uint8_t permissions = 0;
  496. uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits)
  497. if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) {
  498. permissions = TELEM_PERM_BASE;
  499. } else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) {
  500. permissions = cp & TELEM_PERM_BASE;
  501. }
  502. if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) {
  503. permissions |= TELEM_PERM_LOCATION;
  504. } else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) {
  505. permissions |= cp & TELEM_PERM_LOCATION;
  506. }
  507. if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) {
  508. permissions |= TELEM_PERM_ENVIRONMENT;
  509. } else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) {
  510. permissions |= cp & TELEM_PERM_ENVIRONMENT;
  511. }
  512. uint8_t perm_mask = ~(data[1]); // NEW: first reserved byte (of 4), is now inverse mask to apply to permissions
  513. permissions &= perm_mask;
  514. if (permissions & TELEM_PERM_BASE) { // only respond if base permission bit is set
  515. telemetry.reset();
  516. telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  517. // query other sensors -- target specific
  518. sensors.querySensors(permissions, telemetry);
  519. memcpy(reply, &sender_timestamp,
  520. 4); // reflect sender_timestamp back in response packet (kind of like a 'tag')
  521. uint8_t tlen = telemetry.getSize();
  522. memcpy(&reply[4], telemetry.getBuffer(), tlen);
  523. return 4 + tlen;
  524. }
  525. }
  526. return 0; // unknown
  527. }
  528. void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) {
  529. uint32_t tag;
  530. memcpy(&tag, data, 4);
  531. if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) { // check for login response
  532. // yes, is response to pending sendLogin()
  533. pending_login = 0;
  534. int i = 0;
  535. if (memcmp(&data[4], "OK", 2) == 0) { // legacy Repeater login OK response
  536. out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS;
  537. out_frame[i++] = 0; // legacy: is_admin = false
  538. memcpy(&out_frame[i], contact.id.pub_key, 6);
  539. i += 6; // pub_key_prefix
  540. } else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response
  541. uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16;
  542. if (keep_alive_secs > 0) {
  543. startConnection(contact, keep_alive_secs);
  544. }
  545. out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS;
  546. out_frame[i++] = data[6]; // permissions (eg. is_admin)
  547. memcpy(&out_frame[i], contact.id.pub_key, 6);
  548. i += 6; // pub_key_prefix
  549. memcpy(&out_frame[i], &tag, 4);
  550. i += 4; // NEW: include server timestamp
  551. out_frame[i++] = data[7]; // NEW (v7): ACL permissions
  552. out_frame[i++] = data[12]; // FIRMWARE_VER_LEVEL
  553. } else {
  554. out_frame[i++] = PUSH_CODE_LOGIN_FAIL;
  555. out_frame[i++] = 0; // reserved
  556. memcpy(&out_frame[i], contact.id.pub_key, 6);
  557. i += 6; // pub_key_prefix
  558. }
  559. _serial->writeFrame(out_frame, i);
  560. } else if (len > 4 && // check for status response
  561. pending_status &&
  562. memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme
  563. // FUTURE: tag == pending_status
  564. ) {
  565. pending_status = 0;
  566. int i = 0;
  567. out_frame[i++] = PUSH_CODE_STATUS_RESPONSE;
  568. out_frame[i++] = 0; // reserved
  569. memcpy(&out_frame[i], contact.id.pub_key, 6);
  570. i += 6; // pub_key_prefix
  571. memcpy(&out_frame[i], &data[4], len - 4);
  572. i += (len - 4);
  573. _serial->writeFrame(out_frame, i);
  574. } else if (len > 4 && tag == pending_telemetry) { // check for matching response tag
  575. pending_telemetry = 0;
  576. int i = 0;
  577. out_frame[i++] = PUSH_CODE_TELEMETRY_RESPONSE;
  578. out_frame[i++] = 0; // reserved
  579. memcpy(&out_frame[i], contact.id.pub_key, 6);
  580. i += 6; // pub_key_prefix
  581. memcpy(&out_frame[i], &data[4], len - 4);
  582. i += (len - 4);
  583. _serial->writeFrame(out_frame, i);
  584. } else if (len > 4 && tag == pending_req) { // check for matching response tag
  585. pending_req = 0;
  586. int i = 0;
  587. out_frame[i++] = PUSH_CODE_BINARY_RESPONSE;
  588. out_frame[i++] = 0; // reserved
  589. memcpy(&out_frame[i], &tag, 4); // app needs to match this to RESP_CODE_SENT.tag
  590. i += 4;
  591. memcpy(&out_frame[i], &data[4], len - 4);
  592. i += (len - 4);
  593. _serial->writeFrame(out_frame, i);
  594. }
  595. }
  596. bool MyMesh::onContactPathRecv(ContactInfo& contact, uint8_t* in_path, uint8_t in_path_len, uint8_t* out_path, uint8_t out_path_len, uint8_t extra_type, uint8_t* extra, uint8_t extra_len) {
  597. if (extra_type == PAYLOAD_TYPE_RESPONSE && extra_len > 4) {
  598. uint32_t tag;
  599. memcpy(&tag, extra, 4);
  600. if (tag == pending_discovery) { // check for matching response tag)
  601. pending_discovery = 0;
  602. if (in_path_len > MAX_PATH_SIZE || out_path_len > MAX_PATH_SIZE) {
  603. MESH_DEBUG_PRINTLN("onContactPathRecv, invalid path sizes: %d, %d", in_path_len, out_path_len);
  604. } else {
  605. int i = 0;
  606. out_frame[i++] = PUSH_CODE_PATH_DISCOVERY_RESPONSE;
  607. out_frame[i++] = 0; // reserved
  608. memcpy(&out_frame[i], contact.id.pub_key, 6);
  609. i += 6; // pub_key_prefix
  610. out_frame[i++] = out_path_len;
  611. memcpy(&out_frame[i], out_path, out_path_len);
  612. i += out_path_len;
  613. out_frame[i++] = in_path_len;
  614. memcpy(&out_frame[i], in_path, in_path_len);
  615. i += in_path_len;
  616. // NOTE: telemetry data in 'extra' is discarded at present
  617. _serial->writeFrame(out_frame, i);
  618. }
  619. return false; // DON'T send reciprocal path!
  620. }
  621. }
  622. // let base class handle received path and data
  623. return BaseChatMesh::onContactPathRecv(contact, in_path, in_path_len, out_path, out_path_len, extra_type, extra, extra_len);
  624. }
  625. void MyMesh::onControlDataRecv(mesh::Packet *packet) {
  626. if (packet->payload_len + 4 > sizeof(out_frame)) {
  627. MESH_DEBUG_PRINTLN("onControlDataRecv(), payload_len too long: %d", packet->payload_len);
  628. return;
  629. }
  630. int i = 0;
  631. out_frame[i++] = PUSH_CODE_CONTROL_DATA;
  632. out_frame[i++] = (int8_t)(_radio->getLastSNR() * 4);
  633. out_frame[i++] = (int8_t)(_radio->getLastRSSI());
  634. out_frame[i++] = packet->path_len;
  635. memcpy(&out_frame[i], packet->payload, packet->payload_len);
  636. i += packet->payload_len;
  637. if (_serial->isConnected()) {
  638. _serial->writeFrame(out_frame, i);
  639. } else {
  640. MESH_DEBUG_PRINTLN("onControlDataRecv(), data received while app offline");
  641. }
  642. }
  643. void MyMesh::onRawDataRecv(mesh::Packet *packet) {
  644. if (packet->payload_len + 4 > sizeof(out_frame)) {
  645. MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len);
  646. return;
  647. }
  648. int i = 0;
  649. out_frame[i++] = PUSH_CODE_RAW_DATA;
  650. out_frame[i++] = (int8_t)(_radio->getLastSNR() * 4);
  651. out_frame[i++] = (int8_t)(_radio->getLastRSSI());
  652. out_frame[i++] = 0xFF; // reserved (possibly path_len in future)
  653. memcpy(&out_frame[i], packet->payload, packet->payload_len);
  654. i += packet->payload_len;
  655. if (_serial->isConnected()) {
  656. _serial->writeFrame(out_frame, i);
  657. } else {
  658. MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline");
  659. }
  660. }
  661. void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags,
  662. const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) {
  663. uint8_t path_sz = flags & 0x03; // NEW v1.11+
  664. if (12 + path_len + (path_len >> path_sz) + 1 > sizeof(out_frame)) {
  665. MESH_DEBUG_PRINTLN("onTraceRecv(), path_len is too long: %d", (uint32_t)path_len);
  666. return;
  667. }
  668. int i = 0;
  669. out_frame[i++] = PUSH_CODE_TRACE_DATA;
  670. out_frame[i++] = 0; // reserved
  671. out_frame[i++] = path_len;
  672. out_frame[i++] = flags;
  673. memcpy(&out_frame[i], &tag, 4);
  674. i += 4;
  675. memcpy(&out_frame[i], &auth_code, 4);
  676. i += 4;
  677. memcpy(&out_frame[i], path_hashes, path_len);
  678. i += path_len;
  679. memcpy(&out_frame[i], path_snrs, path_len >> path_sz);
  680. i += path_len >> path_sz;
  681. out_frame[i++] = (int8_t)(packet->getSNR() * 4); // extra/final SNR (to this node)
  682. if (_serial->isConnected()) {
  683. _serial->writeFrame(out_frame, i);
  684. } else {
  685. MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline");
  686. }
  687. }
  688. uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const {
  689. return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis);
  690. }
  691. uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const {
  692. return SEND_TIMEOUT_BASE_MILLIS +
  693. ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) *
  694. (path_len + 1));
  695. }
  696. void MyMesh::onSendTimeout() {}
  697. MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables, DataStore& store, AbstractUITask* ui)
  698. : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables),
  699. _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4), _store(&store), _ui(ui) {
  700. _iter_started = false;
  701. _cli_rescue = false;
  702. offline_queue_len = 0;
  703. app_target_ver = 0;
  704. clearPendingReqs();
  705. next_ack_idx = 0;
  706. sign_data = NULL;
  707. dirty_contacts_expiry = 0;
  708. memset(advert_paths, 0, sizeof(advert_paths));
  709. memset(send_scope.key, 0, sizeof(send_scope.key));
  710. // defaults
  711. memset(&_prefs, 0, sizeof(_prefs));
  712. _prefs.airtime_factor = 1.0; // one half
  713. strcpy(_prefs.node_name, "NONAME");
  714. _prefs.freq = LORA_FREQ;
  715. _prefs.sf = LORA_SF;
  716. _prefs.bw = LORA_BW;
  717. _prefs.cr = LORA_CR;
  718. _prefs.tx_power_dbm = LORA_TX_POWER;
  719. _prefs.gps_enabled = 0; // GPS disabled by default
  720. _prefs.gps_interval = 0; // No automatic GPS updates by default
  721. //_prefs.rx_delay_base = 10.0f; enable once new algo fixed
  722. }
  723. void MyMesh::begin(bool has_display) {
  724. BaseChatMesh::begin();
  725. if (!_store->loadMainIdentity(self_id)) {
  726. self_id = radio_new_identity(); // create new random identity
  727. int count = 0;
  728. while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes
  729. self_id = radio_new_identity();
  730. count++;
  731. }
  732. _store->saveMainIdentity(self_id);
  733. }
  734. // use hex of first 4 bytes of identity public key as default node name
  735. char pub_key_hex[10];
  736. mesh::Utils::toHex(pub_key_hex, self_id.pub_key, 4);
  737. strcpy(_prefs.node_name, pub_key_hex);
  738. // if name is provided as a build flag, use that as default node name instead
  739. #ifdef ADVERT_NAME
  740. strcpy(_prefs.node_name, ADVERT_NAME);
  741. #endif
  742. // load persisted prefs
  743. _store->loadPrefs(_prefs, sensors.node_lat, sensors.node_lon);
  744. // sanitise bad pref values
  745. _prefs.rx_delay_base = constrain(_prefs.rx_delay_base, 0, 20.0f);
  746. _prefs.airtime_factor = constrain(_prefs.airtime_factor, 0, 9.0f);
  747. _prefs.freq = constrain(_prefs.freq, 400.0f, 2500.0f);
  748. _prefs.bw = constrain(_prefs.bw, 7.8f, 500.0f);
  749. _prefs.sf = constrain(_prefs.sf, 5, 12);
  750. _prefs.cr = constrain(_prefs.cr, 5, 8);
  751. _prefs.tx_power_dbm = constrain(_prefs.tx_power_dbm, 1, MAX_LORA_TX_POWER);
  752. _prefs.gps_enabled = constrain(_prefs.gps_enabled, 0, 1); // Ensure boolean 0 or 1
  753. _prefs.gps_interval = constrain(_prefs.gps_interval, 0, 86400); // Max 24 hours
  754. #ifdef BLE_PIN_CODE // 123456 by default
  755. if (_prefs.ble_pin == 0) {
  756. #ifdef DISPLAY_CLASS
  757. if (has_display && BLE_PIN_CODE == 123456) {
  758. StdRNG rng;
  759. _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session
  760. } else {
  761. _active_ble_pin = BLE_PIN_CODE; // otherwise static pin
  762. }
  763. #else
  764. _active_ble_pin = BLE_PIN_CODE; // otherwise static pin
  765. #endif
  766. } else {
  767. _active_ble_pin = _prefs.ble_pin;
  768. }
  769. #else
  770. _active_ble_pin = 0;
  771. #endif
  772. resetContacts();
  773. _store->loadContacts(this);
  774. bootstrapRTCfromContacts();
  775. addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel
  776. _store->loadChannels(this);
  777. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  778. radio_set_tx_power(_prefs.tx_power_dbm);
  779. }
  780. const char *MyMesh::getNodeName() {
  781. return _prefs.node_name;
  782. }
  783. NodePrefs *MyMesh::getNodePrefs() {
  784. return &_prefs;
  785. }
  786. uint32_t MyMesh::getBLEPin() {
  787. return _active_ble_pin;
  788. }
  789. void MyMesh::startInterface(BaseSerialInterface &serial) {
  790. _serial = &serial;
  791. serial.enable();
  792. }
  793. void MyMesh::handleCmdFrame(size_t len) {
  794. if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection
  795. app_target_ver = cmd_frame[1]; // which version of protocol does app understand
  796. int i = 0;
  797. out_frame[i++] = RESP_CODE_DEVICE_INFO;
  798. out_frame[i++] = FIRMWARE_VER_CODE;
  799. out_frame[i++] = MAX_CONTACTS / 2; // v3+
  800. out_frame[i++] = MAX_GROUP_CHANNELS; // v3+
  801. memcpy(&out_frame[i], &_prefs.ble_pin, 4);
  802. i += 4;
  803. memset(&out_frame[i], 0, 12);
  804. strcpy((char *)&out_frame[i], FIRMWARE_BUILD_DATE);
  805. i += 12;
  806. StrHelper::strzcpy((char *)&out_frame[i], board.getManufacturerName(), 40);
  807. i += 40;
  808. StrHelper::strzcpy((char *)&out_frame[i], FIRMWARE_VERSION, 20);
  809. i += 20;
  810. _serial->writeFrame(out_frame, i);
  811. } else if (cmd_frame[0] == CMD_APP_START &&
  812. len >= 8) { // sent when app establishes connection, respond with node ID
  813. // cmd_frame[1..7] reserved future
  814. char *app_name = (char *)&cmd_frame[8];
  815. cmd_frame[len] = 0; // make app_name null terminated
  816. MESH_DEBUG_PRINTLN("App %s connected", app_name);
  817. _iter_started = false; // stop any left-over ContactsIterator
  818. int i = 0;
  819. out_frame[i++] = RESP_CODE_SELF_INFO;
  820. out_frame[i++] = ADV_TYPE_CHAT; // what this node Advert identifies as (maybe node's pronouns too?? :-)
  821. out_frame[i++] = _prefs.tx_power_dbm;
  822. out_frame[i++] = MAX_LORA_TX_POWER;
  823. memcpy(&out_frame[i], self_id.pub_key, PUB_KEY_SIZE);
  824. i += PUB_KEY_SIZE;
  825. int32_t lat, lon;
  826. lat = (sensors.node_lat * 1000000.0);
  827. lon = (sensors.node_lon * 1000000.0);
  828. memcpy(&out_frame[i], &lat, 4);
  829. i += 4;
  830. memcpy(&out_frame[i], &lon, 4);
  831. i += 4;
  832. out_frame[i++] = _prefs.multi_acks; // new v7+
  833. out_frame[i++] = _prefs.advert_loc_policy;
  834. out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) |
  835. (_prefs.telemetry_mode_base); // v5+
  836. out_frame[i++] = _prefs.manual_add_contacts;
  837. uint32_t freq = _prefs.freq * 1000;
  838. memcpy(&out_frame[i], &freq, 4);
  839. i += 4;
  840. uint32_t bw = _prefs.bw * 1000;
  841. memcpy(&out_frame[i], &bw, 4);
  842. i += 4;
  843. out_frame[i++] = _prefs.sf;
  844. out_frame[i++] = _prefs.cr;
  845. int tlen = strlen(_prefs.node_name); // revisit: UTF_8 ??
  846. memcpy(&out_frame[i], _prefs.node_name, tlen);
  847. i += tlen;
  848. _serial->writeFrame(out_frame, i);
  849. } else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) {
  850. int i = 1;
  851. uint8_t txt_type = cmd_frame[i++];
  852. uint8_t attempt = cmd_frame[i++];
  853. uint32_t msg_timestamp;
  854. memcpy(&msg_timestamp, &cmd_frame[i], 4);
  855. i += 4;
  856. uint8_t *pub_key_prefix = &cmd_frame[i];
  857. i += 6;
  858. ContactInfo *recipient = lookupContactByPubKey(pub_key_prefix, 6);
  859. if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) {
  860. char *text = (char *)&cmd_frame[i];
  861. int tlen = len - i;
  862. uint32_t est_timeout;
  863. text[tlen] = 0; // ensure null
  864. int result;
  865. uint32_t expected_ack;
  866. if (txt_type == TXT_TYPE_CLI_DATA) {
  867. msg_timestamp = getRTCClock()->getCurrentTimeUnique(); // Use node's RTC instead of app timestamp to avoid tripping replay protection
  868. result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout);
  869. expected_ack = 0; // no Ack expected
  870. } else {
  871. result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout);
  872. }
  873. // TODO: add expected ACK to table
  874. if (result == MSG_SEND_FAILED) {
  875. writeErrFrame(ERR_CODE_TABLE_FULL);
  876. } else {
  877. if (expected_ack) {
  878. expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table
  879. expected_ack_table[next_ack_idx].ack = expected_ack;
  880. expected_ack_table[next_ack_idx].contact = recipient;
  881. next_ack_idx = (next_ack_idx + 1) % EXPECTED_ACK_TABLE_SIZE;
  882. }
  883. out_frame[0] = RESP_CODE_SENT;
  884. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  885. memcpy(&out_frame[2], &expected_ack, 4);
  886. memcpy(&out_frame[6], &est_timeout, 4);
  887. _serial->writeFrame(out_frame, 10);
  888. }
  889. } else {
  890. writeErrFrame(recipient == NULL
  891. ? ERR_CODE_NOT_FOUND
  892. : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_*
  893. }
  894. } else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg
  895. int i = 1;
  896. uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN
  897. uint8_t channel_idx = cmd_frame[i++];
  898. uint32_t msg_timestamp;
  899. memcpy(&msg_timestamp, &cmd_frame[i], 4);
  900. i += 4;
  901. const char *text = (char *)&cmd_frame[i];
  902. if (txt_type != TXT_TYPE_PLAIN) {
  903. writeErrFrame(ERR_CODE_UNSUPPORTED_CMD);
  904. } else {
  905. ChannelDetails channel;
  906. bool success = getChannel(channel_idx, channel);
  907. if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) {
  908. writeOKFrame();
  909. } else {
  910. writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx
  911. }
  912. }
  913. } else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list
  914. if (_iter_started) {
  915. writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy
  916. } else {
  917. if (len >= 5) { // has optional 'since' param
  918. memcpy(&_iter_filter_since, &cmd_frame[1], 4);
  919. } else {
  920. _iter_filter_since = 0;
  921. }
  922. uint8_t reply[5];
  923. reply[0] = RESP_CODE_CONTACTS_START;
  924. uint32_t count = getNumContacts(); // total, NOT filtered count
  925. memcpy(&reply[1], &count, 4);
  926. _serial->writeFrame(reply, 5);
  927. // start iterator
  928. _iter = startContactsIterator();
  929. _iter_started = true;
  930. _most_recent_lastmod = 0;
  931. }
  932. } else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) {
  933. int nlen = len - 1;
  934. if (nlen > sizeof(_prefs.node_name) - 1) nlen = sizeof(_prefs.node_name) - 1; // max len
  935. memcpy(_prefs.node_name, &cmd_frame[1], nlen);
  936. _prefs.node_name[nlen] = 0; // null terminator
  937. savePrefs();
  938. writeOKFrame();
  939. } else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) {
  940. int32_t lat, lon, alt = 0;
  941. memcpy(&lat, &cmd_frame[1], 4);
  942. memcpy(&lon, &cmd_frame[5], 4);
  943. if (len >= 13) {
  944. memcpy(&alt, &cmd_frame[9], 4); // for FUTURE support
  945. }
  946. if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) {
  947. sensors.node_lat = ((double)lat) / 1000000.0;
  948. sensors.node_lon = ((double)lon) / 1000000.0;
  949. savePrefs();
  950. writeOKFrame();
  951. } else {
  952. writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate
  953. }
  954. } else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) {
  955. uint8_t reply[5];
  956. reply[0] = RESP_CODE_CURR_TIME;
  957. uint32_t now = getRTCClock()->getCurrentTime();
  958. memcpy(&reply[1], &now, 4);
  959. _serial->writeFrame(reply, 5);
  960. } else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) {
  961. uint32_t secs;
  962. memcpy(&secs, &cmd_frame[1], 4);
  963. uint32_t curr = getRTCClock()->getCurrentTime();
  964. if (secs >= curr) {
  965. getRTCClock()->setCurrentTime(secs);
  966. writeOKFrame();
  967. } else {
  968. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  969. }
  970. } else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) {
  971. mesh::Packet* pkt;
  972. if (_prefs.advert_loc_policy == ADVERT_LOC_NONE) {
  973. pkt = createSelfAdvert(_prefs.node_name);
  974. } else {
  975. pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon);
  976. }
  977. if (pkt) {
  978. if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop)
  979. sendFlood(pkt);
  980. } else {
  981. sendZeroHop(pkt);
  982. }
  983. writeOKFrame();
  984. } else {
  985. writeErrFrame(ERR_CODE_TABLE_FULL);
  986. }
  987. } else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) {
  988. uint8_t *pub_key = &cmd_frame[1];
  989. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  990. if (recipient) {
  991. recipient->out_path_len = -1;
  992. // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact
  993. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  994. writeOKFrame();
  995. } else {
  996. writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact
  997. }
  998. } else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) {
  999. uint8_t *pub_key = &cmd_frame[1];
  1000. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1001. uint32_t last_mod = getRTCClock()->getCurrentTime(); // fallback value if not present in cmd_frame
  1002. if (recipient) {
  1003. updateContactFromFrame(*recipient, last_mod, cmd_frame, len);
  1004. recipient->lastmod = last_mod;
  1005. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  1006. writeOKFrame();
  1007. } else {
  1008. ContactInfo contact;
  1009. updateContactFromFrame(contact, last_mod, cmd_frame, len);
  1010. contact.lastmod = last_mod;
  1011. contact.sync_since = 0;
  1012. if (addContact(contact)) {
  1013. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  1014. writeOKFrame();
  1015. } else {
  1016. writeErrFrame(ERR_CODE_TABLE_FULL);
  1017. }
  1018. }
  1019. } else if (cmd_frame[0] == CMD_REMOVE_CONTACT) {
  1020. uint8_t *pub_key = &cmd_frame[1];
  1021. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1022. if (recipient && removeContact(*recipient)) {
  1023. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  1024. writeOKFrame();
  1025. } else {
  1026. writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove
  1027. }
  1028. } else if (cmd_frame[0] == CMD_SHARE_CONTACT) {
  1029. uint8_t *pub_key = &cmd_frame[1];
  1030. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1031. if (recipient) {
  1032. if (shareContactZeroHop(*recipient)) {
  1033. writeOKFrame();
  1034. } else {
  1035. writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send
  1036. }
  1037. } else {
  1038. writeErrFrame(ERR_CODE_NOT_FOUND);
  1039. }
  1040. } else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) {
  1041. uint8_t *pub_key = &cmd_frame[1];
  1042. ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1043. if (contact) {
  1044. writeContactRespFrame(RESP_CODE_CONTACT, *contact);
  1045. } else {
  1046. writeErrFrame(ERR_CODE_NOT_FOUND); // not found
  1047. }
  1048. } else if (cmd_frame[0] == CMD_EXPORT_CONTACT) {
  1049. if (len < 1 + PUB_KEY_SIZE) {
  1050. // export SELF
  1051. mesh::Packet* pkt;
  1052. if (_prefs.advert_loc_policy == ADVERT_LOC_NONE) {
  1053. pkt = createSelfAdvert(_prefs.node_name);
  1054. } else {
  1055. pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon);
  1056. }
  1057. if (pkt) {
  1058. pkt->header |= ROUTE_TYPE_FLOOD; // would normally be sent in this mode
  1059. out_frame[0] = RESP_CODE_EXPORT_CONTACT;
  1060. uint8_t out_len = pkt->writeTo(&out_frame[1]);
  1061. releasePacket(pkt); // undo the obtainNewPacket()
  1062. _serial->writeFrame(out_frame, out_len + 1);
  1063. } else {
  1064. writeErrFrame(ERR_CODE_TABLE_FULL); // Error
  1065. }
  1066. } else {
  1067. uint8_t *pub_key = &cmd_frame[1];
  1068. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1069. uint8_t out_len;
  1070. if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) {
  1071. out_frame[0] = RESP_CODE_EXPORT_CONTACT;
  1072. _serial->writeFrame(out_frame, out_len + 1);
  1073. } else {
  1074. writeErrFrame(ERR_CODE_NOT_FOUND); // not found
  1075. }
  1076. }
  1077. } else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) {
  1078. if (importContact(&cmd_frame[1], len - 1)) {
  1079. writeOKFrame();
  1080. } else {
  1081. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1082. }
  1083. } else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) {
  1084. int out_len;
  1085. if ((out_len = getFromOfflineQueue(out_frame)) > 0) {
  1086. _serial->writeFrame(out_frame, out_len);
  1087. #ifdef DISPLAY_CLASS
  1088. if (_ui) _ui->msgRead(offline_queue_len);
  1089. #endif
  1090. } else {
  1091. out_frame[0] = RESP_CODE_NO_MORE_MESSAGES;
  1092. _serial->writeFrame(out_frame, 1);
  1093. }
  1094. } else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) {
  1095. int i = 1;
  1096. uint32_t freq;
  1097. memcpy(&freq, &cmd_frame[i], 4);
  1098. i += 4;
  1099. uint32_t bw;
  1100. memcpy(&bw, &cmd_frame[i], 4);
  1101. i += 4;
  1102. uint8_t sf = cmd_frame[i++];
  1103. uint8_t cr = cmd_frame[i++];
  1104. if (freq >= 300000 && freq <= 2500000 && sf >= 5 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 &&
  1105. bw <= 500000) {
  1106. _prefs.sf = sf;
  1107. _prefs.cr = cr;
  1108. _prefs.freq = (float)freq / 1000.0;
  1109. _prefs.bw = (float)bw / 1000.0;
  1110. savePrefs();
  1111. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  1112. MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf,
  1113. (uint32_t)cr);
  1114. writeOKFrame();
  1115. } else {
  1116. MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf,
  1117. (uint32_t)cr);
  1118. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1119. }
  1120. } else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) {
  1121. if (cmd_frame[1] > MAX_LORA_TX_POWER) {
  1122. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1123. } else {
  1124. _prefs.tx_power_dbm = cmd_frame[1];
  1125. savePrefs();
  1126. radio_set_tx_power(_prefs.tx_power_dbm);
  1127. writeOKFrame();
  1128. }
  1129. } else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) {
  1130. int i = 1;
  1131. uint32_t rx, af;
  1132. memcpy(&rx, &cmd_frame[i], 4);
  1133. i += 4;
  1134. memcpy(&af, &cmd_frame[i], 4);
  1135. i += 4;
  1136. _prefs.rx_delay_base = ((float)rx) / 1000.0f;
  1137. _prefs.airtime_factor = ((float)af) / 1000.0f;
  1138. savePrefs();
  1139. writeOKFrame();
  1140. } else if (cmd_frame[0] == CMD_GET_TUNING_PARAMS) {
  1141. uint32_t rx = _prefs.rx_delay_base * 1000, af = _prefs.airtime_factor * 1000;
  1142. int i = 0;
  1143. out_frame[i++] = RESP_CODE_TUNING_PARAMS;
  1144. memcpy(&out_frame[i], &rx, 4); i += 4;
  1145. memcpy(&out_frame[i], &af, 4); i += 4;
  1146. _serial->writeFrame(out_frame, i);
  1147. } else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) {
  1148. _prefs.manual_add_contacts = cmd_frame[1];
  1149. if (len >= 3) {
  1150. _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+
  1151. _prefs.telemetry_mode_loc = (cmd_frame[2] >> 2) & 0x03;
  1152. _prefs.telemetry_mode_env = (cmd_frame[2] >> 4) & 0x03;
  1153. if (len >= 4) {
  1154. _prefs.advert_loc_policy = cmd_frame[3];
  1155. if (len >= 5) {
  1156. _prefs.multi_acks = cmd_frame[4];
  1157. }
  1158. }
  1159. }
  1160. savePrefs();
  1161. writeOKFrame();
  1162. } else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) {
  1163. if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed?
  1164. saveContacts();
  1165. }
  1166. board.reboot();
  1167. } else if (cmd_frame[0] == CMD_GET_BATT_AND_STORAGE) {
  1168. uint8_t reply[11];
  1169. int i = 0;
  1170. reply[i++] = RESP_CODE_BATT_AND_STORAGE;
  1171. uint16_t battery_millivolts = board.getBattMilliVolts();
  1172. uint32_t used = _store->getStorageUsedKb();
  1173. uint32_t total = _store->getStorageTotalKb();
  1174. memcpy(&reply[i], &battery_millivolts, 2); i += 2;
  1175. memcpy(&reply[i], &used, 4); i += 4;
  1176. memcpy(&reply[i], &total, 4); i += 4;
  1177. _serial->writeFrame(reply, i);
  1178. } else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) {
  1179. #if ENABLE_PRIVATE_KEY_EXPORT
  1180. uint8_t reply[65];
  1181. reply[0] = RESP_CODE_PRIVATE_KEY;
  1182. self_id.writeTo(&reply[1], 64);
  1183. _serial->writeFrame(reply, 65);
  1184. #else
  1185. writeDisabledFrame();
  1186. #endif
  1187. } else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) {
  1188. #if ENABLE_PRIVATE_KEY_IMPORT
  1189. mesh::LocalIdentity identity;
  1190. identity.readFrom(&cmd_frame[1], 64);
  1191. if (_store->saveMainIdentity(identity)) {
  1192. self_id = identity;
  1193. writeOKFrame();
  1194. // re-load contacts, to invalidate ecdh shared_secrets
  1195. resetContacts();
  1196. _store->loadContacts(this);
  1197. } else {
  1198. writeErrFrame(ERR_CODE_FILE_IO_ERROR);
  1199. }
  1200. #else
  1201. writeDisabledFrame();
  1202. #endif
  1203. } else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) {
  1204. int i = 1;
  1205. int8_t path_len = cmd_frame[i++];
  1206. if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload
  1207. uint8_t *path = &cmd_frame[i];
  1208. i += path_len;
  1209. auto pkt = createRawData(&cmd_frame[i], len - i);
  1210. if (pkt) {
  1211. sendDirect(pkt, path, path_len);
  1212. writeOKFrame();
  1213. } else {
  1214. writeErrFrame(ERR_CODE_TABLE_FULL);
  1215. }
  1216. } else {
  1217. writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet)
  1218. }
  1219. } else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) {
  1220. uint8_t *pub_key = &cmd_frame[1];
  1221. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1222. char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE];
  1223. cmd_frame[len] = 0; // ensure null terminator in password
  1224. if (recipient) {
  1225. uint32_t est_timeout;
  1226. int result = sendLogin(*recipient, password, est_timeout);
  1227. if (result == MSG_SEND_FAILED) {
  1228. writeErrFrame(ERR_CODE_TABLE_FULL);
  1229. } else {
  1230. clearPendingReqs();
  1231. memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse()
  1232. out_frame[0] = RESP_CODE_SENT;
  1233. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1234. memcpy(&out_frame[2], &pending_login, 4);
  1235. memcpy(&out_frame[6], &est_timeout, 4);
  1236. _serial->writeFrame(out_frame, 10);
  1237. }
  1238. } else {
  1239. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1240. }
  1241. } else if (cmd_frame[0] == CMD_SEND_ANON_REQ && len > 1 + PUB_KEY_SIZE) {
  1242. uint8_t *pub_key = &cmd_frame[1];
  1243. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1244. uint8_t *data = &cmd_frame[1 + PUB_KEY_SIZE];
  1245. if (recipient) {
  1246. uint32_t tag, est_timeout;
  1247. int result = sendAnonReq(*recipient, data, len - (1 + PUB_KEY_SIZE), tag, est_timeout);
  1248. if (result == MSG_SEND_FAILED) {
  1249. writeErrFrame(ERR_CODE_TABLE_FULL);
  1250. } else {
  1251. clearPendingReqs();
  1252. pending_req = tag; // match this to onContactResponse()
  1253. out_frame[0] = RESP_CODE_SENT;
  1254. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1255. memcpy(&out_frame[2], &tag, 4);
  1256. memcpy(&out_frame[6], &est_timeout, 4);
  1257. _serial->writeFrame(out_frame, 10);
  1258. }
  1259. } else {
  1260. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1261. }
  1262. } else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) {
  1263. uint8_t *pub_key = &cmd_frame[1];
  1264. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1265. if (recipient) {
  1266. uint32_t tag, est_timeout;
  1267. int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout);
  1268. if (result == MSG_SEND_FAILED) {
  1269. writeErrFrame(ERR_CODE_TABLE_FULL);
  1270. } else {
  1271. clearPendingReqs();
  1272. // FUTURE: pending_status = tag; // match this in onContactResponse()
  1273. memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme
  1274. out_frame[0] = RESP_CODE_SENT;
  1275. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1276. memcpy(&out_frame[2], &tag, 4);
  1277. memcpy(&out_frame[6], &est_timeout, 4);
  1278. _serial->writeFrame(out_frame, 10);
  1279. }
  1280. } else {
  1281. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1282. }
  1283. } else if (cmd_frame[0] == CMD_SEND_PATH_DISCOVERY_REQ && cmd_frame[1] == 0 && len >= 2 + PUB_KEY_SIZE) {
  1284. uint8_t *pub_key = &cmd_frame[2];
  1285. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1286. if (recipient) {
  1287. uint32_t tag, est_timeout;
  1288. // 'Path Discovery' is just a special case of flood + Telemetry req
  1289. uint8_t req_data[9];
  1290. req_data[0] = REQ_TYPE_GET_TELEMETRY_DATA;
  1291. req_data[1] = ~(TELEM_PERM_BASE); // NEW: inverse permissions mask (ie. we only want BASE telemetry)
  1292. memset(&req_data[2], 0, 3); // reserved
  1293. getRNG()->random(&req_data[5], 4); // random blob to help make packet-hash unique
  1294. auto save = recipient->out_path_len; // temporarily force sendRequest() to flood
  1295. recipient->out_path_len = -1;
  1296. int result = sendRequest(*recipient, req_data, sizeof(req_data), tag, est_timeout);
  1297. recipient->out_path_len = save;
  1298. if (result == MSG_SEND_FAILED) {
  1299. writeErrFrame(ERR_CODE_TABLE_FULL);
  1300. } else {
  1301. clearPendingReqs();
  1302. pending_discovery = tag; // match this in onContactResponse()
  1303. out_frame[0] = RESP_CODE_SENT;
  1304. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1305. memcpy(&out_frame[2], &tag, 4);
  1306. memcpy(&out_frame[6], &est_timeout, 4);
  1307. _serial->writeFrame(out_frame, 10);
  1308. }
  1309. } else {
  1310. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1311. }
  1312. } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { // can deprecate, in favour of CMD_SEND_BINARY_REQ
  1313. uint8_t *pub_key = &cmd_frame[4];
  1314. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1315. if (recipient) {
  1316. uint32_t tag, est_timeout;
  1317. int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout);
  1318. if (result == MSG_SEND_FAILED) {
  1319. writeErrFrame(ERR_CODE_TABLE_FULL);
  1320. } else {
  1321. clearPendingReqs();
  1322. pending_telemetry = tag; // match this in onContactResponse()
  1323. out_frame[0] = RESP_CODE_SENT;
  1324. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1325. memcpy(&out_frame[2], &tag, 4);
  1326. memcpy(&out_frame[6], &est_timeout, 4);
  1327. _serial->writeFrame(out_frame, 10);
  1328. }
  1329. } else {
  1330. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1331. }
  1332. } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len == 4) { // 'self' telemetry request
  1333. telemetry.reset();
  1334. telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  1335. // query other sensors -- target specific
  1336. sensors.querySensors(0xFF, telemetry);
  1337. int i = 0;
  1338. out_frame[i++] = PUSH_CODE_TELEMETRY_RESPONSE;
  1339. out_frame[i++] = 0; // reserved
  1340. memcpy(&out_frame[i], self_id.pub_key, 6);
  1341. i += 6; // pub_key_prefix
  1342. uint8_t tlen = telemetry.getSize();
  1343. memcpy(&out_frame[i], telemetry.getBuffer(), tlen);
  1344. i += tlen;
  1345. _serial->writeFrame(out_frame, i);
  1346. } else if (cmd_frame[0] == CMD_SEND_BINARY_REQ && len >= 2 + PUB_KEY_SIZE) {
  1347. uint8_t *pub_key = &cmd_frame[1];
  1348. ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE);
  1349. if (recipient) {
  1350. uint8_t *req_data = &cmd_frame[1 + PUB_KEY_SIZE];
  1351. uint32_t tag, est_timeout;
  1352. int result = sendRequest(*recipient, req_data, len - (1 + PUB_KEY_SIZE), tag, est_timeout);
  1353. if (result == MSG_SEND_FAILED) {
  1354. writeErrFrame(ERR_CODE_TABLE_FULL);
  1355. } else {
  1356. clearPendingReqs();
  1357. pending_req = tag; // match this in onContactResponse()
  1358. out_frame[0] = RESP_CODE_SENT;
  1359. out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0;
  1360. memcpy(&out_frame[2], &tag, 4);
  1361. memcpy(&out_frame[6], &est_timeout, 4);
  1362. _serial->writeFrame(out_frame, 10);
  1363. }
  1364. } else {
  1365. writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found
  1366. }
  1367. } else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) {
  1368. uint8_t *pub_key = &cmd_frame[1];
  1369. if (hasConnectionTo(pub_key)) {
  1370. writeOKFrame();
  1371. } else {
  1372. writeErrFrame(ERR_CODE_NOT_FOUND);
  1373. }
  1374. } else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) {
  1375. uint8_t *pub_key = &cmd_frame[1];
  1376. stopConnection(pub_key);
  1377. writeOKFrame();
  1378. } else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) {
  1379. uint8_t channel_idx = cmd_frame[1];
  1380. ChannelDetails channel;
  1381. if (getChannel(channel_idx, channel)) {
  1382. int i = 0;
  1383. out_frame[i++] = RESP_CODE_CHANNEL_INFO;
  1384. out_frame[i++] = channel_idx;
  1385. strcpy((char *)&out_frame[i], channel.name);
  1386. i += 32;
  1387. memcpy(&out_frame[i], channel.channel.secret, 16);
  1388. i += 16; // NOTE: only 128-bit supported
  1389. _serial->writeFrame(out_frame, i);
  1390. } else {
  1391. writeErrFrame(ERR_CODE_NOT_FOUND);
  1392. }
  1393. } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) {
  1394. writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet)
  1395. } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) {
  1396. uint8_t channel_idx = cmd_frame[1];
  1397. ChannelDetails channel;
  1398. StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32);
  1399. memset(channel.channel.secret, 0, sizeof(channel.channel.secret));
  1400. memcpy(channel.channel.secret, &cmd_frame[2 + 32], 16); // NOTE: only 128-bit supported
  1401. if (setChannel(channel_idx, channel)) {
  1402. saveChannels();
  1403. writeOKFrame();
  1404. } else {
  1405. writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx
  1406. }
  1407. } else if (cmd_frame[0] == CMD_SIGN_START) {
  1408. out_frame[0] = RESP_CODE_SIGN_START;
  1409. out_frame[1] = 0; // reserved
  1410. uint32_t len = MAX_SIGN_DATA_LEN;
  1411. memcpy(&out_frame[2], &len, 4);
  1412. _serial->writeFrame(out_frame, 6);
  1413. if (sign_data) {
  1414. free(sign_data);
  1415. }
  1416. sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN);
  1417. sign_data_len = 0;
  1418. } else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) {
  1419. if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) {
  1420. writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long
  1421. } else {
  1422. memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1);
  1423. sign_data_len += (len - 1);
  1424. writeOKFrame();
  1425. }
  1426. } else if (cmd_frame[0] == CMD_SIGN_FINISH) {
  1427. if (sign_data) {
  1428. self_id.sign(&out_frame[1], sign_data, sign_data_len);
  1429. free(sign_data); // don't need sign_data now
  1430. sign_data = NULL;
  1431. out_frame[0] = RESP_CODE_SIGNATURE;
  1432. _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE);
  1433. } else {
  1434. writeErrFrame(ERR_CODE_BAD_STATE);
  1435. }
  1436. } else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PACKET_PAYLOAD-5) {
  1437. uint8_t path_len = len - 10;
  1438. uint8_t flags = cmd_frame[9];
  1439. uint8_t path_sz = flags & 0x03; // NEW v1.11+
  1440. if ((path_len >> path_sz) > MAX_PATH_SIZE || (path_len % (1 << path_sz)) != 0) { // make sure is multiple of path_sz
  1441. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1442. } else {
  1443. uint32_t tag, auth;
  1444. memcpy(&tag, &cmd_frame[1], 4);
  1445. memcpy(&auth, &cmd_frame[5], 4);
  1446. auto pkt = createTrace(tag, auth, flags);
  1447. if (pkt) {
  1448. sendDirect(pkt, &cmd_frame[10], path_len);
  1449. uint32_t t = _radio->getEstAirtimeFor(pkt->payload_len + pkt->path_len + 2);
  1450. uint32_t est_timeout = calcDirectTimeoutMillisFor(t, path_len);
  1451. out_frame[0] = RESP_CODE_SENT;
  1452. out_frame[1] = 0;
  1453. memcpy(&out_frame[2], &tag, 4);
  1454. memcpy(&out_frame[6], &est_timeout, 4);
  1455. _serial->writeFrame(out_frame, 10);
  1456. } else {
  1457. writeErrFrame(ERR_CODE_TABLE_FULL);
  1458. }
  1459. }
  1460. } else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) {
  1461. // get pin from command frame
  1462. uint32_t pin;
  1463. memcpy(&pin, &cmd_frame[1], 4);
  1464. // ensure pin is zero, or a valid 6 digit pin
  1465. if (pin == 0 || (pin >= 100000 && pin <= 999999)) {
  1466. _prefs.ble_pin = pin;
  1467. savePrefs();
  1468. writeOKFrame();
  1469. } else {
  1470. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1471. }
  1472. } else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) {
  1473. out_frame[0] = RESP_CODE_CUSTOM_VARS;
  1474. char *dp = (char *)&out_frame[1];
  1475. for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) {
  1476. if (i > 0) {
  1477. *dp++ = ',';
  1478. }
  1479. strcpy(dp, sensors.getSettingName(i));
  1480. dp = strchr(dp, 0);
  1481. *dp++ = ':';
  1482. strcpy(dp, sensors.getSettingValue(i));
  1483. dp = strchr(dp, 0);
  1484. }
  1485. _serial->writeFrame(out_frame, dp - (char *)out_frame);
  1486. } else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) {
  1487. cmd_frame[len] = 0;
  1488. char *sp = (char *)&cmd_frame[1];
  1489. char *np = strchr(sp, ':'); // look for separator char
  1490. if (np) {
  1491. *np++ = 0; // modify 'cmd_frame', replace ':' with null
  1492. bool success = sensors.setSettingValue(sp, np);
  1493. if (success) {
  1494. #if ENV_INCLUDE_GPS == 1
  1495. // Update node preferences for GPS settings
  1496. if (strcmp(sp, "gps") == 0) {
  1497. _prefs.gps_enabled = (np[0] == '1') ? 1 : 0;
  1498. savePrefs();
  1499. } else if (strcmp(sp, "gps_interval") == 0) {
  1500. uint32_t interval_seconds = atoi(np);
  1501. _prefs.gps_interval = constrain(interval_seconds, 0, 86400);
  1502. savePrefs();
  1503. }
  1504. #endif
  1505. writeOKFrame();
  1506. } else {
  1507. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1508. }
  1509. } else {
  1510. writeErrFrame(ERR_CODE_ILLEGAL_ARG);
  1511. }
  1512. } else if (cmd_frame[0] == CMD_GET_ADVERT_PATH && len >= PUB_KEY_SIZE+2) {
  1513. // FUTURE use: uint8_t reserved = cmd_frame[1];
  1514. uint8_t *pub_key = &cmd_frame[2];
  1515. AdvertPath* found = NULL;
  1516. for (int i = 0; i < ADVERT_PATH_TABLE_SIZE; i++) {
  1517. auto p = &advert_paths[i];
  1518. if (memcmp(p->pubkey_prefix, pub_key, sizeof(p->pubkey_prefix)) == 0) {
  1519. found = p;
  1520. break;
  1521. }
  1522. }
  1523. if (found) {
  1524. out_frame[0] = RESP_CODE_ADVERT_PATH;
  1525. memcpy(&out_frame[1], &found->recv_timestamp, 4);
  1526. out_frame[5] = found->path_len;
  1527. memcpy(&out_frame[6], found->path, found->path_len);
  1528. _serial->writeFrame(out_frame, 6 + found->path_len);
  1529. } else {
  1530. writeErrFrame(ERR_CODE_NOT_FOUND);
  1531. }
  1532. } else if (cmd_frame[0] == CMD_GET_STATS && len >= 2) {
  1533. uint8_t stats_type = cmd_frame[1];
  1534. if (stats_type == STATS_TYPE_CORE) {
  1535. int i = 0;
  1536. out_frame[i++] = RESP_CODE_STATS;
  1537. out_frame[i++] = STATS_TYPE_CORE;
  1538. uint16_t battery_mv = board.getBattMilliVolts();
  1539. uint32_t uptime_secs = _ms->getMillis() / 1000;
  1540. uint8_t queue_len = (uint8_t)_mgr->getOutboundCount(0xFFFFFFFF);
  1541. memcpy(&out_frame[i], &battery_mv, 2); i += 2;
  1542. memcpy(&out_frame[i], &uptime_secs, 4); i += 4;
  1543. memcpy(&out_frame[i], &_err_flags, 2); i += 2;
  1544. out_frame[i++] = queue_len;
  1545. _serial->writeFrame(out_frame, i);
  1546. } else if (stats_type == STATS_TYPE_RADIO) {
  1547. int i = 0;
  1548. out_frame[i++] = RESP_CODE_STATS;
  1549. out_frame[i++] = STATS_TYPE_RADIO;
  1550. int16_t noise_floor = (int16_t)_radio->getNoiseFloor();
  1551. int8_t last_rssi = (int8_t)radio_driver.getLastRSSI();
  1552. int8_t last_snr = (int8_t)(radio_driver.getLastSNR() * 4); // scaled by 4 for 0.25 dB precision
  1553. uint32_t tx_air_secs = getTotalAirTime() / 1000;
  1554. uint32_t rx_air_secs = getReceiveAirTime() / 1000;
  1555. memcpy(&out_frame[i], &noise_floor, 2); i += 2;
  1556. out_frame[i++] = last_rssi;
  1557. out_frame[i++] = last_snr;
  1558. memcpy(&out_frame[i], &tx_air_secs, 4); i += 4;
  1559. memcpy(&out_frame[i], &rx_air_secs, 4); i += 4;
  1560. _serial->writeFrame(out_frame, i);
  1561. } else if (stats_type == STATS_TYPE_PACKETS) {
  1562. int i = 0;
  1563. out_frame[i++] = RESP_CODE_STATS;
  1564. out_frame[i++] = STATS_TYPE_PACKETS;
  1565. uint32_t recv = radio_driver.getPacketsRecv();
  1566. uint32_t sent = radio_driver.getPacketsSent();
  1567. uint32_t n_sent_flood = getNumSentFlood();
  1568. uint32_t n_sent_direct = getNumSentDirect();
  1569. uint32_t n_recv_flood = getNumRecvFlood();
  1570. uint32_t n_recv_direct = getNumRecvDirect();
  1571. memcpy(&out_frame[i], &recv, 4); i += 4;
  1572. memcpy(&out_frame[i], &sent, 4); i += 4;
  1573. memcpy(&out_frame[i], &n_sent_flood, 4); i += 4;
  1574. memcpy(&out_frame[i], &n_sent_direct, 4); i += 4;
  1575. memcpy(&out_frame[i], &n_recv_flood, 4); i += 4;
  1576. memcpy(&out_frame[i], &n_recv_direct, 4); i += 4;
  1577. _serial->writeFrame(out_frame, i);
  1578. } else {
  1579. writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid stats sub-type
  1580. }
  1581. } else if (cmd_frame[0] == CMD_FACTORY_RESET && memcmp(&cmd_frame[1], "reset", 5) == 0) {
  1582. if (_serial) {
  1583. MESH_DEBUG_PRINTLN("Factory reset: disabling serial interface to prevent reconnects (BLE/WiFi)");
  1584. _serial->disable(); // Phone app disconnects before we can send OK frame so it's safe here
  1585. }
  1586. bool success = _store->formatFileSystem();
  1587. if (success) {
  1588. writeOKFrame();
  1589. delay(1000);
  1590. board.reboot(); // doesn't return
  1591. } else {
  1592. writeErrFrame(ERR_CODE_FILE_IO_ERROR);
  1593. }
  1594. } else if (cmd_frame[0] == CMD_SET_FLOOD_SCOPE && len >= 2 && cmd_frame[1] == 0) {
  1595. if (len >= 2 + 16) {
  1596. memcpy(send_scope.key, &cmd_frame[2], sizeof(send_scope.key)); // set curr scope TransportKey
  1597. } else {
  1598. memset(send_scope.key, 0, sizeof(send_scope.key)); // set scope to null
  1599. }
  1600. writeOKFrame();
  1601. } else if (cmd_frame[0] == CMD_SEND_CONTROL_DATA && len >= 2 && (cmd_frame[1] & 0x80) != 0) {
  1602. auto resp = createControlData(&cmd_frame[1], len - 1);
  1603. if (resp) {
  1604. sendZeroHop(resp);
  1605. writeOKFrame();
  1606. } else {
  1607. writeErrFrame(ERR_CODE_TABLE_FULL);
  1608. }
  1609. } else if (cmd_frame[0] == CMD_SET_AUTOADD_CONFIG) {
  1610. _prefs.autoadd_config = cmd_frame[1];
  1611. savePrefs();
  1612. writeOKFrame();
  1613. } else if (cmd_frame[0] == CMD_GET_AUTOADD_CONFIG) {
  1614. int i = 0;
  1615. out_frame[i++] = RESP_CODE_AUTOADD_CONFIG;
  1616. out_frame[i++] = _prefs.autoadd_config;
  1617. _serial->writeFrame(out_frame, i);
  1618. } else {
  1619. writeErrFrame(ERR_CODE_UNSUPPORTED_CMD);
  1620. MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]);
  1621. }
  1622. }
  1623. void MyMesh::enterCLIRescue() {
  1624. _cli_rescue = true;
  1625. cli_command[0] = 0;
  1626. Serial.println("========= CLI Rescue =========");
  1627. }
  1628. void MyMesh::checkCLIRescueCmd() {
  1629. int len = strlen(cli_command);
  1630. while (Serial.available() && len < sizeof(cli_command)-1) {
  1631. char c = Serial.read();
  1632. if (c != '\n') {
  1633. cli_command[len++] = c;
  1634. cli_command[len] = 0;
  1635. }
  1636. Serial.print(c); // echo
  1637. }
  1638. if (len == sizeof(cli_command)-1) { // command buffer full
  1639. cli_command[sizeof(cli_command)-1] = '\r';
  1640. }
  1641. if (len > 0 && cli_command[len - 1] == '\r') { // received complete line
  1642. cli_command[len - 1] = 0; // replace newline with C string null terminator
  1643. if (memcmp(cli_command, "set ", 4) == 0) {
  1644. const char* config = &cli_command[4];
  1645. if (memcmp(config, "pin ", 4) == 0) {
  1646. _prefs.ble_pin = atoi(&config[4]);
  1647. savePrefs();
  1648. Serial.printf(" > pin is now %06d\n", _prefs.ble_pin);
  1649. } else {
  1650. Serial.printf(" Error: unknown config: %s\n", config);
  1651. }
  1652. } else if (strcmp(cli_command, "rebuild") == 0) {
  1653. bool success = _store->formatFileSystem();
  1654. if (success) {
  1655. _store->saveMainIdentity(self_id);
  1656. savePrefs();
  1657. saveContacts();
  1658. saveChannels();
  1659. Serial.println(" > erase and rebuild done");
  1660. } else {
  1661. Serial.println(" Error: erase failed");
  1662. }
  1663. } else if (strcmp(cli_command, "erase") == 0) {
  1664. bool success = _store->formatFileSystem();
  1665. if (success) {
  1666. Serial.println(" > erase done");
  1667. } else {
  1668. Serial.println(" Error: erase failed");
  1669. }
  1670. } else if (memcmp(cli_command, "ls", 2) == 0) {
  1671. // get path from command e.g: "ls /adafruit"
  1672. const char *path = &cli_command[3];
  1673. bool is_fs2 = false;
  1674. if (memcmp(path, "UserData/", 9) == 0) {
  1675. path += 8; // skip "UserData"
  1676. } else if (memcmp(path, "ExtraFS/", 8) == 0) {
  1677. path += 7; // skip "ExtraFS"
  1678. is_fs2 = true;
  1679. }
  1680. Serial.printf("Listing files in %s\n", path);
  1681. // log each file and directory
  1682. File root = _store->openRead(path);
  1683. if (is_fs2 == false) {
  1684. if (root) {
  1685. File file = root.openNextFile();
  1686. while (file) {
  1687. if (file.isDirectory()) {
  1688. Serial.printf("[dir] UserData%s/%s\n", path, file.name());
  1689. } else {
  1690. Serial.printf("[file] UserData%s/%s (%d bytes)\n", path, file.name(), file.size());
  1691. }
  1692. // move to next file
  1693. file = root.openNextFile();
  1694. }
  1695. root.close();
  1696. }
  1697. }
  1698. if (is_fs2 == true || strlen(path) == 0 || strcmp(path, "/") == 0) {
  1699. if (_store->getSecondaryFS() != nullptr) {
  1700. File root2 = _store->openRead(_store->getSecondaryFS(), path);
  1701. File file = root2.openNextFile();
  1702. while (file) {
  1703. if (file.isDirectory()) {
  1704. Serial.printf("[dir] ExtraFS%s/%s\n", path, file.name());
  1705. } else {
  1706. Serial.printf("[file] ExtraFS%s/%s (%d bytes)\n", path, file.name(), file.size());
  1707. }
  1708. // move to next file
  1709. file = root2.openNextFile();
  1710. }
  1711. root2.close();
  1712. }
  1713. }
  1714. } else if (memcmp(cli_command, "cat", 3) == 0) {
  1715. // get path from command e.g: "cat /contacts3"
  1716. const char *path = &cli_command[4];
  1717. bool is_fs2 = false;
  1718. if (memcmp(path, "UserData/", 9) == 0) {
  1719. path += 8; // skip "UserData"
  1720. } else if (memcmp(path, "ExtraFS/", 8) == 0) {
  1721. path += 7; // skip "ExtraFS"
  1722. is_fs2 = true;
  1723. } else {
  1724. Serial.println("Invalid path provided, must start with UserData/ or ExtraFS/");
  1725. cli_command[0] = 0;
  1726. return;
  1727. }
  1728. // log file content as hex
  1729. File file = _store->openRead(path);
  1730. if (is_fs2 == true) {
  1731. file = _store->openRead(_store->getSecondaryFS(), path);
  1732. }
  1733. if(file){
  1734. // get file content
  1735. int file_size = file.available();
  1736. uint8_t buffer[file_size];
  1737. file.read(buffer, file_size);
  1738. // print hex
  1739. mesh::Utils::printHex(Serial, buffer, file_size);
  1740. Serial.print("\n");
  1741. file.close();
  1742. }
  1743. } else if (memcmp(cli_command, "rm ", 3) == 0) {
  1744. // get path from command e.g: "rm /adv_blobs"
  1745. const char *path = &cli_command[3];
  1746. MESH_DEBUG_PRINTLN("Removing file: %s", path);
  1747. // ensure path is not empty, or root dir
  1748. if(!path || strlen(path) == 0 || strcmp(path, "/") == 0){
  1749. Serial.println("Invalid path provided");
  1750. } else {
  1751. bool is_fs2 = false;
  1752. if (memcmp(path, "UserData/", 9) == 0) {
  1753. path += 8; // skip "UserData"
  1754. } else if (memcmp(path, "ExtraFS/", 8) == 0) {
  1755. path += 7; // skip "ExtraFS"
  1756. is_fs2 = true;
  1757. }
  1758. // remove file
  1759. bool removed;
  1760. if (is_fs2) {
  1761. MESH_DEBUG_PRINTLN("Removing file from ExtraFS: %s", path);
  1762. removed = _store->removeFile(_store->getSecondaryFS(), path);
  1763. } else {
  1764. MESH_DEBUG_PRINTLN("Removing file from UserData: %s", path);
  1765. removed = _store->removeFile(path);
  1766. }
  1767. if(removed){
  1768. Serial.println("File removed");
  1769. } else {
  1770. Serial.println("Failed to remove file");
  1771. }
  1772. }
  1773. } else if (strcmp(cli_command, "reboot") == 0) {
  1774. board.reboot(); // doesn't return
  1775. } else {
  1776. Serial.println(" Error: unknown command");
  1777. }
  1778. cli_command[0] = 0; // reset command buffer
  1779. }
  1780. }
  1781. void MyMesh::checkSerialInterface() {
  1782. size_t len = _serial->checkRecvFrame(cmd_frame);
  1783. if (len > 0) {
  1784. handleCmdFrame(len);
  1785. } else if (_iter_started // check if our ContactsIterator is 'running'
  1786. && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly!
  1787. ) {
  1788. ContactInfo contact;
  1789. if (_iter.hasNext(this, contact)) {
  1790. if (contact.lastmod > _iter_filter_since) { // apply the 'since' filter
  1791. writeContactRespFrame(RESP_CODE_CONTACT, contact);
  1792. if (contact.lastmod > _most_recent_lastmod) {
  1793. _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame
  1794. }
  1795. }
  1796. } else { // EOF
  1797. out_frame[0] = RESP_CODE_END_OF_CONTACTS;
  1798. memcpy(&out_frame[1], &_most_recent_lastmod,
  1799. 4); // include the most recent lastmod, so app can update their 'since'
  1800. _serial->writeFrame(out_frame, 5);
  1801. _iter_started = false;
  1802. }
  1803. //} else if (!_serial->isWriteBusy()) {
  1804. // checkConnections(); // TODO - deprecate the 'Connections' stuff
  1805. }
  1806. }
  1807. void MyMesh::loop() {
  1808. BaseChatMesh::loop();
  1809. if (_cli_rescue) {
  1810. checkCLIRescueCmd();
  1811. } else {
  1812. checkSerialInterface();
  1813. }
  1814. // is there are pending dirty contacts write needed?
  1815. if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
  1816. saveContacts();
  1817. dirty_contacts_expiry = 0;
  1818. }
  1819. #ifdef DISPLAY_CLASS
  1820. if (_ui) _ui->setHasConnection(_serial->isConnected());
  1821. #endif
  1822. }
  1823. bool MyMesh::advert() {
  1824. mesh::Packet* pkt;
  1825. if (_prefs.advert_loc_policy == ADVERT_LOC_NONE) {
  1826. pkt = createSelfAdvert(_prefs.node_name);
  1827. } else {
  1828. pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon);
  1829. }
  1830. if (pkt) {
  1831. sendZeroHop(pkt);
  1832. return true;
  1833. } else {
  1834. return false;
  1835. }
  1836. }