MyMesh.cpp 77 KB

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