MyMesh.cpp 81 KB

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