From 93ffbee39b7193485f38302c65f86161b4761cf2 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sat, 25 Jun 2022 00:39:41 -0700 Subject: [PATCH] Seperate the plugins / modules --- docs/settings/moduleconfig/canned-message.mdx | 279 ++++++++++ .../moduleconfig/external-notification.mdx | 337 ++++++++++++ docs/settings/moduleconfig/serial.mdx | 2 +- .../moduleconfig/store-and-forward.mdx | 336 ++++++++++++ docs/settings/moduleconfig/telemetry.mdx | 506 ++++++++++++++++++ .../modules/canned-message-module.mdx | 75 ++- .../modules/external-notification-module.mdx | 69 ++- docs/settings/modules/input-broker.mdx | 468 ++++++++++++++++ .../modules/store-and-forward-module.mdx | 91 ++-- docs/settings/modules/telemetry-module.mdx | 115 ++-- 10 files changed, 2092 insertions(+), 186 deletions(-) create mode 100644 docs/settings/moduleconfig/canned-message.mdx create mode 100644 docs/settings/moduleconfig/external-notification.mdx create mode 100644 docs/settings/moduleconfig/store-and-forward.mdx create mode 100644 docs/settings/moduleconfig/telemetry.mdx create mode 100644 docs/settings/modules/input-broker.mdx diff --git a/docs/settings/moduleconfig/canned-message.mdx b/docs/settings/moduleconfig/canned-message.mdx new file mode 100644 index 00000000..749d01f2 --- /dev/null +++ b/docs/settings/moduleconfig/canned-message.mdx @@ -0,0 +1,279 @@ +--- +id: canned-message +title: Canned Message Module Configuration +sidebar_label: Canned Message +--- + +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. It also requires use of the [Rotary Encoder Module](input-broker-module) to configure the input source. +::: + +## Overview + +The CannedMessage Module will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. + +:::tip +Once module settings are changed, a **reset** is required for them to take effect. +::: + +## Settings + +| Setting | Acceptable Values | Default | +| :--------------------------------------: | :---------------: | :-----: | +| canned_message_module_allow_input_source | `rotEnc1`, `_any` | `_any` | +| canned_message_module_enabled | `true`, `false` | `false` | +| canned_message_module_messages | `string` | `""` | +| canned_message_module_send_bell | `true`, `false` | `false` | +| (Messages)\* | `string` | `""` | + +- Messages can be set with a dedicated option: + +`--set-canned-message ""` + +### canned_message_module_allow_input_source + +Input event source accepted by the canned message module. + +| Value | Description | +| :-------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `_any` | Default. Allows any peripheral input device connected to the device. | +| `rotEnc1` | Hardcoded value naming the input device that this module listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. | + +#### Set input source + + + + +```shell title="Set Allowed Input Source" +meshtastic --set canned_message_module_allow_input_source "_any" +``` + +```shell title="Specify Allowed Input Source" +meshtastic --set canned_message_module_allow_input_source "rotEnc1" +``` + + + + +:::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. +::: + + + + +### canned_message_module_enabled + +Enables the module. + +:::tip +Using the canned message module requires you set up the [Rotary Encoder Module](input-broker-module). See [prerequisites](#prerequisites) below. +::: + +#### Enable/Disable the module + + + + +```shell title="Enable Canned Message Module" +meshtastic --set canned_message_module_enabled true +``` + +```shell title="Disable Canned Message Module" +meshtastic --set canned_message_module_enabled false +``` + + + + +:::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. +::: + + + + +### canned_message_module_send_bell + +CannedMessageModule also sends a "bell character" with the messages. +The [External Notification Module](external-notification-module) can benefit from this feature as it utilizes the bell character. + +_We have an "External Notification Module", that can be set up to beep, when new message arrives. +This module can also be configured to beep only when message contains the "bell character". +See module documentation (link above) for details._ + +#### Enable/Disable bell character + + + + +```shell title="Enable Bell Character" +meshtastic --set canned_message_module_send_bell true +``` + +```shell title="Disable Bell Character" +meshtastic --set canned_message_module_send_bell false +``` + + + + +:::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. +::: + + + + +### Messages + +CLI has a dedicated option for canned message module to set predefines messages: `--set-canned-message ` +Predefined messages separated by `|` characters. + +You can define up to 50 messages with a total length 800 bytes. + +Existing configuration can be queried with CLI option: `--get-canned-message` + +#### Set canned messages + + + + +```shell title="Set Canned Messages" +meshtastic --set canned_message_module_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger" +``` + + + + +:::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 + +### Prerequisites + + + +- Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step. +- Once attached, configure peripheral device with [Rotary Encoder Module](input-broker-module) Settings. + +:::note +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 +``` + +::: +That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Module. diff --git a/docs/settings/moduleconfig/external-notification.mdx b/docs/settings/moduleconfig/external-notification.mdx new file mode 100644 index 00000000..cea973f7 --- /dev/null +++ b/docs/settings/moduleconfig/external-notification.mdx @@ -0,0 +1,337 @@ +--- +id: external-notification +title: External Notification Module Settings +sidebar_label: External Notification +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::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 + +The External Notification Module will allow you to connect a speaker, LED, or other device to notify you when a message has been received from the mesh network. + +:::tip +Once module settings are changed, a **reset** is required for them to take effect. +::: + +## Settings + +| Setting | Acceptable Values | Default | +| :-----------------------------------: | :----------------------: | :-----: | +| ext_notification_module_active | `true`, `false` | `false` | +| ext_notification_module_alert_bell | `true`, `false` | `false` | +| ext_notification_module_alert_message | `true`, `false` | `false` | +| ext_notification_module_enabled | `true`, `false` | `false` | +| ext_notification_module_output | `integer` | `0` | +| ext_notification_module_output_ms | `integer` (milliseconds) | `0` | + +### ext_notification_module_active + +Specifies whether the external circuit is triggered when the device's GPIO is low or high. + +:::caution +To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. +::: + +#### Specify High/Low GPIO triggers circuit + + + + +```shell title="GPIO active high" +meshtastic --set ext_notification_module_active true +``` + +```shell title="GPIO active low (default)" +meshtastic --set ext_notification_module_active false +``` + + + + +:::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. +::: + + + + +### ext_notification_module_alert_bell + +Specifies if an alert should be sent when receiving an incoming bell. + +#### Enable/Disable alert on incoming bell + + + + +```shell title="Enable alert on incoming bell" +meshtastic --set ext_notification_module_alert_bell true +``` + +```shell title="Disable alert on incoming bell" +meshtastic --set ext_notification_module_alert_bell false +``` + + + + +:::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. +::: + + + + +### ext_notification_module_alert_message + +Specifies if an alert should be sent when receiving an incoming message. + +#### Enable/Disable Alert on incoming message + + + + +```shell title="Enable alert on incoming message" +meshtastic --set ext_notification_module_alert_message true +``` + +```shell title="Disable alert on incoming message" +meshtastic --set ext_notification_module_alert_message false +``` + + + + +:::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. +::: + + + + +### ext_notification_module_enabled + +Enables the module. + +#### Enable/Disable the module + + + + +```shell title="Enable Module" +meshtastic --set ext_notification_module_enabled true +``` + +```shell title="Disable Module" +meshtastic --set ext_notification_module_enabled false +``` + + + + +:::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. +::: + + + + +### ext_notification_module_output + +Specifies the GPIO that your external circuit is attached to on the device. + +:::caution +To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. +::: + +#### Specify GPIO for circuit to monitor + + + + +:::note +Replace `GPIO` in the below command with the GPIO number your circuit is attached to. +::: + +```shell title="Specify GPIO that circuit is connected to" +meshtastic --set ext_notification_module_output 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. +::: + + + + +### ext_notification_module_output_ms + +Specifies how long in milliseconds you would like your external circuit triggered. Default is `1000`. (Because of the way that defaults are handled in the protobufs `0` is interpreted as `1000`) + +#### Specify how many milliseconds to trigger circuit + + + + +```shell title="Set to default (1000ms)" +meshtastic --set ext_notification_module_output_ms 0 +``` + +```shell title="Set to other value" +meshtastic --set ext_notification_module_output_ms 1500 +``` + + + + +:::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. +::: + + + diff --git a/docs/settings/moduleconfig/serial.mdx b/docs/settings/moduleconfig/serial.mdx index affd6f48..691f24e3 100644 --- a/docs/settings/moduleconfig/serial.mdx +++ b/docs/settings/moduleconfig/serial.mdx @@ -1,6 +1,6 @@ --- id: serial -title: Serial Module Settings +title: Serial Module Configuration sidebar_label: Serial --- diff --git a/docs/settings/moduleconfig/store-and-forward.mdx b/docs/settings/moduleconfig/store-and-forward.mdx new file mode 100644 index 00000000..9dbfef9a --- /dev/null +++ b/docs/settings/moduleconfig/store-and-forward.mdx @@ -0,0 +1,336 @@ +--- +id: store-and-forward +title: Store & Forward Module Configuration +sidebar_label: Store & Forward +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::info +Currently only available for ESP32 based devices with external PSRAM. Requires the device to be set as a router. + +**Don't enable Store and Forward Module on multiple [routers](/docs/settings/router).** +::: + +## Overview + +:::caution +This is a work in progress and is partially available. Stability is not guaranteed. +::: + +The Store Forward Module is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. + +Because of the increased network traffic for this overhead, it's not advised to use this if you are duty cycle limited for your airtime usage nor is it advised to use this for SF12 (Long Range / Slow). + +:::tip +Once module settings are changed, a **reset** is required for them to take effect. +::: + +## Settings + +| Setting | Acceptable Values | Default | +| :----------------------------------------: | :---------------: | :-----: | +| store_forward_module_enabled | `true`, `false` | `false` | +| store_forward_module_heartbeat | `true`, `false` | `false` | +| store_forward_module_history_return_max | `integer` | `0` | +| store_forward_module_history_return_window | `integer` | `0` | +| store_forward_module_records | `integer` | `0` | + +### store_forward_module_enabled + +Enables the module. + + + + +```shell title="Enable the module" +meshtastic --set store_forward_module_enabled true +``` + +```shell title="Disable the module" +meshtastic --set store_forward_module_enabled false +``` + + + + +:::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. +::: + + + + +### store_forward_module_heartbeat + +The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. A client like Android, iOS, or Web can (if supported) indicate to the user whether a store and forward router is available. + + + + +```shell title="Set store_forward_module_heartbeat to default" +meshtastic --set store_forward_module_heartbeat 0 +``` + + + + +:::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. +::: + + + + +### store_forward_module_history_return_max + +Sets the maximum number of messages to return to a client device. + + + + +```shell title="Set store_forward_module_history_return_max to default" +meshtastic --set store_forward_module_history_return_max 0 +``` + +```shell title="Set store_forward_module_history_return_max to 100 messages" +meshtastic --set store_forward_module_history_return_max 100 +``` + + + + +:::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. +::: + + + + +### store_forward_module_history_return_window + +Limits the time period (in minutes) a client device can request. + + + + +```shell title="Set store_forward_module_history_return_window to default" +meshtastic --set store_forward_module_history_return_window 0 +``` + +```shell title="Set store_forward_module_history_return_window to 1 day (1440 minutes)" +meshtastic --set store_forward_module_history_return_window 1440 +``` + + + + +:::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. +::: + + + + +### store_forward_module_records + +Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. + + + + +```shell title="Set store_forward_module_records to default (≈11,000 records)" +meshtastic --set store_forward_module_records 0 +``` + +```shell title="Set store_forward_module_records to 100 records" +meshtastic --set store_forward_module_records 100 +``` + + + + +:::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 + +### How it works + +![Store & Forward - Overview](/img/modules/store_and_forward/store_and_forward-overview.png) + +### Requirements + +Initial Requirements: + +- Must be installed on a router node. + - This is an artificial limitation, but is in place to enforce best practices. + - Router nodes are intended to be always online. If this module misses any messages, the reliability of the stored messages will be reduced. +- Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others) + +### Usage Overview + +- To use / test this you will want at least 3 devices + - One device will (currently) need be a tbeam v1.0 and tbeamv1.1 configured as a Meshtastic router. Other devices with built in PSRAM will be supported at some point. + - Two others will be regular clients. Nothing special required. + +### Meshtastic channel configuration + +Don't use this on the "Long Range / Slow" or "Long Range / Fast" channel settings. You're welcome to try and report back, but those channels have a [very low bitrate](/docs/developers/firmware/radio-settings#pre-defined). + +Either use a custom channel configuration with at an at least 1kbit data rate or use "Medium Range / Fast". + +Recommended channel setting is for 1.343kbps: + +```shell title="Recommended channel setting for S&F module" +meshtastic --setchan spread_factor 11 --setchan coding_rate 5 --setchan bandwidth 500 +``` + +With an aftermarket coaxial antenna or moxon antenna, that will give you roughly the same range as "Long Range / Slow" and 5x the bitrate. + +### Router setup + +:::warning +Don't enable the Store and Forward module on multiple routers! +::: + +- Configure your device as a [meshtastic router](/docs/settings/router). +- Name your router node something that makes it easily identifiable, aka "Router". +- Configure the Store and Forward module + ```shell title="Required - Enable the module" + meshtastic --set store_forward_module_enabled true + ``` + ```shell title="Optional - Set maximum number of records to save to device" + meshtastic --set store_forward_module_records 100 + ``` + :::tip + Best to leave `store_forward_module_records` at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. + ::: + +### Client Usage + +Currently, no special configuration is required. To request your history sent to you, send the command into the message field "SF". That's it. This will eventually change to make it easier. At the moment, that message will be sent to everyone on the mesh but we'll (eventually) make it easier to use where there'll be a button (or maybe it'll be transparent) and the command isn't sent as a text message to the mesh. + +Available Commands: + +| Command | Definition | +| :-----: | :------------------------------------------: | +| SF | Send the last few messages I may have missed | +| SFm | Send a 240 byte payload (Used for testing) | + +The Store and Forward module will only service one client at a time. If a second client requests messages while the S&F is busy, the S&F will send a private message to the second client that they will need to wait. diff --git a/docs/settings/moduleconfig/telemetry.mdx b/docs/settings/moduleconfig/telemetry.mdx new file mode 100644 index 00000000..d5814296 --- /dev/null +++ b/docs/settings/moduleconfig/telemetry.mdx @@ -0,0 +1,506 @@ +--- +id: telemetry +title: Telemetry Module Configuration +sidebar_label: Telemetry +--- + +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 +The environment metrics feature of this module requires attaching a peripheral accessory to your device. It will not work without one. +::: + +## Overview + +In addition to key device metrics such as battery level, the Telemetry Module will also allow nodes to send environmental metrics from externally connected sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22, Dallas 1-wire DS18B20 and MCP9808. + +:::tip +Once module settings are changed, a **reset** is required for them to take effect. +::: + +## Settings + +| Setting | Acceptable Values | Default | +| :-----------------------------------------------------: | :-----------------: | :-----: | +| telemetry_module_device_update_interval | `integer` (seconds) | `0` | +| telemetry_module_environment_display_fahrenheit | `true`, `false` | `false` | +| telemetry_module_environment_measurement_enabled | `true`, `false` | `false` | +| telemetry_module_environment_read_error_count_threshold | `integer` | `0` | +| telemetry_module_environment_recovery_interval | `integer` (seconds) | `0` | +| telemetry_module_environment_screen_enabled | `true`, `false` | `0` | +| telemetry_module_environment_sensor_pin | `integer` | `0` | +| telemetry_module_environment_sensor_type | `0-6` | `0` | +| telemetry_module_environment_update_interval | `integer` (seconds) | `0` | + +### telemetry_module_device_update_interval + +Interval in seconds of how often we should try to send our measurements to the mesh. + + + + +```shell title="Set module update interval to default" +meshtastic --set telemetry_module_device_update_interval 0 +``` + +```shell title="Set module update interval to 120 seconds" +meshtastic --set telemetry_module_device_update_interval 120 +``` + + + + +:::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. +::: + + + + +### telemetry_module_environment_display_fahrenheit + +The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. + +#### Display Farenheit/Celsius + + + + +```shell title="Display Farenheit" +meshtastic --set telemetry_module_environment_display_fahrenheit true +```` + +```shell title="Display Celsius" +meshtastic --set telemetry_module_environment_display_fahrenheit false +``` + + + + +:::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. +::: + + + + +### telemetry_module_environment_measurement_enabled + +Enables the module to utilize environmental metrics. + +#### Enable/Disable the module + + + + +```shell title="Enable Module" +meshtastic --set telemetry_module_environment_measurement_enabled true +```` + +```shell title="Disable Module" +meshtastic --set telemetry_module_environment_measurement_enabled false +``` + + + + +:::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. +::: + + + + +### telemetry_module_environment_read_error_count_threshold + +Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor + +#### Configure telemetry_module_environment_read_error_count_threshold + + + + +```shell title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries" +meshtastic --set telemetry_module_environment_read_error_count_threshold 3 +```` + + + + +:::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. +::: + + + + +### telemetry_module_environment_recovery_interval + +Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again. + +#### Configure telemetry_module_environment_recovery_interval + + + + +```shell title="Configure telemetry_module_environment_recovery_interval to 120 seconds" +meshtastic --set telemetry_module_environment_recovery_interval 120 +```` + + + + +:::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. +::: + + + + +### telemetry_module_environment_screen_enabled + +Enable/Disable the Telemetry Module on-device display. + +#### Enable/Disable the module on device screen + + + + +```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 +``` + + + + +:::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. +::: + + + + +### telemetry_module_environment_sensor_pin + +:::note +The preferred setup is using I2C, so the `telemetry_module_environment_sensor_pin` may not be needed. +::: + +Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C. + +:::caution +To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. +::: + +#### Set module sensor pin + + + + +```shell title="Set module sensor pin" +meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER +```` + + + + +:::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. +::: + + + + +### telemetry_module_environment_sensor_type + +Specify the sensor type. + +:::important +The sensor values changed between 1.2 and 1.3. The docs represent the 1.3 values. When configuring devices on 1.2, please subtract 1 from the numbers below for the appropriate sensor. +::: + +| Value | Description | Sensor Features | +| :---: | :---------------------: | :--------------------------------------: | +| `1` | DHT11 | Temperature, Humidity | +| `2` | DS18B20 (Dallas 1-wire) | Temperature | +| `3` | DHT12 | Temperature, Humidity | +| `4` | DHT21 | Temperature, Humidity | +| `5` | DHT22 | Temperature, Humidity | +| `6` | BME280 | Temperature, Humidity, Pressure | +| `7` | BME680 | Temperature, Humidity, Pressure, VOC Gas | +| `8` | MCP9808 | Precision Temperature | + +#### Set sensor type + +:::important +The sensor values changed between 1.2 and 1.3. The docs represent the 1.3 values. When configuring devices on 1.2, please subtract 1 from the numbers on the table above for the appropriate sensor. +::: + + + + +:::note +The CLI is able to take the `value` or the `name` of the sensor from the table above. +::: + +```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 +``` + + + + +:::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. +::: + + + + +#### Set module update interval + + + + +```shell title="Set module update interval to 120 seconds" +meshtastic --set telemetry_module_environment_update_interval 120 +```` + + + + +:::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 + +### Hardware + +The sensors can be wired differently, here's [one example](https://randomnerdtutorials.com/esp32-ds18b20-temperature-arduino-ide) for sensor DS18B20. + +### Known Problems + +- No default configuration values are currently set, so this must be done when enabling the module. diff --git a/docs/settings/modules/canned-message-module.mdx b/docs/settings/modules/canned-message-module.mdx index ff4116ef..2de89d7d 100644 --- a/docs/settings/modules/canned-message-module.mdx +++ b/docs/settings/modules/canned-message-module.mdx @@ -1,55 +1,50 @@ --- id: canned-message-module -title: Canned Message Module -sidebar_label: Canned Message Module +title: Canned Message Plugin Settings +sidebar_label: Canned Message Plugin --- 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. It also requires use of the [Rotary Encoder Module](input-broker-module) to configure the input source. +This plugin requires attaching a peripheral accessory to your device. It will not work without one. It also requires use of the [Rotary Encoder](input-broker-module) to configure the input source. ::: ## Overview -The CannedMessage Module will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. +The CannedMessage Plugin will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. :::tip -Once module settings are changed, a **reset** is required for them to take effect. +Once plugin settings are changed, a **reset** is required for them to take effect. ::: ## Settings | Setting | Acceptable Values | Default | | :--------------------------------------: | :---------------: | :-----: | -| canned_message_module_allow_input_source | `rotEnc1`, `_any` | `_any` | -| canned_message_module_enabled | `true`, `false` | `false` | -| canned_message_module_messages | `string` | `""` | -| canned_message_module_send_bell | `true`, `false` | `false` | +| canned_message_plugin_allow_input_source | `rotEnc1`, `_any` | `_any` | +| canned_message_plugin_enabled | `true`, `false` | `false` | +| canned_message_plugin_messages | `string` | `""` | +| canned_message_plugin_send_bell | `true`, `false` | `false` | | (Messages)\* | `string` | `""` | - Messages can be set with a dedicated option: `--set-canned-message ""` -### canned_message_module_allow_input_source +### canned_message_plugin_allow_input_source -Input event source accepted by the canned message module. +Input event source accepted by the canned message plugin. | Value | Description | | :-------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | | `_any` | Default. Allows any peripheral input device connected to the device. | -| `rotEnc1` | Hardcoded value naming the input device that this module listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. | +| `rotEnc1` | Hardcoded value naming the input device that this plugin listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. | #### Set input source @@ -65,11 +60,11 @@ values={[ ```shell title="Set Allowed Input Source" -meshtastic --set canned_message_module_allow_input_source "_any" +meshtastic --set canned_message_plugin_allow_input_source "_any" ``` ```shell title="Specify Allowed Input Source" -meshtastic --set canned_message_module_allow_input_source "rotEnc1" +meshtastic --set canned_message_plugin_allow_input_source "rotEnc1" ``` @@ -96,15 +91,15 @@ Configuring this setting is not yet available for the selected platform. If this -### canned_message_module_enabled +### canned_message_plugin_enabled -Enables the module. +Enables the plugin. :::tip -Using the canned message module requires you set up the [Rotary Encoder Module](input-broker-module). See [prerequisites](#prerequisites) below. +Using the canned message plugin requires you set up the [Rotary Encoder](input-broker-module). See [prerequisites](#prerequisites) below. ::: -#### Enable/Disable the module +#### Enable/Disable the plugin -```shell title="Enable Canned Message Module" -meshtastic --set canned_message_module_enabled true +```shell title="Enable Canned Message Plugin" +meshtastic --set canned_message_plugin_enabled true ``` -```shell title="Disable Canned Message Module" -meshtastic --set canned_message_module_enabled false +```shell title="Disable Canned Message Plugin" +meshtastic --set canned_message_plugin_enabled false ``` @@ -149,14 +144,14 @@ Configuring this setting is not yet available for the selected platform. If this -### canned_message_module_send_bell +### canned_message_plugin_send_bell -CannedMessageModule also sends a "bell character" with the messages. -The [External Notification Module](external-notification-module) can benefit from this feature as it utilizes the bell character. +CannedMessagePlugin also sends a "bell character" with the messages. +The [External Notification Plugin](external-notification-module) can benefit from this feature as it utilizes the bell character. -_We have an "External Notification Module", that can be set up to beep, when new message arrives. -This module can also be configured to beep only when message contains the "bell character". -See module documentation (link above) for details._ +_We have an "External Notification Plugin", that can be set up to beep, when new message arrives. +This plugin can also be configured to beep only when message contains the "bell character". +See plugin documentation (link above) for details._ #### Enable/Disable bell character @@ -172,11 +167,11 @@ values={[ ```shell title="Enable Bell Character" -meshtastic --set canned_message_module_send_bell true +meshtastic --set canned_message_plugin_send_bell true ``` ```shell title="Disable Bell Character" -meshtastic --set canned_message_module_send_bell false +meshtastic --set canned_message_plugin_send_bell false ``` @@ -205,7 +200,7 @@ Configuring this setting is not yet available for the selected platform. If this ### Messages -CLI has a dedicated option for canned message module to set predefines messages: `--set-canned-message ` +CLI has a dedicated option for canned message plugin to set predefines messages: `--set-canned-message ` Predefined messages separated by `|` characters. You can define up to 50 messages with a total length 800 bytes. @@ -226,7 +221,7 @@ values={[ ```shell title="Set Canned Messages" -meshtastic --set canned_message_module_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger" +meshtastic --set canned_message_plugin_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger" ``` @@ -260,12 +255,12 @@ Configuring this setting is not yet available for the selected platform. If this - Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step. -- Once attached, configure peripheral device with [Rotary Encoder Module](input-broker-module) Settings. +- Once attached, configure peripheral device with [Rotary Encoder](input-broker-module) Settings. :::note 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 Plugin - Required Rotary Encoder Settings" meshtastic --set rotary1_pin_a GPIO meshtastic --set rotary1_pin_b GPIO meshtastic --set rotary1_pin_press GPIO @@ -276,4 +271,4 @@ 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. +That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Plugin. diff --git a/docs/settings/modules/external-notification-module.mdx b/docs/settings/modules/external-notification-module.mdx index 22dabb4b..9f56cb71 100644 --- a/docs/settings/modules/external-notification-module.mdx +++ b/docs/settings/modules/external-notification-module.mdx @@ -1,45 +1,41 @@ --- id: external-notification-module -title: External Notification Module Settings -sidebar_label: External Notification Module +title: External Notification Plugin Settings +sidebar_label: External Notification Plugin --- 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. +This plugin requires attaching a peripheral accessory to your device. It will not work without one. ::: ## Overview -The External Notification Module will allow you to connect a speaker, LED, or other device to notify you when a message has been received from the mesh network. +The External Notification Plugin will allow you to connect a speaker, LED, or other device to notify you when a message has been received from the mesh network. :::tip -Once module settings are changed, a **reset** is required for them to take effect. +Once plugin settings are changed, a **reset** is required for them to take effect. ::: ## Settings | Setting | Acceptable Values | Default | | :-----------------------------------: | :----------------------: | :-----: | -| ext_notification_module_active | `true`, `false` | `false` | -| ext_notification_module_alert_bell | `true`, `false` | `false` | -| ext_notification_module_alert_message | `true`, `false` | `false` | -| ext_notification_module_enabled | `true`, `false` | `false` | -| ext_notification_module_output | `integer` | `0` | -| ext_notification_module_output_ms | `integer` (milliseconds) | `0` | +| ext_notification_plugin_active | `true`, `false` | `false` | +| ext_notification_plugin_alert_bell | `true`, `false` | `false` | +| ext_notification_plugin_alert_message | `true`, `false` | `false` | +| ext_notification_plugin_enabled | `true`, `false` | `false` | +| ext_notification_plugin_output | `integer` | `0` | +| ext_notification_plugin_output_ms | `integer` (milliseconds) | `0` | -### ext_notification_module_active +### ext_notification_plugin_active Specifies whether the external circuit is triggered when the device's GPIO is low or high. @@ -61,11 +57,11 @@ values={[ ```shell title="GPIO active high" -meshtastic --set ext_notification_module_active true +meshtastic --set ext_notification_plugin_active true ``` ```shell title="GPIO active low (default)" -meshtastic --set ext_notification_module_active false +meshtastic --set ext_notification_plugin_active false ``` @@ -92,7 +88,7 @@ Configuring this setting is not yet available for the selected platform. If this -### ext_notification_module_alert_bell +### ext_notification_plugin_alert_bell Specifies if an alert should be sent when receiving an incoming bell. @@ -110,11 +106,11 @@ values={[ ```shell title="Enable alert on incoming bell" -meshtastic --set ext_notification_module_alert_bell true +meshtastic --set ext_notification_plugin_alert_bell true ``` ```shell title="Disable alert on incoming bell" -meshtastic --set ext_notification_module_alert_bell false +meshtastic --set ext_notification_plugin_alert_bell false ``` @@ -141,7 +137,7 @@ Configuring this setting is not yet available for the selected platform. If this -### ext_notification_module_alert_message +### ext_notification_plugin_alert_message Specifies if an alert should be sent when receiving an incoming message. @@ -159,11 +155,11 @@ values={[ ```shell title="Enable alert on incoming message" -meshtastic --set ext_notification_module_alert_message true +meshtastic --set ext_notification_plugin_alert_message true ``` ```shell title="Disable alert on incoming message" -meshtastic --set ext_notification_module_alert_message false +meshtastic --set ext_notification_plugin_alert_message false ``` @@ -190,11 +186,11 @@ Configuring this setting is not yet available for the selected platform. If this -### ext_notification_module_enabled +### ext_notification_plugin_enabled -Enables the module. +Enables the plugin. -#### Enable/Disable the module +#### Enable/Disable the plugin -```shell title="Enable Module" -meshtastic --set ext_notification_module_enabled true +```shell title="Enable / Disable Plugin" +meshtastic --set ext_notification_plugin_enabled true +meshtastic --set ext_notification_plugin_enabled false ``` -```shell title="Disable Module" -meshtastic --set ext_notification_module_enabled false -``` + @@ -239,7 +234,7 @@ Configuring this setting is not yet available for the selected platform. If this -### ext_notification_module_output +### ext_notification_plugin_output Specifies the GPIO that your external circuit is attached to on the device. @@ -265,7 +260,7 @@ Replace `GPIO` in the below command with the GPIO number your circuit is attache ::: ```shell title="Specify GPIO that circuit is connected to" -meshtastic --set ext_notification_module_output GPIO +meshtastic --set ext_notification_plugin_output GPIO ``` @@ -292,7 +287,7 @@ Configuring this setting is not yet available for the selected platform. If this -### ext_notification_module_output_ms +### ext_notification_plugin_output_ms Specifies how long in milliseconds you would like your external circuit triggered. Default is `1000`. (Because of the way that defaults are handled in the protobufs `0` is interpreted as `1000`) @@ -310,11 +305,11 @@ values={[ ```shell title="Set to default (1000ms)" -meshtastic --set ext_notification_module_output_ms 0 +meshtastic --set ext_notification_plugin_output_ms 0 ``` ```shell title="Set to other value" -meshtastic --set ext_notification_module_output_ms 1500 +meshtastic --set ext_notification_plugin_output_ms 1500 ``` diff --git a/docs/settings/modules/input-broker.mdx b/docs/settings/modules/input-broker.mdx new file mode 100644 index 00000000..284148e3 --- /dev/null +++ b/docs/settings/modules/input-broker.mdx @@ -0,0 +1,468 @@ +--- +id: input-broker +title: Input Broker +sidebar_label: Input Broker +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +:::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 | +| :-----------------: | :---------------: | :-----------: | +| 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) | + +### inputbroker_enabled + +Enable the rotary encoder #1 + +#### Enable/Disable rotary1 + + + + +```shell title="Enable rotary1" +meshtastic --set inputbroker_enabled true +``` + +```shell title="Disable rotary1" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +```shell title="Set rotary1 event cw to 'KEY_UP'" +meshtastic --set inputbroker_event_press KEY_UP +``` + +```shell title="Unset rotary1 event cw" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +```shell title="Set rotary1 event ccw to 'KEY_DOWN'" +meshtastic --set inputbroker_event_ccw KEY_DOWN +``` + +```shell title="Unset rotary1 event ccw" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +```shell title="Set rotary1 event press to 'KEY_SELECT'" +meshtastic --set inputbroker_event_press KEY_SELECT +``` + +```shell title="Unset rotary1 event press" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + +```shell title="Specify rotary1 pin a" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + +```shell title="Specify rotary1 pin b" +meshtastic --set inputbroker_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. +::: + + + + +### inputbroker_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 + + + + +:::note +Replace `GPIO` below with the GPIO number from hardware setup. +::: + +```shell title="Specify rotary1 pin press" +meshtastic --set inputbroker_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 + + + + +:::note +Replace each `GPIO` (x3) below with the GPIO numbers from hardware setup. +::: + +```shell title="Canned Message Module - Required Rotary Encoder Module Settings" +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 +``` + + + + +:::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. +::: + + + diff --git a/docs/settings/modules/store-and-forward-module.mdx b/docs/settings/modules/store-and-forward-module.mdx index 53e49242..c5244421 100644 --- a/docs/settings/modules/store-and-forward-module.mdx +++ b/docs/settings/modules/store-and-forward-module.mdx @@ -1,17 +1,16 @@ --- id: store-and-forward-module -title: Store and Forward Settings -sidebar_label: Store and Forward +title: Store & Forward Plugin Settings +sidebar_label: Store & Forward Plugin --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; :::info Currently only available for ESP32 based devices with external PSRAM. Requires the device to be set as a router. -**Don't enable Store and Forward Module on multiple [routers](/docs/settings/router).** +**Don't enable Store and Forward Plugin on multiple [routers](/docs/settings/router).** ::: ## Overview @@ -20,29 +19,27 @@ Currently only available for ESP32 based devices with external PSRAM. Requires t This is a work in progress and is partially available. Stability is not guaranteed. ::: - - -The Store Forward Module is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. +The Store Forward Plugin is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. Because of the increased network traffic for this overhead, it's not advised to use this if you are duty cycle limited for your airtime usage nor is it advised to use this for SF12 (Long Range / Slow). :::tip -Once module settings are changed, a **reset** is required for them to take effect. +Once plugin settings are changed, a **reset** is required for them to take effect. ::: ## Settings | Setting | Acceptable Values | Default | | :----------------------------------------: | :---------------: | :-----: | -| store_forward_module_enabled | `true`, `false` | `false` | -| store_forward_module_heartbeat | `true`, `false` | `false` | -| store_forward_module_history_return_max | `integer` | `0` | -| store_forward_module_history_return_window | `integer` | `0` | -| store_forward_module_records | `integer` | `0` | +| store_forward_plugin_enabled | `true`, `false` | `false` | +| store_forward_plugin_heartbeat | `true`, `false` | `false` | +| store_forward_plugin_history_return_max | `integer` | `0` | +| store_forward_plugin_history_return_window | `integer` | `0` | +| store_forward_plugin_records | `integer` | `0` | -### store_forward_module_enabled +### store_forward_plugin_enabled -Enables the module. +Enables the plugin. -```shell title="Enable the module" -meshtastic --set store_forward_module_enabled true +```shell title="Enable the plugin" +meshtastic --set store_forward_plugin_enabled true ``` -```shell title="Disable the module" -meshtastic --set store_forward_module_enabled false +```shell title="Disable the plugin" +meshtastic --set store_forward_plugin_enabled false ``` @@ -87,7 +84,7 @@ Configuring this setting is not yet available for the selected platform. If this -### store_forward_module_heartbeat +### store_forward_plugin_heartbeat The Store & Forward Router sends a periodic message onto the network. This allows connected devices to know that a router is in range and listening to received messages. A client like Android, iOS, or Web can (if supported) indicate to the user whether a store and forward router is available. @@ -102,8 +99,8 @@ values={[ ]}> -```shell title="Set store_forward_module_heartbeat to default" -meshtastic --set store_forward_module_heartbeat 0 +```shell title="Set store_forward_plugin_heartbeat to default" +meshtastic --set store_forward_plugin_heartbeat 0 ``` @@ -130,7 +127,7 @@ Configuring this setting is not yet available for the selected platform. If this -### store_forward_module_history_return_max +### store_forward_plugin_history_return_max Sets the maximum number of messages to return to a client device. @@ -145,12 +142,12 @@ values={[ ]}> -```shell title="Set store_forward_module_history_return_max to default" -meshtastic --set store_forward_module_history_return_max 0 +```shell title="Set store_forward_plugin_history_return_max to default" +meshtastic --set store_forward_plugin_history_return_max 0 ``` -```shell title="Set store_forward_module_history_return_max to 100 messages" -meshtastic --set store_forward_module_history_return_max 100 +```shell title="Set store_forward_plugin_history_return_max to 100 messages" +meshtastic --set store_forward_plugin_history_return_max 100 ``` @@ -177,7 +174,7 @@ Configuring this setting is not yet available for the selected platform. If this -### store_forward_module_history_return_window +### store_forward_plugin_history_return_window Limits the time period (in minutes) a client device can request. @@ -192,12 +189,12 @@ values={[ ]}> -```shell title="Set store_forward_module_history_return_window to default" -meshtastic --set store_forward_module_history_return_window 0 +```shell title="Set store_forward_plugin_history_return_window to default" +meshtastic --set store_forward_plugin_history_return_window 0 ``` -```shell title="Set store_forward_module_history_return_window to 1 day (1440 minutes)" -meshtastic --set store_forward_module_history_return_window 1440 +```shell title="Set store_forward_plugin_history_return_window to 1 day (1440 minutes)" +meshtastic --set store_forward_plugin_history_return_window 1440 ``` @@ -224,9 +221,9 @@ Configuring this setting is not yet available for the selected platform. If this -### store_forward_module_records +### store_forward_plugin_records -Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. +Set this to the maximum number of records to save. Best to leave this at the default (`0`) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. -```shell title="Set store_forward_module_records to default (≈11,000 records)" -meshtastic --set store_forward_module_records 0 +```shell title="Set store_forward_plugin_records to default (≈11,000 records)" +meshtastic --set store_forward_plugin_records 0 ``` -```shell title="Set store_forward_module_records to 100 records" -meshtastic --set store_forward_module_records 100 +```shell title="Set store_forward_plugin_records to 100 records" +meshtastic --set store_forward_plugin_records 100 ``` @@ -283,7 +280,7 @@ Initial Requirements: - Must be installed on a router node. - This is an artificial limitation, but is in place to enforce best practices. - - Router nodes are intended to be always online. If this module misses any messages, the reliability of the stored messages will be reduced. + - Router nodes are intended to be always online. If this plugin misses any messages, the reliability of the stored messages will be reduced. - Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others) ### Usage Overview @@ -300,7 +297,7 @@ Either use a custom channel configuration with at an at least 1kbit data rate or Recommended channel setting is for 1.343kbps: -```shell title="Recommended channel setting for S&F module" +```shell title="Recommended channel setting for S&F plugin" meshtastic --setchan spread_factor 11 --setchan coding_rate 5 --setchan bandwidth 500 ``` @@ -309,20 +306,20 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup :::warning -Don't enable the Store and Forward module on multiple routers! +Don't enable the Store and Forward plugin on multiple routers! ::: - Configure your device as a [meshtastic router](/docs/settings/router). - Name your router node something that makes it easily identifiable, aka "Router". -- Configure the Store and Forward module - ```shell title="Required - Enable the module" - meshtastic --set store_forward_module_enabled true +- Configure the Store and Forward plugin + ```shell title="Required - Enable the plugin" + meshtastic --set plugin true ``` ```shell title="Optional - Set maximum number of records to save to device" - meshtastic --set store_forward_module_records 100 + meshtastic --set store_forward_plugin_records 100 ``` :::tip - Best to leave `store_forward_module_records` at the default (`0`) where the module will use 2/3 of your device's available PSRAM. This is about 11,000 records. + Best to leave `store_forward_plugin_records` at the default (`0`) where the plugin will use 2/3 of your device's available PSRAM. This is about 11,000 records. ::: ### Client Usage @@ -336,4 +333,4 @@ Available Commands: | SF | Send the last few messages I may have missed | | SFm | Send a 240 byte payload (Used for testing) | -The Store and Forward module will only service one client at a time. If a second client requests messages while the S&F is busy, the S&F will send a private message to the second client that they will need to wait. +The Store and Forward plugin will only service one client at a time. If a second client requests messages while the S&F is busy, the S&F will send a private message to the second client that they will need to wait. diff --git a/docs/settings/modules/telemetry-module.mdx b/docs/settings/modules/telemetry-module.mdx index 2b9550e9..bf49274a 100644 --- a/docs/settings/modules/telemetry-module.mdx +++ b/docs/settings/modules/telemetry-module.mdx @@ -1,51 +1,44 @@ --- id: telemetry-module -title: Telemetry Module Settings -sidebar_label: Telemetry Module +title: Environmental Measurement Plugin Settings +sidebar_label: Environmental Measurement Plugin --- 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 -The environment metrics feature of this module requires attaching a peripheral accessory to your device. It will not work without one. +The environment metrics feature of this plugin requires attaching a peripheral accessory to your device. It will not work without one. ::: ## Overview -In addition to key device metrics such as battery level, the Telemetry Module will also allow nodes to send environmental metrics from externally connected sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22, Dallas 1-wire DS18B20 and MCP9808. +In addition to key device metrics such as battery level, the Environment Monitoring Plugin will also allow nodes to send environmental metrics from externally connected sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22, Dallas 1-wire DS18B20 and MCP9808. :::tip -Once module settings are changed, a **reset** is required for them to take effect. +Once plugin settings are changed, a **reset** is required for them to take effect. ::: ## Settings | Setting | Acceptable Values | Default | | :-----------------------------------------------------: | :-----------------: | :-----: | -| telemetry_module_device_update_interval | `integer` (seconds) | `0` | -| telemetry_module_environment_display_fahrenheit | `true`, `false` | `false` | -| telemetry_module_environment_measurement_enabled | `true`, `false` | `false` | -| telemetry_module_environment_read_error_count_threshold | `integer` | `0` | -| telemetry_module_environment_recovery_interval | `integer` (seconds) | `0` | -| telemetry_module_environment_screen_enabled | `true`, `false` | `0` | -| telemetry_module_environment_sensor_pin | `integer` | `0` | -| telemetry_module_environment_sensor_type | `0-6` | `0` | -| telemetry_module_environment_update_interval | `integer` (seconds) | `0` | +| environmental_measurement_plugin_device_update_interval | `integer` (seconds) | `0` | +| environmental_measurement_plugin_display_fahrenheit | `true`, `false` | `false` | +| environmental_measurement_plugin_measurement_enabled | `true`, `false` | `false` | +| environmental_measurement_plugin_read_error_count_threshold | `integer` | `0` | +| environmental_measurement_plugin_recovery_interval | `integer` (seconds) | `0` | +| environmental_measurement_plugin_screen_enabled | `true`, `false` | `0` | +| environmental_measurement_plugin_sensor_pin | `integer` | `0` | +| environmental_measurement_plugin_sensor_type | `0-6` | `0` | +| environmental_measurement_plugin_update_interval | `integer` (seconds) | `0` | -### telemetry_module_device_update_interval +### environmental_measurement_plugin_device_update_interval Interval in seconds of how often we should try to send our measurements to the mesh. @@ -60,12 +53,12 @@ values={[ ]}> -```shell title="Set module update interval to default" -meshtastic --set telemetry_module_device_update_interval 0 +```shell title="Set plugin update interval to default" +meshtastic --set environmental_measurement_plugin_device_update_interval 0 ``` -```shell title="Set module update interval to 120 seconds" -meshtastic --set telemetry_module_device_update_interval 120 +```shell title="Set plugin update interval to 120 seconds" +meshtastic --set environmental_measurement_plugin_device_update_interval 120 ``` @@ -92,7 +85,7 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_display_fahrenheit +### environmental_measurement_plugin_display_fahrenheit The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. @@ -110,11 +103,11 @@ values={[ ```shell title="Display Farenheit" -meshtastic --set telemetry_module_environment_display_fahrenheit true +meshtastic --set environmental_measurement_plugin_display_fahrenheit true ```` ```shell title="Display Celsius" -meshtastic --set telemetry_module_environment_display_fahrenheit false +meshtastic --set environmental_measurement_plugin_display_fahrenheit false ``` @@ -141,11 +134,11 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_measurement_enabled +### environmental_measurement_plugin_measurement_enabled -Enables the module to utilize environmental metrics. +Enables the plugin to utilize environmental metrics. -#### Enable/Disable the module +#### Enable/Disable the plugin -```shell title="Enable Module" -meshtastic --set telemetry_module_environment_measurement_enabled true +```shell title="Enable Plugin" +meshtastic --set environmental_measurement_plugin_measurement_enabled true ```` -```shell title="Disable Module" -meshtastic --set telemetry_module_environment_measurement_enabled false +```shell title="Disable Plugin" +meshtastic --set environmental_measurement_plugin_measurement_enabled false ``` @@ -190,11 +183,11 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_read_error_count_threshold +### environmental_measurement_plugin_read_error_count_threshold Sometimes sensor reads can fail. If this happens, we will retry a configurable number of attempts. Each attempt will be delayed by the minimum required refresh rate for that sensor -#### Configure telemetry_module_environment_read_error_count_threshold +#### Configure environmental_measurement_plugin_read_error_count_threshold -```shell title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries" -meshtastic --set telemetry_module_environment_read_error_count_threshold 3 +```shell title="Configure environmental_measurement_plugin_read_error_count_threshold to 3 tries" +meshtastic --set environmental_measurement_plugin_read_error_count_threshold 3 ```` @@ -235,11 +228,11 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_recovery_interval +### environmental_measurement_plugin_recovery_interval Sometimes we can end up with more than read_error_count_threshold failures. In this case, we will stop trying to read from the sensor for a while. Wait this long until trying to read from the sensor again. -#### Configure telemetry_module_environment_recovery_interval +#### Configure environmental_measurement_plugin_recovery_interval -```shell title="Configure telemetry_module_environment_recovery_interval to 120 seconds" -meshtastic --set telemetry_module_environment_recovery_interval 120 +```shell title="Configure environmental_measurement_plugin_recovery_interval to 120 seconds" +meshtastic --set environmental_measurement_plugin_recovery_interval 120 ```` @@ -280,11 +273,11 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_screen_enabled +### environmental_measurement_plugin_screen_enabled -Enable/Disable the Telemetry Module on-device display. +Enable/Disable the Environmental Measurement Plugin on-device display. -#### Enable/Disable the module on device screen +#### Enable/Disable the plugin on device screen ```shell title="Enable on device screen" -meshtastic --set telemetry_module_environment_screen_enabled true +meshtastic --set environmental_measurement_plugin_screen_enabled true ```` ```shell title="Disable on device screen" -meshtastic --set telemetry_module_environment_screen_enabled false +meshtastic --set environmental_measurement_plugin_screen_enabled false ``` @@ -329,10 +322,10 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_sensor_pin +### environmental_measurement_plugin_sensor_pin :::note -The preferred setup is using I2C, so the `telemetry_module_environment_sensor_pin` may not be needed. +The preferred setup is using I2C, so the `environmental_measurement_plugin_sensor_pin` may not be needed. ::: Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C. @@ -341,7 +334,7 @@ Specify the preferred GPIO Pin for sensor readings. May not be needed if using I To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value. ::: -#### Set module sensor pin +#### Set plugin sensor pin -```shell title="Set module sensor pin" -meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER +```shell title="Set plugin sensor pin" +meshtastic --set environmental_measurement_plugin_sensor_pin PINNUMBER ```` @@ -382,7 +375,7 @@ Configuring this setting is not yet available for the selected platform. If this -### telemetry_module_environment_sensor_type +### environmental_measurement_plugin_sensor_type Specify the sensor type. @@ -423,11 +416,11 @@ The CLI is able to take the `value` or the `name` of the sensor from the table a ::: ```shell title="Set sensor type to DS18B20" -meshtastic --set telemetry_module_environment_sensor_type 2 +meshtastic --set environmental_measurement_plugin_sensor_type 2 ```` ```shell title="Set sensor type to DS18B20" -meshtastic --set telemetry_module_environment_sensor_type DS18B20 +meshtastic --set environmental_measurement_plugin_sensor_type DS18B20 ``` @@ -454,7 +447,7 @@ Configuring this setting is not yet available for the selected platform. If this -#### Set module update interval +#### Set plugin update interval -```shell title="Set module update interval to 120 seconds" -meshtastic --set telemetry_module_environment_update_interval 120 +```shell title="Set plugin update interval to 120 seconds" +meshtastic --set environmental_measurement_plugin_update_interval 120 ```` @@ -503,4 +496,4 @@ The sensors can be wired differently, here's [one example](https://randomnerdtut ### Known Problems -- No default configuration values are currently set, so this must be done when enabling the module. +- No default configuration values are currently set, so this must be done when enabling the plugin.