meshtastic/docs/software/settings/channel.md

11 KiB

id title sidebar_label
channel Channel Settings Channel

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Overview

Channel settings are an integral part of the way your devices communicate across the mesh. If you have mismatched channel settings, your radios will be unable to communicate with one another.

Settings

Setting Acceptable Values Default
downlink_enabled true, false false
id integer 0
modem_config Bw125Cr45Sf128, Bw500Cr45Sf128, Bw31_25Cr48Sf512, Bw125Cr48Sf4096 TODO
name string ""
psk 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, none, default, random 1
region Unset, US, EU433, EU865, CN, JP, ANZ, KR, TW, RU Unset
uplink_enabled true, false false

If true, messages seen on the internet will be forwarded to the local mesh through a gateway node. See MQTT settings for more details.

:::caution This is in active development and not ready for casual users. Testing only. :::

id

Set Channel ID

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --ch-set id 1234 --ch-index 0

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::note The channel id must be an integer. :::

modem_config

Setting Name Bandwidth Coding Rate Spread Factor Speed
Bw125Cr45Sf128 ShortSlow 125 kHz 4/5 7 = 128chips/symbol 5.469 kbps
Bw500Cr45Sf128 ShortFast 500 kHz 4/5 7 = 128chips/symbol 21.875 kbps
Bw31_25Cr48Sf512 LongFast 31.25 kHz 4/8 9 = 512chips/symbol 275 bps
Bw125Cr48Sf4096 LongSlow 125 kHz 4/8 12 = 4096chips/symbol 183 bps

Set Modem

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --ch-set modem_config Bw125Cr48Sf4096 --ch-index 0

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::tip For advanced modem configuration, see Channel Settings - Advanced. :::

name

The name of the channel. If this is left an empty string it is assumed that this channel is the special (minimally secure) "Default" channel. Channel Names should be short (less than 12 bytes).

Set Channel Name

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --ch-set name MyChannel --ch-index 0
meshtastic --ch-set name "My Channel" --ch-index 0

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::note A channel id must be set in order to name a channel. :::

psk

:::note Selecting a number from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. :::

Setting Behavior
0 Disable Encryption
1 Default Encryption
2-10 Default Encryption, except with 1-9 added to the last byte
Setting Behavior
none Disable Encryption
default Default Encryption (use the weak encryption key)
random Generate a secure 256-bit encryption key. Use this setting for private communication.

:::tip If you use Meshtastic for exchanging messages you don't want other people to see, random is the setting you should use. :::

Set/Disable Encryption

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --ch-set psk default --ch-index 0
meshtastic --ch-set psk random --ch-index 0
meshtastic --ch-set psk none --ch-index 0

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

region

The region variable sets which region your radio is configured to work in. It is important to ensure that you've set it to the correct region. If left Unset, it will default to US settings.

Name Center Frequency Spacing Number of Channels Power Limit
US 903.08 2.16 13 0
EU433 433.175 0.2 8 0
EU865 865.2 0.3 10 0
CN 470.0 2.0 20 0
JP 920.0 0.5 10 13
ANZ 916.0 0.5 20 0
KR 921.9 0.2 8 0
TW 923.0 0.2 10 0
RU 868.9 0.2 2 20
Unset 903.08 2.16 13 0
:::note
For more details about region settings, you can see the source code here
:::

Set Region

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set region Unset
meshtastic --set region US

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

If true, messages on the mesh will be sent to the public internet by any gateway node. See MQTT settings for more details.