Merge pull request #441 from meshtastic/role_descriptions

Add new device role descriptions to protobuf comments

meshtastic/config.proto

@@ -18,64 +18,62 @@ message Config {
      */
     enum Role {
       /*
-       * Client device role
+       * Description: App connected or stand alone messaging device.
+       * Technical Details: Default Role
        */
       CLIENT = 0;
-
       /*
-       * Client Mute device role
+       *  Description: Device that does not forward packets from other devices.
-       *   Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh.
        */
       CLIENT_MUTE = 1;
 
       /*
-       * Router device role.
+       * Description: Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list.
-       *   Mesh packets will prefer to be routed over this node. This node will not be used by client apps.
+       * Technical Details: Mesh packets will prefer to be routed over this node. This node will not be used by client apps.
-       *   The wifi/ble radios and the oled screen will be put to sleep.
+       *   The wifi radio and the oled screen will be put to sleep.
        *   This mode may still potentially have higher power usage due to it's preference in message rebroadcasting on the mesh.
        */
       ROUTER = 2;
 
       /*
-       * Router Client device role
+       * Description: Combination of both ROUTER and CLIENT. Not for mobile devices.
-       *   Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client.
        */
       ROUTER_CLIENT = 3;
 
       /*
-       * Repeater device role
+       * Description: Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list.
-       *   Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry
+       * Technical Details: Mesh packets will simply be rebroadcasted over this node. Nodes configured with this role will not originate NodeInfo, Position, Telemetry
        *   or any other packet type. They will simply rebroadcast any mesh packets on the same frequency, channel num, spread factor, and coding rate.
        */
       REPEATER = 4;
 
       /*
-       * Tracker device role
+       * Description: Broadcasts GPS position packets as priority.
-       *   Position Mesh packets will be prioritized higher and sent more frequently by default.
+       * Technical Details: Position Mesh packets will be prioritized higher and sent more frequently by default.
        *   When used in conjunction with power.is_power_saving = true, nodes will wake up, 
        *   send position, and then sleep for position.position_broadcast_secs seconds.
        */
       TRACKER = 5;
 
       /*
-       * Sensor device role
+       * Description: Broadcasts telemetry packets as priority.
-       *   Telemetry Mesh packets will be prioritized higher and sent more frequently by default.
+       * Technical Details: Telemetry Mesh packets will be prioritized higher and sent more frequently by default.
        *   When used in conjunction with power.is_power_saving = true, nodes will wake up, 
        *   send environment telemetry, and then sleep for telemetry.environment_update_interval seconds.
        */
       SENSOR = 6;
 
       /*
-       * TAK device role
+       * Description: Optimized for ATAK system communication, reduces routine broadcasts.
-       *    Used for nodes dedicated for connection to an ATAK EUD.
+       * Technical Details: Used for nodes dedicated for connection to an ATAK EUD.
        *    Turns off many of the routine broadcasts to favor CoT packet stream
        *    from the Meshtastic ATAK plugin -> IMeshService -> Node
        */
       TAK = 7;
 
       /*
-       * Client Hidden device role
+       * Description: Device that only broadcasts as needed for stealth or power savings.
-       *    Used for nodes that "only speak when spoken to"
+       * Technical Details: Used for nodes that "only speak when spoken to"
        *    Turns all of the routine broadcasts but allows for ad-hoc communication
        *    Still rebroadcasts, but with local only rebroadcast mode (known meshes only)
        *    Can be used for clandestine operation or to dramatically reduce airtime / power consumption 
@@ -83,8 +81,8 @@ message Config {
       CLIENT_HIDDEN = 8;
 
       /*
-       * Lost and Found device role
+       * Description: Broadcasts location as message to default channel regularly for to assist with device recovery.
-       *    Used to automatically send a text message to the mesh 
+       * Technical Details: Used to automatically send a text message to the mesh 
        *    with the current position of the device on a frequent interval:
        *    "I'm lost! Position: lat / long"
        */
@@ -946,4 +944,4 @@ message Config {
     LoRaConfig lora = 6;
     BluetoothConfig bluetooth = 7;
   }
-}
+}