MyMesh.cpp 75 KB

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