mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 06:04:22 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #320 from jfirwin/remaining-plugin-module-fixes

Browse source 
extra module fixes
This commit is contained in:
Foster Irwin 2022-04-22 10:30:54 -06:00 committed by GitHub
parent f4b6ace933 7005657167
commit d102b56318
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 38 additions and 102 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

64
docs/settings/modules/input-broker-module.mdx
View file

@ -34,15 +34,15 @@ Once module settings are changed, a **reset** is required for them to take effec
| Setting | Acceptable Values | Default |
| :-----------------: | :---------------: | :-----------: |
| rotary1_enabled | `true`, `false` | `false` |
| rotary1_event_cw | `InputEventChar` | (not defined) |
| rotary1_event_ccw | `InputEventChar` | (not defined) |
| rotary1_event_press | `InputEventChar` | (not defined) |
| rotary1_pin_a | `integer` | (not defined) |
| rotary1_pin_b | `integer` | (not defined) |
| rotary1_pin_press | `integer` | (not defined) |
| inputbroker_enabled | `true`, `false` | `false` |
| inputbroker_event_cw | `InputEventChar` | (not defined) |
| inputbroker_event_ccw | `InputEventChar` | (not defined) |
| inputbroker_event_press | `InputEventChar` | (not defined) |
| inputbroker_pin_a | `integer` | (not defined) |
| inputbroker_pin_b | `integer` | (not defined) |
| inputbroker_pin_press | `integer` | (not defined) |
### rotary1_enabled
### inputbroker_enabled
Enable the rotary encoder #1
@ -60,11 +60,11 @@ values={[
<TabItem value="cli">
```shell title="Enable rotary1"
meshtastic --set rotary1_enabled true
meshtastic --set inputbroker_enabled true
```
```shell title="Disable rotary1"
meshtastic --set rotary1_enabled true
meshtastic --set inputbroker_enabled true
```
</TabItem>
@ -91,7 +91,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_event_cw
### inputbroker_event_cw
Generate input event on CW of this kind.
@ -113,11 +113,11 @@ values={[
<TabItem value="cli">
```shell title="Set rotary1 event cw to 'KEY_UP'"
meshtastic --set rotary1_event_press KEY_UP
meshtastic --set inputbroker_event_press KEY_UP
```
```shell title="Unset rotary1 event cw"
meshtastic --set rotary1_event_press ""
meshtastic --set inputbroker_event_press ""
```
</TabItem>
@ -144,7 +144,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_event_ccw
### inputbroker_event_ccw
Generate input event on CCW of this kind.
@ -166,11 +166,11 @@ values={[
<TabItem value="cli">
```shell title="Set rotary1 event ccw to 'KEY_DOWN'"
meshtastic --set rotary1_event_ccw KEY_DOWN
meshtastic --set inputbroker_event_ccw KEY_DOWN
```
```shell title="Unset rotary1 event ccw"
meshtastic --set rotary1_event_ccw ""
meshtastic --set inputbroker_event_ccw ""
```
</TabItem>
@ -197,7 +197,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_event_press
### inputbroker_event_press
Generate input event on Press of this kind.
@ -219,11 +219,11 @@ values={[
<TabItem value="cli">
```shell title="Set rotary1 event press to 'KEY_SELECT'"
meshtastic --set rotary1_event_press KEY_SELECT
meshtastic --set inputbroker_event_press KEY_SELECT
```
```shell title="Unset rotary1 event press"
meshtastic --set rotary1_event_press ""
meshtastic --set inputbroker_event_press ""
```
</TabItem>
@ -250,7 +250,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_pin_a
### inputbroker_pin_a
GPIO pin for rotary encoder A port.
@ -276,7 +276,7 @@ Replace `GPIO` below with the GPIO number from hardware setup.
:::
```shell title="Specify rotary1 pin a"
meshtastic --set rotary1_pin_a GPIO
meshtastic --set inputbroker_pin_a GPIO
```
</TabItem>
@ -303,7 +303,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_pin_b
### inputbroker_pin_b
GPIO pin for rotary encoder B port.
@ -329,7 +329,7 @@ Replace `GPIO` below with the GPIO number from hardware setup.
:::
```shell title="Specify rotary1 pin b"
meshtastic --set rotary1_pin_b GPIO
meshtastic --set inputbroker_pin_b GPIO
```
</TabItem>
@ -356,7 +356,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem>
</Tabs>
### rotary1_pin_press
### inputbroker_pin_press
GPIO pin for rotary encoder Press port.
@ -382,7 +382,7 @@ Replace `GPIO` below with the GPIO number from hardware setup.
:::
```shell title="Specify rotary1 pin press"
meshtastic --set rotary1_pin_press GPIO
meshtastic --set inputbroker_pin_press GPIO
```
</TabItem>
@ -435,13 +435,13 @@ Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup.
:::
```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
meshtastic --set rotary1_pin_a GPIO
meshtastic --set rotary1_pin_b GPIO
meshtastic --set rotary1_pin_press GPIO
meshtastic --set rotary1_event_cw KEY_UP
meshtastic --set rotary1_event_ccw KEY_DOWN
meshtastic --set rotary1_event_press KEY_SELECT
meshtastic --set rotary1_enabled True
meshtastic --set inputbroker_pin_a GPIO
meshtastic --set inputbroker_pin_b GPIO
meshtastic --set inputbroker_pin_press GPIO
meshtastic --set inputbroker_event_cw KEY_UP
meshtastic --set inputbroker_event_ccw KEY_DOWN
meshtastic --set inputbroker_event_press KEY_SELECT
meshtastic --set inputbroker_enabled True
```
</TabItem>

64
docs/settings/modules/telemetry-module.mdx
View file

@ -109,22 +109,12 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
```shell title="Display Farenheit"
meshtastic --set telemetry_module_display_farenheit true
```
````shell title="Display Celsius"
meshtastic --set telemetry_module_display_farenheit false
=======
```shell title="Display Farenheit"
meshtastic --set telemetry_module_environment_display_fahrenheit true
````
```shell title="Display Celsius"
meshtastic --set telemetry_module_environment_display_fahrenheit false
>>>>>>> master:docs/settings/telemetry-module.md
```
</TabItem>
@ -168,22 +158,12 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
```shell title="Enable Module"
meshtastic --set telemetry_module_measurement_enabled true
```
````shell title="Disable Module"
meshtastic --set telemetry_module_measurement_enabled false
=======
```shell title="Enable Module"
meshtastic --set telemetry_module_environment_measurement_enabled true
````
```shell title="Disable Module"
meshtastic --set telemetry_module_environment_measurement_enabled false
>>>>>>> master:docs/settings/telemetry-module.md
```
</TabItem>
@ -227,14 +207,8 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
````shell title="Configure telemetry_module_read_error_count_threshold to 3 tries"
meshtastic --set telemetry_module_read_error_count_threshold 3
=======
```shell title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries"
meshtastic --set telemetry_module_environment_read_error_count_threshold 3
>>>>>>> master:docs/settings/telemetry-module.md
````
</TabItem>
@ -278,14 +252,8 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
````shell title="Configure telemetry_module_recovery_interval to 120 seconds"
meshtastic --set telemetry_module_recovery_interval 120
=======
```shell title="Configure telemetry_module_environment_recovery_interval to 120 seconds"
meshtastic --set telemetry_module_environment_recovery_interval 120
>>>>>>> master:docs/settings/telemetry-module.md
````
</TabItem>
@ -329,22 +297,12 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
```shell title="Enable on device screen"
meshtastic --set telemetry_module_screen_enabled true
```
````shell title="Disable on device screen"
meshtastic --set telemetry_module_screen_enabled false
=======
```shell title="Enable on device screen"
meshtastic --set telemetry_module_environment_screen_enabled true
````
```shell title="Disable on device screen"
meshtastic --set telemetry_module_environment_screen_enabled false
>>>>>>> master:docs/settings/telemetry-module.md
```
</TabItem>
@ -396,14 +354,8 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
````shell title="Set module sensor pin"
meshtastic --set telemetry_module_sensor_pin PINNUMBER
=======
```shell title="Set module sensor pin"
meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER
>>>>>>> master:docs/settings/telemetry-module.md
````
</TabItem>
@ -470,22 +422,12 @@ values={[
The CLI is able to take the `value` or the `name` of the sensor from the table above.
:::
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
```shell title="Set sensor type to DS18B20"
meshtastic --set telemetry_module_sensor_type 1
```
````shell title="Set sensor type to DS18B20"
meshtastic --set telemetry_module_sensor_type DS18B20
=======
```shell title="Set sensor type to DS18B20"
meshtastic --set telemetry_module_environment_sensor_type 2
````
```shell title="Set sensor type to DS18B20"
meshtastic --set telemetry_module_environment_sensor_type DS18B20
>>>>>>> master:docs/settings/telemetry-module.md
```
</TabItem>
@ -525,14 +467,8 @@ values={[
]}>
<TabItem value="cli">
<<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx
````shell title="Set module update interval to 15 seconds"
meshtastic --set telemetry_module_update_interval 15
=======
```shell title="Set module update interval to 120 seconds"
meshtastic --set telemetry_module_environment_update_interval 120
>>>>>>> master:docs/settings/telemetry-module.md
````
</TabItem>

2
docs/software/modules/canned-message.mdx
View file

@ -98,7 +98,7 @@ The rotary encoder #1 will send input events under name "rotEnc1".
## Configuration of the module
<PluginModule name="canned_message_" rename="canned_message_" />
<PluginModule name="canned_message_plugin" rename="canned_message_module" />
Following configuration can be set for the module.

2
docs/software/modules/external-notifications.mdx
View file

@ -12,7 +12,7 @@ The ExternalNotification Module will allow you to connect a speaker, LED or othe
## Configuration
<PluginModule name="ext_notification_" rename="ext_notification_" />
<PluginModule name="ext_notification_plugin" rename="ext_notification_module" />
These are the settings that can be configured.

2
docs/software/modules/serial.mdx
View file

@ -12,7 +12,7 @@ This is a simple interface to send messages over the mesh network by sending str
Default is to use RX GPIO 16 and TX GPIO 17.
<PluginModule name="serial_" rename="serial_" />
<PluginModule name="serial_plugin" rename="serial_module" />
## Basic Usage:

2
docs/software/modules/store-forward.mdx
View file

@ -52,7 +52,7 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly
### Router setup
<PluginModule name="store_forward_" rename="store_forward_" />
<PluginModule name="store_forward_module" rename="store_forward_plugin" />
- Configure your device as a [Meshtastic router](/docs/settings/router).
- Configure the Store and Forward Module

2
docs/software/modules/telemetry.mdx
View file

@ -6,7 +6,7 @@ sidebar_label: Telemetry
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
<PluginModule name="telemetry_" rename="environmental_measurment_" />
<PluginModule name="telemetry_module_environment" rename="environmental_measurement_plugin" />
## About

2
src/components/HardwareComponents.tsx
View file

@ -98,7 +98,7 @@
// </tr>
// <tr>
// <td style={{align: "center"}}>
// Module - Telemetry (aka Environmental Measurment)
// Module - Telemetry (aka Environmental Measurement)
// </td>
// <td style={{align: "center"}}>
// VALUE