MyMesh.cpp 72 KB

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