mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-02-02 08:42:11 -08:00
Merge branch 'master' into patch-2
This commit is contained in:
rcarteraz
GitHub
commit
299cddaebf
5
.github/CODEOWNERS
vendored
Normal file
5
.github/CODEOWNERS
vendored
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
# Protect this CODEOWNERS file from change
|
||||
/.github/CODEOWNERS @meshtastic/admins
|
||||
|
||||
# Protect the legal directory from change
|
||||
/docs/legal/* @meshtastic/admins
|
||||
|
|
@ -1,10 +1,14 @@
|
|||
---
|
||||
title: Community Guide
|
||||
title: Contributing to Meshtastic
|
||||
sidebar_label: Contributing
|
||||
slug: /contributing
|
||||
sidebar_position: 3
|
||||
---
|
||||
### Volunteer Based Development
|
||||
|
||||
import Link from "@docusaurus/Link"
|
||||
|
||||
## Volunteer Based Development
|
||||
|
||||
|
||||
Meshtastic is a team of volunteers, and as such there are always plenty of ways to help. This project gets great contributions from people in their off hours. Those contributors work on the features they are interested in. It is a very open and welcoming developer community, and we are always looking for help to improve Meshtastic.
|
||||
|
||||
|
|
@ -19,38 +23,62 @@ Meshtastic is a team of volunteers, and as such there are always plenty of ways
|
|||
|
||||
There are several developers, testers, and active users on [Discord](https://discord.gg/ktMAKGBnBs).
|
||||
|
||||
## Meshtastic Ecosystem
|
||||
### Meshtastic Ecosystem
|
||||
|
||||
There are many technologies (and repositories) used in creating the Meshtastic ecosystem. Below is a breakdown:
|
||||
The Meshtastic ecosystem leverages a variety of technologies and repositories to provide a robust decentralized communication platform. This ecosystem is continuously evolving, thanks to the collaborative effort of developers, contributors, and the community, aiming to enhance and expand Meshtastic's capabilities for decentralized off-grid communication.
|
||||
|
||||
### Protocol Buffers
|
||||
Key components include:
|
||||
- **Protocol Buffers**: The backbone of communication and interactions, with changes and definitions managed in the [Meshtastic Protobuf Definitions repository](https://github.com/meshtastic/protobufs). For detailed information, see the [Protobuf API Reference](https://buf.build/meshtastic/protobufs/).
|
||||
- **Device Firmware**: Development for ESP32, nRF52, and RP2040 based devices occurs in the [firmware repository](https://github.com/meshtastic/firmware), focusing on C and C++ code for hardware interaction and communication.
|
||||
- **Firmware Modules**: Extend the core functionalities of devices and mesh networks, implemented mainly within the firmware repository. Modules are essential for adding new features and integrating devices within the ecosystem.
|
||||
- **CLI Apps (Device Interface)**: The [Meshtastic Python CLI](https://github.com/meshtastic/Meshtastic-python) enables interaction with device settings and functionalities, serving both as a utility and a library for application development.
|
||||
- **Web and JavaScript Apps**: Development for the hosted web server on ESP32 devices is done in [Meshtastic Web](https://github.com/meshtastic/web), with a JavaScript library for device interfaces available in [Meshtastic JS](https://github.com/meshtastic/meshtastic.js).
|
||||
- **Mobile and Desktop Apps**: Android, iOS, iPadOS, and macOS applications provide user interfaces for interacting with Meshtastic devices. Development for Android is detailed in the [Meshtastic-Android repository](https://github.com/meshtastic/Meshtastic-Android), while Apple platforms are supported by the [Meshtastic-Apple repository](https://github.com/meshtastic/Meshtastic-Apple).
|
||||
- **Documentation**: The source for the Meshtastic website and documentation resides in the [meshtastic/meshtastic repository](https://github.com/meshtastic/meshtastic). For guidelines on maintaining documentation, visit the [Maintaining Documentation](/docs/development/docs) page.
|
||||
|
||||
Most communication and interactions happen with protocol buffers. The [Meshtastic Protobuf Definitions](https://github.com/meshtastic/protobufs) repo is where all of the protocol buffer changes happen. See the [Protobuf API Reference](https://buf.build/meshtastic/protobufs/) for more details.
|
||||
This ecosystem is continuously evolving, thanks to the collaborative effort of developers, contributors and the community, aiming to enhance and expand Meshtastic's capabilities for decentralized off-grid communication.
|
||||
|
||||
### Device Firmware
|
||||
|
||||
The [firmware repo](https://github.com/meshtastic/firmware) is where all of the device firmware development happens. This is where the code for the ESP32, nRF52 and RP2040 based devices is developed. It is mainly C and C++ code. Think Arduino. It is where the first level of hardware interaction begins and ends.
|
||||
## Supporting and Contributing to Meshtastic
|
||||
|
||||
### Firmware Modules
|
||||
The Meshtastic project benefits greatly from the contributions of our volunteers and the financial support from our community. As the project has evolved, the expansion of features and services has led to increased financial needs, including hardware for development, GitHub fees, hosting for public MQTT services, among others. This growth into a robust platform for decentralized off-grid mesh networking solutions showcases the dedication of our developers and the generosity of our financial supporters.
|
||||
|
||||
[Modules](/docs/configuration/module) extend device and mesh functionality beyond core functions. These are also implemented mainly in the firmware repo above. Typically, you would add functions in the protobufs repo and the device repo to implement module functionality. You probably also want to have some client or device, use or interact with the module. This is where Device Interface support comes into play.
|
||||
### How You Can Support Meshtastic Financially
|
||||
|
||||
### CLI Apps (Device Interface)
|
||||
If direct development contribution is not feasible for you, financial support is another invaluable way to help Meshtastic grow and thrive. We offer two primary options for monetary donations:
|
||||
|
||||
- **Meshtastic Python CLI** - The [meshtastic/Meshtastic-python repository](https://github.com/meshtastic/Meshtastic-python) is a command line utility that allows you to interact with most of the device settings and functionality. This python library can also be consumed for other applications. See [Meshtastic Python Development](/docs/development/python/) for more details
|
||||
<div className="indexCtasBody">
|
||||
<div className="split-container">
|
||||
<div className="split-item">
|
||||
<a
|
||||
className="button button--outline button--lg cta--button"
|
||||
href="https://opencollective.com/meshtastic"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
Support on Open Collective
|
||||
</a>
|
||||
</div>
|
||||
|
||||
### Web Apps (Device Interface)
|
||||
<div className="split-item">
|
||||
<a
|
||||
className="button button--outline button--lg cta--button"
|
||||
href="https://github.com/sponsors/meshtastic"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
>
|
||||
Sponsor on GitHub
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
- **Meshtastic Web** - The [meshtastic/web repository](https://github.com/meshtastic/web) is where the hosted web server on the ESP32 devices in Typescript is developed. See the [Web Development Overview](/docs/development/web/) for more details.
|
||||
- **Meshtastic JS** - The [meshtastic/meshtastic.js](https://github.com/meshtastic/meshtastic.js) repository is a JavaScript library that provides an interface for Meshtastic devices. See [Javascript Development](/docs/development/js) for more details
|
||||
### Fiscal Sponsorships
|
||||
|
||||
### Mobile and Desktop Apps (Device Interface)
|
||||
We're deeply thankful for the backing from the Open Collective, Open Source Collective, DigitalOcean, and Vercel, which has been instrumental in our project's sustainability and growth:
|
||||
|
||||
There are Android, iOS, iPadOS, and macOS apps that interact with Meshtastic devices:
|
||||
- **Open Collective & Open Source Collective**: Our collaboration with these organizations offers a robust fiscal management framework and banking solutions, supporting our project alongside over three thousand other open source initiatives. Open Collective's transparent framework lets everyone see our finances, including income, expenditures, and contributions on [Meshtastic's Open Collective page](https://opencollective.com/meshtastic). This transparency and support affirm that we're in excellent company.
|
||||
|
||||
- **Android App** - The [meshtastic/Meshtastic-Android](https://github.com/meshtastic/Meshtastic-Android) repository contains the Kotlin code for Android based interactions with Meshtastic devices. See the [Android development instructions](/docs/development/android) on how to create a development environment and build the Meshtastic Android App.
|
||||
- **Apple Apps** - The [meshtastic/Meshtastic-Apple](https://github.com/meshtastic/Meshtastic-Apple) repository contains the SwiftUI client applications code for iPhone, iPad and Mac.
|
||||
- **DigitalOcean**: Champions of open source, DigitalOcean supports Meshtastic through credits, which significantly aid our development, infrastructure, and testing efforts. This contribution is part of their commitment to fostering innovation and collaboration within the open source ecosystem.
|
||||
|
||||
### Documentation
|
||||
|
||||
The Meshtastic website (the one you are looking at right now) is in the [meshtastic/Meshtastic](https://github.com/meshtastic/meshtastic) repository. See [Maintaining Documentation](/docs/development/docs) for more details.
|
||||
- **Vercel**: By covering our hosting costs, Vercel directly contributes to Meshtastic's growth, enhancing our web scalability and presence. Their sponsorship is crucial for our continued development and focus on creating a robust platform for decentralized communication.
|
||||
|
|
|
|||
|
|
@ -5,139 +5,133 @@ slug: /faq
|
|||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
### Where can I get additional help, ask questions, or bond with the Meshtastic community?
|
||||
|
||||
This site (which has a great search function) is the preferred place for up-to-date documentation. Many of our users and developers hang out on the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) server where you may connect with like-minded people.
|
||||
|
||||
### How can I contribute to Meshtastic?
|
||||
|
||||
Everyone contributes in a different way. Join the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Development](/docs/developers) menu on the left.
|
||||
|
||||
<!-- Android Client-->
|
||||
|
||||
## Android Client
|
||||
|
||||
### 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/).
|
||||
|
||||
### 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.
|
||||
- Person with a check mark - The intended recipient of your direct message acknowledged the message.
|
||||
- Cloud crossed out - Not acknowledged or message error.
|
||||
|
||||
### How can I clear the message history?
|
||||
|
||||
Long press any message to select and show the menu with "delete" and "select all" buttons.
|
||||
|
||||
### After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?
|
||||
|
||||
Try forgetting the Bluetooth connection from the Android Bluetooth Settings menu. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.
|
||||
|
||||
<!-- Apple Clients-->
|
||||
|
||||
## Apple Clients
|
||||
|
||||
### What version of iOS/iPadOS/macOS does the Meshtastic App Require?
|
||||
|
||||
The Meshtastic App on Apple Clients require the following minimum OS versions: iOS 16.2, iPadOS 16.2, and macOS 13.
|
||||
|
||||
### How do I get the Apple Meshtastic App?
|
||||
|
||||
See [Apple Apps](/docs/software/apple/installation)
|
||||
|
||||
### After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?
|
||||
|
||||
Try forgetting the Bluetooth connection from the iOS/iPadOS/macOS System Settings. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.
|
||||
|
||||
### Do the Apple applications provide an indication if the message was acknowledged on the mesh?
|
||||
|
||||
Yes, when the message is sent you will first see a `Waiting to be acknowledged...` status beneath the message. If the message is acknowledged by a node on the mesh this will update to `Acknowledged` in orange, which turns into grey when sending a direct message and the intended recipient acknowledged it. If no nodes have responded it will indicate `Max Retransmission Reached`. If there is an error, the status will update to the appropriate error. Additionally, you can long press on the message and select `Message Details` to view the date/time sent, if ack was received and the time ack was received or the error (if there was one).
|
||||
|
||||
<!-- Channels -->
|
||||
|
||||
## Channels
|
||||
|
||||
### How do I share my Meshtastic Channel with other people?
|
||||
|
||||
Your Meshtastic client (Android, Apple, Web, or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel.
|
||||
|
||||
<!-- Python -->
|
||||
|
||||
## Python CLI
|
||||
|
||||
### How do I find out more about installing (and using) Meshtastic via command line?
|
||||
|
||||
[See our guide here](/docs/software/python/cli/installation).
|
||||
|
||||
### How do I find out more about using python to interact?
|
||||
|
||||
[See our guide here](/docs/software/python/cli/usage).
|
||||
|
||||
<!-- Devices -->
|
||||
|
||||
## Devices
|
||||
|
||||
### How do I turn **off** an ESP32 T-Beam based device?
|
||||
|
||||
Hold down the left PWR button for about 10 seconds and the display should turn off.
|
||||
|
||||
### How do I turn **on** an ESP32 T-Beam based device?
|
||||
|
||||
Push the left PWR button for about 1 second.
|
||||
|
||||
### Functionality of the T-Beam Buttons
|
||||
|
||||
[T-Beam Buttons](/docs/hardware/devices/tbeam/buttons) explained here
|
||||
|
||||
### Where do I purchase the device hardware?
|
||||
|
||||
Each [supported device](/docs/hardware/devices/index.mdx) has a "Purchase Link".
|
||||
|
||||
### I have my hardware. How do I install the firmware and any required drivers?
|
||||
|
||||
[See our guide here](/docs/getting-started).
|
||||
|
||||
### How do I update the firmware to the latest version?
|
||||
|
||||
Updating firmware varies with hardware. See [Flashing Firmware](/docs/getting-started/flashing-firmware).
|
||||
|
||||
### My device has gone to sleep. Are received messages lost?
|
||||
|
||||
The LoRa radio on the node is still active and will wake up the CPU when the device is sleeping. If your phone is in range, the node will relay any messages your phone may have missed. If you're in range and your device is active, messages have not been lost.
|
||||
|
||||
### My device has gone to sleep and I can't send any messages.
|
||||
|
||||
Once the node wakes up from sleep, your phone will relay any delayed messages through your node and to the mesh network. Give it a few minutes and it'll do the right thing.
|
||||
|
||||
### How can I tell the device not to sleep?
|
||||
|
||||
See [Device Power Configuration](/docs/configuration/radio/power) options.
|
||||
|
||||
### 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).
|
||||
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?
|
||||
|
||||
There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to any firmware > 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`.
|
||||
|
||||
<!-- HAM -->
|
||||
|
||||
## Amateur Radio (HAM)
|
||||
|
||||
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:
|
||||
import { FaqAccordion } from "/src/components/FaqAccordion";
|
||||
import { FaqStructuredData } from "/src/components/FaqStructuredData";
|
||||
|
||||
export const Faq = {
|
||||
"general": [
|
||||
{
|
||||
title: "Where can I get additional help, ask questions, or bond with the Meshtastic community?",
|
||||
content: `This site (which has a great search function) is the preferred place for up-to-date documentation. Many of our users and developers hang out on the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) server where you may connect with like-minded people.`,
|
||||
},
|
||||
{
|
||||
title: "How can I contribute to Meshtastic?",
|
||||
content: "Everyone contributes in a different way. Join the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Development](/docs/developers) menu on the left.",
|
||||
},
|
||||
],
|
||||
"android": [
|
||||
{
|
||||
title: "What versions of Android does the Meshtastic Android App require?",
|
||||
content: `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/).`,
|
||||
},
|
||||
{
|
||||
title: "What does the icon next to the message mean?",
|
||||
content: `
|
||||
- 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.
|
||||
- Person with a check mark - The intended recipient of your direct message acknowledged the message.
|
||||
- Cloud crossed out - Not acknowledged or message error.`,
|
||||
},
|
||||
{
|
||||
title: "How can I clear the message history?",
|
||||
content: `Long press any message to select and show the menu with "delete" and "select all" buttons.`,
|
||||
},
|
||||
{
|
||||
title: "After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?",
|
||||
content: `Try forgetting the Bluetooth connection from the Android Bluetooth Settings menu. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.`,
|
||||
},
|
||||
],
|
||||
"apple": [
|
||||
{
|
||||
title: "What version of iOS/iPadOS/macOS does the Meshtastic App Require?",
|
||||
content: `The Meshtastic App on Apple Clients require the following minimum OS versions: iOS 16.2, iPadOS 16.2, and macOS 13.`,
|
||||
},
|
||||
{
|
||||
title: "How do I get the Apple Meshtastic App?",
|
||||
content: `See [Apple Apps](/docs/software/apple/installation)`,
|
||||
},
|
||||
{
|
||||
title: "After a fresh firmware install, my node is not connecting via Bluetooth. What should I do?",
|
||||
content: `Try forgetting the Bluetooth connection from the iOS/iPadOS/macOS System Settings. Re-pair and try again. This is a security measure and there is no workaround for it. It prevents apps and other accessories from spoofing an existing accessory by un-pairing and "re-pairing" themselves without the users' knowledge.`,
|
||||
},
|
||||
{
|
||||
title: "Do the Apple applications provide an indication if the message was acknowledged on the mesh?",
|
||||
content: 'Yes, when the message is sent you will first see a `Waiting to be acknowledged...` status beneath the message. If the message is acknowledged by a node on the mesh this will update to `Acknowledged` in orange, which turns into grey when sending a direct message and the intended recipient acknowledged it. If no nodes have responded it will indicate `Max Retransmission Reached`. If there is an error, the status will update to the appropriate error. Additionally, you can long press on the message and select `Message Details` to view the date/time sent, if ack was received and the time ack was received or the error (if there was one).',
|
||||
},
|
||||
],
|
||||
"channels": [
|
||||
{
|
||||
title: "How do I share my Meshtastic Channel with other people?",
|
||||
content: `Your Meshtastic client (Android, Apple, Web, or Python) will provide you a URL or QR code. You can email, text or print this URL or QR code and share it with people you want to join your Meshtastic Channel.`,
|
||||
},
|
||||
],
|
||||
"python": [
|
||||
{
|
||||
title: "How do I find out more about installing (and using) Meshtastic via command line?",
|
||||
content: `[See our guide here](/docs/software/python/cli/installation).`,
|
||||
},
|
||||
{
|
||||
title: "How do I find out more about using python to interact?",
|
||||
content: `[See our guide here](/docs/software/python/cli/usage).`,
|
||||
},
|
||||
{
|
||||
title: "What if I'm still having issues on Windows 10?",
|
||||
content: "It's been reported that `App execution aliases` might conflict with one another and prevent python3 from being able to run properly. There is an example of a fix located [here](https://github.com/meshtastic/Meshtastic-gui-installer/issues/154).",
|
||||
},
|
||||
],
|
||||
"devices": [
|
||||
{
|
||||
title: "How do I turn off an ESP32 T-Beam based device?",
|
||||
content: `Hold down the left PWR button for about 10 seconds and the display should turn off.`,
|
||||
},
|
||||
{
|
||||
title: "How do I turn on an ESP32 T-Beam based device?",
|
||||
content: `Push the left PWR button for about 1 second.`,
|
||||
},
|
||||
{
|
||||
title: "Functionality of the T-Beam Buttons",
|
||||
content: `[T-Beam Buttons](/docs/hardware/devices/tbeam/buttons) explained here`,
|
||||
},
|
||||
{
|
||||
title: "Where do I purchase the device hardware?",
|
||||
content: `Each [supported device](/docs/hardware/devices/index.mdx) has a "Purchase Link".`,
|
||||
},
|
||||
{
|
||||
title: "I have my hardware. How do I install the firmware and any required drivers?",
|
||||
content: `[See our guide here](/docs/getting-started).`,
|
||||
},
|
||||
{
|
||||
title: "How do I update the firmware to the latest version?",
|
||||
content: `Updating firmware varies with hardware. See [Flashing Firmware](/docs/getting-started/flashing-firmware).`,
|
||||
},
|
||||
{
|
||||
title: "My device has gone to sleep. Are received messages lost?",
|
||||
content: `The LoRa radio on the node is still active and will wake up the CPU when the device is sleeping. If your phone is in range, the node will relay any messages your phone may have missed. If you're in range and your device is active, messages have not been lost.`,
|
||||
},
|
||||
{
|
||||
title: "My device has gone to sleep and I can't send any messages.",
|
||||
content: `Once the node wakes up from sleep, your phone will relay any delayed messages through your node and to the mesh network. Give it a few minutes and it'll do the right thing.`,
|
||||
},
|
||||
{
|
||||
title: "How can I tell the device not to sleep?",
|
||||
content: `See [Device Power Configuration](/docs/configuration/radio/power) options.`,
|
||||
},
|
||||
{
|
||||
title: "I am in Europe and my device seems to stop transmitting after a while, what is going on?",
|
||||
content: `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.`,
|
||||
},
|
||||
{
|
||||
title: "Why does only one RAK Meshtastic Starter kit show up in my node list?",
|
||||
content: "There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to any firmware > 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`.",
|
||||
},
|
||||
],
|
||||
"ham": [
|
||||
{
|
||||
title: "What is the benefit of using a ham license with Meshtastic?",
|
||||
content: `
|
||||
If you use your ham radio license with Meshtastic, consider both the privileges and restrictions:
|
||||
#### Privileges
|
||||
|
||||
- Increased Transmit Power
|
||||
|
|
@ -149,46 +143,84 @@ If you use your HAM radio license with Meshtastic, consider both the privileges
|
|||
- Plain-Text Only
|
||||
- On amateur radio bands, encryption is illegal. [FCC Part 97.113.A.4](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97/subpart-B/section-97.113#p-97.113(a)(4))
|
||||
- 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#p-97.119(a))
|
||||
- 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#p-97.119(a))
|
||||
`,
|
||||
},
|
||||
{
|
||||
title: "How do I set my ham call sign?",
|
||||
content: `
|
||||
- On Android navigate to Radio configuration -> User and set Long name to your Ham Radio callsign, then activate the slider for 'Licensed amateur radio'.
|
||||
- On iPhone navigate to Settings -> User and set Long Name to your Ham Radio callsign, then activate the slider for 'Licensed Operator'.
|
||||
- Instructions for Enabling ham License from the Python CLI can be found [here](/docs/software/python/cli/usage#ham-radio-support).
|
||||
`,
|
||||
},
|
||||
],
|
||||
"mesh": [
|
||||
{
|
||||
title: "Does Meshtastic use LoRaWAN?",
|
||||
content: `Meshtastic uses LoRa peer to peer (p2p), which allows much more flexibility in how LoRa is utilized. Our messaging and position updates are far too "random" compared to LoRaWAN requirements.`,
|
||||
},
|
||||
{
|
||||
title: "Will Meshtastic work with (insert LoRa service)",
|
||||
content: `Meshtastic uses LoRa peer to peer (p2p), which has allowed us to customize how we use the protocol. Likely it will not work with the service you have in mind, but it may be possible to build a bridge between services using MQTT. That will require further development outside the scope of this project to implement.`,
|
||||
},
|
||||
{
|
||||
title: "Can I locate a device via triangulation?",
|
||||
content: `There is a [community project](https://github.com/a-f-G-U-C/Meshtastic-ZPS) that has worked out how to accomplish this.`,
|
||||
},
|
||||
],
|
||||
"modules": [
|
||||
{
|
||||
title: "What are Modules?",
|
||||
content: `Modules are features that expand the basic device functionality and/or integrate with other services.`,
|
||||
},
|
||||
{
|
||||
title: "What modules do we have available?",
|
||||
content: `A list of available modules is available [here](/docs/configuration/module).`,
|
||||
},
|
||||
{
|
||||
title: "I'd like to write a module. How do I get started?",
|
||||
content: `API documentation for creating modules is available [here](/docs/development/device/module-api).`,
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
### How do I set my HAM call sign?
|
||||
<FaqStructuredData faqs={Faq} />
|
||||
|
||||
- On Android navigate to Radio configuration -> User and set Long name to your Ham Radio callsign, then activate the slider for 'Licensed amateur radio'.
|
||||
- On iPhone navigate to Settings -> User and set Long Name to your Ham Radio callsign, then activate the slider for 'Licensed Operator'.
|
||||
- Instructions for Enabling HAM License from the Python CLI can be found [here](/docs/software/python/cli/usage#ham-radio-support).
|
||||
## Overview
|
||||
|
||||
### What if I'm still having issues on Windows 10?
|
||||
<FaqAccordion rows={Faq.general} slug="general" />
|
||||
|
||||
It's been reported that `App execution aliases` might conflict with one another and prevent python3 from being able to run properly. There is an example of a fix located [here](https://github.com/meshtastic/Meshtastic-gui-installer/issues/154).
|
||||
## Android Client
|
||||
|
||||
<!-- Mesh -->
|
||||
<FaqAccordion rows={Faq.android} slug="android" />
|
||||
|
||||
## Apple Clients
|
||||
|
||||
<FaqAccordion rows={Faq.apple} slug="apple" />
|
||||
|
||||
## Channels
|
||||
|
||||
<FaqAccordion rows={Faq.channels} slug="channels" />
|
||||
|
||||
## Python CLI
|
||||
|
||||
<FaqAccordion rows={Faq.python} slug="python" />
|
||||
|
||||
## Devices
|
||||
|
||||
<FaqAccordion rows={Faq.devices} slug="devices" />
|
||||
|
||||
## Amateur Radio (ham)
|
||||
|
||||
Meshtastic can be used by both unlicensed people and licensed HAM operators.
|
||||
|
||||
<FaqAccordion rows={Faq.ham} slug="ham" />
|
||||
|
||||
## Mesh
|
||||
|
||||
### Does Meshtastic use LoRaWAN?
|
||||
|
||||
Meshtastic uses LoRa peer to peer (p2p), which allows much more flexibility in how LoRa is utilized. Our messaging and position updates are far too "random" compared to LoRaWAN requirements.
|
||||
|
||||
### Will Meshtastic work with (insert LoRa service)
|
||||
|
||||
Meshtastic uses LoRa peer to peer (p2p), which has allowed us to customize how we use the protocol. Likely it will not work with the service you have in mind, but it may be possible to build a bridge between services using MQTT. That will require further development outside the scope of this project to implement.
|
||||
|
||||
### Can I locate a device via triangulation?
|
||||
|
||||
There is a [community project](https://github.com/a-f-G-U-C/Meshtastic-ZPS) that has worked out how to accomplish this.
|
||||
|
||||
<!-- Modules -->
|
||||
<FaqAccordion rows={Faq.mesh} slug="mesh" />
|
||||
|
||||
## Modules
|
||||
|
||||
### What are Modules?
|
||||
|
||||
Modules are features that expand the basic device functionality and/or integrate with other services.
|
||||
|
||||
### What modules do we have available?
|
||||
|
||||
A list of available modules is available [here](/docs/configuration/module).
|
||||
|
||||
### I'd like to write a module. How do I get started?
|
||||
|
||||
API documentation for creating modules is available [here](/docs/development/device/module-api).
|
||||
<FaqAccordion rows={Faq.modules} slug="modules" />
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ us on [Discord](https://discord.com/invite/ktMAKGBnBs) to add your group.
|
|||
- [Laguna Mesh](https://lagunamesh.com)
|
||||
- [Mission Viejo Mesh](https://missionviejomesh.org/)
|
||||
- [Bay Area Mesh](https://canvis.app/z2k8a8)
|
||||
- [San Diego Mesh](https://discord.gg/HzE248x2)
|
||||
- [San Diego Mesh](https://discord.gg/k8RputgWgD)
|
||||
|
||||
### Colorado
|
||||
- [Denver Mesh](https://denvermesh.org)
|
||||
|
|
|
|||
|
|
@ -11,24 +11,19 @@ The device config options are: Role, Serial Output, and Debug Log. Device config
|
|||
|
||||
## Device Config Values
|
||||
|
||||
### Role
|
||||
|
||||
Sets the role of the node.
|
||||
|
||||
Acceptable values:
|
||||
|
||||
| Value | Description |
|
||||
|:----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
||||
| `CLIENT` | Client (default) - This role will follow the standard routing rules while also allowing the device to interact with client applications via BLE/Wi-Fi (Android/Apple/Web). |
|
||||
| `CLIENT_MUTE` | Client Mute - Same as a client except packets will not hop over this node, does not contribute to routing packets for mesh. |
|
||||
| `ROUTER` | Router - Mesh packets will prefer to be routed over this node. The assumption is that Router-type devices will be placed in locations with a height/range/antenna advantage, and therefore have better overall coverage. This node will not be used by client apps. The BLE/Wi-Fi radios and the OLED screen will be put to sleep. Please note: Due to the preferred routing, this role may cause higher power usage due to more frequent transmission. |
|
||||
| `ROUTER_CLIENT` | Router Client - Hybrid of the Client and Router roles. Similar to Router, except the Router Client can be used as both a Router and an app connected Client. BLE/Wi-Fi and OLED screen will not be put to sleep. |
|
||||
| `REPEATER` | Repeater - Mesh packets will prefer to be routed over this node. This role eliminates unnecessary overhead such as NodeInfo, DeviceTelemetry, and any other mesh packet, resulting in the device not appearing as part of the network. As such, direct messaging this node is not available, as it will not appear in your nodes list which results in a cleaner mesh network. Channel and modem settings of the mesh packets being repeated must be identical to the repeater's configuration. Please see Rebroadcast Mode for additional settings specific to this role. |
|
||||
| `TRACKER` | Tracker - For use with devices intended as a GPS tracker. Position packets sent from this device will be higher priority. Smart Position Broadcast will default to the currently configured settings. When used in conjunction with power.is_power_saving = true, nodes will wake up, send position, and then sleep for position.position_broadcast_secs seconds. |
|
||||
| `SENSOR` | Sensor - For use with devices intended to primarily collect sensor readings. Telemetry packets sent from this device will be higher priority, broadcasting every five minutes. When used in conjunction with power.is_power_saving = true, nodes will wake up, send environment telemetry, and then sleep for telemetry.environment_update_interval seconds. |
|
||||
| `TAK` | TAK - Used for nodes dedicated for connection to an ATAK EUD. Turns off many of the routine broadcasts to favor CoT packet stream from the Meshtastic ATAK plugin -> IMeshService -> Node. |
|
||||
| `CLIENT_HIDDEN` | Client Hidden - Used for nodes that "only speak when spoken to." Turns off all of the routine broadcasts but allows for ad-hoc communication. Still rebroadcasts, but with local only rebroadcast mode (known meshes only). Can be used for clandestine operation or to dramatically reduce airtime / power consumption |
|
||||
| `LOST_AND_FOUND` | Lost and Found - Used to automatically send a text message with current position at frequent intervals to the primary channel for the device: "I'm lost! Position: lat / long" |
|
||||
### Roles
|
||||
| Device Role | Description | Best Uses |
|
||||
| -------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| CLIENT | App connected or stand alone messaging device. | General use for individuals needing to communicate over the Meshtastic network with support for client applications. |
|
||||
| CLIENT_MUTE | Device that does not forward packets from other devices. | Situations where a device needs to participate in the network without assisting in packet routing, reducing network load. |
|
||||
| CLIENT_HIDDEN | Device that only broadcasts as needed for stealth or power savings. | Use in stealth/hidden deployments or to reduce airtime/power consumption while still participating in the network. |
|
||||
| TRACKER | Broadcasts GPS position packets as priority. | Tracking the location of individuals or assets, especially in scenarios where timely and efficient location updates are critical. |
|
||||
| LOST_AND_FOUND | Broadcasts location as message to default channel regularly for to assist with device recovery. | Used for recovery efforts of a lost device. |
|
||||
| SENSOR | Broadcasts telemetry packets as priority. | Deploying in scenarios where gathering environmental or other sensor data is crucial, with efficient power usage and frequent updates. |
|
||||
| TAK | Optimized for ATAK system communication, reduces routine broadcasts. | Integration with ATAK systems for communication in tactical or coordinated operations. |
|
||||
| REPEATER | Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is not shown in topology. |
|
||||
| ROUTER | Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list. | Best positioned in strategic locations to maximize the network's overall coverage. Device is shown in topology. |
|
||||
| ROUTER_CLIENT | Combination of both ROUTER and CLIENT. Not for mobile devices. | Devices in a strategic position for priority routing that need to also serve as a standard CLIENT. |
|
||||
|
||||
#### Role Comparison
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ The Presets available are as follows, and follow a linear pattern of Fastest \<\
|
|||
|
||||
7. `LONG_SLOW`
|
||||
|
||||
8. `VERY_LONG_SLOW` (Slowest, lowest bandwidth, highest airtime, longest range)
|
||||
8. `VERY_LONG_SLOW` (Slowest, lowest bandwidth, highest airtime, longest range. Not recommended for regular usage as does not form meshes well and is unreliable)
|
||||
|
||||
### Max Hops
|
||||
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Should be set to floating point value between 2 and 6
|
|||
|
||||
#### Calibration Process ([Attribution](https://wiki.uniteng.com/en/meshtastic/nano-g1-explorer#calibration-process))
|
||||
|
||||
1. Install the rechargeable Li-Polymer battery.
|
||||
1. Install the rechargeable battery.
|
||||
2. Charge the battery until full. Indication of this state may vary depending on device. At this point, the battery voltage should be 4.2V +-1%.
|
||||
3. Input the "Battery Charge Percent" displayed on the screen or in your connected app into the calculator below.
|
||||
4. If "Battery Charge Percent" (e.g., B 3.82V 60%) is not displayed on the screen, it means that the default value of "Operative Adc Multiplier" is too high. Lower the "Operative Adc Multiplier" to a smaller number (it is recommended to decrease by 0.1) until the screen displays "Battery Charge Percent". Enter the current "Operative Adc Multiplier" in use into the "Operative Adc Multiplier" field in the calculator. Also, input the "Battery Charge Percent" displayed on the screen into the calculator.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,48 @@
|
|||
---
|
||||
id: update-techo-bootloader
|
||||
title: How to Update the LilyGo T-Echo Bootloader to the Latest Version
|
||||
sidebar_label: Update T-Echo Bootloader
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
If you're experiencing issues with updating or flashing newer versions of the Meshtastic firmware, and your LilyGo T-Echo is not running the latest bootloader version (0.6.1), updating the bootloader may resolve these problems.
|
||||
|
||||
To check which version of the bootloader your device is running, place the device into DFU mode by double-pressing the reset button. Then, open the mounted drive that appears on your computer and check the INFO_UF2.TXT file.
|
||||
|
||||
## Updating bootloader
|
||||
|
||||
Below are the steps to update your bootloader.
|
||||
|
||||
### Method 1: Using the UF2 File (Recommended)
|
||||
|
||||
1. Download the Latest UF2 Bootloader File for the T-Echo from [Github](https://github.com/meshtastic/firmware/blob/master/bin/update-lilygo_techo_bootloader-0.6.1_nosd.uf2).
|
||||
2. Connect your LilyGo T-Echo to your computer via USB.
|
||||
3. Activate bootloader mode by quickly double pressing the RESET button on your T-Echo. The device should appear as a removable drive on your computer.
|
||||
4. Drag and drop the .uf2 file you downloaded into the T-Echo's drive. The device will automatically update the bootloader and reset.
|
||||
5. Once the device resets, the update is complete. Your T-Echo is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop/).
|
||||
|
||||
### Method 2: Using adafruit-nrfutil
|
||||
|
||||
Should flashing the UF2 file to update your bootloader fail, you can use adafruit-nrfutil.
|
||||
|
||||
:::info
|
||||
|
||||
These instructions assume you have python and pip already installed. If you do not, please install the latest verion of python (which includes pip) from [Python.org](https://www.python.org/downloads/).
|
||||
|
||||
:::
|
||||
|
||||
1. Open a terminal or command prompt and install adafruit-nrfutil by running:
|
||||
|
||||
```bash
|
||||
pip install adafruit-nrfutil
|
||||
```
|
||||
|
||||
2. Obtain the lilygo_techo_bootloader-0.6.1.zip package from [Github](https://github.com/meshtastic/firmware/blob/master/bin/lilygo_techo_bootloader-0.6.1.zip).
|
||||
3. Connect your LilyGo T-Echo to your computer via USB.
|
||||
4. In the terminal or command prompt, navigate to the directory where you downloaded the bootloader zip package and execute the following command, replacing /dev/ttyACM0 with the correct port for your device (Windows users might use COMx):
|
||||
|
||||
```bash
|
||||
adafruit-nrfutil --verbose dfu serial --package lilygo_techo_bootloader-0.6.1.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200
|
||||
```
|
||||
|
||||
5. Once the process finishes, the update is complete. Your T-Echo is now running the latest bootloader version and you can proceed with [flashing the firmware](/docs/getting-started/flashing-firmware/nrf52/drag-n-drop/).
|
||||
|
|
@ -81,6 +81,11 @@ This device may have issues charging a connected battery if utilizing a USB-C to
|
|||
- User and Reset Buttons
|
||||
- No GPS
|
||||
|
||||
### Meshtastic I2C Definitions
|
||||
|
||||
- SDA: GPIO41
|
||||
- SCL: GPIO42
|
||||
|
||||
### Pin Map
|
||||
|
||||
_V3.webp>)
|
||||
|
|
@ -128,8 +133,8 @@ This device may have issues charging a connected battery if utilizing a USB-C to
|
|||
|
||||
### Meshtastic I2C Definitions
|
||||
|
||||
- SCL: GPIO47
|
||||
- SDA: GPIO48
|
||||
- SDA: GPIO41
|
||||
- SCL: GPIO42
|
||||
|
||||
### Pin Map
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ Modular hardware system with Base, Core and Peripheral modules including the low
|
|||
[RAK13002](./rak/peripherals?rakmodules=IO) IO<br/>
|
||||
RAK14001 RGB LED<br/>
|
||||
RAK12002 RTC<br/>
|
||||
[RAK1910](./rak/peripherals?rakmodules=Sensors&sensors=RAK1901) Temperature and Humidity Sensor<br/>
|
||||
[RAK1901](./rak/peripherals?rakmodules=Sensors&sensors=RAK1901) Temperature and Humidity Sensor<br/>
|
||||
[RAK1902](./rak/peripherals?rakmodules=Sensors&sensors=RAK1902) Barometric Pressure Sensor<br/>
|
||||
[RAK1906](./rak/peripherals?rakmodules=Sensors&sensors=RAK1906) Environment Sensor<br/>
|
||||
RAK12013 Radar Sensor<br/>
|
||||
|
|
|
|||
|
|
@ -116,11 +116,11 @@ The RAK11200 does not contain a LoRa transceiver, and thus needs to be added sep
|
|||
- Firmware file: `firmware-rak11200-X.X.X.xxxxxxx.bin`
|
||||
- Further information on the RAK11200 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11200/Overview/#product-description).
|
||||
- Purchase Links:
|
||||
- US
|
||||
- [Rokland](https://store.rokland.com/products/rakwireless-rak11200-wifi-and-ble-espressif-esp32-wrover-pid-110023)
|
||||
- International
|
||||
- [RAK Wireless Store](https://store.rakwireless.com/products/wiscore-esp32-module-rak11200)
|
||||
- [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256802312474717.html)
|
||||
- US
|
||||
- [Rokland](https://store.rokland.com/products/rakwireless-rak11200-wifi-and-ble-espressif-esp32-wrover-pid-110023)
|
||||
|
||||
<img
|
||||
alt="RAK4631 5005 11200"
|
||||
|
|
@ -163,6 +163,8 @@ The RAK11200 does not contain a LoRa transceiver, and thus needs to be added sep
|
|||
- Firmware file: `firmware-rak11310-X.X.X.xxxxxxx.uf2`
|
||||
- Further information on the RAK11310 can be found on the [RAK Documentation Center](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK11310/Overview/#product-description).
|
||||
- Purchase Links:
|
||||
- US
|
||||
- [Rokland](https://store.rokland.com/products/rak-raspberry-pi-rp2040-core-module-for-lorawan-with-lora-sx1262-us915-mhz-rak11310-pid-116003)
|
||||
- International
|
||||
- [RAK Wireless Store](https://store.rakwireless.com/products/rak11310-wisblock-lpwan-module)
|
||||
- [RAK Wireless Aliexpress](https://www.aliexpress.us/item/3256803225175784.html)
|
||||
|
|
|
|||
|
|
@ -22,19 +22,30 @@ values={[
|
|||
|
||||
## GPS Modules
|
||||
|
||||
### RAK5005-0 / RAK1910
|
||||
### RAK12500
|
||||
|
||||
To add a GPS to the RAK5005-O base board, you need the [RAK1910 GPS sensor](https://store.rakwireless.com/collections/wisblock-sensor/products/rak1910-max-7q-gnss-location-sensor). It is supported on slot A of the 5005 board via UART.
|
||||
The [RAK12500 GPS sensor](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500) is a newer GPS module and is generally preferred.
|
||||
|
||||
- uBlox Zoe-M8Q GNSS receiver
|
||||
- GPS, GLONASS, QZSS and BeiDou satellite support
|
||||
|
||||
The RAK12500 is supported on the following base boards & slots:
|
||||
|
||||
- RAK19007 on slot A
|
||||
- RAK19003 on slot C
|
||||
|
||||
### RAK1910
|
||||
|
||||
The [RAK1910 GPS sensor](https://store.rakwireless.com/collections/wisblock-sensor/products/rak1910-max-7q-gnss-location-sensor) is the older of the supported GPS modules for RAK boards.
|
||||
|
||||
- uBlox MAX-7Q GPS module
|
||||
- GPS and GLONASS satellite support
|
||||
|
||||
### RAK19003 / RAK12500
|
||||
The RAK1910 is supported on the following base boards & slots:
|
||||
|
||||
To add a GPS to the RAK19003 base board, you need the [RAK12500 GPS sensor](https://store.rakwireless.com/products/wisblock-gnss-location-module-rak12500). It is supported via I<sup>2</sup>C on slot B for firmware versions 1.49 and above.
|
||||
|
||||
- uBlox Zoe-M8Q GNSS receiver
|
||||
- GPS, GLONASS, QZSS and BeiDou satellite support
|
||||
- RAK5005-0 on slot A
|
||||
- RAK19007 on slot A
|
||||
- RAK19003 on slot C
|
||||
|
||||
### Resources
|
||||
- RAK Documentation Center
|
||||
|
|
|
|||
|
|
@ -4,6 +4,7 @@ sidebar_label: Legal
|
|||
slug: /legal
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
## Disclaimers
|
||||
|
||||
**Project Status:** Meshtastic is now at a stage where it offers a _mostly_ stable and reliable functionality, thanks to the dedicated efforts of our development team. While the core aspects of the project are well-established, we are still rapidly evolving and actively adding new features. As we continue to innovate and expand, some features in our current builds are in development, reflecting our commitment to continuous improvement and growth. We appreciate your engagement as we advance further in this exciting journey.
|
||||
|
|
|
|||
18
docs/software/android/translate.mdx
Normal file
18
docs/software/android/translate.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
id: android-app-translate
|
||||
title: Translate the Android App
|
||||
sidebar_label: Translate
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## How to Contribute
|
||||
|
||||
Contributing translations to the Meshtastic Android app helps make the project accessible to a wider audience. Follow these steps to add your translations through Crowdin:
|
||||
|
||||
1. **Access Crowdin**: Visit the Meshtastic project's Crowdin page at [https://crowdin.meshtastic.org](https://crowdin.meshtastic.org).
|
||||
2. **Create an Account**: Click on 'Sign Up' in the top right corner of the page and follow the prompts to create a Crowdin account.
|
||||
3. **Navigate to the Project**: Once logged in, locate and select the 'Android Application' project from the Crowdin dashboard.
|
||||
4. **Choose a Language**: Find the language you want to contribute translations for and click on 'Go to Editor' to start translating.
|
||||
5. **Start Translating**: In the editor, you'll see a list of strings on the left-hand side. Click on a string to select it, then enter your translation in the editor box. When you're finished with a string, click 'Save' to store your translation. Repeat this process for each string you wish to translate.
|
||||
|
||||
Your contribution will be reviewed, and upon approval, your translation will be included in the next release of the Meshtastic Android app. Thank you for helping expand the reach of Meshtastic!
|
||||
|
|
@ -3,6 +3,7 @@ id: installation
|
|||
title: Apple Application Installation
|
||||
description: Download on the App Store
|
||||
sidebar_label: Installation
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
<a href="https://apple.co/3Auysep">
|
||||
|
|
|
|||
18
docs/software/apple/translate.mdx
Normal file
18
docs/software/apple/translate.mdx
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
---
|
||||
id: apple-app-translate
|
||||
title: Translate the Apple App
|
||||
sidebar_label: Translate
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## How to Contribute
|
||||
|
||||
Contributing translations to the Meshtastic Apple app helps make the project accessible to a wider audience. Follow these steps to add translations for a new language:
|
||||
|
||||
1. **Fork the Repository**: Start by forking the [Meshtastic-Apple repository](<https://github.com/meshtastic/Meshtastic-Apple/tree/main>) to your GitHub account.
|
||||
2. **Create a Language Folder**: In your forked repository, create a new folder for your language using the language code followed by `.lproj`. For example, for German, create a folder named `de.lproj`.
|
||||
3. **Copy the Localizable.strings File**: Navigate to the [English strings folder](<https://github.com/meshtastic/Meshtastic-Apple/blob/main/en.lproj/Localizable.strings>) and copy the `Localizable.strings` file. Paste this file into the folder you created in the previous step.
|
||||
4. **Translate the Strings**: Open the `Localizable.strings` file in your language folder and translate the English strings into your language. Be sure to maintain the format of the file.
|
||||
5. **Create a Pull Request**: Once you've completed the translation, create a new pull request from your forked repository to the main Meshtastic-Apple repository. Title the pull request appropriately (e.g., "Add German Translation") and describe the changes you've made.
|
||||
|
||||
Your contribution will be reviewed, and upon approval, your translation will be included in the next release of the Meshtastic Apple app. Thank you for helping expand the reach of Meshtastic!
|
||||
|
|
@ -2,6 +2,7 @@
|
|||
id: usage
|
||||
title: Apple Application Usage
|
||||
sidebar_label: Usage
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## Offline Maps
|
||||
|
|
|
|||
|
|
@ -268,7 +268,7 @@ First, create an input text helper entity. The preferred way to configure an inp
|
|||
|
||||
### Create a Send Message Automation
|
||||
|
||||
This automation will check the send box for changes. After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to call your channel "mqtt" and to update the device ID and `from` field in the example below.
|
||||
This automation will check the send box for changes. After typing a message, either hit enter or click off the box and the automation will send a text string in JSON to the mqtt broker. Make sure to publish to a channel called "mqtt" and to update the device ID and `from` field in the example below. A field `channel` can be added to transmit on a different channel index than the primary, or a `to` field can be added with a node number to send a DM.
|
||||
|
||||
```yaml
|
||||
- alias: Meshtastic - Send Automation
|
||||
|
|
|
|||
|
|
@ -98,11 +98,13 @@ If the message received contains valid JSON in the payload, the JSON is deserial
|
|||
|
||||
|
||||
#### JSON downlink to instruct a node to send a message
|
||||
You can also send a JSON message to the topic `msh/2/json/mqtt/` to instruct a gateway node to send a message to the mesh. Note that the channel **must** be called "mqtt". The JSON message should contain the following fields:
|
||||
You can also send a JSON message to the topic `msh/2/json/mqtt/` to instruct a gateway node to send a message to the mesh. Note that the channel you publish it on **must** be called "mqtt". The JSON message should contain the following fields:
|
||||
|
||||
```json
|
||||
{
|
||||
"from": <node number>,
|
||||
"from": <node number of MQTT node>,
|
||||
"to": <node number of recipient for a DM (optional)>,
|
||||
"channel": <channel index (optional)>,
|
||||
"type": "type",
|
||||
"payload": {
|
||||
"key":"value"
|
||||
|
|
@ -111,7 +113,7 @@ You can also send a JSON message to the topic `msh/2/json/mqtt/` to instruct a g
|
|||
}
|
||||
```
|
||||
|
||||
`from` and `payload` fields are required for a valid envelope (note that in firmware <2.2.20 a field `sender` was required, but this is no longer the case). The `from` field should be equal to the node number of the node that will transmit the message. Optionally, you can specify a destination by setting the `to` field to the node number of the destination. If the `to` field is not set, the message will be broadcast to all nodes on the mesh.
|
||||
`from` and `payload` fields are required for a valid envelope (note that in firmware <2.2.20 a field `sender` was required, but this is no longer the case). The `from` field should be equal to the node number of the node that will transmit the message. Optionally, you can specify a different channel than the primary channel by setting the `channel` field to a channel index (0-7). Furthermore, you can send a direct message by setting the `to` field to the node number of the destination. If the `to` field is not set, the message will be broadcast to all nodes on the mesh.
|
||||
|
||||
Currently two types of messages are supported: `"sendtext"` and `"sendposition"`.
|
||||
For the type `sendtext`, the `payload` should be a string containing the text to send. For the type `sendposition`, the payload should be an object with the fields `latitude_i`, `longitude_i`, `altitude` (optional) and `time` (optional).
|
||||
|
|
|
|||
|
|
@ -54,13 +54,15 @@ The JSON output only publishes the following subset of the messages on a Meshtas
|
|||
> Protobufs are mesh native.
|
||||
|
||||
#### 1. Using JSON-encoded messages
|
||||
Make sure that option *JSON Output Enabled* is set in MQTT module options and your channel is called "mqtt".
|
||||
Make sure that option *JSON Output Enabled* is set in MQTT module options and you have a channel called "mqtt".
|
||||
|
||||
Below is a valid JSON envelope for information sent by MQTT to a device for broadcast onto the mesh.
|
||||
Below is a valid JSON envelope for information sent by MQTT to a device for broadcast onto the mesh. The `to` field is optional and can be omitted for broadcast. The `channel` field is also optional and can be omitted to send to the primary channel.
|
||||
|
||||
```json
|
||||
{
|
||||
"from":<node number of the transmitter>,
|
||||
"to": <node number of the receiver for a DM (optional)>,
|
||||
"channel": <channel index (optional)>,
|
||||
"type":"sendtext",
|
||||
"payload": text or a json object go here
|
||||
}
|
||||
|
|
@ -979,7 +981,7 @@ The flow is:
|
|||
]
|
||||
```
|
||||
|
||||
Sending a position to a device for broadcast to the mesh is much easier with JSON. It requires a channel called "mqtt". This introduces a new MQTT Service Envelope type: "sendposition". A valid MQTT envelope and message to broadcast lat, lon, altitude (optional) and time (optional) looks like this:
|
||||
Sending a position to a device for broadcast to the mesh is much easier with JSON. It requires the message to be published to a channel called "mqtt". You can let the message send out to a different channel by setting the `channel` field to a channel index (0-7). Then use the MQTT Service Envelope type: "sendposition". A valid MQTT envelope and message to broadcast lat, lon, altitude (optional) and time (optional) looks like this:
|
||||
|
||||
```json
|
||||
{
|
||||
|
|
|
|||
113
docs/terms/index.mdx
Normal file
113
docs/terms/index.mdx
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
---
|
||||
id: glossary
|
||||
title: Glossary of Terms
|
||||
slug: /terms/
|
||||
---
|
||||
|
||||
App / Application / Client Application
|
||||
: An application that connects to a Meshtastic node, typically for the purpose of sending or receiving data through the mesh network.
|
||||
|
||||
Band
|
||||
: A range of frequencies used for LoRa, dependent on region. Meshtastic further divides these bands into channels. Sometimes identified by the lower and upper bounds of the range (e.g. 902-928MHz), sometimes identified by a center frequency within the range (e.g. 915MHz), and sometimes only by the region they apply to (e.g. US).
|
||||
|
||||
Broadcast
|
||||
: Sending a message or data from one device to all other devices within range in the Meshtastic network, rather than to a specific recipient.
|
||||
|
||||
Channel | [Configuration](/docs/configuration/radio/channels/) | [Frequency Calculator](/docs/overview/radio-settings/#channel-frequency-calculator)
|
||||
: At least two definitions in Meshtastic usage: 1) One of 8 configurable channels in the firmware, each supporting a separate name and encryption, with one set as primary and the rest secondary. 2) A specific frequency within a LoRa band that a device can be configured to use.
|
||||
|
||||
CLI | [Guide](/docs/software/python/cli/)
|
||||
: Command Line Interface, a text-based interface used for interacting with software or devices like Meshtastic.
|
||||
|
||||
Client
|
||||
: A device or application that connects to a Meshtastic node, typically for the purpose of sending or receiving data through the mesh network.
|
||||
|
||||
Device
|
||||
: A physical piece of hardware that utilizes the Meshtastic software and LoRa (Long Range) radio technology to create a decentralized, long-range mesh network.
|
||||
|
||||
DFU
|
||||
: Device Firmware Update, a state which a device is placed into for it to receive a firmware update
|
||||
|
||||
ESP32 | [Drivers](/docs/getting-started/serial-drivers/esp32/) | [Firmware](/docs/getting-started/flashing-firmware/esp32/)
|
||||
: A chipset of microcontroller made/designed by Espressif, used by a number of devices. Higher power usage than NRF52, but often cheaper and supports WiFi if desired.
|
||||
|
||||
Firmware | [Guide](https://meshtastic.org/docs/getting-started/flashing-firmware/)
|
||||
: The low-level software programmed onto a Meshtastic device, controlling its hardware functions and enabling it to communicate within the mesh network using LoRa technology. Firmware
|
||||
|
||||
Flash/Flashing | [Guide](https://meshtastic.org/docs/getting-started/flashing-firmware/)
|
||||
: The process of updating or installing firmware on a Meshtastic device. This is typically done using a computer to load new firmware versions or custom software to enhance or modify device functionality.
|
||||
|
||||
GPIO
|
||||
: General Purpose Input/Output. An uncommitted digital signal pin on a device
|
||||
|
||||
LoRa
|
||||
: A low-power, long-range wireless communication technology used by Meshtastic devices to enable communication over distances of several kilometers without the need for cellular, Wi-Fi, or other traditional network infrastructures.
|
||||
|
||||
LoS
|
||||
: Line of Sight, a pathway through only air between two points.
|
||||
|
||||
Mesh | [Algorithm](/docs/overview/mesh-algo/)
|
||||
: In the context of Meshtastic and networking, a mesh refers to a network topology where devices (nodes) are interconnected, allowing them to directly and dynamically communicate with each other. This setup enables data to be relayed across the network, improving coverage and reliability, especially in challenging environments.
|
||||
|
||||
Message
|
||||
: A piece of data or text sent between Meshtastic devices over the mesh network, which can include text communications, GPS location updates, and other small data payloads.
|
||||
|
||||
MHz
|
||||
: Megahertz, a unit of frequency equal to one million hertz (cycles per second), used to specify the operating frequency of LoRa devices in the Meshtastic network, affecting range and data rate.
|
||||
|
||||
Module | [Software Modules](/docs/configuration/module/) | [Hardware Modules](/docs/hardware/devices/)
|
||||
: At least two definitions in Meshtastic usage: 1) A software plug-in to expand the capabilities of a Meshtastic device. 2) A hardware component or add-on for a Meshtastic device, such as a temperature sensor or GPS.
|
||||
|
||||
[MQTT](/docs/software/integrations/mqtt/)
|
||||
: An acronym for Message Queuing Telemetry Transport, is a lightweight messaging protocol designed for small sensors and mobile devices, enabling efficient data transmission in the Meshtastic network for Internet connectivity and integration with IoT platforms. See https://en.wikipedia.org/wiki/MQTT. In Meshtastic, MQTT is used to connect a node to the internet, and can be used to connect multiple meshes to each other.
|
||||
|
||||
Node
|
||||
: A unit within the Meshtastic network that can send, receive, and relay messages, helping to form and extend the mesh network's coverage.
|
||||
|
||||
NRF52 | [Drivers](/docs/getting-started/serial-drivers/nrf52/) | [Firmware](/docs/getting-started/flashing-firmware/nrf52/)
|
||||
: A microcontroller chipset made by Nordic, used by a number of devices used by several devices such as the RAK Meshtastic Starter Kit and the Lilygo T-Echo. Lower power usage than ESP32.
|
||||
|
||||
Packet
|
||||
: A formatted unit of data sent over the network. In Meshtastic, packets carry messages, GPS locations, and other information through the LoRa mesh network.
|
||||
|
||||
Protobuf | [Reference](/docs/development/reference/protobufs/)
|
||||
: Protocol Buffers, a method developed by Google for serializing structured data, used in Meshtastic for efficient communication protocol between devices.
|
||||
|
||||
PSK | [Encryption](/docs/overview/encryption/)
|
||||
: Pre-Shared Key, a secret code or passphrase used in Meshtastic channels for encryption, ensuring that only devices with the matching PSK can communicate within that specific channel.
|
||||
|
||||
Repeater | [Role Definitions](/docs/configuration/radio/device/#roles)
|
||||
: Infrastructure node for extending network coverage by relaying messages with minimal overhead. Not visible in Nodes list.
|
||||
|
||||
Router | [Role Definitions](/docs/configuration/radio/device/#roles)
|
||||
: Infrastructure node for extending network coverage by relaying messages. Visible in Nodes list.
|
||||
|
||||
rp2040
|
||||
: A microcontroller chip developed by Raspberry Pi, featuring dual ARM Cortex-M0+ processors.
|
||||
|
||||
RX
|
||||
: Abbreviation for Receive.
|
||||
|
||||
Sensor
|
||||
: A device component that detects and responds to some type of input from the physical environment. In Meshtastic, sensors can be used to gather environmental data (e.g., temperature, humidity, GPS location) which can then be transmitted over the mesh network for monitoring or other applications.
|
||||
|
||||
Serial
|
||||
: A communication protocol used for the transmission of data between the Meshtastic device and a computer or other devices. Typically over USB or UART.
|
||||
|
||||
SNR
|
||||
: Signal-to-Noise Ratio, a measure used in communications to quantify the level of a desired signal to the level of background noise. In Meshtastic and other wireless systems, a higher SNR indicates a clearer signal that can enhance the reliability and quality of data transmission.
|
||||
|
||||
SWR
|
||||
: Standing Wave Ratio, a measure of the efficiency of the radio frequency (RF) power transmission from a transmitter through a transmission line to an antenna in Meshtastic devices. It indicates the ratio of the amplitude of a standing wave at maximum to the amplitude at minimum, with an ideal SWR close to 1:1, signifying that most of the power is transmitted to the antenna with minimal reflections.
|
||||
|
||||
Telemetry
|
||||
: The sending of sensor data or system metrics over the mesh network.
|
||||
|
||||
Tranceiver
|
||||
: A device capable of both transmitting and receiving communications.
|
||||
|
||||
Transmit
|
||||
: The act of sending data, such as messages or GPS locations, from one Meshtastic device to another over the LoRa network.
|
||||
|
||||
TX
|
||||
: Abbreviation for Transmit.
|
||||
|
|
@ -1,6 +1,7 @@
|
|||
// @ts-check
|
||||
|
||||
require("dotenv").config();
|
||||
import remarkDefList from "remark-deflist";
|
||||
|
||||
/** @type {import('@docusaurus/types').Config} */
|
||||
const config = {
|
||||
|
|
@ -121,6 +122,7 @@ const config = {
|
|||
editUrl: "https://github.com/meshtastic/meshtastic/edit/master/",
|
||||
breadcrumbs: false,
|
||||
showLastUpdateAuthor: true,
|
||||
remarkPlugins: [remarkDefList],
|
||||
},
|
||||
theme: {
|
||||
customCss: require.resolve("./src/css/custom.css"),
|
||||
|
|
|
|||
|
|
@ -27,8 +27,11 @@
|
|||
"dotenv": "^16.3.1",
|
||||
"postcss": "^8.4.33",
|
||||
"react": "^18.2.0",
|
||||
"react-accessible-accordion": "^5.0.0",
|
||||
"react-dom": "^18.2.0",
|
||||
"react-icons": "^4.12.0",
|
||||
"react-markdown": "^9.0.1",
|
||||
"remark-deflist": "^1.0.0",
|
||||
"swr": "^2.2.4",
|
||||
"tailwindcss": "^3.4.1"
|
||||
},
|
||||
|
|
|
|||
|
|
@ -50,12 +50,21 @@ dependencies:
|
|||
react:
|
||||
specifier: ^18.2.0
|
||||
version: 18.2.0
|
||||
react-accessible-accordion:
|
||||
specifier: ^5.0.0
|
||||
version: 5.0.0(react-dom@18.2.0)(react@18.2.0)
|
||||
react-dom:
|
||||
specifier: ^18.2.0
|
||||
version: 18.2.0(react@18.2.0)
|
||||
react-icons:
|
||||
specifier: ^4.12.0
|
||||
version: 4.12.0(react@18.2.0)
|
||||
react-markdown:
|
||||
specifier: ^9.0.1
|
||||
version: 9.0.1(@types/react@18.2.47)(react@18.2.0)
|
||||
remark-deflist:
|
||||
specifier: ^1.0.0
|
||||
version: 1.0.0
|
||||
swr:
|
||||
specifier: ^2.2.4
|
||||
version: 2.2.4(react@18.2.0)
|
||||
|
|
@ -5790,6 +5799,10 @@ packages:
|
|||
engines: {node: '>=8'}
|
||||
dev: false
|
||||
|
||||
/html-url-attributes@3.0.0:
|
||||
resolution: {integrity: sha512-/sXbVCWayk6GDVg3ctOX6nxaVj7So40FcFAnWlWGNAB1LpYKcV5Cd10APjPjW80O7zYW2MsjBV4zZ7IZO5fVow==}
|
||||
dev: false
|
||||
|
||||
/html-void-elements@3.0.0:
|
||||
resolution: {integrity: sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==}
|
||||
dev: false
|
||||
|
|
@ -6689,6 +6702,13 @@ packages:
|
|||
transitivePeerDependencies:
|
||||
- supports-color
|
||||
|
||||
/mdast-util-phrasing@3.0.1:
|
||||
resolution: {integrity: sha512-WmI1gTXUBJo4/ZmSk79Wcb2HcjPJBzM1nlI/OUWA8yk2X9ik3ffNbBGsU+09BFmXaL1IBb9fiuvq6/KMiNycSg==}
|
||||
dependencies:
|
||||
'@types/mdast': 3.0.15
|
||||
unist-util-is: 5.2.1
|
||||
dev: false
|
||||
|
||||
/mdast-util-phrasing@4.0.0:
|
||||
resolution: {integrity: sha512-xadSsJayQIucJ9n053dfQwVu1kuXg7jCTdYsMK8rqzKZh52nLfSH/k0sAxE0u+pj/zKZX+o5wB+ML5mRayOxFA==}
|
||||
dependencies:
|
||||
|
|
@ -6707,6 +6727,19 @@ packages:
|
|||
unist-util-position: 5.0.0
|
||||
unist-util-visit: 5.0.0
|
||||
|
||||
/mdast-util-to-markdown@1.5.0:
|
||||
resolution: {integrity: sha512-bbv7TPv/WC49thZPg3jXuqzuvI45IL2EVAr/KxF0BSdHsU0ceFHOmwQn6evxAh1GaoK/6GQ1wp4R4oW2+LFL/A==}
|
||||
dependencies:
|
||||
'@types/mdast': 3.0.15
|
||||
'@types/unist': 2.0.10
|
||||
longest-streak: 3.1.0
|
||||
mdast-util-phrasing: 3.0.1
|
||||
mdast-util-to-string: 3.2.0
|
||||
micromark-util-decode-string: 1.1.0
|
||||
unist-util-visit: 4.1.2
|
||||
zwitch: 2.0.4
|
||||
dev: false
|
||||
|
||||
/mdast-util-to-markdown@2.1.0:
|
||||
resolution: {integrity: sha512-SR2VnIEdVNCJbP6y7kVTJgPLifdr8WEU440fQec7qHoHOUz/oJ2jmNRqdDQ3rbiStOXb2mCDGTuwsK5OPUgYlQ==}
|
||||
dependencies:
|
||||
|
|
@ -8390,6 +8423,16 @@ packages:
|
|||
strip-json-comments: 2.0.1
|
||||
dev: false
|
||||
|
||||
/react-accessible-accordion@5.0.0(react-dom@18.2.0)(react@18.2.0):
|
||||
resolution: {integrity: sha512-MT2obYpTgLIIfPr9d7hEyvPB5rg8uJcHpgA83JSRlEUHvzH48+8HJPvzSs+nM+XprTugDgLfhozO5qyJpBvYRQ==}
|
||||
peerDependencies:
|
||||
react: ^16.3.2 || ^17.0.0 || ^18.0.0
|
||||
react-dom: ^16.3.3 || ^17.0.0 || ^18.0.0
|
||||
dependencies:
|
||||
react: 18.2.0
|
||||
react-dom: 18.2.0(react@18.2.0)
|
||||
dev: false
|
||||
|
||||
/react-dev-utils@12.0.1(typescript@5.3.3)(webpack@5.89.0):
|
||||
resolution: {integrity: sha512-84Ivxmr17KjUupyqzFode6xKhjwuEJDROWKJy/BthkL7Wn6NJ8h4WE6k/exAv6ImS+0oZLRRW5j/aINMHyeGeQ==}
|
||||
engines: {node: '>=14'}
|
||||
|
|
@ -8506,6 +8549,28 @@ packages:
|
|||
webpack: 5.89.0
|
||||
dev: false
|
||||
|
||||
/react-markdown@9.0.1(@types/react@18.2.47)(react@18.2.0):
|
||||
resolution: {integrity: sha512-186Gw/vF1uRkydbsOIkcGXw7aHq0sZOCRFFjGrr7b9+nVZg4UfA4enXCaxm4fUzecU38sWfrNDitGhshuU7rdg==}
|
||||
peerDependencies:
|
||||
'@types/react': '>=18'
|
||||
react: '>=18'
|
||||
dependencies:
|
||||
'@types/hast': 3.0.3
|
||||
'@types/react': 18.2.47
|
||||
devlop: 1.1.0
|
||||
hast-util-to-jsx-runtime: 2.3.0
|
||||
html-url-attributes: 3.0.0
|
||||
mdast-util-to-hast: 13.0.2
|
||||
react: 18.2.0
|
||||
remark-parse: 11.0.0
|
||||
remark-rehype: 11.0.0
|
||||
unified: 11.0.4
|
||||
unist-util-visit: 5.0.0
|
||||
vfile: 6.0.1
|
||||
transitivePeerDependencies:
|
||||
- supports-color
|
||||
dev: false
|
||||
|
||||
/react-router-config@5.1.1(react-router@5.3.4)(react@18.2.0):
|
||||
resolution: {integrity: sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==}
|
||||
peerDependencies:
|
||||
|
|
@ -8671,6 +8736,17 @@ packages:
|
|||
engines: {node: '>= 0.10'}
|
||||
dev: false
|
||||
|
||||
/remark-deflist@1.0.0:
|
||||
resolution: {integrity: sha512-sDHM+ZbgWC6wwaxltMdH5x+XYMW8VpjyeHyC2ZCI106+iYgbPv8lBYKiNqdW0Cs0FVox/LysYhb3qIZe1b0cmg==}
|
||||
dependencies:
|
||||
mdast-util-from-markdown: 1.3.1
|
||||
mdast-util-to-markdown: 1.5.0
|
||||
mdast-util-to-string: 3.2.0
|
||||
unist-util-visit: 4.1.2
|
||||
transitivePeerDependencies:
|
||||
- supports-color
|
||||
dev: false
|
||||
|
||||
/remark-directive@3.0.0:
|
||||
resolution: {integrity: sha512-l1UyWJ6Eg1VPU7Hm/9tt0zKtReJQNOA4+iDMAxTyZNWnJnFlbS/7zhiel/rogTLQ2vMYwDzSJa4BiVNqGlqIMA==}
|
||||
dependencies:
|
||||
|
|
@ -9598,6 +9674,12 @@ packages:
|
|||
crypto-random-string: 4.0.0
|
||||
dev: false
|
||||
|
||||
/unist-util-is@5.2.1:
|
||||
resolution: {integrity: sha512-u9njyyfEh43npf1M+yGKDGVPbY/JWEemg5nH05ncKPfi+kBbKBJoTdsogMu33uhytuLlv9y0O7GH7fEdwLdLQw==}
|
||||
dependencies:
|
||||
'@types/unist': 2.0.10
|
||||
dev: false
|
||||
|
||||
/unist-util-is@6.0.0:
|
||||
resolution: {integrity: sha512-2qCTHimwdxLfz+YzdGfkqNlH0tLi9xjTnHddPmJwtIG9MGsdbutfTc4P+haPD7l7Cjxf/WZj+we5qfVPvvxfYw==}
|
||||
dependencies:
|
||||
|
|
@ -9630,12 +9712,27 @@ packages:
|
|||
dependencies:
|
||||
'@types/unist': 3.0.2
|
||||
|
||||
/unist-util-visit-parents@5.1.3:
|
||||
resolution: {integrity: sha512-x6+y8g7wWMyQhL1iZfhIPhDAs7Xwbn9nRosDXl7qoPTSCy0yNxnKc+hWokFifWQIDGi154rdUqKvbCa4+1kLhg==}
|
||||
dependencies:
|
||||
'@types/unist': 2.0.10
|
||||
unist-util-is: 5.2.1
|
||||
dev: false
|
||||
|
||||
/unist-util-visit-parents@6.0.1:
|
||||
resolution: {integrity: sha512-L/PqWzfTP9lzzEa6CKs0k2nARxTdZduw3zyh8d2NVBnsyvHjSX4TWse388YrrQKbvI8w20fGjGlhgT96WwKykw==}
|
||||
dependencies:
|
||||
'@types/unist': 3.0.2
|
||||
unist-util-is: 6.0.0
|
||||
|
||||
/unist-util-visit@4.1.2:
|
||||
resolution: {integrity: sha512-MSd8OUGISqHdVvfY9TPhyK2VdUrPgxkUtWSuMHF6XAAFuL4LokseigBnZtPnJMu+FbynTkFNnFlyjxpVKujMRg==}
|
||||
dependencies:
|
||||
'@types/unist': 2.0.10
|
||||
unist-util-is: 5.2.1
|
||||
unist-util-visit-parents: 5.1.3
|
||||
dev: false
|
||||
|
||||
/unist-util-visit@5.0.0:
|
||||
resolution: {integrity: sha512-MR04uvD+07cwl/yhVuVWAtw+3GOR/knlL55Nd/wAdblk27GCVt3lqpTivy/tkJcZoNPzTwS1Y+KMojlLDhoTzg==}
|
||||
dependencies:
|
||||
|
|
|
|||
98
src/components/FaqAccordion.tsx
Normal file
98
src/components/FaqAccordion.tsx
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
import BrowserOnly from "@docusaurus/BrowserOnly";
|
||||
import {
|
||||
Accordion,
|
||||
AccordionItem,
|
||||
AccordionItemButton,
|
||||
AccordionItemHeading,
|
||||
AccordionItemPanel,
|
||||
} from "react-accessible-accordion";
|
||||
import ReactMarkdown from "react-markdown";
|
||||
|
||||
import "../css/faq.css";
|
||||
|
||||
export interface Faq {
|
||||
title: string;
|
||||
content: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the query parameter `openFaqItems` which is an array of
|
||||
* faq items that should be pre-opened
|
||||
* @type {Function}
|
||||
*/
|
||||
const getOpenFaqItemsFromUrl = (slug: string): string[] => {
|
||||
if (typeof window !== "undefined") {
|
||||
// Use URLSearchParams to parse the query parameters from the current URL
|
||||
const searchParams = new URLSearchParams(window.location.search);
|
||||
|
||||
// Get the 'openFaqItems' parameter as a comma-separated string
|
||||
const openFaqItemsString = searchParams.get(`openFaqItems-${slug}`);
|
||||
|
||||
// If the parameter exists, split it by commas into an array; otherwise, return an empty array
|
||||
return openFaqItemsString ? openFaqItemsString.split(",") : [];
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Updates query parameters in the url when items are opened
|
||||
* so that a link can be shared with the faq item already opened
|
||||
*/
|
||||
const handleChange = (
|
||||
openFaqItems: (string | number)[],
|
||||
slug: string,
|
||||
): void => {
|
||||
const searchParams = new URLSearchParams(window.location.search);
|
||||
|
||||
if (openFaqItems.length > 0) {
|
||||
// Create comma-separated string and update/add the parameter
|
||||
searchParams.set(
|
||||
`openFaqItems-${slug}`,
|
||||
openFaqItems.map(String).join(","),
|
||||
);
|
||||
} else {
|
||||
// If openFaqItems is empty, remove the parameter from the URL
|
||||
searchParams.delete(`openFaqItems-${slug}`);
|
||||
}
|
||||
|
||||
// Construct the new URL, preserve existing parameters
|
||||
const newUrl = `${window.location.protocol}//${window.location.host}${
|
||||
window.location.pathname
|
||||
}?${searchParams.toString()}`;
|
||||
|
||||
// Change the URL without reloading the page
|
||||
window.history.pushState({ path: newUrl }, "", newUrl);
|
||||
};
|
||||
|
||||
export const FaqAccordion = ({
|
||||
rows,
|
||||
slug,
|
||||
}: { rows: Faq[]; slug: string }): JSX.Element => {
|
||||
return (
|
||||
<BrowserOnly fallback={<div>Loading FAQ's...</div>}>
|
||||
{() => {
|
||||
return (
|
||||
<Accordion
|
||||
allowMultipleExpanded={true}
|
||||
allowZeroExpanded={true}
|
||||
onChange={(itemUuids) => {
|
||||
handleChange(itemUuids, slug);
|
||||
}}
|
||||
preExpanded={getOpenFaqItemsFromUrl(slug)}
|
||||
>
|
||||
{rows.map((row, index) => (
|
||||
// biome-ignore lint/suspicious/noArrayIndexKey: React complains if there is no key
|
||||
<AccordionItem key={index}>
|
||||
<AccordionItemHeading aria-level="3">
|
||||
<AccordionItemButton>{row.title}</AccordionItemButton>
|
||||
</AccordionItemHeading>
|
||||
<AccordionItemPanel>
|
||||
<ReactMarkdown>{row.content}</ReactMarkdown>
|
||||
</AccordionItemPanel>
|
||||
</AccordionItem>
|
||||
))}
|
||||
</Accordion>
|
||||
);
|
||||
}}
|
||||
</BrowserOnly>
|
||||
);
|
||||
};
|
||||
20
src/components/FaqStructuredData.tsx
Normal file
20
src/components/FaqStructuredData.tsx
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
export const FaqStructuredData = ({ faqs }) => {
|
||||
const allFaqs = Object.values(faqs).flat();
|
||||
|
||||
const structuredData = {
|
||||
"@context": "https://schema.org",
|
||||
"@type": "FAQPage",
|
||||
mainEntity: allFaqs.map((faq) => ({
|
||||
"@type": "Question",
|
||||
name: faq.title,
|
||||
acceptedAnswer: {
|
||||
"@type": "Answer",
|
||||
text: faq.content,
|
||||
},
|
||||
})),
|
||||
};
|
||||
|
||||
return (
|
||||
<script type="application/ld+json">{JSON.stringify(structuredData)}</script>
|
||||
);
|
||||
};
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
import { Protobuf, Types } from "@meshtastic/js";
|
||||
import React, { useEffect } from "react";
|
||||
import React, { useEffect, useState } from "react";
|
||||
|
||||
interface Region {
|
||||
freqStart: number;
|
||||
|
|
@ -273,18 +273,18 @@ const modemPresets = new Map<
|
|||
|
||||
export const FrequencyCalculator = (): JSX.Element => {
|
||||
const [modemPreset, setModemPreset] =
|
||||
React.useState<Protobuf.Config.Config_LoRaConfig_ModemPreset>(
|
||||
useState<Protobuf.Config.Config_LoRaConfig_ModemPreset>(
|
||||
Protobuf.Config.Config_LoRaConfig_ModemPreset.LONG_FAST,
|
||||
);
|
||||
const [region, setRegion] =
|
||||
React.useState<Protobuf.Config.Config_LoRaConfig_RegionCode>(
|
||||
useState<Protobuf.Config.Config_LoRaConfig_RegionCode>(
|
||||
Protobuf.Config.Config_LoRaConfig_RegionCode.US,
|
||||
);
|
||||
const [channel, setChannel] = React.useState<Types.ChannelNumber>(
|
||||
Types.ChannelNumber.PRIMARY,
|
||||
const [channel, setChannel] = useState<Types.ChannelNumber>(
|
||||
Types.ChannelNumber.Primary,
|
||||
);
|
||||
const [numChannels, setNumChannels] = React.useState<number>(0);
|
||||
const [channelFrequency, setChannelFrequency] = React.useState<number>(0);
|
||||
const [numChannels, setNumChannels] = useState<number>(0);
|
||||
const [channelFrequency, setChannelFrequency] = useState<number>(0);
|
||||
|
||||
useEffect(() => {
|
||||
const selectedRegion = RegionData.get(region);
|
||||
|
|
@ -344,6 +344,12 @@ export const FrequencyCalculator = (): JSX.Element => {
|
|||
))}
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div className="flex gap-2 mb-4">
|
||||
<label className="font-semibold">Number of channels:</label>
|
||||
<input type="number" disabled={true} value={numChannels} />
|
||||
</div>
|
||||
|
||||
<div className="flex gap-2">
|
||||
<label>Channel:</label>
|
||||
<select
|
||||
|
|
@ -358,10 +364,6 @@ export const FrequencyCalculator = (): JSX.Element => {
|
|||
</select>
|
||||
</div>
|
||||
|
||||
<div className="flex gap-2">
|
||||
<label className="font-semibold">Number of channels:</label>
|
||||
<input type="number" disabled={true} value={numChannels} />
|
||||
</div>
|
||||
<div className="flex gap-2">
|
||||
<label className="font-semibold">Channel Frequency:</label>
|
||||
<input type="number" disabled={true} value={channelFrequency} />
|
||||
|
|
|
|||
|
|
@ -82,13 +82,30 @@ html[data-theme="dark"] .header-github-link:before {
|
|||
color: var(--ifm-link-color);
|
||||
}
|
||||
|
||||
|
||||
.split-container {
|
||||
display: flex;
|
||||
justify-content: space-between;
|
||||
}
|
||||
|
||||
.split-item {
|
||||
flex: 1;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* mobile screens */
|
||||
@media (max-width: 768px) {
|
||||
.split-container {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.split-item {
|
||||
width: 100%;
|
||||
padding: 10px 0;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.indexCtasBody {
|
||||
--ifm-button-size-multiplier: 1.6;
|
||||
display: flex;
|
||||
|
|
|
|||
46
src/css/faq.css
Normal file
46
src/css/faq.css
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
.accordion {
|
||||
border-radius: 2px;
|
||||
border: 1px solid var(--ifm-color-emphasis-200);
|
||||
}
|
||||
|
||||
.accordion__item + .accordion__item {
|
||||
border-top: 1px solid var(--ifm-color-emphasis-200);
|
||||
}
|
||||
|
||||
.accordion__button {
|
||||
background-color: var(--ifm-footer-background-color);
|
||||
border: none;
|
||||
cursor: pointer;
|
||||
padding: calc(var(--ifm-pre-padding)/1.5);
|
||||
text-align: left;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.accordion__button:hover {
|
||||
background-color: var(--ifm-background-surface-color);
|
||||
}
|
||||
|
||||
.accordion__button:before {
|
||||
border-bottom: 2px solid currentColor;
|
||||
border-right: 2px solid currentColor;
|
||||
content: '';
|
||||
display: inline-block;
|
||||
height: 10px;
|
||||
margin-right: 12px;
|
||||
transform: rotate(-45deg);
|
||||
width: 10px;
|
||||
}
|
||||
|
||||
.accordion__button[aria-expanded='true']::before,
|
||||
.accordion__button[aria-selected='true']::before {
|
||||
transform: rotate(45deg);
|
||||
}
|
||||
|
||||
[hidden] {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.accordion__panel {
|
||||
background: var(--ifm-background-color);
|
||||
padding: var(--ifm-pre-padding);
|
||||
}
|
||||
|
|
@ -1,111 +0,0 @@
|
|||
import Link from "@docusaurus/Link";
|
||||
import Layout from "@theme/Layout";
|
||||
|
||||
const Credits = (): JSX.Element => {
|
||||
return (
|
||||
<Layout
|
||||
title="Credits"
|
||||
description="Meshtastic is made possible by the following people & organizations."
|
||||
>
|
||||
<main className="relative mt-20">
|
||||
<div className="container mx-auto p-6 leading-normal space-y-4">
|
||||
<h1>Credits</h1>
|
||||
<p>
|
||||
Meshtastic is community driven. Thousands of hours have been donated
|
||||
by volunteers who want to develop this amazing project. Whether
|
||||
you've submitted a pull request or triaged a bug in our
|
||||
Discord/Forum. You've made Meshtastic possible. Thank you for your
|
||||
contributions.
|
||||
</p>
|
||||
<p>
|
||||
We would also like to recognize those who have donated financially
|
||||
to the project. As Meshtastic has grown, we've aquired some ongoing
|
||||
costs to keep the project running. Thank you for your generous
|
||||
donations.
|
||||
</p>
|
||||
</div>
|
||||
<div className="container mx-auto p-6 leading-normal space-y-4">
|
||||
<h2>Fiscal Sponsors</h2>
|
||||
<p>
|
||||
We have partnered with both the{" "}
|
||||
<a
|
||||
className="underline"
|
||||
href="https://opencollective.com"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
Open Collective
|
||||
</a>{" "}
|
||||
and the{" "}
|
||||
<a
|
||||
className="underline"
|
||||
href="https://www.oscollective.org"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
Open Source Collective
|
||||
</a>{" "}
|
||||
to help us with a fiscal management framework and banking needs.
|
||||
They help support over three thousand open source projects including
|
||||
the PHP Foundation, F-Droid, Sonarr, LinuxServer and DarkReader. We
|
||||
are in good hands and good company.
|
||||
</p>
|
||||
<p>
|
||||
As with everything we do here, Open Collective provides a fully
|
||||
transparent framework for our budget and expenses. You can see what
|
||||
we’re bringing in, who is spending money and where that money is
|
||||
going{" "}
|
||||
<a
|
||||
className="underline"
|
||||
href="https://opencollective.com/meshtastic"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
here
|
||||
</a>
|
||||
.
|
||||
</p>
|
||||
<p>
|
||||
In addition to our partnership with Open Collective and Open Source
|
||||
Collective, we have also been approved into the{" "}
|
||||
<a
|
||||
className="underline"
|
||||
href="https://github.com/sponsors"
|
||||
rel="noreferrer"
|
||||
target="_blank"
|
||||
>
|
||||
GitHub Sponsors
|
||||
</a>{" "}
|
||||
program where we can set fundraising goals with GitHub.
|
||||
</p>
|
||||
<p>
|
||||
All donations made through GitHub will be deposited to our account
|
||||
with the Open Source Collective and managed by the Open Collective.
|
||||
This means we have a single place to monitor and maintain
|
||||
transparency of our finances.
|
||||
</p>
|
||||
<p>If you are able, please contribute to this amazing project.</p>
|
||||
<div className="indexCtasBody">
|
||||
<Link
|
||||
className={"button button--outline button--lg cta--button"}
|
||||
to={"https://opencollective.com/meshtastic/donate"}
|
||||
>
|
||||
Sponsor Meshtastic
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
<div className="container mx-auto p-6 leading-normal space-y-4">
|
||||
<h2>Contributors</h2>
|
||||
<p>
|
||||
Literally thousands of hours have gone into creating, maintaining,
|
||||
and improving Meshtastic. Without our contributors none of this
|
||||
would be possible. Thank you for donating the time for each and
|
||||
every commit, issue, and pull request.
|
||||
</p>
|
||||
</div>
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
};
|
||||
|
||||
export default Credits;
|
||||
Loading…
Reference in a new issue