diff --git a/docs/about/overview/mesh-alg.mdx b/docs/about/overview/mesh-alg.mdx index 2b9f9c2d..686c35f2 100644 --- a/docs/about/overview/mesh-alg.mdx +++ b/docs/about/overview/mesh-alg.mdx @@ -45,7 +45,8 @@ This layer is conventional non-reliable LoRa packet transmission. A packet gener | :----: | :-------: | :----------------------------- | | 0 | 3 | HopLimit (see note in Layer 3) | | 3 | 1 | WantAck | -| 4 .. 7 | 4 | Currently unused | +| 4 | 1 | ViaMQTT (packet came via MQTT) | +| 5 .. 7 | 3 | Currently unused | #### Usage Details diff --git a/docs/about/overview/radio-settings.mdx b/docs/about/overview/radio-settings.mdx index 7580f60f..cb238219 100644 --- a/docs/about/overview/radio-settings.mdx +++ b/docs/about/overview/radio-settings.mdx @@ -69,7 +69,7 @@ Various data-rate options are available when configuring a channel and are inver ### Presets -We have six LoRa radio presets. These are the most common settings and have been proven to work well: +We have eight LoRa radio presets. These are the most common settings and have been proven to work well: | Channel setting | Alt Channel Name | Data-Rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | | :--------------------: | :--------------: | :-----------------: | :----------: | :---------: | :-------: | :---------: | diff --git a/docs/community/software/atak.mdx b/docs/community/software/atak.mdx deleted file mode 100644 index 045a7a41..00000000 --- a/docs/community/software/atak.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -id: community-atak -title: ATAK Forwarder -sidebar_label: ATAK Forwarder -sidebar_position: 1 ---- - -:::note - -This is a community project maintained by @paulmandal. -Development can be followed on [GitHub](https://github.com/paulmandal/atak-forwarder). -Support should be sought from the respective authors. - -::: - -:::info - -The ATAK Forwarder plugin has recently been updated to support Meshtastic 2.0.6+ but is currently a pre-release version to allow for additional testing to be completed. - -- After installing you need to open the Meshtastic app and click the add device "+" so it will ask for Bluetooth permissions. - -::: - -The ATAK Forwarder plugin requires the Meshtastic Android app to be installed. - -This is a plugin for ATAK (Android Team Awareness Kit) that uses Meshtastic to provide off-grid communications. This includes plotting the position of others on the map, transmission of markers and routes, and chat messages. - -![ATAK Module](/img/atak-animation.gif) - -- A walk-through on how to [set up ATAK](https://paul-mandal.medium.com/atak-for-hikers-d96d5246193e). -- The module source is available on [GitHub](https://github.com/paulmandal/atak-forwarder), along with instructions for setting it up, and the latest [Releases](https://github.com/paulmandal/atak-forwarder/releases/). diff --git a/docs/community/software/index.mdx b/docs/community/software/index.mdx index e8e28af5..9a4865fd 100644 --- a/docs/community/software/index.mdx +++ b/docs/community/software/index.mdx @@ -9,7 +9,6 @@ The Meshtastic ecosystem is highly extensible, and a number of community project Current community projects: -- [ATAK (Android Team Awareness Kit) Forwarder](/docs/community/software/community-atak) - An ATAK plugin for forwarding CoT messages via a hardware layer which supports Meshtastic devices. - [Meshtasticator (Simulator)](/docs/community/software/community-meshtasticator) - Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software. - [Meshtastic Web API](/docs/community/software/meshtastic-web-api) - Meshtastic Web API provides a RESTful interface to interact with a Meshtastic node via a serial connection. diff --git a/docs/community/software/meshtastic-web-api.mdx b/docs/community/software/meshtastic-web-api.mdx index 32cd01d5..edea6f0d 100644 --- a/docs/community/software/meshtastic-web-api.mdx +++ b/docs/community/software/meshtastic-web-api.mdx @@ -2,7 +2,7 @@ id: meshtastic-web-api title: Meshtastic Web API sidebar_label: Meshtastic Web API -sidebar_position: 3 +sidebar_position: 2 --- :::note diff --git a/docs/community/software/meshtasticator.mdx b/docs/community/software/meshtasticator.mdx index b7ebbd69..dfa56a21 100644 --- a/docs/community/software/meshtasticator.mdx +++ b/docs/community/software/meshtasticator.mdx @@ -2,7 +2,7 @@ id: community-meshtasticator title: Meshtasticator sidebar_label: Meshtasticator (Simulator) -sidebar_position: 2 +sidebar_position: 1 --- :::note diff --git a/docs/configuration/radio/bluetooth.mdx b/docs/configuration/radio/bluetooth.mdx index 3dd0b1fc..f3a9cc57 100644 --- a/docs/configuration/radio/bluetooth.mdx +++ b/docs/configuration/radio/bluetooth.mdx @@ -36,7 +36,7 @@ The default pairing mode will be determined based on whether the device has or d ### Fixed PIN -If your pairing mode is set to `FIXED_PIN`, the default value is 123456. For all other pairing modes, this number is ignored. A custom integer (6 digits) can be set via the Bluetooth config options. +If your pairing mode is set to `FIXED_PIN`, the default value is **123456**. For all other pairing modes, this number is ignored. A custom integer (6 digits) can be set via the Bluetooth config options. ## Configure Bluetooth Config diff --git a/docs/configuration/radio/device.mdx b/docs/configuration/radio/device.mdx index 1f26b426..1e4d1750 100644 --- a/docs/configuration/radio/device.mdx +++ b/docs/configuration/radio/device.mdx @@ -28,7 +28,7 @@ Acceptable values: | `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. When used in conjunction with power.is_power_saving = true, nodes will wake up, send environment telemetry, and then sleep for telemetry.environment_update_interval seconds. | | `TAK` | TAK - Used for nodes dedicated for connection to an ATAK EUD. Turns off many of the routine broadcasts to favor CoT packet stream from the Meshtastic ATAK plugin -> IMeshService -> Node. | | `CLIENT_HIDDEN` | Client Hidden - Used for nodes that "only speak when spoken to." Turns off all of the routine broadcasts but allows for ad-hoc communication. Still rebroadcasts, but with local only rebroadcast mode (known meshes only). Can be used for clandestine operation or to dramatically reduce airtime / power consumption | -| `LOST_AND_FOUND` | Lost and Found - Used to automatically send a text message to the mesh with the current position of the device on a frequent interval: "I'm lost! Position: lat / long" | +| `LOST_AND_FOUND` | Lost and Found - Used to automatically send a text message with current position at frequent intervals to the primary channel for the device: "I'm lost! Position: lat / long" | ### Rebroadcast Mode diff --git a/docs/configuration/radio/lora.mdx b/docs/configuration/radio/lora.mdx index a204b9ca..071fb7f0 100644 --- a/docs/configuration/radio/lora.mdx +++ b/docs/configuration/radio/lora.mdx @@ -8,7 +8,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import LoRaRegions from "../../blocks/_lora-regions.mdx"; -The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Channel Number, Ignore Incoming Array, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a `Config.LoRa` protobuf. +The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Enabled, Channel Number, Ignore Incoming Array, Ignore MQTT, Override Duty Cycle Limit, SX126x RX Boosted Gain, and Override Frequency. LoRa config uses an admin message sending a `Config.LoRa` protobuf. :::note In order to communicate fully, devices within a mesh must have identical settings for Region and Modem Preset, or identical custom Modem settings. @@ -112,6 +112,10 @@ LoRa Channel Configuration should not to be confused with messaging [Channel Con For testing it is useful sometimes to force a node to never listen to particular other nodes (simulating radio out of range). All nodenums listed in the ignore_incoming array will have packets they send dropped on receive (by router.cpp) +### Ignore MQTT + +Setting this to option to 'true' means the device will ignore any messages it receives via LoRa that came via MQTT somewhere along the path towards the device. Note this only works when your device and the MQTT node are running at least firmware version 2.2.19. + ### Override Duty Cycle Limit 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. @@ -175,6 +179,7 @@ LoRa config commands are available in the python CLI. Example commands are below | lora.tx_power | `0` to `30` | `0` | | lora.tx_enabled | `false`, `true` | `true` | | lora.channel_num | `0`, `1` to `NUM_CHANNELS` | `0` | +| lora.ignore_mqtt | `false`, `true` | `false` | | lora.override_duty_cycle | `false`, `true` | `false` | | lora.sx126x_rx_boosted_gain | `false`, `true` | `false` | | lora.override_frequency | Any supported frequency the LoRA radio is capable of. Please respect local rules and regulations | `0` | diff --git a/docs/hardware/devices/heltec/buttons.mdx b/docs/hardware/devices/heltec/buttons.mdx index 63c81562..1e4ff0c4 100644 --- a/docs/hardware/devices/heltec/buttons.mdx +++ b/docs/hardware/devices/heltec/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: Heltec LoRa 32 Hardware Buttons sidebar_label: Buttons sidebar_position: 1 --- diff --git a/docs/hardware/devices/heltec/enclosures.mdx b/docs/hardware/devices/heltec/enclosures.mdx index 967e748f..65933641 100644 --- a/docs/hardware/devices/heltec/enclosures.mdx +++ b/docs/hardware/devices/heltec/enclosures.mdx @@ -1,6 +1,6 @@ --- id: enclosures -title: Enclosures +title: Heltec LoRa 32 Enclosures sidebar_label: Enclosures sidebar_position: 2 --- diff --git a/docs/hardware/devices/heltec/index.mdx b/docs/hardware/devices/heltec/index.mdx index 11698fca..6c9a0026 100644 --- a/docs/hardware/devices/heltec/index.mdx +++ b/docs/hardware/devices/heltec/index.mdx @@ -21,6 +21,8 @@ values={[ ]}> +## HELTEC v2.1 + :::warning Not recommended because of design issues! Support is being phased out. Use V3 in new projects. ::: @@ -38,19 +40,22 @@ Not recommended because of design issues! Support is being phased out. Use V3 in - Antenna: - U.FL/IPEX antenna connector for LoRa -## Features +### Features - Built in 0.96 inch OLED display - User and Reset Buttons - No GPS -## Resources +### Resources - Firmware file: `firmware-heltec-v2.1-X.X.X.xxxxxxx.bin` + +## HELTEC v3 + :::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. ::: @@ -70,7 +75,7 @@ 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 -## Features +### Features - Built in 0.96 inch OLED display - User and Reset Buttons @@ -82,15 +87,19 @@ This device may have issues charging a connected battery if utilizing a USB-C to Image Source: [Heltec]() -## Resources +### Resources - Firmware file: `firmware-heltec-v3-X.X.X.xxxxxxx.bin` -- Purchase link: [Heltec](https://heltec.org/project/wifi-lora-32-v3/) -- Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805256690400.html) +- Purchase links + - [Heltec](https://heltec.org/project/wifi-lora-32-v3/) + - [AliExpress](https://www.aliexpress.us/item/3256805256690400.html) + +## HELTEC Wireless Stick Lite V3 + :::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. ::: @@ -110,7 +119,7 @@ This device may have issues charging a connected battery if utilizing a USB-C to - Dedicated 2.4 GHz stamped metal antenna for WiFi/Bluetooth - U.FL/IPEX antenna connector for LoRa (next to the V3 icon) -## Features +### Features - No display. - User and Reset Buttons @@ -128,14 +137,19 @@ This device may have issues charging a connected battery if utilizing a USB-C to Image Source: [Heltec](https://resource.heltec.cn/download/Wireless_Stick_Lite_V3/HTIT-WSL_V3.png) -## Resources +### Resources - Firmware file: `firmware-heltec-wsl-v3-X.X.X.xxxxxxx.bin` -- Purchase link: [Heltec](https://heltec.org/project/wireless-stick-lite-v2/) -- Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805256996507.html) +- Purchase Links: + - International + - [Heltec](https://heltec.org/project/wireless-stick-lite-v2/) + - [AliExpress](https://www.aliexpress.us/item/3256805256996507.html) - + + + +## HELTEC Tracker :::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. @@ -155,12 +169,12 @@ 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 and GNSS -## Features +### Features - Onboard 0.96-inch LCD display - User and Reset Buttons -## Flashing the Wireless Tracker +### Flashing If you are having issues flashing the wireless tracker, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so. @@ -179,21 +193,26 @@ The following process will manually place the device into the Espressif Firmware With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "Heltec Wireless Tracker" from the device drop-down. -## Pin Map +### Pin Map ![HT-Tracker_V1 Pin Map](/img/hardware/HT-Tracker_V1_Pin_Map.png) Image Source: [Heltec](https://heltec.org/project/wireless-tracker/) -## Resources +### Resources - Firmware file: `firmware-heltec-wireless-tracker-X.X.X.xxxxxxx.bin` -- Purchase link: [Heltec](https://heltec.org/project/wireless-tracker/) -- Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805495189423.html) +- Purchase Links: + - International + - [Heltec](https://heltec.org/project/wireless-tracker/) + - [AliExpress](https://www.aliexpress.us/item/3256805495189423.html) + +## HELTEC Paper + :::caution Currently the display is only supported in devices labeled v1.1. @@ -217,17 +236,19 @@ This device may have issues charging a connected battery if utilizing a USB-C to - U.FL/IPEX antenna connector for LoRa - Integrated 2.4 GHz PCB antenna -## Features +### Features - Onboard 2.13-inch black and white E-Ink display screen - User and Reset switches - No GPS -## Resources +### Resources - Firmware file: `firmware-heltec-wireless-paper-X.X.X.xxxxxxx.bin` -- Purchase link: [Heltec](https://heltec.org/project/wireless-paper/) -- Purchase link: [AliExpress](https://www.aliexpress.us/item/3256805461611876.html) +- Purchase Links: + - International + - [Heltec](https://heltec.org/project/wireless-paper/) + - [AliExpress](https://www.aliexpress.us/item/3256805461611876.html) diff --git a/docs/hardware/devices/lora/buttons.mdx b/docs/hardware/devices/lora/buttons.mdx index a331a225..5d23852f 100644 --- a/docs/hardware/devices/lora/buttons.mdx +++ b/docs/hardware/devices/lora/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: LILYGO® TTGO Lora Hardware Buttons sidebar_label: Buttons sidebar_position: 3 --- diff --git a/docs/hardware/devices/lora/enclosures.mdx b/docs/hardware/devices/lora/enclosures.mdx index f0405d8a..d8f6c5f9 100644 --- a/docs/hardware/devices/lora/enclosures.mdx +++ b/docs/hardware/devices/lora/enclosures.mdx @@ -1,6 +1,6 @@ --- id: enclosures -title: Enclosures +title: LILYGO® TTGO Lora Enclosures sidebar_label: Enclosures sidebar_position: 3 --- diff --git a/docs/hardware/devices/lora/gpio.mdx b/docs/hardware/devices/lora/gpio.mdx index 9a4ae8d9..0f74728c 100644 --- a/docs/hardware/devices/lora/gpio.mdx +++ b/docs/hardware/devices/lora/gpio.mdx @@ -1,6 +1,6 @@ --- id: gpio -title: GPIO +title: LILYGO® TTGO Lora GPIO sidebar_label: GPIO sidebar_position: 4 --- diff --git a/docs/hardware/devices/lora/index.mdx b/docs/hardware/devices/lora/index.mdx index 6d68c069..d9bdf759 100644 --- a/docs/hardware/devices/lora/index.mdx +++ b/docs/hardware/devices/lora/index.mdx @@ -24,6 +24,7 @@ values={[ ]}> +## Lora v1 :::warning Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. ::: @@ -43,21 +44,27 @@ This board is still in production but for various reasons not recommended for ne - Micro USB - Antenna: U.FL antenna connector -## Features +### Features - Built in 0.96 inch OLED display -## Resources +### Resources - Firmware file: `firmware-tlora-v1-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/32996759721.html) -- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v1-0-wireless-module-esp32-lora-915mhz-oled-0-96-inch-display-wifi-bluetooth-esp-32-antenna-ch9102-q184?ref=8Bb2mUO5i-jKwt) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v1-0-wireless-module-esp32-lora-915mhz-oled-0-96-inch-display-wifi-bluetooth-esp-32-antenna-ch9102-q184?ref=8Bb2mUO5i-jKwt) + - International + - [AliExpress](https://www.aliexpress.com/item/32996759721.html) ![LILYGO® TTGO Lora V1](/img/hardware/lora-v1.png) + +## Lora v1.3 + :::warning Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. ::: @@ -77,14 +84,16 @@ This board is still in production but for various reasons not recommended for ne - Micro USB - Antenna: U.FL antenna connector -## Features +### Features - Built in 0.96 inch OLED display -## Resources +### Resources - Firmware file: `firmware-tlora_v1_3-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/4000628100802.html) +- Purchase Links: + - International + - [AliExpress](https://www.aliexpress.com/item/4000628100802.html) ![LILYGO® TTGO Lora V1.3](/img/hardware/lora-v1.3.png) ![LILYGO® TTGO Lora V1.3 pin map](/img/hardware/lora-v1.3_pinmap.webp) @@ -92,6 +101,8 @@ This board is still in production but for various reasons not recommended for ne +## Lora V2.0 + :::warning Not recommended with a battery! These boards contain the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. ::: @@ -112,23 +123,27 @@ This board is still in production but for various reasons not recommended for ne - Micro USB - Antenna: U.FL antenna connector -## Features +### Features - Built in 0.96 inch OLED display - Power and Reset switches - microSD connector - No GPS -## Resources +### Resources - Firmware file: `firmware-tlora-v2-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/32846302183.html) +- Purchase Links: + - International + - [AliExpress](https://www.aliexpress.com/item/32846302183.html) ![LILYGO® TTGO Lora V2](/img/hardware/lora-v2.0.png) +## Lora v2.1-1.6 + :::caution Early versions of some of these boards contained the wrong component in the LiPo battery charging circuit allowing the battery to be overcharged. Boards purchased after 2021 should be ok. ::: @@ -145,24 +160,28 @@ Early versions of some of these boards contained the wrong component in the LiPo - Micro USB - Antenna: SMA antenna connector -## Variations of identifying marks +### Variations of identifying marks - FCC ID: 2ASYE-T3-V1-6-1 - "T3_v1.6.1 20210104" on the board - "Model T3 V1.6.1" on the FCC sticker -## Features +### Features - Built in 0.96 inch OLED display - Power and Reset switches - microSD connector - No GPS -## Resources +### Resources - Firmware file: `firmware-tlora-v2-1-1.6-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/32915894264.html) -- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v2-1_1-6-version-915mhz-esp32-lora-oled-0-96-inch-sd-card-bluetooth-wifi-wireless-module-esp-32-sma-q211?ref=8Bb2mUO5i-jKwt) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-ttgo-lora32-v2-1_1-6-version-915mhz-esp32-lora-oled-0-96-inch-sd-card-bluetooth-wifi-wireless-module-esp-32-sma-q211?ref=8Bb2mUO5i-jKwt) + - International + - [AliExpress](https://www.aliexpress.com/item/32915894264.html) + - [Lilygo](https://www.lilygo.cc/products/lora3) ![TTGO Lora V2.1-1.6](/img/hardware/lora-v2.1-1.6.png) @@ -170,6 +189,8 @@ Early versions of some of these boards contained the wrong component in the LiPo +## Lora v2.1-1.8 + - **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** @@ -180,14 +201,14 @@ Early versions of some of these boards contained the wrong component in the LiPo - USB-C - Antenna: SMA antenna connector -## Features +### Features - Built in 0.96 inch OLED display - Power and Reset switches - microSD connector - No GPS -## Resources +### Resources - Firmware file: `firmware-tlora-v2-1-1.8-X.X.X.xxxxxxx.bin` @@ -197,6 +218,8 @@ Early versions of some of these boards contained the wrong component in the LiPo +## Lora T3S3 v1.0 + - **MCU** - ESP32-S3 (WiFi & Bluetooth) - **LoRa Transceiver** @@ -211,14 +234,14 @@ Early versions of some of these boards contained the wrong component in the LiPo - USB-C - Antenna: SMA antenna connector -## Features +### Features - Built in 0.96 inch OLED display - Power and Reset switches, Boot / User Button - microSD connector - No GPS -## Flashing the T3S3 +### Flashing the T3S3 :::warning @@ -242,10 +265,16 @@ If after successfully flashing the device and the screen remains black, you may ::: -## Resources +### Resources - Firmware file: `firmware-tlora-t3s3-v1.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/1005004627139838.html) +- Purchase Links: + - US + - [Amazon](https://www.amazon.com/LILYGO-ESP32-S3-Development-Wireless-Display/dp/B0BW5W9QXZ) + - International + - [AliExpress](https://www.aliexpress.com/item/1005004627139838.html) + - [Lilygo](https://www.lilygo.cc/products/t3s3-v1-0) + - [Tindie](https://www.tindie.com/products/lilygo/lilygo-t3-s3-v10-esp32-s3-lora-sx1280-24g/) ![TTGO Lora T3S3 V1](/img/hardware/lora-t3s3.jpg) diff --git a/docs/hardware/devices/nano/buttons.mdx b/docs/hardware/devices/nano/buttons.mdx index 386a234c..b46d7018 100644 --- a/docs/hardware/devices/nano/buttons.mdx +++ b/docs/hardware/devices/nano/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: Nano Series Hardware Buttons sidebar_label: Buttons sidebar_position: 1 --- diff --git a/docs/hardware/devices/nano/index.mdx b/docs/hardware/devices/nano/index.mdx index 4a2622f1..e6fd19c3 100644 --- a/docs/hardware/devices/nano/index.mdx +++ b/docs/hardware/devices/nano/index.mdx @@ -24,9 +24,11 @@ values={[ +## Nano G2 Ultra + 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 +### Specifications - **MCU:** - NRF52840 @@ -42,7 +44,7 @@ The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circ - **Connectors:** - USB-C -### Nano G2 Ultra Features +### 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. @@ -54,23 +56,26 @@ The Nano G2 Ultra and Nano G1 Explorer have exactly the same Lora front-end circ - 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 +### 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). +- [Unit Engineering's Official Wiki](https://wiki.uniteng.com/en/meshtastic/nano-g2-ultra) +- Purchase Links: + - International + - [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/) ![Nano G2 Ultra](/img/hardware/nano_g2_ultra.jpeg) - + + + +## Nano G1 Explorer 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 +### Specifications - **MCU:** - ESP32 WROOM (WiFi & Bluetooth) @@ -86,7 +91,7 @@ The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the N - **Connectors:** - USB-C -### Nano G1 Explorer Features +### 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. @@ -96,23 +101,26 @@ The Nano G1 Explorer, powered by Meshtastic, is a significant upgrade from the N - 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 +### 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). +- [Unit Engineering's Official Wiki](https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer) +- Purchase Links: + - International + - [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/) ![Nano G1 Explorer](/img/hardware/nano_g1_explorer.jpeg) + +## Nano 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 +### Specifications - **MCU** - ESP32 WROOM (WiFi & Bluetooth) @@ -129,18 +137,17 @@ The Nano G1 is the first dedicated hardware device to be designed from scratch p - **Connectors** - USB-C -### Nano G1 Features +### Features - Meshtastic pre-installed - User button - 1.3 inch OLED screen - Buzzer -### Nano G1 Resources +### 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). +- [Unit Engineering's Official Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:nano) ![Nano G1](/img/hardware/nano-g1-front.jpg) diff --git a/docs/hardware/devices/rak/base-boards.mdx b/docs/hardware/devices/rak/base-boards.mdx index 07fb992f..24d93b9e 100644 --- a/docs/hardware/devices/rak/base-boards.mdx +++ b/docs/hardware/devices/rak/base-boards.mdx @@ -8,7 +8,7 @@ sidebar_position: 1 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -## WisBlock Base +Operation requires both a base board and a [core module](/docs/hardware/devices/rak/core-module). -### RAK5005-O +## RAK5005-O :::caution The RAK5005-O is no longer in production. It is recommended to use the RAK19007 instead. @@ -60,7 +60,7 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent -### RAK19007 +## RAK19007 - [RAK19007](https://store.rakwireless.com/products/rak19007-wisblock-base-board-2nd-gen) - WisBlock Base Board (2nd Generation, an upgrade to the RAK5005-O) - **Slots** @@ -80,13 +80,19 @@ 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) +### Resources +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-base-board-2nd-gen-rak19007-ver-b-pid-110082) + - International + - [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441632284870) + - [RAK Wireless Starter Kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) -### RAK19003 +## RAK19003 - [RAK19003](https://store.rakwireless.com/products/wisblock-base-board-rak19003) - WisBlock's Mini Base Board. - **Slots** @@ -100,13 +106,18 @@ US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak - Connector for 3.7v LiPo battery (with charge controller) - Connector for 5v solar panel (max 5.5v) - I2C, UART and BOOT headers accessible with solder contacts - - USB Type-C port for debugging and power + - USB-C port for debugging and power - **Screen Support** - OLED screen support (OLED screen sold separately) 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) +### Resources +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-mini-base-board-rak19003-ver-b-pid-306024) + - International + - [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441632252102) RAK4631 19003 -### RAK19001 +## RAK19001 - [RAK19001](https://store.rakwireless.com/products/rak19001-wisblock-dual-io-base-board) - WisBlock's Dual IO Base Board. - **Slots** @@ -140,7 +151,13 @@ US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak 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) +### Resources +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-dual-io-base-board-rak19001-pid-110081) + - International + - [RAK Wireless](https://store.rakwireless.com/products/wisblock-base?variant=42441631924422) + diff --git a/docs/hardware/devices/rak/buttons.mdx b/docs/hardware/devices/rak/buttons.mdx index fbf7aa41..0426bec0 100644 --- a/docs/hardware/devices/rak/buttons.mdx +++ b/docs/hardware/devices/rak/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: RAK WisBlock Hardware Buttons sidebar_label: Buttons sidebar_position: 3 --- diff --git a/docs/hardware/devices/rak/core-modules.mdx b/docs/hardware/devices/rak/core-modules.mdx index 0d2facca..c5fcb094 100644 --- a/docs/hardware/devices/rak/core-modules.mdx +++ b/docs/hardware/devices/rak/core-modules.mdx @@ -8,8 +8,6 @@ sidebar_position: 2 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -## WisBlock Core - diff --git a/docs/hardware/devices/rak/enclosures/harbor_breeze_solar_enclosure.mdx b/docs/hardware/devices/rak/enclosures/harbor-breeze-solar-enclosure.mdx similarity index 96% rename from docs/hardware/devices/rak/enclosures/harbor_breeze_solar_enclosure.mdx rename to docs/hardware/devices/rak/enclosures/harbor-breeze-solar-enclosure.mdx index d086b5f4..45414b78 100644 --- a/docs/hardware/devices/rak/enclosures/harbor_breeze_solar_enclosure.mdx +++ b/docs/hardware/devices/rak/enclosures/harbor-breeze-solar-enclosure.mdx @@ -1,6 +1,6 @@ --- -id: harbor_breeze_solar -title: Harbor Breeze Solar Light Enclosure Hack +id: harbor-breeze-solar-hack +title: RAK WisBlock Harbor Breeze Solar Light Enclosure Hack sidebar_label: Solar Light Enclosure Hack sidebar_position: 1 --- @@ -49,4 +49,4 @@ Here is a Lowes.com link to the solar light : (https://www.lowes.com/pd/60LM-Sol Here is a link to the Meshtastic Starter kit : (https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) -Here is an amazon link to the sma and antennas (https://www.amazon.com/DIYmalls-915MHz) \ No newline at end of file +Here is an amazon link to the sma and antennas (https://www.amazon.com/DIYmalls-915MHz) diff --git a/docs/hardware/devices/rak/enclosures/index.mdx b/docs/hardware/devices/rak/enclosures/index.mdx index 338bc90f..cc02e631 100644 --- a/docs/hardware/devices/rak/enclosures/index.mdx +++ b/docs/hardware/devices/rak/enclosures/index.mdx @@ -1,6 +1,6 @@ --- id: enclosures -title: Enclosures +title: RAK WisBlock Enclosures sidebar_label: Enclosures sidebar_position: 3 --- @@ -41,7 +41,7 @@ Download from [Printables](https://www.printables.com/model/286664-rak19003-micr ## Created by tavdog/Tavis Gustafson -### [Harbor Breeze Meshtastic Hack](./harbor_breeze_solar_enclosure.mdx) +### [Harbor Breeze Meshtastic Hack](./harbor-breeze-solar-enclosure.mdx) ![Harbor Breeze Solar LED Meshtastic Hack Complete](/img/enclosures/hbmh_complete.png) diff --git a/docs/hardware/devices/rak/index.mdx b/docs/hardware/devices/rak/index.mdx index 27a99064..3f3ad0ff 100644 --- a/docs/hardware/devices/rak/index.mdx +++ b/docs/hardware/devices/rak/index.mdx @@ -8,8 +8,6 @@ sidebar_position: 1 import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; - - The RAK WisBlock is a modular hardware system that can be used to build Meshtastic devices. RAK Wireless currently sells a [Meshtastic Starter kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) that has the minimum you need to get started. @@ -23,5 +21,7 @@ Please see the RAK documentation for the correct way to connect your hardware to ## Resources - RAK's Wisblock [Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock) -- [American Distributor - Rokland - Purchase Link](https://store.rokland.com/products/rak-wireless-wisblock-meshtastic-starter-kit?ref=8Bb2mUO5i-jKwt) - RAK's [GitHub Page](https://github.com/RAKWireless/WisBlock) for the WisBlock +- Purchase links + - See purchase links under specific base boards, core modules, and peripherals + - US Distributor [RAK Wireless Starter Kit](https://store.rakwireless.com/products/wisblock-meshtastic-starter-kit) diff --git a/docs/hardware/devices/rak/peripherals.mdx b/docs/hardware/devices/rak/peripherals.mdx index 8266ef05..f700f72d 100644 --- a/docs/hardware/devices/rak/peripherals.mdx +++ b/docs/hardware/devices/rak/peripherals.mdx @@ -1,6 +1,6 @@ --- id: peripherals -title: Supported Peripherals +title: RAK WisBlock Supported Peripherals sidebar_label: Peripherals sidebar_position: 3 --- @@ -20,34 +20,52 @@ values={[ ]}> +## GPS Modules + +### RAK5005-0 / RAK1910 + To add a GPS to the RAK5005-O base board, you need the [RAK1910 GPS sensor](https://store.rakwireless.com/collections/wisblock-sensor/products/rak1910-max-7q-gnss-location-sensor). It is supported on slot A of the 5005 board via UART. - uBlox MAX-7Q GPS module - GPS and GLONASS satellite support -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) +### RAK19003 / RAK12500 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 I2C on slot B for firmware versions 1.49 and above. - uBlox Zoe-M8Q GNSS receiver - GPS, GLONASS, QZSS and BeiDou satellite support -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) +### Resources +- RAK Documentation Center + - [RAK12500](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK12500/Overview/#product-description) + - [RAK1910](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1910/Overview/#product-description) +- Purchase Links: + - US + - [Rokland RAK1910](https://store.rokland.com/products/rak-wireless-rak1910-wisblock-gnss-location-module) + - [Rokland RAK12500](https://store.rokland.com/products/rak-wireless-rak12500-gnss-gps-location-module-u-blox-zoe-m8q) + - International + - [RAK Wireless RAK1910](https://store.rakwireless.com/products/rak1910-max-7q-gnss-location-sensor) + - [RAK Wireless RAK12500](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500) +## Buzzer + The [RAK18001 Buzzer Module](https://store.rakwireless.com/products/wisblock-buzzer-module-rak18001) is currently being tested for integration with the External Notifications plugin. There is currently a known conflict with buzzer if the module is placed in Slot D, although other slots should work. -Further information on the RAK18001 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK18001/Overview/#product-description). +### Resources +- [RAK Documentation Center RAK18001](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK18001/Overview/#product-description) +- Purchase Links: + - International + - [RAK Wireless](https://store.rakwireless.com/products/wisblock-buzzer-module-rak18001) +## IO Module + The [RAK13002 IO Module](https://store.rakwireless.com/collections/wisblock-interface/products/adapter-module-rak13002) can be used to, among other things, add a user button to the RAK base boards (excluding the RAK19003 Mini base board). It features a number of different interface options: - 2x I2C interfaces @@ -57,22 +75,22 @@ The [RAK13002 IO Module](https://store.rakwireless.com/collections/wisblock-inte - 2x ADC interfaces - 3.3v Power rails -There is development activity in progress to get sensors such as this added to the Meshtastic Core. -Further information on the RAK13002 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK13002/Overview). +There is development activity in progress to get sensors such as this added to the Meshtastic Core. + +### Resources +- [RAK Documentation Center RAK13002](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK13002/Overview) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-rak13002-wisblock-io-adapter-module) + - International + - [RAK Wireless](https://store.rakwireless.com/collections/wisblock-interface/products/adapter-module-rak13002) - - +## Environmental Sensors + +### RAK1901 Temperature and Humidity Sensor The [RAK1901 Temperature and Humidity Sensor](https://store.rakwireless.com/products/rak1901-shtc3-temperature-humidity-sensor) is based on the Sensirion SHTC3 module and has the following features: @@ -80,13 +98,7 @@ The [RAK1901 Temperature and Humidity Sensor](https://store.rakwireless.com/prod - Humidity measurement (Range 0% to 100%) - Lower power consumption -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) - - - - +### RAK-1902 Barometric Pressure Sensor The [RAK1902 Barometric Pressure Sensor](https://store.rakwireless.com/products/rak1902-kps22hb-barometric-pressure-sensor) is based on the STMicroelectronics LPS22HB module and has the following features: @@ -94,11 +106,7 @@ The [RAK1902 Barometric Pressure Sensor](https://store.rakwireless.com/products/ - Low power consumption of 3uA - Small form factor -Further information on the RAK1902 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1902/Overview/#product-description). - - - - +### RAK1906 Environment Sensor The [RAK1906 Environment Sensor](https://store.rakwireless.com/products/rak1906-bme680-environment-sensor) is based on the Bosch BME680 module and has the following features: @@ -107,11 +115,20 @@ The [RAK1906 Environment Sensor](https://store.rakwireless.com/products/rak1906- - Barometer measurement (Range 300 to 1100 hPa) - Air Quality measurement -Further information on the RAK1906 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1906/Overview/#product-description). - - - - +#### Resources +- RAK Documentation Center + - [RAK1901](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1901/Overview/#product-description) + - [RAK1902](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1902/Overview/#product-description) + - [RAK1906](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1906/Overview/#product-description) +- Purchase Links: + - US + - [Rokland RAK1901](https://store.rokland.com/products/rak-wireless-rak1901-temperature-and-humidity-sensor-sensirion-shtc3-pid-100001) + - [Rokland RAK1902](https://store.rokland.com/products/rak-wireless-rak1902-barometric-pressure-sensor-stmicroelectronics-lps22hb-100010-2-pack) + - [Rokland RAK1906](https://store.rokland.com/products/rak-wireless-rak1906-wisblock-environment-sensor-bosch-bme680) + - International + - [RAK Wireless RAK1901](https://store.rakwireless.com/products/rak1901-shtc3-temperature-humidity-sensor) + - [RAK Wireless RAK1902](https://store.rakwireless.com/products/rak1902-kps22hb-barometric-pressure-sensor) + - [RAK Wireless RAK1906](https://store.rakwireless.com/products/rak1906-bme680-environment-sensor) diff --git a/docs/hardware/devices/rak/screens.mdx b/docs/hardware/devices/rak/screens.mdx index 42958442..32d83016 100644 --- a/docs/hardware/devices/rak/screens.mdx +++ b/docs/hardware/devices/rak/screens.mdx @@ -1,6 +1,6 @@ --- id: screens -title: Screens +title: RAK WisBlock Screens sidebar_label: Screens sidebar_position: 2 --- @@ -20,23 +20,33 @@ values={[ ]}> +## RAK1921 OLED Display + 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 - I2C interface -This item requires soldering. -Further information on the RAK1921 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1921/Overview/#product-description). +This item requires soldering. Similar modules are widely available from other suppliers, but do check the boards as some have the VDD and GND pins swapped round. This will prevent directly soldering the display to the baseboard. The preferred order is VDD, GND, SCL, SDA. If pin ordering on the OLED board are swapped, there are some tricks to allow either reconfiguring the pins of the OLED via soldered jumpers, or by carefully soldering wire for those pins that are out-of-sequence. The final option is to use longer wires between the board and display, which permits re-ordering the wires as required. +### Resources +- [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK1921/Overview/#product-description) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-oled-display-rak1921-pid-110004) + - International + - [RAK Wireless](https://store.rakwireless.com/products/rak1921-oled-display-panel) + [0.96 inch OLED display](/img/hardware/screen.png) +## RAK1400 E-Ink Display + The [RAK1400 EPD module](https://store.rakwireless.com/products/wisblock-epd-module-rak14000) is an ultra low power E-Ink display with three user buttons. - 2.13 inch black and white E-Ink display @@ -44,8 +54,17 @@ The [RAK1400 EPD module](https://store.rakwireless.com/products/wisblock-epd-mod - Resolution 212 x 104 pixels - Occupies the IO Port of a Wisblock Base -- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-epd-module-rak14000-pid-110024) +Please note only the white-black display is supported at this time, the white-black-red display may work, but is not supported. + + +### Resources - Firmware for 5005 with RAK14000 e-paper: [`firmware-rak4631_eink-X.X.X.xxxxxxx.uf2`](/downloads) +- [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK14000/Overview/#product-description) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/rak-wireless-wisblock-epd-module-rak14000-pid-110024) + - International + - [RAK Wireless](https://store.rakwireless.com/products/wisblock-epd-module-rak14000) RAK4631 5005 14000 -Please note only the white-black display is supported at this time, the white-black-red display may work, but is not supported. -Further information on the RAK14000 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK14000/Overview/#product-description). - diff --git a/docs/hardware/devices/raspberry-pi/index.mdx b/docs/hardware/devices/raspberry-pi/index.mdx index 5e76d4f3..14d74174 100644 --- a/docs/hardware/devices/raspberry-pi/index.mdx +++ b/docs/hardware/devices/raspberry-pi/index.mdx @@ -15,7 +15,7 @@ The Raspberry Pi Pico series is a range of tiny, fast, and versatile boards buil Only the Pico W has WiFi/BLE capabilities. Meshtastic supports WiFi on the Pico W (although no web server and HTTP API), but does not currently support BLE. ::: -### Pico +## Specifications - **MCU:** - Raspberry Pi RP2040 @@ -46,8 +46,8 @@ LoRa transmissions may interfere with the USB connection. It is recommended to p ::: -### Pico Resources +### Resources - Firmware file:`firmware-pico-X.X.X.xxxxxxx.uf2` -- for Pico W use: `firmware-picow-X.X.X.xxxxxxx.uf2` + - for Pico W use: `firmware-picow-X.X.X.xxxxxxx.uf2` - [Offical Website for the Raspberry Pi Pico](https://www.raspberrypi.com/products/raspberry-pi-pico/), including official reseller links. diff --git a/docs/hardware/devices/raspberry-pi/peripherals.mdx b/docs/hardware/devices/raspberry-pi/peripherals.mdx index bb82aeeb..34604d5c 100644 --- a/docs/hardware/devices/raspberry-pi/peripherals.mdx +++ b/docs/hardware/devices/raspberry-pi/peripherals.mdx @@ -1,6 +1,6 @@ --- id: peripherals -title: Supported Peripherals +title: Raspberry Pi Pico Supported Peripherals sidebar_label: Peripherals sidebar_position: 1 --- @@ -11,4 +11,4 @@ I2C peripherals like OLED Displays (e.g. SSD1306 or SH1106) and keybo ## External device using Serial Module -For connecting an external device via the [Serial Module](/docs/configuration/module/serial), it's recommended to use GPIO pins 8 (`serial.txd`) and 9 (`serial.rxd`). \ No newline at end of file +For connecting an external device via the [Serial Module](/docs/configuration/module/serial), it's recommended to use GPIO pins 8 (`serial.txd`) and 9 (`serial.rxd`). diff --git a/docs/hardware/devices/station-g1/buttons.mdx b/docs/hardware/devices/station-g1/buttons.mdx index 010425b0..fdb0f39f 100644 --- a/docs/hardware/devices/station-g1/buttons.mdx +++ b/docs/hardware/devices/station-g1/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: Station G1 Hardware Buttons sidebar_label: Buttons sidebar_position: 1 --- diff --git a/docs/hardware/devices/station-g1/index.mdx b/docs/hardware/devices/station-g1/index.mdx index 345feea4..d28cdf15 100644 --- a/docs/hardware/devices/station-g1/index.mdx +++ b/docs/hardware/devices/station-g1/index.mdx @@ -7,7 +7,7 @@ sidebar_position: 9 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. -### Specifications +## Specifications - **MCU** - ESP32 WROOM (WiFi & Bluetooth) @@ -25,7 +25,7 @@ The Station G1 is the second dedicated hardware device to be designed from scrat - **Connectors** - USB-C -### Features +## Features - Meshtastic pre-installed - User button @@ -33,12 +33,13 @@ The Station G1 is the second dedicated hardware device to be designed from scrat - Optional GPS Module and IO Extension Socket - Optional [12V Battery Docker](https://shop.uniteng.com/product/12v-battery-docker-for-station-edition-g1/) which can be used as Backup Power, or in scenarios that require mobility -### Resources +## Resources - Firmware file: `firmware-station-g1-X.X.X.xxxxxxx.bin` -- [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-station-edition/) -- [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-station-edition/) - -Further information on the Station G1 can be found on [Unit Engineering's Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:station). +- [Unit Engineering's Official Wiki](https://uniteng.com/wiki/doku.php?id=meshtastic:station) +- Purchase Links: + - International + - [Official Store](https://shop.uniteng.com/product/meshtastic-mesh-device-station-edition/) + - [Official Tindie Store](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-station-edition/) ![Station G1](/img/hardware/station-g1.jpg) diff --git a/docs/hardware/devices/tbeam/buttons.mdx b/docs/hardware/devices/tbeam/buttons.mdx index 33fe8eac..235829be 100644 --- a/docs/hardware/devices/tbeam/buttons.mdx +++ b/docs/hardware/devices/tbeam/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: T-Beam Hardware Buttons sidebar_label: Buttons sidebar_position: 3 --- diff --git a/docs/hardware/devices/tbeam/enclosures.mdx b/docs/hardware/devices/tbeam/enclosures.mdx index bdf7493b..6d1c405e 100644 --- a/docs/hardware/devices/tbeam/enclosures.mdx +++ b/docs/hardware/devices/tbeam/enclosures.mdx @@ -1,6 +1,6 @@ --- id: enclosures -title: Enclosures +title: T-Beam Enclosures sidebar_label: Enclosures sidebar_position: 3 --- diff --git a/docs/hardware/devices/tbeam/index.mdx b/docs/hardware/devices/tbeam/index.mdx index 86bce35a..992772b7 100644 --- a/docs/hardware/devices/tbeam/index.mdx +++ b/docs/hardware/devices/tbeam/index.mdx @@ -17,16 +17,18 @@ groupId="t-beam" queryString="t-beam" defaultValue="sx1262" values={[ -{label: 'T-Beam v0.7', value:'0.7'}, -{label: 'T-Beam v1.1', value: '1.1'}, -{label: 'T-Beam with M8N', value: 'm8n'}, -{label: 'T-Beam with M8N & SX1262', value: 'sx1262'}, -{label: 'T-Beam S3-Core', value: 's3core'}, -{label: 'T-Beam Supreme', value: 'supreme'} +{label: 'v0.7', value:'0.7'}, +{label: 'v1.1', value: '1.1'}, +{label: 'M8N', value: 'm8n'}, +{label: 'M8N & SX1262', value: 'sx1262'}, +{label: 'S3-Core', value: 's3core'}, +{label: 'Supreme', value: 'supreme'} ]}> +## T-Beam v0.7 + :::caution Firmware Version Notice This is an earlier version of the T-Beam board. Due to changes in the design this board uses a specific firmware file different from the other T-Beam boards. This board is no longer in production and not recommended for new purchases. ::: @@ -45,24 +47,29 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - Micro USB - Antenna: SMA antenna connector -## Features +### Features - Meshtastic preinstalled - Power, Program and Reset switches - Screen sold separately - No GPS -## Resources +### Resources - Firmware file: `firmware-tbeam0.7-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/4000469332610.html) +- Purchase Links: + - International + - [AliExpress](https://www.aliexpress.com/item/4000469332610.html) ![T-Beam v0.7](/img/hardware/t-beam-v0.7.png) ![T-Beam v0.7 pin map](/img/hardware/t-beam_v0.7_pinmap.jpeg) + +## T-Beam v1.1 + - **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** @@ -78,17 +85,21 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - Micro USB - Antenna: SMA antenna connector -## Features +### Features - Meshtastic preinstalled - Power, Program and Reset switches - **Comes with 0.96 inch OLED display** (soldering required to assemble) -## Resources +### Resources - Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/4001178678568.html) -- US Distributor - Purchase link: Rokland [No OLED](https://store.rokland.com/products/lilygo-ttgo-t-beam-v1-1-lora-esp32-development-board-wifi-bluetooth-module-gps-neo-6m-sx1276-915mhz-q219?ref=8Bb2mUO5i-jKwt), [OLED](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-beam-v1-1-esp32-lora-915-mhz-wireless-module-wifi-gps-neo-6m-with-oled-display-soldered-for-arduino-q349) +- Purchase Links: + - US + - [Rokland OLED](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-beam-v1-1-esp32-lora-915-mhz-wireless-module-wifi-gps-neo-6m-with-oled-display-soldered-for-arduino-q349) + - [Rokland No OLED](https://store.rokland.com/products/lilygo-ttgo-t-beam-v1-1-lora-esp32-development-board-wifi-bluetooth-module-gps-neo-6m-sx1276-915mhz-q219?ref=8Bb2mUO5i-jKwt) + - International + - [AliExpress](https://www.aliexpress.com/item/4001178678568.html) ![TTGO T-Beam v1.1](/img/hardware/t-beam-v1.1.png) ![TTGO T-Beam v1.1 pinmap](/img/hardware/t-beam_v1.1_pinmap.webp) @@ -97,6 +108,8 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi +## T-Beam with M8N and SX1276 + - **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** @@ -112,23 +125,29 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - Micro USB - Antenna: U.FL antenna connector -## Features +### Features - Meshtastic preinstalled - Power, Program and Reset switches - Screen sold separately -## Resources +### Resources - Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/32889583204.html) -- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-ttgo-t-beam-v1-1-ipex-esp32-lora-915mhz-wifi-wireless-bluetooth-module-gps-neo-m8n-ipex-18650-battery-holder-q107?ref=8Bb2mUO5i-jKwt) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-ttgo-t-beam-v1-1-ipex-esp32-lora-915mhz-wifi-wireless-bluetooth-module-gps-neo-m8n-ipex-18650-battery-holder-q107?ref=8Bb2mUO5i-jKwt) + - International + - [AliExpress](https://www.aliexpress.com/item/32889583204.html) ![TTGO T-Beam M8N](/img/hardware/t-beam-m8n.png) + +## T-Beam with M8N and SX1276 + - **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** @@ -144,23 +163,29 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - Micro USB - Antenna: U.FL antenna connector -## Features +### Features - Meshtastic preinstalled - Power, Program and Reset switches - Screen sold separately -## Resources +### Resources - Firmware file: `firmware-tbeam-X.X.X.xxxxxxx.bin` -- Purchase link: [AliExpress](https://www.aliexpress.com/item/4001287221970.html) -- US Distributor - Purchase link: [Rokland](https://store.rokland.com/products/lilygo-t-beam-v1-1-neo-m8n-gnss-ipex-lora-sx1262-915mhz-wireless-module-wifi-bluetooth-board-q215?ref=8Bb2mUO5i-jKwt) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-t-beam-v1-1-neo-m8n-gnss-ipex-lora-sx1262-915mhz-wireless-module-wifi-bluetooth-board-q215?ref=8Bb2mUO5i-jKwt) + - International + - [AliExpress](https://www.aliexpress.com/item/4001287221970.html) ![T-Beam M8N & SX1262](/img/hardware/t-beam-sx1262.png) + +## T-Beam S3 Core + - **MCU** - ESP32-S3 (WiFi & Bluetooth 5LE) - **LoRa Transceiver** @@ -176,22 +201,27 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - USB-C - Antenna: U.FL antenna connector -## Features +### Features - SoftRF preinstalled (flashing to Meshtastic required) - Boot and Reset switches - Can be used standalone without 'Supreme' daughterboard in a headless configuration -## Resources +### Resources - Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin` -- Purchase Link: [AliExpress](https://www.aliexpress.com/item/1005005418286231.html) +- Purchase Links: + - International + - [AliExpress](https://www.aliexpress.com/item/1005005418286231.html) ![T-Beam S3-Core](/img/hardware/T-BEAM-S3Core.jpg) + +## T-Beam Supreme + - **MCU** - ESP32-S3 (WiFi & Bluetooth 5LE) - **LoRa Transceiver** @@ -207,7 +237,7 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - USB-C - Antenna: U.FL antenna connector -## Features +### Features - Includes T-Beam S3-Core Module - SoftRF preinstalled (flashing to Meshtastic required) @@ -219,7 +249,7 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi - PCF8563 RTC - Micro-SD reader (not implemented in Meshtastic) -## Flashing the T-Beam Supreme +### Flashing If you are having issues flashing the T-Beam Supreme, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so. @@ -238,13 +268,16 @@ The following process will manually place the device into the Espressif Firmware With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "Tbeam S3 Core from the device drop-down. -## Resources +### Resources - Firmware file: `firmware-tbeam-s3-core-X.X.X.xxxxxxx.bin` -- Purchase links: - - LilyGO Store: [Meshtastic T-Beam 433/868/915/923Mhz](https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module) - - AliExpress: [Meshtastic T-Beam 868/915MHz](https://www.aliexpress.com/item/1005005418286231.html) - - US Distributor - Purchase link: Rokland [NEO-M10S](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191378003), [Quectel L76K](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191345235) +- Purchase Links: + - International + - [LilyGO Store](https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module) + - [AliExpress](https://www.aliexpress.com/item/1005005418286231.html) + - US + - [Rokland NEO-M10S](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191378003) + - [Rokland Quectel L76K](https://store.rokland.com/products/lilygo-t-beam-supreme-esp32-s3-lora-development-board-sx1262-915mhz-gps-l76k-or-u-blox?variant=41051191345235) ![T-Beam Supreme](/img/hardware/T-BEAM-S3-Supreme.jpg) diff --git a/docs/hardware/devices/tbeam/screens.mdx b/docs/hardware/devices/tbeam/screens.mdx index 730f1a53..1922c646 100644 --- a/docs/hardware/devices/tbeam/screens.mdx +++ b/docs/hardware/devices/tbeam/screens.mdx @@ -1,17 +1,12 @@ --- id: screens -title: Screens +title: T-Beam Screens sidebar_label: Screens sidebar_position: 2 --- ## 0.96 inch OLED I2C 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) - ### Pin map To attach the screen: @@ -22,3 +17,12 @@ To attach the screen: 4. Connect SDA to pin 21 ![Connecting the OLED screen to a T-Beam](/img/hardware/t-beam-screen.jpg) + +### Resources +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-ttgo-0-96-inch-oled-white-color-text-display-module-l206-for-t-beam-and-t-sim) + - International + - [Aliexpress](https://www.aliexpress.com/item/32922106384.html) + +![0.96 inch OLED display](/img/hardware/screen.png) diff --git a/docs/hardware/devices/tdeck/index.mdx b/docs/hardware/devices/tdeck/index.mdx index fc90fa68..aecf749a 100644 --- a/docs/hardware/devices/tdeck/index.mdx +++ b/docs/hardware/devices/tdeck/index.mdx @@ -7,7 +7,7 @@ sidebar_position: 5 The T-Deck is a compact device featuring a 2.8-inch IPS LCD touch screen with a resolution of 320x240 pixels, integrated with a small keyboard, trackball, microphone and speaker running on an ESP32-S3 dual-core processor. -### Specifications +## Specifications - **MCU** - ESP32-S3FN16R8 (WiFi & Bluetooth 5 LE) @@ -22,14 +22,14 @@ The T-Deck is a compact device featuring a 2.8-inch IPS LCD touch screen with a - **Connectors** - USB-C -### Features +## Features - LILYGO® backlit T-Keyboard - Trackball - 2.8 inch ST7789 SPI Interface IPS LCD (Resolution: 320 x 240) - I2S Speaker/Microphone -## Flashing the T-Deck +## Flashing If you are having issues flashing the T-Deck, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so. @@ -49,12 +49,14 @@ The following process will manually place the device into the Espressif Firmware With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "T Deck" from the device drop-down. -### Resources +## Resources - Firmware file: `firmware-t-deck-X.X.X.xxxxxxx.bin` -- Purchase links: - - LilyGO Store: [T-Deck 433/868/915Mhz](https://www.lilygo.cc/products/t-deck) - - AliExpress: [T-Deck 433/868/915MHz](https://www.aliexpress.us/item/3256805505920840.html) - - US Distributor - Purchase link: Rokland [915MHz](https://store.rokland.com/products/lilygo-t-deck-portable-microcontroller-programmer-lora-915-mhz-h642) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-t-deck-portable-microcontroller-programmer-lora-915-mhz-h642) + - International + - [LilyGO Store](https://www.lilygo.cc/products/t-deck) + - [AliExpress](https://www.aliexpress.us/item/3256805505920840.html) ![T-Deck](/img/hardware/LILYGO-T-DECK.jpg) diff --git a/docs/hardware/devices/techo/buttons.mdx b/docs/hardware/devices/techo/buttons.mdx index 333dada8..010975a0 100644 --- a/docs/hardware/devices/techo/buttons.mdx +++ b/docs/hardware/devices/techo/buttons.mdx @@ -1,6 +1,6 @@ --- id: buttons -title: Hardware Buttons +title: T-Echo Hardware Buttons sidebar_label: Buttons sidebar_position: 3 --- diff --git a/docs/hardware/devices/techo/enclosures.mdx b/docs/hardware/devices/techo/enclosures.mdx index 18962d72..ea0c23e7 100644 --- a/docs/hardware/devices/techo/enclosures.mdx +++ b/docs/hardware/devices/techo/enclosures.mdx @@ -1,6 +1,6 @@ --- id: enclosures -title: Enclosures +title: T-Echo Enclosures sidebar_label: Enclosures sidebar_position: 3 --- diff --git a/docs/hardware/devices/techo/index.mdx b/docs/hardware/devices/techo/index.mdx index e13d6b4b..381c0614 100644 --- a/docs/hardware/devices/techo/index.mdx +++ b/docs/hardware/devices/techo/index.mdx @@ -9,7 +9,7 @@ The T-Echo is the latest device to be release by LILYGO® supporting a low power Further information on the LILYGO® T-Echo devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGO-T-Echo). -### Specifications +## Specifications - **MCU** - nRF52840 (Bluetooth BLE 5.0 & NFC) @@ -24,19 +24,22 @@ Further information on the LILYGO® T-Echo devices can be found on LILYGO®'s [G - **Connectors** - U.FL antenna connector -### Features +## Features - Reset, Program and capacitive touch buttons - 1.54" eInk display - Optional BME280 - Humidity and Pressure Sensor - Comes with a case and battery -### Resources +## Resources - Firmware file: `firmware-t-echo-2.x.x.uf2` -- Purchase links: - - LilyGO Store: [T-Echo Meshtastic 433/868/915MHz](https://www.lilygo.cc/products/t-echo) - - AliExpress: [T-Echo Meshtastic 433/868/915MHz with optional BME280 sensor](https://www.aliexpress.com/item/1005003026107533.html) - - US Distributor - Rokland: [915MHz](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-lora-sx1262-wireless-module-915mhz-nrf52840-gps-for-arduino?ref=8Bb2mUO5i-jKwt) [915MHz BME280 Kit](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-bme280-lora-sx1262-wireless-module-915mhz-nrf52840-gps-rtc-nfc-for-arduino?ref=8Bb2mUO5i-jKwt) +- Purchase Links: + - US + - [Rokland 915MHz](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-lora-sx1262-wireless-module-915mhz-nrf52840-gps-for-arduino?ref=8Bb2mUO5i-jKwt) + - [Rokland 915MHz w/ BME280 Kit](https://store.rokland.com/products/lilygo-ttgo-meshtastic-t-echo-white-bme280-lora-sx1262-wireless-module-915mhz-nrf52840-gps-rtc-nfc-for-arduino?ref=8Bb2mUO5i-jKwt) + - International + - [LilyGO](https://www.lilygo.cc/products/t-echo) + - [AliExpress](https://www.aliexpress.com/item/1005003026107533.html) ![LILYGO T-Echo](/img/hardware/t-echo.svg) diff --git a/docs/hardware/devices/twatch/index.mdx b/docs/hardware/devices/twatch/index.mdx index 39d938a5..381b5a2d 100644 --- a/docs/hardware/devices/twatch/index.mdx +++ b/docs/hardware/devices/twatch/index.mdx @@ -7,7 +7,7 @@ sidebar_position: 6 The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch screen with a resolution of 240x240 pixels. It includes haptic feedback, an integrated microphone, speaker, real-time clock, and a three-axis accelerometer. -### Specifications +## Specifications - **MCU** - ESP32-S3 (WiFi & Bluetooth 5 LE) @@ -22,7 +22,7 @@ The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch - **Connectors** - Micro-USB -### Features +## Features - 1.54 inch ST7789V TFT LCD (Resolution: 240 x 240) - DRV2605 Haptic Driver @@ -31,7 +31,7 @@ The T-Watch S3 is a compact wearable device featuring a 1.54-inch IPS LCD touch - BMA423 Three Axis accelerometer - Real-Time Clock -## Flashing the T-Watch S3 +## Flashing If you are having issues flashing the T-Watch S3, especially if it's your first attempt, you may need to manually place the device into Espressif's Firmware Download mode. Please follow the process below to do so. @@ -54,12 +54,14 @@ The following process will manually place the device into the Espressif Firmware With the device now in the Espressif Firmware Download mode, you can proceed with flashing using one of the supported flashing methods. It's generally recommended to use the [Web Flasher](https://flasher.meshtastic.org/). You can select "T Watch S3" from the device drop-down. -### Resources +## Resources - Firmware file: `firmware-t-watch-X.X.X.xxxxxxx.bin` -- Purchase links: - - LilyGO Store: [T-Watch 433/868/915Mhz](https://www.lilygo.cc/products/t-watch-s3) - - AliExpress: [T-Watch 433/868/915MHz](https://www.aliexpress.us/item/3256805456685117.html) - - US Distributor - Purchase link: Rokland [915MHz](https://store.rokland.com/products/lilygo-t-watch-s3-open-source-smartwatch-with-lora-and-esp32) +- Purchase Links: + - US + - [Rokland](https://store.rokland.com/products/lilygo-t-watch-s3-open-source-smartwatch-with-lora-and-esp32) + - International + - [LilyGO](https://www.lilygo.cc/products/t-watch-s3) + - [AliExpress](https://www.aliexpress.us/item/3256805456685117.html) ![T-Watch](/img/hardware/LILYGO-T-Watch-S3.jpg) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 7f530f6f..6ffe8eed 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -49,3 +49,5 @@ This process ensures transparency and community involvement in the granting of t - Details: Neil is a contributer of hardware designs, 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 Neil is sponsored or endorsed by Meshtastic. Neil also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: [Emmett Plant](mailto:tetrisblock@gmail.com) - Details: Emmett is producing 'Axanar!,' a non-commercial Star Trek fan puppet show. The Meshtastic logo/trademark will used only in a positive manner, to hint to the audience that Meshtastic is still up and running in the year 2380. The use of the Meshtastic Logo and Trademarks does not imply Emmett Plant or Axanar! is sponsored or endorsed by Meshtastic. Emmett also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revocable at any time for any reason. +- Grant: [Simon - muzi.works](https://instagram.com/muzi.works) + - Details: Simon is a Meshtastic designer of devices, device enclosures and accessories that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Simon is sponsored or endorsed by Meshtastic. Simon also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. diff --git a/docs/software/integrations/mqtt/home-assistant.mdx b/docs/software/integrations/mqtt/home-assistant.mdx index d0458484..b2702d3b 100644 --- a/docs/software/integrations/mqtt/home-assistant.mdx +++ b/docs/software/integrations/mqtt/home-assistant.mdx @@ -268,7 +268,7 @@ First, create an input text helper entity. The preferred way to configure an inp ### Create a Send Message Automation -This automation will check the send box for changes. After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to update the channel name and device ID in the example below. +This automation will check the send box for changes. After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to call your channel "mqtt" and to update the device ID and `from` field in the example below. ```yaml - alias: Meshtastic - Send Automation @@ -288,9 +288,9 @@ This automation will check the send box for changes. After typing a message, ei data: qos: 0 retain: false - topic: msh/2/json/LongFast/!67ea9400 + topic: msh/2/json/mqtt/!67ea9400 payload: >- - {"channel":"0","sender":"broker","type":"sendtext","payload":"{{ + {"from":1743426560,"type":"sendtext","payload":"{{ states('input_text.meshtastic_send_box') }}"} - delay: hours: 0 diff --git a/docs/software/integrations/mqtt/index.mdx b/docs/software/integrations/mqtt/index.mdx index 41d42745..3bbaf209 100644 --- a/docs/software/integrations/mqtt/index.mdx +++ b/docs/software/integrations/mqtt/index.mdx @@ -96,11 +96,14 @@ The `from` field can thus be used as a stable identifier for a specific node. N If the message received contains valid JSON in the payload, the JSON is deserialized and added as a JSON object rather than a string containing the serialized JSON. -**Sent messages** will be checked if the MQTT payload contains a valid JSON-encoded envelope: + +#### JSON downlink to instruct a node to send a message +You can also send a JSON message to the topic `msh/2/json/mqtt/` to instruct a gateway node to send a message to the mesh. Note that the channel **must** be called "mqtt". The JSON message should contain the following fields: ```json { - "sender": "SENDER", + "from": , + "type": "type", "payload": { "key":"value" ... @@ -108,7 +111,10 @@ If the message received contains valid JSON in the payload, the JSON is deserial } ``` -`sender` and `payload` fields are required for a valid envelope. If a valid MQTT message is found, the message is sent over the radio as a message of type `TEXT_MESSAGE_APP` with the serialized `payload` value in the message payload. +`from` and `payload` fields are required for a valid envelope (note that in firmware <2.2.20 a field `sender` was required, but this is no longer the case). The `from` field should be equal to the node number of the node that will transmit the message. Optionally, you can specify a destination by setting the `to` field to the node number of the destination. If the `to` field is not set, the message will be broadcast to all nodes on the mesh. + +Currently two types of messages are supported: `"sendtext"` and `"sendposition"`. +For the type `sendtext`, the `payload` should be a string containing the text to send. For the type `sendposition`, the payload should be an object with the fields `latitude_i`, `longitude_i`, `altitude` (optional) and `time` (optional). ### Basic Configuration diff --git a/docs/software/integrations/mqtt/nodered.mdx b/docs/software/integrations/mqtt/nodered.mdx index 17db1290..1e87f15a 100644 --- a/docs/software/integrations/mqtt/nodered.mdx +++ b/docs/software/integrations/mqtt/nodered.mdx @@ -54,13 +54,13 @@ The JSON output only publishes the following subset of the messages on a Meshtas > Protobufs are mesh native. #### 1. Using JSON-encoded messages -Make sure that option *JSON Output Enabled* is set in MQTT module options. +Make sure that option *JSON Output Enabled* is set in MQTT module options and your channel is called "mqtt". Below is a valid JSON envelope for information sent by MQTT to a device for broadcast onto the mesh. ```json { - "sender":"whatever you want to be the SENDER", + "from":, "type":"sendtext", "payload": text or a json object go here } @@ -979,11 +979,11 @@ The flow is: ] ``` -Sending a position to a device for broadcast to the mesh is much easier with JSON. This introduces a new MQTT Service Envelope type: "sendposition". A valid MQTT envelope and message to broadcast lat, lon, altitude looks like this. +Sending a position to a device for broadcast to the mesh is much easier with JSON. It requires a channel called "mqtt". This introduces a new MQTT Service Envelope type: "sendposition". A valid MQTT envelope and message to broadcast lat, lon, altitude (optional) and time (optional) looks like this: ```json { - "sender": "someSender", + "from": 2130636288, "type": "sendposition", "payload": { "latitude_i": 399600000, diff --git a/docusaurus.config.js b/docusaurus.config.js index aa8bd237..dd90736d 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -4,136 +4,136 @@ require("dotenv").config(); /** @type {import('@docusaurus/types').Config} */ const config = { - title: "Meshtastic", - tagline: - "An open source, off-grid, decentralized, mesh network built to run on affordable, low-power devices", - url: "https://meshtastic.org", - baseUrl: "/", - onBrokenLinks: "throw", - onBrokenMarkdownLinks: "warn", - favicon: "design/web/favicon.ico", - organizationName: "meshtastic", - projectName: "meshtastic", - themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ { - docs: { - sidebar: { - autoCollapseCategories: true, - }, - }, - navbar: { - title: "Meshtastic", - hideOnScroll: true, - logo: { - alt: "Meshtastic Logo", - src: "design/logo/svg/Mesh_Logo_Black.svg", - srcDark: "design/logo/svg/Mesh_Logo_White.svg", - }, - items: [ - { - label: "Docs", - to: "docs/introduction", - }, - { - label: "Downloads", - to: "downloads", - }, - { - label: "About", - position: "right", - items: [ - { - label: "Introduction", - to: "docs/introduction", - }, - { - label: "Getting Started", - to: "docs/getting-started", - }, - { - label: "Contributing", - to: "docs/contributing", - }, - { - label: "Legal", - to: "docs/legal", - }, - { - label: "FAQs", - to: "docs/faq", - }, - ], - }, - { - href: "https://github.com/meshtastic", - position: "right", - className: "header-github-link", - "aria-label": "GitHub repository", - }, - ], - }, - footer: { - copyright: `Powered by ▲ Vercel | Meshtastic® is a registered trademark of Meshtastic LLC. | Legal Information.`, - }, - algolia: { - appId: "IG2GQB8L3V", - apiKey: "2e4348812173ec7ea6f7879c7032bb21", - indexName: "meshtastic", - contextualSearch: false, - searchPagePath: "search", - }, - colorMode: { - respectPrefersColorScheme: true, - }, - mermaid: { - theme: { light: "base", dark: "base" }, - options: { - themeVariables: { - primaryColor: "#67EA94", - primaryTextColor: "var(--tw-prose-headings)", - primaryBorderColor: "#4D4D4D", - lineColor: "#EAD667", - secondaryColor: "#EA67BD", - tertiaryColor: "#677CEA", - }, - }, - }, - }, - plugins: [ - () => { - return { - name: "docusaurus-tailwindcss", - configurePostCss(postcssOptions) { - postcssOptions.plugins.push(require("tailwindcss")); - postcssOptions.plugins.push(require("autoprefixer")); - return postcssOptions; - }, - }; - }, - ], - presets: [ - [ - "@docusaurus/preset-classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - { - docs: { - sidebarPath: require.resolve("./sidebars.js"), - editUrl: "https://github.com/meshtastic/meshtastic/edit/master/", - breadcrumbs: false, - showLastUpdateAuthor: true, - }, - theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - }, - ], - ], - customFields: { - API_URL: process.env.API_URL, - }, - markdown: { - mermaid: true, - }, - themes: ["@docusaurus/theme-mermaid"], + title: "Meshtastic", + tagline: + "An open source, off-grid, decentralized, mesh network built to run on affordable, low-power devices", + url: "https://meshtastic.org", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + favicon: "design/web/favicon.ico", + organizationName: "meshtastic", + projectName: "meshtastic", + themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ { + docs: { + sidebar: { + autoCollapseCategories: true, + }, + }, + navbar: { + title: "Meshtastic", + hideOnScroll: true, + logo: { + alt: "Meshtastic Logo", + src: "design/logo/svg/Mesh_Logo_Black.svg", + srcDark: "design/logo/svg/Mesh_Logo_White.svg", + }, + items: [ + { + label: "Docs", + to: "docs/introduction", + }, + { + label: "Downloads", + to: "downloads", + }, + { + label: "About", + position: "right", + items: [ + { + label: "Introduction", + to: "docs/introduction", + }, + { + label: "Getting Started", + to: "docs/getting-started", + }, + { + label: "Contributing", + to: "docs/contributing", + }, + { + label: "Legal", + to: "docs/legal", + }, + { + label: "FAQs", + to: "docs/faq", + }, + ], + }, + { + href: "https://github.com/meshtastic", + position: "right", + className: "header-github-link", + "aria-label": "GitHub repository", + }, + ], + }, + footer: { + copyright: `Powered by ▲ Vercel | Meshtastic® is a registered trademark of Meshtastic LLC. | Legal Information.`, + }, + algolia: { + appId: "IG2GQB8L3V", + apiKey: "2e4348812173ec7ea6f7879c7032bb21", + indexName: "meshtastic", + contextualSearch: false, + searchPagePath: "search", + }, + colorMode: { + respectPrefersColorScheme: true, + }, + mermaid: { + theme: { light: "base", dark: "base" }, + options: { + themeVariables: { + primaryColor: "#67EA94", + primaryTextColor: "var(--tw-prose-headings)", + primaryBorderColor: "#4D4D4D", + lineColor: "#EAD667", + secondaryColor: "#EA67BD", + tertiaryColor: "#677CEA", + }, + }, + }, + }, + plugins: [ + () => { + return { + name: "docusaurus-tailwindcss", + configurePostCss(postcssOptions) { + postcssOptions.plugins.push(require("tailwindcss")); + postcssOptions.plugins.push(require("autoprefixer")); + return postcssOptions; + }, + }; + }, + ], + presets: [ + [ + "@docusaurus/preset-classic", + /** @type {import('@docusaurus/preset-classic').Options} */ + { + docs: { + sidebarPath: require.resolve("./sidebars.js"), + editUrl: "https://github.com/meshtastic/meshtastic/edit/master/", + breadcrumbs: false, + showLastUpdateAuthor: true, + }, + theme: { + customCss: require.resolve("./src/css/custom.css"), + }, + }, + ], + ], + customFields: { + API_URL: process.env.API_URL, + }, + markdown: { + mermaid: true, + }, + themes: ["@docusaurus/theme-mermaid"], }; module.exports = config; diff --git a/vercel.json b/vercel.json index b6b95c2d..b3b831fb 100644 --- a/vercel.json +++ b/vercel.json @@ -81,4 +81,4 @@ "destination": "/docs/software/integrations/mqtt" } ] -} \ No newline at end of file +}