Brewery/gravitymon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs and added logo

Browse Source
This commit is contained in:
Magnus Persson 2022-10-22 10:22:49 +02:00
parent 21298b09f4
commit f319ec4569
3 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src_docs/source/conf.py
View File

@ -48,6 +48,8 @@ exclude_patterns = []
# a list of builtin themes. # a list of builtin themes.
# #
html_theme = 'furo' 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, # 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, # relative to this directory. They are copied after the builtin static files,

8
src_docs/source/index.rst
View File

@ -3,11 +3,11 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to GravityMon's documentation! Welcome to GravityMon
###################################### #####################
.. note:: .. 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 User interface overview
----------------------- -----------------------
@ -23,7 +23,7 @@ This animation shows how the user interface is structured, it reflects an older
Main features 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 * Operates in two modes gravity monitoring and configuration mode
* Gravity mode is comparable to how the iSpindle works when collecting data * 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 * Configuration mode has a modern HTML5 based web UI. No need to start the access point to change settings

15
src_docs/source/installation.rst
View File

@ -3,11 +3,13 @@
Installation Installation
------------ ------------
You have these 3 options for flashing this firmware. You have these 5 options for flashing this firmware.
* Brewflasher via USB serial * Brewflasher via USB serial
* Brewflasher WEB via USB serial
* Esptool via USB serial * Esptool via USB serial
* iSpindel web interface * iSpindel web interface (only ESP8266)
* Build from source and flash via VSCode + Platformio
Brewflasher 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 <https://www.brewflasher.com/>`_ there is also a web based version on both Windows and Mac. You can download the latest version from here: `Brewflasher <https://www.brewflasher.com/>`_ there is also a web based version
available here `Brewflasher WEB <https://web.brewflasher.com/>`_. available here `Brewflasher WEB <https://web.brewflasher.com/>`_.
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 .. image:: images/brewflasher.png
:width: 600 :width: 600
:alt: Serial output :alt: Serial output
@ -108,7 +117,7 @@ Just select a baud rate of 115200, 8N1.
:width: 600 :width: 600
:alt: Serial output :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. 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. 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.