mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-20 08:07:33 -07:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

changes made per review

Browse source
This commit is contained in:
sigmahour 2022-10-11 11:47:48 -04:00
parent 2e50d10549
commit 4905644599
1 changed files with 17 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/settings/config/channels.mdx
View file

@ -10,11 +10,11 @@ import TabItem from '@theme/TabItem';
The Channels config options are: Index, Roles, and Settings. Channel config uses an admin message sending a `Channel` protobuf which also consists of a `ChannelSettings` protobuf.
:::info
**Channel Settings** (as described on this page) should not be confused with [LoRa Radio Settings](/docs/settings/config/lora)
**Channel Settings** (as described on this page) should not be confused with [Modem Preset Settings](/docs/settings/config/lora#modem-preset)
[LoRa Radio Settings](/docs/settings/config/lora) contain the modem configuration (frequency settings, spreading factor, bandwidth, etc.) used for the radio. These settings are identical for all channels and can *not* be unique per channel. Radio settings are directly applied to the Primary channel from which all Secondary channels derive their radio settings.
[Modem Preset Settings](/docs/settings/config/lora#modem-preset) contain the modem configuration (frequency settings, spreading factor, bandwidth, etc.) used for the LoRa radio. These settings are identical for all channels and can **not** be unique per channel. Modem settings are directly applied to the Primary channel from which all Secondary channels derive their modem settings.
**Channel Settings** contain information for segregating message groups, configuring optional encryption, and enabling or disabling messaging over internet gateways. These settings *are* unique and configurable per channel.
**Channel Settings** contain information for segregating message groups, configuring optional encryption, and enabling or disabling messaging over internet gateways. These settings **are** unique and configurable per channel.
:::
## Channel Config Values
@ -34,7 +34,12 @@ _Indexing_ can not be modified.
| 4 | 5 | `DISABLED` | User defined |
| 5 | 6 | `DISABLED` | User defined |
| 6 | 7 | `DISABLED` | User defined |
| 7 | 8 | `SECONDARY` | Used as `admin` channel |
| 7 | 8 | `DISABLED` | User defined |
:::note
You can **not** have `DISABLED` channels inbetween active channels such as `PRIMARY` and `SECONDARY`. Active channels must be consecutive.
:::
### Role
@ -44,14 +49,14 @@ Each channel is assigned one of 3 roles:
- This is the first channel that is created for you on initial setup.
- Can not be disabled.
- Only one primary channel can exist.
- All secondary channels derive their [Radio Settings](/docs/settings/config/lora) from this channel.
- All secondary channels derive their [Modem Presets](/docs/settings/config/lora#modem-preset) from this channel.
- Direct messages are only available on this channel.
2. `SECONDARY` or `2`
- Derives its [Radio Settings](/docs/settings/config/lora) from the primary channel.
- Derives its [Modem Preset](/docs/settings/config/lora#modem-preset) from the primary channel.
- Can modify the encryption key (psk).
3. `DISABLED` or `0`
- The channel is no longer available for use.
- Channel Settings are cleared.
- Channel settings are cleared.
## Channel Settings Values
@ -67,11 +72,13 @@ The full globally unique ID will be `name.id` where ID is base36 encoded. Assumi
### Name
A short identifier (< 12 bytes) for the channel.
A short identifier _(< 12 bytes)_ for the channel.
Empty `""` by default for all channels.
| Reserved Name | Purpose |
| :--------------------: | :----------------: |
| `""` (default) | If left empty on the primary channel, this designates the `default` channel. |
| `admin` | On Secondary channels, the name `admin` (case sensitive) designates the `admin` channel used to administer nodes over the mesh |
If this is left an empty string it is assumed that this channel is the `default` channel.
### PSK