From f319ec45694a37d39016fdba84402fbcdfb9148b Mon Sep 17 00:00:00 2001 From: Magnus Persson Date: Sat, 22 Oct 2022 10:22:49 +0200 Subject: [PATCH] Update docs and added logo --- src_docs/source/conf.py | 2 ++ src_docs/source/index.rst | 8 ++++---- src_docs/source/installation.rst | 15 ++++++++++++--- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/src_docs/source/conf.py b/src_docs/source/conf.py index 0d8db60..472ea20 100644 --- a/src_docs/source/conf.py +++ b/src_docs/source/conf.py @@ -48,6 +48,8 @@ exclude_patterns = [] # a list of builtin themes. # html_theme = 'furo' +html_logo = "images/gravitymon_logo.png" +html_title = "GravityMon v1.2.0" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 563328e..71f7a8e 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -3,11 +3,11 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to GravityMon's documentation! -###################################### +Welcome to GravityMon +##################### .. note:: - This documentation reflects **v1.2 - beta 1**. Last updated 2022-10-15 + This documentation reflects **v1.2 - beta 1**. Last updated 2022-10-22 User interface overview ----------------------- @@ -23,7 +23,7 @@ This animation shows how the user interface is structured, it reflects an older Main features ------------- -* Support either an ESP8266-d1-mini, ESP32-mini or ESP32C3-mini board (see :ref:`hardware`) +* Support either an ESP8266-d1-mini, ESP32-mini, ESP32S2-mini or ESP32C3-mini board (see :ref:`hardware`) * Operates in two modes gravity monitoring and configuration mode * Gravity mode is comparable to how the iSpindle works when collecting data * Configuration mode has a modern HTML5 based web UI. No need to start the access point to change settings diff --git a/src_docs/source/installation.rst b/src_docs/source/installation.rst index 134aa46..37415d8 100644 --- a/src_docs/source/installation.rst +++ b/src_docs/source/installation.rst @@ -3,11 +3,13 @@ Installation ------------ -You have these 3 options for flashing this firmware. +You have these 5 options for flashing this firmware. * Brewflasher via USB serial +* Brewflasher WEB via USB serial * Esptool via USB serial -* iSpindel web interface +* iSpindel web interface (only ESP8266) +* Build from source and flash via VSCode + Platformio Brewflasher =========== @@ -16,6 +18,13 @@ The preferred option for flashing GravityMon is using BrewFlasher, its a tools t on both Windows and Mac. You can download the latest version from here: `Brewflasher `_ there is also a web based version available here `Brewflasher WEB `_. +In order to flash an C3 board you will need Brewflasher 1.5 or newer. + +.. note:: + The S2 and C3 chips might need to be put in flash mode before flashing can be done. Hold the button on the opposite side from the RST button, + press the RST button and release it before the first button you pressed. This should force the chip into download mode. If you connect a serial + terminal it should say "waiting for download". + .. image:: images/brewflasher.png :width: 600 :alt: Serial output @@ -108,7 +117,7 @@ Just select a baud rate of 115200, 8N1. :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 +On the build for ESP32C3 and ESP32S2 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.