#include "MyMesh.h" #include #include /* ------------------------------ Config -------------------------------- */ #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 DEFAULT_RX_DELAY_BASE #define DEFAULT_RX_DELAY_BASE 0.0f #endif #ifndef DEFAULT_LOOP_DETECT #define DEFAULT_LOOP_DETECT LOOP_DETECT_OFF #endif #ifndef DEFAULT_POWERSAVING_ENABLED #define DEFAULT_POWERSAVING_ENABLED 0 #endif #ifndef DEFAULT_AGC_RESET_INTERVAL #define DEFAULT_AGC_RESET_INTERVAL 0 #endif #ifndef DEFAULT_ADVERT_INTERVAL #define DEFAULT_ADVERT_INTERVAL 1 #endif #ifndef DEFAULT_FLOOD_ADVERT_INTERVAL #define DEFAULT_FLOOD_ADVERT_INTERVAL 12 #endif #ifndef DEFAULT_MULTI_ACKS #define DEFAULT_MULTI_ACKS 0 #endif #ifndef DEFAULT_PATH_HASH_MODE #define DEFAULT_PATH_HASH_MODE 0 #endif #ifndef ADVERT_NAME #define ADVERT_NAME "repeater" #endif #ifndef ADVERT_LAT #define ADVERT_LAT 0.0 #endif #ifndef ADVERT_LON #define ADVERT_LON 0.0 #endif #ifndef ADMIN_PASSWORD #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 #ifndef HALO_DIRECT_RETRY_DELAY_MIN #define HALO_DIRECT_RETRY_DELAY_MIN 200 #endif #define FIRMWARE_VER_LEVEL 2 #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_ACCESS_LIST 0x05 #define REQ_TYPE_GET_NEIGHBOURS 0x06 #define REQ_TYPE_GET_OWNER_INFO 0x07 // FIRMWARE_VER_LEVEL >= 2 #define RESP_SERVER_LOGIN_OK 0 // response to ANON_REQ #define ANON_REQ_TYPE_REGIONS 0x01 #define ANON_REQ_TYPE_OWNER 0x02 #define ANON_REQ_TYPE_BASIC 0x03 // just remote clock #define CLI_REPLY_DELAY_MILLIS 600 #define LAZY_CONTACTS_WRITE_DELAY 5000 #ifndef REPEATERS_CHANNEL_KEY_HEX #define REPEATERS_CHANNEL_KEY_HEX "89db441e2814dccf0dbd2e8cc5f501a3" #endif #ifndef BATT_MIN_MILLIVOLTS #define BATT_MIN_MILLIVOLTS 3000 #endif #ifndef BATT_MAX_MILLIVOLTS #define BATT_MAX_MILLIVOLTS 4200 #endif #define LOW_BATTERY_MIN_VALID_MV 1000 #define LOW_BATTERY_WARN_PERCENT_DEFAULT 20 #define LOW_BATTERY_CRITICAL_PERCENT_DEFAULT 10 #define LOW_BATTERY_CHECK_INTERVAL (60UL * 1000UL) #define LOW_BATTERY_WARN_INTERVAL (24UL * 60UL * 60UL * 1000UL) #define LOW_BATTERY_CRITICAL_INTERVAL (12UL * 60UL * 60UL * 1000UL) static void formatRecentRepeaterPrefix(const SimpleMeshTables::RecentRepeaterInfo* info, char* out, size_t out_len) { if (out == NULL || out_len == 0) { return; } out[0] = 0; if (info == NULL) { return; } uint8_t prefix_len = info->prefix_len; if (prefix_len > MAX_ROUTE_HASH_BYTES) { prefix_len = MAX_ROUTE_HASH_BYTES; } if (prefix_len > 0) { mesh::Utils::toHex(out, info->prefix, prefix_len); } size_t used = strlen(out); const size_t target_len = MAX_ROUTE_HASH_BYTES * 2; while (used < target_len && used + 1 < out_len) { out[used++] = ' '; } out[used] = 0; } static void formatRecentRepeaterSnrX4(int8_t snr_x4, char* out, size_t out_len) { if (out == NULL || out_len == 0) { return; } const char* snr_text = StrHelper::ftoa(((float)snr_x4) / 4.0f); if (snr_text[0] == '-') { snprintf(out, out_len, "%s", snr_text); } else { snprintf(out, out_len, " %s", snr_text); } } static int buildSortedRecentRepeaterView(SimpleMeshTables* tables, const SimpleMeshTables::RecentRepeaterInfo** out, int out_cap) { if (tables == NULL || out == NULL || out_cap <= 0) { return 0; } int total = tables->getRecentRepeaterCount(); if (total > out_cap) { total = out_cap; } int count = 0; for (int i = 0; i < total; i++) { const auto* info = tables->getRecentRepeaterNewestByIdx(i); if (info != NULL) { out[count++] = info; } } std::stable_sort(out, out + count, [](const SimpleMeshTables::RecentRepeaterInfo* a, const SimpleMeshTables::RecentRepeaterInfo* b) { uint8_t a_len = a->prefix_len; uint8_t b_len = b->prefix_len; if (a_len > MAX_ROUTE_HASH_BYTES) a_len = MAX_ROUTE_HASH_BYTES; if (b_len > MAX_ROUTE_HASH_BYTES) b_len = MAX_ROUTE_HASH_BYTES; if (a_len != b_len) { return a_len > b_len; // 3-byte first, then 2-byte, then 1-byte } if (a->snr_x4 != b->snr_x4) { return a->snr_x4 > b->snr_x4; // highest SNR first within each prefix size } return false; // keep original newest-first order for ties }); return count; } static uint8_t decodeTraceHashSize(uint8_t flags, uint8_t route_bytes) { uint8_t code = flags & 0x03; uint8_t size_pow2 = (uint8_t)(1U << code); // legacy TRACE interpretation uint8_t size_linear = (uint8_t)(code + 1U); // packed-size interpretation (1..4) bool pow2_ok = size_pow2 > 0 && (route_bytes % size_pow2) == 0; bool linear_ok = size_linear > 0 && (route_bytes % size_linear) == 0; if (pow2_ok && !linear_ok) { return size_pow2; } if (linear_ok && !pow2_ok) { return size_linear; } if (pow2_ok) { return size_pow2; } return size_linear; } void MyMesh::putNeighbour(const mesh::Identity &id, uint32_t timestamp, float snr) { #if MAX_NEIGHBOURS // check if neighbours enabled // find existing neighbour, else use least recently updated uint32_t oldest_timestamp = 0xFFFFFFFF; NeighbourInfo *neighbour = &neighbours[0]; for (int i = 0; i < MAX_NEIGHBOURS; i++) { // if neighbour already known, we should update it if (id.matches(neighbours[i].id)) { neighbour = &neighbours[i]; break; } // otherwise we should update the least recently updated neighbour if (neighbours[i].heard_timestamp < oldest_timestamp) { neighbour = &neighbours[i]; oldest_timestamp = neighbour->heard_timestamp; } } // update neighbour info neighbour->id = id; neighbour->advert_timestamp = timestamp; neighbour->heard_timestamp = getRTCClock()->getCurrentTime(); neighbour->snr = (int8_t)(snr * 4); #endif } uint8_t MyMesh::handleLoginReq(const mesh::Identity& sender, const uint8_t* secret, uint32_t sender_timestamp, const uint8_t* data, bool is_flood) { ClientInfo* client = NULL; if (data[0] == 0) { // blank password, just check if sender is in ACL client = acl.getClient(sender.pub_key, PUB_KEY_SIZE); if (client == NULL) { #if MESH_DEBUG MESH_DEBUG_PRINTLN("Login, sender not in ACL"); #endif } } if (client == NULL) { uint8_t perms; if (strcmp((char *)data, _prefs.password) == 0) { // check for valid admin password perms = PERM_ACL_ADMIN; } else if (strcmp((char *)data, _prefs.guest_password) == 0) { // check guest password perms = PERM_ACL_GUEST; } else { #if MESH_DEBUG MESH_DEBUG_PRINTLN("Invalid password: %s", data); #endif return 0; } client = acl.putClient(sender, 0); // add to contacts (if not already known) if (sender_timestamp <= client->last_timestamp) { MESH_DEBUG_PRINTLN("Possible login replay attack!"); return 0; // FATAL: client table is full -OR- replay attack } MESH_DEBUG_PRINTLN("Login success!"); client->last_timestamp = sender_timestamp; client->last_activity = getRTCClock()->getCurrentTime(); client->permissions &= ~0x03; client->permissions |= perms; memcpy(client->shared_secret, secret, PUB_KEY_SIZE); if (perms != PERM_ACL_GUEST) { // keep number of FS writes to a minimum dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); } } if (is_flood) { client->out_path_len = OUT_PATH_UNKNOWN; // need to rediscover out_path } uint32_t now = getRTCClock()->getCurrentTimeUnique(); memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp reply_data[4] = RESP_SERVER_LOGIN_OK; reply_data[5] = 0; // Legacy: was recommended keep-alive interval (secs / 16) reply_data[6] = client->isAdmin() ? 1 : 0; reply_data[7] = client->permissions; getRNG()->random(&reply_data[8], 4); // random blob to help packet-hash uniqueness reply_data[12] = FIRMWARE_VER_LEVEL; // New field return 13; // reply length } uint8_t MyMesh::handleAnonRegionsReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) { if (anon_limiter.allow(rtc_clock.getCurrentTime())) { // request data has: {reply-path-len}{reply-path} reply_path_len = *data & 63; reply_path_hash_size = (*data >> 6) + 1; data++; memcpy(reply_path, data, ((uint8_t)reply_path_len) * reply_path_hash_size); // data += (uint8_t)reply_path_len * reply_path_hash_size; memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness) return 8 + region_map.exportNamesTo((char *) &reply_data[8], sizeof(reply_data) - 12, REGION_DENY_FLOOD); // reply length } return 0; } uint8_t MyMesh::handleAnonOwnerReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) { if (anon_limiter.allow(rtc_clock.getCurrentTime())) { // request data has: {reply-path-len}{reply-path} reply_path_len = *data & 63; reply_path_hash_size = (*data >> 6) + 1; data++; memcpy(reply_path, data, ((uint8_t)reply_path_len) * reply_path_hash_size); // data += (uint8_t)reply_path_len * reply_path_hash_size; memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness) sprintf((char *) &reply_data[8], "%s\n%s", _prefs.node_name, _prefs.owner_info); return 8 + strlen((char *) &reply_data[8]); // reply length } return 0; } uint8_t MyMesh::handleAnonClockReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) { if (anon_limiter.allow(rtc_clock.getCurrentTime())) { // request data has: {reply-path-len}{reply-path} reply_path_len = *data & 63; reply_path_hash_size = (*data >> 6) + 1; data++; memcpy(reply_path, data, ((uint8_t)reply_path_len) * reply_path_hash_size); // data += (uint8_t)reply_path_len * reply_path_hash_size; memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag uint32_t now = getRTCClock()->getCurrentTime(); memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness) reply_data[8] = 0; // features #ifdef WITH_RS232_BRIDGE reply_data[8] |= 0x01; // is bridge, type UART #elif WITH_ESPNOW_BRIDGE reply_data[8] |= 0x03; // is bridge, type ESP-NOW #endif if (_prefs.disable_fwd) { // is this repeater currently disabled reply_data[8] |= 0x80; // is disabled } // TODO: add some kind of moving-window utilisation metric, so can query 'how busy' is this repeater return 9; // reply length } return 0; } int MyMesh::handleRequest(ClientInfo *sender, uint32_t sender_timestamp, uint8_t *payload, size_t payload_len) { // uint32_t now = getRTCClock()->getCurrentTimeUnique(); // memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp memcpy(reply_data, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag') if (payload[0] == REQ_TYPE_GET_STATUS) { // guests can also access this now RepeaterStats stats; stats.batt_milli_volts = board.getBattMilliVolts(); stats.curr_tx_queue_len = _mgr->getOutboundTotal(); stats.noise_floor = (int16_t)_radio->getNoiseFloor(); stats.last_rssi = (int16_t)radio_driver.getLastRSSI(); stats.n_packets_recv = radio_driver.getPacketsRecv(); stats.n_packets_sent = radio_driver.getPacketsSent(); stats.total_air_time_secs = getTotalAirTime() / 1000; stats.total_up_time_secs = uptime_millis / 1000; stats.n_sent_flood = getNumSentFlood(); stats.n_sent_direct = getNumSentDirect(); stats.n_recv_flood = getNumRecvFlood(); stats.n_recv_direct = getNumRecvDirect(); stats.err_events = _err_flags; stats.last_snr = (int16_t)(radio_driver.getLastSNR() * 4); stats.n_direct_dups = ((SimpleMeshTables *)getTables())->getNumDirectDups(); stats.n_flood_dups = ((SimpleMeshTables *)getTables())->getNumFloodDups(); stats.total_rx_air_time_secs = getReceiveAirTime() / 1000; stats.n_recv_errors = radio_driver.getPacketsRecvErrors(); memcpy(&reply_data[4], &stats, sizeof(stats)); return 4 + sizeof(stats); // reply_len } if (payload[0] == REQ_TYPE_GET_TELEMETRY_DATA) { uint8_t perm_mask = ~(payload[1]); // NEW: first reserved byte (of 4), is now inverse mask to apply to permissions telemetry.reset(); telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f); // query other sensors -- target specific if ((sender->permissions & PERM_ACL_ROLE_MASK) == PERM_ACL_GUEST) { perm_mask = 0x00; // just base telemetry allowed } sensors.querySensors(perm_mask, telemetry); // This default temperature will be overridden by external sensors (if any) float temperature = board.getMCUTemperature(); if(!isnan(temperature)) { // Supported boards with built-in temperature sensor. ESP32-C3 may return NAN telemetry.addTemperature(TELEM_CHANNEL_SELF, temperature); // Built-in MCU Temperature } uint8_t tlen = telemetry.getSize(); memcpy(&reply_data[4], telemetry.getBuffer(), tlen); return 4 + tlen; // reply_len } if (payload[0] == REQ_TYPE_GET_ACCESS_LIST && sender->isAdmin()) { uint8_t res1 = payload[1]; // reserved for future (extra query params) uint8_t res2 = payload[2]; if (res1 == 0 && res2 == 0) { uint8_t ofs = 4; for (int i = 0; i < acl.getNumClients() && ofs + 7 <= sizeof(reply_data) - 4; i++) { auto c = acl.getClientByIdx(i); if (c->permissions == 0) continue; // skip deleted entries memcpy(&reply_data[ofs], c->id.pub_key, 6); ofs += 6; // just 6-byte pub_key prefix reply_data[ofs++] = c->permissions; } return ofs; } } if (payload[0] == REQ_TYPE_GET_NEIGHBOURS) { uint8_t request_version = payload[1]; if (request_version == 0) { // reply data offset (after response sender_timestamp/tag) int reply_offset = 4; // get request params uint8_t count = payload[2]; // how many neighbours to fetch (0-255) uint16_t offset; memcpy(&offset, &payload[3], 2); // offset from start of neighbours list (0-65535) uint8_t order_by = payload[5]; // how to order neighbours. 0=newest_to_oldest, 1=oldest_to_newest, 2=strongest_to_weakest, 3=weakest_to_strongest uint8_t pubkey_prefix_length = payload[6]; // how many bytes of neighbour pub key we want // we also send a 4 byte random blob in payload[7...10] to help packet uniqueness MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS count=%d, offset=%d, order_by=%d, pubkey_prefix_length=%d", count, offset, order_by, pubkey_prefix_length); // clamp pub key prefix length to max pub key length if(pubkey_prefix_length > PUB_KEY_SIZE){ pubkey_prefix_length = PUB_KEY_SIZE; MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS invalid pubkey_prefix_length=%d clamping to %d", pubkey_prefix_length, PUB_KEY_SIZE); } // create copy of neighbours list, skipping empty entries so we can sort it separately from main list int16_t neighbours_count = 0; #if MAX_NEIGHBOURS NeighbourInfo* sorted_neighbours[MAX_NEIGHBOURS]; for (int i = 0; i < MAX_NEIGHBOURS; i++) { auto neighbour = &neighbours[i]; if (neighbour->heard_timestamp > 0) { sorted_neighbours[neighbours_count] = neighbour; neighbours_count++; } } // sort neighbours based on order if (order_by == 0) { // sort by newest to oldest MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting newest to oldest"); std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) { return a->heard_timestamp > b->heard_timestamp; // desc }); } else if (order_by == 1) { // sort by oldest to newest MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting oldest to newest"); std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) { return a->heard_timestamp < b->heard_timestamp; // asc }); } else if (order_by == 2) { // sort by strongest to weakest MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting strongest to weakest"); std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) { return a->snr > b->snr; // desc }); } else if (order_by == 3) { // sort by weakest to strongest MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting weakest to strongest"); std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) { return a->snr < b->snr; // asc }); } #endif // build results buffer int results_count = 0; int results_offset = 0; uint8_t results_buffer[130]; for(int index = 0; index < count && index + offset < neighbours_count; index++){ // stop if we can't fit another entry in results int entry_size = pubkey_prefix_length + 4 + 1; if(results_offset + entry_size > sizeof(results_buffer)){ MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS no more entries can fit in results buffer"); break; } #if MAX_NEIGHBOURS // add next neighbour to results auto neighbour = sorted_neighbours[index + offset]; uint32_t heard_seconds_ago = getRTCClock()->getCurrentTime() - neighbour->heard_timestamp; memcpy(&results_buffer[results_offset], neighbour->id.pub_key, pubkey_prefix_length); results_offset += pubkey_prefix_length; memcpy(&results_buffer[results_offset], &heard_seconds_ago, 4); results_offset += 4; memcpy(&results_buffer[results_offset], &neighbour->snr, 1); results_offset += 1; results_count++; #endif } // build reply MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS neighbours_count=%d results_count=%d", neighbours_count, results_count); memcpy(&reply_data[reply_offset], &neighbours_count, 2); reply_offset += 2; memcpy(&reply_data[reply_offset], &results_count, 2); reply_offset += 2; memcpy(&reply_data[reply_offset], &results_buffer, results_offset); reply_offset += results_offset; return reply_offset; } } else if (payload[0] == REQ_TYPE_GET_OWNER_INFO) { sprintf((char *) &reply_data[4], "%s\n%s\n%s", FIRMWARE_VERSION, _prefs.node_name, _prefs.owner_info); return 4 + strlen((char *) &reply_data[4]); } return 0; // unknown command } mesh::Packet *MyMesh::createSelfAdvert() { uint8_t app_data[MAX_ADVERT_DATA_SIZE]; uint8_t app_data_len = _cli.buildAdvertData(ADV_TYPE_REPEATER, app_data); return createAdvert(self_id, app_data, app_data_len); } File MyMesh::openAppend(const char *fname) { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) return _fs->open(fname, FILE_O_WRITE); #elif defined(RP2040_PLATFORM) return _fs->open(fname, "a"); #else return _fs->open(fname, "a", true); #endif } static uint8_t max_loop_minimal[] = { 0, /* 1-byte */ 4, /* 2-byte */ 2, /* 3-byte */ 1 }; static uint8_t max_loop_moderate[] = { 0, /* 1-byte */ 2, /* 2-byte */ 1, /* 3-byte */ 1 }; static uint8_t max_loop_strict[] = { 0, /* 1-byte */ 1, /* 2-byte */ 1, /* 3-byte */ 1 }; // SF5..SF12 receive floors, scaled by 4 so we can keep the retry gate in int8_t quarter-dB units. static const int8_t direct_retry_floor_x4[] = { -10, -20, -30, -40, -50, -60, -70, -80 }; bool MyMesh::isLooped(const mesh::Packet* packet, const uint8_t max_counters[]) { uint8_t hash_size = packet->getPathHashSize(); uint8_t hash_count = packet->getPathHashCount(); uint8_t n = 0; const uint8_t* path = packet->path; while (hash_count > 0) { // count how many times this node is already in the path if (self_id.isHashMatch(path, hash_size)) n++; hash_count--; path += hash_size; } return n >= max_counters[hash_size]; } void MyMesh::sendFloodReply(mesh::Packet* packet, unsigned long delay_millis, uint8_t path_hash_size) { if (recv_pkt_region && !recv_pkt_region->isWildcard()) { // if _request_ packet scope is known, send reply with same scope TransportKey scope; if (region_map.getTransportKeysFor(*recv_pkt_region, &scope, 1) > 0) { sendFloodScoped(scope, packet, delay_millis, path_hash_size); } else { sendFlood(packet, delay_millis, path_hash_size); // send un-scoped } } else { sendFlood(packet, delay_millis, path_hash_size); // send un-scoped } } static bool pathsEqual(const uint8_t* a, uint8_t a_len, const uint8_t* b, uint8_t b_len) { if (a == NULL || b == NULL || a_len != b_len || !mesh::Packet::isValidPathLen(a_len)) return false; uint8_t hash_count = a_len & 63; uint8_t hash_size = (a_len >> 6) + 1; return memcmp(a, b, hash_count * hash_size) == 0; } static bool hasUsablePath(const uint8_t* path, uint8_t path_len) { return path != NULL && mesh::Packet::isValidPathLen(path_len); } static bool buildRepeatersChannel(mesh::GroupChannel& channel) { const char* hex = REPEATERS_CHANNEL_KEY_HEX; size_t hex_len = strlen(hex); if (!(hex_len == 32 || hex_len == 64)) return false; for (size_t i = 0; i < hex_len; i++) { if (!mesh::Utils::isHexChar(hex[i])) return false; } memset(channel.secret, 0, sizeof(channel.secret)); size_t key_len = hex_len / 2; if (!mesh::Utils::fromHex(channel.secret, key_len, hex)) return false; mesh::Utils::sha256(channel.hash, sizeof(channel.hash), channel.secret, key_len); return true; } static uint8_t batteryPercentFromMilliVolts(uint16_t batt_mv) { const int min_mv = BATT_MIN_MILLIVOLTS; const int max_mv = BATT_MAX_MILLIVOLTS; if (max_mv <= min_mv) return 100; int pct = (((int)batt_mv - min_mv) * 100) / (max_mv - min_mv); if (pct < 0) return 0; if (pct > 100) return 100; return (uint8_t)pct; } static bool parseBatteryAlertPercent(const char* value, uint8_t min_value, uint8_t max_value, uint8_t& result) { if (value == NULL || *value == 0) { return false; } uint16_t parsed = 0; while (*value) { if (*value < '0' || *value > '9') { return false; } parsed = (uint16_t)(parsed * 10 + (*value - '0')); if (parsed > max_value) { return false; } value++; } if (parsed < min_value) { return false; } result = (uint8_t)parsed; return true; } mesh::Packet* MyMesh::createPacketCopy(const mesh::Packet* packet, const char* caller) { if (packet == NULL) return NULL; mesh::Packet* copy = obtainNewPacket(); if (copy == NULL) { MESH_DEBUG_PRINTLN("%s %s: error, packet pool empty", getLogDateTime(), caller); return NULL; } *copy = *packet; return copy; } mesh::Packet* MyMesh::createAltPathCopy(const mesh::Packet* packet, const uint8_t* primary_path, uint8_t primary_path_len, const uint8_t* alt_path, uint8_t alt_path_len) { if (!hasUsablePath(alt_path, alt_path_len)) return NULL; if (hasUsablePath(primary_path, primary_path_len) && pathsEqual(primary_path, primary_path_len, alt_path, alt_path_len)) { return NULL; } return createPacketCopy(packet, "MyMesh::createAltPathCopy()"); } void MyMesh::sendFloodReplyWithAltPath(mesh::Packet* packet, const uint8_t* direct_path, uint8_t direct_path_len, const uint8_t* alt_path, uint8_t alt_path_len, unsigned long delay_millis, uint8_t path_hash_size) { mesh::Packet* direct = hasUsablePath(direct_path, direct_path_len) ? createPacketCopy(packet, "MyMesh::sendFloodReplyWithAltPath(direct)") : NULL; mesh::Packet* alt = createAltPathCopy(packet, direct_path, direct_path_len, alt_path, alt_path_len); sendFloodReply(packet, delay_millis, path_hash_size); if (direct) sendDirect(direct, direct_path, direct_path_len, delay_millis); if (alt) sendDirect(alt, alt_path, alt_path_len, delay_millis); } void MyMesh::sendDirectWithAltPath(mesh::Packet* packet, const uint8_t* path, uint8_t path_len, const uint8_t* alt_path, uint8_t alt_path_len, uint32_t delay_millis) { mesh::Packet* alt = createAltPathCopy(packet, path, path_len, alt_path, alt_path_len); sendDirect(packet, path, path_len, delay_millis); if (alt) sendDirect(alt, alt_path, alt_path_len, delay_millis); } bool MyMesh::allowPacketForward(const mesh::Packet *packet) { if (_prefs.disable_fwd) return false; if (packet->isRouteDirect() && packet->getPayloadType() == PAYLOAD_TYPE_TRACE && packet->payload_len >= 9) { auto* tables = (SimpleMeshTables *)getTables(); uint8_t route_bytes = packet->payload_len - 9; uint8_t hash_size = decodeTraceHashSize(packet->payload[8], route_bytes); uint16_t offset = (uint16_t)packet->path_len * (uint16_t)hash_size; uint8_t sf = constrain(active_sf, (uint8_t)5, (uint8_t)12); int16_t fallback_snr_x4 = direct_retry_floor_x4[sf - 5] + 40; // fixed +10 dB above SF floor // A successful TRACE forward reveals the downstream next-hop hash. Seed/update the recent table immediately. if (hash_size > 0 && offset + (2U * hash_size) <= route_bytes) { uint8_t prefix_len = hash_size; if (prefix_len > MAX_ROUTE_HASH_BYTES) { prefix_len = MAX_ROUTE_HASH_BYTES; } const uint8_t* next_hop_prefix = &packet->payload[9 + offset + hash_size]; const auto* existing = tables->findRecentRepeaterByHash(next_hop_prefix, prefix_len); // This point only proves we can forward TO next_hop; packet->_snr is upstream RX and not a // trustworthy metric for next_hop. Seed with existing table value or fallback only. int8_t trace_snr_x4 = (existing != NULL) ? existing->snr_x4 : (int8_t)constrain(fallback_snr_x4, -128, 127); tables->setRecentRepeater(next_hop_prefix, prefix_len, trace_snr_x4, false, true); } } if (packet->isRouteFlood()) { if (packet->getPathHashCount() >= _prefs.flood_max) return false; if (packet->getRouteType() == ROUTE_TYPE_FLOOD && packet->getPathHashCount() >= _prefs.flood_max_unscoped) return false; if (packet->getPayloadType() == PAYLOAD_TYPE_ADVERT && packet->getPathHashCount() >= _prefs.flood_max_advert) return false; } if (packet->isRouteFlood() && packet->getPathHashCount() >= _prefs.flood_max) return false; if (packet->isRouteFlood() && recv_pkt_region == NULL) { MESH_DEBUG_PRINTLN("allowPacketForward: unknown transport code, or wildcard not allowed for FLOOD packet"); return false; } if (packet->isRouteFlood() && _prefs.loop_detect != LOOP_DETECT_OFF) { const uint8_t* maximums; if (_prefs.loop_detect == LOOP_DETECT_MINIMAL) { maximums = max_loop_minimal; } else if (_prefs.loop_detect == LOOP_DETECT_MODERATE) { maximums = max_loop_moderate; } else { maximums = max_loop_strict; } if (isLooped(packet, maximums)) { MESH_DEBUG_PRINTLN("allowPacketForward: FLOOD packet loop detected!"); return false; } } return true; } const char *MyMesh::getLogDateTime() { static char tmp[32]; uint32_t now = getRTCClock()->getCurrentTime(); DateTime dt = DateTime(now); sprintf(tmp, "%02d:%02d:%02d - %d/%d/%d U", dt.hour(), dt.minute(), dt.second(), dt.day(), dt.month(), dt.year()); return tmp; } void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) { #if MESH_PACKET_LOGGING Serial.print(getLogDateTime()); Serial.print(" RAW: "); mesh::Utils::printHex(Serial, raw, len); Serial.println(); #endif } void MyMesh::logRx(mesh::Packet *pkt, int len, float score) { #ifdef WITH_BRIDGE if (_prefs.bridge_pkt_src == 1) { bridge.sendPacket(pkt); } #endif if (_logging) { File f = openAppend(PACKET_LOG_FILE); if (f) { f.print(getLogDateTime()); f.printf(": RX, len=%d (type=%d, route=%s, payload_len=%d) SNR=%d RSSI=%d score=%d", len, pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len, (int)_radio->getLastSNR(), (int)_radio->getLastRSSI(), (int)(score * 1000)); if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ || pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) { f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]); } else { f.printf("\n"); } f.close(); } } } void MyMesh::logTx(mesh::Packet *pkt, int len) { #ifdef WITH_BRIDGE if (_prefs.bridge_pkt_src == 0) { bridge.sendPacket(pkt); } #endif if (_logging) { File f = openAppend(PACKET_LOG_FILE); if (f) { f.print(getLogDateTime()); f.printf(": TX, len=%d (type=%d, route=%s, payload_len=%d)", len, pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len); if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ || pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) { f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]); } else { f.printf("\n"); } f.close(); } } } void MyMesh::logTxFail(mesh::Packet *pkt, int len) { if (_logging) { File f = openAppend(PACKET_LOG_FILE); if (f) { f.print(getLogDateTime()); f.printf(": TX FAIL!, len=%d (type=%d, route=%s, payload_len=%d)\n", len, pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len); f.close(); } } } void MyMesh::onDirectRetryEvent(const char* event, const mesh::Packet* packet, uint32_t delay_millis, uint8_t retry_attempt) { if (packet == NULL) { return; } if (strcmp(event, "failure") == 0) { return; } uint8_t prefix[MAX_ROUTE_HASH_BYTES] = {0}; uint8_t prefix_len = 0; bool has_prefix = extractDirectRetryPrefix(packet, prefix, prefix_len); auto* tables = (SimpleMeshTables *)getTables(); const auto* existing = has_prefix ? tables->findRecentRepeaterByHash(prefix, prefix_len) : NULL; char next_hop_hex[(MAX_ROUTE_HASH_BYTES * 2) + 1] = {0}; if (has_prefix && prefix_len > 0) { mesh::Utils::toHex(next_hop_hex, prefix, prefix_len); } const char* next_hop = (has_prefix && prefix_len > 0) ? next_hop_hex : "unknown"; char hop_text[24]; if (packet->isRouteDirect() && packet->getPayloadType() == PAYLOAD_TYPE_TRACE && packet->payload_len >= 9) { uint8_t route_bytes = packet->payload_len - 9; uint8_t hash_size = decodeTraceHashSize(packet->payload[8], route_bytes); uint8_t total_hops = (hash_size > 0) ? (route_bytes / hash_size) : 0; if (total_hops > 0) { snprintf(hop_text, sizeof(hop_text), "%u/%u", (unsigned int)packet->path_len, (unsigned int)total_hops); } else { snprintf(hop_text, sizeof(hop_text), "unknown"); } } else if (packet->isRouteDirect()) { snprintf(hop_text, sizeof(hop_text), "remaining:%u", (unsigned int)packet->getPathHashCount()); } else { snprintf(hop_text, sizeof(hop_text), "unknown"); } // Direct-retry events are TX-side and usually have no trustworthy RX SNR. // Cap event SNR at fixed SF floor + 10 dB so trace-start retries can't inflate table SNR. uint8_t sf = constrain(active_sf, (uint8_t)5, (uint8_t)12); int16_t fallback_snr_x4_raw = direct_retry_floor_x4[sf - 5] + 40; int8_t fallback_snr_x4 = (int8_t)constrain(fallback_snr_x4_raw, -128, 127); bool is_success_event = strcmp(event, "good") == 0; bool updates_quality = strcmp(event, "good") == 0; int8_t retry_event_snr_x4; if (is_success_event) { // On success, Mesh.cpp injects echo RX SNR for the downstream retry target. retry_event_snr_x4 = packet->_snr; } else if (existing != NULL) { retry_event_snr_x4 = existing->snr_x4; } else { retry_event_snr_x4 = fallback_snr_x4; } char snr_pkt_text[12]; char snr_table_text[12]; if (has_prefix && updates_quality) { // Refresh SNR only once per successful echo/progress event, not on queued/resent bookkeeping. tables->setRecentRepeater(prefix, prefix_len, retry_event_snr_x4, false, true); } if (strcmp(event, "failed_all_tries") == 0) { if (has_prefix) { if (existing == NULL) { int16_t seed_snr_x4 = (int16_t)getDirectRetryMinSNRX4() + 10; // +2.5 dB over the active retry cutoff. tables->setRecentRepeater(prefix, prefix_len, (int8_t)constrain(seed_snr_x4, -128, 127), false, true); } // SNR is stored in quarter-dB units, so 1 lowers quality by 0.25 dB. tables->decrementRecentRepeaterSnrX4(prefix, prefix_len, 1); } } snprintf(snr_pkt_text, sizeof(snr_pkt_text), "%s", StrHelper::ftoa(((float)packet->_snr) / 4.0f)); const auto* log_existing = has_prefix ? tables->findRecentRepeaterByHash(prefix, prefix_len) : NULL; if (log_existing != NULL) { snprintf(snr_table_text, sizeof(snr_table_text), "%s", StrHelper::ftoa(((float)log_existing->snr_x4) / 4.0f)); } else { snprintf(snr_table_text, sizeof(snr_table_text), "na"); } const char* time_label = "time_ms"; if (strcmp(event, "queued") == 0 || strcmp(event, "dropped_queue_full") == 0) { time_label = "wait_ms"; } else if (strcmp(event, "resent") == 0 || strcmp(event, "failed_all_tries") == 0 || strcmp(event, "failure") == 0) { time_label = "elapsed_ms"; } else if (strcmp(event, "good") == 0) { time_label = "echo_ms"; } uint8_t log_cr = (packet->tx_cr >= 4 && packet->tx_cr <= 8) ? packet->tx_cr : active_cr; MESH_DEBUG_PRINTLN("%s direct retry %s (retry=%u, type=%d, route=%s, payload_len=%d, hop=%s, next_hop=%s, pkt=%s, tbl=%s, cr=%u, %s=%lu)", getLogDateTime(), event, (unsigned int)retry_attempt, (uint32_t)packet->getPayloadType(), packet->isRouteDirect() ? "D" : "F", (uint32_t)packet->payload_len, hop_text, next_hop, snr_pkt_text, snr_table_text, (unsigned int)log_cr, time_label, (unsigned long)delay_millis); if (_logging) { File f = openAppend(PACKET_LOG_FILE); if (f) { f.print(getLogDateTime()); f.printf(": DIRECT RETRY %s (retry=%u, type=%d, route=%s, payload_len=%d, hop=%s, next_hop=%s, pkt=%s, tbl=%s, cr=%u, %s=%lu)\n", event, (unsigned int)retry_attempt, (uint32_t)packet->getPayloadType(), packet->isRouteDirect() ? "D" : "F", (uint32_t)packet->payload_len, hop_text, next_hop, snr_pkt_text, snr_table_text, (unsigned int)log_cr, time_label, (unsigned long)delay_millis); f.close(); } } } 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); } uint32_t MyMesh::getRetransmitDelay(const mesh::Packet *packet) { uint32_t t = (_radio->getEstAirtimeFor(packet->getPathByteLen() + packet->payload_len + 2) * _prefs.tx_delay_factor); return getRNG()->nextInt(0, 5*t + 1); } uint32_t MyMesh::getDirectRetransmitDelay(const mesh::Packet *packet) { uint32_t t = (_radio->getEstAirtimeFor(packet->getPathByteLen() + packet->payload_len + 2) * _prefs.direct_tx_delay_factor); return getRNG()->nextInt(0, 5*t + 1); } int8_t MyMesh::getDirectRetryMinSNRX4() const { // Use the live SF so `tempradio` changes immediately affect the retry threshold. uint8_t sf = constrain(active_sf, (uint8_t)5, (uint8_t)12); int16_t margin_x4 = (int16_t)_prefs.direct_retry_snr_margin_db; int16_t threshold = direct_retry_floor_x4[sf - 5] + margin_x4; return (int8_t)constrain(threshold, -128, 127); } bool MyMesh::extractDirectRetryPrefix(const mesh::Packet* packet, uint8_t* prefix, uint8_t& prefix_len) const { if (packet == NULL || prefix == NULL) { return false; } // TRACE direct routes encode repeater hashes in payload; packet->path carries SNR trail bytes. if (packet->isRouteDirect() && packet->getPayloadType() == PAYLOAD_TYPE_TRACE && packet->payload_len >= 9) { uint8_t route_bytes = packet->payload_len - 9; uint8_t hash_size = decodeTraceHashSize(packet->payload[8], route_bytes); uint16_t offset = (uint16_t)packet->path_len * (uint16_t)hash_size; if (hash_size > 0 && offset + hash_size <= route_bytes) { prefix_len = hash_size; if (prefix_len > MAX_ROUTE_HASH_BYTES) { prefix_len = MAX_ROUTE_HASH_BYTES; } memcpy(prefix, &packet->payload[9 + offset], prefix_len); return true; } } if (packet->isRouteDirect() && packet->getPathHashCount() > 0) { prefix_len = packet->getPathHashSize(); if (prefix_len > MAX_ROUTE_HASH_BYTES) { prefix_len = MAX_ROUTE_HASH_BYTES; } if (prefix_len == 0) { return false; } memcpy(prefix, packet->path, prefix_len); return true; } return false; } bool MyMesh::allowDirectRetry(const mesh::Packet* packet, const uint8_t* next_hop_hash, uint8_t next_hop_hash_len) const { if (_prefs.disable_fwd) { return false; } int8_t min_snr_x4 = getDirectRetryMinSNRX4(); if (_prefs.direct_retry_recent_enabled) { const auto* recent = ((const SimpleMeshTables *)getTables())->findRecentRepeaterByHash(next_hop_hash, next_hop_hash_len); return recent == NULL || recent->snr_x4 >= min_snr_x4; } return true; } bool MyMesh::maybeShortCircuitDirect(mesh::Packet* packet) { if (packet == NULL || !packet->isRouteDirect() || packet->getPayloadType() == PAYLOAD_TYPE_TRACE) { return false; } uint8_t hash_count = packet->getPathHashCount(); uint8_t hash_size = packet->getPathHashSize(); if (hash_count < 2 || hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return false; } // Normal direct forwarding handles the first path entry. Short-circuit only when we are later in the route. int self_idx = -1; for (uint8_t i = 1; i < hash_count; i++) { if (self_id.isHashMatch(&packet->path[i * hash_size], hash_size)) { self_idx = i; break; } } if (self_idx < 0) { return false; } const SimpleMeshTables* tables = (const SimpleMeshTables*)getTables(); bool adjacent_recent = false; if (self_idx > 0 && tables->findRecentRepeaterByHash(&packet->path[(self_idx - 1) * hash_size], hash_size) != NULL) { adjacent_recent = true; } if (!adjacent_recent && self_idx + 1 < hash_count && tables->findRecentRepeaterByHash(&packet->path[(self_idx + 1) * hash_size], hash_size) != NULL) { adjacent_recent = true; } if (!adjacent_recent) { return false; } uint8_t remaining = hash_count - (uint8_t)self_idx; memmove(packet->path, &packet->path[self_idx * hash_size], remaining * hash_size); packet->setPathHashCount(remaining); MESH_DEBUG_PRINTLN("%s direct short-circuit (type=%d, original_hop=%d, remaining_hops=%d)", getLogDateTime(), (uint32_t)packet->getPayloadType(), self_idx + 1, (uint32_t)remaining); return true; } uint8_t MyMesh::getDirectRetryCodingRateForSNR(int8_t snr_x4) const { if (_prefs.direct_retry_cr4_snr_x4 == 0 && _prefs.direct_retry_cr5_snr_x4 == 0 && _prefs.direct_retry_cr7_snr_x4 == 0 && _prefs.direct_retry_cr8_snr_x4 == 0) { return 0; } if (snr_x4 >= _prefs.direct_retry_cr4_snr_x4) { return 4; } if (snr_x4 >= _prefs.direct_retry_cr5_snr_x4) { return 5; } if (snr_x4 <= _prefs.direct_retry_cr8_snr_x4) { return 8; } if (snr_x4 >= _prefs.direct_retry_cr7_snr_x4) { return 7; } return 7; } void MyMesh::configureDirectRetryPacket(mesh::Packet* retry, const mesh::Packet* original, uint8_t retry_attempt) { (void) original; if (retry == NULL || !retry->isRouteDirect()) { return; } switch (retry->getPayloadType()) { case PAYLOAD_TYPE_ACK: case PAYLOAD_TYPE_PATH: case PAYLOAD_TYPE_REQ: case PAYLOAD_TYPE_RESPONSE: case PAYLOAD_TYPE_TXT_MSG: case PAYLOAD_TYPE_ANON_REQ: case PAYLOAD_TYPE_TRACE: case PAYLOAD_TYPE_MULTIPART: break; default: return; } uint8_t prefix[MAX_ROUTE_HASH_BYTES]; uint8_t prefix_len = 0; if (!extractDirectRetryPrefix(retry, prefix, prefix_len)) { return; } if (_prefs.direct_retry_cr4_snr_x4 == 0 && _prefs.direct_retry_cr5_snr_x4 == 0 && _prefs.direct_retry_cr7_snr_x4 == 0 && _prefs.direct_retry_cr8_snr_x4 == 0) { return; } const auto* recent = ((const SimpleMeshTables *)getTables())->findRecentRepeaterByHash(prefix, prefix_len); uint8_t retry_cr = (recent != NULL) ? getDirectRetryCodingRateForSNR(recent->snr_x4) : 5; if (retry_cr == 4 && retry_attempt > 3) { retry_cr = 5; } if (retry_cr >= 4 && retry_cr <= 8 && retry_cr != 6 && retry_cr != active_cr) { retry->tx_cr = retry_cr; } } uint8_t MyMesh::getDirectRetryPreset() const { if (_prefs.retry_preset <= RETRY_PRESET_MOBILE) { return _prefs.retry_preset; } return RETRY_PRESET_ROOFTOP; } uint8_t MyMesh::getDirectRetryConfiguredMaxAttempts() const { return constrain(_prefs.direct_retry_attempts, (uint8_t)1, (uint8_t)15); } uint32_t MyMesh::getDirectRetryAttemptStepMillis() const { return constrain((uint32_t)_prefs.direct_retry_step_ms, (uint32_t)0, (uint32_t)5000); } bool MyMesh::hasFloodRetryPrefixes() const { for (int i = 0; i < FLOOD_RETRY_PREFIX_SLOTS; i++) { const uint8_t* configured = _prefs.flood_retry_prefixes[i]; if (configured[0] != 0 || configured[1] != 0 || configured[2] != 0) { return true; } } return false; } bool MyMesh::floodRetryLastHopMatches(const mesh::Packet* packet) const { if (packet == NULL || packet->getPathHashCount() == 0) { return false; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return false; } const uint8_t* heard_prefix = &packet->path[(packet->getPathHashCount() - 1) * hash_size]; for (int i = 0; i < FLOOD_RETRY_PREFIX_SLOTS; i++) { const uint8_t* configured = _prefs.flood_retry_prefixes[i]; if ((configured[0] != 0 || configured[1] != 0 || configured[2] != 0) && memcmp(configured, heard_prefix, hash_size) == 0) { return true; } } return false; } bool MyMesh::floodRetryPrefixMatches(const mesh::Packet* packet) const { if (packet == NULL || packet->getPathHashCount() == 0) { return false; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return false; } const uint8_t* path = packet->path; for (int hop = 0; hop < packet->getPathHashCount(); hop++) { for (int i = 0; i < FLOOD_RETRY_PREFIX_SLOTS; i++) { const uint8_t* configured = _prefs.flood_retry_prefixes[i]; if ((configured[0] != 0 || configured[1] != 0 || configured[2] != 0) && memcmp(configured, path, hash_size) == 0) { return true; } } path += hash_size; } return false; } bool MyMesh::floodRetryPrefixIgnored(const uint8_t* prefix, uint8_t prefix_len) const { if (prefix == NULL || prefix_len == 0 || prefix_len > MAX_ROUTE_HASH_BYTES) { return false; } for (int i = 0; i < FLOOD_RETRY_IGNORE_PREFIXES; i++) { const uint8_t* ignored = _prefs.flood_retry_ignore_prefixes[i]; if ((ignored[0] != 0 || ignored[1] != 0 || ignored[2] != 0) && memcmp(ignored, prefix, prefix_len) == 0) { return true; } } return false; } uint8_t MyMesh::floodRetryEffectivePathLength(const mesh::Packet* packet, uint8_t max_hops) const { if (packet == NULL || !packet->isRouteFlood() || packet->getPathHashCount() == 0) { return 0; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return packet->getPathHashCount(); } uint8_t hop_count = packet->getPathHashCount(); if (max_hops < hop_count) { hop_count = max_hops; } uint8_t effective_len = 0; const uint8_t* path = packet->path; for (uint8_t hop = 0; hop < hop_count; hop++) { if (!floodRetryPrefixIgnored(path, hash_size)) { effective_len++; } path += hash_size; } return effective_len; } bool MyMesh::floodRetryPrefixFresh(const uint8_t* prefix, uint8_t prefix_len) const { const auto* recent = ((const SimpleMeshTables *)getTables())->findRecentRepeaterByHash(prefix, prefix_len); if (recent == NULL || recent->last_heard_millis == 0) { return false; } return (uint32_t)(millis() - recent->last_heard_millis) <= 3600000UL; } static const uint8_t FLOOD_RETRY_BRIDGE_OTHER_BUCKET = FLOOD_RETRY_BRIDGE_BUCKETS; static uint8_t floodRetryBucketMask(uint8_t bucket) { if (bucket >= 8) { return 0; } return (uint8_t)(1U << bucket); } int MyMesh::floodRetryBucketForPrefix(const uint8_t* prefix, uint8_t prefix_len, bool require_fresh, bool include_other) const { if (prefix == NULL || prefix_len == 0 || prefix_len > MAX_ROUTE_HASH_BYTES) { return -1; } if (floodRetryPrefixIgnored(prefix, prefix_len)) { return -1; } if (require_fresh && !floodRetryPrefixFresh(prefix, prefix_len)) { return -1; } for (int bucket = 0; bucket < FLOOD_RETRY_BRIDGE_BUCKETS; bucket++) { for (int i = 0; i < FLOOD_RETRY_BUCKET_PREFIXES; i++) { const uint8_t* configured = _prefs.flood_retry_bridge_buckets[bucket][i]; if ((configured[0] != 0 || configured[1] != 0 || configured[2] != 0) && memcmp(configured, prefix, prefix_len) == 0) { return bucket; } } } if (include_other) { return FLOOD_RETRY_BRIDGE_OTHER_BUCKET; } return -1; } int MyMesh::floodRetryBucketForPathHop(const uint8_t* prefix, uint8_t prefix_len, uint8_t hop, uint8_t progress_marker) const { return floodRetryBucketForPrefix(prefix, prefix_len, hop < progress_marker, true); } int MyMesh::floodRetrySourceBucket(const mesh::Packet* packet) const { if (packet == NULL) { return -1; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return -1; } if (packet->getPathHashCount() < 2) { return FLOOD_RETRY_BRIDGE_OTHER_BUCKET; } const uint8_t* source_prefix = &packet->path[(packet->getPathHashCount() - 2) * hash_size]; return floodRetryBucketForPrefix(source_prefix, hash_size, true, true); } uint8_t MyMesh::floodRetryBridgeTargetMask(uint8_t source_bucket) const { uint8_t mask = 0; for (int bucket = 0; bucket < FLOOD_RETRY_BRIDGE_BUCKETS; bucket++) { if (bucket == source_bucket) { continue; } for (int i = 0; i < FLOOD_RETRY_BUCKET_PREFIXES; i++) { const uint8_t* configured = _prefs.flood_retry_bridge_buckets[bucket][i]; if ((configured[0] != 0 || configured[1] != 0 || configured[2] != 0) && !floodRetryPrefixIgnored(configured, FLOOD_RETRY_PREFIX_LEN) && floodRetryPrefixFresh(configured, FLOOD_RETRY_PREFIX_LEN)) { mask |= floodRetryBucketMask((uint8_t)bucket); break; } } } if (source_bucket != FLOOD_RETRY_BRIDGE_OTHER_BUCKET) { mask |= floodRetryBucketMask(FLOOD_RETRY_BRIDGE_OTHER_BUCKET); } return mask; } uint8_t MyMesh::floodRetryBridgeHeardMask(const mesh::Packet* packet, uint8_t source_bucket, uint8_t progress_marker) const { if (packet == NULL || packet->getPathHashCount() == 0) { return 0; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return 0; } uint8_t mask = 0; const uint8_t* path = packet->path; for (int hop = 0; hop < packet->getPathHashCount(); hop++) { if (progress_marker > 0 && hop == progress_marker - 1) { path += hash_size; continue; } int bucket = floodRetryBucketForPathHop(path, hash_size, (uint8_t)hop, progress_marker); if (bucket >= 0 && bucket != source_bucket) { mask |= floodRetryBucketMask((uint8_t)bucket); } path += hash_size; } return mask; } MyMesh::FloodRetryBridgeState* MyMesh::floodRetryBridgeStateFor(const mesh::Packet* packet, bool create) const { if (packet == NULL) { return NULL; } uint8_t key[MAX_HASH_SIZE]; packet->calculatePacketHash(key); FloodRetryBridgeState* free_slot = NULL; for (int i = 0; i < MAX_FLOOD_RETRY_SLOTS; i++) { if (flood_retry_bridge_states[i].active && memcmp(flood_retry_bridge_states[i].key, key, MAX_HASH_SIZE) == 0) { return &flood_retry_bridge_states[i]; } if (!flood_retry_bridge_states[i].active && free_slot == NULL) { free_slot = &flood_retry_bridge_states[i]; } } if (!create) { return NULL; } if (free_slot == NULL) { return NULL; } int source_bucket = floodRetrySourceBucket(packet); if (source_bucket < 0) { return NULL; } uint8_t target_mask = floodRetryBridgeTargetMask((uint8_t)source_bucket); if (target_mask == 0) { return NULL; } uint8_t progress_marker = packet->getPathHashCount(); uint8_t heard_mask = floodRetryBridgeHeardMask(packet, (uint8_t)source_bucket, progress_marker) & target_mask; if ((heard_mask & target_mask) == target_mask) { return NULL; } memset(free_slot, 0, sizeof(*free_slot)); memcpy(free_slot->key, key, sizeof(free_slot->key)); free_slot->source_bucket = (uint8_t)source_bucket; free_slot->target_mask = target_mask; free_slot->heard_mask = heard_mask; free_slot->progress_marker = progress_marker; free_slot->active = true; return free_slot; } uint32_t MyMesh::getDirectRetryEchoDelay(const mesh::Packet* packet) const { uint32_t base_wait_millis = constrain((uint32_t)_prefs.direct_retry_base_ms, (uint32_t)10, (uint32_t)5000); if (packet == NULL) { return base_wait_millis; } // Approximate LoRa line rate in kilobits/sec from the live radio params the repeater is using now. float kbps = (((float) active_sf) * active_bw * ((float) active_cr)) / ((float) (1UL << active_sf)); if (kbps <= 0.0f) { return base_wait_millis; } // Wait roughly long enough for our transmission, the next hop's receive/forward window, and its echo back. uint32_t bits = ((uint32_t) packet->getRawLength()) * 8; uint32_t scaled_wait_millis = (uint32_t) ((((float) bits) * 4.0f) / kbps); return base_wait_millis + scaled_wait_millis; } bool MyMesh::allowFloodRetry(const mesh::Packet* packet) const { if (_prefs.disable_fwd || constrain(_prefs.flood_retry_attempts, (uint8_t)0, (uint8_t)15) == 0) { return false; } if (packet != NULL && packet->getPayloadType() == PAYLOAD_TYPE_ADVERT && !_prefs.flood_retry_advert_enabled) { return false; } if (!_prefs.flood_retry_bridge_enabled) { return true; } FloodRetryBridgeState* state = floodRetryBridgeStateFor(packet, true); if (state == NULL) { return false; } if ((state->heard_mask & state->target_mask) == state->target_mask) { state->active = false; return false; } return true; } void MyMesh::clearFloodRetryBridgeState(const mesh::Packet* packet) { FloodRetryBridgeState* state = floodRetryBridgeStateFor(packet, false); if (state != NULL) { state->active = false; } } void MyMesh::refreshFloodRetryHeardRecent(const mesh::Packet* packet) { if (packet == NULL || !packet->isRouteFlood() || packet->getPathHashCount() == 0) { return; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return; } auto* tables = (SimpleMeshTables*)getTables(); const uint8_t* path = packet->path; if (_prefs.flood_retry_bridge_enabled) { FloodRetryBridgeState* state = floodRetryBridgeStateFor(packet, false); if (state != NULL) { for (int hop = 0; hop < packet->getPathHashCount(); hop++) { if (state->progress_marker > 0 && hop == state->progress_marker - 1) { path += hash_size; continue; } int bucket = floodRetryBucketForPathHop(path, hash_size, (uint8_t)hop, state->progress_marker); uint8_t bucket_mask = bucket >= 0 ? floodRetryBucketMask((uint8_t)bucket) : 0; if (bucket >= 0 && bucket != state->source_bucket && (state->target_mask & bucket_mask)) { tables->setRecentRepeater(path, hash_size, packet->_snr, false, true); } path += hash_size; } return; } } const uint8_t* heard_prefix = &packet->path[(packet->getPathHashCount() - 1) * hash_size]; tables->setRecentRepeater(heard_prefix, hash_size, packet->_snr, false, true); } void MyMesh::formatFloodRetryPath(char* dest, size_t dest_len, const mesh::Packet* packet) const { if (dest == NULL || dest_len == 0) { return; } dest[0] = 0; if (packet == NULL || packet->getPathHashCount() == 0) { StrHelper::strncpy(dest, "-", dest_len); return; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { StrHelper::strncpy(dest, "invalid", dest_len); return; } char* out = dest; size_t remaining = dest_len; const uint8_t* path = packet->path; for (int hop = 0; hop < packet->getPathHashCount(); hop++) { size_t needed = (hop > 0 ? 1 : 0) + ((size_t)hash_size * 2) + 1; if (remaining < needed) { if (remaining > 4) { strcpy(out, "..."); } return; } if (hop > 0) { *out++ = '>'; remaining--; } mesh::Utils::toHex(out, path, hash_size); out += (size_t)hash_size * 2; remaining -= (size_t)hash_size * 2; path += hash_size; } } bool MyMesh::formatFloodRetryHeard(char* dest, size_t dest_len, const mesh::Packet* packet) const { if (dest == NULL || dest_len == 0 || packet == NULL || packet->getPathHashCount() == 0) { return false; } dest[0] = 0; uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return false; } char* out = dest; size_t remaining = dest_len; bool first = true; if (_prefs.flood_retry_bridge_enabled) { FloodRetryBridgeState* state = floodRetryBridgeStateFor(packet, false); if (state == NULL) { return false; } const uint8_t* path = packet->path; for (int hop = 0; hop < packet->getPathHashCount(); hop++) { if (state->progress_marker > 0 && hop == state->progress_marker - 1) { path += hash_size; continue; } int bucket = floodRetryBucketForPathHop(path, hash_size, (uint8_t)hop, state->progress_marker); uint8_t bucket_mask = bucket >= 0 ? floodRetryBucketMask((uint8_t)bucket) : 0; if (bucket >= 0 && bucket != state->source_bucket && (state->target_mask & bucket_mask)) { char bucket_label[8]; if ((uint8_t)bucket == FLOOD_RETRY_BRIDGE_OTHER_BUCKET) { strcpy(bucket_label, "other"); } else { snprintf(bucket_label, sizeof(bucket_label), "b%d", bucket + 1); } size_t needed = (first ? 0 : 1) + strlen(bucket_label) + 1 + ((size_t)hash_size * 2) + 1; if (remaining < needed) { if (remaining > 4) { strcpy(out, "..."); } return dest[0] != 0; } if (!first) { *out++ = ','; remaining--; } int n = snprintf(out, remaining, "%s:", bucket_label); if (n < 0 || (size_t)n >= remaining) { return dest[0] != 0; } out += n; remaining -= n; mesh::Utils::toHex(out, path, hash_size); out += (size_t)hash_size * 2; remaining -= (size_t)hash_size * 2; first = false; } path += hash_size; } return dest[0] != 0; } const uint8_t* heard_prefix = &packet->path[(packet->getPathHashCount() - 1) * hash_size]; if (remaining < ((size_t)hash_size * 2) + 1) { return false; } mesh::Utils::toHex(out, heard_prefix, hash_size); return true; } void MyMesh::onFloodRetryEvent(const char* event, const mesh::Packet* packet, uint32_t delay_millis, uint8_t retry_attempt) { if (event == NULL || packet == NULL) { return; } bool clear_bridge_state = _prefs.flood_retry_bridge_enabled && (strcmp(event, "good") == 0 || strcmp(event, "failure") == 0 || strcmp(event, "failed_all_tries") == 0 || strncmp(event, "dropped_", 8) == 0); if (clear_bridge_state && strcmp(event, "failure") == 0) { clearFloodRetryBridgeState(packet); } if (strcmp(event, "failure") == 0) { return; } const char* time_label = "time_ms"; if (strcmp(event, "queued") == 0 || strcmp(event, "dropped_queue_full") == 0) { time_label = "wait_ms"; } else if (strcmp(event, "resent") == 0 || strcmp(event, "failed_all_tries") == 0 || strcmp(event, "failure") == 0 || strncmp(event, "dropped_", 8) == 0) { time_label = "elapsed_ms"; } else if (strcmp(event, "good") == 0) { time_label = "echo_ms"; } char path_log[208]; char heard_log[96]; char heard_suffix[112]; formatFloodRetryPath(path_log, sizeof(path_log), packet); heard_suffix[0] = 0; if (strcmp(event, "good") == 0 && formatFloodRetryHeard(heard_log, sizeof(heard_log), packet)) { refreshFloodRetryHeardRecent(packet); snprintf(heard_suffix, sizeof(heard_suffix), ", heard=%s", heard_log); } MESH_DEBUG_PRINTLN("%s flood retry %s (retry=%u, type=%d, route=%s, payload_len=%d, hop=%u, path=%s%s, %s=%lu)", getLogDateTime(), event, (unsigned int)retry_attempt, (uint32_t)packet->getPayloadType(), packet->isRouteDirect() ? "D" : "F", (uint32_t)packet->payload_len, (unsigned int)packet->getPathHashCount(), path_log, heard_suffix, time_label, (unsigned long)delay_millis); if (_logging) { File f = openAppend(PACKET_LOG_FILE); if (f) { f.print(getLogDateTime()); f.printf(": FLOOD RETRY %s (retry=%u, type=%d, route=%s, payload_len=%d, hop=%u, path=%s%s, %s=%lu)\n", event, (unsigned int)retry_attempt, (uint32_t)packet->getPayloadType(), packet->isRouteDirect() ? "D" : "F", (uint32_t)packet->payload_len, (unsigned int)packet->getPathHashCount(), path_log, heard_suffix, time_label, (unsigned long)delay_millis); f.close(); } } if (clear_bridge_state) { clearFloodRetryBridgeState(packet); } } bool MyMesh::hasFloodRetryTargetPrefix(const mesh::Packet* packet) const { if (_prefs.flood_retry_bridge_enabled) { return false; } return floodRetryPrefixMatches(packet); } uint8_t MyMesh::getFloodRetryMaxPathLength(const mesh::Packet* packet) const { uint8_t gate = _prefs.flood_retry_path_gate; if (gate == FLOOD_RETRY_PATH_GATE_DISABLED) { return FLOOD_RETRY_PATH_GATE_DISABLED; } if (gate > 63) { gate = 2; } uint8_t raw_hops = packet != NULL ? packet->getPathHashCount() : 0; uint8_t effective_hops = floodRetryEffectivePathLength(packet); uint8_t ignored_hops = raw_hops > effective_hops ? raw_hops - effective_hops : 0; uint16_t adjusted_gate = (uint16_t)gate + ignored_hops; return adjusted_gate > 63 ? 63 : (uint8_t)adjusted_gate; } uint8_t MyMesh::getFloodRetryMaxAttempts(const mesh::Packet* packet) const { if (_prefs.disable_fwd) { return 0; } return constrain(_prefs.flood_retry_attempts, (uint8_t)0, (uint8_t)15); } bool MyMesh::isFloodRetryEchoTarget(const mesh::Packet* packet, uint8_t progress_marker) const { if (packet == NULL || !packet->isRouteFlood()) { return false; } if (_prefs.flood_retry_bridge_enabled) { FloodRetryBridgeState* state = floodRetryBridgeStateFor(packet, false); if (state == NULL) { return false; } state->heard_mask |= floodRetryBridgeHeardMask(packet, state->source_bucket, state->progress_marker) & state->target_mask; return (state->heard_mask & state->target_mask) == state->target_mask; } if (packet->getPathHashCount() == 0) { return false; } uint8_t hash_size = packet->getPathHashSize(); if (hash_size == 0 || hash_size > MAX_ROUTE_HASH_BYTES) { return false; } const uint8_t* heard_prefix = &packet->path[(packet->getPathHashCount() - 1) * hash_size]; if (floodRetryPrefixIgnored(heard_prefix, hash_size)) { return false; } if (hasFloodRetryPrefixes()) { return floodRetryLastHopMatches(packet); } if (floodRetryEffectivePathLength(packet) <= floodRetryEffectivePathLength(packet, progress_marker)) { return false; } return true; } uint8_t MyMesh::getDirectRetryMaxAttempts(const mesh::Packet* packet) const { uint8_t configured_attempts = getDirectRetryConfiguredMaxAttempts(); uint8_t total_hops = 0; if (packet != NULL) { if (packet->isRouteDirect() && packet->getPayloadType() == PAYLOAD_TYPE_TRACE && packet->payload_len >= 9) { uint8_t route_bytes = packet->payload_len - 9; uint8_t hash_size = decodeTraceHashSize(packet->payload[8], route_bytes); if (hash_size > 0) { total_hops = (uint8_t)(route_bytes / hash_size); } } else { total_hops = packet->getPathHashCount(); } } uint8_t path_cap = 15; if (total_hops <= 3) { path_cap = 8; } else if (total_hops == 4) { path_cap = 12; } return configured_attempts < path_cap ? configured_attempts : path_cap; } uint32_t MyMesh::getDirectRetryAttemptDelay(const mesh::Packet* packet, uint8_t attempt_idx) { uint32_t retry_delay = getDirectRetryEchoDelay(packet) + ((uint32_t)attempt_idx * getDirectRetryAttemptStepMillis()); if (packet == NULL) { return retry_delay; } return getDirectRetransmitDelay(packet) + retry_delay; } bool MyMesh::filterRecvFloodPacket(mesh::Packet* pkt) { // just try to determine region for packet (apply later in allowPacketForward()) if (pkt->getRouteType() == ROUTE_TYPE_TRANSPORT_FLOOD) { recv_pkt_region = region_map.findMatch(pkt, REGION_DENY_FLOOD); } else if (pkt->getRouteType() == ROUTE_TYPE_FLOOD) { if (region_map.getWildcard().flags & REGION_DENY_FLOOD) { recv_pkt_region = NULL; } else { recv_pkt_region = ®ion_map.getWildcard(); } } else { recv_pkt_region = NULL; } // do normal processing return false; } void MyMesh::onAnonDataRecv(mesh::Packet *packet, const uint8_t *secret, const mesh::Identity &sender, uint8_t *data, size_t len) { if (packet->getPayloadType() == PAYLOAD_TYPE_ANON_REQ) { // received an initial request by a possible admin // client (unknown at this stage) uint32_t timestamp; memcpy(×tamp, data, 4); data[len] = 0; // ensure null terminator uint8_t reply_len; reply_path_len = -1; if (data[4] == 0 || data[4] >= ' ') { // is password, ie. a login request reply_len = handleLoginReq(sender, secret, timestamp, &data[4], packet->isRouteFlood()); } else if (data[4] == ANON_REQ_TYPE_REGIONS && packet->isRouteDirect()) { reply_len = handleAnonRegionsReq(sender, timestamp, &data[5]); } else if (data[4] == ANON_REQ_TYPE_OWNER && packet->isRouteDirect()) { reply_len = handleAnonOwnerReq(sender, timestamp, &data[5]); } else if (data[4] == ANON_REQ_TYPE_BASIC && packet->isRouteDirect()) { reply_len = handleAnonClockReq(sender, timestamp, &data[5]); } else { reply_len = 0; // unknown/invalid request type } if (reply_len == 0) return; // invalid request if (packet->isRouteFlood()) { // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response mesh::Packet* path = createPathReturn(sender, secret, packet->path, packet->path_len, PAYLOAD_TYPE_RESPONSE, reply_data, reply_len); if (path) sendFloodReply(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize()); } else if (reply_path_len < 0) { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len); if (reply) sendFloodReply(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize()); } else { mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len); uint8_t path_len = ((reply_path_hash_size - 1) << 6) | (reply_path_len & 63); if (reply) sendDirect(reply, reply_path, path_len, SERVER_RESPONSE_DELAY); } } } int MyMesh::searchPeersByHash(const uint8_t *hash) { int n = 0; for (int i = 0; i < acl.getNumClients(); i++) { if (acl.getClientByIdx(i)->id.isHashMatch(hash)) { matching_peer_indexes[n++] = i; // store the INDEXES of matching contacts (for subsequent 'peer' methods) } } return n; } void MyMesh::getPeerSharedSecret(uint8_t *dest_secret, int peer_idx) { int i = matching_peer_indexes[peer_idx]; if (i >= 0 && i < acl.getNumClients()) { // lookup pre-calculated shared_secret memcpy(dest_secret, acl.getClientByIdx(i)->shared_secret, PUB_KEY_SIZE); } else { MESH_DEBUG_PRINTLN("getPeerSharedSecret: Invalid peer idx: %d", i); } } static bool isShare(const mesh::Packet *packet) { if (packet->hasTransportCodes()) { return packet->transport_codes[0] == 0 && packet->transport_codes[1] == 0; // codes { 0, 0 } means 'send to nowhere' } return false; } void MyMesh::onAdvertRecv(mesh::Packet *packet, const mesh::Identity &id, uint32_t timestamp, const uint8_t *app_data, size_t app_data_len) { mesh::Mesh::onAdvertRecv(packet, id, timestamp, app_data, app_data_len); // chain to super impl // if this a zero hop advert (and not via 'Share'), add it to neighbours if (packet->path_len == 0 && !isShare(packet)) { AdvertDataParser parser(app_data, app_data_len); if (parser.isValid() && parser.getType() == ADV_TYPE_REPEATER) { // just keep neigbouring Repeaters putNeighbour(id, timestamp, packet->getSNR()); } } } void MyMesh::onPeerDataRecv(mesh::Packet *packet, uint8_t type, int sender_idx, const uint8_t *secret, uint8_t *data, size_t len) { int i = matching_peer_indexes[sender_idx]; if (i < 0 || i >= acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context) MESH_DEBUG_PRINTLN("onPeerDataRecv: invalid peer idx: %d", i); return; } ClientInfo* client = acl.getClientByIdx(i); if (type == PAYLOAD_TYPE_REQ) { // request (from a Known admin client!) uint32_t timestamp; memcpy(×tamp, data, 4); if (timestamp > client->last_timestamp) { // prevent replay attacks int reply_len = handleRequest(client, timestamp, &data[4], len - 4); if (reply_len == 0) return; // invalid command client->last_timestamp = timestamp; client->last_activity = getRTCClock()->getCurrentTime(); if (packet->isRouteFlood()) { // 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) { if (hasUsablePath(client->out_path, client->out_path_len)) { sendFloodReplyWithAltPath(path, client->out_path, client->out_path_len, client->alt_path, client->alt_path_len, SERVER_RESPONSE_DELAY, packet->getPathHashSize()); } else { sendFloodReply(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize()); } } } else { mesh::Packet *reply = createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len); if (reply) { if (hasUsablePath(client->out_path, client->out_path_len)) { // we have an out_path, so send DIRECT sendDirectWithAltPath(reply, client->out_path, client->out_path_len, client->alt_path, client->alt_path_len, SERVER_RESPONSE_DELAY); } else { sendFloodReply(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize()); } } } } else { MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected"); } } else if (type == PAYLOAD_TYPE_TXT_MSG && len > 5 && client->isAdmin()) { // a CLI command uint32_t sender_timestamp; memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong) uint8_t flags = (data[4] >> 2); // message attempt number, and other flags if (!(flags == TXT_TYPE_PLAIN || flags == TXT_TYPE_CLI_DATA)) { MESH_DEBUG_PRINTLN("onPeerDataRecv: unsupported text type received: flags=%02x", (uint32_t)flags); } else if (sender_timestamp >= client->last_timestamp) { // prevent replay attacks bool is_retry = (sender_timestamp == client->last_timestamp); client->last_timestamp = sender_timestamp; client->last_activity = getRTCClock()->getCurrentTime(); // len can be > original length, but 'text' will be padded with zeroes data[len] = 0; // need to make a C string again, with null terminator if (flags == TXT_TYPE_PLAIN) { // for legacy CLI, send Acks uint32_t ack_hash; // calc truncated hash of the message timestamp + text + sender pub_key, to prove // to sender that we got it mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 5 + strlen((char *)&data[5]), client->id.pub_key, PUB_KEY_SIZE); mesh::Packet *ack = createAck(ack_hash); if (ack) { if (hasUsablePath(client->out_path, client->out_path_len)) { sendDirectWithAltPath(ack, client->out_path, client->out_path_len, client->alt_path, client->alt_path_len, TXT_ACK_DELAY); } else { sendFloodReply(ack, TXT_ACK_DELAY, packet->getPathHashSize()); } } } uint8_t temp[166]; char *command = (char *)&data[5]; char *reply = (char *)&temp[5]; if (is_retry) { *reply = 0; } else { handleCommand(sender_timestamp, client, command, reply); } int text_len = strlen(reply); if (text_len > 0) { uint32_t timestamp = getRTCClock()->getCurrentTimeUnique(); if (timestamp == sender_timestamp) { // WORKAROUND: the two timestamps need to be different, in the CLI view timestamp++; } memcpy(temp, ×tamp, 4); // mostly an extra blob to help make packet_hash unique temp[4] = (TXT_TYPE_CLI_DATA << 2); // NOTE: legacy was: TXT_TYPE_PLAIN auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len); if (reply) { if (hasUsablePath(client->out_path, client->out_path_len)) { sendDirectWithAltPath(reply, client->out_path, client->out_path_len, client->alt_path, client->alt_path_len, CLI_REPLY_DELAY_MILLIS); } else { sendFloodReply(reply, CLI_REPLY_DELAY_MILLIS, packet->getPathHashSize()); } } } } else { MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected"); } } } bool MyMesh::onPeerPathRecv(mesh::Packet *packet, int sender_idx, const uint8_t *secret, uint8_t *path, uint8_t path_len, uint8_t extra_type, uint8_t *extra, uint8_t extra_len) { // TODO: prevent replay attacks int i = matching_peer_indexes[sender_idx]; if (i >= 0 && i < acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context) MESH_DEBUG_PRINTLN("PATH to client, path_len=%d", (uint32_t)path_len); auto client = acl.getClientByIdx(i); // store a copy of path, for sendDirect() if (client->out_path_len != OUT_PATH_FORCE_FLOOD) { client->out_path_len = mesh::Packet::copyPath(client->out_path, path, path_len); } client->last_activity = getRTCClock()->getCurrentTime(); } else { MESH_DEBUG_PRINTLN("onPeerPathRecv: invalid peer idx: %d", i); } // NOTE: no reciprocal path send!! return false; } #define CTL_TYPE_NODE_DISCOVER_REQ 0x80 #define CTL_TYPE_NODE_DISCOVER_RESP 0x90 void MyMesh::onControlDataRecv(mesh::Packet* packet) { uint8_t type = packet->payload[0] & 0xF0; // just test upper 4 bits if (type == CTL_TYPE_NODE_DISCOVER_REQ && packet->payload_len >= 6 && !_prefs.disable_fwd && discover_limiter.allow(rtc_clock.getCurrentTime()) ) { int i = 1; uint8_t filter = packet->payload[i++]; uint32_t tag; memcpy(&tag, &packet->payload[i], 4); i += 4; uint32_t since; if (packet->payload_len >= i+4) { // optional since field memcpy(&since, &packet->payload[i], 4); i += 4; } else { since = 0; } if ((filter & (1 << ADV_TYPE_REPEATER)) != 0 && _prefs.discovery_mod_timestamp >= since) { bool prefix_only = packet->payload[0] & 1; uint8_t data[6 + PUB_KEY_SIZE]; data[0] = CTL_TYPE_NODE_DISCOVER_RESP | ADV_TYPE_REPEATER; // low 4-bits for node type data[1] = packet->_snr; // let sender know the inbound SNR ( x 4) memcpy(&data[2], &tag, 4); // include tag from request, for client to match to memcpy(&data[6], self_id.pub_key, PUB_KEY_SIZE); auto resp = createControlData(data, prefix_only ? 6 + 8 : 6 + PUB_KEY_SIZE); if (resp) { sendZeroHop(resp, getRetransmitDelay(resp)*4); // apply random delay (widened x4), as multiple nodes can respond to this } } } else if (type == CTL_TYPE_NODE_DISCOVER_RESP && packet->payload_len >= 6) { uint8_t node_type = packet->payload[0] & 0x0F; if (node_type != ADV_TYPE_REPEATER) { return; } if (packet->payload_len < 6 + PUB_KEY_SIZE) { MESH_DEBUG_PRINTLN("onControlDataRecv: DISCOVER_RESP pubkey too short: %d", (uint32_t)packet->payload_len); return; } if (pending_discover_tag == 0 || millisHasNowPassed(pending_discover_until)) { pending_discover_tag = 0; return; } uint32_t tag; memcpy(&tag, &packet->payload[2], 4); if (tag != pending_discover_tag) { return; } mesh::Identity id(&packet->payload[6]); if (id.matches(self_id)) { return; } putNeighbour(id, rtc_clock.getCurrentTime(), packet->getSNR()); } } void MyMesh::sendNodeDiscoverReq() { uint8_t data[10]; data[0] = CTL_TYPE_NODE_DISCOVER_REQ; // prefix_only=0 data[1] = (1 << ADV_TYPE_REPEATER); getRNG()->random(&data[2], 4); // tag memcpy(&pending_discover_tag, &data[2], 4); pending_discover_until = futureMillis(60000); uint32_t since = 0; memcpy(&data[6], &since, 4); auto pkt = createControlData(data, sizeof(data)); if (pkt) { sendZeroHop(pkt); } } MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondClock &ms, mesh::RNG &rng, mesh::RTCClock &rtc, mesh::MeshTables &tables) : mesh::Mesh(radio, ms, rng, rtc, *new StaticPoolPacketManager(32), tables), region_map(key_store), temp_map(key_store), _cli(board, rtc, sensors, region_map, acl, &_prefs, this), telemetry(MAX_PACKET_PAYLOAD - 4), discover_limiter(4, 120), // max 4 every 2 minutes anon_limiter(4, 180) // max 4 every 3 minutes #if defined(WITH_RS232_BRIDGE) , bridge(&_prefs, WITH_RS232_BRIDGE, _mgr, &rtc) #endif #if defined(WITH_ESPNOW_BRIDGE) , bridge(&_prefs, _mgr, &rtc) #endif { last_millis = 0; uptime_millis = 0; next_local_advert = next_flood_advert = 0; next_battery_alert_check = 0; last_battery_alert_sent = 0; battery_alert_sent = false; dirty_contacts_expiry = 0; set_radio_at = revert_radio_at = 0; _logging = false; region_load_active = false; memset(flood_retry_bridge_states, 0, sizeof(flood_retry_bridge_states)); #if MAX_NEIGHBOURS memset(neighbours, 0, sizeof(neighbours)); #endif // defaults memset(&_prefs, 0, sizeof(_prefs)); _prefs.airtime_factor = 1.0; _prefs.rx_delay_base = DEFAULT_RX_DELAY_BASE; _prefs.tx_delay_factor = 0.5f; // was 0.25f _prefs.direct_tx_delay_factor = 0.3f; // was 0.2 _prefs.direct_retry_recent_enabled = 1; _prefs.direct_retry_snr_margin_db = DIRECT_RETRY_ROOFTOP_MARGIN_X4; _prefs.direct_retry_attempts = DIRECT_RETRY_ROOFTOP_COUNT; _prefs.direct_retry_base_ms = DIRECT_RETRY_ROOFTOP_BASE_MS; _prefs.direct_retry_step_ms = DIRECT_RETRY_ROOFTOP_STEP_MS; _prefs.retry_preset = RETRY_PRESET_ROOFTOP; _prefs.flood_retry_attempts = 3; _prefs.flood_retry_path_gate = 2; _prefs.flood_retry_bridge_enabled = 0; _prefs.flood_retry_advert_enabled = 0; _prefs.battery_alert_enabled = 0; _prefs.battery_alert_low_percent = LOW_BATTERY_WARN_PERCENT_DEFAULT; _prefs.battery_alert_critical_percent = LOW_BATTERY_CRITICAL_PERCENT_DEFAULT; _prefs.direct_retry_cr4_snr_x4 = DIRECT_RETRY_CR4_MIN_SNR_X4_DEFAULT; _prefs.direct_retry_cr5_snr_x4 = DIRECT_RETRY_CR5_MIN_SNR_X4_DEFAULT; _prefs.direct_retry_cr7_snr_x4 = DIRECT_RETRY_CR7_MIN_SNR_X4_DEFAULT; _prefs.direct_retry_cr8_snr_x4 = DIRECT_RETRY_CR8_MAX_SNR_X4_DEFAULT; StrHelper::strncpy(_prefs.node_name, ADVERT_NAME, sizeof(_prefs.node_name)); _prefs.node_lat = ADVERT_LAT; _prefs.node_lon = ADVERT_LON; StrHelper::strncpy(_prefs.password, ADMIN_PASSWORD, sizeof(_prefs.password)); _prefs.freq = LORA_FREQ; _prefs.sf = LORA_SF; _prefs.bw = LORA_BW; _prefs.cr = LORA_CR; _prefs.tx_power_dbm = LORA_TX_POWER; _prefs.advert_interval = DEFAULT_ADVERT_INTERVAL; _prefs.flood_advert_interval = DEFAULT_FLOOD_ADVERT_INTERVAL; _prefs.flood_max = 64; _prefs.flood_max_unscoped = 64; _prefs.flood_max_advert = 8; _prefs.interference_threshold = 0; // disabled _prefs.agc_reset_interval = DEFAULT_AGC_RESET_INTERVAL; _prefs.multi_acks = DEFAULT_MULTI_ACKS; _prefs.path_hash_mode = DEFAULT_PATH_HASH_MODE; _prefs.loop_detect = DEFAULT_LOOP_DETECT; _prefs.powersaving_enabled = DEFAULT_POWERSAVING_ENABLED; // bridge defaults _prefs.bridge_enabled = 1; // enabled _prefs.bridge_delay = 500; // milliseconds _prefs.bridge_pkt_src = 0; // logTx _prefs.bridge_baud = 115200; // baud rate _prefs.bridge_channel = 1; // channel 1 StrHelper::strncpy(_prefs.bridge_secret, "LVSITANOS", sizeof(_prefs.bridge_secret)); // GPS defaults _prefs.gps_enabled = 0; _prefs.gps_interval = 0; _prefs.advert_loc_policy = ADVERT_LOC_PREFS; _prefs.adc_multiplier = 0.0f; // 0.0f means use default board multiplier #if defined(USE_SX1262) || defined(USE_SX1268) #ifdef SX126X_RX_BOOSTED_GAIN _prefs.rx_boosted_gain = SX126X_RX_BOOSTED_GAIN; #else _prefs.rx_boosted_gain = 1; // enabled by default; #endif #endif _prefs.radio_fem_rxgain = 1; pending_discover_tag = 0; pending_discover_until = 0; active_bw = _prefs.bw; active_sf = _prefs.sf; active_cr = _prefs.cr; } void MyMesh::begin(FILESYSTEM *fs) { mesh::Mesh::begin(); _fs = fs; // load persisted prefs _cli.loadPrefs(_fs); #ifdef CASCADIA_PROFILE _prefs.rx_delay_base = DEFAULT_RX_DELAY_BASE; _prefs.agc_reset_interval = DEFAULT_AGC_RESET_INTERVAL; _prefs.advert_interval = DEFAULT_ADVERT_INTERVAL; _prefs.flood_advert_interval = DEFAULT_FLOOD_ADVERT_INTERVAL; _prefs.multi_acks = DEFAULT_MULTI_ACKS; _prefs.path_hash_mode = DEFAULT_PATH_HASH_MODE; _prefs.loop_detect = DEFAULT_LOOP_DETECT; #endif acl.load(_fs, self_id); // TODO: key_store.begin(); region_map.load(_fs); // establish default-scope { RegionEntry* r = region_map.getDefaultRegion(); if (r) { region_map.getTransportKeysFor(*r, &default_scope, 1); } else { #ifdef DEFAULT_FLOOD_SCOPE_NAME r = region_map.findByName(DEFAULT_FLOOD_SCOPE_NAME); if (r == NULL) { r = region_map.putRegion(DEFAULT_FLOOD_SCOPE_NAME, 0); // auto-create the default scope region if (r) { r->flags = 0; } // Allow-flood } if (r) { region_map.setDefaultRegion(r); region_map.getTransportKeysFor(*r, &default_scope, 1); } #endif } } #if defined(WITH_BRIDGE) if (_prefs.bridge_enabled) { bridge.begin(); } #endif radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); active_bw = _prefs.bw; active_sf = _prefs.sf; active_cr = _prefs.cr; ((SimpleMeshTables *)getTables())->setRecentRepeaterMinSNRX4(getDirectRetryMinSNRX4()); radio_set_tx_power(_prefs.tx_power_dbm); radio_driver.setRxBoostedGainMode(_prefs.rx_boosted_gain); MESH_DEBUG_PRINTLN("RX Boosted Gain Mode: %s", radio_driver.getRxBoostedGainMode() ? "Enabled" : "Disabled"); board.setLoRaFemLnaEnabled(_prefs.radio_fem_rxgain); updateAdvertTimer(); updateFloodAdvertTimer(); board.setAdcMultiplier(_prefs.adc_multiplier); #if ENV_INCLUDE_GPS == 1 applyGpsPrefs(); #endif } void MyMesh::sendFloodScoped(const TransportKey& scope, mesh::Packet* pkt, uint32_t delay_millis, uint8_t path_hash_size) { if (scope.isNull()) { sendFlood(pkt, delay_millis, path_hash_size); } else { uint16_t codes[2]; codes[0] = scope.calcTransportCode(pkt); codes[1] = 0; // REVISIT: set to 'home' Region, for sender/return region? sendFlood(pkt, codes, delay_millis, path_hash_size); } } void MyMesh::sendFloodScopedWithSelfPath(const TransportKey& scope, mesh::Packet* pkt, uint32_t delay_millis, uint8_t path_hash_size) { if (pkt == NULL) { return; } if (path_hash_size == 0 || path_hash_size > MAX_ROUTE_HASH_BYTES) { MESH_DEBUG_PRINTLN("%s MyMesh::sendFloodScopedWithSelfPath(): invalid path_hash_size", getLogDateTime()); return; } pkt->header &= ~PH_ROUTE_MASK; if (scope.isNull()) { pkt->header |= ROUTE_TYPE_FLOOD; } else { uint16_t codes[2]; codes[0] = scope.calcTransportCode(pkt); codes[1] = 0; pkt->header |= ROUTE_TYPE_TRANSPORT_FLOOD; pkt->transport_codes[0] = codes[0]; pkt->transport_codes[1] = codes[1]; } pkt->setPathHashSizeAndCount(path_hash_size, 1); self_id.copyHashTo(pkt->path, path_hash_size); getTables()->markSent(pkt); sendPacket(pkt, 1, delay_millis); } bool MyMesh::sendRepeatersFloodText(const char* text) { if (text == NULL || *text == 0) return false; mesh::GroupChannel channel; if (!buildRepeatersChannel(channel)) { return false; } uint8_t temp[MAX_PACKET_PAYLOAD]; uint32_t timestamp = getRTCClock()->getCurrentTimeUnique(); memcpy(temp, ×tamp, 4); temp[4] = (TXT_TYPE_PLAIN << 2); const size_t max_data_len = MAX_PACKET_PAYLOAD - CIPHER_BLOCK_SIZE; const size_t prefix_cap = max_data_len > 5 ? max_data_len - 5 + 1 : 0; char sender_name[sizeof(_prefs.node_name)]; StrHelper::strncpy(sender_name, _prefs.node_name, sizeof(sender_name)); for (char* p = sender_name; *p; p++) { if (*p == ':') { *p = ';'; } } int prefix_written = prefix_cap > 0 ? snprintf((char*)&temp[5], prefix_cap, "%s: ", sender_name) : -1; if (prefix_written < 0) { return false; } size_t prefix_len = (size_t)prefix_written; if (prefix_len >= prefix_cap) { prefix_len = prefix_cap - 1; } size_t text_len = strlen(text); size_t max_text_len = max_data_len - 5 - prefix_len; if (text_len > max_text_len) { text_len = max_text_len; } memcpy(&temp[5 + prefix_len], text, text_len); auto pkt = createGroupDatagram(PAYLOAD_TYPE_GRP_TXT, channel, temp, 5 + prefix_len + text_len); if (pkt == NULL) { return false; } sendFloodScopedWithSelfPath(default_scope, pkt, 0, _prefs.path_hash_mode + 1); return true; } void MyMesh::checkBatteryAlert() { if (!_prefs.battery_alert_enabled) { battery_alert_sent = false; return; } if (next_battery_alert_check && !millisHasNowPassed(next_battery_alert_check)) { return; } next_battery_alert_check = futureMillis(LOW_BATTERY_CHECK_INTERVAL); uint16_t batt_mv = board.getBattMilliVolts(); uint8_t batt_pct = batteryPercentFromMilliVolts(batt_mv); if (batt_mv <= LOW_BATTERY_MIN_VALID_MV || batt_pct >= _prefs.battery_alert_low_percent) { battery_alert_sent = false; return; } unsigned long interval = batt_pct < _prefs.battery_alert_critical_percent ? LOW_BATTERY_CRITICAL_INTERVAL : LOW_BATTERY_WARN_INTERVAL; if (battery_alert_sent && !millisHasNowPassed(last_battery_alert_sent + interval)) { return; } char text[96]; snprintf(text, sizeof(text), "LOW BATTERY %u%% (%u mV)", (uint32_t)batt_pct, (uint32_t)batt_mv); if (sendRepeatersFloodText(text)) { battery_alert_sent = true; last_battery_alert_sent = millis(); } } void MyMesh::applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) { set_radio_at = futureMillis(2000); // give CLI reply some time to be sent back, before applying temp radio params pending_freq = freq; pending_bw = bw; pending_sf = sf; pending_cr = cr; revert_radio_at = futureMillis(2000 + timeout_mins * 60 * 1000); // schedule when to revert radio params } 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::sendSelfAdvertisement(int delay_millis, bool flood) { mesh::Packet *pkt = createSelfAdvert(); if (pkt) { if (flood) { sendFloodScoped(default_scope, pkt, delay_millis, _prefs.path_hash_mode + 1); } else { sendZeroHop(pkt, delay_millis); } } else { MESH_DEBUG_PRINTLN("ERROR: unable to create advertisement packet!"); } } void MyMesh::updateAdvertTimer() { if (_prefs.advert_interval > 0) { // schedule local advert timer next_local_advert = futureMillis(((uint32_t)_prefs.advert_interval) * 2 * 60 * 1000); } else { next_local_advert = 0; // stop the timer } } void MyMesh::updateFloodAdvertTimer() { if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000); } else { next_flood_advert = 0; // stop the timer } } void MyMesh::dumpLogFile() { #if defined(RP2040_PLATFORM) File f = _fs->open(PACKET_LOG_FILE, "r"); #else File f = _fs->open(PACKET_LOG_FILE); #endif if (f) { while (f.available()) { int c = f.read(); if (c < 0) break; Serial.print((char)c); } f.close(); } } void MyMesh::setTxPower(int8_t power_dbm) { radio_set_tx_power(power_dbm); } #if defined(USE_SX1262) || defined(USE_SX1268) void MyMesh::setRxBoostedGain(bool enable) { radio_driver.setRxBoostedGainMode(enable); } #endif void MyMesh::formatNeighborsReply(char *reply) { char *dp = reply; #if MAX_NEIGHBOURS // create copy of neighbours list, skipping empty entries so we can sort it separately from main list int16_t neighbours_count = 0; NeighbourInfo* sorted_neighbours[MAX_NEIGHBOURS]; for (int i = 0; i < MAX_NEIGHBOURS; i++) { auto neighbour = &neighbours[i]; if (neighbour->heard_timestamp > 0) { sorted_neighbours[neighbours_count] = neighbour; neighbours_count++; } } // sort neighbours newest to oldest std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) { return a->heard_timestamp > b->heard_timestamp; // desc }); for (int i = 0; i < neighbours_count && dp - reply < 134; i++) { NeighbourInfo *neighbour = sorted_neighbours[i]; // add new line if not first item if (i > 0) *dp++ = '\n'; char hex[10]; // get 4 bytes of neighbour id as hex mesh::Utils::toHex(hex, neighbour->id.pub_key, 4); // add next neighbour uint32_t secs_ago = getRTCClock()->getCurrentTime() - neighbour->heard_timestamp; sprintf(dp, "%s:%d:%d", hex, secs_ago, neighbour->snr); while (*dp) dp++; // find end of string } #endif if (dp == reply) { // no neighbours, need empty response strcpy(dp, "-none-"); dp += 6; } *dp = 0; // null terminator } void MyMesh::removeNeighbor(const uint8_t *pubkey, int key_len) { #if MAX_NEIGHBOURS for (int i = 0; i < MAX_NEIGHBOURS; i++) { NeighbourInfo *neighbour = &neighbours[i]; if (memcmp(neighbour->id.pub_key, pubkey, key_len) == 0) { neighbours[i] = NeighbourInfo(); // clear neighbour entry } } #endif } void MyMesh::startRegionsLoad() { temp_map.resetFrom(region_map); // rebuild regions in a temp instance memset(load_stack, 0, sizeof(load_stack)); load_stack[0] = &temp_map.getWildcard(); region_load_active = true; } bool MyMesh::saveRegions() { return region_map.save(_fs); } void MyMesh::onDefaultRegionChanged(const RegionEntry* r) { if (r) { region_map.getTransportKeysFor(*r, &default_scope, 1); } else { memset(default_scope.key, 0, sizeof(default_scope.key)); } } void MyMesh::formatStatsReply(char *reply) { StatsFormatHelper::formatCoreStats(reply, board, *_ms, _err_flags, _mgr); } void MyMesh::formatRadioStatsReply(char *reply) { StatsFormatHelper::formatRadioStats(reply, _radio, radio_driver, getTotalAirTime(), getReceiveAirTime()); } void MyMesh::formatPacketStatsReply(char *reply) { StatsFormatHelper::formatPacketStats(reply, radio_driver, getNumSentFlood(), getNumSentDirect(), getNumRecvFlood(), getNumRecvDirect()); } void MyMesh::saveIdentity(const mesh::LocalIdentity &new_id) { #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM) IdentityStore store(*_fs, ""); #elif defined(ESP32) IdentityStore store(*_fs, "/identity"); #elif defined(RP2040_PLATFORM) IdentityStore store(*_fs, "/identity"); #else #error "need to define saveIdentity()" #endif store.save("_main", new_id); } void MyMesh::clearStats() { radio_driver.resetStats(); resetStats(); ((SimpleMeshTables *)getTables())->resetStats(); } static char* trimSpaces(char* s) { while (*s == ' ') s++; char* end = s + strlen(s); while (end > s && end[-1] == ' ') end--; *end = 0; return s; } static bool parsePathCommand(char* raw, uint8_t* out_path, uint8_t& out_path_len, const char*& err) { if (raw == NULL || out_path == NULL) { err = "Err - bad params"; return false; } char* spec = trimSpaces(raw); if (*spec == 0) { err = "Err - missing path"; return false; } if (strcmp(spec, "clear") == 0 || strcmp(spec, "-") == 0 || strcmp(spec, "none") == 0) { out_path_len = OUT_PATH_UNKNOWN; return true; } if (strcmp(spec, "flood") == 0) { out_path_len = OUT_PATH_FORCE_FLOOD; return true; } if (strcmp(spec, "direct") == 0) { out_path_len = 0; return true; } uint8_t hash_size = 0; uint8_t hop_count = 0; char* token = spec; while (token && *token) { char* comma = strchr(token, ','); if (comma) *comma = 0; token = trimSpaces(token); int hex_len = strlen(token); if (!(hex_len == 2 || hex_len == 4 || hex_len == 6)) { err = "Err - each hop must be 1/2/3 bytes hex"; return false; } uint8_t hop_hash_size = (uint8_t)(hex_len / 2); if (hash_size == 0) { hash_size = hop_hash_size; } else if (hash_size != hop_hash_size) { err = "Err - mixed hash sizes in path"; return false; } if (hop_count >= 63 || (hop_count + 1) * hash_size > MAX_PATH_SIZE) { err = "Err - path too long"; return false; } if (!mesh::Utils::fromHex(&out_path[hop_count * hash_size], hash_size, token)) { err = "Err - bad hex"; return false; } hop_count++; token = comma ? comma + 1 : NULL; } if (hash_size == 0 || hop_count == 0) { err = "Err - missing path"; return false; } out_path_len = ((hash_size - 1) << 6) | (hop_count & 63); return true; } static void formatPathReply(const uint8_t* path, uint8_t path_len, char* out, size_t out_len) { if (path_len == OUT_PATH_FORCE_FLOOD) { snprintf(out, out_len, "> flood"); return; } if (path_len == OUT_PATH_UNKNOWN) { snprintf(out, out_len, "> unknown"); return; } if (!mesh::Packet::isValidPathLen(path_len)) { snprintf(out, out_len, "> invalid"); return; } if ((path_len & 63) == 0) { snprintf(out, out_len, "> direct"); return; } uint8_t hash_size = (path_len >> 6) + 1; uint8_t hop_count = path_len & 63; uint8_t byte_len = hop_count * hash_size; char hex[(MAX_PATH_SIZE * 2) + 1]; mesh::Utils::toHex(hex, path, byte_len); snprintf(out, out_len, "> hs=%u hops=%u hex=%s", (uint32_t)hash_size, (uint32_t)hop_count, hex); } void MyMesh::handleCommand(uint32_t sender_timestamp, ClientInfo* sender, char *command, char *reply) { if (region_load_active) { if (StrHelper::isBlank(command)) { // empty/blank line, signal to terminate 'load' operation region_map = temp_map; // copy over the temp instance as new current map region_load_active = false; sprintf(reply, "OK - loaded %d regions", region_map.getCount()); } else { char *np = command; while (*np == ' ') np++; // skip indent int indent = np - command; char *ep = np; while (RegionMap::is_name_char(*ep)) ep++; if (*ep) { *ep++ = 0; } // set null terminator for end of name while (*ep && *ep != 'F') ep++; // look for (optional) flags if (indent > 0 && indent < 8 && strlen(np) > 0) { auto parent = load_stack[indent - 1]; if (parent) { auto old = region_map.findByName(np); auto nw = temp_map.putRegion(np, parent->id, old ? old->id : 0); // carry-over the current ID (if name already exists) if (nw) { nw->flags = old ? old->flags : (*ep == 'F' ? 0 : REGION_DENY_FLOOD); // carry-over flags from curr load_stack[indent] = nw; // keep pointers to parent regions, to resolve parent_id's } } } reply[0] = 0; } return; } while (*command == ' ') command++; // skip leading spaces if (strlen(command) > 4 && command[2] == '|') { // optional prefix (for companion radio CLI) memcpy(reply, command, 3); // reflect the prefix back reply += 3; command += 3; } // handle ACL related commands if (memcmp(command, "setperm ", 8) == 0) { // format: setperm {pubkey-hex} {permissions-int8} char* hex = &command[8]; char* sp = strchr(hex, ' '); // look for separator char if (sp == NULL) { strcpy(reply, "Err - bad params"); } else { *sp++ = 0; // replace space with null terminator uint8_t pubkey[PUB_KEY_SIZE]; int hex_len = min(sp - hex, PUB_KEY_SIZE*2); if (mesh::Utils::fromHex(pubkey, hex_len / 2, hex)) { uint8_t perms = atoi(sp); if (acl.applyPermissions(self_id, pubkey, hex_len / 2, perms)) { dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); // trigger acl.save() strcpy(reply, "OK"); } else { strcpy(reply, "Err - invalid params"); } } else { strcpy(reply, "Err - bad pubkey"); } } } else if (sender_timestamp == 0 && strcmp(command, "get acl") == 0) { Serial.println("ACL:"); for (int i = 0; i < acl.getNumClients(); i++) { auto c = acl.getClientByIdx(i); if (c->permissions == 0) continue; // skip deleted (or guest) entries Serial.printf("%02X ", c->permissions); mesh::Utils::printHex(Serial, c->id.pub_key, PUB_KEY_SIZE); Serial.printf("\n"); } reply[0] = 0; } else if (strcmp(command, "get outpath") == 0 || strcmp(command, "set outpath") == 0 || strncmp(command, "set outpath ", 12) == 0 || strcmp(command, "get altpath") == 0 || strcmp(command, "set altpath") == 0 || strncmp(command, "set altpath ", 12) == 0) { bool is_get = strncmp(command, "get ", 4) == 0; bool is_alt = strstr(command, "altpath") != NULL; if (sender == NULL) { strcpy(reply, "Err - command needs remote client context"); } else if (is_get) { formatPathReply(is_alt ? sender->alt_path : sender->out_path, is_alt ? sender->alt_path_len : sender->out_path_len, reply, 160); } else { char* spec = command + 11; // length of "set outpath"/"set altpath" if (*spec == ' ') spec++; uint8_t path[MAX_PATH_SIZE]; uint8_t path_len = OUT_PATH_UNKNOWN; const char* err = NULL; if (!parsePathCommand(spec, path, path_len, err)) { strcpy(reply, err ? err : "Err - invalid path"); } else if (is_alt && path_len == OUT_PATH_FORCE_FLOOD) { strcpy(reply, "Err - bad params"); } else { if (is_alt) { if (path_len == OUT_PATH_UNKNOWN) { memset(sender->alt_path, 0, sizeof(sender->alt_path)); sender->alt_path_len = OUT_PATH_UNKNOWN; } else { sender->alt_path_len = mesh::Packet::copyPath(sender->alt_path, path, path_len); } } else { if (path_len == OUT_PATH_UNKNOWN || path_len == OUT_PATH_FORCE_FLOOD) { memset(sender->out_path, 0, sizeof(sender->out_path)); sender->out_path_len = path_len; } else { sender->out_path_len = mesh::Packet::copyPath(sender->out_path, path, path_len); } } dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); formatPathReply(is_alt ? sender->alt_path : sender->out_path, is_alt ? sender->alt_path_len : sender->out_path_len, reply, 160); } } } else if (strncmp(command, "send text.flood ", 16) == 0) { char* text = trimSpaces(command + 16); if (*text == 0) { strcpy(reply, "Err - usage: send text.flood "); } else if (sendRepeatersFloodText(text)) { strcpy(reply, "OK"); } else { strcpy(reply, "Err - unable to create packet"); } } else if (strcmp(command, "get battery.alert") == 0) { sprintf(reply, "> %s", _prefs.battery_alert_enabled ? "on" : "off"); } else if (strcmp(command, "get battery.alert.low") == 0) { sprintf(reply, "> %u", (uint32_t)_prefs.battery_alert_low_percent); } else if (strcmp(command, "get battery.alert.critical") == 0) { sprintf(reply, "> %u", (uint32_t)_prefs.battery_alert_critical_percent); } else if (strncmp(command, "set battery.alert ", 18) == 0) { const char* value = command + 18; if (strcmp(value, "on") == 0) { _prefs.battery_alert_enabled = 1; next_battery_alert_check = 0; savePrefs(); strcpy(reply, "OK"); } else if (strcmp(value, "off") == 0) { _prefs.battery_alert_enabled = 0; battery_alert_sent = false; savePrefs(); strcpy(reply, "OK"); } else { strcpy(reply, "Err - usage: set battery.alert "); } } else if (strncmp(command, "set battery.alert.low ", 22) == 0) { uint8_t percent; if (!parseBatteryAlertPercent(command + 22, 1, 100, percent)) { strcpy(reply, "Err - usage: set battery.alert.low <1-100>"); } else if (percent <= _prefs.battery_alert_critical_percent) { strcpy(reply, "Err - low must be greater than critical"); } else { _prefs.battery_alert_low_percent = percent; next_battery_alert_check = 0; savePrefs(); strcpy(reply, "OK"); } } else if (strncmp(command, "set battery.alert.critical ", 27) == 0) { uint8_t percent; if (!parseBatteryAlertPercent(command + 27, 0, 99, percent)) { strcpy(reply, "Err - usage: set battery.alert.critical <0-99>"); } else if (percent >= _prefs.battery_alert_low_percent) { strcpy(reply, "Err - critical must be less than low"); } else { _prefs.battery_alert_critical_percent = percent; next_battery_alert_check = 0; savePrefs(); strcpy(reply, "OK"); } } else if (strncmp(command, "get recent.repeater", 19) == 0 || strncmp(command, "set recent.repeater", 19) == 0 || strncmp(command, "clear recent.repeater", 21) == 0 || strncmp(command, "recent.repeater", 15) == 0) { bool is_get = false; bool is_set = false; bool is_clear = false; const char* sub = command; if (strncmp(command, "get recent.repeater", 19) == 0) { is_get = true; sub = command + 19; } else if (strncmp(command, "set recent.repeater", 19) == 0) { is_set = true; sub = command + 19; } else if (strncmp(command, "clear recent.repeater", 21) == 0) { is_clear = true; sub = command + 21; } else { sub = command + 15; // legacy command format } while (*sub == ' ') sub++; auto* tables = (SimpleMeshTables*)getTables(); if (!is_get && !is_set && !is_clear && strncmp(sub, "clear", 5) == 0 && (sub[5] == 0 || sub[5] == ' ')) { is_clear = true; sub += 5; while (*sub == ' ') sub++; } if (is_clear) { if (*sub != 0) { strcpy(reply, "Err - usage: clear recent.repeater"); } else { tables->clearRecentRepeaters(); strcpy(reply, "OK"); } } else if (is_set) { char* params = (char*) sub; char* arg_snr = strchr(params, ' '); if (arg_snr == NULL) { strcpy(reply, "Err - usage: set recent.repeater "); } else { *arg_snr++ = 0; while (*arg_snr == ' ') arg_snr++; if (*arg_snr == 0) { strcpy(reply, "Err - usage: set recent.repeater "); } else { uint8_t prefix[MAX_ROUTE_HASH_BYTES] = {0}; int hex_len = strlen(params); if (hex_len != (MAX_ROUTE_HASH_BYTES * 2) || !mesh::Utils::fromHex(prefix, MAX_ROUTE_HASH_BYTES, params)) { strcpy(reply, "Err - prefix must be exactly 3 bytes hex (6 chars)"); } else { char* end_snr = NULL; float snr_db = strtof(arg_snr, &end_snr); while (end_snr != NULL && *end_snr == ' ') end_snr++; if (end_snr == arg_snr || (end_snr != NULL && *end_snr != 0)) { strcpy(reply, "Err - snr must be numeric"); return; } int snr_x4 = (int)(snr_db * 4.0f + (snr_db >= 0.0f ? 0.5f : -0.5f)); snr_x4 = constrain(snr_x4, -128, 127); if (tables->setRecentRepeater(prefix, MAX_ROUTE_HASH_BYTES, (int8_t)snr_x4, true)) { strcpy(reply, "OK"); } else { strcpy(reply, "Err - unable to store prefix"); } } } } } else { const long page_size = sender_timestamp == 0 ? 128 : 7; long page_num = 1; const char* arg = sub; if (strncmp(arg, "page ", 5) == 0) { arg += 5; while (*arg == ' ') arg++; } if (*arg != 0) { char* end_ptr = NULL; page_num = strtol(arg, &end_ptr, 10); while (end_ptr != NULL && *end_ptr == ' ') end_ptr++; if (end_ptr == NULL || page_num <= 0 || (end_ptr != NULL && *end_ptr != 0)) { strcpy(reply, "Err - usage: get recent.repeater [page]"); return; } } size_t sorted_size = sizeof(SimpleMeshTables::RecentRepeaterInfo*) * MAX_RECENT_REPEATERS; const SimpleMeshTables::RecentRepeaterInfo** sorted_recent = (const SimpleMeshTables::RecentRepeaterInfo**)malloc(sorted_size); if (sorted_recent == NULL) { strcpy(reply, "Err - unable to allocate recent repeater view"); return; } int total = buildSortedRecentRepeaterView(tables, sorted_recent, MAX_RECENT_REPEATERS); if (total <= 0) { strcpy(reply, "> none"); } else { int total_pages = (total + (int)page_size - 1) / (int)page_size; if (page_num > total_pages) { sprintf(reply, "> none (page=%ld/%d)", page_num, total_pages); free(sorted_recent); return; } int offset = ((int)page_num - 1) * (int)page_size; int limit = total - offset; if (limit > (int)page_size) { limit = (int)page_size; } if (sender_timestamp == 0) { Serial.printf("Recent repeater table (3-byte,2-byte,1-byte; SNR desc, page=%ld/%d, n=%d/%d):\n", page_num, total_pages, limit, total); for (int i = 0; i < limit; i++) { const auto* info = sorted_recent[offset + i]; if (info == NULL) { continue; } char hex[(MAX_ROUTE_HASH_BYTES * 2) + 1]; formatRecentRepeaterPrefix(info, hex, sizeof(hex)); char snr_text[12]; formatRecentRepeaterSnrX4(info->snr_x4, snr_text, sizeof(snr_text)); Serial.printf("%s,%s%s\n", hex, snr_text, info->snr_locked ? ",l" : ""); } sprintf(reply, "> page=%ld/%d n=%d/%d", page_num, total_pages, limit, total); } else { int written = snprintf(reply, 160, "> page=%ld/%d n=%d/%d", page_num, total_pages, limit, total); bool truncated = false; if (written < 0) { reply[0] = 0; written = 0; } for (int i = 0; i < limit; i++) { int idx = offset + i; const auto* info = sorted_recent[idx]; if (info == NULL) { continue; } if (written >= 154) { truncated = true; break; } char hex[(MAX_ROUTE_HASH_BYTES * 2) + 1]; formatRecentRepeaterPrefix(info, hex, sizeof(hex)); char snr_text[12]; formatRecentRepeaterSnrX4(info->snr_x4, snr_text, sizeof(snr_text)); int n = snprintf(reply + written, 160 - written, "\n%s,%s%s", hex, snr_text, info->snr_locked ? ",l" : ""); if (n < 0 || n >= (160 - written)) { truncated = true; break; } written += n; } if (truncated && written < 156) { snprintf(reply + written, 160 - written, "\n... next page"); } } } free(sorted_recent); } } else if (memcmp(command, "discover.neighbors", 18) == 0) { const char* sub = command + 18; while (*sub == ' ') sub++; if (*sub != 0) { strcpy(reply, "Err - discover.neighbors has no options"); } else { sendNodeDiscoverReq(); strcpy(reply, "OK - Discover sent"); } } else{ _cli.handleCommand(sender_timestamp, command, reply); // common CLI commands } } void MyMesh::loop() { #ifdef WITH_BRIDGE bridge.loop(); #endif mesh::Mesh::loop(); checkBatteryAlert(); if (next_flood_advert && millisHasNowPassed(next_flood_advert)) { mesh::Packet *pkt = createSelfAdvert(); uint32_t delay_millis = 0; if (pkt) sendFloodScoped(default_scope, pkt, delay_millis, _prefs.path_hash_mode + 1); updateFloodAdvertTimer(); // schedule next flood advert updateAdvertTimer(); // also schedule local advert (so they don't overlap) } else if (next_local_advert && millisHasNowPassed(next_local_advert)) { mesh::Packet *pkt = createSelfAdvert(); if (pkt) sendZeroHop(pkt); updateAdvertTimer(); // schedule next local advert } if (set_radio_at && millisHasNowPassed(set_radio_at)) { // apply pending (temporary) radio params set_radio_at = 0; // clear timer radio_set_params(pending_freq, pending_bw, pending_sf, pending_cr); active_bw = pending_bw; active_sf = pending_sf; active_cr = pending_cr; MESH_DEBUG_PRINTLN("Temp radio params"); } if (revert_radio_at && millisHasNowPassed(revert_radio_at)) { // revert radio params to orig revert_radio_at = 0; // clear timer radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr); active_bw = _prefs.bw; active_sf = _prefs.sf; active_cr = _prefs.cr; MESH_DEBUG_PRINTLN("Radio params restored"); } // Keep recent-prefix learning aligned with the live retry SNR gate. ((SimpleMeshTables *)getTables())->setRecentRepeaterMinSNRX4(getDirectRetryMinSNRX4()); // is pending dirty contacts write needed? if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) { acl.save(_fs); dirty_contacts_expiry = 0; } // update uptime uint32_t now = millis(); uptime_millis += now - last_millis; last_millis = now; } // To check if there is pending work bool MyMesh::hasPendingWork() const { #if defined(WITH_BRIDGE) if (bridge.isRunning()) return true; // bridge needs WiFi radio, can't sleep #endif return _mgr->getOutboundTotal() > 0; }