Merge branch 'master' into lora-config

This commit is contained in:
Ben Meadors 2023-07-05 06:05:00 -05:00 committed by GitHub
commit 6ee94d3df6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 16 additions and 38 deletions

View file

@ -62,17 +62,7 @@ To ensure devices with different PRIMARY channel name transmit on the same frequ
## Channel Settings Values ## Channel Settings Values
The Channel Settings options are: ID, Name, PSK, Downlink Enabled, and Uplink Enabled. Channel settings are embedded in the `Channel` protobuf as a `ChannelSettings` protobuf and sent as an admin message. The Channel Settings options are: Name, PSK, Downlink Enabled, and Uplink Enabled. Channel settings are embedded in the `Channel` protobuf as a `ChannelSettings` protobuf and sent as an admin message.
:::note
The full globally unique ID will be constructed from the Name and ID (`<name>.<id>`) where ID is base36 encoded. Assuming that the number of Meshtastic users is below 20K (true for a long time) the chance of this 64 bit random number colliding with anyone else is super low. The penalty for collision is low as well.
:::
### ID
Used to construct a globally unique channel ID.
Set to `0` by default.
### Name ### Name
@ -103,6 +93,8 @@ If enabled, messages from the mesh will be sent to the **public** internet throu
Set to `false` by default for all channels. Set to `false` by default for all channels.
## Examples
<Tabs <Tabs
groupId="settings" groupId="settings"
defaultValue="cli" defaultValue="cli"
@ -162,11 +154,6 @@ meshtastic --ch-set name "My Channel" --ch-set psk random --ch-set uplink_enable
::: :::
### Id
```shell title="Set the PRIMARY channel ID"
meshtastic --ch-set id 1234 --ch-index 0
```
### Name ### Name

View file

@ -12,6 +12,8 @@ The Canned Message Module will allow you to send messages to the mesh network fr
The canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf. The canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf.
<object data="https://www.youtube.com/embed/qKQVYUbLLkg?autohide=1&autoplay=0" width="100%" height="400"></object>
## Canned Message Module Config Values ## Canned Message Module Config Values
### Enabled ### Enabled
@ -219,9 +221,9 @@ Example: 1|2|3||5|6|7||9|10|11||13|14|15 - the slots 4,8 and 12 can not be used.
The CardKB is fully supported in freetext mode and select mode. Use UP/DOWN/ENTER to select a predefined message and send it. For a freetext message, just type it in and press ENTER to send it. The CardKB is fully supported in freetext mode and select mode. Use UP/DOWN/ENTER to select a predefined message and send it. For a freetext message, just type it in and press ENTER to send it.
If you don't want to broadcast your freetext message, you can use the CardKB to send it to a specific node. Just press TAB and select the target node with the LEFT/RIGHT keys. The message will be sent to the node with the matching name and node number. The target node will be remebered for your nexxt message. If you don't want to broadcast your freetext message, you can use the CardKB to send it to a specific node. Just press TAB and select the target node with the LEFT/RIGHT keys. The message will be sent to the node with the matching name and node number. The target node will be remembered for your next message.
### 3 Buttun up/down and RAK rotary encoder ### 3 Button up/down and RAK rotary encoder
Just use UP/DOWN/ENTER to select a predefined message and send it. Just use UP/DOWN/ENTER to select a predefined message and send it.

View file

@ -22,7 +22,7 @@ The [T-Beam 0.7](/docs/hardware/devices/tbeam#t-beam---v07) board is an earlier
::: :::
## Command Line Interface Instructions ## Command Line Interface Instructions
### Install Prerequisite Software
<Tabs <Tabs
groupId="operating-system" groupId="operating-system"
defaultValue="linux" defaultValue="linux"
@ -33,7 +33,6 @@ values={[
]}> ]}>
<TabItem value="linux"> <TabItem value="linux">
### Install Prerequisite Software
Check if you have `python3` and `pip` installed with the following command Check if you have `python3` and `pip` installed with the following command
@ -53,18 +52,12 @@ If `pip` is not installed, install with
```shell ```shell
sudo apt-get install python3-pip sudo apt-get install python3-pip
```
### Install `esptool`
```shell
pip3 install --upgrade esptool
``` ```
</TabItem> </TabItem>
<TabItem value="macos"> <TabItem value="macos">
### Install Prerequisite Software
OS X comes with `Python 2.7` installed, but not `pip`. The following uses Homebrew to install `python3` which includes `pip3`. On MacOS you will use `pip3` instead > of `pip`. OS X comes with `Python 2.7` installed, but not `pip`. The following uses Homebrew to install `python3` which includes `pip3`. On MacOS you will use `pip3` instead > of `pip`.
@ -96,12 +89,6 @@ Confirm `pip3` was installed alongside `python3`
```shell ```shell
pip3 -v pip3 -v
```
### Install `esptool`
```shell
pip3 install --upgrade esptool
``` ```
</TabItem> </TabItem>
@ -123,15 +110,17 @@ pip --version
::: :::
### Install `esptool`
```shell
pip install --upgrade esptool
```
</TabItem> </TabItem>
</Tabs> </Tabs>
### Install `esptool`
```shell
pip3 install --upgrade esptool
```
### Confirm Communication With Chip ### Confirm Communication With Chip
<Tabs <Tabs