From 48da95254c5b8d8fe1aa535378634ee2b31987e5 Mon Sep 17 00:00:00 2001 From: PlumRugOfDoom Date: Tue, 23 Nov 2021 20:36:32 +0100 Subject: [PATCH] flashing device and python installation update --- .../docs/getting-started/flashing-esp32.md | 11 ++--- website/docs/software/python/installation.md | 44 +++++++++++++++---- 2 files changed, 42 insertions(+), 13 deletions(-) diff --git a/website/docs/getting-started/flashing-esp32.md b/website/docs/getting-started/flashing-esp32.md index 59705fef..918beab3 100644 --- a/website/docs/getting-started/flashing-esp32.md +++ b/website/docs/getting-started/flashing-esp32.md @@ -27,25 +27,26 @@ Some newer boards may require the drivers for the [CH9102](http://www.wch.cn/dow ]}> - > Open a `Terminal` and enter the following command: + > Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command: > ```bash > lsusb > ``` - + > You should see something like: `ID 10c4:ea60 Silicon Labs CP210x UART Bridge` for CP210X or `ID 1a86:55d4 QinHeng Electronics USB Single Serial` for CH9102 + > Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. + > You should see something like `CP210X USB to UART Bridge Controller`. If not download the appropriate drivers - > Navigate to `Device Manager > Ports (COM & LPT)`. + > Navigate to `Device Manager > Ports (COM & LPT)`. You should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`. If not download the appropriate drivers -You should see something like `CP210X USB to UART Bridge Controller`. If you don't, you will need to install the appropriate driver from [Silicon Labs](https://silabs.com/developers/usb-to-uart-bridge-vcp-drivers). ### Download Latest Firmware @@ -83,7 +84,7 @@ The [T-Beam 0.7](../hardware/tbeam-hardware#t-beam---v07) board is an earlier ve > If `python3` is not installed, install with > ```bash > sudo apt-get update - > sudo apt-get install python3.6 + > sudo apt-get install python3 > ``` > If `pip` is not installed, install with > ```bash diff --git a/website/docs/software/python/installation.md b/website/docs/software/python/installation.md index 603459e1..766042d6 100644 --- a/website/docs/software/python/installation.md +++ b/website/docs/software/python/installation.md @@ -19,6 +19,11 @@ You must use pip version 20 or later. To upgrade to the latest pip, do: `pip ins :::info Make sure that the `PATH variable` also gets installed by checking the box while installing python. If you don't, python may not be available and you may not be able to call `meshtastic` from your CLI. If you do forget to check that box, you will need to install the path environment variable for python on your operating system. ::: +:::important +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 drivers for the [CH9102](http://www.wch.cn/downloads/CH343SER_ZIP.html) or [Direct Download](https://github.com/Xinyuan-LilyGO/CH9102_Driver) for Windows 7. +::: = 3.4 * Check that pip is installed using this command ```bash pip3 -V ``` - * If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/) + * If this does not return a version, install pip + ```bash + sudo apt-get install python3-pip + ``` + +* Optional: use a python virtual environment (otherwise jump to step "Install pytap2") + * Install python-virtualenvwrapper (arch based distros as an example) + ```bash + sudo pacman -Syu python-virtualenvwrapper + ``` + * Create a virtual environment + ```bash + source /usr/bin/virtualenvwrapper.sh + mkvirtualenv meshtastic + workon meshtastic + ``` * Install pytap2 ```bash - sudo pip3 install --upgrade pytap2 + pip3 install --upgrade pytap2 ``` * Install meshtastic: ```bash - sudo pip3 install --upgrade meshtastic + pip3 install --upgrade meshtastic ``` @@ -90,6 +117,7 @@ Make sure that the `PATH variable` also gets installed by checking the box while pip3 -V ``` * If this does not return a version, install [pip](https://pip.pypa.io/en/stable/installing/) + * Install pytap2 ```bash sudo pip3 install --upgrade pytap2 @@ -130,7 +158,7 @@ Make sure that the `PATH variable` also gets installed by checking the box while ```powershell pip3 install --upgrade meshtastic ``` - + @@ -164,4 +192,4 @@ Be aware that the Meshtastic CLI is not able to control the nodes over USB throu :::info You may need to close and re-open the CLI. The path variables may or may not update for the current session when installing. -::: \ No newline at end of file +:::