mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-03-05 21:00:08 -08:00
Foster Irwin
GitHub
commit
a9bf305493
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Maintaining Documentation
|
||||
sidebar_label: Maintaining Documentation
|
||||
slug: /about-documentation
|
||||
---
|
||||
Meshtastic documentation is an important ingredient to the overall project. We want users to hit the ground running with the information they need right at their finger tips. This section will discuss the documentation software stack, file organization, and style guides.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Contribute to Meshtastic
|
||||
sidebar_label: Contribute to Meshtastic
|
||||
slug: /developers
|
||||
---
|
||||
# How to Help
|
||||
|
|
|
|||
57
docs/getting-started/clients.md
Normal file
57
docs/getting-started/clients.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
---
|
||||
id: clients
|
||||
title: Clients Overview
|
||||
sidebar_label: Clients Overview
|
||||
---
|
||||
import { DownloadCard } from '/src/pages/downloads/_components/DownloadCard.tsx'
|
||||
|
||||
## Overview
|
||||
|
||||
There are many ways to connect to your newly flashed device. Below is a quickstart for each client that you can use to connect to your radio.
|
||||
|
||||
### Commandline Interface (CLI)
|
||||
|
||||
The CLI is currently the best way to manage your settings. It is feature rich and well documented. The [settings pages](/docs/settings) have examples for each user preference for the device. The CLI is included in the [Meshtastic-python](https://github.com/meshtastic/Meshtastic-python) project. If you'd like to use python to interface with a device, see the [API documentation](https://python.meshtastic.org).
|
||||
|
||||
To install/upgrade Meshtastic-python, see below:
|
||||
|
||||
```bash title="Install Meshtastic-python (includes CLI)"
|
||||
pip install meshtastic
|
||||
```
|
||||
```bash title="Upgrade Meshtastic-python (includes CLI)"
|
||||
pip install --upgrade meshtastic
|
||||
```
|
||||
|
||||
### Mobile Client Downloads
|
||||
<ul
|
||||
style={{
|
||||
position: "relative",
|
||||
display: "grid",
|
||||
gap: "1.5rem",
|
||||
gridTemplateColumns: "repeat(auto-fill, minmax(280px, 1fr))",
|
||||
paddingLeft: "0",
|
||||
}}
|
||||
>
|
||||
<DownloadCard
|
||||
client="Android"
|
||||
imgUrl="https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png"
|
||||
url="https://play.google.com/store/apps/details?id=com.geeksville.mesh&referrer=utm_source=downloads-page"
|
||||
notes={["To sideload, ",<a href="https://github.com/meshtastic/Meshtastic-Android/releases/latest" rel="noreferrer" target="_blank">download the latest .apk</a>," from Github", ]}
|
||||
/>
|
||||
<DownloadCard
|
||||
client="iOS"
|
||||
url="https://testflight.apple.com/join/c8nNl8q1"
|
||||
buttonText="Download on TestFlight"
|
||||
notes="Currently only available in TestFlight"
|
||||
/>
|
||||
</ul>
|
||||
|
||||
### Serial
|
||||
|
||||
Using your preferred program (PuTTy, Serial, etc) connect to your device with the following settings to see the logs in real time.
|
||||
|
||||
| Baudrate | Data Bits | Parity | Stop Bits |
|
||||
| :------: | :-------: | :----: | :-------: |
|
||||
| `921600` | `8` | `None` | `1` |
|
||||
|
||||
### Web
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Getting Started
|
||||
sidebar_label: Getting Started
|
||||
slug: /getting-started
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,15 @@
|
|||
---
|
||||
id: meshtastic-flasher
|
||||
title: Using Meshtastic Flasher GUI
|
||||
sidebar_label: Meshtastic Flasher GUI
|
||||
title: Using Meshtastic Flasher
|
||||
sidebar_label: Using Meshtastic Flasher
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Overview
|
||||
|
||||
Meshtastic Flasher is a graphical user interface for flashing [supported devices](/docs/hardware) with Meshtastic.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Install Meshtastic Flasher by either [downloading the executable file](https://github.com/meshtastic/Meshtastic-gui-installer/releases) or installing using `pip`. The following operating systems are: Windows, Mac, and Ubuntu.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Hardware
|
||||
sidebar_label: Hardware
|
||||
slug: /hardware
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Legal
|
||||
sidebar_label: Legal
|
||||
slug: /legal
|
||||
---
|
||||
## Disclaimers
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Software
|
||||
sidebar_label: Software
|
||||
slug: /software
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
id: overview
|
||||
title: Overview
|
||||
sidebar_label: Overview
|
||||
title: Device Settings
|
||||
sidebar_label: Device Settings
|
||||
slug: /settings
|
||||
---
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
|
|
@ -34,6 +34,18 @@ const config = {
|
|||
activeBasePath: "docs/academy",
|
||||
},
|
||||
*/
|
||||
/*
|
||||
{
|
||||
label: "About Meshtastic",
|
||||
to: "docs/about",
|
||||
activeBasePath: "docs/about",
|
||||
},
|
||||
*/
|
||||
{
|
||||
label: "Showcase",
|
||||
to: "showcase",
|
||||
activeBasePath: "showcase",
|
||||
},
|
||||
{
|
||||
label: "Documentation",
|
||||
items: [
|
||||
|
|
@ -73,11 +85,6 @@ const config = {
|
|||
to: "downloads",
|
||||
activeBasePath: "downloads",
|
||||
},
|
||||
{
|
||||
label: "Showcase",
|
||||
to: "showcase",
|
||||
activeBasePath: "showcase",
|
||||
},
|
||||
{
|
||||
href: "https://meshtastic.discourse.group",
|
||||
label: "Forum",
|
||||
|
|
@ -118,10 +125,6 @@ const config = {
|
|||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
{
|
||||
label: 'YouTube',
|
||||
to: 'https://www.youtube.com/meshtastic',
|
||||
},
|
||||
{
|
||||
label: 'Discord',
|
||||
to: 'https://discord.com/invite/UQJ5QuM7vq',
|
||||
|
|
@ -130,6 +133,14 @@ const config = {
|
|||
label: 'Forum',
|
||||
to: 'https://meshtastic.discourse.group',
|
||||
},
|
||||
{
|
||||
label: 'Reddit',
|
||||
to: 'https://reddit.com/r/meshtastic',
|
||||
},
|
||||
{
|
||||
label: 'YouTube',
|
||||
to: 'https://www.youtube.com/meshtastic',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
63
sidebars.js
63
sidebars.js
|
|
@ -1,5 +1,5 @@
|
|||
module.exports = {
|
||||
About: {
|
||||
Software: {
|
||||
Software: [
|
||||
"software/overview",
|
||||
{
|
||||
|
|
@ -95,23 +95,39 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
],
|
||||
"Additional Documentation": [
|
||||
{type: "ref", id: "getting-started/overview"},
|
||||
{type: "ref", id: "software/settings/overview"},
|
||||
{type: "ref", id: "hardware/overview"},
|
||||
{type: "ref", id: "developers/overview"},
|
||||
{type: "ref", id: "about-documentation/overview"},
|
||||
{type: "ref", id: "legal/overview"},
|
||||
],
|
||||
},
|
||||
GettingStarted: {
|
||||
Configuration: {
|
||||
"Getting Started": [
|
||||
"getting-started/overview",
|
||||
"getting-started/faq",
|
||||
{
|
||||
"Flashing firmware": [
|
||||
"getting-started/meshtastic-flasher",
|
||||
"getting-started/flashing-esp32",
|
||||
"getting-started/flashing-nrf52",
|
||||
{
|
||||
"Manual Method": [
|
||||
"getting-started/flashing-esp32",
|
||||
"getting-started/flashing-nrf52",
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"Connect to Device": [
|
||||
"getting-started/clients",
|
||||
],
|
||||
},
|
||||
"getting-started/concepts",
|
||||
],
|
||||
},
|
||||
Settings: {
|
||||
Settings: [
|
||||
|
||||
"Device Settings": [
|
||||
"software/settings/overview",
|
||||
"software/settings/channel",
|
||||
"software/settings/gps",
|
||||
|
|
@ -136,6 +152,13 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
],
|
||||
"Additional Documentation": [
|
||||
{type: "ref", id: "hardware/overview"},
|
||||
{type: "ref", id: "software/overview"},
|
||||
{type: "ref", id: "developers/overview"},
|
||||
{type: "ref", id: "about-documentation/overview"},
|
||||
{type: "ref", id: "legal/overview"},
|
||||
],
|
||||
},
|
||||
Hardware: {
|
||||
Hardware: [
|
||||
|
|
@ -162,6 +185,14 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
],
|
||||
"Additional Documentation": [
|
||||
{type: "ref", id: "getting-started/overview"},
|
||||
{type: "ref", id: "software/settings/overview"},
|
||||
{type: "ref", id: "software/overview"},
|
||||
{type: "ref", id: "developers/overview"},
|
||||
{type: "ref", id: "about-documentation/overview"},
|
||||
{type: "ref", id: "legal/overview"},
|
||||
],
|
||||
},
|
||||
Contribute: {
|
||||
Developers: [
|
||||
|
|
@ -192,9 +223,7 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
Documentation: {
|
||||
"About Documentation": [
|
||||
"Maintaining Documentation": [
|
||||
"about-documentation/overview",
|
||||
{
|
||||
Dependencies: [
|
||||
|
|
@ -214,6 +243,13 @@ module.exports = {
|
|||
],
|
||||
},
|
||||
],
|
||||
"Additional Documentation": [
|
||||
{type: "ref", id: "getting-started/overview"},
|
||||
{type: "ref", id: "software/settings/overview"},
|
||||
{type: "ref", id: "hardware/overview"},
|
||||
{type: "ref", id: "software/overview"},
|
||||
{type: "ref", id: "legal/overview"},
|
||||
],
|
||||
},
|
||||
Legal: {
|
||||
Legal: [
|
||||
|
|
@ -222,5 +258,12 @@ module.exports = {
|
|||
"legal/trademark",
|
||||
"legal/privacy",
|
||||
],
|
||||
"Additional Documentation": [
|
||||
{type: "ref", id: "getting-started/overview"},
|
||||
{type: "ref", id: "software/settings/overview"},
|
||||
{type: "ref", id: "hardware/overview"},
|
||||
{type: "ref", id: "software/overview"},
|
||||
{type: "ref", id: "developers/overview"},
|
||||
],
|
||||
},
|
||||
};
|
||||
|
|
|
|||
Loading…
Reference in a new issue