MyMesh.cpp 61 KB

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