Enumeration Config_DeviceConfig_Role

Defines the device's role on the Mesh network

Generated

from enum meshtastic.Config.DeviceConfig.Role

Enumeration Members

CLIENT: 0

Description: App connected or stand alone messaging device. Technical Details: Default Role

Generated

from enum value: CLIENT = 0;

CLIENT_HIDDEN: 8

Description: Device that only broadcasts as needed for stealth or power savings. 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

Generated

from enum value: CLIENT_HIDDEN = 8;

CLIENT_MUTE: 1

Description: Device that does not forward packets from other devices.

Generated

from enum value: CLIENT_MUTE = 1;

LOST_AND_FOUND: 9

Description: Broadcasts location as message to default channel regularly for to assist with device recovery. 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"

Generated

from enum value: LOST_AND_FOUND = 9;

REPEATER: 4

Description: Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list. 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.

Generated

from enum value: REPEATER = 4;

ROUTER: 2

Description: Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. Technical Details: Mesh packets will prefer to be routed over this node. This node will not be used by client apps. 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.

Generated

from enum value: ROUTER = 2;

ROUTER_CLIENT: 3

Description: Combination of both ROUTER and CLIENT. Not for mobile devices.

Generated

from enum value: ROUTER_CLIENT = 3;

SENSOR: 6

Description: Broadcasts telemetry packets as priority. 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.

Generated

from enum value: SENSOR = 6;

TAK: 7

Description: Optimized for ATAK system communication and reduces routine broadcasts. 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

Generated

from enum value: TAK = 7;

TAK_TRACKER: 10

Description: Enables automatic TAK PLI broadcasts and reduces routine broadcasts. Technical Details: Turns off many of the routine broadcasts to favor ATAK CoT packet stream and automatic TAK PLI (position location information) broadcasts. Uses position module configuration to determine TAK PLI broadcast interval.

Generated

from enum value: TAK_TRACKER = 10;

TRACKER: 5

Description: Broadcasts GPS position packets as priority. 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.

Generated

from enum value: TRACKER = 5;

Generated using TypeDoc