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

Merge branch 'master' into clean-getting-started

Browse source
This commit is contained in:
Foster Irwin 2022-03-03 15:26:43 -07:00 committed by GitHub
parent 04682c9ffe b3afc9a95a
commit 80c994dc6b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 188 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
docs/getting-started/getting_started.md
View file

@ -14,11 +14,13 @@ The radios automatically create a mesh to forward packets as needed, so everyone
Meshtastic uses LoRa for the long range communications and depending on settings used, the maximum theoretical group size ranges from 30-200 device nodes. Currently, each device can only support a connection from a single user at a time.
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/about'}>
Learn More
</Link>
<div className="indexCtasBody">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/about'}>
Learn More
</Link>
</div>
## Hardware
@ -28,11 +30,13 @@ Meshtastic uses LoRa for the long range communications and depending on settings
The easiest way is to [buy a device with the software already installed](https://www.aliexpress.com/item/4001178678568.html). Other devices are [available](/docs/hardware/supported/tbeam). In the Americas get the 915MHz version, in Europe the 868MHz, or Asia 923MHz. See this listing by [The Things Network](https://www.thethingsnetwork.org/docs/lorawan/frequencies-by-country.html) for frequencies by specific countries.
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/hardware'}>
Purchase Hardware
</Link>
<div className="indexCtasBody">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/hardware'}>
Purchase Hardware
</Link>
</div>
#### Purchase battery
@ -62,11 +66,13 @@ If your device already has Meshtastic flashed to it, you can update it over the
The manual firmware installation method will also depend on whether you have an ESP32 based device or a nRF52 based device. See our [hardware section](/docs/hardware) to determine which microcontroller your device is based on.
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/flashing-firmware'}>
Flash Firmware
</Link>
<div className="indexCtasBody">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/flashing-firmware'}>
Flash Firmware
</Link>
</div>
## Connect to your Device
@ -78,6 +84,15 @@ There are many ways to connect to your new radio!
- Bluetooth
- Web app over Wifi (in development)
<div className="indexCtasBody">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/clients'}>
Connect to Node
</Link>
</div>
### A good first test (connect via USB and CLI)
If you have at least two radios with the Meshtastic firmware, you may consider connecting one via USB and the other battery powered. Communicate with the USB radio using a CLI like [Meshtastic-python](https://meshtastic.org/docs/software/python/python-installation).

4
docs/settings/channel.md
View file

@ -17,7 +17,7 @@ Channel settings are an integral part of the way your devices communicate across
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| id | `integer` | `0` |
| modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | `Bw125Cr45Sf128` |
| modem_config | `Bw125Cr45Sf128`, `Bw500Cr45Sf128`, `Bw31_25Cr48Sf512`, `Bw125Cr48Sf4096` | `Bw125Cr48Sf4096` |
| name | `string` | `""` |
| psk | `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `none`, `default`, `random` | `1` |
| region | `Unset`, `US`, `EU433`, `EU865`, `CN`, `JP`, `ANZ`, `KR`, `TW`, `RU` | `Unset` |
@ -252,7 +252,7 @@ The `region` variable sets which region your radio is configured to work in. It
| :--: | :-------: | :-----: | :----------------: | :---------: |
| US | 903.08 | 2.16 | 13 | 0 |
| EU433 | 433.175 | 0.2 | 8 | 0 |
| EU865 | 865.2 | 0.3 | 10 | 0 |
| EU868 | 865.2 | 0.3 | 10 | 0 |
| CN | 470.0 | 2.0 | 20 | 0 |
| JP | 920.0 | 0.5 | 10 | 13 |
| ANZ | 916.0 | 0.5 | 20 | 0 |

2
protobufs

@ -1 +1 @@
Subproject commit 7c49bdad99f53332d17796188fc89fd5c29e0ce3
Subproject commit f6ba3722be8a51c3c0c1446bb08e730a0be568e0

36
src/css/custom.css
View file

@ -55,3 +55,39 @@ html[data-theme="dark"] .header-github-link:before {
--ifm-button-border-color: var(--ifm-link-color);
color: var(--ifm-link-color);
}
.indexCtasBody {
--ifm-button-size-multiplier: 1.6;
display: flex;
flex-wrap: wrap;
align-items: center;
justify-content: center;
margin-top: 24px;
}
.indexCtasBody a:last-of-type {
margin: 20px 36px;
}
.indexCtas {
--ifm-button-size-multiplier: 1.6;
display: flex;
flex-wrap: wrap;
align-items: center;
justify-content: center;
margin-top: 24px;
}
.indexCtas a {
color: var(--ifm-font-color-base-inverse);
--ifm-button-border-color: var(--ifm-font-color-base-inverse);
}
.indexCtas a:hover {
color: rgb(77, 77, 77);
--ifm-button-border-color: rgb(77, 77, 77);
}
.indexCtas a:last-of-type {
margin: 20px 36px;
}

119
src/pages/index.tsx
View file

@ -4,6 +4,8 @@ import Head from '@docusaurus/Head';
import useBaseUrl from '@docusaurus/useBaseUrl';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import Layout from '@theme/Layout';
import Link from '@docusaurus/Link';
import { HeaderText } from './downloads/_components/HeaderText';
const features = [
{
@ -120,6 +122,14 @@ function Home() {
/>
</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className="indexCtas">
<Link className="button button--lg" to="/docs/about">
Learn More
</Link>
<Link className="button button--lg" to="/docs/getting-started">
Get Started
</Link>
</div>
</div>
</header>
<main>
@ -136,6 +146,115 @@ function Home() {
</div>
</section>
)}
<div className="container">
<HeaderText
type="h1"
text="Getting Started"
link="getting-started"
/>
<p>
Getting started with Meshtastic is as easy as 1, 2, 3!
</p>
<ul
style={{
position: "relative",
display: "grid",
gap: "1.5rem",
gridTemplateColumns: "repeat(auto-fill, minmax(280px, 1fr))",
paddingLeft: "0",
}}
>
<div className="card">
<div
className="card__header"
style={{ display: "flex", justifyContent: "space-between" }}
>
<h3>
1. Purchase Supported Hardware
</h3>
</div>
<div
className="card__body"
style={{ display: "flex", justifyContent: "center"}}
>
<p>
Hardware you will want to consider:
<ul>
<li>
Radio
</li>
<li>
Battery
</li>
<li>
Case
</li>
<li>
Antenna (most devices include an antenna, but the quality can be a bit of a mixed bag from some suppliers on stock antennas)
</li>
</ul>
</p>
</div>
</div>
<div className="card">
<div
className="card__header"
style={{ display: "flex", justifyContent: "space-between" }}
>
<h3>
2. Flash & Configure Node
</h3>
</div>
<div
className="card__body"
style={{ display: "flex", justifyContent: "center"}}
>
<p>
The Meshtastic Flasher application can assist you in flashing the firmware and configuring settings.
</p>
</div>
</div>
<div className="card">
<div
className="card__header"
style={{ display: "flex", justifyContent: "space-between" }}
>
<h3>
3. Connect to Node
</h3>
</div>
<div
className="card__body"
style={{ display: "flex", justifyContent: "center"}}
>
<p>
Applications are available for the following systems:
<ul>
<li>
Android
</li>
<li>
iOS
</li>
<li>
Mac
</li>
<li>
Web Browser
</li>
</ul>
</p>
</div>
</div>
</ul>
<div className="indexCtasBody">
<Link
className="button button--outline button--lg cta--button" to="/docs/getting-started"
>
Getting Started
</Link>
</div>
</div>
</main>
</Layout>
);