MyMesh.cpp 74 KB

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