diff --git a/docs/community/local-groups.mdx b/docs/community/local-groups.mdx index d763f2c3..e9e81c5a 100644 --- a/docs/community/local-groups.mdx +++ b/docs/community/local-groups.mdx @@ -38,5 +38,8 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group. ### Hawaii - [Hawaii Meshnet](https://www.hawaiimesh.net/) +### Massachusetts +- [Boston Meshnet](https://github.com/Darachnid/Boston-Meshnet) + ### Texas - [Austin Mesh](https://austinmesh.org/) diff --git a/docs/configuration/module/mqtt.mdx b/docs/configuration/module/mqtt.mdx index 69b3dab3..7645e0e7 100644 --- a/docs/configuration/module/mqtt.mdx +++ b/docs/configuration/module/mqtt.mdx @@ -38,6 +38,10 @@ Whether to send encrypted or unencrypted packets to MQTT. This parameter is only ### JSON Enabled +:::note +JSON is not supported on the nRF52 platform. +::: + 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 diff --git a/docs/configuration/module/paxcounter.mdx b/docs/configuration/module/paxcounter.mdx index 1878dc41..6e24847e 100644 --- a/docs/configuration/module/paxcounter.mdx +++ b/docs/configuration/module/paxcounter.mdx @@ -67,7 +67,7 @@ meshtastic --set paxcounter.enabled true meshtastic --set paxcounter.enabled false ``` -```shell title="Set the Minimum Broadcast Interval to 90 seconds" +```shell title="Set the Minimum Broadcast Interval to 900 seconds" meshtastic --set paxcounter.paxcounter_update_interval 900 ``` diff --git a/docs/configuration/module/telemetry.mdx b/docs/configuration/module/telemetry.mdx index d6b4bd5a..bb3ada3f 100644 --- a/docs/configuration/module/telemetry.mdx +++ b/docs/configuration/module/telemetry.mdx @@ -44,7 +44,9 @@ Default is `900` seconds (15 minutes). How often we should send Device Metrics over the mesh. -Default is `900` seconds (15 minutes). +Default is `900` seconds (15 minutes). + +Device Metrics to a connected client app will always be sent once per minute, regardless of this setting. ### Environment Screen Enabled diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index a2794b6a..5ba782b0 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -78,7 +78,7 @@ This is the GPIO pin number that will be used for the PWM buzzer, if your device ### Node Info Broadcast Seconds -This is the number of seconds between NodeInfo message broadcasts from the device. The device will still respond ad-hoc to NodeInfo messages when a response is wanted. +This is the number of seconds between NodeInfo message (containing i.a. long and short name) broadcasts from the device. The device will still respond ad-hoc to NodeInfo messages when a response is wanted. When the device hears any packet from a node it doesn't know yet, it will send its NodeInfo and ask for a response automatically. ### Double Tap as Button Press diff --git a/docs/configuration/radio/network.mdx b/docs/configuration/radio/network.mdx index da0f99bb..25672dd9 100644 --- a/docs/configuration/radio/network.mdx +++ b/docs/configuration/radio/network.mdx @@ -167,7 +167,7 @@ All Network config options are available in the Web UI. ### WiFi Client -With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know to connect to your network. Make sure you are in range of your WiFi. If you have a single Meshtastic device on your local network it's easy to connect to your device with DNS `http://meshtastic.local`. If you have multiple Meshtastic devices you will need to connect using their respective IP addresses. +With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know to connect to your network. Make sure you are in range of your WiFi and it is a 2.4GHz-only network. If you have a single Meshtastic device on your local network it's easy to connect to your device with DNS `http://meshtastic.local`. If you have multiple Meshtastic devices you will need to connect using their respective IP addresses. ### Disable WiFi diff --git a/docs/hardware/devices/heltec/index.mdx b/docs/hardware/devices/heltec/index.mdx index e47eaea1..7ce37ce4 100644 --- a/docs/hardware/devices/heltec/index.mdx +++ b/docs/hardware/devices/heltec/index.mdx @@ -14,7 +14,7 @@ queryString="heltec" defaultValue="v3" values={[ {label: 'LoRa32 V2.1', value: 'v2.1'}, -{label: 'LoRa32 V3', value:'v3'}, +{label: 'LoRa32 V3/V3.1', value:'v3'}, {label: 'Wireless Stick Lite V3', value:'Wireless Stick Lite V3'}, {label: 'Wireless Tracker', value: 'tracker'}, {label: 'Wireless Paper', value: 'paper'} @@ -54,7 +54,7 @@ Not recommended because of design issues! Support is being phased out. Use V3 in -## HELTEC v3 +## HELTEC v3/v3.1 :::info This device may have issues charging a connected battery if utilizing a USB-C to USB-C cable. It's recommended to use a USB-A to USB-C cable. @@ -75,6 +75,13 @@ This device may have issues charging a connected battery if utilizing a USB-C to - Dedicated 2.4 GHz metal spring antenna for WiFi/Bluetooth - U.FL/IPEX antenna connector for LoRa +### V3.1 differences + +Firmware remains the same as V3 below. Compare schematics: [V3.0](https://web.archive.org/web/20221127054612/https://resource.heltec.cn/download/WiFi_LoRa32_V3/HTIT-WB32LA(F)_V3_Schematic_Diagram.pdf) and [V3.1](https://resource.heltec.cn/download/WiFi_LoRa_32_V3/HTIT-WB32LA(F)_V3.1_Schematic_Diagram.pdf). Key differences: + +- Removal of [FDG6322C](https://www.mouser.com/datasheet/2/308/1/FDG6322C_D-2312203.pdf) (a dual N & P channel FET) from the V3.1 power supply. +- Antenna filter values in V3.1 (L11 = 1.8pF, C15 = 2.7nH, C24 = 1.8pF) align more closely with ESP32-S3 reference design than V3.0 (L11 = 1.6nH, C15 = 6.9pF, C24 = 2.4pF). + ### Features - Built in 0.96 inch OLED display diff --git a/docs/hardware/devices/heltec/peripherals.mdx b/docs/hardware/devices/heltec/peripherals.mdx index 0b55dd6e..a19186cf 100644 --- a/docs/hardware/devices/heltec/peripherals.mdx +++ b/docs/hardware/devices/heltec/peripherals.mdx @@ -77,14 +77,15 @@ By following this guide, you can enhance your Heltec ESP32 V3 board with valuabl ## Keyboard -Comming Soon +Coming Soon ## Buzzer -Commming Soon +Coming Soon + diff --git a/docs/hardware/devices/index.mdx b/docs/hardware/devices/index.mdx index feb64e21..f1131a97 100644 --- a/docs/hardware/devices/index.mdx +++ b/docs/hardware/devices/index.mdx @@ -106,7 +106,7 @@ Inexpensive basic ESP32-based boards. | Name | MCU | Radio | WiFi | BT | GPS | |:------------------------------------------------------------------|:------------|:-------|:------------:|:---:|:---:| | [LoRa32 V2.1](./heltec/?heltec=v2.1) | ESP32 | SX127x | 2.4GHz b/g/n | 4.2 | NO | -| [LoRa32 V3](./heltec/?heltec=v23) | ESP32 | SX1262 | 2.4GHz b/g/n | 4.2 | NO | +| [LoRa32 V3/3.1](./heltec/?heltec=v23) | ESP32 | SX1262 | 2.4GHz b/g/n | 4.2 | NO | | [Wireless Stick Lite V3](./heltec/?heltec=Wireless+Stick+Lite+V3) | ESP32-S3FN8 | SX1262 | 2.4GHz b/g/n | 5.0 | NO | | [Wireless Tracker](./heltec/?heltec=tracker) | ESP32-S3FN8 | SX1262 | 2.4GHz b/g/n | 5.0 | YES | | [Wireless Paper](./heltec/?heltec=paper) | ESP32-S3FN8 | SX1262 | 2.4GHz b/g/n | 5.0 | NO | diff --git a/docs/software/integrations/atak-plugin.mdx b/docs/software/integrations/atak-plugin.mdx index d2732ecc..609e836b 100644 --- a/docs/software/integrations/atak-plugin.mdx +++ b/docs/software/integrations/atak-plugin.mdx @@ -23,11 +23,13 @@ The ATAK plugin does not permit any Meshtastic configuration. The plugin does th 2. Set the device's role to `TAK` in the [device configuration settings](/docs/configuration/radio/device/). -3. With the Meshtastic Android App running in the background (to ensure the IMeshService is alive), launch ATAK (with the Meshtastic ATAK-Plugin installed or install it once ATAK is running) and you should observe a green Meshtastic icon in the bottom right. If the icon is red, then the plugin was not able to bind to the IMeshService provided by the Meshtastic Android App. If this is the case, check to ensure the Meshtastic Android App is functioning. The plugin will reconnect after a failed bind without restarting ATAK. +3. Install the version of the Meshtastic ATAK-Plugin that matches the ATAK version on all participants' devices from the [project's GitHub Releases](https://github.com/meshtastic/ATAK-Plugin/releases). + +4. With the Meshtastic Android App running in the background (to ensure the IMeshService is alive), launch ATAK (with the Meshtastic ATAK-Plugin installed or install it once ATAK is running) and you should observe a green Meshtastic icon in the bottom right. If the icon is red, then the plugin was not able to bind to the IMeshService provided by the Meshtastic Android App. If this is the case, check to ensure the Meshtastic Android App is functioning. The plugin will reconnect after a failed bind without restarting ATAK. If you do not see a Meshtastic icon, make sure that you have installed the Meshtastic ATAK-Plugin correctly. ## Standalone TAK Tracker usage -For devices with GPS available, configuring the device's role to `TAK_TRACKER` will allow the Meshtastic to transmit TAK PLI (Position Location Information) independently of ATAK. This data can be received and displayed within ATAK EUDs connected to a Meshtastic device and configured with the Meshtastic ATAK plugin (provided they are configured on the same Meshtastic channels). +For devices with GPS available, configuring the device's role to `TAK_TRACKER` will allow the Meshtastic to transmit TAK PLI (Position Location Information) independently of ATAK. This data can be received and displayed within ATAK EUDs connected to a Meshtastic device and configured with the Meshtastic ATAK plugin (provided they are configured on the same Meshtastic channels). A couple of important notes regarding this setup: diff --git a/docs/software/integrations/mqtt/index.mdx b/docs/software/integrations/mqtt/index.mdx index f885e3f4..90ae23e9 100644 --- a/docs/software/integrations/mqtt/index.mdx +++ b/docs/software/integrations/mqtt/index.mdx @@ -54,6 +54,10 @@ The payload is a raw protobuf, whose definitions for Meshtastic can be found [he If [encryption_enabled](/docs/configuration/module/mqtt#encryption-enabled) is set to true, the payload of the MeshPacket will remain encrypted with the key for the specified channel. #### JSON topic +:::note +JSON is not supported on the nRF52 platform. +::: + If [JSON is enabled](/docs/configuration/module/mqtt#json-enabled), packets from the following [port numbers](/docs/development/firmware/portnum) are serialized to JSON: `TEXT_MESSAGE_APP`, `TELEMETRY_APP`, `NODEINFO_APP`, `POSITION_APP`, `WAYPOINT_APP`, `NEIGHBORINFO_APP`, `TRACEROUTE_APP`, `DETECTION_SENSOR_APP`, `PAXCOUNTER_APP` and `REMOTE_HARDWARE_APP`. These are then forwarded to the topic: `msh/2/json/CHANNELNAME/USERID`. @@ -123,7 +127,7 @@ For the type `sendtext`, the `payload` should be a string containing the text to Check out [MQTT Settings](/docs/configuration/module/mqtt) for full information. For quick start instructions, read on. - Connect your gateway node to wifi, by setting the `network.wifi_ssid`, `network.wifi_psk` and `network.wifi_enabled` preferences. -- Alternatively use the RAK4631 with Ethernet Module RAK13800, by setting `network.eth_mode` and `network.eth_enabled`. +- Alternatively use the RAK4631 with Ethernet Module RAK13800, by setting `network.eth_mode` and `network.eth_enabled` (note that JSON is not supported on the nRF52 platform). - Configure your broker settings: `mqtt.address`, `mqtt.username`, and `mqtt.password`. If all are left blank, the device will connect to the Meshtastic broker. - Set `uplink_enabled` and `downlink_enabled` as appropriate for each channel. Most users will just have a single channel (at channel index 0). `meshtastic --ch-index 0 --ch-set uplink_enabled true` diff --git a/docs/software/integrations/mqtt/nodered.mdx b/docs/software/integrations/mqtt/nodered.mdx index 4c465cd3..85456688 100644 --- a/docs/software/integrations/mqtt/nodered.mdx +++ b/docs/software/integrations/mqtt/nodered.mdx @@ -54,6 +54,10 @@ The JSON output only publishes the following subset of the messages on a Meshtas > Protobufs are mesh native. #### 1. Using JSON-encoded messages +:::note +JSON is not supported on the nRF52 platform. +::: + Make sure that option *JSON Output Enabled* is set in MQTT module options and you have a channel called "mqtt". Below is a valid JSON envelope for information sent by MQTT to a device for broadcast onto the mesh. The `to` field is optional and can be omitted for broadcast. The `channel` field is also optional and can be omitted to send to the primary channel. diff --git a/docusaurus.config.js b/docusaurus.config.js index 2214253a..d7e177d5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -23,7 +23,6 @@ const config = { }, }, navbar: { - title: "Meshtastic", hideOnScroll: true, logo: { alt: "Meshtastic Logo", @@ -39,6 +38,10 @@ const config = { label: "Downloads", to: "downloads", }, + { + label: "Donate", + to: "docs/contributing/#supporting-and-contributing-to-meshtastic", + }, { label: "About", position: "right",