Add a signal readout for the nearest repeater. With improvements to app bar and other UI polish. (#200)

* Refactor Cayenne LPP parsing with error handling and logging - Added error handling and logging to the Cayenne LPP parsing methods to manage malformed data gracefully. - Improved the structure of the parsing logic for better readability and maintainability. - Updated the Contact model to include error handling during frame parsing. - Refactored Channels, Contacts, Map, and Neighbours screens to utilize a new AppBarTitle widget for consistent app bar design. - Enhanced the BatteryIndicator widget to display SNR information for direct repeaters. - Introduced SNRUi class for better management of SNR icon and text representation. - Improved error handling in PathTraceMap and Neighbours screens to log errors appropriately. * Fix trace route bytes generation logic in Contact model * Ignore advertisements from self in MeshCoreConnector * Refactor PathTraceData to use List<double> for snrData and adjust data mapping in PathTraceMapScreen * Add SNRIndicator to AppBar and refactor BatteryIndicator layout * Enhance path management dialog to display direct repeaters with color coding based on signal strength * Remove unused import from SNR indicator widget * Update lib/models/contact.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update lib/connector/meshcore_connector.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update lib/connector/meshcore_connector.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update lib/screens/path_trace_map.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update lib/widgets/battery_indicator.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update lib/helpers/cayenne_lpp.dart Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Refactor packet handling to skip only the RSSI byte for improved reliability * Add SNR indicator localization and update UI references for nearby repeaters * Handle loading state and error parsing in PathTraceMapScreen; update SNR indicator dialog content layout * Throw an exception for unsupported LPP types in CayenneLpp class * Refactor AppBarTitle widget to remove unused style parameter; update related screens to reflect changes Improve SNR handling by adding validation for spreading factor range in snrUiFromSNR function Update contact handling in MeshCoreConnector to fix variable naming and improve readability Stop parsing unsupported LPP types in CayenneLpp to avoid misalignment * Sort direct repeaters by last updated time and SNR; limit to top three for improved path management dialog * Prevent notifications for chat and sensor adverts without a valid path * Implement ranking system for direct repeaters based on SNR and recency; update related UI components to reflect changes * Refactor localization keys for "neighbors" terminology across multiple languages - Updated localization keys from "neighbours" to "neighbors" in the following files: - app_localizations_bg.dart - app_localizations_de.dart - app_localizations_en.dart - app_localizations_es.dart - app_localizations_fr.dart - app_localizations_it.dart - app_localizations_nl.dart - app_localizations_pl.dart - app_localizations_pt.dart - app_localizations_ru.dart - app_localizations_sk.dart - app_localizations_sl.dart - app_localizations_sv.dart - app_localizations_uk.dart - app_localizations_zh.dart - Updated corresponding ARB files to reflect the changes in keys. - Renamed the NeighboursScreen to NeighborsScreen in the chat and repeater hub screens for consistency. * Adjust ranking calculation for direct repeaters by adding offset to SNR for improved accuracy * Fix typo in variable name for second direct repeater in path management dialog * Refactor ranking calculation for direct repeaters and update path handling in channel message screens * Refactor path handling in ChannelMessagePathScreen to improve logic for outgoing messages and channel messages * Fix AppBarTitle horizontal overflow with long titles (#187) * Initial plan * Wrap title Column in Expanded to prevent horizontal overflow in AppBarTitle Co-authored-by: wel97459 <12990640+wel97459@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: wel97459 <12990640+wel97459@users.noreply.github.com> * Refactor AppBarTitle widget to simplify Text widget initialization * Add "Show All Paths" feature to chat path management - Implemented localization for "Show All Paths" in multiple languages (DE, EN, ES, FR, IT, NL, PL, PT, RU, SK, SL, SV, UK, ZH). - Updated path management dialog to include a toggle for showing all paths. - Refactored path history display logic to conditionally show paths based on the toggle state. - Cleaned up unused print statements and improved code readability in path tracing and chat screens. * Refactor FeatureToggleRow visibility in chat and path management dialogs based on repeaters list * Remove unused import of 'dart:ffi' in path_trace_map.dart * Refactor repeater management logic and update UI state handling in chat and path management dialogs * Refactor RX data handling and improve repeater management logic in chat and path management dialogs --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: wel97459 <12990640+wel97459@users.noreply.github.com>
2026-07-09 02:03:24 +10:00 · 2026-02-20 20:27:38 -08:00
parent 0c4910e149
commit d2b693e5ce
49 changed files with 1956 additions and 914 deletions
@@ -37,6 +37,42 @@ class MeshCoreUuids {
  static const String txCharacteristic = "6e400003-b5a3-f393-e0a9-e50e24dcca9e";
 }

+class DirectRepeater {
+  static const int maxAgeMinutes = 30; // Max age for direct repeater info
+  final int pubkeyFirstByte;
+  double snr;
+  DateTime lastUpdated;
+
+  DirectRepeater({
+    required this.pubkeyFirstByte,
+    required this.snr,
+    DateTime? lastUpdated,
+  }) : lastUpdated = lastUpdated ?? DateTime.now();
+
+  void update(double newSNR) {
+    snr = newSNR;
+    lastUpdated = DateTime.now();
+  }
+
+  int get ranking {
+    if (isStale()) {
+      return -1; // Stale repeaters get lowest rank
+    }
+    // Higher SNR gets higher rank and recency within maxAgeMinutes breaks ties.
+    final ageMs =
+        DateTime.now().millisecondsSinceEpoch -
+        lastUpdated.millisecondsSinceEpoch;
+    final maxAgeMs = maxAgeMinutes * 60 * 1000;
+    final recencyScore = (maxAgeMs - ageMs).clamp(0, maxAgeMs);
+    return ((snr - 31.75) * 1000).round() + recencyScore;
+  }
+
+  bool isStale() {
+    return DateTime.now().difference(lastUpdated) >
+        const Duration(minutes: maxAgeMinutes);
+  }
+}
+
 enum MeshCoreConnectionState {
  disconnected,
  scanning,
@@ -95,6 +131,7 @@ class MeshCoreConnector extends ChangeNotifier {
  int? _batteryMillivolts;
  double? _selfLatitude;
  double? _selfLongitude;
+  final List<DirectRepeater> _directRepeaters = List.empty(growable: true);
  bool _isLoadingContacts = false;
  bool _isLoadingChannels = false;
  bool _hasLoadedChannels = false;
@@ -196,6 +233,7 @@ class MeshCoreConnector extends ChangeNotifier {
  String? get selfName => _selfName;
  double? get selfLatitude => _selfLatitude;
  double? get selfLongitude => _selfLongitude;
+  List<DirectRepeater> get directRepeaters => _directRepeaters;
  int? get currentTxPower => _currentTxPower;
  int? get maxTxPower => _maxTxPower;
  int? get currentFreqHz => _currentFreqHz;
@@ -1696,6 +1734,11 @@ class MeshCoreConnector extends ChangeNotifier {
        _isLoadingContacts = true;
        notifyListeners();
        break;
+      case pushCodeNewAdvert:
+        debugPrint('Got New CONTACT');
+        // It's the same format as respCodeContact, so we can reuse the handler
+        _handleContact(frame);
+        break;
      case respCodeContact:
        debugPrint('Got CONTACT');
        _handleContact(frame);
@@ -1740,6 +1783,7 @@ class MeshCoreConnector extends ChangeNotifier {
      case pushCodeStatusResponse:
        break;
      case pushCodeLogRxData:
+        _handleRxData(frame);
        _handleLogRxData(frame);
        break;
      case respCodeChannelInfo:
@@ -2028,6 +2072,80 @@ class MeshCoreConnector extends ChangeNotifier {
    }
  }

+  void _handleContactAdvert(Contact contact) {
+    if (listEquals(contact.publicKey, _selfPublicKey)) {
+      return;
+    }
+
+    if (contact.type == advTypeRepeater) {
+      _contactUnreadCount.remove(contact.publicKeyHex);
+      _unreadStore.saveContactUnreadCount(
+        Map<String, int>.from(_contactUnreadCount),
+      );
+    }
+    // Check if this is a new contact
+    final isNewContact = !_knownContactKeys.contains(contact.publicKeyHex);
+    final existingIndex = _contacts.indexWhere(
+      (c) => c.publicKeyHex == contact.publicKeyHex,
+    );
+
+    if (existingIndex >= 0) {
+      final existing = _contacts[existingIndex];
+      final mergedLastMessageAt =
+          existing.lastMessageAt.isAfter(contact.lastMessageAt)
+          ? existing.lastMessageAt
+          : contact.lastMessageAt;
+
+      appLogger.info(
+        'Refreshing contact ${contact.name}: devicePath=${contact.pathLength}, existingOverride=${existing.pathOverride}',
+        tag: 'Connector',
+      );
+
+      // CRITICAL: Preserve user's path override when contact is refreshed from device
+      _contacts[existingIndex] = contact.copyWith(
+        lastMessageAt: mergedLastMessageAt,
+        pathOverride: existing.pathOverride, // Preserve user's path choice
+        pathOverrideBytes: existing.pathOverrideBytes,
+      );
+
+      appLogger.info(
+        'After merge: pathOverride=${_contacts[existingIndex].pathOverride}, devicePath=${_contacts[existingIndex].pathLength}',
+        tag: 'Connector',
+      );
+    } else {
+      _contacts.add(contact);
+      appLogger.info(
+        'Added new contact ${contact.name}: pathLen=${contact.pathLength}',
+        tag: 'Connector',
+      );
+    }
+    _knownContactKeys.add(contact.publicKeyHex);
+    _loadMessagesForContact(contact.publicKeyHex);
+
+    // Add path to history if we have a valid path
+    if (_pathHistoryService != null && contact.pathLength >= 0) {
+      _pathHistoryService!.handlePathUpdated(contact);
+    }
+
+    notifyListeners();
+
+    // Show notification for new contact (advertisement)
+    if (isNewContact && _appSettingsService != null) {
+      final settings = _appSettingsService!.settings;
+      if (settings.notificationsEnabled && settings.notifyOnNewAdvert) {
+        _notificationService.showAdvertNotification(
+          contactName: contact.name,
+          contactType: contact.typeLabel,
+          contactId: contact.publicKeyHex,
+        );
+      }
+    }
+
+    if (!_isLoadingContacts) {
+      unawaited(_persistContacts());
+    }
+  }
+
  Future<void> _persistContacts() async {
    await _contactStore.saveContacts(_contacts);
  }
@@ -3287,7 +3405,11 @@ class MeshCoreConnector extends ChangeNotifier {

  void _handleCustomVars(Uint8List frame) {
    final buf = BufferReader(frame.sublist(1));
-    _currentCustomVars = _parseKeyValueString(buf.readString());
+    try {
+      _currentCustomVars = _parseKeyValueString(buf.readString());
+    } catch (e) {
+      appLogger.warn('Malformed custom vars frame: $e', tag: 'Connector');
+    }
  }

  void _setState(MeshCoreConnectionState newState) {
@@ -3311,6 +3433,191 @@ class MeshCoreConnector extends ChangeNotifier {

    super.dispose();
  }
+
+  void _handleRxData(Uint8List frame) {
+    final packet = BufferReader(frame);
+    double snr = 0.0;
+    int routeType = 0;
+    int payloadType = 0;
+    Uint8List pathBytes = Uint8List(0);
+    Uint8List payload = Uint8List(0);
+    try {
+      packet.skipBytes(1); // Skip frame type byte
+      snr = packet.readInt8() / 4.0;
+      packet.skipBytes(1); // Skip RSSI byte
+      //final rssi = packet.readByte();
+      final header = packet.readByte();
+      routeType = header & 0x03;
+      payloadType = (header >> 2) & 0x0F;
+      //final payloadVer = (header >> 6) & 0x03;
+      final pathLen = packet.readByte();
+      pathBytes = packet.readBytes(pathLen);
+      payload = packet.readBytes(packet.remaining);
+    } catch (e) {
+      appLogger.warn('Malformed RX frame: $e', tag: 'Connector');
+      return;
+    }
+
+    switch (payloadType) {
+      case payloadTypeADVERT:
+        _handlePayloadAdvertReceived(payload, pathBytes, routeType, snr);
+        break;
+      default:
+    }
+  }
+
+  void _handlePayloadAdvertReceived(
+    Uint8List frame,
+    Uint8List path,
+    int routeType,
+    double snr,
+  ) {
+    final advert = BufferReader(frame);
+    double latitude = 0.0;
+    double longitude = 0.0;
+    String name = '';
+    String contactKeyHex = '';
+    Uint8List publicKey = Uint8List(0);
+    int type = 0;
+    int timestamp = 0;
+    bool hasLocation = false;
+    bool hasName = false;
+    try {
+      publicKey = advert.readBytes(32);
+      contactKeyHex = publicKey
+          .map((b) => b.toRadixString(16).padLeft(2, '0'))
+          .join();
+
+      timestamp = advert.readInt32LE();
+      //TODO add signature verification
+      advert.skipBytes(64); // Skip signature for now
+      final flags = advert.readByte();
+      type = flags & 0x0F;
+      hasLocation = (flags & 0x10) != 0;
+      // For future use:
+      //final hasFeature1 = (flags & 0x20) != 0;
+      //final hasFeature2 = (flags & 0x40) != 0;
+      hasName = (flags & 0x80) != 0;
+      if (hasLocation && advert.remaining >= 8) {
+        latitude = advert.readInt32LE() / 1e6;
+        longitude = advert.readInt32LE() / 1e6;
+      }
+      if (hasName && advert.remaining > 0) {
+        name = advert.readString();
+      }
+    } catch (e) {
+      appLogger.warn('Malformed advert frame: $e', tag: 'Connector');
+      return;
+    }
+
+    if (listEquals(publicKey, _selfPublicKey)) {
+      return;
+    }
+
+    // Check if this is a new contact
+    final isNewContact = !_knownContactKeys.contains(contactKeyHex);
+
+    if (isNewContact) {
+      final newContact = Contact(
+        publicKey: publicKey,
+        name: name,
+        type: type,
+        pathLength: path.length,
+        path: Uint8List.fromList(
+          path.reversed.toList(),
+        ), // Store path in reverse for easier use in outgoing messages
+        latitude: latitude,
+        longitude: longitude,
+        lastSeen: DateTime.fromMillisecondsSinceEpoch(timestamp * 1000),
+      );
+      _handleContactAdvert(newContact);
+      _updateDirectRepeater(newContact, snr, path);
+      return;
+    }
+
+    final existingIndex = _contacts.indexWhere(
+      (c) => c.publicKeyHex == contactKeyHex,
+    );
+
+    if (existingIndex >= 0) {
+      final existing = _contacts[existingIndex];
+      final mergedLastMessageAt = existing.lastMessageAt.isAfter(DateTime.now())
+          ? DateTime.now()
+          : existing.lastMessageAt;
+
+      appLogger.info(
+        'Refreshing contact ${existing.name}: devicePath=${existing.pathLength}, existingOverride=${existing.pathOverride}',
+        tag: 'Connector',
+      );
+
+      // CRITICAL: Preserve user's path override when contact is refreshed from device
+      _contacts[existingIndex] = existing.copyWith(
+        latitude: hasLocation ? latitude : existing.latitude,
+        longitude: hasLocation ? longitude : existing.longitude,
+        name: hasName ? name : existing.name,
+        path: Uint8List.fromList(path.reversed.toList()),
+        pathLength: path.length,
+        lastMessageAt: mergedLastMessageAt,
+        lastSeen: DateTime.fromMillisecondsSinceEpoch(timestamp * 1000),
+        pathOverride: existing.pathOverride, // Preserve user's path choice
+        pathOverrideBytes: existing.pathOverrideBytes,
+      );
+
+      // Add path to history if we have a valid path
+      if (_pathHistoryService != null &&
+          _contacts[existingIndex].pathLength >= 0) {
+        _pathHistoryService!.handlePathUpdated(_contacts[existingIndex]);
+      }
+
+      _updateDirectRepeater(_contacts[existingIndex], snr, path);
+
+      appLogger.info(
+        'After merge: pathOverride=${_contacts[existingIndex].pathOverride}, devicePath=${_contacts[existingIndex].pathLength}',
+        tag: 'Connector',
+      );
+    }
+  }
+
+  void _updateDirectRepeater(Contact contact, double snr, Uint8List path) {
+    final pubkeyFirstByte = path.isNotEmpty
+        ? path.last
+        : contact.publicKey.first;
+
+    _directRepeaters.removeWhere((r) => r.isStale());
+
+    //We can use adverts from chat and sensor nodes, but only if the advert has a path to get the last hop.
+    if ((contact.type == advTypeChat || contact.type == advTypeSensor) &&
+        path.isEmpty) {
+      notifyListeners();
+      return;
+    }
+
+    final isTracked = _directRepeaters.where(
+      (r) => r.pubkeyFirstByte == pubkeyFirstByte,
+    );
+
+    final sortedRepeaters = List<DirectRepeater>.from(_directRepeaters)
+      ..sort((a, b) => b.snr.compareTo(a.snr));
+    final weakestRepeater = sortedRepeaters.isNotEmpty
+        ? sortedRepeaters.last
+        : null;
+
+    if (_directRepeaters.length >= 5 &&
+        weakestRepeater != null &&
+        isTracked.isEmpty) {
+      _directRepeaters.remove(weakestRepeater);
+    }
+
+    if (isTracked.isNotEmpty) {
+      final repeater = isTracked.first;
+      repeater.update(snr);
+    } else if (_directRepeaters.length < 5) {
+      _directRepeaters.add(
+        DirectRepeater(pubkeyFirstByte: pubkeyFirstByte, snr: snr),
+      );
+    }
+    notifyListeners();
+  }
 }

 const int _phRouteMask = 0x03;
@@ -13,12 +13,22 @@ class BufferReader {
  int readByte() => readBytes(1)[0];

  Uint8List readBytes(int count) {
+    if (_pointer + count > _buffer.length) {
+      throw RangeError(
+        'Attempted to read $count bytes at offset $_pointer, but only $remaining bytes remaining in buffer of length ${_buffer.length}',
+      );
+    }
    final data = _buffer.sublist(_pointer, _pointer + count);
    _pointer += count;
    return data;
  }

  void skipBytes(int count) {
+    if (_pointer + count > _buffer.length) {
+      throw RangeError(
+        'Attempted to skip $count bytes at offset $_pointer, but only $remaining bytes remaining in buffer of length ${_buffer.length}',
+      );
+    }
    _pointer += count;
  }

@@ -151,6 +161,7 @@ const int cmdGetContactByKey = 30;
 const int cmdGetChannel = 31;
 const int cmdSetChannel = 32;
 const int cmdSendTracePath = 36;
+const int cmdSetOtherParams = 38;
 const int cmdGetRadioSettings = 57;
 const int cmdGetTelemetryReq = 39;
 const int cmdGetCustomVar = 40;
@@ -166,7 +177,7 @@ const int reqTypeGetStatus = 0x01;
 const int reqTypeKeepAlive = 0x02;
 const int reqTypeGetTelemetry = 0x03;
 const int reqTypeGetAccessList = 0x05;
-const int reqTypeGetNeighbours = 0x06;
+const int reqTypeGetNeighbors = 0x06;

 // Repeater response codes
 const int respServerLoginOk = 0;
@@ -212,6 +223,30 @@ const int advTypeRepeater = 2;
 const int advTypeRoom = 3;
 const int advTypeSensor = 4;

+// Payload Types
+const int payloadTypeREQ =
+    0x00; // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)
+const int payloadTypeRESPONSE =
+    0x01; // response to REQ or ANON_REQ (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)
+const int payloadTypeTXTMSG =
+    0x02; // a plain text message (prefixed with dest/src hashes, MAC) (enc data: timestamp, text)
+const int payloadTypeACK = 0x03; // a simple ack
+const int payloadTypeADVERT = 0x04; // a node advertising its Identity
+const int payloadTypeGRPTXT =
+    0x05; // an (unverified) group text message (prefixed with channel hash, MAC) (enc data: timestamp, "name: msg")
+const int payloadTypeGRPDATA =
+    0x06; // an (unverified) group datagram (prefixed with channel hash, MAC) (enc data: timestamp, blob)
+const int payloadTypeANONREQ =
+    0x07; // generic request (prefixed with dest_hash, ephemeral pub_key, MAC) (enc data: ...)
+const int payloadTypePATH =
+    0x08; // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra)
+const int payloadTypeTRACE = 0x09; // trace a path, collecting SNI for each hop
+const int payloadTypeMULTIPART = 0x0A; // packet is one of a set of packets
+const int payloadTypeCONTROL = 0x0B; // a control/discovery packet
+//...
+const int payloadTypeRawCustom =
+    0x0F; // custom packet as raw bytes, for applications with custom encryption, payloads, etc
+
 // Sizes
 const int pubKeySize = 32;
 const int maxPathSize = 64;
@@ -788,3 +823,22 @@ Uint8List buildZeroHopContact(Uint8List pubKey) {
  writer.writeBytes(pubKey);
  return writer.toBytes();
 }
+
+// Build CMD_SET_OTHER_PARAMS frame
+// Format: [cmd][allowAutoAddContacts][allowTelemetryFlags][advertLocationPolicy][multiAcks]
+Uint8List buildSetOtherParamsFrame(
+  bool allowAutoAddContacts,
+  int allowTelemetryFlags,
+  int advertLocationPolicy,
+  int multiAcks,
+) {
+  final writer = BufferWriter();
+  writer.writeByte(cmdSetOtherParams);
+  writer.writeByte(
+    allowAutoAddContacts ? 0x00 : 0x01,
+  ); // Allow Auto Add Contacts
+  writer.writeByte(allowTelemetryFlags); // Allow Telemetry Flags
+  writer.writeByte(advertLocationPolicy); // Advertisement Location Policy
+  writer.writeByte(multiAcks); // Multi Acknowledgements
+  return writer.toBytes();
+}