diff --git a/src_docs/source/images/esp32.jpg b/src_docs/source/images/esp32.jpg index 3d77413..0ea5b62 100644 Binary files a/src_docs/source/images/esp32.jpg and b/src_docs/source/images/esp32.jpg differ diff --git a/src_docs/source/images/esp32_hardware.jpg b/src_docs/source/images/esp32_hardware.jpg index e839c25..56d50eb 100644 Binary files a/src_docs/source/images/esp32_hardware.jpg and b/src_docs/source/images/esp32_hardware.jpg differ diff --git a/src_docs/source/images/esp32_mini.jpg b/src_docs/source/images/esp32_mini.jpg index f511621..c8564e0 100644 Binary files a/src_docs/source/images/esp32_mini.jpg and b/src_docs/source/images/esp32_mini.jpg differ diff --git a/src_docs/source/images/esp32_res.jpg b/src_docs/source/images/esp32_res.jpg index 228c97a..95353ca 100644 Binary files a/src_docs/source/images/esp32_res.jpg and b/src_docs/source/images/esp32_res.jpg differ diff --git a/src_docs/source/images/ispindel_esp32.jpg b/src_docs/source/images/ispindel_esp32.jpg index 8994fe2..660af86 100644 Binary files a/src_docs/source/images/ispindel_esp32.jpg and b/src_docs/source/images/ispindel_esp32.jpg differ diff --git a/src_docs/source/images/ispindel_esp32c3.jpg b/src_docs/source/images/ispindel_esp32c3.jpg index 5d8ea92..0cdde25 100644 Binary files a/src_docs/source/images/ispindel_esp32c3.jpg and b/src_docs/source/images/ispindel_esp32c3.jpg differ diff --git a/src_docs/source/images/ispindel_esp8266.jpg b/src_docs/source/images/ispindel_esp8266.jpg index fbded59..34a4c4d 100644 Binary files a/src_docs/source/images/ispindel_esp8266.jpg and b/src_docs/source/images/ispindel_esp8266.jpg differ diff --git a/src_docs/source/images/ispindel_pcb4.jpg b/src_docs/source/images/ispindel_pcb4.jpg index 2b6b308..3c0a979 100644 Binary files a/src_docs/source/images/ispindel_pcb4.jpg and b/src_docs/source/images/ispindel_pcb4.jpg differ diff --git a/src_docs/source/images/serial_esp32c3.jpg b/src_docs/source/images/serial_esp32c3.jpg new file mode 100644 index 0000000..b895e8e Binary files /dev/null and b/src_docs/source/images/serial_esp32c3.jpg differ diff --git a/src_docs/source/images/usb-ttl.jpg b/src_docs/source/images/usb-ttl.jpg new file mode 100644 index 0000000..5b27fa0 Binary files /dev/null and b/src_docs/source/images/usb-ttl.jpg differ diff --git a/src_docs/source/installation.rst b/src_docs/source/installation.rst index a4ce9a2..1e35de6 100644 --- a/src_docs/source/installation.rst +++ b/src_docs/source/installation.rst @@ -23,30 +23,30 @@ available here `Brewflasher WEB `_. Binaries ******** -In the /bin directory you will find 3 different firmware builds; +In the /bin directory you will find 4 different firmware builds; * **firmware.bin** This is the standard release build (prefered version) -* **firmware-perf.bin** - - This version also submits performance data to an influx database with detailed execution times. - * **firmware32.bin** - This is the standard release build for an ESP32 variant. When flashing an ESP32 you also need the **partition32.bin** file that outlines the flash memory structure. Due to + This is the release build for an ESP32-d1-mini variant. When flashing an ESP32 you also need the *partition32.bin* file that outlines the flash memory structure. Due to the size of the firmware we are using a custom partition setup. -In these versions all the html files are embedded in the binaries. The file system is currently only used for storing -the configuration file. +* **firmware32c3.bin** -If the software becomes so large the html files can be moved to the file system, but this is not enabled by -default (see compiling for details). This approach makes installation much easier and ensure that html files -and code is in sync. + This is the release build for an ESP32c3-mini variant. When flashing an ESP32 you also need the *partition32c3.bin* file that outlines the flash memory structure. Due to + the size of the firmware we are using a custom partition setup. -Esptool -======= +* **firmware32s2.bin** + + This is the release build for an ESP32s2-mini variant. When flashing an ESP32 you also need the *partition32s2.bin* file that outlines the flash memory structure. Due to + the size of the firmware we are using a custom partition setup. + + +Esptool (esp8266) +================= The other option for flashing esp8266 device is via the official esptool. Documentation can be found here; `esptool home page `_ @@ -61,8 +61,8 @@ If there are issues you can try do erase the flash first using this command; ``esptool.py --port COM4 erase_flash`` -iSpindel -======== +iSpindel (esp8266) +================== If you already have the device flashed with iSpindel firmware you can go into the configuration mode where you will find an option for updating firmware. The option is under the maintence meny. @@ -101,9 +101,21 @@ To check output from the device (logs) there are several tools out there. I foun Just select a baud rate of 115200, 8N1. .. image:: images/serial.png - :width: 800 + :width: 600 :alt: Serial output +On the build for esp32c3 the serial output is written to UART0 which is connected to the RX/TX pins on the chip. This way the serial output can be viewed +without a connection to the USB port, convinient when running the device on battery power. + +You need a USB to TTL cable that you connect the TX, RX and GND pins. **Dont connect the power pin** if you are powering the device from USB or Battery. + +.. image:: images/usb-ttl.jpg + :width: 300 + :alt: USB to TTL cable + +.. image:: images/serial_esp32c3.jpg + :width: 300 + :alt: Serial output ESP32c3 .. _setup_wifi: @@ -130,7 +142,7 @@ successful then it will be used as primary. *The second wifi setting is optional .. image:: images/wifi.png - :width: 200 + :width: 300 :alt: Wifi page diff --git a/src_docs/source/releases.rst b/src_docs/source/releases.rst index 62a633e..cae02b4 100644 --- a/src_docs/source/releases.rst +++ b/src_docs/source/releases.rst @@ -9,6 +9,7 @@ v1.2.0 - beta1 Features ++++++++ * Added support for the ESP32 C3 mini board +* Serial output is written to TX/RX pins instead of the USB connection for the ESP32c3. This way the serial console can be viewed when running on battery power. Issues adressed ++++++++++++++++ @@ -17,6 +18,8 @@ Issues adressed Documentation +++++++++++++ * Updated hardware section with options for ESP32 boards +* Updated installation instructions. + v1.1.0 ======