meshtastic/docs/getting-started/index.mdx

217 lines
5.9 KiB
Plaintext
Raw Normal View History

---
title: Getting Started
sidebar_label: Getting Started
slug: /getting-started
2022-04-24 15:32:31 -07:00
sidebar_position: 2
---
2022-03-08 23:51:46 -08:00
2022-03-02 10:10:10 -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
2022-11-02 11:46:54 -07:00
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
2022-11-02 11:46:54 -07:00
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
2022-11-02 11:46:54 -07:00
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
2022-11-02 11:46:54 -07:00
If your device is not listed above, please review our [supported hardware](/docs/supported-hardware) devices to determine which MCU your device has or contact us in [Discord](https://discord.gg/ktMAKGBnBs) with any questions.
:::
## Setup Working Environment
2022-11-02 11:46:54 -07:00
:::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
2022-11-02 11:46:54 -07:00
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-for-driver-installation).
2022-11-02 11:46:54 -07:00
### Install serial drivers
2022-03-03 09:53:57 -08:00
<div className="indexCtasBody">
<Link target="_blank"
2022-03-03 09:53:57 -08:00
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/serial-drivers'}
>
Install Serial Drivers
2022-03-03 09:53:57 -08:00
</Link>
</div>
2022-03-02 10:10:10 -08:00
2022-11-02 11:46:54 -07:00
### 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)).
:::
2022-11-02 11:46:54 -07:00
## Flash Firmware
### ESP32
2022-03-03 14:29:52 -08:00
2022-03-03 09:53:57 -08:00
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/flashing-firmware/esp32/'}
>
Flash ESP32 Firmware
2022-03-03 09:53:57 -08:00
</Link>
</div>
2022-03-02 10:10:10 -08:00
### NRF52
2022-11-02 11:46:54 -07:00
For RAK4631 users, if you have a RAK4631-R (the RUI3 bootloader version of the RAK4631), you must [convert it to use the Arduino bootloader](/docs/getting-started/flashing-firmware/nrf52/#convert-rak4631-r-to-rak4631)
2022-03-03 09:53:57 -08:00
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/flashing-firmware/nrf52/'}
>
Flash NRF52 Firmware
2022-03-03 09:53:57 -08:00
</Link>
</div>
## Connect to Device
Depending on your device, there are 3 ways to connect to your device:
### Serial
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/connect-device/connect-serial'}
>
Connect using Serial
</Link>
</div>
### Bluetooth
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/connect-device/connect-ble'}
>
Connect using Bluetooth
</Link>
</div>
### Network
Connecting over network is only supported on ESP32 devices.
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/connect-device/connect-network'}
>
Connect over Network
</Link>
</div>
## Configure Device
The initial configuration of the device includes setting the regional settings...
<div className="indexCtasBody">
<Link target="_blank"
className={'button button--outline button--lg cta--button'}
to={'/docs/getting-started/initial-config'}
>
Configure Device
</Link>
</div>
## Use Meshtastic
### with Command Line Tools
- [Python CLI](/docs/software/python/cli)
### with mobile apps
2022-11-02 14:50:50 -07:00
- [Android](/docs/category/android-app)
- [Apple](/docs/category/apple-apps)
### with a browser
- https://client.meshtastic.org
2022-11-03 19:54:37 -07:00
- [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.