meshtastic/docs/getting-started/flashing-firmware.md
2022-03-03 19:36:40 -07:00

6.1 KiB

id title sidebar_label
flashing-firmware Firmware Flashing Prerequisites Prerequisites

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Overview

Before you flash your device it is prudent to verify that we have proper connectivity with the device being flashed. Outlined below are steps that can be taken to verify connectivity and, if necessary, to install the appropriate drivers. If you end up needing to install drivers be sure to reboot your computer afterwards to verify the installation is complete.

Prerequisites

Verify data cable

Verify you have a data cable (not a charging only cable) before proceeding. There's 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 data cable, check the following to see if you need to install a driver to communicate with your device.

:::tip If you know you have installed the correct driver, the following step can be used to check if your cable is a data cable. :::

Test for 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. Select your operating system below.

If you can see your device, you are ready to flash the firmware. Skip to theChoose Firmware Flashing Method section.

If you don't see your device in the following test, you either:

  1. Need to install a driver.
  2. Are currently using a charging only cable.

<Tabs groupId="operating-system" defaultValue="linux" values={[ {label: 'Linux', value: 'linux'}, {label: 'macOS', value: 'macos'}, {label: 'Windows', value: 'windows'}, ]}> Connect your Meshtastic device to your USB port, open a Terminal and enter the following command:

lsusb

You should see something like: ID xxxx:xxxx Silicon Labs CP210x UART Bridge, ID xxxx:xxxx QinHeng Electronics USB Single Serial, or FIXME (WISBLOCK OUTPUT).

Navigate to Apple Menu  > About This Mac > System Report... > Hardware > USB. You should see something like CP210X USB to UART Bridge Controller, CH9102 USB to UART Bridge Controller, or WisCore RAK4631 Board. If not download the appropriate drivers below.

Navigate to Device Manager > Ports (COM & LPT). You should see something like Silicon Labs CP210X USB to UART Bridge (COM5), Silicon Labs CH9102 USB to UART Bridge (COM5), or FIXME (WISBLOCK OUTPUT). If not download the appropriate drivers below.

Install Appropriate Drivers

ESP32 Drivers

You may need to install a driver from Silicon Labs for the CP210X USB to UART bridge

Some newer boards may require the CH9102 (CH340/CH341) Driver.

<Tabs groupId="operating-system" defaultValue="linux" values={[ {label: 'Linux', value: 'linux'}, {label: 'macOS', value: 'macos'}, {label: 'Windows', value: 'windows'}, ]}>

CP210X USB to UART bridge - Download

CH9102 Driver - Linux Download

CP210X USB to UART bridge - Download

CH9102 Driver - MacOS Download

CP210X USB to UART bridge - Download

CH9102 Driver - Windows Download

CH9102 Driver - Windows Download (Direct Download for Windows 7)

:::important Reboot your computer after you have installed the driver to complete the installation. :::

NRF52 Drivers

<Tabs groupId="operating-system" defaultValue="linux" values={[ {label: 'Linux', value: 'linux'}, {label: 'macOS', value: 'macos'}, {label: 'Windows', value: 'windows'}, ]}>

CH9102 Driver - Linux Download

CH9102 Driver - MacOS Download

:::caution With the latest versions of MacOS, the USB Serial driver is built-in. Do NOT download the USB device drivers unless required. If you downloaded/installed any already, please remove them:

Removing the CH34x (CH340/CH341) USB Drivers
If you have already downloaded/installed the MacOS WCH-IC CH340 ("CH341SER_MAC") drivers via the CH34x_Install_V1.5.pkg, you will have to Uninstall the kernel extension:

1. Unplug your T-Echo
2. Open the Terminal and run:
3. sudo -rf /Library/Extensions/usbserial.kext
4. Reboot

:::

CH9102 Driver - Windows Download

:::important Reboot your computer after you have installed the driver to complete the installation. :::

Choose Firmware Flashing Method

For most users we recommend using the Meshtastic Flasher application. It does a lot under the hood to prevent you from needing to use the terminal. It also allows you to set device settings and configure your device.

If you choose to flash the firmware using the manual method, ESP32 based devices and NRF52 based devices have different methods. Select the appropriate one. If you don't know what chipset your device is, take a look at our supported hardware section.