MyMesh.cpp 64 KB

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