Merge pull request #939 from NomDeTom/feat/mesh-beacon

Feat/mesh beacon

Author: thebentern

meshtastic/localonly.proto

@@ -146,6 +146,11 @@ message LocalModuleConfig {
    */
   ModuleConfig.TAKConfig tak = 17;
 
+  /*
+   * MeshBeacon Config
+   */
+  ModuleConfig.MeshBeaconConfig mesh_beacon = 18;
+
   /*
    * A version integer used to invalidate old save files when we make
    * incompatible changes This integer is set at build time and is private to

meshtastic/mesh_beacon.options

@@ -0,0 +1,3 @@
+*MeshBeacon.message max_size:101
+*MeshBeacon.offer_channel.name max_size:12
+*MeshBeacon.offer_channel.psk max_size:32

meshtastic/mesh_beacon.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+package meshtastic;
+
+import "meshtastic/channel.proto";
+import "meshtastic/config.proto";
+
+option csharp_namespace = "Meshtastic.Protobufs";
+option go_package = "github.com/meshtastic/go/generated";
+option java_outer_classname = "MeshBeaconProtos";
+option java_package = "org.meshtastic.proto";
+option swift_prefix = "";
+
+/*
+ * Payload for MESH_BEACON_APP packets.
+ * Periodically broadcast by nodes in beacon mode.
+ * Listeners deliver the text message to the local inbox and cache any offered
+ * channel/preset for the client app to act on — the firmware never auto-applies them.
+ */
+message MeshBeacon {
+  /*
+   * Human-readable beacon message. Max 100 bytes enforced by firmware on send.
+   */
+  string message = 1;
+
+  /*
+   * Optional channel (name + PSK) being advertised to listening clients.
+   * A client app may offer to switch the user to this channel; firmware never applies it automatically.
+   */
+  ChannelSettings offer_channel = 2;
+
+  /*
+   * Optional region being advertised alongside offer_preset.
+   */
+  Config.LoRaConfig.RegionCode offer_region = 3;
+
+  /*
+   * Optional modem preset being advertised.
+   * Combined with offer_region, tells a client "there is a mesh on this preset/region".
+   */
+  optional Config.LoRaConfig.ModemPreset offer_preset = 4;
+}

meshtastic/module_config.options

@@ -29,3 +29,10 @@
 *DetectionSensorConfig.detection_trigger_type max_size:8
 
 *StatusMessageConfig.node_status max_size:80
+
+*MeshBeaconConfig.broadcast_message max_size:101
+*MeshBeaconConfig.broadcast_offer_channel.name max_size:12
+*MeshBeaconConfig.broadcast_offer_channel.psk max_size:32
+*MeshBeaconConfig.broadcast_on_channel.name max_size:12
+*MeshBeaconConfig.broadcast_on_channel.psk max_size:32
+*MeshBeaconConfig.broadcast_targets max_count:4

meshtastic/module_config.proto

@@ -3,6 +3,8 @@ syntax = "proto3";
 package meshtastic;
 
 import "meshtastic/atak.proto";
+import "meshtastic/channel.proto";
+import "meshtastic/config.proto";
 
 option csharp_namespace = "Meshtastic.Protobufs";
 option go_package = "github.com/meshtastic/go/generated";
@@ -827,6 +829,141 @@ message ModuleConfig {
     string node_status = 1;
   }
 
+  /*
+   * MeshBeacon module config
+   */
+  message MeshBeaconConfig {
+    /*
+     * Boolean options for the beacon module, packed into the `flags` bitfield below.
+     * OR the FLAG_* values together; a flag is on when its bit is set.
+     */
+    enum Flags {
+      /*
+       * No options enabled.
+       */
+      FLAG_NONE = 0;
+
+      /*
+       * Enable receiving MESH_BEACON_APP packets from other nodes.
+       * The text portion is delivered to the local message inbox.
+       * Offered channel/preset are stored for the client app to act on.
+       */
+      FLAG_LISTEN_ENABLED = 1;
+
+      /*
+       * Enable periodically broadcasting MESH_BEACON_APP packets from this node.
+       */
+      FLAG_BROADCAST_ENABLED = 2;
+
+      /*
+       * When both text and offer content are present, split the beacon into a separate
+       * MESH_BEACON_APP (offer only) and TEXT_MESSAGE_APP (text only) packet, so firmware
+       * that only decodes TEXT_MESSAGE_APP still receives the human-readable text.
+       */
+      FLAG_LEGACY_SPLIT = 4;
+    }
+
+    /*
+     * Bitwise-OR of Flags values (listen / broadcast / legacy-split toggles).
+     */
+    uint32 flags = 1;
+
+    /*
+     * Optional: node ID to send beacon messages AS.
+     * When set, the `from` field of outgoing beacon packets is set to this node ID,
+     * making beacons appear to originate from that node.
+     * When unset (0), beacons are sent as the local node.
+     * A remote admin can only set this field to their own node ID.
+     */
+    uint32 broadcast_send_as_node = 3;
+
+    /*
+     * Message to include in each beacon broadcast. Max 100 bytes enforced by firmware.
+     */
+    string broadcast_message = 4;
+
+    /*
+     * Optional channel (name + PSK) to advertise in the MeshBeacon offer_channel field.
+     */
+    ChannelSettings broadcast_offer_channel = 5;
+
+    /*
+     * Optional region to advertise in the MeshBeacon offer_region field.
+     */
+    Config.LoRaConfig.RegionCode broadcast_offer_region = 6;
+
+    /*
+     * Optional modem preset to advertise in the MeshBeacon offer_preset field.
+     */
+    optional Config.LoRaConfig.ModemPreset broadcast_offer_preset = 7;
+
+    /*
+     * Single-target TX channel: channel settings (name + PSK) to send beacons on.
+     * If unset, beacons go out on the primary channel. Used only when broadcast_targets is empty.
+     * NOTE: the single-target path embeds the ChannelSettings inline here, whereas a
+     * broadcast_targets entry references a channel-table slot by channel_index instead — see
+     * BroadcastTarget. The two paths are equal, first-class options; only this representation differs.
+     */
+    ChannelSettings broadcast_on_channel = 8;
+
+    /*
+     * Region to use when sending beacons on broadcast_on_preset.
+     */
+    Config.LoRaConfig.RegionCode broadcast_on_region = 9;
+
+    /*
+     * Modem preset to use when sending beacons.
+     * If different from current config, the radio is temporarily switched for TX.
+     */
+    optional Config.LoRaConfig.ModemPreset broadcast_on_preset = 10;
+
+    /*
+     * How often to broadcast, in seconds. Min 3600 (1 h), default 3600.
+     */
+    uint32 broadcast_interval_secs = 11;
+
+    /*
+     * One entry in the multi-target broadcast list.
+     * The broadcaster transmits one beacon copy per entry, each on its own radio settings.
+     */
+    message BroadcastTarget {
+      /*
+       * Modem preset to use for this target.
+       * Falls back to the running config preset if unset.
+       */
+      optional Config.LoRaConfig.ModemPreset preset = 1;
+
+      /*
+       * Region to use for this target. UNSET means use the running config region.
+       */
+      Config.LoRaConfig.RegionCode region = 2;
+
+      // Tag 3 was an embedded ChannelSettings; replaced by channel_index (tag 4) to keep
+      // ModuleConfig within the BLE FromRadio size budget. Branch unreleased, so tag 3 is a gap.
+
+      /*
+       * Index into the device's channel table (0..MAX_NUM_CHANNELS-1) of the channel to
+       * transmit this target's beacon on. The referenced channel must already be configured
+       * on the node (its key is needed to encrypt). If unset, the default channel for the
+       * preset is used.
+       */
+      optional uint32 channel_index = 4;
+    }
+
+    /*
+     * Multi-target broadcast list.
+     * When non-empty the broadcaster transmits one beacon copy per entry in sequence,
+     * each temporarily switching the radio to that entry's preset/region/channel.
+     * When empty, the broadcaster uses the scalar broadcast_on_preset / broadcast_on_region /
+     * broadcast_on_channel fields instead (the single-target path).
+     * Single- and multi-target are equal, first-class options — neither is preferred or
+     * deprecated. They differ only in how the TX channel is named: broadcast_on_channel embeds a
+     * ChannelSettings inline, while a target references an existing channel-table slot by
+     * channel_index (see BroadcastTarget).
+     */
+    repeated BroadcastTarget broadcast_targets = 13;
+  }
+
   /*
    * TODO: REPLACE
    */
@@ -910,6 +1047,11 @@ message ModuleConfig {
      * TAK team/role configuration for TAK_TRACKER
      */
     TAKConfig tak = 16;
+
+    /*
+     * MeshBeacon module config
+     */
+    MeshBeaconConfig mesh_beacon = 17;
   }
 
   /*

meshtastic/portnums.proto

@@ -155,6 +155,14 @@ enum PortNum {
    */
   NODE_STATUS_APP = 36;
 
+  /*
+   * Beacon module broadcast packets.
+   * ENCODING: protobuf
+   * Periodically broadcast by nodes in beacon mode; received by nodes with MeshBeaconConfig.FLAG_LISTEN_ENABLED.
+   * Carries a text message plus optional channel/preset offers for client apps.
+   */
+  MESH_BEACON_APP = 37;
+
   /*
    * Provides a hardware serial interface to send and receive from the Meshtastic network.
    * Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic