mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-03-05 21:00:08 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

swapped rotary1 with inputbroker

Browse source
This commit is contained in:
Foster Irwin 2022-04-22 10:16:15 -06:00
parent 411a190924
commit e5662ae19a
1 changed files with 32 additions and 32 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 | | Setting | Acceptable Values | Default |
| :-----------------: | :---------------: | :-----------: | | :-----------------: | :---------------: | :-----------: |
| rotary1_enabled | `true`, `false` | `false` | | inputbroker_enabled | `true`, `false` | `false` |
| rotary1_event_cw | `InputEventChar` | (not defined) | | inputbroker_event_cw | `InputEventChar` | (not defined) |
| rotary1_event_ccw | `InputEventChar` | (not defined) | | inputbroker_event_ccw | `InputEventChar` | (not defined) |
| rotary1_event_press | `InputEventChar` | (not defined) | | inputbroker_event_press | `InputEventChar` | (not defined) |
| rotary1_pin_a | `integer` | (not defined) | | inputbroker_pin_a | `integer` | (not defined) |
| rotary1_pin_b | `integer` | (not defined) | | inputbroker_pin_b | `integer` | (not defined) |
| rotary1_pin_press | `integer` | (not defined) | | inputbroker_pin_press | `integer` | (not defined) |
### rotary1_enabled ### inputbroker_enabled
Enable the rotary encoder #1 Enable the rotary encoder #1
@ -60,11 +60,11 @@ values={[
<TabItem value="cli"> <TabItem value="cli">
```shell title="Enable rotary1" ```shell title="Enable rotary1"
meshtastic --set rotary1_enabled true meshtastic --set inputbroker_enabled true
``` ```
```shell title="Disable rotary1" ```shell title="Disable rotary1"
meshtastic --set rotary1_enabled true meshtastic --set inputbroker_enabled true
``` ```
</TabItem> </TabItem>
@ -91,7 +91,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_event_cw ### inputbroker_event_cw
Generate input event on CW of this kind. Generate input event on CW of this kind.
@ -113,11 +113,11 @@ values={[
<TabItem value="cli"> <TabItem value="cli">
```shell title="Set rotary1 event cw to 'KEY_UP'" ```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" ```shell title="Unset rotary1 event cw"
meshtastic --set rotary1_event_press "" meshtastic --set inputbroker_event_press ""
``` ```
</TabItem> </TabItem>
@ -144,7 +144,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_event_ccw ### inputbroker_event_ccw
Generate input event on CCW of this kind. Generate input event on CCW of this kind.
@ -166,11 +166,11 @@ values={[
<TabItem value="cli"> <TabItem value="cli">
```shell title="Set rotary1 event ccw to 'KEY_DOWN'" ```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" ```shell title="Unset rotary1 event ccw"
meshtastic --set rotary1_event_ccw "" meshtastic --set inputbroker_event_ccw ""
``` ```
</TabItem> </TabItem>
@ -197,7 +197,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_event_press ### inputbroker_event_press
Generate input event on Press of this kind. Generate input event on Press of this kind.
@ -219,11 +219,11 @@ values={[
<TabItem value="cli"> <TabItem value="cli">
```shell title="Set rotary1 event press to 'KEY_SELECT'" ```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" ```shell title="Unset rotary1 event press"
meshtastic --set rotary1_event_press "" meshtastic --set inputbroker_event_press ""
``` ```
</TabItem> </TabItem>
@ -250,7 +250,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_pin_a ### inputbroker_pin_a
GPIO pin for rotary encoder A port. 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" ```shell title="Specify rotary1 pin a"
meshtastic --set rotary1_pin_a GPIO meshtastic --set inputbroker_pin_a GPIO
``` ```
</TabItem> </TabItem>
@ -303,7 +303,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_pin_b ### inputbroker_pin_b
GPIO pin for rotary encoder B port. 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" ```shell title="Specify rotary1 pin b"
meshtastic --set rotary1_pin_b GPIO meshtastic --set inputbroker_pin_b GPIO
``` ```
</TabItem> </TabItem>
@ -356,7 +356,7 @@ Configuring this setting is not yet available for the selected platform. If this
</TabItem> </TabItem>
</Tabs> </Tabs>
### rotary1_pin_press ### inputbroker_pin_press
GPIO pin for rotary encoder Press port. 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" ```shell title="Specify rotary1 pin press"
meshtastic --set rotary1_pin_press GPIO meshtastic --set inputbroker_pin_press GPIO
``` ```
</TabItem> </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" ```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
meshtastic --set rotary1_pin_a GPIO meshtastic --set inputbroker_pin_a GPIO
meshtastic --set rotary1_pin_b GPIO meshtastic --set inputbroker_pin_b GPIO
meshtastic --set rotary1_pin_press GPIO meshtastic --set inputbroker_pin_press GPIO
meshtastic --set rotary1_event_cw KEY_UP meshtastic --set inputbroker_event_cw KEY_UP
meshtastic --set rotary1_event_ccw KEY_DOWN meshtastic --set inputbroker_event_ccw KEY_DOWN
meshtastic --set rotary1_event_press KEY_SELECT meshtastic --set inputbroker_event_press KEY_SELECT
meshtastic --set rotary1_enabled True meshtastic --set inputbroker_enabled True
``` ```
</TabItem> </TabItem>