From 4b23a3a36e6686c99c276c5afda1f578e7f84033 Mon Sep 17 00:00:00 2001 From: Luke Prior <22492406+LukePrior@users.noreply.github.com> Date: Thu, 27 May 2021 15:37:23 +1000 Subject: [PATCH] Update readme with installation instructions --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 35de853..c6a17fa 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,28 @@ Adding support for LMS6 (see issue #48) and ims100 (see branch ims100) could be but currently I don't have plans to do add this myself. Well-tested pull requests will of course be considered for inclusion :-). +## Installation + +You can download the latest binary automated build for the development and testing branches [here](http://rdzsonde.mooo.com/download.html), the binary includes everything including configuration files so any existing settings will be reset. + +To update an existing installatiom to the latest development or master version you can use the [OTA](https://github.com/dl9rdz/rdz_ttgo_sonde/wiki/Other-features#over-the-air-updates) update feature. + +The downloaded .bin file can be flashed to your ESP32 board using [esptool](https://github.com/espressif/esptool) or [ESP32 Download Tool](https://www.espressif.com/en/support/download/other-tools) + +### esptool + +You can run the following command replacing `` with the path to the downloaded .bin file. + +If you encounter errors with the device COM not automatically being detected replace `/dev/cu.SLAB_USBtoUART` with `COM`. + +``` +esptool --chip esp32 --port /dev/cu.SLAB_USBtoUART --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m --flash_size detect 0x1000 +``` + +### ESP32 Download Tool + +The binary file can also be installed using the GUI application with the [following](http://rdzsonde.mooo.com/) settings. + ## Button commands You can use the button on the board (not the reset button, the second one) to