mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-12-26 22:19:46 -08:00
all sections converted
This commit is contained in:
thomas.ekstrand
parent
0da1b5df48
commit
b687e0b5b8
|
|
@ -42,114 +42,128 @@ export const AndroidFaq = [
|
|||
},
|
||||
];
|
||||
|
||||
export const AppleFaq = [
|
||||
{
|
||||
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).',
|
||||
},
|
||||
];
|
||||
|
||||
export const ChannelsFaq = [
|
||||
{
|
||||
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.`,
|
||||
},
|
||||
];
|
||||
|
||||
export const PythonFaq = [
|
||||
{
|
||||
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).",
|
||||
},
|
||||
];
|
||||
|
||||
## Overview
|
||||
|
||||
<FaqAccordion rows={GeneralFaq} slug="general" />
|
||||
|
||||
<!-- Android Client-->
|
||||
|
||||
## Android Client
|
||||
<FaqAccordion rows={AndroidFaq} slug="android" />
|
||||
|
||||
<!-- Apple Clients-->
|
||||
<FaqAccordion rows={AndroidFaq} slug="android" />
|
||||
|
||||
## 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 -->
|
||||
<FaqAccordion rows={AppleFaq} slug="apple" />
|
||||
|
||||
## 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 -->
|
||||
<FaqAccordion rows={ChannelsFaq} slug="channels" />
|
||||
|
||||
## 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).
|
||||
<FaqAccordion rows={PythonFaq} slug="python" />
|
||||
|
||||
<!-- Devices -->
|
||||
|
||||
## Devices
|
||||
|
||||
### How do I turn **off** an ESP32 T-Beam based device?
|
||||
export const DevicesFaq = [
|
||||
{
|
||||
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`.",
|
||||
},
|
||||
];
|
||||
|
||||
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 -->
|
||||
<FaqAccordion rows={DevicesFaq} slug="devices" />
|
||||
|
||||
## 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?
|
||||
|
||||
export const HamFaq = [
|
||||
{
|
||||
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
|
||||
|
|
@ -162,45 +176,56 @@ If you use your HAM radio license with Meshtastic, consider both the privileges
|
|||
- 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))
|
||||
|
||||
### How do I set my HAM call sign?
|
||||
|
||||
- On Android navigate to Radio configuration -> User and set Long name to your Ham Radio callsign, then activate the slider for 'Licensed amateur radio'.
|
||||
`,
|
||||
},
|
||||
{
|
||||
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).
|
||||
`,
|
||||
},
|
||||
];
|
||||
|
||||
### What if I'm still having issues on Windows 10?
|
||||
Meshtastic can be used by both unlicensed people and licensed HAM operators.
|
||||
|
||||
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).
|
||||
|
||||
<!-- Mesh -->
|
||||
<FaqAccordion rows={HamFaq} slug="ham" />
|
||||
|
||||
## Mesh
|
||||
|
||||
### Does Meshtastic use LoRaWAN?
|
||||
export const MeshFaq = [
|
||||
{
|
||||
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.`,
|
||||
},
|
||||
];
|
||||
|
||||
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={MeshFaq} slug="mesh" />
|
||||
|
||||
## Modules
|
||||
|
||||
### What are Modules?
|
||||
export const ModulesFaq = [
|
||||
{
|
||||
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).`,
|
||||
},
|
||||
];
|
||||
|
||||
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={ModulesFaq} slug="modules" />
|
||||
|
|
|
|||
Loading…
Reference in a new issue