mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-19 23:57:31 -07:00
Merge branch 'master' into mqtt-default-server
This commit is contained in:
Ben Lipsey
GitHub
commit
d9b594e9ed
|
|
@ -42,7 +42,7 @@ A `PUT` request to this endpoint will be expected to contain a series of ToRadio
|
|||
|
||||
The protobufs will be sent in binary as the body for the request.
|
||||
|
||||
For the initial implementation, only one ToRadio message per request is supported, but future optimizations to improve throughput might add support for multiple ToRadios in a single request.
|
||||
Only one ToRadio message per request is supported.
|
||||
|
||||
#### OPTIONS
|
||||
|
||||
|
|
@ -76,9 +76,7 @@ The protobufs will be sent in binary as the body for the request.
|
|||
|
||||
## Authentication
|
||||
|
||||
The initial release will not have **any** user authentication. We assume access to the HTTP server is enough to establish trust.
|
||||
|
||||
Since authentication is also eventually needed for our other transports (TCP and eventually open BLE), we will be adding authentication **in-band**. When added in the second release there will be a new payload supported inside ToRadio for `SignIn <userid> <usersecret>`. The server will respond with a FromRadio `SignInResponse okay|fail`. Also, in the case of the REST API, that SignIn status will then be associated with the current session key. Most (all?) ToRadio packets will be ignored if the client is not signed in. Most (all?) FromRadio packets will be sent to clients that are not signed in.
|
||||
There isn't **any** user authentication. We assume access to the HTTP server is enough to establish trust.
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
|||
75
docs/hardware/devices/Nano Series/buttons.mdx
Normal file
75
docs/hardware/devices/Nano Series/buttons.mdx
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
---
|
||||
id: buttons
|
||||
title: Hardware Buttons
|
||||
sidebar_label: Buttons
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
## Device
|
||||
|
||||
<Tabs
|
||||
groupId="nano-series"
|
||||
defaultValue="g2"
|
||||
values={[
|
||||
{label: 'Nano G2 Ultra', value:'g2'},
|
||||
{label: 'Nano G1 Explorer', value: 'g1-e'},
|
||||
{label: 'Nano G1', value: 'g1'}
|
||||
]}>
|
||||
|
||||
<TabItem value="g2">
|
||||
|
||||
### Nano G2 Ultra Buttons
|
||||
|
||||
- **User/Program Button:**
|
||||
- **Single press:** Changes the information page displayed on the device's screen.
|
||||
- **Double press:** Sends an adhoc ping of the device's position to the network.
|
||||
- **Long press:** Will signal the device to shutdown after 5 seconds (*soft off*).
|
||||
- **Message Read Button:**
|
||||
- **Single press:** Clears the New Message LED.
|
||||
|
||||
### Nano G2 Ultra Switches
|
||||
|
||||
- **Power:**
|
||||
- **Toggle Up:** Turns on the device.
|
||||
- **Toggle Down:** Turns off the device.
|
||||
- **Location Pin:**
|
||||
- **Toggle Up:** Sets GPS to operating mode.
|
||||
- **Toggle Down:** Sets GPS to low power mode.
|
||||
- **Bell:**
|
||||
- **Toggle Up:** Selects Buzzer for Enhanced Message Notification Circuit.
|
||||
- **Toggle Down:** Selects LED for Enhanced Message Notification Circuit.
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="g1-e">
|
||||
|
||||
### Nano G1 Explorer Buttons
|
||||
|
||||
- **User/Program Button:**
|
||||
- **Single press:** Changes the information page displayed on the device's screen.
|
||||
- **Double press:** Sends an adhoc ping of the device's position to the network.
|
||||
- **Message Read Button:**
|
||||
- **Single press:** Clears the New Message LED.
|
||||
|
||||
### Nano G1 Explorer Switches
|
||||
|
||||
- **Power:**
|
||||
- **Toggle Up:** Turns on the device.
|
||||
- **Toggle Down:** Turns off the device.
|
||||
- **Location Pin:**
|
||||
- **Toggle Up:** Sets GPS to operating mode.
|
||||
- **Toggle Down:** Sets GPS to low power mode.
|
||||
- **Bell:**
|
||||
- **Toggle Up:** Selects Buzzer for Enhanced Message Notification Circuit.
|
||||
- **Toggle Down:** Selects LED for Enhanced Message Notification Circuit.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="g1">
|
||||
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
147
docs/hardware/devices/Nano Series/index.mdx
Normal file
147
docs/hardware/devices/Nano Series/index.mdx
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
---
|
||||
id: nano-series
|
||||
title: Nano Series
|
||||
sidebar_label: Nano Series
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
The Nano Series, designed by Neil Hao from B&Q Consulting and powered by Meshtastic, are devices engineered to be a portable and durable solution for outdoor adventures such as hiking, piloting, skiing and more. They are designed to strike a balance between RF performance, size, ruggedness, and power efficiency — providing users with a reliable solution in various outdoor environments.
|
||||
|
||||
For a full and complete comparison of the different devices in the Nano series, be sure to visit B&Q Consulting's [nano series wiki page](https://wiki.uniteng.com/en/meshtastic#nano-edition).
|
||||
|
||||
<Tabs
|
||||
groupId="nano-series"
|
||||
defaultValue="g2"
|
||||
values={[
|
||||
{label: 'Nano G2 Ultra', value:'g2'},
|
||||
{label: 'Nano G1 Explorer', value: 'g1-e'},
|
||||
{label: 'Nano G1', value: 'g1'}
|
||||
]}>
|
||||
|
||||
<TabItem value="g2">
|
||||
|
||||
The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circuit design and internal wideband Lora antenna. The primary design goal of the Nano G2 Ultra is to reduce power consumption and improve battery life by using the low power MCU NRF52840. The typical battery life is optimized to be about 3.5 days. As with the Nano G1 Explorer, the Nano G2 Ultra's design also takes into account the potential impact of the human body on its antenna performance, ensuring optimal RF performance even when carried in a pocket.
|
||||
|
||||
### Nano G2 Ultra Specifications
|
||||
|
||||
- **MCU:**
|
||||
- NRF52840
|
||||
- Bluetooth 5.4
|
||||
- **LoRa Transceiver:**
|
||||
- Semtech SX1262
|
||||
- **Frequency Options:**
|
||||
- _US (902.0Mhz to 928.0Mhz), EU_868 (869.4Mhz to 869.65Mhz), JP (920.8Mhz to 927.8Mhz), ANZ (915.0Mhz to 928.0Mhz), RU (868.7Mhz to 869.2Mhz), KR (920.0Mhz to 923.0Mhz), TW (920.0Mhz to 925.0Mhz), IN (865.0Mhz to 867.0Mhz), NZ_865 (864.0Mhz to 868.0Mhz), TH (920.0Mhz to 925.0Mhz), UA_868 (868.0Mhz to 868.6Mhz)._
|
||||
- **Navigation Module:**
|
||||
- ATGM336H-5N-71 (Supports GPS, BDS and GLONASS)
|
||||
- **Antenna:**
|
||||
- New internal wide-band antenna with optimized wide-band LoRa RF frontend circuit.
|
||||
- **Connectors:**
|
||||
- USB-C
|
||||
|
||||
### Nano G2 Ultra Features
|
||||
|
||||
- Meshtastic pre-installed.
|
||||
- New internal GPS antenna that significantly reduces GPS lock time compared to the Nano G1. Additionally, the GPS module can be set to a low-power mode with the GPS physical switch.
|
||||
- Integrated enhanced message notification circuit for LED or Buzzer, configurable via physical switches.
|
||||
- Physical power switch to easily turn the device on/off.
|
||||
- Replaceable 1.3" OLED screen with a FPC connector.
|
||||
- Internal Li-Polymer Battery Charger. _(An optional 3.7V 603450 JST 1.25mm Rechargeable Li-Polymer Battery can also be installed.)_
|
||||
- Buck-boost converter to provide stable 3.3V to the system even in the event the Li-Polymer battery voltage drops to as low as 2.5V. Supply voltage stability is very important to ensure that the performance of RF circuits meets design expectations.
|
||||
- NXP PCF8563 Real Time Clock (RTC)
|
||||
- Optional I2C Extension Board (1x GROVE I2C Socket and 1x SparkFun QWIIC I2C Socket for Sensors and Keyboard)
|
||||
|
||||
### Nano G2 Ultra Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g2-ultra-X.X.X.xxxxxxx.uf2`
|
||||
- Official Purchase Links:
|
||||
- [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-nano-g2-ultra/)
|
||||
- [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-nano-g2-ultra/)
|
||||
|
||||
Further information on the Nano G2 Ultra can be found on [Unit Engineering's Wiki](https://wiki.uniteng.com/en/meshtastic/nano-g2-ultra).
|
||||
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="g1-e">
|
||||
|
||||
The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the Nano G1. It incorporates the latest RF technologies from B&Q Consulting, featuring a new internal wide-band LoRa antenna that can support frequencies ranging from 815 MHz to 940 MHz. With this new antenna, combined with an optimized wide-band LoRa RF frontend circuit, the Nano G1 Explorer is capable of working with the majority of LoRa frequency bands worldwide without the need for antenna changes. The device's design also takes into account the potential impact of the human body on its antenna performance, ensuring optimal RF performance even when carried in a pocket.
|
||||
|
||||
### Nano G1 Explorer Specifications
|
||||
|
||||
- **MCU:**
|
||||
- ESP32 WROOM (WiFi & Bluetooth)
|
||||
- Bluetooth 4.2
|
||||
- **LoRa Transceiver:**
|
||||
- Semtech SX1262
|
||||
- **Frequency Options:**
|
||||
- _US (902.0Mhz to 928.0Mhz), EU_868 (869.4Mhz to 869.65Mhz), JP (920.8Mhz to 927.8Mhz), ANZ (915.0Mhz to 928.0Mhz), RU (868.7Mhz to 869.2Mhz), KR (920.0Mhz to 923.0Mhz), TW (920.0Mhz to 925.0Mhz), IN (865.0Mhz to 867.0Mhz), NZ_865 (864.0Mhz to 868.0Mhz), TH (920.0Mhz to 925.0Mhz), UA_868 (868.0Mhz to 868.6Mhz)._
|
||||
- **Navigation Module:**
|
||||
- ATGM336H-5N-71 (Supports GPS, BDS and GLONASS)
|
||||
- **Antenna:**
|
||||
- New internal wide-band antenna with optimized wide-band LoRa RF frontend circuit.
|
||||
- **Connectors:**
|
||||
- USB-C
|
||||
|
||||
### Nano G1 Explorer Features
|
||||
|
||||
- Meshtastic pre-installed.
|
||||
- New internal GPS antenna that significantly reduces GPS lock time compared to the Nano G1. Additionally, the GPS module can be set to a low-power mode with the GPS physical switch.
|
||||
- Integrated enhanced message notification circuit for LED or Buzzer, configurable via physical switches.
|
||||
- Physical power switch to easily turn the device on/off.
|
||||
- Replaceable 1.3" OLED screen with a FPC connector.
|
||||
- Internal Li-Polymer Battery Charger. _(An optional 3.7V 603450 JST 1.25mm Rechargeable Li-Polymer Battery can also be installed.)_
|
||||
- Buck-boost converter to provide stable 3.3V to the system even in the event the Li-Polymer battery voltage drops to as low as 2.5V. Supply voltage stability is very important to ensure that the performance of RF circuits meets design expectations.
|
||||
|
||||
### Nano G1 Explorer Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g1-explorer-X.X.X.xxxxxxx.bin`
|
||||
- Official Purchase Links:
|
||||
- [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-nano-edition/)
|
||||
- [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-nano-g1-explorer/)
|
||||
|
||||
Further information on the Nano G1 can be found on [Unit Engineering's Wiki](https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer).
|
||||
|
||||
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="g1">
|
||||
|
||||
The Nano G1 is the first dedicated hardware device to be designed from scratch purely for Meshtastic by Neil Hao. It has been designed to be small and compact with the inclusion of a high quality internal PCB antenna.
|
||||
|
||||
### Nano G1 Specifications
|
||||
|
||||
- **MCU**
|
||||
- ESP32 WROOM (WiFi & Bluetooth)
|
||||
- Bluetooth 4.2
|
||||
- **LoRa Transceiver**
|
||||
- Semtech SX1276
|
||||
- Additional ultra-low noise amplifier to improve LoRa receiver sensitivity
|
||||
- **Frequency options**
|
||||
- US-915 MHz
|
||||
- **Navigation Module**
|
||||
- ATGM336H-5N-71 (Supports GPS, BDS and GLONASS)
|
||||
- **Antenna**
|
||||
- Built in 915Mhz Lora PCB Antenna (VSWR \<=1.5 @ 915 MHz)
|
||||
- **Connectors**
|
||||
- USB-C
|
||||
|
||||
### Nano G1 Features
|
||||
|
||||
- Meshtastic pre-installed
|
||||
- User button
|
||||
- 1.3 inch OLED screen
|
||||
- Buzzer
|
||||
|
||||
### Nano G1 Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g1-X.X.X.xxxxxxx.bin`
|
||||
|
||||
Further information on the Nano G1 can be found on [Unit Engineering's Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:nano).
|
||||
|
||||
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
id: heltec
|
||||
title: HELTEC® LoRa 32
|
||||
sidebar_label: HELTEC® LoRa 32
|
||||
sidebar_position: 7
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: lora
|
||||
title: LILYGO® TTGO Lora Devices
|
||||
sidebar_label: LILYGO® Lora
|
||||
sidebar_position: 3
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
id: buttons
|
||||
title: Hardware Buttons
|
||||
sidebar_label: Buttons
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import { power } from "@heroicons/react/24/solid";
|
||||
import { information_circle } from "@heroicons/react/24/solid";
|
||||
import { envelope_open } from "@heroicons/react/24/solid";
|
||||
import { map_pin } from "@heroicons/react/24/solid";
|
||||
import { bell } from "@heroicons/react/24/solid";
|
||||
|
||||
## Functionality
|
||||
|
||||
### Buttons
|
||||
|
||||
- **User/Program Button:**
|
||||
- **Single press:** Changes the information page displayed on the device's screen.
|
||||
- **Double press:** Sends an adhoc ping of the device's position to the network.
|
||||
- **Message Read Button:**
|
||||
- **Single press:** Clears the New Message LED.
|
||||
|
||||
### Switches
|
||||
|
||||
- **Power:**
|
||||
- **Toggle Up:** Turns on the device.
|
||||
- **Toggle Down:** Turns off the device.
|
||||
- **Location Pin:** Toggles GPS module into operating and lower power modes.
|
||||
- **Toggle Up:** Sets GPS to operating mode.
|
||||
- **Toggle Down:** Sets GPS to low power mode.
|
||||
- **Bell:**
|
||||
- **Toggle Up:** Selects Buzzer for Enhanced Message Notification Circuit.
|
||||
- **Toggle Down:** Selects LED for Enhanced Message Notification Circuit.
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
---
|
||||
id: nano-g1-explorer
|
||||
title: Nano G1 Explorer
|
||||
sidebar_label: Nano G1 Explorer
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the Nano G1. It incorporates the latest RF technologies from B&Q Consulting, featuring a new internal wide-band LoRa antenna that can support frequencies ranging from 815 MHz to 940 MHz. With this new antenna, combined with an optimized wide-band LoRa RF frontend circuit, the Nano G1 Explorer is capable of working with the majority of LoRa frequency bands worldwide without the need for antenna changes. The device's design also takes into account the potential impact of the human body on its antenna performance, ensuring optimal RF performance even when carried in a pocket.
|
||||
|
||||
### Specifications
|
||||
|
||||
- **MCU:**
|
||||
- ESP32 WROOM (WiFi & Bluetooth)
|
||||
- Bluetooth 4.2
|
||||
- **LoRa Transceiver:**
|
||||
- Semtech SX1262
|
||||
- **Frequency Options:**
|
||||
- _US (902.0Mhz to 928.0Mhz), EU_868 (869.4Mhz to 869.65Mhz), JP (920.8Mhz to 927.8Mhz), ANZ (915.0Mhz to 928.0Mhz), RU (868.7Mhz to 869.2Mhz), KR (920.0Mhz to 923.0Mhz), TW (920.0Mhz to 925.0Mhz), IN (865.0Mhz to 867.0Mhz), NZ_865 (864.0Mhz to 868.0Mhz), TH (920.0Mhz to 925.0Mhz), UA_868 (868.0Mhz to 868.6Mhz)._
|
||||
- **Navigation Module:**
|
||||
- ATGM336H-5N-71 (Supports GPS, BDS and GLONASS)
|
||||
- **Antenna:**
|
||||
- New internal wide-band antenna with optimized wide-band LoRa RF frontend circuit.
|
||||
- **Connectors:**
|
||||
- USB-C
|
||||
|
||||
### Features
|
||||
|
||||
- Meshtastic pre-installed.
|
||||
- New internal GPS antenna that significantly reduces GPS lock time compared to the Nano G1. Additionally, the GPS module can be set to a low-power mode with the GPS physical switch.
|
||||
- Integrated enhanced message notification circuit for LED or Buzzer, configurable via physical switches.
|
||||
- Physical power switch to easily turn the device on/off.
|
||||
- Replaceable 1.3" OLED screen with a FPC connector.
|
||||
- Internal Li-Polymer Battery Charger. _(An optional 3.7V 603450 JST 1.25mm Rechargeable Li-Polymer Battery can also be installed.)_
|
||||
- Buck-boost converter to provide stable 3.3V to the system even in the event the Li-Polymer battery voltage drops to as low as 2.5V. Supply voltage stability is very important to ensure that the performance of RF circuits meets design expectations.
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g1-explorer-X.X.X.xxxxxxx.bin`
|
||||
- Official Purchase Links:
|
||||
- [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-nano-edition/)
|
||||
- [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-nano-g1-explorer/)
|
||||
|
||||
Further information on the Nano G1 can be found on [Unit Engineering's Wiki](https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer).
|
||||
|
||||
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
id: buttons
|
||||
title: Hardware Buttons
|
||||
sidebar_label: Buttons
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Functionality
|
||||
|
||||
- **User/Program Button:**
|
||||
- **Single press:** Changes the information page displayed on the device's screen.
|
||||
- **Double press:** Sends an adhoc ping of the device's position to the network.
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
id: nano-g1
|
||||
title: Nano G1 device
|
||||
sidebar_label: Nano G1
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
The Nano G1 is the first dedicated hardware device to be designed from scratch purely for Meshtastic by Neil Hao. It has been designed to be small and compact with the inclusion of a high quality internal PCB antenna.
|
||||
|
||||
### Specifications
|
||||
|
||||
- **MCU**
|
||||
- ESP32 WROOM (WiFi & Bluetooth)
|
||||
- Bluetooth 4.2
|
||||
- **LoRa Transceiver**
|
||||
- Semtech SX1276
|
||||
- Additional ultra-low noise amplifier to improve LoRa receiver sensitivity
|
||||
- **Frequency options**
|
||||
- US-915 MHz
|
||||
- **Navigation Module**
|
||||
- ATGM336H-5N-71 (Supports GPS, BDS and GLONASS)
|
||||
- **Antenna**
|
||||
- Built in 915Mhz Lora PCB Antenna (VSWR \<=1.5 @ 915 MHz)
|
||||
- **Connectors**
|
||||
- USB-C
|
||||
|
||||
### Features
|
||||
|
||||
- Meshtastic pre-installed
|
||||
- User button
|
||||
- 1.3 inch OLED screen
|
||||
- Buzzer
|
||||
|
||||
### Resources
|
||||
|
||||
- Firmware file: `firmware-nano-g1-X.X.X.xxxxxxx.bin`
|
||||
|
||||
Further information on the Nano G1 can be found on [Unit Engineering's Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:nano).
|
||||
|
||||
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
id: raspberry-pi
|
||||
title: Raspberry Pi Pico
|
||||
sidebar_label: Raspberry Pi Pico
|
||||
sidebar_position: 9
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
import Tabs from "@theme/Tabs";
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: station-g1
|
||||
title: Station G1 device
|
||||
sidebar_label: Station G1
|
||||
sidebar_position: 4
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
The Station G1 is the second dedicated hardware device to be designed from scratch purely for Meshtastic Licensed (HAM) Operation by Neil Hao. It has been designed to be small and compact with the inclusion of 35dBm high power PA.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
id: techo
|
||||
title: LILYGO® TTGO T-Echo devices
|
||||
sidebar_label: LILYGO® T-Echo
|
||||
sidebar_position: 2
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
The T-Echo is the latest device to be release by LILYGO® supporting a low power consumption micro-controller.
|
||||
|
|
|
|||
BIN
static/img/hardware/nano_g2_ultra.jpeg
Normal file
BIN
static/img/hardware/nano_g2_ultra.jpeg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 217 KiB |
Loading…
Reference in a new issue