MyMesh.cpp 83 KB

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