meshtastic/docs/settings/input-broker-module.md

id	title	sidebar_label
input-broker-module	Input Broker	Input Broker

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';

:::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. :::

Overview

Meshtastic supports hardwired rotary encoders as input devices. Currently, one rotary encoder (rotary1) is defined, but later more rotary encoders can be added (if needed) the same way.

:::tip Once module settings are changed, a reset is required for them to take effect. :::

Settings

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)

rotary1_enabled

Enable the rotary encoder #1

Enable/Disable rotary1

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set rotary1_enabled true

meshtastic --set rotary1_enabled true

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_event_cw

Generate input event on CW of this kind.

:::tip For using with CannedMessageModule you must choose value KEY_UP here. :::

Specify rotary1 event cw

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set rotary1_event_press KEY_UP

meshtastic --set rotary1_event_press ""

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_event_ccw

Generate input event on CCW of this kind.

:::tip For using with CannedMessageModule you must choose value KEY_DOWN here. :::

Specify rotary1 event ccw

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set rotary1_event_ccw KEY_DOWN

meshtastic --set rotary1_event_ccw ""

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_event_press

Generate input event on Press of this kind.

:::tip For using with CannedMessageModule you must choose value KEY_SELECT here. :::

Specify rotary1 event press

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set rotary1_event_press KEY_SELECT

meshtastic --set rotary1_event_press ""

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_pin_a

GPIO pin for rotary encoder A port.

:::caution To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. :::

Specify rotary1 pin a

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

:::note Replace GPIO below with the GPIO number from hardware setup. :::

meshtastic --set rotary1_pin_a GPIO

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_pin_b

GPIO pin for rotary encoder B port.

:::caution To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. :::

Specify rotary1 pin b

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

:::note Replace GPIO below with the GPIO number from hardware setup. :::

meshtastic --set rotary1_pin_b GPIO

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

rotary1_pin_press

GPIO pin for rotary encoder Press port.

:::caution To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. :::

Specify rotary1 pin press

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

:::note Replace GPIO below with the GPIO number from hardware setup. :::

meshtastic --set rotary1_pin_press GPIO

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

Details

Configuring the rotary encoder module require attaching the compatible hardware.

Examples

Configure rotary encoder for Canned Message Module

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

:::note Replace each GPIO (x3) below with the GPIO numbers from hardware setup. :::

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

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::