mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-21 03:25:51 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge branch 'master' into i18n

Browse source
This commit is contained in:
Thomas Göttgens 2023-05-11 08:20:20 +02:00 committed by GitHub
parent c421ac6716 e4119e097c
commit 198984bcf3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
27 changed files with 220 additions and 112 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/about/contributing.mdx
View file

@ -27,7 +27,7 @@ Most communication and interactions happen with protocol buffers. The [Meshtasti
### Device Firmware
The [firmware](https://github.com/meshtastic/firmware) is where all of the firmware development happens. This is where the code for the ESP32 and nRF52 based devices is developed. It is mainly C and C++ code.Think Arduino. It is where the first level of hardware interaction begins and ends.
The [firmware](https://github.com/meshtastic/firmware) is where all of the firmware development happens. This is where the code for the ESP32 and nRF52 based devices is developed. It is mainly C and C++ code. Think Arduino. It is where the first level of hardware interaction begins and ends.
### Firmware Modules

33
docs/about/overview/mesh-alg.mdx
View file

@ -19,29 +19,30 @@ need to consider the MeshPacket and Sub-packet message types.
All data is converted into LoRa symbols which are sent to the radio for transmission. The details are described elsewhere, but it is worth noting that in addition to the converted packet bytes described below, there is also a preamble sent at the start of any data packet.
This preamble allows receiving radios to synchronize clocks and start framing. We use a preamble length of 32, which is longer than the minimum preamble length of 8, to maximize the amount of time the LoRa receivers can stay asleep, which dramatically lowers power consumption.
This preamble allows receiving radios to synchronize clocks and start framing. We use a preamble length of 16, which is longer than the minimum preamble length of 8, to let SX126x LoRa receivers sleep for a while, which lowers power consumption.
After the preamble comes the LoRa Physical Header, which contains information about the packet length as well as a sync word to distinguish networks. For Meshtastic, it is set to `0x2B`.
### Layer 1: Unreliable Zero Hop Messaging
This layer is conventional non-reliable LoRa packet transmission. The transmitted packet has the following representation before encoding for transmission:
This layer is conventional non-reliable LoRa packet transmission. A packet generated by a Meshtastic device has the following representation before encoding for transmission:
| Offset | Length | Type | Usage |
| :----------: | :---------------------------: | :-----: | :--------------------------------------------------------------------------------------- |
| 0x00 | 1 byte | Integer | syncWord, always `0x2B`. |
| 0x01 | 4 bytes | Integer | Packet header: Destination. The destination's unique NodeID. `0xFFFFFFFF` for broadcast. |
| 0x05 | 4 bytes | Integer | Packet Header: Sender. The sender's unique NodeID. |
| 0x09 | 4 bytes | Integer | Packet Header: The sending node's unique packet ID for this packet. |
| 0x0D | 32 bits | Bits | Packet Header: Flags. See the [header flags](#packet-header-flags) for usage. |
| 0x11 .. 0xFD | Varies, maximum of 237 bytes. | Bytes | Actual packet data. Unused bytes are not transmitted. |
| 0xFE .. 0xFF | 2 Bytes | Bytes | Unused. |
| Offset | Length | Type | Usage |
| :----: | :--------------------------------------: | :-----: | :--------------------------------------------------------------------------------------- |
| 0x00 | 4 bytes | Integer | Packet Header: Destination. The destination's unique NodeID. `0xFFFFFFFF` for broadcast. |
| 0x04 | 4 bytes | Integer | Packet Header: Sender. The sender's unique NodeID. |
| 0x08 | 4 bytes | Integer | Packet Header: The sending node's unique packet ID for this packet. |
| 0x0C | 1 byte | Bits | Packet Header: Flags. See the [header flags](#packet-header-flags) for usage. |
| 0x0D | 1 byte | Bits | Packet Header: Channel hash. Used as hint for decryption for the receiver. |
| 0x0E | Max. 237 bytes (excl. protobuf overhead) | Bytes | Actual packet data. Unused bytes are not transmitted. |
#### Packet Header Flags
| Index | # of Bits | Usage |
| :-----: | :-------: | :----------------------------- |
| 0 | 3 | HopLimit (see note in Layer 3) |
| 3 | 1 | WantAck |
| 4 .. 32 | 28 | Currently unused |
| Index | # of Bits | Usage |
| :----: | :-------: | :----------------------------- |
| 0 | 3 | HopLimit (see note in Layer 3) |
| 3 | 1 | WantAck |
| 4 .. 7 | 4 | Currently unused |
#### Usage Details

46
docs/configuration/device-config/device.mdx
View file

@ -18,22 +18,19 @@ Sets the role of the node.
Acceptable values:
| Value | Description |
| :-------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). |
| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. |
| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. |
| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. |
| `REPEATER`[^1] | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role.[^1] |
| `TRACKER`[^1] | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority, with position broadcasting every two minutes. Smart Position Broadcast will default to off.[^1] |
[^1]: These roles are new as of the 2.0.15 alpha release. They are still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues.
| Value | Description |
| :-------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). |
| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. |
| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. |
| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. |
| `REPEATER` | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role. |
| `TRACKER` | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority. Smart Position Broadcast will default to the currently configured settings. |
| `SENSOR` | Sensor - For use with devices intended to primarily collect sensor readings. Telemetry packets sent from this device will be higher priority, broadcasting every five minutes. |
### Rebroadcast Mode
This setting defines the device's behavior for how messages are rebroadcasted. [^2]
[^2]: This setting is new as of the 2.0.16 alpha release. It is still a work in progress and as such features and functionality may not work as described and can evolve or change as development continues.
This setting defines the device's behavior for how messages are rebroadcasted.
| Value | Description |
| :-----------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
@ -65,6 +62,10 @@ This is the GPIO pin number that will be used for the PWM buzzer, if your device
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.
### Double Tap as Button Press
This option will enable a double tap, when a supported accelerometer is attached to the device, to be treated as a button press.
## Device Config Client Availability
<Tabs
@ -103,15 +104,16 @@ All device config options are available in the python CLI. Example commands are
:::
| Setting | Acceptable Values | Default |
| ------------------------------- | ------------------------------------------------------------------------- | ----------------- |
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER` | `CLIENT` |
| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` |
| device.serial_enabled | `true`, `false` | `true` |
| device.button_gpio | `0` - `34` | `0` |
| device.buzzer_gpio | `0` - `34` | `0` |
| device.node_info_broadcast_secs | `0` - `UINT MAX` | `10800` (3 hours) |
| Setting | Acceptable Values | Default |
| --------------------------------- | ----------------------------------------------------------------------------------- | ----------------- |
| device.debug_log_enabled | `true`, `false` | `false` |
| device.role | `CLIENT`, `CLIENT_MUTE`, `ROUTER`, `ROUTER_CLIENT`, `REPEATER`, `TRACKER`, `SENSOR` | `CLIENT` |
| device.rebroadcast_mode | `ALL`, `ALL_SKIP_DECODING`, `LOCAL_ONLY` | `ALL` |
| device.serial_enabled | `true`, `false` | `true` |
| device.button_gpio | `0` - `34` | `0` |
| device.buzzer_gpio | `0` - `34` | `0` |
| device.node_info_broadcast_secs | `0` - `UINT MAX` | `10800` (3 hours) |
| device.double_tap_as_button_press | `false`, `true` | `false` |
:::tip

5
docs/configuration/device-config/display.mdx
View file

@ -68,6 +68,10 @@ The display mode can be set to `NORMAL` (default), `TWOCOLOR` or `INVERTED`. The
The heading can be hard to read when 'INVERTED' or 'TWOCOLOR' display mode is used. This setting will make the heading bold, so it is easier to read.
### Wake on Tap or Motion
This option enables the ability to wake the device screen when motion, such as a tap on the device, is detected via an attached accelerometer.
## Device Config Client Availability
<Tabs
@ -117,6 +121,7 @@ All display config options are available in the python CLI. Example commands are
| display.units | `METRIC`, `IMPERIAL` | `METRIC` |
| display.displaymode | `NORMAL`, `TWOCOLOR`, `INVERTED` | `NORMAL` |
| display.heading_bold | `false`, `true` | `false` |
| display.wake_on_tap_or_motion | `false`, `true` | `false` |
:::tip

27
docs/configuration/device-config/lora.mdx
View file

@ -66,17 +66,16 @@ In most cases you should use zero here. Units are in dBm.
### Bandwidth
Bandwidth in kHz
Certain bandwidth numbers are 'special' and will be converted by the device firmware to the appropriate floating point value:
| Special Value | Interpreted as |
| :---: | :---: |
| 31 | 31.25kHz |
| 62 | 62.5kHz |
| 200 | 203.125kHz |
| 400 | 406.25kHz |
| 800 | 812.5kHz |
| 1600 | 1625.0kHz |
| Special Value | Interpreted As |
| :-----------: | :------------: |
| 31 | 31.25 kHz |
| 62 | 62.5 kHz |
| 200 | 203.125 kHz |
| 400 | 406.25 kHz |
| 800 | 812.5 kHz |
| 1600 | 1625.0 kHz |
Please be aware that values < 62.5kHz may require a TCXO on some hardware devices.
@ -112,6 +111,14 @@ For testing it is useful sometimes to force a node to never listen to particular
Setting this option to 'true' means the device will ignore the hourly duty cycle limit in Europe. This means that you might violate regulations if the device transmits too much. By default, this option is set to 'false,' which means the device will stop sending data when it reaches the hourly limit and will start again when it is allowed to do so.
### SX126x RX Boosted Gain
This is an option specific to the SX126x chip series which allows the chip to consume a small amount of additional power to increase RX sensitivity.
### Override Frequency
This parameter is for advanced users and licensed HAM radio operators. When enabled, the channel calculation will be ignored, and the set frequency will be used instead (frequency_offset still applies). This will allow you to use out-of-band frequencies. Please respect your local laws and regulations. If you are a license HAM operator, make sure you enable HAM mode and turn off encryption.
## LoRa Config Client Availability
<Tabs

2
docs/development/device/module-api.mdx
View file

@ -5,7 +5,7 @@ sidebar_label: Module API
sidebar_position: 3
---
This is a tutorial on how to write small modules which run on the device. Modules are bits of regular 'Arduino' code that can send and receive packets to other Nodes/Apps/PCs using the Meshtastic mesh.
The purpose of this tutorial is for writing new core modules that can be ran on a device. In most cases, it is best to start with utilizing the serial module rather than creating a new one. However, if you're interested in creating a new core functionality from scratch, then building a module would be appropriate.
## Key concepts

32
docs/getting-started/flashing-firmware/nrf52/drag-n-drop.mdx
View file

@ -9,12 +9,6 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import Link from "@docusaurus/Link";
:::info
Before flashing confirm that you have [RAK4631](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/) and not a [RAK4631-R](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631-R/) If this is not the case, fear not. The hardware is identical but requires changing the bootloader. Instructions on how to do this are located [here](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r).
:::
## Flash Firmware
Download and unzip the latest firmware from [Meshtastic Downloads](https://meshtastic.org/downloads).
@ -27,16 +21,6 @@ Download and unzip the latest firmware from [Meshtastic Downloads](https://mesht
Once the file has finished copying onto the drive, the device will reboot and install the Meshtastic firmware.
### Issues When Upgrading from A Previous Version of Meshtastic
:::info
Previous versions of the Meshtastic firmware may save stale data, causing devices to get stuck in a crash loop during startup. If you experience issues when upgrading your nRF52 device from a previous version of Meshtastic, you may need to perform a full factory reset of the internal flash memory.
Follow the guide to [factory erase your nRF52](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) device before continuing to [flash firmware](#flash-firmware).
:::
## Connect and Configure Device
After flashing the Meshtastic firmware to the device, you can proceed with the initial configuration.
@ -49,3 +33,19 @@ After flashing the Meshtastic firmware to the device, you can proceed with the i
Connect and Configure Device
</Link>
</div>
### Potential Flashing Edge Cases
:::info
Before flashing confirm that you have [RAK4631](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/) and not a [RAK4631-R](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631-R/) If this is not the case, fear not. The hardware is identical but requires changing the bootloader. Instructions on how to do this are located [here](/docs/getting-started/flashing-firmware/nrf52/convert-rak4631r).
:::
:::info
Previous versions of the Meshtastic firmware may save stale data, causing devices to get stuck in a crash loop during startup. If you experience issues when upgrading your nRF52 device from a previous version of Meshtastic, you may need to perform a full factory reset of the internal flash memory.
Follow the guide to [factory erase your nRF52](/docs/getting-started/flashing-firmware/nrf52/nrf52-erase) device before continuing to [flash firmware](#flash-firmware).
:::

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

@ -10,4 +10,3 @@ sidebar_position: 2
The nRF52 based devices have the easiest firmware upgrade process. No driver or software install is required on any platform.
1. The [Drag & Drop](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop) firmware installation method is considered the "manual process" and recommended as the easiest solution.
2. The [Python Flasher](/docs/software/python/flasher) application does a lot under the hood to prevent you from needing to use the terminal.

12
docs/hardware/devices/heltec/buttons.mdx
View file

@ -7,9 +7,9 @@ sidebar_position: 3
## Functionality
- **Reset Button**
- _**Single press**_ resets the device.
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Long press**_ adjusts the contrast of the screen.
- _**Triple press**_ sends a broadcast message of the device position.
- **Reset Button (bottom):**
- **Single press:** Resets the device.
- **User/Program Button (top):**
- **Long press:** Will signal the device to shutdown after 5 seconds.
- **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.

12
docs/hardware/devices/lora/buttons.mdx
View file

@ -7,9 +7,9 @@ sidebar_position: 3
## Functionality
- **Reset Button**
- _**Single press**_ resets the device.
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Long press**_ adjusts the contrast of the screen.
- _**Triple press**_ sends a broadcast message of the device position.
- **Reset Button:**
- **Single press:** Resets the device.
- **User/Program Button:**
- **Long press:** Will signal the device to shutdown after 5 seconds.
- **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.

2
docs/hardware/devices/lora/index.mdx
View file

@ -2,7 +2,7 @@
id: lora
title: LILYGO® TTGO Lora Devices
sidebar_label: LILYGO® Lora
sidebar_position: 6
sidebar_position: 3
---
import Tabs from "@theme/Tabs";

34
docs/hardware/devices/nano-g1-explorer/buttons.mdx Normal file
View file

@ -0,0 +1,34 @@
---
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.

45
docs/hardware/devices/nano-g1-explorer/index.mdx Normal file
View file

@ -0,0 +1,45 @@
---
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.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).
![Nano G1 Explorer](/img/hardware/nano_g1_explorer.jpeg)

9
docs/hardware/devices/nano-g1/buttons.mdx
View file

@ -2,12 +2,11 @@
id: buttons
title: Hardware Buttons
sidebar_label: Buttons
sidebar_position: 3
sidebar_position: 1
---
## Functionality
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Long press**_ adjusts the contrast of the screen.
- _**Triple press**_ sends a broadcast message of the device position.
- **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.

2
docs/hardware/devices/nano-g1/index.mdx
View file

@ -2,7 +2,7 @@
id: nano-g1
title: Nano G1 device
sidebar_label: Nano G1
sidebar_position: 4
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.

6
docs/hardware/devices/rak/base-boards.mdx
View file

@ -79,6 +79,8 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent
Further information on the RAK19007 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19007/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-base-board-2nd-gen-rak19007-ver-b-pid-110082)
</TabItem>
<TabItem value="RAK19003">
@ -103,6 +105,8 @@ Further information on the RAK19007 can be found on the [RAK Documentation Cente
Further information on the RAK19003 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19003/Overview/#product-description)
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-mini-base-board-rak19003-ver-b-pid-306024)
<img
alt="RAK4631 19003"
src="/img/hardware/rak4631_19003.png"
@ -135,5 +139,7 @@ Further information on the RAK19003 can be found on the [RAK Documentation Cente
Further information on the RAK19001 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19001/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-dual-io-base-board-rak19001-pid-110081)
</TabItem>
</Tabs>

28
docs/hardware/devices/rak/buttons.mdx
View file

@ -11,20 +11,20 @@ Button functionality for RAK devices greatly depends on the device specific conf
### RAK5005-O / RAK19007 / RAK19003
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Double press (nRF52 only)**_ puts the device in bootloader mode and mounts a drive to your computer.
- _**Long press**_ signals the device to shutdown.
- _**Triple press**_ sends a broadcast message of the device position.
- **Reset Button:**
- **Single press:** Resets the device.
- **Double press:** Put device into bootloader mode.
- **User/Program(if configured):**
- **Long press:** Will signal the device to shutdown after 5 seconds.
- **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.
### RAK19001
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Double press (nRF52 only)**_ puts the device in bootloader mode and mounts a drive to your computer.
- _**Long press**_ signals the device to shutdown.
- _**Triple press**_ sends a broadcast message of the device position.
- **User Button**
- _Not yet implemented by Meshtastic_
- **Reset Button:**
- **Single press:** Resets the device.
- **Double press:** Put device into bootloader mode.
- **User/Program Button (if configured):**
- **Long press:** Will signal the device to shutdown after 5 seconds.
- **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.

2
docs/hardware/devices/rak/core-modules.mdx
View file

@ -49,6 +49,8 @@ Please be aware of the difference between the RAK4631 (Arduino bootloader) and t
Further information on the RAK4631 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Overview/#product-description).
US Distributor - Purchase link: [Rokland - US915 Mhz](https://store.rokland.com/products/rak-wireless-rak4631-nordic-nrf52840-ble-core-module-for-lorawan-with-lora-sx1262)
<img
alt="RAK4631 Core Module"
src="/img/hardware/rak4631.png"

6
docs/hardware/devices/rak/peripherals.mdx
View file

@ -26,6 +26,8 @@ To add a GPS to the RAK5005-O base board, you need the [RAK1910 GPS sensor](http
Further information on the RAK1910 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1910/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak1910-wisblock-gnss-location-module)
To add a GPS to the RAK19003 base board, you need the [RAK12500 GPS sensor](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500). It is supported via I<sup>2</sup>C on slot B for firmware versions 1.49 and above.
- uBlox Zoe-M8Q GNSS receiver
@ -33,6 +35,8 @@ To add a GPS to the RAK19003 base board, you need the [RAK12500 GPS sensor](http
Further information on the RAK12500 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK12500/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak12500-gnss-gps-location-module-u-blox-zoe-m8q)
</TabItem>
<TabItem value="Buzzer">
@ -76,6 +80,8 @@ The [RAK1901 Temperature and Humidity Sensor](https://store.rakwireless.com/prod
Further information on the RAK1901 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1901/Overview/#product-description).
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-rak1901-temperature-and-humidity-sensor-sensirion-shtc3-pid-100001)
</TabItem>
<TabItem value="RAK1902">

1
docs/hardware/devices/rak/screens.mdx
View file

@ -20,6 +20,7 @@ values={[
<TabItem value="OLED">
The [RAK1921 OLED display](https://store.rakwireless.com/products/rak1921-oled-display-panel) is a 0.96 inch monochrome display.
US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-oled-display-rak1921-pid-110004)
- 0.96 inch OLED display
- Resolution 128 x 64 pixels

9
docs/hardware/devices/station-g1/buttons.mdx
View file

@ -2,12 +2,11 @@
id: buttons
title: Hardware Buttons
sidebar_label: Buttons
sidebar_position: 3
sidebar_position: 1
---
## Functionality
- **Program button**
- _**Single press**_ changes the page of information displayed on the screen.
- _**Long press**_ adjusts the contrast of the screen.
- _**Triple press**_ sends a broadcast message of the device position.
- **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.

2
docs/hardware/devices/station-g1/index.mdx
View file

@ -2,7 +2,7 @@
id: station-g1
title: Station G1 device
sidebar_label: Station G1
sidebar_position: 3
sidebar_position: 4
---
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
docs/hardware/devices/tbeam/buttons.mdx
View file

@ -11,7 +11,7 @@ sidebar_position: 3
- **Long press:** Powers the device on or off.
- **Reset Button (right):**
- **Single press:** Resets the device.
- **Program button (middle):**
- **User/Program Button (middle):**
- **Long press:** Will signal the device to shutdown after 5 seconds.
- **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.

2
docs/hardware/devices/tbeam/index.mdx
View file

@ -2,7 +2,7 @@
id: tbeam
title: LILYGO® TTGO T-Beam Devices
sidebar_label: LILYGO® T-Beam
sidebar_position: 5
sidebar_position: 2
---
import Tabs from "@theme/Tabs";

1
docs/hardware/devices/tbeam/screens.mdx
View file

@ -8,6 +8,7 @@ sidebar_position: 2
## 0.96 inch OLED I<sup>2</sup>C display
- [Purchase link](https://www.aliexpress.com/item/32922106384.html)
- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-0-96-inch-oled-white-color-text-display-module-l206-for-t-beam-and-t-sim)
![0.96 inch OLED display](/img/hardware/screen.png)

9
docs/legal/trademark.mdx
View file

@ -77,10 +77,11 @@ If you would like to make some non-software goods to give away or sell at the ev
It is permissible to use the Meshtastic Trademarks in the title and content of a publication, provided that:
- the use is clearly in reference to the Meshtastic\* the use does not imply sponsorship or endorsement of the publication by Meshtastic
- proper trademark symbols are used in connection with the Meshtastic Trademarks and the trademark attribution statement must appear as explained in Proper Trademark Use
- the Logo Usage Guidelines are strictly observed
- A copy of the use of the Meshtastic Trademarks is provided to the Trademark Supervisor within seven (7) days of its initial use, for example by sending a URL or other copy of such use
- The use is clearly in reference to Meshtastic.
- The use does not imply sponsorship or endorsement of the publication by Meshtastic.
- Proper trademark symbols are used in connection with the Meshtastic Trademarks and the trademark attribution statement must appear as explained in Proper Trademark Use.
- The Logo Usage Guidelines are strictly observed.
- A copy of the use of the Meshtastic Trademarks is provided to the Trademark Supervisor within seven (7) days of its initial use, for example by sending a URL or other copy of such use.
## Usage that Require Prior Written Approval

BIN
static/img/hardware/nano_g1_explorer.jpeg Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 96 KiB