meshtastic/docs/getting-started/initial-config.mdx

137 lines
3.6 KiB
Plaintext
Raw Normal View History

2022-11-07 20:53:52 -08:00
---
id: initial-config
title: Initial Configuration
sidebar_label: Initial Configuration
slug: /getting-started/initial-config
sidebar_position: 4
description: Getting started with the initial configuration of your Meshtastic device including serial, bluetooth, LoRa, and more.
2022-11-07 20:53:52 -08:00
---
2023-01-19 05:01:57 -08:00
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import LoRaRegions from "../blocks/_lora-regions.mdx";
2023-01-21 09:32:24 -08:00
import Link from "@docusaurus/Link";
2022-11-07 20:53:52 -08:00
2022-11-09 10:21:08 -08:00
## Supported Clients per Connection Type
2022-11-07 20:53:52 -08:00
2022-11-09 10:21:08 -08:00
Depending on your connection, some configuration options are not fully supported. Find out which client is best for your type of connection.
2022-11-07 20:53:52 -08:00
<Tabs
groupId="settings"
2023-01-21 09:32:24 -08:00
defaultValue="ble"
2022-11-07 20:53:52 -08:00
values={[
{label: 'Serial', value: 'serial'},
{label: 'Bluetooth', value: 'ble'},
{label: 'Network', value: 'network'},
]}>
<TabItem value="serial">
2024-02-22 13:09:26 -08:00
#### Serial
2022-11-07 20:53:52 -08:00
- [Python CLI](/docs/software/python/cli/)
- [Web Client](https://client.meshtastic.org)
- [Android App](/docs/category/android-app)
</TabItem>
<TabItem value="ble">
2024-02-22 13:09:26 -08:00
#### Bluetooth
2022-11-07 20:53:52 -08:00
- [Android App](/docs/category/android-app)
- [Web Client](https://client.meshtastic.org)
</TabItem>
<TabItem value="network">
2024-02-22 13:09:26 -08:00
#### Network
2022-11-09 10:21:08 -08:00
:::info
Connecting over network is only supported on ESP32 devices.
:::
2022-11-07 20:53:52 -08:00
- [Web Client](https://client.meshtastic.org)
- [Android App](/docs/category/android-app)
- [iOS App](/docs/category/apple-apps)
- [Python CLI](/docs/software/python/cli/)
</TabItem>
</Tabs>
## Set Regional Settings
2022-11-09 10:21:08 -08:00
In order to start communicating over the mesh, you must set your region. This setting controls which frequency range your device uses and should be set according to your regional location.
2022-11-07 20:53:52 -08:00
<Tabs
groupId="settings"
defaultValue="apple"
values={[
{label: 'Android', value: 'android'},
{label: 'Apple', value: 'apple'},
{label: 'CLI', value: 'cli'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="android">
2024-02-22 13:09:26 -08:00
#### Android
2022-11-07 20:53:52 -08:00
1. Follow the [installation](/docs/software/android/installation) and [usage](/docs/software/python/cli/usage) instructions for [Meshtastic Android](/docs/category/android-app).
2. Open the app, connect to the device from your phone over USB Serial or Bluetooth.
3. Once paired, Click "UNSET" next to the device name.
4. Select the region from the list according to your regional location.
</TabItem>
<TabItem value="apple">
2024-02-22 13:09:26 -08:00
#### Apple
2022-11-07 20:53:52 -08:00
:::info
Configuration of Region, Modem Preset and Hop Limit is available on iOS, iPadOS and macOS at Settings > Radio Configuration > LoRa.
:::
</TabItem>
<TabItem value="cli">
2024-02-22 13:09:26 -08:00
#### CLI
2022-11-07 20:53:52 -08:00
1. Install [Meshtastic PythonCLI](/docs/software/python/cli/installation)
2023-01-19 05:01:57 -08:00
```sh
pip3 install --upgrade pytap2
pip3 install --upgrade meshtastic
```
2022-11-07 20:53:52 -08:00
2. Run the following command, replacing `<REGION-CODE>` with the region code listed above according to your regional location.
2023-01-19 05:01:57 -08:00
```sh
meshtastic --set lora.region <REGION-CODE>
```
2022-11-07 20:53:52 -08:00
</TabItem>
<TabItem value="web">
2024-02-22 13:09:26 -08:00
#### Web
2022-11-07 20:53:52 -08:00
1. Open the Meshtastic Web interface: [client.meshtastic.org](https://client.meshtastic.org)
2. Navigate to the **LoRa** menu.
3. Under **Regional Settings**, set your **Region** according to your regional location.
4. Click **Save**.
</TabItem>
</Tabs>
### Region Codes
<LoRaRegions />
2023-01-21 09:32:24 -08:00
2024-05-06 11:55:24 -07:00
Refer to [LoRa Region by Country](/docs/configuration/region-by-country) for a more comprehensive list.
2023-01-21 09:32:24 -08:00
## Continue Configuration
Now that you have set the LoRa region on your device, you can continue with configuring any additional configs to suit your needs.
<div className="indexCtasBody">
<Link
className={"button button--outline button--lg cta--button"}
2023-09-28 19:10:42 -07:00
to={"/docs/configuration/"}
2023-01-21 09:32:24 -08:00
>
Device Configuration
</Link>
</div>