mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-01-30 07:10:51 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'master' into patch-1

Browse source
This commit is contained in:
charminULTRA 2023-07-11 21:53:59 -04:00 committed by GitHub
parent de9200fa4f 70c8e3f5a8
commit ab4fb3671d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 187 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
docs/configuration/device-config/position.mdx
View file

@ -8,31 +8,31 @@ sidebar_label: Position
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf.
The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Smart Broadcast Minimum Distance, Smart Broadcast Minimum Interval, Broadcast Interval, Position Packet Flags, and GPS RX/TX Pins. Position config uses an admin message sending a `Config.Position` protobuf.
Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a GPS or internet connection for time.
## Position Config Values
### GPS Disabled
### GPS Enabled
Acceptable values: `true` or `false`
Defaults to false. Should the device GPS be disabled for this node?
Defaults to true. Enables GPS on the node.
### GPS Update Interval
How often should we try to get GPS position (in seconds), or zero for the default of once every 30 seconds, or a very large value (maxint) to update only once at boot.
How often we should try to get GPS position (in seconds), or zero for the default of once every 2 minutes, or a very large value (maxint) to update only once at boot.
### GPS Attempt Time
How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 30 seconds.
How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 15 minutes.
### Fixed Position
Acceptable values: `true` or `false`
Off by default
True by default
If set, this node is at a fixed position. The device will generate GPS updates at the regular GPS update interval, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS.
@ -40,7 +40,7 @@ If set, this node is at a fixed position. The device will generate GPS updates a
Acceptable values: `true` or `false`
On by default
True by default
Smart broadcast will send out your position at an increased frequency only if your location has changed enough for a position update to be useful.
@ -48,17 +48,29 @@ Smart broadcast complements broadcast interval (doesn't override that setting) b
Smart broadcast will calculate an ideal position update interval based on the data rate of your selected channel configuration.
### Smart Broadcast Minimum Distance
Default of `0` is 100 meters
The minimum distance in meters traveled (since the last send) before we can send a position to the mesh if smart broadcast is enabled.
### Smart Broadcast Minimum Interval
Default of `0` is 30 seconds
The minimum number of seconds (since the last send) before we can send a position to the mesh if smart broadcast is enabled.
### Broadcast Interval
Default of `0` is 15 minutes
If smart broadcast is of we should send our position this often (but only if it has changed significantly)
If smart broadcast is off we should send our position this often (but only if it has changed significantly)
The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved. This defaults to broadcast every 15 minutes.
The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved.
### Position Flags
Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags)
Defines which options are sent in POSITION messages. Values are stored as a bit field of boolean configuration options (bitwise OR of PositionFlags).
| Value | Description |
| :----------------: | :--------------------------------------------------------------: |
@ -117,13 +129,15 @@ All Position config commands are available in the python CLI. Example commands a
:::
| Setting | Acceptable Values | Default |
| :---------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: |
| :------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: |
| position.gps_enabled | `true`, `false` | `true` |
| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds |
| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds |
| position.gps_update_interval | `integer` (seconds) | Default `0` is 2 Minutes |
| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 15 Minutes |
| position.fixed_position | `true`, `false` | `false` |
| position.position_broadcast_smart_enabled | `true`, `false` | `true` |
| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes |
| position.broadcast_smart_minimum_distance | `integer` (meters) | Default of `0` is 100 Meters |
|position.broadcast_smart_minimum_interval_secs| `integer` (seconds) | Default of `0` is 15 Minutes |
| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 30 Seconds |
| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` |
| position.rx_gpio | `integer` (0-39) | `UNSET` |
| position.tx_gpio | `integer` (0-34) | `UNSET` |

4
docs/configuration/device-config/power.mdx
View file

@ -13,7 +13,7 @@ import calculateADC from "/src/utils/calculateADC";
Power settings are advanced configuration, most users should choose a role under [Device Config](/docs/settings/config/device) to manage power for their device and shouldn't ever need to adjust these settings.
:::
The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override, Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval, and Minimum Wake Interval. Power config uses an admin message sending a `Config.Power` protobuf.
The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override, Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval, Minimum Wake Interval, and Device Battery INA2xx Address. Power config uses an admin message sending a `Config.Power` protobuf.
:::info
ADC Multiplier, Super Deep Sleep, and Light Sleep settings only apply to ESP32-based boards. These settings will have no effect on nRF52 modules.
@ -176,7 +176,7 @@ All Power config options are available in the python CLI.
| power.wait_bluetooth_secs | `integer` (seconds) | Default of `0` is 1 minute |
| power.mesh_sds_timeout_secs | `integer` (seconds) | Default of `0` is 2 hours |
| power.sds_secs | `integer` (seconds) | Default of `0` is 1 year |
| power.ls_secs | `integer` (seconds) | Default of `0` is 1 hour |
| power.ls_secs | `integer` (seconds) | Default of `0` is 5 minutes |
| power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds |
| power.device_battery_ina_address | `integer` (I2C address as decimal) | Default of `0` is no address set |

4
docs/configuration/device-config/user.mdx
View file

@ -51,7 +51,7 @@ values={[
:::info
User Config options are available for Android.
All User config options are available for Android.
1. Open the Meshtastic App
2. Navigate to: **Vertical Ellipsis (3 dots top right) > Radio Configuration > User**
@ -63,7 +63,7 @@ User Config options are available for Android.
<TabItem value="apple">
:::info
`ShortName` and `LongName` User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`.
All User config options are available on iOS, iPadOS and macOS at `Settings > Radio Configuration > User`.
:::
</TabItem>

10
docs/configuration/module-config/audio.mdx
View file

@ -96,8 +96,8 @@ All audio module config options are available in the python CLI. Example command
:::
| Setting | Acceptable Values | Default |
| :-----------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: |
| audio.enabled | `true`, `false` | `false` |
| :----------------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: |
|audio.codec2_enabled| `true`, `false` | `false` |
| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset |
| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` |
| audio.i2s_ws | GPIO Pin Number 1-34 | no Default |
@ -110,14 +110,14 @@ All audio module config options are available in the python CLI. Example command
Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one.
```shell title="Example:"
meshtastic --set audio.enabled true --set audio.bitrate CODEC2_1400
meshtastic --set audio.codec2_enabled true --set audio.bitrate CODEC2_1400
```
:::
```shell title="Enable / Disable Module"
meshtastic --set audio.enabled true
meshtastic --set audio.enabled false
meshtastic --set audio.codec2_enabled true
meshtastic --set audio.codec2_enabled false
```
```shell title="Set WS to GPIO pin number 7"

6
docs/configuration/module-config/canned-message.mdx
View file

@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem";
The Canned Message 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 canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf.
The canned message module config options are: Enabled, Send Bell, Messages, Input Source, Rotary Encoder Enabled, Up Down Encoder Enabled, Input Broker Pin A, Input Broker Pin B, Input Broker Pin Press, Input Broker Event Clockwise, Input Broker Event Counter Clockwise, and Input Broker Event Press. Canned Message config uses an admin message sending a `ConfigModule.CannedMessage` protobuf.
<object data="https://www.youtube.com/embed/qKQVYUbLLkg?autohide=1&autoplay=0" width="100%" height="400"></object>
@ -25,7 +25,7 @@ Enables the canned message module.
Sends a bell character with each message.
The [External Notification Module](external-notification) can be set up to beep when a new message arrives.
This module can also be configured to beep only when message contains the bell character.
This module can also be configured to beep only when a message contains the bell character.
### Messages
@ -119,7 +119,7 @@ Example commands are below:
| canned_message.enabled | `true`, `false` | `false` |
| canned_message.send_bell | `true`, `false` | `false` |
| canned_message.allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb` | `_any` |
| canned_message.messages | `string` | `""` (separate using pipes) |
| --set-canned-message | `string` | `""` (separate using pipes) |
| canned_message.inputbroker_event_cw | `InputEventChar` | (not defined) |
| canned_message.inputbroker_event_ccw | `InputEventChar` | (not defined) |
| canned_message.inputbroker_event_press | `InputEventChar` | (not defined) |

10
docs/configuration/module-config/external-notification.mdx
View file

@ -10,6 +10,8 @@ import TabItem from "@theme/TabItem";
The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network. You can enable up to 3 pins independently from each other.
The External Notification Module config options are: Enabled, Active, Alert Bell (General),Alert Bell Vibra, Alert Bell Buzzer, Alert Message (General), Alert Message Vibra, Alert Message Buzzer, Output (General), Output Vibra, Output Buzzer, Output Milliseconds, Use PWM, and Nag Timeout. External Notification config uses an admin message sending a `ConfigModule.ExternalNotificationConfig` protobuf.
<object data="https://www.youtube.com/embed/MWt3RHMpifo?autohide=1&autoplay=0" width="100%" height="400"></object>
## External Notification Module Config Values
@ -18,6 +20,10 @@ The External Notification Module will allow you to connect a buzzer, speaker, LE
Enables the external notification module.
### Active (general / LED only)
Specifies whether the external circuit is active when the device's GPIO is low or high. If this is set true, the pin will be pulled active high, false means active low.
### Alert when receiving a bell (general / LED, Vibra and Buzzer)
Specifies if an alert should be triggered when receiving an incoming bell.
@ -26,10 +32,6 @@ Specifies if an alert should be triggered when receiving an incoming bell.
Specifies if an alert should be triggered when receiving an incoming message.
### Active (general / LED only)
Specifies whether the external circuit is active when the device's GPIO is low or high.
### GPIO Pins (general / LED, Vibra and Buzzer)
Specifies the GPIO that your external circuit is attached to on the device. On devices that have a PWM buzzer, you can use the buzzer for notifications by setting the use_pwm property to TRUE. The Buzzer Pin will be ignored and the device.buzzer_gpio is used instead. If you enable PWM mode, the device will use

34
docs/configuration/module-config/mqtt.mdx
View file

@ -8,9 +8,9 @@ sidebar_label: MQTT
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must be enabled as uplink and/or downlink for protobufs to be transmitted from and/or to the mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings the node will still connect to MQTT server and send status messages.
If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages.
The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled and JSON Enabled. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf.
The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled, JSON Enabled, TLS Enabled, and Root Topic. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf.
## Settings
@ -22,7 +22,7 @@ Enables the MQTT module.
### Server Address
The server to use for MQTT. If not set, the default server public will be used.
The server to use for MQTT. If not set, the default public server will be used.
### Username
@ -30,16 +30,24 @@ MQTT Server username to use (most useful for a custom MQTT server). If using a c
### Password
MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password
MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password.
### Encryption Enabled
Whether to send encrypted or decrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets.
Whether to send encrypted or unencrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets). Unencrypted packets may be useful for external systems that want to consume meshtastic packets.
### JSON Enabled
Enable the sending / consumption of JSON packets on MQTT. These packets are not encrypted, but offer an easy way to integrate with systems that can read JSON.
### TLS Enabled
If true, we attempt to establish a secure connection using TLS.
### Root Topic
The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs.
## MQTT Module Config Client Availability
<Tabs
@ -66,7 +74,9 @@ MQTT Config options are available for Android.
<TabItem value="apple">
:::info
MQTT module config is not available for Apple.
MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT.
:::
</TabItem>
@ -79,13 +89,15 @@ All MQTT module config options are available in the python CLI. Example commands
:::
| Setting | Acceptable Values | Default |
| :---------------------: | :---------------: | :-----: |
| :---------------------: | :---------------: | :-----------------: |
| mqtt.enabled | `true`, `false` | `false` |
| mqtt.address | `string` | |
| mqtt.username | `string` | |
| mqtt.password | `string` | |
| mqtt.encryption_enabled | `string` | |
| mqtt.address | `string` |`mqtt.meshtastic.org`|
| mqtt.username | `string` | `meshdev` |
| mqtt.password | `string` | `large4cats` |
| mqtt.encryption_enabled | `true`, `false` | `false` |
| mqtt.json_enabled | `true`, `false` | `false` |
| mqtt.tls_enabled | `true`, `false` | `false` |
| mqtt.root | `string` | |
:::tip

78
docs/configuration/module-config/range-test.mdx
View file

@ -8,7 +8,16 @@ sidebar_label: Range Test
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
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.
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 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.
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.
:::info
Be sure to turn off the module or disable sending when not in use. This will use a lot of time on air, slow down your mesh, and spam your channel.
:::
The range test module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.RangeTest` protobuf.
@ -18,13 +27,33 @@ The range test module config options are: Enabled, Save, and Sender. Range Test
Enables the range test module.
### Save CSV File `ESP32 Only Setting`
### Save CSV File
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.
:::info
Saving files is only available on ESP32-based devises
:::
If enabled, a log of all received messages will be saved to a file named rangetest.csv.
To access this file, first turn on the WiFi on your device and connect to your network. Once you can connect to your device, navigate to `meshtastic.local/rangetest.csv` (or your_device_ip/rangetest.csv) and the file will be downloaded automatically. This file will only be created after receiving initial messages.
To prevent filling up the storage, the device will abort writing if there is less than 50kb of space on the filesystem.
### Sender Interval
How long to wait between sending test packets. 0 is default which disables sending messages.
How long to wait between sending sequential test packets. 0 is default which disables sending messages.
### Recommended Sender Settings
| Radio Setting | `range_test.sender` |
| :-----------: | :-----------------: |
| Long Slow | 60 |
| Long Alt | 30 |
| Medium | 15 |
| Short Fast | 15 |
## Range Test Module Config Client Availability
@ -48,6 +77,8 @@ Range Test Config options are available for Android.
:::
Android also had the option to download a rangetest.csv file which is stored on your phone. This file does not require the Range Test module to be active and will log all incoming Nodeinfo, Position, Telemetry and Messages.
</TabItem>
<TabItem value="apple">
@ -55,6 +86,8 @@ Range Test Config options are available for Android.
All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test.
:::
Apple apps also have the option to download logged position data which is stored on your iPhone/iPad/Mac. Access this by clicking on the Nodes tab, selecting a node, then select Position Log and click Save. This data file does not require the Range Test module to be active.
</TabItem>
<TabItem value="cli">
@ -103,42 +136,13 @@ meshtastic --set range_test.sender 0
:::info
No range test module config options are available in the Web UI.
All range test module config options are available in the Web UI.
:::
</TabItem>
</Tabs>
## Examples
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.
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](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum) are sent on.
:::
### Accessing your CSV
Connect to your device over WiFi, either using the [software access point](/docs/settings/config/network#software-access-point) or [WiFi Client](/docs/settings/config/network#wifi-client). Then navigate to `meshtastic.local` (or your IP address). Your file will be available for download under `Extensions > File Browser > rangetest.csv` once it has been created by receiving messages.
```plaintext title="Example URLs"
http://meshtastic.local
http://198.168.0.15
```
### Recommended Sender Settings
| Radio Setting | `range_test.sender` |
| :-----------: | :-----------------: |
| Long Slow | 60 |
| Long Alt | 30 |
| Medium | 15 |
| Short Fast | 15 |
## Application Examples
@ -169,10 +173,6 @@ You can style the ranges differently based on the values, so you can have the pi
## FAQ
Q: Where is rangetest.csv saved?
- Turn on the WiFi on your device as either a WiFi client or a WiFi AP. Once you can connect to your device, navigate to `Extensions > File Browser` and you will see `rangetest.csv` once messages have been saved and the file has been created.
Q: Do I need to have WiFi turned on for the file to be saved?
- Nope, it'll just work.
@ -191,7 +191,7 @@ Q: What will happen if I run out of space on my device?
Q: What do I do with the rangetest.csv file when I'm done?
- Go to /static and delete the file.
- Currently the only way to erase the file is to perform a factory reset.
Q: Can I use this as a sender while on battery power?

2
docs/configuration/module-config/serial.mdx
View file

@ -8,7 +8,7 @@ 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.
The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO, Baud Rate, Timeout, and Override Console Serial Port. 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.

3
docs/getting-started/flashing-firmware/nrf52/index.mdx
View file

@ -12,6 +12,9 @@ The nRF52 based devices have the easiest firmware upgrade process. No driver or
### Drag & Drop
nRF52 devices use the [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) installation method to install firmware releases.
### Over-The-Air (OTA)
nRF52 devices are able to accept [OTA firmware updates](/docs/getting-started/flashing-firmware/nrf52/ota) from a mobile device over bluetooth.
### Factory Erase
You may wish to perform a [Factory Erase](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) prior to installing firmware to clear data that may change format and location between releases.

50
docs/getting-started/flashing-firmware/nrf52/ota.mdx Normal file
View file

@ -0,0 +1,50 @@
---
id: ota
title: nRF52 OTA Firmware Updates
sidebar_label: Over-The-Air
sidebar_position: 2
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
nRF52 devices are able to accept OTA firmware updates from a mobile device over bluetooth.
<Tabs
groupId="settings"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
]}>
<TabItem value="android">
:::info
As of this writing, the current Android release of the nRF DFU app (v2.3.0) is not compatible with Meshtastic firmware updates.
:::
OTA firmware updates are available for Android using an older release of the more advanced nRF Connect App __version 4.24.3__ which is available for download from the [Nordic Semiconductor GitHub page](https://github.com/NordicSemiconductor/Android-nRF-Connect/releases/tag/v4.24.3).
1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads) or [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases).
2. Unzip the firmware folder
3. Open the nRF Connect App and select CONNECT on your device from the SCANNER tab
4. Select the DFU icon from the top-right of the screen
5. Select the correct device firmware file (will end with -ota.zip)
6. The update will start automatically
</TabItem>
<TabItem value="apple">
OTA firmware updates are available on iOS & iPadOS using the nRF Device Firmware Update App available through the [Apple App Store](https://apps.apple.com/us/app/nrf-device-firmware-update/id1624454660)
1. Download the firmware release you wish to install from the [Meshtastic Download Page](/downloads), [Meshtastic GitHub](https://github.com/meshtastic/firmware/releases), or via the iOS or iPadOS app.
2. Unzip the firmware folder
3. Open the nRF DFU App and select the correct device firmware file (will end with -ota.zip)
4. Connect to your device
5. Upload the firmware
</TabItem>
</Tabs>

8
docs/legal/trademark-grants.mdx
View file

@ -14,3 +14,11 @@ sidebar_label: Trademark Grants
- Details: Tony is an admin and contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Tony is sponsored or endorsed by Meshtastic. Tony also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
- Grant: http://k9rocket.tech
- Details: K9 Rocket Technologies is an open technology development company selling and implementing Meshtastic-powered devices. The devices and their respective promotional content carry the "Powered by Meshtastic", "Meshtastic", & "M" logos. The use of the Meshtastic Logo and Trademarks does not imply K9 Rocket Technologies is sponsored or endorsed by Meshtastic. K9 Rocket Technologies also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason
- Grant: Ben Lipsey
- Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
- Grant: Mark Birss
- Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
- Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe)
- Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.
- Grant: [Keith Monaghan](http://voltaicenclosures.com/)
- Details: Keith is a contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Keith is sponsored or endorsed by Meshtastic. Keith also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.