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

Merge pull request #373 from meshtastic/module_cleanup

Browse source 
Module cleanup
This commit is contained in:
Garth Vander Houwen 2022-07-14 23:07:14 -07:00 committed by GitHub
parent 5fb2ec84d0 0041030f19
commit e2448d1943
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 19 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/settings/config/device.mdx
View file

@ -48,7 +48,7 @@ This setting is never saved to disk, but if set, all device settings will be ret
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},

2
docs/settings/config/display.mdx
View file

@ -36,7 +36,7 @@ Acceptable values:
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},

2
docs/settings/config/lora.mdx
View file

@ -79,7 +79,7 @@ For testing it is useful sometimes to force a node to never listen to particular
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},

2
docs/settings/config/position.mdx
View file

@ -77,7 +77,7 @@ The GPS updates will be sent out every Broadcast Interval, with either the actua
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},

13
docs/settings/moduleconfig/canned-message.mdx
View file

@ -189,6 +189,12 @@ No canned message test module config options are available in the Web UI.
</TabItem>
</Tabs>
:::warning
GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.
This module requires attaching a peripheral accessory to your device. It will not work without one.
:::
## Hardware
To navigate through messages and select one, you will require some hardware attached to your device. Currently, the module is tested with a generic rotary encoder, but this is not a limitation further input methods can be added in the future.
@ -257,10 +263,3 @@ meshtastic --set rotary1_enabled True
That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Module.
:::tip
Once module settings are changed, a **reset** is required for them to take effect.
:::
:::warning
GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.
:::

6
docs/settings/moduleconfig/external-notification.mdx
View file

@ -43,7 +43,7 @@ Default of 0 is 1000ms
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
@ -123,10 +123,6 @@ External Notification module config is not available for the Web UI.
</TabItem>
</Tabs>
:::tip
Once module settings are changed, a **reset** is required for them to take effect.
:::
:::warning
GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.

2
docs/settings/moduleconfig/range-test.mdx
View file

@ -31,7 +31,7 @@ How long to wait between sending test packets. 0 is default which disables sendi
<Tabs
groupId="settings"
defaultValue="cli"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},

16
docs/settings/moduleconfig/serial.mdx
View file

@ -11,14 +11,6 @@ The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmi
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
:::warning
GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.
:::
:::note
This module requires attaching a peripheral accessory to your device. It will not work without one.
:::
## Serial Module Config Values
### Enabled
@ -59,7 +51,7 @@ Once module settings are changed, a **reset** is required for them to take effec
<Tabs
groupId="settings"
defaultValue="flasher"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
@ -145,6 +137,12 @@ No serial test module config options are available in the Web UI.
</TabItem>
</Tabs>
:::warning
GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk.
This module requires attaching a peripheral accessory to your device. It will not work without one.
:::
## Examples
Default is to use RX GPIO 16 and TX GPIO 17.