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

combine json

Browse source
This commit is contained in:
thomas.ekstrand 2024-02-13 21:27:02 -06:00
parent c53625948e
commit 384aa87d06
2 changed files with 182 additions and 187 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
docs/about/faq.mdx
View file

@ -7,7 +7,8 @@ sidebar_position: 3
import { FaqAccordion } from "/src/components/FaqAccordion";
export const GeneralFaq = [
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.`,
@ -16,9 +17,8 @@ export const GeneralFaq = [
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.",
},
];
export const AndroidFaq = [
],
"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/).`,
@ -26,11 +26,11 @@ export const AndroidFaq = [
{
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.`,
- 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?",
@ -40,9 +40,8 @@ export const AndroidFaq = [
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.`,
},
];
export const AppleFaq = [
],
"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.`,
@ -59,16 +58,14 @@ export const AppleFaq = [
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 = [
],
"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.`,
},
];
export const PythonFaq = [
],
"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).`,
@ -81,9 +78,8 @@ export const PythonFaq = [
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).",
},
];
export const DevicesFaq = [
],
"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.`,
@ -123,30 +119,29 @@ export const DevicesFaq = [
{
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.`,
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`.",
},
];
export const HamFaq = [
],
"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
If you use your ham radio license with Meshtastic, consider both the privileges and restrictions:
#### Privileges
- Increased Transmit Power
- Increased Transmit Power
- Up to 10W transmit power in the United States! [47 CFR 97.313(j)](https://www.ecfr.gov/current/title-47/chapter-I/subchapter-D/part-97#p-97.313(j))
- Higher Gain Antennas
- Higher Gain Antennas
#### Restrictions
#### Restrictions
- Plain-Text Only
- 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
- 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))
`,
},
@ -154,13 +149,12 @@ If you use your ham radio license with Meshtastic, consider both the privileges
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).
- 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).
`,
},
];
export const MeshFaq = [
],
"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.`,
@ -173,9 +167,8 @@ export const MeshFaq = [
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.`,
},
];
export const ModulesFaq = [
],
"modules": [
{
title: "What are Modules?",
content: `Modules are features that expand the basic device functionality and/or integrate with other services.`,
@ -188,42 +181,44 @@ export const ModulesFaq = [
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).`,
},
];
],
};
## Overview
<FaqAccordion rows={GeneralFaq} slug="general" />
{<FaqAccordion rows={Faq.general} slug="general" />}
## Android Client
<FaqAccordion rows={AndroidFaq} slug="android" />
<FaqAccordion rows={Faq.android} slug="android" />
## Apple Clients
<FaqAccordion rows={AppleFaq} slug="apple" />
<FaqAccordion rows={Faq.apple} slug="apple" />
## Channels
<FaqAccordion rows={ChannelsFaq} slug="channels" />
<FaqAccordion rows={Faq.channels} slug="channels" />
## Python CLI
<FaqAccordion rows={PythonFaq} slug="python" />
<FaqAccordion rows={Faq.python} slug="python" />
## Devices
<FaqAccordion rows={DevicesFaq} slug="devices" />
<FaqAccordion rows={Faq.devices} slug="devices" />
## Amateur Radio (ham)
Meshtastic can be used by both unlicensed people and licensed HAM operators.
<FaqAccordion rows={HamFaq} slug="ham" />
<FaqAccordion rows={Faq.ham} slug="ham" />
## Mesh
<FaqAccordion rows={MeshFaq} slug="mesh" />
<FaqAccordion rows={Faq.mesh} slug="mesh" />
## Modules
<FaqAccordion rows={ModulesFaq} slug="modules" />
<FaqAccordion rows={Faq.modules} slug="modules" />

2
src/components/FaqAccordion.tsx
View file

@ -104,7 +104,7 @@ export const FaqAccordion = ({
{rows.map((row, index) => (
// biome-ignore lint/suspicious/noArrayIndexKey: React complains if there is no key
<AccordionItem key={index}>
<AccordionItemHeading aria-level="2">
<AccordionItemHeading aria-level="3">
<AccordionItemButton>{row.title}</AccordionItemButton>
</AccordionItemHeading>
<AccordionItemPanel>