mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 07:34:11 -08:00
Merge pull request #303 from jfirwin/discord-notes
Fixing 1.3 module commands
This commit is contained in:
Sacha Weatherstone
GitHub
commit
9dfd44e055
|
|
@ -1,3 +1,3 @@
|
|||
:::important
|
||||
<span>The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute '{props.name}module' prefix with '{props.rename}plugin' to get the 1.2 compatible command name.</span>
|
||||
<span>The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute '{props.name}' prefix with '{props.rename}' to get the 1.2 compatible command name.</span>
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -11,12 +11,12 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
|||
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.
|
||||
:::
|
||||
|
||||
<PluginModule name="canned_message_" rename="canned_message_" />
|
||||
<PluginModule name="canned_message_module" rename="canned_message_plugin" />
|
||||
|
||||
<!--- TODO add link to hardware setup to admonition--->
|
||||
|
||||
:::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](rotary-encoder-module) to configure the input source.
|
||||
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
|
||||
|
|
@ -100,7 +100,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
Enables the module.
|
||||
|
||||
:::tip
|
||||
Using the canned message module requires you set up the [Rotary Encoder Module](rotary-encoder-module). See [prerequisites](#prerequisites) below.
|
||||
Using the canned message module requires you set up the [Rotary Encoder Module](input-broker-module). See [prerequisites](#prerequisites) below.
|
||||
:::
|
||||
|
||||
#### Enable/Disable the module
|
||||
|
|
@ -259,7 +259,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
<!--- TODO add link to hardware pages to first bullet point --->
|
||||
|
||||
- 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](rotary-encoder-module) Settings.
|
||||
- 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.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ 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.
|
||||
:::
|
||||
<PluginModule name="ext_notification_" rename="ext_notification_" />
|
||||
<PluginModule name="ext_notification_module" rename="ext_notification_plugin" />
|
||||
|
||||
<!--- TODO add link to hardware setup to admonition--->
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,19 @@
|
|||
---
|
||||
id: rotary-encoder-module
|
||||
title: Rotary Encoder
|
||||
sidebar_label: Rotary Encoder
|
||||
id: input-broker-module
|
||||
title: Input Broker
|
||||
sidebar_label: 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.
|
||||
:::
|
||||
|
||||
<PluginModule name="inputbroker_" rename="rotary1_"/>
|
||||
|
||||
<!--- TODO add link to hardware setup to admonition--->
|
||||
|
||||
:::note
|
||||
|
|
@ -66,18 +69,21 @@ meshtastic --set rotary1_enabled true
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -116,18 +122,21 @@ meshtastic --set rotary1_event_press ""
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -166,18 +175,21 @@ meshtastic --set rotary1_event_ccw ""
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -216,18 +228,21 @@ meshtastic --set rotary1_event_press ""
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -266,18 +281,21 @@ meshtastic --set rotary1_pin_a GPIO
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -316,18 +334,21 @@ meshtastic --set rotary1_pin_b GPIO
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -366,18 +387,21 @@ meshtastic --set rotary1_pin_press GPIO
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -422,18 +446,21 @@ meshtastic --set rotary1_enabled True
|
|||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
|
@ -11,7 +11,7 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
|||
## Overview
|
||||
|
||||
This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh.
|
||||
<PluginModule name="range_test_" rename="range_test_" />
|
||||
<PluginModule name="range_test_module" rename="range_test_plugin" />
|
||||
|
||||
:::tip
|
||||
Once module settings are changed, a **reset** is required for them to take effect.
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
|||
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.
|
||||
:::
|
||||
|
||||
<PluginModule name="serial_" rename="serial_" />
|
||||
<PluginModule name="serial_module" rename="serial_plugin" />
|
||||
|
||||
:::note
|
||||
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ 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.
|
||||
:::
|
||||
|
||||
<PluginModule name="store_forward_" rename="store_forward_" />
|
||||
<PluginModule name="store_forward_module" rename="store_forward_plugin" />
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
|
|
@ -12,17 +12,17 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
|||
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.
|
||||
:::
|
||||
|
||||
<PluginModule name="telemetry_" rename="environmental_measurment_"/>
|
||||
<PluginModule name="telemetry_module_environment" rename="environmental_measurement_plugin"/>
|
||||
|
||||
<!--- TODO add link to hardware setup to admonition--->
|
||||
|
||||
:::note
|
||||
This module requires attaching a peripheral accessory to your device. It will not work without one.
|
||||
The environment metrics feature of this module requires attaching a peripheral accessory to your device. It will not work without one.
|
||||
:::
|
||||
|
||||
## Overview
|
||||
|
||||
The Telemetry Module will allow nodes to send a specific message with information from connected sensors. Currently supported sensors are BME280, BME680, DHT11, DHT12, DHT21, DHT22 and Dallas 1-wire DS18B20.
|
||||
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.
|
||||
|
|
@ -32,16 +32,64 @@ Once module settings are changed, a **reset** is required for them to take effec
|
|||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-----------------------------------------: | :-----------------: | :-----: |
|
||||
| telemetry_module_display_farenheit | `true`, `false` | `false` |
|
||||
| telemetry_module_measurement_enabled | `true`, `false` | `false` |
|
||||
| telemetry_module_read_error_count_threshold | `integer` | `0` |
|
||||
| telemetry_module_recovery_interval | `integer` (seconds) | `0` |
|
||||
| telemetry_module_screen_enabled | `true`, `false` | `0` |
|
||||
| telemetry_module_sensor_pin | `integer` | `0` |
|
||||
| telemetry_module_sensor_type | `0-6` | `0` |
|
||||
| telemetry_module_update_interval | `integer` (seconds) | `0` |
|
||||
| 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_display_farenheit
|
||||
### telemetry_module_device_update_interval
|
||||
|
||||
Interval in seconds of how often we should try to send our measurements to the mesh.
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
values={[
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'iOS', value: 'iOS'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```bash title="Set module update interval to default"
|
||||
meshtastic --set telemetry_module_device_update_interval 0
|
||||
```
|
||||
```bash title="Set module update interval to 120 seconds"
|
||||
meshtastic --set telemetry_module_device_update_interval 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="iOS">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
### 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.
|
||||
|
||||
|
|
@ -59,11 +107,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```bash title="Display Farenheit"
|
||||
meshtastic --set telemetry_module_display_farenheit true
|
||||
meshtastic --set telemetry_module_environment_display_fahrenheit true
|
||||
```
|
||||
|
||||
```bash title="Display Celsius"
|
||||
meshtastic --set telemetry_module_display_farenheit false
|
||||
meshtastic --set telemetry_module_environment_display_fahrenheit false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -90,9 +138,9 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_measurement_enabled
|
||||
### telemetry_module_environment_measurement_enabled
|
||||
|
||||
Enables the module.
|
||||
Enables the module to utilize environmental metrics.
|
||||
|
||||
#### Enable/Disable the module
|
||||
|
||||
|
|
@ -108,11 +156,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```bash title="Enable Module"
|
||||
meshtastic --set telemetry_module_measurement_enabled true
|
||||
meshtastic --set telemetry_module_environment_measurement_enabled true
|
||||
```
|
||||
|
||||
```bash title="Disable Module"
|
||||
meshtastic --set telemetry_module_measurement_enabled false
|
||||
meshtastic --set telemetry_module_environment_measurement_enabled false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -139,11 +187,11 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_read_error_count_threshold
|
||||
### 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_read_error_count_threshold
|
||||
#### Configure telemetry_module_environment_read_error_count_threshold
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
|
|
@ -156,8 +204,8 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```bash title="Configure telemetry_module_read_error_count_threshold to 3 tries"
|
||||
meshtastic --set telemetry_module_read_error_count_threshold 3
|
||||
```bash title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries"
|
||||
meshtastic --set telemetry_module_environment_read_error_count_threshold 3
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -184,11 +232,11 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_recovery_interval
|
||||
### 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_recovery_interval
|
||||
#### Configure telemetry_module_environment_recovery_interval
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
|
|
@ -201,8 +249,8 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```bash title="Configure telemetry_module_recovery_interval to 120 seconds"
|
||||
meshtastic --set telemetry_module_recovery_interval 120
|
||||
```bash title="Configure telemetry_module_environment_recovery_interval to 120 seconds"
|
||||
meshtastic --set telemetry_module_environment_recovery_interval 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -229,7 +277,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_screen_enabled
|
||||
### telemetry_module_environment_screen_enabled
|
||||
|
||||
Enable/Disable the Telemetry Module on-device display.
|
||||
|
||||
|
|
@ -247,11 +295,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```bash title="Enable on device screen"
|
||||
meshtastic --set telemetry_module_screen_enabled true
|
||||
meshtastic --set telemetry_module_environment_screen_enabled true
|
||||
```
|
||||
|
||||
```bash title="Disable on device screen"
|
||||
meshtastic --set telemetry_module_screen_enabled false
|
||||
meshtastic --set telemetry_module_environment_screen_enabled false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -278,10 +326,10 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_sensor_pin
|
||||
### telemetry_module_environment_sensor_pin
|
||||
|
||||
:::note
|
||||
The preferred setup is using I2C, so the `telemetry_module_sensor_pin` may not be needed.
|
||||
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.
|
||||
|
|
@ -304,7 +352,7 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```bash title="Set module sensor pin"
|
||||
meshtastic --set telemetry_module_sensor_pin PINNUMBER
|
||||
meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -331,23 +379,31 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_sensor_type
|
||||
### 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 |
|
||||
| :---: | :---------------------: | :--------------------------------------: |
|
||||
| `0` | DHT11 | Temperature, Humidity |
|
||||
| `1` | DS18B20 (Dallas 1-wire) | Temperature |
|
||||
| `2` | DHT12 | Temperature, Humidity |
|
||||
| `3` | DHT21 | Temperature, Humidity |
|
||||
| `4` | DHT22 | Temperature, Humidity |
|
||||
| `5` | BME280 | Temperature, Humidity, Pressure |
|
||||
| `6` | BME680 | Temperature, Humidity, Pressure, VOC Gas |
|
||||
| `7` | MCP9808 | Precision Temperature |
|
||||
| `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.
|
||||
:::
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="cli"
|
||||
|
|
@ -364,11 +420,11 @@ The CLI is able to take the `value` or the `name` of the sensor from the table a
|
|||
:::
|
||||
|
||||
```bash title="Set sensor type to DS18B20"
|
||||
meshtastic --set telemetry_module_sensor_type 1
|
||||
meshtastic --set telemetry_module_environment_sensor_type 2
|
||||
```
|
||||
|
||||
```bash title="Set sensor type to DS18B20"
|
||||
meshtastic --set telemetry_module_sensor_type DS18B20
|
||||
meshtastic --set telemetry_module_environment_sensor_type DS18B20
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -395,10 +451,6 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### telemetry_module_update_interval
|
||||
|
||||
Interval in seconds of how often we should try to send our measurements to the mesh.
|
||||
|
||||
#### Set module update interval
|
||||
|
||||
<Tabs
|
||||
|
|
@ -412,8 +464,8 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```bash title="Set module update interval to 15 seconds"
|
||||
meshtastic --set telemetry_module_update_interval 15
|
||||
```bash title="Set module update interval to 120 seconds"
|
||||
meshtastic --set telemetry_module_environment_update_interval 120
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
@ -175,12 +175,12 @@ module.exports = {
|
|||
{
|
||||
Modules: [
|
||||
"settings/canned-message-module",
|
||||
"settings/telemetry-module",
|
||||
"settings/input-broker-module",
|
||||
"settings/external-notification-module",
|
||||
"settings/range-test-module",
|
||||
"settings/rotary-encoder-module",
|
||||
"settings/serial-module",
|
||||
"settings/store-and-forward-module",
|
||||
"settings/telemetry-module",
|
||||
],
|
||||
Advanced: ["settings/channel-advanced", "settings/misc"],
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in a new issue