MyMesh.cpp 82 KB

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