meshtastic/docs/getting-started/index.mdx

137 lines
4.5 KiB
Plaintext
Raw Normal View History

---
2022-11-07 20:53:52 -08:00
id: getting-started
title: Getting Started
sidebar_label: Getting Started
slug: /getting-started
2022-04-24 15:32:31 -07:00
sidebar_position: 2
description: The official Meshtastic guide to get you started. Covers all devices and configurations.
---
2022-03-08 23:51:46 -08:00
2023-01-19 05:01:57 -08:00
import Link from "@docusaurus/Link";
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
2022-11-02 11:46:54 -07:00
## Identify Hardware
2023-01-21 09:32:24 -08:00
:::note
2023-11-30 22:40:50 -08:00
This guide assumes that you have already purchased the devices you will be using with Meshtastic. If you haven't, you can check out our list of [supported hardware](/docs/hardware/devices/index.mdx)
2023-01-21 09:32:24 -08:00
to see your options.
:::
2023-07-30 22:49:34 -07:00
Before you begin, it's important to determine which kind of hardware you're using. Meshtastic works with devices that have these types of Micro-Controller Units (MCU):
### ESP32
2023-07-29 13:56:08 -07:00
The ESP32 chip is older and consumes more power than the nRF52 chip, but is equipped with both WiFi and Bluetooth. Supported ESP32 devices include:
- LILYGO® TTGO T-Beam (>V1.1 recommended)
- LILYGO® TTGO Lora (>V2.1 recommended)
- Nano G1
- Station G1
2023-01-21 09:32:24 -08:00
- Heltec V3 and Wireless Stick Lite V3
2023-07-29 14:48:18 -07:00
- RAK11200 Core module for RAK WisBlock modular boards
2023-01-21 09:32:24 -08:00
### nRF52
2023-07-29 13:56:08 -07:00
The nRF52 chip is much more power efficient than the ESP32 chip and easier to update, but is only equipped with Bluetooth. Supported nRF52 devices include:
2023-07-29 14:48:18 -07:00
- RAK4631 Core module for RAK WisBlock modular boards
- LILYGO® TTGO T-Echo
2023-07-29 13:56:08 -07:00
### RP2040
The RP2040 is a dual-core ARM chip developed by Raspberry Pi. Supported RP2040 devices include:
2023-12-19 10:36:49 -08:00
- Raspberry Pi Pico + Waveshare LoRa Module (Note: **Bluetooth on the Pico W is not yet supported by Meshtastic**)
2023-07-29 15:11:32 -07:00
- RAK11310 Core module for RAK WisBlock modular boards
2023-07-29 13:56:08 -07:00
:::info
2023-01-21 09:32:24 -08:00
2023-11-30 22:40:50 -08:00
If your device is not listed above, please review our [supported devices](/docs/hardware/devices/index.mdx) to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
2023-01-21 09:32:24 -08:00
:::
2023-01-21 09:32:24 -08:00
:::danger STOP! Put The Power Cable Down!
2024-11-01 08:21:09 -07:00
Never power on the radio without attaching an antenna! Doing so could damage the radio chip.
2023-01-21 09:32:24 -08:00
:::
Prior to connecting your Meshtastic device to the computer, you should perform the following basic checks.
2023-01-21 09:32:24 -08:00
### Verify Data Cable
2023-01-21 09:32:24 -08:00
Some cables only provide _charging_, verify that your cable is also capable of _transferring data_ before proceeding. To check if your cable can also transfer data, try connecting it to another device (like a phone) and see if you can copy a file to or from it. If the file transfer works, then your cable is also able to transfer data and you can continue.
2023-01-21 09:32:24 -08:00
### Install Serial Drivers
2023-06-27 21:04:08 -07:00
:::caution
2023-12-19 10:36:49 -08:00
nRF52/RP2040 devices typically do not require serial drivers. They use the UF2 bootloader which makes the devices appear as flash drives. Do _NOT_ download the USB device drivers unless required to install UF2 support.
2023-06-27 21:04:08 -07:00
:::
If you require serial drivers installed on your computer, please choose one of the options below and install it before continuing.
2022-03-03 09:53:57 -08:00
<div className="indexCtasBody">
2023-01-21 09:32:24 -08:00
<div className="split-container">
<div className="split-item">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/serial-drivers/esp32'}
>
Install ESP32 Drivers
</Link>
</div>
<div className="split-item">
<Link
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/serial-drivers/nrf52'}
>
2023-12-19 10:36:49 -08:00
Install nRF52/RP2040 Drivers
2023-01-21 09:32:24 -08:00
</Link>
</div>
2022-11-07 20:53:52 -08:00
</div>
2022-03-03 09:53:57 -08:00
</div>
2022-03-02 10:10:10 -08:00
2023-01-21 09:32:24 -08:00
### Flash Firmware
2023-01-19 05:01:57 -08:00
2023-01-21 09:32:24 -08:00
After completing the previous steps, you can now flash the Meshtastic firmware onto your device. To proceed, select the appropriate device type for your device.
2022-03-03 14:29:52 -08:00
2022-03-03 09:53:57 -08:00
<div className="indexCtasBody">
2023-01-21 09:32:24 -08:00
<div className="split-container">
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/esp32/"}
>
Flash ESP32 Firmware
</Link>
</div>
<div className="split-item">
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/flashing-firmware/nrf52/"}
>
2023-12-19 10:36:49 -08:00
Flash nRF52/RP2040 Firmware
2023-01-21 09:32:24 -08:00
</Link>
</div>
2022-11-07 20:53:52 -08:00
</div>
2022-03-03 09:53:57 -08:00
</div>
2022-03-02 10:10:10 -08:00
### Connect and Configure Device
2023-01-21 09:32:24 -08:00
After flashing the Meshtastic firmware onto your device, you can now move on to initial configuration.
<div className="indexCtasBody">
2023-01-19 05:01:57 -08:00
<Link
className={"button button--outline button--lg cta--button"}
to={"/docs/getting-started/initial-config"}
>
2022-11-07 20:53:52 -08:00
Connect and Configure Device
</Link>
</div>