mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 15:44:18 -08:00
197 lines
5.5 KiB
Plaintext
197 lines
5.5 KiB
Plaintext
---
|
|
id: getting-started
|
|
title: Getting Started
|
|
sidebar_label: Getting Started
|
|
slug: /getting-started
|
|
sidebar_position: 2
|
|
---
|
|
|
|
import Link from '@docusaurus/Link';
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
## Identify Hardware
|
|
|
|
The first order of business in getting started is determining what type of hardware you will be working with. Meshtastic currently supports devices with either of the two Micro-Controller Units (MCU):
|
|
|
|
### ESP32
|
|
|
|
The ESP32 is older and consumes more power than the nrf52, but is equipped with both WiFi and Bluetooth. Supported ESP32 devices:
|
|
|
|
- LILYGO® TTGO T-Beam
|
|
- LILYGO® TTGO Lora
|
|
- Nano G1
|
|
- Station G1
|
|
|
|
### NRF52
|
|
|
|
The NRF52 is much more power efficient than the esp32 and easier to update, but is only equipped with Bluetooth. Supported NRF52 devices:
|
|
|
|
- RAK WisBlock
|
|
- LILYGO® TTGO T-Echo
|
|
|
|
:::info
|
|
If your device is not listed above, please review our [supported devices](/docs/supported-hardware) to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
|
|
:::
|
|
|
|
## Setup Working Environment
|
|
|
|
:::danger STOP! Put the power cable down!
|
|
Never power on the radio without attaching an antenna! _it could damage the radio chip._
|
|
:::
|
|
|
|
Prior to connecting your Meshtastic device to the computer, you should perform the following basic checks.
|
|
|
|
### Verify data cable
|
|
|
|
Some cables only provide _charging_, verify that your cable is also capable of _transferring data_ before proceeding.
|
|
|
|
There is no definitive way to determine the difference in cables if you aren't willing to pull it apart. Trying out a few cables will be the best way to verify.
|
|
|
|
Once you've located a working data cable, [install the correct serial driver](#install-serial-drivers) and [test for driver installation](#test-driver-installation).
|
|
|
|
### Install serial drivers
|
|
|
|
<div className="indexCtasBody">
|
|
<div class="split left">
|
|
<div class="centered">
|
|
<Link target="_blank"
|
|
className={'button button--outline button--lg cta--button'}
|
|
to={'/docs/getting-started/serial-drivers/esp32'}
|
|
>
|
|
Install ESP32 Drivers
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="split right">
|
|
<div class="centered">
|
|
<Link target="_blank"
|
|
className={'button button--outline button--lg cta--button'}
|
|
to={'/docs/getting-started/serial-drivers/nrf52'}
|
|
>
|
|
Install NRF52 Drivers
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
### Test driver installation
|
|
|
|
You can verify that you have a proper data cable (rather than a charge-only type cable) and that the appropriate drivers for your system are installed by performing the following test:
|
|
|
|
<Tabs
|
|
groupId="operating-system"
|
|
defaultValue="linux"
|
|
values={[
|
|
{label: 'Linux', value: 'linux'},
|
|
{label: 'macOS', value: 'macos'},
|
|
{label: 'Windows', value: 'windows'},
|
|
]}>
|
|
<TabItem value="linux">
|
|
|
|
1. Connect your Meshtastic device to your USB port
|
|
2. Open a **Terminal** and enter the following command:
|
|
|
|
```shell
|
|
lsusb
|
|
```
|
|
3. You should see something like:
|
|
|
|
```shell
|
|
ID xxxx:xxxx Silicon Labs CP210x UART Bridge
|
|
# or
|
|
ID xxxx:xxxx QinHeng Electronics USB Single Serial
|
|
# or
|
|
FIXME (WISBLOCK OUTPUT)
|
|
```
|
|
|
|
</TabItem>
|
|
<TabItem value="macos">
|
|
|
|
1. Navigate to `Apple Menu > About This Mac > System Report... > Hardware > USB`.
|
|
2. You should see similar to one of the following entries:
|
|
- `CP210X USB to UART Bridge Controller`
|
|
- `CH9102 USB to UART Bridge Controller`
|
|
- `WisCore RAK4631 Board`
|
|
|
|
</TabItem>
|
|
<TabItem value="windows">
|
|
|
|
1. Navigate to `Device Manager > Ports (COM & LPT)`
|
|
2. You should see similar to one of the following entries:
|
|
- `Silicon Labs CP210X USB to UART Bridge (COM5)`
|
|
- `Silicon Labs CH9102 USB to UART Bridge (COM5)`
|
|
- `FIXME (WISBLOCK OUTPUT)`
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
:::info
|
|
If you do not see your device:
|
|
|
|
1. You may be using a charging-only cable, [verify your cable](#verify-data-cable).
|
|
2. You may need to [install the USB serial driver](/docs/getting-started/serial-drivers)).
|
|
:::
|
|
|
|
## Flash Firmware
|
|
|
|
:::info
|
|
If you have a RAK4631-R (the RUI3 bootloader version of the RAK4631), you must [convert the bootloader](/docs/guides/convert-rak4631r) for use with the Arduino before flashing Meshtastic firmware.
|
|
:::
|
|
|
|
<div className="indexCtasBody">
|
|
<div class="split left">
|
|
<div class="centered">
|
|
<Link target="_blank"
|
|
className={'button button--outline button--lg cta--button'}
|
|
to={'/docs/getting-started/flashing-firmware/esp32/'}
|
|
>
|
|
Flash ESP32 Firmware
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="split right">
|
|
<div class="centered">
|
|
<Link target="_blank"
|
|
className={'button button--outline button--lg cta--button'}
|
|
to={'/docs/getting-started/flashing-firmware/nrf52/'}
|
|
>
|
|
Flash NRF52 Firmware
|
|
</Link>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
## Connect and Configure Device
|
|
|
|
After connecting to the device for the first time, you should set the regional settings for the radio as well as other optional settings such as the name of the device.
|
|
|
|
<div className="indexCtasBody">
|
|
<Link target="_blank"
|
|
className={'button button--outline button--lg cta--button'}
|
|
to={'/docs/getting-started/initial-config'}
|
|
>
|
|
Connect and Configure Device
|
|
</Link>
|
|
</div>
|
|
|
|
## Use Meshtastic
|
|
|
|
### with Command Line Tools
|
|
- [Python CLI](/docs/software/python/cli)
|
|
|
|
### with mobile apps
|
|
- [Android](/docs/category/android-app)
|
|
- [Apple](/docs/category/apple-apps)
|
|
|
|
### with a browser
|
|
- https://client.meshtastic.org
|
|
- [Meshtastic Web](/docs/software/web-client)
|
|
|
|
### over the internet with MQTT
|
|
- [MQTT](/docs/software/mqtt/)
|
|
|
|
There are many ways to interact with and use Meshtastic, please visit the [Software](/docs/software) page for more information. |