mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-26 22:19:46 -08:00
move configuration to the bottom of the page
This commit is contained in:
parent
dda9a9d13a
commit
2f5f041048
|
@ -11,11 +11,6 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
||||||
The ExternalNotification 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 ExternalNotification 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.
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the External Notification Module requires configuring the following modules:
|
|
||||||
- [External Notification Module](/docs/settings/modules/external-notification-module)
|
|
||||||
|
|
||||||
### Alert Types
|
### Alert Types
|
||||||
|
|
||||||
We support being alerted on two events:
|
We support being alerted on two events:
|
||||||
|
@ -40,6 +35,11 @@ Ideas for external hardware:
|
||||||
- Strobe Light
|
- Strobe Light
|
||||||
- Siren
|
- Siren
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the External Notification Module requires configuring the following modules:
|
||||||
|
- [External Notification Module](/docs/settings/modules/external-notification-module)
|
||||||
|
|
||||||
## Known Problems
|
## Known Problems
|
||||||
|
|
||||||
- This won't directly support a passive (normal) speaker as it does not generate any audio wave forms.
|
- This won't directly support a passive (normal) speaker as it does not generate any audio wave forms.
|
||||||
|
|
|
@ -7,19 +7,21 @@ sidebar_position: 1
|
||||||
|
|
||||||
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
This module allows you to test the range of your Meshtastic nodes. It uses two nodes, one to send a message every minute, and another to receive the messages. 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, for example, Google Earth, allowing you to see where you have coverage.
|
This module allows you to test the range of your Meshtastic nodes. It uses two nodes, one to send a message every minute, and another to receive the messages. 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, for example, Google Earth, allowing you to see where you have coverage.
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Range Test Module requires configuring the following modules:
|
|
||||||
- [Range Test Module](/docs/settings/modules/range-test-module)
|
|
||||||
|
|
||||||
### Other things to keep in mind
|
### Other things to keep in mind
|
||||||
|
|
||||||
Be sure to turn off either the module configured as a sender or the device where the module setup as sender when not in use. This will use a lot of time on air and will spam your channel.
|
Be sure to turn off either the module configured as a sender or the device where the module setup as sender when not in use. This will use a lot of time on air and will spam your channel.
|
||||||
|
|
||||||
Also, be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results.
|
Also, be mindful of your space usage on the file system. It has protections from filling up the space but it's best to delete old range test results.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Range Test Module requires configuring the following modules:
|
||||||
|
- [Range Test Module](/docs/settings/modules/range-test-module)
|
||||||
|
|
||||||
## Application Examples
|
## Application Examples
|
||||||
|
|
||||||
### Google Earth Integration
|
### Google Earth Integration
|
||||||
|
|
|
@ -15,11 +15,6 @@ Default is to use RX GPIO 16 and TX GPIO 17.
|
||||||
|
|
||||||
<PluginModule name="serial_plugin" rename="serial_module" />
|
<PluginModule name="serial_plugin" rename="serial_module" />
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Serial Module requires configuring the following modules:
|
|
||||||
- [Serial Module](/docs/settings/modules/serial-module)
|
|
||||||
|
|
||||||
## Basic Usage:
|
## Basic Usage:
|
||||||
|
|
||||||
1. Enable the module by setting `serial_module_enabled` to `1`.
|
1. Enable the module by setting `serial_module_enabled` to `1`.
|
||||||
|
@ -44,6 +39,11 @@ The device must be restarted after the settings have been changed for the module
|
||||||
This won't happen any time soon.
|
This won't happen any time soon.
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Serial Module requires configuring the following modules:
|
||||||
|
- [Serial Module](/docs/settings/modules/serial-module)
|
||||||
|
|
||||||
## Known Problems
|
## Known Problems
|
||||||
|
|
||||||
- Until the module is initialized by the startup sequence, the TX pin is in a floating state. Device connected to that pin may see this as "noise".
|
- Until the module is initialized by the startup sequence, the TX pin is in a floating state. Device connected to that pin may see this as "noise".
|
||||||
|
|
|
@ -30,11 +30,6 @@ Initial Requirements:
|
||||||
- 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 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)
|
- Esp32 Processor based device with external PSRAM. (tbeam v1.0 and tbeamv1.1, and maybe others)
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Store and Forward requires configuring the following modules:
|
|
||||||
- [Store and Forward](/docs/settings/modules/store-and-forward-module)
|
|
||||||
|
|
||||||
## Usage Overview
|
## Usage Overview
|
||||||
|
|
||||||
To use / test this you will want at least 3 devices
|
To use / test this you will want at least 3 devices
|
||||||
|
@ -180,6 +175,11 @@ When a message is 'real time', time a message is sent is the same as the time th
|
||||||
|
|
||||||
Where the message is a delayed broadcast, the "To" is _not_ a broadcast address but rather the address of the device that requested the messages to be replayed. This is to allow the message to be routed over the mesh network and not displayed in the message screen of other devices.
|
Where the message is a delayed broadcast, the "To" is _not_ a broadcast address but rather the address of the device that requested the messages to be replayed. This is to allow the message to be routed over the mesh network and not displayed in the message screen of other devices.
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Store and Forward requires configuring the following modules:
|
||||||
|
- [Store and Forward](/docs/settings/modules/store-and-forward-module)
|
||||||
|
|
||||||
## Developer TODO
|
## Developer TODO
|
||||||
|
|
||||||
Not necessarily in this order:
|
Not necessarily in this order:
|
||||||
|
|
|
@ -15,11 +15,6 @@ The Telemetry Module will allow nodes to send a specific message with informatio
|
||||||
|
|
||||||
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_sensor_pin` may not be needed.
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Telemetry Module requires configuring the following modules:
|
|
||||||
- [Telemetry Module](/docs/settings/modules/telemetry-module)
|
|
||||||
|
|
||||||
## Usage Notes
|
## Usage Notes
|
||||||
|
|
||||||
For basic usage, start with:
|
For basic usage, start with:
|
||||||
|
@ -173,6 +168,11 @@ meshtastic --info
|
||||||
|
|
||||||
and verify the the `telemetry_module_sensor_type`
|
and verify the the `telemetry_module_sensor_type`
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
Configuration details are available on the [Device Settings](/docs/settings) pages. Configuring the Telemetry Module requires configuring the following modules:
|
||||||
|
- [Telemetry Module](/docs/settings/modules/telemetry-module)
|
||||||
|
|
||||||
## Known Problems
|
## 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 module.
|
||||||
|
|
Loading…
Reference in a new issue