Merge branch 'master' of github.com:meshtastic/Meshtastic-protobufs

Author: caveman99

.github/pull_request_template.md

@@ -10,3 +10,21 @@
 
 - [ ] All top level messages commented
 - [ ] All enum members have unique descriptions
+
+
+### New Hardware Model Acceptance Policy
+
+Due to limited availability and ongoing support, new Hardware Models will only be accepted from [Meshtastic Backers and Partners](https://meshtastic.com/). The Meshtastic team reserves the right to make exceptions to this policy.
+
+#### Alternative for Community Contributors
+
+You are welcome to use one of the existing DIY hardware models in your PlatformIO environment and create a pull request in the firmware project. Please note the following conditions:
+
+- The device will **not** be officially supported by the core Meshtastic team.
+- The device will **not** appear in the [Web Flasher](https://flasher.meshtastic.org/) or Github release assets.
+- You will be responsible for ongoing maintenance and support.
+- Community-contributed / DIY hardware models are considered experimental and will likely have limited or no testing.
+
+#### Getting Official Support
+
+To have your hardware model officially supported and included in the Meshtastic ecosystem, consider becoming a Meshtastic Backer or Partner. Visit [meshtastic.com](https://meshtastic.com/) for more information about partnership opportunities.

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -14,3 +14,4 @@ The [Protobuf](https://developers.google.com/protocol-buffers) message definitio
 ## Stats
 
 ![Alt](https://repobeats.axiom.co/api/embed/47e9ee1d81d9c0fdd2b4b5b4c673adb1756f6db5.svg "Repobeats analytics image")
+

meshtastic/admin.options

@@ -2,6 +2,11 @@
 
 *AdminMessage.session_passkey max_size:8
 
+*AdminMessage.InputEvent.event_code int_size:8
+*AdminMessage.InputEvent.kb_char int_size:8
+*AdminMessage.InputEvent.touch_x int_size:16
+*AdminMessage.InputEvent.touch_y int_size:16
+
 *AdminMessage.set_canned_message_module_messages max_size:201
 *AdminMessage.get_canned_message_module_messages_response max_size:201
 *AdminMessage.delete_file_request max_size:201

meshtastic/admin.proto

@@ -74,7 +74,7 @@ message AdminMessage {
     SECURITY_CONFIG = 7;
 
     /*
-     *
+     * Session key config
      */
     SESSIONKEY_CONFIG = 8;
 
@@ -166,6 +166,28 @@ message AdminMessage {
     SD = 1;
   }
 
+  /*
+   * Input event message to be sent to the node.
+   */
+  message InputEvent {
+    /*
+     * The input event code
+     */
+    uint32 event_code = 1;
+    /*
+     * Keyboard character code
+     */
+    uint32 kb_char = 2;
+    /*
+     * The touch X coordinate
+     */
+    uint32 touch_x = 3;
+    /*
+     * The touch Y coordinate
+     */
+    uint32 touch_y = 4;
+  }
+
   /*
    * TODO: REPLACE
    */
@@ -296,6 +318,13 @@ message AdminMessage {
      * Remove backups of the node's preferences
      */
     BackupLocation remove_backup_preferences = 26;
+
+    /*
+     * Send an input event to the node.
+     * This is used to trigger physical input events like button presses, touch events, etc.
+     */
+    InputEvent send_input_event = 27;
+
     /*
      * Set the owner for this node
      */
@@ -397,6 +426,16 @@ message AdminMessage {
      */
     bool commit_edit_settings = 65;
 
+    /*
+     * Add a contact (User) to the nodedb
+     */
+    SharedContact add_contact = 66;
+
+    /*
+     * Initiate or respond to a key verification request
+     */
+    KeyVerificationAdmin key_verification = 67;
+
     /*
      * Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.
      */
@@ -472,3 +511,70 @@ message NodeRemoteHardwarePinsResponse {
    */
   repeated NodeRemoteHardwarePin node_remote_hardware_pins = 1;
 }
+
+message SharedContact {
+  /*
+   * The node number of the contact
+   */
+  uint32 node_num = 1;
+
+  /*
+   * The User of the contact
+   */
+  User user = 2;
+
+  /*
+   * Add this contact to the blocked / ignored list
+   */
+  bool should_ignore = 3;
+}
+
+  /*
+   * This message is used by a client to initiate or complete a key verification
+   */
+message KeyVerificationAdmin {
+  /*
+   * Three stages of this request.
+   */
+  enum MessageType {
+
+    /*
+    * This is the first stage, where a client initiates
+    */
+    INITIATE_VERIFICATION = 0;
+
+    /*
+     * After the nonce has been returned over the mesh, the client prompts for the security number
+     * And uses this message to provide it to the node.
+     */
+    PROVIDE_SECURITY_NUMBER = 1;
+ 
+   /*
+    * Once the user has compared the verification message, this message notifies the node.
+    */
+    DO_VERIFY = 2;
+
+   /*
+    * This is the cancel path, can be taken at any point
+    */
+    DO_NOT_VERIFY = 3;
+
+  }
+
+  MessageType message_type = 1;
+
+   /*
+    * The nodenum we're requesting
+    */
+  uint32 remote_nodenum = 2;
+
+   /*
+    * The nonce is used to track the connection
+    */
+  uint64 nonce = 3;
+
+   /*
+    * The 4 digit code generated by the remote node, and communicated outside the mesh
+    */
+  optional uint32 security_number = 4;
+}

meshtastic/config.options

@@ -1,5 +1,7 @@
 # longest current is 45 chars, plan with a bit of buffer
 *DeviceConfig.tzdef max_size:65
+*DeviceConfig.buzzer_mode int_size:8
+
 
 *NetworkConfig.wifi_ssid max_size:33
 *NetworkConfig.wifi_psk max_size:65

meshtastic/config.proto

@@ -41,7 +41,7 @@ message Config {
        * Description: Combination of both ROUTER and CLIENT. Not for mobile devices.
        * Deprecated in v2.3.15 because improper usage is impacting public meshes: Use ROUTER or CLIENT instead.
        */
-      
+
       ROUTER_CLIENT = 3 [deprecated = true];
 
       /*
@@ -150,6 +150,36 @@ message Config {
       CORE_PORTNUMS_ONLY = 5;
     }
 
+    /*
+     * Defines buzzer behavior for audio feedback
+     */
+    enum BuzzerMode {
+      /*
+       * Default behavior.
+       * Buzzer is enabled for all audio feedback including button presses and alerts.
+       */
+      ALL_ENABLED = 0;
+
+      /*
+       * Disabled.
+       * All buzzer audio feedback is disabled.
+       */
+      DISABLED = 1;
+
+      /*
+       * Notifications Only.
+       * Buzzer is enabled only for notifications and alerts, but not for button presses.
+       * External notification config determines the specifics of the notification behavior.
+       */
+      NOTIFICATIONS_ONLY = 2;
+
+      /*
+       * Non-notification system buzzer tones only.
+       * Buzzer is enabled only for non-notification tones such as button presses, startup, shutdown, but not for alerts.
+       */
+      SYSTEM_ONLY = 3;
+    }
+
     /*
      * Sets the role of node
      */
@@ -207,9 +237,15 @@ message Config {
     string tzdef = 11;
 
     /*
-     * If true, disable the default blinking LED (LED_PIN) behavior on the device 
+     * If true, disable the default blinking LED (LED_PIN) behavior on the device
      */
     bool led_heartbeat_disabled = 12;
+
+    /*
+     * Controls buzzer behavior for audio feedback
+     * Defaults to ENABLED
+     */
+    BuzzerMode buzzer_mode = 13;
   }
 
   /*
@@ -380,7 +416,7 @@ message Config {
    */
   message PowerConfig {
     /*
-     * Description: Will sleep everything as much as possible, for the tracker and sensor role this will also include the lora radio. 
+     * Description: Will sleep everything as much as possible, for the tracker and sensor role this will also include the lora radio.
      * Don't use this setting if you want to use your device with the phone apps or are using a device without a user button.
      * Technical Details: Works for ESP32 devices and NRF52 devices in the Sensor or Tracker roles
      */
@@ -434,7 +470,7 @@ message Config {
      * If non-zero, we want powermon log outputs.  With the particular (bitfield) sources enabled.
      * Note: we picked an ID of 32 so that lower more efficient IDs can be used for more frequently used options.
      */
-     uint64 powermon_enables = 32;    
+     uint64 powermon_enables = 32;
   }
 
   /*
@@ -492,7 +528,7 @@ message Config {
     string wifi_psk = 4;
 
     /*
-     * NTP server to use if WiFi is conneced, defaults to `0.pool.ntp.org`
+     * NTP server to use if WiFi is conneced, defaults to `meshtastic.pool.ntp.org`
      */
     string ntp_server = 5;
 
@@ -521,6 +557,11 @@ message Config {
      */
     uint32 enabled_protocols = 10;
 
+    /*
+     * Enable/Disable ipv6 support
+     */
+    bool ipv6_enabled = 11;
+
     /*
      * Available flags auxiliary network protocols
      */
@@ -603,24 +644,29 @@ message Config {
      */
     enum OledType {
       /*
-       * Default / Auto
+       * Default / Autodetect
        */
       OLED_AUTO = 0;
 
       /*
-       * Default / Auto
+       * Default / Autodetect
        */
       OLED_SSD1306 = 1;
 
       /*
-       * Default / Auto
+       * Default / Autodetect
        */
       OLED_SH1106 = 2;
 
       /*
        * Can not be auto detected but set by proto. Used for 128x128 screens
        */
       OLED_SH1107 = 3;
+
+      /*
+       * Can not be auto detected but set by proto. Used for 128x64 screens
+       */
+      OLED_SH1107_128_64 = 4;
     }
 
     /*
@@ -850,21 +896,26 @@ message Config {
        * Singapore 923mhz
        */
       SG_923 = 18;
-      
+
       /*
        * Philippines 433mhz
        */
       PH_433 = 19;
-      
+
       /*
        * Philippines 868mhz
        */
       PH_868 = 20;
-      
+
       /*
        * Philippines 915mhz
        */
       PH_915 = 21;
+      /*
+       * Australia / New Zealand 433MHz
+       */
+      ANZ_433 = 22;
+
     }
 
     /*
@@ -1139,4 +1190,4 @@ message Config {
     SessionkeyConfig sessionkey = 9;
     DeviceUIConfig device_ui = 10;
   }
-}
+}

meshtastic/device_ui.options

@@ -2,9 +2,10 @@
 *DeviceUIConfig.screen_timeout int_size:16
 *DeviceUIConfig.ring_tone_id int_size:8
 *DeviceUIConfig.calibration_data max_size:16
+*DeviceUIConfig.compass_mode int_size:8
 *NodeFilter.node_name max_size:16
 *NodeFilter.hops_away int_size:8
 *NodeFilter.channel int_size:8
 *NodeHighlight.node_name max_size:16
 *GeoPoint.zoom int_size:8
-*Map.style max_size:20
+*Map.style max_size:20