device

The device config options are: Role, Rebroadcast Mode, GPIO for User Button, GPIO for PWM Buzzer, Node Info Broadcast Seconds, Double Tap as Button Press, Disable Triple Click, Timezone Definition, and LED Heartbeat Disabled. Device config uses an admin message sending a Config.Device protobuf.

Device Config Values

Roles

[^4]: This role has been deprecated as of firmware version 2.7.11 :::tip Still not sure which role to use? Check out our blog post: Choosing the Right Device Role :::

Looking for ROUTER_CLIENT? This role was deprecated in firmware 2.3.15. Learn more in the 2.3.15 release notes

Role Comparison

This table shows the default values after selecting a preset. As always, individual settings can be adjusted after choosing a preset.

[^1]: Awake Only indicates retransmissions will occur normally but not while asleep between transmission intervals.

[^2]: The ROUTER role enables Power Saving by default (ESP32 only). When needing to update a ROUTER via BLE, it's recommended you utilize an admin channel to temporarily change the role in order to update and then revert when done.

[^3]: Favorites Only indicates that the CLIENT_BASE will prioritize packets from or to any favorited nodes. From your CLIENT_BASE, you should favorite all of your other nodes which are typically within range of the better-positioned CLIENT_BASE base station.

Notes about Power Saving + Role behavior

ESP32 Platform Only

Every role except for the TRACKER and SENSOR roles are capable of traditional sleep behavior using the power.is_power_saving setting. When a node goes to sleep, in general, the serial console, peripherals, GPS, and WiFi/Bluetooth radio are all shut down to conserve power. The CPU will enter a low power state (light sleep or deep sleep on the ESP32). The LoRA radio will be left on stand-by for receiving any packets which will wake up the device to resume services and respond.

Timeout configurations of display.screen_on_secs (Screen timeout), power.min_wake_secs (Minimum time till sleep), and power.wait_bluetooth_secs (Bluetooth timeout) will delay a node's transition to a sleep state. The timeouts and subsequent transition to sleep states may also be reset by external events or actions such as receiving a packet, pressing a button, or connecting via client through serial or other means.

For the ROUTER role, the power.is_power_saving behavior of sleep is enabled automatically and cannot be turned off.

ESP32 and NRF52 Platforms

In the TRACKER and SENSOR roles, there are special sleep behaviors when combined with power.is_power_saving. For TRACKER, the device will go to sleep for position.position_broadcast_secs and upon waking will send a position packet when the GPS provides a valid location and repeat the cycle. For SENSOR, the device will go to sleep for telemetry.environment_update_interval and upon waking will gather environment data and send a telemetry packet and repeat the cycle. For both of these roles, the LoRA radio does not remain in standby mode to accept packets and wake up the device. Sleep remains constrained to their respective transmission intervals.

Rebroadcast Mode

This setting defines the device's behavior for how messages are rebroadcasted.

GPIO for User Button

This is the GPIO pin number that will be used for the user button, if your device does not come with a predefined user button.

GPIO for PWM Buzzer

This is the GPIO pin number that will be used for the PWM buzzer, if your device does not come with a predefined buzzer.

Node Info Broadcast Seconds

This is the number of seconds between NodeInfo message (containing i.a. long and short name) broadcasts from the device. The device will still respond ad-hoc to NodeInfo messages when a response is wanted. When the device hears any packet from a node it doesn't know yet, it will send its NodeInfo and ask for a response automatically.

Double Tap as Button Press

This option will enable a double tap, when a supported accelerometer is attached to the device, to be treated as a button press.

Disable Triple Click

Disables the triple-press of user button to enable or disable GPS.

TZDEF (Timezone Definition)

The tzdef setting allows the local offset to be defined for the device. It uses the TZ Database format to display the correct local time on the device display and in its logs.

To set the timezone, use the POSIX TZ Database string for the relevant region. Here is a list of supported timezones. For example, if your region is America/Los_Angeles, you would input PST8PDT,M3.2.0,M11.1.0 as the timezone.

LED Heartbeat Disabled

If true, disable the default blinking LED (LED_PIN) behavior on the device.

Device Config Client Availability

      <Icon icon="mdi:android" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Android
    </>
  ),
  value: "android",
},
{
  label: (
    <>
      <Icon icon="mdi:apple" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Apple
    </>
  ),
  value: "apple",
},
{
  label: (
    <>
      <Icon icon="mdi:terminal" height="1.5rem" style={{ marginRight: "0.25rem" }} /> CLI
    </>
  ),
  value: "cli",
},
{
  label: (
    <>
      <Icon icon="mdi:internet" height="1.5rem" style={{ marginRight: "0.25rem" }} /> Web
    </>
  ),
  value: "web",
},

]}>

Android

:::info

Device Config is available for Android.

1. Open the Meshtastic App
2. Navigate to: Vertical Ellipsis (3 dots top right) > Radio Configuration > Device

:::

Apple

:::info All device config options other than NTP Server are available on iOS, iPadOS and macOS at Settings > Device Configuration > Device. :::

CLI

:::info

All device config options are available in the python CLI. Example commands are below:

:::

:::tip

Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.

```shell title="Example:" meshtastic --set device.role CLIENT --set device.tzdef UTC0

:::

```shell title="Set the role to client"
meshtastic --set device.role CLIENT

shell title="Set tzdef" meshtastic --set device.tzdef UTC0

Web

:::info All device config options are available in the Web UI. :::