mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-21 03:25:51 -08:00
Update Apple pages, fix serial and range test plugins
This commit is contained in:
parent
7c8b912c3f
commit
63238c1028
|
@ -1,12 +1,11 @@
|
|||
---
|
||||
id: input-broker-module
|
||||
id: input-broker
|
||||
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.
|
146
docs/settings/moduleconfig/serial.mdx
Normal file
146
docs/settings/moduleconfig/serial.mdx
Normal file
|
@ -0,0 +1,146 @@
|
|||
---
|
||||
id: serial
|
||||
title: Serial Module Settings
|
||||
sidebar_label: Serial
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO and Sender. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf.
|
||||
|
||||
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
||||
|
||||
:::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.
|
||||
:::
|
||||
|
||||
## Serial Module Config Values
|
||||
|
||||
### Enabled
|
||||
|
||||
Enables the serial module.
|
||||
|
||||
### Echo
|
||||
|
||||
If set, any packets you send will be echoed back to your device.
|
||||
|
||||
### Mode
|
||||
|
||||
### Receive GPIO Pin
|
||||
|
||||
Set the GPIO pin to the RXD pin you have set up.
|
||||
|
||||
### Transmit GPIO Pin
|
||||
|
||||
Set the GPIO pin to the RXD pin you have set up.
|
||||
|
||||
:::tip
|
||||
Connect the TX pin to the other device's RX pin, and vice versa. Connect their grounds to each other (not necessary if they're both plugged into the same USB power source.)
|
||||
:::
|
||||
|
||||
### Baud Rate
|
||||
|
||||
The serial baud rate.
|
||||
|
||||
### Timeout
|
||||
|
||||
The amount of time to wait before we consider your packet as "done".
|
||||
|
||||
:::tip
|
||||
Once module settings are changed, a **reset** is required for them to take effect.
|
||||
:::
|
||||
|
||||
## Serial Module Config Client Availability
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="flasher"
|
||||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
{label: 'Command Line', value: 'cli'},
|
||||
{label: 'Flasher', value: 'flasher'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
<TabItem value="android">
|
||||
|
||||
:::info
|
||||
Serial module config is not available for Android.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="apple">
|
||||
|
||||
:::info
|
||||
Serial module config is not yet available on Apple OS's.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli">
|
||||
|
||||
All serial module config options are available in the python CLI. Example commands are below:
|
||||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-------------------: | :-----------------: | :-----: |
|
||||
| serial_module_enabled | `true`, `false` | `false` |
|
||||
| serial_module_echo | `true`, `false` | `false` |
|
||||
| serial_module_mode | `modeDefault` `modeSimple` `modeProto` | `modeDefault` |
|
||||
| serial_module_rxd | GPIO Pin Number 1-39 | Default of `0` is Unset |
|
||||
| serial_module_txd | GPIO Pin Number 1-39 | Defaunlt of `0` is Unset |
|
||||
| serial_module_baud | `baudDefault` `baud110` `baud300` `baud600` `baud1200` `baud2400` `baud4800` `baud9600` `baud19200` `baud38400` `baud57600` `baud115200` `baud230400` `baud460800` `baud576000` `baud921600` | `baudDefault` |
|
||||
| serial_module_timeout | `integer` (seconds) | `0` |
|
||||
|
||||
|
||||
```shell title="Enable / Disable Module"
|
||||
meshtastic --set serial_module_enabled true
|
||||
meshtastic --set serial_module_enabled false
|
||||
```
|
||||
|
||||
```shell title="Enable / Disable Echo"
|
||||
meshtastic --set serial_module_echo true
|
||||
meshtastic --set serial_module_echo false
|
||||
```
|
||||
|
||||
```shell title="Set Mode"
|
||||
meshtastic --set serial_module_mode modeDefault
|
||||
meshtastic --set serial_module_mode modeProto
|
||||
```
|
||||
|
||||
```shell title="Set RXD to GPIO pin number 7"
|
||||
meshtastic --set serial_module_rxd 7
|
||||
```
|
||||
|
||||
```shell title="Set TXD to GPIO pin number 28"
|
||||
meshtastic --set serial_module_txd 28
|
||||
```
|
||||
|
||||
```shell title="Set Baud Rate"
|
||||
meshtastic --set serial_module_baud baudDefault
|
||||
meshtastic --set serial_module_baud baud576000
|
||||
```
|
||||
|
||||
```shell title="Set Timeout to 15 seconds"
|
||||
meshtastic --set serial_module_timeout 15
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="flasher">
|
||||
|
||||
:::info
|
||||
Serial module config is not available in the Flasher.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
:::info
|
||||
Serial module config is not available for the Web UI.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: range-test-module
|
||||
title: Range Test Module Settings
|
||||
sidebar_label: Range Test Module
|
||||
title: Range Test Plugin Settings
|
||||
sidebar_label: Range Test Plugin
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
@ -12,8 +12,6 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
|
|||
|
||||
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_module" rename="range_test_plugin" />
|
||||
|
||||
:::tip
|
||||
Once module settings are changed, a **reset** is required for them to take effect.
|
||||
:::
|
||||
|
@ -22,15 +20,15 @@ Once module settings are changed, a **reset** is required for them to take effec
|
|||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-----------------------: | :-----------------: | :-----: |
|
||||
| range_test_module_enabled | `true`, `false` | `false` |
|
||||
| range_test_module_save | `true`, `false` | `false` |
|
||||
| range_test_module_sender | `integer` (Seconds) | `0` |
|
||||
| range_test_plugin_enabled | `true`, `false` | `false` |
|
||||
| range_test_plugin_save | `true`, `false` | `false` |
|
||||
| range_test_plugin_sender | `integer` (Seconds) | `0` |
|
||||
|
||||
### range_test_module_enabled
|
||||
### range_test_pluigin_enabled
|
||||
|
||||
Enables the module.
|
||||
Enables the plugin.
|
||||
|
||||
#### Enable/Disable the module
|
||||
#### Enable/Disable the plugin
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
|
@ -44,11 +42,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```shell title="Enable the module"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_plugin_enabled true
|
||||
```
|
||||
|
||||
```shell title="Disable the module"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_plugin_enabled true
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -75,7 +73,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### range_test_module_save
|
||||
### range_test_plugin_save
|
||||
|
||||
If enabled, we will save a log of all received messages to a file named `rangetest.csv` which you can access from the web server `Extensions > File Browser > rangetest.csv`. The file will be created after receiving messages. The device will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage.
|
||||
|
||||
|
@ -93,11 +91,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```shell title="Enable range test save"
|
||||
meshtastic --set range_test_module_save true
|
||||
meshtastic --set range_test_plugin_save true
|
||||
```
|
||||
|
||||
```shell title="Disable range test save"
|
||||
meshtastic --set range_test_module_save false
|
||||
meshtastic --set range_test_plugin_save false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -124,7 +122,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### range_test_module_sender
|
||||
### range_test_plugin_sender
|
||||
|
||||
Number of seconds to wait between sending packets. Using the long_slow channel configuration, it's best not to go more frequent than once every 60 seconds. You can be more aggressive with faster settings. `0` is default which disables sending messages.
|
||||
|
||||
|
@ -142,11 +140,11 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```shell title="Enable range test sender (send every 60 seconds)"
|
||||
meshtastic --set range_test_module_sender 60
|
||||
meshtastic --set range_test_plugin_sender 60
|
||||
```
|
||||
|
||||
```shell title="Disable range test sender"
|
||||
meshtastic --set range_test_module_sender 0
|
||||
meshtastic --set range_test_plugin_sender 0
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -177,12 +175,12 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
|
||||
While a minimum of two radios is required, more can be used. You can have any number of receivers and senders that your mesh is able to handle. You can test having a single sender with multiple receivers or a single receiver with multiple senders. Let us know on the [forum thread](https://meshtastic.discourse.group/t/new-plugin-rangetestplugin/2591) the results of your configuration.
|
||||
|
||||
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 plugin configured as a sender or the device where the plugin 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.
|
||||
|
||||
:::note
|
||||
Leaving this module on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](/docs/developers/protobufs/api#portnumsproto) are sent on.
|
||||
Leaving this plugin on can slow down your mesh. Currently, the messages are sent using the same `TEXT_MESSAGE_APP` [port that all other messages](/docs/developers/protobufs/api#portnumsproto) are sent on.
|
||||
:::
|
||||
|
||||
### Accessing your CSV
|
||||
|
@ -196,7 +194,7 @@ http://198.168.0.15
|
|||
|
||||
### Recommended Sender Settings
|
||||
|
||||
| Radio Setting | `range_test_module_sender` |
|
||||
| Radio Setting | `range_test_plugin_sender` |
|
||||
| :-----------: | :------------------------: |
|
||||
| Long Slow | 60 |
|
||||
| Long Alt | 30 |
|
||||
|
@ -219,8 +217,8 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```shell title="Example - Sender Node"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_module_sender 60
|
||||
meshtastic --set range_test_plugin_enabled true
|
||||
meshtastic --set range_test_plugin_sender 60
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -261,8 +259,8 @@ values={[
|
|||
<TabItem value="cli">
|
||||
|
||||
```shell title="Example - Receiver Node"
|
||||
meshtastic --set range_test_module_enabled true
|
||||
meshtastic --set range_test_module_save true
|
||||
meshtastic --set range_test_plugin_enabled true
|
||||
meshtastic --set range_test_plugin_save true
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
|
@ -1,29 +1,26 @@
|
|||
---
|
||||
id: serial-module
|
||||
title: Serial Module Settings
|
||||
sidebar_label: Serial Module
|
||||
title: Serial Plugin Settings
|
||||
sidebar_label: Serial 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.
|
||||
:::
|
||||
|
||||
<PluginModule name="serial_module" rename="serial_plugin" />
|
||||
|
||||
:::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
|
||||
|
||||
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
||||
This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this plugin does not (yet) allow arbitrary protobuf commands to be sent over the serial connection.
|
||||
|
||||
:::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.
|
||||
:::
|
||||
|
||||
:::tip
|
||||
|
@ -34,16 +31,16 @@ Connect the TX pin to the other device's RX pin, and vice versa. Connect their g
|
|||
|
||||
| Setting | Acceptable Values | Default |
|
||||
| :-------------------: | :-----------------: | :-----: |
|
||||
| serial_module_enabled | `true`, `false` | `false` |
|
||||
| serial_module_echo | `true`, `false` | `false` |
|
||||
| serial_module_mode | `integer` | `0` |
|
||||
| serial_module_rxd | `integer` (GPIO) | `0` |
|
||||
| serial_module_timeout | `integer` (seconds) | `0` |
|
||||
| serial_module_txd | `integer` (GPIO) | `0` |
|
||||
| serial_plugin_enabled | `true`, `false` | `false` |
|
||||
| serial_plugin_echo | `true`, `false` | `false` |
|
||||
| serial_plugin_mode | `integer` | `0` |
|
||||
| serial_plugin_rxd | `integer` (GPIO) | `0` |
|
||||
| serial_plugin_timeout | `integer` (seconds) | `0` |
|
||||
| serial_plugin_txd | `integer` (GPIO) | `0` |
|
||||
|
||||
### serial_module_enabled
|
||||
### serial_plugin_enabled
|
||||
|
||||
Enables the module.
|
||||
Enables the plugin.
|
||||
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
|
@ -56,12 +53,12 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Enable module"
|
||||
meshtastic --set serial_module_enabled true
|
||||
```shell title="Enable plugin"
|
||||
meshtastic --set serial_plugin_enabled true
|
||||
```
|
||||
|
||||
```shell title="Disable module"
|
||||
meshtastic --set serial_module_enabled false
|
||||
```shell title="Disable plugin"
|
||||
meshtastic --set serial_plugin_enabled false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -88,7 +85,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### serial_module_echo
|
||||
### serial_plugin_echo
|
||||
|
||||
If set, any packets you send will be echoed back to your device.
|
||||
|
||||
|
@ -103,12 +100,12 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Enable serial_module_echo"
|
||||
meshtastic --set serial_module_echo true
|
||||
```shell title="Enable serial_plugin_echo"
|
||||
meshtastic --set serial_plugin_echo true
|
||||
```
|
||||
|
||||
```shell title="Disable serial_module_echo"
|
||||
meshtastic --set serial_module_echo false
|
||||
```shell title="Disable serial_plugin_echo"
|
||||
meshtastic --set serial_plugin_echo false
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -135,7 +132,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### serial_module_mode
|
||||
### serial_plugin_mode
|
||||
|
||||
<!--- TODO --->
|
||||
|
||||
|
@ -178,7 +175,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### serial_module_rxd
|
||||
### serial_plugin_rxd
|
||||
|
||||
Set the GPIO pin to the RXD pin you have set up.
|
||||
|
||||
|
@ -202,7 +199,7 @@ Replace `GPIO` in the below command with the GPIO number your circuit is attache
|
|||
:::
|
||||
|
||||
```shell title="Set RXD to GPIO pin number"
|
||||
meshtastic --set serial_module_rxd GPIO
|
||||
meshtastic --set serial_plugin_rxd GPIO
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -229,7 +226,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### serial_module_timeout
|
||||
### serial_plugin_timeout
|
||||
|
||||
The amount of time to wait before we consider your packet as "done".
|
||||
|
||||
|
@ -244,8 +241,8 @@ values={[
|
|||
]}>
|
||||
<TabItem value="cli">
|
||||
|
||||
```shell title="Set serial_module_timeout to 15 seconds"
|
||||
meshtastic --set serial_module_timeout 15
|
||||
```shell title="Set serial_plugin_timeout to 15 seconds"
|
||||
meshtastic --set serial_plugin_timeout 15
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
@ -272,7 +269,7 @@ Configuring this setting is not yet available for the selected platform. If this
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### serial_module_txd
|
||||
### serial_plugin_txd
|
||||
|
||||
Set the GPIO pin to the TXD pin you have set up.
|
||||
|
||||
|
@ -296,7 +293,7 @@ Replace `GPIO` in the below command with the GPIO number your circuit is attache
|
|||
:::
|
||||
|
||||
```shell title="Set TXD to GPIO pin number"
|
||||
meshtastic --set serial_module_txd GPIO
|
||||
meshtastic --set serial_plugin_txd GPIO
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
|
|
|
@ -1,17 +1,15 @@
|
|||
---
|
||||
id: ios-development
|
||||
title: iOS application development
|
||||
sidebar_label: iOS & MacOS Apps
|
||||
title: Apple Applications
|
||||
sidebar_label: Apple Apps
|
||||
---
|
||||
|
||||
The Meshtastic iOS app is currently available in TestFlight as a public beta with a projected App Store release in the fall of 2022 alongside iOS 16.
|
||||
The Meshtastic Apple Apps are currently available in TestFlight as public betas with a projected App Store release in the fall of 2022 alongside iOS 16.
|
||||
|
||||
There are 1000 remaining beta spaces available and there are no codes.
|
||||
There are lesss than 1000 remaining beta spaces available and there are no codes.
|
||||
|
||||
iOS 15 is required and you can sign up by opening the following link on any iOS device with TestFlight installed.
|
||||
iOS 15 or macOS 12 is required and you can sign up by opening the following link on any iOS, iPadOS or macOS device with TestFlight installed.
|
||||
|
||||
Both 1.2 Legacy and 1.3 Preview builds are available.
|
||||
Both 1.2 Legacy and 1.3 Preview builds are available for iOS and iPadOS.
|
||||
|
||||
https://testflight.apple.com/join/c8nNl8q1
|
||||
|
||||
An alpha MacOS application is available in the beta TestFlight app for MacOS using the same link.
|
||||
|
|
|
@ -1,5 +1,11 @@
|
|||
---
|
||||
id: ios
|
||||
title: iOS
|
||||
sidebar_label: iOS
|
||||
title: iOS & iPadOS
|
||||
sidebar_label: iOS & iPadOS
|
||||
---
|
||||
|
||||
## iOS and iPadOS TestFlight
|
||||
|
||||
A beta iOS and iPadOS application is available in the TestFlight app using the following link:
|
||||
|
||||
https://testflight.apple.com/join/c8nNl8q1
|
|
@ -1,5 +0,0 @@
|
|||
---
|
||||
id: ipados
|
||||
title: iPadOS
|
||||
sidebar_label: iPadOS
|
||||
---
|
|
@ -1,5 +1,12 @@
|
|||
---
|
||||
id: macos
|
||||
title: MacOS
|
||||
sidebar_label: MacOS
|
||||
title: macOS
|
||||
sidebar_label: macOS
|
||||
---
|
||||
|
||||
|
||||
## macOS TestFlight
|
||||
|
||||
A beta macOS application is available in the TestFlight app for macOS using the following link:
|
||||
|
||||
https://testflight.apple.com/join/c8nNl8q1
|
12
docs/software/apple/maps.mdx
Normal file
12
docs/software/apple/maps.mdx
Normal file
|
@ -0,0 +1,12 @@
|
|||
---
|
||||
id: offline-maps
|
||||
title: Offline Maps
|
||||
sidebar_label: Offline Maps
|
||||
---
|
||||
|
||||
|
||||
## macOS TestFlight
|
||||
|
||||
A beta macOS application is available in the TestFlight app for macOS using the following link:
|
||||
|
||||
https://testflight.apple.com/join/c8nNl8q1
|
Loading…
Reference in a new issue