MyMesh.cpp 78 KB

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