MyMesh.cpp 74 KB

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