MyMesh.cpp 75 KB

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