mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-09-21 00:27:35 -07:00
Merge pull request #410 from meshtastic/flasher_fix
Clean up Flashing instructions, make USB serial adaptor page.
This commit is contained in:
Garth Vander Houwen
GitHub
commit
5d142605f2
|
|
@ -10,6 +10,6 @@ Meshtastic 1.2 was a beta version that has been superceded by 1.3. Version 1.2 i
|
|||
While 1.2 is end of life, it may continue to be useful for certain networks with Android only users, or users of ATAK until the forwarder is updated.
|
||||
|
||||
* Last 1.2 Python api version install: pip install meshtastic==1.2.95
|
||||
* Final 1.2 Meshtastic Flasher instal: pip install meshtastic-flasher==1.0.106 (Do not attempt to install 1.3.x firmware with this release)
|
||||
* Final 1.2 Meshtastic Flasher install: pip install meshtastic-flasher==1.0.106 (Do not attempt to install 1.3.x firmware with this release)
|
||||
* [Final 1.2 Device Firmware](https://github.com/meshtastic/Meshtastic-device/releases/tag/v1.2.65.0adc5ce)
|
||||
* [Final 1.2 Android App](https://github.com/meshtastic/Meshtastic-Android/releases/tag/1.2.67)
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ Meshtastic is the most awesome long range, low power communications service on t
|
|||
|
||||
### Where can I get additional help, ask questions, or bond with the Meshtastic community?
|
||||
|
||||
After reading this FAQ and checking out the links on the left, there are two places... The preferred place is to check out the [Forum](https://meshtastic.discourse.group). There you can be part of our growing community and search for previous posts that may be similar to what you're looking for. We also have the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) server where you may connect with like-minded people.
|
||||
This site (which has a great search function) is the preferred place for up to date documentation. Many of our users and developers hang out on the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) server where you may connect with like-minded people.
|
||||
|
||||
### How can I contribute to Meshtastic?
|
||||
|
||||
Everyone contributes in a different way. Join the [Forum](https://meshtastic.discourse.group) and/or the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](/docs/developers) menu on the left.
|
||||
Everyone contributes in a different way. Join the [Meshtastic Discord](https://discord.gg/ktMAKGBnBs) and introduce yourself. We're all very friendly. If you'd like to pitch in some code, check out the [Developers](/docs/developers) menu on the left.
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: Drag & Drop NRF52 Firmware Updates
|
|||
sidebar_label: Drag & Drop - NRF52
|
||||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
pagination_next: getting-started/flashing-firmware/flashing-esp32
|
||||
sidebar_position: 2
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
|
|
@ -13,164 +13,14 @@ import TabItem from '@theme/TabItem';
|
|||
Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip!
|
||||
:::
|
||||
|
||||
## Meshtastic Flasher GUI Application
|
||||
## Easiest Firmware install options
|
||||
|
||||
For most users we recommend using the [Meshtastic Flasher application](/docs/getting-started/flashing-firmware/meshtastic-flasher). It does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
If you have RAK NRF based devices or a LilyGO T-Echo, [the drag and drop firmware installation process](/docs/getting-started/flashing-firmware/flashing-esp32) is the easiest solution.
|
||||
|
||||
For ESP32 based device users (TBEAM, TLORA, Heltec etc.) we recommend using the [Meshtastic Flasher application](/docs/getting-started/flashing-firmware/meshtastic-flasher). It does a lot under the hood to prevent you from needing to use the terminal. It also allows you to configure your device.
|
||||
|
||||
## Manual Firmware Installation
|
||||
|
||||
Firmware can be downloaded from the [Downloads](/downloads) page. Your initial installation has to happen over USB from your Mac, Windows, or Linux computer.
|
||||
|
||||
If you choose to flash the firmware using the manual method, [ESP32 based devices](/docs/getting-started/flashing-firmware/flashing-esp32) and [NRF52 based devices](/docs/getting-started/flashing-firmware/flashing-nrf52) 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.
|
||||
|
||||
## 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.
|
||||
:::
|
||||
|
||||
## Install USB to Serial Drivers
|
||||
|
||||
### ESP32 Drivers
|
||||
|
||||
You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - Windows Download](http://www.wch.cn/downloads/CH343SER_ZIP.html)
|
||||
|
||||
[CH9102 Driver - Windows Download (Direct Download for Windows 7)](https://github.com/Xinyuan-LilyGO/CH9102_Driver)
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
[CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
[CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
:::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:
|
||||
|
||||
<details>
|
||||
<summary>Removing the CH34x (CH340/CH341) USB Drivers</summary>
|
||||
<div>
|
||||
<div>
|
||||
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:
|
||||
<br />
|
||||
<br />
|
||||
1. Unplug your device
|
||||
<br />
|
||||
2. Open the Terminal and run:
|
||||
<br />
|
||||
3. sudo rm -rf /Library/Extensions/usbserial.kext
|
||||
<br />
|
||||
4. Reboot
|
||||
</div>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
[CH9102 Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html)
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
:::
|
||||
|
||||
### 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 the [Choose Firmware Flashing Method section](#choose-firmware-flashing-method).
|
||||
|
||||
If you don't see your device in the following test, you either:
|
||||
|
||||
1. Need to [install a driver](#install-appropriate-drivers).
|
||||
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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command:
|
||||
|
||||
```shell
|
||||
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)`.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
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.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
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.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ sidebar_label: Meshtastic Flasher
|
|||
pagination_prev: getting-started/flashing-firmware/flashing-firmware
|
||||
pagination_next: getting-started/flashing-firmware/flashing-nrf52
|
||||
|
||||
sidebar_position: 1
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
|
|
|
|||
158
docs/getting-started/flashing-firmware/usb-serial-drivers.mdx
Normal file
158
docs/getting-started/flashing-firmware/usb-serial-drivers.mdx
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
---
|
||||
id: usb-serial-drivers
|
||||
title: Installing USB to Serial Drivers
|
||||
sidebar_label: USB to Serial Drivers
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
## Install USB to Serial Drivers
|
||||
|
||||
### ESP32 Drivers
|
||||
|
||||
You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
[CP210X USB to UART bridge - Download](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)
|
||||
|
||||
[CH9102 Driver - Windows Download](http://www.wch.cn/downloads/CH343SER_ZIP.html)
|
||||
|
||||
[CH9102 Driver - Windows Download (Direct Download for Windows 7)](https://github.com/Xinyuan-LilyGO/CH9102_Driver)
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
|
||||
[CH9102 Driver - Linux Download](http://www.wch-ic.com/downloads/CH341SER_LINUX_ZIP.html)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
[CH9102 Driver - MacOS Download](https://github.com/WCHSoftGroup/ch34xser_macos)
|
||||
|
||||
:::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:
|
||||
|
||||
<details>
|
||||
<summary>Removing the CH34x (CH340/CH341) USB Drivers</summary>
|
||||
<div>
|
||||
<div>
|
||||
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:
|
||||
<br />
|
||||
<br />
|
||||
1. Unplug your device
|
||||
<br />
|
||||
2. Open the Terminal and run:
|
||||
<br />
|
||||
3. sudo rm -rf /Library/Extensions/usbserial.kext
|
||||
<br />
|
||||
4. Reboot
|
||||
</div>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
[CH9102 Driver - Windows Download](http://www.wch-ic.com/downloads/CH341SER_EXE.html)
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::important
|
||||
Reboot your computer after you have installed the driver to complete the installation.
|
||||
:::
|
||||
|
||||
### 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 the [Choose Firmware Flashing Method section](#choose-firmware-flashing-method).
|
||||
|
||||
If you don't see your device in the following test, you either:
|
||||
|
||||
1. Need to [install a driver](#install-appropriate-drivers).
|
||||
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'},
|
||||
]}>
|
||||
<TabItem value="linux">
|
||||
Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command:
|
||||
|
||||
```shell
|
||||
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)`.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="macos">
|
||||
|
||||
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.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="windows">
|
||||
|
||||
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.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## 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.
|
||||
:::
|
||||
Loading…
Reference in a new issue