From bb5509d43e59f9a207c526b2eb676cb2b5fedb44 Mon Sep 17 00:00:00 2001 From: Matthew Sainsbury Date: Mon, 26 May 2025 18:22:31 -0700 Subject: [PATCH 01/87] initial try at documenting payload formats --- docs/payloads.md | 176 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 176 insertions(+) create mode 100644 docs/payloads.md diff --git a/docs/payloads.md b/docs/payloads.md new file mode 100644 index 00000000..2c402102 --- /dev/null +++ b/docs/payloads.md @@ -0,0 +1,176 @@ +# Meshcore payloads +Inside of each [meshcore packet](./packet_structure.md) is a payload, identified by the payload type in the packet header. The types of payloads are: + +* Request (destination/source hashes + MAC). +* Response to REQ or ANON_REQ. +* Plain text message. +* Acknowledgment. +* Node advertisement. +* Group text message (unverified). +* Group datagram (unverified). +* Anonymous request. +* Returned path. +* Custom packet (raw bytes, custom encryption). + +This document defines the structure of each of these payload types + +# Node advertisement +This kind of payload notifies receivers that a node exists, and gives information about the node + +| Field | Size (bytes) | Description | +|---------------|-----------------|----------------------------------------------------------| +| public key | 32 | Ed25519 public key | +| timestamp | 4 | unix timestamp of advertisement | +| signature | 64 | Ed25519 signature of public key, timestamp, and app data | +| appdata | rest of payload | optional, see below | + +Appdata + +| Field | Size (bytes) | Description | +|---------------|-----------------|-------------------------------------------------------| +| flags | 1 | specifies which of the fields are present, see below | +| latitude | 4 | decimal latitude multiplied by 1000000, integer | +| longitude | 4 | decimal longitude multiplied by 1000000, integer | +| feature 1 | 2 | reserved for future use | +| feature 2 | 2 | reserved for future use | +| name | rest of appdata | name of the node | + +Appdata Flags + +| Value | Name | Description | +|--------|-----------|---------------------------------------| +| `0x10` | location | appdata contains lat/long information | +| `0x20` | feature 1 | Reserved for future use. | +| `0x40` | feature 2 | Reserved for future use. | +| `0x80` | name | appdata contains a node name | + +# Acknowledgement +| Field | Size (bytes) | Description | +|----------|--------------|------------------------------------------------------------| +| checksum | 4 | CRC checksum of message timestamp, text, and sender pubkey | + + +# Returned path, request, response, and plain text message +| Field | Size (bytes) | Description | +|------------------|-----------------|------------------------------------------------------| +| destination hash | 1 | first byte of destination node public key | +| source hash | 1 | first byte of source node public key | +| cipher MAC | 2 | MAC for encrypted data in next field | +| ciphertext | rest of payload | encrypted message, see subsections below for details | + +## Returned path + +| Field | Size (bytes) | Description | +|-------------|--------------|----------------------------------------------------------------------------------------------| +| path length | 1 | length of next field | +| path | see above | a list of node hashes (one byte each) describing the route from us to the packet author | +| extra type | 1 | extra, bundled payload type, eg., acknowledgement or response. See packet structure spec | +| extra | rest of data | extra, bundled payload content, follows same format as main content defined by this document | + +## Request + +| Field | Size (bytes) | Description | +|--------------|-----------------|----------------------------| +| timestamp | 4 | send time (unix timestamp) | +| request type | 1 | see below | +| request data | rest of payload | depends on request type | + +Request type + +| Value | Name | Description | +|--------|--------------------|---------------------------------------| +| `0x01` | get status | get status of repeater or room server | +| `0x02` | keepalive | TODO | +| `0x03` | get telemetry data | TODO | + +### Get status + +Gets information about the node, possibly including the following: + +* Battery level (millivolts) +* Current transmit queue length +* Current free queue length +* Last RSSI value +* Number of received packets +* Number of sent packets +* Total airtime (seconds) +* Total uptime (seconds) +* Number of packets sent as flood +* Number of packets sent directly +* Number of packets received as flood +* Number of packets received directly +* Error flags +* Last SNR value +* Number of direct route duplicates +* Number of flood route duplicates +* Number posted (?) +* Number of post pushes (?) + +### Keepalive + +No-op request. + +### Get telemetry data + +Request data about sensors on the node, including battery level. + +## Response + +| Field | Size (bytes) | Description | +|---------|-----------------|-------------| +| tag | 4 | TODO | +| content | rest of payload | TODO | + +## Plain text message + +| Field | Size (bytes) | Description | +|--------------|-----------------|--------------------------------------------------------------| +| timestamp | 4 | send time (unix timestamp) | +| flags + TODO | 1 | first six bits are flags (see below), last two bits are TODO | +| message | rest of payload | the message content, see next table | + +Flags + +| Value | Description | Message content | +|--------|---------------------------|------------------------------------------------------------| +| `0x00` | plain text message | the plain text of the message | +| `0x01` | CLI command | the command text of the message | +| `0x02` | signed plain text message | two bytes of sender prefix, followed by plain text message | + +# Anonymous request + +| Field | Size (bytes) | Description | +|------------------|-----------------|-------------------------------------------| +| destination hash | 1 | first byte of destination node public key | +| public key | 32 | sender's Ed25519 public key | +| cipher MAC | 2 | MAC for encrypted data in next field | +| ciphertext | rest of payload | encrypted message, see below for details | + +Plaintext message + +| Field | Size (bytes) | Description | +|----------------|-----------------|-------------------------------------------------------------------------------| +| timestamp | 4 | send time (unix timestamp) | +| sync timestamp | 4 | for room server, otherwise absent: sender's "sync messages SINCE x" timestamp | +| password | rest of message | password for repeater/room | + +# Group text message / datagram + +| Field | Size (bytes) | Description | +|--------------|-----------------|------------------------------------------| +| channel hash | 1 | TODO | +| cipher MAC | 2 | MAC for encrypted data in next field | +| ciphertext | rest of payload | encrypted message, see below for details | + +Plaintext for text message + +| Field | Size (bytes) | Description | +|-----------|-----------------|----------------------------------| +| timestamp | 4 | send time (unix timestamp) | +| content | rest of message | plain group text message content | + +TODO: describe what datagram looks like + +# Custom packet + +Custom packets have no defined format. \ No newline at end of file From f58a34f5f4c201db63f3da9ce58d5b0f69c0fd6f Mon Sep 17 00:00:00 2001 From: hank Date: Thu, 29 May 2025 13:06:24 -0700 Subject: [PATCH 02/87] Refactored MyMesh, advert on doublepress Pulled the class out of main.cpp, made a header to go along with it, externed globals in headers to make them accessible to button code. Added button code to send an advert on double press. Refactored ini files to prevent linker errors. --- examples/companion_radio/MyMesh.cpp | 1819 ++++++++++++++++++++++++ examples/companion_radio/MyMesh.h | 283 ++++ examples/companion_radio/UITask.cpp | 11 +- examples/companion_radio/UITask.h | 4 +- examples/companion_radio/main.cpp | 1588 +-------------------- variants/generic_espnow/platformio.ini | 2 +- variants/promicro/platformio.ini | 4 +- variants/t114/platformio.ini | 4 +- variants/xiao_nrf52/platformio.ini | 4 +- variants/xiao_s3_wio/platformio.ini | 2 +- 10 files changed, 2135 insertions(+), 1586 deletions(-) create mode 100644 examples/companion_radio/MyMesh.cpp create mode 100644 examples/companion_radio/MyMesh.h diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp new file mode 100644 index 00000000..6e9688a5 --- /dev/null +++ b/examples/companion_radio/MyMesh.cpp @@ -0,0 +1,1819 @@ +#include // needed for PlatformIO +#include +#include "MyMesh.h" + +#ifdef DISPLAY_CLASS + #include "UITask.h" +#endif + +void MyMesh::loadMainIdentity() +{ + if (!_identity_store->load("_main", self_id)) + { + self_id = radio_new_identity(); // create new random identity + int count = 0; + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) + { // reserved id hashes + self_id = radio_new_identity(); + count++; + } + saveMainIdentity(self_id); + } +} + +bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) +{ + return _identity_store->save("_main", identity); +} + +void MyMesh::loadContacts() +{ + if (_fs->exists("/contacts3")) + { +#if defined(RP2040_PLATFORM) + File file = _fs->open("/contacts3", "r"); +#else + File file = _fs->open("/contacts3"); +#endif + if (file) + { + bool full = false; + while (!full) + { + ContactInfo c; + uint8_t pub_key[32]; + uint8_t unused; + + bool success = (file.read(pub_key, 32) == 32); + success = success && (file.read((uint8_t *)&c.name, 32) == 32); + success = success && (file.read(&c.type, 1) == 1); + success = success && (file.read(&c.flags, 1) == 1); + success = success && (file.read(&unused, 1) == 1); + success = success && (file.read((uint8_t *)&c.sync_since, 4) == 4); // was 'reserved' + success = success && (file.read((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.read((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.read(c.out_path, 64) == 64); + success = success && (file.read((uint8_t *)&c.lastmod, 4) == 4); + success = success && (file.read((uint8_t *)&c.gps_lat, 4) == 4); + success = success && (file.read((uint8_t *)&c.gps_lon, 4) == 4); + + if (!success) + break; // EOF + + c.id = mesh::Identity(pub_key); + if (!addContact(c)) + full = true; + } + file.close(); + } + } +} + +void MyMesh::saveContacts() +{ +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/contacts3"); + File file = _fs->open("/contacts3", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/contacts3", "w"); +#else + File file = _fs->open("/contacts3", "w", true); +#endif + if (file) + { + ContactsIterator iter; + ContactInfo c; + uint8_t unused = 0; + + while (iter.hasNext(this, c)) + { + bool success = (file.write(c.id.pub_key, 32) == 32); + success = success && (file.write((uint8_t *)&c.name, 32) == 32); + success = success && (file.write(&c.type, 1) == 1); + success = success && (file.write(&c.flags, 1) == 1); + success = success && (file.write(&unused, 1) == 1); + success = success && (file.write((uint8_t *)&c.sync_since, 4) == 4); + success = success && (file.write((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.write((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.write(c.out_path, 64) == 64); + success = success && (file.write((uint8_t *)&c.lastmod, 4) == 4); + success = success && (file.write((uint8_t *)&c.gps_lat, 4) == 4); + success = success && (file.write((uint8_t *)&c.gps_lon, 4) == 4); + + if (!success) + break; // write failed + } + file.close(); + } +} + +void MyMesh::loadChannels() +{ + if (_fs->exists("/channels2")) + { +#if defined(RP2040_PLATFORM) + File file = _fs->open("/channels2", "r"); +#else + File file = _fs->open("/channels2"); +#endif + if (file) + { + bool full = false; + uint8_t channel_idx = 0; + while (!full) + { + ChannelDetails ch; + uint8_t unused[4]; + + bool success = (file.read(unused, 4) == 4); + success = success && (file.read((uint8_t *)ch.name, 32) == 32); + success = success && (file.read((uint8_t *)ch.channel.secret, 32) == 32); + + if (!success) + break; // EOF + + if (setChannel(channel_idx, ch)) + { + channel_idx++; + } + else + { + full = true; + } + } + file.close(); + } + } +} + +void MyMesh::saveChannels() +{ +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/channels2"); + File file = _fs->open("/channels2", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/channels2", "w"); +#else + File file = _fs->open("/channels2", "w", true); +#endif + if (file) + { + uint8_t channel_idx = 0; + ChannelDetails ch; + uint8_t unused[4]; + memset(unused, 0, 4); + + while (getChannel(channel_idx, ch)) + { + bool success = (file.write(unused, 4) == 4); + success = success && (file.write((uint8_t *)ch.name, 32) == 32); + success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); + + if (!success) + break; // write failed + channel_idx++; + } + file.close(); + } +} + +int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) +{ + char path[64]; + char fname[18]; + + if (key_len > 8) + key_len = 8; // just use first 8 bytes (prefix) + mesh::Utils::toHex(fname, key, key_len); + sprintf(path, "/bl/%s", fname); + + if (_fs->exists(path)) + { +#if defined(RP2040_PLATFORM) + File f = _fs->open(path, "r"); +#else + File f = _fs->open(path); +#endif + if (f) + { + int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! + f.close(); + return len; + } + } + return 0; // not found +} + +bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) +{ + char path[64]; + char fname[18]; + + if (key_len > 8) + key_len = 8; // just use first 8 bytes (prefix) + mesh::Utils::toHex(fname, key, key_len); + sprintf(path, "/bl/%s", fname); + +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove(path); + File f = _fs->open(path, FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File f = _fs->open(path, "w"); +#else + File f = _fs->open(path, "w", true); +#endif + if (f) + { + int n = f.write(src_buf, len); + f.close(); + if (n == len) + return true; // success! + + _fs->remove(path); // blob was only partially written! + } + return false; // error +} + +void MyMesh::writeOKFrame() +{ + uint8_t buf[1]; + buf[0] = RESP_CODE_OK; + _serial->writeFrame(buf, 1); +} +void MyMesh::writeErrFrame(uint8_t err_code) +{ + uint8_t buf[2]; + buf[0] = RESP_CODE_ERR; + buf[1] = err_code; + _serial->writeFrame(buf, 2); +} + +void MyMesh::writeDisabledFrame() +{ + uint8_t buf[1]; + buf[0] = RESP_CODE_DISABLED; + _serial->writeFrame(buf, 1); +} + +void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) +{ + int i = 0; + out_frame[i++] = code; + memcpy(&out_frame[i], contact.id.pub_key, PUB_KEY_SIZE); + i += PUB_KEY_SIZE; + out_frame[i++] = contact.type; + out_frame[i++] = contact.flags; + out_frame[i++] = contact.out_path_len; + memcpy(&out_frame[i], contact.out_path, MAX_PATH_SIZE); + i += MAX_PATH_SIZE; + StrHelper::strzcpy((char *)&out_frame[i], contact.name, 32); + i += 32; + memcpy(&out_frame[i], &contact.last_advert_timestamp, 4); + i += 4; + memcpy(&out_frame[i], &contact.gps_lat, 4); + i += 4; + memcpy(&out_frame[i], &contact.gps_lon, 4); + i += 4; + memcpy(&out_frame[i], &contact.lastmod, 4); + i += 4; + _serial->writeFrame(out_frame, i); +} + +void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len) +{ + int i = 0; + uint8_t code = frame[i++]; // eg. CMD_ADD_UPDATE_CONTACT + memcpy(contact.id.pub_key, &frame[i], PUB_KEY_SIZE); + i += PUB_KEY_SIZE; + contact.type = frame[i++]; + contact.flags = frame[i++]; + contact.out_path_len = frame[i++]; + memcpy(contact.out_path, &frame[i], MAX_PATH_SIZE); + i += MAX_PATH_SIZE; + memcpy(contact.name, &frame[i], 32); + i += 32; + memcpy(&contact.last_advert_timestamp, &frame[i], 4); + i += 4; + if (i + 8 >= len) + { // optional fields + memcpy(&contact.gps_lat, &frame[i], 4); + i += 4; + memcpy(&contact.gps_lon, &frame[i], 4); + i += 4; + } +} + +void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) +{ + if (offline_queue_len >= OFFLINE_QUEUE_SIZE) + { + MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); + } + else + { + offline_queue[offline_queue_len].len = len; + memcpy(offline_queue[offline_queue_len].buf, frame, len); + offline_queue_len++; + } +} +int MyMesh::getFromOfflineQueue(uint8_t frame[]) +{ + if (offline_queue_len > 0) + { // check offline queue + size_t len = offline_queue[0].len; // take from top of queue + memcpy(frame, offline_queue[0].buf, len); + + offline_queue_len--; + for (int i = 0; i < offline_queue_len; i++) + { // delete top item from queue + offline_queue[i] = offline_queue[i + 1]; + } + return len; + } + return 0; // queue is empty +} + +float MyMesh::getAirtimeBudgetFactor() const +{ + return _prefs.airtime_factor; +} + +int MyMesh::getInterferenceThreshold() const +{ + return 14; // hard-coded for now +} + +int MyMesh::calcRxDelay(float score, uint32_t air_time) const +{ + if (_prefs.rx_delay_base <= 0.0f) + return 0; + return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time); +} + +void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) +{ + if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) + { + int i = 0; + out_frame[i++] = PUSH_CODE_LOG_RX_DATA; + out_frame[i++] = (int8_t)(snr * 4); + out_frame[i++] = (int8_t)(rssi); + memcpy(&out_frame[i], raw, len); + i += len; + + _serial->writeFrame(out_frame, i); + } +} + +bool MyMesh::isAutoAddEnabled() const +{ + return (_prefs.manual_add_contacts & 1) == 0; +} + +void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) +{ + if (_serial->isConnected()) + { + if (!isAutoAddEnabled() && is_new) + { + writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); + } + else + { + out_frame[0] = PUSH_CODE_ADVERT; + memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); + _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); + } + } + else + { +#ifdef DISPLAY_CLASS + ui_task.soundBuzzer(UIEventType::newContactMessage); +#endif + } + + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); +} + +void MyMesh::onContactPathUpdated(const ContactInfo &contact) +{ + out_frame[0] = PUSH_CODE_PATH_UPDATED; + memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); + _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected + + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); +} + +bool MyMesh::processAck(const uint8_t *data) +{ + // see if matches any in a table + for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) + { + if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) + { // got an ACK from recipient + out_frame[0] = PUSH_CODE_SEND_CONFIRMED; + memcpy(&out_frame[1], data, 4); + uint32_t trip_time = _ms->getMillis() - expected_ack_table[i].msg_sent; + memcpy(&out_frame[5], &trip_time, 4); + _serial->writeFrame(out_frame, 9); + + // NOTE: the same ACK can be received multiple times! + expected_ack_table[i].ack = 0; // clear expected hash, now that we have received ACK + return true; + } + } + return checkConnectionsAck(data); +} + +void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) +{ + int i = 0; + if (app_target_ver >= 3) + { + out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; + out_frame[i++] = (int8_t)(pkt->getSNR() * 4); + out_frame[i++] = 0; // reserved1 + out_frame[i++] = 0; // reserved2 + } + else + { + out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; + } + memcpy(&out_frame[i], from.id.pub_key, 6); + i += 6; // just 6-byte prefix + uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF; + out_frame[i++] = txt_type; + memcpy(&out_frame[i], &sender_timestamp, 4); + i += 4; + if (extra_len > 0) + { + memcpy(&out_frame[i], extra, extra_len); + i += extra_len; + } + int tlen = strlen(text); // TODO: UTF-8 ?? + if (i + tlen > MAX_FRAME_SIZE) + { + tlen = MAX_FRAME_SIZE - i; + } + memcpy(&out_frame[i], text, tlen); + i += tlen; + addToOfflineQueue(out_frame, i); + + if (_serial->isConnected()) + { + uint8_t frame[1]; + frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' + _serial->writeFrame(frame, 1); + } + else + { +#ifdef DISPLAY_CLASS + ui_task.soundBuzzer(UIEventType::contactMessage); +#endif + } +#ifdef DISPLAY_CLASS + ui_task.newMsg(path_len, from.name, text, offline_queue_len); +#endif +} + +void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +{ + markConnectionActive(from); // in case this is from a server, and we have a connection + queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); +} + +void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +{ + markConnectionActive(from); // in case this is from a server, and we have a connection + queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); +} + +void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) +{ + markConnectionActive(from); + // from.sync_since change needs to be persisted + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); + queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text); +} + +void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, const char *text) +{ + int i = 0; + if (app_target_ver >= 3) + { + out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; + out_frame[i++] = (int8_t)(pkt->getSNR() * 4); + out_frame[i++] = 0; // reserved1 + out_frame[i++] = 0; // reserved2 + } + else + { + out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; + } + + out_frame[i++] = findChannelIdx(channel); + uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF; + + out_frame[i++] = TXT_TYPE_PLAIN; + memcpy(&out_frame[i], ×tamp, 4); + i += 4; + int tlen = strlen(text); // TODO: UTF-8 ?? + if (i + tlen > MAX_FRAME_SIZE) + { + tlen = MAX_FRAME_SIZE - i; + } + memcpy(&out_frame[i], text, tlen); + i += tlen; + addToOfflineQueue(out_frame, i); + + if (_serial->isConnected()) + { + uint8_t frame[1]; + frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' + _serial->writeFrame(frame, 1); + } + else + { +#ifdef DISPLAY_CLASS + ui_task.soundBuzzer(UIEventType::channelMessage); +#endif + } +#ifdef DISPLAY_CLASS + ui_task.newMsg(path_len, "Public", text, offline_queue_len); +#endif +} + +uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, uint8_t len, uint8_t *reply) +{ + if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) + { + uint8_t permissions = 0; + uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) + + if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) + { + permissions = TELEM_PERM_BASE; + } + else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) + { + permissions = cp & TELEM_PERM_BASE; + } + + if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) + { + permissions |= TELEM_PERM_LOCATION; + } + else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) + { + permissions |= cp & TELEM_PERM_LOCATION; + } + + if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) + { + permissions |= TELEM_PERM_ENVIRONMENT; + } + else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) + { + permissions |= cp & TELEM_PERM_ENVIRONMENT; + } + + if (permissions & TELEM_PERM_BASE) + { // only respond if base permission bit is set + telemetry.reset(); + telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); + // query other sensors -- target specific + sensors.querySensors(permissions, telemetry); + + memcpy(reply, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') + + uint8_t tlen = telemetry.getSize(); + memcpy(&reply[4], telemetry.getBuffer(), tlen); + return 4 + tlen; + } + } + return 0; // unknown +} + +void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) +{ + uint32_t tag; + memcpy(&tag, data, 4); + + if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) + { // check for login response + // yes, is response to pending sendLogin() + pending_login = 0; + + int i = 0; + if (memcmp(&data[4], "OK", 2) == 0) + { // legacy Repeater login OK response + out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; + out_frame[i++] = 0; // legacy: is_admin = false + memcpy(&out_frame[i], contact.id.pub_key, 6); + i += 6; // pub_key_prefix + } + else if (data[4] == RESP_SERVER_LOGIN_OK) + { // new login response + uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; + if (keep_alive_secs > 0) + { + startConnection(contact, keep_alive_secs); + } + out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; + out_frame[i++] = data[6]; // permissions (eg. is_admin) + memcpy(&out_frame[i], contact.id.pub_key, 6); + i += 6; // pub_key_prefix + memcpy(&out_frame[i], &tag, 4); + i += 4; // NEW: include server timestamp + } + else + { + out_frame[i++] = PUSH_CODE_LOGIN_FAIL; + out_frame[i++] = 0; // reserved + memcpy(&out_frame[i], contact.id.pub_key, 6); + i += 6; // pub_key_prefix + } + _serial->writeFrame(out_frame, i); + } + else if (len > 4 && // check for status response + pending_status && memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme + // FUTURE: tag == pending_status + ) + { + pending_status = 0; + + int i = 0; + out_frame[i++] = PUSH_CODE_STATUS_RESPONSE; + out_frame[i++] = 0; // reserved + memcpy(&out_frame[i], contact.id.pub_key, 6); + i += 6; // pub_key_prefix + memcpy(&out_frame[i], &data[4], len - 4); + i += (len - 4); + _serial->writeFrame(out_frame, i); + } + else if (len > 4 && tag == pending_telemetry) + { // check for telemetry response + pending_telemetry = 0; + + int i = 0; + out_frame[i++] = PUSH_CODE_TELEMETRY_RESPONSE; + out_frame[i++] = 0; // reserved + memcpy(&out_frame[i], contact.id.pub_key, 6); + i += 6; // pub_key_prefix + memcpy(&out_frame[i], &data[4], len - 4); + i += (len - 4); + _serial->writeFrame(out_frame, i); + } +} + +void MyMesh::onRawDataRecv(mesh::Packet *packet) +{ + if (packet->payload_len + 4 > sizeof(out_frame)) + { + MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); + return; + } + int i = 0; + out_frame[i++] = PUSH_CODE_RAW_DATA; + out_frame[i++] = (int8_t)(_radio->getLastSNR() * 4); + out_frame[i++] = (int8_t)(_radio->getLastRSSI()); + out_frame[i++] = 0xFF; // reserved (possibly path_len in future) + memcpy(&out_frame[i], packet->payload, packet->payload_len); + i += packet->payload_len; + + if (_serial->isConnected()) + { + _serial->writeFrame(out_frame, i); + } + else + { + MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); + } +} + +void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) +{ + int i = 0; + out_frame[i++] = PUSH_CODE_TRACE_DATA; + out_frame[i++] = 0; // reserved + out_frame[i++] = path_len; + out_frame[i++] = flags; + memcpy(&out_frame[i], &tag, 4); + i += 4; + memcpy(&out_frame[i], &auth_code, 4); + i += 4; + memcpy(&out_frame[i], path_hashes, path_len); + i += path_len; + memcpy(&out_frame[i], path_snrs, path_len); + i += path_len; + out_frame[i++] = (int8_t)(packet->getSNR() * 4); // extra/final SNR (to this node) + + if (_serial->isConnected()) + { + _serial->writeFrame(out_frame, i); + } + else + { + MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); + } +} + +uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const +{ + return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); +} +uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const +{ + return SEND_TIMEOUT_BASE_MILLIS + + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); +} + +void MyMesh::onSendTimeout() +{ +} + +MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) + : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), _serial(NULL), + telemetry(MAX_PACKET_PAYLOAD - 4) +{ + _iter_started = false; + offline_queue_len = 0; + app_target_ver = 0; + _identity_store = NULL; + pending_login = pending_status = pending_telemetry = 0; + next_ack_idx = 0; + sign_data = NULL; + dirty_contacts_expiry = 0; + + // defaults + memset(&_prefs, 0, sizeof(_prefs)); + _prefs.airtime_factor = 1.0; // one half + strcpy(_prefs.node_name, "NONAME"); + _prefs.freq = LORA_FREQ; + _prefs.sf = LORA_SF; + _prefs.bw = LORA_BW; + _prefs.cr = LORA_CR; + _prefs.tx_power_dbm = LORA_TX_POWER; + //_prefs.rx_delay_base = 10.0f; enable once new algo fixed +} + +void MyMesh::loadPrefsInt(const char *filename) +{ +#if defined(RP2040_PLATFORM) + File file = _fs->open(filename, "r"); +#else + File file = _fs->open(filename); +#endif + if (file) + { + uint8_t pad[8]; + + file.read((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 + file.read((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 + file.read(pad, 4); // 36 + file.read((uint8_t *)&sensors.node_lat, sizeof(sensors.node_lat)); // 40 + file.read((uint8_t *)&sensors.node_lon, sizeof(sensors.node_lon)); // 48 + file.read((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 + file.read((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 + file.read((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 + file.read((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 + file.read((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 + file.read((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 + file.read((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 + file.read((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 + file.read((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 + file.read((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 + file.read((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 + file.read(pad, 4); // 76 + file.read((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 + + // sanitise bad pref values + _prefs.rx_delay_base = constrain(_prefs.rx_delay_base, 0, 20.0f); + _prefs.airtime_factor = constrain(_prefs.airtime_factor, 0, 9.0f); + _prefs.freq = constrain(_prefs.freq, 400.0f, 2500.0f); + _prefs.bw = constrain(_prefs.bw, 62.5f, 500.0f); + _prefs.sf = constrain(_prefs.sf, 7, 12); + _prefs.cr = constrain(_prefs.cr, 5, 8); + _prefs.tx_power_dbm = constrain(_prefs.tx_power_dbm, 1, MAX_LORA_TX_POWER); + + file.close(); + } +} + +void MyMesh::begin(FILESYSTEM &fs, bool has_display) +{ + _fs = &fs; + + BaseChatMesh::begin(); + +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _identity_store = new IdentityStore(fs, ""); +#elif defined(RP2040_PLATFORM) + _identity_store = new IdentityStore(fs, "/identity"); + _identity_store->begin(); +#else + _identity_store = new IdentityStore(fs, "/identity"); +#endif + + loadMainIdentity(); + + // use hex of first 4 bytes of identity public key as default node name + char pub_key_hex[10]; + mesh::Utils::toHex(pub_key_hex, self_id.pub_key, 4); + strcpy(_prefs.node_name, pub_key_hex); + +// if name is provided as a build flag, use that as default node name instead +#ifdef ADVERT_NAME + strcpy(_prefs.node_name, ADVERT_NAME); +#endif + + // load persisted prefs + if (_fs->exists("/new_prefs")) + { + loadPrefsInt("/new_prefs"); // new filename + } + else if (_fs->exists("/node_prefs")) + { + loadPrefsInt("/node_prefs"); + savePrefs(); // save to new filename + _fs->remove("/node_prefs"); // remove old + } + +#ifdef BLE_PIN_CODE + if (_prefs.ble_pin == 0) + { +#ifdef DISPLAY_CLASS + if (has_display) + { + StdRNG rng; + _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session + } + else + { + _active_ble_pin = BLE_PIN_CODE; // otherwise static pin + } +#else + _active_ble_pin = BLE_PIN_CODE; // otherwise static pin +#endif + } + else + { + _active_ble_pin = _prefs.ble_pin; + } +#else + _active_ble_pin = 0; +#endif + + // init 'blob store' support + _fs->mkdir("/bl"); + + loadContacts(); + addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel + loadChannels(); + + radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); + radio_set_tx_power(_prefs.tx_power_dbm); +} + +const char *MyMesh::getNodeName() { return _prefs.node_name; } +NodePrefs *MyMesh::getNodePrefs() +{ + return &_prefs; +} +uint32_t MyMesh::getBLEPin() { return _active_ble_pin; } + +void MyMesh::startInterface(BaseSerialInterface &serial) +{ + _serial = &serial; + serial.enable(); +} + +void MyMesh::savePrefs() +{ +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/new_prefs"); + File file = _fs->open("/new_prefs", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/new_prefs", "w"); +#else + File file = _fs->open("/new_prefs", "w", true); +#endif + if (file) + { + uint8_t pad[8]; + memset(pad, 0, sizeof(pad)); + + file.write((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 + file.write((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 + file.write(pad, 4); // 36 + file.write((uint8_t *)&sensors.node_lat, sizeof(sensors.node_lat)); // 40 + file.write((uint8_t *)&sensors.node_lon, sizeof(sensors.node_lon)); // 48 + file.write((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 + file.write((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 + file.write((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 + file.write((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 + file.write((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 + file.write((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 + file.write((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 + file.write((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 + file.write((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 + file.write((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 + file.write((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 + file.write(pad, 4); // 76 + file.write((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 + + file.close(); + } +} + +void MyMesh::handleCmdFrame(size_t len) +{ + if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) + { // sent when app establishes connection + app_target_ver = cmd_frame[1]; // which version of protocol does app understand + + int i = 0; + out_frame[i++] = RESP_CODE_DEVICE_INFO; + out_frame[i++] = FIRMWARE_VER_CODE; + out_frame[i++] = MAX_CONTACTS / 2; // v3+ + out_frame[i++] = MAX_GROUP_CHANNELS; // v3+ + memcpy(&out_frame[i], &_prefs.ble_pin, 4); + i += 4; + memset(&out_frame[i], 0, 12); + strcpy((char *)&out_frame[i], FIRMWARE_BUILD_DATE); + i += 12; + StrHelper::strzcpy((char *)&out_frame[i], board.getManufacturerName(), 40); + i += 40; + StrHelper::strzcpy((char *)&out_frame[i], FIRMWARE_VERSION, 20); + i += 20; + _serial->writeFrame(out_frame, i); + } + else if (cmd_frame[0] == CMD_APP_START && len >= 8) + { // sent when app establishes connection, respond with node ID + // cmd_frame[1..7] reserved future + char *app_name = (char *)&cmd_frame[8]; + cmd_frame[len] = 0; // make app_name null terminated + MESH_DEBUG_PRINTLN("App %s connected", app_name); + + _iter_started = false; // stop any left-over ContactsIterator + int i = 0; + out_frame[i++] = RESP_CODE_SELF_INFO; + out_frame[i++] = ADV_TYPE_CHAT; // what this node Advert identifies as (maybe node's pronouns too?? :-) + out_frame[i++] = _prefs.tx_power_dbm; + out_frame[i++] = MAX_LORA_TX_POWER; + memcpy(&out_frame[i], self_id.pub_key, PUB_KEY_SIZE); + i += PUB_KEY_SIZE; + + int32_t lat, lon; + lat = (sensors.node_lat * 1000000.0); + lon = (sensors.node_lon * 1000000.0); + memcpy(&out_frame[i], &lat, 4); + i += 4; + memcpy(&out_frame[i], &lon, 4); + i += 4; + out_frame[i++] = 0; // reserved + out_frame[i++] = 0; // reserved + out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | (_prefs.telemetry_mode_base); // v5+ + out_frame[i++] = _prefs.manual_add_contacts; + + uint32_t freq = _prefs.freq * 1000; + memcpy(&out_frame[i], &freq, 4); + i += 4; + uint32_t bw = _prefs.bw * 1000; + memcpy(&out_frame[i], &bw, 4); + i += 4; + out_frame[i++] = _prefs.sf; + out_frame[i++] = _prefs.cr; + + int tlen = strlen(_prefs.node_name); // revisit: UTF_8 ?? + memcpy(&out_frame[i], _prefs.node_name, tlen); + i += tlen; + _serial->writeFrame(out_frame, i); + } + else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) + { + int i = 1; + uint8_t txt_type = cmd_frame[i++]; + uint8_t attempt = cmd_frame[i++]; + uint32_t msg_timestamp; + memcpy(&msg_timestamp, &cmd_frame[i], 4); + i += 4; + uint8_t *pub_key_prefix = &cmd_frame[i]; + i += 6; + ContactInfo *recipient = lookupContactByPubKey(pub_key_prefix, 6); + if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) + { + char *text = (char *)&cmd_frame[i]; + int tlen = len - i; + uint32_t est_timeout; + text[tlen] = 0; // ensure null + int result; + uint32_t expected_ack; + if (txt_type == TXT_TYPE_CLI_DATA) + { + result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); + expected_ack = 0; // no Ack expected + } + else + { + result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); + } + // TODO: add expected ACK to table + if (result == MSG_SEND_FAILED) + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + else + { + if (expected_ack) + { + expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table + expected_ack_table[next_ack_idx].ack = expected_ack; + next_ack_idx = (next_ack_idx + 1) % EXPECTED_ACK_TABLE_SIZE; + } + + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; + memcpy(&out_frame[2], &expected_ack, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + } + } + else + { + writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* + } + } + else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) + { // send GroupChannel msg + int i = 1; + uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN + uint8_t channel_idx = cmd_frame[i++]; + uint32_t msg_timestamp; + memcpy(&msg_timestamp, &cmd_frame[i], 4); + i += 4; + const char *text = (char *)&cmd_frame[i]; + + if (txt_type != TXT_TYPE_PLAIN) + { + writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); + } + else + { + ChannelDetails channel; + bool success = getChannel(channel_idx, channel); + if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) + { + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx + } + } + } + else if (cmd_frame[0] == CMD_GET_CONTACTS) + { // get Contact list + if (_iter_started) + { + writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy + } + else + { + if (len >= 5) + { // has optional 'since' param + memcpy(&_iter_filter_since, &cmd_frame[1], 4); + } + else + { + _iter_filter_since = 0; + } + + uint8_t reply[5]; + reply[0] = RESP_CODE_CONTACTS_START; + uint32_t count = getNumContacts(); // total, NOT filtered count + memcpy(&reply[1], &count, 4); + _serial->writeFrame(reply, 5); + + // start iterator + _iter = startContactsIterator(); + _iter_started = true; + _most_recent_lastmod = 0; + } + } + else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) + { + int nlen = len - 1; + if (nlen > sizeof(_prefs.node_name) - 1) + nlen = sizeof(_prefs.node_name) - 1; // max len + memcpy(_prefs.node_name, &cmd_frame[1], nlen); + _prefs.node_name[nlen] = 0; // null terminator + savePrefs(); + writeOKFrame(); + } + else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) + { + int32_t lat, lon, alt = 0; + memcpy(&lat, &cmd_frame[1], 4); + memcpy(&lon, &cmd_frame[5], 4); + if (len >= 13) + { + memcpy(&alt, &cmd_frame[9], 4); // for FUTURE support + } + if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) + { + sensors.node_lat = ((double)lat) / 1000000.0; + sensors.node_lon = ((double)lon) / 1000000.0; + savePrefs(); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate + } + } + else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) + { + uint8_t reply[5]; + reply[0] = RESP_CODE_CURR_TIME; + uint32_t now = getRTCClock()->getCurrentTime(); + memcpy(&reply[1], &now, 4); + _serial->writeFrame(reply, 5); + } + else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) + { + uint32_t secs; + memcpy(&secs, &cmd_frame[1], 4); + uint32_t curr = getRTCClock()->getCurrentTime(); + if (secs >= curr) + { + getRTCClock()->setCurrentTime(secs); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) + { + auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); + if (pkt) + { + if (len >= 2 && cmd_frame[1] == 1) + { // optional param (1 = flood, 0 = zero hop) + sendFlood(pkt); + } + else + { + sendZeroHop(pkt); + } + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + } + else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient) + { + recipient->out_path_len = -1; + // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact + } + } + else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient) + { + updateContactFromFrame(*recipient, cmd_frame, len); + // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); + writeOKFrame(); + } + else + { + ContactInfo contact; + updateContactFromFrame(contact, cmd_frame, len); + contact.lastmod = getRTCClock()->getCurrentTime(); + contact.sync_since = 0; + if (addContact(contact)) + { + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + } + } + else if (cmd_frame[0] == CMD_REMOVE_CONTACT) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient && removeContact(*recipient)) + { + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove + } + } + else if (cmd_frame[0] == CMD_SHARE_CONTACT) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient) + { + if (shareContactZeroHop(*recipient)) + { + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send + } + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); + } + } + else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (contact) + { + writeContactRespFrame(RESP_CODE_CONTACT, *contact); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // not found + } + } + else if (cmd_frame[0] == CMD_EXPORT_CONTACT) + { + if (len < 1 + PUB_KEY_SIZE) + { + // export SELF + auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); + if (pkt) + { + pkt->header |= ROUTE_TYPE_FLOOD; // would normally be sent in this mode + + out_frame[0] = RESP_CODE_EXPORT_CONTACT; + uint8_t out_len = pkt->writeTo(&out_frame[1]); + releasePacket(pkt); // undo the obtainNewPacket() + _serial->writeFrame(out_frame, out_len + 1); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); // Error + } + } + else + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + uint8_t out_len; + if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) + { + out_frame[0] = RESP_CODE_EXPORT_CONTACT; + _serial->writeFrame(out_frame, out_len + 1); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // not found + } + } + } + else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) + { + if (importContact(&cmd_frame[1], len - 1)) + { + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) + { + int out_len; + if ((out_len = getFromOfflineQueue(out_frame)) > 0) + { + _serial->writeFrame(out_frame, out_len); +#ifdef DISPLAY_CLASS + ui_task.msgRead(offline_queue_len); +#endif + } + else + { + out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; + _serial->writeFrame(out_frame, 1); + } + } + else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) + { + int i = 1; + uint32_t freq; + memcpy(&freq, &cmd_frame[i], 4); + i += 4; + uint32_t bw; + memcpy(&bw, &cmd_frame[i], 4); + i += 4; + uint8_t sf = cmd_frame[i++]; + uint8_t cr = cmd_frame[i++]; + + if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && bw <= 500000) + { + _prefs.sf = sf; + _prefs.cr = cr; + _prefs.freq = (float)freq / 1000.0; + _prefs.bw = (float)bw / 1000.0; + savePrefs(); + + radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); + MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + + writeOKFrame(); + } + else + { + MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) + { + if (cmd_frame[1] > MAX_LORA_TX_POWER) + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + else + { + _prefs.tx_power_dbm = cmd_frame[1]; + savePrefs(); + radio_set_tx_power(_prefs.tx_power_dbm); + writeOKFrame(); + } + } + else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) + { + int i = 1; + uint32_t rx, af; + memcpy(&rx, &cmd_frame[i], 4); + i += 4; + memcpy(&af, &cmd_frame[i], 4); + i += 4; + _prefs.rx_delay_base = ((float)rx) / 1000.0f; + _prefs.airtime_factor = ((float)af) / 1000.0f; + savePrefs(); + writeOKFrame(); + } + else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) + { + _prefs.manual_add_contacts = cmd_frame[1]; + if (len >= 3) + { + _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ + _prefs.telemetry_mode_loc = (cmd_frame[2] >> 2) & 0x03; + _prefs.telemetry_mode_env = (cmd_frame[2] >> 4) & 0x03; + } + savePrefs(); + writeOKFrame(); + } + else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) + { + if (dirty_contacts_expiry) + { // is there are pending dirty contacts write needed? + saveContacts(); + } + board.reboot(); + } + else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) + { + uint8_t reply[3]; + reply[0] = RESP_CODE_BATTERY_VOLTAGE; + uint16_t battery_millivolts = board.getBattMilliVolts(); + memcpy(&reply[1], &battery_millivolts, 2); + _serial->writeFrame(reply, 3); + } + else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) + { +#if ENABLE_PRIVATE_KEY_EXPORT + uint8_t reply[65]; + reply[0] = RESP_CODE_PRIVATE_KEY; + self_id.writeTo(&reply[1], 64); + _serial->writeFrame(reply, 65); +#else + writeDisabledFrame(); +#endif + } + else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) + { +#if ENABLE_PRIVATE_KEY_IMPORT + mesh::LocalIdentity identity; + identity.readFrom(&cmd_frame[1], 64); + if (saveMainIdentity(identity)) + { + self_id = identity; + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_FILE_IO_ERROR); + } +#else + writeDisabledFrame(); +#endif + } + else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) + { + int i = 1; + int8_t path_len = cmd_frame[i++]; + if (path_len >= 0 && i + path_len + 4 <= len) + { // minimum 4 byte payload + uint8_t *path = &cmd_frame[i]; + i += path_len; + auto pkt = createRawData(&cmd_frame[i], len - i); + if (pkt) + { + sendDirect(pkt, path, path_len); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + } + else + { + writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) + } + } + else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE]; + cmd_frame[len] = 0; // ensure null terminator in password + if (recipient) + { + uint32_t est_timeout; + int result = sendLogin(*recipient, password, est_timeout); + if (result == MSG_SEND_FAILED) + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + else + { + pending_telemetry = pending_status = 0; + memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; + memcpy(&out_frame[2], &pending_login, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + } + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found + } + } + else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) + { + uint8_t *pub_key = &cmd_frame[1]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient) + { + uint32_t tag, est_timeout; + int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); + if (result == MSG_SEND_FAILED) + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + else + { + pending_telemetry = pending_login = 0; + // FUTURE: pending_status = tag; // match this in onContactResponse() + memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; + memcpy(&out_frame[2], &tag, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + } + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found + } + } + else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) + { + uint8_t *pub_key = &cmd_frame[4]; + ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); + if (recipient) + { + uint32_t tag, est_timeout; + int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); + if (result == MSG_SEND_FAILED) + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + else + { + pending_status = pending_login = 0; + pending_telemetry = tag; // match this in onContactResponse() + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; + memcpy(&out_frame[2], &tag, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + } + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found + } + } + else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) + { + uint8_t *pub_key = &cmd_frame[1]; + if (hasConnectionTo(pub_key)) + { + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); + } + } + else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) + { + uint8_t *pub_key = &cmd_frame[1]; + stopConnection(pub_key); + writeOKFrame(); + } + else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) + { + uint8_t channel_idx = cmd_frame[1]; + ChannelDetails channel; + if (getChannel(channel_idx, channel)) + { + int i = 0; + out_frame[i++] = RESP_CODE_CHANNEL_INFO; + out_frame[i++] = channel_idx; + strcpy((char *)&out_frame[i], channel.name); + i += 32; + memcpy(&out_frame[i], channel.channel.secret, 16); + i += 16; // NOTE: only 128-bit supported + _serial->writeFrame(out_frame, i); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); + } + } + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) + { + writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) + } + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) + { + uint8_t channel_idx = cmd_frame[1]; + ChannelDetails channel; + StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32); + memset(channel.channel.secret, 0, sizeof(channel.channel.secret)); + memcpy(channel.channel.secret, &cmd_frame[2 + 32], 16); // NOTE: only 128-bit supported + if (setChannel(channel_idx, channel)) + { + saveChannels(); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx + } + } + else if (cmd_frame[0] == CMD_SIGN_START) + { + out_frame[0] = RESP_CODE_SIGN_START; + out_frame[1] = 0; // reserved + uint32_t len = MAX_SIGN_DATA_LEN; + memcpy(&out_frame[2], &len, 4); + _serial->writeFrame(out_frame, 6); + + if (sign_data) + { + free(sign_data); + } + sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN); + sign_data_len = 0; + } + else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) + { + if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) + { + writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long + } + else + { + memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); + sign_data_len += (len - 1); + writeOKFrame(); + } + } + else if (cmd_frame[0] == CMD_SIGN_FINISH) + { + if (sign_data) + { + self_id.sign(&out_frame[1], sign_data, sign_data_len); + + free(sign_data); // don't need sign_data now + sign_data = NULL; + + out_frame[0] = RESP_CODE_SIGNATURE; + _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); + } + else + { + writeErrFrame(ERR_CODE_BAD_STATE); + } + } + else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) + { + uint32_t tag, auth; + memcpy(&tag, &cmd_frame[1], 4); + memcpy(&auth, &cmd_frame[5], 4); + auto pkt = createTrace(tag, auth, cmd_frame[9]); + if (pkt) + { + uint8_t path_len = len - 10; + sendDirect(pkt, &cmd_frame[10], path_len); + + uint32_t t = _radio->getEstAirtimeFor(pkt->payload_len + pkt->path_len + 2); + uint32_t est_timeout = calcDirectTimeoutMillisFor(t, path_len); + + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = 0; + memcpy(&out_frame[2], &tag, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); + } + } + else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) + { + + // get pin from command frame + uint32_t pin; + memcpy(&pin, &cmd_frame[1], 4); + + // ensure pin is zero, or a valid 6 digit pin + if (pin == 0 || (pin >= 100000 && pin <= 999999)) + { + _prefs.ble_pin = pin; + savePrefs(); + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) + { + out_frame[0] = RESP_CODE_CUSTOM_VARS; + char *dp = (char *)&out_frame[1]; + for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) + { + if (i > 0) + { + *dp++ = ','; + } + strcpy(dp, sensors.getSettingName(i)); + dp = strchr(dp, 0); + *dp++ = ':'; + strcpy(dp, sensors.getSettingValue(i)); + dp = strchr(dp, 0); + } + _serial->writeFrame(out_frame, dp - (char *)out_frame); + } + else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) + { + cmd_frame[len] = 0; + char *sp = (char *)&cmd_frame[1]; + char *np = strchr(sp, ':'); // look for separator char + if (np) + { + *np++ = 0; // modify 'cmd_frame', replace ':' with null + bool success = sensors.setSettingValue(sp, np); + if (success) + { + writeOKFrame(); + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else + { + writeErrFrame(ERR_CODE_ILLEGAL_ARG); + } + } + else + { + writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); + MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); + } +} + +void MyMesh::loop() +{ + BaseChatMesh::loop(); + + size_t len = _serial->checkRecvFrame(cmd_frame); + if (len > 0) + { + handleCmdFrame(len); + } + else if (_iter_started // check if our ContactsIterator is 'running' + && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! + ) + { + ContactInfo contact; + if (_iter.hasNext(this, contact)) + { + if (contact.lastmod > _iter_filter_since) + { // apply the 'since' filter + writeContactRespFrame(RESP_CODE_CONTACT, contact); + if (contact.lastmod > _most_recent_lastmod) + { + _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame + } + } + } + else + { // EOF + out_frame[0] = RESP_CODE_END_OF_CONTACTS; + memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' + _serial->writeFrame(out_frame, 5); + _iter_started = false; + } + } + else if (!_serial->isWriteBusy()) + { + checkConnections(); + } + + // is there are pending dirty contacts write needed? + if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) + { + saveContacts(); + dirty_contacts_expiry = 0; + } + +#ifdef DISPLAY_CLASS + ui_task.setHasConnection(_serial->isConnected()); + ui_task.loop(); +#endif +} + +bool MyMesh::advert() +{ + auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); + if (pkt) + { + sendZeroHop(pkt); + writeOKFrame(); + return true; + } + else + { + writeErrFrame(ERR_CODE_TABLE_FULL); + return false; + } +} \ No newline at end of file diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h new file mode 100644 index 00000000..a4794f1f --- /dev/null +++ b/examples/companion_radio/MyMesh.h @@ -0,0 +1,283 @@ +#ifndef MYMESH_H +#define MYMESH_H + +#include +#include +#ifdef DISPLAY_CLASS + #include "UITask.h" +#endif + +/*------------ Frame Protocol --------------*/ +#define FIRMWARE_VER_CODE 5 + +#ifndef FIRMWARE_BUILD_DATE + #define FIRMWARE_BUILD_DATE "24 May 2025" +#endif + +#ifndef FIRMWARE_VERSION + #define FIRMWARE_VERSION "v1.6.2" +#endif + +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) +#include +#elif defined(RP2040_PLATFORM) +#include +#elif defined(ESP32) +#include +#endif + +#include +#include +#include +#include +#include +#include "NodePrefs.h" +#include +#include + +/* ---------------------------------- CONFIGURATION ------------------------------------- */ + +#ifndef LORA_FREQ + #define LORA_FREQ 915.0 +#endif +#ifndef LORA_BW + #define LORA_BW 250 +#endif +#ifndef LORA_SF + #define LORA_SF 10 +#endif +#ifndef LORA_CR + #define LORA_CR 5 +#endif +#ifndef LORA_TX_POWER + #define LORA_TX_POWER 20 +#endif +#ifndef MAX_LORA_TX_POWER + #define MAX_LORA_TX_POWER LORA_TX_POWER +#endif + +#ifndef MAX_CONTACTS + #define MAX_CONTACTS 100 +#endif + +#ifndef OFFLINE_QUEUE_SIZE + #define OFFLINE_QUEUE_SIZE 16 +#endif + +#ifndef BLE_NAME_PREFIX + #define BLE_NAME_PREFIX "MeshCore-" +#endif + +#include + +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define LAZY_CONTACTS_WRITE_DELAY 5000 + +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" + +#define CMD_APP_START 1 +#define CMD_SEND_TXT_MSG 2 +#define CMD_SEND_CHANNEL_TXT_MSG 3 +#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) +#define CMD_GET_DEVICE_TIME 5 +#define CMD_SET_DEVICE_TIME 6 +#define CMD_SEND_SELF_ADVERT 7 +#define CMD_SET_ADVERT_NAME 8 +#define CMD_ADD_UPDATE_CONTACT 9 +#define CMD_SYNC_NEXT_MESSAGE 10 +#define CMD_SET_RADIO_PARAMS 11 +#define CMD_SET_RADIO_TX_POWER 12 +#define CMD_RESET_PATH 13 +#define CMD_SET_ADVERT_LATLON 14 +#define CMD_REMOVE_CONTACT 15 +#define CMD_SHARE_CONTACT 16 +#define CMD_EXPORT_CONTACT 17 +#define CMD_IMPORT_CONTACT 18 +#define CMD_REBOOT 19 +#define CMD_GET_BATTERY_VOLTAGE 20 +#define CMD_SET_TUNING_PARAMS 21 +#define CMD_DEVICE_QEURY 22 +#define CMD_EXPORT_PRIVATE_KEY 23 +#define CMD_IMPORT_PRIVATE_KEY 24 +#define CMD_SEND_RAW_DATA 25 +#define CMD_SEND_LOGIN 26 +#define CMD_SEND_STATUS_REQ 27 +#define CMD_HAS_CONNECTION 28 +#define CMD_LOGOUT 29 // 'Disconnect' +#define CMD_GET_CONTACT_BY_KEY 30 +#define CMD_GET_CHANNEL 31 +#define CMD_SET_CHANNEL 32 +#define CMD_SIGN_START 33 +#define CMD_SIGN_DATA 34 +#define CMD_SIGN_FINISH 35 +#define CMD_SEND_TRACE_PATH 36 +#define CMD_SET_DEVICE_PIN 37 +#define CMD_SET_OTHER_PARAMS 38 +#define CMD_SEND_TELEMETRY_REQ 39 +#define CMD_GET_CUSTOM_VARS 40 +#define CMD_SET_CUSTOM_VAR 41 + +#define RESP_CODE_OK 0 +#define RESP_CODE_ERR 1 +#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS +#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) +#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS +#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START +#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG +#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME +#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE +#define RESP_CODE_EXPORT_CONTACT 11 +#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE +#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY +#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY +#define RESP_CODE_DISABLED 15 +#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL +#define RESP_CODE_SIGN_START 19 +#define RESP_CODE_SIGNATURE 20 +#define RESP_CODE_CUSTOM_VARS 21 + +// these are _pushed_ to client app at any time +#define PUSH_CODE_ADVERT 0x80 +#define PUSH_CODE_PATH_UPDATED 0x81 +#define PUSH_CODE_SEND_CONFIRMED 0x82 +#define PUSH_CODE_MSG_WAITING 0x83 +#define PUSH_CODE_RAW_DATA 0x84 +#define PUSH_CODE_LOGIN_SUCCESS 0x85 +#define PUSH_CODE_LOGIN_FAIL 0x86 +#define PUSH_CODE_STATUS_RESPONSE 0x87 +#define PUSH_CODE_LOG_RX_DATA 0x88 +#define PUSH_CODE_TRACE_DATA 0x89 +#define PUSH_CODE_NEW_ADVERT 0x8A +#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B + +#define ERR_CODE_UNSUPPORTED_CMD 1 +#define ERR_CODE_NOT_FOUND 2 +#define ERR_CODE_TABLE_FULL 3 +#define ERR_CODE_BAD_STATE 4 +#define ERR_CODE_FILE_IO_ERROR 5 +#define ERR_CODE_ILLEGAL_ARG 6 + +/* -------------------------------------------------------------------------------------- */ + +#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS +#define REQ_TYPE_KEEP_ALIVE 0x02 +#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 + +#define MAX_SIGN_DATA_LEN (8*1024) // 8K + +class MyMesh : public BaseChatMesh { +public: + MyMesh(mesh::Radio& radio, mesh::RNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables); + + void begin(FILESYSTEM& fs, bool has_display); + void startInterface(BaseSerialInterface& serial); + void loadPrefsInt(const char* filename); + void savePrefs(); + + const char* getNodeName(); + NodePrefs* getNodePrefs(); + uint32_t getBLEPin(); + + void loop(); + void handleCmdFrame(size_t len); + bool advert(); + +protected: + float getAirtimeBudgetFactor() const override; + int getInterferenceThreshold() const override; + int calcRxDelay(float score, uint32_t air_time) const override; + + void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; + bool isAutoAddEnabled() const override; + void onDiscoveredContact(ContactInfo& contact, bool is_new) override; + void onContactPathUpdated(const ContactInfo& contact) override; + bool processAck(const uint8_t *data) override; + void queueMessage(const ContactInfo& from, uint8_t txt_type, mesh::Packet* pkt, + uint32_t sender_timestamp, const uint8_t* extra, int extra_len, const char *text); + + void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; + void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; + void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) override; + void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override; + + uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override; + void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override; + void onRawDataRecv(mesh::Packet* packet) override; + void onTraceRecv(mesh::Packet* packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t* path_snrs, + const uint8_t* path_hashes, uint8_t path_len) override; + + uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override; + uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; + void onSendTimeout() override; + +private: + void writeOKFrame(); + void writeErrFrame(uint8_t err_code); + void writeDisabledFrame(); + void writeContactRespFrame(uint8_t code, const ContactInfo& contact); + void updateContactFromFrame(ContactInfo& contact, const uint8_t* frame, int len); + void addToOfflineQueue(const uint8_t frame[], int len); + int getFromOfflineQueue(uint8_t frame[]); + void loadMainIdentity(); + bool saveMainIdentity(const mesh::LocalIdentity& identity); + void loadContacts(); + void saveContacts(); + void loadChannels(); + void saveChannels(); + int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; + +private: + FILESYSTEM* _fs; + IdentityStore* _identity_store; + NodePrefs _prefs; + uint32_t pending_login; + uint32_t pending_status; + uint32_t pending_telemetry; + BaseSerialInterface* _serial; + + ContactsIterator _iter; + uint32_t _iter_filter_since; + uint32_t _most_recent_lastmod; + uint32_t _active_ble_pin; + bool _iter_started; + uint8_t app_target_ver; + uint8_t* sign_data; + uint32_t sign_data_len; + unsigned long dirty_contacts_expiry; + + uint8_t cmd_frame[MAX_FRAME_SIZE + 1]; + uint8_t out_frame[MAX_FRAME_SIZE + 1]; + CayenneLPP telemetry; + + struct Frame { + uint8_t len; + uint8_t buf[MAX_FRAME_SIZE]; + }; + int offline_queue_len; + Frame offline_queue[OFFLINE_QUEUE_SIZE]; + + struct AckTableEntry { + unsigned long msg_sent; + uint32_t ack; + }; + #define EXPECTED_ACK_TABLE_SIZE 8 + AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table + int next_ack_idx; +}; + +extern StdRNG fast_rng; +extern SimpleMeshTables tables; +extern MyMesh the_mesh; +#ifdef DISPLAY_CLASS + extern UITask ui_task; +#endif +#endif // MYMESH_H \ No newline at end of file diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index 5ff5f140..eabfd8f7 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -2,6 +2,7 @@ #include #include #include "NodePrefs.h" +#include "MyMesh.h" #define AUTO_OFF_MILLIS 15000 // 15 seconds #define BOOT_SCREEN_MILLIS 4000 // 4 seconds @@ -340,8 +341,14 @@ void UITask::handleButtonShortPress() { } void UITask::handleButtonDoublePress() { - MESH_DEBUG_PRINTLN("UITask: double press triggered"); - // Not implemented. TODO: possibly send an advert here? + MESH_DEBUG_PRINTLN("UITask: double press triggered, sending advert"); + // ADVERT + if(the_mesh.advert()) { + MESH_DEBUG_PRINTLN("Advert sent!"); + } + else { + MESH_DEBUG_PRINTLN("Advert failed!"); + } } void UITask::handleButtonTriplePress() { diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index acf5237e..6d7e1eb3 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -1,4 +1,5 @@ -#pragma once +#ifndef UI_TASK_H +#define UI_TASK_H #include #include @@ -72,3 +73,4 @@ public: void shutdown(bool restart = false); void loop(); }; +#endif //UI_TASK_H \ No newline at end of file diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index 30a1c9cc..6677d49b 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -1,71 +1,6 @@ #include // needed for PlatformIO #include - -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - #include -#elif defined(RP2040_PLATFORM) - #include -#elif defined(ESP32) - #include -#endif - -#include -#include -#include -#include -#include -#include "NodePrefs.h" -#include -#include - -/* ---------------------------------- CONFIGURATION ------------------------------------- */ - -#ifndef LORA_FREQ - #define LORA_FREQ 915.0 -#endif -#ifndef LORA_BW - #define LORA_BW 250 -#endif -#ifndef LORA_SF - #define LORA_SF 10 -#endif -#ifndef LORA_CR - #define LORA_CR 5 -#endif -#ifndef LORA_TX_POWER - #define LORA_TX_POWER 20 -#endif -#ifndef MAX_LORA_TX_POWER - #define MAX_LORA_TX_POWER LORA_TX_POWER -#endif - -#ifndef MAX_CONTACTS - #define MAX_CONTACTS 100 -#endif - -#ifndef OFFLINE_QUEUE_SIZE - #define OFFLINE_QUEUE_SIZE 16 -#endif - -#ifndef BLE_NAME_PREFIX - #define BLE_NAME_PREFIX "MeshCore-" -#endif - -#include - -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define LAZY_CONTACTS_WRITE_DELAY 5000 - -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" - -#ifdef DISPLAY_CLASS - #include "UITask.h" - - static UITask ui_task(&board); -#endif +#include "MyMesh.h" // Believe it or not, this std C function is busted on some platforms! static uint32_t _atoi(const char* sp) { @@ -77,1518 +12,13 @@ static uint32_t _atoi(const char* sp) { return n; } -/*------------ Frame Protocol --------------*/ - -#define FIRMWARE_VER_CODE 5 - -#ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "24 May 2025" -#endif - -#ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.6.2" -#endif - -#define CMD_APP_START 1 -#define CMD_SEND_TXT_MSG 2 -#define CMD_SEND_CHANNEL_TXT_MSG 3 -#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) -#define CMD_GET_DEVICE_TIME 5 -#define CMD_SET_DEVICE_TIME 6 -#define CMD_SEND_SELF_ADVERT 7 -#define CMD_SET_ADVERT_NAME 8 -#define CMD_ADD_UPDATE_CONTACT 9 -#define CMD_SYNC_NEXT_MESSAGE 10 -#define CMD_SET_RADIO_PARAMS 11 -#define CMD_SET_RADIO_TX_POWER 12 -#define CMD_RESET_PATH 13 -#define CMD_SET_ADVERT_LATLON 14 -#define CMD_REMOVE_CONTACT 15 -#define CMD_SHARE_CONTACT 16 -#define CMD_EXPORT_CONTACT 17 -#define CMD_IMPORT_CONTACT 18 -#define CMD_REBOOT 19 -#define CMD_GET_BATTERY_VOLTAGE 20 -#define CMD_SET_TUNING_PARAMS 21 -#define CMD_DEVICE_QEURY 22 -#define CMD_EXPORT_PRIVATE_KEY 23 -#define CMD_IMPORT_PRIVATE_KEY 24 -#define CMD_SEND_RAW_DATA 25 -#define CMD_SEND_LOGIN 26 -#define CMD_SEND_STATUS_REQ 27 -#define CMD_HAS_CONNECTION 28 -#define CMD_LOGOUT 29 // 'Disconnect' -#define CMD_GET_CONTACT_BY_KEY 30 -#define CMD_GET_CHANNEL 31 -#define CMD_SET_CHANNEL 32 -#define CMD_SIGN_START 33 -#define CMD_SIGN_DATA 34 -#define CMD_SIGN_FINISH 35 -#define CMD_SEND_TRACE_PATH 36 -#define CMD_SET_DEVICE_PIN 37 -#define CMD_SET_OTHER_PARAMS 38 -#define CMD_SEND_TELEMETRY_REQ 39 -#define CMD_GET_CUSTOM_VARS 40 -#define CMD_SET_CUSTOM_VAR 41 - -#define RESP_CODE_OK 0 -#define RESP_CODE_ERR 1 -#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS -#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) -#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS -#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START -#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG -#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME -#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE -#define RESP_CODE_EXPORT_CONTACT 11 -#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE -#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY -#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY -#define RESP_CODE_DISABLED 15 -#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL -#define RESP_CODE_SIGN_START 19 -#define RESP_CODE_SIGNATURE 20 -#define RESP_CODE_CUSTOM_VARS 21 - -// these are _pushed_ to client app at any time -#define PUSH_CODE_ADVERT 0x80 -#define PUSH_CODE_PATH_UPDATED 0x81 -#define PUSH_CODE_SEND_CONFIRMED 0x82 -#define PUSH_CODE_MSG_WAITING 0x83 -#define PUSH_CODE_RAW_DATA 0x84 -#define PUSH_CODE_LOGIN_SUCCESS 0x85 -#define PUSH_CODE_LOGIN_FAIL 0x86 -#define PUSH_CODE_STATUS_RESPONSE 0x87 -#define PUSH_CODE_LOG_RX_DATA 0x88 -#define PUSH_CODE_TRACE_DATA 0x89 -#define PUSH_CODE_NEW_ADVERT 0x8A -#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B - -#define ERR_CODE_UNSUPPORTED_CMD 1 -#define ERR_CODE_NOT_FOUND 2 -#define ERR_CODE_TABLE_FULL 3 -#define ERR_CODE_BAD_STATE 4 -#define ERR_CODE_FILE_IO_ERROR 5 -#define ERR_CODE_ILLEGAL_ARG 6 - -/* -------------------------------------------------------------------------------------- */ - -#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS -#define REQ_TYPE_KEEP_ALIVE 0x02 -#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 - -#define MAX_SIGN_DATA_LEN (8*1024) // 8K - -class MyMesh : public BaseChatMesh { - FILESYSTEM* _fs; - IdentityStore* _identity_store; - NodePrefs _prefs; - uint32_t pending_login; - uint32_t pending_status; - uint32_t pending_telemetry; - BaseSerialInterface* _serial; - ContactsIterator _iter; - uint32_t _iter_filter_since; - uint32_t _most_recent_lastmod; - uint32_t _active_ble_pin; - bool _iter_started; - uint8_t app_target_ver; - uint8_t* sign_data; - uint32_t sign_data_len; - unsigned long dirty_contacts_expiry; - uint8_t cmd_frame[MAX_FRAME_SIZE+1]; - uint8_t out_frame[MAX_FRAME_SIZE+1]; - CayenneLPP telemetry; - - struct Frame { - uint8_t len; - uint8_t buf[MAX_FRAME_SIZE]; - }; - int offline_queue_len; - Frame offline_queue[OFFLINE_QUEUE_SIZE]; - - struct AckTableEntry { - unsigned long msg_sent; - uint32_t ack; - }; - #define EXPECTED_ACK_TABLE_SIZE 8 - AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table - int next_ack_idx; - - void loadMainIdentity() { - if (!_identity_store->load("_main", self_id)) { - self_id = radio_new_identity(); // create new random identity - int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes - self_id = radio_new_identity(); count++; - } - saveMainIdentity(self_id); - } - } - - bool saveMainIdentity(const mesh::LocalIdentity& identity) { - return _identity_store->save("_main", identity); - } - - void loadContacts() { - if (_fs->exists("/contacts3")) { - #if defined(RP2040_PLATFORM) - File file = _fs->open("/contacts3", "r"); - #else - File file = _fs->open("/contacts3"); - #endif - if (file) { - bool full = false; - while (!full) { - ContactInfo c; - uint8_t pub_key[32]; - uint8_t unused; - - bool success = (file.read(pub_key, 32) == 32); - success = success && (file.read((uint8_t *) &c.name, 32) == 32); - success = success && (file.read(&c.type, 1) == 1); - success = success && (file.read(&c.flags, 1) == 1); - success = success && (file.read(&unused, 1) == 1); - success = success && (file.read((uint8_t *) &c.sync_since, 4) == 4); // was 'reserved' - success = success && (file.read((uint8_t *) &c.out_path_len, 1) == 1); - success = success && (file.read((uint8_t *) &c.last_advert_timestamp, 4) == 4); - success = success && (file.read(c.out_path, 64) == 64); - success = success && (file.read((uint8_t *) &c.lastmod, 4) == 4); - success = success && (file.read((uint8_t *) &c.gps_lat, 4) == 4); - success = success && (file.read((uint8_t *) &c.gps_lon, 4) == 4); - - if (!success) break; // EOF - - c.id = mesh::Identity(pub_key); - if (!addContact(c)) full = true; - } - file.close(); - } - } - } - - void saveContacts() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/contacts3"); - File file = _fs->open("/contacts3", FILE_O_WRITE); + #include #elif defined(RP2040_PLATFORM) - File file = _fs->open("/contacts3", "w"); -#else - File file = _fs->open("/contacts3", "w", true); + #include +#elif defined(ESP32) + #include #endif - if (file) { - ContactsIterator iter; - ContactInfo c; - uint8_t unused = 0; - - while (iter.hasNext(this, c)) { - bool success = (file.write(c.id.pub_key, 32) == 32); - success = success && (file.write((uint8_t *) &c.name, 32) == 32); - success = success && (file.write(&c.type, 1) == 1); - success = success && (file.write(&c.flags, 1) == 1); - success = success && (file.write(&unused, 1) == 1); - success = success && (file.write((uint8_t *) &c.sync_since, 4) == 4); - success = success && (file.write((uint8_t *) &c.out_path_len, 1) == 1); - success = success && (file.write((uint8_t *) &c.last_advert_timestamp, 4) == 4); - success = success && (file.write(c.out_path, 64) == 64); - success = success && (file.write((uint8_t *) &c.lastmod, 4) == 4); - success = success && (file.write((uint8_t *) &c.gps_lat, 4) == 4); - success = success && (file.write((uint8_t *) &c.gps_lon, 4) == 4); - - if (!success) break; // write failed - } - file.close(); - } - } - - void loadChannels() { - if (_fs->exists("/channels2")) { - #if defined(RP2040_PLATFORM) - File file = _fs->open("/channels2", "r"); - #else - File file = _fs->open("/channels2"); - #endif - if (file) { - bool full = false; - uint8_t channel_idx = 0; - while (!full) { - ChannelDetails ch; - uint8_t unused[4]; - - bool success = (file.read(unused, 4) == 4); - success = success && (file.read((uint8_t *) ch.name, 32) == 32); - success = success && (file.read((uint8_t *) ch.channel.secret, 32) == 32); - - if (!success) break; // EOF - - if (setChannel(channel_idx, ch)) { - channel_idx++; - } else { - full = true; - } - } - file.close(); - } - } - } - - void saveChannels() { - #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/channels2"); - File file = _fs->open("/channels2", FILE_O_WRITE); - #elif defined(RP2040_PLATFORM) - File file = _fs->open("/channels2", "w"); - #else - File file = _fs->open("/channels2", "w", true); - #endif - if (file) { - uint8_t channel_idx = 0; - ChannelDetails ch; - uint8_t unused[4]; - memset(unused, 0, 4); - - while (getChannel(channel_idx, ch)) { - bool success = (file.write(unused, 4) == 4); - success = success && (file.write((uint8_t *) ch.name, 32) == 32); - success = success && (file.write((uint8_t *) ch.channel.secret, 32) == 32); - - if (!success) break; // write failed - channel_idx++; - } - file.close(); - } - } - - int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override { - char path[64]; - char fname[18]; - - if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) - mesh::Utils::toHex(fname, key, key_len); - sprintf(path, "/bl/%s", fname); - - if (_fs->exists(path)) { - #if defined(RP2040_PLATFORM) - File f = _fs->open(path, "r"); - #else - File f = _fs->open(path); - #endif - if (f) { - int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! - f.close(); - return len; - } - } - return 0; // not found - } - - bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override { - char path[64]; - char fname[18]; - - if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) - mesh::Utils::toHex(fname, key, key_len); - sprintf(path, "/bl/%s", fname); - - #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove(path); - File f = _fs->open(path, FILE_O_WRITE); - #elif defined(RP2040_PLATFORM) - File f = _fs->open(path, "w"); - #else - File f = _fs->open(path, "w", true); - #endif - if (f) { - int n = f.write(src_buf, len); - f.close(); - if (n == len) return true; // success! - - _fs->remove(path); // blob was only partially written! - } - return false; // error - } - - void writeOKFrame() { - uint8_t buf[1]; - buf[0] = RESP_CODE_OK; - _serial->writeFrame(buf, 1); - } - void writeErrFrame(uint8_t err_code) { - uint8_t buf[2]; - buf[0] = RESP_CODE_ERR; - buf[1] = err_code; - _serial->writeFrame(buf, 2); - } - - void writeDisabledFrame() { - uint8_t buf[1]; - buf[0] = RESP_CODE_DISABLED; - _serial->writeFrame(buf, 1); - } - - void writeContactRespFrame(uint8_t code, const ContactInfo& contact) { - int i = 0; - out_frame[i++] = code; - memcpy(&out_frame[i], contact.id.pub_key, PUB_KEY_SIZE); i += PUB_KEY_SIZE; - out_frame[i++] = contact.type; - out_frame[i++] = contact.flags; - out_frame[i++] = contact.out_path_len; - memcpy(&out_frame[i], contact.out_path, MAX_PATH_SIZE); i += MAX_PATH_SIZE; - StrHelper::strzcpy((char *) &out_frame[i], contact.name, 32); i += 32; - memcpy(&out_frame[i], &contact.last_advert_timestamp, 4); i += 4; - memcpy(&out_frame[i], &contact.gps_lat, 4); i += 4; - memcpy(&out_frame[i], &contact.gps_lon, 4); i += 4; - memcpy(&out_frame[i], &contact.lastmod, 4); i += 4; - _serial->writeFrame(out_frame, i); - } - - void updateContactFromFrame(ContactInfo& contact, const uint8_t* frame, int len) { - int i = 0; - uint8_t code = frame[i++]; // eg. CMD_ADD_UPDATE_CONTACT - memcpy(contact.id.pub_key, &frame[i], PUB_KEY_SIZE); i += PUB_KEY_SIZE; - contact.type = frame[i++]; - contact.flags = frame[i++]; - contact.out_path_len = frame[i++]; - memcpy(contact.out_path, &frame[i], MAX_PATH_SIZE); i += MAX_PATH_SIZE; - memcpy(contact.name, &frame[i], 32); i += 32; - memcpy(&contact.last_advert_timestamp, &frame[i], 4); i += 4; - if (i + 8 >= len) { // optional fields - memcpy(&contact.gps_lat, &frame[i], 4); i += 4; - memcpy(&contact.gps_lon, &frame[i], 4); i += 4; - } - } - - void addToOfflineQueue(const uint8_t frame[], int len) { - if (offline_queue_len >= OFFLINE_QUEUE_SIZE) { - MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); - } else { - offline_queue[offline_queue_len].len = len; - memcpy(offline_queue[offline_queue_len].buf, frame, len); - offline_queue_len++; - } - } - int getFromOfflineQueue(uint8_t frame[]) { - if (offline_queue_len > 0) { // check offline queue - size_t len = offline_queue[0].len; // take from top of queue - memcpy(frame, offline_queue[0].buf, len); - - offline_queue_len--; - for (int i = 0; i < offline_queue_len; i++) { // delete top item from queue - offline_queue[i] = offline_queue[i + 1]; - } - return len; - } - return 0; // queue is empty - } - -protected: - float getAirtimeBudgetFactor() const override { - return _prefs.airtime_factor; - } - - int getInterferenceThreshold() const override { - return 14; // hard-coded for now - } - - int calcRxDelay(float score, uint32_t air_time) const override { - if (_prefs.rx_delay_base <= 0.0f) return 0; - return (int) ((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time); - } - - void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override { - if (_serial->isConnected() && len+3 <= MAX_FRAME_SIZE) { - int i = 0; - out_frame[i++] = PUSH_CODE_LOG_RX_DATA; - out_frame[i++] = (int8_t)(snr * 4); - out_frame[i++] = (int8_t)(rssi); - memcpy(&out_frame[i], raw, len); i += len; - - _serial->writeFrame(out_frame, i); - } - } - - bool isAutoAddEnabled() const override { - return (_prefs.manual_add_contacts & 1) == 0; - } - - void onDiscoveredContact(ContactInfo& contact, bool is_new) override { - if (_serial->isConnected()) { - if (!isAutoAddEnabled() && is_new) { - writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); - } else { - out_frame[0] = PUSH_CODE_ADVERT; - memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); - _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); - } - } else { - #ifdef DISPLAY_CLASS - ui_task.soundBuzzer(UIEventType::newContactMessage); - #endif - } - - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - } - - void onContactPathUpdated(const ContactInfo& contact) override { - out_frame[0] = PUSH_CODE_PATH_UPDATED; - memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); - _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected - - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - } - - bool processAck(const uint8_t *data) override { - // see if matches any in a table - for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) { - if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient - out_frame[0] = PUSH_CODE_SEND_CONFIRMED; - memcpy(&out_frame[1], data, 4); - uint32_t trip_time = _ms->getMillis() - expected_ack_table[i].msg_sent; - memcpy(&out_frame[5], &trip_time, 4); - _serial->writeFrame(out_frame, 9); - - // NOTE: the same ACK can be received multiple times! - expected_ack_table[i].ack = 0; // clear expected hash, now that we have received ACK - return true; - } - } - return checkConnectionsAck(data); - } - - void queueMessage(const ContactInfo& from, uint8_t txt_type, mesh::Packet* pkt, uint32_t sender_timestamp, const uint8_t* extra, int extra_len, const char *text) { - int i = 0; - if (app_target_ver >= 3) { - out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; - out_frame[i++] = (int8_t)(pkt->getSNR() * 4); - out_frame[i++] = 0; // reserved1 - out_frame[i++] = 0; // reserved2 - } else { - out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; - } - memcpy(&out_frame[i], from.id.pub_key, 6); i += 6; // just 6-byte prefix - uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF; - out_frame[i++] = txt_type; - memcpy(&out_frame[i], &sender_timestamp, 4); i += 4; - if (extra_len > 0) { - memcpy(&out_frame[i], extra, extra_len); i += extra_len; - } - int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) { - tlen = MAX_FRAME_SIZE - i; - } - memcpy(&out_frame[i], text, tlen); i += tlen; - addToOfflineQueue(out_frame, i); - - if (_serial->isConnected()) { - uint8_t frame[1]; - frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' - _serial->writeFrame(frame, 1); - } else { - #ifdef DISPLAY_CLASS - ui_task.soundBuzzer(UIEventType::contactMessage); - #endif - } - #ifdef DISPLAY_CLASS - ui_task.newMsg(path_len, from.name, text, offline_queue_len); - #endif - } - - void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { - markConnectionActive(from); // in case this is from a server, and we have a connection - queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); - } - - void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { - markConnectionActive(from); // in case this is from a server, and we have a connection - queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); - } - - void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) override { - markConnectionActive(from); - // from.sync_since change needs to be persisted - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text); - } - - void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override { - int i = 0; - if (app_target_ver >= 3) { - out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; - out_frame[i++] = (int8_t)(pkt->getSNR() * 4); - out_frame[i++] = 0; // reserved1 - out_frame[i++] = 0; // reserved2 - } else { - out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; - } - - out_frame[i++] = findChannelIdx(channel); - uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF; - - out_frame[i++] = TXT_TYPE_PLAIN; - memcpy(&out_frame[i], ×tamp, 4); i += 4; - int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) { - tlen = MAX_FRAME_SIZE - i; - } - memcpy(&out_frame[i], text, tlen); i += tlen; - addToOfflineQueue(out_frame, i); - - if (_serial->isConnected()) { - uint8_t frame[1]; - frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' - _serial->writeFrame(frame, 1); - } else { - #ifdef DISPLAY_CLASS - ui_task.soundBuzzer(UIEventType::channelMessage); - #endif - } - #ifdef DISPLAY_CLASS - ui_task.newMsg(path_len, "Public", text, offline_queue_len); - #endif - } - - uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override { - if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) { - uint8_t permissions = 0; - uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) - - if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) { - permissions = TELEM_PERM_BASE; - } else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { - permissions = cp & TELEM_PERM_BASE; - } - - if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) { - permissions |= TELEM_PERM_LOCATION; - } else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { - permissions |= cp & TELEM_PERM_LOCATION; - } - - if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) { - permissions |= TELEM_PERM_ENVIRONMENT; - } else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { - permissions |= cp & TELEM_PERM_ENVIRONMENT; - } - - if (permissions & TELEM_PERM_BASE) { // only respond if base permission bit is set - telemetry.reset(); - telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); - // query other sensors -- target specific - sensors.querySensors(permissions, telemetry); - - memcpy(reply, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') - - uint8_t tlen = telemetry.getSize(); - memcpy(&reply[4], telemetry.getBuffer(), tlen); - return 4 + tlen; - } - } - return 0; // unknown - } - - void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override { - uint32_t tag; - memcpy(&tag, data, 4); - - if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) { // check for login response - // yes, is response to pending sendLogin() - pending_login = 0; - - int i = 0; - if (memcmp(&data[4], "OK", 2) == 0) { // legacy Repeater login OK response - out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; - out_frame[i++] = 0; // legacy: is_admin = false - memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix - } else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response - uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; - if (keep_alive_secs > 0) { - startConnection(contact, keep_alive_secs); - } - out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; - out_frame[i++] = data[6]; // permissions (eg. is_admin) - memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix - memcpy(&out_frame[i], &tag, 4); i += 4; // NEW: include server timestamp - } else { - out_frame[i++] = PUSH_CODE_LOGIN_FAIL; - out_frame[i++] = 0; // reserved - memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix - } - _serial->writeFrame(out_frame, i); - } else if (len > 4 && // check for status response - pending_status && memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme - // FUTURE: tag == pending_status - ) { - pending_status = 0; - - int i = 0; - out_frame[i++] = PUSH_CODE_STATUS_RESPONSE; - out_frame[i++] = 0; // reserved - memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix - memcpy(&out_frame[i], &data[4], len - 4); i += (len - 4); - _serial->writeFrame(out_frame, i); - } else if (len > 4 && tag == pending_telemetry) { // check for telemetry response - pending_telemetry = 0; - - int i = 0; - out_frame[i++] = PUSH_CODE_TELEMETRY_RESPONSE; - out_frame[i++] = 0; // reserved - memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix - memcpy(&out_frame[i], &data[4], len - 4); i += (len - 4); - _serial->writeFrame(out_frame, i); - } - } - - void onRawDataRecv(mesh::Packet* packet) override { - if (packet->payload_len + 4 > sizeof(out_frame)) { - MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); - return; - } - int i = 0; - out_frame[i++] = PUSH_CODE_RAW_DATA; - out_frame[i++] = (int8_t)(_radio->getLastSNR() * 4); - out_frame[i++] = (int8_t)(_radio->getLastRSSI()); - out_frame[i++] = 0xFF; // reserved (possibly path_len in future) - memcpy(&out_frame[i], packet->payload, packet->payload_len); i += packet->payload_len; - - if (_serial->isConnected()) { - _serial->writeFrame(out_frame, i); - } else { - MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); - } - } - - void onTraceRecv(mesh::Packet* packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t* path_snrs, const uint8_t* path_hashes, uint8_t path_len) override { - int i = 0; - out_frame[i++] = PUSH_CODE_TRACE_DATA; - out_frame[i++] = 0; // reserved - out_frame[i++] = path_len; - out_frame[i++] = flags; - memcpy(&out_frame[i], &tag, 4); i += 4; - memcpy(&out_frame[i], &auth_code, 4); i += 4; - memcpy(&out_frame[i], path_hashes, path_len); i += path_len; - memcpy(&out_frame[i], path_snrs, path_len); i += path_len; - out_frame[i++] = (int8_t)(packet->getSNR() * 4); // extra/final SNR (to this node) - - if (_serial->isConnected()) { - _serial->writeFrame(out_frame, i); - } else { - MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); - } - } - - uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override { - return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); - } - uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override { - return SEND_TIMEOUT_BASE_MILLIS + - ( (pkt_airtime_millis*DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); - } - - void onSendTimeout() override { - } - -public: - - MyMesh(mesh::Radio& radio, mesh::RNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables) - : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), _serial(NULL), - telemetry(MAX_PACKET_PAYLOAD - 4) - { - _iter_started = false; - offline_queue_len = 0; - app_target_ver = 0; - _identity_store = NULL; - pending_login = pending_status = pending_telemetry = 0; - next_ack_idx = 0; - sign_data = NULL; - dirty_contacts_expiry = 0; - - // defaults - memset(&_prefs, 0, sizeof(_prefs)); - _prefs.airtime_factor = 1.0; // one half - strcpy(_prefs.node_name, "NONAME"); - _prefs.freq = LORA_FREQ; - _prefs.sf = LORA_SF; - _prefs.bw = LORA_BW; - _prefs.cr = LORA_CR; - _prefs.tx_power_dbm = LORA_TX_POWER; - //_prefs.rx_delay_base = 10.0f; enable once new algo fixed - } - - void loadPrefsInt(const char* filename) { -#if defined(RP2040_PLATFORM) - File file = _fs->open(filename, "r"); -#else - File file = _fs->open(filename); -#endif - if (file) { - uint8_t pad[8]; - - file.read((uint8_t *) &_prefs.airtime_factor, sizeof(float)); // 0 - file.read((uint8_t *) _prefs.node_name, sizeof(_prefs.node_name)); // 4 - file.read(pad, 4); // 36 - file.read((uint8_t *) &sensors.node_lat, sizeof(sensors.node_lat)); // 40 - file.read((uint8_t *) &sensors.node_lon, sizeof(sensors.node_lon)); // 48 - file.read((uint8_t *) &_prefs.freq, sizeof(_prefs.freq)); // 56 - file.read((uint8_t *) &_prefs.sf, sizeof(_prefs.sf)); // 60 - file.read((uint8_t *) &_prefs.cr, sizeof(_prefs.cr)); // 61 - file.read((uint8_t *) &_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 - file.read((uint8_t *) &_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 - file.read((uint8_t *) &_prefs.bw, sizeof(_prefs.bw)); // 64 - file.read((uint8_t *) &_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 - file.read((uint8_t *) &_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 - file.read((uint8_t *) &_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 - file.read((uint8_t *) &_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 - file.read((uint8_t *) &_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 - file.read(pad, 4); // 76 - file.read((uint8_t *) &_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 - - // sanitise bad pref values - _prefs.rx_delay_base = constrain(_prefs.rx_delay_base, 0, 20.0f); - _prefs.airtime_factor = constrain(_prefs.airtime_factor, 0, 9.0f); - _prefs.freq = constrain(_prefs.freq, 400.0f, 2500.0f); - _prefs.bw = constrain(_prefs.bw, 62.5f, 500.0f); - _prefs.sf = constrain(_prefs.sf, 7, 12); - _prefs.cr = constrain(_prefs.cr, 5, 8); - _prefs.tx_power_dbm = constrain(_prefs.tx_power_dbm, 1, MAX_LORA_TX_POWER); - - file.close(); - } - } - - void begin(FILESYSTEM& fs, bool has_display) { - _fs = &fs; - - BaseChatMesh::begin(); - - #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _identity_store = new IdentityStore(fs, ""); - #elif defined(RP2040_PLATFORM) - _identity_store = new IdentityStore(fs, "/identity"); - _identity_store->begin(); - #else - _identity_store = new IdentityStore(fs, "/identity"); - #endif - - loadMainIdentity(); - - // use hex of first 4 bytes of identity public key as default node name - char pub_key_hex[10]; - mesh::Utils::toHex(pub_key_hex, self_id.pub_key, 4); - strcpy(_prefs.node_name, pub_key_hex); - - // if name is provided as a build flag, use that as default node name instead - #ifdef ADVERT_NAME - strcpy(_prefs.node_name, ADVERT_NAME); - #endif - - // load persisted prefs - if (_fs->exists("/new_prefs")) { - loadPrefsInt("/new_prefs"); // new filename - } else if (_fs->exists("/node_prefs")) { - loadPrefsInt("/node_prefs"); - savePrefs(); // save to new filename - _fs->remove("/node_prefs"); // remove old - } - - #ifdef BLE_PIN_CODE - if (_prefs.ble_pin == 0) { - #ifdef DISPLAY_CLASS - if (has_display) { - StdRNG rng; - _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session - } else { - _active_ble_pin = BLE_PIN_CODE; // otherwise static pin - } - #else - _active_ble_pin = BLE_PIN_CODE; // otherwise static pin - #endif - } else { - _active_ble_pin = _prefs.ble_pin; - } - #else - _active_ble_pin = 0; - #endif - - // init 'blob store' support - _fs->mkdir("/bl"); - - loadContacts(); - addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel - loadChannels(); - - radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); - radio_set_tx_power(_prefs.tx_power_dbm); - } - - const char* getNodeName() { return _prefs.node_name; } - NodePrefs* getNodePrefs() { - return &_prefs; - } - uint32_t getBLEPin() { return _active_ble_pin; } - - void startInterface(BaseSerialInterface& serial) { - _serial = &serial; - serial.enable(); - } - - void savePrefs() { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/new_prefs"); - File file = _fs->open("/new_prefs", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/new_prefs", "w"); -#else - File file = _fs->open("/new_prefs", "w", true); -#endif - if (file) { - uint8_t pad[8]; - memset(pad, 0, sizeof(pad)); - - file.write((uint8_t *) &_prefs.airtime_factor, sizeof(float)); // 0 - file.write((uint8_t *) _prefs.node_name, sizeof(_prefs.node_name)); // 4 - file.write(pad, 4); // 36 - file.write((uint8_t *) &sensors.node_lat, sizeof(sensors.node_lat)); // 40 - file.write((uint8_t *) &sensors.node_lon, sizeof(sensors.node_lon)); // 48 - file.write((uint8_t *) &_prefs.freq, sizeof(_prefs.freq)); // 56 - file.write((uint8_t *) &_prefs.sf, sizeof(_prefs.sf)); // 60 - file.write((uint8_t *) &_prefs.cr, sizeof(_prefs.cr)); // 61 - file.write((uint8_t *) &_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 - file.write((uint8_t *) &_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 - file.write((uint8_t *) &_prefs.bw, sizeof(_prefs.bw)); // 64 - file.write((uint8_t *) &_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 - file.write((uint8_t *) &_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 - file.write((uint8_t *) &_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 - file.write((uint8_t *) &_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 - file.write((uint8_t *) &_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 - file.write(pad, 4); // 76 - file.write((uint8_t *) &_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 - - file.close(); - } - } - - void handleCmdFrame(size_t len) { - if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection - app_target_ver = cmd_frame[1]; // which version of protocol does app understand - - int i = 0; - out_frame[i++] = RESP_CODE_DEVICE_INFO; - out_frame[i++] = FIRMWARE_VER_CODE; - out_frame[i++] = MAX_CONTACTS / 2; // v3+ - out_frame[i++] = MAX_GROUP_CHANNELS; // v3+ - memcpy(&out_frame[i], &_prefs.ble_pin, 4); i += 4; - memset(&out_frame[i], 0, 12); - strcpy((char *) &out_frame[i], FIRMWARE_BUILD_DATE); i += 12; - StrHelper::strzcpy((char *) &out_frame[i], board.getManufacturerName(), 40); i += 40; - StrHelper::strzcpy((char *) &out_frame[i], FIRMWARE_VERSION, 20); i += 20; - _serial->writeFrame(out_frame, i); - } else if (cmd_frame[0] == CMD_APP_START && len >= 8) { // sent when app establishes connection, respond with node ID - // cmd_frame[1..7] reserved future - char* app_name = (char *) &cmd_frame[8]; - cmd_frame[len] = 0; // make app_name null terminated - MESH_DEBUG_PRINTLN("App %s connected", app_name); - - _iter_started = false; // stop any left-over ContactsIterator - int i = 0; - out_frame[i++] = RESP_CODE_SELF_INFO; - out_frame[i++] = ADV_TYPE_CHAT; // what this node Advert identifies as (maybe node's pronouns too?? :-) - out_frame[i++] = _prefs.tx_power_dbm; - out_frame[i++] = MAX_LORA_TX_POWER; - memcpy(&out_frame[i], self_id.pub_key, PUB_KEY_SIZE); i += PUB_KEY_SIZE; - - int32_t lat, lon; - lat = (sensors.node_lat * 1000000.0); - lon = (sensors.node_lon * 1000000.0); - memcpy(&out_frame[i], &lat, 4); i += 4; - memcpy(&out_frame[i], &lon, 4); i += 4; - out_frame[i++] = 0; // reserved - out_frame[i++] = 0; // reserved - out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | (_prefs.telemetry_mode_base); // v5+ - out_frame[i++] = _prefs.manual_add_contacts; - - uint32_t freq = _prefs.freq * 1000; - memcpy(&out_frame[i], &freq, 4); i += 4; - uint32_t bw = _prefs.bw*1000; - memcpy(&out_frame[i], &bw, 4); i += 4; - out_frame[i++] = _prefs.sf; - out_frame[i++] = _prefs.cr; - - int tlen = strlen(_prefs.node_name); // revisit: UTF_8 ?? - memcpy(&out_frame[i], _prefs.node_name, tlen); i += tlen; - _serial->writeFrame(out_frame, i); - } else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { - int i = 1; - uint8_t txt_type = cmd_frame[i++]; - uint8_t attempt = cmd_frame[i++]; - uint32_t msg_timestamp; - memcpy(&msg_timestamp, &cmd_frame[i], 4); i += 4; - uint8_t* pub_key_prefix = &cmd_frame[i]; i += 6; - ContactInfo* recipient = lookupContactByPubKey(pub_key_prefix, 6); - if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) { - char *text = (char *) &cmd_frame[i]; - int tlen = len - i; - uint32_t est_timeout; - text[tlen] = 0; // ensure null - int result; - uint32_t expected_ack; - if (txt_type == TXT_TYPE_CLI_DATA) { - result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); - expected_ack = 0; // no Ack expected - } else { - result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); - } - // TODO: add expected ACK to table - if (result == MSG_SEND_FAILED) { - writeErrFrame(ERR_CODE_TABLE_FULL); - } else { - if (expected_ack) { - expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table - expected_ack_table[next_ack_idx].ack = expected_ack; - next_ack_idx = (next_ack_idx + 1) % EXPECTED_ACK_TABLE_SIZE; - } - - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; - memcpy(&out_frame[2], &expected_ack, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - } - } else { - writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* - } - } else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg - int i = 1; - uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN - uint8_t channel_idx = cmd_frame[i++]; - uint32_t msg_timestamp; - memcpy(&msg_timestamp, &cmd_frame[i], 4); i += 4; - const char *text = (char *) &cmd_frame[i]; - - if (txt_type != TXT_TYPE_PLAIN) { - writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); - } else { - ChannelDetails channel; - bool success = getChannel(channel_idx, channel); - if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) { - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx - } - } - } else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list - if (_iter_started) { - writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy - } else { - if (len >= 5) { // has optional 'since' param - memcpy(&_iter_filter_since, &cmd_frame[1], 4); - } else { - _iter_filter_since = 0; - } - - uint8_t reply[5]; - reply[0] = RESP_CODE_CONTACTS_START; - uint32_t count = getNumContacts(); // total, NOT filtered count - memcpy(&reply[1], &count, 4); - _serial->writeFrame(reply, 5); - - // start iterator - _iter = startContactsIterator(); - _iter_started = true; - _most_recent_lastmod = 0; - } - } else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { - int nlen = len - 1; - if (nlen > sizeof(_prefs.node_name)-1) nlen = sizeof(_prefs.node_name)-1; // max len - memcpy(_prefs.node_name, &cmd_frame[1], nlen); - _prefs.node_name[nlen] = 0; // null terminator - savePrefs(); - writeOKFrame(); - } else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { - int32_t lat, lon, alt = 0; - memcpy(&lat, &cmd_frame[1], 4); - memcpy(&lon, &cmd_frame[5], 4); - if (len >= 13) { - memcpy(&alt, &cmd_frame[9], 4); // for FUTURE support - } - if (lat <= 90*1E6 && lat >= -90*1E6 && lon <= 180*1E6 && lon >= -180*1E6) { - sensors.node_lat = ((double)lat) / 1000000.0; - sensors.node_lon = ((double)lon) / 1000000.0; - savePrefs(); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate - } - } else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { - uint8_t reply[5]; - reply[0] = RESP_CODE_CURR_TIME; - uint32_t now = getRTCClock()->getCurrentTime(); - memcpy(&reply[1], &now, 4); - _serial->writeFrame(reply, 5); - } else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { - uint32_t secs; - memcpy(&secs, &cmd_frame[1], 4); - uint32_t curr = getRTCClock()->getCurrentTime(); - if (secs >= curr) { - getRTCClock()->setCurrentTime(secs); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - } else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { - auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) { - if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop) - sendFlood(pkt); - } else { - sendZeroHop(pkt); - } - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); - } - } else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1+32) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) { - recipient->out_path_len = -1; - //recipient->lastmod = ?? shouldn't be needed, app already has this version of contact - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact - } - } else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1+32+2+1) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) { - updateContactFromFrame(*recipient, cmd_frame, len); - //recipient->lastmod = ?? shouldn't be needed, app already has this version of contact - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - writeOKFrame(); - } else { - ContactInfo contact; - updateContactFromFrame(contact, cmd_frame, len); - contact.lastmod = getRTCClock()->getCurrentTime(); - contact.sync_since = 0; - if (addContact(contact)) { - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); - } - } - } else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient && removeContact(*recipient)) { - dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove - } - } else if (cmd_frame[0] == CMD_SHARE_CONTACT) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) { - if (shareContactZeroHop(*recipient)) { - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send - } - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); - } - } else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (contact) { - writeContactRespFrame(RESP_CODE_CONTACT, *contact); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // not found - } - } else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { - if (len < 1 + PUB_KEY_SIZE) { - // export SELF - auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) { - pkt->header |= ROUTE_TYPE_FLOOD; // would normally be sent in this mode - - out_frame[0] = RESP_CODE_EXPORT_CONTACT; - uint8_t out_len = pkt->writeTo(&out_frame[1]); - releasePacket(pkt); // undo the obtainNewPacket() - _serial->writeFrame(out_frame, out_len + 1); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); // Error - } - } else { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - uint8_t out_len; - if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) { - out_frame[0] = RESP_CODE_EXPORT_CONTACT; - _serial->writeFrame(out_frame, out_len + 1); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // not found - } - } - } else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2+32+64) { - if (importContact(&cmd_frame[1], len - 1)) { - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - } else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { - int out_len; - if ((out_len = getFromOfflineQueue(out_frame)) > 0) { - _serial->writeFrame(out_frame, out_len); - #ifdef DISPLAY_CLASS - ui_task.msgRead(offline_queue_len); - #endif - } else { - out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; - _serial->writeFrame(out_frame, 1); - } - } else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { - int i = 1; - uint32_t freq; - memcpy(&freq, &cmd_frame[i], 4); i += 4; - uint32_t bw; - memcpy(&bw, &cmd_frame[i], 4); i += 4; - uint8_t sf = cmd_frame[i++]; - uint8_t cr = cmd_frame[i++]; - - if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && bw <= 500000) { - _prefs.sf = sf; - _prefs.cr = cr; - _prefs.freq = (float)freq / 1000.0; - _prefs.bw = (float)bw / 1000.0; - savePrefs(); - - radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); - MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); - - writeOKFrame(); - } else { - MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - } else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { - if (cmd_frame[1] > MAX_LORA_TX_POWER) { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } else { - _prefs.tx_power_dbm = cmd_frame[1]; - savePrefs(); - radio_set_tx_power(_prefs.tx_power_dbm); - writeOKFrame(); - } - } else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { - int i = 1; - uint32_t rx, af; - memcpy(&rx, &cmd_frame[i], 4); i += 4; - memcpy(&af, &cmd_frame[i], 4); i += 4; - _prefs.rx_delay_base = ((float)rx) / 1000.0f; - _prefs.airtime_factor = ((float)af) / 1000.0f; - savePrefs(); - writeOKFrame(); - } else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { - _prefs.manual_add_contacts = cmd_frame[1]; - if (len >= 3) { - _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ - _prefs.telemetry_mode_loc = (cmd_frame[2] >> 2) & 0x03; - _prefs.telemetry_mode_env = (cmd_frame[2] >> 4) & 0x03; - } - savePrefs(); - writeOKFrame(); - } else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { - if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed? - saveContacts(); - } - board.reboot(); - } else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { - uint8_t reply[3]; - reply[0] = RESP_CODE_BATTERY_VOLTAGE; - uint16_t battery_millivolts = board.getBattMilliVolts(); - memcpy(&reply[1], &battery_millivolts, 2); - _serial->writeFrame(reply, 3); - } else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { - #if ENABLE_PRIVATE_KEY_EXPORT - uint8_t reply[65]; - reply[0] = RESP_CODE_PRIVATE_KEY; - self_id.writeTo(&reply[1], 64); - _serial->writeFrame(reply, 65); - #else - writeDisabledFrame(); - #endif - } else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { - #if ENABLE_PRIVATE_KEY_IMPORT - mesh::LocalIdentity identity; - identity.readFrom(&cmd_frame[1], 64); - if (saveMainIdentity(identity)) { - self_id = identity; - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_FILE_IO_ERROR); - } - #else - writeDisabledFrame(); - #endif - } else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { - int i = 1; - int8_t path_len = cmd_frame[i++]; - if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload - uint8_t* path = &cmd_frame[i]; i += path_len; - auto pkt = createRawData(&cmd_frame[i], len - i); - if (pkt) { - sendDirect(pkt, path, path_len); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); - } - } else { - writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) - } - } else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1+PUB_KEY_SIZE) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - char *password = (char *) &cmd_frame[1+PUB_KEY_SIZE]; - cmd_frame[len] = 0; // ensure null terminator in password - if (recipient) { - uint32_t est_timeout; - int result = sendLogin(*recipient, password, est_timeout); - if (result == MSG_SEND_FAILED) { - writeErrFrame(ERR_CODE_TABLE_FULL); - } else { - pending_telemetry = pending_status = 0; - memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; - memcpy(&out_frame[2], &pending_login, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - } - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found - } - } else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1+PUB_KEY_SIZE) { - uint8_t* pub_key = &cmd_frame[1]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) { - uint32_t tag, est_timeout; - int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); - if (result == MSG_SEND_FAILED) { - writeErrFrame(ERR_CODE_TABLE_FULL); - } else { - pending_telemetry = pending_login = 0; - // FUTURE: pending_status = tag; // match this in onContactResponse() - memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; - memcpy(&out_frame[2], &tag, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - } - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found - } - } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4+PUB_KEY_SIZE) { - uint8_t* pub_key = &cmd_frame[4]; - ContactInfo* recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) { - uint32_t tag, est_timeout; - int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); - if (result == MSG_SEND_FAILED) { - writeErrFrame(ERR_CODE_TABLE_FULL); - } else { - pending_status = pending_login = 0; - pending_telemetry = tag; // match this in onContactResponse() - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = (result == MSG_SEND_SENT_FLOOD) ? 1 : 0; - memcpy(&out_frame[2], &tag, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - } - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found - } - } else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1+PUB_KEY_SIZE) { - uint8_t* pub_key = &cmd_frame[1]; - if (hasConnectionTo(pub_key)) { - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); - } - } else if (cmd_frame[0] == CMD_LOGOUT && len >= 1+PUB_KEY_SIZE) { - uint8_t* pub_key = &cmd_frame[1]; - stopConnection(pub_key); - writeOKFrame(); - } else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { - uint8_t channel_idx = cmd_frame[1]; - ChannelDetails channel; - if (getChannel(channel_idx, channel)) { - int i = 0; - out_frame[i++] = RESP_CODE_CHANNEL_INFO; - out_frame[i++] = channel_idx; - strcpy((char *)&out_frame[i], channel.name); i += 32; - memcpy(&out_frame[i], channel.channel.secret, 16); i += 16; // NOTE: only 128-bit supported - _serial->writeFrame(out_frame, i); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); - } - } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2+32+32) { - writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) - } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2+32+16) { - uint8_t channel_idx = cmd_frame[1]; - ChannelDetails channel; - StrHelper::strncpy(channel.name, (char *) &cmd_frame[2], 32); - memset(channel.channel.secret, 0, sizeof(channel.channel.secret)); - memcpy(channel.channel.secret, &cmd_frame[2+32], 16); // NOTE: only 128-bit supported - if (setChannel(channel_idx, channel)) { - saveChannels(); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx - } - } else if (cmd_frame[0] == CMD_SIGN_START) { - out_frame[0] = RESP_CODE_SIGN_START; - out_frame[1] = 0; // reserved - uint32_t len = MAX_SIGN_DATA_LEN; - memcpy(&out_frame[2], &len, 4); - _serial->writeFrame(out_frame, 6); - - if (sign_data) { - free(sign_data); - } - sign_data = (uint8_t *) malloc(MAX_SIGN_DATA_LEN); - sign_data_len = 0; - } else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { - if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) { - writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long - } else { - memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); - sign_data_len += (len - 1); - writeOKFrame(); - } - } else if (cmd_frame[0] == CMD_SIGN_FINISH) { - if (sign_data) { - self_id.sign(&out_frame[1], sign_data, sign_data_len); - - free(sign_data); // don't need sign_data now - sign_data = NULL; - - out_frame[0] = RESP_CODE_SIGNATURE; - _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); - } else { - writeErrFrame(ERR_CODE_BAD_STATE); - } - } else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { - uint32_t tag, auth; - memcpy(&tag, &cmd_frame[1], 4); - memcpy(&auth, &cmd_frame[5], 4); - auto pkt = createTrace(tag, auth, cmd_frame[9]); - if (pkt) { - uint8_t path_len = len - 10; - sendDirect(pkt, &cmd_frame[10], path_len); - - uint32_t t = _radio->getEstAirtimeFor(pkt->payload_len + pkt->path_len + 2); - uint32_t est_timeout = calcDirectTimeoutMillisFor(t, path_len); - - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = 0; - memcpy(&out_frame[2], &tag, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - } else { - writeErrFrame(ERR_CODE_TABLE_FULL); - } - } else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { - - // get pin from command frame - uint32_t pin; - memcpy(&pin, &cmd_frame[1], 4); - - // ensure pin is zero, or a valid 6 digit pin - if(pin == 0 || (pin >= 100000 && pin <= 999999)){ - _prefs.ble_pin = pin; - savePrefs(); - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - - } else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { - out_frame[0] = RESP_CODE_CUSTOM_VARS; - char* dp = (char *) &out_frame[1]; - for (int i = 0; i < sensors.getNumSettings() && dp - (char *) &out_frame[1] < 140; i++) { - if (i > 0) { *dp++ = ','; } - strcpy(dp, sensors.getSettingName(i)); dp = strchr(dp, 0); - *dp++ = ':'; - strcpy(dp, sensors.getSettingValue(i)); dp = strchr(dp, 0); - } - _serial->writeFrame(out_frame, dp - (char *)out_frame); - } else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { - cmd_frame[len] = 0; - char* sp = (char *) &cmd_frame[1]; - char* np = strchr(sp, ':'); // look for separator char - if (np) { - *np++ = 0; // modify 'cmd_frame', replace ':' with null - bool success = sensors.setSettingValue(sp, np); - if (success) { - writeOKFrame(); - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - } else { - writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - } else { - writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); - MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); - } - } - - void loop() { - BaseChatMesh::loop(); - - size_t len = _serial->checkRecvFrame(cmd_frame); - if (len > 0) { - handleCmdFrame(len); - } else if (_iter_started // check if our ContactsIterator is 'running' - && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! - ) { - ContactInfo contact; - if (_iter.hasNext(this, contact)) { - if (contact.lastmod > _iter_filter_since) { // apply the 'since' filter - writeContactRespFrame(RESP_CODE_CONTACT, contact); - if (contact.lastmod > _most_recent_lastmod) { - _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame - } - } - } else { // EOF - out_frame[0] = RESP_CODE_END_OF_CONTACTS; - memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' - _serial->writeFrame(out_frame, 5); - _iter_started = false; - } - } else if (!_serial->isWriteBusy()) { - checkConnections(); - } - - // is there are pending dirty contacts write needed? - if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) { - saveContacts(); - dirty_contacts_expiry = 0; - } - - #ifdef DISPLAY_CLASS - ui_task.setHasConnection(_serial->isConnected()); - ui_task.loop(); - #endif - } -}; #ifdef ESP32 #ifdef WIFI_SSID @@ -1641,10 +71,18 @@ public: #error "need to define a serial interface" #endif +/* GLOBAL OBJECTS */ StdRNG fast_rng; SimpleMeshTables tables; MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), tables); // TODO: test with 'rtc_clock' in target.cpp +#ifdef DISPLAY_CLASS + #include "UITask.h" + UITask ui_task(&board); +#endif +/* END GLOBAL OBJECTS */ + + void halt() { while (1) ; } diff --git a/variants/generic_espnow/platformio.ini b/variants/generic_espnow/platformio.ini index 8a033a62..b3ae7e45 100644 --- a/variants/generic_espnow/platformio.ini +++ b/variants/generic_espnow/platformio.ini @@ -62,7 +62,7 @@ build_flags = ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 ; NOTE: DO NOT ENABLE --> -D ESPNOW_DEBUG_LOGGING=1 build_src_filter = ${Generic_ESPNOW.build_src_filter} - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${Generic_ESPNOW.lib_deps} densaugeo/base64 @ ~1.4.0 diff --git a/variants/promicro/platformio.ini b/variants/promicro/platformio.ini index 11f73d81..49771624 100644 --- a/variants/promicro/platformio.ini +++ b/variants/promicro/platformio.ini @@ -186,7 +186,7 @@ build_flags = ${ProMicroLLCC68.build_flags} ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${ProMicroLLCC68.build_src_filter} - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${ProMicroLLCC68.lib_deps} adafruit/RTClib @ ^2.1.3 densaugeo/base64 @ ~1.4.0 @@ -205,7 +205,7 @@ build_flags = ${ProMicroLLCC68.build_flags} ; -D MESH_DEBUG=1 build_src_filter = ${ProMicroLLCC68.build_src_filter} + - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${ProMicroLLCC68.lib_deps} adafruit/RTClib @ ^2.1.3 densaugeo/base64 @ ~1.4.0 diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index 37e31e6f..c4569cf8 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -75,7 +75,7 @@ build_flags = ; -D ENABLE_PRIVATE_KEY_IMPORT=1 ; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 -; -D MESH_DEBUG=1 + -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} + + @@ -102,7 +102,7 @@ build_flags = ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} + - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${Heltec_t114.lib_deps} densaugeo/base64 @ ~1.4.0 \ No newline at end of file diff --git a/variants/xiao_nrf52/platformio.ini b/variants/xiao_nrf52/platformio.ini index 2f468f4f..45d28740 100644 --- a/variants/xiao_nrf52/platformio.ini +++ b/variants/xiao_nrf52/platformio.ini @@ -68,7 +68,7 @@ build_flags = ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_nrf52.build_src_filter} + - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${Xiao_nrf52.lib_deps} densaugeo/base64 @ ~1.4.0 @@ -84,7 +84,7 @@ build_flags = ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_nrf52.build_src_filter} + - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${Xiao_nrf52.lib_deps} densaugeo/base64 @ ~1.4.0 diff --git a/variants/xiao_s3_wio/platformio.ini b/variants/xiao_s3_wio/platformio.ini index 841a50c3..cfc8e774 100644 --- a/variants/xiao_s3_wio/platformio.ini +++ b/variants/xiao_s3_wio/platformio.ini @@ -108,7 +108,7 @@ build_flags = ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_S3_WIO.build_src_filter} + - +<../examples/companion_radio/main.cpp> + +<../examples/companion_radio> lib_deps = ${Xiao_S3_WIO.lib_deps} densaugeo/base64 @ ~1.4.0 From 8b780ddd7b0ad6f2308be19042e04e5b6df7aae7 Mon Sep 17 00:00:00 2001 From: uncle lit <43320854+LitBomb@users.noreply.github.com> Date: Sat, 31 May 2025 21:59:14 -0700 Subject: [PATCH 03/87] faq.md: update OTA firmware instructions added ESP32 OTA firmware update instructions added nRF OTA firmware update instructions to use the new nRF DFU app on android and iOS --- docs/faq.md | 88 +++++++++++++++-------------------------------------- 1 file changed, 25 insertions(+), 63 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 030c5531..c61c8d2b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -65,7 +65,8 @@ author: https://github.com/LitBomb - [6.4. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?](#64-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code) - [6.5. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.](#65-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone--it-cant-hold-a-solid-bluetooth-connection) - [7. Other Questions:](#7-other-questions) - - [7.1. Q: How to Update repeater and room server firmware over the air?](#71-q-how-to--update-repeater-and-room-server-firmware-over-the-air) + - [7.2 Q: How to update ESP32-based devices over the air?](#72-q-how-to-update-esp32-based-devices-over-the-air) + - [7.1 Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?](#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app) ## 1. Introduction @@ -534,74 +535,35 @@ You can get the epoch time on and use it to se --- ## 7. Other Questions: -### 7.1. Q: How to Update repeater and room server firmware over the air? -**A:** Only nRF-based RAK4631 and Heltec T114 OTA firmware update are verified using nRF smartphone app. Lilygo T-Echo doesn't work currently. -You can update repeater and room server firmware with a Bluetooth connection between your smartphone and your LoRa radio using the nRF app. +### 7.2 Q: How to update ESP32-based devices over the air? -1. Download the ZIP file for the specific node from the web flasher to your smartphone -2. On the phone client, log on to the repeater as administrator (default password is `password`) to issue the `start ota`command to the repeater or room server to get the device into OTA DFU mode - -![image](https://github.com/user-attachments/assets/889bb81b-7214-4a1c-955a-396b5a05d8ad) - -1. `start ota` can be initiated from USB serial console on the web flasher page or a T-Deck -4. On the smartphone, download and run the nRF app and scan for Bluetooth devices -5. Connect to the repeater/room server node you want to update - 1. nRF app is available on both Android and iOS - -**Android continues after the iOS section:** - -**iOS continues here:** -5. Once connected successfully, a `DFU` icon ![Pasted image 20250309173039](https://github.com/user-attachments/assets/af7a9f78-8739-4946-b734-02bade9c8e71) - appears in the top right corner of the app - ![Pasted image 20250309171919](https://github.com/user-attachments/assets/08007ec8-4924-49c1-989f-ca2611e78793) - -6. Scroll down to change the `PRN(s)` number: - -![Pasted image 20250309190158](https://github.com/user-attachments/assets/11f69cdd-12f3-4696-a6fc-14a78c85fe32) - -- For the T114, change the number of packets `(PRN(s)` to 8 -- For RAK, it can be 10, but it also works on 8. - -7. Click the `DFU` icon ![Pasted image 20250309173039](https://github.com/user-attachments/assets/af7a9f78-8739-4946-b734-02bade9c8e71), select the type of file to upload (choose ZIP), then select the ZIP file that was downloaded earlier from the web flasher -8. The upload process will start now. If everything goes well, the node resets and is flashed successfully. -![Pasted image 20250309190342](https://github.com/user-attachments/assets/a60e25d0-33b8-46cf-af90-20a7d8ac2adb) +**A:** For ESP32-based devices (e.g. Heltec V3): +1. On flasher.meshcore.co.uk, download the **non-merged** version of the firmware for your ESP32 device (e.g. `Heltec_v3_repeater-v1.6.2-4449fd3.bin`, no `"merged"` in the file name) +2. From the MeshCore app, login remotely to the repeater you want to update with admin priviledge +4. Go to the Command Line tab, type `start ota` and hit enter. +5. you should see `OK` to confirm the repeater device is now in OTA mode +6. The command `start ota` on an ESP32-based device starts a wifi hotspot named `MeshCore OTA` +7. From your phone or computer connect to the 'MeshCore OTA' hotspot +8. From a browser, go to http://192.168.4.1/update and upload the non-merged bin from the flasher +### 7.1 Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app? -**Android steps continues below:** -1. on the top left corner of the nRF Connect app on Android, tap the 3-bar hamburger menu, then `Settings`, then `nRF5 DFU Options` +**A:** The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms: -![Android nRF Hamberger](https://github.com/user-attachments/assets/ea6dfeef-9367-4830-bd70-1441d517c706) - -![Android nRF Settings](https://github.com/user-attachments/assets/c63726bf-cecd-4987-be68-afb6358c7190) - -![Android nRF DFU Options](https://github.com/user-attachments/assets/b20e872f-5122-41d9-90df-0215cff5fbc9) - -2. Change `Number of packets` to `10` for RAK, `8` for Heltec T114 - -![Android nRF Number of Packets](https://github.com/user-attachments/assets/c092adaf-4cb3-460b-b7ef-8d7f450d602b) - -3. Go back to the main screen -4. Your LoRa device should already ben in DFU mode from previous steps -5. tap `SCANNER` and then `SCAN` to find the device you want to update, tap `CONNECT` - -![Android nRF Scanner Scan Connect](https://github.com/user-attachments/assets/37218717-f167-48b6-a6ca-93d132ef77ca) - -6. On the top left corner of the nRF Connect app, tap the `DFU` icon next to the three dots - -![Android nRF DFU](https://github.com/user-attachments/assets/1ec3b818-bf0c-461f-8fdf-37c41a63cafa) - -7. Choose `Distribution packet (ZIP)` and then `OK` - -![Android nRF Distribution Packet (ZIP)](https://github.com/user-attachments/assets/e65f5616-9793-44f5-95c0-a3eb15aa7152) - -8. Choose the firmware file in ZIP formate that you downloaded earlier from the MeshCore web flasher, update will start as soon as you tap the file - -![Android nRF FW Updating](https://github.com/user-attachments/assets/0814d123-85ce-4c87-90a7-e1a25dc71900) - -9. When the update process is done, the device will disconnect from nRF app and the LoRa device is updated +1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for `nrf dfu`, the app's full name is `nRF Device Firmware Update` +2. On flasher.meshcore.co.uk, download the **ZIP** version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao) +3. From the MeshCore app, login remotely to the repeater you want to update with admin priviledge +4. Go to the Command Line tab, type `start ota` and hit enter. +5. you should see `OK` to confirm the repeater device is now in OTA mode +6. Run the DFU app,tab `Settings` on the top right corner +7. Enable `Packets receipt notifications` and change `Number of Packets` to 10 for RAK, 8 for T114. 8 also works for RAK. +8. Select the firmware zip file you downloaded +9. Select the device you want to update. If the device you want to updat is not on the list, try enabling`OTA` on the device again +10. Tab the `Upload` to begin OTA update +11. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone. +12. Wait for the update to complete. It can take a few minutes. --- - From 053aa0b3d690dced2628b58bea5ad48c77846632 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 09:24:10 -0700 Subject: [PATCH 04/87] Adding clang-format --- .clang-format | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 84 insertions(+) create mode 100644 .clang-format diff --git a/.clang-format b/.clang-format new file mode 100644 index 00000000..80c7a10a --- /dev/null +++ b/.clang-format @@ -0,0 +1,84 @@ +# .clang-format +Language: Cpp +AccessModifierOffset: -2 +AlignAfterOpenBracket: Align +AlignConsecutiveAssignments: false +AlignConsecutiveDeclarations: false +AlignConsecutiveMacros: + Enabled: true + AcrossEmptyLines: true + AcrossComments: true +AlignOperands: true +AlignTrailingComments: true +AllowAllParametersOfDeclarationOnNextLine: false +AllowShortBlocksOnASingleLine: false +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Inline +AllowShortIfStatementsOnASingleLine: false +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: false +AlwaysBreakTemplateDeclarations: No +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterClass: false + AfterControlStatement: false + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + BeforeCatch: true + BeforeElse: true + IndentBraces: false +BreakBeforeBinaryOperators: None +BreakBeforeBraces: Stroustrup +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +ColumnLimit: 110 +CommentPragmas: '^ IWYU pragma:' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: false +Cpp11BracedListStyle: false +DerivePointerAlignment: false +DisableFormat: false +IncludeBlocks: Regroup +IndentCaseLabels: false +IndentPPDirectives: None +IndentWidth: 2 +IndentWrappedFunctionNames: false +KeepEmptyLinesAtTheStartOfBlocks: true +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBinPackProtocolList: Auto +PenaltyBreakBeforeFirstCallParameter: 19 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyExcessCharacter: 100000 +PenaltyReturnTypeOnItsOwnLine: 60 +PointerAlignment: Right +ReflowComments: true +SortIncludes: true +SpaceAfterCStyleCast: false +SpaceAfterTemplateKeyword: true +SpaceBeforeAssignmentOperators: true +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 1 +SpacesInAngles: false +SpacesInContainerLiterals: false +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +Standard: Auto +TabWidth: 2 +UseTab: Never +AlignEscapedNewlines: LeftWithLastLine \ No newline at end of file From 5bf58127553b0fe0ba4d9f8355124f2764c60293 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 09:24:32 -0700 Subject: [PATCH 05/87] Removing debug mode --- variants/t114/platformio.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index c4569cf8..fd9d6f34 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -75,7 +75,7 @@ build_flags = ; -D ENABLE_PRIVATE_KEY_IMPORT=1 ; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 - -D MESH_DEBUG=1 +; -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} + + From f7f96ad372727e7a981480398ca43952bf9e5065 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 09:25:17 -0700 Subject: [PATCH 06/87] Reformatting code --- examples/companion_radio/Button.cpp | 229 ++++---- examples/companion_radio/Button.h | 112 ++-- examples/companion_radio/MyMesh.cpp | 790 +++++++++++---------------- examples/companion_radio/MyMesh.h | 336 +++++------- examples/companion_radio/NodePrefs.h | 16 +- examples/companion_radio/UITask.h | 47 +- examples/simple_secure_chat/main.cpp | 428 +++++++++------ 7 files changed, 919 insertions(+), 1039 deletions(-) diff --git a/examples/companion_radio/Button.cpp b/examples/companion_radio/Button.cpp index ec1f0f69..5de4b702 100644 --- a/examples/companion_radio/Button.cpp +++ b/examples/companion_radio/Button.cpp @@ -1,125 +1,142 @@ #include "Button.h" -Button::Button(uint8_t pin, bool activeState) - : _pin(pin), _activeState(activeState), _isAnalog(false), _analogThreshold(20) { - _currentState = false; // Initialize as not pressed - _lastState = _currentState; +Button::Button(uint8_t pin, bool activeState) + : _pin(pin), _activeState(activeState), _isAnalog(false), _analogThreshold(20) +{ + _currentState = false; // Initialize as not pressed + _lastState = _currentState; } Button::Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold) - : _pin(pin), _activeState(activeState), _isAnalog(isAnalog), _analogThreshold(analogThreshold) { - _currentState = false; // Initialize as not pressed - _lastState = _currentState; + : _pin(pin), _activeState(activeState), _isAnalog(isAnalog), _analogThreshold(analogThreshold) +{ + _currentState = false; // Initialize as not pressed + _lastState = _currentState; } -void Button::begin() { - _currentState = readButton(); - _lastState = _currentState; +void Button::begin() +{ + _currentState = readButton(); + _lastState = _currentState; } -void Button::update() { - uint32_t now = millis(); - - // Read button at specified interval - if (now - _lastReadTime < BUTTON_READ_INTERVAL_MS) { - return; +void Button::update() +{ + uint32_t now = millis(); + + // Read button at specified interval + if (now - _lastReadTime < BUTTON_READ_INTERVAL_MS) { + return; + } + _lastReadTime = now; + + bool newState = readButton(); + + // Check if state has changed + if (newState != _lastState) { + _stateChangeTime = now; + } + + // Debounce check + if ((now - _stateChangeTime) > BUTTON_DEBOUNCE_TIME_MS) { + if (newState != _currentState) { + _currentState = newState; + handleStateChange(); } - _lastReadTime = now; - - bool newState = readButton(); - - // Check if state has changed - if (newState != _lastState) { - _stateChangeTime = now; + } + + _lastState = newState; + + // Handle multi-click timeout + if (_state == WAITING_FOR_MULTI_CLICK && (now - _releaseTime) > BUTTON_CLICK_TIMEOUT_MS) { + // Timeout reached, process the clicks + if (_clickCount == 1) { + triggerEvent(SHORT_PRESS); } - - // Debounce check - if ((now - _stateChangeTime) > BUTTON_DEBOUNCE_TIME_MS) { - if (newState != _currentState) { - _currentState = newState; - handleStateChange(); - } + else if (_clickCount == 2) { + triggerEvent(DOUBLE_PRESS); } - - _lastState = newState; - - // Handle multi-click timeout - if (_state == WAITING_FOR_MULTI_CLICK && (now - _releaseTime) > BUTTON_CLICK_TIMEOUT_MS) { - // Timeout reached, process the clicks - if (_clickCount == 1) { - triggerEvent(SHORT_PRESS); - } else if (_clickCount == 2) { - triggerEvent(DOUBLE_PRESS); - } else if (_clickCount >= 3) { - triggerEvent(TRIPLE_PRESS); - } - _clickCount = 0; + else if (_clickCount >= 3) { + triggerEvent(TRIPLE_PRESS); + } + _clickCount = 0; + _state = IDLE; + } + + // Handle long press while button is held + if (_state == PRESSED && (now - _pressTime) > BUTTON_LONG_PRESS_TIME_MS) { + triggerEvent(LONG_PRESS); + _state = IDLE; // Prevent multiple press events + _clickCount = 0; + } +} + +bool Button::readButton() +{ + if (_isAnalog) { + return (analogRead(_pin) < _analogThreshold); + } + else { + return (digitalRead(_pin) == _activeState); + } +} + +void Button::handleStateChange() +{ + uint32_t now = millis(); + + if (_currentState) { + // Button pressed + _pressTime = now; + _state = PRESSED; + triggerEvent(ANY_PRESS); + } + else { + // Button released + if (_state == PRESSED) { + uint32_t pressDuration = now - _pressTime; + + if (pressDuration < BUTTON_LONG_PRESS_TIME_MS) { + // Short press detected + _clickCount++; + _releaseTime = now; + _state = WAITING_FOR_MULTI_CLICK; + } + else { + // Long press already handled in update() _state = IDLE; - } - - // Handle long press while button is held - if (_state == PRESSED && (now - _pressTime) > BUTTON_LONG_PRESS_TIME_MS) { - triggerEvent(LONG_PRESS); - _state = IDLE; // Prevent multiple press events _clickCount = 0; + } } + } } -bool Button::readButton() { - if (_isAnalog) { - return (analogRead(_pin) < _analogThreshold); - } else { - return (digitalRead(_pin) == _activeState); - } -} +void Button::triggerEvent(EventType event) +{ + _lastEvent = event; -void Button::handleStateChange() { - uint32_t now = millis(); - - if (_currentState) { - // Button pressed - _pressTime = now; - _state = PRESSED; - triggerEvent(ANY_PRESS); - } else { - // Button released - if (_state == PRESSED) { - uint32_t pressDuration = now - _pressTime; - - if (pressDuration < BUTTON_LONG_PRESS_TIME_MS) { - // Short press detected - _clickCount++; - _releaseTime = now; - _state = WAITING_FOR_MULTI_CLICK; - } else { - // Long press already handled in update() - _state = IDLE; - _clickCount = 0; - } - } - } -} - -void Button::triggerEvent(EventType event) { - _lastEvent = event; - - switch (event) { - case ANY_PRESS: - if (_onAnyPress) _onAnyPress(); - break; - case SHORT_PRESS: - if (_onShortPress) _onShortPress(); - break; - case DOUBLE_PRESS: - if (_onDoublePress) _onDoublePress(); - break; - case TRIPLE_PRESS: - if (_onTriplePress) _onTriplePress(); - break; - case LONG_PRESS: - if (_onLongPress) _onLongPress(); - break; - default: - break; - } + switch (event) { + case ANY_PRESS: + if (_onAnyPress) + _onAnyPress(); + break; + case SHORT_PRESS: + if (_onShortPress) + _onShortPress(); + break; + case DOUBLE_PRESS: + if (_onDoublePress) + _onDoublePress(); + break; + case TRIPLE_PRESS: + if (_onTriplePress) + _onTriplePress(); + break; + case LONG_PRESS: + if (_onLongPress) + _onLongPress(); + break; + default: + break; + } } \ No newline at end of file diff --git a/examples/companion_radio/Button.h b/examples/companion_radio/Button.h index 47c792bd..85564593 100644 --- a/examples/companion_radio/Button.h +++ b/examples/companion_radio/Button.h @@ -4,74 +4,62 @@ #include // Button timing configuration -#define BUTTON_DEBOUNCE_TIME_MS 50 // Debounce time in ms -#define BUTTON_CLICK_TIMEOUT_MS 500 // Max time between clicks for multi-click -#define BUTTON_LONG_PRESS_TIME_MS 3000 // Time to trigger long press (3 seconds) -#define BUTTON_READ_INTERVAL_MS 10 // How often to read the button +#define BUTTON_DEBOUNCE_TIME_MS 50 // Debounce time in ms +#define BUTTON_CLICK_TIMEOUT_MS 500 // Max time between clicks for multi-click +#define BUTTON_LONG_PRESS_TIME_MS 3000 // Time to trigger long press (3 seconds) +#define BUTTON_READ_INTERVAL_MS 10 // How often to read the button class Button { public: - enum EventType { - NONE, - SHORT_PRESS, - DOUBLE_PRESS, - TRIPLE_PRESS, - LONG_PRESS, - ANY_PRESS - }; + enum EventType { NONE, SHORT_PRESS, DOUBLE_PRESS, TRIPLE_PRESS, LONG_PRESS, ANY_PRESS }; - using EventCallback = std::function; + using EventCallback = std::function; - Button(uint8_t pin, bool activeState = LOW); - Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold = 20); - - void begin(); - void update(); - - // Set callbacks for different events - void onShortPress(EventCallback callback) { _onShortPress = callback; } - void onDoublePress(EventCallback callback) { _onDoublePress = callback; } - void onTriplePress(EventCallback callback) { _onTriplePress = callback; } - void onLongPress(EventCallback callback) { _onLongPress = callback; } - void onAnyPress(EventCallback callback) { _onAnyPress = callback; } - - // State getters - bool isPressed() const { return _currentState; } - EventType getLastEvent() const { return _lastEvent; } + Button(uint8_t pin, bool activeState = LOW); + Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold = 20); + + void begin(); + void update(); + + // Set callbacks for different events + void onShortPress(EventCallback callback) { _onShortPress = callback; } + void onDoublePress(EventCallback callback) { _onDoublePress = callback; } + void onTriplePress(EventCallback callback) { _onTriplePress = callback; } + void onLongPress(EventCallback callback) { _onLongPress = callback; } + void onAnyPress(EventCallback callback) { _onAnyPress = callback; } + + // State getters + bool isPressed() const { return _currentState; } + EventType getLastEvent() const { return _lastEvent; } private: - enum State { - IDLE, - PRESSED, - RELEASED, - WAITING_FOR_MULTI_CLICK - }; + enum State { IDLE, PRESSED, RELEASED, WAITING_FOR_MULTI_CLICK }; - uint8_t _pin; - bool _activeState; - bool _isAnalog; - uint16_t _analogThreshold; - - State _state = IDLE; - bool _currentState; - bool _lastState; - - uint32_t _stateChangeTime = 0; - uint32_t _pressTime = 0; - uint32_t _releaseTime = 0; - uint32_t _lastReadTime = 0; - - uint8_t _clickCount = 0; - EventType _lastEvent = NONE; - - // Callbacks - EventCallback _onShortPress = nullptr; - EventCallback _onDoublePress = nullptr; - EventCallback _onTriplePress = nullptr; - EventCallback _onLongPress = nullptr; - EventCallback _onAnyPress = nullptr; - - bool readButton(); - void handleStateChange(); - void triggerEvent(EventType event); + uint8_t _pin; + bool _activeState; + bool _isAnalog; + uint16_t _analogThreshold; + + State _state = IDLE; + bool _currentState; + bool _lastState; + + uint32_t _stateChangeTime = 0; + uint32_t _pressTime = 0; + uint32_t _releaseTime = 0; + uint32_t _lastReadTime = 0; + + uint8_t _clickCount = 0; + EventType _lastEvent = NONE; + + // Callbacks + EventCallback _onShortPress = nullptr; + EventCallback _onDoublePress = nullptr; + EventCallback _onTriplePress = nullptr; + EventCallback _onLongPress = nullptr; + EventCallback _onAnyPress = nullptr; + + bool readButton(); + void handleStateChange(); + void triggerEvent(EventType event); }; \ No newline at end of file diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 6e9688a5..db40169f 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1,19 +1,83 @@ -#include // needed for PlatformIO -#include #include "MyMesh.h" +#include // needed for PlatformIO +#include + +#define CMD_APP_START 1 +#define CMD_SEND_TXT_MSG 2 +#define CMD_SEND_CHANNEL_TXT_MSG 3 +#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) +#define CMD_GET_DEVICE_TIME 5 +#define CMD_SET_DEVICE_TIME 6 +#define CMD_SEND_SELF_ADVERT 7 +#define CMD_SET_ADVERT_NAME 8 +#define CMD_ADD_UPDATE_CONTACT 9 +#define CMD_SYNC_NEXT_MESSAGE 10 +#define CMD_SET_RADIO_PARAMS 11 +#define CMD_SET_RADIO_TX_POWER 12 +#define CMD_RESET_PATH 13 +#define CMD_SET_ADVERT_LATLON 14 +#define CMD_REMOVE_CONTACT 15 +#define CMD_SHARE_CONTACT 16 +#define CMD_EXPORT_CONTACT 17 +#define CMD_IMPORT_CONTACT 18 +#define CMD_REBOOT 19 +#define CMD_GET_BATTERY_VOLTAGE 20 +#define CMD_SET_TUNING_PARAMS 21 +#define CMD_DEVICE_QEURY 22 +#define CMD_EXPORT_PRIVATE_KEY 23 +#define CMD_IMPORT_PRIVATE_KEY 24 +#define CMD_SEND_RAW_DATA 25 +#define CMD_SEND_LOGIN 26 +#define CMD_SEND_STATUS_REQ 27 +#define CMD_HAS_CONNECTION 28 +#define CMD_LOGOUT 29 // 'Disconnect' +#define CMD_GET_CONTACT_BY_KEY 30 +#define CMD_GET_CHANNEL 31 +#define CMD_SET_CHANNEL 32 +#define CMD_SIGN_START 33 +#define CMD_SIGN_DATA 34 +#define CMD_SIGN_FINISH 35 +#define CMD_SEND_TRACE_PATH 36 +#define CMD_SET_DEVICE_PIN 37 +#define CMD_SET_OTHER_PARAMS 38 +#define CMD_SEND_TELEMETRY_REQ 39 +#define CMD_GET_CUSTOM_VARS 40 +#define CMD_SET_CUSTOM_VAR 41 + +#define RESP_CODE_OK 0 +#define RESP_CODE_ERR 1 +#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS +#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) +#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS +#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START +#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG +#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME +#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE +#define RESP_CODE_EXPORT_CONTACT 11 +#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE +#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY +#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY +#define RESP_CODE_DISABLED 15 +#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL +#define RESP_CODE_SIGN_START 19 +#define RESP_CODE_SIGNATURE 20 +#define RESP_CODE_CUSTOM_VARS 21 + #ifdef DISPLAY_CLASS - #include "UITask.h" +#include "UITask.h" #endif void MyMesh::loadMainIdentity() { - if (!_identity_store->load("_main", self_id)) - { + if (!_identity_store->load("_main", self_id)) { self_id = radio_new_identity(); // create new random identity int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) - { // reserved id hashes + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes self_id = radio_new_identity(); count++; } @@ -28,18 +92,15 @@ bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) void MyMesh::loadContacts() { - if (_fs->exists("/contacts3")) - { + if (_fs->exists("/contacts3")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/contacts3", "r"); #else File file = _fs->open("/contacts3"); #endif - if (file) - { + if (file) { bool full = false; - while (!full) - { + while (!full) { ContactInfo c; uint8_t pub_key[32]; uint8_t unused; @@ -79,14 +140,12 @@ void MyMesh::saveContacts() #else File file = _fs->open("/contacts3", "w", true); #endif - if (file) - { + if (file) { ContactsIterator iter; ContactInfo c; uint8_t unused = 0; - while (iter.hasNext(this, c)) - { + while (iter.hasNext(this, c)) { bool success = (file.write(c.id.pub_key, 32) == 32); success = success && (file.write((uint8_t *)&c.name, 32) == 32); success = success && (file.write(&c.type, 1) == 1); @@ -109,19 +168,16 @@ void MyMesh::saveContacts() void MyMesh::loadChannels() { - if (_fs->exists("/channels2")) - { + if (_fs->exists("/channels2")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/channels2", "r"); #else File file = _fs->open("/channels2"); #endif - if (file) - { + if (file) { bool full = false; uint8_t channel_idx = 0; - while (!full) - { + while (!full) { ChannelDetails ch; uint8_t unused[4]; @@ -132,12 +188,10 @@ void MyMesh::loadChannels() if (!success) break; // EOF - if (setChannel(channel_idx, ch)) - { + if (setChannel(channel_idx, ch)) { channel_idx++; } - else - { + else { full = true; } } @@ -156,15 +210,13 @@ void MyMesh::saveChannels() #else File file = _fs->open("/channels2", "w", true); #endif - if (file) - { + if (file) { uint8_t channel_idx = 0; ChannelDetails ch; uint8_t unused[4]; memset(unused, 0, 4); - while (getChannel(channel_idx, ch)) - { + while (getChannel(channel_idx, ch)) { bool success = (file.write(unused, 4) == 4); success = success && (file.write((uint8_t *)ch.name, 32) == 32); success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); @@ -187,15 +239,13 @@ int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); - if (_fs->exists(path)) - { + if (_fs->exists(path)) { #if defined(RP2040_PLATFORM) File f = _fs->open(path, "r"); #else File f = _fs->open(path); #endif - if (f) - { + if (f) { int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! f.close(); return len; @@ -222,8 +272,7 @@ bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_bu #else File f = _fs->open(path, "w", true); #endif - if (f) - { + if (f) { int n = f.write(src_buf, len); f.close(); if (n == len) @@ -294,8 +343,7 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, i += 32; memcpy(&contact.last_advert_timestamp, &frame[i], 4); i += 4; - if (i + 8 >= len) - { // optional fields + if (i + 8 >= len) { // optional fields memcpy(&contact.gps_lat, &frame[i], 4); i += 4; memcpy(&contact.gps_lon, &frame[i], 4); @@ -305,12 +353,10 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) { - if (offline_queue_len >= OFFLINE_QUEUE_SIZE) - { + if (offline_queue_len >= OFFLINE_QUEUE_SIZE) { MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); } - else - { + else { offline_queue[offline_queue_len].len = len; memcpy(offline_queue[offline_queue_len].buf, frame, len); offline_queue_len++; @@ -318,14 +364,12 @@ void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) } int MyMesh::getFromOfflineQueue(uint8_t frame[]) { - if (offline_queue_len > 0) - { // check offline queue + if (offline_queue_len > 0) { // check offline queue size_t len = offline_queue[0].len; // take from top of queue memcpy(frame, offline_queue[0].buf, len); offline_queue_len--; - for (int i = 0; i < offline_queue_len; i++) - { // delete top item from queue + for (int i = 0; i < offline_queue_len; i++) { // delete top item from queue offline_queue[i] = offline_queue[i + 1]; } return len; @@ -352,8 +396,7 @@ int MyMesh::calcRxDelay(float score, uint32_t air_time) const void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) { - if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) - { + if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) { int i = 0; out_frame[i++] = PUSH_CODE_LOG_RX_DATA; out_frame[i++] = (int8_t)(snr * 4); @@ -372,21 +415,17 @@ bool MyMesh::isAutoAddEnabled() const void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { - if (_serial->isConnected()) - { - if (!isAutoAddEnabled() && is_new) - { + if (_serial->isConnected()) { + if (!isAutoAddEnabled() && is_new) { writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); } - else - { + else { out_frame[0] = PUSH_CODE_ADVERT; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); } } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::newContactMessage); #endif @@ -407,10 +446,8 @@ void MyMesh::onContactPathUpdated(const ContactInfo &contact) bool MyMesh::processAck(const uint8_t *data) { // see if matches any in a table - for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) - { - if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) - { // got an ACK from recipient + for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) { + if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient out_frame[0] = PUSH_CODE_SEND_CONFIRMED; memcpy(&out_frame[1], data, 4); uint32_t trip_time = _ms->getMillis() - expected_ack_table[i].msg_sent; @@ -425,18 +462,17 @@ bool MyMesh::processAck(const uint8_t *data) return checkConnectionsAck(data); } -void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) +void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, + uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) { int i = 0; - if (app_target_ver >= 3) - { + if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 } - else - { + else { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; } memcpy(&out_frame[i], from.id.pub_key, 6); @@ -445,28 +481,24 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe out_frame[i++] = txt_type; memcpy(&out_frame[i], &sender_timestamp, 4); i += 4; - if (extra_len > 0) - { + if (extra_len > 0) { memcpy(&out_frame[i], extra, extra_len); i += extra_len; } int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) - { + if (i + tlen > MAX_FRAME_SIZE) { tlen = MAX_FRAME_SIZE - i; } memcpy(&out_frame[i], text, tlen); i += tlen; addToOfflineQueue(out_frame, i); - if (_serial->isConnected()) - { + if (_serial->isConnected()) { uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::contactMessage); #endif @@ -476,19 +508,22 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe #endif } -void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); } -void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); } -void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) +void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) { markConnectionActive(from); // from.sync_since change needs to be persisted @@ -496,18 +531,17 @@ void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uin queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text); } -void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, const char *text) +void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, + const char *text) { int i = 0; - if (app_target_ver >= 3) - { + if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 } - else - { + else { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; } @@ -518,22 +552,19 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe memcpy(&out_frame[i], ×tamp, 4); i += 4; int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) - { + if (i + tlen > MAX_FRAME_SIZE) { tlen = MAX_FRAME_SIZE - i; } memcpy(&out_frame[i], text, tlen); i += tlen; addToOfflineQueue(out_frame, i); - if (_serial->isConnected()) - { + if (_serial->isConnected()) { uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::channelMessage); #endif @@ -543,48 +574,42 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe #endif } -uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, uint8_t len, uint8_t *reply) +uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, + uint8_t len, uint8_t *reply) { - if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) - { + if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) { uint8_t permissions = 0; uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) - if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) { permissions = TELEM_PERM_BASE; } - else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { permissions = cp & TELEM_PERM_BASE; } - if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_LOCATION; } - else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_LOCATION; } - if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_ENVIRONMENT; } - else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_ENVIRONMENT; } - if (permissions & TELEM_PERM_BASE) - { // only respond if base permission bit is set + if (permissions & TELEM_PERM_BASE) { // only respond if base permission bit is set telemetry.reset(); telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); // query other sensors -- target specific sensors.querySensors(permissions, telemetry); - memcpy(reply, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') + memcpy(reply, &sender_timestamp, + 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') uint8_t tlen = telemetry.getSize(); memcpy(&reply[4], telemetry.getBuffer(), tlen); @@ -599,24 +624,20 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint32_t tag; memcpy(&tag, data, 4); - if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) - { // check for login response + if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) { // check for login response // yes, is response to pending sendLogin() pending_login = 0; int i = 0; - if (memcmp(&data[4], "OK", 2) == 0) - { // legacy Repeater login OK response + if (memcmp(&data[4], "OK", 2) == 0) { // legacy Repeater login OK response out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; out_frame[i++] = 0; // legacy: is_admin = false memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix } - else if (data[4] == RESP_SERVER_LOGIN_OK) - { // new login response + else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; - if (keep_alive_secs > 0) - { + if (keep_alive_secs > 0) { startConnection(contact, keep_alive_secs); } out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; @@ -626,8 +647,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, memcpy(&out_frame[i], &tag, 4); i += 4; // NEW: include server timestamp } - else - { + else { out_frame[i++] = PUSH_CODE_LOGIN_FAIL; out_frame[i++] = 0; // reserved memcpy(&out_frame[i], contact.id.pub_key, 6); @@ -635,11 +655,11 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, } _serial->writeFrame(out_frame, i); } - else if (len > 4 && // check for status response - pending_status && memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme - // FUTURE: tag == pending_status - ) - { + else if (len > 4 && // check for status response + pending_status && + memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme + // FUTURE: tag == pending_status + ) { pending_status = 0; int i = 0; @@ -651,8 +671,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, i += (len - 4); _serial->writeFrame(out_frame, i); } - else if (len > 4 && tag == pending_telemetry) - { // check for telemetry response + else if (len > 4 && tag == pending_telemetry) { // check for telemetry response pending_telemetry = 0; int i = 0; @@ -668,8 +687,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, void MyMesh::onRawDataRecv(mesh::Packet *packet) { - if (packet->payload_len + 4 > sizeof(out_frame)) - { + if (packet->payload_len + 4 > sizeof(out_frame)) { MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); return; } @@ -681,17 +699,16 @@ void MyMesh::onRawDataRecv(mesh::Packet *packet) memcpy(&out_frame[i], packet->payload, packet->payload_len); i += packet->payload_len; - if (_serial->isConnected()) - { + if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); } - else - { + else { MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); } } -void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) +void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) { int i = 0; out_frame[i++] = PUSH_CODE_TRACE_DATA; @@ -708,12 +725,10 @@ void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, i += path_len; out_frame[i++] = (int8_t)(packet->getSNR() * 4); // extra/final SNR (to this node) - if (_serial->isConnected()) - { + if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); } - else - { + else { MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); } } @@ -725,16 +740,15 @@ uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const { return SEND_TIMEOUT_BASE_MILLIS + - ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * + (path_len + 1)); } -void MyMesh::onSendTimeout() -{ -} +void MyMesh::onSendTimeout() {} MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) - : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), _serial(NULL), - telemetry(MAX_PACKET_PAYLOAD - 4) + : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), + _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { _iter_started = false; offline_queue_len = 0; @@ -764,8 +778,7 @@ void MyMesh::loadPrefsInt(const char *filename) #else File file = _fs->open(filename); #endif - if (file) - { + if (file) { uint8_t pad[8]; file.read((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 @@ -828,36 +841,30 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) #endif // load persisted prefs - if (_fs->exists("/new_prefs")) - { + if (_fs->exists("/new_prefs")) { loadPrefsInt("/new_prefs"); // new filename } - else if (_fs->exists("/node_prefs")) - { + else if (_fs->exists("/node_prefs")) { loadPrefsInt("/node_prefs"); savePrefs(); // save to new filename _fs->remove("/node_prefs"); // remove old } #ifdef BLE_PIN_CODE - if (_prefs.ble_pin == 0) - { + if (_prefs.ble_pin == 0) { #ifdef DISPLAY_CLASS - if (has_display) - { + if (has_display) { StdRNG rng; _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session } - else - { + else { _active_ble_pin = BLE_PIN_CODE; // otherwise static pin } #else _active_ble_pin = BLE_PIN_CODE; // otherwise static pin #endif } - else - { + else { _active_ble_pin = _prefs.ble_pin; } #else @@ -875,12 +882,18 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) radio_set_tx_power(_prefs.tx_power_dbm); } -const char *MyMesh::getNodeName() { return _prefs.node_name; } +const char *MyMesh::getNodeName() +{ + return _prefs.node_name; +} NodePrefs *MyMesh::getNodePrefs() { return &_prefs; } -uint32_t MyMesh::getBLEPin() { return _active_ble_pin; } +uint32_t MyMesh::getBLEPin() +{ + return _active_ble_pin; +} void MyMesh::startInterface(BaseSerialInterface &serial) { @@ -898,8 +911,7 @@ void MyMesh::savePrefs() #else File file = _fs->open("/new_prefs", "w", true); #endif - if (file) - { + if (file) { uint8_t pad[8]; memset(pad, 0, sizeof(pad)); @@ -928,9 +940,8 @@ void MyMesh::savePrefs() void MyMesh::handleCmdFrame(size_t len) { - if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) - { // sent when app establishes connection - app_target_ver = cmd_frame[1]; // which version of protocol does app understand + if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection + app_target_ver = cmd_frame[1]; // which version of protocol does app understand int i = 0; out_frame[i++] = RESP_CODE_DEVICE_INFO; @@ -948,8 +959,8 @@ void MyMesh::handleCmdFrame(size_t len) i += 20; _serial->writeFrame(out_frame, i); } - else if (cmd_frame[0] == CMD_APP_START && len >= 8) - { // sent when app establishes connection, respond with node ID + else if (cmd_frame[0] == CMD_APP_START && + len >= 8) { // sent when app establishes connection, respond with node ID // cmd_frame[1..7] reserved future char *app_name = (char *)&cmd_frame[8]; cmd_frame[len] = 0; // make app_name null terminated @@ -971,9 +982,10 @@ void MyMesh::handleCmdFrame(size_t len) i += 4; memcpy(&out_frame[i], &lon, 4); i += 4; - out_frame[i++] = 0; // reserved - out_frame[i++] = 0; // reserved - out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | (_prefs.telemetry_mode_base); // v5+ + out_frame[i++] = 0; // reserved + out_frame[i++] = 0; // reserved + out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | + (_prefs.telemetry_mode_base); // v5+ out_frame[i++] = _prefs.manual_add_contacts; uint32_t freq = _prefs.freq * 1000; @@ -990,8 +1002,7 @@ void MyMesh::handleCmdFrame(size_t len) i += tlen; _serial->writeFrame(out_frame, i); } - else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) - { + else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { int i = 1; uint8_t txt_type = cmd_frame[i++]; uint8_t attempt = cmd_frame[i++]; @@ -1001,32 +1012,26 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t *pub_key_prefix = &cmd_frame[i]; i += 6; ContactInfo *recipient = lookupContactByPubKey(pub_key_prefix, 6); - if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) - { + if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) { char *text = (char *)&cmd_frame[i]; int tlen = len - i; uint32_t est_timeout; text[tlen] = 0; // ensure null int result; uint32_t expected_ack; - if (txt_type == TXT_TYPE_CLI_DATA) - { + if (txt_type == TXT_TYPE_CLI_DATA) { result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); expected_ack = 0; // no Ack expected } - else - { + else { result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); } // TODO: add expected ACK to table - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { - if (expected_ack) - { + else { + if (expected_ack) { expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table expected_ack_table[next_ack_idx].ack = expected_ack; next_ack_idx = (next_ack_idx + 1) % EXPECTED_ACK_TABLE_SIZE; @@ -1039,13 +1044,13 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { - writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* + else { + writeErrFrame(recipient == NULL + ? ERR_CODE_NOT_FOUND + : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* } } - else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) - { // send GroupChannel msg + else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg int i = 1; uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN uint8_t channel_idx = cmd_frame[i++]; @@ -1054,38 +1059,29 @@ void MyMesh::handleCmdFrame(size_t len) i += 4; const char *text = (char *)&cmd_frame[i]; - if (txt_type != TXT_TYPE_PLAIN) - { + if (txt_type != TXT_TYPE_PLAIN) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); } - else - { + else { ChannelDetails channel; bool success = getChannel(channel_idx, channel); - if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) - { + if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } } - else if (cmd_frame[0] == CMD_GET_CONTACTS) - { // get Contact list - if (_iter_started) - { + else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list + if (_iter_started) { writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy } - else - { - if (len >= 5) - { // has optional 'since' param + else { + if (len >= 5) { // has optional 'since' param memcpy(&_iter_filter_since, &cmd_frame[1], 4); } - else - { + else { _iter_filter_since = 0; } @@ -1101,8 +1097,7 @@ void MyMesh::handleCmdFrame(size_t len) _most_recent_lastmod = 0; } } - else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) - { + else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { int nlen = len - 1; if (nlen > sizeof(_prefs.node_name) - 1) nlen = sizeof(_prefs.node_name) - 1; // max len @@ -1111,169 +1106,134 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) - { + else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { int32_t lat, lon, alt = 0; memcpy(&lat, &cmd_frame[1], 4); memcpy(&lon, &cmd_frame[5], 4); - if (len >= 13) - { + if (len >= 13) { memcpy(&alt, &cmd_frame[9], 4); // for FUTURE support } - if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) - { + if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) { sensors.node_lat = ((double)lat) / 1000000.0; sensors.node_lon = ((double)lon) / 1000000.0; savePrefs(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate } } - else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) - { + else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { uint8_t reply[5]; reply[0] = RESP_CODE_CURR_TIME; uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply[1], &now, 4); _serial->writeFrame(reply, 5); } - else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) - { + else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { uint32_t secs; memcpy(&secs, &cmd_frame[1], 4); uint32_t curr = getRTCClock()->getCurrentTime(); - if (secs >= curr) - { + if (secs >= curr) { getRTCClock()->setCurrentTime(secs); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) - { + else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { - if (len >= 2 && cmd_frame[1] == 1) - { // optional param (1 = flood, 0 = zero hop) + if (pkt) { + if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop) sendFlood(pkt); } - else - { + else { sendZeroHop(pkt); } writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) - { + else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { recipient->out_path_len = -1; // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact } } - else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) - { + else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { updateContactFromFrame(*recipient, cmd_frame, len); // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { ContactInfo contact; updateContactFromFrame(contact, cmd_frame, len); contact.lastmod = getRTCClock()->getCurrentTime(); contact.sync_since = 0; - if (addContact(contact)) - { + if (addContact(contact)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } } - else if (cmd_frame[0] == CMD_REMOVE_CONTACT) - { + else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient && removeContact(*recipient)) - { + if (recipient && removeContact(*recipient)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove } } - else if (cmd_frame[0] == CMD_SHARE_CONTACT) - { + else if (cmd_frame[0] == CMD_SHARE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { - if (shareContactZeroHop(*recipient)) - { + if (recipient) { + if (shareContactZeroHop(*recipient)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) - { + else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (contact) - { + if (contact) { writeContactRespFrame(RESP_CODE_CONTACT, *contact); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } - else if (cmd_frame[0] == CMD_EXPORT_CONTACT) - { - if (len < 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { + if (len < 1 + PUB_KEY_SIZE) { // export SELF auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { + if (pkt) { pkt->header |= ROUTE_TYPE_FLOOD; // would normally be sent in this mode out_frame[0] = RESP_CODE_EXPORT_CONTACT; @@ -1281,56 +1241,45 @@ void MyMesh::handleCmdFrame(size_t len) releasePacket(pkt); // undo the obtainNewPacket() _serial->writeFrame(out_frame, out_len + 1); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); // Error } } - else - { + else { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); uint8_t out_len; - if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) - { + if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) { out_frame[0] = RESP_CODE_EXPORT_CONTACT; _serial->writeFrame(out_frame, out_len + 1); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } } - else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) - { - if (importContact(&cmd_frame[1], len - 1)) - { + else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { + if (importContact(&cmd_frame[1], len - 1)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) - { + else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { int out_len; - if ((out_len = getFromOfflineQueue(out_frame)) > 0) - { + if ((out_len = getFromOfflineQueue(out_frame)) > 0) { _serial->writeFrame(out_frame, out_len); #ifdef DISPLAY_CLASS ui_task.msgRead(offline_queue_len); #endif } - else - { + else { out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; _serial->writeFrame(out_frame, 1); } } - else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { int i = 1; uint32_t freq; memcpy(&freq, &cmd_frame[i], 4); @@ -1341,8 +1290,8 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t sf = cmd_frame[i++]; uint8_t cr = cmd_frame[i++]; - if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && bw <= 500000) - { + if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && + bw <= 500000) { _prefs.sf = sf; _prefs.cr = cr; _prefs.freq = (float)freq / 1000.0; @@ -1350,32 +1299,29 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); - MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, + (uint32_t)cr); writeOKFrame(); } - else - { - MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + else { + MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, + (uint32_t)cr); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) - { - if (cmd_frame[1] > MAX_LORA_TX_POWER) - { + else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { + if (cmd_frame[1] > MAX_LORA_TX_POWER) { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - else - { + else { _prefs.tx_power_dbm = cmd_frame[1]; savePrefs(); radio_set_tx_power(_prefs.tx_power_dbm); writeOKFrame(); } } - else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { int i = 1; uint32_t rx, af; memcpy(&rx, &cmd_frame[i], 4); @@ -1387,11 +1333,9 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { _prefs.manual_add_contacts = cmd_frame[1]; - if (len >= 3) - { + if (len >= 3) { _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ _prefs.telemetry_mode_loc = (cmd_frame[2] >> 2) & 0x03; _prefs.telemetry_mode_env = (cmd_frame[2] >> 4) & 0x03; @@ -1399,24 +1343,20 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) - { - if (dirty_contacts_expiry) - { // is there are pending dirty contacts write needed? + else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { + if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed? saveContacts(); } board.reboot(); } - else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) - { + else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { uint8_t reply[3]; reply[0] = RESP_CODE_BATTERY_VOLTAGE; uint16_t battery_millivolts = board.getBattMilliVolts(); memcpy(&reply[1], &battery_millivolts, 2); _serial->writeFrame(reply, 3); } - else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) - { + else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { #if ENABLE_PRIVATE_KEY_EXPORT uint8_t reply[65]; reply[0] = RESP_CODE_PRIVATE_KEY; @@ -1426,64 +1366,52 @@ void MyMesh::handleCmdFrame(size_t len) writeDisabledFrame(); #endif } - else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) - { + else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { #if ENABLE_PRIVATE_KEY_IMPORT mesh::LocalIdentity identity; identity.readFrom(&cmd_frame[1], 64); - if (saveMainIdentity(identity)) - { + if (saveMainIdentity(identity)) { self_id = identity; writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_FILE_IO_ERROR); } #else writeDisabledFrame(); #endif } - else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) - { + else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { int i = 1; int8_t path_len = cmd_frame[i++]; - if (path_len >= 0 && i + path_len + 4 <= len) - { // minimum 4 byte payload + if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload uint8_t *path = &cmd_frame[i]; i += path_len; auto pkt = createRawData(&cmd_frame[i], len - i); - if (pkt) - { + if (pkt) { sendDirect(pkt, path, path_len); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else - { + else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) } } - else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE]; cmd_frame[len] = 0; // ensure null terminator in password - if (recipient) - { + if (recipient) { uint32_t est_timeout; int result = sendLogin(*recipient, password, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_telemetry = pending_status = 0; memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1493,25 +1421,20 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { uint32_t tag, est_timeout; int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_telemetry = pending_login = 0; // FUTURE: pending_status = tag; // match this in onContactResponse() memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme @@ -1522,25 +1445,20 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[4]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { uint32_t tag, est_timeout; int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_status = pending_login = 0; pending_telemetry = tag; // match this in onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1550,35 +1468,28 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; - if (hasConnectionTo(pub_key)) - { + if (hasConnectionTo(pub_key)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; stopConnection(pub_key); writeOKFrame(); } - else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) - { + else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; - if (getChannel(channel_idx, channel)) - { + if (getChannel(channel_idx, channel)) { int i = 0; out_frame[i++] = RESP_CODE_CHANNEL_INFO; out_frame[i++] = channel_idx; @@ -1588,64 +1499,52 @@ void MyMesh::handleCmdFrame(size_t len) i += 16; // NOTE: only 128-bit supported _serial->writeFrame(out_frame, i); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) - { + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) - { + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32); memset(channel.channel.secret, 0, sizeof(channel.channel.secret)); memcpy(channel.channel.secret, &cmd_frame[2 + 32], 16); // NOTE: only 128-bit supported - if (setChannel(channel_idx, channel)) - { + if (setChannel(channel_idx, channel)) { saveChannels(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } - else if (cmd_frame[0] == CMD_SIGN_START) - { + else if (cmd_frame[0] == CMD_SIGN_START) { out_frame[0] = RESP_CODE_SIGN_START; out_frame[1] = 0; // reserved uint32_t len = MAX_SIGN_DATA_LEN; memcpy(&out_frame[2], &len, 4); _serial->writeFrame(out_frame, 6); - if (sign_data) - { + if (sign_data) { free(sign_data); } sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN); sign_data_len = 0; } - else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) - { - if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) - { + else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { + if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) { writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long } - else - { + else { memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); sign_data_len += (len - 1); writeOKFrame(); } } - else if (cmd_frame[0] == CMD_SIGN_FINISH) - { - if (sign_data) - { + else if (cmd_frame[0] == CMD_SIGN_FINISH) { + if (sign_data) { self_id.sign(&out_frame[1], sign_data, sign_data_len); free(sign_data); // don't need sign_data now @@ -1654,19 +1553,16 @@ void MyMesh::handleCmdFrame(size_t len) out_frame[0] = RESP_CODE_SIGNATURE; _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); } - else - { + else { writeErrFrame(ERR_CODE_BAD_STATE); } } - else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { uint32_t tag, auth; memcpy(&tag, &cmd_frame[1], 4); memcpy(&auth, &cmd_frame[5], 4); auto pkt = createTrace(tag, auth, cmd_frame[9]); - if (pkt) - { + if (pkt) { uint8_t path_len = len - 10; sendDirect(pkt, &cmd_frame[10], path_len); @@ -1679,38 +1575,31 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) - { + else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { // get pin from command frame uint32_t pin; memcpy(&pin, &cmd_frame[1], 4); // ensure pin is zero, or a valid 6 digit pin - if (pin == 0 || (pin >= 100000 && pin <= 999999)) - { + if (pin == 0 || (pin >= 100000 && pin <= 999999)) { _prefs.ble_pin = pin; savePrefs(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) - { + else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { out_frame[0] = RESP_CODE_CUSTOM_VARS; char *dp = (char *)&out_frame[1]; - for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) - { - if (i > 0) - { + for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) { + if (i > 0) { *dp++ = ','; } strcpy(dp, sensors.getSettingName(i)); @@ -1721,31 +1610,25 @@ void MyMesh::handleCmdFrame(size_t len) } _serial->writeFrame(out_frame, dp - (char *)out_frame); } - else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) - { + else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { cmd_frame[len] = 0; char *sp = (char *)&cmd_frame[1]; char *np = strchr(sp, ':'); // look for separator char - if (np) - { + if (np) { *np++ = 0; // modify 'cmd_frame', replace ':' with null bool success = sensors.setSettingValue(sp, np); - if (success) - { + if (success) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else - { + else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); } @@ -1756,42 +1639,35 @@ void MyMesh::loop() BaseChatMesh::loop(); size_t len = _serial->checkRecvFrame(cmd_frame); - if (len > 0) - { + if (len > 0) { handleCmdFrame(len); } else if (_iter_started // check if our ContactsIterator is 'running' && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! - ) - { + ) { ContactInfo contact; - if (_iter.hasNext(this, contact)) - { - if (contact.lastmod > _iter_filter_since) - { // apply the 'since' filter + if (_iter.hasNext(this, contact)) { + if (contact.lastmod > _iter_filter_since) { // apply the 'since' filter writeContactRespFrame(RESP_CODE_CONTACT, contact); - if (contact.lastmod > _most_recent_lastmod) - { + if (contact.lastmod > _most_recent_lastmod) { _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame } } } - else - { // EOF + else { // EOF out_frame[0] = RESP_CODE_END_OF_CONTACTS; - memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' + memcpy(&out_frame[1], &_most_recent_lastmod, + 4); // include the most recent lastmod, so app can update their 'since' _serial->writeFrame(out_frame, 5); _iter_started = false; } } - else if (!_serial->isWriteBusy()) - { + else if (!_serial->isWriteBusy()) { checkConnections(); } // is there are pending dirty contacts write needed? - if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) - { + if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) { saveContacts(); dirty_contacts_expiry = 0; } @@ -1805,14 +1681,12 @@ void MyMesh::loop() bool MyMesh::advert() { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { + if (pkt) { sendZeroHop(pkt); writeOKFrame(); return true; } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); return false; } diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index a4794f1f..574b9878 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -1,21 +1,20 @@ -#ifndef MYMESH_H -#define MYMESH_H +#pragma once #include #include #ifdef DISPLAY_CLASS - #include "UITask.h" +#include "UITask.h" #endif /*------------ Frame Protocol --------------*/ -#define FIRMWARE_VER_CODE 5 +#define FIRMWARE_VER_CODE 5 #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "24 May 2025" +#define FIRMWARE_BUILD_DATE "24 May 2025" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.6.2" +#define FIRMWARE_VERSION "v1.6.2" #endif #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) @@ -26,258 +25,197 @@ #include #endif -#include -#include -#include -#include -#include #include "NodePrefs.h" + #include +#include +#include +#include +#include +#include #include /* ---------------------------------- CONFIGURATION ------------------------------------- */ #ifndef LORA_FREQ - #define LORA_FREQ 915.0 +#define LORA_FREQ 915.0 #endif #ifndef LORA_BW - #define LORA_BW 250 +#define LORA_BW 250 #endif #ifndef LORA_SF - #define LORA_SF 10 +#define LORA_SF 10 #endif #ifndef LORA_CR - #define LORA_CR 5 +#define LORA_CR 5 #endif #ifndef LORA_TX_POWER - #define LORA_TX_POWER 20 +#define LORA_TX_POWER 20 #endif #ifndef MAX_LORA_TX_POWER - #define MAX_LORA_TX_POWER LORA_TX_POWER +#define MAX_LORA_TX_POWER LORA_TX_POWER #endif #ifndef MAX_CONTACTS - #define MAX_CONTACTS 100 +#define MAX_CONTACTS 100 #endif #ifndef OFFLINE_QUEUE_SIZE - #define OFFLINE_QUEUE_SIZE 16 +#define OFFLINE_QUEUE_SIZE 16 #endif #ifndef BLE_NAME_PREFIX - #define BLE_NAME_PREFIX "MeshCore-" +#define BLE_NAME_PREFIX "MeshCore-" #endif #include -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define LAZY_CONTACTS_WRITE_DELAY 5000 +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define LAZY_CONTACTS_WRITE_DELAY 5000 -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" - -#define CMD_APP_START 1 -#define CMD_SEND_TXT_MSG 2 -#define CMD_SEND_CHANNEL_TXT_MSG 3 -#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) -#define CMD_GET_DEVICE_TIME 5 -#define CMD_SET_DEVICE_TIME 6 -#define CMD_SEND_SELF_ADVERT 7 -#define CMD_SET_ADVERT_NAME 8 -#define CMD_ADD_UPDATE_CONTACT 9 -#define CMD_SYNC_NEXT_MESSAGE 10 -#define CMD_SET_RADIO_PARAMS 11 -#define CMD_SET_RADIO_TX_POWER 12 -#define CMD_RESET_PATH 13 -#define CMD_SET_ADVERT_LATLON 14 -#define CMD_REMOVE_CONTACT 15 -#define CMD_SHARE_CONTACT 16 -#define CMD_EXPORT_CONTACT 17 -#define CMD_IMPORT_CONTACT 18 -#define CMD_REBOOT 19 -#define CMD_GET_BATTERY_VOLTAGE 20 -#define CMD_SET_TUNING_PARAMS 21 -#define CMD_DEVICE_QEURY 22 -#define CMD_EXPORT_PRIVATE_KEY 23 -#define CMD_IMPORT_PRIVATE_KEY 24 -#define CMD_SEND_RAW_DATA 25 -#define CMD_SEND_LOGIN 26 -#define CMD_SEND_STATUS_REQ 27 -#define CMD_HAS_CONNECTION 28 -#define CMD_LOGOUT 29 // 'Disconnect' -#define CMD_GET_CONTACT_BY_KEY 30 -#define CMD_GET_CHANNEL 31 -#define CMD_SET_CHANNEL 32 -#define CMD_SIGN_START 33 -#define CMD_SIGN_DATA 34 -#define CMD_SIGN_FINISH 35 -#define CMD_SEND_TRACE_PATH 36 -#define CMD_SET_DEVICE_PIN 37 -#define CMD_SET_OTHER_PARAMS 38 -#define CMD_SEND_TELEMETRY_REQ 39 -#define CMD_GET_CUSTOM_VARS 40 -#define CMD_SET_CUSTOM_VAR 41 - -#define RESP_CODE_OK 0 -#define RESP_CODE_ERR 1 -#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS -#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) -#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS -#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START -#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG -#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME -#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE -#define RESP_CODE_EXPORT_CONTACT 11 -#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE -#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY -#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY -#define RESP_CODE_DISABLED 15 -#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL -#define RESP_CODE_SIGN_START 19 -#define RESP_CODE_SIGNATURE 20 -#define RESP_CODE_CUSTOM_VARS 21 +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" // these are _pushed_ to client app at any time -#define PUSH_CODE_ADVERT 0x80 -#define PUSH_CODE_PATH_UPDATED 0x81 -#define PUSH_CODE_SEND_CONFIRMED 0x82 -#define PUSH_CODE_MSG_WAITING 0x83 -#define PUSH_CODE_RAW_DATA 0x84 -#define PUSH_CODE_LOGIN_SUCCESS 0x85 -#define PUSH_CODE_LOGIN_FAIL 0x86 -#define PUSH_CODE_STATUS_RESPONSE 0x87 -#define PUSH_CODE_LOG_RX_DATA 0x88 -#define PUSH_CODE_TRACE_DATA 0x89 -#define PUSH_CODE_NEW_ADVERT 0x8A -#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B +#define PUSH_CODE_ADVERT 0x80 +#define PUSH_CODE_PATH_UPDATED 0x81 +#define PUSH_CODE_SEND_CONFIRMED 0x82 +#define PUSH_CODE_MSG_WAITING 0x83 +#define PUSH_CODE_RAW_DATA 0x84 +#define PUSH_CODE_LOGIN_SUCCESS 0x85 +#define PUSH_CODE_LOGIN_FAIL 0x86 +#define PUSH_CODE_STATUS_RESPONSE 0x87 +#define PUSH_CODE_LOG_RX_DATA 0x88 +#define PUSH_CODE_TRACE_DATA 0x89 +#define PUSH_CODE_NEW_ADVERT 0x8A +#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B -#define ERR_CODE_UNSUPPORTED_CMD 1 -#define ERR_CODE_NOT_FOUND 2 -#define ERR_CODE_TABLE_FULL 3 -#define ERR_CODE_BAD_STATE 4 -#define ERR_CODE_FILE_IO_ERROR 5 -#define ERR_CODE_ILLEGAL_ARG 6 +#define ERR_CODE_UNSUPPORTED_CMD 1 +#define ERR_CODE_NOT_FOUND 2 +#define ERR_CODE_TABLE_FULL 3 +#define ERR_CODE_BAD_STATE 4 +#define ERR_CODE_FILE_IO_ERROR 5 +#define ERR_CODE_ILLEGAL_ARG 6 /* -------------------------------------------------------------------------------------- */ -#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS -#define REQ_TYPE_KEEP_ALIVE 0x02 -#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 +#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS +#define REQ_TYPE_KEEP_ALIVE 0x02 +#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 -#define MAX_SIGN_DATA_LEN (8*1024) // 8K +#define MAX_SIGN_DATA_LEN (8 * 1024) // 8K class MyMesh : public BaseChatMesh { public: - MyMesh(mesh::Radio& radio, mesh::RNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables); - - void begin(FILESYSTEM& fs, bool has_display); - void startInterface(BaseSerialInterface& serial); - void loadPrefsInt(const char* filename); - void savePrefs(); - - const char* getNodeName(); - NodePrefs* getNodePrefs(); - uint32_t getBLEPin(); + MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables); - void loop(); - void handleCmdFrame(size_t len); - bool advert(); + void begin(FILESYSTEM &fs, bool has_display); + void startInterface(BaseSerialInterface &serial); + void loadPrefsInt(const char *filename); + void savePrefs(); + + const char *getNodeName(); + NodePrefs *getNodePrefs(); + uint32_t getBLEPin(); + + void loop(); + void handleCmdFrame(size_t len); + bool advert(); protected: - float getAirtimeBudgetFactor() const override; - int getInterferenceThreshold() const override; - int calcRxDelay(float score, uint32_t air_time) const override; + float getAirtimeBudgetFactor() const override; + int getInterferenceThreshold() const override; + int calcRxDelay(float score, uint32_t air_time) const override; - void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; - bool isAutoAddEnabled() const override; - void onDiscoveredContact(ContactInfo& contact, bool is_new) override; - void onContactPathUpdated(const ContactInfo& contact) override; - bool processAck(const uint8_t *data) override; - void queueMessage(const ContactInfo& from, uint8_t txt_type, mesh::Packet* pkt, - uint32_t sender_timestamp, const uint8_t* extra, int extra_len, const char *text); + void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; + bool isAutoAddEnabled() const override; + void onDiscoveredContact(ContactInfo &contact, bool is_new) override; + void onContactPathUpdated(const ContactInfo &contact) override; + bool processAck(const uint8_t *data) override; + void queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *extra, int extra_len, const char *text); - void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; - void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; - void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, - const uint8_t *sender_prefix, const char *text) override; - void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override; + void onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override; + void onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override; + void onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) override; + void onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, + const char *text) override; - uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override; - void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override; - void onRawDataRecv(mesh::Packet* packet) override; - void onTraceRecv(mesh::Packet* packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t* path_snrs, - const uint8_t* path_hashes, uint8_t path_len) override; + uint8_t onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, + uint8_t len, uint8_t *reply) override; + void onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) override; + void onRawDataRecv(mesh::Packet *packet) override; + void onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) override; - uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override; - uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; - void onSendTimeout() override; + uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override; + uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; + void onSendTimeout() override; private: - void writeOKFrame(); - void writeErrFrame(uint8_t err_code); - void writeDisabledFrame(); - void writeContactRespFrame(uint8_t code, const ContactInfo& contact); - void updateContactFromFrame(ContactInfo& contact, const uint8_t* frame, int len); - void addToOfflineQueue(const uint8_t frame[], int len); - int getFromOfflineQueue(uint8_t frame[]); - void loadMainIdentity(); - bool saveMainIdentity(const mesh::LocalIdentity& identity); - void loadContacts(); - void saveContacts(); - void loadChannels(); - void saveChannels(); - int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; - bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; + void writeOKFrame(); + void writeErrFrame(uint8_t err_code); + void writeDisabledFrame(); + void writeContactRespFrame(uint8_t code, const ContactInfo &contact); + void updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len); + void addToOfflineQueue(const uint8_t frame[], int len); + int getFromOfflineQueue(uint8_t frame[]); + void loadMainIdentity(); + bool saveMainIdentity(const mesh::LocalIdentity &identity); + void loadContacts(); + void saveContacts(); + void loadChannels(); + void saveChannels(); + int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; private: - FILESYSTEM* _fs; - IdentityStore* _identity_store; - NodePrefs _prefs; - uint32_t pending_login; - uint32_t pending_status; - uint32_t pending_telemetry; - BaseSerialInterface* _serial; + FILESYSTEM *_fs; + IdentityStore *_identity_store; + NodePrefs _prefs; + uint32_t pending_login; + uint32_t pending_status; + uint32_t pending_telemetry; + BaseSerialInterface *_serial; - ContactsIterator _iter; - uint32_t _iter_filter_since; - uint32_t _most_recent_lastmod; - uint32_t _active_ble_pin; - bool _iter_started; - uint8_t app_target_ver; - uint8_t* sign_data; - uint32_t sign_data_len; - unsigned long dirty_contacts_expiry; + ContactsIterator _iter; + uint32_t _iter_filter_since; + uint32_t _most_recent_lastmod; + uint32_t _active_ble_pin; + bool _iter_started; + uint8_t app_target_ver; + uint8_t *sign_data; + uint32_t sign_data_len; + unsigned long dirty_contacts_expiry; - uint8_t cmd_frame[MAX_FRAME_SIZE + 1]; - uint8_t out_frame[MAX_FRAME_SIZE + 1]; - CayenneLPP telemetry; + uint8_t cmd_frame[MAX_FRAME_SIZE + 1]; + uint8_t out_frame[MAX_FRAME_SIZE + 1]; + CayenneLPP telemetry; - struct Frame { - uint8_t len; - uint8_t buf[MAX_FRAME_SIZE]; - }; - int offline_queue_len; - Frame offline_queue[OFFLINE_QUEUE_SIZE]; + struct Frame { + uint8_t len; + uint8_t buf[MAX_FRAME_SIZE]; + }; + int offline_queue_len; + Frame offline_queue[OFFLINE_QUEUE_SIZE]; - struct AckTableEntry { - unsigned long msg_sent; - uint32_t ack; - }; - #define EXPECTED_ACK_TABLE_SIZE 8 - AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table - int next_ack_idx; + struct AckTableEntry { + unsigned long msg_sent; + uint32_t ack; + }; +#define EXPECTED_ACK_TABLE_SIZE 8 + AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table + int next_ack_idx; }; extern StdRNG fast_rng; extern SimpleMeshTables tables; extern MyMesh the_mesh; #ifdef DISPLAY_CLASS - extern UITask ui_task; -#endif -#endif // MYMESH_H \ No newline at end of file +extern UITask ui_task; +#endif \ No newline at end of file diff --git a/examples/companion_radio/NodePrefs.h b/examples/companion_radio/NodePrefs.h index 09d04266..44d7ecbf 100644 --- a/examples/companion_radio/NodePrefs.h +++ b/examples/companion_radio/NodePrefs.h @@ -1,13 +1,11 @@ -#ifndef NODE_PREFS_H -#define NODE_PREFS_H - +#pragma once #include // For uint8_t, uint32_t -#define TELEM_MODE_DENY 0 -#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags -#define TELEM_MODE_ALLOW_ALL 2 +#define TELEM_MODE_DENY 0 +#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags +#define TELEM_MODE_ALLOW_ALL 2 -struct NodePrefs { // persisted to file +struct NodePrefs { // persisted to file float airtime_factor; char node_name[32]; float freq; @@ -22,6 +20,4 @@ struct NodePrefs { // persisted to file uint8_t telemetry_mode_env; float rx_delay_base; uint32_t ble_pin; -}; - -#endif // NODE_PREFS_H \ No newline at end of file +}; \ No newline at end of file diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index 6d7e1eb3..f52c0961 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -1,53 +1,43 @@ -#ifndef UI_TASK_H -#define UI_TASK_H - +#pragma once #include #include #include #ifdef PIN_BUZZER - #include +#include #endif -#include "NodePrefs.h" #include "Button.h" +#include "NodePrefs.h" - enum class UIEventType -{ - none, - contactMessage, - channelMessage, - roomMessage, - newContactMessage, - ack -}; +enum class UIEventType { none, contactMessage, channelMessage, roomMessage, newContactMessage, ack }; class UITask { - DisplayDriver* _display; - mesh::MainBoard* _board; + DisplayDriver *_display; + mesh::MainBoard *_board; #ifdef PIN_BUZZER genericBuzzer buzzer; #endif unsigned long _next_refresh, _auto_off; bool _connected; uint32_t _pin_code; - NodePrefs* _node_prefs; + NodePrefs *_node_prefs; char _version_info[32]; char _origin[62]; char _msg[80]; int _msgcount; bool _need_refresh = true; - bool _displayWasOn = false; // Track display state before button press + bool _displayWasOn = false; // Track display state before button press // Button handlers #if defined(PIN_USER_BTN) || defined(PIN_USER_BTN_ANA) - Button* _userButton = nullptr; + Button *_userButton = nullptr; #endif void renderCurrScreen(); void userLedHandler(); void renderBatteryIndicator(uint16_t batteryMilliVolts); - + // Button action handlers void handleButtonAnyPress(); void handleButtonShortPress(); @@ -55,22 +45,21 @@ class UITask { void handleButtonTriplePress(); void handleButtonLongPress(); - public: - - UITask(mesh::MainBoard* board) : _board(board), _display(NULL) { - _next_refresh = 0; - _connected = false; + UITask(mesh::MainBoard *board) : _board(board), _display(NULL) + { + _next_refresh = 0; + _connected = false; } - void begin(DisplayDriver* display, NodePrefs* node_prefs, const char* build_date, const char* firmware_version, uint32_t pin_code); + void begin(DisplayDriver *display, NodePrefs *node_prefs, const char *build_date, + const char *firmware_version, uint32_t pin_code); void setHasConnection(bool connected) { _connected = connected; } bool hasDisplay() const { return _display != NULL; } void clearMsgPreview(); void msgRead(int msgcount); - void newMsg(uint8_t path_len, const char* from_name, const char* text, int msgcount); + void newMsg(uint8_t path_len, const char *from_name, const char *text, int msgcount); void soundBuzzer(UIEventType bet = UIEventType::none); void shutdown(bool restart = false); void loop(); -}; -#endif //UI_TASK_H \ No newline at end of file +}; \ No newline at end of file diff --git a/examples/simple_secure_chat/main.cpp b/examples/simple_secure_chat/main.cpp index 63ff20da..2440b697 100644 --- a/examples/simple_secure_chat/main.cpp +++ b/examples/simple_secure_chat/main.cpp @@ -1,56 +1,57 @@ -#include // needed for PlatformIO +#include // needed for PlatformIO #include #if defined(NRF52_PLATFORM) - #include +#include #elif defined(RP2040_PLATFORM) - #include +#include #elif defined(ESP32) - #include +#include #endif -#include -#include -#include -#include #include +#include +#include +#include +#include #include /* ---------------------------------- CONFIGURATION ------------------------------------- */ -#define FIRMWARE_VER_TEXT "v2 (build: 4 Feb 2025)" +#define FIRMWARE_VER_TEXT "v2 (build: 4 Feb 2025)" #ifndef LORA_FREQ - #define LORA_FREQ 915.0 +#define LORA_FREQ 915.0 #endif #ifndef LORA_BW - #define LORA_BW 250 +#define LORA_BW 250 #endif #ifndef LORA_SF - #define LORA_SF 10 +#define LORA_SF 10 #endif #ifndef LORA_CR - #define LORA_CR 5 +#define LORA_CR 5 #endif #ifndef LORA_TX_POWER - #define LORA_TX_POWER 20 +#define LORA_TX_POWER 20 #endif #ifndef MAX_CONTACTS - #define MAX_CONTACTS 100 +#define MAX_CONTACTS 100 #endif #include -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" // Believe it or not, this std C function is busted on some platforms! -static uint32_t _atoi(const char* sp) { +static uint32_t _atoi(const char *sp) +{ uint32_t n = 0; while (*sp && *sp >= '0' && *sp <= '9') { n *= 10; @@ -61,7 +62,7 @@ static uint32_t _atoi(const char* sp) { /* -------------------------------------------------------------------------------------- */ -struct NodePrefs { // persisted to file +struct NodePrefs { // persisted to file float airtime_factor; char node_name[32]; double node_lat, node_lon; @@ -71,30 +72,35 @@ struct NodePrefs { // persisted to file }; class MyMesh : public BaseChatMesh, ContactVisitor { - FILESYSTEM* _fs; + FILESYSTEM *_fs; NodePrefs _prefs; uint32_t expected_ack_crc; - ChannelDetails* _public; + ChannelDetails *_public; unsigned long last_msg_sent; - ContactInfo* curr_recipient; - char command[512+10]; + ContactInfo *curr_recipient; + char command[512 + 10]; uint8_t tmp_buf[256]; char hex_buf[512]; - const char* getTypeName(uint8_t type) const { - if (type == ADV_TYPE_CHAT) return "Chat"; - if (type == ADV_TYPE_REPEATER) return "Repeater"; - if (type == ADV_TYPE_ROOM) return "Room"; - return "??"; // unknown + const char *getTypeName(uint8_t type) const + { + if (type == ADV_TYPE_CHAT) + return "Chat"; + if (type == ADV_TYPE_REPEATER) + return "Repeater"; + if (type == ADV_TYPE_ROOM) + return "Room"; + return "??"; // unknown } - void loadContacts() { + void loadContacts() + { if (_fs->exists("/contacts")) { - #if defined(RP2040_PLATFORM) +#if defined(RP2040_PLATFORM) File file = _fs->open("/contacts", "r"); - #else +#else File file = _fs->open("/contacts"); - #endif +#endif if (file) { bool full = false; while (!full) { @@ -104,28 +110,31 @@ class MyMesh : public BaseChatMesh, ContactVisitor { uint32_t reserved; bool success = (file.read(pub_key, 32) == 32); - success = success && (file.read((uint8_t *) &c.name, 32) == 32); + success = success && (file.read((uint8_t *)&c.name, 32) == 32); success = success && (file.read(&c.type, 1) == 1); success = success && (file.read(&c.flags, 1) == 1); success = success && (file.read(&unused, 1) == 1); - success = success && (file.read((uint8_t *) &reserved, 4) == 4); - success = success && (file.read((uint8_t *) &c.out_path_len, 1) == 1); - success = success && (file.read((uint8_t *) &c.last_advert_timestamp, 4) == 4); + success = success && (file.read((uint8_t *)&reserved, 4) == 4); + success = success && (file.read((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.read((uint8_t *)&c.last_advert_timestamp, 4) == 4); success = success && (file.read(c.out_path, 64) == 64); - c.gps_lat = c.gps_lon = 0; // not yet supported + c.gps_lat = c.gps_lon = 0; // not yet supported - if (!success) break; // EOF + if (!success) + break; // EOF c.id = mesh::Identity(pub_key); c.lastmod = 0; - if (!addContact(c)) full = true; + if (!addContact(c)) + full = true; } file.close(); } } } - void saveContacts() { + void saveContacts() + { #if defined(NRF52_PLATFORM) _fs->remove("/contacts"); File file = _fs->open("/contacts", FILE_O_WRITE); @@ -142,44 +151,50 @@ class MyMesh : public BaseChatMesh, ContactVisitor { while (iter.hasNext(this, c)) { bool success = (file.write(c.id.pub_key, 32) == 32); - success = success && (file.write((uint8_t *) &c.name, 32) == 32); + success = success && (file.write((uint8_t *)&c.name, 32) == 32); success = success && (file.write(&c.type, 1) == 1); success = success && (file.write(&c.flags, 1) == 1); success = success && (file.write(&unused, 1) == 1); - success = success && (file.write((uint8_t *) &reserved, 4) == 4); - success = success && (file.write((uint8_t *) &c.out_path_len, 1) == 1); - success = success && (file.write((uint8_t *) &c.last_advert_timestamp, 4) == 4); + success = success && (file.write((uint8_t *)&reserved, 4) == 4); + success = success && (file.write((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.write((uint8_t *)&c.last_advert_timestamp, 4) == 4); success = success && (file.write(c.out_path, 64) == 64); - if (!success) break; // write failed + if (!success) + break; // write failed } file.close(); } } - void setClock(uint32_t timestamp) { + void setClock(uint32_t timestamp) + { uint32_t curr = getRTCClock()->getCurrentTime(); if (timestamp > curr) { getRTCClock()->setCurrentTime(timestamp); Serial.println(" (OK - clock set!)"); - } else { + } + else { Serial.println(" (ERR: clock cannot go backwards)"); } } - void importCard(const char* command) { - while (*command == ' ') command++; // skip leading spaces + void importCard(const char *command) + { + while (*command == ' ') + command++; // skip leading spaces if (memcmp(command, "meshcore://", 11) == 0) { - command += 11; // skip the prefix - char *ep = strchr(command, 0); // find end of string + command += 11; // skip the prefix + char *ep = strchr(command, 0); // find end of string while (ep > command) { ep--; - if (mesh::Utils::isHexChar(*ep)) break; // found tail end of card - *ep = 0; // remove trailing spaces and other junk + if (mesh::Utils::isHexChar(*ep)) + break; // found tail end of card + *ep = 0; // remove trailing spaces and other junk } int len = strlen(command); if (len % 2 == 0) { - len >>= 1; // halve, for num bytes + len >>= 1; // halve, for num bytes if (mesh::Utils::fromHex(tmp_buf, len, command)) { importContact(tmp_buf, len); return; @@ -190,97 +205,112 @@ class MyMesh : public BaseChatMesh, ContactVisitor { } protected: - float getAirtimeBudgetFactor() const override { - return _prefs.airtime_factor; + float getAirtimeBudgetFactor() const override { return _prefs.airtime_factor; } + + int calcRxDelay(float score, uint32_t air_time) const override + { + return 0; // disable rxdelay } - int calcRxDelay(float score, uint32_t air_time) const override { - return 0; // disable rxdelay - } + bool allowPacketForward(const mesh::Packet *packet) override { return true; } - bool allowPacketForward(const mesh::Packet* packet) override { - return true; - } - - void onDiscoveredContact(ContactInfo& contact, bool is_new) override { + void onDiscoveredContact(ContactInfo &contact, bool is_new) override + { // TODO: if not in favs, prompt to add as fav(?) Serial.printf("ADVERT from -> %s\n", contact.name); Serial.printf(" type: %s\n", getTypeName(contact.type)); - Serial.print(" public key: "); mesh::Utils::printHex(Serial, contact.id.pub_key, PUB_KEY_SIZE); Serial.println(); + Serial.print(" public key: "); + mesh::Utils::printHex(Serial, contact.id.pub_key, PUB_KEY_SIZE); + Serial.println(); saveContacts(); } - void onContactPathUpdated(const ContactInfo& contact) override { - Serial.printf("PATH to: %s, path_len=%d\n", contact.name, (int32_t) contact.out_path_len); + void onContactPathUpdated(const ContactInfo &contact) override + { + Serial.printf("PATH to: %s, path_len=%d\n", contact.name, (int32_t)contact.out_path_len); saveContacts(); } - bool processAck(const uint8_t *data) override { - if (memcmp(data, &expected_ack_crc, 4) == 0) { // got an ACK from recipient + bool processAck(const uint8_t *data) override + { + if (memcmp(data, &expected_ack_crc, 4) == 0) { // got an ACK from recipient Serial.printf(" Got ACK! (round trip: %d millis)\n", _ms->getMillis() - last_msg_sent); // NOTE: the same ACK can be received multiple times! - expected_ack_crc = 0; // reset our expected hash, now that we have received ACK + expected_ack_crc = 0; // reset our expected hash, now that we have received ACK return true; } - //uint32_t crc; - //memcpy(&crc, data, 4); - //MESH_DEBUG_PRINTLN("unknown ACK received: %08X (expected: %08X)", crc, expected_ack_crc); + // uint32_t crc; + // memcpy(&crc, data, 4); + // MESH_DEBUG_PRINTLN("unknown ACK received: %08X (expected: %08X)", crc, expected_ack_crc); return false; } - void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { + void onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override + { Serial.printf("(%s) MSG -> from %s\n", pkt->isRouteDirect() ? "DIRECT" : "FLOOD", from.name); Serial.printf(" %s\n", text); - if (strcmp(text, "clock sync") == 0) { // special text command + if (strcmp(text, "clock sync") == 0) { // special text command setClock(sender_timestamp + 1); } } - void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { + void onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override + { } - void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) override { + void onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) override + { } - void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override { + void onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, + const char *text) override + { if (pkt->isRouteDirect()) { Serial.printf("PUBLIC CHANNEL MSG -> (Direct!)\n"); - } else { + } + else { Serial.printf("PUBLIC CHANNEL MSG -> (Flood) hops %d\n", pkt->path_len); } Serial.printf(" %s\n", text); } - uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override { - return 0; // unknown + uint8_t onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, + uint8_t len, uint8_t *reply) override + { + return 0; // unknown } - void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override { + void onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) override + { // not supported } - uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override { + uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override + { return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); } - uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override { - return SEND_TIMEOUT_BASE_MILLIS + - ( (pkt_airtime_millis*DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); + uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override + { + return SEND_TIMEOUT_BASE_MILLIS + + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * + (path_len + 1)); } - void onSendTimeout() override { - Serial.println(" ERROR: timed out, no ACK."); - } + void onSendTimeout() override { Serial.println(" ERROR: timed out, no ACK."); } public: - MyMesh(mesh::Radio& radio, StdRNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables) - : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables) + MyMesh(mesh::Radio &radio, StdRNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) + : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables) { // defaults memset(&_prefs, 0, sizeof(_prefs)); - _prefs.airtime_factor = 2.0; // one third + _prefs.airtime_factor = 2.0; // one third strcpy(_prefs.node_name, "NONAME"); _prefs.freq = LORA_FREQ; _prefs.tx_power_dbm = LORA_TX_POWER; @@ -292,45 +322,49 @@ public: float getFreqPref() const { return _prefs.freq; } uint8_t getTxPowerPref() const { return _prefs.tx_power_dbm; } - void begin(FILESYSTEM& fs) { + void begin(FILESYSTEM &fs) + { _fs = &fs; BaseChatMesh::begin(); - #if defined(NRF52_PLATFORM) +#if defined(NRF52_PLATFORM) IdentityStore store(fs, ""); - #elif defined(RP2040_PLATFORM) +#elif defined(RP2040_PLATFORM) IdentityStore store(fs, "/identity"); store.begin(); - #else +#else IdentityStore store(fs, "/identity"); - #endif - if (!store.load("_main", self_id, _prefs.node_name, sizeof(_prefs.node_name))) { // legacy: node_name was from identity file +#endif + if (!store.load("_main", self_id, _prefs.node_name, + sizeof(_prefs.node_name))) { // legacy: node_name was from identity file // Need way to get some entropy to seed RNG Serial.println("Press ENTER to generate key:"); char c = 0; - while (c != '\n') { // wait for ENTER to be pressed - if (Serial.available()) c = Serial.read(); + while (c != '\n') { // wait for ENTER to be pressed + if (Serial.available()) + c = Serial.read(); } ((StdRNG *)getRNG())->begin(millis()); - self_id = mesh::LocalIdentity(getRNG()); // create new random identity + self_id = mesh::LocalIdentity(getRNG()); // create new random identity int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes - self_id = mesh::LocalIdentity(getRNG()); count++; + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes + self_id = mesh::LocalIdentity(getRNG()); + count++; } store.save("_main", self_id); } // load persisted prefs if (_fs->exists("/node_prefs")) { - #if defined(RP2040_PLATFORM) +#if defined(RP2040_PLATFORM) File file = _fs->open("/node_prefs", "r"); - #else +#else File file = _fs->open("/node_prefs"); - #endif +#endif if (file) { - file.read((uint8_t *) &_prefs, sizeof(_prefs)); + file.read((uint8_t *)&_prefs, sizeof(_prefs)); file.close(); } } @@ -339,7 +373,8 @@ public: _public = addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel } - void savePrefs() { + void savePrefs() + { #if defined(NRF52_PLATFORM) _fs->remove("/node_prefs"); File file = _fs->open("/node_prefs", FILE_O_WRITE); @@ -354,7 +389,8 @@ public: } } - void showWelcome() { + void showWelcome() + { Serial.println("===== MeshCore Chat Terminal ====="); Serial.println(); Serial.printf("WELCOME %s\n", _prefs.node_name); @@ -364,7 +400,8 @@ public: Serial.println(); } - void sendSelfAdvert(int delay_millis) { + void sendSelfAdvert(int delay_millis) + { auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { sendFlood(pkt, delay_millis); @@ -372,7 +409,8 @@ public: } // ContactVisitor - void onContactVisit(const ContactInfo& contact) override { + void onContactVisit(const ContactInfo &contact) override + { Serial.printf(" %s - ", contact.name); char tmp[40]; int32_t secs = contact.last_advert_timestamp - getRTCClock()->getCurrentTime(); @@ -380,129 +418,159 @@ public: Serial.println(tmp); } - void handleCommand(const char* command) { - while (*command == ' ') command++; // skip leading spaces + void handleCommand(const char *command) + { + while (*command == ' ') + command++; // skip leading spaces if (memcmp(command, "send ", 5) == 0) { if (curr_recipient) { const char *text = &command[5]; uint32_t est_timeout; - int result = sendMessage(*curr_recipient, getRTCClock()->getCurrentTime(), 0, text, expected_ack_crc, est_timeout); + int result = sendMessage(*curr_recipient, getRTCClock()->getCurrentTime(), 0, text, expected_ack_crc, + est_timeout); if (result == MSG_SEND_FAILED) { Serial.println(" ERROR: unable to send."); - } else { + } + else { last_msg_sent = _ms->getMillis(); Serial.printf(" (message sent - %s)\n", result == MSG_SEND_SENT_FLOOD ? "FLOOD" : "DIRECT"); } - } else { + } + else { Serial.println(" ERROR: no recipient selected (use 'to' cmd)."); } - } else if (memcmp(command, "public ", 7) == 0) { // send GroupChannel msg - uint8_t temp[5+MAX_TEXT_LEN+32]; + } + else if (memcmp(command, "public ", 7) == 0) { // send GroupChannel msg + uint8_t temp[5 + MAX_TEXT_LEN + 32]; uint32_t timestamp = getRTCClock()->getCurrentTime(); - memcpy(temp, ×tamp, 4); // mostly an extra blob to help make packet_hash unique - temp[4] = 0; // attempt and flags + memcpy(temp, ×tamp, 4); // mostly an extra blob to help make packet_hash unique + temp[4] = 0; // attempt and flags - sprintf((char *) &temp[5], "%s: %s", _prefs.node_name, &command[7]); // : - temp[5 + MAX_TEXT_LEN] = 0; // truncate if too long + sprintf((char *)&temp[5], "%s: %s", _prefs.node_name, &command[7]); // : + temp[5 + MAX_TEXT_LEN] = 0; // truncate if too long - int len = strlen((char *) &temp[5]); + int len = strlen((char *)&temp[5]); auto pkt = createGroupDatagram(PAYLOAD_TYPE_GRP_TXT, _public->channel, temp, 5 + len); if (pkt) { sendFlood(pkt); Serial.println(" Sent."); - } else { + } + else { Serial.println(" ERROR: unable to send"); } - } else if (memcmp(command, "list", 4) == 0) { // show Contact list, by most recent + } + else if (memcmp(command, "list", 4) == 0) { // show Contact list, by most recent int n = 0; - if (command[4] == ' ') { // optional param, last 'N' + if (command[4] == ' ') { // optional param, last 'N' n = atoi(&command[5]); } scanRecentContacts(n, this); - } else if (strcmp(command, "clock") == 0) { // show current time + } + else if (strcmp(command, "clock") == 0) { // show current time uint32_t now = getRTCClock()->getCurrentTime(); DateTime dt = DateTime(now); - Serial.printf( "%02d:%02d - %d/%d/%d UTC\n", dt.hour(), dt.minute(), dt.day(), dt.month(), dt.year()); - } else if (memcmp(command, "time ", 5) == 0) { // set time (to epoch seconds) + Serial.printf("%02d:%02d - %d/%d/%d UTC\n", dt.hour(), dt.minute(), dt.day(), dt.month(), dt.year()); + } + else if (memcmp(command, "time ", 5) == 0) { // set time (to epoch seconds) uint32_t secs = _atoi(&command[5]); setClock(secs); - } else if (memcmp(command, "to ", 3) == 0) { // set current recipient + } + else if (memcmp(command, "to ", 3) == 0) { // set current recipient curr_recipient = searchContactsByPrefix(&command[3]); if (curr_recipient) { Serial.printf(" Recipient %s now selected.\n", curr_recipient->name); - } else { + } + else { Serial.println(" Error: Name prefix not found."); } - } else if (strcmp(command, "to") == 0) { // show current recipient + } + else if (strcmp(command, "to") == 0) { // show current recipient if (curr_recipient) { - Serial.printf(" Current: %s\n", curr_recipient->name); - } else { - Serial.println(" Err: no recipient selected"); + Serial.printf(" Current: %s\n", curr_recipient->name); } - } else if (strcmp(command, "advert") == 0) { + else { + Serial.println(" Err: no recipient selected"); + } + } + else if (strcmp(command, "advert") == 0) { auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { sendZeroHop(pkt); Serial.println(" (advert sent, zero hop)."); - } else { + } + else { Serial.println(" ERR: unable to send"); } - } else if (strcmp(command, "reset path") == 0) { + } + else if (strcmp(command, "reset path") == 0) { if (curr_recipient) { resetPathTo(*curr_recipient); saveContacts(); Serial.println(" Done."); } - } else if (memcmp(command, "card", 4) == 0) { + } + else if (memcmp(command, "card", 4) == 0) { Serial.printf("Hello %s\n", _prefs.node_name); auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { - uint8_t len = pkt->writeTo(tmp_buf); - releasePacket(pkt); // undo the obtainNewPacket() + uint8_t len = pkt->writeTo(tmp_buf); + releasePacket(pkt); // undo the obtainNewPacket() mesh::Utils::toHex(hex_buf, tmp_buf, len); Serial.println("Your MeshCore biz card:"); - Serial.print("meshcore://"); Serial.println(hex_buf); + Serial.print("meshcore://"); + Serial.println(hex_buf); Serial.println(); - } else { + } + else { Serial.println(" Error"); } - } else if (memcmp(command, "import ", 7) == 0) { + } + else if (memcmp(command, "import ", 7) == 0) { importCard(&command[7]); - } else if (memcmp(command, "set ", 4) == 0) { - const char* config = &command[4]; + } + else if (memcmp(command, "set ", 4) == 0) { + const char *config = &command[4]; if (memcmp(config, "af ", 3) == 0) { _prefs.airtime_factor = atof(&config[3]); savePrefs(); Serial.println(" OK"); - } else if (memcmp(config, "name ", 5) == 0) { + } + else if (memcmp(config, "name ", 5) == 0) { StrHelper::strncpy(_prefs.node_name, &config[5], sizeof(_prefs.node_name)); savePrefs(); Serial.println(" OK"); - } else if (memcmp(config, "lat ", 4) == 0) { + } + else if (memcmp(config, "lat ", 4) == 0) { _prefs.node_lat = atof(&config[4]); savePrefs(); Serial.println(" OK"); - } else if (memcmp(config, "lon ", 4) == 0) { + } + else if (memcmp(config, "lon ", 4) == 0) { _prefs.node_lon = atof(&config[4]); savePrefs(); Serial.println(" OK"); - } else if (memcmp(config, "tx ", 3) == 0) { + } + else if (memcmp(config, "tx ", 3) == 0) { _prefs.tx_power_dbm = atoi(&config[3]); savePrefs(); Serial.println(" OK - reboot to apply"); - } else if (memcmp(config, "freq ", 5) == 0) { + } + else if (memcmp(config, "freq ", 5) == 0) { _prefs.freq = atof(&config[5]); savePrefs(); Serial.println(" OK - reboot to apply"); - } else { + } + else { Serial.printf(" ERROR: unknown config: %s\n", config); } - } else if (memcmp(command, "ver", 3) == 0) { + } + else if (memcmp(command, "ver", 3) == 0) { Serial.println(FIRMWARE_VER_TEXT); - } else if (memcmp(command, "help", 4) == 0) { + } + else if (memcmp(command, "help", 4) == 0) { Serial.println("Commands:"); Serial.println(" set {name|lat|lon|freq|tx|af} {value}"); Serial.println(" card"); @@ -516,50 +584,59 @@ public: Serial.println(" advert"); Serial.println(" reset path"); Serial.println(" public "); - } else { - Serial.print(" ERROR: unknown command: "); Serial.println(command); + } + else { + Serial.print(" ERROR: unknown command: "); + Serial.println(command); } } - void loop() { + void loop() + { BaseChatMesh::loop(); int len = strlen(command); - while (Serial.available() && len < sizeof(command)-1) { + while (Serial.available() && len < sizeof(command) - 1) { char c = Serial.read(); - if (c != '\n') { + if (c != '\n') { command[len++] = c; command[len] = 0; } Serial.print(c); } - if (len == sizeof(command)-1) { // command buffer full - command[sizeof(command)-1] = '\r'; + if (len == sizeof(command) - 1) { // command buffer full + command[sizeof(command) - 1] = '\r'; } - if (len > 0 && command[len - 1] == '\r') { // received complete line - command[len - 1] = 0; // replace newline with C string null terminator + if (len > 0 && command[len - 1] == '\r') { // received complete line + command[len - 1] = 0; // replace newline with C string null terminator handleCommand(command); - command[0] = 0; // reset command buffer + command[0] = 0; // reset command buffer } } }; StdRNG fast_rng; SimpleMeshTables tables; -MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), tables); // TODO: test with 'rtc_clock' in target.cpp +MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), + tables); // TODO: test with 'rtc_clock' in target.cpp -void halt() { - while (1) ; +void halt() +{ + while (1) + ; } -void setup() { +void setup() +{ Serial.begin(115200); board.begin(); - if (!radio_init()) { halt(); } + if (!radio_init()) { + halt(); + } fast_rng.begin(radio_get_rng_seed()); @@ -573,7 +650,7 @@ void setup() { SPIFFS.begin(true); the_mesh.begin(SPIFFS); #else - #error "need to define filesystem" +#error "need to define filesystem" #endif radio_set_params(the_mesh.getFreqPref(), LORA_BW, LORA_SF, LORA_CR); @@ -582,9 +659,10 @@ void setup() { the_mesh.showWelcome(); // send out initial Advertisement to the mesh - the_mesh.sendSelfAdvert(1200); // add slight delay + the_mesh.sendSelfAdvert(1200); // add slight delay } -void loop() { +void loop() +{ the_mesh.loop(); } From 4eccc9e5a59ec77cd5affeb0d600a66ccbbbde4d Mon Sep 17 00:00:00 2001 From: ripplebiz Date: Mon, 2 Jun 2025 11:18:37 +1000 Subject: [PATCH 07/87] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index b4943dea..708db2c4 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,11 @@ MeshCore is open-source software released under the MIT License. You are free to Please submit PR's using 'dev' as the base branch! For minor changes just submit your PR and I'll try to review it, but for anything more 'impactful' please open an Issue first and start a discussion. Is better to sound out what it is you want to achieve first, and try to come to a consensus on what the best approach is, especially when it impacts the structure or architecture of this codebase. +Here are some general principals you should try to adhere to: +* Keep it simple. Please, don't think like a high-level lang programmer. Think embedded, and keep code concise, without any unecessary layers. +* No dynamic memory allocation, except during setup/begin functions. +* Use the same brace and indenting style that's in the core source modules. (A .clang-format is prob going to be added soon, but please do NOT retroactively re-format existing code. This just creates unnecessary diffs that make finding problems harder) + ## 📞 Get Support - Report bugs and request features on the [GitHub Issues](https://github.com/ripplebiz/MeshCore/issues) page. From a987efeca1da43ffd10dbf7315f4f74a03d23090 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 12:54:40 +1000 Subject: [PATCH 08/87] * companion: disabling interference threshold for now --- examples/companion_radio/main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index 4cc85dba..84848d8b 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -491,7 +491,7 @@ protected: } int getInterferenceThreshold() const override { - return 14; // hard-coded for now + return 0; // disabled for now, until currentRSSI() problem is resolved } int calcRxDelay(float score, uint32_t air_time) const override { From 9959475c0d908f477d82a2fe166d49b905ead289 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 09:25:17 -0700 Subject: [PATCH 09/87] Reformatting code --- examples/companion_radio/MyMesh.cpp | 790 +++++++++++---------------- examples/companion_radio/MyMesh.h | 336 +++++------- examples/companion_radio/NodePrefs.h | 16 +- examples/companion_radio/UITask.h | 47 +- 4 files changed, 493 insertions(+), 696 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 6e9688a5..db40169f 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1,19 +1,83 @@ -#include // needed for PlatformIO -#include #include "MyMesh.h" +#include // needed for PlatformIO +#include + +#define CMD_APP_START 1 +#define CMD_SEND_TXT_MSG 2 +#define CMD_SEND_CHANNEL_TXT_MSG 3 +#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) +#define CMD_GET_DEVICE_TIME 5 +#define CMD_SET_DEVICE_TIME 6 +#define CMD_SEND_SELF_ADVERT 7 +#define CMD_SET_ADVERT_NAME 8 +#define CMD_ADD_UPDATE_CONTACT 9 +#define CMD_SYNC_NEXT_MESSAGE 10 +#define CMD_SET_RADIO_PARAMS 11 +#define CMD_SET_RADIO_TX_POWER 12 +#define CMD_RESET_PATH 13 +#define CMD_SET_ADVERT_LATLON 14 +#define CMD_REMOVE_CONTACT 15 +#define CMD_SHARE_CONTACT 16 +#define CMD_EXPORT_CONTACT 17 +#define CMD_IMPORT_CONTACT 18 +#define CMD_REBOOT 19 +#define CMD_GET_BATTERY_VOLTAGE 20 +#define CMD_SET_TUNING_PARAMS 21 +#define CMD_DEVICE_QEURY 22 +#define CMD_EXPORT_PRIVATE_KEY 23 +#define CMD_IMPORT_PRIVATE_KEY 24 +#define CMD_SEND_RAW_DATA 25 +#define CMD_SEND_LOGIN 26 +#define CMD_SEND_STATUS_REQ 27 +#define CMD_HAS_CONNECTION 28 +#define CMD_LOGOUT 29 // 'Disconnect' +#define CMD_GET_CONTACT_BY_KEY 30 +#define CMD_GET_CHANNEL 31 +#define CMD_SET_CHANNEL 32 +#define CMD_SIGN_START 33 +#define CMD_SIGN_DATA 34 +#define CMD_SIGN_FINISH 35 +#define CMD_SEND_TRACE_PATH 36 +#define CMD_SET_DEVICE_PIN 37 +#define CMD_SET_OTHER_PARAMS 38 +#define CMD_SEND_TELEMETRY_REQ 39 +#define CMD_GET_CUSTOM_VARS 40 +#define CMD_SET_CUSTOM_VAR 41 + +#define RESP_CODE_OK 0 +#define RESP_CODE_ERR 1 +#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS +#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) +#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS +#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START +#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG +#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) +#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME +#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE +#define RESP_CODE_EXPORT_CONTACT 11 +#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE +#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY +#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY +#define RESP_CODE_DISABLED 15 +#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) +#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL +#define RESP_CODE_SIGN_START 19 +#define RESP_CODE_SIGNATURE 20 +#define RESP_CODE_CUSTOM_VARS 21 + #ifdef DISPLAY_CLASS - #include "UITask.h" +#include "UITask.h" #endif void MyMesh::loadMainIdentity() { - if (!_identity_store->load("_main", self_id)) - { + if (!_identity_store->load("_main", self_id)) { self_id = radio_new_identity(); // create new random identity int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) - { // reserved id hashes + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes self_id = radio_new_identity(); count++; } @@ -28,18 +92,15 @@ bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) void MyMesh::loadContacts() { - if (_fs->exists("/contacts3")) - { + if (_fs->exists("/contacts3")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/contacts3", "r"); #else File file = _fs->open("/contacts3"); #endif - if (file) - { + if (file) { bool full = false; - while (!full) - { + while (!full) { ContactInfo c; uint8_t pub_key[32]; uint8_t unused; @@ -79,14 +140,12 @@ void MyMesh::saveContacts() #else File file = _fs->open("/contacts3", "w", true); #endif - if (file) - { + if (file) { ContactsIterator iter; ContactInfo c; uint8_t unused = 0; - while (iter.hasNext(this, c)) - { + while (iter.hasNext(this, c)) { bool success = (file.write(c.id.pub_key, 32) == 32); success = success && (file.write((uint8_t *)&c.name, 32) == 32); success = success && (file.write(&c.type, 1) == 1); @@ -109,19 +168,16 @@ void MyMesh::saveContacts() void MyMesh::loadChannels() { - if (_fs->exists("/channels2")) - { + if (_fs->exists("/channels2")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/channels2", "r"); #else File file = _fs->open("/channels2"); #endif - if (file) - { + if (file) { bool full = false; uint8_t channel_idx = 0; - while (!full) - { + while (!full) { ChannelDetails ch; uint8_t unused[4]; @@ -132,12 +188,10 @@ void MyMesh::loadChannels() if (!success) break; // EOF - if (setChannel(channel_idx, ch)) - { + if (setChannel(channel_idx, ch)) { channel_idx++; } - else - { + else { full = true; } } @@ -156,15 +210,13 @@ void MyMesh::saveChannels() #else File file = _fs->open("/channels2", "w", true); #endif - if (file) - { + if (file) { uint8_t channel_idx = 0; ChannelDetails ch; uint8_t unused[4]; memset(unused, 0, 4); - while (getChannel(channel_idx, ch)) - { + while (getChannel(channel_idx, ch)) { bool success = (file.write(unused, 4) == 4); success = success && (file.write((uint8_t *)ch.name, 32) == 32); success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); @@ -187,15 +239,13 @@ int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); - if (_fs->exists(path)) - { + if (_fs->exists(path)) { #if defined(RP2040_PLATFORM) File f = _fs->open(path, "r"); #else File f = _fs->open(path); #endif - if (f) - { + if (f) { int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! f.close(); return len; @@ -222,8 +272,7 @@ bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_bu #else File f = _fs->open(path, "w", true); #endif - if (f) - { + if (f) { int n = f.write(src_buf, len); f.close(); if (n == len) @@ -294,8 +343,7 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, i += 32; memcpy(&contact.last_advert_timestamp, &frame[i], 4); i += 4; - if (i + 8 >= len) - { // optional fields + if (i + 8 >= len) { // optional fields memcpy(&contact.gps_lat, &frame[i], 4); i += 4; memcpy(&contact.gps_lon, &frame[i], 4); @@ -305,12 +353,10 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) { - if (offline_queue_len >= OFFLINE_QUEUE_SIZE) - { + if (offline_queue_len >= OFFLINE_QUEUE_SIZE) { MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); } - else - { + else { offline_queue[offline_queue_len].len = len; memcpy(offline_queue[offline_queue_len].buf, frame, len); offline_queue_len++; @@ -318,14 +364,12 @@ void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) } int MyMesh::getFromOfflineQueue(uint8_t frame[]) { - if (offline_queue_len > 0) - { // check offline queue + if (offline_queue_len > 0) { // check offline queue size_t len = offline_queue[0].len; // take from top of queue memcpy(frame, offline_queue[0].buf, len); offline_queue_len--; - for (int i = 0; i < offline_queue_len; i++) - { // delete top item from queue + for (int i = 0; i < offline_queue_len; i++) { // delete top item from queue offline_queue[i] = offline_queue[i + 1]; } return len; @@ -352,8 +396,7 @@ int MyMesh::calcRxDelay(float score, uint32_t air_time) const void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) { - if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) - { + if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) { int i = 0; out_frame[i++] = PUSH_CODE_LOG_RX_DATA; out_frame[i++] = (int8_t)(snr * 4); @@ -372,21 +415,17 @@ bool MyMesh::isAutoAddEnabled() const void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { - if (_serial->isConnected()) - { - if (!isAutoAddEnabled() && is_new) - { + if (_serial->isConnected()) { + if (!isAutoAddEnabled() && is_new) { writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); } - else - { + else { out_frame[0] = PUSH_CODE_ADVERT; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); } } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::newContactMessage); #endif @@ -407,10 +446,8 @@ void MyMesh::onContactPathUpdated(const ContactInfo &contact) bool MyMesh::processAck(const uint8_t *data) { // see if matches any in a table - for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) - { - if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) - { // got an ACK from recipient + for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) { + if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient out_frame[0] = PUSH_CODE_SEND_CONFIRMED; memcpy(&out_frame[1], data, 4); uint32_t trip_time = _ms->getMillis() - expected_ack_table[i].msg_sent; @@ -425,18 +462,17 @@ bool MyMesh::processAck(const uint8_t *data) return checkConnectionsAck(data); } -void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) +void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, + uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) { int i = 0; - if (app_target_ver >= 3) - { + if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 } - else - { + else { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; } memcpy(&out_frame[i], from.id.pub_key, 6); @@ -445,28 +481,24 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe out_frame[i++] = txt_type; memcpy(&out_frame[i], &sender_timestamp, 4); i += 4; - if (extra_len > 0) - { + if (extra_len > 0) { memcpy(&out_frame[i], extra, extra_len); i += extra_len; } int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) - { + if (i + tlen > MAX_FRAME_SIZE) { tlen = MAX_FRAME_SIZE - i; } memcpy(&out_frame[i], text, tlen); i += tlen; addToOfflineQueue(out_frame, i); - if (_serial->isConnected()) - { + if (_serial->isConnected()) { uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::contactMessage); #endif @@ -476,19 +508,22 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe #endif } -void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); } -void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const char *text) +void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); } -void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) +void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) { markConnectionActive(from); // from.sync_since change needs to be persisted @@ -496,18 +531,17 @@ void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uin queueMessage(from, TXT_TYPE_SIGNED_PLAIN, pkt, sender_timestamp, sender_prefix, 4, text); } -void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, const char *text) +void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, + const char *text) { int i = 0; - if (app_target_ver >= 3) - { + if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 } - else - { + else { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; } @@ -518,22 +552,19 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe memcpy(&out_frame[i], ×tamp, 4); i += 4; int tlen = strlen(text); // TODO: UTF-8 ?? - if (i + tlen > MAX_FRAME_SIZE) - { + if (i + tlen > MAX_FRAME_SIZE) { tlen = MAX_FRAME_SIZE - i; } memcpy(&out_frame[i], text, tlen); i += tlen; addToOfflineQueue(out_frame, i); - if (_serial->isConnected()) - { + if (_serial->isConnected()) { uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); } - else - { + else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::channelMessage); #endif @@ -543,48 +574,42 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe #endif } -uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, uint8_t len, uint8_t *reply) +uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, + uint8_t len, uint8_t *reply) { - if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) - { + if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) { uint8_t permissions = 0; uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) - if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) { permissions = TELEM_PERM_BASE; } - else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { permissions = cp & TELEM_PERM_BASE; } - if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_LOCATION; } - else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_LOCATION; } - if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) - { + if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_ENVIRONMENT; } - else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) - { + else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_ENVIRONMENT; } - if (permissions & TELEM_PERM_BASE) - { // only respond if base permission bit is set + if (permissions & TELEM_PERM_BASE) { // only respond if base permission bit is set telemetry.reset(); telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); // query other sensors -- target specific sensors.querySensors(permissions, telemetry); - memcpy(reply, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') + memcpy(reply, &sender_timestamp, + 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') uint8_t tlen = telemetry.getSize(); memcpy(&reply[4], telemetry.getBuffer(), tlen); @@ -599,24 +624,20 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint32_t tag; memcpy(&tag, data, 4); - if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) - { // check for login response + if (pending_login && memcmp(&pending_login, contact.id.pub_key, 4) == 0) { // check for login response // yes, is response to pending sendLogin() pending_login = 0; int i = 0; - if (memcmp(&data[4], "OK", 2) == 0) - { // legacy Repeater login OK response + if (memcmp(&data[4], "OK", 2) == 0) { // legacy Repeater login OK response out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; out_frame[i++] = 0; // legacy: is_admin = false memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix } - else if (data[4] == RESP_SERVER_LOGIN_OK) - { // new login response + else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; - if (keep_alive_secs > 0) - { + if (keep_alive_secs > 0) { startConnection(contact, keep_alive_secs); } out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; @@ -626,8 +647,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, memcpy(&out_frame[i], &tag, 4); i += 4; // NEW: include server timestamp } - else - { + else { out_frame[i++] = PUSH_CODE_LOGIN_FAIL; out_frame[i++] = 0; // reserved memcpy(&out_frame[i], contact.id.pub_key, 6); @@ -635,11 +655,11 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, } _serial->writeFrame(out_frame, i); } - else if (len > 4 && // check for status response - pending_status && memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme - // FUTURE: tag == pending_status - ) - { + else if (len > 4 && // check for status response + pending_status && + memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme + // FUTURE: tag == pending_status + ) { pending_status = 0; int i = 0; @@ -651,8 +671,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, i += (len - 4); _serial->writeFrame(out_frame, i); } - else if (len > 4 && tag == pending_telemetry) - { // check for telemetry response + else if (len > 4 && tag == pending_telemetry) { // check for telemetry response pending_telemetry = 0; int i = 0; @@ -668,8 +687,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, void MyMesh::onRawDataRecv(mesh::Packet *packet) { - if (packet->payload_len + 4 > sizeof(out_frame)) - { + if (packet->payload_len + 4 > sizeof(out_frame)) { MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); return; } @@ -681,17 +699,16 @@ void MyMesh::onRawDataRecv(mesh::Packet *packet) memcpy(&out_frame[i], packet->payload, packet->payload_len); i += packet->payload_len; - if (_serial->isConnected()) - { + if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); } - else - { + else { MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); } } -void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) +void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) { int i = 0; out_frame[i++] = PUSH_CODE_TRACE_DATA; @@ -708,12 +725,10 @@ void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, i += path_len; out_frame[i++] = (int8_t)(packet->getSNR() * 4); // extra/final SNR (to this node) - if (_serial->isConnected()) - { + if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); } - else - { + else { MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); } } @@ -725,16 +740,15 @@ uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const { return SEND_TIMEOUT_BASE_MILLIS + - ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * + (path_len + 1)); } -void MyMesh::onSendTimeout() -{ -} +void MyMesh::onSendTimeout() {} MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) - : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), _serial(NULL), - telemetry(MAX_PACKET_PAYLOAD - 4) + : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), + _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { _iter_started = false; offline_queue_len = 0; @@ -764,8 +778,7 @@ void MyMesh::loadPrefsInt(const char *filename) #else File file = _fs->open(filename); #endif - if (file) - { + if (file) { uint8_t pad[8]; file.read((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 @@ -828,36 +841,30 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) #endif // load persisted prefs - if (_fs->exists("/new_prefs")) - { + if (_fs->exists("/new_prefs")) { loadPrefsInt("/new_prefs"); // new filename } - else if (_fs->exists("/node_prefs")) - { + else if (_fs->exists("/node_prefs")) { loadPrefsInt("/node_prefs"); savePrefs(); // save to new filename _fs->remove("/node_prefs"); // remove old } #ifdef BLE_PIN_CODE - if (_prefs.ble_pin == 0) - { + if (_prefs.ble_pin == 0) { #ifdef DISPLAY_CLASS - if (has_display) - { + if (has_display) { StdRNG rng; _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session } - else - { + else { _active_ble_pin = BLE_PIN_CODE; // otherwise static pin } #else _active_ble_pin = BLE_PIN_CODE; // otherwise static pin #endif } - else - { + else { _active_ble_pin = _prefs.ble_pin; } #else @@ -875,12 +882,18 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) radio_set_tx_power(_prefs.tx_power_dbm); } -const char *MyMesh::getNodeName() { return _prefs.node_name; } +const char *MyMesh::getNodeName() +{ + return _prefs.node_name; +} NodePrefs *MyMesh::getNodePrefs() { return &_prefs; } -uint32_t MyMesh::getBLEPin() { return _active_ble_pin; } +uint32_t MyMesh::getBLEPin() +{ + return _active_ble_pin; +} void MyMesh::startInterface(BaseSerialInterface &serial) { @@ -898,8 +911,7 @@ void MyMesh::savePrefs() #else File file = _fs->open("/new_prefs", "w", true); #endif - if (file) - { + if (file) { uint8_t pad[8]; memset(pad, 0, sizeof(pad)); @@ -928,9 +940,8 @@ void MyMesh::savePrefs() void MyMesh::handleCmdFrame(size_t len) { - if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) - { // sent when app establishes connection - app_target_ver = cmd_frame[1]; // which version of protocol does app understand + if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection + app_target_ver = cmd_frame[1]; // which version of protocol does app understand int i = 0; out_frame[i++] = RESP_CODE_DEVICE_INFO; @@ -948,8 +959,8 @@ void MyMesh::handleCmdFrame(size_t len) i += 20; _serial->writeFrame(out_frame, i); } - else if (cmd_frame[0] == CMD_APP_START && len >= 8) - { // sent when app establishes connection, respond with node ID + else if (cmd_frame[0] == CMD_APP_START && + len >= 8) { // sent when app establishes connection, respond with node ID // cmd_frame[1..7] reserved future char *app_name = (char *)&cmd_frame[8]; cmd_frame[len] = 0; // make app_name null terminated @@ -971,9 +982,10 @@ void MyMesh::handleCmdFrame(size_t len) i += 4; memcpy(&out_frame[i], &lon, 4); i += 4; - out_frame[i++] = 0; // reserved - out_frame[i++] = 0; // reserved - out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | (_prefs.telemetry_mode_base); // v5+ + out_frame[i++] = 0; // reserved + out_frame[i++] = 0; // reserved + out_frame[i++] = (_prefs.telemetry_mode_env << 4) | (_prefs.telemetry_mode_loc << 2) | + (_prefs.telemetry_mode_base); // v5+ out_frame[i++] = _prefs.manual_add_contacts; uint32_t freq = _prefs.freq * 1000; @@ -990,8 +1002,7 @@ void MyMesh::handleCmdFrame(size_t len) i += tlen; _serial->writeFrame(out_frame, i); } - else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) - { + else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { int i = 1; uint8_t txt_type = cmd_frame[i++]; uint8_t attempt = cmd_frame[i++]; @@ -1001,32 +1012,26 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t *pub_key_prefix = &cmd_frame[i]; i += 6; ContactInfo *recipient = lookupContactByPubKey(pub_key_prefix, 6); - if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) - { + if (recipient && (txt_type == TXT_TYPE_PLAIN || txt_type == TXT_TYPE_CLI_DATA)) { char *text = (char *)&cmd_frame[i]; int tlen = len - i; uint32_t est_timeout; text[tlen] = 0; // ensure null int result; uint32_t expected_ack; - if (txt_type == TXT_TYPE_CLI_DATA) - { + if (txt_type == TXT_TYPE_CLI_DATA) { result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); expected_ack = 0; // no Ack expected } - else - { + else { result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); } // TODO: add expected ACK to table - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { - if (expected_ack) - { + else { + if (expected_ack) { expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table expected_ack_table[next_ack_idx].ack = expected_ack; next_ack_idx = (next_ack_idx + 1) % EXPECTED_ACK_TABLE_SIZE; @@ -1039,13 +1044,13 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { - writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* + else { + writeErrFrame(recipient == NULL + ? ERR_CODE_NOT_FOUND + : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* } } - else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) - { // send GroupChannel msg + else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg int i = 1; uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN uint8_t channel_idx = cmd_frame[i++]; @@ -1054,38 +1059,29 @@ void MyMesh::handleCmdFrame(size_t len) i += 4; const char *text = (char *)&cmd_frame[i]; - if (txt_type != TXT_TYPE_PLAIN) - { + if (txt_type != TXT_TYPE_PLAIN) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); } - else - { + else { ChannelDetails channel; bool success = getChannel(channel_idx, channel); - if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) - { + if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } } - else if (cmd_frame[0] == CMD_GET_CONTACTS) - { // get Contact list - if (_iter_started) - { + else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list + if (_iter_started) { writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy } - else - { - if (len >= 5) - { // has optional 'since' param + else { + if (len >= 5) { // has optional 'since' param memcpy(&_iter_filter_since, &cmd_frame[1], 4); } - else - { + else { _iter_filter_since = 0; } @@ -1101,8 +1097,7 @@ void MyMesh::handleCmdFrame(size_t len) _most_recent_lastmod = 0; } } - else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) - { + else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { int nlen = len - 1; if (nlen > sizeof(_prefs.node_name) - 1) nlen = sizeof(_prefs.node_name) - 1; // max len @@ -1111,169 +1106,134 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) - { + else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { int32_t lat, lon, alt = 0; memcpy(&lat, &cmd_frame[1], 4); memcpy(&lon, &cmd_frame[5], 4); - if (len >= 13) - { + if (len >= 13) { memcpy(&alt, &cmd_frame[9], 4); // for FUTURE support } - if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) - { + if (lat <= 90 * 1E6 && lat >= -90 * 1E6 && lon <= 180 * 1E6 && lon >= -180 * 1E6) { sensors.node_lat = ((double)lat) / 1000000.0; sensors.node_lon = ((double)lon) / 1000000.0; savePrefs(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate } } - else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) - { + else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { uint8_t reply[5]; reply[0] = RESP_CODE_CURR_TIME; uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply[1], &now, 4); _serial->writeFrame(reply, 5); } - else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) - { + else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { uint32_t secs; memcpy(&secs, &cmd_frame[1], 4); uint32_t curr = getRTCClock()->getCurrentTime(); - if (secs >= curr) - { + if (secs >= curr) { getRTCClock()->setCurrentTime(secs); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) - { + else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { - if (len >= 2 && cmd_frame[1] == 1) - { // optional param (1 = flood, 0 = zero hop) + if (pkt) { + if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop) sendFlood(pkt); } - else - { + else { sendZeroHop(pkt); } writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) - { + else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { recipient->out_path_len = -1; // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact } } - else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) - { + else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { updateContactFromFrame(*recipient, cmd_frame, len); // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { ContactInfo contact; updateContactFromFrame(contact, cmd_frame, len); contact.lastmod = getRTCClock()->getCurrentTime(); contact.sync_since = 0; - if (addContact(contact)) - { + if (addContact(contact)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } } - else if (cmd_frame[0] == CMD_REMOVE_CONTACT) - { + else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient && removeContact(*recipient)) - { + if (recipient && removeContact(*recipient)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove } } - else if (cmd_frame[0] == CMD_SHARE_CONTACT) - { + else if (cmd_frame[0] == CMD_SHARE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { - if (shareContactZeroHop(*recipient)) - { + if (recipient) { + if (shareContactZeroHop(*recipient)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) - { + else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (contact) - { + if (contact) { writeContactRespFrame(RESP_CODE_CONTACT, *contact); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } - else if (cmd_frame[0] == CMD_EXPORT_CONTACT) - { - if (len < 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { + if (len < 1 + PUB_KEY_SIZE) { // export SELF auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { + if (pkt) { pkt->header |= ROUTE_TYPE_FLOOD; // would normally be sent in this mode out_frame[0] = RESP_CODE_EXPORT_CONTACT; @@ -1281,56 +1241,45 @@ void MyMesh::handleCmdFrame(size_t len) releasePacket(pkt); // undo the obtainNewPacket() _serial->writeFrame(out_frame, out_len + 1); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); // Error } } - else - { + else { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); uint8_t out_len; - if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) - { + if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) { out_frame[0] = RESP_CODE_EXPORT_CONTACT; _serial->writeFrame(out_frame, out_len + 1); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } } - else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) - { - if (importContact(&cmd_frame[1], len - 1)) - { + else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { + if (importContact(&cmd_frame[1], len - 1)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) - { + else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { int out_len; - if ((out_len = getFromOfflineQueue(out_frame)) > 0) - { + if ((out_len = getFromOfflineQueue(out_frame)) > 0) { _serial->writeFrame(out_frame, out_len); #ifdef DISPLAY_CLASS ui_task.msgRead(offline_queue_len); #endif } - else - { + else { out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; _serial->writeFrame(out_frame, 1); } } - else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { int i = 1; uint32_t freq; memcpy(&freq, &cmd_frame[i], 4); @@ -1341,8 +1290,8 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t sf = cmd_frame[i++]; uint8_t cr = cmd_frame[i++]; - if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && bw <= 500000) - { + if (freq >= 300000 && freq <= 2500000 && sf >= 7 && sf <= 12 && cr >= 5 && cr <= 8 && bw >= 7000 && + bw <= 500000) { _prefs.sf = sf; _prefs.cr = cr; _prefs.freq = (float)freq / 1000.0; @@ -1350,32 +1299,29 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); - MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + MESH_DEBUG_PRINTLN("OK: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, + (uint32_t)cr); writeOKFrame(); } - else - { - MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); + else { + MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, + (uint32_t)cr); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) - { - if (cmd_frame[1] > MAX_LORA_TX_POWER) - { + else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { + if (cmd_frame[1] > MAX_LORA_TX_POWER) { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - else - { + else { _prefs.tx_power_dbm = cmd_frame[1]; savePrefs(); radio_set_tx_power(_prefs.tx_power_dbm); writeOKFrame(); } } - else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { int i = 1; uint32_t rx, af; memcpy(&rx, &cmd_frame[i], 4); @@ -1387,11 +1333,9 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) - { + else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { _prefs.manual_add_contacts = cmd_frame[1]; - if (len >= 3) - { + if (len >= 3) { _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ _prefs.telemetry_mode_loc = (cmd_frame[2] >> 2) & 0x03; _prefs.telemetry_mode_env = (cmd_frame[2] >> 4) & 0x03; @@ -1399,24 +1343,20 @@ void MyMesh::handleCmdFrame(size_t len) savePrefs(); writeOKFrame(); } - else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) - { - if (dirty_contacts_expiry) - { // is there are pending dirty contacts write needed? + else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { + if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed? saveContacts(); } board.reboot(); } - else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) - { + else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { uint8_t reply[3]; reply[0] = RESP_CODE_BATTERY_VOLTAGE; uint16_t battery_millivolts = board.getBattMilliVolts(); memcpy(&reply[1], &battery_millivolts, 2); _serial->writeFrame(reply, 3); } - else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) - { + else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { #if ENABLE_PRIVATE_KEY_EXPORT uint8_t reply[65]; reply[0] = RESP_CODE_PRIVATE_KEY; @@ -1426,64 +1366,52 @@ void MyMesh::handleCmdFrame(size_t len) writeDisabledFrame(); #endif } - else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) - { + else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { #if ENABLE_PRIVATE_KEY_IMPORT mesh::LocalIdentity identity; identity.readFrom(&cmd_frame[1], 64); - if (saveMainIdentity(identity)) - { + if (saveMainIdentity(identity)) { self_id = identity; writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_FILE_IO_ERROR); } #else writeDisabledFrame(); #endif } - else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) - { + else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { int i = 1; int8_t path_len = cmd_frame[i++]; - if (path_len >= 0 && i + path_len + 4 <= len) - { // minimum 4 byte payload + if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload uint8_t *path = &cmd_frame[i]; i += path_len; auto pkt = createRawData(&cmd_frame[i], len - i); - if (pkt) - { + if (pkt) { sendDirect(pkt, path, path_len); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else - { + else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) } } - else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE]; cmd_frame[len] = 0; // ensure null terminator in password - if (recipient) - { + if (recipient) { uint32_t est_timeout; int result = sendLogin(*recipient, password, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_telemetry = pending_status = 0; memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1493,25 +1421,20 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { uint32_t tag, est_timeout; int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_telemetry = pending_login = 0; // FUTURE: pending_status = tag; // match this in onContactResponse() memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme @@ -1522,25 +1445,20 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[4]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); - if (recipient) - { + if (recipient) { uint32_t tag, est_timeout; int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); - if (result == MSG_SEND_FAILED) - { + if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); } - else - { + else { pending_status = pending_login = 0; pending_telemetry = tag; // match this in onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1550,35 +1468,28 @@ void MyMesh::handleCmdFrame(size_t len) _serial->writeFrame(out_frame, 10); } } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } - else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; - if (hasConnectionTo(pub_key)) - { + if (hasConnectionTo(pub_key)) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) - { + else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; stopConnection(pub_key); writeOKFrame(); } - else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) - { + else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; - if (getChannel(channel_idx, channel)) - { + if (getChannel(channel_idx, channel)) { int i = 0; out_frame[i++] = RESP_CODE_CHANNEL_INFO; out_frame[i++] = channel_idx; @@ -1588,64 +1499,52 @@ void MyMesh::handleCmdFrame(size_t len) i += 16; // NOTE: only 128-bit supported _serial->writeFrame(out_frame, i); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); } } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) - { + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) - { + else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32); memset(channel.channel.secret, 0, sizeof(channel.channel.secret)); memcpy(channel.channel.secret, &cmd_frame[2 + 32], 16); // NOTE: only 128-bit supported - if (setChannel(channel_idx, channel)) - { + if (setChannel(channel_idx, channel)) { saveChannels(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } - else if (cmd_frame[0] == CMD_SIGN_START) - { + else if (cmd_frame[0] == CMD_SIGN_START) { out_frame[0] = RESP_CODE_SIGN_START; out_frame[1] = 0; // reserved uint32_t len = MAX_SIGN_DATA_LEN; memcpy(&out_frame[2], &len, 4); _serial->writeFrame(out_frame, 6); - if (sign_data) - { + if (sign_data) { free(sign_data); } sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN); sign_data_len = 0; } - else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) - { - if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) - { + else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { + if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) { writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long } - else - { + else { memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); sign_data_len += (len - 1); writeOKFrame(); } } - else if (cmd_frame[0] == CMD_SIGN_FINISH) - { - if (sign_data) - { + else if (cmd_frame[0] == CMD_SIGN_FINISH) { + if (sign_data) { self_id.sign(&out_frame[1], sign_data, sign_data_len); free(sign_data); // don't need sign_data now @@ -1654,19 +1553,16 @@ void MyMesh::handleCmdFrame(size_t len) out_frame[0] = RESP_CODE_SIGNATURE; _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); } - else - { + else { writeErrFrame(ERR_CODE_BAD_STATE); } } - else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) - { + else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { uint32_t tag, auth; memcpy(&tag, &cmd_frame[1], 4); memcpy(&auth, &cmd_frame[5], 4); auto pkt = createTrace(tag, auth, cmd_frame[9]); - if (pkt) - { + if (pkt) { uint8_t path_len = len - 10; sendDirect(pkt, &cmd_frame[10], path_len); @@ -1679,38 +1575,31 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) - { + else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { // get pin from command frame uint32_t pin; memcpy(&pin, &cmd_frame[1], 4); // ensure pin is zero, or a valid 6 digit pin - if (pin == 0 || (pin >= 100000 && pin <= 999999)) - { + if (pin == 0 || (pin >= 100000 && pin <= 999999)) { _prefs.ble_pin = pin; savePrefs(); writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) - { + else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { out_frame[0] = RESP_CODE_CUSTOM_VARS; char *dp = (char *)&out_frame[1]; - for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) - { - if (i > 0) - { + for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) { + if (i > 0) { *dp++ = ','; } strcpy(dp, sensors.getSettingName(i)); @@ -1721,31 +1610,25 @@ void MyMesh::handleCmdFrame(size_t len) } _serial->writeFrame(out_frame, dp - (char *)out_frame); } - else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) - { + else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { cmd_frame[len] = 0; char *sp = (char *)&cmd_frame[1]; char *np = strchr(sp, ':'); // look for separator char - if (np) - { + if (np) { *np++ = 0; // modify 'cmd_frame', replace ':' with null bool success = sensors.setSettingValue(sp, np); - if (success) - { + if (success) { writeOKFrame(); } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else - { + else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } } - else - { + else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); } @@ -1756,42 +1639,35 @@ void MyMesh::loop() BaseChatMesh::loop(); size_t len = _serial->checkRecvFrame(cmd_frame); - if (len > 0) - { + if (len > 0) { handleCmdFrame(len); } else if (_iter_started // check if our ContactsIterator is 'running' && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! - ) - { + ) { ContactInfo contact; - if (_iter.hasNext(this, contact)) - { - if (contact.lastmod > _iter_filter_since) - { // apply the 'since' filter + if (_iter.hasNext(this, contact)) { + if (contact.lastmod > _iter_filter_since) { // apply the 'since' filter writeContactRespFrame(RESP_CODE_CONTACT, contact); - if (contact.lastmod > _most_recent_lastmod) - { + if (contact.lastmod > _most_recent_lastmod) { _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame } } } - else - { // EOF + else { // EOF out_frame[0] = RESP_CODE_END_OF_CONTACTS; - memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' + memcpy(&out_frame[1], &_most_recent_lastmod, + 4); // include the most recent lastmod, so app can update their 'since' _serial->writeFrame(out_frame, 5); _iter_started = false; } } - else if (!_serial->isWriteBusy()) - { + else if (!_serial->isWriteBusy()) { checkConnections(); } // is there are pending dirty contacts write needed? - if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) - { + if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) { saveContacts(); dirty_contacts_expiry = 0; } @@ -1805,14 +1681,12 @@ void MyMesh::loop() bool MyMesh::advert() { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); - if (pkt) - { + if (pkt) { sendZeroHop(pkt); writeOKFrame(); return true; } - else - { + else { writeErrFrame(ERR_CODE_TABLE_FULL); return false; } diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index a4794f1f..574b9878 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -1,21 +1,20 @@ -#ifndef MYMESH_H -#define MYMESH_H +#pragma once #include #include #ifdef DISPLAY_CLASS - #include "UITask.h" +#include "UITask.h" #endif /*------------ Frame Protocol --------------*/ -#define FIRMWARE_VER_CODE 5 +#define FIRMWARE_VER_CODE 5 #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "24 May 2025" +#define FIRMWARE_BUILD_DATE "24 May 2025" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.6.2" +#define FIRMWARE_VERSION "v1.6.2" #endif #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) @@ -26,258 +25,197 @@ #include #endif -#include -#include -#include -#include -#include #include "NodePrefs.h" + #include +#include +#include +#include +#include +#include #include /* ---------------------------------- CONFIGURATION ------------------------------------- */ #ifndef LORA_FREQ - #define LORA_FREQ 915.0 +#define LORA_FREQ 915.0 #endif #ifndef LORA_BW - #define LORA_BW 250 +#define LORA_BW 250 #endif #ifndef LORA_SF - #define LORA_SF 10 +#define LORA_SF 10 #endif #ifndef LORA_CR - #define LORA_CR 5 +#define LORA_CR 5 #endif #ifndef LORA_TX_POWER - #define LORA_TX_POWER 20 +#define LORA_TX_POWER 20 #endif #ifndef MAX_LORA_TX_POWER - #define MAX_LORA_TX_POWER LORA_TX_POWER +#define MAX_LORA_TX_POWER LORA_TX_POWER #endif #ifndef MAX_CONTACTS - #define MAX_CONTACTS 100 +#define MAX_CONTACTS 100 #endif #ifndef OFFLINE_QUEUE_SIZE - #define OFFLINE_QUEUE_SIZE 16 +#define OFFLINE_QUEUE_SIZE 16 #endif #ifndef BLE_NAME_PREFIX - #define BLE_NAME_PREFIX "MeshCore-" +#define BLE_NAME_PREFIX "MeshCore-" #endif #include -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define LAZY_CONTACTS_WRITE_DELAY 5000 +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define LAZY_CONTACTS_WRITE_DELAY 5000 -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" - -#define CMD_APP_START 1 -#define CMD_SEND_TXT_MSG 2 -#define CMD_SEND_CHANNEL_TXT_MSG 3 -#define CMD_GET_CONTACTS 4 // with optional 'since' (for efficient sync) -#define CMD_GET_DEVICE_TIME 5 -#define CMD_SET_DEVICE_TIME 6 -#define CMD_SEND_SELF_ADVERT 7 -#define CMD_SET_ADVERT_NAME 8 -#define CMD_ADD_UPDATE_CONTACT 9 -#define CMD_SYNC_NEXT_MESSAGE 10 -#define CMD_SET_RADIO_PARAMS 11 -#define CMD_SET_RADIO_TX_POWER 12 -#define CMD_RESET_PATH 13 -#define CMD_SET_ADVERT_LATLON 14 -#define CMD_REMOVE_CONTACT 15 -#define CMD_SHARE_CONTACT 16 -#define CMD_EXPORT_CONTACT 17 -#define CMD_IMPORT_CONTACT 18 -#define CMD_REBOOT 19 -#define CMD_GET_BATTERY_VOLTAGE 20 -#define CMD_SET_TUNING_PARAMS 21 -#define CMD_DEVICE_QEURY 22 -#define CMD_EXPORT_PRIVATE_KEY 23 -#define CMD_IMPORT_PRIVATE_KEY 24 -#define CMD_SEND_RAW_DATA 25 -#define CMD_SEND_LOGIN 26 -#define CMD_SEND_STATUS_REQ 27 -#define CMD_HAS_CONNECTION 28 -#define CMD_LOGOUT 29 // 'Disconnect' -#define CMD_GET_CONTACT_BY_KEY 30 -#define CMD_GET_CHANNEL 31 -#define CMD_SET_CHANNEL 32 -#define CMD_SIGN_START 33 -#define CMD_SIGN_DATA 34 -#define CMD_SIGN_FINISH 35 -#define CMD_SEND_TRACE_PATH 36 -#define CMD_SET_DEVICE_PIN 37 -#define CMD_SET_OTHER_PARAMS 38 -#define CMD_SEND_TELEMETRY_REQ 39 -#define CMD_GET_CUSTOM_VARS 40 -#define CMD_SET_CUSTOM_VAR 41 - -#define RESP_CODE_OK 0 -#define RESP_CODE_ERR 1 -#define RESP_CODE_CONTACTS_START 2 // first reply to CMD_GET_CONTACTS -#define RESP_CODE_CONTACT 3 // multiple of these (after CMD_GET_CONTACTS) -#define RESP_CODE_END_OF_CONTACTS 4 // last reply to CMD_GET_CONTACTS -#define RESP_CODE_SELF_INFO 5 // reply to CMD_APP_START -#define RESP_CODE_SENT 6 // reply to CMD_SEND_TXT_MSG -#define RESP_CODE_CONTACT_MSG_RECV 7 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CHANNEL_MSG_RECV 8 // a reply to CMD_SYNC_NEXT_MESSAGE (ver < 3) -#define RESP_CODE_CURR_TIME 9 // a reply to CMD_GET_DEVICE_TIME -#define RESP_CODE_NO_MORE_MESSAGES 10 // a reply to CMD_SYNC_NEXT_MESSAGE -#define RESP_CODE_EXPORT_CONTACT 11 -#define RESP_CODE_BATTERY_VOLTAGE 12 // a reply to a CMD_GET_BATTERY_VOLTAGE -#define RESP_CODE_DEVICE_INFO 13 // a reply to CMD_DEVICE_QEURY -#define RESP_CODE_PRIVATE_KEY 14 // a reply to CMD_EXPORT_PRIVATE_KEY -#define RESP_CODE_DISABLED 15 -#define RESP_CODE_CONTACT_MSG_RECV_V3 16 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_MSG_RECV_V3 17 // a reply to CMD_SYNC_NEXT_MESSAGE (ver >= 3) -#define RESP_CODE_CHANNEL_INFO 18 // a reply to CMD_GET_CHANNEL -#define RESP_CODE_SIGN_START 19 -#define RESP_CODE_SIGNATURE 20 -#define RESP_CODE_CUSTOM_VARS 21 +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" // these are _pushed_ to client app at any time -#define PUSH_CODE_ADVERT 0x80 -#define PUSH_CODE_PATH_UPDATED 0x81 -#define PUSH_CODE_SEND_CONFIRMED 0x82 -#define PUSH_CODE_MSG_WAITING 0x83 -#define PUSH_CODE_RAW_DATA 0x84 -#define PUSH_CODE_LOGIN_SUCCESS 0x85 -#define PUSH_CODE_LOGIN_FAIL 0x86 -#define PUSH_CODE_STATUS_RESPONSE 0x87 -#define PUSH_CODE_LOG_RX_DATA 0x88 -#define PUSH_CODE_TRACE_DATA 0x89 -#define PUSH_CODE_NEW_ADVERT 0x8A -#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B +#define PUSH_CODE_ADVERT 0x80 +#define PUSH_CODE_PATH_UPDATED 0x81 +#define PUSH_CODE_SEND_CONFIRMED 0x82 +#define PUSH_CODE_MSG_WAITING 0x83 +#define PUSH_CODE_RAW_DATA 0x84 +#define PUSH_CODE_LOGIN_SUCCESS 0x85 +#define PUSH_CODE_LOGIN_FAIL 0x86 +#define PUSH_CODE_STATUS_RESPONSE 0x87 +#define PUSH_CODE_LOG_RX_DATA 0x88 +#define PUSH_CODE_TRACE_DATA 0x89 +#define PUSH_CODE_NEW_ADVERT 0x8A +#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B -#define ERR_CODE_UNSUPPORTED_CMD 1 -#define ERR_CODE_NOT_FOUND 2 -#define ERR_CODE_TABLE_FULL 3 -#define ERR_CODE_BAD_STATE 4 -#define ERR_CODE_FILE_IO_ERROR 5 -#define ERR_CODE_ILLEGAL_ARG 6 +#define ERR_CODE_UNSUPPORTED_CMD 1 +#define ERR_CODE_NOT_FOUND 2 +#define ERR_CODE_TABLE_FULL 3 +#define ERR_CODE_BAD_STATE 4 +#define ERR_CODE_FILE_IO_ERROR 5 +#define ERR_CODE_ILLEGAL_ARG 6 /* -------------------------------------------------------------------------------------- */ -#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS -#define REQ_TYPE_KEEP_ALIVE 0x02 -#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 +#define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS +#define REQ_TYPE_KEEP_ALIVE 0x02 +#define REQ_TYPE_GET_TELEMETRY_DATA 0x03 -#define MAX_SIGN_DATA_LEN (8*1024) // 8K +#define MAX_SIGN_DATA_LEN (8 * 1024) // 8K class MyMesh : public BaseChatMesh { public: - MyMesh(mesh::Radio& radio, mesh::RNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables); - - void begin(FILESYSTEM& fs, bool has_display); - void startInterface(BaseSerialInterface& serial); - void loadPrefsInt(const char* filename); - void savePrefs(); - - const char* getNodeName(); - NodePrefs* getNodePrefs(); - uint32_t getBLEPin(); + MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables); - void loop(); - void handleCmdFrame(size_t len); - bool advert(); + void begin(FILESYSTEM &fs, bool has_display); + void startInterface(BaseSerialInterface &serial); + void loadPrefsInt(const char *filename); + void savePrefs(); + + const char *getNodeName(); + NodePrefs *getNodePrefs(); + uint32_t getBLEPin(); + + void loop(); + void handleCmdFrame(size_t len); + bool advert(); protected: - float getAirtimeBudgetFactor() const override; - int getInterferenceThreshold() const override; - int calcRxDelay(float score, uint32_t air_time) const override; + float getAirtimeBudgetFactor() const override; + int getInterferenceThreshold() const override; + int calcRxDelay(float score, uint32_t air_time) const override; - void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; - bool isAutoAddEnabled() const override; - void onDiscoveredContact(ContactInfo& contact, bool is_new) override; - void onContactPathUpdated(const ContactInfo& contact) override; - bool processAck(const uint8_t *data) override; - void queueMessage(const ContactInfo& from, uint8_t txt_type, mesh::Packet* pkt, - uint32_t sender_timestamp, const uint8_t* extra, int extra_len, const char *text); + void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; + bool isAutoAddEnabled() const override; + void onDiscoveredContact(ContactInfo &contact, bool is_new) override; + void onContactPathUpdated(const ContactInfo &contact) override; + bool processAck(const uint8_t *data) override; + void queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *extra, int extra_len, const char *text); - void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; - void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override; - void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, - const uint8_t *sender_prefix, const char *text) override; - void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override; + void onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override; + void onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const char *text) override; + void onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, + const uint8_t *sender_prefix, const char *text) override; + void onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, + const char *text) override; - uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override; - void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override; - void onRawDataRecv(mesh::Packet* packet) override; - void onTraceRecv(mesh::Packet* packet, uint32_t tag, uint32_t auth_code, uint8_t flags, const uint8_t* path_snrs, - const uint8_t* path_hashes, uint8_t path_len) override; + uint8_t onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, + uint8_t len, uint8_t *reply) override; + void onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) override; + void onRawDataRecv(mesh::Packet *packet) override; + void onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) override; - uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override; - uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; - void onSendTimeout() override; + uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override; + uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; + void onSendTimeout() override; private: - void writeOKFrame(); - void writeErrFrame(uint8_t err_code); - void writeDisabledFrame(); - void writeContactRespFrame(uint8_t code, const ContactInfo& contact); - void updateContactFromFrame(ContactInfo& contact, const uint8_t* frame, int len); - void addToOfflineQueue(const uint8_t frame[], int len); - int getFromOfflineQueue(uint8_t frame[]); - void loadMainIdentity(); - bool saveMainIdentity(const mesh::LocalIdentity& identity); - void loadContacts(); - void saveContacts(); - void loadChannels(); - void saveChannels(); - int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; - bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; + void writeOKFrame(); + void writeErrFrame(uint8_t err_code); + void writeDisabledFrame(); + void writeContactRespFrame(uint8_t code, const ContactInfo &contact); + void updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len); + void addToOfflineQueue(const uint8_t frame[], int len); + int getFromOfflineQueue(uint8_t frame[]); + void loadMainIdentity(); + bool saveMainIdentity(const mesh::LocalIdentity &identity); + void loadContacts(); + void saveContacts(); + void loadChannels(); + void saveChannels(); + int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; private: - FILESYSTEM* _fs; - IdentityStore* _identity_store; - NodePrefs _prefs; - uint32_t pending_login; - uint32_t pending_status; - uint32_t pending_telemetry; - BaseSerialInterface* _serial; + FILESYSTEM *_fs; + IdentityStore *_identity_store; + NodePrefs _prefs; + uint32_t pending_login; + uint32_t pending_status; + uint32_t pending_telemetry; + BaseSerialInterface *_serial; - ContactsIterator _iter; - uint32_t _iter_filter_since; - uint32_t _most_recent_lastmod; - uint32_t _active_ble_pin; - bool _iter_started; - uint8_t app_target_ver; - uint8_t* sign_data; - uint32_t sign_data_len; - unsigned long dirty_contacts_expiry; + ContactsIterator _iter; + uint32_t _iter_filter_since; + uint32_t _most_recent_lastmod; + uint32_t _active_ble_pin; + bool _iter_started; + uint8_t app_target_ver; + uint8_t *sign_data; + uint32_t sign_data_len; + unsigned long dirty_contacts_expiry; - uint8_t cmd_frame[MAX_FRAME_SIZE + 1]; - uint8_t out_frame[MAX_FRAME_SIZE + 1]; - CayenneLPP telemetry; + uint8_t cmd_frame[MAX_FRAME_SIZE + 1]; + uint8_t out_frame[MAX_FRAME_SIZE + 1]; + CayenneLPP telemetry; - struct Frame { - uint8_t len; - uint8_t buf[MAX_FRAME_SIZE]; - }; - int offline_queue_len; - Frame offline_queue[OFFLINE_QUEUE_SIZE]; + struct Frame { + uint8_t len; + uint8_t buf[MAX_FRAME_SIZE]; + }; + int offline_queue_len; + Frame offline_queue[OFFLINE_QUEUE_SIZE]; - struct AckTableEntry { - unsigned long msg_sent; - uint32_t ack; - }; - #define EXPECTED_ACK_TABLE_SIZE 8 - AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table - int next_ack_idx; + struct AckTableEntry { + unsigned long msg_sent; + uint32_t ack; + }; +#define EXPECTED_ACK_TABLE_SIZE 8 + AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table + int next_ack_idx; }; extern StdRNG fast_rng; extern SimpleMeshTables tables; extern MyMesh the_mesh; #ifdef DISPLAY_CLASS - extern UITask ui_task; -#endif -#endif // MYMESH_H \ No newline at end of file +extern UITask ui_task; +#endif \ No newline at end of file diff --git a/examples/companion_radio/NodePrefs.h b/examples/companion_radio/NodePrefs.h index 09d04266..44d7ecbf 100644 --- a/examples/companion_radio/NodePrefs.h +++ b/examples/companion_radio/NodePrefs.h @@ -1,13 +1,11 @@ -#ifndef NODE_PREFS_H -#define NODE_PREFS_H - +#pragma once #include // For uint8_t, uint32_t -#define TELEM_MODE_DENY 0 -#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags -#define TELEM_MODE_ALLOW_ALL 2 +#define TELEM_MODE_DENY 0 +#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags +#define TELEM_MODE_ALLOW_ALL 2 -struct NodePrefs { // persisted to file +struct NodePrefs { // persisted to file float airtime_factor; char node_name[32]; float freq; @@ -22,6 +20,4 @@ struct NodePrefs { // persisted to file uint8_t telemetry_mode_env; float rx_delay_base; uint32_t ble_pin; -}; - -#endif // NODE_PREFS_H \ No newline at end of file +}; \ No newline at end of file diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index 6d7e1eb3..f52c0961 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -1,53 +1,43 @@ -#ifndef UI_TASK_H -#define UI_TASK_H - +#pragma once #include #include #include #ifdef PIN_BUZZER - #include +#include #endif -#include "NodePrefs.h" #include "Button.h" +#include "NodePrefs.h" - enum class UIEventType -{ - none, - contactMessage, - channelMessage, - roomMessage, - newContactMessage, - ack -}; +enum class UIEventType { none, contactMessage, channelMessage, roomMessage, newContactMessage, ack }; class UITask { - DisplayDriver* _display; - mesh::MainBoard* _board; + DisplayDriver *_display; + mesh::MainBoard *_board; #ifdef PIN_BUZZER genericBuzzer buzzer; #endif unsigned long _next_refresh, _auto_off; bool _connected; uint32_t _pin_code; - NodePrefs* _node_prefs; + NodePrefs *_node_prefs; char _version_info[32]; char _origin[62]; char _msg[80]; int _msgcount; bool _need_refresh = true; - bool _displayWasOn = false; // Track display state before button press + bool _displayWasOn = false; // Track display state before button press // Button handlers #if defined(PIN_USER_BTN) || defined(PIN_USER_BTN_ANA) - Button* _userButton = nullptr; + Button *_userButton = nullptr; #endif void renderCurrScreen(); void userLedHandler(); void renderBatteryIndicator(uint16_t batteryMilliVolts); - + // Button action handlers void handleButtonAnyPress(); void handleButtonShortPress(); @@ -55,22 +45,21 @@ class UITask { void handleButtonTriplePress(); void handleButtonLongPress(); - public: - - UITask(mesh::MainBoard* board) : _board(board), _display(NULL) { - _next_refresh = 0; - _connected = false; + UITask(mesh::MainBoard *board) : _board(board), _display(NULL) + { + _next_refresh = 0; + _connected = false; } - void begin(DisplayDriver* display, NodePrefs* node_prefs, const char* build_date, const char* firmware_version, uint32_t pin_code); + void begin(DisplayDriver *display, NodePrefs *node_prefs, const char *build_date, + const char *firmware_version, uint32_t pin_code); void setHasConnection(bool connected) { _connected = connected; } bool hasDisplay() const { return _display != NULL; } void clearMsgPreview(); void msgRead(int msgcount); - void newMsg(uint8_t path_len, const char* from_name, const char* text, int msgcount); + void newMsg(uint8_t path_len, const char *from_name, const char *text, int msgcount); void soundBuzzer(UIEventType bet = UIEventType::none); void shutdown(bool restart = false); void loop(); -}; -#endif //UI_TASK_H \ No newline at end of file +}; \ No newline at end of file From 73a7a96ae461301ba0419d4211ec82bb3249f75f Mon Sep 17 00:00:00 2001 From: Florent Date: Sat, 31 May 2025 20:29:03 +0200 Subject: [PATCH 10/87] wio_e5 : bme280 support --- variants/wio-e5-mini/platformio.ini | 2 ++ variants/wio-e5-mini/target.cpp | 34 ++++++++++++++++++++++------- variants/wio-e5-mini/target.h | 15 ++++++++++++- 3 files changed, 42 insertions(+), 9 deletions(-) diff --git a/variants/wio-e5-mini/platformio.ini b/variants/wio-e5-mini/platformio.ini index 55ab0bc8..887304ea 100644 --- a/variants/wio-e5-mini/platformio.ini +++ b/variants/wio-e5-mini/platformio.ini @@ -10,6 +10,8 @@ build_flags = ${stm32_base.build_flags} -I variants/wio-e5-mini build_src_filter = ${stm32_base.build_src_filter} +<../variants/wio-e5-mini> +lib_deps = ${stm32_base.lib_deps} + finitespace/BME280 @ ^3.0.0 [env:wio-e5-mini-repeater] extends = lora_e5_mini diff --git a/variants/wio-e5-mini/target.cpp b/variants/wio-e5-mini/target.cpp index 8ccbe384..7a2b0d39 100644 --- a/variants/wio-e5-mini/target.cpp +++ b/variants/wio-e5-mini/target.cpp @@ -18,20 +18,15 @@ static const Module::RfSwitchMode_t rfswitch_table[] = { }; VolatileRTCClock rtc_clock; -SensorManager sensors; +BME280I2C bme; +WIOE5SensorManager sensors(bme); #ifndef LORA_CR #define LORA_CR 5 #endif bool radio_init() { -// rtc_clock.begin(Wire); - -// #ifdef SX126X_DIO3_TCXO_VOLTAGE -// float tcxo = SX126X_DIO3_TCXO_VOLTAGE; -// #else -// float tcxo = 1.6f; -// #endif + Wire.begin(); radio.setRfSwitchTable(rfswitch_pins, rfswitch_table); @@ -71,3 +66,26 @@ mesh::LocalIdentity radio_new_identity() { RadioNoiseListener rng(radio); return mesh::LocalIdentity(&rng); // create new random identity } + +bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) { + if (!has_bme) return false; + + float temp(NAN), hum(NAN), pres(NAN); + + BME280::TempUnit tempUnit(BME280::TempUnit_Celsius); + BME280::PresUnit presUnit(BME280::PresUnit_bar); + + _bme->read(pres, temp, hum, tempUnit, presUnit); + + telemetry.addTemperature(TELEM_CHANNEL_SELF, temp); + telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, hum); + telemetry.addBarometricPressure(TELEM_CHANNEL_SELF, pres); + + return true; +} + +bool WIOE5SensorManager::begin() { + has_bme = _bme->begin(); + + return has_bme; +} \ No newline at end of file diff --git a/variants/wio-e5-mini/target.h b/variants/wio-e5-mini/target.h index f7a882ee..daf7e174 100644 --- a/variants/wio-e5-mini/target.h +++ b/variants/wio-e5-mini/target.h @@ -8,6 +8,9 @@ #include #include +#include +#include + class WIOE5Board : public STM32Board { public: const char* getManufacturerName() const override { @@ -21,10 +24,20 @@ public: } }; +class WIOE5SensorManager : public SensorManager { + BME280I2C* _bme; + bool has_bme = false; + +public: + WIOE5SensorManager(BME280I2C& bme) : _bme(&bme) {} + bool begin() override; + bool querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) override; +}; + extern WIOE5Board board; extern WRAPPER_CLASS radio_driver; extern VolatileRTCClock rtc_clock; -extern SensorManager sensors; +extern WIOE5SensorManager sensors; bool radio_init(); uint32_t radio_get_rng_seed(); From 92c296308a96b79c0e4199d1e9d126e37949c72f Mon Sep 17 00:00:00 2001 From: Florent Date: Sun, 1 Jun 2025 08:30:53 +0200 Subject: [PATCH 11/87] wioe5: integrate sensor in sensor mgr --- src/helpers/stm32/InternalFileSystem.cpp | 7 +++++-- variants/wio-e5-mini/target.cpp | 9 ++++----- variants/wio-e5-mini/target.h | 4 ++-- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/src/helpers/stm32/InternalFileSystem.cpp b/src/helpers/stm32/InternalFileSystem.cpp index 2714ec6b..dc032eb9 100644 --- a/src/helpers/stm32/InternalFileSystem.cpp +++ b/src/helpers/stm32/InternalFileSystem.cpp @@ -126,11 +126,14 @@ InternalFileSystem::InternalFileSystem(void) bool InternalFileSystem::begin(void) { + volatile bool format_fs; #ifdef FORMAT_FS - this->format(); + format_fs = true; + #else + format_fs = false; // you can always use debugger to force formatting ;) #endif // failed to mount, erase all sector then format and mount again - if ( !Adafruit_LittleFS::begin() ) + if ( format_fs || !Adafruit_LittleFS::begin() ) { // lfs format this->format(); diff --git a/variants/wio-e5-mini/target.cpp b/variants/wio-e5-mini/target.cpp index 7a2b0d39..e3dd2ec7 100644 --- a/variants/wio-e5-mini/target.cpp +++ b/variants/wio-e5-mini/target.cpp @@ -18,8 +18,7 @@ static const Module::RfSwitchMode_t rfswitch_table[] = { }; VolatileRTCClock rtc_clock; -BME280I2C bme; -WIOE5SensorManager sensors(bme); +WIOE5SensorManager sensors; #ifndef LORA_CR #define LORA_CR 5 @@ -73,9 +72,9 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& float temp(NAN), hum(NAN), pres(NAN); BME280::TempUnit tempUnit(BME280::TempUnit_Celsius); - BME280::PresUnit presUnit(BME280::PresUnit_bar); + BME280::PresUnit presUnit(BME280::PresUnit_hPa); - _bme->read(pres, temp, hum, tempUnit, presUnit); + bme.read(pres, temp, hum, tempUnit, presUnit); telemetry.addTemperature(TELEM_CHANNEL_SELF, temp); telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, hum); @@ -85,7 +84,7 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& } bool WIOE5SensorManager::begin() { - has_bme = _bme->begin(); + has_bme = bme.begin(); return has_bme; } \ No newline at end of file diff --git a/variants/wio-e5-mini/target.h b/variants/wio-e5-mini/target.h index daf7e174..4b510d56 100644 --- a/variants/wio-e5-mini/target.h +++ b/variants/wio-e5-mini/target.h @@ -25,11 +25,11 @@ public: }; class WIOE5SensorManager : public SensorManager { - BME280I2C* _bme; + BME280I2C bme; bool has_bme = false; public: - WIOE5SensorManager(BME280I2C& bme) : _bme(&bme) {} + WIOE5SensorManager() {} bool begin() override; bool querySensors(uint8_t requester_permissions, CayenneLPP& telemetry) override; }; From 31cbf9ed0e5af4ac70e5a59ea93f79319a685c12 Mon Sep 17 00:00:00 2001 From: Florent Date: Sat, 31 May 2025 10:57:22 +0200 Subject: [PATCH 12/87] gps : sync time on fix --- examples/companion_radio/main.cpp | 2 +- src/helpers/sensors/LocationProvider.h | 6 ++++ .../sensors/MicroNMEALocationProvider.h | 29 +++++++++++++++++-- variants/t1000-e/target.cpp | 21 ++++++++++++-- 4 files changed, 52 insertions(+), 6 deletions(-) diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index 6677d49b..8c822a5c 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -74,7 +74,7 @@ static uint32_t _atoi(const char* sp) { /* GLOBAL OBJECTS */ StdRNG fast_rng; SimpleMeshTables tables; -MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), tables); // TODO: test with 'rtc_clock' in target.cpp +MyMesh the_mesh(radio_driver, fast_rng, rtc_clock, tables); #ifdef DISPLAY_CLASS #include "UITask.h" diff --git a/src/helpers/sensors/LocationProvider.h b/src/helpers/sensors/LocationProvider.h index 056e61e0..f51eea28 100644 --- a/src/helpers/sensors/LocationProvider.h +++ b/src/helpers/sensors/LocationProvider.h @@ -4,13 +4,19 @@ class LocationProvider { +protected: + bool _time_sync_needed = true; public: + virtual void syncTime() { _time_sync_needed = true; } + virtual bool waitingTimeSync() { return _time_sync_needed; } virtual long getLatitude() = 0; virtual long getLongitude() = 0; virtual long getAltitude() = 0; + virtual long satellitesCount() = 0; virtual bool isValid() = 0; virtual long getTimestamp() = 0; + virtual void sendSentence(const char * sentence); virtual void reset(); virtual void begin(); virtual void stop(); diff --git a/src/helpers/sensors/MicroNMEALocationProvider.h b/src/helpers/sensors/MicroNMEALocationProvider.h index 9f439e25..ee6e43eb 100644 --- a/src/helpers/sensors/MicroNMEALocationProvider.h +++ b/src/helpers/sensors/MicroNMEALocationProvider.h @@ -19,13 +19,16 @@ class MicroNMEALocationProvider : public LocationProvider { char _nmeaBuffer[100]; MicroNMEA nmea; + mesh::RTCClock* _clock; Stream* _gps_serial; int _pin_reset; int _pin_en; + long next_check = 0; + long time_valid = 0; public : - MicroNMEALocationProvider(Stream& ser, int pin_reset = GPS_RESET, int pin_en = GPS_EN) : - _gps_serial(&ser), nmea(_nmeaBuffer, sizeof(_nmeaBuffer)), _pin_reset(pin_reset), _pin_en(pin_en) { + MicroNMEALocationProvider(Stream& ser, mesh::RTCClock* clock = &rtc_clock, int pin_reset = GPS_RESET, int pin_en = GPS_EN) : + _gps_serial(&ser), nmea(_nmeaBuffer, sizeof(_nmeaBuffer)), _pin_reset(pin_reset), _pin_en(pin_en), _clock(clock) { if (_pin_reset != -1) { pinMode(_pin_reset, OUTPUT); digitalWrite(_pin_reset, GPS_RESET_FORCE); @@ -59,6 +62,7 @@ public : } } + void syncTime() override { nmea.clear(); LocationProvider::syncTime(); } long getLatitude() override { return nmea.getLatitude(); } long getLongitude() override { return nmea.getLongitude(); } long getAltitude() override { @@ -66,6 +70,7 @@ public : nmea.getAltitude(alt); return alt; } + long satellitesCount() override { return nmea.getNumSatellites(); } bool isValid() override { return nmea.isValid(); } long getTimestamp() override { @@ -73,7 +78,12 @@ public : return dt.unixtime(); } + void sendSentence(const char *sentence) override { + nmea.sendSentence(*_gps_serial, sentence); + } + void loop() override { + while (_gps_serial->available()) { char c = _gps_serial->read(); #ifdef GPS_NMEA_DEBUG @@ -81,5 +91,20 @@ public : #endif nmea.process(c); } + + if (!isValid()) time_valid = 0; + + if (millis() > next_check) { + next_check = millis() + 1000; + if (_time_sync_needed && time_valid > 2) { + if (_clock != NULL) { + rtc_clock.setCurrentTime(getTimestamp()); + _time_sync_needed = false; + } + } + if (isValid()) { + time_valid ++; + } + } } }; \ No newline at end of file diff --git a/variants/t1000-e/target.cpp b/variants/t1000-e/target.cpp index be82ca76..296551e1 100644 --- a/variants/t1000-e/target.cpp +++ b/variants/t1000-e/target.cpp @@ -9,7 +9,7 @@ RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BU WRAPPER_CLASS radio_driver(radio, board); VolatileRTCClock rtc_clock; -MicroNMEALocationProvider nmea = MicroNMEALocationProvider(Serial1); +MicroNMEALocationProvider nmea = MicroNMEALocationProvider(Serial1, &rtc_clock); T1000SensorManager sensors = T1000SensorManager(nmea); #ifdef DISPLAY_CLASS @@ -179,14 +179,26 @@ void T1000SensorManager::loop() { } } -int T1000SensorManager::getNumSettings() const { return 1; } // just one supported: "gps" (power switch) +int T1000SensorManager::getNumSettings() const { return 2; } // just one supported: "gps" (power switch) const char* T1000SensorManager::getSettingName(int i) const { - return i == 0 ? "gps" : NULL; + switch (i) { + case 0: + return "gps"; + break; + case 1: + return "sync"; + break; + default: + return NULL; + break; + } } const char* T1000SensorManager::getSettingValue(int i) const { if (i == 0) { return gps_active ? "1" : "0"; + } else if (i == 1) { + return _nmea->waitingTimeSync() ? "1" : "0"; } return NULL; } @@ -198,6 +210,9 @@ bool T1000SensorManager::setSettingValue(const char* name, const char* value) { start_gps(); } return true; + } else if (strcmp(name, "sync") == 0) { + _nmea->syncTime(); // whatever the value ... + return true; } return false; // not supported } From 49da6957b5ea18f449f2e389f8c3476c2fdfd426 Mon Sep 17 00:00:00 2001 From: Florent Date: Sun, 1 Jun 2025 14:12:22 +0200 Subject: [PATCH 13/87] micronmea: was using global rtc_clock to sync instead of _clock --- src/helpers/sensors/MicroNMEALocationProvider.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/helpers/sensors/MicroNMEALocationProvider.h b/src/helpers/sensors/MicroNMEALocationProvider.h index ee6e43eb..a4a2f5d6 100644 --- a/src/helpers/sensors/MicroNMEALocationProvider.h +++ b/src/helpers/sensors/MicroNMEALocationProvider.h @@ -98,7 +98,7 @@ public : next_check = millis() + 1000; if (_time_sync_needed && time_valid > 2) { if (_clock != NULL) { - rtc_clock.setCurrentTime(getTimestamp()); + _clock.setCurrentTime(getTimestamp()); _time_sync_needed = false; } } From 14cd4ea0104b4be5f0b1a48ba822193bd603f2e8 Mon Sep 17 00:00:00 2001 From: Florent Date: Sun, 1 Jun 2025 15:32:02 +0200 Subject: [PATCH 14/87] t1000: remove sync custom var --- .../sensors/MicroNMEALocationProvider.h | 2 +- variants/t1000-e/target.cpp | 19 ++----------------- 2 files changed, 3 insertions(+), 18 deletions(-) diff --git a/src/helpers/sensors/MicroNMEALocationProvider.h b/src/helpers/sensors/MicroNMEALocationProvider.h index a4a2f5d6..e8b09d9a 100644 --- a/src/helpers/sensors/MicroNMEALocationProvider.h +++ b/src/helpers/sensors/MicroNMEALocationProvider.h @@ -98,7 +98,7 @@ public : next_check = millis() + 1000; if (_time_sync_needed && time_valid > 2) { if (_clock != NULL) { - _clock.setCurrentTime(getTimestamp()); + _clock->setCurrentTime(getTimestamp()); _time_sync_needed = false; } } diff --git a/variants/t1000-e/target.cpp b/variants/t1000-e/target.cpp index 296551e1..29ca1acd 100644 --- a/variants/t1000-e/target.cpp +++ b/variants/t1000-e/target.cpp @@ -179,26 +179,14 @@ void T1000SensorManager::loop() { } } -int T1000SensorManager::getNumSettings() const { return 2; } // just one supported: "gps" (power switch) +int T1000SensorManager::getNumSettings() const { return 1; } // just one supported: "gps" (power switch) const char* T1000SensorManager::getSettingName(int i) const { - switch (i) { - case 0: - return "gps"; - break; - case 1: - return "sync"; - break; - default: - return NULL; - break; - } + return i == 0 ? "gps" : NULL; } const char* T1000SensorManager::getSettingValue(int i) const { if (i == 0) { return gps_active ? "1" : "0"; - } else if (i == 1) { - return _nmea->waitingTimeSync() ? "1" : "0"; } return NULL; } @@ -210,9 +198,6 @@ bool T1000SensorManager::setSettingValue(const char* name, const char* value) { start_gps(); } return true; - } else if (strcmp(name, "sync") == 0) { - _nmea->syncTime(); // whatever the value ... - return true; } return false; // not supported } From 3749264e073a8440a2cf28376f5132915baa3c49 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sun, 1 Jun 2025 23:55:57 +1000 Subject: [PATCH 15/87] * MicroNMEALocationProvider: clock param now NULL by default --- src/helpers/sensors/MicroNMEALocationProvider.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/helpers/sensors/MicroNMEALocationProvider.h b/src/helpers/sensors/MicroNMEALocationProvider.h index e8b09d9a..5a2c59d3 100644 --- a/src/helpers/sensors/MicroNMEALocationProvider.h +++ b/src/helpers/sensors/MicroNMEALocationProvider.h @@ -27,7 +27,7 @@ class MicroNMEALocationProvider : public LocationProvider { long time_valid = 0; public : - MicroNMEALocationProvider(Stream& ser, mesh::RTCClock* clock = &rtc_clock, int pin_reset = GPS_RESET, int pin_en = GPS_EN) : + MicroNMEALocationProvider(Stream& ser, mesh::RTCClock* clock = NULL, int pin_reset = GPS_RESET, int pin_en = GPS_EN) : _gps_serial(&ser), nmea(_nmeaBuffer, sizeof(_nmeaBuffer)), _pin_reset(pin_reset), _pin_en(pin_en), _clock(clock) { if (_pin_reset != -1) { pinMode(_pin_reset, OUTPUT); From 42efbda40a8c7ef334b7745b661066e3f1baae69 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 19:57:35 -0700 Subject: [PATCH 16/87] Re-applying ecd2b0b --- examples/companion_radio/MyMesh.cpp | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index db40169f..f4ee900b 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -545,7 +545,8 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; } - out_frame[i++] = findChannelIdx(channel); + uint8_t channel_idx = findChannelIdx(channel); + out_frame[i++] = channel_idx; uint8_t path_len = out_frame[i++] = pkt->isRouteFlood() ? pkt->path_len : 0xFF; out_frame[i++] = TXT_TYPE_PLAIN; @@ -570,7 +571,13 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe #endif } #ifdef DISPLAY_CLASS - ui_task.newMsg(path_len, "Public", text, offline_queue_len); + // Get the channel name from the channel index + const char *channel_name = "Unknown"; + ChannelDetails channel_details; + if (getChannel(channel_idx, channel_details)) { + channel_name = channel_details.name; + } + ui_task.newMsg(path_len, channel_name, text, offline_queue_len); #endif } From 40bf7bbb9f4536c947d3589914013b81f0979565 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:15:16 -0700 Subject: [PATCH 17/87] Reverting changes to Button code --- examples/companion_radio/Button.cpp | 231 +++++++++++++--------------- examples/companion_radio/Button.h | 112 ++++++++------ 2 files changed, 169 insertions(+), 174 deletions(-) diff --git a/examples/companion_radio/Button.cpp b/examples/companion_radio/Button.cpp index 5de4b702..ec1f0f69 100644 --- a/examples/companion_radio/Button.cpp +++ b/examples/companion_radio/Button.cpp @@ -1,142 +1,125 @@ #include "Button.h" -Button::Button(uint8_t pin, bool activeState) - : _pin(pin), _activeState(activeState), _isAnalog(false), _analogThreshold(20) -{ - _currentState = false; // Initialize as not pressed - _lastState = _currentState; +Button::Button(uint8_t pin, bool activeState) + : _pin(pin), _activeState(activeState), _isAnalog(false), _analogThreshold(20) { + _currentState = false; // Initialize as not pressed + _lastState = _currentState; } Button::Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold) - : _pin(pin), _activeState(activeState), _isAnalog(isAnalog), _analogThreshold(analogThreshold) -{ - _currentState = false; // Initialize as not pressed - _lastState = _currentState; + : _pin(pin), _activeState(activeState), _isAnalog(isAnalog), _analogThreshold(analogThreshold) { + _currentState = false; // Initialize as not pressed + _lastState = _currentState; } -void Button::begin() -{ - _currentState = readButton(); - _lastState = _currentState; +void Button::begin() { + _currentState = readButton(); + _lastState = _currentState; } -void Button::update() -{ - uint32_t now = millis(); - - // Read button at specified interval - if (now - _lastReadTime < BUTTON_READ_INTERVAL_MS) { - return; - } - _lastReadTime = now; - - bool newState = readButton(); - - // Check if state has changed - if (newState != _lastState) { - _stateChangeTime = now; - } - - // Debounce check - if ((now - _stateChangeTime) > BUTTON_DEBOUNCE_TIME_MS) { - if (newState != _currentState) { - _currentState = newState; - handleStateChange(); +void Button::update() { + uint32_t now = millis(); + + // Read button at specified interval + if (now - _lastReadTime < BUTTON_READ_INTERVAL_MS) { + return; } - } - - _lastState = newState; - - // Handle multi-click timeout - if (_state == WAITING_FOR_MULTI_CLICK && (now - _releaseTime) > BUTTON_CLICK_TIMEOUT_MS) { - // Timeout reached, process the clicks - if (_clickCount == 1) { - triggerEvent(SHORT_PRESS); + _lastReadTime = now; + + bool newState = readButton(); + + // Check if state has changed + if (newState != _lastState) { + _stateChangeTime = now; } - else if (_clickCount == 2) { - triggerEvent(DOUBLE_PRESS); + + // Debounce check + if ((now - _stateChangeTime) > BUTTON_DEBOUNCE_TIME_MS) { + if (newState != _currentState) { + _currentState = newState; + handleStateChange(); + } } - else if (_clickCount >= 3) { - triggerEvent(TRIPLE_PRESS); - } - _clickCount = 0; - _state = IDLE; - } - - // Handle long press while button is held - if (_state == PRESSED && (now - _pressTime) > BUTTON_LONG_PRESS_TIME_MS) { - triggerEvent(LONG_PRESS); - _state = IDLE; // Prevent multiple press events - _clickCount = 0; - } -} - -bool Button::readButton() -{ - if (_isAnalog) { - return (analogRead(_pin) < _analogThreshold); - } - else { - return (digitalRead(_pin) == _activeState); - } -} - -void Button::handleStateChange() -{ - uint32_t now = millis(); - - if (_currentState) { - // Button pressed - _pressTime = now; - _state = PRESSED; - triggerEvent(ANY_PRESS); - } - else { - // Button released - if (_state == PRESSED) { - uint32_t pressDuration = now - _pressTime; - - if (pressDuration < BUTTON_LONG_PRESS_TIME_MS) { - // Short press detected - _clickCount++; - _releaseTime = now; - _state = WAITING_FOR_MULTI_CLICK; - } - else { - // Long press already handled in update() - _state = IDLE; + + _lastState = newState; + + // Handle multi-click timeout + if (_state == WAITING_FOR_MULTI_CLICK && (now - _releaseTime) > BUTTON_CLICK_TIMEOUT_MS) { + // Timeout reached, process the clicks + if (_clickCount == 1) { + triggerEvent(SHORT_PRESS); + } else if (_clickCount == 2) { + triggerEvent(DOUBLE_PRESS); + } else if (_clickCount >= 3) { + triggerEvent(TRIPLE_PRESS); + } + _clickCount = 0; + _state = IDLE; + } + + // Handle long press while button is held + if (_state == PRESSED && (now - _pressTime) > BUTTON_LONG_PRESS_TIME_MS) { + triggerEvent(LONG_PRESS); + _state = IDLE; // Prevent multiple press events _clickCount = 0; - } } - } } -void Button::triggerEvent(EventType event) -{ - _lastEvent = event; +bool Button::readButton() { + if (_isAnalog) { + return (analogRead(_pin) < _analogThreshold); + } else { + return (digitalRead(_pin) == _activeState); + } +} - switch (event) { - case ANY_PRESS: - if (_onAnyPress) - _onAnyPress(); - break; - case SHORT_PRESS: - if (_onShortPress) - _onShortPress(); - break; - case DOUBLE_PRESS: - if (_onDoublePress) - _onDoublePress(); - break; - case TRIPLE_PRESS: - if (_onTriplePress) - _onTriplePress(); - break; - case LONG_PRESS: - if (_onLongPress) - _onLongPress(); - break; - default: - break; - } +void Button::handleStateChange() { + uint32_t now = millis(); + + if (_currentState) { + // Button pressed + _pressTime = now; + _state = PRESSED; + triggerEvent(ANY_PRESS); + } else { + // Button released + if (_state == PRESSED) { + uint32_t pressDuration = now - _pressTime; + + if (pressDuration < BUTTON_LONG_PRESS_TIME_MS) { + // Short press detected + _clickCount++; + _releaseTime = now; + _state = WAITING_FOR_MULTI_CLICK; + } else { + // Long press already handled in update() + _state = IDLE; + _clickCount = 0; + } + } + } +} + +void Button::triggerEvent(EventType event) { + _lastEvent = event; + + switch (event) { + case ANY_PRESS: + if (_onAnyPress) _onAnyPress(); + break; + case SHORT_PRESS: + if (_onShortPress) _onShortPress(); + break; + case DOUBLE_PRESS: + if (_onDoublePress) _onDoublePress(); + break; + case TRIPLE_PRESS: + if (_onTriplePress) _onTriplePress(); + break; + case LONG_PRESS: + if (_onLongPress) _onLongPress(); + break; + default: + break; + } } \ No newline at end of file diff --git a/examples/companion_radio/Button.h b/examples/companion_radio/Button.h index 85564593..47c792bd 100644 --- a/examples/companion_radio/Button.h +++ b/examples/companion_radio/Button.h @@ -4,62 +4,74 @@ #include // Button timing configuration -#define BUTTON_DEBOUNCE_TIME_MS 50 // Debounce time in ms -#define BUTTON_CLICK_TIMEOUT_MS 500 // Max time between clicks for multi-click -#define BUTTON_LONG_PRESS_TIME_MS 3000 // Time to trigger long press (3 seconds) -#define BUTTON_READ_INTERVAL_MS 10 // How often to read the button +#define BUTTON_DEBOUNCE_TIME_MS 50 // Debounce time in ms +#define BUTTON_CLICK_TIMEOUT_MS 500 // Max time between clicks for multi-click +#define BUTTON_LONG_PRESS_TIME_MS 3000 // Time to trigger long press (3 seconds) +#define BUTTON_READ_INTERVAL_MS 10 // How often to read the button class Button { public: - enum EventType { NONE, SHORT_PRESS, DOUBLE_PRESS, TRIPLE_PRESS, LONG_PRESS, ANY_PRESS }; + enum EventType { + NONE, + SHORT_PRESS, + DOUBLE_PRESS, + TRIPLE_PRESS, + LONG_PRESS, + ANY_PRESS + }; - using EventCallback = std::function; + using EventCallback = std::function; - Button(uint8_t pin, bool activeState = LOW); - Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold = 20); - - void begin(); - void update(); - - // Set callbacks for different events - void onShortPress(EventCallback callback) { _onShortPress = callback; } - void onDoublePress(EventCallback callback) { _onDoublePress = callback; } - void onTriplePress(EventCallback callback) { _onTriplePress = callback; } - void onLongPress(EventCallback callback) { _onLongPress = callback; } - void onAnyPress(EventCallback callback) { _onAnyPress = callback; } - - // State getters - bool isPressed() const { return _currentState; } - EventType getLastEvent() const { return _lastEvent; } + Button(uint8_t pin, bool activeState = LOW); + Button(uint8_t pin, bool activeState, bool isAnalog, uint16_t analogThreshold = 20); + + void begin(); + void update(); + + // Set callbacks for different events + void onShortPress(EventCallback callback) { _onShortPress = callback; } + void onDoublePress(EventCallback callback) { _onDoublePress = callback; } + void onTriplePress(EventCallback callback) { _onTriplePress = callback; } + void onLongPress(EventCallback callback) { _onLongPress = callback; } + void onAnyPress(EventCallback callback) { _onAnyPress = callback; } + + // State getters + bool isPressed() const { return _currentState; } + EventType getLastEvent() const { return _lastEvent; } private: - enum State { IDLE, PRESSED, RELEASED, WAITING_FOR_MULTI_CLICK }; + enum State { + IDLE, + PRESSED, + RELEASED, + WAITING_FOR_MULTI_CLICK + }; - uint8_t _pin; - bool _activeState; - bool _isAnalog; - uint16_t _analogThreshold; - - State _state = IDLE; - bool _currentState; - bool _lastState; - - uint32_t _stateChangeTime = 0; - uint32_t _pressTime = 0; - uint32_t _releaseTime = 0; - uint32_t _lastReadTime = 0; - - uint8_t _clickCount = 0; - EventType _lastEvent = NONE; - - // Callbacks - EventCallback _onShortPress = nullptr; - EventCallback _onDoublePress = nullptr; - EventCallback _onTriplePress = nullptr; - EventCallback _onLongPress = nullptr; - EventCallback _onAnyPress = nullptr; - - bool readButton(); - void handleStateChange(); - void triggerEvent(EventType event); + uint8_t _pin; + bool _activeState; + bool _isAnalog; + uint16_t _analogThreshold; + + State _state = IDLE; + bool _currentState; + bool _lastState; + + uint32_t _stateChangeTime = 0; + uint32_t _pressTime = 0; + uint32_t _releaseTime = 0; + uint32_t _lastReadTime = 0; + + uint8_t _clickCount = 0; + EventType _lastEvent = NONE; + + // Callbacks + EventCallback _onShortPress = nullptr; + EventCallback _onDoublePress = nullptr; + EventCallback _onTriplePress = nullptr; + EventCallback _onLongPress = nullptr; + EventCallback _onAnyPress = nullptr; + + bool readButton(); + void handleStateChange(); + void triggerEvent(EventType event); }; \ No newline at end of file From 9247ce460a52008943b39f25d3565fdec05384ca Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:16:29 -0700 Subject: [PATCH 18/87] Reverting changes to simple_secure_chat main --- examples/simple_secure_chat/main.cpp | 426 +++++++++++---------------- 1 file changed, 174 insertions(+), 252 deletions(-) diff --git a/examples/simple_secure_chat/main.cpp b/examples/simple_secure_chat/main.cpp index 2440b697..63ff20da 100644 --- a/examples/simple_secure_chat/main.cpp +++ b/examples/simple_secure_chat/main.cpp @@ -1,57 +1,56 @@ -#include // needed for PlatformIO +#include // needed for PlatformIO #include #if defined(NRF52_PLATFORM) -#include + #include #elif defined(RP2040_PLATFORM) -#include + #include #elif defined(ESP32) -#include + #include #endif -#include #include -#include -#include #include +#include +#include +#include #include /* ---------------------------------- CONFIGURATION ------------------------------------- */ -#define FIRMWARE_VER_TEXT "v2 (build: 4 Feb 2025)" +#define FIRMWARE_VER_TEXT "v2 (build: 4 Feb 2025)" #ifndef LORA_FREQ -#define LORA_FREQ 915.0 + #define LORA_FREQ 915.0 #endif #ifndef LORA_BW -#define LORA_BW 250 + #define LORA_BW 250 #endif #ifndef LORA_SF -#define LORA_SF 10 + #define LORA_SF 10 #endif #ifndef LORA_CR -#define LORA_CR 5 + #define LORA_CR 5 #endif #ifndef LORA_TX_POWER -#define LORA_TX_POWER 20 + #define LORA_TX_POWER 20 #endif #ifndef MAX_CONTACTS -#define MAX_CONTACTS 100 + #define MAX_CONTACTS 100 #endif #include -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" // Believe it or not, this std C function is busted on some platforms! -static uint32_t _atoi(const char *sp) -{ +static uint32_t _atoi(const char* sp) { uint32_t n = 0; while (*sp && *sp >= '0' && *sp <= '9') { n *= 10; @@ -62,7 +61,7 @@ static uint32_t _atoi(const char *sp) /* -------------------------------------------------------------------------------------- */ -struct NodePrefs { // persisted to file +struct NodePrefs { // persisted to file float airtime_factor; char node_name[32]; double node_lat, node_lon; @@ -72,35 +71,30 @@ struct NodePrefs { // persisted to file }; class MyMesh : public BaseChatMesh, ContactVisitor { - FILESYSTEM *_fs; + FILESYSTEM* _fs; NodePrefs _prefs; uint32_t expected_ack_crc; - ChannelDetails *_public; + ChannelDetails* _public; unsigned long last_msg_sent; - ContactInfo *curr_recipient; - char command[512 + 10]; + ContactInfo* curr_recipient; + char command[512+10]; uint8_t tmp_buf[256]; char hex_buf[512]; - const char *getTypeName(uint8_t type) const - { - if (type == ADV_TYPE_CHAT) - return "Chat"; - if (type == ADV_TYPE_REPEATER) - return "Repeater"; - if (type == ADV_TYPE_ROOM) - return "Room"; - return "??"; // unknown + const char* getTypeName(uint8_t type) const { + if (type == ADV_TYPE_CHAT) return "Chat"; + if (type == ADV_TYPE_REPEATER) return "Repeater"; + if (type == ADV_TYPE_ROOM) return "Room"; + return "??"; // unknown } - void loadContacts() - { + void loadContacts() { if (_fs->exists("/contacts")) { -#if defined(RP2040_PLATFORM) + #if defined(RP2040_PLATFORM) File file = _fs->open("/contacts", "r"); -#else + #else File file = _fs->open("/contacts"); -#endif + #endif if (file) { bool full = false; while (!full) { @@ -110,31 +104,28 @@ class MyMesh : public BaseChatMesh, ContactVisitor { uint32_t reserved; bool success = (file.read(pub_key, 32) == 32); - success = success && (file.read((uint8_t *)&c.name, 32) == 32); + success = success && (file.read((uint8_t *) &c.name, 32) == 32); success = success && (file.read(&c.type, 1) == 1); success = success && (file.read(&c.flags, 1) == 1); success = success && (file.read(&unused, 1) == 1); - success = success && (file.read((uint8_t *)&reserved, 4) == 4); - success = success && (file.read((uint8_t *)&c.out_path_len, 1) == 1); - success = success && (file.read((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.read((uint8_t *) &reserved, 4) == 4); + success = success && (file.read((uint8_t *) &c.out_path_len, 1) == 1); + success = success && (file.read((uint8_t *) &c.last_advert_timestamp, 4) == 4); success = success && (file.read(c.out_path, 64) == 64); - c.gps_lat = c.gps_lon = 0; // not yet supported + c.gps_lat = c.gps_lon = 0; // not yet supported - if (!success) - break; // EOF + if (!success) break; // EOF c.id = mesh::Identity(pub_key); c.lastmod = 0; - if (!addContact(c)) - full = true; + if (!addContact(c)) full = true; } file.close(); } } } - void saveContacts() - { + void saveContacts() { #if defined(NRF52_PLATFORM) _fs->remove("/contacts"); File file = _fs->open("/contacts", FILE_O_WRITE); @@ -151,50 +142,44 @@ class MyMesh : public BaseChatMesh, ContactVisitor { while (iter.hasNext(this, c)) { bool success = (file.write(c.id.pub_key, 32) == 32); - success = success && (file.write((uint8_t *)&c.name, 32) == 32); + success = success && (file.write((uint8_t *) &c.name, 32) == 32); success = success && (file.write(&c.type, 1) == 1); success = success && (file.write(&c.flags, 1) == 1); success = success && (file.write(&unused, 1) == 1); - success = success && (file.write((uint8_t *)&reserved, 4) == 4); - success = success && (file.write((uint8_t *)&c.out_path_len, 1) == 1); - success = success && (file.write((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.write((uint8_t *) &reserved, 4) == 4); + success = success && (file.write((uint8_t *) &c.out_path_len, 1) == 1); + success = success && (file.write((uint8_t *) &c.last_advert_timestamp, 4) == 4); success = success && (file.write(c.out_path, 64) == 64); - if (!success) - break; // write failed + if (!success) break; // write failed } file.close(); } } - void setClock(uint32_t timestamp) - { + void setClock(uint32_t timestamp) { uint32_t curr = getRTCClock()->getCurrentTime(); if (timestamp > curr) { getRTCClock()->setCurrentTime(timestamp); Serial.println(" (OK - clock set!)"); - } - else { + } else { Serial.println(" (ERR: clock cannot go backwards)"); } } - void importCard(const char *command) - { - while (*command == ' ') - command++; // skip leading spaces + void importCard(const char* command) { + while (*command == ' ') command++; // skip leading spaces if (memcmp(command, "meshcore://", 11) == 0) { - command += 11; // skip the prefix - char *ep = strchr(command, 0); // find end of string + command += 11; // skip the prefix + char *ep = strchr(command, 0); // find end of string while (ep > command) { ep--; - if (mesh::Utils::isHexChar(*ep)) - break; // found tail end of card - *ep = 0; // remove trailing spaces and other junk + if (mesh::Utils::isHexChar(*ep)) break; // found tail end of card + *ep = 0; // remove trailing spaces and other junk } int len = strlen(command); if (len % 2 == 0) { - len >>= 1; // halve, for num bytes + len >>= 1; // halve, for num bytes if (mesh::Utils::fromHex(tmp_buf, len, command)) { importContact(tmp_buf, len); return; @@ -205,112 +190,97 @@ class MyMesh : public BaseChatMesh, ContactVisitor { } protected: - float getAirtimeBudgetFactor() const override { return _prefs.airtime_factor; } - - int calcRxDelay(float score, uint32_t air_time) const override - { - return 0; // disable rxdelay + float getAirtimeBudgetFactor() const override { + return _prefs.airtime_factor; } - bool allowPacketForward(const mesh::Packet *packet) override { return true; } + int calcRxDelay(float score, uint32_t air_time) const override { + return 0; // disable rxdelay + } - void onDiscoveredContact(ContactInfo &contact, bool is_new) override - { + bool allowPacketForward(const mesh::Packet* packet) override { + return true; + } + + void onDiscoveredContact(ContactInfo& contact, bool is_new) override { // TODO: if not in favs, prompt to add as fav(?) Serial.printf("ADVERT from -> %s\n", contact.name); Serial.printf(" type: %s\n", getTypeName(contact.type)); - Serial.print(" public key: "); - mesh::Utils::printHex(Serial, contact.id.pub_key, PUB_KEY_SIZE); - Serial.println(); + Serial.print(" public key: "); mesh::Utils::printHex(Serial, contact.id.pub_key, PUB_KEY_SIZE); Serial.println(); saveContacts(); } - void onContactPathUpdated(const ContactInfo &contact) override - { - Serial.printf("PATH to: %s, path_len=%d\n", contact.name, (int32_t)contact.out_path_len); + void onContactPathUpdated(const ContactInfo& contact) override { + Serial.printf("PATH to: %s, path_len=%d\n", contact.name, (int32_t) contact.out_path_len); saveContacts(); } - bool processAck(const uint8_t *data) override - { - if (memcmp(data, &expected_ack_crc, 4) == 0) { // got an ACK from recipient + bool processAck(const uint8_t *data) override { + if (memcmp(data, &expected_ack_crc, 4) == 0) { // got an ACK from recipient Serial.printf(" Got ACK! (round trip: %d millis)\n", _ms->getMillis() - last_msg_sent); // NOTE: the same ACK can be received multiple times! - expected_ack_crc = 0; // reset our expected hash, now that we have received ACK + expected_ack_crc = 0; // reset our expected hash, now that we have received ACK return true; } - // uint32_t crc; - // memcpy(&crc, data, 4); - // MESH_DEBUG_PRINTLN("unknown ACK received: %08X (expected: %08X)", crc, expected_ack_crc); + //uint32_t crc; + //memcpy(&crc, data, 4); + //MESH_DEBUG_PRINTLN("unknown ACK received: %08X (expected: %08X)", crc, expected_ack_crc); return false; } - void onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) override - { + void onMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { Serial.printf("(%s) MSG -> from %s\n", pkt->isRouteDirect() ? "DIRECT" : "FLOOD", from.name); Serial.printf(" %s\n", text); - if (strcmp(text, "clock sync") == 0) { // special text command + if (strcmp(text, "clock sync") == 0) { // special text command setClock(sender_timestamp + 1); } } - void onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) override - { + void onCommandDataRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) override { } - void onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const uint8_t *sender_prefix, const char *text) override - { + void onSignedMessageRecv(const ContactInfo& from, mesh::Packet* pkt, uint32_t sender_timestamp, const uint8_t *sender_prefix, const char *text) override { } - void onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, - const char *text) override - { + void onChannelMessageRecv(const mesh::GroupChannel& channel, mesh::Packet* pkt, uint32_t timestamp, const char *text) override { if (pkt->isRouteDirect()) { Serial.printf("PUBLIC CHANNEL MSG -> (Direct!)\n"); - } - else { + } else { Serial.printf("PUBLIC CHANNEL MSG -> (Flood) hops %d\n", pkt->path_len); } Serial.printf(" %s\n", text); } - uint8_t onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, - uint8_t len, uint8_t *reply) override - { - return 0; // unknown + uint8_t onContactRequest(const ContactInfo& contact, uint32_t sender_timestamp, const uint8_t* data, uint8_t len, uint8_t* reply) override { + return 0; // unknown } - void onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) override - { + void onContactResponse(const ContactInfo& contact, const uint8_t* data, uint8_t len) override { // not supported } - uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override - { + uint32_t calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const override { return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); } - uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override - { - return SEND_TIMEOUT_BASE_MILLIS + - ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * - (path_len + 1)); + uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override { + return SEND_TIMEOUT_BASE_MILLIS + + ( (pkt_airtime_millis*DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); } - void onSendTimeout() override { Serial.println(" ERROR: timed out, no ACK."); } + void onSendTimeout() override { + Serial.println(" ERROR: timed out, no ACK."); + } public: - MyMesh(mesh::Radio &radio, StdRNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) - : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables) + MyMesh(mesh::Radio& radio, StdRNG& rng, mesh::RTCClock& rtc, SimpleMeshTables& tables) + : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables) { // defaults memset(&_prefs, 0, sizeof(_prefs)); - _prefs.airtime_factor = 2.0; // one third + _prefs.airtime_factor = 2.0; // one third strcpy(_prefs.node_name, "NONAME"); _prefs.freq = LORA_FREQ; _prefs.tx_power_dbm = LORA_TX_POWER; @@ -322,49 +292,45 @@ public: float getFreqPref() const { return _prefs.freq; } uint8_t getTxPowerPref() const { return _prefs.tx_power_dbm; } - void begin(FILESYSTEM &fs) - { + void begin(FILESYSTEM& fs) { _fs = &fs; BaseChatMesh::begin(); -#if defined(NRF52_PLATFORM) + #if defined(NRF52_PLATFORM) IdentityStore store(fs, ""); -#elif defined(RP2040_PLATFORM) + #elif defined(RP2040_PLATFORM) IdentityStore store(fs, "/identity"); store.begin(); -#else + #else IdentityStore store(fs, "/identity"); -#endif - if (!store.load("_main", self_id, _prefs.node_name, - sizeof(_prefs.node_name))) { // legacy: node_name was from identity file + #endif + if (!store.load("_main", self_id, _prefs.node_name, sizeof(_prefs.node_name))) { // legacy: node_name was from identity file // Need way to get some entropy to seed RNG Serial.println("Press ENTER to generate key:"); char c = 0; - while (c != '\n') { // wait for ENTER to be pressed - if (Serial.available()) - c = Serial.read(); + while (c != '\n') { // wait for ENTER to be pressed + if (Serial.available()) c = Serial.read(); } ((StdRNG *)getRNG())->begin(millis()); - self_id = mesh::LocalIdentity(getRNG()); // create new random identity + self_id = mesh::LocalIdentity(getRNG()); // create new random identity int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes - self_id = mesh::LocalIdentity(getRNG()); - count++; + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes + self_id = mesh::LocalIdentity(getRNG()); count++; } store.save("_main", self_id); } // load persisted prefs if (_fs->exists("/node_prefs")) { -#if defined(RP2040_PLATFORM) + #if defined(RP2040_PLATFORM) File file = _fs->open("/node_prefs", "r"); -#else + #else File file = _fs->open("/node_prefs"); -#endif + #endif if (file) { - file.read((uint8_t *)&_prefs, sizeof(_prefs)); + file.read((uint8_t *) &_prefs, sizeof(_prefs)); file.close(); } } @@ -373,8 +339,7 @@ public: _public = addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel } - void savePrefs() - { + void savePrefs() { #if defined(NRF52_PLATFORM) _fs->remove("/node_prefs"); File file = _fs->open("/node_prefs", FILE_O_WRITE); @@ -389,8 +354,7 @@ public: } } - void showWelcome() - { + void showWelcome() { Serial.println("===== MeshCore Chat Terminal ====="); Serial.println(); Serial.printf("WELCOME %s\n", _prefs.node_name); @@ -400,8 +364,7 @@ public: Serial.println(); } - void sendSelfAdvert(int delay_millis) - { + void sendSelfAdvert(int delay_millis) { auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { sendFlood(pkt, delay_millis); @@ -409,8 +372,7 @@ public: } // ContactVisitor - void onContactVisit(const ContactInfo &contact) override - { + void onContactVisit(const ContactInfo& contact) override { Serial.printf(" %s - ", contact.name); char tmp[40]; int32_t secs = contact.last_advert_timestamp - getRTCClock()->getCurrentTime(); @@ -418,159 +380,129 @@ public: Serial.println(tmp); } - void handleCommand(const char *command) - { - while (*command == ' ') - command++; // skip leading spaces + void handleCommand(const char* command) { + while (*command == ' ') command++; // skip leading spaces if (memcmp(command, "send ", 5) == 0) { if (curr_recipient) { const char *text = &command[5]; uint32_t est_timeout; - int result = sendMessage(*curr_recipient, getRTCClock()->getCurrentTime(), 0, text, expected_ack_crc, - est_timeout); + int result = sendMessage(*curr_recipient, getRTCClock()->getCurrentTime(), 0, text, expected_ack_crc, est_timeout); if (result == MSG_SEND_FAILED) { Serial.println(" ERROR: unable to send."); - } - else { + } else { last_msg_sent = _ms->getMillis(); Serial.printf(" (message sent - %s)\n", result == MSG_SEND_SENT_FLOOD ? "FLOOD" : "DIRECT"); } - } - else { + } else { Serial.println(" ERROR: no recipient selected (use 'to' cmd)."); } - } - else if (memcmp(command, "public ", 7) == 0) { // send GroupChannel msg - uint8_t temp[5 + MAX_TEXT_LEN + 32]; + } else if (memcmp(command, "public ", 7) == 0) { // send GroupChannel msg + uint8_t temp[5+MAX_TEXT_LEN+32]; uint32_t timestamp = getRTCClock()->getCurrentTime(); - memcpy(temp, ×tamp, 4); // mostly an extra blob to help make packet_hash unique - temp[4] = 0; // attempt and flags + memcpy(temp, ×tamp, 4); // mostly an extra blob to help make packet_hash unique + temp[4] = 0; // attempt and flags - sprintf((char *)&temp[5], "%s: %s", _prefs.node_name, &command[7]); // : - temp[5 + MAX_TEXT_LEN] = 0; // truncate if too long + sprintf((char *) &temp[5], "%s: %s", _prefs.node_name, &command[7]); // : + temp[5 + MAX_TEXT_LEN] = 0; // truncate if too long - int len = strlen((char *)&temp[5]); + int len = strlen((char *) &temp[5]); auto pkt = createGroupDatagram(PAYLOAD_TYPE_GRP_TXT, _public->channel, temp, 5 + len); if (pkt) { sendFlood(pkt); Serial.println(" Sent."); - } - else { + } else { Serial.println(" ERROR: unable to send"); } - } - else if (memcmp(command, "list", 4) == 0) { // show Contact list, by most recent + } else if (memcmp(command, "list", 4) == 0) { // show Contact list, by most recent int n = 0; - if (command[4] == ' ') { // optional param, last 'N' + if (command[4] == ' ') { // optional param, last 'N' n = atoi(&command[5]); } scanRecentContacts(n, this); - } - else if (strcmp(command, "clock") == 0) { // show current time + } else if (strcmp(command, "clock") == 0) { // show current time uint32_t now = getRTCClock()->getCurrentTime(); DateTime dt = DateTime(now); - Serial.printf("%02d:%02d - %d/%d/%d UTC\n", dt.hour(), dt.minute(), dt.day(), dt.month(), dt.year()); - } - else if (memcmp(command, "time ", 5) == 0) { // set time (to epoch seconds) + Serial.printf( "%02d:%02d - %d/%d/%d UTC\n", dt.hour(), dt.minute(), dt.day(), dt.month(), dt.year()); + } else if (memcmp(command, "time ", 5) == 0) { // set time (to epoch seconds) uint32_t secs = _atoi(&command[5]); setClock(secs); - } - else if (memcmp(command, "to ", 3) == 0) { // set current recipient + } else if (memcmp(command, "to ", 3) == 0) { // set current recipient curr_recipient = searchContactsByPrefix(&command[3]); if (curr_recipient) { Serial.printf(" Recipient %s now selected.\n", curr_recipient->name); - } - else { + } else { Serial.println(" Error: Name prefix not found."); } - } - else if (strcmp(command, "to") == 0) { // show current recipient + } else if (strcmp(command, "to") == 0) { // show current recipient if (curr_recipient) { - Serial.printf(" Current: %s\n", curr_recipient->name); + Serial.printf(" Current: %s\n", curr_recipient->name); + } else { + Serial.println(" Err: no recipient selected"); } - else { - Serial.println(" Err: no recipient selected"); - } - } - else if (strcmp(command, "advert") == 0) { + } else if (strcmp(command, "advert") == 0) { auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { sendZeroHop(pkt); Serial.println(" (advert sent, zero hop)."); - } - else { + } else { Serial.println(" ERR: unable to send"); } - } - else if (strcmp(command, "reset path") == 0) { + } else if (strcmp(command, "reset path") == 0) { if (curr_recipient) { resetPathTo(*curr_recipient); saveContacts(); Serial.println(" Done."); } - } - else if (memcmp(command, "card", 4) == 0) { + } else if (memcmp(command, "card", 4) == 0) { Serial.printf("Hello %s\n", _prefs.node_name); auto pkt = createSelfAdvert(_prefs.node_name, _prefs.node_lat, _prefs.node_lon); if (pkt) { - uint8_t len = pkt->writeTo(tmp_buf); - releasePacket(pkt); // undo the obtainNewPacket() + uint8_t len = pkt->writeTo(tmp_buf); + releasePacket(pkt); // undo the obtainNewPacket() mesh::Utils::toHex(hex_buf, tmp_buf, len); Serial.println("Your MeshCore biz card:"); - Serial.print("meshcore://"); - Serial.println(hex_buf); + Serial.print("meshcore://"); Serial.println(hex_buf); Serial.println(); - } - else { + } else { Serial.println(" Error"); } - } - else if (memcmp(command, "import ", 7) == 0) { + } else if (memcmp(command, "import ", 7) == 0) { importCard(&command[7]); - } - else if (memcmp(command, "set ", 4) == 0) { - const char *config = &command[4]; + } else if (memcmp(command, "set ", 4) == 0) { + const char* config = &command[4]; if (memcmp(config, "af ", 3) == 0) { _prefs.airtime_factor = atof(&config[3]); savePrefs(); Serial.println(" OK"); - } - else if (memcmp(config, "name ", 5) == 0) { + } else if (memcmp(config, "name ", 5) == 0) { StrHelper::strncpy(_prefs.node_name, &config[5], sizeof(_prefs.node_name)); savePrefs(); Serial.println(" OK"); - } - else if (memcmp(config, "lat ", 4) == 0) { + } else if (memcmp(config, "lat ", 4) == 0) { _prefs.node_lat = atof(&config[4]); savePrefs(); Serial.println(" OK"); - } - else if (memcmp(config, "lon ", 4) == 0) { + } else if (memcmp(config, "lon ", 4) == 0) { _prefs.node_lon = atof(&config[4]); savePrefs(); Serial.println(" OK"); - } - else if (memcmp(config, "tx ", 3) == 0) { + } else if (memcmp(config, "tx ", 3) == 0) { _prefs.tx_power_dbm = atoi(&config[3]); savePrefs(); Serial.println(" OK - reboot to apply"); - } - else if (memcmp(config, "freq ", 5) == 0) { + } else if (memcmp(config, "freq ", 5) == 0) { _prefs.freq = atof(&config[5]); savePrefs(); Serial.println(" OK - reboot to apply"); - } - else { + } else { Serial.printf(" ERROR: unknown config: %s\n", config); } - } - else if (memcmp(command, "ver", 3) == 0) { + } else if (memcmp(command, "ver", 3) == 0) { Serial.println(FIRMWARE_VER_TEXT); - } - else if (memcmp(command, "help", 4) == 0) { + } else if (memcmp(command, "help", 4) == 0) { Serial.println("Commands:"); Serial.println(" set {name|lat|lon|freq|tx|af} {value}"); Serial.println(" card"); @@ -584,59 +516,50 @@ public: Serial.println(" advert"); Serial.println(" reset path"); Serial.println(" public "); - } - else { - Serial.print(" ERROR: unknown command: "); - Serial.println(command); + } else { + Serial.print(" ERROR: unknown command: "); Serial.println(command); } } - void loop() - { + void loop() { BaseChatMesh::loop(); int len = strlen(command); - while (Serial.available() && len < sizeof(command) - 1) { + while (Serial.available() && len < sizeof(command)-1) { char c = Serial.read(); - if (c != '\n') { + if (c != '\n') { command[len++] = c; command[len] = 0; } Serial.print(c); } - if (len == sizeof(command) - 1) { // command buffer full - command[sizeof(command) - 1] = '\r'; + if (len == sizeof(command)-1) { // command buffer full + command[sizeof(command)-1] = '\r'; } - if (len > 0 && command[len - 1] == '\r') { // received complete line - command[len - 1] = 0; // replace newline with C string null terminator + if (len > 0 && command[len - 1] == '\r') { // received complete line + command[len - 1] = 0; // replace newline with C string null terminator handleCommand(command); - command[0] = 0; // reset command buffer + command[0] = 0; // reset command buffer } } }; StdRNG fast_rng; SimpleMeshTables tables; -MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), - tables); // TODO: test with 'rtc_clock' in target.cpp +MyMesh the_mesh(radio_driver, fast_rng, *new VolatileRTCClock(), tables); // TODO: test with 'rtc_clock' in target.cpp -void halt() -{ - while (1) - ; +void halt() { + while (1) ; } -void setup() -{ +void setup() { Serial.begin(115200); board.begin(); - if (!radio_init()) { - halt(); - } + if (!radio_init()) { halt(); } fast_rng.begin(radio_get_rng_seed()); @@ -650,7 +573,7 @@ void setup() SPIFFS.begin(true); the_mesh.begin(SPIFFS); #else -#error "need to define filesystem" + #error "need to define filesystem" #endif radio_set_params(the_mesh.getFreqPref(), LORA_BW, LORA_SF, LORA_CR); @@ -659,10 +582,9 @@ void setup() the_mesh.showWelcome(); // send out initial Advertisement to the mesh - the_mesh.sendSelfAdvert(1200); // add slight delay + the_mesh.sendSelfAdvert(1200); // add slight delay } -void loop() -{ +void loop() { the_mesh.loop(); } From 69b431a517b99cc425521ad2840f938407c5658a Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:28:29 -0700 Subject: [PATCH 19/87] Re-applying 73a7a96, formatting, MyMesh reformat --- .clang-format | 4 +- examples/companion_radio/MyMesh.cpp | 504 ++++++++++------------------ variants/wio-e5-mini/target.cpp | 9 +- 3 files changed, 177 insertions(+), 340 deletions(-) diff --git a/.clang-format b/.clang-format index 80c7a10a..66ecd43a 100644 --- a/.clang-format +++ b/.clang-format @@ -14,7 +14,7 @@ AllowAllParametersOfDeclarationOnNextLine: false AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: Inline -AllowShortIfStatementsOnASingleLine: false +AllowShortIfStatementsOnASingleLine: true AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None @@ -35,7 +35,7 @@ BraceWrapping: BeforeElse: true IndentBraces: false BreakBeforeBinaryOperators: None -BreakBeforeBraces: Stroustrup +BreakBeforeBraces: Attach BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false ColumnLimit: 110 diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 1988c367..e53022f6 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -72,8 +72,7 @@ #include "UITask.h" #endif -void MyMesh::loadMainIdentity() -{ +void MyMesh::loadMainIdentity() { if (!_identity_store->load("_main", self_id)) { self_id = radio_new_identity(); // create new random identity int count = 0; @@ -85,13 +84,11 @@ void MyMesh::loadMainIdentity() } } -bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) -{ +bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) { return _identity_store->save("_main", identity); } -void MyMesh::loadContacts() -{ +void MyMesh::loadContacts() { if (_fs->exists("/contacts3")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/contacts3", "r"); @@ -118,20 +115,17 @@ void MyMesh::loadContacts() success = success && (file.read((uint8_t *)&c.gps_lat, 4) == 4); success = success && (file.read((uint8_t *)&c.gps_lon, 4) == 4); - if (!success) - break; // EOF + if (!success) break; // EOF c.id = mesh::Identity(pub_key); - if (!addContact(c)) - full = true; + if (!addContact(c)) full = true; } file.close(); } } } -void MyMesh::saveContacts() -{ +void MyMesh::saveContacts() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/contacts3"); File file = _fs->open("/contacts3", FILE_O_WRITE); @@ -159,15 +153,13 @@ void MyMesh::saveContacts() success = success && (file.write((uint8_t *)&c.gps_lat, 4) == 4); success = success && (file.write((uint8_t *)&c.gps_lon, 4) == 4); - if (!success) - break; // write failed + if (!success) break; // write failed } file.close(); } } -void MyMesh::loadChannels() -{ +void MyMesh::loadChannels() { if (_fs->exists("/channels2")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/channels2", "r"); @@ -185,13 +177,11 @@ void MyMesh::loadChannels() success = success && (file.read((uint8_t *)ch.name, 32) == 32); success = success && (file.read((uint8_t *)ch.channel.secret, 32) == 32); - if (!success) - break; // EOF + if (!success) break; // EOF if (setChannel(channel_idx, ch)) { channel_idx++; - } - else { + } else { full = true; } } @@ -200,8 +190,7 @@ void MyMesh::loadChannels() } } -void MyMesh::saveChannels() -{ +void MyMesh::saveChannels() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/channels2"); File file = _fs->open("/channels2", FILE_O_WRITE); @@ -221,21 +210,18 @@ void MyMesh::saveChannels() success = success && (file.write((uint8_t *)ch.name, 32) == 32); success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); - if (!success) - break; // write failed + if (!success) break; // write failed channel_idx++; } file.close(); } } -int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) -{ +int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { char path[64]; char fname[18]; - if (key_len > 8) - key_len = 8; // just use first 8 bytes (prefix) + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); @@ -254,13 +240,11 @@ int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) return 0; // not found } -bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) -{ +bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) { char path[64]; char fname[18]; - if (key_len > 8) - key_len = 8; // just use first 8 bytes (prefix) + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); @@ -275,37 +259,32 @@ bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_bu if (f) { int n = f.write(src_buf, len); f.close(); - if (n == len) - return true; // success! + if (n == len) return true; // success! _fs->remove(path); // blob was only partially written! } return false; // error } -void MyMesh::writeOKFrame() -{ +void MyMesh::writeOKFrame() { uint8_t buf[1]; buf[0] = RESP_CODE_OK; _serial->writeFrame(buf, 1); } -void MyMesh::writeErrFrame(uint8_t err_code) -{ +void MyMesh::writeErrFrame(uint8_t err_code) { uint8_t buf[2]; buf[0] = RESP_CODE_ERR; buf[1] = err_code; _serial->writeFrame(buf, 2); } -void MyMesh::writeDisabledFrame() -{ +void MyMesh::writeDisabledFrame() { uint8_t buf[1]; buf[0] = RESP_CODE_DISABLED; _serial->writeFrame(buf, 1); } -void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) -{ +void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) { int i = 0; out_frame[i++] = code; memcpy(&out_frame[i], contact.id.pub_key, PUB_KEY_SIZE); @@ -328,8 +307,7 @@ void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) _serial->writeFrame(out_frame, i); } -void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len) -{ +void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len) { int i = 0; uint8_t code = frame[i++]; // eg. CMD_ADD_UPDATE_CONTACT memcpy(contact.id.pub_key, &frame[i], PUB_KEY_SIZE); @@ -351,19 +329,16 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, } } -void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) -{ +void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) { if (offline_queue_len >= OFFLINE_QUEUE_SIZE) { MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); - } - else { + } else { offline_queue[offline_queue_len].len = len; memcpy(offline_queue[offline_queue_len].buf, frame, len); offline_queue_len++; } } -int MyMesh::getFromOfflineQueue(uint8_t frame[]) -{ +int MyMesh::getFromOfflineQueue(uint8_t frame[]) { if (offline_queue_len > 0) { // check offline queue size_t len = offline_queue[0].len; // take from top of queue memcpy(frame, offline_queue[0].buf, len); @@ -377,25 +352,20 @@ int MyMesh::getFromOfflineQueue(uint8_t frame[]) return 0; // queue is empty } -float MyMesh::getAirtimeBudgetFactor() const -{ +float MyMesh::getAirtimeBudgetFactor() const { return _prefs.airtime_factor; } -int MyMesh::getInterferenceThreshold() const -{ +int MyMesh::getInterferenceThreshold() const { return 0; // disabled for now, until currentRSSI() problem is resolved } -int MyMesh::calcRxDelay(float score, uint32_t air_time) const -{ - if (_prefs.rx_delay_base <= 0.0f) - return 0; +int MyMesh::calcRxDelay(float score, uint32_t air_time) const { + if (_prefs.rx_delay_base <= 0.0f) return 0; return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time); } -void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) -{ +void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) { if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) { int i = 0; out_frame[i++] = PUSH_CODE_LOG_RX_DATA; @@ -408,24 +378,20 @@ void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) } } -bool MyMesh::isAutoAddEnabled() const -{ +bool MyMesh::isAutoAddEnabled() const { return (_prefs.manual_add_contacts & 1) == 0; } -void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) -{ +void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { if (_serial->isConnected()) { if (!isAutoAddEnabled() && is_new) { writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); - } - else { + } else { out_frame[0] = PUSH_CODE_ADVERT; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); } - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::newContactMessage); #endif @@ -434,8 +400,7 @@ void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } -void MyMesh::onContactPathUpdated(const ContactInfo &contact) -{ +void MyMesh::onContactPathUpdated(const ContactInfo &contact) { out_frame[0] = PUSH_CODE_PATH_UPDATED; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected @@ -443,8 +408,7 @@ void MyMesh::onContactPathUpdated(const ContactInfo &contact) dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } -bool MyMesh::processAck(const uint8_t *data) -{ +bool MyMesh::processAck(const uint8_t *data) { // see if matches any in a table for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) { if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient @@ -463,16 +427,14 @@ bool MyMesh::processAck(const uint8_t *data) } void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, - uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) -{ + uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) { int i = 0; if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 - } - else { + } else { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; } memcpy(&out_frame[i], from.id.pub_key, 6); @@ -497,8 +459,7 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::contactMessage); #endif @@ -509,22 +470,19 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe } void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) -{ + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); } void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) -{ + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); } void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const uint8_t *sender_prefix, const char *text) -{ + const uint8_t *sender_prefix, const char *text) { markConnectionActive(from); // from.sync_since change needs to be persisted dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); @@ -532,16 +490,14 @@ void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uin } void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, - const char *text) -{ + const char *text) { int i = 0; if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 - } - else { + } else { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; } @@ -564,8 +520,7 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::channelMessage); #endif @@ -582,30 +537,26 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe } uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, - uint8_t len, uint8_t *reply) -{ + uint8_t len, uint8_t *reply) { if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) { uint8_t permissions = 0; uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) { permissions = TELEM_PERM_BASE; - } - else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { permissions = cp & TELEM_PERM_BASE; } if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_LOCATION; - } - else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_LOCATION; } if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_ENVIRONMENT; - } - else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_ENVIRONMENT; } @@ -626,8 +577,7 @@ uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_tim return 0; // unknown } -void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) -{ +void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) { uint32_t tag; memcpy(&tag, data, 4); @@ -640,9 +590,8 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; out_frame[i++] = 0; // legacy: is_admin = false memcpy(&out_frame[i], contact.id.pub_key, 6); - i += 6; // pub_key_prefix - } - else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response + i += 6; // pub_key_prefix + } else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; if (keep_alive_secs > 0) { startConnection(contact, keep_alive_secs); @@ -653,19 +602,17 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, i += 6; // pub_key_prefix memcpy(&out_frame[i], &tag, 4); i += 4; // NEW: include server timestamp - } - else { + } else { out_frame[i++] = PUSH_CODE_LOGIN_FAIL; out_frame[i++] = 0; // reserved memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix } _serial->writeFrame(out_frame, i); - } - else if (len > 4 && // check for status response - pending_status && - memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme - // FUTURE: tag == pending_status + } else if (len > 4 && // check for status response + pending_status && + memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme + // FUTURE: tag == pending_status ) { pending_status = 0; @@ -677,8 +624,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, memcpy(&out_frame[i], &data[4], len - 4); i += (len - 4); _serial->writeFrame(out_frame, i); - } - else if (len > 4 && tag == pending_telemetry) { // check for telemetry response + } else if (len > 4 && tag == pending_telemetry) { // check for telemetry response pending_telemetry = 0; int i = 0; @@ -692,8 +638,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, } } -void MyMesh::onRawDataRecv(mesh::Packet *packet) -{ +void MyMesh::onRawDataRecv(mesh::Packet *packet) { if (packet->payload_len + 4 > sizeof(out_frame)) { MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); return; @@ -708,15 +653,13 @@ void MyMesh::onRawDataRecv(mesh::Packet *packet) if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); - } - else { + } else { MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); } } void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, - const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) -{ + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) { int i = 0; out_frame[i++] = PUSH_CODE_TRACE_DATA; out_frame[i++] = 0; // reserved @@ -734,18 +677,15 @@ void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); - } - else { + } else { MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); } } -uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const -{ +uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const { return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); } -uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const -{ +uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const { return SEND_TIMEOUT_BASE_MILLIS + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); @@ -755,8 +695,7 @@ void MyMesh::onSendTimeout() {} MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), - _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) -{ + _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { _iter_started = false; offline_queue_len = 0; app_target_ver = 0; @@ -778,8 +717,7 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe //_prefs.rx_delay_base = 10.0f; enable once new algo fixed } -void MyMesh::loadPrefsInt(const char *filename) -{ +void MyMesh::loadPrefsInt(const char *filename) { #if defined(RP2040_PLATFORM) File file = _fs->open(filename, "r"); #else @@ -820,8 +758,7 @@ void MyMesh::loadPrefsInt(const char *filename) } } -void MyMesh::begin(FILESYSTEM &fs, bool has_display) -{ +void MyMesh::begin(FILESYSTEM &fs, bool has_display) { _fs = &fs; BaseChatMesh::begin(); @@ -850,8 +787,7 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) // load persisted prefs if (_fs->exists("/new_prefs")) { loadPrefsInt("/new_prefs"); // new filename - } - else if (_fs->exists("/node_prefs")) { + } else if (_fs->exists("/node_prefs")) { loadPrefsInt("/node_prefs"); savePrefs(); // save to new filename _fs->remove("/node_prefs"); // remove old @@ -863,15 +799,13 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) if (has_display) { StdRNG rng; _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session - } - else { + } else { _active_ble_pin = BLE_PIN_CODE; // otherwise static pin } #else _active_ble_pin = BLE_PIN_CODE; // otherwise static pin #endif - } - else { + } else { _active_ble_pin = _prefs.ble_pin; } #else @@ -889,27 +823,22 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) radio_set_tx_power(_prefs.tx_power_dbm); } -const char *MyMesh::getNodeName() -{ +const char *MyMesh::getNodeName() { return _prefs.node_name; } -NodePrefs *MyMesh::getNodePrefs() -{ +NodePrefs *MyMesh::getNodePrefs() { return &_prefs; } -uint32_t MyMesh::getBLEPin() -{ +uint32_t MyMesh::getBLEPin() { return _active_ble_pin; } -void MyMesh::startInterface(BaseSerialInterface &serial) -{ +void MyMesh::startInterface(BaseSerialInterface &serial) { _serial = &serial; serial.enable(); } -void MyMesh::savePrefs() -{ +void MyMesh::savePrefs() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/new_prefs"); File file = _fs->open("/new_prefs", FILE_O_WRITE); @@ -945,8 +874,7 @@ void MyMesh::savePrefs() } } -void MyMesh::handleCmdFrame(size_t len) -{ +void MyMesh::handleCmdFrame(size_t len) { if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection app_target_ver = cmd_frame[1]; // which version of protocol does app understand @@ -965,9 +893,8 @@ void MyMesh::handleCmdFrame(size_t len) StrHelper::strzcpy((char *)&out_frame[i], FIRMWARE_VERSION, 20); i += 20; _serial->writeFrame(out_frame, i); - } - else if (cmd_frame[0] == CMD_APP_START && - len >= 8) { // sent when app establishes connection, respond with node ID + } else if (cmd_frame[0] == CMD_APP_START && + len >= 8) { // sent when app establishes connection, respond with node ID // cmd_frame[1..7] reserved future char *app_name = (char *)&cmd_frame[8]; cmd_frame[len] = 0; // make app_name null terminated @@ -1008,8 +935,7 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[i], _prefs.node_name, tlen); i += tlen; _serial->writeFrame(out_frame, i); - } - else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { + } else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { int i = 1; uint8_t txt_type = cmd_frame[i++]; uint8_t attempt = cmd_frame[i++]; @@ -1029,15 +955,13 @@ void MyMesh::handleCmdFrame(size_t len) if (txt_type == TXT_TYPE_CLI_DATA) { result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); expected_ack = 0; // no Ack expected - } - else { + } else { result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); } // TODO: add expected ACK to table if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { if (expected_ack) { expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table expected_ack_table[next_ack_idx].ack = expected_ack; @@ -1050,14 +974,12 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* } - } - else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg + } else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg int i = 1; uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN uint8_t channel_idx = cmd_frame[i++]; @@ -1068,27 +990,22 @@ void MyMesh::handleCmdFrame(size_t len) if (txt_type != TXT_TYPE_PLAIN) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); - } - else { + } else { ChannelDetails channel; bool success = getChannel(channel_idx, channel); if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } - } - else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list + } else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list if (_iter_started) { writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy - } - else { + } else { if (len >= 5) { // has optional 'since' param memcpy(&_iter_filter_since, &cmd_frame[1], 4); - } - else { + } else { _iter_filter_since = 0; } @@ -1103,17 +1020,14 @@ void MyMesh::handleCmdFrame(size_t len) _iter_started = true; _most_recent_lastmod = 0; } - } - else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { + } else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { int nlen = len - 1; - if (nlen > sizeof(_prefs.node_name) - 1) - nlen = sizeof(_prefs.node_name) - 1; // max len + if (nlen > sizeof(_prefs.node_name) - 1) nlen = sizeof(_prefs.node_name) - 1; // max len memcpy(_prefs.node_name, &cmd_frame[1], nlen); _prefs.node_name[nlen] = 0; // null terminator savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { + } else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { int32_t lat, lon, alt = 0; memcpy(&lat, &cmd_frame[1], 4); memcpy(&lon, &cmd_frame[5], 4); @@ -1125,46 +1039,38 @@ void MyMesh::handleCmdFrame(size_t len) sensors.node_lon = ((double)lon) / 1000000.0; savePrefs(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate } - } - else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { + } else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { uint8_t reply[5]; reply[0] = RESP_CODE_CURR_TIME; uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply[1], &now, 4); _serial->writeFrame(reply, 5); - } - else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { + } else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { uint32_t secs; memcpy(&secs, &cmd_frame[1], 4); uint32_t curr = getRTCClock()->getCurrentTime(); if (secs >= curr) { getRTCClock()->setCurrentTime(secs); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { + } else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); if (pkt) { if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop) sendFlood(pkt); - } - else { + } else { sendZeroHop(pkt); } writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { + } else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1172,12 +1078,10 @@ void MyMesh::handleCmdFrame(size_t len) // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact } - } - else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { + } else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1185,8 +1089,7 @@ void MyMesh::handleCmdFrame(size_t len) // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { ContactInfo contact; updateContactFromFrame(contact, cmd_frame, len); contact.lastmod = getRTCClock()->getCurrentTime(); @@ -1194,49 +1097,40 @@ void MyMesh::handleCmdFrame(size_t len) if (addContact(contact)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - } - else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { + } else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient && removeContact(*recipient)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove } - } - else if (cmd_frame[0] == CMD_SHARE_CONTACT) { + } else if (cmd_frame[0] == CMD_SHARE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { if (shareContactZeroHop(*recipient)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { + } else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (contact) { writeContactRespFrame(RESP_CODE_CONTACT, *contact); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } - } - else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { + } else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { if (len < 1 + PUB_KEY_SIZE) { // export SELF auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); @@ -1247,46 +1141,38 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t out_len = pkt->writeTo(&out_frame[1]); releasePacket(pkt); // undo the obtainNewPacket() _serial->writeFrame(out_frame, out_len + 1); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); // Error } - } - else { + } else { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); uint8_t out_len; if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) { out_frame[0] = RESP_CODE_EXPORT_CONTACT; _serial->writeFrame(out_frame, out_len + 1); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } - } - else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { + } else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { if (importContact(&cmd_frame[1], len - 1)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { + } else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { int out_len; if ((out_len = getFromOfflineQueue(out_frame)) > 0) { _serial->writeFrame(out_frame, out_len); #ifdef DISPLAY_CLASS ui_task.msgRead(offline_queue_len); #endif - } - else { + } else { out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; _serial->writeFrame(out_frame, 1); } - } - else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { int i = 1; uint32_t freq; memcpy(&freq, &cmd_frame[i], 4); @@ -1310,25 +1196,21 @@ void MyMesh::handleCmdFrame(size_t len) (uint32_t)cr); writeOKFrame(); - } - else { + } else { MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { + } else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { if (cmd_frame[1] > MAX_LORA_TX_POWER) { writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - else { + } else { _prefs.tx_power_dbm = cmd_frame[1]; savePrefs(); radio_set_tx_power(_prefs.tx_power_dbm); writeOKFrame(); } - } - else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { int i = 1; uint32_t rx, af; memcpy(&rx, &cmd_frame[i], 4); @@ -1339,8 +1221,7 @@ void MyMesh::handleCmdFrame(size_t len) _prefs.airtime_factor = ((float)af) / 1000.0f; savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { _prefs.manual_add_contacts = cmd_frame[1]; if (len >= 3) { _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ @@ -1349,21 +1230,18 @@ void MyMesh::handleCmdFrame(size_t len) } savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { + } else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed? saveContacts(); } board.reboot(); - } - else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { + } else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { uint8_t reply[3]; reply[0] = RESP_CODE_BATTERY_VOLTAGE; uint16_t battery_millivolts = board.getBattMilliVolts(); memcpy(&reply[1], &battery_millivolts, 2); _serial->writeFrame(reply, 3); - } - else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { + } else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { #if ENABLE_PRIVATE_KEY_EXPORT uint8_t reply[65]; reply[0] = RESP_CODE_PRIVATE_KEY; @@ -1372,23 +1250,20 @@ void MyMesh::handleCmdFrame(size_t len) #else writeDisabledFrame(); #endif - } - else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { + } else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { #if ENABLE_PRIVATE_KEY_IMPORT mesh::LocalIdentity identity; identity.readFrom(&cmd_frame[1], 64); if (saveMainIdentity(identity)) { self_id = identity; writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_FILE_IO_ERROR); } #else writeDisabledFrame(); #endif - } - else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { + } else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { int i = 1; int8_t path_len = cmd_frame[i++]; if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload @@ -1398,16 +1273,13 @@ void MyMesh::handleCmdFrame(size_t len) if (pkt) { sendDirect(pkt, path, path_len); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else { + } else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) } - } - else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE]; @@ -1417,8 +1289,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendLogin(*recipient, password, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_telemetry = pending_status = 0; memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1427,12 +1298,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1440,8 +1309,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_telemetry = pending_login = 0; // FUTURE: pending_status = tag; // match this in onContactResponse() memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme @@ -1451,12 +1319,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[4]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1464,8 +1330,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_status = pending_login = 0; pending_telemetry = tag; // match this in onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1474,26 +1339,21 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; if (hasConnectionTo(pub_key)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; stopConnection(pub_key); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { + } else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; if (getChannel(channel_idx, channel)) { @@ -1505,15 +1365,12 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[i], channel.channel.secret, 16); i += 16; // NOTE: only 128-bit supported _serial->writeFrame(out_frame, i); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { + } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) - } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { + } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32); @@ -1522,12 +1379,10 @@ void MyMesh::handleCmdFrame(size_t len) if (setChannel(channel_idx, channel)) { saveChannels(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } - } - else if (cmd_frame[0] == CMD_SIGN_START) { + } else if (cmd_frame[0] == CMD_SIGN_START) { out_frame[0] = RESP_CODE_SIGN_START; out_frame[1] = 0; // reserved uint32_t len = MAX_SIGN_DATA_LEN; @@ -1539,18 +1394,15 @@ void MyMesh::handleCmdFrame(size_t len) } sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN); sign_data_len = 0; - } - else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { + } else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) { writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long - } - else { + } else { memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); sign_data_len += (len - 1); writeOKFrame(); } - } - else if (cmd_frame[0] == CMD_SIGN_FINISH) { + } else if (cmd_frame[0] == CMD_SIGN_FINISH) { if (sign_data) { self_id.sign(&out_frame[1], sign_data, sign_data_len); @@ -1559,12 +1411,10 @@ void MyMesh::handleCmdFrame(size_t len) out_frame[0] = RESP_CODE_SIGNATURE; _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); - } - else { + } else { writeErrFrame(ERR_CODE_BAD_STATE); } - } - else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { uint32_t tag, auth; memcpy(&tag, &cmd_frame[1], 4); memcpy(&auth, &cmd_frame[5], 4); @@ -1581,12 +1431,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[2], &tag, 4); memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { + } else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { // get pin from command frame uint32_t pin; @@ -1597,12 +1445,10 @@ void MyMesh::handleCmdFrame(size_t len) _prefs.ble_pin = pin; savePrefs(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { + } else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { out_frame[0] = RESP_CODE_CUSTOM_VARS; char *dp = (char *)&out_frame[1]; for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) { @@ -1616,8 +1462,7 @@ void MyMesh::handleCmdFrame(size_t len) dp = strchr(dp, 0); } _serial->writeFrame(out_frame, dp - (char *)out_frame); - } - else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { + } else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { cmd_frame[len] = 0; char *sp = (char *)&cmd_frame[1]; char *np = strchr(sp, ':'); // look for separator char @@ -1626,31 +1471,26 @@ void MyMesh::handleCmdFrame(size_t len) bool success = sensors.setSettingValue(sp, np); if (success) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else { + } else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); } } -void MyMesh::loop() -{ +void MyMesh::loop() { BaseChatMesh::loop(); size_t len = _serial->checkRecvFrame(cmd_frame); if (len > 0) { handleCmdFrame(len); - } - else if (_iter_started // check if our ContactsIterator is 'running' - && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! + } else if (_iter_started // check if our ContactsIterator is 'running' + && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! ) { ContactInfo contact; if (_iter.hasNext(this, contact)) { @@ -1660,16 +1500,14 @@ void MyMesh::loop() _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame } } - } - else { // EOF + } else { // EOF out_frame[0] = RESP_CODE_END_OF_CONTACTS; memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' _serial->writeFrame(out_frame, 5); _iter_started = false; } - } - else if (!_serial->isWriteBusy()) { + } else if (!_serial->isWriteBusy()) { checkConnections(); } @@ -1685,15 +1523,13 @@ void MyMesh::loop() #endif } -bool MyMesh::advert() -{ +bool MyMesh::advert() { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); if (pkt) { sendZeroHop(pkt); writeOKFrame(); return true; - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); return false; } diff --git a/variants/wio-e5-mini/target.cpp b/variants/wio-e5-mini/target.cpp index e3dd2ec7..7a2b0d39 100644 --- a/variants/wio-e5-mini/target.cpp +++ b/variants/wio-e5-mini/target.cpp @@ -18,7 +18,8 @@ static const Module::RfSwitchMode_t rfswitch_table[] = { }; VolatileRTCClock rtc_clock; -WIOE5SensorManager sensors; +BME280I2C bme; +WIOE5SensorManager sensors(bme); #ifndef LORA_CR #define LORA_CR 5 @@ -72,9 +73,9 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& float temp(NAN), hum(NAN), pres(NAN); BME280::TempUnit tempUnit(BME280::TempUnit_Celsius); - BME280::PresUnit presUnit(BME280::PresUnit_hPa); + BME280::PresUnit presUnit(BME280::PresUnit_bar); - bme.read(pres, temp, hum, tempUnit, presUnit); + _bme->read(pres, temp, hum, tempUnit, presUnit); telemetry.addTemperature(TELEM_CHANNEL_SELF, temp); telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, hum); @@ -84,7 +85,7 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& } bool WIOE5SensorManager::begin() { - has_bme = bme.begin(); + has_bme = _bme->begin(); return has_bme; } \ No newline at end of file From 4e2786c516a28c2feb3b25b0750a78dc2c26afc0 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:28:29 -0700 Subject: [PATCH 20/87] Re-applying 73a7a96, formatting, MyMesh reformat --- .clang-format | 4 +- examples/companion_radio/MyMesh.cpp | 504 ++++++++++------------------ 2 files changed, 172 insertions(+), 336 deletions(-) diff --git a/.clang-format b/.clang-format index 80c7a10a..66ecd43a 100644 --- a/.clang-format +++ b/.clang-format @@ -14,7 +14,7 @@ AllowAllParametersOfDeclarationOnNextLine: false AllowShortBlocksOnASingleLine: false AllowShortCaseLabelsOnASingleLine: false AllowShortFunctionsOnASingleLine: Inline -AllowShortIfStatementsOnASingleLine: false +AllowShortIfStatementsOnASingleLine: true AllowShortLoopsOnASingleLine: false AlwaysBreakAfterDefinitionReturnType: None AlwaysBreakAfterReturnType: None @@ -35,7 +35,7 @@ BraceWrapping: BeforeElse: true IndentBraces: false BreakBeforeBinaryOperators: None -BreakBeforeBraces: Stroustrup +BreakBeforeBraces: Attach BreakBeforeTernaryOperators: true BreakConstructorInitializersBeforeComma: false ColumnLimit: 110 diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 1988c367..e53022f6 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -72,8 +72,7 @@ #include "UITask.h" #endif -void MyMesh::loadMainIdentity() -{ +void MyMesh::loadMainIdentity() { if (!_identity_store->load("_main", self_id)) { self_id = radio_new_identity(); // create new random identity int count = 0; @@ -85,13 +84,11 @@ void MyMesh::loadMainIdentity() } } -bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) -{ +bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) { return _identity_store->save("_main", identity); } -void MyMesh::loadContacts() -{ +void MyMesh::loadContacts() { if (_fs->exists("/contacts3")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/contacts3", "r"); @@ -118,20 +115,17 @@ void MyMesh::loadContacts() success = success && (file.read((uint8_t *)&c.gps_lat, 4) == 4); success = success && (file.read((uint8_t *)&c.gps_lon, 4) == 4); - if (!success) - break; // EOF + if (!success) break; // EOF c.id = mesh::Identity(pub_key); - if (!addContact(c)) - full = true; + if (!addContact(c)) full = true; } file.close(); } } } -void MyMesh::saveContacts() -{ +void MyMesh::saveContacts() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/contacts3"); File file = _fs->open("/contacts3", FILE_O_WRITE); @@ -159,15 +153,13 @@ void MyMesh::saveContacts() success = success && (file.write((uint8_t *)&c.gps_lat, 4) == 4); success = success && (file.write((uint8_t *)&c.gps_lon, 4) == 4); - if (!success) - break; // write failed + if (!success) break; // write failed } file.close(); } } -void MyMesh::loadChannels() -{ +void MyMesh::loadChannels() { if (_fs->exists("/channels2")) { #if defined(RP2040_PLATFORM) File file = _fs->open("/channels2", "r"); @@ -185,13 +177,11 @@ void MyMesh::loadChannels() success = success && (file.read((uint8_t *)ch.name, 32) == 32); success = success && (file.read((uint8_t *)ch.channel.secret, 32) == 32); - if (!success) - break; // EOF + if (!success) break; // EOF if (setChannel(channel_idx, ch)) { channel_idx++; - } - else { + } else { full = true; } } @@ -200,8 +190,7 @@ void MyMesh::loadChannels() } } -void MyMesh::saveChannels() -{ +void MyMesh::saveChannels() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/channels2"); File file = _fs->open("/channels2", FILE_O_WRITE); @@ -221,21 +210,18 @@ void MyMesh::saveChannels() success = success && (file.write((uint8_t *)ch.name, 32) == 32); success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); - if (!success) - break; // write failed + if (!success) break; // write failed channel_idx++; } file.close(); } } -int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) -{ +int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { char path[64]; char fname[18]; - if (key_len > 8) - key_len = 8; // just use first 8 bytes (prefix) + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); @@ -254,13 +240,11 @@ int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) return 0; // not found } -bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) -{ +bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) { char path[64]; char fname[18]; - if (key_len > 8) - key_len = 8; // just use first 8 bytes (prefix) + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); @@ -275,37 +259,32 @@ bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_bu if (f) { int n = f.write(src_buf, len); f.close(); - if (n == len) - return true; // success! + if (n == len) return true; // success! _fs->remove(path); // blob was only partially written! } return false; // error } -void MyMesh::writeOKFrame() -{ +void MyMesh::writeOKFrame() { uint8_t buf[1]; buf[0] = RESP_CODE_OK; _serial->writeFrame(buf, 1); } -void MyMesh::writeErrFrame(uint8_t err_code) -{ +void MyMesh::writeErrFrame(uint8_t err_code) { uint8_t buf[2]; buf[0] = RESP_CODE_ERR; buf[1] = err_code; _serial->writeFrame(buf, 2); } -void MyMesh::writeDisabledFrame() -{ +void MyMesh::writeDisabledFrame() { uint8_t buf[1]; buf[0] = RESP_CODE_DISABLED; _serial->writeFrame(buf, 1); } -void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) -{ +void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) { int i = 0; out_frame[i++] = code; memcpy(&out_frame[i], contact.id.pub_key, PUB_KEY_SIZE); @@ -328,8 +307,7 @@ void MyMesh::writeContactRespFrame(uint8_t code, const ContactInfo &contact) _serial->writeFrame(out_frame, i); } -void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len) -{ +void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len) { int i = 0; uint8_t code = frame[i++]; // eg. CMD_ADD_UPDATE_CONTACT memcpy(contact.id.pub_key, &frame[i], PUB_KEY_SIZE); @@ -351,19 +329,16 @@ void MyMesh::updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, } } -void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) -{ +void MyMesh::addToOfflineQueue(const uint8_t frame[], int len) { if (offline_queue_len >= OFFLINE_QUEUE_SIZE) { MESH_DEBUG_PRINTLN("ERROR: offline_queue is full!"); - } - else { + } else { offline_queue[offline_queue_len].len = len; memcpy(offline_queue[offline_queue_len].buf, frame, len); offline_queue_len++; } } -int MyMesh::getFromOfflineQueue(uint8_t frame[]) -{ +int MyMesh::getFromOfflineQueue(uint8_t frame[]) { if (offline_queue_len > 0) { // check offline queue size_t len = offline_queue[0].len; // take from top of queue memcpy(frame, offline_queue[0].buf, len); @@ -377,25 +352,20 @@ int MyMesh::getFromOfflineQueue(uint8_t frame[]) return 0; // queue is empty } -float MyMesh::getAirtimeBudgetFactor() const -{ +float MyMesh::getAirtimeBudgetFactor() const { return _prefs.airtime_factor; } -int MyMesh::getInterferenceThreshold() const -{ +int MyMesh::getInterferenceThreshold() const { return 0; // disabled for now, until currentRSSI() problem is resolved } -int MyMesh::calcRxDelay(float score, uint32_t air_time) const -{ - if (_prefs.rx_delay_base <= 0.0f) - return 0; +int MyMesh::calcRxDelay(float score, uint32_t air_time) const { + if (_prefs.rx_delay_base <= 0.0f) return 0; return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time); } -void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) -{ +void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) { if (_serial->isConnected() && len + 3 <= MAX_FRAME_SIZE) { int i = 0; out_frame[i++] = PUSH_CODE_LOG_RX_DATA; @@ -408,24 +378,20 @@ void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) } } -bool MyMesh::isAutoAddEnabled() const -{ +bool MyMesh::isAutoAddEnabled() const { return (_prefs.manual_add_contacts & 1) == 0; } -void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) -{ +void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { if (_serial->isConnected()) { if (!isAutoAddEnabled() && is_new) { writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); - } - else { + } else { out_frame[0] = PUSH_CODE_ADVERT; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); } - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::newContactMessage); #endif @@ -434,8 +400,7 @@ void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } -void MyMesh::onContactPathUpdated(const ContactInfo &contact) -{ +void MyMesh::onContactPathUpdated(const ContactInfo &contact) { out_frame[0] = PUSH_CODE_PATH_UPDATED; memcpy(&out_frame[1], contact.id.pub_key, PUB_KEY_SIZE); _serial->writeFrame(out_frame, 1 + PUB_KEY_SIZE); // NOTE: app may not be connected @@ -443,8 +408,7 @@ void MyMesh::onContactPathUpdated(const ContactInfo &contact) dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } -bool MyMesh::processAck(const uint8_t *data) -{ +bool MyMesh::processAck(const uint8_t *data) { // see if matches any in a table for (int i = 0; i < EXPECTED_ACK_TABLE_SIZE; i++) { if (memcmp(data, &expected_ack_table[i].ack, 4) == 0) { // got an ACK from recipient @@ -463,16 +427,14 @@ bool MyMesh::processAck(const uint8_t *data) } void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, - uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) -{ + uint32_t sender_timestamp, const uint8_t *extra, int extra_len, const char *text) { int i = 0; if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 - } - else { + } else { out_frame[i++] = RESP_CODE_CONTACT_MSG_RECV; } memcpy(&out_frame[i], from.id.pub_key, 6); @@ -497,8 +459,7 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::contactMessage); #endif @@ -509,22 +470,19 @@ void MyMesh::queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packe } void MyMesh::onMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) -{ + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_PLAIN, pkt, sender_timestamp, NULL, 0, text); } void MyMesh::onCommandDataRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const char *text) -{ + const char *text) { markConnectionActive(from); // in case this is from a server, and we have a connection queueMessage(from, TXT_TYPE_CLI_DATA, pkt, sender_timestamp, NULL, 0, text); } void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uint32_t sender_timestamp, - const uint8_t *sender_prefix, const char *text) -{ + const uint8_t *sender_prefix, const char *text) { markConnectionActive(from); // from.sync_since change needs to be persisted dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); @@ -532,16 +490,14 @@ void MyMesh::onSignedMessageRecv(const ContactInfo &from, mesh::Packet *pkt, uin } void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packet *pkt, uint32_t timestamp, - const char *text) -{ + const char *text) { int i = 0; if (app_target_ver >= 3) { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV_V3; out_frame[i++] = (int8_t)(pkt->getSNR() * 4); out_frame[i++] = 0; // reserved1 out_frame[i++] = 0; // reserved2 - } - else { + } else { out_frame[i++] = RESP_CODE_CHANNEL_MSG_RECV; } @@ -564,8 +520,7 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe uint8_t frame[1]; frame[0] = PUSH_CODE_MSG_WAITING; // send push 'tickle' _serial->writeFrame(frame, 1); - } - else { + } else { #ifdef DISPLAY_CLASS ui_task.soundBuzzer(UIEventType::channelMessage); #endif @@ -582,30 +537,26 @@ void MyMesh::onChannelMessageRecv(const mesh::GroupChannel &channel, mesh::Packe } uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_timestamp, const uint8_t *data, - uint8_t len, uint8_t *reply) -{ + uint8_t len, uint8_t *reply) { if (data[0] == REQ_TYPE_GET_TELEMETRY_DATA) { uint8_t permissions = 0; uint8_t cp = contact.flags >> 1; // LSB used as 'favourite' bit (so only use upper bits) if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_ALL) { permissions = TELEM_PERM_BASE; - } - else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_base == TELEM_MODE_ALLOW_FLAGS) { permissions = cp & TELEM_PERM_BASE; } if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_LOCATION; - } - else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_loc == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_LOCATION; } if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_ALL) { permissions |= TELEM_PERM_ENVIRONMENT; - } - else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { + } else if (_prefs.telemetry_mode_env == TELEM_MODE_ALLOW_FLAGS) { permissions |= cp & TELEM_PERM_ENVIRONMENT; } @@ -626,8 +577,7 @@ uint8_t MyMesh::onContactRequest(const ContactInfo &contact, uint32_t sender_tim return 0; // unknown } -void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) -{ +void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, uint8_t len) { uint32_t tag; memcpy(&tag, data, 4); @@ -640,9 +590,8 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, out_frame[i++] = PUSH_CODE_LOGIN_SUCCESS; out_frame[i++] = 0; // legacy: is_admin = false memcpy(&out_frame[i], contact.id.pub_key, 6); - i += 6; // pub_key_prefix - } - else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response + i += 6; // pub_key_prefix + } else if (data[4] == RESP_SERVER_LOGIN_OK) { // new login response uint16_t keep_alive_secs = ((uint16_t)data[5]) * 16; if (keep_alive_secs > 0) { startConnection(contact, keep_alive_secs); @@ -653,19 +602,17 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, i += 6; // pub_key_prefix memcpy(&out_frame[i], &tag, 4); i += 4; // NEW: include server timestamp - } - else { + } else { out_frame[i++] = PUSH_CODE_LOGIN_FAIL; out_frame[i++] = 0; // reserved memcpy(&out_frame[i], contact.id.pub_key, 6); i += 6; // pub_key_prefix } _serial->writeFrame(out_frame, i); - } - else if (len > 4 && // check for status response - pending_status && - memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme - // FUTURE: tag == pending_status + } else if (len > 4 && // check for status response + pending_status && + memcmp(&pending_status, contact.id.pub_key, 4) == 0 // legacy matching scheme + // FUTURE: tag == pending_status ) { pending_status = 0; @@ -677,8 +624,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, memcpy(&out_frame[i], &data[4], len - 4); i += (len - 4); _serial->writeFrame(out_frame, i); - } - else if (len > 4 && tag == pending_telemetry) { // check for telemetry response + } else if (len > 4 && tag == pending_telemetry) { // check for telemetry response pending_telemetry = 0; int i = 0; @@ -692,8 +638,7 @@ void MyMesh::onContactResponse(const ContactInfo &contact, const uint8_t *data, } } -void MyMesh::onRawDataRecv(mesh::Packet *packet) -{ +void MyMesh::onRawDataRecv(mesh::Packet *packet) { if (packet->payload_len + 4 > sizeof(out_frame)) { MESH_DEBUG_PRINTLN("onRawDataRecv(), payload_len too long: %d", packet->payload_len); return; @@ -708,15 +653,13 @@ void MyMesh::onRawDataRecv(mesh::Packet *packet) if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); - } - else { + } else { MESH_DEBUG_PRINTLN("onRawDataRecv(), data received while app offline"); } } void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, uint8_t flags, - const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) -{ + const uint8_t *path_snrs, const uint8_t *path_hashes, uint8_t path_len) { int i = 0; out_frame[i++] = PUSH_CODE_TRACE_DATA; out_frame[i++] = 0; // reserved @@ -734,18 +677,15 @@ void MyMesh::onTraceRecv(mesh::Packet *packet, uint32_t tag, uint32_t auth_code, if (_serial->isConnected()) { _serial->writeFrame(out_frame, i); - } - else { + } else { MESH_DEBUG_PRINTLN("onTraceRecv(), data received while app offline"); } } -uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const -{ +uint32_t MyMesh::calcFloodTimeoutMillisFor(uint32_t pkt_airtime_millis) const { return SEND_TIMEOUT_BASE_MILLIS + (FLOOD_SEND_TIMEOUT_FACTOR * pkt_airtime_millis); } -uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const -{ +uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const { return SEND_TIMEOUT_BASE_MILLIS + ((pkt_airtime_millis * DIRECT_SEND_PERHOP_FACTOR + DIRECT_SEND_PERHOP_EXTRA_MILLIS) * (path_len + 1)); @@ -755,8 +695,7 @@ void MyMesh::onSendTimeout() {} MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), - _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) -{ + _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { _iter_started = false; offline_queue_len = 0; app_target_ver = 0; @@ -778,8 +717,7 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe //_prefs.rx_delay_base = 10.0f; enable once new algo fixed } -void MyMesh::loadPrefsInt(const char *filename) -{ +void MyMesh::loadPrefsInt(const char *filename) { #if defined(RP2040_PLATFORM) File file = _fs->open(filename, "r"); #else @@ -820,8 +758,7 @@ void MyMesh::loadPrefsInt(const char *filename) } } -void MyMesh::begin(FILESYSTEM &fs, bool has_display) -{ +void MyMesh::begin(FILESYSTEM &fs, bool has_display) { _fs = &fs; BaseChatMesh::begin(); @@ -850,8 +787,7 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) // load persisted prefs if (_fs->exists("/new_prefs")) { loadPrefsInt("/new_prefs"); // new filename - } - else if (_fs->exists("/node_prefs")) { + } else if (_fs->exists("/node_prefs")) { loadPrefsInt("/node_prefs"); savePrefs(); // save to new filename _fs->remove("/node_prefs"); // remove old @@ -863,15 +799,13 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) if (has_display) { StdRNG rng; _active_ble_pin = rng.nextInt(100000, 999999); // random pin each session - } - else { + } else { _active_ble_pin = BLE_PIN_CODE; // otherwise static pin } #else _active_ble_pin = BLE_PIN_CODE; // otherwise static pin #endif - } - else { + } else { _active_ble_pin = _prefs.ble_pin; } #else @@ -889,27 +823,22 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) radio_set_tx_power(_prefs.tx_power_dbm); } -const char *MyMesh::getNodeName() -{ +const char *MyMesh::getNodeName() { return _prefs.node_name; } -NodePrefs *MyMesh::getNodePrefs() -{ +NodePrefs *MyMesh::getNodePrefs() { return &_prefs; } -uint32_t MyMesh::getBLEPin() -{ +uint32_t MyMesh::getBLEPin() { return _active_ble_pin; } -void MyMesh::startInterface(BaseSerialInterface &serial) -{ +void MyMesh::startInterface(BaseSerialInterface &serial) { _serial = &serial; serial.enable(); } -void MyMesh::savePrefs() -{ +void MyMesh::savePrefs() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) _fs->remove("/new_prefs"); File file = _fs->open("/new_prefs", FILE_O_WRITE); @@ -945,8 +874,7 @@ void MyMesh::savePrefs() } } -void MyMesh::handleCmdFrame(size_t len) -{ +void MyMesh::handleCmdFrame(size_t len) { if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection app_target_ver = cmd_frame[1]; // which version of protocol does app understand @@ -965,9 +893,8 @@ void MyMesh::handleCmdFrame(size_t len) StrHelper::strzcpy((char *)&out_frame[i], FIRMWARE_VERSION, 20); i += 20; _serial->writeFrame(out_frame, i); - } - else if (cmd_frame[0] == CMD_APP_START && - len >= 8) { // sent when app establishes connection, respond with node ID + } else if (cmd_frame[0] == CMD_APP_START && + len >= 8) { // sent when app establishes connection, respond with node ID // cmd_frame[1..7] reserved future char *app_name = (char *)&cmd_frame[8]; cmd_frame[len] = 0; // make app_name null terminated @@ -1008,8 +935,7 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[i], _prefs.node_name, tlen); i += tlen; _serial->writeFrame(out_frame, i); - } - else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { + } else if (cmd_frame[0] == CMD_SEND_TXT_MSG && len >= 14) { int i = 1; uint8_t txt_type = cmd_frame[i++]; uint8_t attempt = cmd_frame[i++]; @@ -1029,15 +955,13 @@ void MyMesh::handleCmdFrame(size_t len) if (txt_type == TXT_TYPE_CLI_DATA) { result = sendCommandData(*recipient, msg_timestamp, attempt, text, est_timeout); expected_ack = 0; // no Ack expected - } - else { + } else { result = sendMessage(*recipient, msg_timestamp, attempt, text, expected_ack, est_timeout); } // TODO: add expected ACK to table if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { if (expected_ack) { expected_ack_table[next_ack_idx].msg_sent = _ms->getMillis(); // add to circular table expected_ack_table[next_ack_idx].ack = expected_ack; @@ -1050,14 +974,12 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(recipient == NULL ? ERR_CODE_NOT_FOUND : ERR_CODE_UNSUPPORTED_CMD); // unknown recipient, or unsuported TXT_TYPE_* } - } - else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg + } else if (cmd_frame[0] == CMD_SEND_CHANNEL_TXT_MSG) { // send GroupChannel msg int i = 1; uint8_t txt_type = cmd_frame[i++]; // should be TXT_TYPE_PLAIN uint8_t channel_idx = cmd_frame[i++]; @@ -1068,27 +990,22 @@ void MyMesh::handleCmdFrame(size_t len) if (txt_type != TXT_TYPE_PLAIN) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); - } - else { + } else { ChannelDetails channel; bool success = getChannel(channel_idx, channel); if (success && sendGroupMessage(msg_timestamp, channel.channel, _prefs.node_name, text, len - i)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } } - } - else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list + } else if (cmd_frame[0] == CMD_GET_CONTACTS) { // get Contact list if (_iter_started) { writeErrFrame(ERR_CODE_BAD_STATE); // iterator is currently busy - } - else { + } else { if (len >= 5) { // has optional 'since' param memcpy(&_iter_filter_since, &cmd_frame[1], 4); - } - else { + } else { _iter_filter_since = 0; } @@ -1103,17 +1020,14 @@ void MyMesh::handleCmdFrame(size_t len) _iter_started = true; _most_recent_lastmod = 0; } - } - else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { + } else if (cmd_frame[0] == CMD_SET_ADVERT_NAME && len >= 2) { int nlen = len - 1; - if (nlen > sizeof(_prefs.node_name) - 1) - nlen = sizeof(_prefs.node_name) - 1; // max len + if (nlen > sizeof(_prefs.node_name) - 1) nlen = sizeof(_prefs.node_name) - 1; // max len memcpy(_prefs.node_name, &cmd_frame[1], nlen); _prefs.node_name[nlen] = 0; // null terminator savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { + } else if (cmd_frame[0] == CMD_SET_ADVERT_LATLON && len >= 9) { int32_t lat, lon, alt = 0; memcpy(&lat, &cmd_frame[1], 4); memcpy(&lon, &cmd_frame[5], 4); @@ -1125,46 +1039,38 @@ void MyMesh::handleCmdFrame(size_t len) sensors.node_lon = ((double)lon) / 1000000.0; savePrefs(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); // invalid geo coordinate } - } - else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { + } else if (cmd_frame[0] == CMD_GET_DEVICE_TIME) { uint8_t reply[5]; reply[0] = RESP_CODE_CURR_TIME; uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply[1], &now, 4); _serial->writeFrame(reply, 5); - } - else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { + } else if (cmd_frame[0] == CMD_SET_DEVICE_TIME && len >= 5) { uint32_t secs; memcpy(&secs, &cmd_frame[1], 4); uint32_t curr = getRTCClock()->getCurrentTime(); if (secs >= curr) { getRTCClock()->setCurrentTime(secs); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { + } else if (cmd_frame[0] == CMD_SEND_SELF_ADVERT) { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); if (pkt) { if (len >= 2 && cmd_frame[1] == 1) { // optional param (1 = flood, 0 = zero hop) sendFlood(pkt); - } - else { + } else { sendZeroHop(pkt); } writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { + } else if (cmd_frame[0] == CMD_RESET_PATH && len >= 1 + 32) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1172,12 +1078,10 @@ void MyMesh::handleCmdFrame(size_t len) // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // unknown contact } - } - else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { + } else if (cmd_frame[0] == CMD_ADD_UPDATE_CONTACT && len >= 1 + 32 + 2 + 1) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1185,8 +1089,7 @@ void MyMesh::handleCmdFrame(size_t len) // recipient->lastmod = ?? shouldn't be needed, app already has this version of contact dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { ContactInfo contact; updateContactFromFrame(contact, cmd_frame, len); contact.lastmod = getRTCClock()->getCurrentTime(); @@ -1194,49 +1097,40 @@ void MyMesh::handleCmdFrame(size_t len) if (addContact(contact)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } } - } - else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { + } else if (cmd_frame[0] == CMD_REMOVE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient && removeContact(*recipient)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found, or unable to remove } - } - else if (cmd_frame[0] == CMD_SHARE_CONTACT) { + } else if (cmd_frame[0] == CMD_SHARE_CONTACT) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { if (shareContactZeroHop(*recipient)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); // unable to send } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { + } else if (cmd_frame[0] == CMD_GET_CONTACT_BY_KEY) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *contact = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (contact) { writeContactRespFrame(RESP_CODE_CONTACT, *contact); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } - } - else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { + } else if (cmd_frame[0] == CMD_EXPORT_CONTACT) { if (len < 1 + PUB_KEY_SIZE) { // export SELF auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); @@ -1247,46 +1141,38 @@ void MyMesh::handleCmdFrame(size_t len) uint8_t out_len = pkt->writeTo(&out_frame[1]); releasePacket(pkt); // undo the obtainNewPacket() _serial->writeFrame(out_frame, out_len + 1); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); // Error } - } - else { + } else { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); uint8_t out_len; if (recipient && (out_len = exportContact(*recipient, &out_frame[1])) > 0) { out_frame[0] = RESP_CODE_EXPORT_CONTACT; _serial->writeFrame(out_frame, out_len + 1); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // not found } } - } - else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { + } else if (cmd_frame[0] == CMD_IMPORT_CONTACT && len > 2 + 32 + 64) { if (importContact(&cmd_frame[1], len - 1)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { + } else if (cmd_frame[0] == CMD_SYNC_NEXT_MESSAGE) { int out_len; if ((out_len = getFromOfflineQueue(out_frame)) > 0) { _serial->writeFrame(out_frame, out_len); #ifdef DISPLAY_CLASS ui_task.msgRead(offline_queue_len); #endif - } - else { + } else { out_frame[0] = RESP_CODE_NO_MORE_MESSAGES; _serial->writeFrame(out_frame, 1); } - } - else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_RADIO_PARAMS) { int i = 1; uint32_t freq; memcpy(&freq, &cmd_frame[i], 4); @@ -1310,25 +1196,21 @@ void MyMesh::handleCmdFrame(size_t len) (uint32_t)cr); writeOKFrame(); - } - else { + } else { MESH_DEBUG_PRINTLN("Error: CMD_SET_RADIO_PARAMS: f=%d, bw=%d, sf=%d, cr=%d", freq, bw, (uint32_t)sf, (uint32_t)cr); writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { + } else if (cmd_frame[0] == CMD_SET_RADIO_TX_POWER) { if (cmd_frame[1] > MAX_LORA_TX_POWER) { writeErrFrame(ERR_CODE_ILLEGAL_ARG); - } - else { + } else { _prefs.tx_power_dbm = cmd_frame[1]; savePrefs(); radio_set_tx_power(_prefs.tx_power_dbm); writeOKFrame(); } - } - else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_TUNING_PARAMS) { int i = 1; uint32_t rx, af; memcpy(&rx, &cmd_frame[i], 4); @@ -1339,8 +1221,7 @@ void MyMesh::handleCmdFrame(size_t len) _prefs.airtime_factor = ((float)af) / 1000.0f; savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { + } else if (cmd_frame[0] == CMD_SET_OTHER_PARAMS) { _prefs.manual_add_contacts = cmd_frame[1]; if (len >= 3) { _prefs.telemetry_mode_base = cmd_frame[2] & 0x03; // v5+ @@ -1349,21 +1230,18 @@ void MyMesh::handleCmdFrame(size_t len) } savePrefs(); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { + } else if (cmd_frame[0] == CMD_REBOOT && memcmp(&cmd_frame[1], "reboot", 6) == 0) { if (dirty_contacts_expiry) { // is there are pending dirty contacts write needed? saveContacts(); } board.reboot(); - } - else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { + } else if (cmd_frame[0] == CMD_GET_BATTERY_VOLTAGE) { uint8_t reply[3]; reply[0] = RESP_CODE_BATTERY_VOLTAGE; uint16_t battery_millivolts = board.getBattMilliVolts(); memcpy(&reply[1], &battery_millivolts, 2); _serial->writeFrame(reply, 3); - } - else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { + } else if (cmd_frame[0] == CMD_EXPORT_PRIVATE_KEY) { #if ENABLE_PRIVATE_KEY_EXPORT uint8_t reply[65]; reply[0] = RESP_CODE_PRIVATE_KEY; @@ -1372,23 +1250,20 @@ void MyMesh::handleCmdFrame(size_t len) #else writeDisabledFrame(); #endif - } - else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { + } else if (cmd_frame[0] == CMD_IMPORT_PRIVATE_KEY && len >= 65) { #if ENABLE_PRIVATE_KEY_IMPORT mesh::LocalIdentity identity; identity.readFrom(&cmd_frame[1], 64); if (saveMainIdentity(identity)) { self_id = identity; writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_FILE_IO_ERROR); } #else writeDisabledFrame(); #endif - } - else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { + } else if (cmd_frame[0] == CMD_SEND_RAW_DATA && len >= 6) { int i = 1; int8_t path_len = cmd_frame[i++]; if (path_len >= 0 && i + path_len + 4 <= len) { // minimum 4 byte payload @@ -1398,16 +1273,13 @@ void MyMesh::handleCmdFrame(size_t len) if (pkt) { sendDirect(pkt, path, path_len); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else { + } else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // flood, not supported (yet) } - } - else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_LOGIN && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); char *password = (char *)&cmd_frame[1 + PUB_KEY_SIZE]; @@ -1417,8 +1289,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendLogin(*recipient, password, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_telemetry = pending_status = 0; memcpy(&pending_login, recipient->id.pub_key, 4); // match this to onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1427,12 +1298,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_STATUS_REQ && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1440,8 +1309,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendRequest(*recipient, REQ_TYPE_GET_STATUS, tag, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_telemetry = pending_login = 0; // FUTURE: pending_status = tag; // match this in onContactResponse() memcpy(&pending_status, recipient->id.pub_key, 4); // legacy matching scheme @@ -1451,12 +1319,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len >= 4 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[4]; ContactInfo *recipient = lookupContactByPubKey(pub_key, PUB_KEY_SIZE); if (recipient) { @@ -1464,8 +1330,7 @@ void MyMesh::handleCmdFrame(size_t len) int result = sendRequest(*recipient, REQ_TYPE_GET_TELEMETRY_DATA, tag, est_timeout); if (result == MSG_SEND_FAILED) { writeErrFrame(ERR_CODE_TABLE_FULL); - } - else { + } else { pending_status = pending_login = 0; pending_telemetry = tag; // match this in onContactResponse() out_frame[0] = RESP_CODE_SENT; @@ -1474,26 +1339,21 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); } - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } - } - else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; if (hasConnectionTo(pub_key)) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { + } else if (cmd_frame[0] == CMD_LOGOUT && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; stopConnection(pub_key); writeOKFrame(); - } - else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { + } else if (cmd_frame[0] == CMD_GET_CHANNEL && len >= 2) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; if (getChannel(channel_idx, channel)) { @@ -1505,15 +1365,12 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[i], channel.channel.secret, 16); i += 16; // NOTE: only 128-bit supported _serial->writeFrame(out_frame, i); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); } - } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { + } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 32) { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); // not supported (yet) - } - else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { + } else if (cmd_frame[0] == CMD_SET_CHANNEL && len >= 2 + 32 + 16) { uint8_t channel_idx = cmd_frame[1]; ChannelDetails channel; StrHelper::strncpy(channel.name, (char *)&cmd_frame[2], 32); @@ -1522,12 +1379,10 @@ void MyMesh::handleCmdFrame(size_t len) if (setChannel(channel_idx, channel)) { saveChannels(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_NOT_FOUND); // bad channel_idx } - } - else if (cmd_frame[0] == CMD_SIGN_START) { + } else if (cmd_frame[0] == CMD_SIGN_START) { out_frame[0] = RESP_CODE_SIGN_START; out_frame[1] = 0; // reserved uint32_t len = MAX_SIGN_DATA_LEN; @@ -1539,18 +1394,15 @@ void MyMesh::handleCmdFrame(size_t len) } sign_data = (uint8_t *)malloc(MAX_SIGN_DATA_LEN); sign_data_len = 0; - } - else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { + } else if (cmd_frame[0] == CMD_SIGN_DATA && len > 1) { if (sign_data == NULL || sign_data_len + (len - 1) > MAX_SIGN_DATA_LEN) { writeErrFrame(sign_data == NULL ? ERR_CODE_BAD_STATE : ERR_CODE_TABLE_FULL); // error: too long - } - else { + } else { memcpy(&sign_data[sign_data_len], &cmd_frame[1], len - 1); sign_data_len += (len - 1); writeOKFrame(); } - } - else if (cmd_frame[0] == CMD_SIGN_FINISH) { + } else if (cmd_frame[0] == CMD_SIGN_FINISH) { if (sign_data) { self_id.sign(&out_frame[1], sign_data, sign_data_len); @@ -1559,12 +1411,10 @@ void MyMesh::handleCmdFrame(size_t len) out_frame[0] = RESP_CODE_SIGNATURE; _serial->writeFrame(out_frame, 1 + SIGNATURE_SIZE); - } - else { + } else { writeErrFrame(ERR_CODE_BAD_STATE); } - } - else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { + } else if (cmd_frame[0] == CMD_SEND_TRACE_PATH && len > 10 && len - 10 < MAX_PATH_SIZE) { uint32_t tag, auth; memcpy(&tag, &cmd_frame[1], 4); memcpy(&auth, &cmd_frame[5], 4); @@ -1581,12 +1431,10 @@ void MyMesh::handleCmdFrame(size_t len) memcpy(&out_frame[2], &tag, 4); memcpy(&out_frame[6], &est_timeout, 4); _serial->writeFrame(out_frame, 10); - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); } - } - else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { + } else if (cmd_frame[0] == CMD_SET_DEVICE_PIN && len >= 5) { // get pin from command frame uint32_t pin; @@ -1597,12 +1445,10 @@ void MyMesh::handleCmdFrame(size_t len) _prefs.ble_pin = pin; savePrefs(); writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { + } else if (cmd_frame[0] == CMD_GET_CUSTOM_VARS) { out_frame[0] = RESP_CODE_CUSTOM_VARS; char *dp = (char *)&out_frame[1]; for (int i = 0; i < sensors.getNumSettings() && dp - (char *)&out_frame[1] < 140; i++) { @@ -1616,8 +1462,7 @@ void MyMesh::handleCmdFrame(size_t len) dp = strchr(dp, 0); } _serial->writeFrame(out_frame, dp - (char *)out_frame); - } - else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { + } else if (cmd_frame[0] == CMD_SET_CUSTOM_VAR && len >= 4) { cmd_frame[len] = 0; char *sp = (char *)&cmd_frame[1]; char *np = strchr(sp, ':'); // look for separator char @@ -1626,31 +1471,26 @@ void MyMesh::handleCmdFrame(size_t len) bool success = sensors.setSettingValue(sp, np); if (success) { writeOKFrame(); - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else { + } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } - } - else { + } else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); } } -void MyMesh::loop() -{ +void MyMesh::loop() { BaseChatMesh::loop(); size_t len = _serial->checkRecvFrame(cmd_frame); if (len > 0) { handleCmdFrame(len); - } - else if (_iter_started // check if our ContactsIterator is 'running' - && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! + } else if (_iter_started // check if our ContactsIterator is 'running' + && !_serial->isWriteBusy() // don't spam the Serial Interface too quickly! ) { ContactInfo contact; if (_iter.hasNext(this, contact)) { @@ -1660,16 +1500,14 @@ void MyMesh::loop() _most_recent_lastmod = contact.lastmod; // save for the RESP_CODE_END_OF_CONTACTS frame } } - } - else { // EOF + } else { // EOF out_frame[0] = RESP_CODE_END_OF_CONTACTS; memcpy(&out_frame[1], &_most_recent_lastmod, 4); // include the most recent lastmod, so app can update their 'since' _serial->writeFrame(out_frame, 5); _iter_started = false; } - } - else if (!_serial->isWriteBusy()) { + } else if (!_serial->isWriteBusy()) { checkConnections(); } @@ -1685,15 +1523,13 @@ void MyMesh::loop() #endif } -bool MyMesh::advert() -{ +bool MyMesh::advert() { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); if (pkt) { sendZeroHop(pkt); writeOKFrame(); return true; - } - else { + } else { writeErrFrame(ERR_CODE_TABLE_FULL); return false; } From 9fe218e0d8e67322c1377b380cfee95fa7ec0a3c Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:41:04 -0700 Subject: [PATCH 21/87] Reverting format changes to NodePrefs But changing to pragma once. --- examples/companion_radio/NodePrefs.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/companion_radio/NodePrefs.h b/examples/companion_radio/NodePrefs.h index 44d7ecbf..4fd0fd3b 100644 --- a/examples/companion_radio/NodePrefs.h +++ b/examples/companion_radio/NodePrefs.h @@ -1,11 +1,11 @@ #pragma once #include // For uint8_t, uint32_t -#define TELEM_MODE_DENY 0 -#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags -#define TELEM_MODE_ALLOW_ALL 2 +#define TELEM_MODE_DENY 0 +#define TELEM_MODE_ALLOW_FLAGS 1 // use contact.flags +#define TELEM_MODE_ALLOW_ALL 2 -struct NodePrefs { // persisted to file +struct NodePrefs { // persisted to file float airtime_factor; char node_name[32]; float freq; From 33d5f85556b1bba24f48661e20301251bd406201 Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:42:40 -0700 Subject: [PATCH 22/87] Re-merging 92c2963 --- variants/wio-e5-mini/target.cpp | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/variants/wio-e5-mini/target.cpp b/variants/wio-e5-mini/target.cpp index 7a2b0d39..e3dd2ec7 100644 --- a/variants/wio-e5-mini/target.cpp +++ b/variants/wio-e5-mini/target.cpp @@ -18,8 +18,7 @@ static const Module::RfSwitchMode_t rfswitch_table[] = { }; VolatileRTCClock rtc_clock; -BME280I2C bme; -WIOE5SensorManager sensors(bme); +WIOE5SensorManager sensors; #ifndef LORA_CR #define LORA_CR 5 @@ -73,9 +72,9 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& float temp(NAN), hum(NAN), pres(NAN); BME280::TempUnit tempUnit(BME280::TempUnit_Celsius); - BME280::PresUnit presUnit(BME280::PresUnit_bar); + BME280::PresUnit presUnit(BME280::PresUnit_hPa); - _bme->read(pres, temp, hum, tempUnit, presUnit); + bme.read(pres, temp, hum, tempUnit, presUnit); telemetry.addTemperature(TELEM_CHANNEL_SELF, temp); telemetry.addRelativeHumidity(TELEM_CHANNEL_SELF, hum); @@ -85,7 +84,7 @@ bool WIOE5SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& } bool WIOE5SensorManager::begin() { - has_bme = _bme->begin(); + has_bme = bme.begin(); return has_bme; } \ No newline at end of file From 884d8f1a987af3fcd0bb8368cd271e5004b3682b Mon Sep 17 00:00:00 2001 From: hank Date: Sun, 1 Jun 2025 20:45:18 -0700 Subject: [PATCH 23/87] Reverting UITask.h changes --- examples/companion_radio/UITask.h | 43 +++++++++++++++++++------------ 1 file changed, 26 insertions(+), 17 deletions(-) diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index f52c0961..acf5237e 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -1,43 +1,52 @@ #pragma once + #include #include #include #ifdef PIN_BUZZER -#include + #include #endif -#include "Button.h" #include "NodePrefs.h" +#include "Button.h" -enum class UIEventType { none, contactMessage, channelMessage, roomMessage, newContactMessage, ack }; + enum class UIEventType +{ + none, + contactMessage, + channelMessage, + roomMessage, + newContactMessage, + ack +}; class UITask { - DisplayDriver *_display; - mesh::MainBoard *_board; + DisplayDriver* _display; + mesh::MainBoard* _board; #ifdef PIN_BUZZER genericBuzzer buzzer; #endif unsigned long _next_refresh, _auto_off; bool _connected; uint32_t _pin_code; - NodePrefs *_node_prefs; + NodePrefs* _node_prefs; char _version_info[32]; char _origin[62]; char _msg[80]; int _msgcount; bool _need_refresh = true; - bool _displayWasOn = false; // Track display state before button press + bool _displayWasOn = false; // Track display state before button press // Button handlers #if defined(PIN_USER_BTN) || defined(PIN_USER_BTN_ANA) - Button *_userButton = nullptr; + Button* _userButton = nullptr; #endif void renderCurrScreen(); void userLedHandler(); void renderBatteryIndicator(uint16_t batteryMilliVolts); - + // Button action handlers void handleButtonAnyPress(); void handleButtonShortPress(); @@ -45,21 +54,21 @@ class UITask { void handleButtonTriplePress(); void handleButtonLongPress(); + public: - UITask(mesh::MainBoard *board) : _board(board), _display(NULL) - { - _next_refresh = 0; - _connected = false; + + UITask(mesh::MainBoard* board) : _board(board), _display(NULL) { + _next_refresh = 0; + _connected = false; } - void begin(DisplayDriver *display, NodePrefs *node_prefs, const char *build_date, - const char *firmware_version, uint32_t pin_code); + void begin(DisplayDriver* display, NodePrefs* node_prefs, const char* build_date, const char* firmware_version, uint32_t pin_code); void setHasConnection(bool connected) { _connected = connected; } bool hasDisplay() const { return _display != NULL; } void clearMsgPreview(); void msgRead(int msgcount); - void newMsg(uint8_t path_len, const char *from_name, const char *text, int msgcount); + void newMsg(uint8_t path_len, const char* from_name, const char* text, int msgcount); void soundBuzzer(UIEventType bet = UIEventType::none); void shutdown(bool restart = false); void loop(); -}; \ No newline at end of file +}; From 5729d66a9ead2ff7a7620882a82607180fee4824 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 15:25:55 +1000 Subject: [PATCH 24/87] * companion: some further refactors after the MyMesh refactor --- examples/companion_radio/MyMesh.cpp | 33 +++++++++++++++++++++++++++-- examples/companion_radio/MyMesh.h | 33 ----------------------------- examples/companion_radio/UITask.cpp | 18 +++++++--------- examples/companion_radio/UITask.h | 3 +-- examples/companion_radio/main.cpp | 2 +- 5 files changed, 41 insertions(+), 48 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index e53022f6..b0905bb6 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -68,6 +68,37 @@ #define RESP_CODE_SIGNATURE 20 #define RESP_CODE_CUSTOM_VARS 21 +#define SEND_TIMEOUT_BASE_MILLIS 500 +#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f +#define DIRECT_SEND_PERHOP_FACTOR 6.0f +#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 +#define LAZY_CONTACTS_WRITE_DELAY 5000 + +#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" + +// these are _pushed_ to client app at any time +#define PUSH_CODE_ADVERT 0x80 +#define PUSH_CODE_PATH_UPDATED 0x81 +#define PUSH_CODE_SEND_CONFIRMED 0x82 +#define PUSH_CODE_MSG_WAITING 0x83 +#define PUSH_CODE_RAW_DATA 0x84 +#define PUSH_CODE_LOGIN_SUCCESS 0x85 +#define PUSH_CODE_LOGIN_FAIL 0x86 +#define PUSH_CODE_STATUS_RESPONSE 0x87 +#define PUSH_CODE_LOG_RX_DATA 0x88 +#define PUSH_CODE_TRACE_DATA 0x89 +#define PUSH_CODE_NEW_ADVERT 0x8A +#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B + +#define ERR_CODE_UNSUPPORTED_CMD 1 +#define ERR_CODE_NOT_FOUND 2 +#define ERR_CODE_TABLE_FULL 3 +#define ERR_CODE_BAD_STATE 4 +#define ERR_CODE_FILE_IO_ERROR 5 +#define ERR_CODE_ILLEGAL_ARG 6 + +#define MAX_SIGN_DATA_LEN (8 * 1024) // 8K + #ifdef DISPLAY_CLASS #include "UITask.h" #endif @@ -1527,10 +1558,8 @@ bool MyMesh::advert() { auto pkt = createSelfAdvert(_prefs.node_name, sensors.node_lat, sensors.node_lon); if (pkt) { sendZeroHop(pkt); - writeOKFrame(); return true; } else { - writeErrFrame(ERR_CODE_TABLE_FULL); return false; } } \ No newline at end of file diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index 574b9878..9d7da0df 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -70,43 +70,12 @@ #include -#define SEND_TIMEOUT_BASE_MILLIS 500 -#define FLOOD_SEND_TIMEOUT_FACTOR 16.0f -#define DIRECT_SEND_PERHOP_FACTOR 6.0f -#define DIRECT_SEND_PERHOP_EXTRA_MILLIS 250 -#define LAZY_CONTACTS_WRITE_DELAY 5000 - -#define PUBLIC_GROUP_PSK "izOH6cXN6mrJ5e26oRXNcg==" - -// these are _pushed_ to client app at any time -#define PUSH_CODE_ADVERT 0x80 -#define PUSH_CODE_PATH_UPDATED 0x81 -#define PUSH_CODE_SEND_CONFIRMED 0x82 -#define PUSH_CODE_MSG_WAITING 0x83 -#define PUSH_CODE_RAW_DATA 0x84 -#define PUSH_CODE_LOGIN_SUCCESS 0x85 -#define PUSH_CODE_LOGIN_FAIL 0x86 -#define PUSH_CODE_STATUS_RESPONSE 0x87 -#define PUSH_CODE_LOG_RX_DATA 0x88 -#define PUSH_CODE_TRACE_DATA 0x89 -#define PUSH_CODE_NEW_ADVERT 0x8A -#define PUSH_CODE_TELEMETRY_RESPONSE 0x8B - -#define ERR_CODE_UNSUPPORTED_CMD 1 -#define ERR_CODE_NOT_FOUND 2 -#define ERR_CODE_TABLE_FULL 3 -#define ERR_CODE_BAD_STATE 4 -#define ERR_CODE_FILE_IO_ERROR 5 -#define ERR_CODE_ILLEGAL_ARG 6 - /* -------------------------------------------------------------------------------------- */ #define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS #define REQ_TYPE_KEEP_ALIVE 0x02 #define REQ_TYPE_GET_TELEMETRY_DATA 0x03 -#define MAX_SIGN_DATA_LEN (8 * 1024) // 8K - class MyMesh : public BaseChatMesh { public: MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables); @@ -213,8 +182,6 @@ private: int next_ack_idx; }; -extern StdRNG fast_rng; -extern SimpleMeshTables tables; extern MyMesh the_mesh; #ifdef DISPLAY_CLASS extern UITask ui_task; diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index eabfd8f7..00263e5e 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -34,26 +34,25 @@ static const uint8_t meshcore_logo [] PROGMEM = { 0xe3, 0xe3, 0x8f, 0xff, 0x1f, 0xfc, 0x3c, 0x0e, 0x1f, 0xf8, 0xff, 0xf8, 0x70, 0x3c, 0x7f, 0xf8, }; -void UITask::begin(DisplayDriver* display, NodePrefs* node_prefs, const char* build_date, const char* firmware_version, uint32_t pin_code) { +void UITask::begin(DisplayDriver* display, NodePrefs* node_prefs) { _display = display; _auto_off = millis() + AUTO_OFF_MILLIS; clearMsgPreview(); _node_prefs = node_prefs; - _pin_code = pin_code; if (_display != NULL) { _display->turnOn(); } // strip off dash and commit hash by changing dash to null terminator // e.g: v1.2.3-abcdef -> v1.2.3 - char *version = strdup(firmware_version); + char *version = strdup(FIRMWARE_VERSION); char *dash = strchr(version, '-'); - if(dash){ + if (dash) { *dash = 0; } // v1.2.3 (1 Jan 2025) - sprintf(_version_info, "%s (%s)", version, build_date); + sprintf(_version_info, "%s (%s)", version, FIRMWARE_BUILD_DATE); #ifdef PIN_BUZZER buzzer.begin(); @@ -216,11 +215,11 @@ void UITask::renderCurrScreen() { _display->print(tmp); // BT pin - if (!_connected && _pin_code != 0) { + if (!_connected && the_mesh.getBLEPin() != 0) { _display->setColor(DisplayDriver::RED); _display->setTextSize(2); _display->setCursor(0, 43); - sprintf(tmp, "Pin:%d", _pin_code); + sprintf(tmp, "Pin:%d", the_mesh.getBLEPin()); _display->print(tmp); _display->setColor(DisplayDriver::GREEN); } else { @@ -343,10 +342,9 @@ void UITask::handleButtonShortPress() { void UITask::handleButtonDoublePress() { MESH_DEBUG_PRINTLN("UITask: double press triggered, sending advert"); // ADVERT - if(the_mesh.advert()) { + if (the_mesh.advert()) { MESH_DEBUG_PRINTLN("Advert sent!"); - } - else { + } else { MESH_DEBUG_PRINTLN("Advert failed!"); } } diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index acf5237e..6914e9ec 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -29,7 +29,6 @@ class UITask { #endif unsigned long _next_refresh, _auto_off; bool _connected; - uint32_t _pin_code; NodePrefs* _node_prefs; char _version_info[32]; char _origin[62]; @@ -61,7 +60,7 @@ public: _next_refresh = 0; _connected = false; } - void begin(DisplayDriver* display, NodePrefs* node_prefs, const char* build_date, const char* firmware_version, uint32_t pin_code); + void begin(DisplayDriver* display, NodePrefs* node_prefs); void setHasConnection(bool connected) { _connected = connected; } bool hasDisplay() const { return _display != NULL; } diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index 8c822a5c..a276a2b5 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -181,7 +181,7 @@ void setup() { sensors.begin(); #ifdef DISPLAY_CLASS - ui_task.begin(disp, the_mesh.getNodePrefs(), FIRMWARE_BUILD_DATE, FIRMWARE_VERSION, the_mesh.getBLEPin()); + ui_task.begin(disp, the_mesh.getNodePrefs()); // still want to pass this in as dependency, as prefs might be moved #endif } From 006cd425e5b5777682822b73ea82ec843a26241f Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 15:27:33 +1000 Subject: [PATCH 25/87] * removing ESP32C6 stuff. (causing cache corruptions) --- platformio.ini | 5 -- variants/lilygo_tlora_c6/platformio.ini | 68 -------------------- variants/lilygo_tlora_c6/target.cpp | 82 ------------------------- variants/lilygo_tlora_c6/target.h | 20 ------ 4 files changed, 175 deletions(-) delete mode 100644 variants/lilygo_tlora_c6/platformio.ini delete mode 100644 variants/lilygo_tlora_c6/target.cpp delete mode 100644 variants/lilygo_tlora_c6/target.h diff --git a/platformio.ini b/platformio.ini index 94c961cf..80f850ea 100644 --- a/platformio.ini +++ b/platformio.ini @@ -47,11 +47,6 @@ lib_deps = me-no-dev/ESPAsyncWebServer @ ^3.6.0 file://arch/esp32/AsyncElegantOTA -; esp32c6 uses arduino framework 3.x -[esp32c6_base] -extends = esp32_base -platform = https://github.com/pioarduino/platform-espressif32.git - ; ----------------- NRF52 --------------------- [nrf52_base] diff --git a/variants/lilygo_tlora_c6/platformio.ini b/variants/lilygo_tlora_c6/platformio.ini deleted file mode 100644 index 48e310c0..00000000 --- a/variants/lilygo_tlora_c6/platformio.ini +++ /dev/null @@ -1,68 +0,0 @@ -[tlora_c6] -extends = esp32c6_base -board = esp32-c6-devkitm-1 -board_build.partitions = min_spiffs.csv ; get around 4mb flash limit -build_flags = - ${esp32c6_base.build_flags} - -I variants/lilygo_tlora_c6 - -D ARDUINO_USB_CDC_ON_BOOT=1 - -D ARDUINO_USB_MODE=1 - -D P_LORA_TX_LED=7 - -D P_LORA_SCLK=6 - -D P_LORA_MISO=1 - -D P_LORA_MOSI=0 - -D P_LORA_NSS=18 - -D P_LORA_DIO_1=23 - -D P_LORA_BUSY=22 - -D P_LORA_RESET=21 - -D PIN_BOARD_SDA=8 - -D PIN_BOARD_SCL=9 - -D SX126X_RXEN=15 - -D SX126X_TXEN=14 - -D SX126X_DIO2_AS_RF_SWITCH=true - -D SX126X_DIO3_TCXO_VOLTAGE=1.8 - -D SX126X_CURRENT_LIMIT=140 - -D SX126X_RX_BOOSTED_GAIN=1 - -D RADIO_CLASS=CustomSX1262 - -D WRAPPER_CLASS=CustomSX1262Wrapper - -D LORA_TX_POWER=22 - -D DISABLE_WIFI_OTA=1 -build_src_filter = ${esp32c6_base.build_src_filter} - +<../variants/lilygo_tlora_c6> - -[env:LilyGo_Tlora_c6_Repeater] -extends = tlora_c6 -build_src_filter = ${tlora_c6.build_src_filter} - +<../examples/simple_repeater/main.cpp> -build_flags = - ${tlora_c6.build_flags} - -D ADVERT_NAME='"Tlora C6 Repeater"' - -D ADVERT_LAT=0.0 - -D ADVERT_LON=0.0 - -D ADMIN_PASSWORD='"password"' - -D MAX_NEIGHBOURS=8 -; -D MESH_PACKET_LOGGING=1 -; -D MESH_DEBUG=1 -lib_deps = - ${tlora_c6.lib_deps} -; ${esp32_ota.lib_deps} - -[env:LilyGo_Tlora_c6_companion_radio_ble] -extends = tlora_c6 -build_flags = ${tlora_c6.build_flags} - -D MAX_CONTACTS=100 - -D MAX_GROUP_CHANNELS=8 - -D BLE_PIN_CODE=123456 - -D BLE_DEBUG_LOGGING=1 - -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 -; -D MESH_PACKET_LOGGING=1 -; -D MESH_DEBUG=1 -build_src_filter = ${tlora_c6.build_src_filter} - + - - - +<../examples/companion_radio> -lib_deps = - ${tlora_c6.lib_deps} - densaugeo/base64 @ ~1.4.0 diff --git a/variants/lilygo_tlora_c6/target.cpp b/variants/lilygo_tlora_c6/target.cpp deleted file mode 100644 index 1e60dc32..00000000 --- a/variants/lilygo_tlora_c6/target.cpp +++ /dev/null @@ -1,82 +0,0 @@ -#include -#include "target.h" - -ESP32Board board; - -#if defined(P_LORA_SCLK) - static SPIClass spi(0); - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); -#else - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); -#endif - -WRAPPER_CLASS radio_driver(radio, board); - -ESP32RTCClock fallback_clock; -AutoDiscoverRTCClock rtc_clock(fallback_clock); -SensorManager sensors; - -#ifndef LORA_CR - #define LORA_CR 5 -#endif - -bool radio_init() { - fallback_clock.begin(); - rtc_clock.begin(Wire); - -#ifdef SX126X_DIO3_TCXO_VOLTAGE - float tcxo = SX126X_DIO3_TCXO_VOLTAGE; -#else - float tcxo = 1.6f; -#endif - -#if defined(P_LORA_SCLK) - spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); -#endif - int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); - if (status != RADIOLIB_ERR_NONE) { - Serial.print("ERROR: radio init failed: "); - Serial.println(status); - return false; // fail - } - - radio.setCRC(1); - -#if defined(SX126X_RXEN) && defined(SX126X_TXEN) - radio.setRfSwitchPins(SX126X_RXEN, SX126X_TXEN); -#endif - -#ifdef SX126X_CURRENT_LIMIT - radio.setCurrentLimit(SX126X_CURRENT_LIMIT); -#endif - -#ifdef SX126X_DIO2_AS_RF_SWITCH - radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); -#endif - -#ifdef SX126X_RX_BOOSTED_GAIN - radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); -#endif - - return true; // success -} - -uint32_t radio_get_rng_seed() { - return radio.random(0x7FFFFFFF); -} - -void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { - radio.setFrequency(freq); - radio.setSpreadingFactor(sf); - radio.setBandwidth(bw); - radio.setCodingRate(cr); -} - -void radio_set_tx_power(uint8_t dbm) { - radio.setOutputPower(dbm); -} - -mesh::LocalIdentity radio_new_identity() { - RadioNoiseListener rng(radio); - return mesh::LocalIdentity(&rng); // create new random identity -} diff --git a/variants/lilygo_tlora_c6/target.h b/variants/lilygo_tlora_c6/target.h deleted file mode 100644 index eef923ab..00000000 --- a/variants/lilygo_tlora_c6/target.h +++ /dev/null @@ -1,20 +0,0 @@ -#pragma once - -#define RADIOLIB_STATIC_ONLY 1 -#include -#include -#include -#include -#include -#include - -extern ESP32Board board; -extern WRAPPER_CLASS radio_driver; -extern AutoDiscoverRTCClock rtc_clock; -extern SensorManager sensors; - -bool radio_init(); -uint32_t radio_get_rng_seed(); -void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); -void radio_set_tx_power(uint8_t dbm); -mesh::LocalIdentity radio_new_identity(); From 870b5d2b702a0604f2735b8ce3ace80c928014e5 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 20:28:00 +1000 Subject: [PATCH 26/87] * companion: 'self telemetry' request with CMD_SEND_TELEMETRY_REQ (with no pubkey param) --- examples/companion_radio/MyMesh.cpp | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index b0905bb6..f7811415 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1373,6 +1373,28 @@ void MyMesh::handleCmdFrame(size_t len) { } else { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } + } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len == 4) { // 'self' telemetry request + out_frame[0] = RESP_CODE_SENT; + out_frame[1] = 0; + uint32_t tag = 0, est_timeout = 50; + memcpy(&out_frame[2], &tag, 4); + memcpy(&out_frame[6], &est_timeout, 4); + _serial->writeFrame(out_frame, 10); + + telemetry.reset(); + telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); + // query other sensors -- target specific + sensors.querySensors(0xFF, telemetry); + + int i = 0; + out_frame[i++] = PUSH_CODE_TELEMETRY_RESPONSE; + out_frame[i++] = 0; // reserved + memcpy(&out_frame[i], self_id.pub_key, 6); + i += 6; // pub_key_prefix + uint8_t tlen = telemetry.getSize(); + memcpy(&out_frame[i], telemetry.getBuffer(), tlen); + i += tlen; + _serial->writeFrame(out_frame, i); } else if (cmd_frame[0] == CMD_HAS_CONNECTION && len >= 1 + PUB_KEY_SIZE) { uint8_t *pub_key = &cmd_frame[1]; if (hasConnectionTo(pub_key)) { From 1ba69f3b8dcc36247245b359da10f5aa3f34eee4 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 20:44:05 +1000 Subject: [PATCH 27/87] * self telemetry response simpler now --- examples/companion_radio/MyMesh.cpp | 7 ------- 1 file changed, 7 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index f7811415..121584a6 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1374,13 +1374,6 @@ void MyMesh::handleCmdFrame(size_t len) { writeErrFrame(ERR_CODE_NOT_FOUND); // contact not found } } else if (cmd_frame[0] == CMD_SEND_TELEMETRY_REQ && len == 4) { // 'self' telemetry request - out_frame[0] = RESP_CODE_SENT; - out_frame[1] = 0; - uint32_t tag = 0, est_timeout = 50; - memcpy(&out_frame[2], &tag, 4); - memcpy(&out_frame[6], &est_timeout, 4); - _serial->writeFrame(out_frame, 10); - telemetry.reset(); telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); // query other sensors -- target specific From 8cf20c7c240d87b87394debfc417651fac26e899 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 2 Jun 2025 22:19:46 +1000 Subject: [PATCH 28/87] * Room server fix: re-tries for pushPostToClient() used to have same packet hash --- examples/simple_room_server/main.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 5ba6cbca..219c73ab 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -204,7 +204,10 @@ class MyMesh : public mesh::Mesh, public CommonCLICallbacks { void pushPostToClient(ClientInfo* client, PostInfo& post) { int len = 0; memcpy(&reply_data[len], &post.post_timestamp, 4); len += 4; // this is a PAST timestamp... but should be accepted by client - reply_data[len++] = (TXT_TYPE_SIGNED_PLAIN << 2); // 'signed' plain text + + uint8_t attempt; + getRNG()->random(&attempt, 1); // need this for re-tries, so packet hash (and ACK) will be different + reply_data[len++] = (TXT_TYPE_SIGNED_PLAIN << 2) | (attempt & 3); // 'signed' plain text // encode prefix of post.author.pub_key memcpy(&reply_data[len], post.author.pub_key, 4); len += 4; // just first 4 bytes From f7e79ada1e0589d07e5aafecb65efd1794270a49 Mon Sep 17 00:00:00 2001 From: recrof Date: Mon, 2 Jun 2025 17:36:45 +0200 Subject: [PATCH 29/87] re-introduce tlora c6 with fixed arduino versions --- platformio.ini | 7 +- variants/lilygo_tlora_c6/platformio.ini | 85 +++++++++++++++++++++++++ variants/lilygo_tlora_c6/target.cpp | 82 ++++++++++++++++++++++++ variants/lilygo_tlora_c6/target.h | 20 ++++++ 4 files changed, 193 insertions(+), 1 deletion(-) create mode 100644 variants/lilygo_tlora_c6/platformio.ini create mode 100644 variants/lilygo_tlora_c6/target.cpp create mode 100644 variants/lilygo_tlora_c6/target.h diff --git a/platformio.ini b/platformio.ini index 80f850ea..e6a1be41 100644 --- a/platformio.ini +++ b/platformio.ini @@ -35,7 +35,7 @@ build_src_filter = [esp32_base] extends = arduino_base -platform = espressif32 +platform = platformio/espressif32@^6.11.0 monitor_filters = esp32_exception_decoder extra_scripts = merge-bin.py build_flags = ${arduino_base.build_flags} @@ -47,6 +47,11 @@ lib_deps = me-no-dev/ESPAsyncWebServer @ ^3.6.0 file://arch/esp32/AsyncElegantOTA +; esp32c6 uses arduino framework 3.x +[esp32c6_base] +extends = esp32_base +platform = https://github.com/pioarduino/platform-espressif32/releases/download/stable/platform-espressif32.zip + ; ----------------- NRF52 --------------------- [nrf52_base] diff --git a/variants/lilygo_tlora_c6/platformio.ini b/variants/lilygo_tlora_c6/platformio.ini new file mode 100644 index 00000000..7f89c3da --- /dev/null +++ b/variants/lilygo_tlora_c6/platformio.ini @@ -0,0 +1,85 @@ +[tlora_c6] +extends = esp32c6_base +board = esp32-c6-devkitm-1 +board_build.partitions = min_spiffs.csv ; get around 4mb flash limit +build_flags = + ${esp32c6_base.build_flags} + -I variants/lilygo_tlora_c6 + -D ARDUINO_USB_CDC_ON_BOOT=1 + -D ARDUINO_USB_MODE=1 + -D P_LORA_TX_LED=7 + -D P_LORA_SCLK=6 + -D P_LORA_MISO=1 + -D P_LORA_MOSI=0 + -D P_LORA_NSS=18 + -D P_LORA_DIO_1=23 + -D P_LORA_BUSY=22 + -D P_LORA_RESET=21 + -D PIN_BOARD_SDA=8 + -D PIN_BOARD_SCL=9 + -D SX126X_RXEN=15 + -D SX126X_TXEN=14 + -D SX126X_DIO2_AS_RF_SWITCH=true + -D SX126X_DIO3_TCXO_VOLTAGE=1.8 + -D SX126X_CURRENT_LIMIT=140 + -D SX126X_RX_BOOSTED_GAIN=1 + -D RADIO_CLASS=CustomSX1262 + -D WRAPPER_CLASS=CustomSX1262Wrapper + -D LORA_TX_POWER=22 + -D DISABLE_WIFI_OTA=1 +build_src_filter = ${esp32c6_base.build_src_filter} + +<../variants/lilygo_tlora_c6> + +[env:LilyGo_Tlora_C6_repeater] +extends = tlora_c6 +build_src_filter = ${tlora_c6.build_src_filter} + +<../examples/simple_repeater/main.cpp> +build_flags = + ${tlora_c6.build_flags} + -D ADVERT_NAME='"Tlora C6 Repeater"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D MAX_NEIGHBOURS=8 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +lib_deps = + ${tlora_c6.lib_deps} +; ${esp32_ota.lib_deps} + +[env:LilyGo_Tlora_C6_room_server] +extends = tlora_c6 +build_src_filter = ${tlora_c6.build_src_filter} + +<../examples/simple_room_server> +build_flags = + ${tlora_c6.build_flags} + -D ADVERT_NAME='"Tlora C6 Room"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D ROOM_PASSWORD='"hello"' +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +lib_deps = + ${tlora_c6.lib_deps} +; ${esp32_ota.lib_deps} + +[env:LilyGo_Tlora_C6_companion_radio_ble] +extends = tlora_c6 +build_flags = ${tlora_c6.build_flags} + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D BLE_PIN_CODE=123456 + -D BLE_DEBUG_LOGGING=1 + -D OFFLINE_QUEUE_SIZE=256 + -D ENABLE_PRIVATE_KEY_IMPORT=1 + -D ENABLE_PRIVATE_KEY_EXPORT=1 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${tlora_c6.build_src_filter} + + + - + +<../examples/companion_radio> +lib_deps = + ${tlora_c6.lib_deps} + densaugeo/base64 @ ~1.4.0 diff --git a/variants/lilygo_tlora_c6/target.cpp b/variants/lilygo_tlora_c6/target.cpp new file mode 100644 index 00000000..1e60dc32 --- /dev/null +++ b/variants/lilygo_tlora_c6/target.cpp @@ -0,0 +1,82 @@ +#include +#include "target.h" + +ESP32Board board; + +#if defined(P_LORA_SCLK) + static SPIClass spi(0); + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); +#else + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); +#endif + +WRAPPER_CLASS radio_driver(radio, board); + +ESP32RTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); +SensorManager sensors; + +#ifndef LORA_CR + #define LORA_CR 5 +#endif + +bool radio_init() { + fallback_clock.begin(); + rtc_clock.begin(Wire); + +#ifdef SX126X_DIO3_TCXO_VOLTAGE + float tcxo = SX126X_DIO3_TCXO_VOLTAGE; +#else + float tcxo = 1.6f; +#endif + +#if defined(P_LORA_SCLK) + spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); +#endif + int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); + if (status != RADIOLIB_ERR_NONE) { + Serial.print("ERROR: radio init failed: "); + Serial.println(status); + return false; // fail + } + + radio.setCRC(1); + +#if defined(SX126X_RXEN) && defined(SX126X_TXEN) + radio.setRfSwitchPins(SX126X_RXEN, SX126X_TXEN); +#endif + +#ifdef SX126X_CURRENT_LIMIT + radio.setCurrentLimit(SX126X_CURRENT_LIMIT); +#endif + +#ifdef SX126X_DIO2_AS_RF_SWITCH + radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); +#endif + +#ifdef SX126X_RX_BOOSTED_GAIN + radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); +#endif + + return true; // success +} + +uint32_t radio_get_rng_seed() { + return radio.random(0x7FFFFFFF); +} + +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { + radio.setFrequency(freq); + radio.setSpreadingFactor(sf); + radio.setBandwidth(bw); + radio.setCodingRate(cr); +} + +void radio_set_tx_power(uint8_t dbm) { + radio.setOutputPower(dbm); +} + +mesh::LocalIdentity radio_new_identity() { + RadioNoiseListener rng(radio); + return mesh::LocalIdentity(&rng); // create new random identity +} diff --git a/variants/lilygo_tlora_c6/target.h b/variants/lilygo_tlora_c6/target.h new file mode 100644 index 00000000..eef923ab --- /dev/null +++ b/variants/lilygo_tlora_c6/target.h @@ -0,0 +1,20 @@ +#pragma once + +#define RADIOLIB_STATIC_ONLY 1 +#include +#include +#include +#include +#include +#include + +extern ESP32Board board; +extern WRAPPER_CLASS radio_driver; +extern AutoDiscoverRTCClock rtc_clock; +extern SensorManager sensors; + +bool radio_init(); +uint32_t radio_get_rng_seed(); +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); +void radio_set_tx_power(uint8_t dbm); +mesh::LocalIdentity radio_new_identity(); From a3f8c21ff49c7a4cb60b84c0ed17484507bda93b Mon Sep 17 00:00:00 2001 From: Florent Date: Mon, 2 Jun 2025 19:33:48 +0200 Subject: [PATCH 30/87] t1000e: light and temp sensor support --- variants/t1000-e/t1000e_sensors.cpp | 119 ++++++++++++++++++++++++++++ variants/t1000-e/t1000e_sensors.h | 8 ++ variants/t1000-e/target.cpp | 5 ++ 3 files changed, 132 insertions(+) create mode 100644 variants/t1000-e/t1000e_sensors.cpp create mode 100644 variants/t1000-e/t1000e_sensors.h diff --git a/variants/t1000-e/t1000e_sensors.cpp b/variants/t1000-e/t1000e_sensors.cpp new file mode 100644 index 00000000..17693022 --- /dev/null +++ b/variants/t1000-e/t1000e_sensors.cpp @@ -0,0 +1,119 @@ +#include +#include "t1000e_sensors.h" + +#define HEATER_NTC_BX 4250 // thermistor coefficient B +#define HEATER_NTC_RP 8250 // ohm, series resistance to thermistor +#define HEATER_NTC_KA 273.15 // 25 Celsius at Kelvin +#define NTC_REF_VCC 3000 // mV, output voltage of LDO +#define LIGHT_REF_VCC 2400 // + +static unsigned int ntc_res2[136]={ + 113347,107565,102116,96978,92132,87559,83242,79166,75316,71677, + 68237,64991,61919,59011,56258,53650,51178,48835,46613,44506, + 42506,40600,38791,37073,35442,33892,32420,31020,29689,28423, + 27219,26076,24988,23951,22963,22021,21123,20267,19450,18670, + 17926,17214,16534,15886,15266,14674,14108,13566,13049,12554, + 12081,11628,11195,10780,10382,10000,9634,9284,8947,8624, + 8315,8018,7734,7461,7199,6948,6707,6475,6253,6039, + 5834,5636,5445,5262,5086,4917,4754,4597,4446,4301, + 4161,4026,3896,3771,3651,3535,3423,3315,3211,3111, + 3014,2922,2834,2748,2666,2586,2509,2435,2364,2294, + 2228,2163,2100,2040,1981,1925,1870,1817,1766,1716, + 1669,1622,1578,1535,1493,1452,1413,1375,1338,1303, + 1268,1234,1202,1170,1139,1110,1081,1053,1026,999, + 974,949,925,902,880,858, +}; + +static char ntc_temp2[136]= +{ + -30,-29,-28,-27,-26,-25,-24,-23,-22,-21, + -20,-19,-18,-17,-16,-15,-14,-13,-12,-11, + -10,-9,-8,-7,-6,-5,-4,-3,-2,-1, + 0,1,2,3,4,5,6,7,8,9, + 10,11,12,13,14,15,16,17,18,19, + 20,21,22,23,24,25,26,27,28,29, + 30,31,32,33,34,35,36,37,38,39, + 40,41,42,43,44,45,46,47,48,49, + 50,51,52,53,54,55,56,57,58,59, + 60,61,62,63,64,65,66,67,68,69, + 70,71,72,73,74,75,76,77,78,79, + 80,81,82,83,84,85,86,87,88,89, + 90,91,92,93,94,95,96,97,98,99, + 100,101,102,103,104,105, +}; + +static float get_heater_temperature( unsigned int vcc_volt, unsigned int ntc_volt ) +{ + int i = 0; + float Vout = 0, Rt = 0, temp = 0; + Vout = ntc_volt; + + Rt = ( HEATER_NTC_RP * vcc_volt ) / Vout - HEATER_NTC_RP; + + for( i = 0; i < 136; i++ ) + { + if( Rt >= ntc_res2[i] ) + { + break; + } + } + + temp = ntc_temp2[i - 1] + 1 * ( ntc_res2[i - 1] - Rt ) / ( float )( ntc_res2[i - 1] - ntc_res2[i] ); + + temp = ( temp * 100 + 5 ) / 100; + return temp; +} + +static int get_light_lv( unsigned int light_volt ) +{ + float Vout = 0, Vin = 0, Rt = 0, temp = 0; + unsigned int light_level = 0; + + if( light_volt <= 80 ) + { + light_level = 0; + return light_level; + } + else if( light_volt >= 2480 ) + { + light_level = 100; + return light_level; + } + Vout = light_volt; + light_level = 100 * ( Vout - 80 ) / LIGHT_REF_VCC; + + return light_level; +} + +float t1000e_get_temperature( void ) +{ + unsigned int ntc_v, vcc_v; + + digitalWrite(PIN_3V3_EN, HIGH); + digitalWrite(SENSOR_EN, HIGH); + analogReference(AR_INTERNAL_3_0); + analogReadResolution(12); + delay(10); + vcc_v = (1000.0*(analogRead(BATTERY_PIN) * ADC_MULTIPLIER * AREF_VOLTAGE)) / 4096; + ntc_v = (1000.0 * AREF_VOLTAGE * analogRead(TEMP_SENSOR)) / 4096; + digitalWrite(PIN_3V3_EN, LOW); + digitalWrite(SENSOR_EN, LOW); + + return get_heater_temperature (vcc_v, ntc_v); +} + +uint32_t t1000e_get_light( void ) +{ + int lux = 0; + unsigned int lux_v = 0; + + digitalWrite(SENSOR_EN, HIGH); + analogReference(AR_INTERNAL_3_0); + analogReadResolution(12); + delay(10); + lux_v = 1000 * analogRead(LUX_SENSOR) * AREF_VOLTAGE / 4096; + lux = get_light_lv( lux_v ); + digitalWrite(SENSOR_EN, LOW); + + return lux; +} \ No newline at end of file diff --git a/variants/t1000-e/t1000e_sensors.h b/variants/t1000-e/t1000e_sensors.h new file mode 100644 index 00000000..8f3967ca --- /dev/null +++ b/variants/t1000-e/t1000e_sensors.h @@ -0,0 +1,8 @@ +#pragma once + +// Light and temperature sensors are on ADC ports +// functions adapted from Seeed examples to get values +// see : https://github.com/Seeed-Studio/Seeed-Tracker-T1000-E-for-LoRaWAN-dev-board + +extern uint32_t t1000e_get_light(); +extern float t1000e_get_temperature(); \ No newline at end of file diff --git a/variants/t1000-e/target.cpp b/variants/t1000-e/target.cpp index 29ca1acd..caa53930 100644 --- a/variants/t1000-e/target.cpp +++ b/variants/t1000-e/target.cpp @@ -1,4 +1,5 @@ #include +#include "t1000e_sensors.h" #include "target.h" #include @@ -160,6 +161,10 @@ bool T1000SensorManager::querySensors(uint8_t requester_permissions, CayenneLPP& if (requester_permissions & TELEM_PERM_LOCATION) { // does requester have permission? telemetry.addGPS(TELEM_CHANNEL_SELF, node_lat, node_lon, node_altitude); } + if (requester_permissions & TELEM_PERM_ENVIRONMENT) { + telemetry.addLuminosity(TELEM_CHANNEL_SELF, t1000e_get_light()); + telemetry.addTemperature(TELEM_CHANNEL_SELF, t1000e_get_temperature()); + } return true; } From 203a7f2bd363e74281bf6cb3b9b51057ef91f266 Mon Sep 17 00:00:00 2001 From: JQ Date: Mon, 2 Jun 2025 14:10:10 -0700 Subject: [PATCH 31/87] add display to station G2 firmwares --- variants/station_g2/platformio.ini | 11 ++++++++--- variants/station_g2/target.cpp | 4 ++++ variants/station_g2/target.h | 8 ++++++++ 3 files changed, 20 insertions(+), 3 deletions(-) diff --git a/variants/station_g2/platformio.ini b/variants/station_g2/platformio.ini index d3f45eb0..03914dce 100644 --- a/variants/station_g2/platformio.ini +++ b/variants/station_g2/platformio.ini @@ -9,18 +9,23 @@ build_flags = -D WRAPPER_CLASS=CustomSX1262Wrapper -D LORA_TX_POWER=7 ; -D P_LORA_TX_LED=35 -; -D PIN_BOARD_SDA=5 -; -D PIN_BOARD_SCL=6 - -D PIN_USER_BTN=0 + -D PIN_BOARD_SDA=5 + -D PIN_BOARD_SCL=6 + -D PIN_USER_BTN=38 -D SX126X_DIO2_AS_RF_SWITCH=true -D SX126X_DIO3_TCXO_VOLTAGE=1.8 -D SX126X_CURRENT_LIMIT=140 ; -D SX126X_RX_BOOSTED_GAIN=1 - DO NOT ENABLE THIS! + -I src/helpers/ui + -D DISPLAY_CLASS=SH1106Display ; https://wiki.uniteng.com/en/meshtastic/station-g2#impact-of-lora-node-dense-areashigh-noise-environments-on-rf-performance build_src_filter = ${esp32_base.build_src_filter} +<../variants/station_g2> + + lib_deps = ${esp32_base.lib_deps} + adafruit/Adafruit SH110X @ ~2.1.13 + adafruit/Adafruit GFX Library @ ^1.12.1 [env:Station_G2_repeater] extends = Station_G2 diff --git a/variants/station_g2/target.cpp b/variants/station_g2/target.cpp index e279b139..dca94f21 100644 --- a/variants/station_g2/target.cpp +++ b/variants/station_g2/target.cpp @@ -16,6 +16,10 @@ ESP32RTCClock fallback_clock; AutoDiscoverRTCClock rtc_clock(fallback_clock); SensorManager sensors; +#ifdef DISPLAY_CLASS + DISPLAY_CLASS display; +#endif + #ifndef LORA_CR #define LORA_CR 5 #endif diff --git a/variants/station_g2/target.h b/variants/station_g2/target.h index e44c2ebe..695e700a 100644 --- a/variants/station_g2/target.h +++ b/variants/station_g2/target.h @@ -8,11 +8,19 @@ #include #include +#ifdef DISPLAY_CLASS + #include +#endif + extern StationG2Board board; extern WRAPPER_CLASS radio_driver; extern AutoDiscoverRTCClock rtc_clock; extern SensorManager sensors; +#ifdef DISPLAY_CLASS + extern DISPLAY_CLASS display; +#endif + bool radio_init(); uint32_t radio_get_rng_seed(); void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); From 8f5e521717c5956aeb910805a60eec50009225c1 Mon Sep 17 00:00:00 2001 From: Florent Date: Mon, 2 Jun 2025 22:09:37 +0200 Subject: [PATCH 32/87] sx1262_wio: hook rxen, specify txen as not connected --- variants/xiao_nrf52/platformio.ini | 2 ++ variants/xiao_nrf52/target.cpp | 4 ++++ variants/xiao_s3_wio/platformio.ini | 2 ++ variants/xiao_s3_wio/target.cpp | 6 +++++- 4 files changed, 13 insertions(+), 1 deletion(-) diff --git a/variants/xiao_nrf52/platformio.ini b/variants/xiao_nrf52/platformio.ini index 45d28740..50baccad 100644 --- a/variants/xiao_nrf52/platformio.ini +++ b/variants/xiao_nrf52/platformio.ini @@ -36,6 +36,8 @@ build_flags = ${nrf52840_xiao.build_flags} -D P_LORA_RESET=D2 -D P_LORA_BUSY=D3 -D P_LORA_NSS=D4 + -D SX126X_RXEN=D5 + -D SX126X_TXEN=RADIOLIB_NC -D SX126X_DIO2_AS_RF_SWITCH=1 -D SX126X_DIO3_TCXO_VOLTAGE=1.8 -D SX126X_CURRENT_LIMIT=140 diff --git a/variants/xiao_nrf52/target.cpp b/variants/xiao_nrf52/target.cpp index c78ea159..724e7c63 100644 --- a/variants/xiao_nrf52/target.cpp +++ b/variants/xiao_nrf52/target.cpp @@ -35,6 +35,10 @@ bool radio_init() { radio.setCRC(1); +#if defined(SX126X_RXEN) && defined(SX126X_TXEN) + radio.setRfSwitchPins(SX126X_RXEN, SX126X_TXEN); +#endif + #ifdef SX126X_CURRENT_LIMIT radio.setCurrentLimit(SX126X_CURRENT_LIMIT); #endif diff --git a/variants/xiao_s3_wio/platformio.ini b/variants/xiao_s3_wio/platformio.ini index cfc8e774..bb5ae698 100644 --- a/variants/xiao_s3_wio/platformio.ini +++ b/variants/xiao_s3_wio/platformio.ini @@ -15,6 +15,8 @@ build_flags = ${esp32_base.build_flags} -D P_LORA_MOSI=9 -D PIN_USER_BTN=21 -D PIN_STATUS_LED=48 + -D SX126X_RXEN=38 + -D SX126X_TXEN=RADIOLIB_NC -D SX126X_DIO2_AS_RF_SWITCH=true -D SX126X_DIO3_TCXO_VOLTAGE=1.8 -D SX126X_CURRENT_LIMIT=140 diff --git a/variants/xiao_s3_wio/target.cpp b/variants/xiao_s3_wio/target.cpp index 09ee5daa..2f443205 100644 --- a/variants/xiao_s3_wio/target.cpp +++ b/variants/xiao_s3_wio/target.cpp @@ -47,7 +47,11 @@ bool radio_init() { } radio.setCRC(1); - + +#if defined(SX126X_RXEN) && defined(SX126X_TXEN) + radio.setRfSwitchPins(SX126X_RXEN, SX126X_TXEN); +#endif + #ifdef SX126X_CURRENT_LIMIT radio.setCurrentLimit(SX126X_CURRENT_LIMIT); #endif From bdc369be67e62ad04480138e9109385520da0bf8 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 3 Jun 2025 19:01:03 +1000 Subject: [PATCH 33/87] * repeater & room server: new SERVER_RESPONSE_DELAY and TXT_ACK_DELAY defines. --- examples/simple_repeater/main.cpp | 21 ++++++++++++++------- examples/simple_room_server/main.cpp | 26 +++++++++++++++++--------- 2 files changed, 31 insertions(+), 16 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 5db62ff1..d8ae9556 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -59,6 +59,14 @@ #define ADMIN_PASSWORD "password" #endif +#ifndef SERVER_RESPONSE_DELAY + #define SERVER_RESPONSE_DELAY 300 +#endif + +#ifndef TXT_ACK_DELAY + #define TXT_ACK_DELAY 200 +#endif + #ifdef DISPLAY_CLASS #include "UITask.h" static UITask ui_task(display); @@ -112,8 +120,7 @@ struct NeighbourInfo { int8_t snr; // multiplied by 4, user should divide to get float value }; -// NOTE: need to space the ACK and the reply text apart (in CLI) -#define CLI_REPLY_DELAY_MILLIS 1500 +#define CLI_REPLY_DELAY_MILLIS 1000 class MyMesh : public mesh::Mesh, public CommonCLICallbacks { FILESYSTEM* _fs; @@ -446,14 +453,14 @@ protected: // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(client->id, secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, reply_data, reply_len); - if (path) sendFlood(path); + if (path) sendFlood(path, SERVER_RESPONSE_DELAY); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len); if (reply) { if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT - sendDirect(reply, client->out_path, client->out_path_len); + sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY); } else { - sendFlood(reply); + sendFlood(reply, SERVER_RESPONSE_DELAY); } } } @@ -482,9 +489,9 @@ protected: mesh::Packet* ack = createAck(ack_hash); if (ack) { if (client->out_path_len < 0) { - sendFlood(ack); + sendFlood(ack, TXT_ACK_DELAY); } else { - sendDirect(ack, client->out_path, client->out_path_len); + sendDirect(ack, client->out_path, client->out_path_len, TXT_ACK_DELAY); } } } diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 219c73ab..9f2149fe 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -67,6 +67,14 @@ #define MAX_UNSYNCED_POSTS 32 #endif +#ifndef SERVER_RESPONSE_DELAY + #define SERVER_RESPONSE_DELAY 300 +#endif + +#ifndef TXT_ACK_DELAY + #define TXT_ACK_DELAY 200 +#endif + #ifdef DISPLAY_CLASS #include "UITask.h" static UITask ui_task(display); @@ -568,12 +576,12 @@ protected: mesh::Packet* ack = createAck(ack_hash); if (ack) { if (client->out_path_len < 0) { - sendFlood(ack); + sendFlood(ack, TXT_ACK_DELAY); } else { - sendDirect(ack, client->out_path, client->out_path_len); + sendDirect(ack, client->out_path, client->out_path_len, TXT_ACK_DELAY); } } - delay_millis = REPLY_DELAY_MILLIS; + delay_millis = TXT_ACK_DELAY + REPLY_DELAY_MILLIS; } else { delay_millis = 0; } @@ -592,9 +600,9 @@ protected: auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len); if (reply) { if (client->out_path_len < 0) { - sendFlood(reply, delay_millis); + sendFlood(reply, delay_millis + SERVER_RESPONSE_DELAY); } else { - sendDirect(reply, client->out_path, client->out_path_len, delay_millis); + sendDirect(reply, client->out_path, client->out_path_len, delay_millis + SERVER_RESPONSE_DELAY); } } } @@ -637,7 +645,7 @@ protected: auto reply = createAck(ack_hash); if (reply) { reply->payload[reply->payload_len++] = getUnsyncedCount(client); // NEW: add unsynced counter to end of ACK packet - sendDirect(reply, client->out_path, client->out_path_len); + sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY); } } } else { @@ -647,14 +655,14 @@ protected: // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(client->id, secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, reply_data, reply_len); - if (path) sendFlood(path); + if (path) sendFlood(path, SERVER_RESPONSE_DELAY); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len); if (reply) { if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT - sendDirect(reply, client->out_path, client->out_path_len); + sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY); } else { - sendFlood(reply); + sendFlood(reply, SERVER_RESPONSE_DELAY); } } } From 6e2a0f3a9cf4a59201e9220dc824bc83dd5b5540 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 3 Jun 2025 19:01:45 +1000 Subject: [PATCH 34/87] * ESP32-C3 targets, now 80Mhz cpu --- variants/xiao_c3/platformio.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/variants/xiao_c3/platformio.ini b/variants/xiao_c3/platformio.ini index 6024905f..55baf2b8 100644 --- a/variants/xiao_c3/platformio.ini +++ b/variants/xiao_c3/platformio.ini @@ -4,6 +4,7 @@ board = seeed_xiao_esp32c3 build_flags = ${esp32_base.build_flags} -I variants/xiao_c3 + -D ESP32_CPU_FREQ=80 -D LORA_TX_BOOST_PIN=D3 -D P_LORA_TX_LED=D5 -D PIN_VBAT_READ=D0 From 75503ed52abccb79ee2c377888ec9fc6e3806189 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 3 Jun 2025 20:27:09 +1000 Subject: [PATCH 35/87] * Companion now can be configured with TXT_ACK_DELAY (default is 200ms) --- src/helpers/BaseChatMesh.cpp | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index 36ddcbb4..bcf83f8b 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -1,6 +1,10 @@ #include #include +#ifndef TXT_ACK_DELAY + #define TXT_ACK_DELAY 200 +#endif + mesh::Packet* BaseChatMesh::createSelfAdvert(const char* name, double lat, double lon) { uint8_t app_data[MAX_ADVERT_DATA_SIZE]; uint8_t app_data_len; @@ -131,14 +135,14 @@ void BaseChatMesh::onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the ACK mesh::Packet* path = createPathReturn(from.id, secret, packet->path, packet->path_len, PAYLOAD_TYPE_ACK, (uint8_t *) &ack_hash, 4); - if (path) sendFlood(path); + if (path) sendFlood(path, TXT_ACK_DELAY); } else { mesh::Packet* ack = createAck(ack_hash); if (ack) { if (from.out_path_len < 0) { - sendFlood(ack); + sendFlood(ack, TXT_ACK_DELAY); } else { - sendDirect(ack, from.out_path, from.out_path_len); + sendDirect(ack, from.out_path, from.out_path_len, TXT_ACK_DELAY); } } } @@ -164,14 +168,14 @@ void BaseChatMesh::onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the ACK mesh::Packet* path = createPathReturn(from.id, secret, packet->path, packet->path_len, PAYLOAD_TYPE_ACK, (uint8_t *) &ack_hash, 4); - if (path) sendFlood(path); + if (path) sendFlood(path, TXT_ACK_DELAY); } else { mesh::Packet* ack = createAck(ack_hash); if (ack) { if (from.out_path_len < 0) { - sendFlood(ack); + sendFlood(ack, TXT_ACK_DELAY); } else { - sendDirect(ack, from.out_path, from.out_path_len); + sendDirect(ack, from.out_path, from.out_path_len, TXT_ACK_DELAY); } } } From 0535919d63e4524dad66c4cbf04971a2c492f44d Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Tue, 3 Jun 2025 20:28:05 +1000 Subject: [PATCH 36/87] * Mesh: reciprocal path send now with slightly less priority and 500ms delay --- src/Mesh.cpp | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/Mesh.cpp b/src/Mesh.cpp index 6029c192..a6b06c07 100644 --- a/src/Mesh.cpp +++ b/src/Mesh.cpp @@ -142,7 +142,7 @@ DispatcherAction Mesh::onRecvPacket(Packet* pkt) { if (pkt->isRouteFlood()) { // send a reciprocal return path to sender, but send DIRECTLY! mesh::Packet* rpath = createPathReturn(&src_hash, secret, pkt->path, pkt->path_len, 0, NULL, 0); - if (rpath) sendDirect(rpath, path, path_len); + if (rpath) sendDirect(rpath, path, path_len, 500); } } } else { @@ -518,7 +518,11 @@ void Mesh::sendDirect(Packet* packet, const uint8_t* path, uint8_t path_len, uin pri = 5; // maybe make this configurable } else { memcpy(packet->path, path, packet->path_len = path_len); - pri = 0; + if (packet->getPayloadType() == PAYLOAD_TYPE_PATH) { + pri = 1; // slightly less priority + } else { + pri = 0; + } } _tables->hasSeen(packet); // mark this packet as already sent in case it is rebroadcast back to us sendPacket(packet, pri, delay_millis); From 5d15a68d0d8f62dc21aeac4ce2a4cd993f8dd0d6 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Wed, 4 Jun 2025 18:10:47 +1000 Subject: [PATCH 37/87] * SERVER_RESPONSE_DELAY now applied to: login responses, companion telemetry responses --- examples/simple_repeater/main.cpp | 6 +++--- examples/simple_room_server/main.cpp | 6 +++--- src/helpers/BaseChatMesh.cpp | 10 +++++++--- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index d8ae9556..c2a8ae92 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -383,14 +383,14 @@ protected: // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(sender, client->secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, reply_data, 12); - if (path) sendFlood(path); + if (path) sendFlood(path, SERVER_RESPONSE_DELAY); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, client->secret, reply_data, 12); if (reply) { if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT - sendDirect(reply, client->out_path, client->out_path_len); + sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY); } else { - sendFlood(reply); + sendFlood(reply, SERVER_RESPONSE_DELAY); } } } diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 9f2149fe..32fe4a04 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -479,14 +479,14 @@ protected: // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(sender, client->secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, reply_data, 8 + 2); - if (path) sendFlood(path); + if (path) sendFlood(path, SERVER_RESPONSE_DELAY); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, client->secret, reply_data, 8 + 2); if (reply) { if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT - sendDirect(reply, client->out_path, client->out_path_len); + sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY); } else { - sendFlood(reply); + sendFlood(reply, SERVER_RESPONSE_DELAY); } } } diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index bcf83f8b..ba8c3e28 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -1,6 +1,10 @@ #include #include +#ifndef SERVER_RESPONSE_DELAY + #define SERVER_RESPONSE_DELAY 300 +#endif + #ifndef TXT_ACK_DELAY #define TXT_ACK_DELAY 200 #endif @@ -191,14 +195,14 @@ void BaseChatMesh::onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(from.id, secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, temp_buf, reply_len); - if (path) sendFlood(path); + if (path) sendFlood(path, SERVER_RESPONSE_DELAY); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, from.id, secret, temp_buf, reply_len); if (reply) { if (from.out_path_len >= 0) { // we have an out_path, so send DIRECT - sendDirect(reply, from.out_path, from.out_path_len); + sendDirect(reply, from.out_path, from.out_path_len, SERVER_RESPONSE_DELAY); } else { - sendFlood(reply); + sendFlood(reply, SERVER_RESPONSE_DELAY); } } } From 647d712ae8a553d3f3aab3036076db7a2667e1ee Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Wed, 4 Jun 2025 21:33:48 +1000 Subject: [PATCH 38/87] * Companion: long-press in first 8 seconds now enters CLI Rescue mode --- examples/companion_radio/MyMesh.cpp | 84 +++++++++++++++++++++++++- examples/companion_radio/MyMesh.h | 7 +++ examples/companion_radio/UITask.cpp | 7 ++- examples/companion_radio/UITask.h | 4 +- variants/heltec_tracker/platformio.ini | 2 +- 5 files changed, 99 insertions(+), 5 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 121584a6..730747e1 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -728,6 +728,7 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { _iter_started = false; + _cli_rescue = false; offline_queue_len = 0; app_target_ver = 0; _identity_store = NULL; @@ -1529,9 +1530,78 @@ void MyMesh::handleCmdFrame(size_t len) { } } -void MyMesh::loop() { - BaseChatMesh::loop(); +void MyMesh::enterCLIRescue() { + _cli_rescue = true; + cli_command[0] = 0; + Serial.println("========= CLI Rescue ========="); +} +bool MyMesh::formatFileSystem() { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + return InternalFS.format(); +#elif defined(RP2040_PLATFORM) + return LittleFS.format(); +#elif defined(ESP32) + return SPIFFS.format(); +#else + #error "need to implement file system erase" + return false; +#endif +} + +void MyMesh::checkCLIRescueCmd() { + int len = strlen(cli_command); + while (Serial.available() && len < sizeof(cli_command)-1) { + char c = Serial.read(); + if (c != '\n') { + cli_command[len++] = c; + cli_command[len] = 0; + } + Serial.print(c); // echo + } + if (len == sizeof(cli_command)-1) { // command buffer full + cli_command[sizeof(cli_command)-1] = '\r'; + } + + if (len > 0 && cli_command[len - 1] == '\r') { // received complete line + cli_command[len - 1] = 0; // replace newline with C string null terminator + + if (memcmp(cli_command, "set ", 4) == 0) { + const char* config = &cli_command[4]; + if (memcmp(config, "pin ", 4) == 0) { + _prefs.ble_pin = atoi(&config[4]); + savePrefs(); + Serial.printf(" > pin is now %06d\n", _prefs.ble_pin); + } else { + Serial.printf(" Error: unknown config: %s\n", config); + } + } else if (strcmp(cli_command, "rebuild") == 0) { + bool success = formatFileSystem(); + if (success) { + saveMainIdentity(self_id); + saveContacts(); + Serial.println(" > erase and rebuild done"); + } else { + Serial.println(" Error: erase failed"); + } + } else if (strcmp(cli_command, "erase") == 0) { + bool success = formatFileSystem(); + if (success) { + Serial.println(" > erase done"); + } else { + Serial.println(" Error: erase failed"); + } + } else if (strcmp(cli_command, "reboot") == 0) { + board.reboot(); // doesn't return + } else { + Serial.println(" Error: unknown command"); + } + + cli_command[0] = 0; // reset command buffer + } +} + +void MyMesh::checkSerialInterface() { size_t len = _serial->checkRecvFrame(cmd_frame); if (len > 0) { handleCmdFrame(len); @@ -1556,6 +1626,16 @@ void MyMesh::loop() { } else if (!_serial->isWriteBusy()) { checkConnections(); } +} + +void MyMesh::loop() { + BaseChatMesh::loop(); + + if (_cli_rescue) { + checkCLIRescueCmd(); + } else { + checkSerialInterface(); + } // is there are pending dirty contacts write needed? if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) { diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index 9d7da0df..92da8c9d 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -92,6 +92,7 @@ public: void loop(); void handleCmdFrame(size_t len); bool advert(); + void enterCLIRescue(); protected: float getAirtimeBudgetFactor() const override; @@ -143,6 +144,10 @@ private: int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; + void checkCLIRescueCmd(); + void checkSerialInterface(); + bool formatFileSystem(); + private: FILESYSTEM *_fs; IdentityStore *_identity_store; @@ -157,6 +162,8 @@ private: uint32_t _most_recent_lastmod; uint32_t _active_ble_pin; bool _iter_started; + bool _cli_rescue; + char cli_command[80]; uint8_t app_target_ver; uint8_t *sign_data; uint32_t sign_data_len; diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index 00263e5e..f0f780d6 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -75,6 +75,7 @@ void UITask::begin(DisplayDriver* display, NodePrefs* node_prefs) { _userButton->onLongPress([this]() { handleButtonLongPress(); }); _userButton->onAnyPress([this]() { handleButtonAnyPress(); }); #endif + ui_started_at = millis(); } void UITask::soundBuzzer(UIEventType bet) { @@ -365,5 +366,9 @@ void UITask::handleButtonTriplePress() { void UITask::handleButtonLongPress() { MESH_DEBUG_PRINTLN("UITask: long press triggered"); - shutdown(); + if (millis() - ui_started_at < 8000) { // long press in first 8 seconds since startup -> CLI/rescue + the_mesh.enterCLIRescue(); + } else { + shutdown(); + } } \ No newline at end of file diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index 6914e9ec..fff0bbe1 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -36,6 +36,7 @@ class UITask { int _msgcount; bool _need_refresh = true; bool _displayWasOn = false; // Track display state before button press + unsigned long ui_started_at; // Button handlers #if defined(PIN_USER_BTN) || defined(PIN_USER_BTN_ANA) @@ -57,7 +58,8 @@ class UITask { public: UITask(mesh::MainBoard* board) : _board(board), _display(NULL) { - _next_refresh = 0; + _next_refresh = 0; + ui_started_at = 0; _connected = false; } void begin(DisplayDriver* display, NodePrefs* node_prefs); diff --git a/variants/heltec_tracker/platformio.ini b/variants/heltec_tracker/platformio.ini index d62771f4..ed4cbe28 100644 --- a/variants/heltec_tracker/platformio.ini +++ b/variants/heltec_tracker/platformio.ini @@ -39,7 +39,7 @@ extends = Heltec_tracker_base build_flags = ${Heltec_tracker_base.build_flags} -I src/helpers/ui - ; -D ARDUINO_USB_CDC_ON_BOOT=1 ; need for debugging + -D ARDUINO_USB_CDC_ON_BOOT=1 ; need for Serial -D DISPLAY_ROTATION=1 -D DISPLAY_CLASS=ST7735Display -D MAX_CONTACTS=100 From 9bcab0949e5c80b7c5934abfd5e2121eed06f4ee Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Thu, 5 Jun 2025 14:04:33 +1000 Subject: [PATCH 39/87] * noise floor lower bound now clamped to -120 --- src/helpers/RadioLibWrappers.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/helpers/RadioLibWrappers.cpp b/src/helpers/RadioLibWrappers.cpp index d37bc498..1415a864 100644 --- a/src/helpers/RadioLibWrappers.cpp +++ b/src/helpers/RadioLibWrappers.cpp @@ -63,6 +63,9 @@ void RadioLibWrapper::loop() { } } else if (_num_floor_samples >= NUM_NOISE_FLOOR_SAMPLES && _floor_sample_sum != 0) { _noise_floor = _floor_sample_sum / NUM_NOISE_FLOOR_SAMPLES; + if (_noise_floor < -120) { + _noise_floor = -120; // clamp to lower bound of -120dBi + } _floor_sample_sum = 0; MESH_DEBUG_PRINTLN("RadioLibWrapper: noise_floor = %d", (int)_noise_floor); From 22058c0ee5c0421270ce848516cfe21101e65084 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Thu, 5 Jun 2025 20:35:40 +1200 Subject: [PATCH 40/87] add logo files --- logo/meshcore.afdesign | Bin 0 -> 20497 bytes logo/meshcore.png | Bin 0 -> 12486 bytes logo/meshcore.svg | 12 ++++++++++++ logo/meshcore_tm.svg | 14 ++++++++++++++ 4 files changed, 26 insertions(+) create mode 100644 logo/meshcore.afdesign create mode 100644 logo/meshcore.png create mode 100644 logo/meshcore.svg create mode 100644 logo/meshcore_tm.svg diff --git a/logo/meshcore.afdesign b/logo/meshcore.afdesign new file mode 100644 index 0000000000000000000000000000000000000000..17cc02a98815dc6dc1d220cb4628038b4a3a314b GIT binary patch literal 20497 zcmZ^}byQuk(g(T^?oM%ccXxM+TXCnjwG=&g@#608S_%|*cb5XirATo-kAC;wx86T* z*4oJ=**UXkWin^xmjDnY31k2OoZQ{is1%&6vGLy;Zxs07x)1L^?f;dSk7G9fc&PtA zYHrRR&~H4Itepe>ceWQmexU;pjL=rpAveHv#Q^eoN+C#H+&}mb44?k6-ECSzAkSYS zdak3N`x)z?IctVvylCbPX_)9~;Oh;;*)b(-Z3etzdb1j(_e~#Z!Bp?1KBm#O#sj`S_fvU$zV!QHsxI{sbj_2%``|Xf;g)q@5unRTHl&#j5)O7*FRT zRmFl&Ino@@y0C?<3H|H+{WI*=;J#hCBPV6o5WhRsEFQE(zhWqgKBN_cldPpHxz}$ zmi+R?83=kpea2xfY>wx3dHDiXBp>zrm9Sj~q8AohQ&x%`^<-|TE~-2R$BF}3`N5Br zN!-p3ii=`YNyXaNK@E*(@Ne_T^c9?*LOH_IUhPg3!!S6_BNj%UjKnGE-bgM|>!E^- zoV)Nyu3i#f`Arcq0cb>*v}hoFWb|Ah{d>Bt=3b?LY+ZbCpCv56^1Cf4Vp^7NvxL8M z{Qm|w7sk1-ex^}OaF5*n%t%*;aNU093Hsfox5)L@QBm@^+4pMWqe-9mZ93o>TVbla z7DcX9v>sRR#?$Ih=$dxV)*)nm$~o22*ODe~*c zm@85^&cXu)jku>e>E`+$Q$5{F6n-VzVcl6)cwVzrCBsv7migmz-Xu$1=k!OOy%~n= znzQ+z@pn(oHltyO4qXwr)h~rrdIO^`J`Kx?Rz=!#BcD`IS@v#C2+l1les2aSiQ7J( zWE(P|b)qAZ@VTYAM9Z>nD8^!@S?mqc55*+okq8**7`72-qooq@zfx+k&(p02Sef&h z;^s}hG8Hy(XxB5&4_XHEc(U0XE>x8mMvrTs)$&UjLDpVR5IKwlxjudRBu`m)wY#a* zBa54%s$)@vSsA%3Xru$SHK<;a(6dkl8ys>~ zNw5-B&sB%>&YRj%_>5^Th5qy-a{)>9AQjSN2&p{NqX9-nIYnyJ>zbobVX{tWA^s&XJLQkqxvOWy%1I0s!G?mPA0MjCZg`E61 za)}@q1+1SL3rSC6Yh%mb?y*16es&|w3=Eys(~G))Z(*TgWx~O$1YwDpn5C}Lw0Rt= z&qh6Vg+y61Etq{j#^{<>vpI}|iXx-ONWwJHpnV?=6-8g?rJinXEUcyY*2o1Y^h3Yu zY^2>>u@Ms3Gp;$aao67jSeV$FM}3%m)^$j?OF*B<2unen82yvaK)B+MmoKoW^@>M< z8eP7gUd(jO#uPK5r4#?%?FmbBVY;(l&CE9GAawm*2<|S#3K#C-&I&gN!ullnVWQ>F zUFiP6tK1VCer5UO?Ngu6%Cq~w(q*mIwz(IQf;*uzypf(avXE9>Irz#<$yEKcruQyA zw&gBV$3*fMYNYokP@rfLEftzPGQ#zjR7`|x3Z4ge_{SM2D8E~y-(emvL@BlzyQoT9 zR(&2NoQ(BJ;7Wq&a2l?O_jYh}G(wJ|#ROS6`ewOtRlD(!{>1e112MCa$f6uw8J*SH zI!n){aRI4T2u5-YBLpO@E!cncbU}7xipv8t=?q_4MIkF8Ah5!_&_av@VVrjpgfQtO z1pg-6D{vKrP#ybz(I~sxdr;S^OINh&n&l4lCu>_q8N4DpGUpo8P%ujZLCCkUoF*d~;|T>@Yt=Y(?W zhZbkUHydAuW_mB|YM!Ts)gu*wXkC%l|CNNZh{%CoNmafFfk@d)18iGWSsxJd$C8lC z`+j)&b*g#ekkjRNKT=X%7nG{jPC!Ed<`bRio3nal@F@qX88pOU(J2*G#>K(#Q2O`1 zxK7jRJHxn2U`5dsTSUrI1l9TZVOt(jYZ(~S7rM1B4o=;Q#+O*`>1Vm_ppq(tAD_Lg z4>yH+(hfF-I?@j|+Z#cprP5N#kIy~_$2XwBl1X8Qe?Gn(`m~Ed>v;a*eZKJZuGpY8 z_~i$*gyumPw8(W)F--(9X=}E{zJ8DB^`K?2PUn}Yj zbX+sUUC1f=R*W<=lm94|pXx(ySiB_*zN0ijt&l)Jk4Dn!OElAvE+8U=w3N2(P6BrwWc3I#Er4;Rno zI5AGdYv7!WC}&XB!iVj8Q{l&wb|glu=`k-3BB@B|(P?71c1^>$1+@6lVGqAx*S|

u;rIY?=}Kfk zxD)%g!^O&^Sr%6O#V`zCYHy)?;@mMCO;ZJ3D_+{>%c)S+p@}pUxlOxRVZ>rRkCmSa zP2W8$euIAh6uO1rzYbaH#C&eSm2rJ%ppFw0@+zagr-7->nW|XY_(oi#YPmKu+y!dt zR*O}iC^WFKto=Ug$PG*Po0y?6-aK}bc}OvDn<==Y%T*-D~9yb^X`1Wg3o zgBzO{SQirXD2~jiqtH&sX$nv<$HQR}M1Skv0;qQLU@*BQR(nf_qTxQ=f2-;aA@}tj zx2=OEC}N2Ix?L1Zo($|kK^Z>dg<9vrW}`VO*g1^=T_QFdk>pH4vmiHI~R23;hL*ihmHCY zA8<8^^w**5_qZ^`L? zrdV*TRxe{uEbgX%cK6lM$F-jE4uXeWIhhwAGj|d$pOQhVrXLAGR%cczXuyGBt1~NM z4i9!kY`l$~GAiwYh-uZg*ad#yeKnGa5YG$1R;g9LMs~cVYAV$qMq)X}F_YxZh=)+i zXxGd zE=y>k3g%@-#~Z(%S};r)SXJXAa_MU{DO>6JQ%W`)wh(cFb&c~_vFQS3?ha$50^c?J3G+NdSqnG!g^kH7vOXuW7eclxrk8%$yv^Q zs^Sd3-Aa$@X$|k?tfJPw=oxYL#*C8Ls=Btqz26|HKs|mUVkLtqPMr)IrLh6?;8BOP z!-=Xrs6cUYHATfZZ>ma)&+Ufvhel%-h~I1;hSotztygq4u`cz~zgP?ri(2t^AQQ8OUjhogLBNc)A>_e~I1tXZ zO=BwPw=Q8m0s}Km=(sr>1etQ)ut8(2l;X6@#I8i}3E9k^bp=1gWl zK4Z`#O2Q+MKG#8$d5BZNbGb|h;|i1O6KJ231xLPw@GUE-n1=8!*TMN9(q@^neGlPA zu)!E5kCs3PzJL`fS2zsvvjw5P8%HQUq!?d;d_mBygJedl!G4Hlhh-6^Kr#)XTb_n7 zL%fB2gLw+z4^o3MLy*J>Awv+UOV*K*kakwAIxOjI;#p16FUZ&3_o#pENvKljoUPh~ zU=p$mvhTpc8#?5L!l`jy2=suX|3E!KR$3N*1mHY%^$%8e2GHL^u(NPk$g#R0NbPyu zujgNS2Vicq-{_sJ+DE#k>S1rS%~$Eg;Kx^Iud=5xd5b)u@)0>Gc561voH?1Q&}8hn=8vv#9rKbIe7ONMqXrmLx*47U?@P{~eyju_flHWfzzvPDZ(sLB zMDM=`v4_xf&MJF0LzpHWYw4awA#Po>RqF*9`tj3UG2iveHA*b+3iG1h62_mm0ThcF z<&7`Ak=oDBf9Mwp@7|KL*C?(em4p}j-gxahIzDL|(jQ#Ej%b@~A{(bCzjAS1H>Kl_ zqJP@AyB3~HFP%0S=aLfQn(dzE`WH2%PkMxYl9egQ&lcF|mK3t!oR}`3LuGCYK!&VkN8!Hc+GW0vtWK8BF74NBl1^~`{Mp>f zx;^p9s2SZ?-<7KXk{oUj@rht0D}PBU!WTk8SfKFh0=jS7zS-FJa1(D;Qu|fL#&+x~ zuGx}psw=;NvixAvfRk&#zP0?O@x`BU=|pVUzy5rnV-r4uP9oc``f}{vfnl1vRi=28 zN$c?v(nx@EEn#$o0T~IP?2S&6eCEs?zwH_k4lMh&OHTEVf(7Rc3ilH{^Jc3kh9KCH z-)SGkh!D6`(4f#=#Ic`b8w1(rb_X-i)^j7WwcrT;QThfe>h4fUzrl{}yO4C+A1|>y zB==&CT~TPB#exg%6efFjKIX%E46FV_gy_$yD`a6d89b&hWS^@*7VD856pYsel1(V_ z8BOw6SDW#6M-O-(_7C;hrN^d^Zxo{dx6f_J`cuiHTAl=Na_O$@84brzRY0mhFEW{iIiRl%7hpef+!id!1s8n{>&S<`5sF~n3eIxpiYts?OqgPRr^TOnew zzDKSB2CNgUhesQ1&~?J__@UH9PQEn-tKf&b?BA#kSXs?*Rw(czN2mkMHIIN&oliy$ z?nge9`@MdCqaqal9NXCeA&TFw#4HsW=;kY6{dV(E_<{&jaS?I^*GK(q0n3>OhS9%_ zgvWHg+E)5f&k1UKnGReg%eVA$ftg?}7CqCkTRa-OWBvF7rhEQ{= zz+B?J1^bkQ#yI}dNRfo^79A{g7a-m1Qc6LkI-YA#Q0+mhcYW`fnm)g94L7;Z1wVX; z)1gG|Wq<*FkdUDLmkh-1Ess|bxKLE1P9b)>r~>!ltL_xsLKC=CfYnPg``7i=5fSz3 zek%f`^nQoYa=A*PF|QbVE2DKRfF#o;(mUs_pK=$~uMLTmPu)Vkt*CsCw~UL171MVP z8gu@{=keg!>anu*&)4#5>F>uPXuF?D4K=Ibt3CWNe;K&Ic&75NmR)xnfnjoRt%Ln~ zXU#bXA3+DFkv#YeBj$aLzYliD$JW~hcf`+oG2~%tR5Ly!stD4ScGLtCdBqT)s7`%x zYreN*Haoes!$j(LDEd}x0I4NUqeGFWohZ_Eyb&-aX$;HRo!CwQg!Y4j)#**}C;n!^ zPflr3;04?;$s29u0%(=|f#UvW@VXJ;NniSL80|Gc*UZDQXu~%*gMgRr+HwnL+14Fq z+*d^>8vwq4P5(W;PW3gJ@lW?o^0MoUii^s!^~Y%T?l=!TYbF#0ha}}CGexsO3f=fP zx|v?}sKIDSe>_Wt5;?7t!P_I}#C-?nrREqq@%66);(t6F`Iq6u=K@7wEqgHI_qA7C z`JL)V-183mFY_hPH~Xf_Y=UDd99N(7ZeuAhUHk*rzd&u6F^F5Y;J}!DGBWP@U4S>Q zA#CuthAGHkj>RAQ6N=a`M$Fo~n7ty>E$^ykw))or^B7y$-S53gzZ;D z2pY!iD|4jw+0RYK=XS=`gpa?ZpIaDMjOk@fz}H4`{-h3%n_d;ShkbX&C`0h`cXq{ipK{nc#9AWv%Re}5yx3bETSE&r7a=!C7KSrP?LZ41KG zF)rZ&wV5WvO?X2DHPoBUUyYnlC^)wsc z04&2?kUv8h+YgB05Lo-B-o%2u;I>@v*KY)XwEz3$x2e3lNZpuVboRmk*uvXdGubB* zurA;as)OE=13sI{`oRuj35U!;@BrCu126&P`-OffFu4zy{!i-_3|JtF9sO1C`N`@2 zfe8pehLl{Ign+_WS}x(47rTgSeCpJCc%n(tpuzuB)LOd66bAw|e$^F11VP1zz98&2 z0ksDcK*U1sYJ2)%5CVR{@ja)yWt*Y_|5eaEoq@sB_>o6AB>=$`uN%bNdXBQcm)naU z?3WfV79JSr<8qv97Sed})Ohil`2W%GlO?9=1{aD86f_{m-q(fiKlQCgF0H-`P3&hd zC%6SAV8|Z5dxjYJf7g*nvepkVW&Q^O*WnO5;DW-nkL&`tAdJCpO)V3FjUn~VB();I zkUPNszlC!cMz}%gMlfFM!uaJL!3kZ5`W~SjJol1oW*WEz%D@K~(7)TV4N*W~+D;DO zt9WpKq2#6Hhj!s5jH#K+mHEsN8FV)pb=L{y;{r~V?{~vB;=4?ovGpi-PCDN{F=|cO zyE@5PXbRmCLSIs0u@lxwW_M!MGFIBQQMx!VzKf=#sfy5kJi+4aWb(7XPn@(7P8EOA zn>4*_nY%d8ffE`_@%kgy%FK|@#Ph?9CxH>452u`SSnJN?7SqsA{;ik0c>7jc zI*$O2yXLdpI%m*_@Xu<$enioqAL%C%W#hbdLGjHVutQH>68E-${sgri8uP&T>`Riu z+(PQ#MOFiyl>5K|&ZdPkh1nz?W4G)%Va-6zBurx49z)-vK~2P9R5kuk7l!zuZd_jb zwjM)3ef#3Ib~{m8ebk!6_w~i4+Ke~aG%>61gOZzicJGcXP5cDha@tDCUs8wdzXoAU zT28%o!-!c>LV+2LrZ2*8oyP=oU}MuSPRT!e`Wb@0X#hK0K3YHtq%X7+x!a z1Dn~&GX`3FYM)Qp7^`Uqz-oG8iE4Er^`z7xHw2#SF~$b+u-c(N@ZXumz~uBKO(QH2 zb$#o}3ITl^e$BoE(`~oKS@*w(9#(0A`A}!_u`}FwHv2;4y%`HJSvTH3 zwMZ241Jnu83nH315dHL+(;v zDe3xh-2n6wE!!lm@|yfpZ53p|FRXg==Qb%)+H5&gVRYrp70uxbXu@5;JBOm@oWd}$ z7{8QuhH&eT3)yDKlQ&KW->-`?mp#SMHwWMp3Pt_=X5kKKe5Ow?Acq{X-u={H+;%#q z&nHhT4lG8!O9wQJ;Ey;NL_JH#e#?4iW8Y)lzPf0b3GuuhxV*CyTZdnoa>bwH0T-|m zlRsUfIVhu>p6pThu4h^hD#iA1mt!wKf8*I*#|2m;3tG%(J}$D{V0zB_rBy$wi~eA> z`rI1iA^8dxX)JK5sw1YyP^54|vZAZ68GI8it0h z6aE;(RX1;k(7A~OJBHb~z~!O!U;HW`2l-5sNh#~#?HIL~`yvRr1TGb(oTtOCgtPF+ zCgaRex-h+Khq{B&PXDWsanCwBzt#kF3p%h=h1(O9xS%us^1<7?bRk6~^kl7+ju*fc zKy_=72A_~RY#e8J*V&i#MrQrOCRo@+=J$mkiFv!X+x*~&uEt!d3y5nnco?=; zUa7olA-KxoHq9WgOZxA!n#xDG@}MUR!WgJTf>gqyc~G*iwTD0+RZ&vxc0_yw6S4V^M3P-Njk3 z4glNU!u_LD;2zh>M( z0lK@oaSyOt!g(tP$u7ocjh6Y3Hdqu(#H1uL*$4j80T39X!a>c-hQ3l%|6v`6a9u(O zqu@992Podu_gi_Xm$z;87y!nzM){xl_AZ6%)(zxMh#UYRnl!iNQSv2gpEMhUun0SR zhE*@<i0)RPq*`RC2VEM==ZdER>9aXRrIuc4Pl=%tyA_IE@9eCqky-L<@PcgIV#mD7ZTpP_hu*CWTwCt z!)Qc6V@nUW1xekFl0n^Z#|QSlJ1XI-D}>wVj9nPnxwEhnIQhNxDzAnt=>1w>c+EqY ze1^e0cYJh<_3^Kyh%Gzc5xKah%$~B9r#@d82HQ=s;Zk2k@v}lzsT_S=_JpLDNcbOuec@@f z<{PoJBJP+2G+`W1GTsz2H8kywz9lmhP$rr6Up)5OdysH|L}O2SdmGZ!ml=N+lc;Z@ z`eD@_HW!u~On@9Nuha^9Z1$7YyG4gc_UFFcD_RnsvZQzNNxnr^;xK>_mSve%dh%#W zh~r93t0d5^F+gS-772h|J8`U31@}=F0Kf$!&&nWr%-Y9a6KCR47XbJZ|B6J*JYc^1 zYUfY>)l*>0>9vnO;nhXiU;HMT$^n?xDCq)qL7Wyc=OW=Hi^f}*%c-U($v9W&7s4s$ zedqkI`szj6Q+h*^C4WcPQfT=qK5e?uqn*z^stf1>eeIs}<7(_~1 z!XGQo?eXMT+t7I-8B%3`yBEQ=)hzo&UUVyVNTZD&@henA@x+DjI}>yr8W$}*dr{;1 zwH!&vo7s&ky?~m*Y1ui6(Xxelu)uFO93Da}T-m~DPPa}JsCMakMXq*Vd z$QBmRN5(fPc0vcpUVqh0hl|+(VW(Y0p2z%*tuM(irsL{6(zoMvP2`Me{7y%6d3UUy zk!xyyjza-YGfG;zy=S;zCwrWIn}6w{GLU_zahv<;$=pxCzJ@?a=3W>INWpLT(fw|9 z$dLN^XYHY2N0??&RVtmHRSgmepyMhW_SseWp{8OfpITMWDO2v4=U9P|Z-0GS!pthf zyQio}b7%N6C*np!cSNOT*Js$@Ff>3+yn}QJ1IS(=zR)ZVpv$klCs}dUTx$R{P0^`hOM7c@>&+|MT1gb-aG)zhr`83PMv+e99fyaT857)Qga^> zF>tS_-{o5q4c!c+(oczgdd_?{nFpM_|4x)jZ=YJO$0sv70BO>6S;cW^Vd=70OV z_W5H++pUfmQkM<0Bk~z$1;t0MNP|TjqFmRgX5Bpy0huciP^XTzB+?N83o2i^1IrL(B#L4u(*3_(QJb$S6P!s9nNkk?DkqLoPNl_NH%kCbWt8+dQb)Ajz zLyC_(j6hrmserrT3IDqnG}41HoncK_fY2wJ0LUYQ?#Afm%>qrkwXqg-943SAN%ssk z4a@)TmyKIc*Mx7{?%Od!=au@SDs(L%W~xl{pXRUoWDvzF@J9WLZQloW9r#4N7( z#uN5{+Kx=NBg3F&ovro7eH5Tqi%d^gG#ftQ$hzIO3r+-p1GkP~p2(G8M=z)h6|beH zc?Yi;K6@vS#rL=D(v`5o1bBwCe{Cc>+hcBLn{0_wI$M=KNEp=|L;XqpmmYdLbkfS< z9v{t+O|Edpvy6;Rt+;`DEm32pr@o&~o>4`N8<@r>4hXAWn5w&E05(I0x?1TnZ@bQT z_9G6V2)voy1JKc=0^d$GF^2ilsP{86qIg4hv`)%UywNe35dZa z*&ZcE4krNG{@Y)w=+Sk_fa%%Y2~7H%h##)l=e>d`uTUpR{0wm7A6(9Qge`6(={$#| z{N<5Lqt9Vt&BglcSc0My5QgMnUqQ{S%bHoF93Al$t;+gWmxc*Pd7LzVex-tjBkXjv zJ+gWxH>al-IOQfzY>|u@mIVSu<~Dl=3JV*jL~JpkT%nXW1$?%D>a7kvQxc{(V`NPd zT$%Ex@VS8H-&a@mf67M0;!BB?5z($;*i48jGnIZ<<_7;O`hek? zyg;RC>G0%v8lMSYQ5X&XK5?ao9>8i7-ItW0aAvE4+Z?`=gEiwn9rXTU{y zRu1bi2Hgh$ugJzUv#FrGtG>vJ^S*;isOvs{AchUAoKG2CM7yx|b(7-XS9^ z*ul|GF!XOGuLrw1Vg}&r5YqZ&_*anlN78qo?y0)gQqVq+YD6MH0CyjRNUOTU0SHsr zBfx=a1f}f>q4c`{3<^5t789&}xX4)w2$^f~J8xykXF^Nf<&KKjDe+-Hhlqimf40k+ z3^BAJl%F2sgOe^V$>Vf^S2T-vUu!D8)80!~H2C(osb1T-bAPG=@|Y6)46|78q{(|r zRGH~!XT>;ukpMR=Aza{@pu4L_c!&aPsG?KT#FMlfxkV@0dh#e<9JnBavwlT??k?&? z>82bFNBh$o6L8k{)%_!mDQ_t7mga!E(Z&xUC|jj29i#1X$v^83MvY$yn^g#eayy`a zYIC#Dz?909_$~%}u#MF-ihJ*`zRXK45$d=x^J8K_52SCDF7^{M);m_-H~5gVYF01$1L)a zVEifo1PwS~#ji3Ks~k%L(LX$k*UW3<)0c$@IsKh=XYOgy)yyP~*SHoxV$cp056(9w zk{+Zgk{1&wRnW62$9=6Antfu3Y<|yQ`jPcJChBG)ll?_QJ3k`VUe24X@PE;sx|3&N z+vTzj%D*K@v#f=WjHN4u_kGSv+8fgsb1cYV%(UTHPoR8!QHd$>aB_FopI`p?+ji4Z z)e|NSCVehV9z?jr;i=mmi}>7@RA!%QKr4?P51kjiLO^V3JWG`p623{Bhy<$pfNOtu zbosZ%uwa^Z8!?p4^pF3_pD2L5^t4oAwE{3-S zQ~JbNpm{!lP-frqa~h(UB^o&8!46sFhEqfB)5cqfCXn?W3QR{o7v6gH1^w4>B#_4j zEk2;2D0r5ZlEE=yqf&c{V^t`iFh#4HGJjbF1&EePC83(c{#gAKS0BDoob5dh5cezv zB&&`(k}mWU-o&>cQEH3nf>s#e^2P*pw*8mEGz_c-S>zjXNr57Pp@d%2_xwsIjh0vx zKwj2qDY*qvXPsteI7&CNUYE1Cg3;;=uYxuLSOAc|&R`aRf&K;s)(FiECtaoY^;guN z!axCXV;X3sbU;}nH?TQMk`_tF9d@@Kxgo0AW2J{bdUVZDx;4GLqPmMz%$;i(;l)Mv ziQ&XSfXDzBez8C~)|B3LcS9EG#j#n!Z5IfD)@&NB`bbr+wQZmSh}VsM*VPtCICkZ$ zm-P#U6H5hsUE-L!P$OTnBGKK*y)Dz16^LkwvqeKBiX-Whkmb0rYsr55H~+WyBB~j~Y#CdXFd2V9q3zc69e5<;;+N6XEnM}i z6-~HDx&v(hAX4u@37^9KHI@!u^RE5*r_$FFCz3mn3V%fZAZC!+((Z;Hx0xrO?=OyM#5@b`8$)mjXEy}__+Ds) zQ#eHB3{;U^)0sM=js)0(!#juG2HP^$l6 zR!p}?13=#i$LB9pi4(Qs90;)vxIL_Z-YQ3Fh-^#0kCr! z8Ud<$3BZ2yd>LleH#%PDbBE@OkZBb0Ea*H6Fe4l}F8vXleuzjgE`B0MQMhu&wJC!j8kCHQK}OWI-DEk5M9>kVR!;l! z1@%xS(W-j|5@?(f`kOmKv}kFXIjJId*5V%N_n(&I!1T1emjnTT`jZ!NWs<@TnC~gK z05nFqHQn^XOo6l?eI;&Ed;WlxNE_nSb3o|1-G0A{cF6!>i?D@F36Qe{tTbGMs&+QH z(o$~_`n<>aOh}A9cj|qJ`HZud(g>lpmeYv2sc+s>`1G8h{#BJNwDE(>tei)2CahM7 zEaxBeX+_c_libiuW>;3f# z^3licswEb=ckkJevcre3Bkbcee|JLLU+}nt&@r=nD=Ds>e`+)}(tDzaC;lG4Oxqy_ z+tENk=4EQE(5F~X_;`6oiP>bjjQx(;;haHC>>|%tzm_CCO=7>r8-)oFLr|EU_v=p? zY{oF^=I+nC(TBHR`mb_UA!Z2$ehN*7I_M-Bt(@JAaHfahqb;K4vn_L3)-iuuW)FZ@ z%oLIrggzoFR>41qC8@k;<;T$MXnFH;8Rk8XZh@Qtx#4Qh{#Vb4CYA zvfigW2twh@kL}3Tns%Dl9eYs;)y1P~I7ZaS@S*q;4QJOfv$Bl2d!ZIr(cXsNpSL#p zR^QMii+g5~h%*4q8~^j18}%p#xhalOhU@0-XRTQAhiI2yRJorwTjy)cJi+8LEvk4- z#+r+)OP#l}rn6}&s_G2xuaEuXr9FVH*SEV`_e_IFodtN)S%Cm^cuWAmBlve004NtM zXN6JIo?U?jE=XHVk}}Q`V9FxE<$GUY+mDZtmG6ARh*TYYP}Z#hH#eXuFd;<%-7cwC zO?3NQM47CS+Q-^bfz`1^YJQRXi|<$63!N@4y?XeXH>mG?>3&1xK7D1g@3#gLknt{Q z_FnPJU!lw*$3}*YpGJ$Bin z@;3Hs@{#j#;AMIz*|SeUeDua40@1I!aCt{po^F~Vvad$ki|w?pM?LSj39lvHI_2VG zv~dJ?d)45!Sh7I!BgcC!UEPiQ<;>`26a>vbH^7df-cwRgfHtMl->amqVu|7(mBs~( zJe_iHfC3z&0a0zWnEQbSgJz1lTSxJ_Tvk^B3V2`cu+2zDPzr9nCX-BV#W2(MKE|h3 z>F9$df~hSW`Q*<-pQfu~UngBc;ZC_@3zqFagrgNm7RBq>H)CjT9;JIJ1L~yhLM|3< z-#9|Qo#M^zu*aWr?SQ;dHYXZ=y2!jKwUYf7f|FJCiqG&#C(l!6vblI2knb5j8l%ZX z87wXe*ie)F^9n{g5%&3zg{!#op?Q^|;4h#0io?sUjquyN#Cj(AASBJ{P7SteqL$o* zn5eno&)-Ov`D@j0fw(OIyrc$*_q?mbSSF~gw${Z((`PUWSHyLnaNjrpVvv^&vGx*Y zj-Y_ypz0B(=}xCWPVD?WSuI;dDf>oz*n0sAfEOx*7Fs+w!@vM8$<9$^MJ@9bWgj;3 z7x|%iS))>8L7S785tE>nxt}n@j8l&CydV6D{$Ik9A80_<8|taFZ>j)+4)U4MRr*q* z%qkob%-G;11qF^XLmBP;JHM75UvsGSVUM&A(+;~yZ3`YRoD~aGxK%Z znL6PVMUds`9xIA)U8ZSbQ}VFF76V!qt$EB;4yGSVb9&)a36+qI#xw(fns-Rzvq;~LE1f1JfOgFNJ zpMZ%1Y@*k;zf;?!&^(t3baqJl-XM2UykJ^Vv#E~&vPE8AU#{Ip7_d>WEvz-hN@id* z9Z|t|I+-!qgZ*3%m6l@L*dV2sJjs-1?2Br_dbjO|eysuIp_nKd4}g?E#}h2197%z? zPh8I1KlOdS#3)UV7v-tQ5+`LZ1WZ{T^%EVs+adP&8xTF#Pqmettb|iDi5;SSq_>2I z5zUB0*r^i(dzyZYs_);9WY~aL?9Tjf6wtKo2}od7PFQzxYeFK{bSedhIVOVCMf#}l zt8L3+eJ5C?)DvG%8Ph79dr49XTH9v$$H4l-XzR1{8*Wj`;NG*2(ER!(yKg0;I;?BQ zPm5$$szh$cU}24_bTqF9#U){uH-~lx#*pVVqt8`j`pDr}yYgxp7HFaYeai2#kzh65 zDd_Zv-8u*SgFLU+gIC_wa7-Z1wvz zu%-vS-}3&>A0DV69D2HmBWhR78uCAZ4ck+c4n0FOiYj;FKriAt`kj;@o2TXw0Jh0q z$}UJDbf5LH5>7E5H+nd8{Tymu^{0V8GBZHxqekHs9ybLGUAzrFh1dMPSGAwleCthvK#k3IB{F>hK51JX7)CV0QdCMlsL zL8~x-ZTRo&RIUsBu7B)LThPCqXfDocO_B0dA8RrW?z9A;$O!>r#MY{n#Pk+%D9RWI_k}85@K~z*X$DtkF zozV+c{qS{Z4G|I#vUieC1p7B#;X}KKi&5Q@Zoks2YVwnacWU#$)3x~7uC@TcA7oE> zDYWtq{Xtqns6)*H$;U)=7m}3uq+Z~V09bPINC`?nf4j$X&c0igKHm!D9TDH8F^q5! zde@&UaxHJmO67=cP-hU2RDv0FV%0(2ybi&2#WlP)X(1TmZbtstXLNf_BCzhBvhh`# zPNLz>dW+Fdq8%MP<>gAT3L6|9-7arv7zzp&;Lr^cPo6nsOuax#H(G8Z={ewrn4#8w99_r5{X-+Q4FdoVke90f_*!E}&$w4X9gt1Yo9E&4 zm>jI#Pn!V1N*D|OtxiEIfF`xS2Xowh2JmONLDW(?-iwB^sycS2GG;LV0Lo(@7d?Lo zcf5E?=>i-KOilVE0jj}dpJtXq-A6j2qIantb;^WZ!x?~|VCeA~Oi3|+peq1qJ4Q7( z1i0HjD90??ARAsB#*@Og}Xe}Q|!@%Ys_U^UeWT*orB z*(MC15kT*u%mCc5XcdW=x{l+MYID}I0)VICGc_bSE=P^@SDr(qrk^tib zl>@j}bOn33Uyzcx{COR~v!+=en$y?4D&dAP*}4!ws^X#YS%xWv$KiLA zN(j-zmZ(^c;cN?^*FBh0d>O9i@Yq{!vz0!gApj~k9`@2Em$3O`BcvUe0@b5Lt30PR z(ULnV%b~i*^;utSEqbexG`j!*dbF3Y`OrLzApw9Ue{ybOWjTtjRN;F`Wj}!3KNBu# zc>4(RRtUOy5?-oj&Wj9)HUOfr<(?!MVzo@F^L7N=8*kuULJ1&ar$nFg8p=R~N4Zmf zGzmj6cfvg|F?9E#!FL?J|O^2 zP+`X=9woVtJOGd?%pBz*H}7Dz?w{bLNkpn$sv6qRc5Vn@1mCpGVBQSBTfyWqsA)Kf zz>nY*9$ATpFopOW4gg-@c6-lBh<51X#!t<=U>x}~jAHx*2LN^9oZJ)f;-su0634nG zbXC>oD=l9{@9!d-8?u1gC67a`;|n-_P5@7XrOzS`t))o37kSF%B5t4f*+;Z52In-T zA4-98`R*r}9*uPo_adtc2$)g<`Za8we1z59zk{#mV^jkGzOKU$<+*~<==a0#R?)m( zdEZPdCbRbh#)#5D(i@NeR;yXMo>Z&rnD;Og^V1|OrCx{I#vRNM0O*qh$o|cTu!Y3I zjw7i;PpV_`-+S0%COg2*-6yHBt`9($5CG9LlaDr01_G0i1(aiodvK-1Q}dp{&tG^6 zi}gN7UQ6X6?{`ry<{+dp00aQgN{Sg8$tpAJyx6yX-c^_^(dJD=7|vi+zDemsrXy!se5n+pieam?>Sz_ z|sLD0ToF11Yox7#Mj1^Y~xFjQ`8<|F1>3&a}Y@yL~AG(6ywq%GeGS0_bzH zTbu+K-&1TbyCy19*tTF)fxU~_EvJ5Mk z-$PLKD=dGCtm;uHx2%++DCjZs88UphEkCal{tflKZ_GVE}TU z*AQ}wa;yDMa2-5VsR{vfF_`p-=sC0V5m^DvB+mf?EFB@$$fFgxaNokaMezY^iBQvN zXR18nQ`AVK#yJ3e`)*H5)JTxwAWcj!WfcYlG%@aL5Qc9!e>{BSEv&%^TOl_w07I1A zB}-IxsoorwQ{1k%>7JSx0A?TWhtG{Y$}VyAaSHc4*J=#JnKiu&n>+R-(2&Qhj3q_l zz7lMT^9w9F?mcYnYH4%aRyemA8Ji(d*Xc8ETgMEqF`<}r`s47KIVUpSg)so%!dZnA z06Rrd9Ky>0wRu#5X-ZsEtmkX%@v0lh1A?<41$<+%Dum&o z-(gHZT@FA_2Q@XedLmwzFc(8A+TcV1Ku&AZrba+ah};j~w+9C<^e8nue%hkrp>a}> zr2t?BJ|0bwOU+831z{Icj%x?TZ2klT0Po5RuH z*R!XFA_xH3{qh91R~eeQhMxm4R1UzjBnIj+u$`K8?F3lI0G!Itl>yND>m1akrB@6s zyn`_Se}mUn5`D%1pe}Jujei{g;P1#>bm;>yE23VNG5}TRIwv!J7DTC2wt-d#fQ_nn zG;Y_D&Zl;e>^f$ zCHAIB>((tsqHk@|aMO7V0DIx5pm|7&Y%*^V& za4}~`GuErVcT&cb&pB>>qt93w4c^->d@KY8e4brP1&5Y+?dtq--st^v{l0?fII;r- z>eNBn3O9xIV5ot*PCJ6K+_^|N2#Ile=GokbCo3Mo4YMBJR`>jwe9Vx>ueg2sYaxHn zJ)2^yW=-NMGbYQ=L2h45Xn->yn!v`y3?AtdH9^h**AI!i4_fv1S>X_2Ig~P zNN2F4QG1FiPHiDdfXR#9AnEnLf#-(Qt!3>3AE87JUOm*(a0?+NrYoJHL}D>|x8bPwvnq=SZ-h8{n0zsP|inqWs&CVAl%nSm`+#-fA<95!kWpfEMHV_aol5ynIoEiA7J{7VJm`I9%vQ=fH)^A1^{(!dAVmkp_~{?b|Gi|s$)SN`Wx(d^VyTJAiG2z ztj~q_sr>;609b8s8Q!B^1l3l}G62xA>fvEztr)tRs>BQc7ep*X=LfI}|A^ZFfQw>; zG6TSv)g!pktfQ?I<+5Q7QT~60&*S3N#u)my$^ei$iob)+Fm_;zR~dkq3ac`ZT{h07 zMQJ}}0Ga^6ETL;+`L_Z9WdJtd;a{%7m;sn&2aKW)4Ch|~z)Uazd$0wu z1dr<nHj2Y!e=lUFs@(z0^11uT(-ol3IUM)pvT2Fs5DAbujQ-|rOYqk4RQA1MvDrD zl=^;nkH+7og-|sVMDR)De+>7O-oia6UMHwmYMe{fT2s-`LtBpCtD%NZaE5{4S92-) zjPVP+v!!~jRn-_g*I`G-ybA|)H%3FhD;N+a}slemOUNFDsc_P>|PPxy9@6`sP{iY zIT!3Ryj+>Bd}mGK@zG%+JIOvdGXVg8g+1ioQ9gl9C*cxy)4V>wnm7-&laX5x_LD2OJl*fslL+tZSrV1mv3S7 zwvXnyR4{r7dyc<{&tUkVOD>3pXf9yS{3qCccn^=oS7muKZ-wEA*YIOh+mtz(j|I4~ zWn-94cwcua>`8QiR66?z-kpwfs<|pET)QXHeV&HDWr7(mEq5Fz3lN8!l(yCcQZ_XE z1TST5YOT!A;#~X=Kg<3XltVW0_;%p2|BvvqQ~DYp?Yc>af#bT5vi?=3mam0;&TBXm zvJ0=?;ka1=Mo`7vgZn+lFfP&Y?Zcf-vM)2i0Q`T;=$u}hG`DI10000QpJ zMS2ub2oOL@fKcv6ea|`HH_li7++X+ZF@T+{xt}@LY-`QA7g4wMG*8pA(Sksr)7o0s z3_&1rF5v#%DJtOiUr!&h0e@&bwC;L?Ky*weKVVQ=#sv_F3hius$LEgjEkzj8P2A1_ zX%83ock=+KK_F!{e-AsD3*3jx9`5MuuEMj{(!s;!?4ZJ9CZj8<>!AU6a@Gp;f*S?u z8N&iyUFA^UY6`m_647u*; z-saLkdcnD5#U;gHl9IAqath*7veI%gP*E<3Bt%L=5+WfbBPJ!KC<9THf^z-2cmQr* z4hTiVYd8Mz0zRqmIQjT^C`w46P$+Q}R2=E$C?Tbwpm2f#frtSVV%`DnK6d_M?%uqA zBV2=f!@Qh5e4LT)TqlTj_DEkJ6&^s+-&1h&_y?@J_a8L@3X|}+^N^4dmpqx$--Nol z|2?Uj+drtieXjcfT>i-WZ-Kpy13cgohH!7BuNMq{-4E{W!}~Wg4=1D#(%T97U&!{4 z;r}3^1MD9RJ$$`ff2qd-CINSay8+nV0Ik$7`8*Ugyx?{|NH1d~()Djc-Ts>+7X%^> z@-~FO$KyLVSj+82?b9qP>)Zf;?0nAtq^OZzm=# zBP}DQU@vDU22p@HNJ~mf%gW2b|3=gIat4CM&h=kWPo#1H5FO+tdf`a&lK%oC+@An13R%R9GLy@ubuym_WpNr z{(c_i1P4I>y|sT+cq0)$C_69s6-PkH{|i@=_^%}Qw)6Y%<^JDU{r{HSe-sLHvU7KY z16fjn=VT@lC;8;JIVAqGrT%GYW4OQ1ExQ1?m-nB^U$t}mryBlA_lri)&JFMg-RnkL z8v2IU|J7lB4WD5B%kaOb^WWka>;4xAz`#Ey@LL>-e**jmfq%{MUvlW*(*_dr$?ZQ@ z1mMFz))crqpdv3|#eiNYC8g?v(v453|2+%bpQ8W4^Mp{c1WW zL?FcHl00#?#>dyp#EiI!?yzn>o6}O7r8;C})lp$%qN}T~&&zXiB|O-+0-rg#QZLe~ zUpu+@*eSVwkHwPx^=s(;4e;Y%mqQ-t7s<6(2B2RgJQISTUnI|5&xQUX(USdt9L7O8 zj>?^?(Bi-w>H%7>RjAllz+i+53k#V=jz_&SNUtZT|LBbMX%Tp;RvGoZwW-2$3%KmZ zt*)MTEkjSU9b5d?_&fiL9~Qo0Fc@#<#_o^N8As0F8G>I799{aORf7uAaH3y%;*%AR1xXUGZ6_qxM#`{^zqUmXAljyiz zI~ot!&7xp8x@pL!nl#z(N8DYWKADD?txFA6yBstuEiE8-c)jz^D zmU9?qKz|q{b$yR7Q%QJr8-Kn`=9v7CC&WxxzP^$Sa@Yy6xq3cS^jm-3@x$K^^=u1I-w-K7U)*xrs3vzrUpzx6C`YnJRLK z7xB)3j_WN|+RfNH4nAZ47_X3X4N4FiVm?5A|=%J#{=<7K3Gh98RqClHqqGtvXZu=h!N%X4)SaF@7H1Owz+X z$hD*=fW@ITCeJF&&Y|RN9hv94+c6gXE2w7`4_lB_%4htY%3R{!ZDUy#I?@U4=c~l3 zOe!EjRcv<<2vk>Vaf?1U2*j9k*q1ztH9^!Xo3`0w)aKq|f=jJb=VTD|A1J!MO`~s? zbd0_Y9SA#3D$~D71b0Ac=)9Qm1a?phd5{5`MYi&owIm6fi9L;lW4jQ3nl?$E#O+W` zuo8q-!m}uBs+j+RjUA$ac$also7pEM+u_tFk+Br=VHuDoF&T6mUGgP*i62*v*lBt< zz8c$tq;F;QSEQc)IUOCOMqkAQ5KL^j?sn+Rml!%=vt?}i~85^or^3O8EmxsXCX{DQ% z)MG=r=0_V*ourGGcNN#KLM@(^fKYQB@@e=Z4hq+Vk}@)R4_Oa355qy*i5VN3)<^FN z2iD{V)azC_8*j=7_(bU)4ycm7Jz4xd_*ffP=UF0C$vd#(64j?w5!`}O^ss$nZwh)U zUDG#}u|g04OFXeC_&C|uFCObFg$m&tMJ_qnw%i%#D4ri!DRYdT2I8uIH5Td`mm(aH1L(~YB105&X#d%3@8$e0fQWA>`hN!5rLG3Tpl$F~95CU;xgFiPhBuJADRrQ5L=VqQn( zpH>CQ7VNiBcoSK2E(Jao6uLtQj&BKJl+P~FP*{3Rjg|7%EG-{T;NK0sC%wQLRWb9p zr6WW7HMOx2zh+@$Rm&v;;Ro4V9^2jp?{)C{t2-=SsM2FXGC14u)dR**-cXxnlH+o6 z(8ngyGr`@IzCx@>Xy5c9IicO)$<+}78rjD}beZJw`={rXct#4MdYVZumEeRUQQThY zlc~0afSw!WU5zs|mLC_$2<f4jrJ(E>nkBBUKP}=F!pfz&=*UI&8eOK83DR>Mw3I-gx{L zlFafcsx#Z8Jzkbc>k?}l^Sobhdg3%1iaK^IvAW*y*rLFosa2!L&AIZ;F20 zqo0+{*4P<2U!uhA0jBBNpd>2HHoDBlGE*Z%!GCo59U3?jmWZ_)VpUs z-jix@o}}EX{&q@Tk@61V$QCyj`lAaoXj_LisHR)jz+pT~p@CCmHr~VweT>Vg7u?x# z&jWp1DgahK!OqWb#(?;UA3ndGMtAhX{S4J2)J8Qvx+!Y1;pv%1s*8#5_N3N(oJ*jJ zR&1X}7%TdMtidANKU%u`-R}i?%@8sl@@s2EgF0uDZx7H#x0M~{f2P~L9kEY>cd~hAyJK|4kWKds*`_38AG9`W?4Tzl7$l>br3*2aEYTg# z!aJLzNYxJN{FJ|xuU#Py&!8v`K-)=PSaVNP@M^Qe2iH2yLA$%V1J$%{=%ftyMyOf3P(DW*{Ynz5ZOZ;9r( z(5-C*PTyYCImP@b#_U7IW|h+X>=n8C_@Dzur^`vVQJ_AHtn@rLymzrukHzbH@E9qz zKdIuow=?c4?Imi?^b!cuq96)Mg4m<@QC}kNWUUa~reNFJZ|M0CX`89J(5GYF=r2wi zO>pmPwWWP5+a~PLO8O-U5;9Y+~~kpW!T0wtic%7!v$WpkX~bL1d99OW!$4@ z4wq`D)lI+GsjfSU4UIyj;(pXC>l4-buTgTLzu(}Tg-t}`rMBmjt0 zd-8wP%@r5Y!*ujn-Eg$mI@}|Wi_<9Na3&pT+6rsOMwTu`KN-NhSa`9UHTzT9H+0_r zM&Bl2(@(_KPA&}&a9H@G-5|X-vO8eQ*{{kn^>%4KqO-bneEAU~0hDF!azQ$Wd*YB9 zldvDHX9g@%Zhl(Zun6TaGIa>&`0xwwbI;7w3aUU=JLUZaFtA>Q-C;kh-FO^W5Px<% zHIULHEHxl{bL6uuilxdmhkP1+36~U50@W!ei*I(*X){J;Gkqx1Qj>!E1T2+@%?}&H z*O}Xrw`bLR5XF7@lR3ds7j%X?9IcN*kq;(>A0^qTe`KN^!2A z;1u8A}Wja@Jk>;EK9@B87GWfHC$#p71K2?u0 z>t}9H6$-*><@Si=GT7Ny=VX9b!MC=H{B>^;{LT-1iD*S5$iICr(iE$+tcpvIzUb`} z_atV773-*!k=^Xpocnh17Ck1UbUbxp8{CsTOi21}flX$+NL(2?e+EQg0Dx5oQz8nf zG5W)niK^P3k({BRi(@ECTAens#^HWlc@R(I4~gx!jfQJQnfY4+nX zn79j`+HCG7N8#)|-`1vz!u88kgky3|8B3wn_>rVDpb7?MYYtpv@Fo9NU_}rGtTwvu zrsqX;3(e#iFDQRo>^Hk=Bm@LtuJ?0ilT7w7MkZByi-f6AX#Yyu^|&DVsw-cc55T)r zqX~T)4QCtA?$)RJns@OUO^sMoxV4#eCUka5AKl-+_VHr6>ebPDt7n)pSweyN(LpI< zr;lHtkyMYJ)pjwtt37HR;rGT!3FL1d>E$k0lb+6Lsm5d!QaMz}rqU|rso*^U`uyNt z&T~s%kJu@{ZEZFeKv=_4P{gZQdga-fhDDLfxm6<~PU8x_)g^;H{VNZm`UJaRXKjux zu-*eJ6`c$82F{zj_CXX&a{F|tb3X-#$A7rv0uX*WU%mF%i|OH()EDm|SR4dJQd&YH zw^}-EF8Ci*t(*1mNQe%-y3SqM?Ou9##LmqTfmDzidAy}U zhb~7}3zp2N@+I5%*4nNBOvp+@>fN{-6{v0TX%e4k?(;{c7{iW>OF=b7BiU;_PzzR% z`}q3#N$mNiNdE1)%?5<&zH;?hrF6`(_;}hxY*e3H8y&O38?roT^y%}G4MjqGYLhCEhmrM#xe0A=*8r?jU zGw?V!RGO$!v=w)qh=L(7?1j3y7*Q_57et0!YFJWmU!^bqtgeL}~Q z1!R3)oaB#~i@fG*DB=QZuk*Yq&V^gy&88>ubl4-`ijN0=WU2(hny3?HQbN9aI_Fn{ z4JF~0<)CFf)sY1t>aw7v1ETb7^2Z|Wv_<9Yvzi}uES$v)&T4)c5r`TQ5VE=r`bw~P z=J>w8o`HInlax!Y)fT?Pn11o}hjhsEk6oUGBQ0o4(Y!C`RZ>BDdLYNTB2m>WJagR2 zICHZ!EIKTk+%avU3qv>fS(YO;C#F5(*14H1JSl6~=@Z{Hn!SXDR_HW0NPA|&5^Txr zuZMTE*A7Y6rU%)1?ekryTNO=83znG&q4b~em;?eF77MV8*-uw8lV+7rf$NQf-_KM? zIi!P?K-3@!3RNo0Zv>V`lFdkIdcGlkx|UnW?Wo6z{IA}X-R+!WbkH=K#kMqJJM7hw z`1OKxjJ{XL9dtr&tQaVjEQ@(F9GF^~0iIz|;|y;(|F%PK&LpEe_zr=9EF&&IF5jwm zK6O>`0I!aM?wp@uULZ_8lZBt}y-%_pCIXv4xHfw_gZ3p%`&|GJEH66tkSZZiCU4|? zRU}V$eyyyx2mgCNtY%mZUd~Et>GkNqJzQ?+ybRf}E}kT(yT{~qGb2=0YR&~UmvT=c z?YRy;=uz(09MTa+uWnDEhC~3VvBSLoucIsl3OD1rP<9OG!KR)p_o zp)GQ_-2#lTVT<24IauuVDPUB?W2*|e8Z|!gJPbPYT;9i;B){WFJf_+C zPO;?ifqO&T-|hlFnz^j-@)w_&;FTmnWImn-mfX`gM&U2H&VdTC9H%>7>?VBo9mUpZ z%nniu^SGf?Xhi5SNkF_XUpjm5c}nDqX1&XYR-D;6^psqyG4+S(Vh$7zG^2cQx3;ATqe8J4Sf9%u*-Hbs7DLx`Gmyg`)Ng21+64Mt3JlRNu1!oej9wv!yQ_Lzi^$ zqcO6vlSlbB5I;eC)pL5W{^iMF87ZaaIl@chU0oDoM>>TJ8H=BqC@#ri1WQ~eg-7`Rwa$ZsiVcpU zn$m~)pVV6!!vqbf`#WT7hRx3Zr(0QV&{fw=^wu!`SocQ4p zpA*l%IpcRF`@xLU4Es^6Zz!aKhNKmGt4B6=E*ueNosvhvMZmJb@nKo7 zb8Mp&qJ`lcTXP6!OVHw+Cn!;6K|AX)(rL%f^rMhRr1*VROD9BWI_C;ONlJm2N#Xuw z2Wp>f?J>!SIpjGQgZj(8!U&C9C)Gk?soZHst+RY1LE#s*>lAXNq1RvxK8ip)TBlb z_I6Cup@qgLkVCOeT+t{yq2C#YF$0x`Mw@5Ijhrd}Tp?XEWyoxc=pbWom@eJ#taZU{ zXt<^8csk>HVHl-*ZY-l0o{Y?mi}bI=b;5m2zCtD!2& z$lbx=fh9Xu(Zrkdj%tb1zOTu+jtmn1@l7y4>-o`zk~NE^(ob7%E!g=-ld?&<8&h7W zxtJ}b^G|nHZ4O0sXFjsMITZ2ajG25UfAqdTcU#KCfbgAC>m-db8Y+8rm*Z%2_3njl-?B{h;BBvX9^0#)Gke)gll{Gjb%PCS=H}Dm9Z% zxs;&Xalv14-Dw!L(k<9yQR9r;p)jF8MH%H~dm~RBQfuY^^NKcy9dvNotpb5`kY*%9Q8U`Yh$q)uYz-SHrNH|+9s)bhiIbGe>n!Aaq-ickc0AKR%jrB^3+%I9t3iAV$*|SP zuYh3|B$a?&>>z3UTHL`@?xpbIyTjLo$l`Plapshk&w(;1pK#$}jBJ=9t<}G`WXGZ1LYldn84ZXK;%zF6Syx&{`%X&Jed zZ{5ia7vTAJ#lTotlMHCVFCdtQXA24Hb1sN+0r5P2%yCu&qiybLBJ?>>i??3_>qBZ- zYNvm|xB)d(scNc^ISKZ!SmSCV77Dg<6kaUf3Rnv^nyb96U|M}Qvypx&tff-3F5I&B zblz2F(+ecpI~X;aceHmbz%7NPv>^5-Qdm^qq7h!M&7zq!+zGG!P6z@4OYL*A_(nZQ zjX>H2<5{Z{x0PMv(?rd&eik-p5=l`KR(ZG;eijIG&;WXUOa=M|et72hUCkBm{r7A00mH>IxE?e?W>g)jm;ux|ELgt@c( zVuJ1mv+Vq8J#<2XSZ%LPFT>XT<)n~wVWQ$TUZT3J5GWg6q;reUSG}t#8GH~rBp}ZF zXmk1y8*jjmnxom3U%xe6=?A?bN8y9lneG=Y9R8V0)H02hSp{XpW6JcV4@t`B)Q3>e9d6W= zh03I-&U_`PfwB^+R#M{RYHEJ$Aq#-kPo5E!`DU0#*p0;1lkSq}@R}49p++ljDq`!) zG8~z2-Q@H*F1J@A#NYwUXziFgDPET1r!rHv3&OFh^<~R3WdQm1(?(J%qF(r?FTm1W z2#ik1x#Ps3Ws|;`nNc;JB2F<29SYx0!d+(K13LQHqilVu} zN@2Y&bl#{#VL384UrTixaQyqV_>vR~Ba%j1!bnz=!1R_F^w z^kHUoWy@n!Q_zaK`Otu*E{X4flq0YNvnR?TeP_RfKuH`P)^A?H?g(zv(x!)6f0~N? z?hdUfW#c4`GH zDBUi1;2VgThRNj4Jp2YNa!p5UDS*-Xwr@M(5q>f5I)>3-T3&sbWtZcxeDBagw|nay zO{!_y&9S%<-jp>x-@|~`?ipgVC-=5?c&rz+3wT}IZswt=V7F%_`T{6*)<_Mqx;wN+ z!*SCv;#;hCT7m9|xbn{P?K;-X4f?uMQFE8eA7(fq8Yr?7=TlP@lQz!{_e-S?1!6UM ztZo9Y63|7I0#Y`h;c*HdQ2&ZDt~bKhX&D`zZ#^J*kAlKCK|^N0x`h_qFwPWxmb!?* z^k$^8XKmC-wuC=LojdVrvV0~5H?OupQAsC-(rCZx)X(XWq0S8F3}oLOW@EZ@ZPoKK zBS7fp>q7*WDY&9O=@4@E(qCQz96RQWb0j<;T7LXVS+ITP{sa0_mF{k6lE^?sfG zM;yCPEf+>-t@Xb#7OHAj#jC!5*)Kzu@QNG_G``%uY_A|^*b1x%3@0hJ+Cop;n>lpW zl9>kfq)h0WXC%)D6BWn|fBqne^IAS?f6zSy0YO_X$cq7cyZ1BLnt`(SXWw~GL~n@< zELgw$+StF~M$_7`(1cHnU|pcSBZ&e5d^i;MHol!pI`!8{VGWdVfj2J|E&;`8vESn) z$q*Rg%1y)|WH%}=TF~!dW#F6Tbl!3JyUF|dvsdfhh1E8kl^^a8{`iIMviR1AsMNy? z@+yw0SdkgDGte~$+VoTH#+U_8Fb#Sa{U}(@lUBR!&CKb~YF57HDqCAGRBwF>YL%!8 z?tK#TA!wj%;E4>>P_5Bjwx;xVCPGqHm94%<__3`g`H!;J;_4e`F{HJ5Gr0XU-9?iS z#ulwZrDYMvV~*55=p;HDXo8=->k$%oNj(GfPnhJP23E{WK*Ozy;-)Qo?#u1 z{9WjlC`ae^ljeVi`?WxKA}Ac<-;9-+6! zpxu^sd7+o#b^6`Wpaf;s{Ci5&K!{S`78 z>v;y+LhlbrYIiq!u`UJdhS<;y1aW&tuA5g_GXCAK?ZrhTBf&(jb#4hRSl_Vg`ags zb-GZ!VjI6LII9UMu~)!ikUQP1jUI0Yyq;EFv(jrAUcKw525tG&Zw*prY8363(Zm&D zYx-AcILw;UhU)TlFC7R#mwi9ULt9SmCiiz86@Kvqf{SJ;k$#X3td%(zboCp=oifWA zG49jYT@)rVZ|rC-68d8Vxih&B*)Z$arCC3a6&PC{=}>X^y|JwGhHaIR{0jS0>p5-a|22Yqa6I=PoxNjBC|KRHW*rPaGGRht6N&J*eYsixW17AEa)wuP1Oc4+qW zmFMOCqxI9!tYVQ#M_ zWcj!SdF|25p?>#Rv-DlO3EaHHNoZrUiNue+fgb1mpn`Y-kx>*L*Z)6Q_y787!S8C|1aV9p<>7nIlm9f(zOHwz;;L=<{{eAt B%d!9f literal 0 HcmV?d00001 diff --git a/logo/meshcore.svg b/logo/meshcore.svg new file mode 100644 index 00000000..eb1b7bc4 --- /dev/null +++ b/logo/meshcore.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + diff --git a/logo/meshcore_tm.svg b/logo/meshcore_tm.svg new file mode 100644 index 00000000..b7e252d9 --- /dev/null +++ b/logo/meshcore_tm.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + From bb1e5c5a1cef21d05ad8188bce56cd1ab1cbc1aa Mon Sep 17 00:00:00 2001 From: recrof Date: Fri, 6 Jun 2025 00:07:03 +0200 Subject: [PATCH 41/87] nrf52 fix: don't allow LFS_ASSERT to freeze the board --- platformio.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/platformio.ini b/platformio.ini index e6a1be41..bb93626f 100644 --- a/platformio.ini +++ b/platformio.ini @@ -58,6 +58,7 @@ platform = https://github.com/pioarduino/platform-espressif32/releases/download/ extends = arduino_base platform = nordicnrf52 build_flags = ${arduino_base.build_flags} + -D LFS_NO_ASSERT=1 -D NRF52_PLATFORM [nrf52840_base] From 6e5c865c21c2d3c7fdeae76f1a6ecf7cfd97dc92 Mon Sep 17 00:00:00 2001 From: Rastislav Vysoky Date: Fri, 6 Jun 2025 00:23:57 +0200 Subject: [PATCH 42/87] Disable LFS_ASSERT to stop freezing the boards on LFS errors --- platformio.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/platformio.ini b/platformio.ini index 80f850ea..0c16ead4 100644 --- a/platformio.ini +++ b/platformio.ini @@ -54,6 +54,7 @@ extends = arduino_base platform = nordicnrf52 build_flags = ${arduino_base.build_flags} -D NRF52_PLATFORM + -D LFS_NO_ASSERT=1 [nrf52840_base] extends = nrf52_base @@ -83,4 +84,4 @@ build_flags = ${arduino_base.build_flags} build_src_filter = ${arduino_base.build_src_filter} + lib_deps = ${arduino_base.lib_deps} - file://arch/stm32/Adafruit_LittleFS_stm32 \ No newline at end of file + file://arch/stm32/Adafruit_LittleFS_stm32 From 6e0b505a2a83d628f11efc2052f52ab6ddc4af49 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 6 Jun 2025 15:30:35 +1000 Subject: [PATCH 43/87] * companion: refactor of all filesystem access to new DataStore module --- examples/companion_radio/DataStore.cpp | 306 ++++++++++++++++++++++ examples/companion_radio/DataStore.h | 36 +++ examples/companion_radio/MyMesh.cpp | 344 ++----------------------- examples/companion_radio/MyMesh.h | 32 +-- examples/companion_radio/main.cpp | 15 +- src/helpers/BaseChatMesh.cpp | 7 + src/helpers/BaseChatMesh.h | 20 +- src/helpers/ChannelDetails.h | 9 + src/helpers/ContactInfo.h | 18 ++ 9 files changed, 433 insertions(+), 354 deletions(-) create mode 100644 examples/companion_radio/DataStore.cpp create mode 100644 examples/companion_radio/DataStore.h create mode 100644 src/helpers/ChannelDetails.h create mode 100644 src/helpers/ContactInfo.h diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp new file mode 100644 index 00000000..fa848c05 --- /dev/null +++ b/examples/companion_radio/DataStore.cpp @@ -0,0 +1,306 @@ +#include +#include "DataStore.h" + +DataStore::DataStore(FILESYSTEM& fs) : _fs(&fs), +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + identity_store(fs, "") +#elif defined(RP2040_PLATFORM) + identity_store(fs, "/identity") +#else + identity_store(fs, "/identity") +#endif +{ +} + +void DataStore::begin() { +#if defined(RP2040_PLATFORM) + identity_store.begin(); +#endif + + // init 'blob store' support + _fs->mkdir("/bl"); +} + +#if defined(ESP32) + #include +#elif defined(RP2040_PLATFORM) + #include +#endif + +bool DataStore::formatFileSystem() { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + return _fs->format(); +#elif defined(RP2040_PLATFORM) + return LittleFS.format(); +#elif defined(ESP32) + return ((fs::SPIFFSFS *)_fs)->format(); +#else + #error "need to implement format()" +#endif +} + +bool DataStore::loadMainIdentity(mesh::LocalIdentity &identity) { + return identity_store.load("_main", identity); +} + +bool DataStore::saveMainIdentity(const mesh::LocalIdentity &identity) { + return identity_store.save("_main", identity); +} + +void DataStore::loadPrefs(NodePrefs& prefs, double& node_lat, double& node_lon) { + if (_fs->exists("/new_prefs")) { + loadPrefsInt("/new_prefs", prefs, node_lat, node_lon); // new filename + } else if (_fs->exists("/node_prefs")) { + loadPrefsInt("/node_prefs", prefs, node_lat, node_lon); + savePrefs(prefs, node_lat, node_lon); // save to new filename + _fs->remove("/node_prefs"); // remove old + } +} + +void DataStore::loadPrefsInt(const char *filename, NodePrefs& _prefs, double& node_lat, double& node_lon) { +#if defined(RP2040_PLATFORM) + File file = _fs->open(filename, "r"); +#else + File file = _fs->open(filename); +#endif + if (file) { + uint8_t pad[8]; + + file.read((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 + file.read((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 + file.read(pad, 4); // 36 + file.read((uint8_t *)&node_lat, sizeof(node_lat)); // 40 + file.read((uint8_t *)&node_lon, sizeof(node_lon)); // 48 + file.read((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 + file.read((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 + file.read((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 + file.read((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 + file.read((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 + file.read((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 + file.read((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 + file.read((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 + file.read((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 + file.read((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 + file.read((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 + file.read(pad, 4); // 76 + file.read((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 + + file.close(); + } +} + +void DataStore::savePrefs(const NodePrefs& _prefs, double node_lat, double node_lon) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/new_prefs"); + File file = _fs->open("/new_prefs", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/new_prefs", "w"); +#else + File file = _fs->open("/new_prefs", "w", true); +#endif + if (file) { + uint8_t pad[8]; + memset(pad, 0, sizeof(pad)); + + file.write((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 + file.write((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 + file.write(pad, 4); // 36 + file.write((uint8_t *)&node_lat, sizeof(node_lat)); // 40 + file.write((uint8_t *)&node_lon, sizeof(node_lon)); // 48 + file.write((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 + file.write((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 + file.write((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 + file.write((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 + file.write((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 + file.write((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 + file.write((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 + file.write((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 + file.write((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 + file.write((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 + file.write((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 + file.write(pad, 4); // 76 + file.write((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 + + file.close(); + } +} + +void DataStore::loadContacts(DataStoreHost* host) { + if (_fs->exists("/contacts3")) { +#if defined(RP2040_PLATFORM) + File file = _fs->open("/contacts3", "r"); +#else + File file = _fs->open("/contacts3"); +#endif + if (file) { + bool full = false; + while (!full) { + ContactInfo c; + uint8_t pub_key[32]; + uint8_t unused; + + bool success = (file.read(pub_key, 32) == 32); + success = success && (file.read((uint8_t *)&c.name, 32) == 32); + success = success && (file.read(&c.type, 1) == 1); + success = success && (file.read(&c.flags, 1) == 1); + success = success && (file.read(&unused, 1) == 1); + success = success && (file.read((uint8_t *)&c.sync_since, 4) == 4); // was 'reserved' + success = success && (file.read((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.read((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.read(c.out_path, 64) == 64); + success = success && (file.read((uint8_t *)&c.lastmod, 4) == 4); + success = success && (file.read((uint8_t *)&c.gps_lat, 4) == 4); + success = success && (file.read((uint8_t *)&c.gps_lon, 4) == 4); + + if (!success) break; // EOF + + c.id = mesh::Identity(pub_key); + if (!host->onContactLoaded(c)) full = true; + } + file.close(); + } + } +} + +void DataStore::saveContacts(DataStoreHost* host) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/contacts3"); + File file = _fs->open("/contacts3", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/contacts3", "w"); +#else + File file = _fs->open("/contacts3", "w", true); +#endif + if (file) { + uint32_t idx = 0; + ContactInfo c; + uint8_t unused = 0; + + while (host->getContactForSave(idx, c)) { + bool success = (file.write(c.id.pub_key, 32) == 32); + success = success && (file.write((uint8_t *)&c.name, 32) == 32); + success = success && (file.write(&c.type, 1) == 1); + success = success && (file.write(&c.flags, 1) == 1); + success = success && (file.write(&unused, 1) == 1); + success = success && (file.write((uint8_t *)&c.sync_since, 4) == 4); + success = success && (file.write((uint8_t *)&c.out_path_len, 1) == 1); + success = success && (file.write((uint8_t *)&c.last_advert_timestamp, 4) == 4); + success = success && (file.write(c.out_path, 64) == 64); + success = success && (file.write((uint8_t *)&c.lastmod, 4) == 4); + success = success && (file.write((uint8_t *)&c.gps_lat, 4) == 4); + success = success && (file.write((uint8_t *)&c.gps_lon, 4) == 4); + + if (!success) break; // write failed + + idx++; // advance to next contact + } + file.close(); + } +} + +void DataStore::loadChannels(DataStoreHost* host) { + if (_fs->exists("/channels2")) { +#if defined(RP2040_PLATFORM) + File file = _fs->open("/channels2", "r"); +#else + File file = _fs->open("/channels2"); +#endif + if (file) { + bool full = false; + uint8_t channel_idx = 0; + while (!full) { + ChannelDetails ch; + uint8_t unused[4]; + + bool success = (file.read(unused, 4) == 4); + success = success && (file.read((uint8_t *)ch.name, 32) == 32); + success = success && (file.read((uint8_t *)ch.channel.secret, 32) == 32); + + if (!success) break; // EOF + + if (host->onChannelLoaded(channel_idx, ch)) { + channel_idx++; + } else { + full = true; + } + } + file.close(); + } + } +} + +void DataStore::saveChannels(DataStoreHost* host) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove("/channels2"); + File file = _fs->open("/channels2", FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File file = _fs->open("/channels2", "w"); +#else + File file = _fs->open("/channels2", "w", true); +#endif + if (file) { + uint8_t channel_idx = 0; + ChannelDetails ch; + uint8_t unused[4]; + memset(unused, 0, 4); + + while (host->getChannelForSave(channel_idx, ch)) { + bool success = (file.write(unused, 4) == 4); + success = success && (file.write((uint8_t *)ch.name, 32) == 32); + success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); + + if (!success) break; // write failed + channel_idx++; + } + file.close(); + } +} + +int DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { + char path[64]; + char fname[18]; + + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) + mesh::Utils::toHex(fname, key, key_len); + sprintf(path, "/bl/%s", fname); + + if (_fs->exists(path)) { +#if defined(RP2040_PLATFORM) + File f = _fs->open(path, "r"); +#else + File f = _fs->open(path); +#endif + if (f) { + int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! + f.close(); + return len; + } + } + return 0; // not found +} + +bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) { + char path[64]; + char fname[18]; + + if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) + mesh::Utils::toHex(fname, key, key_len); + sprintf(path, "/bl/%s", fname); + +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove(path); + File f = _fs->open(path, FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + File f = _fs->open(path, "w"); +#else + File f = _fs->open(path, "w", true); +#endif + if (f) { + int n = f.write(src_buf, len); + f.close(); + if (n == len) return true; // success! + + _fs->remove(path); // blob was only partially written! + } + return false; // error +} diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h new file mode 100644 index 00000000..d1ed19bf --- /dev/null +++ b/examples/companion_radio/DataStore.h @@ -0,0 +1,36 @@ +#pragma once + +#include +#include +#include +#include "NodePrefs.h" + +class DataStoreHost { +public: + virtual bool onContactLoaded(const ContactInfo& contact) =0; + virtual bool getContactForSave(uint32_t idx, ContactInfo& contact) =0; + virtual bool onChannelLoaded(uint8_t channel_idx, const ChannelDetails& ch) =0; + virtual bool getChannelForSave(uint8_t channel_idx, ChannelDetails& ch) =0; +}; + +class DataStore { + FILESYSTEM* _fs; + IdentityStore identity_store; + + void loadPrefsInt(const char *filename, NodePrefs& prefs, double& node_lat, double& node_lon); + + public: + DataStore(FILESYSTEM& fs); + void begin(); + bool formatFileSystem(); + bool loadMainIdentity(mesh::LocalIdentity &identity); + bool saveMainIdentity(const mesh::LocalIdentity &identity); + void loadPrefs(NodePrefs& prefs, double& node_lat, double& node_lon); + void savePrefs(const NodePrefs& prefs, double node_lat, double node_lon); + void loadContacts(DataStoreHost* host); + void saveContacts(DataStoreHost* host); + void loadChannels(DataStoreHost* host); + void saveChannels(DataStoreHost* host); + int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]); + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len); +}; diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 730747e1..4c7b1618 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -103,200 +103,6 @@ #include "UITask.h" #endif -void MyMesh::loadMainIdentity() { - if (!_identity_store->load("_main", self_id)) { - self_id = radio_new_identity(); // create new random identity - int count = 0; - while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes - self_id = radio_new_identity(); - count++; - } - saveMainIdentity(self_id); - } -} - -bool MyMesh::saveMainIdentity(const mesh::LocalIdentity &identity) { - return _identity_store->save("_main", identity); -} - -void MyMesh::loadContacts() { - if (_fs->exists("/contacts3")) { -#if defined(RP2040_PLATFORM) - File file = _fs->open("/contacts3", "r"); -#else - File file = _fs->open("/contacts3"); -#endif - if (file) { - bool full = false; - while (!full) { - ContactInfo c; - uint8_t pub_key[32]; - uint8_t unused; - - bool success = (file.read(pub_key, 32) == 32); - success = success && (file.read((uint8_t *)&c.name, 32) == 32); - success = success && (file.read(&c.type, 1) == 1); - success = success && (file.read(&c.flags, 1) == 1); - success = success && (file.read(&unused, 1) == 1); - success = success && (file.read((uint8_t *)&c.sync_since, 4) == 4); // was 'reserved' - success = success && (file.read((uint8_t *)&c.out_path_len, 1) == 1); - success = success && (file.read((uint8_t *)&c.last_advert_timestamp, 4) == 4); - success = success && (file.read(c.out_path, 64) == 64); - success = success && (file.read((uint8_t *)&c.lastmod, 4) == 4); - success = success && (file.read((uint8_t *)&c.gps_lat, 4) == 4); - success = success && (file.read((uint8_t *)&c.gps_lon, 4) == 4); - - if (!success) break; // EOF - - c.id = mesh::Identity(pub_key); - if (!addContact(c)) full = true; - } - file.close(); - } - } -} - -void MyMesh::saveContacts() { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/contacts3"); - File file = _fs->open("/contacts3", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/contacts3", "w"); -#else - File file = _fs->open("/contacts3", "w", true); -#endif - if (file) { - ContactsIterator iter; - ContactInfo c; - uint8_t unused = 0; - - while (iter.hasNext(this, c)) { - bool success = (file.write(c.id.pub_key, 32) == 32); - success = success && (file.write((uint8_t *)&c.name, 32) == 32); - success = success && (file.write(&c.type, 1) == 1); - success = success && (file.write(&c.flags, 1) == 1); - success = success && (file.write(&unused, 1) == 1); - success = success && (file.write((uint8_t *)&c.sync_since, 4) == 4); - success = success && (file.write((uint8_t *)&c.out_path_len, 1) == 1); - success = success && (file.write((uint8_t *)&c.last_advert_timestamp, 4) == 4); - success = success && (file.write(c.out_path, 64) == 64); - success = success && (file.write((uint8_t *)&c.lastmod, 4) == 4); - success = success && (file.write((uint8_t *)&c.gps_lat, 4) == 4); - success = success && (file.write((uint8_t *)&c.gps_lon, 4) == 4); - - if (!success) break; // write failed - } - file.close(); - } -} - -void MyMesh::loadChannels() { - if (_fs->exists("/channels2")) { -#if defined(RP2040_PLATFORM) - File file = _fs->open("/channels2", "r"); -#else - File file = _fs->open("/channels2"); -#endif - if (file) { - bool full = false; - uint8_t channel_idx = 0; - while (!full) { - ChannelDetails ch; - uint8_t unused[4]; - - bool success = (file.read(unused, 4) == 4); - success = success && (file.read((uint8_t *)ch.name, 32) == 32); - success = success && (file.read((uint8_t *)ch.channel.secret, 32) == 32); - - if (!success) break; // EOF - - if (setChannel(channel_idx, ch)) { - channel_idx++; - } else { - full = true; - } - } - file.close(); - } - } -} - -void MyMesh::saveChannels() { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/channels2"); - File file = _fs->open("/channels2", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/channels2", "w"); -#else - File file = _fs->open("/channels2", "w", true); -#endif - if (file) { - uint8_t channel_idx = 0; - ChannelDetails ch; - uint8_t unused[4]; - memset(unused, 0, 4); - - while (getChannel(channel_idx, ch)) { - bool success = (file.write(unused, 4) == 4); - success = success && (file.write((uint8_t *)ch.name, 32) == 32); - success = success && (file.write((uint8_t *)ch.channel.secret, 32) == 32); - - if (!success) break; // write failed - channel_idx++; - } - file.close(); - } -} - -int MyMesh::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { - char path[64]; - char fname[18]; - - if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) - mesh::Utils::toHex(fname, key, key_len); - sprintf(path, "/bl/%s", fname); - - if (_fs->exists(path)) { -#if defined(RP2040_PLATFORM) - File f = _fs->open(path, "r"); -#else - File f = _fs->open(path); -#endif - if (f) { - int len = f.read(dest_buf, 255); // currently MAX 255 byte blob len supported!! - f.close(); - return len; - } - } - return 0; // not found -} - -bool MyMesh::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) { - char path[64]; - char fname[18]; - - if (key_len > 8) key_len = 8; // just use first 8 bytes (prefix) - mesh::Utils::toHex(fname, key, key_len); - sprintf(path, "/bl/%s", fname); - -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove(path); - File f = _fs->open(path, FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File f = _fs->open(path, "w"); -#else - File f = _fs->open(path, "w", true); -#endif - if (f) { - int n = f.write(src_buf, len); - f.close(); - if (n == len) return true; // success! - - _fs->remove(path); // blob was only partially written! - } - return false; // error -} - void MyMesh::writeOKFrame() { uint8_t buf[1]; buf[0] = RESP_CODE_OK; @@ -724,14 +530,13 @@ uint32_t MyMesh::calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t void MyMesh::onSendTimeout() {} -MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables) +MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables, DataStore& store) : BaseChatMesh(radio, *new ArduinoMillis(), rng, rtc, *new StaticPoolPacketManager(16), tables), - _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4) { + _serial(NULL), telemetry(MAX_PACKET_PAYLOAD - 4), _store(&store) { _iter_started = false; _cli_rescue = false; offline_queue_len = 0; app_target_ver = 0; - _identity_store = NULL; pending_login = pending_status = pending_telemetry = 0; next_ack_idx = 0; sign_data = NULL; @@ -749,62 +554,18 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe //_prefs.rx_delay_base = 10.0f; enable once new algo fixed } -void MyMesh::loadPrefsInt(const char *filename) { -#if defined(RP2040_PLATFORM) - File file = _fs->open(filename, "r"); -#else - File file = _fs->open(filename); -#endif - if (file) { - uint8_t pad[8]; - - file.read((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 - file.read((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 - file.read(pad, 4); // 36 - file.read((uint8_t *)&sensors.node_lat, sizeof(sensors.node_lat)); // 40 - file.read((uint8_t *)&sensors.node_lon, sizeof(sensors.node_lon)); // 48 - file.read((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 - file.read((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 - file.read((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 - file.read((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 - file.read((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 - file.read((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 - file.read((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 - file.read((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 - file.read((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 - file.read((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 - file.read((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 - file.read(pad, 4); // 76 - file.read((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 - - // sanitise bad pref values - _prefs.rx_delay_base = constrain(_prefs.rx_delay_base, 0, 20.0f); - _prefs.airtime_factor = constrain(_prefs.airtime_factor, 0, 9.0f); - _prefs.freq = constrain(_prefs.freq, 400.0f, 2500.0f); - _prefs.bw = constrain(_prefs.bw, 62.5f, 500.0f); - _prefs.sf = constrain(_prefs.sf, 7, 12); - _prefs.cr = constrain(_prefs.cr, 5, 8); - _prefs.tx_power_dbm = constrain(_prefs.tx_power_dbm, 1, MAX_LORA_TX_POWER); - - file.close(); - } -} - -void MyMesh::begin(FILESYSTEM &fs, bool has_display) { - _fs = &fs; - +void MyMesh::begin(bool has_display) { BaseChatMesh::begin(); -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _identity_store = new IdentityStore(fs, ""); -#elif defined(RP2040_PLATFORM) - _identity_store = new IdentityStore(fs, "/identity"); - _identity_store->begin(); -#else - _identity_store = new IdentityStore(fs, "/identity"); -#endif - - loadMainIdentity(); + if (!_store->loadMainIdentity(self_id)) { + self_id = radio_new_identity(); // create new random identity + int count = 0; + while (count < 10 && (self_id.pub_key[0] == 0x00 || self_id.pub_key[0] == 0xFF)) { // reserved id hashes + self_id = radio_new_identity(); + count++; + } + _store->saveMainIdentity(self_id); + } // use hex of first 4 bytes of identity public key as default node name char pub_key_hex[10]; @@ -817,13 +578,16 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) { #endif // load persisted prefs - if (_fs->exists("/new_prefs")) { - loadPrefsInt("/new_prefs"); // new filename - } else if (_fs->exists("/node_prefs")) { - loadPrefsInt("/node_prefs"); - savePrefs(); // save to new filename - _fs->remove("/node_prefs"); // remove old - } + _store->loadPrefs(_prefs, sensors.node_lat, sensors.node_lon); + + // sanitise bad pref values + _prefs.rx_delay_base = constrain(_prefs.rx_delay_base, 0, 20.0f); + _prefs.airtime_factor = constrain(_prefs.airtime_factor, 0, 9.0f); + _prefs.freq = constrain(_prefs.freq, 400.0f, 2500.0f); + _prefs.bw = constrain(_prefs.bw, 62.5f, 500.0f); + _prefs.sf = constrain(_prefs.sf, 7, 12); + _prefs.cr = constrain(_prefs.cr, 5, 8); + _prefs.tx_power_dbm = constrain(_prefs.tx_power_dbm, 1, MAX_LORA_TX_POWER); #ifdef BLE_PIN_CODE if (_prefs.ble_pin == 0) { @@ -844,12 +608,9 @@ void MyMesh::begin(FILESYSTEM &fs, bool has_display) { _active_ble_pin = 0; #endif - // init 'blob store' support - _fs->mkdir("/bl"); - - loadContacts(); + _store->loadContacts(this); addChannel("Public", PUBLIC_GROUP_PSK); // pre-configure Andy's public channel - loadChannels(); + _store->loadChannels(this); radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); radio_set_tx_power(_prefs.tx_power_dbm); @@ -870,42 +631,6 @@ void MyMesh::startInterface(BaseSerialInterface &serial) { serial.enable(); } -void MyMesh::savePrefs() { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/new_prefs"); - File file = _fs->open("/new_prefs", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/new_prefs", "w"); -#else - File file = _fs->open("/new_prefs", "w", true); -#endif - if (file) { - uint8_t pad[8]; - memset(pad, 0, sizeof(pad)); - - file.write((uint8_t *)&_prefs.airtime_factor, sizeof(float)); // 0 - file.write((uint8_t *)_prefs.node_name, sizeof(_prefs.node_name)); // 4 - file.write(pad, 4); // 36 - file.write((uint8_t *)&sensors.node_lat, sizeof(sensors.node_lat)); // 40 - file.write((uint8_t *)&sensors.node_lon, sizeof(sensors.node_lon)); // 48 - file.write((uint8_t *)&_prefs.freq, sizeof(_prefs.freq)); // 56 - file.write((uint8_t *)&_prefs.sf, sizeof(_prefs.sf)); // 60 - file.write((uint8_t *)&_prefs.cr, sizeof(_prefs.cr)); // 61 - file.write((uint8_t *)&_prefs.reserved1, sizeof(_prefs.reserved1)); // 62 - file.write((uint8_t *)&_prefs.manual_add_contacts, sizeof(_prefs.manual_add_contacts)); // 63 - file.write((uint8_t *)&_prefs.bw, sizeof(_prefs.bw)); // 64 - file.write((uint8_t *)&_prefs.tx_power_dbm, sizeof(_prefs.tx_power_dbm)); // 68 - file.write((uint8_t *)&_prefs.telemetry_mode_base, sizeof(_prefs.telemetry_mode_base)); // 69 - file.write((uint8_t *)&_prefs.telemetry_mode_loc, sizeof(_prefs.telemetry_mode_loc)); // 70 - file.write((uint8_t *)&_prefs.telemetry_mode_env, sizeof(_prefs.telemetry_mode_env)); // 71 - file.write((uint8_t *)&_prefs.rx_delay_base, sizeof(_prefs.rx_delay_base)); // 72 - file.write(pad, 4); // 76 - file.write((uint8_t *)&_prefs.ble_pin, sizeof(_prefs.ble_pin)); // 80 - - file.close(); - } -} - void MyMesh::handleCmdFrame(size_t len) { if (cmd_frame[0] == CMD_DEVICE_QEURY && len >= 2) { // sent when app establishes connection app_target_ver = cmd_frame[1]; // which version of protocol does app understand @@ -1286,7 +1011,7 @@ void MyMesh::handleCmdFrame(size_t len) { #if ENABLE_PRIVATE_KEY_IMPORT mesh::LocalIdentity identity; identity.readFrom(&cmd_frame[1], 64); - if (saveMainIdentity(identity)) { + if (_store->saveMainIdentity(identity)) { self_id = identity; writeOKFrame(); } else { @@ -1536,19 +1261,6 @@ void MyMesh::enterCLIRescue() { Serial.println("========= CLI Rescue ========="); } -bool MyMesh::formatFileSystem() { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - return InternalFS.format(); -#elif defined(RP2040_PLATFORM) - return LittleFS.format(); -#elif defined(ESP32) - return SPIFFS.format(); -#else - #error "need to implement file system erase" - return false; -#endif -} - void MyMesh::checkCLIRescueCmd() { int len = strlen(cli_command); while (Serial.available() && len < sizeof(cli_command)-1) { @@ -1576,16 +1288,16 @@ void MyMesh::checkCLIRescueCmd() { Serial.printf(" Error: unknown config: %s\n", config); } } else if (strcmp(cli_command, "rebuild") == 0) { - bool success = formatFileSystem(); + bool success = _store->formatFileSystem(); if (success) { - saveMainIdentity(self_id); + _store->saveMainIdentity(self_id); saveContacts(); Serial.println(" > erase and rebuild done"); } else { Serial.println(" Error: erase failed"); } } else if (strcmp(cli_command, "erase") == 0) { - bool success = formatFileSystem(); + bool success = _store->formatFileSystem(); if (success) { Serial.println(" > erase done"); } else { diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index 92da8c9d..6ac030d9 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -25,6 +25,7 @@ #include #endif +#include "DataStore.h" #include "NodePrefs.h" #include @@ -76,14 +77,12 @@ #define REQ_TYPE_KEEP_ALIVE 0x02 #define REQ_TYPE_GET_TELEMETRY_DATA 0x03 -class MyMesh : public BaseChatMesh { +class MyMesh : public BaseChatMesh, public DataStoreHost { public: - MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables); + MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMeshTables &tables, DataStore& store); - void begin(FILESYSTEM &fs, bool has_display); + void begin(bool has_display); void startInterface(BaseSerialInterface &serial); - void loadPrefsInt(const char *filename); - void savePrefs(); const char *getNodeName(); NodePrefs *getNodePrefs(); @@ -127,6 +126,12 @@ protected: uint32_t calcDirectTimeoutMillisFor(uint32_t pkt_airtime_millis, uint8_t path_len) const override; void onSendTimeout() override; + // DataStoreHost methods + bool onContactLoaded(const ContactInfo& contact) override { return addContact(contact); } + bool getContactForSave(uint32_t idx, ContactInfo& contact) override { return getContactByIdx(idx, contact); } + bool onChannelLoaded(uint8_t channel_idx, const ChannelDetails& ch) override { return setChannel(channel_idx, ch); } + bool getChannelForSave(uint8_t channel_idx, ChannelDetails& ch) override { return getChannel(channel_idx, ch); } + private: void writeOKFrame(); void writeErrFrame(uint8_t err_code); @@ -135,22 +140,17 @@ private: void updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len); void addToOfflineQueue(const uint8_t frame[], int len); int getFromOfflineQueue(uint8_t frame[]); - void loadMainIdentity(); - bool saveMainIdentity(const mesh::LocalIdentity &identity); - void loadContacts(); - void saveContacts(); - void loadChannels(); - void saveChannels(); - int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override; - bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override; void checkCLIRescueCmd(); void checkSerialInterface(); - bool formatFileSystem(); + + // helpers, short-cuts + void savePrefs() { _store->savePrefs(_prefs, sensors.node_lat, sensors.node_lon); } + void saveChannels() { _store->saveChannels(this); } + void saveContacts() { _store->saveContacts(this); } private: - FILESYSTEM *_fs; - IdentityStore *_identity_store; + DataStore* _store; NodePrefs _prefs; uint32_t pending_login; uint32_t pending_status; diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index a276a2b5..b463dcbe 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -14,10 +14,13 @@ static uint32_t _atoi(const char* sp) { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) #include + DataStore store(InternalFS); #elif defined(RP2040_PLATFORM) #include + DataStore store(LittleFS); #elif defined(ESP32) #include + DataStore store(SPIFFS); #endif #ifdef ESP32 @@ -74,7 +77,7 @@ static uint32_t _atoi(const char* sp) { /* GLOBAL OBJECTS */ StdRNG fast_rng; SimpleMeshTables tables; -MyMesh the_mesh(radio_driver, fast_rng, rtc_clock, tables); +MyMesh the_mesh(radio_driver, fast_rng, rtc_clock, tables, store); #ifdef DISPLAY_CLASS #include "UITask.h" @@ -82,7 +85,6 @@ MyMesh the_mesh(radio_driver, fast_rng, rtc_clock, tables); #endif /* END GLOBAL OBJECTS */ - void halt() { while (1) ; } @@ -108,7 +110,8 @@ void setup() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) InternalFS.begin(); - the_mesh.begin(InternalFS, + store.begin(); + the_mesh.begin( #ifdef DISPLAY_CLASS disp != NULL #else @@ -126,7 +129,8 @@ void setup() { the_mesh.startInterface(serial_interface); #elif defined(RP2040_PLATFORM) LittleFS.begin(); - the_mesh.begin(LittleFS, + store.begin(); + the_mesh.begin( #ifdef DISPLAY_CLASS disp != NULL #else @@ -151,7 +155,8 @@ void setup() { the_mesh.startInterface(serial_interface); #elif defined(ESP32) SPIFFS.begin(true); - the_mesh.begin(SPIFFS, + store.begin(); + the_mesh.begin( #ifdef DISPLAY_CLASS disp != NULL #else diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index ba8c3e28..7efd4735 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -699,6 +699,13 @@ int BaseChatMesh::findChannelIdx(const mesh::GroupChannel& ch) { } #endif +bool BaseChatMesh::getContactByIdx(uint32_t idx, ContactInfo& contact) { + if (idx >= num_contacts) return false; + + contact = contacts[idx]; + return true; +} + ContactsIterator BaseChatMesh::startContactsIterator() { return ContactsIterator(); } diff --git a/src/helpers/BaseChatMesh.h b/src/helpers/BaseChatMesh.h index 2222bf4e..83ad2a89 100644 --- a/src/helpers/BaseChatMesh.h +++ b/src/helpers/BaseChatMesh.h @@ -7,19 +7,7 @@ #define MAX_TEXT_LEN (10*CIPHER_BLOCK_SIZE) // must be LESS than (MAX_PACKET_PAYLOAD - 4 - CIPHER_MAC_SIZE - 1) -struct ContactInfo { - mesh::Identity id; - char name[32]; - uint8_t type; // on of ADV_TYPE_* - uint8_t flags; - int8_t out_path_len; - uint8_t out_path[MAX_PATH_SIZE]; - uint32_t last_advert_timestamp; // by THEIR clock - uint8_t shared_secret[PUB_KEY_SIZE]; - uint32_t lastmod; // by OUR clock - int32_t gps_lat, gps_lon; // 6 dec places - uint32_t sync_since; -}; +#include "ContactInfo.h" #define MAX_SEARCH_RESULTS 8 @@ -61,10 +49,7 @@ struct ConnectionInfo { uint32_t expected_ack; }; -struct ChannelDetails { - mesh::GroupChannel channel; - char name[32]; -}; +#include "ChannelDetails.h" /** * \brief abstract Mesh class for common 'chat' client @@ -158,6 +143,7 @@ public: bool removeContact(ContactInfo& contact); bool addContact(const ContactInfo& contact); int getNumContacts() const { return num_contacts; } + bool getContactByIdx(uint32_t idx, ContactInfo& contact); ContactsIterator startContactsIterator(); ChannelDetails* addChannel(const char* name, const char* psk_base64); bool getChannel(int idx, ChannelDetails& dest); diff --git a/src/helpers/ChannelDetails.h b/src/helpers/ChannelDetails.h new file mode 100644 index 00000000..b9d38d4f --- /dev/null +++ b/src/helpers/ChannelDetails.h @@ -0,0 +1,9 @@ +#pragma once + +#include +#include + +struct ChannelDetails { + mesh::GroupChannel channel; + char name[32]; +}; diff --git a/src/helpers/ContactInfo.h b/src/helpers/ContactInfo.h new file mode 100644 index 00000000..4a8038d3 --- /dev/null +++ b/src/helpers/ContactInfo.h @@ -0,0 +1,18 @@ +#pragma once + +#include +#include + +struct ContactInfo { + mesh::Identity id; + char name[32]; + uint8_t type; // on of ADV_TYPE_* + uint8_t flags; + int8_t out_path_len; + uint8_t out_path[MAX_PATH_SIZE]; + uint32_t last_advert_timestamp; // by THEIR clock + uint8_t shared_secret[PUB_KEY_SIZE]; + uint32_t lastmod; // by OUR clock + int32_t gps_lat, gps_lon; // 6 dec places + uint32_t sync_since; +}; From dd808ee6c741367f57010e2e56fd1db8fb9a35a7 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 6 Jun 2025 19:50:51 +1000 Subject: [PATCH 44/87] * new nRF52 impl for advert blobs --- examples/companion_radio/DataStore.cpp | 128 ++++++++++++++++++------- examples/companion_radio/DataStore.h | 9 +- examples/companion_radio/MyMesh.cpp | 2 + 3 files changed, 102 insertions(+), 37 deletions(-) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index fa848c05..8e0d119a 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -12,13 +12,28 @@ DataStore::DataStore(FILESYSTEM& fs) : _fs(&fs), { } +static File openWrite(FILESYSTEM* _fs, const char* filename) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + _fs->remove(filename); + return _fs->open(filename, FILE_O_WRITE); +#elif defined(RP2040_PLATFORM) + return _fs->open(filename, "w"); +#else + return _fs->open(filename, "w", true); +#endif +} + void DataStore::begin() { #if defined(RP2040_PLATFORM) identity_store.begin(); #endif +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + checkAdvBlobFile(); +#else // init 'blob store' support _fs->mkdir("/bl"); +#endif } #if defined(ESP32) @@ -90,14 +105,7 @@ void DataStore::loadPrefsInt(const char *filename, NodePrefs& _prefs, double& no } void DataStore::savePrefs(const NodePrefs& _prefs, double node_lat, double node_lon) { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/new_prefs"); - File file = _fs->open("/new_prefs", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/new_prefs", "w"); -#else - File file = _fs->open("/new_prefs", "w", true); -#endif + File file = openWrite(_fs, "/new_prefs"); if (file) { uint8_t pad[8]; memset(pad, 0, sizeof(pad)); @@ -163,14 +171,7 @@ void DataStore::loadContacts(DataStoreHost* host) { } void DataStore::saveContacts(DataStoreHost* host) { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/contacts3"); - File file = _fs->open("/contacts3", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/contacts3", "w"); -#else - File file = _fs->open("/contacts3", "w", true); -#endif + File file = openWrite(_fs, "/contacts3"); if (file) { uint32_t idx = 0; ContactInfo c; @@ -230,14 +231,7 @@ void DataStore::loadChannels(DataStoreHost* host) { } void DataStore::saveChannels(DataStoreHost* host) { -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove("/channels2"); - File file = _fs->open("/channels2", FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File file = _fs->open("/channels2", "w"); -#else - File file = _fs->open("/channels2", "w", true); -#endif + File file = openWrite(_fs, "/channels2"); if (file) { uint8_t channel_idx = 0; ChannelDetails ch; @@ -256,7 +250,79 @@ void DataStore::saveChannels(DataStoreHost* host) { } } -int DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + +#define MAX_ADVERT_PKT_LEN (PUB_KEY_SIZE + 4 + SIGNATURE_SIZE + MAX_ADVERT_DATA_SIZE) + +void DataStore::checkAdvBlobFile() { + if (!_fs->exists("/adv_blobs")) { + File file = openWrite(_fs, "/adv_blobs"); + if (file) { + uint8_t zeroes[1 + MAX_ADVERT_PKT_LEN]; + memset(zeroes, 0, sizeof(zeroes)); + for (int i = 0; i < 24; i++) { // pre-allocate to fixed size + file.write(zeroes, sizeof(zeroes)); + } + file.close(); + } + } +} + +uint8_t DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { + File file = _fs->open("/adv_blobs"); + uint8_t len = 0; // 0 = not found + if (file) { + uint8_t tmp[1 + MAX_ADVERT_PKT_LEN]; + while (file.read(tmp, sizeof(tmp)) == sizeof(tmp)) { + if (memcmp(key, &tmp[1], PUB_KEY_SIZE) == 0) { // public key is first 32 bytes of advert blob + len = tmp[0]; + memcpy(dest_buf, &tmp[1], len); + break; + } + } + file.close(); + } + return len; +} + +bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], uint8_t len) { + if (len < PUB_KEY_SIZE+4+SIGNATURE_SIZE || len > MAX_ADVERT_PKT_LEN) return false; + + checkAdvBlobFile(); + + File file = _fs->open("/adv_blobs", FILE_O_WRITE); + if (file) { + uint32_t pos = 0, found_pos = 0; + uint32_t min_timestamp = 0xFFFFFFFF; + + // search for matching key OR evict by oldest timestmap + uint8_t tmp[1 + MAX_ADVERT_PKT_LEN]; + while (file.read(tmp, sizeof(tmp)) == sizeof(tmp)) { + if (memcmp(src_buf, &tmp[1], PUB_KEY_SIZE) == 0) { // public key is first 32 bytes of advert blob + found_pos = pos; + break; + } + uint32_t timestamp; + memcpy(×tamp, &tmp[1 + PUB_KEY_SIZE], 4); + if (timestamp < min_timestamp) { + min_timestamp = timestamp; + found_pos = pos; + } + + pos += sizeof(tmp); + } + + file.seek(found_pos); + file.write(&len, 1); + file.write(src_buf, len); + + file.close(); + return true; + } + return false; // error +} +#else +uint8_t DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { char path[64]; char fname[18]; @@ -279,7 +345,7 @@ int DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[] return 0; // not found } -bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) { +bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], uint8_t len) { char path[64]; char fname[18]; @@ -287,14 +353,7 @@ bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src mesh::Utils::toHex(fname, key, key_len); sprintf(path, "/bl/%s", fname); -#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) - _fs->remove(path); - File f = _fs->open(path, FILE_O_WRITE); -#elif defined(RP2040_PLATFORM) - File f = _fs->open(path, "w"); -#else - File f = _fs->open(path, "w", true); -#endif + File f = openWrite(_fs, path); if (f) { int n = f.write(src_buf, len); f.close(); @@ -304,3 +363,4 @@ bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src } return false; // error } +#endif diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h index d1ed19bf..540bc9cd 100644 --- a/examples/companion_radio/DataStore.h +++ b/examples/companion_radio/DataStore.h @@ -18,8 +18,11 @@ class DataStore { IdentityStore identity_store; void loadPrefsInt(const char *filename, NodePrefs& prefs, double& node_lat, double& node_lon); +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + void checkAdvBlobFile(); +#endif - public: +public: DataStore(FILESYSTEM& fs); void begin(); bool formatFileSystem(); @@ -31,6 +34,6 @@ class DataStore { void saveContacts(DataStoreHost* host); void loadChannels(DataStoreHost* host); void saveChannels(DataStoreHost* host); - int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]); - bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len); + uint8_t getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]); + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], uint8_t len); }; diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 4c7b1618..054d0cba 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1291,7 +1291,9 @@ void MyMesh::checkCLIRescueCmd() { bool success = _store->formatFileSystem(); if (success) { _store->saveMainIdentity(self_id); + savePrefs(); saveContacts(); + saveChannels(); Serial.println(" > erase and rebuild done"); } else { Serial.println(" Error: erase failed"); From 4b9eac81c6d72fc18302a0999fe36f89639d9cfb Mon Sep 17 00:00:00 2001 From: liamcottle Date: Fri, 6 Jun 2025 21:55:03 +1200 Subject: [PATCH 45/87] fix 150mA power draw on ThinkNode M1 --- src/helpers/ui/buzzer.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/src/helpers/ui/buzzer.cpp b/src/helpers/ui/buzzer.cpp index ccc18cd3..c8e5cfcc 100644 --- a/src/helpers/ui/buzzer.cpp +++ b/src/helpers/ui/buzzer.cpp @@ -11,6 +11,7 @@ void genericBuzzer::begin() { quiet(false); pinMode(PIN_BUZZER, OUTPUT); + digitalWrite(PIN_BUZZER, LOW); // need to pull low by default to avoid extreme power draw startup(); } From 9c833486bf3c25b730fd81fc2d7f190f58d1f74c Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 6 Jun 2025 21:35:54 +1000 Subject: [PATCH 46/87] * DataStore, advert blob record format change --- examples/companion_radio/DataStore.cpp | 51 ++++++++++++++++---------- examples/companion_radio/DataStore.h | 3 +- examples/companion_radio/MyMesh.h | 6 +++ examples/companion_radio/main.cpp | 6 +-- variants/t114/platformio.ini | 2 +- 5 files changed, 43 insertions(+), 25 deletions(-) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index 8e0d119a..a37cfa49 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -1,7 +1,7 @@ #include #include "DataStore.h" -DataStore::DataStore(FILESYSTEM& fs) : _fs(&fs), +DataStore::DataStore(FILESYSTEM& fs, mesh::RTCClock& clock) : _fs(&fs), _clock(&clock), #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) identity_store(fs, "") #elif defined(RP2040_PLATFORM) @@ -252,16 +252,23 @@ void DataStore::saveChannels(DataStoreHost* host) { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) -#define MAX_ADVERT_PKT_LEN (PUB_KEY_SIZE + 4 + SIGNATURE_SIZE + MAX_ADVERT_DATA_SIZE) +#define MAX_ADVERT_PKT_LEN (2 + 32 + PUB_KEY_SIZE + 4 + SIGNATURE_SIZE + MAX_ADVERT_DATA_SIZE) + +struct BlobRec { + uint32_t timestamp; + uint8_t key[7]; + uint8_t len; + uint8_t data[MAX_ADVERT_PKT_LEN]; +}; void DataStore::checkAdvBlobFile() { if (!_fs->exists("/adv_blobs")) { File file = openWrite(_fs, "/adv_blobs"); if (file) { - uint8_t zeroes[1 + MAX_ADVERT_PKT_LEN]; - memset(zeroes, 0, sizeof(zeroes)); - for (int i = 0; i < 24; i++) { // pre-allocate to fixed size - file.write(zeroes, sizeof(zeroes)); + BlobRec zeroes; + memset(&zeroes, 0, sizeof(zeroes)); + for (int i = 0; i < 20; i++) { // pre-allocate to fixed size + file.write((uint8_t *) &zeroes, sizeof(zeroes)); } file.close(); } @@ -271,12 +278,13 @@ void DataStore::checkAdvBlobFile() { uint8_t DataStore::getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) { File file = _fs->open("/adv_blobs"); uint8_t len = 0; // 0 = not found + if (file) { - uint8_t tmp[1 + MAX_ADVERT_PKT_LEN]; - while (file.read(tmp, sizeof(tmp)) == sizeof(tmp)) { - if (memcmp(key, &tmp[1], PUB_KEY_SIZE) == 0) { // public key is first 32 bytes of advert blob - len = tmp[0]; - memcpy(dest_buf, &tmp[1], len); + BlobRec tmp; + while (file.read((uint8_t *) &tmp, sizeof(tmp)) == sizeof(tmp)) { + if (memcmp(key, tmp.key, sizeof(tmp.key)) == 0) { // only match by 7 byte prefix + len = tmp.len; + memcpy(dest_buf, tmp.data, len); break; } } @@ -296,25 +304,28 @@ bool DataStore::putBlobByKey(const uint8_t key[], int key_len, const uint8_t src uint32_t min_timestamp = 0xFFFFFFFF; // search for matching key OR evict by oldest timestmap - uint8_t tmp[1 + MAX_ADVERT_PKT_LEN]; - while (file.read(tmp, sizeof(tmp)) == sizeof(tmp)) { - if (memcmp(src_buf, &tmp[1], PUB_KEY_SIZE) == 0) { // public key is first 32 bytes of advert blob + BlobRec tmp; + file.seek(0); + while (file.read((uint8_t *) &tmp, sizeof(tmp)) == sizeof(tmp)) { + if (memcmp(key, tmp.key, sizeof(tmp.key)) == 0) { // only match by 7 byte prefix found_pos = pos; break; } - uint32_t timestamp; - memcpy(×tamp, &tmp[1 + PUB_KEY_SIZE], 4); - if (timestamp < min_timestamp) { - min_timestamp = timestamp; + if (tmp.timestamp < min_timestamp) { + min_timestamp = tmp.timestamp; found_pos = pos; } pos += sizeof(tmp); } + memcpy(tmp.key, key, sizeof(tmp.key)); // just record 7 byte prefix of key + memcpy(tmp.data, src_buf, len); + tmp.len = len; + tmp.timestamp = _clock->getCurrentTime(); + file.seek(found_pos); - file.write(&len, 1); - file.write(src_buf, len); + file.write((uint8_t *) &tmp, sizeof(tmp)); file.close(); return true; diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h index 540bc9cd..139131e1 100644 --- a/examples/companion_radio/DataStore.h +++ b/examples/companion_radio/DataStore.h @@ -15,6 +15,7 @@ public: class DataStore { FILESYSTEM* _fs; + mesh::RTCClock* _clock; IdentityStore identity_store; void loadPrefsInt(const char *filename, NodePrefs& prefs, double& node_lat, double& node_lon); @@ -23,7 +24,7 @@ class DataStore { #endif public: - DataStore(FILESYSTEM& fs); + DataStore(FILESYSTEM& fs, mesh::RTCClock& clock); void begin(); bool formatFileSystem(); bool loadMainIdentity(mesh::LocalIdentity &identity); diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index 6ac030d9..43194f09 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -140,6 +140,12 @@ private: void updateContactFromFrame(ContactInfo &contact, const uint8_t *frame, int len); void addToOfflineQueue(const uint8_t frame[], int len); int getFromOfflineQueue(uint8_t frame[]); + int getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]) override { + return _store->getBlobByKey(key, key_len, dest_buf); + } + bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], int len) override { + return _store->putBlobByKey(key, key_len, src_buf, len); + } void checkCLIRescueCmd(); void checkSerialInterface(); diff --git a/examples/companion_radio/main.cpp b/examples/companion_radio/main.cpp index b463dcbe..b46cdaab 100644 --- a/examples/companion_radio/main.cpp +++ b/examples/companion_radio/main.cpp @@ -14,13 +14,13 @@ static uint32_t _atoi(const char* sp) { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) #include - DataStore store(InternalFS); + DataStore store(InternalFS, rtc_clock); #elif defined(RP2040_PLATFORM) #include - DataStore store(LittleFS); + DataStore store(LittleFS, rtc_clock); #elif defined(ESP32) #include - DataStore store(SPIFFS); + DataStore store(SPIFFS, rtc_clock); #endif #ifdef ESP32 diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index fd9d6f34..5343e5ad 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -70,7 +70,7 @@ build_flags = -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -D BLE_PIN_CODE=123456 - -D BLE_DEBUG_LOGGING=1 +; -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 ; -D ENABLE_PRIVATE_KEY_IMPORT=1 ; -D ENABLE_PRIVATE_KEY_EXPORT=1 From da5b0f8524aa04be94d4b9106682f344cd85ca5b Mon Sep 17 00:00:00 2001 From: Rob Loranger Date: Wed, 4 Jun 2025 09:51:16 -0700 Subject: [PATCH 47/87] add basic alert system to companion UI Adds `_alert[80]` which can be set along with `_needs_refresh` to trigger a simple on screen alert that lasts 1s at this time. Implements POC with double press to advert action --- examples/companion_radio/UITask.cpp | 17 ++++++++++++++++- examples/companion_radio/UITask.h | 1 + 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index f0f780d6..deeacdad 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -162,7 +162,16 @@ void UITask::renderCurrScreen() { if (_display == NULL) return; // assert() ?? char tmp[80]; - if (_origin[0] && _msg[0]) { // message preview + if (_alert[0]) { + uint16_t textWidth = _display->getTextWidth(_alert); + _display->setCursor((_display->width() - textWidth) / 2, 22); + _display->setTextSize(1.4); + _display->setColor(DisplayDriver::GREEN); + _display->print(_alert); + _alert[0] = 0; + _need_refresh = true; + return; + } else if (_origin[0] && _msg[0]) { // message preview // render message preview _display->setCursor(0, 0); _display->setTextSize(1); @@ -343,11 +352,17 @@ void UITask::handleButtonShortPress() { void UITask::handleButtonDoublePress() { MESH_DEBUG_PRINTLN("UITask: double press triggered, sending advert"); // ADVERT + #ifdef PIN_BUZZER + soundBuzzer(UIEventType::ack); + #endif if (the_mesh.advert()) { MESH_DEBUG_PRINTLN("Advert sent!"); + sprintf(_alert, "Advert sent!"); } else { MESH_DEBUG_PRINTLN("Advert failed!"); + sprintf(_alert, "Advert failed.."); } + _need_refresh = true; } void UITask::handleButtonTriplePress() { diff --git a/examples/companion_radio/UITask.h b/examples/companion_radio/UITask.h index fff0bbe1..93a2ef89 100644 --- a/examples/companion_radio/UITask.h +++ b/examples/companion_radio/UITask.h @@ -33,6 +33,7 @@ class UITask { char _version_info[32]; char _origin[62]; char _msg[80]; + char _alert[80]; int _msgcount; bool _need_refresh = true; bool _displayWasOn = false; // Track display state before button press From 0f601752e4e9089a866c2e6d70c439e709c93b94 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 15:23:55 +1200 Subject: [PATCH 48/87] implement ls and cat commands for rescue mode --- examples/companion_radio/DataStore.cpp | 10 ++++++ examples/companion_radio/DataStore.h | 1 + examples/companion_radio/MyMesh.cpp | 48 ++++++++++++++++++++++++++ 3 files changed, 59 insertions(+) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index a37cfa49..795e38cc 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -42,6 +42,16 @@ void DataStore::begin() { #include #endif +File DataStore::openRead(const char* filename) { +#if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) + return _fs->open(filename, FILE_O_READ); +#elif defined(RP2040_PLATFORM) + return _fs->open(filename, "r"); +#else + return _fs->open(filename, "r", true); +#endif +} + bool DataStore::formatFileSystem() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) return _fs->format(); diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h index 139131e1..201dac01 100644 --- a/examples/companion_radio/DataStore.h +++ b/examples/companion_radio/DataStore.h @@ -37,4 +37,5 @@ public: void saveChannels(DataStoreHost* host); uint8_t getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]); bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], uint8_t len); + File openRead(const char* filename); }; diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 054d0cba..79910aee 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1305,6 +1305,54 @@ void MyMesh::checkCLIRescueCmd() { } else { Serial.println(" Error: erase failed"); } + } else if (memcmp(cli_command, "ls", 2) == 0) { + + // get path from command e.g: "ls /adafruit" + const char *path = &cli_command[3]; + + // log each file and directory + File root = _store->openRead(path); + File file = root.openNextFile(); + while (file) { + + if (file.isDirectory()) { + Serial.print("[dir] "); + Serial.println(file.name()); + } else { + Serial.print("[file] "); + Serial.print(file.name()); + Serial.print(" ("); + Serial.print(file.size()); + Serial.println(" bytes)"); + } + + // move to next file + file = root.openNextFile(); + + } + + } else if (memcmp(cli_command, "cat", 3) == 0) { + + // get path from command e.g: "cat /contacts3" + const char *path = &cli_command[4]; + + // log file content as hex + File file = _store->openRead(path); + if(file){ + + // get file content + int file_size = file.available(); + uint8_t buffer[file_size]; + file.read(buffer, file_size); + + // print hex + mesh::Utils::printHex(Serial, buffer, file_size); + Serial.print("\n"); + + file.close(); + + } + } else if (strcmp(cli_command, "reboot") == 0) { board.reboot(); // doesn't return } else { From a22c176d45123361523c9d0209056e78dae8ef3b Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 15:44:36 +1200 Subject: [PATCH 49/87] add rm command to remove file --- examples/companion_radio/DataStore.cpp | 4 ++++ examples/companion_radio/DataStore.h | 1 + examples/companion_radio/MyMesh.cpp | 13 +++++++++++++ 3 files changed, 18 insertions(+) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index 795e38cc..508b270e 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -52,6 +52,10 @@ File DataStore::openRead(const char* filename) { #endif } +bool DataStore::removeFile(const char* filename) { + return _fs->remove(filename); +} + bool DataStore::formatFileSystem() { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) return _fs->format(); diff --git a/examples/companion_radio/DataStore.h b/examples/companion_radio/DataStore.h index 201dac01..32ccd196 100644 --- a/examples/companion_radio/DataStore.h +++ b/examples/companion_radio/DataStore.h @@ -38,4 +38,5 @@ public: uint8_t getBlobByKey(const uint8_t key[], int key_len, uint8_t dest_buf[]); bool putBlobByKey(const uint8_t key[], int key_len, const uint8_t src_buf[], uint8_t len); File openRead(const char* filename); + bool removeFile(const char* filename); }; diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 79910aee..63fbf142 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1353,6 +1353,19 @@ void MyMesh::checkCLIRescueCmd() { } + } else if (memcmp(cli_command, "rm ", 3) == 0) { + + // get path from command e.g: "rm /adv_blobs" + const char *path = &cli_command[4]; + + // remove file + bool removed = _store->removeFile(path); + if(removed){ + Serial.println("File removed"); + } else { + Serial.println("Failed to remove file"); + } + } else if (strcmp(cli_command, "reboot") == 0) { board.reboot(); // doesn't return } else { From 9d574b2de0a3ba9cd2ef27359d745343c02420fc Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 16:03:04 +1200 Subject: [PATCH 50/87] ensure user isn't removing invalid path --- examples/companion_radio/MyMesh.cpp | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 63fbf142..4d3860c3 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1357,13 +1357,20 @@ void MyMesh::checkCLIRescueCmd() { // get path from command e.g: "rm /adv_blobs" const char *path = &cli_command[4]; - - // remove file - bool removed = _store->removeFile(path); - if(removed){ - Serial.println("File removed"); + + // ensure path is not empty, or root dir + if(!path || strlen(path) == 0 || strcmp(path, "/") == 0){ + Serial.println("Invalid path provided"); } else { - Serial.println("Failed to remove file"); + + // remove file + bool removed = _store->removeFile(path); + if(removed){ + Serial.println("File removed"); + } else { + Serial.println("Failed to remove file"); + } + } } else if (strcmp(cli_command, "reboot") == 0) { From a814bfb00be1fabb164c1986fc5c8ab850b7bbeb Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 16:17:45 +1200 Subject: [PATCH 51/87] don't create file when trying to open for read --- examples/companion_radio/DataStore.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/companion_radio/DataStore.cpp b/examples/companion_radio/DataStore.cpp index 508b270e..2ba5ccfb 100644 --- a/examples/companion_radio/DataStore.cpp +++ b/examples/companion_radio/DataStore.cpp @@ -48,7 +48,7 @@ File DataStore::openRead(const char* filename) { #elif defined(RP2040_PLATFORM) return _fs->open(filename, "r"); #else - return _fs->open(filename, "r", true); + return _fs->open(filename, "r", false); #endif } From 7dd7b715cdeb16961ff268d7c403ba8f5f4a0da8 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 7 Jun 2025 14:20:59 +1000 Subject: [PATCH 52/87] * enabling _PRIVATE_KEY import/export for ALL companions. --- platformio.ini | 2 ++ variants/generic_espnow/platformio.ini | 2 -- variants/heltec_tracker/platformio.ini | 2 -- variants/heltec_v2/platformio.ini | 2 -- variants/heltec_v3/platformio.ini | 8 -------- variants/lilygo_t3s3/platformio.ini | 4 ---- variants/lilygo_tbeam/platformio.ini | 2 -- variants/lilygo_tbeam_SX1262/platformio.ini | 2 -- variants/lilygo_tbeam_supreme_SX1262/platformio.ini | 2 -- variants/lilygo_tlora_v2_1/platformio.ini | 4 ---- variants/nano_g2_ultra/platformio.ini | 2 -- variants/picow/platformio.ini | 6 ------ variants/promicro/platformio.ini | 4 ---- variants/rak4631/platformio.ini | 6 ------ variants/t114/platformio.ini | 4 ---- variants/techo/platformio.ini | 2 -- variants/thinknode_m1/platformio.ini | 2 -- variants/xiao_nrf52/platformio.ini | 2 -- variants/xiao_s3_wio/platformio.ini | 2 -- 19 files changed, 2 insertions(+), 58 deletions(-) diff --git a/platformio.ini b/platformio.ini index 0c16ead4..2c3ffd83 100644 --- a/platformio.ini +++ b/platformio.ini @@ -27,6 +27,8 @@ build_flags = -w -DNDEBUG -DRADIOLIB_STATIC_ONLY=1 -DRADIOLIB_GODMODE=1 -D LORA_FREQ=869.525 -D LORA_BW=250 -D LORA_SF=11 + -D ENABLE_PRIVATE_KEY_IMPORT=1 ; NOTE: comment these out for more secure firmware + -D ENABLE_PRIVATE_KEY_EXPORT=1 build_src_filter = +<*.cpp> + diff --git a/variants/generic_espnow/platformio.ini b/variants/generic_espnow/platformio.ini index b3ae7e45..dbc902f0 100644 --- a/variants/generic_espnow/platformio.ini +++ b/variants/generic_espnow/platformio.ini @@ -56,8 +56,6 @@ build_flags = ${Generic_ESPNOW.build_flags} -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 ; NOTE: DO NOT ENABLE --> -D ESPNOW_DEBUG_LOGGING=1 diff --git a/variants/heltec_tracker/platformio.ini b/variants/heltec_tracker/platformio.ini index ed4cbe28..8d9013a5 100644 --- a/variants/heltec_tracker/platformio.ini +++ b/variants/heltec_tracker/platformio.ini @@ -47,8 +47,6 @@ build_flags = -D BLE_PIN_CODE=123456 ; HWT will use display for pin -D OFFLINE_QUEUE_SIZE=256 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_tracker_base.build_src_filter} diff --git a/variants/heltec_v2/platformio.ini b/variants/heltec_v2/platformio.ini index 495f20f8..562b309d 100644 --- a/variants/heltec_v2/platformio.ini +++ b/variants/heltec_v2/platformio.ini @@ -99,8 +99,6 @@ build_flags = -D BLE_PIN_CODE=0 -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_lora32_v2.build_src_filter} diff --git a/variants/heltec_v3/platformio.ini b/variants/heltec_v3/platformio.ini index 28c6d562..e8818fdd 100644 --- a/variants/heltec_v3/platformio.ini +++ b/variants/heltec_v3/platformio.ini @@ -91,8 +91,6 @@ build_flags = -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -D DISPLAY_CLASS=SSD1306Display -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${Heltec_lora32_v3.build_src_filter} @@ -112,8 +110,6 @@ build_flags = -D BLE_PIN_CODE=0 ; dynamic, random PIN -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_lora32_v3.build_src_filter} @@ -134,8 +130,6 @@ build_flags = -D WIFI_DEBUG_LOGGING=1 -D WIFI_SSID='"myssid"' -D WIFI_PWD='"mypwd"' -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_lora32_v3.build_src_filter} @@ -189,8 +183,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_lora32_v3.build_src_filter} diff --git a/variants/lilygo_t3s3/platformio.ini b/variants/lilygo_t3s3/platformio.ini index 94ec87af..f3a95e96 100644 --- a/variants/lilygo_t3s3/platformio.ini +++ b/variants/lilygo_t3s3/platformio.ini @@ -92,8 +92,6 @@ build_flags = -D DISPLAY_CLASS=SSD1306Display -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${LilyGo_T3S3_sx1262.build_src_filter} @@ -113,8 +111,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${LilyGo_T3S3_sx1262.build_src_filter} diff --git a/variants/lilygo_tbeam/platformio.ini b/variants/lilygo_tbeam/platformio.ini index c471e44c..4369243d 100644 --- a/variants/lilygo_tbeam/platformio.ini +++ b/variants/lilygo_tbeam/platformio.ini @@ -33,8 +33,6 @@ build_flags = -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 ; -D RADIOLIB_DEBUG_BASIC=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${LilyGo_TBeam.build_src_filter} diff --git a/variants/lilygo_tbeam_SX1262/platformio.ini b/variants/lilygo_tbeam_SX1262/platformio.ini index 517fc2e0..153fc6fa 100644 --- a/variants/lilygo_tbeam_SX1262/platformio.ini +++ b/variants/lilygo_tbeam_SX1262/platformio.ini @@ -38,8 +38,6 @@ build_flags = ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 ; -D RADIOLIB_DEBUG_BASIC=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${LilyGo_TBeam_SX1262.build_src_filter} diff --git a/variants/lilygo_tbeam_supreme_SX1262/platformio.ini b/variants/lilygo_tbeam_supreme_SX1262/platformio.ini index 4e6721f9..bcc51703 100644 --- a/variants/lilygo_tbeam_supreme_SX1262/platformio.ini +++ b/variants/lilygo_tbeam_supreme_SX1262/platformio.ini @@ -69,8 +69,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D OFFLINE_QUEUE_SIZE=256 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=8 ; -D MESH_DEBUG=1 build_src_filter = ${T_Beam_S3_Supreme_SX1262.build_src_filter} diff --git a/variants/lilygo_tlora_v2_1/platformio.ini b/variants/lilygo_tlora_v2_1/platformio.ini index 5591a400..d9cecfc2 100644 --- a/variants/lilygo_tlora_v2_1/platformio.ini +++ b/variants/lilygo_tlora_v2_1/platformio.ini @@ -72,8 +72,6 @@ build_flags = ${LilyGo_TLora_V2_1_1_6.build_flags} -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${LilyGo_TLora_V2_1_1_6.build_src_filter} @@ -92,8 +90,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D OFFLINE_QUEUE_SIZE=256 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${LilyGo_TLora_V2_1_1_6.build_src_filter} diff --git a/variants/nano_g2_ultra/platformio.ini b/variants/nano_g2_ultra/platformio.ini index 98feb35c..20928bdf 100644 --- a/variants/nano_g2_ultra/platformio.ini +++ b/variants/nano_g2_ultra/platformio.ini @@ -41,8 +41,6 @@ build_flags = -D OFFLINE_QUEUE_SIZE=256 -D DISPLAY_CLASS=SH1106Display -D PIN_BUZZER=4 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Nano_G2_Ultra.build_src_filter} diff --git a/variants/picow/platformio.ini b/variants/picow/platformio.ini index ec27e6ee..0e925486 100644 --- a/variants/picow/platformio.ini +++ b/variants/picow/platformio.ini @@ -49,8 +49,6 @@ extends = picow build_flags = ${picow.build_flags} -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${picow.build_src_filter} @@ -65,8 +63,6 @@ lib_deps = ${picow.lib_deps} ; -D MAX_GROUP_CHANNELS=8 ; -D BLE_PIN_CODE=123456 ; -D BLE_DEBUG_LOGGING=1 -; ; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; ; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; ; -D MESH_PACKET_LOGGING=1 ; ; -D MESH_DEBUG=1 ; build_src_filter = ${picow.build_src_filter} @@ -82,8 +78,6 @@ lib_deps = ${picow.lib_deps} ; -D WIFI_DEBUG_LOGGING=1 ; -D WIFI_SSID='"myssid"' ; -D WIFI_PWD='"mypwd"' -; ; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; ; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; ; -D MESH_PACKET_LOGGING=1 ; ; -D MESH_DEBUG=1 ; build_src_filter = ${picow.build_src_filter} diff --git a/variants/promicro/platformio.ini b/variants/promicro/platformio.ini index 49771624..e7099d1e 100644 --- a/variants/promicro/platformio.ini +++ b/variants/promicro/platformio.ini @@ -103,8 +103,6 @@ build_flags = ${Faketec.build_flags} -D MAX_GROUP_CHANNELS=8 -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 - -D ENABLE_PRIVATE_KEY_EXPORT=1 - -D ENABLE_PRIVATE_KEY_IMPORT=1 -D OFFLINE_QUEUE_SIZE=256 -D DISPLAY_CLASS=SSD1306Display ; -D MESH_PACKET_LOGGING=1 @@ -198,8 +196,6 @@ build_flags = ${ProMicroLLCC68.build_flags} -D MAX_GROUP_CHANNELS=8 -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 - -D ENABLE_PRIVATE_KEY_EXPORT=1 - -D ENABLE_PRIVATE_KEY_IMPORT=1 -D OFFLINE_QUEUE_SIZE=256 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 diff --git a/variants/rak4631/platformio.ini b/variants/rak4631/platformio.ini index c7f1fa53..3014bc59 100644 --- a/variants/rak4631/platformio.ini +++ b/variants/rak4631/platformio.ini @@ -64,8 +64,6 @@ build_flags = -D DISPLAY_CLASS=SSD1306Display -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 ; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 build_src_filter = ${rak4631.build_src_filter} @@ -85,8 +83,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${rak4631.build_src_filter} @@ -108,8 +104,6 @@ build_flags = -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -D ENV_INCLUDE_GPS=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${rak4631.build_src_filter} diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index fd9d6f34..4aba03e1 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -72,8 +72,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D BLE_DEBUG_LOGGING=1 -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} @@ -96,8 +94,6 @@ build_flags = -D MAX_GROUP_CHANNELS=8 ; -D BLE_PIN_CODE=123456 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} diff --git a/variants/techo/platformio.ini b/variants/techo/platformio.ini index 95c9ff84..8ad5ca03 100644 --- a/variants/techo/platformio.ini +++ b/variants/techo/platformio.ini @@ -67,8 +67,6 @@ build_flags = -D BLE_DEBUG_LOGGING=1 -D DISPLAY_CLASS=GxEPDDisplay -D OFFLINE_QUEUE_SIZE=256 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${LilyGo_Techo.build_src_filter} diff --git a/variants/thinknode_m1/platformio.ini b/variants/thinknode_m1/platformio.ini index 06910c0a..1a4837d8 100644 --- a/variants/thinknode_m1/platformio.ini +++ b/variants/thinknode_m1/platformio.ini @@ -75,8 +75,6 @@ build_flags = -D DISPLAY_CLASS=GxEPDDisplay -D OFFLINE_QUEUE_SIZE=256 -D PIN_BUZZER=6 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${ThinkNode_M1.build_src_filter} diff --git a/variants/xiao_nrf52/platformio.ini b/variants/xiao_nrf52/platformio.ini index 50baccad..c4934e04 100644 --- a/variants/xiao_nrf52/platformio.ini +++ b/variants/xiao_nrf52/platformio.ini @@ -65,7 +65,6 @@ build_flags = -D BLE_PIN_CODE=123456 -D OFFLINE_QUEUE_SIZE=256 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_nrf52.build_src_filter} @@ -81,7 +80,6 @@ build_flags = ${Xiao_nrf52.build_flags} -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_nrf52.build_src_filter} diff --git a/variants/xiao_s3_wio/platformio.ini b/variants/xiao_s3_wio/platformio.ini index bb5ae698..4d6fed88 100644 --- a/variants/xiao_s3_wio/platformio.ini +++ b/variants/xiao_s3_wio/platformio.ini @@ -85,8 +85,6 @@ build_flags = -D DISPLAY_CLASS=SSD1306Display -D OFFLINE_QUEUE_SIZE=256 ; -D BLE_DEBUG_LOGGING=1 -; -D ENABLE_PRIVATE_KEY_IMPORT=1 -; -D ENABLE_PRIVATE_KEY_EXPORT=1 ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Xiao_S3_WIO.build_src_filter} From a50f89f16f1a67b066e3414ae2e6fff4184ecc8b Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 17:38:22 +1200 Subject: [PATCH 53/87] ensure root path is usable --- examples/companion_radio/MyMesh.cpp | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 4d3860c3..68e9d615 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1312,8 +1312,9 @@ void MyMesh::checkCLIRescueCmd() { // log each file and directory File root = _store->openRead(path); - File file = root.openNextFile(); - while (file) { + if(root){ + File file = root.openNextFile(); + while (file) { if (file.isDirectory()) { Serial.print("[dir] "); @@ -1329,6 +1330,7 @@ void MyMesh::checkCLIRescueCmd() { // move to next file file = root.openNextFile(); + } } } else if (memcmp(cli_command, "cat", 3) == 0) { From 28edff43fd91038456046a095e2a399a1c78dab6 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 17:42:18 +1200 Subject: [PATCH 54/87] simplify serial print --- examples/companion_radio/MyMesh.cpp | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 68e9d615..9c8b96b1 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1317,14 +1317,9 @@ void MyMesh::checkCLIRescueCmd() { while (file) { if (file.isDirectory()) { - Serial.print("[dir] "); - Serial.println(file.name()); + Serial.printf("[dir] %s\n", file.name()); } else { - Serial.print("[file] "); - Serial.print(file.name()); - Serial.print(" ("); - Serial.print(file.size()); - Serial.println(" bytes)"); + Serial.printf("[file] %s (%d bytes)\n", file.name(), file.size()); } // move to next file From 7f79d0c5142a9b43e87d29d1e865c368ca3bf934 Mon Sep 17 00:00:00 2001 From: liamcottle Date: Sat, 7 Jun 2025 17:56:20 +1200 Subject: [PATCH 55/87] close roor dir after listing files --- examples/companion_radio/MyMesh.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 9c8b96b1..2b98ec04 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -1326,6 +1326,7 @@ void MyMesh::checkCLIRescueCmd() { file = root.openNextFile(); } + root.close(); } } else if (memcmp(cli_command, "cat", 3) == 0) { From af0c409cbbc0aad2065a80218a97c2981013e92a Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sat, 7 Jun 2025 16:15:17 +1000 Subject: [PATCH 56/87] * ver bump to v1.7.0 --- examples/companion_radio/MyMesh.h | 4 ++-- examples/simple_repeater/main.cpp | 4 ++-- examples/simple_room_server/main.cpp | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index 43194f09..f6603feb 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -10,11 +10,11 @@ #define FIRMWARE_VER_CODE 5 #ifndef FIRMWARE_BUILD_DATE -#define FIRMWARE_BUILD_DATE "24 May 2025" +#define FIRMWARE_BUILD_DATE "7 Jun 2025" #endif #ifndef FIRMWARE_VERSION -#define FIRMWARE_VERSION "v1.6.2" +#define FIRMWARE_VERSION "v1.7.0" #endif #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index c2a8ae92..effc177a 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -22,11 +22,11 @@ /* ------------------------------ Config -------------------------------- */ #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "24 May 2025" + #define FIRMWARE_BUILD_DATE "7 Jun 2025" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.6.2" + #define FIRMWARE_VERSION "v1.7.0" #endif #ifndef LORA_FREQ diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 32fe4a04..400b31dd 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -22,11 +22,11 @@ /* ------------------------------ Config -------------------------------- */ #ifndef FIRMWARE_BUILD_DATE - #define FIRMWARE_BUILD_DATE "24 May 2025" + #define FIRMWARE_BUILD_DATE "7 Jun 2025" #endif #ifndef FIRMWARE_VERSION - #define FIRMWARE_VERSION "v1.6.2" + #define FIRMWARE_VERSION "v1.7.0" #endif #ifndef LORA_FREQ From 7525877f6c1b7f9e3e1f6edbddf02b9e7b5fbe0e Mon Sep 17 00:00:00 2001 From: Rastislav Vysoky Date: Sat, 7 Jun 2025 10:48:09 +0200 Subject: [PATCH 57/87] add mising config for `openocd_target` --- boards/nano-g2-ultra.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/boards/nano-g2-ultra.json b/boards/nano-g2-ultra.json index 11e7ebaa..9fa22d7b 100644 --- a/boards/nano-g2-ultra.json +++ b/boards/nano-g2-ultra.json @@ -46,7 +46,8 @@ ], "debug": { "jlink_device": "nRF52840_xxAA", - "svd_path": "nrf52840.svd" + "svd_path": "nrf52840.svd", + "openocd_target": "nrf52.cfg" }, "frameworks": [ "arduino" @@ -69,4 +70,4 @@ }, "url": "https://wiki.uniteng.com/en/meshtastic/nano-g2-ultra", "vendor": "BQ Consulting" -} \ No newline at end of file +} From 1bc94c2ec3cead325993798a90a1351e4d237a65 Mon Sep 17 00:00:00 2001 From: JQ Date: Sat, 7 Jun 2025 15:57:22 -0700 Subject: [PATCH 58/87] minor companion ui fixes --- examples/companion_radio/UITask.cpp | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index deeacdad..79dde2d8 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -5,7 +5,7 @@ #include "MyMesh.h" #define AUTO_OFF_MILLIS 15000 // 15 seconds -#define BOOT_SCREEN_MILLIS 4000 // 4 seconds +#define BOOT_SCREEN_MILLIS 3000 // 3 seconds #ifdef PIN_STATUS_LED #define LED_ON_MILLIS 20 @@ -191,7 +191,7 @@ void UITask::renderCurrScreen() { sprintf(tmp, "%d", _msgcount); _display->print(tmp); _display->setColor(DisplayDriver::YELLOW); // last color will be kept on T114 - } else if (millis() < BOOT_SCREEN_MILLIS) { // boot screen + } else if ((millis() - ui_started_at) < BOOT_SCREEN_MILLIS) { // boot screen // meshcore logo _display->setColor(DisplayDriver::BLUE); int logoWidth = 128; @@ -302,7 +302,7 @@ void UITask::loop() { if (_display != NULL && _display->isOn()) { static bool _firstBoot = true; - if(_firstBoot && millis() >= BOOT_SCREEN_MILLIS) { + if(_firstBoot && (millis() - ui_started_at) >= BOOT_SCREEN_MILLIS) { _need_refresh = true; _firstBoot = false; } @@ -344,6 +344,8 @@ void UITask::handleButtonShortPress() { // Otherwise, refresh the display _need_refresh = true; } + } else { + _need_refresh = true; // display just turned on, so we need to refresh } // Note: Display turn-on and auto-off timer extension are handled by handleButtonAnyPress } @@ -372,10 +374,13 @@ void UITask::handleButtonTriplePress() { if (buzzer.isQuiet()) { buzzer.quiet(false); soundBuzzer(UIEventType::ack); + sprintf(_alert, "Quiet mode: OFF"); } else { soundBuzzer(UIEventType::ack); buzzer.quiet(true); + sprintf(_alert, "Quiet mode: ON"); } + _need_refresh = true; #endif } From 42ef297241a539be366da3f989ff7dfc0c021b42 Mon Sep 17 00:00:00 2001 From: JQ Date: Sat, 7 Jun 2025 22:35:59 -0700 Subject: [PATCH 59/87] set text width ahead of width calculation --- examples/companion_radio/UITask.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index 79dde2d8..3801236b 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -163,9 +163,9 @@ void UITask::renderCurrScreen() { char tmp[80]; if (_alert[0]) { + _display->setTextSize(1.4); uint16_t textWidth = _display->getTextWidth(_alert); _display->setCursor((_display->width() - textWidth) / 2, 22); - _display->setTextSize(1.4); _display->setColor(DisplayDriver::GREEN); _display->print(_alert); _alert[0] = 0; From dafb5d3e983387f06a78fb8280975707fec98c67 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sun, 8 Jun 2025 18:41:29 +1000 Subject: [PATCH 60/87] * added repeater target for Heltec-CT62 --- variants/heltec_ct62/platformio.ini | 47 ++++++++++++++++++ variants/heltec_ct62/target.cpp | 76 +++++++++++++++++++++++++++++ variants/heltec_ct62/target.h | 20 ++++++++ 3 files changed, 143 insertions(+) create mode 100644 variants/heltec_ct62/platformio.ini create mode 100644 variants/heltec_ct62/target.cpp create mode 100644 variants/heltec_ct62/target.h diff --git a/variants/heltec_ct62/platformio.ini b/variants/heltec_ct62/platformio.ini new file mode 100644 index 00000000..6a0ba376 --- /dev/null +++ b/variants/heltec_ct62/platformio.ini @@ -0,0 +1,47 @@ +[Heltec_ct62] +extends = esp32_base +board = esp32-c3-devkitm-1 +build_flags = + ${esp32_base.build_flags} + -I variants/heltec_ct62 + -D HELTEC_HT_CT62=1 + -D RADIO_CLASS=CustomSX1262 + -D WRAPPER_CLASS=CustomSX1262Wrapper + -D ESP32_CPU_FREQ=80 + -D LORA_TX_POWER=22 + -D P_LORA_TX_LED=18 + -D PIN_BOARD_SDA=0 + -D PIN_BOARD_SCL=1 + -D PIN_USER_BTN=9 + -D PIN_VBAT_READ=2 + -D P_LORA_DIO_1=3 + -D P_LORA_NSS=8 + -D P_LORA_RESET=5 + -D P_LORA_RESET=RADIOLIB_NC + -D P_LORA_BUSY=4 + -D P_LORA_SCLK=10 + -D P_LORA_MISO=6 + -D P_LORA_MOSI=7 + -D SX126X_DIO2_AS_RF_SWITCH=true + -D SX126X_DIO3_TCXO_VOLTAGE=1.8 + -D SX126X_CURRENT_LIMIT=140 + -D SX126X_RX_BOOSTED_GAIN=1 +build_src_filter = ${esp32_base.build_src_filter} + +<../variants/heltec_ct62> + +[env:Heltec_ct62_repeater] +extends = Heltec_ct62 +build_flags = + ${Heltec_ct62.build_flags} + -D ADVERT_NAME='"HT-CT62 Repeater"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D MAX_NEIGHBOURS=8 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${Heltec_ct62.build_src_filter} + +<../examples/simple_repeater> +lib_deps = + ${Heltec_ct62.lib_deps} + ${esp32_ota.lib_deps} diff --git a/variants/heltec_ct62/target.cpp b/variants/heltec_ct62/target.cpp new file mode 100644 index 00000000..4073518f --- /dev/null +++ b/variants/heltec_ct62/target.cpp @@ -0,0 +1,76 @@ +#include +#include "target.h" + +ESP32Board board; + +#if defined(P_LORA_SCLK) + static SPIClass spi; + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); +#else + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); +#endif + +WRAPPER_CLASS radio_driver(radio, board); + +ESP32RTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); +SensorManager sensors; + +#ifndef LORA_CR + #define LORA_CR 5 +#endif + +bool radio_init() { + fallback_clock.begin(); + rtc_clock.begin(Wire); + +#ifdef SX126X_DIO3_TCXO_VOLTAGE + float tcxo = SX126X_DIO3_TCXO_VOLTAGE; +#else + float tcxo = 1.6f; +#endif + +#if defined(P_LORA_SCLK) + spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); +#endif + int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); + if (status != RADIOLIB_ERR_NONE) { + Serial.print("ERROR: radio init failed: "); + Serial.println(status); + return false; // fail + } + + radio.setCRC(1); + +#ifdef SX126X_CURRENT_LIMIT + radio.setCurrentLimit(SX126X_CURRENT_LIMIT); +#endif +#ifdef SX126X_DIO2_AS_RF_SWITCH + radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); +#endif +#ifdef SX126X_RX_BOOSTED_GAIN + radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); +#endif + + return true; // success +} + +uint32_t radio_get_rng_seed() { + return radio.random(0x7FFFFFFF); +} + +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { + radio.setFrequency(freq); + radio.setSpreadingFactor(sf); + radio.setBandwidth(bw); + radio.setCodingRate(cr); +} + +void radio_set_tx_power(uint8_t dbm) { + radio.setOutputPower(dbm); +} + +mesh::LocalIdentity radio_new_identity() { + RadioNoiseListener rng(radio); + return mesh::LocalIdentity(&rng); // create new random identity +} diff --git a/variants/heltec_ct62/target.h b/variants/heltec_ct62/target.h new file mode 100644 index 00000000..eef923ab --- /dev/null +++ b/variants/heltec_ct62/target.h @@ -0,0 +1,20 @@ +#pragma once + +#define RADIOLIB_STATIC_ONLY 1 +#include +#include +#include +#include +#include +#include + +extern ESP32Board board; +extern WRAPPER_CLASS radio_driver; +extern AutoDiscoverRTCClock rtc_clock; +extern SensorManager sensors; + +bool radio_init(); +uint32_t radio_get_rng_seed(); +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); +void radio_set_tx_power(uint8_t dbm); +mesh::LocalIdentity radio_new_identity(); From fd4885e9aa71d85540a2a14f16ceab318664b10f Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Sun, 8 Jun 2025 20:11:35 +1000 Subject: [PATCH 61/87] * HT-CT62 SPI fixes --- variants/heltec_ct62/target.cpp | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/variants/heltec_ct62/target.cpp b/variants/heltec_ct62/target.cpp index 4073518f..df43bc45 100644 --- a/variants/heltec_ct62/target.cpp +++ b/variants/heltec_ct62/target.cpp @@ -4,8 +4,7 @@ ESP32Board board; #if defined(P_LORA_SCLK) - static SPIClass spi; - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, spi); + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); #else RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); #endif @@ -31,7 +30,7 @@ bool radio_init() { #endif #if defined(P_LORA_SCLK) - spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); + SPI.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); #endif int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); if (status != RADIOLIB_ERR_NONE) { From e44f1eebb19de87b50950e668037a771697c1c11 Mon Sep 17 00:00:00 2001 From: recrof Date: Sun, 8 Jun 2025 17:02:34 +0200 Subject: [PATCH 62/87] fix duplicate flag --- platformio.ini | 1 - 1 file changed, 1 deletion(-) diff --git a/platformio.ini b/platformio.ini index 58c35d15..07f73a76 100644 --- a/platformio.ini +++ b/platformio.ini @@ -60,7 +60,6 @@ platform = https://github.com/pioarduino/platform-espressif32/releases/download/ extends = arduino_base platform = nordicnrf52 build_flags = ${arduino_base.build_flags} - -D LFS_NO_ASSERT=1 -D NRF52_PLATFORM -D LFS_NO_ASSERT=1 From 7c011324f245c87563deed8f7e14977d73908a71 Mon Sep 17 00:00:00 2001 From: JQ Date: Sun, 8 Jun 2025 08:25:54 -0700 Subject: [PATCH 63/87] feedback --- examples/companion_radio/UITask.cpp | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/examples/companion_radio/UITask.cpp b/examples/companion_radio/UITask.cpp index 3801236b..01906f90 100644 --- a/examples/companion_radio/UITask.cpp +++ b/examples/companion_radio/UITask.cpp @@ -374,11 +374,10 @@ void UITask::handleButtonTriplePress() { if (buzzer.isQuiet()) { buzzer.quiet(false); soundBuzzer(UIEventType::ack); - sprintf(_alert, "Quiet mode: OFF"); + sprintf(_alert, "Buzzer: ON"); } else { - soundBuzzer(UIEventType::ack); buzzer.quiet(true); - sprintf(_alert, "Quiet mode: ON"); + sprintf(_alert, "Buzzer: OFF"); } _need_refresh = true; #endif From f208f043240f1b295774a5bbdcde2b91ba925dba Mon Sep 17 00:00:00 2001 From: Florent Date: Sun, 8 Jun 2025 18:46:11 +0200 Subject: [PATCH 64/87] ct62: adding companion radios --- variants/heltec_ct62/platformio.ini | 39 +++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/variants/heltec_ct62/platformio.ini b/variants/heltec_ct62/platformio.ini index 6a0ba376..bf7116a2 100644 --- a/variants/heltec_ct62/platformio.ini +++ b/variants/heltec_ct62/platformio.ini @@ -33,6 +33,8 @@ build_src_filter = ${esp32_base.build_src_filter} extends = Heltec_ct62 build_flags = ${Heltec_ct62.build_flags} + ;-D ARDUINO_USB_MODE=1 + ;-D ARDUINO_USB_CDC_ON_BOOT=1 -D ADVERT_NAME='"HT-CT62 Repeater"' -D ADVERT_LAT=0.0 -D ADVERT_LON=0.0 @@ -45,3 +47,40 @@ build_src_filter = ${Heltec_ct62.build_src_filter} lib_deps = ${Heltec_ct62.lib_deps} ${esp32_ota.lib_deps} + +[env:Heltec_ct62_companion_radio_usb] +extends = Heltec_ct62 +build_flags = + ${Heltec_ct62.build_flags} +; -D ARDUINO_USB_MODE=1 +; -D ARDUINO_USB_CDC_ON_BOOT=1 + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D OFFLINE_QUEUE_SIZE=256 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${Heltec_ct62.build_src_filter} + +<../examples/companion_radio> +lib_deps = + ${Heltec_ct62.lib_deps} + ${esp32_ota.lib_deps} + densaugeo/base64 @ ~1.4.0 + +[env:Heltec_ct62_companion_radio_ble] +extends = Heltec_ct62 +build_flags = + ${Heltec_ct62.build_flags} +; -D ARDUINO_USB_MODE=1 +; -D ARDUINO_USB_CDC_ON_BOOT=1 + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D OFFLINE_QUEUE_SIZE=256 + -D BLE_PIN_CODE=123456 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${Heltec_ct62.build_src_filter} + +<../examples/companion_radio> +lib_deps = + ${Heltec_ct62.lib_deps} + ${esp32_ota.lib_deps} + densaugeo/base64 @ ~1.4.0 From 516f6a36c42e18af1332130f47c23a3b6e507ce6 Mon Sep 17 00:00:00 2001 From: Rastislav Vysoky Date: Sun, 8 Jun 2025 21:01:04 +0200 Subject: [PATCH 65/87] Add companion roles to Station G2 --- variants/station_g2/platformio.ini | 36 ++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/variants/station_g2/platformio.ini b/variants/station_g2/platformio.ini index 03914dce..8ba368bd 100644 --- a/variants/station_g2/platformio.ini +++ b/variants/station_g2/platformio.ini @@ -60,3 +60,39 @@ build_flags = lib_deps = ${Station_G2.lib_deps} ${esp32_ota.lib_deps} + +[env:Station_G2_companion_radio_usb] +extends = Station_G2 +build_flags = + ${Station_G2.build_flags} + -D DISPLAY_CLASS=SH1106Display + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 +; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 +; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 +build_src_filter = ${Station_G2.build_src_filter} + + + +<../examples/companion_radio> +lib_deps = + ${Station_G2.lib_deps} + densaugeo/base64 @ ~1.4.0 + +[env:Station_G2_companion_radio_ble] +extends = Station_G2 +build_flags = + ${Station_G2.build_flags} + -D DISPLAY_CLASS=SH1106Display + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D BLE_PIN_CODE=123456 + -D BLE_DEBUG_LOGGING=1 + -D OFFLINE_QUEUE_SIZE=256 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${Station_G2.build_src_filter} + + + + + +<../examples/companion_radio> +lib_deps = + ${Station_G2.lib_deps} + densaugeo/base64 @ ~1.4.0 From c6f6e088fce2094dbe76bd438dca8bb4ab80fb56 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 9 Jun 2025 17:34:04 +1000 Subject: [PATCH 66/87] * some HT-CT62 fixes --- variants/heltec_ct62/HT-CT62Board.h | 33 +++++++++++++++++++++++++++++ variants/heltec_ct62/platformio.ini | 6 ++++-- variants/heltec_ct62/target.cpp | 11 +++------- variants/heltec_ct62/target.h | 6 +++--- 4 files changed, 43 insertions(+), 13 deletions(-) create mode 100644 variants/heltec_ct62/HT-CT62Board.h diff --git a/variants/heltec_ct62/HT-CT62Board.h b/variants/heltec_ct62/HT-CT62Board.h new file mode 100644 index 00000000..e5a627b8 --- /dev/null +++ b/variants/heltec_ct62/HT-CT62Board.h @@ -0,0 +1,33 @@ +#pragma once + +#include +#include + +#if defined(ESP_PLATFORM) + +#include + +class Heltec_CT62_Board : public ESP32Board { +public: + +uint16_t getBattMilliVolts() override { + #ifdef PIN_VBAT_READ + analogReadResolution(12); // ESP32-C3 ADC is 12-bit - 3.3/4096 (ref voltage/max counts) + uint32_t raw = 0; + for (int i = 0; i < 8; i++) { + raw += analogRead(PIN_VBAT_READ); + } + raw = raw / 8; + + return ((6.52 * raw) / 1024.0) * 1000; + #else + return 0; // not supported + #endif + } + + const char* getManufacturerName() const override { + return "Heltec CT62"; + } +}; + +#endif diff --git a/variants/heltec_ct62/platformio.ini b/variants/heltec_ct62/platformio.ini index bf7116a2..ba23a5a6 100644 --- a/variants/heltec_ct62/platformio.ini +++ b/variants/heltec_ct62/platformio.ini @@ -12,12 +12,13 @@ build_flags = -D P_LORA_TX_LED=18 -D PIN_BOARD_SDA=0 -D PIN_BOARD_SCL=1 - -D PIN_USER_BTN=9 + ;-D PIN_USER_BTN=9 -D PIN_VBAT_READ=2 -D P_LORA_DIO_1=3 -D P_LORA_NSS=8 -D P_LORA_RESET=5 - -D P_LORA_RESET=RADIOLIB_NC + -D P_LORA_DIO_0=RADIOLIB_NC + -D P_LORA_DIO_2=RADIOLIB_NC -D P_LORA_BUSY=4 -D P_LORA_SCLK=10 -D P_LORA_MISO=6 @@ -80,6 +81,7 @@ build_flags = ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_ct62.build_src_filter} +<../examples/companion_radio> + + lib_deps = ${Heltec_ct62.lib_deps} ${esp32_ota.lib_deps} diff --git a/variants/heltec_ct62/target.cpp b/variants/heltec_ct62/target.cpp index df43bc45..eae43bd1 100644 --- a/variants/heltec_ct62/target.cpp +++ b/variants/heltec_ct62/target.cpp @@ -1,14 +1,9 @@ #include #include "target.h" -ESP32Board board; - -#if defined(P_LORA_SCLK) - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); -#else - RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); -#endif +Heltec_CT62_Board board; +RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY); WRAPPER_CLASS radio_driver(radio, board); ESP32RTCClock fallback_clock; @@ -72,4 +67,4 @@ void radio_set_tx_power(uint8_t dbm) { mesh::LocalIdentity radio_new_identity() { RadioNoiseListener rng(radio); return mesh::LocalIdentity(&rng); // create new random identity -} +} \ No newline at end of file diff --git a/variants/heltec_ct62/target.h b/variants/heltec_ct62/target.h index eef923ab..ff114e6e 100644 --- a/variants/heltec_ct62/target.h +++ b/variants/heltec_ct62/target.h @@ -3,12 +3,12 @@ #define RADIOLIB_STATIC_ONLY 1 #include #include -#include +#include "HT-CT62Board.h" #include #include #include -extern ESP32Board board; +extern Heltec_CT62_Board board; extern WRAPPER_CLASS radio_driver; extern AutoDiscoverRTCClock rtc_clock; extern SensorManager sensors; @@ -17,4 +17,4 @@ bool radio_init(); uint32_t radio_get_rng_seed(); void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); void radio_set_tx_power(uint8_t dbm); -mesh::LocalIdentity radio_new_identity(); +mesh::LocalIdentity radio_new_identity(); \ No newline at end of file From e1ceaab7eda6fa5bb94e00967b31f02eaabe908e Mon Sep 17 00:00:00 2001 From: JQ Date: Mon, 9 Jun 2025 17:35:00 -0700 Subject: [PATCH 67/87] add TX led to thinknode M1 --- src/helpers/nrf52/ThinkNodeM1Board.cpp | 5 +++++ src/helpers/nrf52/ThinkNodeM1Board.h | 9 +++++++++ variants/thinknode_m1/platformio.ini | 1 + 3 files changed, 15 insertions(+) diff --git a/src/helpers/nrf52/ThinkNodeM1Board.cpp b/src/helpers/nrf52/ThinkNodeM1Board.cpp index ef1cf111..63768eea 100644 --- a/src/helpers/nrf52/ThinkNodeM1Board.cpp +++ b/src/helpers/nrf52/ThinkNodeM1Board.cpp @@ -26,6 +26,11 @@ void ThinkNodeM1Board::begin() { Wire.begin(); + #ifdef P_LORA_TX_LED + pinMode(P_LORA_TX_LED, OUTPUT); + digitalWrite(P_LORA_TX_LED, LOW); + #endif + pinMode(SX126X_POWER_EN, OUTPUT); digitalWrite(SX126X_POWER_EN, HIGH); delay(10); // give sx1262 some time to power up diff --git a/src/helpers/nrf52/ThinkNodeM1Board.h b/src/helpers/nrf52/ThinkNodeM1Board.h index cc87c96d..97334bd3 100644 --- a/src/helpers/nrf52/ThinkNodeM1Board.h +++ b/src/helpers/nrf52/ThinkNodeM1Board.h @@ -39,6 +39,15 @@ public: return startup_reason; } + #if defined(P_LORA_TX_LED) + void onBeforeTransmit() override { + digitalWrite(P_LORA_TX_LED, HIGH); // turn TX LED on + } + void onAfterTransmit() override { + digitalWrite(P_LORA_TX_LED, LOW); // turn TX LED off + } + #endif + const char* getManufacturerName() const override { return "Elecrow ThinkNode-M1"; } diff --git a/variants/thinknode_m1/platformio.ini b/variants/thinknode_m1/platformio.ini index 1a4837d8..2104a080 100644 --- a/variants/thinknode_m1/platformio.ini +++ b/variants/thinknode_m1/platformio.ini @@ -19,6 +19,7 @@ build_flags = ${nrf52840_thinknode_m1.build_flags} -D RADIO_CLASS=CustomSX1262 -D WRAPPER_CLASS=CustomSX1262Wrapper -D LORA_TX_POWER=22 + -D P_LORA_TX_LED=13 -D SX126X_CURRENT_LIMIT=140 -D SX126X_RX_BOOSTED_GAIN=1 build_src_filter = ${nrf52840_thinknode_m1.build_src_filter} From deaa0ec2c86f2bd6c81fdabe705b1019d3fbd143 Mon Sep 17 00:00:00 2001 From: "Bence T." <3326575+tbb98@users.noreply.github.com> Date: Sat, 8 Mar 2025 00:04:43 +0100 Subject: [PATCH 68/87] Create packet_structure.md As mentioned by @mofosyne at issue #72 --- docs/packet_structure.md | 50 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/packet_structure.md diff --git a/docs/packet_structure.md b/docs/packet_structure.md new file mode 100644 index 00000000..a38c43ce --- /dev/null +++ b/docs/packet_structure.md @@ -0,0 +1,50 @@ +# Packet Structure + +| Field | Size (bytes) | Description | +|--------------|------------------------|-------------| +| `header` | 1 | Contains routing type, payload type, and payload version. | +| `payload_len` | 2 | Length of the payload in bytes. | +| `path_len` | 2 | Length of the path field in bytes. | +| `path` | `MAX_PATH_SIZE` | Stores the routing path if applicable. | +| `payload` | `MAX_PACKET_PAYLOAD` | The actual data being transmitted. | + +## Header Breakdown + +| Bits | Mask | Field | Description | +|-------|---------------|----------------|-------------| +| 0-1 | `0x03` | Route Type | Specifies the routing type (Flood, Direct, Reserved). | +| 2-5 | `0x0F` | Payload Type | Specifies the type of payload (Request, Response, Text, ACK, etc.). | +| 6-7 | `0x03` | Payload Version | Versioning of the payload format. | + +## Route Type Values + +| Value | Name | Description | +|--------|-------------------------|-------------| +| `0x00` | `ROUTE_TYPE_RESERVED1` | Reserved for future use. | +| `0x01` | `ROUTE_TYPE_FLOOD` | Flood routing mode (builds up path). | +| `0x02` | `ROUTE_TYPE_DIRECT` | Direct route (path is supplied). | +| `0x03` | `ROUTE_TYPE_RESERVED2` | Reserved for future use. | + +## Payload Type Values + +| Value | Name | Description | +|--------|-------------------------|-------------| +| `0x00` | `PAYLOAD_TYPE_REQ` | Request (destination/source hashes + MAC). | +| `0x01` | `PAYLOAD_TYPE_RESPONSE` | Response to REQ or ANON_REQ. | +| `0x02` | `PAYLOAD_TYPE_TXT_MSG` | Plain text message. | +| `0x03` | `PAYLOAD_TYPE_ACK` | Acknowledgment. | +| `0x04` | `PAYLOAD_TYPE_ADVERT` | Node advertisement. | +| `0x05` | `PAYLOAD_TYPE_GRP_TXT` | Group text message (unverified). | +| `0x06` | `PAYLOAD_TYPE_GRP_DATA` | Group datagram (unverified). | +| `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. | +| `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. | +| `0x0F` | `PAYLOAD_TYPE_RAW_CUSTOM` | Custom packet (raw bytes, custom encryption). | + +## Payload Version Values + +| Value | Name | Description | +|--------|---------------|-------------| +| `0x00` | `PAYLOAD_VER_1` | 1-byte src/dest hashes, 2-byte MAC. | +| `0x01` | `PAYLOAD_VER_2` | Future version (e.g., 2-byte hashes, 4-byte MAC). | +| `0x02` | `PAYLOAD_VER_3` | Future version. | +| `0x03` | `PAYLOAD_VER_4` | Future version. | From a2a9455dc0669f16d0230cb65e80c906ab37555a Mon Sep 17 00:00:00 2001 From: Matthew Sainsbury Date: Thu, 5 Jun 2025 20:16:18 -0700 Subject: [PATCH 69/87] corrections and style --- docs/packet_structure.md | 69 ++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 34 deletions(-) diff --git a/docs/packet_structure.md b/docs/packet_structure.md index a38c43ce..b02c3c33 100644 --- a/docs/packet_structure.md +++ b/docs/packet_structure.md @@ -1,50 +1,51 @@ # Packet Structure -| Field | Size (bytes) | Description | -|--------------|------------------------|-------------| -| `header` | 1 | Contains routing type, payload type, and payload version. | -| `payload_len` | 2 | Length of the payload in bytes. | -| `path_len` | 2 | Length of the path field in bytes. | -| `path` | `MAX_PATH_SIZE` | Stores the routing path if applicable. | -| `payload` | `MAX_PACKET_PAYLOAD` | The actual data being transmitted. | +| Field | Size (bytes) | Description | +|----------|----------------------------------|-----------------------------------------------------------| +| header | 1 | Contains routing type, payload type, and payload version. | +| path_len | 1 | Length of the path field in bytes. | +| path | up to 64 (`MAX_PATH_SIZE`) | Stores the routing path if applicable. | +| payload | up to 184 (`MAX_PACKET_PAYLOAD`) | The actual data being transmitted. | + +Note: see the [payloads doc](./payloads.md) for more information about the content of payload. ## Header Breakdown -| Bits | Mask | Field | Description | -|-------|---------------|----------------|-------------| -| 0-1 | `0x03` | Route Type | Specifies the routing type (Flood, Direct, Reserved). | -| 2-5 | `0x0F` | Payload Type | Specifies the type of payload (Request, Response, Text, ACK, etc.). | -| 6-7 | `0x03` | Payload Version | Versioning of the payload format. | +| Bits | Mask | Field | Description | +|-------|--------|-----------------|-----------------------------------------------| +| 0-1 | `0x03` | Route Type | Flood, Direct, Reserved - see below. | +| 2-5 | `0x0F` | Payload Type | Request, Response, ACK, etc. - see below. | +| 6-7 | `0x03` | Payload Version | Versioning of the payload format - see below. | ## Route Type Values -| Value | Name | Description | -|--------|-------------------------|-------------| -| `0x00` | `ROUTE_TYPE_RESERVED1` | Reserved for future use. | +| Value | Name | Description | +|--------|------------------------|--------------------------------------| +| `0x00` | `ROUTE_TYPE_RESERVED1` | Reserved for future use. | | `0x01` | `ROUTE_TYPE_FLOOD` | Flood routing mode (builds up path). | -| `0x02` | `ROUTE_TYPE_DIRECT` | Direct route (path is supplied). | -| `0x03` | `ROUTE_TYPE_RESERVED2` | Reserved for future use. | +| `0x02` | `ROUTE_TYPE_DIRECT` | Direct route (path is supplied). | +| `0x03` | `ROUTE_TYPE_RESERVED2` | Reserved for future use. | ## Payload Type Values -| Value | Name | Description | -|--------|-------------------------|-------------| -| `0x00` | `PAYLOAD_TYPE_REQ` | Request (destination/source hashes + MAC). | -| `0x01` | `PAYLOAD_TYPE_RESPONSE` | Response to REQ or ANON_REQ. | -| `0x02` | `PAYLOAD_TYPE_TXT_MSG` | Plain text message. | -| `0x03` | `PAYLOAD_TYPE_ACK` | Acknowledgment. | -| `0x04` | `PAYLOAD_TYPE_ADVERT` | Node advertisement. | -| `0x05` | `PAYLOAD_TYPE_GRP_TXT` | Group text message (unverified). | -| `0x06` | `PAYLOAD_TYPE_GRP_DATA` | Group datagram (unverified). | -| `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. | -| `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. | +| Value | Name | Description | +|--------|---------------------------|-----------------------------------------------| +| `0x00` | `PAYLOAD_TYPE_REQ` | Request (destination/source hashes + MAC). | +| `0x01` | `PAYLOAD_TYPE_RESPONSE` | Response to REQ or ANON_REQ. | +| `0x02` | `PAYLOAD_TYPE_TXT_MSG` | Plain text message. | +| `0x03` | `PAYLOAD_TYPE_ACK` | Acknowledgment. | +| `0x04` | `PAYLOAD_TYPE_ADVERT` | Node advertisement. | +| `0x05` | `PAYLOAD_TYPE_GRP_TXT` | Group text message (unverified). | +| `0x06` | `PAYLOAD_TYPE_GRP_DATA` | Group datagram (unverified). | +| `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. | +| `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. | | `0x0F` | `PAYLOAD_TYPE_RAW_CUSTOM` | Custom packet (raw bytes, custom encryption). | ## Payload Version Values -| Value | Name | Description | -|--------|---------------|-------------| -| `0x00` | `PAYLOAD_VER_1` | 1-byte src/dest hashes, 2-byte MAC. | -| `0x01` | `PAYLOAD_VER_2` | Future version (e.g., 2-byte hashes, 4-byte MAC). | -| `0x02` | `PAYLOAD_VER_3` | Future version. | -| `0x03` | `PAYLOAD_VER_4` | Future version. | +| Value | Version | Description | +|--------|---------|---------------------------------------------------| +| `0x00` | 1 | 1-byte src/dest hashes, 2-byte MAC. | +| `0x01` | 2 | Future version (e.g., 2-byte hashes, 4-byte MAC). | +| `0x02` | 3 | Future version. | +| `0x03` | 4 | Future version. | From fca86d93f3319d19683b0e86dfceaf4bf2d0b0d0 Mon Sep 17 00:00:00 2001 From: Alex Wolden Date: Tue, 10 Jun 2025 22:07:47 -0700 Subject: [PATCH 70/87] Added support for t3s3 sx1276 --- docs/packet_structure.md | 51 --------- variants/lilygo_t3s3_sx1276/platformio.ini | 119 +++++++++++++++++++++ variants/lilygo_t3s3_sx1276/target.cpp | 70 ++++++++++++ variants/lilygo_t3s3_sx1276/target.h | 27 +++++ 4 files changed, 216 insertions(+), 51 deletions(-) delete mode 100644 docs/packet_structure.md create mode 100644 variants/lilygo_t3s3_sx1276/platformio.ini create mode 100644 variants/lilygo_t3s3_sx1276/target.cpp create mode 100644 variants/lilygo_t3s3_sx1276/target.h diff --git a/docs/packet_structure.md b/docs/packet_structure.md deleted file mode 100644 index b02c3c33..00000000 --- a/docs/packet_structure.md +++ /dev/null @@ -1,51 +0,0 @@ -# Packet Structure - -| Field | Size (bytes) | Description | -|----------|----------------------------------|-----------------------------------------------------------| -| header | 1 | Contains routing type, payload type, and payload version. | -| path_len | 1 | Length of the path field in bytes. | -| path | up to 64 (`MAX_PATH_SIZE`) | Stores the routing path if applicable. | -| payload | up to 184 (`MAX_PACKET_PAYLOAD`) | The actual data being transmitted. | - -Note: see the [payloads doc](./payloads.md) for more information about the content of payload. - -## Header Breakdown - -| Bits | Mask | Field | Description | -|-------|--------|-----------------|-----------------------------------------------| -| 0-1 | `0x03` | Route Type | Flood, Direct, Reserved - see below. | -| 2-5 | `0x0F` | Payload Type | Request, Response, ACK, etc. - see below. | -| 6-7 | `0x03` | Payload Version | Versioning of the payload format - see below. | - -## Route Type Values - -| Value | Name | Description | -|--------|------------------------|--------------------------------------| -| `0x00` | `ROUTE_TYPE_RESERVED1` | Reserved for future use. | -| `0x01` | `ROUTE_TYPE_FLOOD` | Flood routing mode (builds up path). | -| `0x02` | `ROUTE_TYPE_DIRECT` | Direct route (path is supplied). | -| `0x03` | `ROUTE_TYPE_RESERVED2` | Reserved for future use. | - -## Payload Type Values - -| Value | Name | Description | -|--------|---------------------------|-----------------------------------------------| -| `0x00` | `PAYLOAD_TYPE_REQ` | Request (destination/source hashes + MAC). | -| `0x01` | `PAYLOAD_TYPE_RESPONSE` | Response to REQ or ANON_REQ. | -| `0x02` | `PAYLOAD_TYPE_TXT_MSG` | Plain text message. | -| `0x03` | `PAYLOAD_TYPE_ACK` | Acknowledgment. | -| `0x04` | `PAYLOAD_TYPE_ADVERT` | Node advertisement. | -| `0x05` | `PAYLOAD_TYPE_GRP_TXT` | Group text message (unverified). | -| `0x06` | `PAYLOAD_TYPE_GRP_DATA` | Group datagram (unverified). | -| `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. | -| `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. | -| `0x0F` | `PAYLOAD_TYPE_RAW_CUSTOM` | Custom packet (raw bytes, custom encryption). | - -## Payload Version Values - -| Value | Version | Description | -|--------|---------|---------------------------------------------------| -| `0x00` | 1 | 1-byte src/dest hashes, 2-byte MAC. | -| `0x01` | 2 | Future version (e.g., 2-byte hashes, 4-byte MAC). | -| `0x02` | 3 | Future version. | -| `0x03` | 4 | Future version. | diff --git a/variants/lilygo_t3s3_sx1276/platformio.ini b/variants/lilygo_t3s3_sx1276/platformio.ini new file mode 100644 index 00000000..1bcbbbf9 --- /dev/null +++ b/variants/lilygo_t3s3_sx1276/platformio.ini @@ -0,0 +1,119 @@ +[LilyGo_T3S3_sx1276] +extends = esp32_base +board = t3_s3_v1_x +build_flags = + ${esp32_base.build_flags} + -I variants/lilygo_t3s3_sx1276 + -D LILYGO_T3S3 + -D P_LORA_DIO_0=9 + -D P_LORA_DIO_1=33 + -D P_LORA_NSS=7 + -D P_LORA_RESET=8 + -D P_LORA_SCLK=5 + -D P_LORA_MISO=3 + -D P_LORA_MOSI=6 + -D P_LORA_TX_LED=37 + -D PIN_VBAT_READ=1 + -D PIN_USER_BTN=0 + -D PIN_BOARD_SDA=18 + -D PIN_BOARD_SCL=17 + -D PIN_OLED_RESET=21 + -D RADIO_CLASS=CustomSX1276 + -D WRAPPER_CLASS=CustomSX1276Wrapper + -D SX127X_CURRENT_LIMIT=120 + -D LORA_TX_POWER=20 +build_src_filter = ${esp32_base.build_src_filter} + +<../variants/lilygo_t3s3_sx1276> +lib_deps = + ${esp32_base.lib_deps} + adafruit/Adafruit SSD1306 @ ^2.5.13 + +; === LilyGo T3S3 with SX1276 environments === +[env:LilyGo_T3S3_sx1276_Repeater] +extends = LilyGo_T3S3_sx1276 +build_flags = + ${LilyGo_T3S3_sx1276.build_flags} + -D DISPLAY_CLASS=SSD1306Display + -D ADVERT_NAME='"T3S3-1276 Repeater"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D MAX_NEIGHBOURS=8 + ; -D MESH_PACKET_LOGGING=1 + ; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_T3S3_sx1276.build_src_filter} + + + +<../examples/simple_repeater> +lib_deps = + ${LilyGo_T3S3_sx1276.lib_deps} + ${esp32_ota.lib_deps} + +[env:LilyGo_T3S3_sx1276_terminal_chat] +extends = LilyGo_T3S3_sx1276 +build_flags = + ${LilyGo_T3S3_sx1276.build_flags} + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=1 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_T3S3_sx1276.build_src_filter} + +<../examples/simple_secure_chat/main.cpp> +lib_deps = + ${LilyGo_T3S3_sx1276.lib_deps} + densaugeo/base64 @ ~1.4.0 + +[env:LilyGo_T3S3_sx1276_room_server] +extends = LilyGo_T3S3_sx1276 +build_flags = + ${LilyGo_T3S3_sx1276.build_flags} + -D DISPLAY_CLASS=SSD1306Display + -D ADVERT_NAME='"T3S3-1276 Room"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D ROOM_PASSWORD='"hello"' +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_T3S3_sx1276.build_src_filter} + + + +<../examples/simple_room_server> +lib_deps = + ${LilyGo_T3S3_sx1276.lib_deps} + ${esp32_ota.lib_deps} + +[env:LilyGo_T3S3_sx1276_companion_radio_usb] +extends = LilyGo_T3S3_sx1276 +upload_speed = 115200 +build_flags = + ${LilyGo_T3S3_sx1276.build_flags} + -D DISPLAY_CLASS=SSD1306Display + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D MESH_PACKET_LOGGING=1 + -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_T3S3_sx1276.build_src_filter} + + + +<../examples/companion_radio> +lib_deps = + ${LilyGo_T3S3_sx1276.lib_deps} + densaugeo/base64 @ ~1.4.0 + +[env:LilyGo_T3S3_sx1276_companion_radio_ble] +extends = LilyGo_T3S3_sx1276 +build_flags = + ${LilyGo_T3S3_sx1276.build_flags} + -D DISPLAY_CLASS=SSD1306Display + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 + -D BLE_PIN_CODE=123456 + -D BLE_DEBUG_LOGGING=1 + -D OFFLINE_QUEUE_SIZE=256 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${LilyGo_T3S3_sx1276.build_src_filter} + + + + + +<../examples/companion_radio> +lib_deps = + ${LilyGo_T3S3_sx1276.lib_deps} + densaugeo/base64 @ ~1.4.0 \ No newline at end of file diff --git a/variants/lilygo_t3s3_sx1276/target.cpp b/variants/lilygo_t3s3_sx1276/target.cpp new file mode 100644 index 00000000..db11433a --- /dev/null +++ b/variants/lilygo_t3s3_sx1276/target.cpp @@ -0,0 +1,70 @@ +#include +#include "target.h" + +ESP32Board board; + +#if defined(P_LORA_SCLK) + static SPIClass spi; + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_0, P_LORA_RESET, P_LORA_DIO_1, spi); +#else + RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_0, P_LORA_RESET, P_LORA_DIO_1); +#endif + +WRAPPER_CLASS radio_driver(radio, board); + +ESP32RTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); +SensorManager sensors; + +#ifdef DISPLAY_CLASS + DISPLAY_CLASS display; +#endif + +#ifndef LORA_CR + #define LORA_CR 5 +#endif + +bool radio_init() { + fallback_clock.begin(); + rtc_clock.begin(Wire); + +#if defined(P_LORA_SCLK) + spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); +#endif + int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8); + if (status != RADIOLIB_ERR_NONE) { + Serial.print("ERROR: radio init failed: "); + Serial.println(status); + return false; // fail + } + +#ifdef SX127X_CURRENT_LIMIT + radio.setCurrentLimit(SX127X_CURRENT_LIMIT); +#endif + + radio.setCRC(1); + + radio.setRfSwitchPins(21, 10); + + return true; // success +} + +uint32_t radio_get_rng_seed() { + return radio.random(0x7FFFFFFF); +} + +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { + radio.setFrequency(freq); + radio.setSpreadingFactor(sf); + radio.setBandwidth(bw); + radio.setCodingRate(cr); +} + +void radio_set_tx_power(uint8_t dbm) { + radio.setOutputPower(dbm); +} + +mesh::LocalIdentity radio_new_identity() { + RadioNoiseListener rng(radio); + return mesh::LocalIdentity(&rng); // create new random identity +} \ No newline at end of file diff --git a/variants/lilygo_t3s3_sx1276/target.h b/variants/lilygo_t3s3_sx1276/target.h new file mode 100644 index 00000000..c5fc0be0 --- /dev/null +++ b/variants/lilygo_t3s3_sx1276/target.h @@ -0,0 +1,27 @@ +#pragma once + +#define RADIOLIB_STATIC_ONLY 1 +#include +#include +#include +#include +#include +#include +#ifdef DISPLAY_CLASS + #include +#endif + +extern ESP32Board board; +extern WRAPPER_CLASS radio_driver; +extern AutoDiscoverRTCClock rtc_clock; +extern SensorManager sensors; + +#ifdef DISPLAY_CLASS + extern DISPLAY_CLASS display; +#endif + +bool radio_init(); +uint32_t radio_get_rng_seed(); +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); +void radio_set_tx_power(uint8_t dbm); +mesh::LocalIdentity radio_new_identity(); \ No newline at end of file From 32ca3dc9d04185053a230baa5f8913c33284c84a Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 13 Jun 2025 14:15:21 +1000 Subject: [PATCH 71/87] * repeater and room server: new CLI setting "agc.reset.interval" (seconds) --- examples/simple_repeater/main.cpp | 3 +++ examples/simple_room_server/main.cpp | 3 +++ src/Dispatcher.cpp | 8 ++++++++ src/Dispatcher.h | 7 +++++-- src/helpers/CommonCLI.cpp | 12 ++++++++++-- src/helpers/CommonCLI.h | 1 + src/helpers/RadioLibWrappers.cpp | 9 +++++++++ src/helpers/RadioLibWrappers.h | 1 + 8 files changed, 40 insertions(+), 4 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index effc177a..893306ed 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -337,6 +337,9 @@ protected: int getInterferenceThreshold() const override { return _prefs.interference_threshold; } + int getAGCResetInterval() const override { + return ((int)_prefs.agc_reset_interval) * 4000; // milliseconds + } void onAnonDataRecv(mesh::Packet* packet, uint8_t type, const mesh::Identity& sender, uint8_t* data, size_t len) override { if (type == PAYLOAD_TYPE_ANON_REQ) { // received an initial request by a possible admin client (unknown at this stage) diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 400b31dd..e7a91ea9 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -420,6 +420,9 @@ protected: int getInterferenceThreshold() const override { return _prefs.interference_threshold; } + int getAGCResetInterval() const override { + return ((int)_prefs.agc_reset_interval) * 4000; // milliseconds + } bool allowPacketForward(const mesh::Packet* packet) override { if (_prefs.disable_fwd) return false; diff --git a/src/Dispatcher.cpp b/src/Dispatcher.cpp index 7ac5cbe3..da34bd35 100644 --- a/src/Dispatcher.cpp +++ b/src/Dispatcher.cpp @@ -87,6 +87,14 @@ void Dispatcher::loop() { } else { return; // can't do any more radio activity until send is complete or timed out } + + // going back into receive mode now... + next_agc_reset_time = futureMillis(getAGCResetInterval()); + } + + if (millisHasNowPassed(next_agc_reset_time)) { + _radio->resetAGC(); + next_agc_reset_time = futureMillis(getAGCResetInterval()); } // check inbound (delayed) queue diff --git a/src/Dispatcher.h b/src/Dispatcher.h index bce13b6b..2200f81b 100644 --- a/src/Dispatcher.h +++ b/src/Dispatcher.h @@ -65,6 +65,8 @@ public: virtual void triggerNoiseFloorCalibrate(int threshold) { } + virtual void resetAGC() { } + virtual bool isInRecvMode() const = 0; /** @@ -116,7 +118,7 @@ class Dispatcher { unsigned long next_tx_time; unsigned long cad_busy_start; unsigned long radio_nonrx_start; - unsigned long next_floor_calib_time; + unsigned long next_floor_calib_time, next_agc_reset_time; bool prev_isrecv_mode; uint32_t n_sent_flood, n_sent_direct; uint32_t n_recv_flood, n_recv_direct; @@ -134,7 +136,7 @@ protected: { outbound = NULL; total_air_time = 0; next_tx_time = 0; cad_busy_start = 0; - next_floor_calib_time = 0; + next_floor_calib_time = next_agc_reset_time = 0; _err_flags = 0; radio_nonrx_start = 0; prev_isrecv_mode = true; @@ -154,6 +156,7 @@ protected: virtual uint32_t getCADFailRetryDelay() const; virtual uint32_t getCADFailMaxDuration() const; virtual int getInterferenceThreshold() const { return 0; } // disabled by default + virtual int getAGCResetInterval() const { return 0; } // disabled by default public: void begin(); diff --git a/src/helpers/CommonCLI.cpp b/src/helpers/CommonCLI.cpp index baad8f40..63e2740c 100644 --- a/src/helpers/CommonCLI.cpp +++ b/src/helpers/CommonCLI.cpp @@ -53,7 +53,8 @@ void CommonCLI::loadPrefsInt(FILESYSTEM* fs, const char* filename) { file.read((uint8_t *) &_prefs->allow_read_only, sizeof(_prefs->allow_read_only)); // 114 file.read((uint8_t *) &_prefs->reserved2, sizeof(_prefs->reserved2)); // 115 file.read((uint8_t *) &_prefs->bw, sizeof(_prefs->bw)); // 116 - file.read(pad, 4); // 120 + file.read((uint8_t *) &_prefs->agc_reset_interval, sizeof(_prefs->agc_reset_interval)); // 120 + file.read(pad, 3); // 121 file.read((uint8_t *) &_prefs->flood_max, sizeof(_prefs->flood_max)); // 124 file.read((uint8_t *) &_prefs->flood_advert_interval, sizeof(_prefs->flood_advert_interval)); // 125 file.read((uint8_t *) &_prefs->interference_threshold, sizeof(_prefs->interference_threshold)); // 126 @@ -107,7 +108,8 @@ void CommonCLI::savePrefs(FILESYSTEM* fs) { file.write((uint8_t *) &_prefs->allow_read_only, sizeof(_prefs->allow_read_only)); // 114 file.write((uint8_t *) &_prefs->reserved2, sizeof(_prefs->reserved2)); // 115 file.write((uint8_t *) &_prefs->bw, sizeof(_prefs->bw)); // 116 - file.write(pad, 4); // 120 + file.write((uint8_t *) &_prefs->agc_reset_interval, sizeof(_prefs->agc_reset_interval)); // 120 + file.write(pad, 3); // 121 file.write((uint8_t *) &_prefs->flood_max, sizeof(_prefs->flood_max)); // 124 file.write((uint8_t *) &_prefs->flood_advert_interval, sizeof(_prefs->flood_advert_interval)); // 125 file.write((uint8_t *) &_prefs->interference_threshold, sizeof(_prefs->interference_threshold)); // 126 @@ -180,6 +182,8 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, const char* command, ch sprintf(reply, "> %s", StrHelper::ftoa(_prefs->airtime_factor)); } else if (memcmp(config, "int.thresh", 10) == 0) { sprintf(reply, "> %d", (uint32_t) _prefs->interference_threshold); + } else if (memcmp(config, "agc.reset.interval", 18) == 0) { + sprintf(reply, "> %d", ((uint32_t) _prefs->agc_reset_interval) * 4); } else if (memcmp(config, "allow.read.only", 15) == 0) { sprintf(reply, "> %s", _prefs->allow_read_only ? "on" : "off"); } else if (memcmp(config, "flood.advert.interval", 21) == 0) { @@ -231,6 +235,10 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, const char* command, ch _prefs->interference_threshold = atoi(&config[11]); savePrefs(); strcpy(reply, "OK"); + } else if (memcmp(config, "agc.reset.interval ", 19) == 0) { + _prefs->agc_reset_interval = atoi(&config[19]) / 4; + savePrefs(); + strcpy(reply, "OK"); } else if (memcmp(config, "allow.read.only ", 16) == 0) { _prefs->allow_read_only = memcmp(&config[16], "on", 2) == 0; savePrefs(); diff --git a/src/helpers/CommonCLI.h b/src/helpers/CommonCLI.h index 37402c09..1778c715 100644 --- a/src/helpers/CommonCLI.h +++ b/src/helpers/CommonCLI.h @@ -25,6 +25,7 @@ struct NodePrefs { // persisted to file float bw; uint8_t flood_max; uint8_t interference_threshold; + uint8_t agc_reset_interval; // secs / 4 }; class CommonCLICallbacks { diff --git a/src/helpers/RadioLibWrappers.cpp b/src/helpers/RadioLibWrappers.cpp index 1415a864..0593451a 100644 --- a/src/helpers/RadioLibWrappers.cpp +++ b/src/helpers/RadioLibWrappers.cpp @@ -52,6 +52,15 @@ void RadioLibWrapper::triggerNoiseFloorCalibrate(int threshold) { } } +void RadioLibWrapper::resetAGC() { + // make sure we're not mid-receive of packet! + if ((state & STATE_INT_READY) != 0 || isReceivingPacket()) return; + + // NOTE: according to higher powers, just issuing RadioLib's startReceive() will reset the AGC. + // revisit this if a better impl is discovered. + state = STATE_IDLE; // trigger a startReceive() +} + void RadioLibWrapper::loop() { if (state == STATE_RX && _num_floor_samples < NUM_NOISE_FLOOR_SAMPLES) { if (!isReceivingPacket()) { diff --git a/src/helpers/RadioLibWrappers.h b/src/helpers/RadioLibWrappers.h index bb308071..25cc5358 100644 --- a/src/helpers/RadioLibWrappers.h +++ b/src/helpers/RadioLibWrappers.h @@ -39,6 +39,7 @@ public: int getNoiseFloor() const override { return _noise_floor; } void triggerNoiseFloorCalibrate(int threshold) override; + void resetAGC() override; void loop() override; From 466bd6d59669fd85b2d26ca9bc8ce3d414944250 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 13 Jun 2025 14:25:09 +1000 Subject: [PATCH 72/87] * fix for when AGC reset is disabled (interval = 0) --- src/Dispatcher.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Dispatcher.cpp b/src/Dispatcher.cpp index da34bd35..7f39dc49 100644 --- a/src/Dispatcher.cpp +++ b/src/Dispatcher.cpp @@ -92,7 +92,7 @@ void Dispatcher::loop() { next_agc_reset_time = futureMillis(getAGCResetInterval()); } - if (millisHasNowPassed(next_agc_reset_time)) { + if (getAGCResetInterval() > 0 && millisHasNowPassed(next_agc_reset_time)) { _radio->resetAGC(); next_agc_reset_time = futureMillis(getAGCResetInterval()); } From 8a7ec9d7fe06358d2c1c0827fad60004d15d0fa5 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Fri, 13 Jun 2025 17:24:47 +1000 Subject: [PATCH 73/87] * interference threshold now disabled by default --- examples/simple_repeater/main.cpp | 2 +- examples/simple_room_server/main.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/simple_repeater/main.cpp b/examples/simple_repeater/main.cpp index 893306ed..c33cadda 100644 --- a/examples/simple_repeater/main.cpp +++ b/examples/simple_repeater/main.cpp @@ -578,7 +578,7 @@ public: _prefs.advert_interval = 1; // default to 2 minutes for NEW installs _prefs.flood_advert_interval = 3; // 3 hours _prefs.flood_max = 64; - _prefs.interference_threshold = 14; // DB + _prefs.interference_threshold = 0; // disabled } CommonCLI* getCLI() { return &_cli; } diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index e7a91ea9..740d70e5 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -728,7 +728,7 @@ public: _prefs.advert_interval = 1; // default to 2 minutes for NEW installs _prefs.flood_advert_interval = 3; // 3 hours _prefs.flood_max = 64; - _prefs.interference_threshold = 14; // DB + _prefs.interference_threshold = 0; // disabled #ifdef ROOM_PASSWORD StrHelper::strncpy(_prefs.guest_password, ROOM_PASSWORD, sizeof(_prefs.guest_password)); #endif From 8f6b2b75d7cfd1dace9eea34cac73ce33de14e4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Sun, 15 Jun 2025 23:48:49 +0100 Subject: [PATCH 74/87] Waveshare RP2040-LoRa board support --- platformio.ini | 2 + src/helpers/rp2040/WaveshareBoard.cpp | 29 +++++ src/helpers/rp2040/WaveshareBoard.h | 65 +++++++++++ variants/picow/platformio.ini | 2 +- variants/waveshare_rp2040_lora/platformio.ini | 107 ++++++++++++++++++ variants/waveshare_rp2040_lora/target.cpp | 81 +++++++++++++ variants/waveshare_rp2040_lora/target.h | 21 ++++ 7 files changed, 306 insertions(+), 1 deletion(-) create mode 100644 src/helpers/rp2040/WaveshareBoard.cpp create mode 100644 src/helpers/rp2040/WaveshareBoard.h create mode 100644 variants/waveshare_rp2040_lora/platformio.ini create mode 100644 variants/waveshare_rp2040_lora/target.cpp create mode 100644 variants/waveshare_rp2040_lora/target.h diff --git a/platformio.ini b/platformio.ini index 2c3ffd83..ad3ce4eb 100644 --- a/platformio.ini +++ b/platformio.ini @@ -70,6 +70,8 @@ lib_deps = [rp2040_base] extends = arduino_base +platform = https://github.com/maxgerhardt/platform-raspberrypi.git +board_build.core = earlephilhower build_flags = ${arduino_base.build_flags} -D RP2040_PLATFORM diff --git a/src/helpers/rp2040/WaveshareBoard.cpp b/src/helpers/rp2040/WaveshareBoard.cpp new file mode 100644 index 00000000..f4154dbe --- /dev/null +++ b/src/helpers/rp2040/WaveshareBoard.cpp @@ -0,0 +1,29 @@ +#include "WaveshareBoard.h" + +#include +#include + +void WaveshareBoard::begin() { + // for future use, sub-classes SHOULD call this from their begin() + startup_reason = BD_STARTUP_NORMAL; + +#ifdef PIN_LED_BUILTIN + pinMode(PIN_LED_BUILTIN, OUTPUT); +#endif + +#ifdef PIN_VBAT_READ + pinMode(PIN_VBAT_READ, INPUT); +#endif + +#if defined(PIN_BOARD_SDA) && defined(PIN_BOARD_SCL) + Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL); +#endif + + Wire.begin(); + + delay(10); // give sx1262 some time to power up +} + +bool WaveshareBoard::startOTAUpdate(const char *id, char reply[]) { + return false; +} diff --git a/src/helpers/rp2040/WaveshareBoard.h b/src/helpers/rp2040/WaveshareBoard.h new file mode 100644 index 00000000..0aa136ab --- /dev/null +++ b/src/helpers/rp2040/WaveshareBoard.h @@ -0,0 +1,65 @@ +#pragma once + +#include +#include + +// LoRa radio module pins for Waveshare RP2040-LoRa-HF/LF +// https://files.waveshare.com/wiki/RP2040-LoRa/Rp2040-lora-sch.pdf + +#define P_LORA_DIO_1 16 +#define P_LORA_NSS 13 // CS +#define P_LORA_RESET 23 +#define P_LORA_BUSY 18 +#define P_LORA_SCLK 14 +#define P_LORA_MISO 24 +#define P_LORA_MOSI 15 + +#define SX126X_DIO2_AS_RF_SWITCH true +#define SX126X_DIO3_TCXO_VOLTAGE 0 + +// built-ins +#define PIN_LED_BUILTIN 25 + +// This board has no built-in way to read battery voltage +// #define PIN_VBAT_READ 26 +// #define BATTERY_SAMPLES 8 +// #define ADC_MULTIPLIER (3.1 * 3.3 * 1000) // MT Uses 3.1 + +class WaveshareBoard : public mesh::MainBoard { +protected: + uint8_t startup_reason; + +public: + void begin(); + uint8_t getStartupReason() const override { return startup_reason; } + + void onBeforeTransmit() override { + digitalWrite(PIN_LED_BUILTIN, HIGH); // turn TX LED on + } + + void onAfterTransmit() override { + digitalWrite(PIN_LED_BUILTIN, LOW); // turn TX LED off + } + + uint16_t getBattMilliVolts() override { +#if defined(PIN_VBAT_READ) && defined(ADC_MULTIPLIER) + analogReadResolution(12); + + uint32_t raw = 0; + for (int i = 0; i < BATTERY_SAMPLES; i++) { + raw += analogRead(PIN_VBAT_READ); + } + raw = raw / BATTERY_SAMPLES; + + return (ADC_MULTIPLIER * raw) / 4096; +#else + return 0; +#endif + } + + const char *getManufacturerName() const override { return "Waveshare RP2040-LoRa"; } + + void reboot() override { rp2040.reboot(); } + + bool startOTAUpdate(const char *id, char reply[]) override; +}; diff --git a/variants/picow/platformio.ini b/variants/picow/platformio.ini index 0e925486..8b6c2506 100644 --- a/variants/picow/platformio.ini +++ b/variants/picow/platformio.ini @@ -14,7 +14,7 @@ build_flags = ${rp2040_base.build_flags} -D LORA_TX_POWER=22 -D SX126X_RX_BOOSTED_GAIN=1 build_src_filter = ${rp2040_base.build_src_filter} - + + + +<../variants/picow> lib_deps = ${rp2040_base.lib_deps} diff --git a/variants/waveshare_rp2040_lora/platformio.ini b/variants/waveshare_rp2040_lora/platformio.ini new file mode 100644 index 00000000..e84e57ad --- /dev/null +++ b/variants/waveshare_rp2040_lora/platformio.ini @@ -0,0 +1,107 @@ +; Waveshare RP2040-LoRa-HF/LF +; https://files.waveshare.com/wiki/RP2040-LoRa/Rp2040-lora-sch.pdf + +[waveshare_rp2040_lora] +extends = rp2040_base + +board = pico +board_build.filesystem_size = 0.5m + +build_flags = ${rp2040_base.build_flags} + -I variants/waveshare_rp2040_lora + -D SX126X_CURRENT_LIMIT=130 + -D RADIO_CLASS=CustomSX1262 + -D WRAPPER_CLASS=CustomSX1262Wrapper + -D LORA_TX_POWER=22 + -D SX126X_RX_BOOSTED_GAIN=1 +; Debug options + ; -D DEBUG_RP2040_WIRE=1 + ; -D DEBUG_RP2040_SPI=1 + ; -D DEBUG_RP2040_CORE=1 + ; -D RADIOLIB_DEBUG_SPI=1 + ; -D DEBUG_RP2040_PORT=Serial + +build_src_filter = ${rp2040_base.build_src_filter} + + + +<../variants/waveshare_rp2040_lora> + +lib_deps = ${rp2040_base.lib_deps} + +[env:waveshare_rp2040_lora_Repeater] +extends = waveshare_rp2040_lora +build_flags = ${waveshare_rp2040_lora.build_flags} + -D ADVERT_NAME='"Waveshare RP2040-LoRa Repeater"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D MAX_NEIGHBOURS=8 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${waveshare_rp2040_lora.build_src_filter} + +<../examples/simple_repeater> + +[env:waveshare_rp2040_lora_room_server] +extends = waveshare_rp2040_lora +build_flags = ${waveshare_rp2040_lora.build_flags} + -D ADVERT_NAME='"Test Room"' + -D ADVERT_LAT=0.0 + -D ADVERT_LON=0.0 + -D ADMIN_PASSWORD='"password"' + -D ROOM_PASSWORD='"hello"' +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${waveshare_rp2040_lora.build_src_filter} + +<../examples/simple_room_server> + +[env:waveshare_rp2040_lora_companion_radio_usb] +extends = waveshare_rp2040_lora +build_flags = ${waveshare_rp2040_lora.build_flags} + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=8 +; NOTE: DO NOT ENABLE --> -D MESH_PACKET_LOGGING=1 +; NOTE: DO NOT ENABLE --> -D MESH_DEBUG=1 +build_src_filter = ${waveshare_rp2040_lora.build_src_filter} + +<../examples/companion_radio> +lib_deps = ${waveshare_rp2040_lora.lib_deps} + densaugeo/base64 @ ~1.4.0 + +; [env:waveshare_rp2040_lora_companion_radio_ble] +; extends = waveshare_rp2040_lora +; build_flags = ${waveshare_rp2040_lora.build_flags} +; -D MAX_CONTACTS=100 +; -D MAX_GROUP_CHANNELS=8 +; -D BLE_PIN_CODE=123456 +; -D BLE_DEBUG_LOGGING=1 +; ; -D MESH_PACKET_LOGGING=1 +; ; -D MESH_DEBUG=1 +; build_src_filter = ${waveshare_rp2040_lora.build_src_filter} +; +<../examples/companion_radio> +; lib_deps = ${waveshare_rp2040_lora.lib_deps} +; densaugeo/base64 @ ~1.4.0 + +; [env:waveshare_rp2040_lora_companion_radio_wifi] +; extends = waveshare_rp2040_lora +; build_flags = ${waveshare_rp2040_lora.build_flags} +; -D MAX_CONTACTS=100 +; -D MAX_GROUP_CHANNELS=8 +; -D WIFI_DEBUG_LOGGING=1 +; -D WIFI_SSID='"myssid"' +; -D WIFI_PWD='"mypwd"' +; ; -D MESH_PACKET_LOGGING=1 +; ; -D MESH_DEBUG=1 +; build_src_filter = ${waveshare_rp2040_lora.build_src_filter} +; +<../examples/companion_radio> +; lib_deps = ${waveshare_rp2040_lora.lib_deps} +; densaugeo/base64 @ ~1.4.0 + +[env:waveshare_rp2040_lora_terminal_chat] +extends = waveshare_rp2040_lora +build_flags = ${waveshare_rp2040_lora.build_flags} + -D MAX_CONTACTS=100 + -D MAX_GROUP_CHANNELS=1 +; -D MESH_PACKET_LOGGING=1 +; -D MESH_DEBUG=1 +build_src_filter = ${waveshare_rp2040_lora.build_src_filter} + +<../examples/simple_secure_chat/main.cpp> +lib_deps = ${waveshare_rp2040_lora.lib_deps} + densaugeo/base64 @ ~1.4.0 diff --git a/variants/waveshare_rp2040_lora/target.cpp b/variants/waveshare_rp2040_lora/target.cpp new file mode 100644 index 00000000..895f6db2 --- /dev/null +++ b/variants/waveshare_rp2040_lora/target.cpp @@ -0,0 +1,81 @@ +#include "target.h" + +#include +#include + +WaveshareBoard board; + +RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BUSY, SPI1); +WRAPPER_CLASS radio_driver(radio, board); + +VolatileRTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); +SensorManager sensors; + +#ifndef LORA_CR +#define LORA_CR 5 +#endif + +bool radio_init() { + rtc_clock.begin(Wire); + +#ifdef SX126X_DIO3_TCXO_VOLTAGE + float tcxo = SX126X_DIO3_TCXO_VOLTAGE; +#else + float tcxo = 1.6f; +#endif + + SPI1.setSCK(P_LORA_SCLK); + SPI1.setTX(P_LORA_MOSI); + SPI1.setRX(P_LORA_MISO); + + pinMode(P_LORA_NSS, OUTPUT); + digitalWrite(P_LORA_NSS, HIGH); + + SPI1.begin(false); + + int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, + LORA_TX_POWER, 8, tcxo); + + if (status != RADIOLIB_ERR_NONE) { + Serial.print("ERROR: radio init failed: "); + Serial.println(status); + return false; // fail + } + + radio.setCRC(1); + +#ifdef SX126X_CURRENT_LIMIT + radio.setCurrentLimit(SX126X_CURRENT_LIMIT); +#endif + +#ifdef SX126X_DIO2_AS_RF_SWITCH + radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); +#endif + +#ifdef SX126X_RX_BOOSTED_GAIN + radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); +#endif + + return true; // success +} + +uint32_t radio_get_rng_seed() { + return radio.random(0x7FFFFFFF); +} + +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr) { + radio.setFrequency(freq); + radio.setSpreadingFactor(sf); + radio.setBandwidth(bw); + radio.setCodingRate(cr); +} + +void radio_set_tx_power(uint8_t dbm) { + radio.setOutputPower(dbm); +} + +mesh::LocalIdentity radio_new_identity() { + RadioNoiseListener rng(radio); + return mesh::LocalIdentity(&rng); // create new random identity +} diff --git a/variants/waveshare_rp2040_lora/target.h b/variants/waveshare_rp2040_lora/target.h new file mode 100644 index 00000000..3ebe0570 --- /dev/null +++ b/variants/waveshare_rp2040_lora/target.h @@ -0,0 +1,21 @@ +#pragma once + +#define RADIOLIB_STATIC_ONLY 1 + +#include +#include +#include +#include +#include +#include + +extern WaveshareBoard board; +extern WRAPPER_CLASS radio_driver; +extern AutoDiscoverRTCClock rtc_clock; +extern SensorManager sensors; + +bool radio_init(); +uint32_t radio_get_rng_seed(); +void radio_set_params(float freq, float bw, uint8_t sf, uint8_t cr); +void radio_set_tx_power(uint8_t dbm); +mesh::LocalIdentity radio_new_identity(); From 52acae1fe7b76615cb1dc22e45d66a8438e387e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Mon, 16 Jun 2025 02:01:04 +0100 Subject: [PATCH 75/87] Set default upload protocol --- platformio.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/platformio.ini b/platformio.ini index ad3ce4eb..b3aabad2 100644 --- a/platformio.ini +++ b/platformio.ini @@ -70,8 +70,9 @@ lib_deps = [rp2040_base] extends = arduino_base -platform = https://github.com/maxgerhardt/platform-raspberrypi.git +upload_protocol = picotool board_build.core = earlephilhower +platform = https://github.com/maxgerhardt/platform-raspberrypi.git build_flags = ${arduino_base.build_flags} -D RP2040_PLATFORM From 3448db6e3649d330eced7004d821feff2f59b49f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Mon, 16 Jun 2025 02:01:16 +0100 Subject: [PATCH 76/87] Rename LED pin --- src/helpers/rp2040/WaveshareBoard.cpp | 4 ++-- src/helpers/rp2040/WaveshareBoard.h | 15 +++++---------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/src/helpers/rp2040/WaveshareBoard.cpp b/src/helpers/rp2040/WaveshareBoard.cpp index f4154dbe..12e3d4f1 100644 --- a/src/helpers/rp2040/WaveshareBoard.cpp +++ b/src/helpers/rp2040/WaveshareBoard.cpp @@ -7,8 +7,8 @@ void WaveshareBoard::begin() { // for future use, sub-classes SHOULD call this from their begin() startup_reason = BD_STARTUP_NORMAL; -#ifdef PIN_LED_BUILTIN - pinMode(PIN_LED_BUILTIN, OUTPUT); +#ifdef P_LORA_TX_LED + pinMode(P_LORA_TX_LED, OUTPUT); #endif #ifdef PIN_VBAT_READ diff --git a/src/helpers/rp2040/WaveshareBoard.h b/src/helpers/rp2040/WaveshareBoard.h index 0aa136ab..492d54df 100644 --- a/src/helpers/rp2040/WaveshareBoard.h +++ b/src/helpers/rp2040/WaveshareBoard.h @@ -13,13 +13,11 @@ #define P_LORA_SCLK 14 #define P_LORA_MISO 24 #define P_LORA_MOSI 15 +#define P_LORA_TX_LED 25 #define SX126X_DIO2_AS_RF_SWITCH true #define SX126X_DIO3_TCXO_VOLTAGE 0 -// built-ins -#define PIN_LED_BUILTIN 25 - // This board has no built-in way to read battery voltage // #define PIN_VBAT_READ 26 // #define BATTERY_SAMPLES 8 @@ -33,13 +31,10 @@ public: void begin(); uint8_t getStartupReason() const override { return startup_reason; } - void onBeforeTransmit() override { - digitalWrite(PIN_LED_BUILTIN, HIGH); // turn TX LED on - } - - void onAfterTransmit() override { - digitalWrite(PIN_LED_BUILTIN, LOW); // turn TX LED off - } +#ifdef P_LORA_TX_LED + void onBeforeTransmit() override { digitalWrite(P_LORA_TX_LED, HIGH); } + void onAfterTransmit() override { digitalWrite(P_LORA_TX_LED, LOW); } +#endif uint16_t getBattMilliVolts() override { #if defined(PIN_VBAT_READ) && defined(ADC_MULTIPLIER) From 0f9efa2ee865374ef66c2c6d523cba9321e44091 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Mon, 16 Jun 2025 17:02:44 +1000 Subject: [PATCH 77/87] * room server: suggested keep_alive interval now disabled --- examples/simple_room_server/main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/simple_room_server/main.cpp b/examples/simple_room_server/main.cpp index 740d70e5..d9d9f122 100644 --- a/examples/simple_room_server/main.cpp +++ b/examples/simple_room_server/main.cpp @@ -123,7 +123,7 @@ struct PostInfo { #define PUSH_TIMEOUT_BASE 4000 #define PUSH_ACK_TIMEOUT_FACTOR 2000 -#define CLIENT_KEEP_ALIVE_SECS 128 +#define CLIENT_KEEP_ALIVE_SECS 0 // Now Disabled (was 128) #define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS #define REQ_TYPE_KEEP_ALIVE 0x02 From 5c6f3457e2e501ead9b96766c1368bac8702a3b8 Mon Sep 17 00:00:00 2001 From: Florent de Lamotte Date: Mon, 16 Jun 2025 09:14:42 +0200 Subject: [PATCH 78/87] t1000e: don't update position if gps is off --- variants/t1000-e/target.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/variants/t1000-e/target.cpp b/variants/t1000-e/target.cpp index caa53930..49ae26eb 100644 --- a/variants/t1000-e/target.cpp +++ b/variants/t1000-e/target.cpp @@ -174,7 +174,7 @@ void T1000SensorManager::loop() { _nmea->loop(); if (millis() > next_gps_update) { - if (_nmea->isValid()) { + if (gps_active && _nmea->isValid()) { node_lat = ((double)_nmea->getLatitude())/1000000.; node_lon = ((double)_nmea->getLongitude())/1000000.; node_altitude = ((double)_nmea->getAltitude()) / 1000.0; From f3e85a6fbaa004642dc18d62c7ac44c82c4985b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Mon, 16 Jun 2025 16:57:43 +0100 Subject: [PATCH 79/87] Update SX126X_CURRENT_LIMIT --- variants/waveshare_rp2040_lora/platformio.ini | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/variants/waveshare_rp2040_lora/platformio.ini b/variants/waveshare_rp2040_lora/platformio.ini index e84e57ad..2730734d 100644 --- a/variants/waveshare_rp2040_lora/platformio.ini +++ b/variants/waveshare_rp2040_lora/platformio.ini @@ -9,7 +9,7 @@ board_build.filesystem_size = 0.5m build_flags = ${rp2040_base.build_flags} -I variants/waveshare_rp2040_lora - -D SX126X_CURRENT_LIMIT=130 + -D SX126X_CURRENT_LIMIT=140 -D RADIO_CLASS=CustomSX1262 -D WRAPPER_CLASS=CustomSX1262Wrapper -D LORA_TX_POWER=22 @@ -30,7 +30,7 @@ lib_deps = ${rp2040_base.lib_deps} [env:waveshare_rp2040_lora_Repeater] extends = waveshare_rp2040_lora build_flags = ${waveshare_rp2040_lora.build_flags} - -D ADVERT_NAME='"Waveshare RP2040-LoRa Repeater"' + -D ADVERT_NAME='"RP2040-LoRa Repeater"' -D ADVERT_LAT=0.0 -D ADVERT_LON=0.0 -D ADMIN_PASSWORD='"password"' @@ -43,7 +43,7 @@ build_src_filter = ${waveshare_rp2040_lora.build_src_filter} [env:waveshare_rp2040_lora_room_server] extends = waveshare_rp2040_lora build_flags = ${waveshare_rp2040_lora.build_flags} - -D ADVERT_NAME='"Test Room"' + -D ADVERT_NAME='"RP2040-LoRa Room"' -D ADVERT_LAT=0.0 -D ADVERT_LON=0.0 -D ADMIN_PASSWORD='"password"' From 110bd494072684638a3d512b325d72aeeab9592c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Mon, 16 Jun 2025 19:51:53 +0100 Subject: [PATCH 80/87] VBAT schematic --- src/helpers/rp2040/WaveshareBoard.cpp | 3 ++- src/helpers/rp2040/WaveshareBoard.h | 18 ++++++++++++++---- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/helpers/rp2040/WaveshareBoard.cpp b/src/helpers/rp2040/WaveshareBoard.cpp index 12e3d4f1..2e622933 100644 --- a/src/helpers/rp2040/WaveshareBoard.cpp +++ b/src/helpers/rp2040/WaveshareBoard.cpp @@ -16,7 +16,8 @@ void WaveshareBoard::begin() { #endif #if defined(PIN_BOARD_SDA) && defined(PIN_BOARD_SCL) - Wire.setPins(PIN_BOARD_SDA, PIN_BOARD_SCL); + Wire.setSDA(PIN_BOARD_SDA); + Wire.setSCL(PIN_BOARD_SCL); #endif Wire.begin(); diff --git a/src/helpers/rp2040/WaveshareBoard.h b/src/helpers/rp2040/WaveshareBoard.h index 492d54df..a09c4b62 100644 --- a/src/helpers/rp2040/WaveshareBoard.h +++ b/src/helpers/rp2040/WaveshareBoard.h @@ -18,10 +18,20 @@ #define SX126X_DIO2_AS_RF_SWITCH true #define SX126X_DIO3_TCXO_VOLTAGE 0 -// This board has no built-in way to read battery voltage -// #define PIN_VBAT_READ 26 -// #define BATTERY_SAMPLES 8 -// #define ADC_MULTIPLIER (3.1 * 3.3 * 1000) // MT Uses 3.1 +/* + * This board has no built-in way to read battery voltage. + * Nevertheless it's very easy to make it work, you only require two 1% resistors. + * + * VSYS -- /\/\/\/\-- --+ + * 200k | + * +-- GPIO28 + * | + * GND -- /\/\/\/\-- --+ + * 100k + */ +#define PIN_VBAT_READ 28 +#define BATTERY_SAMPLES 8 +#define ADC_MULTIPLIER (3.0f * 3.3f * 1000) class WaveshareBoard : public mesh::MainBoard { protected: From 24464d0c4e994b4e0e993c68f532a8f6da6a3b5d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Br=C3=A1zio?= Date: Mon, 16 Jun 2025 21:28:59 +0100 Subject: [PATCH 81/87] Update VBAT schematic --- src/helpers/rp2040/WaveshareBoard.h | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/helpers/rp2040/WaveshareBoard.h b/src/helpers/rp2040/WaveshareBoard.h index a09c4b62..c2b5aff5 100644 --- a/src/helpers/rp2040/WaveshareBoard.h +++ b/src/helpers/rp2040/WaveshareBoard.h @@ -22,12 +22,15 @@ * This board has no built-in way to read battery voltage. * Nevertheless it's very easy to make it work, you only require two 1% resistors. * - * VSYS -- /\/\/\/\-- --+ - * 200k | - * +-- GPIO28 - * | - * GND -- /\/\/\/\-- --+ - * 100k + * BAT+ -----+ + * | + * VSYS --+ -/\/\/\/\- --+ + * 200k | + * +-- GPIO28 + * | + * GND --+ -/\/\/\/\- --+ + * | 100k + * BAT- -----+ */ #define PIN_VBAT_READ 28 #define BATTERY_SAMPLES 8 From 9363478d6fd174bb22a75dc74f022e0cb4a6d337 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Wed, 18 Jun 2025 01:27:53 +1000 Subject: [PATCH 82/87] * noise floor can now be queried even when int.thresh = 0 --- src/helpers/RadioLibWrappers.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/helpers/RadioLibWrappers.cpp b/src/helpers/RadioLibWrappers.cpp index 0593451a..96fb7aab 100644 --- a/src/helpers/RadioLibWrappers.cpp +++ b/src/helpers/RadioLibWrappers.cpp @@ -9,6 +9,7 @@ #define STATE_INT_READY 16 #define NUM_NOISE_FLOOR_SAMPLES 64 +#define SAMPLING_THRESHOLD 14 static volatile uint8_t state = STATE_IDLE; @@ -46,7 +47,7 @@ void RadioLibWrapper::idle() { void RadioLibWrapper::triggerNoiseFloorCalibrate(int threshold) { _threshold = threshold; - if (threshold > 0 && _num_floor_samples >= NUM_NOISE_FLOOR_SAMPLES) { // ignore trigger if currently sampling + if (_num_floor_samples >= NUM_NOISE_FLOOR_SAMPLES) { // ignore trigger if currently sampling _num_floor_samples = 0; _floor_sample_sum = 0; } @@ -65,7 +66,7 @@ void RadioLibWrapper::loop() { if (state == STATE_RX && _num_floor_samples < NUM_NOISE_FLOOR_SAMPLES) { if (!isReceivingPacket()) { int rssi = getCurrentRSSI(); - if (rssi < _noise_floor + _threshold) { // only consider samples below current floor+THRESHOLD + if (rssi < _noise_floor + SAMPLING_THRESHOLD) { // only consider samples below current floor + sampling THRESHOLD _num_floor_samples++; _floor_sample_sum += rssi; } From 83b70b31670e46292c85bcf998c75bdaa63ad221 Mon Sep 17 00:00:00 2001 From: Matthew Harrold Date: Tue, 17 Jun 2025 23:12:10 +0100 Subject: [PATCH 83/87] Add support for Seeed NRF + RTC --- variants/xiao_nrf52/target.cpp | 5 +++-- variants/xiao_nrf52/target.h | 3 ++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/variants/xiao_nrf52/target.cpp b/variants/xiao_nrf52/target.cpp index 724e7c63..853855cd 100644 --- a/variants/xiao_nrf52/target.cpp +++ b/variants/xiao_nrf52/target.cpp @@ -8,7 +8,8 @@ RADIO_CLASS radio = new Module(P_LORA_NSS, P_LORA_DIO_1, P_LORA_RESET, P_LORA_BU WRAPPER_CLASS radio_driver(radio, board); -VolatileRTCClock rtc_clock; +VolatileRTCClock fallback_clock; +AutoDiscoverRTCClock rtc_clock(fallback_clock); EnvironmentSensorManager sensors; #ifndef LORA_CR @@ -16,7 +17,7 @@ EnvironmentSensorManager sensors; #endif bool radio_init() { -// rtc_clock.begin(Wire); + rtc_clock.begin(Wire); #ifdef SX126X_DIO3_TCXO_VOLTAGE float tcxo = SX126X_DIO3_TCXO_VOLTAGE; diff --git a/variants/xiao_nrf52/target.h b/variants/xiao_nrf52/target.h index ec298a43..eb299006 100644 --- a/variants/xiao_nrf52/target.h +++ b/variants/xiao_nrf52/target.h @@ -5,12 +5,13 @@ #include #include #include +#include #include #include extern XiaoNrf52Board board; extern WRAPPER_CLASS radio_driver; -extern VolatileRTCClock rtc_clock; +extern AutoDiscoverRTCClock rtc_clock; extern EnvironmentSensorManager sensors; bool radio_init(); From b1fe57e892f388e3c290eda4a1bc0ec60c2e0e03 Mon Sep 17 00:00:00 2001 From: JQ Date: Tue, 17 Jun 2025 16:06:07 -0700 Subject: [PATCH 84/87] adding display support to all T114 builds --- variants/t114/platformio.ini | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index d347688a..48dac6d4 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -15,6 +15,7 @@ board = heltec_t114 board_build.ldscript = boards/nrf52840_s140_v6.ld build_flags = ${nrf52840_t114.build_flags} -I variants/t114 + -I src/helpers/ui -DHELTEC_T114 -D P_LORA_TX_LED=35 -D RADIO_CLASS=CustomSX1262 @@ -22,13 +23,19 @@ build_flags = ${nrf52840_t114.build_flags} -D LORA_TX_POWER=22 -D SX126X_CURRENT_LIMIT=140 -D SX126X_RX_BOOSTED_GAIN=1 + -D ST7789 + -D DISPLAY_CLASS=ST7789Display build_src_filter = ${nrf52840_t114.build_src_filter} + + +<../variants/t114> + + + + + + lib_deps = ${nrf52840_t114.lib_deps} stevemarple/MicroNMEA @ ^2.0.6 + adafruit/Adafruit GFX Library @ ^1.12.1 debug_tool = jlink upload_protocol = nrfutil @@ -64,9 +71,6 @@ build_flags = extends = Heltec_t114 build_flags = ${Heltec_t114.build_flags} - -I src/helpers/ui - -D ST7789 - -D DISPLAY_CLASS=ST7789Display -D MAX_CONTACTS=100 -D MAX_GROUP_CHANNELS=8 -D BLE_PIN_CODE=123456 @@ -75,14 +79,9 @@ build_flags = ; -D MESH_PACKET_LOGGING=1 ; -D MESH_DEBUG=1 build_src_filter = ${Heltec_t114.build_src_filter} - + + +<../examples/companion_radio> - + - + - + lib_deps = - adafruit/Adafruit GFX Library @ ^1.12.1 ${Heltec_t114.lib_deps} densaugeo/base64 @ ~1.4.0 From e6ce3c896d724fe8bcc6e15e89a4ec6d13a50b8d Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Wed, 18 Jun 2025 16:02:09 +1000 Subject: [PATCH 85/87] * companion: new CMD_GET_ADVERT_PATH -> RESP_CODE_ADVERT_PATH --- examples/companion_radio/MyMesh.cpp | 46 +++++++++++++++++++++++++++- examples/companion_radio/MyMesh.h | 13 ++++++-- examples/simple_secure_chat/main.cpp | 2 +- src/helpers/BaseChatMesh.cpp | 4 +-- src/helpers/BaseChatMesh.h | 2 +- 5 files changed, 60 insertions(+), 7 deletions(-) diff --git a/examples/companion_radio/MyMesh.cpp b/examples/companion_radio/MyMesh.cpp index 2b98ec04..97781a08 100644 --- a/examples/companion_radio/MyMesh.cpp +++ b/examples/companion_radio/MyMesh.cpp @@ -44,6 +44,7 @@ #define CMD_SEND_TELEMETRY_REQ 39 #define CMD_GET_CUSTOM_VARS 40 #define CMD_SET_CUSTOM_VAR 41 +#define CMD_GET_ADVERT_PATH 42 #define RESP_CODE_OK 0 #define RESP_CODE_ERR 1 @@ -67,6 +68,7 @@ #define RESP_CODE_SIGN_START 19 #define RESP_CODE_SIGNATURE 20 #define RESP_CODE_CUSTOM_VARS 21 +#define RESP_CODE_ADVERT_PATH 22 #define SEND_TIMEOUT_BASE_MILLIS 500 #define FLOOD_SEND_TIMEOUT_FACTOR 16.0f @@ -219,7 +221,7 @@ bool MyMesh::isAutoAddEnabled() const { return (_prefs.manual_add_contacts & 1) == 0; } -void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { +void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new, uint8_t path_len, const uint8_t* path) { if (_serial->isConnected()) { if (!isAutoAddEnabled() && is_new) { writeContactRespFrame(PUSH_CODE_NEW_ADVERT, contact); @@ -234,6 +236,27 @@ void MyMesh::onDiscoveredContact(ContactInfo &contact, bool is_new) { #endif } + // add inbound-path to mem cache + if (path && path_len <= sizeof(AdvertPath::path)) { // check path is valid + AdvertPath* p = advert_paths; + uint32_t oldest = 0xFFFFFFFF; + for (int i = 0; i < ADVERT_PATH_TABLE_SIZE; i++) { // check if already in table, otherwise evict oldest + if (memcmp(advert_paths[i].pubkey_prefix, contact.id.pub_key, sizeof(AdvertPath::pubkey_prefix)) == 0) { + p = &advert_paths[i]; // found + break; + } + if (advert_paths[i].recv_timestamp < oldest) { + oldest = advert_paths[i].recv_timestamp; + p = &advert_paths[i]; + } + } + + memcpy(p->pubkey_prefix, contact.id.pub_key, sizeof(p->pubkey_prefix)); + p->recv_timestamp = getRTCClock()->getCurrentTime(); + p->path_len = path_len; + memcpy(p->path, path, p->path_len); + } + dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } @@ -541,6 +564,7 @@ MyMesh::MyMesh(mesh::Radio &radio, mesh::RNG &rng, mesh::RTCClock &rtc, SimpleMe next_ack_idx = 0; sign_data = NULL; dirty_contacts_expiry = 0; + memset(advert_paths, 0, sizeof(advert_paths)); // defaults memset(&_prefs, 0, sizeof(_prefs)); @@ -1249,6 +1273,26 @@ void MyMesh::handleCmdFrame(size_t len) { } else { writeErrFrame(ERR_CODE_ILLEGAL_ARG); } + } else if (cmd_frame[0] == CMD_GET_ADVERT_PATH && len >= PUB_KEY_SIZE+2) { + // FUTURE use: uint8_t reserved = cmd_frame[1]; + uint8_t *pub_key = &cmd_frame[2]; + AdvertPath* found = NULL; + for (int i = 0; i < ADVERT_PATH_TABLE_SIZE; i++) { + auto p = &advert_paths[i]; + if (memcmp(p->pubkey_prefix, pub_key, sizeof(p->pubkey_prefix)) == 0) { + found = p; + break; + } + } + if (found) { + out_frame[0] = RESP_CODE_ADVERT_PATH; + memcpy(&out_frame[1], &found->recv_timestamp, 4); + out_frame[5] = found->path_len; + memcpy(&out_frame[6], found->path, found->path_len); + _serial->writeFrame(out_frame, 6 + found->path_len); + } else { + writeErrFrame(ERR_CODE_NOT_FOUND); + } } else { writeErrFrame(ERR_CODE_UNSUPPORTED_CMD); MESH_DEBUG_PRINTLN("ERROR: unknown command: %02X", cmd_frame[0]); diff --git a/examples/companion_radio/MyMesh.h b/examples/companion_radio/MyMesh.h index f6603feb..407b11d5 100644 --- a/examples/companion_radio/MyMesh.h +++ b/examples/companion_radio/MyMesh.h @@ -100,7 +100,7 @@ protected: void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override; bool isAutoAddEnabled() const override; - void onDiscoveredContact(ContactInfo &contact, bool is_new) override; + void onDiscoveredContact(ContactInfo &contact, bool is_new, uint8_t path_len, const uint8_t* path) override; void onContactPathUpdated(const ContactInfo &contact) override; bool processAck(const uint8_t *data) override; void queueMessage(const ContactInfo &from, uint8_t txt_type, mesh::Packet *pkt, uint32_t sender_timestamp, @@ -190,9 +190,18 @@ private: unsigned long msg_sent; uint32_t ack; }; -#define EXPECTED_ACK_TABLE_SIZE 8 + #define EXPECTED_ACK_TABLE_SIZE 8 AckTableEntry expected_ack_table[EXPECTED_ACK_TABLE_SIZE]; // circular table int next_ack_idx; + + struct AdvertPath { + uint8_t pubkey_prefix[7]; + uint8_t path_len; + uint32_t recv_timestamp; + uint8_t path[MAX_PATH_SIZE]; + }; + #define ADVERT_PATH_TABLE_SIZE 16 + AdvertPath advert_paths[ADVERT_PATH_TABLE_SIZE]; // circular table }; extern MyMesh the_mesh; diff --git a/examples/simple_secure_chat/main.cpp b/examples/simple_secure_chat/main.cpp index 63ff20da..a6b048a1 100644 --- a/examples/simple_secure_chat/main.cpp +++ b/examples/simple_secure_chat/main.cpp @@ -202,7 +202,7 @@ protected: return true; } - void onDiscoveredContact(ContactInfo& contact, bool is_new) override { + void onDiscoveredContact(ContactInfo& contact, bool is_new, uint8_t path_len, const uint8_t* path) override { // TODO: if not in favs, prompt to add as fav(?) Serial.printf("ADVERT from -> %s\n", contact.name); diff --git a/src/helpers/BaseChatMesh.cpp b/src/helpers/BaseChatMesh.cpp index 7efd4735..4649040e 100644 --- a/src/helpers/BaseChatMesh.cpp +++ b/src/helpers/BaseChatMesh.cpp @@ -58,7 +58,7 @@ void BaseChatMesh::onAdvertRecv(mesh::Packet* packet, const mesh::Identity& id, } ci.last_advert_timestamp = timestamp; ci.lastmod = getRTCClock()->getCurrentTime(); - onDiscoveredContact(ci, true); // let UI know + onDiscoveredContact(ci, true, packet->path_len, packet->path); // let UI know return; } @@ -89,7 +89,7 @@ void BaseChatMesh::onAdvertRecv(mesh::Packet* packet, const mesh::Identity& id, from->last_advert_timestamp = timestamp; from->lastmod = getRTCClock()->getCurrentTime(); - onDiscoveredContact(*from, is_new); // let UI know + onDiscoveredContact(*from, is_new, packet->path_len, packet->path); // let UI know } int BaseChatMesh::searchPeersByHash(const uint8_t* hash) { diff --git a/src/helpers/BaseChatMesh.h b/src/helpers/BaseChatMesh.h index 83ad2a89..de73ea78 100644 --- a/src/helpers/BaseChatMesh.h +++ b/src/helpers/BaseChatMesh.h @@ -89,7 +89,7 @@ protected: // 'UI' concepts, for sub-classes to implement virtual bool isAutoAddEnabled() const { return true; } - virtual void onDiscoveredContact(ContactInfo& contact, bool is_new) = 0; + virtual void onDiscoveredContact(ContactInfo& contact, bool is_new, uint8_t path_len, const uint8_t* path) = 0; virtual bool processAck(const uint8_t *data) = 0; virtual void onContactPathUpdated(const ContactInfo& contact) = 0; virtual void onMessageRecv(const ContactInfo& contact, mesh::Packet* pkt, uint32_t sender_timestamp, const char *text) = 0; From b3184eb94caba9b0465cfd465ff44fcd205bd3b4 Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Wed, 18 Jun 2025 17:20:38 +1000 Subject: [PATCH 86/87] * T114 repeater build fix --- variants/t114/platformio.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/variants/t114/platformio.ini b/variants/t114/platformio.ini index 48dac6d4..dac12da9 100644 --- a/variants/t114/platformio.ini +++ b/variants/t114/platformio.ini @@ -42,7 +42,8 @@ upload_protocol = nrfutil [env:Heltec_t114_repeater] extends = Heltec_t114 build_src_filter = ${Heltec_t114.build_src_filter} - +<../examples/simple_repeater/main.cpp> + +<../examples/simple_repeater> + build_flags = ${Heltec_t114.build_flags} -D ADVERT_NAME='"Heltec_T114 Repeater"' From 587d9d8818915e9e31d79e08bb532cd441e3e62d Mon Sep 17 00:00:00 2001 From: Scott Powell Date: Thu, 19 Jun 2025 10:58:10 +1000 Subject: [PATCH 87/87] * added CustomSX1262::std_init() * refactored variants to use std_init(): heltec_v3, t114, xiao_c3 --- src/helpers/CustomSX1262.h | 42 +++++++++++++++++++++++++++++++++++ variants/heltec_v3/target.cpp | 33 +++------------------------ variants/t114/target.cpp | 33 +-------------------------- variants/xiao_c3/target.cpp | 33 +++------------------------ 4 files changed, 49 insertions(+), 92 deletions(-) diff --git a/src/helpers/CustomSX1262.h b/src/helpers/CustomSX1262.h index c9fb5b69..8ce742c7 100644 --- a/src/helpers/CustomSX1262.h +++ b/src/helpers/CustomSX1262.h @@ -9,6 +9,48 @@ class CustomSX1262 : public SX1262 { public: CustomSX1262(Module *mod) : SX1262(mod) { } + bool std_init(SPIClass* spi = NULL) { + #ifdef SX126X_DIO3_TCXO_VOLTAGE + float tcxo = SX126X_DIO3_TCXO_VOLTAGE; + #else + float tcxo = 1.6f; + #endif + + #ifdef LORA_CR + uint8_t cr = LORA_CR; + #else + uint8_t cr = 5; + #endif + + #if defined(P_LORA_SCLK) + #ifdef NRF52_PLATFORM + if (spi) { spi->setPins(P_LORA_MISO, P_LORA_SCLK, P_LORA_MOSI); spi->begin(); } + #else + if (spi) spi->begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); + #endif + #endif + int status = begin(LORA_FREQ, LORA_BW, LORA_SF, cr, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); + if (status != RADIOLIB_ERR_NONE) { + Serial.print("ERROR: radio init failed: "); + Serial.println(status); + return false; // fail + } + + setCRC(1); + + #ifdef SX126X_CURRENT_LIMIT + setCurrentLimit(SX126X_CURRENT_LIMIT); + #endif + #ifdef SX126X_DIO2_AS_RF_SWITCH + setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); + #endif + #ifdef SX126X_RX_BOOSTED_GAIN + setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); + #endif + + return true; // success + } + bool isReceiving() { uint16_t irq = getIrqFlags(); bool detected = (irq & SX126X_IRQ_HEADER_VALID) || (irq & SX126X_IRQ_PREAMBLE_DETECTED); diff --git a/variants/heltec_v3/target.cpp b/variants/heltec_v3/target.cpp index be99a1e3..de8e0f92 100644 --- a/variants/heltec_v3/target.cpp +++ b/variants/heltec_v3/target.cpp @@ -20,43 +20,16 @@ EnvironmentSensorManager sensors; DISPLAY_CLASS display; #endif -#ifndef LORA_CR - #define LORA_CR 5 -#endif - bool radio_init() { fallback_clock.begin(); rtc_clock.begin(Wire); -#ifdef SX126X_DIO3_TCXO_VOLTAGE - float tcxo = SX126X_DIO3_TCXO_VOLTAGE; -#else - float tcxo = 1.6f; -#endif - #if defined(P_LORA_SCLK) spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); + return radio.std_init(&spi); +#else + return radio.std_init(); #endif - int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); - if (status != RADIOLIB_ERR_NONE) { - Serial.print("ERROR: radio init failed: "); - Serial.println(status); - return false; // fail - } - - radio.setCRC(1); - -#ifdef SX126X_CURRENT_LIMIT - radio.setCurrentLimit(SX126X_CURRENT_LIMIT); -#endif -#ifdef SX126X_DIO2_AS_RF_SWITCH - radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); -#endif -#ifdef SX126X_RX_BOOSTED_GAIN - radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); -#endif - - return true; // success } uint32_t radio_get_rng_seed() { diff --git a/variants/t114/target.cpp b/variants/t114/target.cpp index a57a55e2..d97c03f6 100644 --- a/variants/t114/target.cpp +++ b/variants/t114/target.cpp @@ -18,41 +18,10 @@ T114SensorManager sensors = T114SensorManager(nmea); DISPLAY_CLASS display; #endif -#ifndef LORA_CR - #define LORA_CR 5 -#endif - bool radio_init() { rtc_clock.begin(Wire); - -#ifdef SX126X_DIO3_TCXO_VOLTAGE - float tcxo = SX126X_DIO3_TCXO_VOLTAGE; -#else - float tcxo = 1.6f; -#endif - SPI.setPins(P_LORA_MISO, P_LORA_SCLK, P_LORA_MOSI); - SPI.begin(); - int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); - if (status != RADIOLIB_ERR_NONE) { - Serial.print("ERROR: radio init failed: "); - Serial.println(status); - return false; // fail - } - - radio.setCRC(1); - -#ifdef SX126X_CURRENT_LIMIT - radio.setCurrentLimit(SX126X_CURRENT_LIMIT); -#endif -#ifdef SX126X_DIO2_AS_RF_SWITCH - radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); -#endif -#ifdef SX126X_RX_BOOSTED_GAIN - radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); -#endif - - return true; // success + return radio.std_init(&SPI); } uint32_t radio_get_rng_seed() { diff --git a/variants/xiao_c3/target.cpp b/variants/xiao_c3/target.cpp index 0ed1609d..b3701ca7 100644 --- a/variants/xiao_c3/target.cpp +++ b/variants/xiao_c3/target.cpp @@ -16,43 +16,16 @@ ESP32RTCClock fallback_clock; AutoDiscoverRTCClock rtc_clock(fallback_clock); SensorManager sensors; -#ifndef LORA_CR - #define LORA_CR 5 -#endif - bool radio_init() { fallback_clock.begin(); rtc_clock.begin(Wire); - -#ifdef SX126X_DIO3_TCXO_VOLTAGE - float tcxo = SX126X_DIO3_TCXO_VOLTAGE; -#else - float tcxo = 1.6f; -#endif #if defined(P_LORA_SCLK) spi.begin(P_LORA_SCLK, P_LORA_MISO, P_LORA_MOSI); + return radio.std_init(&spi); +#else + return radio.std_init(); #endif - int status = radio.begin(LORA_FREQ, LORA_BW, LORA_SF, LORA_CR, RADIOLIB_SX126X_SYNC_WORD_PRIVATE, LORA_TX_POWER, 8, tcxo); - if (status != RADIOLIB_ERR_NONE) { - Serial.print("ERROR: radio init failed: "); - Serial.println(status); - return false; // fail - } - - radio.setCRC(1); - -#ifdef SX126X_CURRENT_LIMIT - radio.setCurrentLimit(SX126X_CURRENT_LIMIT); -#endif -#ifdef SX126X_DIO2_AS_RF_SWITCH - radio.setDio2AsRfSwitch(SX126X_DIO2_AS_RF_SWITCH); -#endif -#ifdef SX126X_RX_BOOSTED_GAIN - radio.setRxBoostedGainMode(SX126X_RX_BOOSTED_GAIN); -#endif - - return true; // success } uint32_t radio_get_rng_seed() {