diff --git a/docs/about/faq.mdx b/docs/about/faq.mdx index b29d79a6..18cb598d 100644 --- a/docs/about/faq.mdx +++ b/docs/about/faq.mdx @@ -21,13 +21,13 @@ Everyone contributes in a different way. Join the [Meshtastic Discord](https://d ### What versions of Android does the Meshtastic Android App require? -Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however at least Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable. While Android 5/6 are officially supported by Meshtastic, it is *not* recommended that you purchase devices with these versions due to their limited OS support and limited battery life due to age. Many newer models exist that are very affordable. A good resource to use when researching affordable devices is the [LineageOS Supported Devices List](https://wiki.lineageos.org/devices/). +Minimum requirement is Android 5 (Lollipop 2014, first BLE support), however at least Android 6 (Marshmallow 2015) is recommended as Bluetooth is more stable. While Android 5/6 are officially supported by Meshtastic, it is _not_ recommended that you purchase devices with these versions due to their limited OS support and limited battery life due to age. Many newer models exist that are very affordable. A good resource to use when researching affordable devices is the [LineageOS Supported Devices List](https://wiki.lineageos.org/devices/). ### What does the icon next to the message mean? - Cloud with an up arrow - Queued on the app to be sent to your device. - Cloud only - Queued on the device to be sent over the mesh. -- Cloud with a check mark - At least one other node on the mesh acknowledged the message. +- Cloud with a check mark - At least one other node on the mesh acknowledged the message. - Person with a check mark - The intended recipient of your direct message acknowledged the message. - Cloud crossed out - Not acknowledged or message error. @@ -91,7 +91,7 @@ Hold down the left PWR button for about 10 seconds and the display should turn o Push the left PWR button for about 1 second. -### Functionality of the T-Beam Buttons ### +### Functionality of the T-Beam Buttons [T-Beam Buttons](/docs/hardware/devices/tbeam/buttons) explained here @@ -120,9 +120,9 @@ Once the node wakes up from sleep, your phone will relay any delayed messages th - Android instructions see: [Android Usage](/docs/software/android/usage#configuration-options) - Python CLI instructions see: [Python Usage](/docs/software/python/cli/usage#changing-settings) -### I am in Europe and my device seems to stop transmitting after a while, what is going on? +### I am in Europe and my device seems to stop transmitting after a while, what is going on? -Europe has an hourly duty cycle limit of 10% in the frequency band that Meshtastic uses. It might be that you hit this limit if you are sending a lot. You can confirm this by checking whether you see duty cycle limit errors in the serial log, Mesh Log (Apple apps) or Debug Panel (Android). +Europe has an hourly duty cycle limit of 10% in the frequency band that Meshtastic uses. It might be that you hit this limit if you are sending a lot. You can confirm this by checking whether you see duty cycle limit errors in the serial log, Mesh Log (Apple apps) or Debug Panel (Android). To limit traffic, you can consider setting the device metrics and position update intervals higher. Alternatively, the device can be configured to override the duty cycle limit, but then you will violate the regulations. ### Why does only one RAK Meshtastic Starter kit show up in my node list? @@ -133,23 +133,24 @@ There was a bug where Meshtastic Starter kits were sent out with the same MAC ad ## Amateur Radio (HAM) -Meshtastic can be used by both unlicensed people and licensed HAM operators. +Meshtastic can be used by both unlicensed people and licensed HAM operators. ### What is the benefit of using a HAM license with Meshtastic? If you use your HAM radio license with Meshtastic, consider both the privileges and restrictions: #### Privileges + - Increased Transmit Power - - Up to 1500W transmit power! [FCC Part 97.313](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-D/section-97.313) + - Up to 1500W transmit power! [FCC Part 97.313](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-D/section-97.313) - Higher Gain Antennas #### Restrictions -- Plain-Text Only - - On amateur radio bands, encryption is illegal. [FCC Part 97.113.C](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.113) -- Lack of Privacy - - As a HAM operator, it is a requirement that you identify yourself by your call sign periodically when transmitting. Your call sign will be publicly transmitted at least once every 10 minutes at minimum. [FCC Part 97.119.A](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.119) +- Plain-Text Only + - On amateur radio bands, encryption is illegal. [FCC Part 97.113.C](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.113) +- Lack of Privacy + - As a HAM operator, it is a requirement that you identify yourself by your call sign periodically when transmitting. Your call sign will be publicly transmitted at least once every 10 minutes at minimum. [FCC Part 97.119.A](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.119) ### How do I set my HAM call sign? diff --git a/docs/about/introduction.mdx b/docs/about/introduction.mdx index ec0441b0..c5290b2e 100644 --- a/docs/about/introduction.mdx +++ b/docs/about/introduction.mdx @@ -5,7 +5,7 @@ slug: /introduction sidebar_position: 1 --- -import Link from '@docusaurus/Link'; +import Link from "@docusaurus/Link"; Meshtastic® is a project that enables you to use inexpensive LoRa radios as a long range off-grid communication platform in areas without existing or reliable communications infrastructure. This project is 100% community driven and open source! @@ -32,8 +32,8 @@ If you are interested in a more technical overview of how Meshtastic works, visi
Technical Overview @@ -45,8 +45,8 @@ Meshtastic is an open source project available on GitHub. Our generous volunteer
Contribute! @@ -54,16 +54,16 @@ Meshtastic is an open source project available on GitHub. Our generous volunteer -## Start using Meshtastic! +## Start using Meshtastic -Hopefully your "Getting Started" experience is straight forward and headache free. If you encounter any issues, please consider updating our documentation to improve future user experiences or reach out on the forum or Discord. +Hopefully your "Getting Started" experience is straight forward and headache free. If you encounter any issues, please consider updating our documentation to improve future user experiences or reach out on the forum or Discord. Our support is 100% volunteer based. We are passionate about the project and hope to help newcomers become Meshtastic experts!
Getting Started diff --git a/docs/about/overview/encryption.mdx b/docs/about/overview/encryption.mdx index 24429e43..fd1f1085 100644 --- a/docs/about/overview/encryption.mdx +++ b/docs/about/overview/encryption.mdx @@ -55,62 +55,59 @@ I'm assuming that meshtastic is being used to hike in places where someone capab I'm guessing that the network behaves somewhat like a store-and-forward network - or, at least, that the goal is to avoid establishing a two-way connection to transmit data. I'm afraid I haven't worked with mesh networks much, but remember studying them briefly in school about ten years ago. - ## Phased Proposal for the Meshtastic Security Framework ### Phase 1 - Fixed network encryption with AES-CTR The current implementation provides optional confidentiality to members of a configured network: - * Encryption is implemented in devices/nodes with network-wide encryption keys. - * Encryption is optional and is turned off when devices are in 'Ham mode'. - * There is no encryption supported in the clients (iOS, Android) to facilitate distribution as mass market software. - * Pairing from client-to-device is by: - * direct USB cable - * BT pairing - * Devices are 'promiscuous' and will pair with any near-by client. Network confidentiality requires physical protextion of all nodes. + +- Encryption is implemented in devices/nodes with network-wide encryption keys. +- Encryption is optional and is turned off when devices are in 'Ham mode'. +- There is no encryption supported in the clients (iOS, Android) to facilitate distribution as mass market software. +- Pairing from client-to-device is by: + - direct USB cable + - BT pairing +- Devices are 'promiscuous' and will pair with any near-by client. Network confidentiality requires physical protextion of all nodes. ### Phase 2 - Strong device and client identity **Phase 2 security goals:** - * Know who sent a message (strong binding of messages to a particular node and/or terminal device) - * This would be an optional feature for a message - * Optionaly enforce identity based restrictions on some actions performed at nodes and/or clients - * Optional support of strong pairing of a client to a device/node and restrict ability to manage and receive messages based on the pairing. - * The BT paring and the cryptographic paring are separate (to simplify pahse 1 deployment and testing) - * Above features should be architected to be ‘cryptographically strong’ and algorithm agile. + +- Know who sent a message (strong binding of messages to a particular node and/or terminal device) + - This would be an optional feature for a message +- Optionaly enforce identity based restrictions on some actions performed at nodes and/or clients +- Optional support of strong pairing of a client to a device/node and restrict ability to manage and receive messages based on the pairing. + - The BT paring and the cryptographic paring are separate (to simplify pahse 1 deployment and testing) +- Above features should be architected to be ‘cryptographically strong’ and algorithm agile. **Phase 2 Proposed mechanisms:** - * Proposed initial algorithms - - Ed25519 for signatures based on NaCl libraries and iOS support for Ed25519 - * Clients and nodes to generate local identity Ed25519 keys - * Devices maintain knowledge of owner public key - * Devices maintain knowledge of some peers public keys and associated information (name, etc.) - * Experimental protobuf message type with - * cipher suite indicator (csi) - * wrapped data using a cipher suite identifier to indicate use of Ed25519 wrapping identified algorithms. - Wrapped data to contain any of the existing message types. - * initial ‘cipher suite’ **only** signs a message - * new signed/authenticated messages to: - * device->client: provide ownership status of device (owner is identifed by a public key) - * client->device: set owner key (must be existing device owner or owner null) - * any->all. Broadcast public key and associated info (crude initial key distribution) - + +- Proposed initial algorithms + - Ed25519 for signatures based on NaCl libraries and iOS support for Ed25519 +- Clients and nodes to generate local identity Ed25519 keys +- Devices maintain knowledge of owner public key +- Devices maintain knowledge of some peers public keys and associated information (name, etc.) +- Experimental protobuf message type with + - cipher suite indicator (csi) + - wrapped data using a cipher suite identifier to indicate use of Ed25519 wrapping identified algorithms. + Wrapped data to contain any of the existing message types. + - initial ‘cipher suite’ **only** signs a message + - new signed/authenticated messages to: + - device->client: provide ownership status of device (owner is identifed by a public key) + - client->device: set owner key (must be existing device owner or owner null) + - any->all. Broadcast public key and associated info (crude initial key distribution) + ### Phase 3 and 3+: - * Device/node e2e message confidentiality (1-to-1) - * NO client side encryption - * All encryption turned off for a network in 'Ham mode' - * Protect messages sent over LoRa from eavesdroppers outside of a well identified group - - multicast group key distribution / discovery (1-to-n) - * Privacy - * BT MAC layer address privatization - * Node address privatization (Use use if based on device public key and schedule based aliasing) - * Private peer discovery - * Private service announcement and discovery - * Device/node security (hardening key storage, tamper resistance, side channel protection, etc.) - * Public key pairing process for client-to-device also sets up BT (no BT pin) - - - - - +- Device/node e2e message confidentiality (1-to-1) + - NO client side encryption + - All encryption turned off for a network in 'Ham mode' +- Protect messages sent over LoRa from eavesdroppers outside of a well identified group + - multicast group key distribution / discovery (1-to-n) +- Privacy + - BT MAC layer address privatization + - Node address privatization (Use use if based on device public key and schedule based aliasing) + - Private peer discovery +- Private service announcement and discovery +- Device/node security (hardening key storage, tamper resistance, side channel protection, etc.) +- Public key pairing process for client-to-device also sets up BT (no BT pin) diff --git a/docs/about/overview/index.mdx b/docs/about/overview/index.mdx index b69ddf3f..8432fa9c 100644 --- a/docs/about/overview/index.mdx +++ b/docs/about/overview/index.mdx @@ -11,4 +11,4 @@ When you send a message on your Meshtastic companion app, it is relayed to the r When a receiving radio captures a packet, it checks to see if it has heard that message before. If it has it ignores the message. If it hasn't heard the message, it will rebroadcast it. -For each message a radio rebroadcasts, it marks the "hop limit" down by one. When a radio receives a packet with a hop limit of zero, it will not rebroadcast the message. \ No newline at end of file +For each message a radio rebroadcasts, it marks the "hop limit" down by one. When a radio receives a packet with a hop limit of zero, it will not rebroadcast the message. diff --git a/docs/about/overview/radio-settings.mdx b/docs/about/overview/radio-settings.mdx index bf3f645f..5f90c043 100644 --- a/docs/about/overview/radio-settings.mdx +++ b/docs/about/overview/radio-settings.mdx @@ -46,7 +46,7 @@ There are 104 channels defined with the standard radio preset `LongFast`. After ### Considerations -Various data-rate options are available when configuring a channel and are inversely proportional to the theoretical range of the devices. +Various data-rate options are available when configuring a channel and are inversely proportional to the theoretical range of the devices. - **Spreading Factor** - How much we "spread" our data over time. - Each step up in Spreading Factor doubles the airtime to transmit. @@ -65,16 +65,15 @@ Various data-rate options are available when configuring a channel and are inver We have six predefined channels. 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 | -| :------------------: | :---------------: | :------------------: | :-----------: | :----------: | :--------:| :---------- :| -| Short Range / Fast | Short Fast | 6.8 kbps | 7 / 128 | 4/8 | 250 | 137dB | -| Short Range / Slow | Short Slow | 3.9 kbps | 8 / 256 | 4/8 | 250 | 140dB | -| Medium Range / Fast | Medium Fast | 2.2 kbps | 9 / 512 | 4/8 | 250 | 143dB | -| Medium Range / Slow | Medium Slow | 1.2 kbps | 10 / 1024 | 4/8 | 250 | 146dB | -| Long Range / Fast | Long Fast | 0.67 kbps (default) | 11 / 2048 | 4/8 | 250 | 148.5dB | -| Long Range / Slow | Long Slow | 0.18 kbps | 12 / 4096 | 4/8 | 125 | 154dB | -| Very Long Range - Slow | Very Long Slow | 0.05 kbps | 12 / 4096 | 4/8 | 31.25 | 160.1dB | - +| Channel setting | Alt Channel Name | Data-Rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | +| :--------------------: | :--------------: | :-----------------: | :----------: | :---------: | :-------: | :---------: | +| Short Range / Fast | Short Fast | 6.8 kbps | 7 / 128 | 4/8 | 250 | 137dB | +| Short Range / Slow | Short Slow | 3.9 kbps | 8 / 256 | 4/8 | 250 | 140dB | +| Medium Range / Fast | Medium Fast | 2.2 kbps | 9 / 512 | 4/8 | 250 | 143dB | +| Medium Range / Slow | Medium Slow | 1.2 kbps | 10 / 1024 | 4/8 | 250 | 146dB | +| Long Range / Fast | Long Fast | 0.67 kbps (default) | 11 / 2048 | 4/8 | 250 | 148.5dB | +| Long Range / Slow | Long Slow | 0.18 kbps | 12 / 4096 | 4/8 | 125 | 154dB | +| Very Long Range - Slow | Very Long Slow | 0.05 kbps | 12 / 4096 | 4/8 | 31.25 | 160.1dB | :::note The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices. Data-rate in this table is actual measured but doesn't count mesh overhead, hops and re-transmissions. @@ -93,18 +92,18 @@ After applying the settings, you will need to restart the device. After your dev Some example settings: | Data-rate | SF / Symbols | Coding Rate | Bandwidth | Link Budget | Note | -| :---------:| :-----------:| :----------:| :--------:| :----------:| :----------------------------------------------------------------------- | -| 37.50 kbps | 6 / 64 | 4/5 | 500 | 129dB | Fastest possible speed | -| 3.125 kbps | 8 / 256 | 4/5 | 125 | 143dB | | -| 1.953 kbps | 8 / 256 | 4/8 | 125 | 143dB | | -| 1.343 kbps | 11 / 2048 | 4/8 | 500 | 145dB | | -| 1.099 kbps | 9 / 512 | 4/8 | 125 | 146dB | | -| 0.814 kbps | 10 / 1024 | 4/6 | 125 | 149dB | | -| 0.610 kbps | 10 / 1024 | 4/8 | 125 | 149dB | | -| 0.488 kbps | 11 / 2048 | 4/6 | 125 | 152dB | | -| 0.336 kbps | 11 / 2048 | 4/8 | 125 | 152dB | | -| 0.073 kbps | 12 / 4096 | 4/5 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", low resilience to noise | -| 0.046 kbps | 12 / 4096 | 4/8 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", high resilience to noise | +| :--------: | :----------: | :---------: | :-------: | :---------: | :----------------------------------------------------------------------- | +| 37.50 kbps | 6 / 64 | 4/5 | 500 | 129dB | Fastest possible speed | +| 3.125 kbps | 8 / 256 | 4/5 | 125 | 143dB | | +| 1.953 kbps | 8 / 256 | 4/8 | 125 | 143dB | | +| 1.343 kbps | 11 / 2048 | 4/8 | 500 | 145dB | | +| 1.099 kbps | 9 / 512 | 4/8 | 125 | 146dB | | +| 0.814 kbps | 10 / 1024 | 4/6 | 125 | 149dB | | +| 0.610 kbps | 10 / 1024 | 4/8 | 125 | 149dB | | +| 0.488 kbps | 11 / 2048 | 4/6 | 125 | 152dB | | +| 0.336 kbps | 11 / 2048 | 4/8 | 125 | 152dB | | +| 0.073 kbps | 12 / 4096 | 4/5 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", low resilience to noise | +| 0.046 kbps | 12 / 4096 | 4/8 | 31 | 160dB | Twice the range and/or coverage of "Long Slow", high resilience to noise | The link budget used by these calculations assumes a transmit power of 17dBm and an antenna with 0dB gain. Adjust your link budget assumptions based on your actual devices. diff --git a/docs/about/overview/range-test.mdx b/docs/about/overview/range-test.mdx index 327d6fb2..6b84d5af 100644 --- a/docs/about/overview/range-test.mdx +++ b/docs/about/overview/range-test.mdx @@ -12,18 +12,21 @@ sidebar_position: 4 - **Record Holder:** _PuzzledPancake_ - **Source:** [Meshtastic Discourse](https://meshtastic.discourse.group/t/practical-range-test-results/692/44) -**Modem Settings** +### Modem Settings + - **Frequency:** 868MHz - **Bandwidth:** 125 - **Spread Factor:** 12 - **Coding Rate:** 4/8 -**Node A** +### Node A + - **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Firmware Version:** 1.2 - **Antenna:** [868MHz 5dBi Antenna](https://ivent.co.nz/product/category/1000/868mhz%205dbi%20antenna%20193mm%20black%20sma%20%28m%29/38646) -**Node B** +### Node B + - **Device:** [LILYGO TTGO T-Beam w/ SX1262](/docs/hardware/devices/tbeam) - **Firmware Version:** 1.2 - **Antenna:** [868MHz Vertical 6dBi](https://ivent.co.nz/product/category/1000/868mhz%20vertical%206dbi%20antenna/38606) @@ -34,5 +37,6 @@ sidebar_position: 4 ![Node B](https://canada1.discourse-cdn.com/free1/uploads/meshtastic/optimized/2X/1/1c8bd5fc41f7bab925404b657a9c481882de9313_2_1332x1000.jpeg) -**Resources Used** - - http://www.heywhatsthat.com \ No newline at end of file +### Resources Used + +- http://www.heywhatsthat.com diff --git a/docs/blocks/_lora-regions.mdx b/docs/blocks/_lora-regions.mdx index b3ae715a..3c51cf01 100644 --- a/docs/blocks/_lora-regions.mdx +++ b/docs/blocks/_lora-regions.mdx @@ -1,21 +1,20 @@ - -| Region Code | Description | -| :-------: | :--------: | -| `UNSET` | Unset | -| `US` | United States | -| `EU_433` | European Union 433MHz | -| `EU_868` | European Union 868MHz | -| `CN` | China | -| `JP` | Japan | -| `ANZ` | Australia & New Zealand | -| `KR` | Korea | -| `TW` | Taiwan | -| `RU` | Russia | -| `IN` | India | -| `NZ_865` | New Zealand 865MHz | -| `TH` | Thailand | -| `LORA_24` | 2.4 GHz band worldwide | +| Region Code | Description | +| :---------: | :---------------------: | +| `UNSET` | Unset | +| `US` | United States | +| `EU_433` | European Union 433MHz | +| `EU_868` | European Union 868MHz | +| `CN` | China | +| `JP` | Japan | +| `ANZ` | Australia & New Zealand | +| `KR` | Korea | +| `TW` | Taiwan | +| `RU` | Russia | +| `IN` | India | +| `NZ_865` | New Zealand 865MHz | +| `TH` | Thailand | +| `LORA_24` | 2.4 GHz band worldwide | :::info EU_433 and EU_868 have to adhere to an hourly duty cycle limitation of 10%. Your device will stop transmitting if you reach it, until it is allowed again. -::: \ No newline at end of file +::: diff --git a/docs/configuration/device-config/bluetooth.mdx b/docs/configuration/device-config/bluetooth.mdx index b97bfbf9..bc1aafad 100644 --- a/docs/configuration/device-config/bluetooth.mdx +++ b/docs/configuration/device-config/bluetooth.mdx @@ -5,10 +5,10 @@ slug: /settings/config/bluetooth sidebar_label: Bluetooth --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf. +The Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN Value. Bluetooth config uses an admin message sending a `Config.Bluetooth` protobuf. :::info ESP32 Devices: Bluetooth will be disabled if WiFi is enabled. The WiFi setting takes precedence. @@ -82,11 +82,11 @@ All Bluetooth module config options are available in the python CLI. Example com ::: -| Setting | Acceptable Values | Default | -| :-----------------------: | :-----------------: | :-----: | -| `bluetooth.enabled` | `true`, `false` | `true` | -| `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` | -| `bluetooth.fixedPin` | `integer` (6 digits) | `123456` | +| Setting | Acceptable Values | Default | +| :------------------: | :---------------------------------: | :----------: | +| `bluetooth.enabled` | `true`, `false` | `true` | +| `bluetooth.mode` | `RANDOM_PIN`, `FIXED_PIN`, `NO_PIN` | `RANDOM_PIN` | +| `bluetooth.fixedPin` | `integer` (6 digits) | `123456` | :::tip @@ -107,6 +107,7 @@ meshtastic --set bluetooth.enabled false meshtastic --set bluetooth.mode FIXED_PIN meshtastic --set bluetooth.fixed_pin 111111 ``` + @@ -120,4 +121,4 @@ All Bluetooth module config options are available for the Web UI. ::: - \ No newline at end of file + diff --git a/docs/configuration/device-config/channels.mdx b/docs/configuration/device-config/channels.mdx index 5485f5d2..1d7e859c 100644 --- a/docs/configuration/device-config/channels.mdx +++ b/docs/configuration/device-config/channels.mdx @@ -5,8 +5,8 @@ slug: /settings/config/channels sidebar_label: Channels --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The Channels config options are: Index, Roles, and Settings. Channel config uses an admin message sending a `Channel` protobuf which also consists of a `ChannelSettings` protobuf. @@ -26,16 +26,16 @@ The channel index begins at 0 and ends at 7. _Indexing_ can not be modified. -| Index | Channel | Default Role | Purpose | -| :--------------------: | :----------------: | :----------------: | :----------------: | -| 0 | 1 | `PRIMARY` | Used as `default` channel | -| 1 | 2 | `DISABLED` | User defined | -| 2 | 3 | `DISABLED` | User defined | -| 3 | 4 | `DISABLED` | User defined | -| 4 | 5 | `DISABLED` | User defined | -| 5 | 6 | `DISABLED` | User defined | -| 6 | 7 | `DISABLED` | User defined | -| 7 | 8 | `DISABLED` | User defined | +| Index | Channel | Default Role | Purpose | +| :---: | :-----: | :----------: | :-----------------------: | +| 0 | 1 | `PRIMARY` | Used as `default` channel | +| 1 | 2 | `DISABLED` | User defined | +| 2 | 3 | `DISABLED` | User defined | +| 3 | 4 | `DISABLED` | User defined | +| 4 | 5 | `DISABLED` | User defined | +| 5 | 6 | `DISABLED` | User defined | +| 6 | 7 | `DISABLED` | User defined | +| 7 | 8 | `DISABLED` | User defined | :::note You can **not** have `DISABLED` channels in-between active channels such as `PRIMARY` and `SECONDARY`. Active channels must be consecutive. @@ -45,15 +45,15 @@ You can **not** have `DISABLED` channels in-between active channels such as `PRI Each channel is assigned one of 3 roles: -1. `PRIMARY` or `1` - - This is the first channel that is created for you on initial setup. - - Only one primary channel can exist and can not be disabled. - - Direct messages are only available on this channel. +1. `PRIMARY` or `1` + - This is the first channel that is created for you on initial setup. + - Only one primary channel can exist and can not be disabled. + - Direct messages are only available on this channel. 2. `SECONDARY` or `2` - - Can modify the encryption key (PSK). -3. `DISABLED` or `0` - - The channel is no longer available for use. - - The channel settings are set to default. + - Can modify the encryption key (PSK). +3. `DISABLED` or `0` + - The channel is no longer available for use. + - The channel settings are set to default. ## Channel Settings Values @@ -71,12 +71,12 @@ Set to `0` by default. ### Name -A short identifier for the channel. _(< 12 bytes)_ +A short identifier for the channel. _(< 12 bytes)_ -| Reserved Name | Purpose | -| :--------------------: | :----------------: | -| `""` (default) | If left empty on the Primary channel, this designates the `default` channel. | -| `admin` | On Secondary channels, the name `admin` (case sensitive) designates the `admin` channel used to administer nodes over the mesh | +| Reserved Name | Purpose | +| :------------: | :----------------------------------------------------------------------------------------------------------------------------: | +| `""` (default) | If left empty on the Primary channel, this designates the `default` channel. | +| `admin` | On Secondary channels, the name `admin` (case sensitive) designates the `admin` channel used to administer nodes over the mesh | ### PSK @@ -140,13 +140,13 @@ meshtastic --ch-set name "My Channel" --ch-set psk random --ch-set uplink_enable ::: -**Id** +### Id ```shell title="Set the PRIMARY channel ID" meshtastic --ch-set id 1234 --ch-index 0 ``` -**Name** +### Name ```shell title="Set channel name for the PRIMARY channel" # without spaces @@ -155,7 +155,7 @@ meshtastic --ch-set name MyChannel --ch-index 0 meshtastic --ch-set name "My Channel" --ch-index 0 ``` -**PSK** +### PSK If you use Meshtastic for exchanging messages you don't want other people to see, `random` is the setting you should use. Selecting `default` or any of the `simple` values from the following table will use publicly known encryption keys. They're shipped with Meshtastic source code and thus, anyone can listen to messages encrypted by them. They're great for testing and public channels. @@ -186,7 +186,7 @@ meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a meshtastic --ch-set psk none --ch-index 0 ``` -**Uplink / Downlink** +### Uplink / Downlink For configuring gateways, please see [MQTT](/docs/settings/moduleconfig/mqtt) @@ -209,4 +209,4 @@ All Channel config options are available in the Web UI. ::: - \ No newline at end of file + diff --git a/docs/configuration/device-config/device.mdx b/docs/configuration/device-config/device.mdx index 8f90ccaf..394024b1 100644 --- a/docs/configuration/device-config/device.mdx +++ b/docs/configuration/device-config/device.mdx @@ -5,32 +5,34 @@ slug: /settings/config/device sidebar_label: Device --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The device config options are: Role, Serial Output, and Debug Log. Device config uses an admin message sending a `Config.Device` protobuf. +The device config options are: Role, Serial Output, and Debug Log. Device config uses an admin message sending a `Config.Device` protobuf. ## Device Config Values ### Role -Sets the role of node. + +Sets the role of node. Acceptable values: -| Value | Description | -| :-------: | :---------------------------------------------------------------------------------------: | -| `CLIENT` | Client (default) - App connected client. | -| `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. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | -| `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | +| Value | Description | +| :-------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| `CLIENT` | Client (default) - App connected client. | +| `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. This node will not be used by client apps. The WiFi/BLE radios and the OLED screen will be put to sleep. | +| `ROUTER_CLIENT` | Router Client - Mesh packets will prefer to be routed over this node. The Router Client can be used as both a Router and an app connected Client. | +### Serial Console -### Serial Console Acceptable values: `true` or `false` Disabling this will disable the SerialConsole by not initializing the StreamAPI. ### Debug Log + Acceptable values: `true` or `false` By default we turn off logging as soon as an API client connects. Set this to true to leave the debug log outputting even when API is active. @@ -74,7 +76,7 @@ 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` | `CLIENT` | | device.serial_enabled | `true`, `false` | `true` | @@ -107,6 +109,6 @@ meshtastic --set device.debug_log_enabled true :::info All device config options are available in the Web UI. ::: - + diff --git a/docs/configuration/device-config/display.mdx b/docs/configuration/device-config/display.mdx index a2e4a89a..34fbf803 100644 --- a/docs/configuration/device-config/display.mdx +++ b/docs/configuration/device-config/display.mdx @@ -5,52 +5,59 @@ slug: /settings/config/display sidebar_label: Display --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The display config options are: Screen On Duration, Auto Carousel Interval, Always Point North and GPS Format. Display config uses an admin message sending a `Config.Display` protobuf. +The display config options are: Screen On Duration, Auto Carousel Interval, Always Point North and GPS Format. Display config uses an admin message sending a `Config.Display` protobuf. ## Device Config Values ### Screen On Duration + How long the screen remains on after the user button is pressed or messages are received. ### Auto Carousel Interval + Automatically toggles to the next page on the screen like a carousel, based the specified interval. ### Always Point North + If this is set, the compass heading on the screen outside of the circle will always point north. This feature is off by default and the top of display represents your heading direction, the North indicator will move around the circle. ### GPS Format + The format used to display GPS coordinates on the device screen. Acceptable values: -| Value | Description | -| :-------: | :--------------------------: | -| `DEC` | Decimal Degrees | -| `DMS` | Degrees Minutes Seconds | -| `UTM` | Universal Transverse Mercator | -| `MGRS` | Military Grid Reference System | -| `OLC` | Open Location Code (Plus Codes) | -| `OSGR` | Ordnance Survey Grid Reference | +| Value | Description | +| :----: | :-----------------------------: | +| `DEC` | Decimal Degrees | +| `DMS` | Degrees Minutes Seconds | +| `UTM` | Universal Transverse Mercator | +| `MGRS` | Military Grid Reference System | +| `OLC` | Open Location Code (Plus Codes) | +| `OSGR` | Ordnance Survey Grid Reference | ### Prefered display units + switch between `METRIC` (default) and `IMPERIAL` units ### Flip Screen + If enabled, the screen will be rotated 180 degrees, for cases that mount the screen upside down ### OLED Defintion + The type of OLED Controller is auto-detected by default, but can be defined with this setting if the auto-detection fails. Acceptable values: -| Value | Description | -| :-------: | :--------------------------: | -| `OLED_AUTO` | Auto detect display controller | -| `OLED_SSD1306` | Always use SSD1306 driver | -| `OLED_SH1106` | Always use SH1106 driver | +| Value | Description | +| :------------: | :----------------------------: | +| `OLED_AUTO` | Auto detect display controller | +| `OLED_SSD1306` | Always use SSD1306 driver | +| `OLED_SH1106` | Always use SH1106 driver | ## Device Config Client Availability @@ -91,7 +98,7 @@ All display config options are available in the python CLI. Example commands are ::: | Setting | Acceptable Values | Default | -|-----------------------------------|--------------------------------------------|------------------------------| +| --------------------------------- | ------------------------------------------ | ---------------------------- | | display.auto_screen_carousel_secs | `integer` | Default of `0` is 10 minutes | | display.compass_north_top | `false`, `true` | `false` | | display.flip_screen | `fasle`, `true` | `false` | @@ -131,6 +138,6 @@ meshtastic --set display.gps_format UTM :::info All display config options are available in the Web UI. ::: - + diff --git a/docs/configuration/device-config/index.mdx b/docs/configuration/device-config/index.mdx index 44c19e32..eb6f2a2c 100644 --- a/docs/configuration/device-config/index.mdx +++ b/docs/configuration/device-config/index.mdx @@ -8,14 +8,14 @@ sidebar_position: 1 There are several config sections in the Meshtastic firmware, these are broken out so they can be sent as small admin messages over the mesh. -| Name | Description | -|:----:|:-----------:| -| [Bluetooth](/docs/settings/config/bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. | -| [Channels](/docs/settings/config/channels) | Channels config options are: Index, Role and Settings. | -| [Device](/docs/settings/config/device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. | -| [Display](/docs/settings/config/display) | Display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, and GPS Format. | -| [LoRa](/docs/settings/config/lora) | The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Disabled and Ignore Incoming Array. | -| [Network](/docs/settings/config/network) | Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, WiFi Mode and NTP Server. | -| [Position](/docs/settings/config/position) | Position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. | -| [Power](/docs/settings/config/power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. | -| [User](/docs/settings/config/user) | The user config options are: Long Name, Short Name, and Is Licensed | \ No newline at end of file +| Name | Description | +| :------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| [Bluetooth](/docs/settings/config/bluetooth) | Bluetooth config options are: Enabled, Pairing Mode and Fixed PIN. | +| [Channels](/docs/settings/config/channels) | Channels config options are: Index, Role and Settings. | +| [Device](/docs/settings/config/device) | Device config options are: Device Role, Serial Output, Debug Log and Factory Reset. | +| [Display](/docs/settings/config/display) | Display config options are: Screen On Duration, Auto Carousel Interval, Always Point North, and GPS Format. | +| [LoRa](/docs/settings/config/lora) | The LoRa config options are: Region, Modem Preset, Max Hops, Transmit Power, Bandwidth, Spread Factor, Coding Rate, Frequency Offset, Transmit Disabled and Ignore Incoming Array. | +| [Network](/docs/settings/config/network) | Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, WiFi Mode and NTP Server. | +| [Position](/docs/settings/config/position) | Position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. | +| [Power](/docs/settings/config/power) | Power config options are: Charge Current, Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. | +| [User](/docs/settings/config/user) | The user config options are: Long Name, Short Name, and Is Licensed | diff --git a/docs/configuration/device-config/lora.mdx b/docs/configuration/device-config/lora.mdx index 8848bc41..be159166 100644 --- a/docs/configuration/device-config/lora.mdx +++ b/docs/configuration/device-config/lora.mdx @@ -5,11 +5,11 @@ slug: /settings/config/lora sidebar_label: LoRa --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import LoRaRegions from '../../blocks/_lora-regions.mdx'; +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 and Ignore Incoming Array. 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 and Ignore Incoming Array. LoRa config uses an admin message sending a `Config.LoRa` protobuf. ## LoRa Config Values @@ -18,14 +18,17 @@ You must set your device's `lora.region` setting. This will ensure that you are ::: ### Region + Sets the region for your node. Default is `unset`. As long as this is not set, the node screen will display a message and not transmit any packets. ### Modem Preset + Use a sensible default for the modem. Default is `unset` which equates to `LONG_FAST`. Also 'Use Presets' has to be defined, which is the default. If 'Use Presets' is not defined, the modem will be configured manually with Bandwidth, Spread Factor, and Coding Rate. ### Max Hops + Maximum number of hops. This can't be greater than 7. Default is 3 which should be fine for most applications. _**Really, 3 is fine.**_ ### Transmit Power @@ -61,6 +64,7 @@ Allows you to enable and disable transmit (TX) from the LoRa radio. Useful for h Defaults to true ### Channel Number + This is controlling the actual hardware frequency the radio is transmitting on. A channel number between 1 and NUM_CHANNELS (whatever the max is in the current region). If this is ZERO/UNSET then the rule is "use the old channel name hash based algorithm to derive the channel number". ### Ignore Incoming Array @@ -110,18 +114,17 @@ LoRa config commands are available in the python CLI. Example commands are below ::: -| Setting | Acceptable Values | Default | -| :----------: | :---------------------------------------------------------------------------: | :---------------: | -| lora.modem_preset | `LONG_FAST`, `LONG_SLOW`, `VERY_LONG_SLOW`, `MEDIUM_SLOW`, `MEDIUM_FAST`, `SHORT_SLOW`, `SHORT_FAST` | `LONG_FAST` | -| lora.region | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH`, `LORA_24` | `UNSET` | -| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` | -| lora.override_duty_cycle | `false`, `true` | `false` | +| Setting | Acceptable Values | Default | +| :----------------------: | :-----------------------------------------------------------------------------------------------------: | :---------: | +| lora.modem_preset | `LONG_FAST`, `LONG_SLOW`, `VERY_LONG_SLOW`, `MEDIUM_SLOW`, `MEDIUM_FAST`, `SHORT_SLOW`, `SHORT_FAST` | `LONG_FAST` | +| lora.region | `UNSET`, `US`, `EU_433`, `EU_868`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` ,`IN`, `NZ_865`, `TH`, `LORA_24` | `UNSET` | +| lora.hop_limit | `1`,`2`,`3`,`4`,`5`,`6`,`7` | `3` | +| lora.override_duty_cycle | `false`, `true` | `false` | :::tip Because the device will reboot after each command is sent via CLI, it is recommended when setting multiple values in a config section that commands be chained together as one. - ```shell title="Example:" meshtastic --set lora.region US --set lora.modem_preset LONG_FAST ``` diff --git a/docs/configuration/device-config/network.mdx b/docs/configuration/device-config/network.mdx index 1d6b0562..7237475d 100644 --- a/docs/configuration/device-config/network.mdx +++ b/docs/configuration/device-config/network.mdx @@ -5,8 +5,8 @@ slug: /settings/config/network sidebar_label: Network --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The Network config options are: WiFi Enabled, WiFi SSID, WiFi PSK, Ethernet Enabled, IPv4 Networking Mode, Static Address and NTP Server. Network config uses an admin message sending a `Config.Network` protobuf. @@ -56,7 +56,6 @@ Set to `DHCP` by default. Change to `STATIC` to use a static IP address. Applies contains ip, gateway, subnet and dns server in case you want a static configuration. - :::tip The first time your device restarts after enabling WiFi or Ethernet, it will take an additional 20-30 seconds to boot. This is to generate self-signed SSL keys. The keys will be saved for future reuse. ::: @@ -103,12 +102,12 @@ All Network config options are available in the python CLI. ::: -| Setting | Acceptable Values | Default | -| :-----------: | :---------------: | :-----: | -| network.ntp_server | string | `0.pool.ntp.org` | -| network.wifi_enabled | `true`, `false` | `false` | -| network.wifi_psk | string | `""` | -| network.wifi_ssid | string | `""` | +| Setting | Acceptable Values | Default | +| :------------------: | :---------------: | :--------------: | +| network.ntp_server | string | `0.pool.ntp.org` | +| network.wifi_enabled | `true`, `false` | `false` | +| network.wifi_psk | string | `""` | +| network.wifi_ssid | string | `""` | :::tip @@ -149,7 +148,7 @@ meshtastic --set network.wifi_psk "my password" :::info All Network config options are available in the Web UI. ::: - + @@ -162,7 +161,7 @@ With `network.wifi_ssid` & `network.wifi_psk` populated, the device will know to If you have a screen attached to your device, the final page will display something similar to the following: -``` +```text WiFi: Software AP (Admin) IP: 192.168.42.1 (0/4) SSID: myNetwork @@ -174,4 +173,4 @@ You should then be able to connect to the node using either the displayed IP add ### Disable WiFi -To disable WiFi completely, set `network.wifi_enabled` to `false`. \ No newline at end of file +To disable WiFi completely, set `network.wifi_enabled` to `false`. diff --git a/docs/configuration/device-config/position.mdx b/docs/configuration/device-config/position.mdx index fc1e0465..acab186e 100644 --- a/docs/configuration/device-config/position.mdx +++ b/docs/configuration/device-config/position.mdx @@ -5,17 +5,18 @@ slug: /settings/config/position sidebar_label: Position --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf. +The position config options are: GPS Enabled, GPS Update Interval, GPS Attempt Time, Fixed Position, Smart Broadcast, Broadcast Interval and Position Packet Flags. Position config uses an admin message sending a `Config.Position` protobuf. Position data from GPS is provided by either the radio or your paired phone. Position data is not required to use Meshtastic but time calculations require at least one device on the mesh have either a GPS or internet connection for time. ## Position Config Values ### GPS Disabled -Acceptable values: `true` or `false` + +Acceptable values: `true` or `false` Defaults to false. Should the device GPS be disabled for this node? @@ -25,18 +26,19 @@ How often should we try to get GPS position (in seconds), or zero for the defaul ### GPS Attempt Time -How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 30 seconds. +How long should we try to get our position during each GPS update interval attempt? (in seconds) Or if zero, use the default of 30 seconds. ### Fixed Position -Acceptable values: `true` or `false` +Acceptable values: `true` or `false` Off by default If set, this node is at a fixed position. The device will generate GPS updates at the regular GPS update interval, but use whatever the last lat/lon/alt it saved for the node. The lat/lon/alt can be set by an internal GPS or with the help of the mobile device's GPS. ### Smart Broadcast -Acceptable values: `true` or `false` + +Acceptable values: `true` or `false` On by default @@ -54,27 +56,25 @@ If smart broadcast is of we should send our position this often (but only if it The GPS updates will be sent out every Broadcast Interval, with either the actual GPS location, or an empty location if no GPS fix was achieved. This defaults to broadcast every 15 minutes. - ### Position Flags +### Position Flags - Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags) +Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags) -| Value | Description | -| :-----------: | :---------------------------------------------------------: | -| UNSET | Required for compilation | -| ALTITUDE | Include an altitude value (if available) | -| ALTITUDE_MSL | Altitude value is MSL | -| GEOIDAL_SEPARATION | Include geoidal separation | -| DOP | Include the DOP value ; PDOP used by default, see below | -| HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of PDOP | -| SATINVIEW | Include number of "satellites in view" | -| SEQ_NO | Include a sequence number incremented per packet | -| TIMESTAMP | Include positional timestamp (from GPS solution) | -| HEADING | Include positional heading (from GPS solution) | -| SPEED | Include positional speed (from GPS solution) | +| Value | Description | +| :----------------: | :--------------------------------------------------------------: | +| UNSET | Required for compilation | +| ALTITUDE | Include an altitude value (if available) | +| ALTITUDE_MSL | Altitude value is MSL | +| GEOIDAL_SEPARATION | Include geoidal separation | +| DOP | Include the DOP value ; PDOP used by default, see below | +| HVDOP | If POS_DOP set, send separate HDOP / VDOP values instead of PDOP | +| SATINVIEW | Include number of "satellites in view" | +| SEQ_NO | Include a sequence number incremented per packet | +| TIMESTAMP | Include positional timestamp (from GPS solution) | +| HEADING | Include positional heading (from GPS solution) | +| SPEED | Include positional speed (from GPS solution) | - - - ## Position Config Client Availability +## Position Config Client Availability -:::info +:::info All Position config commands are available in the python CLI. Example commands are below: ::: -| Setting | Acceptable Values | Default | -| :----------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | -| position.gps_enabled | `true`, `false` | `true` | -| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds | -| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds | -| position.fixed_position | `true`, `false` | `false` | -| position.position_broadcast_smart_enabled | `true`, `false` | `true` | -| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes | -| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` | +| Setting | Acceptable Values | Default | +| :---------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------: | +| position.gps_enabled | `true`, `false` | `true` | +| position.gps_update_interval | `integer` (seconds) | Default `0` is 30 Seconds | +| position.gps_attempt_time | `integer` (seconds) | Default of `0` is 30 Seconds | +| position.fixed_position | `true`, `false` | `false` | +| position.position_broadcast_smart_enabled | `true`, `false` | `true` | +| position.position_broadcast_secs | `integer` (seconds) | Default of `0` is 15 Minutes | +| position.flags | `UNSET`, `ALTITUDE`, `ALTITUDE_MSL`, `GEOIDAL_SEPARATION`, `DOP`, `HVDOP`, `PDOP`, `SATINVIEW`, `SEQ_NO`, `TIMESTAMP`, `HEADING`, `SPEED` | `UNSET` | :::tip @@ -183,7 +183,7 @@ meshtastic --pos-fields UNSET :::info All position config options are available in the Web UI. ::: - + diff --git a/docs/configuration/device-config/power.mdx b/docs/configuration/device-config/power.mdx index 8d36d5fb..4f5158b1 100644 --- a/docs/configuration/device-config/power.mdx +++ b/docs/configuration/device-config/power.mdx @@ -5,10 +5,10 @@ slug: /settings/config/power sidebar_label: Power --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. Power config uses an admin message sending a `Config.Power` protobuf. +The power config options are: Power Saving, Shutdown after losing power, ADC Multiplier Override Wait Bluetooth Interval, Mesh Super Deep Sleep Timeout, Super Deep Sleep Interval, Light Sleep Interval and Minimum Wake Interval. Power config uses an admin message sending a `Config.Power` protobuf. Power settings are advanced configuration, most users should choose a role under Device Config to manage power for their device and should never need to touch any of these settings. @@ -22,8 +22,7 @@ If set, we are powered from a low-current source (i.e. solar), so even if it loo Automatically shut down a device after a defined time period if power is lost. -### ADC Multiplier Override -**Fixes issues on Heltec v2** +### ADC Multiplier Override `Fixes issues on Heltec v2` Ratio of voltage divider for battery pin e.g. 3.20 (R1=100k, R2=220k) @@ -39,21 +38,19 @@ How long wait before turning off BLE in no Bluetooth states ### Mesh Super Deep Sleep Timeout -While in Light Sleep if this value is exceeded we will lower into super deep sleep +While in Light Sleep if this value is exceeded we will lower into super deep sleep or Super Deep Sleep Interval (default 1 year) or a button press `0` for default of two hours, MAXUINT for disabled -### Super Deep Sleep Interval +### Super Deep Sleep Interval While in Light Sleep if Mesh Super Deep Sleep Timeout Seconds is exceeded we will lower into super deep sleep or this value (default 1 year) or a button press `0` for default of one year -### Light Sleep Interval - -**ESP32 Only Setting** +### Light Sleep Interval `ESP32 Only Setting` In light sleep the CPU is suspended, LoRa radio is on, BLE is off an GPS is on @@ -98,22 +95,22 @@ Power config is not available on Apple OS's. -:::info +:::info All Power config options are available in the python CLI. ::: -| Setting | Acceptable Values | Default | -| :----------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------: | -| power.is_power_saving | `true`, `false` | `false` | -| power.on_battery_shutdown_after_secs | `integer` (seconds) | Default of `0` is off | -| power.adc_multiplier_override | `2-4` (floating point value) | Default of `0` uses firmware values | -| power.wait_bluetooth_secs | `integer` (seconds) | Default of `0` is 1 minute | -| power.mesh_sds_timeout_secs | `integer` (seconds) | Default of `0` is 2 hours | -| power.sds_secs | `integer` (seconds) | Default of `0` is 1 year | -| power.ls_secs | `integer` (seconds) | Default of `0` is 1 hour | -| power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds | +| Setting | Acceptable Values | Default | +| :----------------------------------: | :--------------------------: | :---------------------------------: | +| power.is_power_saving | `true`, `false` | `false` | +| power.on_battery_shutdown_after_secs | `integer` (seconds) | Default of `0` is off | +| power.adc_multiplier_override | `2-4` (floating point value) | Default of `0` uses firmware values | +| power.wait_bluetooth_secs | `integer` (seconds) | Default of `0` is 1 minute | +| power.mesh_sds_timeout_secs | `integer` (seconds) | Default of `0` is 2 hours | +| power.sds_secs | `integer` (seconds) | Default of `0` is 1 year | +| power.ls_secs | `integer` (seconds) | Default of `0` is 1 hour | +| power.min_wake_secs | `integer` (seconds) | Default of `0` is 10 seconds | :::tip @@ -161,12 +158,13 @@ meshtastic --set power.ls_secs 120 meshtastic --set power.min_wake_secs 0 meshtastic --set power.min_wake_secs 120 ``` + :::info All power config options are available in the Web UI. ::: - + - \ No newline at end of file + diff --git a/docs/configuration/device-config/user.mdx b/docs/configuration/device-config/user.mdx index 4b6a770a..e7fe8bb2 100644 --- a/docs/configuration/device-config/user.mdx +++ b/docs/configuration/device-config/user.mdx @@ -5,8 +5,8 @@ slug: /settings/config/user sidebar_label: User --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The user config options are: Long Name, Short Name, and Is Licensed. User config uses an admin message sending a `User` protobuf. @@ -51,7 +51,7 @@ values={[ :::info -User Config options are available for Android. +User Config options are available for Android. 1. Open the Meshtastic App 2. Navigate to: **Vertical Ellipsis (3 dots top right) > Device Settings > User Config** @@ -109,4 +109,4 @@ All User config options are available in the Web UI. ::: - \ No newline at end of file + diff --git a/docs/configuration/gpio-peripherals.mdx b/docs/configuration/gpio-peripherals.mdx index 0169846d..2f07cb59 100644 --- a/docs/configuration/gpio-peripherals.mdx +++ b/docs/configuration/gpio-peripherals.mdx @@ -6,7 +6,6 @@ slug: /hardware/peripheral/ sidebar_position: 6 --- - ## Firmware Versions :::warning @@ -47,7 +46,7 @@ The procedure using the python command line tool is: meshtastic --ch-add gpio ``` 3. If doing local testing, you may also want to change the speed of the channel: - ```sh + ```shell meshtastic --ch-mediumfast ``` 4. Check the channel has been created and copy the long "Complete URL" that contains all the channels on that device: @@ -144,7 +143,6 @@ By default, the pin may be "off" or "on". (It will most likely "off".) See the s ![T-Lora v1 with LED on GPIO 21](/img/LED_on_TLoraV1.jpg) - ## Using GPIOs from the Python CLI ### Writing a GPIO @@ -178,4 +176,4 @@ meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest 28979058 # Received RemoteHardware typ=GPIOS_CHANGED, gpio_value=0 # Received RemoteHardware typ=GPIOS_CHANGED, gpio_value=16 # < press ctrl-c to exit > -``` \ No newline at end of file +``` diff --git a/docs/configuration/module-config/audio.mdx b/docs/configuration/module-config/audio.mdx index 7fda6ab7..ffe6e6b6 100644 --- a/docs/configuration/module-config/audio.mdx +++ b/docs/configuration/module-config/audio.mdx @@ -5,8 +5,8 @@ slug: /settings/moduleconfig/audio sidebar_label: Audio --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The audio module config options are: Codec2 Enabled, PTT GPIO, Audio Bitrate/Codec Mode, I2S Word Select, I2S Data IN, I2S Data OUT and I2S Clock. Audio Module config uses an admin message sending a `ConfigModule.Audio` protobuf. @@ -26,15 +26,15 @@ The GPIO to use for the Push-To-Talk button. The default is GPIO 39 on the ESP32 The bitrate to use for audio. The default is `CODEC2_700B`. The available options are: - * CODEC2_DEFAULT - * CODEC2_3200 - * CODEC2_2400 - * CODEC2_1600 - * CODEC2_1400 - * CODEC2_1300 - * CODEC2_1200 - * CODEC2_700B - * CODEC2_700 +- CODEC2_DEFAULT +- CODEC2_3200 +- CODEC2_2400 +- CODEC2_1600 +- CODEC2_1400 +- CODEC2_1300 +- CODEC2_1200 +- CODEC2_700B +- CODEC2_700 ### I2S Word Select @@ -53,7 +53,7 @@ The GPIO to use for the DIN signal in the I2S interface. The GPIO to use for the SCK signal in the I2S interface. :::info What is this? -These Pins comprise an I2S digital audio interface. Meshtastic uses it in monoaural mode. The software will use the logical 'LEFT' Stereo channel for the microphone and the logical 'RIGHT' Stereo channel for the speaker, so configure your breakouts accordingly. Audio is Half-Duplex, so we can re-use part of the pins for a bi-directional configuration. There's __no__ default pin assigment, setting these is mandatory. +These Pins comprise an I2S digital audio interface. Meshtastic uses it in monoaural mode. The software will use the logical 'LEFT' Stereo channel for the microphone and the logical 'RIGHT' Stereo channel for the speaker, so configure your breakouts accordingly. Audio is Half-Duplex, so we can re-use part of the pins for a bi-directional configuration. There's **no** default pin assigment, setting these is mandatory. ::: ## Audio Module Config Client Availability @@ -88,21 +88,21 @@ Audio module config is not available on iOS, iPadOS and macOS. -:::info +:::info All audio module config options are available in the python CLI. Example commands are below: ::: -| Setting | Acceptable Values | Default | -| :-------------------: | :-----------------: | :-----: | -| audio.enabled | `true`, `false` | `false` | -| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset | -| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` | -| audio.i2s_ws | GPIO Pin Number 1-34 | no Default | -| audio.i2s_sd | GPIO Pin Number 1-39 | no Default | -| audio.i2s_din | GPIO Pin Number 1-34 | no Default | -| audio.i2s_sck | GPIO Pin Number 1-34 | no Default | +| Setting | Acceptable Values | Default | +| :-----------: | :-----------------------------------------------------------------------------------------------------------------------------: | :----------------------: | +| audio.enabled | `true`, `false` | `false` | +| audio.ptt_pin | GPIO Pin Number 1-39 | Default of `39` is Unset | +| audio.bitrate | `CODEC2_DEFAULT` `CODEC2_3200` `CODEC2_2400` `CODEC2_1600` `CODEC2_1400` `CODEC2_1300` `CODEC2_1200` `CODEC2_700B` `CODEC2_700` | `CODEC2_DEFAULT` | +| audio.i2s_ws | GPIO Pin Number 1-34 | no Default | +| audio.i2s_sd | GPIO Pin Number 1-39 | no Default | +| audio.i2s_din | GPIO Pin Number 1-34 | no Default | +| audio.i2s_sck | GPIO Pin Number 1-34 | no Default | :::tip @@ -142,7 +142,7 @@ meshtastic --set audio.bitrate CODEC2_1400 :::info All audio module config options are available in the Web UI. ::: - + diff --git a/docs/configuration/module-config/canned-message.mdx b/docs/configuration/module-config/canned-message.mdx index 01322006..b2dce0db 100644 --- a/docs/configuration/module-config/canned-message.mdx +++ b/docs/configuration/module-config/canned-message.mdx @@ -5,12 +5,12 @@ slug: /settings/moduleconfig/canned-message sidebar_label: Canned Message --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The Canned Message Module will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from. -The canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf. +The canned message module config options are: Enabled, Save, and Sender. Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf. ## Canned Message Module Config Values @@ -23,7 +23,7 @@ Enables the canned message module. Sends a bell character with each message. The [External Notification Module](external-notification) can be set up to beep when a new message arrives. -This module can also be configured to beep only when message contains the bell character. +This module can also be configured to beep only when message contains the bell character. ### Messages @@ -33,12 +33,12 @@ The list of pre-set messages, up to 200 bytes. Input event sources accepted by the canned message module. -| Value | Description | -| :----------: | :---------------------------------------------------------------------: | -| `_any` | Default. Allows any peripheral input device connected to the device. | -| `rotEnc1` | Basic Rotary Encoder | -| `upDownEnc1` | Up Down Encoder (use this also for RAK14006 Rotary Encoder) | -| `cardkb` | M5 Stack CardKB (this covers RAK14004 Keymatrix) | +| Value | Description | +| :----------: | :------------------------------------------------------------------: | +| `_any` | Default. Allows any peripheral input device connected to the device. | +| `rotEnc1` | Basic Rotary Encoder | +| `upDownEnc1` | Up Down Encoder (use this also for RAK14006 Rotary Encoder) | +| `cardkb` | M5 Stack CardKB (this covers RAK14004 Keymatrix) | ### Rotary Encoder Enabled @@ -106,25 +106,25 @@ All canned message module config options are available on iOS, iPadOS and macOS :::info -All canned message module config options are available in the python CLI. +All canned message module config options are available in the python CLI. ::: Example commands are below: -| Setting | Acceptable Values | Default | -| :--------------------------------------: | :---------------: | :-----------: | -| canned_message.enabled | `true`, `false` | `false` | -| canned_message.send_bell | `true`, `false` | `false` | -| canned_message.allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb` | `_any` | -| canned_message.messages | `string` | `""` | -| (Messages)\* | `string` | `""` | -| canned_message.inputbroker_event_cw | `InputEventChar` | (not defined) | -| canned_message.inputbroker_event_ccw | `InputEventChar` | (not defined) | -| canned_message.inputbroker_event_press | `InputEventChar` | (not defined) | -| canned_message.inputbroker_pin_a | `integer` | (not defined) | -| canned_message.inputbroker_pin_b | `integer` | (not defined) | -| canned_message.inputbroker_pin_press | `integer` | (not defined) | +| Setting | Acceptable Values | Default | +| :------------------------------------: | :---------------------------------------: | :-----------: | +| canned_message.enabled | `true`, `false` | `false` | +| canned_message.send_bell | `true`, `false` | `false` | +| canned_message.allow_input_source | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb` | `_any` | +| canned_message.messages | `string` | `""` | +| (Messages)\* | `string` | `""` | +| canned_message.inputbroker_event_cw | `InputEventChar` | (not defined) | +| canned_message.inputbroker_event_ccw | `InputEventChar` | (not defined) | +| canned_message.inputbroker_event_press | `InputEventChar` | (not defined) | +| canned_message.inputbroker_pin_a | `integer` | (not defined) | +| canned_message.inputbroker_pin_b | `integer` | (not defined) | +| canned_message.inputbroker_pin_press | `integer` | (not defined) | :::tip @@ -188,13 +188,14 @@ meshtastic --set canned_message.inputbroker_event_ccw "" meshtastic --set canned_message.inputbroker_event_press KEY_SELECT meshtastic --set canned_message.inputbroker_event_press "" ``` + :::info All canned message module config options are available in the Web UI. ::: - + @@ -227,7 +228,7 @@ Just use UP/DOWN/ENTER to select a predefined message and send it. ### Rotary encoder -Meshtastic supports hardwired rotary encoders as input devices. +Meshtastic supports hardwired rotary encoders as input devices. You will need a generic rotary encoder. The types listed below has five legs where two is dedicated to a "press" action, but any other types will likely do the job. You can also use a three-legged version, where the "press" action should be wired from an independent switch. @@ -241,7 +242,7 @@ You will need a generic rotary encoder. The types listed below has five legs whe Connect your rotary encoder as follows. The rotary encoder has two rows of legs. One of the rows contains two legs, the other contains three legs. Bottom side view: -``` +```text B o --- o PRESS GND o | | A o --- o GND @@ -251,7 +252,7 @@ The two legs is to sense the press action (or push). Connect one of the two to G The three legs is to sense the rotation action. Connect the middle leg to GROUND and the ones on the side to GPIO pins. Let's call these ports 'A' and 'B', according to the scheme below. -``` +```text A --|| GND --||]======== B --|| @@ -267,7 +268,6 @@ Recommended GPIO pins for connecting a rotary encoder. There is a reference case 3D-design utilizing the rotary encoder for TTGO LoRa V1: [Case for TTGO-ESP32-LORA-OLED-v1.0 with rotary encoder](https://www.thingiverse.com/thing:5178495) - ## Examples - Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step. @@ -286,6 +286,4 @@ meshtastic --set canned_message.inputbroker_event_press KEY_SELECT meshtastic --set canned_message.rotary1_enabled True ``` - That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Module. - diff --git a/docs/configuration/module-config/external-notification.mdx b/docs/configuration/module-config/external-notification.mdx index e4be42ff..45e3de9d 100644 --- a/docs/configuration/module-config/external-notification.mdx +++ b/docs/configuration/module-config/external-notification.mdx @@ -5,12 +5,12 @@ slug: /settings/moduleconfig/external-notification sidebar_label: External Notification --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network. - ## External Notification Module Config Values +## External Notification Module Config Values ### Enabled @@ -80,8 +80,8 @@ All external notification module config options are available in the python CLI. ::: -| Setting | Acceptable Values | Default | -| :----------------------------: | :----------------------: | :-----: | +| Setting | Acceptable Values | Default | +| :---------------------------------: | :----------------------: | :-----: | | external_notification.enabled | `true`, `false` | `false` | | external_notification.active | `true`, `false` | `false` | | external_notification.alert_bell | `true`, `false` | `false` | @@ -127,13 +127,14 @@ meshtastic --set external_notification.output 21 meshtastic --set external_notification.output_ms 0 meshtastic --set external_notification.output_ms 1500 ``` + :::info All External Notification module config is available for the Web UI. ::: - + diff --git a/docs/configuration/module-config/index.mdx b/docs/configuration/module-config/index.mdx index 54587c7f..24bc612e 100644 --- a/docs/configuration/module-config/index.mdx +++ b/docs/configuration/module-config/index.mdx @@ -8,13 +8,13 @@ sidebar_position: 3 Modules are included in the firmware and allow users to extend the functionality of their mesh or device. -| Name | Description | -|:----:|:-----------:| -| [Audio](/docs/settings/moduleconfig/audio) | enable Support for Codec2 Voice Comms on certain devices | -| [Canned Message](/docs/settings/moduleconfig/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | -| [External Notification](/docs/settings/moduleconfig/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | -| [MQTT](/docs/settings/moduleconfig/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | -| [Range Test](/docs/settings/moduleconfig/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | -| [Serial Module](/docs/settings/moduleconfig/serial) | Send messages across the mesh by sending strings over a serial port. | -| [Telemetry](/docs/settings/moduleconfig/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. | -| [Traceroute](/docs/settings/moduleconfig/traceroute) | Track which nodes are used to hop a message to a certain destination. | \ No newline at end of file +| Name | Description | +| :------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | +| [Audio](/docs/settings/moduleconfig/audio) | enable Support for Codec2 Voice Comms on certain devices | +| [Canned Message](/docs/settings/moduleconfig/canned-message) | Set a number of predefined messages to send out directly from the device with the use of an input device like a rotary encoder. | +| [External Notification](/docs/settings/moduleconfig/external-notification) | Incoming messages are able to alert you using circuits you attach to the device (LEDs, Buzzers, etc) | +| [MQTT](/docs/settings/moduleconfig/mqtt) | Forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on another mesh over the internet. | +| [Range Test](/docs/settings/moduleconfig/range-test) | Send messages with GPS location at an interval to test the distance your devices can communicate. Requires (at least) one device set up as a sender and one as a receiver. The receiver(s) will log all incoming messages to a CSV. | +| [Serial Module](/docs/settings/moduleconfig/serial) | Send messages across the mesh by sending strings over a serial port. | +| [Telemetry](/docs/settings/moduleconfig/telemetry) | Attach sensors to the device and transmit readings on a regular interval to the mesh. | +| [Traceroute](/docs/settings/moduleconfig/traceroute) | Track which nodes are used to hop a message to a certain destination. | diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index bf16ee79..66c00573 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -5,8 +5,8 @@ slug: /settings/moduleconfig/mqtt sidebar_label: MQTT --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must be enabled as uplink and/or downlink for protobufs to be transmitted from and/or to the mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings the node will still connect to MQTT server and send status messages. @@ -14,7 +14,7 @@ The MQTT module config options are: Enabled, Server Address, Username, Password, ## Settings - ## MQTT Module Config Values +## MQTT Module Config Values ### Enabled @@ -78,14 +78,14 @@ All MQTT module config options are available in the python CLI. Example commands ::: -| Setting | Acceptable Values | Default | -| :--------------------------: | :----------------------: | :-----: | -| mqtt.enabled | `true`, `false` | `false` | -| mqtt.address | `string` | | -| mqtt.username | `string` | | -| mqtt.password | `string` | | -| mqtt.encryption_enabled | `string` | | -| mqtt.json_enabled | `true`, `false` | `false` | +| Setting | Acceptable Values | Default | +| :---------------------: | :---------------: | :-----: | +| mqtt.enabled | `true`, `false` | `false` | +| mqtt.address | `string` | | +| mqtt.username | `string` | | +| mqtt.password | `string` | | +| mqtt.encryption_enabled | `string` | | +| mqtt.json_enabled | `true`, `false` | `false` | :::tip @@ -113,6 +113,6 @@ meshtastic --set mqtt.json_enabled false :::info All MQTT module config options are available for the Web UI. ::: - + diff --git a/docs/configuration/module-config/range-test.mdx b/docs/configuration/module-config/range-test.mdx index 5b8835de..6f1cacdb 100644 --- a/docs/configuration/module-config/range-test.mdx +++ b/docs/configuration/module-config/range-test.mdx @@ -18,9 +18,7 @@ The range test module config options are: Enabled, Save, and Sender. Range Test Enables the range test module. -### Save CSV File - -**ESP32 Only Setting** +### Save CSV File `ESP32 Only Setting` If enabled, we will save a log of all received messages to a file named rangetest.csv which you can access from the web server Extensions > File Browser > rangetest.csv. The file will be created after receiving messages. The device will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage. diff --git a/docs/configuration/module-config/serial.mdx b/docs/configuration/module-config/serial.mdx index 5f648637..ad724edb 100644 --- a/docs/configuration/module-config/serial.mdx +++ b/docs/configuration/module-config/serial.mdx @@ -5,16 +5,15 @@ slug: /settings/moduleconfig/serial sidebar_label: Serial --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO and Sender. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf. +The serial module config options are: Enabled, Echo, Mode, Receive GPIO, Transmit GPIO and Sender. Serial Module config uses an admin message sending a `ConfigModule.Serial` protobuf. This is a simple interface to send messages over the mesh network by sending strings over a serial port. Anything you send the node will be turned into a message sent out over the mesh, and anything received from the mesh will be sent to the serial port. Note that this module does not (yet) allow arbitrary protobuf commands to be sent over the serial connection. ![image](https://user-images.githubusercontent.com/9000580/205529843-962c3187-8411-452c-b729-42c58b1571f5.png) - ## Serial Module Config Values ### Enabled @@ -31,11 +30,11 @@ Defaults to 'Simple'. Available Values: -* `DEFAULT` -* `SIMPLE` operate as an dumb UART tunnel. What goes in will come out, Requires a channel named 'serial'. -* `PROTO` Exposes the Protobuf Client API on this serial port. You can use this to connect from another device. [API Reference](/docs/development/device/client-api) -* `TEXTMSG` Will send the string received over the serial port as a Text Message for Display on the other devices. -* `NMEA` Will output a NMEA 0183 Data stream containing the internal GPS or fixed position and other node locations as Waypoints (WPL). +- `DEFAULT` +- `SIMPLE` operate as an dumb UART tunnel. What goes in will come out, Requires a channel named 'serial'. +- `PROTO` Exposes the Protobuf Client API on this serial port. You can use this to connect from another device. [API Reference](/docs/development/device/client-api) +- `TEXTMSG` Will send the string received over the serial port as a Text Message for Display on the other devices. +- `NMEA` Will output a NMEA 0183 Data stream containing the internal GPS or fixed position and other node locations as Waypoints (WPL). ### Receive GPIO Pin @@ -99,15 +98,15 @@ All serial module config options are available in the python CLI. Example comman ::: -| Setting | Acceptable Values | Default | -| :-------------------: | :-----------------: | :-----: | -| serial.enabled | `true`, `false` | `false` | -| serial.echo | `true`, `false` | `false` | -| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG`, `NMEA` | `DEFAULT` | -| serial.rxd | GPIO Pin Number 1-39 | Default of `0` is Unset | -| serial.txd | GPIO Pin Number 1-33 | Default of `0` is Unset | -| serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` | -| serial.timeout | `integer` (milli seconds) | Default of `0` corresponds to 250 ms | +| Setting | Acceptable Values | Default | +| :------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------: | +| serial.enabled | `true`, `false` | `false` | +| serial.echo | `true`, `false` | `false` | +| serial.mode | `DEFAULT` `SIMPLE` `PROTO` `TEXTMSG`, `NMEA` | `DEFAULT` | +| serial.rxd | GPIO Pin Number 1-39 | Default of `0` is Unset | +| serial.txd | GPIO Pin Number 1-33 | Default of `0` is Unset | +| serial.baud | `BAUD_DEFAULT` `BAUD_110` `BAUD_300` `BAUD_600` `BAUD_1200` `BAUD_2400` `BAUD_4800` `BAUD_9600` `BAUD_19200` `BAUD_38400` `BAUD_57600` `BAUD_115200` `BAUD_230400` `BAUD_460800` `BAUD_576000` `BAUD_921600` | `BAUD_DEFAULT` | +| serial.timeout | `integer` (milli seconds) | Default of `0` corresponds to 250 ms | :::tip @@ -170,7 +169,8 @@ This module requires attaching a peripheral accessory to your device. It will no ## Examples Default is to use RX GPIO 16 and TX GPIO 17. -### Basic Usage: + +### Basic Usage 1. Enable the module by setting `serial.enabled` to `1`. 2. Set the pins (`serial.rxd` / `serial.txd`) for your preferred RX and TX GPIO pins. On tbeam boards it is recommended to use: @@ -180,24 +180,28 @@ Default is to use RX GPIO 16 and TX GPIO 17. 4. (Optional) set serial.mode to TEXTMSG if you want to send messages to/from the general text message channel 5. Connect to your device over the serial interface at `38400 8N1`. - With [tio](https://github.com/tio/tio) – `tio -e -b 38400 -f none /dev/myserialport` -7. Send a packet up to 237 bytes in length. This will get relayed over the mesh network. -8. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device. + With [tio](https://github.com/tio/tio) – `tio -e -b 38400 -f none /dev/myserialport` + +6. Send a packet up to 237 bytes in length. This will get relayed over the mesh network. +7. (Optional) Set `serial.echo` to `1` and any message you send out will be echoed back to your device. ### Interfacing PIR Sensor With External Microcontroller -The following is an example of using a Raspberry Pi Pico connected to a PIR sensor to detect motion. When motion is detected, a message is sent via. serial to the T-Beam. The T-Beam transmits the message as text over the default channel by utilizing the serial module in TXTMSG mode. + +The following is an example of using a Raspberry Pi Pico connected to a PIR sensor to detect motion. When motion is detected, a message is sent via. serial to the T-Beam. The T-Beam transmits the message as text over the default channel by utilizing the serial module in TXTMSG mode. #### BOM + - Raspberry Pi Pico running [CircuitPython](https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython) - T-Beam V1.1 running Meshtastic - PIR Sensor ([Adafruit Breadboard Model](https://www.adafruit.com/product/4871)) -#### Meshtastic Software Configuration: +#### Meshtastic Software Configuration + - Serial module enabled, mode: TXTMSG - GPIO Pins (For T-Beam) RX 13, TX 14 - 38400 Baud -#### Wiring: +#### Wiring ![image](https://user-images.githubusercontent.com/2799310/210852481-21ea76e5-ecaa-40c1-8f34-635ef2a1c95b.png) @@ -209,9 +213,10 @@ The following is an example of using a Raspberry Pi Pico connected to a PIR sens - GND pin 38 on the Pico to breadboard ground rail - 3V3 pin 36 on the Pico to the breadboard positive voltage rail - Optional, to power the Pico off of the T-Beam instead of USB: - - Connect 5V pin on T-Beam to Vbus pin 40 on the Pico + - Connect 5V pin on T-Beam to Vbus pin 40 on the Pico #### Circuit Python Code + ```python import time import board diff --git a/docs/configuration/module-config/telemetry.mdx b/docs/configuration/module-config/telemetry.mdx index 317aeb05..60ce0cb0 100644 --- a/docs/configuration/module-config/telemetry.mdx +++ b/docs/configuration/module-config/telemetry.mdx @@ -5,10 +5,10 @@ slug: /settings/moduleconfig/telemetry sidebar_label: Telemetry --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; -The Telemetry Module provides two types of data over the mesh. Device metrics (Battery Level, Voltage, Channel Utilization and Airtime) from your meshtastic device and Environment Metrics from attached I2C sensors. +The Telemetry Module provides two types of data over the mesh. Device metrics (Battery Level, Voltage, Channel Utilization and Airtime) from your meshtastic device and Environment Metrics from attached I2C sensors. Supported sensors connected to the I2C bus of the device will be automatically detected at startup. Environment Telemetry must be enabled for them to be instrumented and their readings sent over the mesh. @@ -16,19 +16,19 @@ The telemetry module config options are: Device Metrics Update Interval, Environ ### Currently Supported Sensor Types -| Sensor | I2C Address | Data Points | +| Sensor | I2C Address | Data Points | | :-----: | :--------------------: | :-----------------------------------------------------------: | -| BMP280 | 0x76, 0x77 | Temperature and barometric pressure | -| BME280 | 0x76, 0x77 | Temperature, barometric pressure and humidity | -| BME680 | 0x76, 0x77 | Temperature, barometric pressure, humidity and air resistance | -| MCP9808 | 0x18 | Temperature | -| INA260 | 0x40, 0x41 | Current and Voltage | -| INA219 | 0x40, 0x41 | Current and Voltage | -| LPS22 | 0x5D, 0x5c | Barometric pressure | -| SHTC3 | 0x70 | Temperature and humidity | -| SHT31 | 0x44 | Temperature and humidity | +| BMP280 | 0x76, 0x77 | Temperature and barometric pressure | +| BME280 | 0x76, 0x77 | Temperature, barometric pressure and humidity | +| BME680 | 0x76, 0x77 | Temperature, barometric pressure, humidity and air resistance | +| MCP9808 | 0x18 | Temperature | +| INA260 | 0x40, 0x41 | Current and Voltage | +| INA219 | 0x40, 0x41 | Current and Voltage | +| LPS22 | 0x5D, 0x5c | Barometric pressure | +| SHTC3 | 0x70 | Temperature and humidity | +| SHT31 | 0x44 | Temperature and humidity | -## Module Config Values +## Module Config Values ### Update Intervals @@ -101,13 +101,13 @@ All telemetry module config options are available in the python CLI. Example com ## Settings -| Setting | Acceptable Values | Default | -| :-----------------------------------------------------: | :-----------------: | :-----: | -| telemetry.device_update_interval | `integer` (seconds) | Default `0` is 15 minutes(`900` seconds). | -| telemetry.environment_display_fahrenheit | `true`, `false` | `false` | -| telemetry.environment_measurement_enabled | `true`, `false` | `false` | -| telemetry.environment_screen_enabled | `true`, `false` | `0` | -| telemetry.environment_update_interval | `integer` (seconds) | Default `0` is 15 minutes(`900` seconds). | +| Setting | Acceptable Values | Default | +| :---------------------------------------: | :-----------------: | :---------------------------------------: | +| telemetry.device_update_interval | `integer` (seconds) | Default `0` is 15 minutes(`900` seconds). | +| telemetry.environment_display_fahrenheit | `true`, `false` | `false` | +| telemetry.environment_measurement_enabled | `true`, `false` | `false` | +| telemetry.environment_screen_enabled | `true`, `false` | `0` | +| telemetry.environment_update_interval | `integer` (seconds) | Default `0` is 15 minutes(`900` seconds). | :::tip @@ -125,7 +125,7 @@ meshtastic --set telemetry.device_update_interval 0 meshtastic --set telemetry.device_update_interval 0 // Environment Metrics Two Minutes meshtastic --set telemetry.environment_update_interval 120 -```` +``` ```shell title="Enable/Disable Environment Module" meshtastic --set telemetry.environment_measurement_enabled true @@ -140,7 +140,7 @@ meshtastic --set telemetry.environment_screen_enabled false ```shell title="Enable / Disable Display Fahrenheit" meshtastic --set telemetry.environment_display_fahrenheit true meshtastic --set telemetry.environment_display_fahrenheit false -```` +``` @@ -150,7 +150,7 @@ meshtastic --set telemetry.environment_display_fahrenheit false All telemetry module config options are available in the Web UI. ::: - + @@ -195,15 +195,15 @@ And examine the serial logs for Telemetry diagnostic information. ### Environment Metrics -The environment metrics in the telemetry module supports a limited amount of fields as they are stored in memory on the device. Support for sensors that provide one or more of the following fields can potentially be added to the main firmware provided there is a GPL licensed library for us to include to support it, and the library size is not prohibitive. +The environment metrics in the telemetry module supports a limited amount of fields as they are stored in memory on the device. Support for sensors that provide one or more of the following fields can potentially be added to the main firmware provided there is a GPL licensed library for us to include to support it, and the library size is not prohibitive. -* Temperature -* Relative Humidity -* Barometric Pressure -* Gas Resistance (AQI) -* Voltage -* Current +- Temperature +- Relative Humidity +- Barometric Pressure +- Gas Resistance (AQI) +- Voltage +- Current ### Supporting Other Sensor types -For other interesting sensor types and use cases we need to add a portnum for more generic telemetry packets and a second MCU will be required to interact with the sensor and process the data to be sent over the mesh. This data will not be stored in the nodedb on the device. +For other interesting sensor types and use cases we need to add a portnum for more generic telemetry packets and a second MCU will be required to interact with the sensor and process the data to be sent over the mesh. This data will not be stored in the nodedb on the device. diff --git a/docs/configuration/module-config/traceroute.mdx b/docs/configuration/module-config/traceroute.mdx index a6579595..17696554 100644 --- a/docs/configuration/module-config/traceroute.mdx +++ b/docs/configuration/module-config/traceroute.mdx @@ -5,14 +5,14 @@ slug: /settings/moduleconfig/traceroute sidebar_label: Traceroute --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; Due to the limited bandwidth of LoRa, Meshtastic does not keep track of the nodes a message used to hop to the destination. However, from firmware 2.0.8 on, there is a Traceroute Module that can show you this. Only nodes that know the encryption key of the channel you use can be tracked. Also note that a message may arrive via multiple routes due to duplication because of rebroadcasting. This module will only track the hops of the first packet containing the traceroute request that arrived at the destination. -In order to use it, make sure your devices use firmware version 2.0.8 or higher. +In order to use it, make sure your devices use firmware version 2.0.8 or higher. ## Traceroute Module Client Availability @@ -32,7 +32,7 @@ Not yet implemented. -Make sure the app is at least version 2.0.9. +Make sure the app is at least version 2.0.9. Under Contacts > Direct Messages, long hold a destination node and select 'Trace Route' to send the request. Depending on the amount of hops that is needed, this might take a while. The result will be shown in the Mesh Log. @@ -61,6 +61,6 @@ The first ID shown is the device you are connected to with the CLI. As you can s Not yet implemented. - + - \ No newline at end of file + diff --git a/docs/configuration/rak-gpio-mapping.mdx b/docs/configuration/rak-gpio-mapping.mdx index 2a2ecac8..8cbc0337 100644 --- a/docs/configuration/rak-gpio-mapping.mdx +++ b/docs/configuration/rak-gpio-mapping.mdx @@ -9,28 +9,28 @@ sidebar_position: 5 The RAK4631 uses symbolic labels for its I/O Pins on the module and baseboard silk screens. The following table shows the mapping of the RAK4631 GPIO pins to the corresponding Arduino pins and the MCU Port numbers. -| RAK Pin | nRF52840 Pin | Arduino GPIO | Remark | -| ------- | ------------ | ------------ | ------ | -| IO1 | P0.17 | 17 | used for GPS PPM signal if GPS module is connected | -| IO2 | P1.02 | 34 | used to power all peripheral modules, not available for user application | -| IO3 | P0.21 | 21 | -| IO4 | P0.04 | 4 | -| IO5 | P0.09 | 9 | The 'User Button' is mapped here. | -| IO6 | P0.10 | 10 | -| IO7 | P0.28 | 28 | -| SW1 | P0.01 | 1 | -| A0 | P0.04/AIN2 | A2 | -| A1 | P0.31/AIN7 | A7 | -| SPI_CS | P0.26 | 26 | +| RAK Pin | nRF52840 Pin | Arduino GPIO | Remark | +| ------- | ------------ | ------------ | ------------------------------------------------------------------------ | +| IO1 | P0.17 | 17 | used for GPS PPM signal if GPS module is connected | +| IO2 | P1.02 | 34 | used to power all peripheral modules, not available for user application | +| IO3 | P0.21 | 21 | +| IO4 | P0.04 | 4 | +| IO5 | P0.09 | 9 | The 'User Button' is mapped here. | +| IO6 | P0.10 | 10 | +| IO7 | P0.28 | 28 | +| SW1 | P0.01 | 1 | +| A0 | P0.04/AIN2 | A2 | +| A1 | P0.31/AIN7 | A7 | +| SPI_CS | P0.26 | 26 | When configuring GPIO pins in your device settings, the Arduino GPIO numbers should be used. ```shell title="Example" meshtastic --set external_notification.output 10 ``` + This will use IO6 on a RAK4631 :::caution Note There is no usable GPIO pin on any RAK base board except the 'big' baseboard RAK19001 without adding a RAK13002 IO module or a third party IO sensor breakout. ::: - diff --git a/docs/development/android.mdx b/docs/development/android.mdx index 2a945d2a..a594cd8d 100644 --- a/docs/development/android.mdx +++ b/docs/development/android.mdx @@ -12,12 +12,12 @@ If you would like to develop this application we'd love your help! These build i 1. Use Android Studio to build/debug 2. Use `git submodule update --init --recursive` to pull in the various sub-modules we depend on. 3. There are a few config files which you'll need to copy from templates included in the project. Run the following commands to do so: - ```sh - rm ./app/google-services.json - cp ./app/google-services-example.json ./app/google-services.json - rm ./app/src/main/res/values/curfirmwareversion.xml - cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/ - ``` + ```shell + rm ./app/google-services.json + cp ./app/google-services-example.json ./app/google-services.json + rm ./app/src/main/res/values/curfirmwareversion.xml + cp ./app/special/curfirmwareversion.xml ./app/src/main/res/values/ + ``` 4. Now you should be able to select "Run / Run" in the IDE and it will happily start running on your phone or the emulator. :::note @@ -30,15 +30,16 @@ Analytics are included but can be disabled by the user on the settings screen. 1. Configure analytics for development device - ```sh - adb shell setprop debug.firebase.analytics.app com.geeksville.mesh - adb shell setprop log.tag.FirebaseCrashlytics DEBUG - ``` + ```shell + adb shell setprop debug.firebase.analytics.app com.geeksville.mesh + adb shell setprop log.tag.FirebaseCrashlytics DEBUG + ``` + 2. Set verbose logging - ```sh - adb shell setprop log.tag.FA VERBOSE - ``` + ```shell + adb shell setprop log.tag.FA VERBOSE + ``` ## Publish to Google Play @@ -47,20 +48,19 @@ Only available for core developers that publish releases. ::: 1. Add repository secrets: - - **KEYSTORE_FILENAME** - - Name of the `.jks` - - **KEYSTORE** - - Convert the `.jks` to base64: - ```sh - openssl base64 < filename.jks | tr -d '\n' | tee filename.txt - ``` - - **KEYSTORE_PROPERTIES** - - `storePassword=nononononono` - - `keyPassword=nononononono` - - `keyAlias=upload` - - `storeFile=nononononono.jks` + - **KEYSTORE_FILENAME** + - Name of the `.jks` + - **KEYSTORE** + - Convert the `.jks` to base64: + ```shell + openssl base64 < filename.jks | tr -d '\n' | tee filename.txt + ``` + - **KEYSTORE_PROPERTIES** + - `storePassword=nononononono` + - `keyPassword=nononononono` + - `keyAlias=upload` + - `storeFile=nononononono.jks` 2. Update protobufs 3. Go to Actions / Make Release / Run Workflow 4. Pick the Releases branch 5. Enter the version found in `app/gradle.build` - diff --git a/docs/development/device/client-api.mdx b/docs/development/device/client-api.mdx index 08ccf623..5dc992c0 100644 --- a/docs/development/device/client-api.mdx +++ b/docs/development/device/client-api.mdx @@ -27,7 +27,6 @@ The 4 byte header is constructed to both provide framing and to not look line 'n The receiver will validate length and if >512 it will assume the packet is corrupted and return to looking for START1. While looking for START1 any other characters are printed as "debug output". For small example implementation of this reader see the python implementation. - ## Bluetooth (MeshBluetoothService) This is the main Bluetooth service for the device and provides the API your app should use to get information about the mesh, send packets, or provision the radio. diff --git a/docs/development/device/http-api.mdx b/docs/development/device/http-api.mdx index 72ca9c42..833dfc13 100644 --- a/docs/development/device/http-api.mdx +++ b/docs/development/device/http-api.mdx @@ -36,15 +36,15 @@ Two endpoints are specified: Allows `PUT` and `OPTION` requests. -#### PUT +#### PUT -A `PUT` request to this endpoint will be expected to contain a series of ToRadio protobuf payloads. +A `PUT` request to this endpoint will be expected to contain a series of ToRadio protobuf payloads. The protobufs will be sent in binary as the body for the request. For the initial implementation, only one ToRadio message per request is supported, but future optimizations to improve throughput might add support for multiple ToRadios in a single request. -#### OPTIONS +#### OPTIONS An `OPTIONS`request to this endpoint will return a response status code `204` and headers only. @@ -52,7 +52,7 @@ An `OPTIONS`request to this endpoint will return a response status code `204` an Allows `GET` requests. -#### GET +#### GET A `GET` request from this endpoint will return a series of FromRadio protobufs. @@ -61,12 +61,14 @@ The protobufs will be sent in binary as the body for the request. **Parameters** ##### **/api/v1/fromradio?all** + - `all=false` (unset default) - - Only one protobuf is returned. -- `all=true` + - Only one protobuf is returned. +- `all=true` - All available protobufs are returned. ##### **/api/v1/fromradio?chunked** + - `chunked=false` (unset default, not yet implemented) - The request returns all protobufs that can be delivered for the client's session (this would allow the client to poll by doing a series of requests). This is the only option that is supported in the initial release. - `chunked=true` (not yet implemented) diff --git a/docs/development/device/module-api.mdx b/docs/development/device/module-api.mdx index e7c93813..12c00a1b 100644 --- a/docs/development/device/module-api.mdx +++ b/docs/development/device/module-api.mdx @@ -27,7 +27,7 @@ The relevant bits of the class hierarchy are as follows: ### First Level: MeshModule - [src/mesh/MeshModule.h](http://github.com/meshtastic/firmware/tree/master/src/mesh/MeshModule.h) - you probably don't want to use this base-class directly. - + ### Second Level: SinglePortModule - [src/mesh/SinglePortModule.h](http://github.com/meshtastic/firmware/tree/master/src/mesh/SinglePortModule.h) - for modules that send/receive from a single port number (the normal case). @@ -66,10 +66,10 @@ A number of [key services](http://github.com/meshtastic/firmware/tree/master/src The easiest way to get started is: 1. [Build the firmware](/docs/development/firmware/build) codebase. -2. Copy the [ReplyModule](http://github.com/meshtastic/firmware/tree/master/src/modules/ReplyModule.cpp) as a template into `src/modules/`. - ```sh - cp src/modules/ReplyModule.* src/modules/YourModule.* - ``` +2. Copy the [ReplyModule](http://github.com/meshtastic/firmware/tree/master/src/modules/ReplyModule.cpp) as a template into `src/modules/`. + ```shell + cp src/modules/ReplyModule.* src/modules/YourModule.* + ``` 3. Change the port number from `PortNum_REPLY_APP` to `PortNum_PRIVATE_APP`. 4. Edit the `setupModules()` function located at `modules/Moduless.cpp` to add a call to create an instance of your module (see comment at head of that function). 5. Rebuild with your new module and install on the device. @@ -96,4 +96,3 @@ If you would like to use protocol buffers to define the structures you send over 1. Create a new `.proto` file in the protos directory. 2. Run `./bin/regen-protos.sh` to regenerate the C code for accessing the protocol buffers. If you don't have the required nanopb tool, follow the instructions printed by the script to get it. 3. Done! You can now use your new protobuf just like any of the existing protobufs in Meshtastic. - diff --git a/docs/development/documentation/index.mdx b/docs/development/documentation/index.mdx index 6e7bc0ef..f00a565c 100644 --- a/docs/development/documentation/index.mdx +++ b/docs/development/documentation/index.mdx @@ -25,7 +25,7 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for | Getting Started | `docs/getting-started` | Instructions on how to get the Meshtastic firmware onto a users device. | | Device Settings | `docs/software/settings` | Details each user setting and provides explanations for what the setting does and how to configure the device using the various clients available (Android, CLI, iOS, Web) | | Hardware Details | `docs/hardware` | Any hardware related content. Any time a user is attaching a peripheral accessory to their device. That includes 3D printed cases, antennas, buttons, chimes, rotary encoders, and screens. | -| Radio Mesh Details | `docs/mesh` | This section discusses everything relating to the Meshtastic mesh. Mesh health metrics will be discussed here as well as topics such as signal strength, range and anything else pertaining to "over the air". | +| Radio Mesh Details | `docs/mesh` | This section discusses everything relating to the Meshtastic mesh. Mesh health metrics will be discussed here as well as topics such as signal strength, range and anything else pertaining to "over the air". | | Contribute to Meshtastic | `docs/developers` | Details each of the projects and how they work together to give a developer an idea of how the Meshtastic ecosystem operates. | | About the Documentation | `docs/maintaining-documentation` | This section explains how our documentation is organized, how to make edits to the documentation, view a local copy of your fork of the project. Style guides and tips will also be included here. | | Legal | `docs/legal` | Any legal information. Most changes here will be handled by developers actually working on the projects that require any legal disclosures. Examples include: the Meshtastic trademark, terms of service, and privacy policy. | @@ -34,31 +34,31 @@ Another component that we use is [Vercel](https://vercel.com) — a platform for Assuming you have the [prerequisites installed](/docs/development/documentation/local-dev#prerequisites), running a local instance of Docusaurus takes three steps: -1. Fork/Clone the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository and navigate to the root directory of the project. +1. Fork/Clone the [meshtastic/meshtastic](https://github.com/meshtastic/meshtastic) repository and navigate to the root directory of the project. -```shell title="Clone the project" -git clone https://github.com/meshtastic/meshtastic.git -``` + ```shell title="Clone the project" + git clone https://github.com/meshtastic/meshtastic.git + ``` -```shell title="Clone fork of the project" -git clone https://github.com/[username]/meshtastic.git -``` + ```shell title="Clone fork of the project" + git clone https://github.com/[username]/meshtastic.git + ``` -```shell title="Change Directory" -cd ~/Meshtastic -``` + ```shell title="Change Directory" + cd ~/Meshtastic + ``` -2. Install Dependencies +2. Install Dependencies -```shell title="Install dependencies using Yarn" -yarn install -``` + ```shell title="Install dependencies using Yarn" + yarn install + ``` -3. Run Docusaurus +3. Run Docusaurus -```shell title="Run node.js server" -yarn start -``` + ```shell title="Run node.js server" + yarn start + ``` :::tip Before submitting a pull request, it's helpful to run the following command to ensure there are no broken links or errors: diff --git a/docs/development/documentation/publish.mdx b/docs/development/documentation/publish.mdx index f3471b2c..abfb203a 100644 --- a/docs/development/documentation/publish.mdx +++ b/docs/development/documentation/publish.mdx @@ -7,14 +7,18 @@ sidebar_label: Publish ## Publish Live 1. Generate protobuf docs - ```shell - cd meshtastic - ./scripts/gen-proto-docs.sh - ``` + + ```shell + cd meshtastic + ./scripts/gen-proto-docs.sh + ``` + 2. Build - ```shell - pnpm build - ``` + + ```shell + pnpm build + ``` + 3. Submit Pull Request ## Publish to Vercel @@ -48,4 +52,3 @@ There is a limited number of branch urls that you will be able to view. If you n Branch urls are helpful in PRs because they will remain constant, and you won't need to resubmit a new url for review each new commit if changes are requested. ::: - diff --git a/docs/development/documentation/style-guides/markdown-features.mdx b/docs/development/documentation/style-guides/markdown-features.mdx index c3ec3293..e4a5564a 100644 --- a/docs/development/documentation/style-guides/markdown-features.mdx +++ b/docs/development/documentation/style-guides/markdown-features.mdx @@ -4,7 +4,7 @@ title: Markdown Features sidebar_label: Markdown Features --- -import { Dark, Light } from '/src/components/ColorMode'; +import { Dark, Light } from "/src/components/ColorMode"; ## Overview @@ -14,7 +14,7 @@ We have developed several [React](https://reactjs.org/) components for assisting ### Light/Dark Mode Switch -#### Usage: +#### Usage ```jsx import { Dark, Light } from '/src/components/ColorMode'; @@ -27,7 +27,7 @@ import { Dark, Light } from '/src/components/ColorMode'; ``` -#### Demo: +#### Demo
@@ -50,7 +50,7 @@ import { Dark, Light } from '/src/components/ColorMode'; ### Code Blocks -#### Usage: +#### Usage Always specify the language used directly after the start of the code block (```). @@ -71,13 +71,13 @@ export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => { ``` ```` -#### Demo: +#### Demo ```ts title="Demo" export const typedArrayToBuffer = (array: Uint8Array): ArrayBuffer => { return array.buffer.slice( array.byteOffset, - array.byteLength + array.byteOffset, + array.byteLength + array.byteOffset ); }; ``` diff --git a/docs/development/firmware/building.mdx b/docs/development/firmware/building.mdx index 500c0864..f5cd4113 100644 --- a/docs/development/firmware/building.mdx +++ b/docs/development/firmware/building.mdx @@ -10,7 +10,7 @@ Meshtastic uses [PlatformIO](https://platformio.org), a development environment 1. [Install PlatformIO](https://platformio.org/platformio-ide) 2. Clone the [Meshtastic Firmware](https://github.com/meshtastic/firmware) repository - ```sh + ```shell git clone https://github.com/meshtastic/firmware.git ``` 3. Update the repository's [submodules](https://github.com/meshtastic/firmware/blob/master/.gitmodules) diff --git a/docs/development/firmware/oled-guide.mdx b/docs/development/firmware/oled-guide.mdx index 8ebc19ad..df26cd67 100644 --- a/docs/development/firmware/oled-guide.mdx +++ b/docs/development/firmware/oled-guide.mdx @@ -4,32 +4,35 @@ title: OLED Localization Guide sidebar_label: OLED Localization --- -1. Create an extended ASCII custom font. Use a glyph editor to create a new font file. The easiest way is to use the online [glyph editor](https://rawgit.com/ThingPulse/esp8266-oled-ssd1306/master/resources/glyphEditor.html) from the OLED library. ([glyph editor source code](https://github.com/ThingPulse/esp8266-oled-ssd1306/tree/master/resources)) - 1. Copy and paste the existing font. - 2. Modify it according desired codepage and save the new font file in `graphics/font` folder. - Please note that the used font file format differs from common Adafruit GFX. +1. Create an extended ASCII custom font. Use a glyph editor to create a new font file. The easiest way is to use the online [glyph editor](https://rawgit.com/ThingPulse/esp8266-oled-ssd1306/master/resources/glyphEditor.html) from the OLED library. ([glyph editor source code](https://github.com/ThingPulse/esp8266-oled-ssd1306/tree/master/resources)) + 1. Copy and paste the existing font. + 2. Modify it according desired codepage and save the new font file in `graphics/font` folder. + Please note that the used font file format differs from common Adafruit GFX. 2. Update the `customFontTableLookup` function in `Screen.h` - 1. To map the double-byte UTF-8 code to the corresponding extended ASCII character of the desired codepage update the `customFontTableLookup` function in the `Screen.h` file. - 2. Modify the `switch (last)` statement: use left byte from UTF-8 code in the `case` label to map charachter's right byte to its extended ASCII code by specifying an offset. + 1. To map the double-byte UTF-8 code to the corresponding extended ASCII character of the desired codepage update the `customFontTableLookup` function in the `Screen.h` file. + 2. Modify the `switch (last)` statement: use left byte from UTF-8 code in the `case` label to map charachter's right byte to its extended ASCII code by specifying an offset. 3. Define language and font in `Screen.cpp` - ```c - #ifdef OLED_{LANG_NAME} - #include "fonts/OLEDDisplayFonts{LANG_NAME}.h" - #endif - ... + ```c + #ifdef OLED_{LANG_NAME} + #include "fonts/OLEDDisplayFonts{LANG_NAME}.h" + #endif + + ... + + #ifdef OLED_{LANG_NAME} + #define FONT_SMALL ArialMT_Plain_10_{LANG_NAME} + #else + #define FONT_SMALL ArialMT_Plain_10 + #endif + ``` - #ifdef OLED_{LANG_NAME} - #define FONT_SMALL ArialMT_Plain_10_{LANG_NAME} - #else - #define FONT_SMALL ArialMT_Plain_10 - #endif - ``` 4. Define language in `variant/*/platformio.ini` - ``` - build_flags = - ${esp32_base.build_flags} - -D xxxxx - -D OLED_{LANG_NAME} - -I variants/xxxxx - ``` \ No newline at end of file + + ```text + build_flags = + ${esp32_base.build_flags} + -D xxxxx + -D OLED_{LANG_NAME} + -I variants/xxxxx + ``` diff --git a/docs/development/firmware/stacktraces.mdx b/docs/development/firmware/stacktraces.mdx index 2dcf45a5..cd5cf2bd 100644 --- a/docs/development/firmware/stacktraces.mdx +++ b/docs/development/firmware/stacktraces.mdx @@ -14,19 +14,21 @@ You may encounter a situation where your device crashes and are left with a stac This method uses the symbols of the `firmware.elf` file generated from your latest build, you may wish to rebuild to get up-to-date symbols. ::: - 1. Save the backtrace string to a text file: - ```text title="backtrace.txt" - Backtrace: 0x.... - ``` +1. Save the backtrace string to a text file: + + ```text title="backtrace.txt" + Backtrace: 0x.... + ``` 2. Run the exception decoder: - ```shell - bin/exception_decoder.py backtrace.txt - ``` + ```shell + bin/exception_decoder.py backtrace.txt + ``` ### In Real-Time In order to decode stack traces in real time, keep the following command (replacing `DEVICE_PORT` with your device's port) running in your terminal with the target device connected: + ```shell pio device monitor --port DEVICE_PORT -f esp32_exception_decoder ``` diff --git a/docs/development/js/connecting.mdx b/docs/development/js/connecting.mdx index aafbd231..0a3e99dd 100644 --- a/docs/development/js/connecting.mdx +++ b/docs/development/js/connecting.mdx @@ -5,17 +5,17 @@ sidebar_label: Connecting --- ```tsx -import type React from 'React'; +import type React from "React"; -import { IHTTPConnection } from '@meshtastic/meshtasticjs'; +import { IHTTPConnection } from "@meshtastic/meshtasticjs"; export const Connection = (): JSX.Element => { const connection = new IHTTPConnection(); const connect = (): void => { void connection.connect({ - address: '10.0.0.10', - fetchInterval: 3000, + address: "10.0.0.10", + fetchInterval: 3000 }); }; diff --git a/docs/development/js/http-api.mdx b/docs/development/js/http-api.mdx index 9fe2574a..d8584390 100644 --- a/docs/development/js/http-api.mdx +++ b/docs/development/js/http-api.mdx @@ -13,8 +13,8 @@ import { Client, Types, Protobuf, - SettingsManager, -} from '@meshtastic/meshtasticjs'; + SettingsManager +} from "@meshtastic/meshtasticjs"; /** * Connection method @@ -24,7 +24,7 @@ const client = new Client(); SettingsManager.setDebugMode(Protobuf.LogLevelEnum.DEBUG); const connection = client.createHTTPConnection(); -connection.connect('192.168.x.x'); +connection.connect("192.168.x.x"); const restartDevice: Promise = connection.restartDevice(); const getStatistics: Promise = diff --git a/docs/development/python/building.mdx b/docs/development/python/building.mdx index 7dd0da66..33bbdb78 100644 --- a/docs/development/python/building.mdx +++ b/docs/development/python/building.mdx @@ -12,7 +12,7 @@ No pre-requisites are needed locally to make a release. All builds are done via To test/validate, you will need to run: -``` +```shell pip3 install -r requirements.txt pip install . ``` @@ -25,7 +25,7 @@ pip install . connect one device to the serial port and run: -``` +```shell pytest -m smoke1 ``` @@ -41,8 +41,6 @@ pytest -m smoke1 You need permissions in the GitHub project to make a build ::: - - ### Meshtastic-flasher A `meshtastic-flasher` release consists of publishing the release to PyPi https://pypi.org/project/meshtastic-flasher/ as well as producing single-executable files that are downloadable from Github https://github.com/meshtastic/Meshtastic-gui-installer/releases. diff --git a/docs/development/python/index.mdx b/docs/development/python/index.mdx index 7aac3b58..f774c13a 100644 --- a/docs/development/python/index.mdx +++ b/docs/development/python/index.mdx @@ -9,41 +9,35 @@ sidebar_label: Python We use the Visual Studio Code (VScode) default python formatting conventions (autopep8). So if you use that IDE you should be able to use "Format Document" and not generate unrelated diffs. If you use some other editor, please do not change formatting on lines you have not changed yourself. - ### Building -**To build a new release** - -```sh +```shell title="To build a new release" apt install pandoc sudo pip3 install markdown pdoc3 webencodings pyparsing twine autopep8 pylint pytest pytest-cov ``` -**For development** - -```sh +```shell title="For development" pip3 install -r requirements.txt ``` ### Linting -```sh +```shell pylint meshtastic ``` + ### Testing -**Install and run pytest** +#### Install and run pytest -- For more verbosity, add `-v` or even `-vv` +- For more verbosity, add `-v` or even `-vv` -```sh +```shell pip3 install . pytest -vv ``` -**Run just unit tests** - -```sh +```shell title="Run just unit tests" pytest # or (more verbosely) pytest -m unit @@ -51,15 +45,11 @@ pytest -m unit make ``` -**Run just integration tests** - -```sh +```shell title="Run just integration tests" pytest -m int ``` -**Run the smoke test with only one device connected serially (aka smoke1)** - -```sh +```shell title="Run the smoke test with only one device connected serially (aka smoke1)" pytest -m smoke1 ``` @@ -68,21 +58,15 @@ Running `smoke1` will reset values on the device, including the region to 1 (US) Be sure to hit the reset button on the device after the test is completed. ::: -**Run the smoke test with only two device connected serially (aka smoke2)** - -```sh +```shell title="Run the smoke test with only two device connected serially (aka smoke2)" pytest -m smoke2 ``` -**Run the wifi smoke test** - -```sh +```shell title="Run the wifi smoke test" pytest -m smokewifi ``` -**Run a specific test** - -```sh +```shell title="Run a specific test" pytest -msmoke1 meshtastic/tests/test_smoke1.py::test_smoke1_info # or to run a specific smoke2 test @@ -96,9 +80,7 @@ pytest -m smokewifi meshtastic/tests/test_smoke_wifi.py::test_smokewifi_info See [pytest.ini](https://github.com/meshtastic/Meshtastic-python/blob/master/pytest.ini). -**To see the unit test code coverage** - -```sh +```shell title="To see the unit test code coverage" pytest --cov=meshtastic # or if want html coverage report pytest --cov-report html --cov=meshtastic @@ -106,9 +88,7 @@ pytest --cov-report html --cov=meshtastic make cov ``` -**To see slowest unit tests, you can run** - -```sh +```shell title="To see slowest unit tests, you can run" pytest --durations=0 # or make slow @@ -118,7 +98,7 @@ make slow Pre-generated: [API documentation](https://python.meshtastic.org) -```sh +```shell bin/regen-docs.sh ``` diff --git a/docs/development/reference/github.mdx b/docs/development/reference/github.mdx index def8c7d6..06db1853 100644 --- a/docs/development/reference/github.mdx +++ b/docs/development/reference/github.mdx @@ -24,6 +24,7 @@ Repobeats images can be generated at [repobeats.axiom.co](https://repobeats.axio + [![Crowdin](https://badges.crowdin.net/e//localized.svg)](https://crowdin.meshtastic.org/) [![CI](https://img.shields.io/github/actions/workflow/status/meshtastic//ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic//actions/workflows/ci.yml) [![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/)](https://cla-assistant.io/meshtastic/) diff --git a/docs/development/reference/lora-design.mdx b/docs/development/reference/lora-design.mdx index cd20d9e7..c6ed65eb 100644 --- a/docs/development/reference/lora-design.mdx +++ b/docs/development/reference/lora-design.mdx @@ -5,4 +5,4 @@ sidebar_label: LoRa Datasheet sidebar_position: 1 --- -- [LoRa Design Guide Datasheet](/documents/LoRa_Design_Guide.pdf) \ No newline at end of file +- [LoRa Design Guide Datasheet](/documents/LoRa_Design_Guide.pdf) diff --git a/docs/development/web/building.mdx b/docs/development/web/building.mdx index ca6ff64c..e44865f3 100644 --- a/docs/development/web/building.mdx +++ b/docs/development/web/building.mdx @@ -4,8 +4,7 @@ title: Building sidebar_label: Building --- - Releases are automatically generated for every commit as per out [CI](https://github.com/meshtastic/web/blob/master/.github/workflows/main.yml). This performs two actions: 1. Generates a perpetually updated [GitHub release](https://github.com/meshtastic/web/releases/tag/latest) with an accompanying `build.tar` that a automatically get's pulled by the firmware CI at build time. -2. A hosted version is deployed to [client.meshtastic.org](https://client.meshtastic.org). \ No newline at end of file +2. A hosted version is deployed to [client.meshtastic.org](https://client.meshtastic.org). diff --git a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx index 5688e7c7..722a6e75 100644 --- a/docs/getting-started/flashing-firmware/esp32/cli-script.mdx +++ b/docs/getting-started/flashing-firmware/esp32/cli-script.mdx @@ -5,8 +5,8 @@ sidebar_label: CLI Script sidebar_position: 3 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; :::caution Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! diff --git a/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx b/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx index 896192e8..4cfffcb4 100644 --- a/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx +++ b/docs/getting-started/flashing-firmware/esp32/external-serial-adapter.mdx @@ -5,8 +5,8 @@ sidebar_label: External Serial Adapter sidebar_position: 4 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; :::info This information will likely only be helpful if you've already attempted to go through the prerequisites and processes outlined in [meshtastic flasher](/docs/software/python/flasher) or [manually flashing](/docs/getting-started/flashing-firmware/esp32/cli-script) @@ -19,9 +19,10 @@ Make sure not to power the radio on without first attaching the antenna! You cou ## Background Situations that may require usage an external USB to Serial Adapter: -* Due to the chip shortage, recently purchased devices such as the TTGO T-Beam may come with legacy or non-standard USB to Serial adapter chips that are unreliable in some cases. -* Certain devices might have defective USB to Serial chip. -* Certain devices, such as the [Hydra](https://github.com/Hydra-Designs/project-hydra-meshtastic-pcb) (Meshtastic-DIY target). + +- Due to the chip shortage, recently purchased devices such as the TTGO T-Beam may come with legacy or non-standard USB to Serial adapter chips that are unreliable in some cases. +- Certain devices might have defective USB to Serial chip. +- Certain devices, such as the [Hydra](https://github.com/Hydra-Designs/project-hydra-meshtastic-pcb) (Meshtastic-DIY target). ### USB Serial Adapters @@ -38,18 +39,18 @@ Plug the adapter into your computer without connecting it to any devices yet. En :::info There are multiple ways to connect the pins of the adapter to the target device: pressing jumpers against contacts, using pogo pin jigs, etc. This tutorial features offset dupont headers soldered onto the operative GPIO pins and connected via jumpers. ::: -Disconnect your USB to Serial Adapter from the computer before starting this process. +Disconnect your USB to Serial Adapter from the computer before starting this process. 1. Connect the RX pin of the adapter to the TX pin of the devices 2. Connect the TX pin of the adapter to the RX pin of the device 3. Connect a GND pin of the adapter to the GND pin of the device 4. Connect either the 5V pin of the adapter to the 5V pin of the device (illustrated) or the 3.3V pin of the adapter to the 3.3V pin of device. 5. Bridge GPIO 0 to GND on the device with a jumper. (This places the device into flash mode when the device is powered up) - Example wiring featuring a T-Beam - ![image](https://user-images.githubusercontent.com/9000580/168446438-d14f34a0-b92d-4716-87fd-e0c2927a35fd.png) + Example wiring featuring a T-Beam + ![image](https://user-images.githubusercontent.com/9000580/168446438-d14f34a0-b92d-4716-87fd-e0c2927a35fd.png) 6. Connect the device to a USB port on the computer 7. Remove the jumper bridging GPIO 0 to GND - ![enter-flash-mode](https://user-images.githubusercontent.com/9000580/168446974-c31d3e9c-3397-4cb1-90a4-91ef2e4d5fac.gif) + ![enter-flash-mode](https://user-images.githubusercontent.com/9000580/168446974-c31d3e9c-3397-4cb1-90a4-91ef2e4d5fac.gif) ### Flashing @@ -62,14 +63,13 @@ After flashing the device is complete, reset your device (via the RST button if If you have the Meshtastic Python CLI installed, you can run `meshtastic --noproto` to connect the device again over the adapter and view the serial output to confirm Meshtastic installed correctly. ![image](https://user-images.githubusercontent.com/9000580/168447159-71a6546a-f487-4bc2-86c1-4c489b2a8975.png) - ### Troubleshooting In the Meshtastic Flasher, device detection may not work when using the external USB to Serial adapter. You might need to manually select the correct device type from the drop-down. ![image](https://user-images.githubusercontent.com/9000580/168447197-206f7e14-debe-4b6a-bb2a-7647418075e4.png) -Sometimes you might receive an error for COM port permission in the Meshtastic Flasher or the manual device install scripts, this can be caused by a number of different issues. +Sometimes you might receive an error for COM port permission in the Meshtastic Flasher or the manual device install scripts, this can be caused by a number of different issues. -You might need to run the process as an administrator, check to ensure software like Cura isn't monopolizing COM ports, or reboot. +You might need to run the process as an administrator, check to ensure software like Cura isn't monopolizing COM ports, or reboot. ![image](https://user-images.githubusercontent.com/9000580/168447232-1a3af39b-e3cc-44b9-bc3a-32843a9e6f1f.png) diff --git a/docs/getting-started/flashing-firmware/esp32/index.mdx b/docs/getting-started/flashing-firmware/esp32/index.mdx index af7d5fd9..1b9f1835 100644 --- a/docs/getting-started/flashing-firmware/esp32/index.mdx +++ b/docs/getting-started/flashing-firmware/esp32/index.mdx @@ -14,4 +14,4 @@ The recommended method for firmware flashing is the [Web-Based Installer.](https 1. The [Web-Based Installer](https://flasher.meshtastic.org) requires either Chrome or Edge browsers but is an excellent choice for quickly flashing devices. **This is the recommended method for firmware flashing, especially for those new to the project, due to its ease of use.** 2. The [Python Flasher](/docs/software/python/flasher) does a lot under the hood to prevent you from needing to use the terminal. 3. The [CLI Script](/docs/getting-started/flashing-firmware/esp32/cli-script) is considered the "manual process" for flashing firmware. -4. Flashing your device using an [external serial adapter](/docs/getting-started/flashing-firmware/esp32/external-serial-adapter) should only be attempted as a last resort if no other method has been successful. \ No newline at end of file +4. Flashing your device using an [external serial adapter](/docs/getting-started/flashing-firmware/esp32/external-serial-adapter) should only be attempted as a last resort if no other method has been successful. diff --git a/docs/getting-started/flashing-firmware/esp32/python-flasher.mdx b/docs/getting-started/flashing-firmware/esp32/python-flasher.mdx index 3515772d..ff3b9f1e 100644 --- a/docs/getting-started/flashing-firmware/esp32/python-flasher.mdx +++ b/docs/getting-started/flashing-firmware/esp32/python-flasher.mdx @@ -5,6 +5,6 @@ sidebar_label: Python Flasher sidebar_position: 2 --- -import MFlasher from '../../../software/python-flasher.mdx' +import MFlasher from "../../../software/python-flasher.mdx"; - \ No newline at end of file + diff --git a/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx b/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx index f86fd86b..79d6c4da 100644 --- a/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx +++ b/docs/getting-started/flashing-firmware/esp32/web-flasher.mdx @@ -9,4 +9,4 @@ sidebar_position: 1 1. Plug in your device 2. Visit [flasher.meshtastic.org](https://flasher.meshtastic.org) _\*requires Chrome or Edge browser_ -3. Follow the instructions \ No newline at end of file +3. Follow the instructions diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index f3c5f6d5..88d37153 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -6,9 +6,9 @@ slug: /getting-started sidebar_position: 2 --- -import Link from '@docusaurus/Link'; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Link from "@docusaurus/Link"; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; ## Identify Hardware @@ -44,7 +44,7 @@ Prior to connecting your Meshtastic device to the computer, you should perform t ### Verify data cable -Some cables only provide _charging_, verify that your cable is also capable of _transferring data_ before proceeding. +Some cables only provide _charging_, verify that your cable is also capable of _transferring data_ before proceeding. There is no definitive way to determine the difference in cables if you aren't willing to pull it apart. Trying out a few cables will be the best way to verify. @@ -78,7 +78,7 @@ Once you've located a working data cable, [install the correct serial driver](#i ### Test driver installation -You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test: +You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test: -1. Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. +1. Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. 2. You should see similar to one of the following entries: - - `CP210X USB to UART Bridge Controller` - - `CH9102 USB to UART Bridge Controller` - - `WisCore RAK4631 Board` + +- `CP210X USB to UART Bridge Controller` +- `CH9102 USB to UART Bridge Controller` +- `WisCore RAK4631 Board` 1. Navigate to `Device Manager > Ports (COM & LPT)` 2. You should see similar to one of the following entries: - - `Silicon Labs CP210X USB to UART Bridge (COM5)` - - `Silicon Labs CH9102 USB to UART Bridge (COM5)` - - `FIXME (WISBLOCK OUTPUT)` + +- `Silicon Labs CP210X USB to UART Bridge (COM5)` +- `Silicon Labs CH9102 USB to UART Bridge (COM5)` +- `FIXME (WISBLOCK OUTPUT)` @@ -132,7 +135,7 @@ If you do not see your device: 1. You may be using a charging-only cable, [verify your cable](#verify-data-cable). 2. You may need to [install the USB serial driver](/docs/getting-started/serial-drivers)). -::: + ::: ## Flash Firmware @@ -164,15 +167,15 @@ If you have a RAK4631-R (the RUI3 bootloader version of the RAK4631), you must [
- ## Connect and Configure Device After connecting to the device for the first time, you should set the regional settings for the radio as well as other optional settings such as the name of the device.
- Connect and Configure Device @@ -181,17 +184,21 @@ After connecting to the device for the first time, you should set the regional s ## Use Meshtastic ### with Command Line Tools - - [Python CLI](/docs/software/python/cli) + +- [Python CLI](/docs/software/python/cli) ### with mobile apps - - [Android](/docs/category/android-app) - - [Apple](/docs/category/apple-apps) + +- [Android](/docs/category/android-app) +- [Apple](/docs/category/apple-apps) ### with a browser - - https://client.meshtastic.org - - [Meshtastic Web](/docs/software/web-client) + +- https://client.meshtastic.org +- [Meshtastic Web](/docs/software/web-client) ### over the internet with MQTT - - [MQTT](/docs/software/mqtt/) -There are many ways to interact with and use Meshtastic, please visit the [Software](/docs/software) page for more information. \ No newline at end of file +- [MQTT](/docs/software/mqtt/) + +There are many ways to interact with and use Meshtastic, please visit the [Software](/docs/software) page for more information. diff --git a/docs/getting-started/initial-config.mdx b/docs/getting-started/initial-config.mdx index de17edd9..31346f7d 100644 --- a/docs/getting-started/initial-config.mdx +++ b/docs/getting-started/initial-config.mdx @@ -6,10 +6,9 @@ slug: /getting-started/initial-config sidebar_position: 4 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import LoRaRegions from '../blocks/_lora-regions.mdx'; - +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import LoRaRegions from "../blocks/_lora-regions.mdx"; ## Supported Clients per Connection Type @@ -36,7 +35,6 @@ values={[ - [Web Client](https://client.meshtastic.org) - [iOS App](/docs/category/apple-apps) - @@ -49,7 +47,6 @@ Connecting over network is only supported on ESP32 devices. - [iOS App](/docs/category/apple-apps) - [Python CLI](/docs/software/python/cli/) - @@ -57,7 +54,6 @@ Connecting over network is only supported on ESP32 devices. In order to start communicating over the mesh, you must set your region. This setting controls which frequency range your device uses and should be set according to your regional location. - 1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation) - ```sh - pip3 install --upgrade pytap2 - pip3 install --upgrade meshtastic - ``` + ```sh + pip3 install --upgrade pytap2 + pip3 install --upgrade meshtastic + ``` 2. Run the following command, replacing `` with the region code listed above according to your regional location. - ```sh - meshtastic --set lora.region - ``` + ```sh + meshtastic --set lora.region + ``` @@ -108,7 +104,3 @@ Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS ### Region Codes - - - - diff --git a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx index cb6d18c7..ed8213f5 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-esp32.mdx @@ -5,8 +5,8 @@ sidebar_label: ESP32 Drivers sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; ## Install ESP32 USB to Serial Drivers @@ -49,4 +49,4 @@ values={[ :::important Reboot your computer after you have installed the driver to complete the installation. -::: \ No newline at end of file +::: diff --git a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx index 60435e39..c67f0d3d 100644 --- a/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx +++ b/docs/getting-started/serial-drivers/serial-drivers-nrf52.mdx @@ -5,8 +5,8 @@ sidebar_label: NRF52 Drivers sidebar_position: 2 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; ## Install NRF52 USB to Serial Drivers @@ -64,4 +64,4 @@ Reboot your computer after you have installed the driver to complete the install - \ No newline at end of file + diff --git a/docs/hardware/antennas/antenna-report.mdx b/docs/hardware/antennas/antenna-report.mdx index 176c41f6..cb339e85 100644 --- a/docs/hardware/antennas/antenna-report.mdx +++ b/docs/hardware/antennas/antenna-report.mdx @@ -7,6 +7,6 @@ sidebar_position: 2 ## RicInNewMexico -[_RicInNewMexico_](https://github.com/RicInNewMexico) has gone through the trouble of testing a number of commonly purchased antennas in the Meshtastic community and given an opinion on whether or not a given antenna is performing optimally. +[_RicInNewMexico_](https://github.com/RicInNewMexico) has gone through the trouble of testing a number of commonly purchased antennas in the Meshtastic community and given an opinion on whether or not a given antenna is performing optimally. Please check out the project on Github: [Meshtastic-Antenna-Reports](https://github.com/RicInNewMexico/Meshtastic-Antenna-Reports) diff --git a/docs/hardware/antennas/lora-antennas.mdx b/docs/hardware/antennas/lora-antennas.mdx index 719c6c7c..62181642 100644 --- a/docs/hardware/antennas/lora-antennas.mdx +++ b/docs/hardware/antennas/lora-antennas.mdx @@ -28,7 +28,7 @@ Devices on another frequency will not be able to interact with yours. See this l ### How will you be carrying / transporting the radio? -A large directional antenna will transmit over significantly greater distance than an omni-directional antenna. However, it must be pointed at its target - so it is not optimal for mobile use. +A large directional antenna will transmit over significantly greater distance than an omni-directional antenna. However, it must be pointed at its target - so it is not optimal for mobile use. A tuned half-wave whip antenna may have more omni-directional range than the quarter wave stubby; but it will be conspicuous in your pocket. @@ -50,7 +50,7 @@ The perfect antenna on paper, sourced from the other side of the world with mixe ### How close will the antenna be to my Meshtastic device? -Most cables will significantly degrade the signal strength over any significant distance. It is often more effective to place a node outside than to have it indoors with the antenna outside. The exception might be if there is extreme heat, cold, or humidity, and if the shortest possible low loss cable is used. +Most cables will significantly degrade the signal strength over any significant distance. It is often more effective to place a node outside than to have it indoors with the antenna outside. The exception might be if there is extreme heat, cold, or humidity, and if the shortest possible low loss cable is used. Still, a proper enclosure should mitigate bad weather. @@ -58,4 +58,4 @@ Still, a proper enclosure should mitigate bad weather. You could do a lot worse than reading the [Wikipedia entry for Antenna](), along with the [Wikipedia entry for LoRa](https://en.wikipedia.org/wiki/LoRa). -Instead of listing the terms, let us recommend this superb [tutorial](https://www.youtube.com/watch?v=J3PBL9oLPX8) by Andreas Spiess (the 'guy with the Swiss accent'). \ No newline at end of file +Instead of listing the terms, let us recommend this superb [tutorial](https://www.youtube.com/watch?v=J3PBL9oLPX8) by Andreas Spiess (the 'guy with the Swiss accent'). diff --git a/docs/hardware/antennas/resources.mdx b/docs/hardware/antennas/resources.mdx index 69a51197..33c4e98e 100644 --- a/docs/hardware/antennas/resources.mdx +++ b/docs/hardware/antennas/resources.mdx @@ -10,35 +10,32 @@ sidebar_position: 4 - [Hackaday's Introduction to Antenna Basics](https://www.youtube.com/playlist?list=PL_tws4AXg7authztKFg5ZN5qWGtq3N_nI) - An excellent series of presentations on the basics of antenna design and function, presented by spacecraft radio engineer Karen Rucker. - ### Coverage prediction - [Tower Coverage.com](https://www.towercoverage.com) + - Commercial, but has free options - - [HeyWhat'sThat](http://www.heywhatsthat.com) - - Free with path profiling options + - Free with path profiling options - [Radio Mobile Online](https://www.ve2dbe.com/rmonline_s.asp) - Radio Mobile Online is a radio wave propagation prediction tool dedicated to amateur radio - ### RF Tools - [Times Microwave Systems](https://www.timesmicrowave.com/calculator/?Product=RG-6&RunLength=10&Frequency=868) + - Coaxial Cable Attenuation & Power Handling Calculator - - [Solwise Link Budget Calculator](https://www.solwise.co.uk/link-budget.htm) - - Predict the received signal strength + - Predict the received signal strength - [Amateur Radio Toolkit](https://play.google.com/store/apps/details?id=com.daveyhollenberg.amateurradiotoolkit) - Android app with lots of antenna information - ### Antenna designs - [1/4 Wave Ground Plane Antenna Calculator](https://m0ukd.com/calculators/quarter-wave-ground-plane-antenna-calculator) diff --git a/docs/hardware/antennas/testing.mdx b/docs/hardware/antennas/testing.mdx index 8a403769..40ecf34b 100644 --- a/docs/hardware/antennas/testing.mdx +++ b/docs/hardware/antennas/testing.mdx @@ -32,7 +32,6 @@ While the LoRa devices we are using for Meshtastic are relatively low power radi The information collected here is by no means definitive, and necessarily abbreviated (it's a huge topic). - ## Range Testing As mentioned, while stating the obvious, the simplest way of performing a test is: @@ -63,7 +62,6 @@ One of the first things to ensure, is that the antenna you have is tuned to the Andreas Spiess also gives a great explanation of [how to use Vector Network Analyzers](https://www.youtube.com/watch?v=ZpKoLvqOWyc) to correctly tune your antennas, as well as a more [in depth tutorial of how to use VNAs](https://www.youtube.com/watch?v=_pjcEKQY_Tk). It is important to remember however, that VNAs can only tell you if the antenna is well-matched, not how well it is transmitting. A 50 ohm resistor across the transmitter output would show as ideally matched, but it would be useless at transmitting a signal. There are a number of VNAs now available for less than $100, making this no longer out of reach for most hobbyists, unlike expensive spectrum analyzers. - ## Non-aerial Factors Affecting Transmission Unless you're using your devices in a vacuum, with clear line of sight between aerials the following will have an effect: @@ -87,11 +85,8 @@ For a bit of light reading on environmental research: In summary - wavelengths in Europe fair well in plain sight, curve over not-so-tall obstacles (including trees), and they reflect off surfaces at low angles of incidence. They go through humans without much attenuation; but not brick, stone, or anything with more attenuation than glass / Kevlar. Oh, and don’t sit under an LTE tower and expect it to be plain sailing. RF emissions at adjacent frequencies can interfere at a high enough power. - ## Discussion To comment on / join in antenna range [Meshtastic discourse](https://meshtastic.discourse.group/t/antenna-improved-range/227/35?u=sens8tion) There, you will also find reference to Meshtastic range achievements and aerial recommendations. (Note we've stopped short of making specific supplier aerial recommendations in this wiki.) - - diff --git a/docs/hardware/devices/heltec/buttons.mdx b/docs/hardware/devices/heltec/buttons.mdx index 04819979..c01bdbbe 100644 --- a/docs/hardware/devices/heltec/buttons.mdx +++ b/docs/hardware/devices/heltec/buttons.mdx @@ -8,8 +8,8 @@ sidebar_position: 3 ## Functionality - **Reset Button** - - _**Single press**_ resets the device. + - _**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. + - _**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. diff --git a/docs/hardware/devices/heltec/enclosures.mdx b/docs/hardware/devices/heltec/enclosures.mdx index 5e86351a..03957997 100644 --- a/docs/hardware/devices/heltec/enclosures.mdx +++ b/docs/hardware/devices/heltec/enclosures.mdx @@ -5,7 +5,7 @@ sidebar_label: Enclosures sidebar_position: 3 --- -import Tropho from '/img/enclosures/3dp-tropho-heltec32.png'; +import Tropho from "/img/enclosures/3dp-tropho-heltec32.png"; ## Created by tropho/TonyG @@ -20,4 +20,4 @@ Download from [Printables](https://www.printables.com/model/118750-heltec-lora-3 - (x1) LiPo battery pack (1,000mAh) - (x1) Latching micro push button switch - \ No newline at end of file + diff --git a/docs/hardware/devices/heltec/index.mdx b/docs/hardware/devices/heltec/index.mdx index 0b81cfa8..10152537 100644 --- a/docs/hardware/devices/heltec/index.mdx +++ b/docs/hardware/devices/heltec/index.mdx @@ -5,8 +5,8 @@ sidebar_label: HELTEC® Lora 32 sidebar_position: 7 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; @@ -51,7 +53,7 @@ Not recommended! Very old board with design issues. Support is being phased out. Not recommended because of design issues! Support is being phased out. Use V3 in new projects. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX127x @@ -62,12 +64,14 @@ Not recommended because of design issues! Support is being phased out. Use V3 in - Micro USB - Antenna: U.FL antenna connector -**Features** +## Features + - Built in 0.96 inch OLED display - User and Reset switches - No GPS -**Resources** +## Resources + - Firmware file: `firmware-heltec-v2.0-X.X.X.xxxxxxx.bin` @@ -77,7 +81,7 @@ Not recommended because of design issues! Support is being phased out. Use V3 in Not recommended because of design issues! Support is being phased out. Use V3 in new projects. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX127x @@ -89,18 +93,20 @@ Not recommended because of design issues! Support is being phased out. Use V3 in - Micro USB - Antenna: U.FL antenna connector -**Features** +## Features + - Built in 0.96 inch OLED display - User and Reset switches - No GPS -**Resources** +## Resources + - Firmware file: `firmware-heltec-v2.1-X.X.X.xxxxxxx.bin` -- **MCU** +- **MCU** - ESP32-S3 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX126x @@ -111,19 +117,21 @@ Not recommended because of design issues! Support is being phased out. Use V3 in - USB-C - Antenna: U.FL antenna connector -**Features** +## Features + - Built in 0.96 inch OLED display - User and Reset switches - No GPS -**Resources** +## Resources + - Firmware file: `firmware-heltec-v3-X.X.X.xxxxxxx.bin` - Purchase link: [AliExpress](https://www.aliexpress.com/item/1005004823000595.html) -- **MCU** +- **MCU** - ESP32-S3 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX126x @@ -135,12 +143,14 @@ Not recommended because of design issues! Support is being phased out. Use V3 in - USB-C - Antenna: IPEX/u.FL antenna connector -**Features** +## Features + - no display - User and Reset switches - No GPS -**Resources** +## Resources + - Firmware file: `firmware-heltec-wsl-v3-X.X.X.xxxxxxx.bin` - Purchase link: [AliExpress](https://www.aliexpress.com/item/1005004839521502.html) diff --git a/docs/hardware/devices/lora/buttons.mdx b/docs/hardware/devices/lora/buttons.mdx index 04819979..c01bdbbe 100644 --- a/docs/hardware/devices/lora/buttons.mdx +++ b/docs/hardware/devices/lora/buttons.mdx @@ -8,8 +8,8 @@ sidebar_position: 3 ## Functionality - **Reset Button** - - _**Single press**_ resets the device. + - _**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. + - _**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. diff --git a/docs/hardware/devices/lora/enclosures.mdx b/docs/hardware/devices/lora/enclosures.mdx index 3013df40..f0405d8a 100644 --- a/docs/hardware/devices/lora/enclosures.mdx +++ b/docs/hardware/devices/lora/enclosures.mdx @@ -5,7 +5,7 @@ sidebar_label: Enclosures sidebar_position: 3 --- -import Tropho from '/img/enclosures/3dp-tropho-lora32.png'; +import Tropho from "/img/enclosures/3dp-tropho-lora32.png"; ## Created by tropho/TonyG diff --git a/docs/hardware/devices/lora/gpio.mdx b/docs/hardware/devices/lora/gpio.mdx index fa1009ff..9a4ae8d9 100644 --- a/docs/hardware/devices/lora/gpio.mdx +++ b/docs/hardware/devices/lora/gpio.mdx @@ -9,6 +9,10 @@ sidebar_position: 4 For the Lora V2.1-1.6 and V2.1-1.8, Shorting IO12 to ground will progress through the screen pages and/or wake up the device. A simple push switch can be added for this purpose. - + - + diff --git a/docs/hardware/devices/lora/index.mdx b/docs/hardware/devices/lora/index.mdx index 01b91105..d746c808 100644 --- a/docs/hardware/devices/lora/index.mdx +++ b/docs/hardware/devices/lora/index.mdx @@ -5,8 +5,8 @@ sidebar_label: LILYGO® Lora sidebar_position: 6 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; Further information on the LILYGO® LoRa devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series). @@ -31,7 +31,7 @@ Not recommended with a battery! These boards contain the wrong component in the This board is still in production but for various reasons not recommended for new purchases or for unattended installations. Firmware support is phased out. If in doubt, choose the Lora V2.1-1.6 or Lora T3S3 board. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX1276 @@ -42,14 +42,15 @@ 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/32840238513.html) - ![LILYGO® TTGO Lora V1](/img/hardware/lora-v1.png) @@ -63,7 +64,7 @@ Not recommended with a battery! These boards contain the wrong component in the This board is still in production but for various reasons not recommended for new purchases or for unattended installations. Firmware support is phased out. If in doubt, choose the Lora V2.1-1.6 or Lora T3S3 board. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX127x @@ -74,10 +75,12 @@ 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) @@ -95,7 +98,7 @@ Not recommended with a battery! These boards contain the wrong component in the This board is still in production but for various reasons not recommended for new purchases or for unattended installations. Firmware support is phased out. If in doubt, choose the Lora V2.1-1.6 or Lora T3S3 board. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX127x @@ -107,13 +110,15 @@ 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) @@ -122,12 +127,11 @@ This board is still in production but for various reasons not recommended for ne - :::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. ::: -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX127x @@ -139,24 +143,25 @@ Early versions of some of these boards contained the wrong component in the LiPo - Micro USB - 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.6-X.X.X.xxxxxxx.bin` - Purchase link: [AliExpress](https://www.aliexpress.com/item/32915894264.html) - ![TTGO Lora V2.1-1.6](/img/hardware/lora-v2.1-1.6.png) -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX1280 (Region LORA_24 worldwide use) @@ -166,23 +171,25 @@ 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` - Purchase link: [Banggood](https://www.banggood.com/LILYGO-LORA-H570-V1_8-SX1280-ESP32-2_4G-Smart-WiFi-bluetooth-Wireless-Module-0_96inch-OLED-Display-Development-Board-with-Antenna-Type-C-p-1969395.html) - ![TTGO Lora V2.1-1.8](/img/hardware/lora-v2.1-1.8.jpg) + -- **MCU** +- **MCU** - ESP32-S3 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX1262 @@ -196,17 +203,20 @@ 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 -**Resources** -- Firmware file: `firmware-tlora-t3s3-v1.xxxxxxx.bin` +## Resources + +- Firmware file: `firmware-tlora-t3s3-v1.xxxxxxx.bin` - Purchase link: [AliExpress](https://www.aliexpress.com/item/1005004627139838.html) - + ![TTGO Lora T3S3 V1](/img/hardware/lora-t3s3.jpg) + diff --git a/docs/hardware/devices/nano-g1/buttons.mdx b/docs/hardware/devices/nano-g1/buttons.mdx index 0370f296..4603ad13 100644 --- a/docs/hardware/devices/nano-g1/buttons.mdx +++ b/docs/hardware/devices/nano-g1/buttons.mdx @@ -8,6 +8,6 @@ sidebar_position: 3 ## 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. \ No newline at end of file + - _**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. diff --git a/docs/hardware/devices/nano-g1/index.mdx b/docs/hardware/devices/nano-g1/index.mdx index 0b34b8f9..e35dbb28 100644 --- a/docs/hardware/devices/nano-g1/index.mdx +++ b/docs/hardware/devices/nano-g1/index.mdx @@ -36,7 +36,6 @@ The Nano G1 is the first dedicated hardware device to be designed from scratch p - Firmware file: `firmware-nano-g1-1.x.x.bin` - [Purchase link](https://www.tindie.com/products/neilhao/meshtastic-mesh-device-nano-edition/) - Further information on the Nano G1 can be found on [Unit Engineering's 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 59082f6b..9aa53680 100644 --- a/docs/hardware/devices/rak/base-boards.mdx +++ b/docs/hardware/devices/rak/base-boards.mdx @@ -5,8 +5,8 @@ sidebar_label: Base Boards sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; ## WisBlock Base @@ -52,7 +52,7 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent RAK4631 5005 @@ -77,10 +77,8 @@ Further information on the RAK5005-O can be found on the [RAK Documentation Cent - **Screen Support** - OLED screen support (OLED screen sold separately) - Further information on the RAK19007 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19007/Overview/#product-description). - @@ -103,13 +101,12 @@ Further information on the RAK19007 can be found on the [RAK Documentation Cente - **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) RAK4631 19003 @@ -136,7 +133,6 @@ Further information on the RAK19003 can be found on the [RAK Documentation Cente - **Screen Support** - OLED screen support (OLED screen sold separately) - Further information on the RAK19001 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK19001/Overview/#product-description). diff --git a/docs/hardware/devices/rak/buttons.mdx b/docs/hardware/devices/rak/buttons.mdx index 00434f66..81657de1 100644 --- a/docs/hardware/devices/rak/buttons.mdx +++ b/docs/hardware/devices/rak/buttons.mdx @@ -12,19 +12,19 @@ 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. + - _**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. ### 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. + - _**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_ \ No newline at end of file + - _Not yet implemented by Meshtastic_ diff --git a/docs/hardware/devices/rak/core-modules.mdx b/docs/hardware/devices/rak/core-modules.mdx index 5b504b13..36a4c86d 100644 --- a/docs/hardware/devices/rak/core-modules.mdx +++ b/docs/hardware/devices/rak/core-modules.mdx @@ -5,8 +5,8 @@ sidebar_label: Core Modules sidebar_position: 2 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; ## WisBlock Core @@ -27,8 +27,8 @@ Please be aware of the difference between the RAK4631 (Arduino bootloader) and t ::: - [RAK4631](https://store.rakwireless.com/products/rak4631-lpwan-node?variant=37505443856582) - - **MCU** - - nRF52840 + - **MCU** + - nRF52840 - Bluetooth BLE 5.0 - Very low power consumption - **Meshtastic Firmware** @@ -52,13 +52,12 @@ Further information on the RAK4631 can be found on the [RAK Documentation Center RAK4631 Core Module - ### RAK11200 / RAK13300 :::caution Note @@ -68,7 +67,7 @@ Only supported on the RAK5005-O / RAK19007 and the RAK19001 base board. The RAK11200 does not contain a LoRa transceiver, and thus needs to be added separately in the form of the [RAK13300 LPWAN module](https://store.rakwireless.com/products/rak13300-wisblock-lpwan). This occupies the IO Port of the base board. - [RAK11200](https://store.rakwireless.com/products/wiscore-esp32-module-rak11200) - - **MCU** + - **MCU** - ESP32-WROVER - Bluetooth 4.2 - WiFi 802.11 b/g/n @@ -93,14 +92,13 @@ Further information on the RAK11200 can be found on the [RAK Documentation Cente - **Connectors** - U.FL antenna - Further information on the RAK13300 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK13300/Overview/#product-description). RAK4631 5005 11200 - \ No newline at end of file + diff --git a/docs/hardware/devices/rak/enclosures.mdx b/docs/hardware/devices/rak/enclosures.mdx index 9f7dd571..07fd76bf 100644 --- a/docs/hardware/devices/rak/enclosures.mdx +++ b/docs/hardware/devices/rak/enclosures.mdx @@ -13,7 +13,6 @@ Download from [Printables](https://www.printables.com/model/297089-meshtastic-so ![rak19003-micro](/img/enclosures/3dp-kmon-basestation.png) - ## Created by tropho/TonyG ### RAK5005 Case diff --git a/docs/hardware/devices/rak/index.mdx b/docs/hardware/devices/rak/index.mdx index bee08899..90e393e0 100644 --- a/docs/hardware/devices/rak/index.mdx +++ b/docs/hardware/devices/rak/index.mdx @@ -5,8 +5,8 @@ sidebar_label: RAK WisBlock sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; @@ -16,7 +16,7 @@ RAK Wireless currently sells a [Meshtastic Starter kit](https://store.rakwireles If you wish to purchase parts separately, you will need a [WisBlock Base Board](/docs/hardware/devices/rak/base-board) and a [WisBlock Core Module](/docs/hardware/devices/rak/core-module). Please ensure you choose the correct operating frequency for your country when purchasing. -You can optionally purchase peripherals such as a GPS module, Screen, Sensor, or other various modules. +You can optionally purchase peripherals such as a GPS module, Screen, Sensor, or other various modules. Please see the RAK documentation for the correct way to connect your hardware to ensure that you do not damage the device. There is currently no pin required to pair RAK devices via BLE. diff --git a/docs/hardware/devices/rak/peripherals.mdx b/docs/hardware/devices/rak/peripherals.mdx index d532dc17..a6d00409 100644 --- a/docs/hardware/devices/rak/peripherals.mdx +++ b/docs/hardware/devices/rak/peripherals.mdx @@ -5,8 +5,8 @@ sidebar_label: Peripherals sidebar_position: 3 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; 2C on slot B for firmware versions 1.49 and above. @@ -32,7 +31,6 @@ To add a GPS to the RAK19003 base board, you need the [RAK12500 GPS sensor](http - 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). @@ -54,7 +52,6 @@ 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). @@ -101,7 +98,7 @@ The [RAK1906 Environment Sensor](https://store.rakwireless.com/products/rak1906- - Humidity measurement (Range 0% to 100%) - 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). @@ -110,4 +107,4 @@ Further information on the RAK1906 can be found on the [RAK Documentation Center - \ No newline at end of file + diff --git a/docs/hardware/devices/rak/screens.mdx b/docs/hardware/devices/rak/screens.mdx index dadc4e6e..c716607c 100644 --- a/docs/hardware/devices/rak/screens.mdx +++ b/docs/hardware/devices/rak/screens.mdx @@ -5,8 +5,8 @@ sidebar_label: Screens sidebar_position: 2 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; There are currently two different screens supported by the RAK WisBlock system: @@ -25,7 +25,6 @@ The [RAK1921 OLED display](https://store.rakwireless.com/products/rak1921-oled-d - 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). 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. @@ -43,13 +42,12 @@ 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 - - Firmware for 5005 with RAK14000 e-paper: [`firmware-rak4631_eink-1.3.x.uf2`](/downloads) 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. diff --git a/docs/hardware/devices/station-g1/buttons.mdx b/docs/hardware/devices/station-g1/buttons.mdx index 0370f296..4603ad13 100644 --- a/docs/hardware/devices/station-g1/buttons.mdx +++ b/docs/hardware/devices/station-g1/buttons.mdx @@ -8,6 +8,6 @@ sidebar_position: 3 ## 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. \ No newline at end of file + - _**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. diff --git a/docs/hardware/devices/station-g1/index.mdx b/docs/hardware/devices/station-g1/index.mdx index 589a042a..dc19e49c 100644 --- a/docs/hardware/devices/station-g1/index.mdx +++ b/docs/hardware/devices/station-g1/index.mdx @@ -24,7 +24,7 @@ The Station G1 is the second dedicated hardware device to be designed from scrat - SMA Socket - **Connectors** - USB-C - + ### Features - Meshtastic pre-installed diff --git a/docs/hardware/devices/tbeam/buttons.mdx b/docs/hardware/devices/tbeam/buttons.mdx index 8ddb5d9f..62dd5c56 100644 --- a/docs/hardware/devices/tbeam/buttons.mdx +++ b/docs/hardware/devices/tbeam/buttons.mdx @@ -8,10 +8,10 @@ sidebar_position: 3 ## Functionality - **Reset Button (right)** - - _**Single press**_ resets the device. + - _**Single press**_ resets the device. - **Power Button (left)** - - _**Long press**_ powers the device off or turns it back on again. + - _**Long press**_ powers the device off or turns it back on again. - **Program button (middle)** - - _**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. \ No newline at end of file + - _**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. diff --git a/docs/hardware/devices/tbeam/enclosures.mdx b/docs/hardware/devices/tbeam/enclosures.mdx index 60cdc73f..bdf7493b 100644 --- a/docs/hardware/devices/tbeam/enclosures.mdx +++ b/docs/hardware/devices/tbeam/enclosures.mdx @@ -17,7 +17,6 @@ Download from [Printables](https://www.printables.com/model/127253-t-beam-case-f - (x4) M3 nuts - (x4) M2x4mm screws (no nuts) to secure T-Beam to the frame - - + diff --git a/docs/hardware/devices/tbeam/index.mdx b/docs/hardware/devices/tbeam/index.mdx index e5fd855f..9fc53bc1 100644 --- a/docs/hardware/devices/tbeam/index.mdx +++ b/docs/hardware/devices/tbeam/index.mdx @@ -5,14 +5,13 @@ sidebar_label: LILYGO® T-Beam sidebar_position: 5 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; All T-beam models have an 18650 size battery holder on the rear of the device. This is designed to the original specification of the 18650 and only fits unprotected flat top 18650 cells. Button top and protected cells are typically longer than 65mm, often approaching 70mm. Further information on the LILYGO® T-Beam devices can be found on LILYGO®'s [GitHub page](https://github.com/Xinyuan-LilyGO/LilyGo-LoRa-Series). - -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX1276 @@ -76,12 +75,14 @@ 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) @@ -92,7 +93,7 @@ This is an earlier version of the T-Beam board. Due to changes in the design thi -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - Semtech SX1276 @@ -107,23 +108,23 @@ 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/33047631119.html) ![TTGO T-Beam M8N](/img/hardware/t-beam-m8n.png) - - -- **MCU** +- **MCU** - ESP32 (WiFi & Bluetooth) - **LoRa Transceiver** - **Semtech SX1262** (improved performance) @@ -138,18 +139,18 @@ 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) - ![T-Beam M8N & SX1262](/img/hardware/t-beam-sx1262.png) - diff --git a/docs/hardware/devices/tbeam/screens.mdx b/docs/hardware/devices/tbeam/screens.mdx index 35e7fdea..7db0f33d 100644 --- a/docs/hardware/devices/tbeam/screens.mdx +++ b/docs/hardware/devices/tbeam/screens.mdx @@ -5,7 +5,6 @@ sidebar_label: Screens sidebar_position: 2 --- - ## 0.96 inch OLED I2C display - [Purchase link](https://www.aliexpress.com/item/32922106384.html) @@ -21,4 +20,4 @@ To attach the screen: 3. Connect SCL to pin 22 4. Connect SDA to pin 21 -![Connecting the OLED screen to a T-Beam](/img/hardware/t-beam-screen.jpg) \ No newline at end of file +![Connecting the OLED screen to a T-Beam](/img/hardware/t-beam-screen.jpg) diff --git a/docs/hardware/devices/techo/buttons.mdx b/docs/hardware/devices/techo/buttons.mdx index 72692d3e..c946c67c 100644 --- a/docs/hardware/devices/techo/buttons.mdx +++ b/docs/hardware/devices/techo/buttons.mdx @@ -17,5 +17,4 @@ sidebar_position: 3 - _**Double press**_ turns the screen backlight on/off - _**Long press**_ signals the device to shutdown. - ![TechoButtons](/img/hardware/t-echo-lilygo.jpg) diff --git a/docs/hardware/devices/techo/enclosures.mdx b/docs/hardware/devices/techo/enclosures.mdx index 73635c88..18962d72 100644 --- a/docs/hardware/devices/techo/enclosures.mdx +++ b/docs/hardware/devices/techo/enclosures.mdx @@ -11,6 +11,6 @@ sidebar_position: 3 Download from [Thingiverse](https://www.thingiverse.com/thing:5028720). - + diff --git a/docs/legal/trademark.mdx b/docs/legal/trademark.mdx index 55a63961..7316280c 100644 --- a/docs/legal/trademark.mdx +++ b/docs/legal/trademark.mdx @@ -6,11 +6,11 @@ sidebar_label: Trademark Meshtastic® is a registered trademark of Meshtastic LLC. Meshtastic software components are released under various licenses, see [GitHub](https://github.com/meshtastic) for details. No warranty is provided - use at your own risk. -# Meshtastic Trademark Policy +## Meshtastic Trademark Policy Meshtastic, and Meshtastic logo ("Meshtastic Logo"), either separately or in combination, are hereinafter referred to as "Meshtastic Trademarks" and are trademarks of the Meshtastic LLC. Except as provided in these guidelines, you may not use the Meshtastic Trademarks or any confusingly similar mark as a trademark for your product, or use the Meshtastic Trademarks in any other manner that might cause confusion in the marketplace, including but not limited to in advertising, on websites, or on software. In fact, the law obligates trademark owners to police their marks and prevent the use of confusingly similar names by third parties. If you have questions about this policy, please contact the Trademark Supervisor by enquiring at [trademark@meshtastic.org](mailto:trademark@meshtastic.org). -# Usage That Does Not Require Written Permission +## Usage That Does Not Require Written Permission Below are the guidelines for use of the Meshtastic Trademarks where, as long as you are in compliance with the guidelines, no advance written permission is necessary. In all cases, use is permitted only provided that: @@ -19,7 +19,7 @@ Below are the guidelines for use of the Meshtastic Trademarks where, as long as - 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 -## Noncommercial and community web sites +### Noncommercial and community web sites In the past, community members have inquired whether it is permissible to show support for Meshtastic by: @@ -39,7 +39,7 @@ if the Meshtastic Trademarks appear in a page header or any area that is designe the site does not use visual styling that could be confusing to viewers or visitors as to whether the site is hosted by or on behalf of Meshtastic. 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. -## Business web sites +### Business web sites In the past, community members have inquired whether it is permissible to show support for Meshtastic by: @@ -59,7 +59,7 @@ It is permissible to use the Meshtastic Trademarks on business web sites, provid - the site does not use visual styling that could be confusing to viewers or visitors as to whether the site is hosted by or on behalf of Meshtastic - 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 -## Promotional events +### Promotional events In the past, community members have inquired whether it is permissible to use the Meshtastic Trademarks to promote events. The guidelines relating to such usage are set forth in this section. @@ -73,7 +73,7 @@ It is permissible to use the Meshtastic Trademarks in such promotional events, p If you would like to make some non-software goods to give away or sell at the event and don't already have a license to do so, see Non-software goods. -## Publications +### Publications It is permissible to use the Meshtastic Trademarks in the title and content of a publication, provided that: @@ -82,23 +82,23 @@ It is permissible to use the Meshtastic Trademarks in the title and content of a - 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 +## Usage that Require Prior Written Approval -## Social Media +### Social Media In the past, community members have inquired whether it is permissible to use the Meshtastic Trademarks, including the term "Meshtastic" in a Social Media account. It is not permissible without written permission of Meshtastic. -## Domain names +### Domain names In the past, community members have inquired whether it is permissible to use the Meshtastic Trademarks, including the term "Meshtastic" in an Internet domain name. It is not permissible without written permission of Meshtastic. -## Non-software goods +### Non-software goods In the past, community members have inquired whether it is permissible to use Meshtastic Trademarks on non-software goods such as Embedded Systems, Enclosures, Hardware, T-shirts, stickers, and pens. Community members may request from the Trademark Supervisor designated by the Admins of Meshtastic a license to use the Meshtastic Trademarks on non-software related goods or services, by enquiring at [trademark@meshtastic.org](mailto: trademark@meshtastic.org). The Trademark Supervisor will be responsible for reviewing samples of the goods and services and managing the relationship. -# Unapproved Use +## Unapproved Use The following uses of the Meshtastic Trademarks are not approved under any foreseeable circumstances. @@ -108,15 +108,15 @@ The following uses of the Meshtastic Trademarks are not approved under any fores These guidelines (except for trademark licenses executed for non software goods) may be amended from time to time at the discretion of Meshtastic and such changes will be effective ten (10) days after the changes are posted. Meshtastic may provide you with notice of such changes, but need not do so. You are responsible for checking this site for any changes. -# Proper Trademark Use +## Proper Trademark Use One of the purposes of Meshtastic is to encourage the use of Meshtastic software to enable the public to come to trust the use of Meshtastic Trademarks. To achieve this purpose it is important that Meshtastic can quickly be identified. Meshtastic has chosen the Meshtastic Logo to identify such software and is granting usage rights in the Meshtastic Logo (and the other Meshtastic Trademarks) as previously described in this document in order to assure widespread availability. -## Trademark Usage Guidelines +### Trademark Usage Guidelines -### Guideline +#### Guideline -#### Examples +##### Examples When using the Meshtastic Trademarks you must provide the proper trademark symbols and a trademark attribution statement. @@ -152,7 +152,7 @@ Unacceptable: Not hyperlinking the Meshtastic Logo where feasible Except as prohibited by law, the person or entity who is using the Meshtastic Trademark under the terms of these Guidelines ("User") acknowledges that Meshtastic is the sole and exclusive owner of the Meshtastic Trademarks and agrees that it will do nothing inconsistent with such ownership either during the term of such use or afterwards. Specifically, User will take no action that will interfere with or diminish Meshtastic's right in the Meshtastic Trademarks. The User acknowledges that the Meshtastic Trademarks are valid under the applicable law and that User's utilization of the Meshtastic Trademarks will not create any right, title or interest in the Meshtastic Trademarks. The User agrees not to apply or assist any third party to register the Meshtastic Trademarks or a confusingly similar designation anywhere in the world. If any application for registration is or has been filed by or on behalf of User in any country and relates to any mark which, in the reasonable opinion of Meshtastic, is confusingly similar, deceptive or misleading with respect to, or dilutes or any way damages the Meshtastic Trademark, User shall, at Meshtastic's request, abandon all use of such mark, and any registration or application for registration thereof and shall reimburse Meshtastic for all costs and expenses of any oppMeshtastiction or related legal proceeding, including attorneys' fees, instigation by Meshtastic or its authorized representative. Upon the written statement that the User is not using the Meshtastic Trademarks in accordance with the Guidelines, within ten (10) days, User shall modify its use to comply with the Guidelines or cease using the Meshtastic Trademarks. -## Logo Usage Guidelines +### Logo Usage Guidelines The Meshtastic logo is a trademark of Meshtastic LLC. In order to protect and grow the Meshtastic brand, we have a distinguishable logo. When displaying the Meshtastic logo, please follow our standard Trademark Guidelines. Other sizes and resolutions of the logo, some suitable for print, can be found [here](https://github.com/meshtastic/design). diff --git a/docs/software/android/installation.mdx b/docs/software/android/installation.mdx index 5df95ccb..01385243 100644 --- a/docs/software/android/installation.mdx +++ b/docs/software/android/installation.mdx @@ -15,30 +15,34 @@ The minimum Android version is 5.0 (Lollipop 2014, first BLE support), however A

- Get it on F-Droid + width="49%" + />

1. Download and Install the F-Droid app from [f-droid.org](https://f-droid.org/) -2. Open the F-Droid app and navigate to `Settings > Repositories`. +2. Open the F-Droid app and navigate to `Settings > Repositories`. 3. Click on the `+` icon to add a new repo. -3. Enter the Meshtastic repo address as follows: `https://mesh.tastic.app/fdroid/repo/` (no fingerprint required) -4. Navigate to the `Categories` page and refresh (scroll down). -5. Search for and install the `Meshtastic` App. +4. Enter the Meshtastic repo address as follows: `https://mesh.tastic.app/fdroid/repo/` (no fingerprint required) +5. Navigate to the `Categories` page and refresh (scroll down). +6. Search for and install the `Meshtastic` App. ### Install from Play Store

- Download at https://play.google.com/store/apps/details?id=com.geeksville.mesh + width="49%" + />

-There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs. +There is a Play Store [testing program](https://play.google.com/apps/testing/com.geeksville.mesh) with the latest cutting edge changes, though this may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to join. @@ -48,27 +52,28 @@ _Google Play and the Google Play logo are trademarks of Google LLC._

- Download at https://github.com/meshtastic/Meshtastic-Android/releases/latest + width="49%" + />

-The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page. +The app can also be sideloaded by downloading the .APK from the [Github Releases](https://github.com/meshtastic/Meshtastic-Android/releases/latest) page. If you do sideload, you may have to give your browser permissions to run a package installer. If you wish to view the code or contribute to development of the app, please visit the app's [GitHub page](https://github.com/meshtastic/Meshtastic-Android) - ### Install with Obtainium 1. Download and Install the Obtanium app from [Github](https://github.com/ImranR98/Obtainium). 2. Open the Obtanium app and navigate to `+ Add App`. 3. You can easily search for the Android repo with the search field by typing `Meshtastic-Android` and selecting the `Meshtastic/Meshtastic-Android` repo. You may also manually enter the Meshtastic Android Github Releases address as follows: `https://github.com/meshtastic/Meshtastic-Android/releases`. -4. Under `Additional Options for Github` toggle as desired `Include prereleases`* or `Fallback to older releases` and press `Add`. +4. Under `Additional Options for Github` toggle as desired `Include prereleases`\* or `Fallback to older releases` and press `Add`. 5. The first time you add an application, obtainium will prompt you for permission to install unknown apps, you will need to toggle `Allow from this source` and press back. Obtainium will download the Android .APK from the Github release page. 6. Press `Install`. Android Installer will prompt "Do you want to install this app?" press `Install`. 7. Press `Open`. Obtainium allows you to install and update Open-Source Apps directly from their releases pages, and receive notifications when new releases are made available. -*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions. +\*Alpha releases include the latest cutting edge changes which may come with extra bugs. It is recommended that you follow the [Meshtastic Discourse Alpha Testers](https://meshtastic.discourse.group/c/development/alpha-testers) channel if you decide to use these versions. diff --git a/docs/software/android/usage.mdx b/docs/software/android/usage.mdx index b0394b59..3824cce6 100644 --- a/docs/software/android/usage.mdx +++ b/docs/software/android/usage.mdx @@ -25,10 +25,10 @@ To find devices to connect via Bluetooth click the button on the bottom right co 1. Select the device name, `Meshtastic_bebc` in this example. (You will see devices within range, so make sure to get the right one.) 2. Before you can connect for the first time, you need to "pair" the devices to allow communication between them. Some devices are pinless, others require entering a PIN shown on the screen. -:::note -If the device was flashed without a screen connected, it will automatically default to a pairing PIN of '123456'. If it was booted with a screen once, the config is set to random pin. If you remove the screen afterwards, it stays like this. -Either set it to use the default pin manually, or factory reset it and it will revert to '123456' after the next boot. -::: + :::note + If the device was flashed without a screen connected, it will automatically default to a pairing PIN of '123456'. If it was booted with a screen once, the config is set to random pin. If you remove the screen afterwards, it stays like this. + Either set it to use the default pin manually, or factory reset it and it will revert to '123456' after the next boot. + ::: 3. This starts the communication with the device. The cloud icon on the status bar should change and show a check mark. [![Device connected](/img/android/android-settings-mike-c.png)](/img/android/android-settings-mike-c.png) @@ -73,7 +73,7 @@ The app will generate a new QR code on the screen, and this encodes the channel 1. If another user shares a QR code, you will be able to scan it directly with your camera using the `Scan` button. -[![Open with Meshtastic](/img/android/android-open-with-c.png)](/img/android/android-open-with.png) + [![Open with Meshtastic](/img/android/android-open-with-c.png)](/img/android/android-open-with.png) 2. If the channel is shared from a file or link using the `Share` button, you can click on the file or link and you need to choose "Open with Meshtastic". diff --git a/docs/software/apple/installation.mdx b/docs/software/apple/installation.mdx index 04f40bba..cffae21a 100644 --- a/docs/software/apple/installation.mdx +++ b/docs/software/apple/installation.mdx @@ -5,5 +5,8 @@ sidebar_label: Installation --- - Meshtastic App Store Launch Image + Meshtastic App Store Launch Image diff --git a/docs/software/apple/usage.mdx b/docs/software/apple/usage.mdx index 9bd37e17..8bbddce2 100644 --- a/docs/software/apple/usage.mdx +++ b/docs/software/apple/usage.mdx @@ -8,14 +8,14 @@ sidebar_label: Usage The Meshtastic app for iOS, iPadOS and macOS supports the sharing of a .mbtiles file with the app for offline map support. -There is an open source cross platform mapping program call [QGIS](https://www.qgis.org/en/site/) +There is an open source cross platform mapping program call [QGIS](https://www.qgis.org/en/site/) -to get a mbtiles out of qgis, start with a small area that you are familiar with. Open qgis, and add a openstreetmap source from the left bar (might be under one of the tile headings). Now you should see something in the main map view. zoom to the area you want. +to get a mbtiles out of qgis, start with a small area that you are familiar with. Open qgis, and add a openstreetmap source from the left bar (might be under one of the tile headings). Now you should see something in the main map view. zoom to the area you want. In the Processing Toolbox (right bar, you may have to show it from the View menu), open Raster Tools > Generate XYZ Tiles (MBTiles) -In Extent, choose Use Map Canvas Extent. This defines the area of the map that will be rendered into the export file -Use a zoom level of 12-17. You can play with this later, but thats a good starting point. Note that every increment of maximum zoom will increase the map size 4x. -Select JPG if there's aerial/satellite imagery, otherwise just use PNG. That will give the best compression. +In Extent, choose Use Map Canvas Extent. This defines the area of the map that will be rendered into the export file +Use a zoom level of 12-17. You can play with this later, but thats a good starting point. Note that every increment of maximum zoom will increase the map size 4x. +Select JPG if there's aerial/satellite imagery, otherwise just use PNG. That will give the best compression. -Finally choose a location for the output file. Click Run and you should eventually get a file that should play nice in the Meshtastic app. \ No newline at end of file +Finally choose a location for the output file. Click Run and you should eventually get a file that should play nice in the Meshtastic app. diff --git a/docs/software/community/atak.mdx b/docs/software/community/atak.mdx index efe45244..c39b11fc 100644 --- a/docs/software/community/atak.mdx +++ b/docs/software/community/atak.mdx @@ -16,6 +16,7 @@ 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. ::: diff --git a/docs/software/community/index.mdx b/docs/software/community/index.mdx index 87f7bb59..c89cbb67 100644 --- a/docs/software/community/index.mdx +++ b/docs/software/community/index.mdx @@ -12,4 +12,4 @@ Current community projects: - [ATAK (Android Team Awareness Kit) Forwarder](/docs/software/community/community-atak) - An ATAK plugin for forwarding CoT messages via a hardware layer which supports Meshtastic devices. - [Meshtasticator (Simulator)](/docs/software/community/community-meshtasticator) - Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software. -Support for these projects should be sought from their respective authors. \ No newline at end of file +Support for these projects should be sought from their respective authors. diff --git a/docs/software/linux-native.mdx b/docs/software/linux-native.mdx index 0c057dd3..05269262 100644 --- a/docs/software/linux-native.mdx +++ b/docs/software/linux-native.mdx @@ -6,14 +6,13 @@ sidebar_position: 9 --- The device software can also run on a native Linux machine thanks to the [Portduino framework](https://github.com/geeksville/framework-portduino). -See either [Usage with a Linux machine](#usage-with-a-linux-machine) or [Usage with Docker](#usage-with-docker) for instructions to run it. The application either simulates some of the interfaces, or uses the real hardware of your machine. Device firmware from 1.3.42 and on even allows you to simulate the LoRa chip by sending and receiving Meshtastic packets via a local TCP port. In this way, you can let multiple instances of the application communicate with each other as if they did via LoRa. For instructions on how to use it, see the [interactive simulator](https://github.com/GUVWAF/Meshtasticator/blob/master/INTERACTIVE_SIM.md) that also emulates a wireless environment using simulated positions of the nodes. -## Usage with a Linux machine {#usage-with-a-linux-machine} +## Usage with a Linux machine The easiest way of building the native application is using Visual Studio Code with the PlatformIO extension. See the instructions for creating such a building environment [here](/docs/development/firmware/build). @@ -29,7 +28,7 @@ Additional arguments can be given to the program, which are listed as follows: - `-h MAC_ADDRESS`: The MAC address to assign to this virtual machine. - `-p TCP_PORT`: The local TCP port to use for running the Meshtastic API. -## Usage with Docker {#usage-with-docker} +## Usage with Docker If you do not own a Linux machine, or you just want to separate things, you might want to run the application inside a docker container. @@ -66,7 +65,7 @@ First, some environment variables need to be set up with command: You also want to make some adjustments in the bin/build-all.sh to conform the amd64 build: -``` +```shell sed -i 's/^BOARDS_ESP32.*/BOARDS_ESP32=""/' bin/build-all.sh sed -i 's/^BOARDS_NRF52.*/BOARDS_NRF52=""/' bin/build-all.sh sed -i 's/echo "Building SPIFFS.*/exit/' bin/build-all.sh diff --git a/docs/software/mqtt/index.mdx b/docs/software/mqtt/index.mdx index 6e7c8ed1..125afba1 100644 --- a/docs/software/mqtt/index.mdx +++ b/docs/software/mqtt/index.mdx @@ -34,7 +34,7 @@ The device will uplink and downlink raw ([protobuf](https://developers.google.co The payload is a raw protobuf. Looking at the MQTT traffic with a program like `mosquitto_sub` will tell you it's working, but you won't get much useful information out of it. For example: -``` +```text 苓????"! !937bed1cTanksTnk"D???05??=???aP` ShortFast !937bed1c @@ -139,43 +139,43 @@ An existing public [MQTT broker](https://mosquitto.org) will be the default for 1. install mqtt server -```sh -brew install mosquitto -``` + ```sh + brew install mosquitto + ``` 2. start the mqtt server -```sh -brew services restart mosquitto -``` + ```sh + brew services restart mosquitto + ``` 3. Do a quick test of server, start a subscriber on a topic: -Note: this will wait until you press control-c (publish a message, see below) + Note: this will wait until you press control-c (publish a message, see below) -```sh -mosquitto_sub -t test/hello -``` + ```sh + mosquitto_sub -t test/hello + ``` 4. In another window, publish a message to that topic: -```sh -mosquitto_pub -h localhost -q 0 -t test/hello -m 'yo!' -``` + ```sh + mosquitto_pub -h localhost -q 0 -t test/hello -m 'yo!' + ``` 5. For Meshtastic to be able to access that server, two settings need to be changed in the `/usr/local/etc/mosquitto/mosquitto.conf` file: -``` -listener 1883 0.0.0.0 -allow_anonymous true -``` + ```shell + listener 1883 0.0.0.0 + allow_anonymous true + ``` 6. Restart the service: -```sh -brew services restart mosquitto -``` + ```shell + brew services restart mosquitto + ``` 7. If you are using the mac firewall, you will need to go into: System Preferences > Security & Privacy > Firewall > Firewall Options and add it. @@ -245,7 +245,7 @@ Enable and enter network SSID/PSK. Settings--> Device Config--> Network; Save. Set MQTT server address. Settings--> Module Config--> MQTT config; Verify Encryption Enabled is OFF. Turn JSON Output Enabled ON. Save. Go to Channel Editor and set Uplink and Downlink enabled to True. Save. There is currently a bug for setting Uplink and Downlink Saving for the default channel. If you encounter this use the CLI commands: -``` +```shell meshtastic --ch-index 0 --ch-set uplink_enabled true meshtastic --ch-index 0 --ch-set downlink_enabled true ``` @@ -274,8 +274,563 @@ If you want to decode text and position messages without json, it gets complicat [](/documents/mqtt/DecodeNewest.jpg) If you are interested in my flow for this it is here: -``` -[{"id":"10fe1b2e9cb3feb2","type":"decode","z":"23dbb1ee.bc2e8e","name":"decode Protobuf","protofile":"a0d4288141f6a629","protoType":"ServiceEnvelope","x":295.5,"y":285,"wires":[["d3e396cf4f0a9608","d08865b41a69d85d","6f592d47b6a2eac4"]]},{"id":"40c9ee66fe7a34cb","type":"function","z":"23dbb1ee.bc2e8e","name":"function get the message as string from TEXT_MESSAGE_APP","func":"msg.payload = msg.payload.packet.decoded.payload;\n\nlet bufferObj = Buffer.from(msg.payload, \"base64\");\nlet decodedString = bufferObj.toString(\"utf8\");\nmsg.payload = decodedString;\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":410.5,"y":450,"wires":[["553374591214eaca"]]},{"id":"553374591214eaca","type":"debug","z":"23dbb1ee.bc2e8e","name":"text message out","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":762.5,"y":449,"wires":[]},{"id":"c6afbb9f1665b162","type":"debug","z":"23dbb1ee.bc2e8e","name":"channelId","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":785.5,"y":257,"wires":[]},{"id":"607ef387d5701985","type":"debug","z":"23dbb1ee.bc2e8e","name":"gatewayId","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":792.5,"y":293,"wires":[]},{"id":"d3e396cf4f0a9608","type":"debug","z":"23dbb1ee.bc2e8e","name":"entire payload","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":296.5,"y":247,"wires":[]},{"id":"2339b328bb9bb1d8","type":"comment","z":"23dbb1ee.bc2e8e","name":"Decode all cleartext text and position messages sent by Meshtastic devices into JSON without relying on JSON conversion on the device.","info":"","x":515.5,"y":214,"wires":[]},{"id":"408d796d997bb832","type":"function","z":"23dbb1ee.bc2e8e","name":"function get the nested payload as base64","func":"msg.payload = msg.payload.packet.decoded.payload;\n\nlet bufferObj = Buffer.from(msg.payload, \"base64\");\n//let decodedString = bufferObj.toString(\"hex\");\nmsg.payload = bufferObj;\nmsg.topic=\"\";\n//if you don't zero out the protubufTopic it will try to\n//decode it as part of the mqtt service envelope instead\n//of two-stage decoding\nmsg.protobufType=null;\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":349,"y":552,"wires":[["9435a3c605efedb4","1ed6f96c8214d7b3"]]},{"id":"61995c9f8e8266b3","type":"debug","z":"23dbb1ee.bc2e8e","name":"portnum","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":784.5,"y":330,"wires":[]},{"id":"9435a3c605efedb4","type":"debug","z":"23dbb1ee.bc2e8e","name":"nested payload","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":281.5,"y":603,"wires":[]},{"id":"b832775d386f7ac9","type":"mqtt in","z":"23dbb1ee.bc2e8e","name":"","topic":"msh/+/c/#","qos":"2","datatype":"buffer","broker":"37cadac381653b1e","nl":false,"rap":true,"rh":0,"inputs":0,"x":117.5,"y":286,"wires":[["10fe1b2e9cb3feb2"]]},{"id":"d08865b41a69d85d","type":"switch","z":"23dbb1ee.bc2e8e","name":"switch manual decoding nested message based on portum","property":"payload.packet.decoded.portnum","propertyType":"msg","rules":[{"t":"eq","v":"TEXT_MESSAGE_APP","vt":"str"},{"t":"eq","v":"POSITION_APP","vt":"str"}],"checkall":"true","repair":false,"outputs":2,"x":281.5,"y":505,"wires":[["40c9ee66fe7a34cb"],["408d796d997bb832"]]},{"id":"8abb1bb458af2c4f","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"gatewayId","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":1021.5,"y":288,"wires":[[]]},{"id":"1ced0be28eeef0d3","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"latitude","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":1026.5,"y":407,"wires":[[]]},{"id":"313fd3cfe6d91850","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"longitude","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":1036.5,"y":450,"wires":[["d02e53cdfb565da6"]]},{"id":"33dd43e3c05f826c","type":"geofence","z":"23dbb1ee.bc2e8e","name":"geofence","mode":"circle","inside":"true","rad":69174.91569647488,"points":[],"centre":{"latitude":40.16287050252407,"longitude":-86.60385131835938},"floor":"","ceiling":"","worldmap":true,"outputs":2,"x":1202.5,"y":595,"wires":[[],["4d01eb8f1b31f039"]]},{"id":"d02e53cdfb565da6","type":"function","z":"23dbb1ee.bc2e8e","name":"trigger function to send a mapping point","func":"let lat = parseFloat(flow.get(\"latitude\"));\nlet lon = parseFloat(flow.get(\"longitude\"));\nlat=lat * 0.0000001;\nlon=lon * 0.0000001;\nlet name = flow.get(\"from\")\n\nmsg={\"payload\":{\"name\":name,\n \"lat\":lat,\n \"lon\":lon,\n \"action\":\"send\",\n \"icon\": \"car\",\n \"label\":name\n }}\n\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1181.5,"y":520,"wires":[["33dd43e3c05f826c","4d01eb8f1b31f039"]]},{"id":"4d01eb8f1b31f039","type":"worldmap","z":"23dbb1ee.bc2e8e","name":"","lat":"40","lon":"-86","zoom":"7","layer":"OSMG","cluster":"","maxage":"","usermenu":"show","layers":"show","panit":"false","panlock":"false","zoomlock":"false","hiderightclick":"false","coords":"none","showgrid":"false","showruler":"false","allowFileDrop":"false","path":"/worldmap","overlist":"DR,CO,RA,DN,HM","maplist":"OSMG,OSMC,EsriC,EsriS,EsriT,EsriDG,UKOS","mapname":"","mapurl":"","mapopt":"","mapwms":false,"x":1206.5,"y":675,"wires":[]},{"id":"1ed6f96c8214d7b3","type":"decode","z":"23dbb1ee.bc2e8e","name":"decode Position Protobuf","protofile":"dbab6472b07929a0","protoType":"Position","x":667.5,"y":548,"wires":[["db1933ba36503bd9","dad9f487318f21d9"]]},{"id":"db1933ba36503bd9","type":"debug","z":"23dbb1ee.bc2e8e","name":"Position decoded","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":673.5,"y":607,"wires":[]},{"id":"dad9f487318f21d9","type":"function","z":"23dbb1ee.bc2e8e","name":"Split","func":"var lat = { payload: msg.payload.latitudeI };\nvar lon = { payload: msg.payload.longitudeI };\nvar alt = { payload: msg.payload.altitude };\nvar tm = { payload: msg.payload.time };\n\nreturn [lat,lon,alt,tm];","outputs":4,"noerr":0,"initialize":"","finalize":"","libs":[],"x":875.5,"y":549,"wires":[["1ced0be28eeef0d3","8bb97f802662976c"],["313fd3cfe6d91850","c8e135f3e542bb1b"],["602fb2020680280c"],["ed424ae3d45dd2ac"]]},{"id":"8bb97f802662976c","type":"debug","z":"23dbb1ee.bc2e8e","name":"lat","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":1017.5,"y":583,"wires":[]},{"id":"c8e135f3e542bb1b","type":"debug","z":"23dbb1ee.bc2e8e","name":"lon","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":1018.5,"y":618,"wires":[]},{"id":"602fb2020680280c","type":"debug","z":"23dbb1ee.bc2e8e","name":"alt","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":1017.5,"y":654,"wires":[]},{"id":"ed424ae3d45dd2ac","type":"debug","z":"23dbb1ee.bc2e8e","name":"time","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":1018.5,"y":688,"wires":[]},{"id":"6f592d47b6a2eac4","type":"function","z":"23dbb1ee.bc2e8e","name":"Split Decoded 1","func":"var channelId = { payload: msg.payload.channelId};\nvar gatewayId = { payload: msg.payload.gatewayId};\nvar portnum = { payload: msg.payload.packet.decoded.portnum};\nvar fr= {payload: \"!\" + msg.payload.packet.from.toString(16)};\nvar to = {payload:\"!\"+ msg.payload.packet.to.toString(16)};\n\nreturn [channelId, gatewayId, portnum, fr, to ];","outputs":5,"noerr":0,"initialize":"","finalize":"","libs":[],"x":577.5,"y":294,"wires":[["c6afbb9f1665b162"],["607ef387d5701985","8abb1bb458af2c4f"],["61995c9f8e8266b3"],["fd881fac22422773","a389f9875da672ec"],["cf066ad415df30ae"]]},{"id":"fd881fac22422773","type":"debug","z":"23dbb1ee.bc2e8e","name":"from","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":772.5,"y":365,"wires":[]},{"id":"cf066ad415df30ae","type":"debug","z":"23dbb1ee.bc2e8e","name":"to","active":false,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":771.5,"y":399,"wires":[]},{"id":"a389f9875da672ec","type":"change","z":"23dbb1ee.bc2e8e","name":"set flow.from","rules":[{"t":"set","p":"from","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":1012.5,"y":364,"wires":[[]]},{"id":"a0d4288141f6a629","type":"protobuf-file","protopath":"E:\\Meshtastic-protobufs-master\\mqtt.proto","watchFile":true,"keepCase":false},{"id":"37cadac381653b1e","type":"mqtt-broker","name":"","broker":"192.168.2.45","port":"1883","clientid":"","autoConnect":true,"usetls":false,"protocolVersion":"4","keepalive":"60","cleansession":true,"birthTopic":"","birthQos":"0","birthPayload":"","birthMsg":{},"closeTopic":"","closeQos":"0","closePayload":"","closeMsg":{},"willTopic":"","willQos":"0","willPayload":"","willMsg":{},"userProps":"","sessionExpiry":""},{"id":"dbab6472b07929a0","type":"protobuf-file","protopath":"E:\\Meshtastic-protobufs-master\\mesh.proto","watchFile":true,"keepCase":false}] +```json +[ + { + "id": "10fe1b2e9cb3feb2", + "type": "decode", + "z": "23dbb1ee.bc2e8e", + "name": "decode Protobuf", + "protofile": "a0d4288141f6a629", + "protoType": "ServiceEnvelope", + "x": 295.5, + "y": 285, + "wires": [["d3e396cf4f0a9608", "d08865b41a69d85d", "6f592d47b6a2eac4"]] + }, + { + "id": "40c9ee66fe7a34cb", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "function get the message as string from TEXT_MESSAGE_APP", + "func": "msg.payload = msg.payload.packet.decoded.payload;\n\nlet bufferObj = Buffer.from(msg.payload, \"base64\");\nlet decodedString = bufferObj.toString(\"utf8\");\nmsg.payload = decodedString;\n\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 410.5, + "y": 450, + "wires": [["553374591214eaca"]] + }, + { + "id": "553374591214eaca", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "text message out", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 762.5, + "y": 449, + "wires": [] + }, + { + "id": "c6afbb9f1665b162", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "channelId", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 785.5, + "y": 257, + "wires": [] + }, + { + "id": "607ef387d5701985", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "gatewayId", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 792.5, + "y": 293, + "wires": [] + }, + { + "id": "d3e396cf4f0a9608", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "entire payload", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 296.5, + "y": 247, + "wires": [] + }, + { + "id": "2339b328bb9bb1d8", + "type": "comment", + "z": "23dbb1ee.bc2e8e", + "name": "Decode all cleartext text and position messages sent by Meshtastic devices into JSON without relying on JSON conversion on the device.", + "info": "", + "x": 515.5, + "y": 214, + "wires": [] + }, + { + "id": "408d796d997bb832", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "function get the nested payload as base64", + "func": "msg.payload = msg.payload.packet.decoded.payload;\n\nlet bufferObj = Buffer.from(msg.payload, \"base64\");\n//let decodedString = bufferObj.toString(\"hex\");\nmsg.payload = bufferObj;\nmsg.topic=\"\";\n//if you don't zero out the protubufTopic it will try to\n//decode it as part of the mqtt service envelope instead\n//of two-stage decoding\nmsg.protobufType=null;\n\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 349, + "y": 552, + "wires": [["9435a3c605efedb4", "1ed6f96c8214d7b3"]] + }, + { + "id": "61995c9f8e8266b3", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "portnum", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 784.5, + "y": 330, + "wires": [] + }, + { + "id": "9435a3c605efedb4", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "nested payload", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "true", + "targetType": "full", + "statusVal": "", + "statusType": "auto", + "x": 281.5, + "y": 603, + "wires": [] + }, + { + "id": "b832775d386f7ac9", + "type": "mqtt in", + "z": "23dbb1ee.bc2e8e", + "name": "", + "topic": "msh/+/c/#", + "qos": "2", + "datatype": "buffer", + "broker": "37cadac381653b1e", + "nl": false, + "rap": true, + "rh": 0, + "inputs": 0, + "x": 117.5, + "y": 286, + "wires": [["10fe1b2e9cb3feb2"]] + }, + { + "id": "d08865b41a69d85d", + "type": "switch", + "z": "23dbb1ee.bc2e8e", + "name": "switch manual decoding nested message based on portum", + "property": "payload.packet.decoded.portnum", + "propertyType": "msg", + "rules": [ + { "t": "eq", "v": "TEXT_MESSAGE_APP", "vt": "str" }, + { "t": "eq", "v": "POSITION_APP", "vt": "str" } + ], + "checkall": "true", + "repair": false, + "outputs": 2, + "x": 281.5, + "y": 505, + "wires": [["40c9ee66fe7a34cb"], ["408d796d997bb832"]] + }, + { + "id": "8abb1bb458af2c4f", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "gatewayId", + "pt": "flow", + "to": "payload", + "tot": "msg" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 1021.5, + "y": 288, + "wires": [[]] + }, + { + "id": "1ced0be28eeef0d3", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "latitude", + "pt": "flow", + "to": "payload", + "tot": "msg" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 1026.5, + "y": 407, + "wires": [[]] + }, + { + "id": "313fd3cfe6d91850", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "longitude", + "pt": "flow", + "to": "payload", + "tot": "msg" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 1036.5, + "y": 450, + "wires": [["d02e53cdfb565da6"]] + }, + { + "id": "33dd43e3c05f826c", + "type": "geofence", + "z": "23dbb1ee.bc2e8e", + "name": "geofence", + "mode": "circle", + "inside": "true", + "rad": 69174.91569647488, + "points": [], + "centre": { + "latitude": 40.16287050252407, + "longitude": -86.60385131835938 + }, + "floor": "", + "ceiling": "", + "worldmap": true, + "outputs": 2, + "x": 1202.5, + "y": 595, + "wires": [[], ["4d01eb8f1b31f039"]] + }, + { + "id": "d02e53cdfb565da6", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "trigger function to send a mapping point", + "func": "let lat = parseFloat(flow.get(\"latitude\"));\nlet lon = parseFloat(flow.get(\"longitude\"));\nlat=lat * 0.0000001;\nlon=lon * 0.0000001;\nlet name = flow.get(\"from\")\n\nmsg={\"payload\":{\"name\":name,\n \"lat\":lat,\n \"lon\":lon,\n \"action\":\"send\",\n \"icon\": \"car\",\n \"label\":name\n }}\n\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1181.5, + "y": 520, + "wires": [["33dd43e3c05f826c", "4d01eb8f1b31f039"]] + }, + { + "id": "4d01eb8f1b31f039", + "type": "worldmap", + "z": "23dbb1ee.bc2e8e", + "name": "", + "lat": "40", + "lon": "-86", + "zoom": "7", + "layer": "OSMG", + "cluster": "", + "maxage": "", + "usermenu": "show", + "layers": "show", + "panit": "false", + "panlock": "false", + "zoomlock": "false", + "hiderightclick": "false", + "coords": "none", + "showgrid": "false", + "showruler": "false", + "allowFileDrop": "false", + "path": "/worldmap", + "overlist": "DR,CO,RA,DN,HM", + "maplist": "OSMG,OSMC,EsriC,EsriS,EsriT,EsriDG,UKOS", + "mapname": "", + "mapurl": "", + "mapopt": "", + "mapwms": false, + "x": 1206.5, + "y": 675, + "wires": [] + }, + { + "id": "1ed6f96c8214d7b3", + "type": "decode", + "z": "23dbb1ee.bc2e8e", + "name": "decode Position Protobuf", + "protofile": "dbab6472b07929a0", + "protoType": "Position", + "x": 667.5, + "y": 548, + "wires": [["db1933ba36503bd9", "dad9f487318f21d9"]] + }, + { + "id": "db1933ba36503bd9", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "Position decoded", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "true", + "targetType": "full", + "statusVal": "", + "statusType": "auto", + "x": 673.5, + "y": 607, + "wires": [] + }, + { + "id": "dad9f487318f21d9", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "Split", + "func": "var lat = { payload: msg.payload.latitudeI };\nvar lon = { payload: msg.payload.longitudeI };\nvar alt = { payload: msg.payload.altitude };\nvar tm = { payload: msg.payload.time };\n\nreturn [lat,lon,alt,tm];", + "outputs": 4, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 875.5, + "y": 549, + "wires": [ + ["1ced0be28eeef0d3", "8bb97f802662976c"], + ["313fd3cfe6d91850", "c8e135f3e542bb1b"], + ["602fb2020680280c"], + ["ed424ae3d45dd2ac"] + ] + }, + { + "id": "8bb97f802662976c", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "lat", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 1017.5, + "y": 583, + "wires": [] + }, + { + "id": "c8e135f3e542bb1b", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "lon", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 1018.5, + "y": 618, + "wires": [] + }, + { + "id": "602fb2020680280c", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "alt", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 1017.5, + "y": 654, + "wires": [] + }, + { + "id": "ed424ae3d45dd2ac", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "time", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 1018.5, + "y": 688, + "wires": [] + }, + { + "id": "6f592d47b6a2eac4", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "Split Decoded 1", + "func": "var channelId = { payload: msg.payload.channelId};\nvar gatewayId = { payload: msg.payload.gatewayId};\nvar portnum = { payload: msg.payload.packet.decoded.portnum};\nvar fr= {payload: \"!\" + msg.payload.packet.from.toString(16)};\nvar to = {payload:\"!\"+ msg.payload.packet.to.toString(16)};\n\nreturn [channelId, gatewayId, portnum, fr, to ];", + "outputs": 5, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 577.5, + "y": 294, + "wires": [ + ["c6afbb9f1665b162"], + ["607ef387d5701985", "8abb1bb458af2c4f"], + ["61995c9f8e8266b3"], + ["fd881fac22422773", "a389f9875da672ec"], + ["cf066ad415df30ae"] + ] + }, + { + "id": "fd881fac22422773", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "from", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 772.5, + "y": 365, + "wires": [] + }, + { + "id": "cf066ad415df30ae", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "to", + "active": false, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 771.5, + "y": 399, + "wires": [] + }, + { + "id": "a389f9875da672ec", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "set flow.from", + "rules": [ + { "t": "set", "p": "from", "pt": "flow", "to": "payload", "tot": "msg" } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 1012.5, + "y": 364, + "wires": [[]] + }, + { + "id": "a0d4288141f6a629", + "type": "protobuf-file", + "protopath": "E:\\Meshtastic-protobufs-master\\mqtt.proto", + "watchFile": true, + "keepCase": false + }, + { + "id": "37cadac381653b1e", + "type": "mqtt-broker", + "name": "", + "broker": "192.168.2.45", + "port": "1883", + "clientid": "", + "autoConnect": true, + "usetls": false, + "protocolVersion": "4", + "keepalive": "60", + "cleansession": true, + "birthTopic": "", + "birthQos": "0", + "birthPayload": "", + "birthMsg": {}, + "closeTopic": "", + "closeQos": "0", + "closePayload": "", + "closeMsg": {}, + "willTopic": "", + "willQos": "0", + "willPayload": "", + "willMsg": {}, + "userProps": "", + "sessionExpiry": "" + }, + { + "id": "dbab6472b07929a0", + "type": "protobuf-file", + "protopath": "E:\\Meshtastic-protobufs-master\\mesh.proto", + "watchFile": true, + "keepCase": false + } +] ``` (documents/mqtt/Flow.txt) @@ -287,8 +842,314 @@ Advanced use, such as encoding Position and sending it to a device via MQTT with [](/documents/mqtt/EncodingPosition.jpg) The flow is: -``` -[{"id":"32ca608d9e7c5236","type":"inject","z":"23dbb1ee.bc2e8e","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":96.5,"y":1952,"wires":[["2b536512e8c7aef2"]]},{"id":"20bbd2d1408b8dc5","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"channelId_outbound","pt":"flow","to":"LongFast","tot":"str"}],"action":"","property":"","from":"","to":"","reg":false,"x":772,"y":2027,"wires":[[]]},{"id":"c6cb373157be01d6","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"gatewayId_outbound","pt":"flow","to":"\"!55c7312c\"","tot":"str"}],"action":"","property":"","from":"","to":"","reg":false,"x":772,"y":2066,"wires":[[]]},{"id":"24199ec7eaf89c1a","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"portnum_outbound","pt":"flow","to":"3","tot":"num"}],"action":"","property":"","from":"","to":"","reg":false,"x":774,"y":2106,"wires":[[]]},{"id":"de38ad5ef343623a","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"from_outbound","pt":"flow","to":"1439117612","tot":"num"}],"action":"","property":"","from":"","to":"","reg":false,"x":781,"y":2146,"wires":[[]]},{"id":"d435e8abe0852f93","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"to_outbound","pt":"flow","to":"4294967295","tot":"num"}],"action":"","property":"","from":"","to":"","reg":false,"x":790,"y":2188,"wires":[[]]},{"id":"1f8d172708898860","type":"function","z":"23dbb1ee.bc2e8e","name":"Assemble Position protobuf","func":"msg.protobufType=null;\nmsg.payload =\n{\n \"packet\": {\n \"from\": flow.get(\"from_outbound\"),\n \"to\": flow.get(\"to_outbound\"), \n \"decoded\":{\n //how ENUMS are handled here\n //portnum is decoded as string but encoded as number\n //in the encode/decode node-red nodes based on protobuf.js\n \"portnum\": flow.get(\"portnum_outbound\"),\n \"payload\": msg.payload \n } \n },\n\n \"channelId\": flow.get(\"channelId_outbound\"),\n \"gatewayId\": flow.get(\"gatewayId_outbound\"),\n};\nreturn msg;\n//info on how to get json data into protobuf \"bytes\" field\n//https://github.com/protobufjs/protobuf.js/wiki/Changes-in-ProtoBuf.js-3.8","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1086,"y":2019,"wires":[["b8ccf1cfe8bf40a3"]]},{"id":"b8ccf1cfe8bf40a3","type":"encode","z":"23dbb1ee.bc2e8e","name":"","protofile":"a0d4288141f6a629","protoType":"ServiceEnvelope","x":1287,"y":2020,"wires":[["dbc78f035c9c2b56","a002c148f3a06bac"]]},{"id":"03a7e69ca6d471fe","type":"debug","z":"23dbb1ee.bc2e8e","name":"show hex string","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"true","targetType":"full","statusVal":"","statusType":"auto","x":1319,"y":2180,"wires":[]},{"id":"dbc78f035c9c2b56","type":"function","z":"23dbb1ee.bc2e8e","name":"dump payload as hex string","func":"var hex=Buffer.from(msg.payload,\"hex\");\nmsg.payload=hex.toString(\"hex\");\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1096,"y":2178,"wires":[["03a7e69ca6d471fe"]]},{"id":"2b536512e8c7aef2","type":"function","z":"23dbb1ee.bc2e8e","name":"Inject lat lon alt","func":"msg.payload={\n \"latitudeI\": 399600000,\n \"longitudeI\": -862600000,\n \"altitude\": 100\n}\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":277.5,"y":1953,"wires":[["9443a9a980e54c75"]]},{"id":"9443a9a980e54c75","type":"encode","z":"23dbb1ee.bc2e8e","name":"encode Position as protobuf","protofile":"dbab6472b07929a0","protoType":"Position","x":506,"y":1953,"wires":[["5c36d3a7f4dca14e"]]},{"id":"5c36d3a7f4dca14e","type":"change","z":"23dbb1ee.bc2e8e","name":"","rules":[{"t":"set","p":"nested_outbound","pt":"flow","to":"payload","tot":"msg"}],"action":"","property":"","from":"","to":"","reg":false,"x":776,"y":1952,"wires":[["20bbd2d1408b8dc5","c6cb373157be01d6","24199ec7eaf89c1a","de38ad5ef343623a","d435e8abe0852f93","04d0c4a5f3485c6f"]]},{"id":"04d0c4a5f3485c6f","type":"function","z":"23dbb1ee.bc2e8e","name":"dump payload as base64 string","func":"var hex=Buffer.from(msg.payload,\"base64\");\nmsg.payload=hex.toString(\"base64\");\nreturn msg;","outputs":1,"noerr":0,"initialize":"","finalize":"","libs":[],"x":1082,"y":1952,"wires":[["1f8d172708898860"]]},{"id":"a002c148f3a06bac","type":"decode","z":"23dbb1ee.bc2e8e","name":"test decode Protobuf","protofile":"a0d4288141f6a629","protoType":"ServiceEnvelope","x":1249,"y":1860,"wires":[["4b6fc79398d05782"]]},{"id":"4b6fc79398d05782","type":"debug","z":"23dbb1ee.bc2e8e","name":"test entire payload","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":1458,"y":1859,"wires":[]},{"id":"a0d4288141f6a629","type":"protobuf-file","protopath":"E:\\Meshtastic-protobufs-master\\mqtt.proto","watchFile":true,"keepCase":false},{"id":"dbab6472b07929a0","type":"protobuf-file","protopath":"E:\\Meshtastic-protobufs-master\\mesh.proto","watchFile":true,"keepCase":false}] +```json +[ + { + "id": "32ca608d9e7c5236", + "type": "inject", + "z": "23dbb1ee.bc2e8e", + "name": "", + "props": [{ "p": "payload" }, { "p": "topic", "vt": "str" }], + "repeat": "", + "crontab": "", + "once": false, + "onceDelay": 0.1, + "topic": "", + "payload": "", + "payloadType": "date", + "x": 96.5, + "y": 1952, + "wires": [["2b536512e8c7aef2"]] + }, + { + "id": "20bbd2d1408b8dc5", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "channelId_outbound", + "pt": "flow", + "to": "LongFast", + "tot": "str" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 772, + "y": 2027, + "wires": [[]] + }, + { + "id": "c6cb373157be01d6", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "gatewayId_outbound", + "pt": "flow", + "to": "\"!55c7312c\"", + "tot": "str" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 772, + "y": 2066, + "wires": [[]] + }, + { + "id": "24199ec7eaf89c1a", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "portnum_outbound", + "pt": "flow", + "to": "3", + "tot": "num" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 774, + "y": 2106, + "wires": [[]] + }, + { + "id": "de38ad5ef343623a", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "from_outbound", + "pt": "flow", + "to": "1439117612", + "tot": "num" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 781, + "y": 2146, + "wires": [[]] + }, + { + "id": "d435e8abe0852f93", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "to_outbound", + "pt": "flow", + "to": "4294967295", + "tot": "num" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 790, + "y": 2188, + "wires": [[]] + }, + { + "id": "1f8d172708898860", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "Assemble Position protobuf", + "func": "msg.protobufType=null;\nmsg.payload =\n{\n \"packet\": {\n \"from\": flow.get(\"from_outbound\"),\n \"to\": flow.get(\"to_outbound\"), \n \"decoded\":{\n //how ENUMS are handled here\n //portnum is decoded as string but encoded as number\n //in the encode/decode node-red nodes based on protobuf.js\n \"portnum\": flow.get(\"portnum_outbound\"),\n \"payload\": msg.payload \n } \n },\n\n \"channelId\": flow.get(\"channelId_outbound\"),\n \"gatewayId\": flow.get(\"gatewayId_outbound\"),\n};\nreturn msg;\n//info on how to get json data into protobuf \"bytes\" field\n//https://github.com/protobufjs/protobuf.js/wiki/Changes-in-ProtoBuf.js-3.8", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1086, + "y": 2019, + "wires": [["b8ccf1cfe8bf40a3"]] + }, + { + "id": "b8ccf1cfe8bf40a3", + "type": "encode", + "z": "23dbb1ee.bc2e8e", + "name": "", + "protofile": "a0d4288141f6a629", + "protoType": "ServiceEnvelope", + "x": 1287, + "y": 2020, + "wires": [["dbc78f035c9c2b56", "a002c148f3a06bac"]] + }, + { + "id": "03a7e69ca6d471fe", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "show hex string", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "true", + "targetType": "full", + "statusVal": "", + "statusType": "auto", + "x": 1319, + "y": 2180, + "wires": [] + }, + { + "id": "dbc78f035c9c2b56", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "dump payload as hex string", + "func": "var hex=Buffer.from(msg.payload,\"hex\");\nmsg.payload=hex.toString(\"hex\");\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1096, + "y": 2178, + "wires": [["03a7e69ca6d471fe"]] + }, + { + "id": "2b536512e8c7aef2", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "Inject lat lon alt", + "func": "msg.payload={\n \"latitudeI\": 399600000,\n \"longitudeI\": -862600000,\n \"altitude\": 100\n}\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 277.5, + "y": 1953, + "wires": [["9443a9a980e54c75"]] + }, + { + "id": "9443a9a980e54c75", + "type": "encode", + "z": "23dbb1ee.bc2e8e", + "name": "encode Position as protobuf", + "protofile": "dbab6472b07929a0", + "protoType": "Position", + "x": 506, + "y": 1953, + "wires": [["5c36d3a7f4dca14e"]] + }, + { + "id": "5c36d3a7f4dca14e", + "type": "change", + "z": "23dbb1ee.bc2e8e", + "name": "", + "rules": [ + { + "t": "set", + "p": "nested_outbound", + "pt": "flow", + "to": "payload", + "tot": "msg" + } + ], + "action": "", + "property": "", + "from": "", + "to": "", + "reg": false, + "x": 776, + "y": 1952, + "wires": [ + [ + "20bbd2d1408b8dc5", + "c6cb373157be01d6", + "24199ec7eaf89c1a", + "de38ad5ef343623a", + "d435e8abe0852f93", + "04d0c4a5f3485c6f" + ] + ] + }, + { + "id": "04d0c4a5f3485c6f", + "type": "function", + "z": "23dbb1ee.bc2e8e", + "name": "dump payload as base64 string", + "func": "var hex=Buffer.from(msg.payload,\"base64\");\nmsg.payload=hex.toString(\"base64\");\nreturn msg;", + "outputs": 1, + "noerr": 0, + "initialize": "", + "finalize": "", + "libs": [], + "x": 1082, + "y": 1952, + "wires": [["1f8d172708898860"]] + }, + { + "id": "a002c148f3a06bac", + "type": "decode", + "z": "23dbb1ee.bc2e8e", + "name": "test decode Protobuf", + "protofile": "a0d4288141f6a629", + "protoType": "ServiceEnvelope", + "x": 1249, + "y": 1860, + "wires": [["4b6fc79398d05782"]] + }, + { + "id": "4b6fc79398d05782", + "type": "debug", + "z": "23dbb1ee.bc2e8e", + "name": "test entire payload", + "active": true, + "tosidebar": true, + "console": false, + "tostatus": false, + "complete": "payload", + "targetType": "msg", + "statusVal": "", + "statusType": "auto", + "x": 1458, + "y": 1859, + "wires": [] + }, + { + "id": "a0d4288141f6a629", + "type": "protobuf-file", + "protopath": "E:\\Meshtastic-protobufs-master\\mqtt.proto", + "watchFile": true, + "keepCase": false + }, + { + "id": "dbab6472b07929a0", + "type": "protobuf-file", + "protopath": "E:\\Meshtastic-protobufs-master\\mesh.proto", + "watchFile": true, + "keepCase": false + } +] ``` 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. diff --git a/docs/software/python-cli/index.mdx b/docs/software/python-cli/index.mdx index e54f3450..23fe0c95 100644 --- a/docs/software/python-cli/index.mdx +++ b/docs/software/python-cli/index.mdx @@ -1,13 +1,11 @@ --- id: python-cli -title: Meshtastic Command Line Interface +title: Meshtastic Python CLI Guide slug: /software/python/cli sidebar_label: Python CLI sidebar_position: 4 --- -# Meshtastic Python CLI Guide - The python pip package installs a "meshtastic" command line executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. This command is not run inside of python, you run it from your operating system shell prompt directly. If when you type "meshtastic" it doesn't find the command and you are using Windows: Check that the python "scripts" directory is in your path. ## Optional Arguments @@ -16,9 +14,7 @@ The python pip package installs a "meshtastic" command line executable, which di Shows a help message that describes the arguments. -**Usage** - -```shell +```shell title="Usage" meshtastic -h ``` @@ -26,9 +22,7 @@ meshtastic -h The port the Meshtastic device is connected to, i.e. `/dev/ttyUSB0`, `/dev/cu.wchusbserial`, `COM4` etc. if unspecified, meshtastic will try to find it. Important to use when multiple devices are connected to ensure you call the command for the correct device. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --info meshtastic --port COM4 --info ``` @@ -37,9 +31,7 @@ meshtastic --port COM4 --info The hostname/ipaddr of the device to connect to (over TCP). -**Usage** - -```shell +```shell title="Usage" meshtastic --host HOST ``` @@ -47,9 +39,7 @@ meshtastic --host HOST Logs device serial output to either 'stdout', 'none' or a filename to append to. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --seriallog ``` @@ -57,9 +47,7 @@ meshtastic --port /dev/ttyUSB0 --seriallog Read and display the radio config information. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --info ``` @@ -67,9 +55,7 @@ meshtastic --port /dev/ttyUSB0 --info Prints a node list in a pretty, formatted table. -**Usage** - -```shell +```shell title="Usage" meshtastic --nodes ``` @@ -77,9 +63,7 @@ meshtastic --nodes Displays the QR code that corresponds to the current channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --qr ``` @@ -87,9 +71,7 @@ meshtastic --qr Gets a preferences field. -**Usage** - -```shell +```shell title="Usage" meshtastic --get lora.region ``` @@ -99,9 +81,7 @@ Sets a preferences field. Configuration values are described in this section: [Configuration Sections](https://meshtastic.org/docs/settings/config) -**Usage** - -```shell +```shell title="Usage" meshtastic --set lora.region Unset ``` @@ -109,9 +89,7 @@ meshtastic --set lora.region Unset Set a channel URL. -**Usage** - -```shell +```shell title="Usage" meshtastic --seturl https://www.meshtastic.org/c/GAMiIE67C6zsNmlWQ-KE1tKt0fRKFciHka-DShI6G7ElvGOiKgZzaGFyZWQ= ``` @@ -119,9 +97,7 @@ meshtastic --seturl https://www.meshtastic.org/c/GAMiIE67C6zsNmlWQ-KE1tKt0fRKFci Set the specified channel index -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-index 1 --ch-disable ``` @@ -129,9 +105,7 @@ meshtastic --ch-index 1 --ch-disable Add a secondary channel, you must specify a channel name. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-add testing-channel ``` @@ -139,9 +113,7 @@ meshtastic --ch-add testing-channel Delete the ch-index channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-index 1 --ch-del ``` @@ -149,9 +121,7 @@ meshtastic --ch-index 1 --ch-del Enable the specified channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-index 1 --ch-enable ``` @@ -159,9 +129,7 @@ meshtastic --ch-index 1 --ch-enable Disable the specified channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-index 1 --ch-disable ``` @@ -169,9 +137,7 @@ meshtastic --ch-index 1 --ch-disable Set a channel parameter. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-set id 1234 --ch-index 0 ``` @@ -179,9 +145,7 @@ meshtastic --ch-set id 1234 --ch-index 0 Change to the standard long-range (but slow) channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-longslow ``` @@ -189,9 +153,7 @@ meshtastic --ch-longslow Change to the standard fast (but short range) channel. -**Usage** - -```shell +```shell title="Usage" meshtastic --ch-shortfast ``` @@ -199,9 +161,7 @@ meshtastic --ch-shortfast Set device owner name. -**Usage** - -```shell +```shell title="Usage" meshtastic --dest '!28979058' --set-owner "MeshyJohn" ``` @@ -209,9 +169,7 @@ meshtastic --dest '!28979058' --set-owner "MeshyJohn" Set licensed Ham ID and turn off encryption. -**Usage** - -```shell +```shell title="Usage" meshtastic --set-ham KI1345 ``` @@ -219,9 +177,7 @@ meshtastic --set-ham KI1345 The destination node id for any sent commands -**Usage** - -```shell +```shell title="Usage" meshtastic --dest '!28979058' --set-owner "MeshyJohn" ``` @@ -229,9 +185,7 @@ meshtastic --dest '!28979058' --set-owner "MeshyJohn" Send a text message. Can specify a channel index ('--ch-index') or a destination ('--dest') -**Usage** - -```shell +```shell title="Usage" meshtastic --sendtext "Hello Mesh!" ``` @@ -239,9 +193,7 @@ meshtastic --sendtext "Hello Mesh!" Send a ping message (which requests a reply). -**Usage** - -```shell +```shell title="Usage" meshtastic --sendping ``` @@ -249,9 +201,7 @@ meshtastic --sendping Tell the destination node to reboot. -**Usage** - -```shell +```shell title="Usage" meshtastic --dest '!28979058' --reboot ``` @@ -259,9 +209,7 @@ meshtastic --dest '!28979058' --reboot Reply to received messages. -**Usage** - -```shell +```shell title="Usage" meshtastic --reply ``` @@ -269,9 +217,7 @@ meshtastic --reply Set a particular GPIO # to 1 or 0. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest '!28979058' ``` @@ -279,9 +225,7 @@ meshtastic --port /dev/ttyUSB0 --gpio-wrb 4 1 --dest '!28979058' Read from a GPIO mask. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest '!28979058' ``` @@ -289,9 +233,7 @@ meshtastic --port /dev/ttyUSB0 --gpio-rd 0x10 --dest '!28979058' Start watching a GPIO mask for changes. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest '!28979058' ``` @@ -299,9 +241,7 @@ meshtastic --port /dev/ttyUSB0 --gpio-watch 0x10 --dest '!28979058' Suppress sending the current time to the mesh. -**Usage** - -```shell +```shell title="Usage" meshtastic --port /dev/ttyUSB0 --no-time ``` @@ -309,9 +249,7 @@ meshtastic --port /dev/ttyUSB0 --no-time Set device altitude (allows use without GPS). -**Usage** - -```shell +```shell title="Usage" meshtastic --setalt 120 ``` @@ -319,9 +257,7 @@ meshtastic --setalt 120 Set device latitude (allows use without GPS). -**Usage** - -```shell +```shell title="Usage" meshtastic --setlat 25.2 ``` @@ -329,9 +265,7 @@ meshtastic --setlat 25.2 Set device longitude (allows use without GPS). -**Usage** - -```shell +```shell title="Usage" meshtastic --setlon -16.8 ``` @@ -339,9 +273,7 @@ meshtastic --setlon -16.8 Show API library debug log messages. -**Usage** - -```shell +```shell title="Usage" meshtastic --debug --info ``` @@ -349,9 +281,7 @@ meshtastic --debug --info Run stress test against all connected Meshtastic devices. -**Usage** - -```shell +```shell title="Usage" meshtastic --test ``` @@ -359,9 +289,7 @@ meshtastic --test BLE mac address to connect to (BLE is not yet supported for this tool). -**Usage** - -```shell +```shell title="Usage" meshtastic --ble "83:38:92:32:37:48" ``` @@ -369,9 +297,7 @@ meshtastic --ble "83:38:92:32:37:48" Don't start the API, just function as a dumb serial terminal. Probably not very helpful from the command line. Used more for testing/internal needs. -**Usage** - -```shell +```shell title="Usage" meshtastic --noproto ``` @@ -379,9 +305,7 @@ meshtastic --noproto Show program's version number and exit. -**Usage** - -```shell +```shell title="Usage" meshtastic --version ``` @@ -389,9 +313,7 @@ meshtastic --version Configure all of the radio configuration from a yaml file. -**Usage** - -```shell +```shell title="Usage" meshtastic --configure example_config.yaml ``` @@ -401,15 +323,11 @@ Export the configuration of the device. (to be consumed by the '--configure' com To create to a file with the connected device's configuration, this command's output must be piped to a yaml file -**Usage** - -```shell +```shell title="Usage" meshtastic --export-config > example_config.yaml ``` -**Usage** - -```shell +```title="Usage"shell meshtastic --export-config ``` @@ -417,9 +335,7 @@ meshtastic --export-config Print out info that would be helpful supporting any issues. -**Usage** - -```shell +```shell title="Usage" meshtastic --support ``` diff --git a/docs/software/python-cli/installation.mdx b/docs/software/python-cli/installation.mdx index 6a47a018..51aaa98d 100644 --- a/docs/software/python-cli/installation.mdx +++ b/docs/software/python-cli/installation.mdx @@ -6,8 +6,8 @@ slug: /software/python/cli/installation sidebar_position: 1 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; This library provides a command line interface (CLI) for Meshtastic nodes and provides an easy API for sending and receiving messages over mesh radios, in addition to changing user settings. Using the command line is currently the most powerful. Events are delivered using a publish-subscribe model, and you can subscribe to only the message types you are interested in. @@ -177,19 +177,19 @@ Wifi connection is currently under development and may not be working properly j - Install [Termux](https://f-droid.org/en/packages/com.termux) from the F-Droid app store (Google play does not currently support the latest builds) - Load Termux and update the package list - ``` + ```shell pkg update ``` - Upgrade the installed packages - ``` + ```shell pkg upgrade ``` - Install python - ``` + ```shell pkg install python ``` - Upgrade pip and installed meshtastic and some of its dependencies - ``` + ```shell pip install --upgrade pip pygatt pytap2 wheel mesthtastic ``` @@ -204,10 +204,8 @@ Be aware that the Meshtastic CLI is not able to control the nodes over USB throu You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing. ::: - ## Standalone - There are standalone executable files for Mac, Windows and Ubuntu. A single file is all you need to run the command line interface (CLI) Meshtastic tool. There is a zip file per operating system. To use, see the operating system specific notes below: They can be found on the [Releases](https://github.com/meshtastic/Meshtastic-python/releases) page. @@ -226,13 +224,13 @@ values={[ - Run the following command to make the file executable and rename it 'meshtastic': -``` +```shell chmod +x meshtastic_ubuntu && mv meshtastic_ubuntu meshtastic ``` - To run the cli: -``` +```shell ./meshtastic ``` @@ -247,13 +245,13 @@ Copy (or move) this binary somewhere in your path. - Run the following command to make the file executable and to rename it 'meshtastic': -``` +```shell chmod +x meshtastic_mac && mv meshtastic_mac meshtastic ``` - Try to run it: -``` +```shell ./meshtastic ``` @@ -266,7 +264,7 @@ You may get a dialog that says: - Try to run it again: -``` +```shell ./meshtastic ``` @@ -278,7 +276,7 @@ Click "Open". - Now when you want to run it, you can simply run: -``` +```shell ./meshtastic ``` @@ -295,10 +293,9 @@ Copy (or move) this binary somewhere in your path. - To run, open a windows command prompt, navigate to the location of the executable and run: -``` +```shell meshtastic.exe ``` - diff --git a/docs/software/python-cli/usage.mdx b/docs/software/python-cli/usage.mdx index a00001a9..76d350da 100644 --- a/docs/software/python-cli/usage.mdx +++ b/docs/software/python-cli/usage.mdx @@ -100,11 +100,11 @@ Toggling `set-ham` changes your device settings in the following ways. | `ShortName` | _Abrv CallSign_ | See [User Config - ShortName](/docs/settings/config/user#short-name) | | `PSK` | `""` | See [Channel Settings - PSK](#changing-the-preshared-key) | -## Changing the preshared key: +## Changing the preshared key You can set the channel preshared key to a particular AES128 or AES256 sequence. -``` +```shell meshtastic --ch-set psk 0x1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b1a1a1a1a2b2b2b2b --info ``` diff --git a/docs/software/python-flasher.mdx b/docs/software/python-flasher.mdx index 76ffdba3..420a45db 100644 --- a/docs/software/python-flasher.mdx +++ b/docs/software/python-flasher.mdx @@ -6,9 +6,9 @@ slug: /software/python/flasher sidebar_position: 5 --- -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import Link from '@docusaurus/Link'; +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import Link from "@docusaurus/Link"; :::caution Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip! @@ -90,7 +90,6 @@ sudo apt install -y python3 python3-pip python3-venv - ### Install or Upgrade App For **Windows**, the [installer](https://github.com/meshtastic/Meshtastic-gui-installer/releases/download/winapp1.0.3/meshtastic-flasher.zip) will manage installing python and flasher updates automatically. diff --git a/src/components/hardware/Tabs/PowerTab.tsx b/src/components/hardware/Tabs/PowerTab.tsx index b1ac6013..8f4ec10c 100644 --- a/src/components/hardware/Tabs/PowerTab.tsx +++ b/src/components/hardware/Tabs/PowerTab.tsx @@ -8,6 +8,6 @@ export interface PowerTabProps { device: IDevice; } -export const PowerTab = ({}: PowerTabProps): JSX.Element => { +export const PowerTab = (): JSX.Element => { return Content 1; }; diff --git a/src/pages/2.0/index.tsx b/src/pages/2.0/index.tsx index 096d685f..d7e3f026 100644 --- a/src/pages/2.0/index.tsx +++ b/src/pages/2.0/index.tsx @@ -3,7 +3,6 @@ import React from "react"; import { FiTwitter } from "react-icons/fi"; import { ChevronRightIcon } from "@heroicons/react/20/solid"; -import FlipClockCountdown from "@leenguyen/react-flip-clock-countdown"; import Layout from "@theme/Layout"; import { Dark, Light } from "/src/components/ColorMode"; diff --git a/src/pages/credits/_components/Avatar.tsx b/src/pages/credits/_components/Avatar.tsx index bc1a4e3e..1995b298 100644 --- a/src/pages/credits/_components/Avatar.tsx +++ b/src/pages/credits/_components/Avatar.tsx @@ -14,7 +14,6 @@ export interface avatarLayoutProps { export const Avatar = ({ imgUrl, name, - userName, description }: avatarProps): JSX.Element => { return ( @@ -36,7 +35,7 @@ export const AvatarLayout = ({ list }: avatarLayoutProps): JSX.Element => { return (
- {list.map((e) => { + {list.map(() => { return ; })}
diff --git a/src/pages/credits/index.tsx b/src/pages/credits/index.tsx index dacfa0a4..3d1b6416 100644 --- a/src/pages/credits/index.tsx +++ b/src/pages/credits/index.tsx @@ -2,7 +2,7 @@ import React from "react"; import Layout from "@theme/Layout"; import Link from "@docusaurus/Link"; -import { Avatar, AvatarLayout } from "./_components/Avatar"; +import { AvatarLayout } from "./_components/Avatar"; const Credits = (): JSX.Element => { const partnerLogos = [ diff --git a/src/pages/index.tsx b/src/pages/index.tsx index f804e4f1..fec05847 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -152,21 +152,6 @@ const SocialCards: SocialCardProps[] = [ } ]; -function Feature({ imageUrl, title, description }) { - const imgUrl = useBaseUrl(imageUrl); - return ( -
- {imgUrl && ( -
- {title} -
- )} -

{title}

-

{description}

-
- ); -} - function Home() { const context = useDocusaurusContext(); const { siteConfig } = context; diff --git a/src/pages/showcase/_components/Filters.tsx b/src/pages/showcase/_components/Filters.tsx index c18f9ba9..317ad356 100644 --- a/src/pages/showcase/_components/Filters.tsx +++ b/src/pages/showcase/_components/Filters.tsx @@ -30,7 +30,7 @@ export const Filters = (): JSX.Element => { }} > {data.map((tag, i) => { - const { label, description, color } = tag; + const { label, color } = tag; const id = `showcase_checkbox_id_${tag};`; return ( diff --git a/src/pages/showcase/_components/TagSelect.tsx b/src/pages/showcase/_components/TagSelect.tsx index 7ef5ef61..98f75da9 100644 --- a/src/pages/showcase/_components/TagSelect.tsx +++ b/src/pages/showcase/_components/TagSelect.tsx @@ -25,7 +25,7 @@ function replaceSearchTags(search: string, newTags: string[]) { } export const TagSelect = React.forwardRef( - ({ id, icon, label, tag, ...rest }, ref) => { + ({ icon, label, tag }) => { const location = useLocation(); const history = useHistory(); const [selected, setSelected] = React.useState(false); diff --git a/src/pages/tools/OEM.tsx b/src/pages/tools/OEM.tsx index 65ebe0f5..d34204d7 100644 --- a/src/pages/tools/OEM.tsx +++ b/src/pages/tools/OEM.tsx @@ -16,8 +16,6 @@ const OEM = (): JSX.Element => { const [oemText, setOemText] = useState(""); const [oemBytes, setOemBytes] = useState(new Uint8Array()); - const encoder = new TextEncoder(); - useEffect(() => { setOemBytes( Protobuf.OEMStore.toBinary({ diff --git a/static/2.0/CF_logo_horizontal_blktype.svg b/static/2.0/CF_logo_horizontal_blktype.svg index 0f8d74e0..43619792 100644 --- a/static/2.0/CF_logo_horizontal_blktype.svg +++ b/static/2.0/CF_logo_horizontal_blktype.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/static/2.0/RAK-blue-main.svg b/static/2.0/RAK-blue-main.svg index 7c4f6c96..e2a1bdd1 100644 --- a/static/2.0/RAK-blue-main.svg +++ b/static/2.0/RAK-blue-main.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/static/2.0/discord.svg b/static/2.0/discord.svg index 1f483fe8..74fd52b0 100644 --- a/static/2.0/discord.svg +++ b/static/2.0/discord.svg @@ -1,23 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/static/2.0/opencollectivelogo.svg b/static/2.0/opencollectivelogo.svg index 79a8df39..3ab0f9ce 100644 --- a/static/2.0/opencollectivelogo.svg +++ b/static/2.0/opencollectivelogo.svg @@ -1,32 +1 @@ - - - - Rectangle - Created with Sketch. - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/2.0/typelogo.svg b/static/2.0/typelogo.svg index f30f2755..748526e9 100644 --- a/static/2.0/typelogo.svg +++ b/static/2.0/typelogo.svg @@ -1,29 +1 @@ - - - - - - - - - - - - - ESHT - - - - - - - - - ST - - - C - - - - +ESHTSTC \ No newline at end of file diff --git a/static/2.0/vercel-logotype-dark.svg b/static/2.0/vercel-logotype-dark.svg index bb5a15a2..ba8cfc48 100644 --- a/static/2.0/vercel-logotype-dark.svg +++ b/static/2.0/vercel-logotype-dark.svg @@ -1,3 +1 @@ - - - + \ No newline at end of file diff --git a/static/img/efficiency.svg b/static/img/efficiency.svg index 199cfc5e..d44b9a7f 100644 --- a/static/img/efficiency.svg +++ b/static/img/efficiency.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/hardware/Hydra-PCB.2.1.svg b/static/img/hardware/Hydra-PCB.2.1.svg index 5ea8ef0d..b626ec41 100755 --- a/static/img/hardware/Hydra-PCB.2.1.svg +++ b/static/img/hardware/Hydra-PCB.2.1.svg @@ -1,4910 +1 @@ - - - Picture generated by PcbDraw - Picture generated by PcbDraw - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -core pcb V2.1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -core pcb V2.1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -core pcb V2.1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -R17 - - - - - - -R15 - - - - - - -R10 - - - - - - - -R11 - - - - - - - -U1 - - - -U2 - - -TP1 - - - - - - -R16 - - - - - - -TP2 - - - - - -U5 - - - -Q4 - - - - - -R12 - - - - - - -Q5 - - - -Q2 - - - -D1 - - - -Q1 - - - - - -R1 - - - - - - -R3 - - - - -J4 - - - - -C2 - - - -C3 - - -L2 - - - -C6 - - - - -R6 - - - - - -R9 - - - - -R8 - - - -R14 - - - - - - -C11 - - - - - -R13 - - - - - - -C10 - - - - - -C12 - - - - - -C13 - - - - - - -C5 - - - - -C4 - - - - - -R7 - - - - - -R5 - - - - -R4 - - - - - -R2 - - - - - -C1 - - - - - - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/hardware/nano_g1_back.svg b/static/img/hardware/nano_g1_back.svg index 21c6413f..47306921 100644 --- a/static/img/hardware/nano_g1_back.svg +++ b/static/img/hardware/nano_g1_back.svg @@ -1,77 +1 @@ - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/hardware/nano_g1_front.svg b/static/img/hardware/nano_g1_front.svg index d1af7482..470f5e11 100644 --- a/static/img/hardware/nano_g1_front.svg +++ b/static/img/hardware/nano_g1_front.svg @@ -1,77 +1 @@ - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/hardware/tbeam-v1.1.svg b/static/img/hardware/tbeam-v1.1.svg index 5263bc43..08124232 100644 --- a/static/img/hardware/tbeam-v1.1.svg +++ b/static/img/hardware/tbeam-v1.1.svg @@ -1 +1 @@ -PWRRSTIO38 +PWRRSTIO38 \ No newline at end of file diff --git a/static/img/homepage/Discord-Logo-White.svg b/static/img/homepage/Discord-Logo-White.svg index f905d235..81e99f7c 100644 --- a/static/img/homepage/Discord-Logo-White.svg +++ b/static/img/homepage/Discord-Logo-White.svg @@ -1,10 +1 @@ - - - - - - - - - - + \ No newline at end of file diff --git a/static/img/homepage/Discourse-Logo-White.svg b/static/img/homepage/Discourse-Logo-White.svg index ff193247..12b6d826 100644 --- a/static/img/homepage/Discourse-Logo-White.svg +++ b/static/img/homepage/Discourse-Logo-White.svg @@ -1 +1 @@ -Discourse_logo \ No newline at end of file + \ No newline at end of file diff --git a/static/img/homepage/GitHub-Logo-White.svg b/static/img/homepage/GitHub-Logo-White.svg index a8d11740..0e85d560 100644 --- a/static/img/homepage/GitHub-Logo-White.svg +++ b/static/img/homepage/GitHub-Logo-White.svg @@ -1,3 +1 @@ - - - + \ No newline at end of file diff --git a/static/img/homepage/Reddit-Logo-White.svg b/static/img/homepage/Reddit-Logo-White.svg index 3ccad13f..60272ca7 100644 --- a/static/img/homepage/Reddit-Logo-White.svg +++ b/static/img/homepage/Reddit-Logo-White.svg @@ -1,15 +1 @@ - - - - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/homepage/Twitter-logo.svg b/static/img/homepage/Twitter-logo.svg index d60af2b8..2d7697b3 100644 --- a/static/img/homepage/Twitter-logo.svg +++ b/static/img/homepage/Twitter-logo.svg @@ -1,4 +1 @@ - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/homepage/YouTube-Logo-White.svg b/static/img/homepage/YouTube-Logo-White.svg index 49e67507..90e7b6fc 100644 --- a/static/img/homepage/YouTube-Logo-White.svg +++ b/static/img/homepage/YouTube-Logo-White.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/homepage/battery.svg b/static/img/homepage/battery.svg index 9600bb08..7ca9e449 100644 --- a/static/img/homepage/battery.svg +++ b/static/img/homepage/battery.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/homepage/encryption.svg b/static/img/homepage/encryption.svg index 4ad82aed..d3e19b0a 100644 --- a/static/img/homepage/encryption.svg +++ b/static/img/homepage/encryption.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/homepage/extendable.svg b/static/img/homepage/extendable.svg index 654172b9..bf481481 100644 --- a/static/img/homepage/extendable.svg +++ b/static/img/homepage/extendable.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/homepage/messages.svg b/static/img/homepage/messages.svg index 7cac8107..edfed95a 100644 --- a/static/img/homepage/messages.svg +++ b/static/img/homepage/messages.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/homepage/opensource.svg b/static/img/homepage/opensource.svg index 64b473be..17979f13 100644 --- a/static/img/homepage/opensource.svg +++ b/static/img/homepage/opensource.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/homepage/platforms.svg b/static/img/homepage/platforms.svg index 216d92d4..ab8f5f7e 100644 --- a/static/img/homepage/platforms.svg +++ b/static/img/homepage/platforms.svg @@ -1 +1 @@ - + \ No newline at end of file diff --git a/static/img/readme/comment-alt.svg b/static/img/readme/comment-alt.svg index 56ef97a8..400d3387 100644 --- a/static/img/readme/comment-alt.svg +++ b/static/img/readme/comment-alt.svg @@ -1,10 +1 @@ - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/readme/discord.svg b/static/img/readme/discord.svg index 8940f5ad..b4938f1f 100644 --- a/static/img/readme/discord.svg +++ b/static/img/readme/discord.svg @@ -1,10 +1 @@ - - - - - - - - - - + \ No newline at end of file diff --git a/static/img/readme/globe.svg b/static/img/readme/globe.svg index bef08be0..f43359ca 100644 --- a/static/img/readme/globe.svg +++ b/static/img/readme/globe.svg @@ -1,10 +1 @@ - - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/readme/google-play.svg b/static/img/readme/google-play.svg index 1d15182b..1580d486 100644 --- a/static/img/readme/google-play.svg +++ b/static/img/readme/google-play.svg @@ -1,9 +1 @@ - - - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/software.svg b/static/img/software.svg index 9a7ba7b9..61e8cbbc 100644 --- a/static/img/software.svg +++ b/static/img/software.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/static/img/undraw_docusaurus_mountain.svg b/static/img/undraw_docusaurus_mountain.svg index 431cef2f..438e4588 100644 --- a/static/img/undraw_docusaurus_mountain.svg +++ b/static/img/undraw_docusaurus_mountain.svg @@ -1,170 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/static/img/undraw_docusaurus_react.svg b/static/img/undraw_docusaurus_react.svg index e4170504..c10c74e2 100644 --- a/static/img/undraw_docusaurus_react.svg +++ b/static/img/undraw_docusaurus_react.svg @@ -1,169 +1 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + \ No newline at end of file diff --git a/static/img/undraw_docusaurus_tree.svg b/static/img/undraw_docusaurus_tree.svg index a05cc03d..012cc505 100644 --- a/static/img/undraw_docusaurus_tree.svg +++ b/static/img/undraw_docusaurus_tree.svg @@ -1 +1 @@ -docu_tree \ No newline at end of file + \ No newline at end of file diff --git a/static/img/versatility.svg b/static/img/versatility.svg index bd9d52d4..ecce4de2 100644 --- a/static/img/versatility.svg +++ b/static/img/versatility.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file