Enumeration Config_DeviceConfig_Role

Defines the device's role on the Mesh network

Generated

from enum meshtastic.Config.DeviceConfig.Role

Enumeration Members

CLIENT: 0

Client device role

Generated

from enum value: CLIENT = 0;

CLIENT_HIDDEN: 8

Client Hidden device role 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

Client Mute device role Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh.

Generated

from enum value: CLIENT_MUTE = 1;

LOST_AND_FOUND: 9

Lost and Found device role 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

Repeater device role 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

Router device role. 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. 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

Router Client device role 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.

Generated

from enum value: ROUTER_CLIENT = 3;

SENSOR: 6

Sensor device role 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

TAK device role 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;

TRACKER: 5

Tracker device role 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