MyMesh.cpp 67 KB

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