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

New install method via brewflasher

Browse Source
This commit is contained in:
Magnus Persson 2022-01-15 16:49:36 +01:00
parent 1adef20edd
commit 10163f3aa7
3 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
src_docs/source/images/brewflasher.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 156 KiB

2
src_docs/source/index.rst
View File

@ -7,7 +7,7 @@ Welcome to GravityMon's documentation!
######################################
.. note::
This documentation reflects **v0.6**. Last updated 2022-01-13
This documentation reflects **v0.6**. Last updated 2022-01-15
GravityMon is a replacement firmare for the iSpindle firmware, it uses the same hardware configuration so

58
src_docs/source/installation.rst
View File

@ -1,36 +1,16 @@
Installation
------------
Official esptool
================
Brewflasher
===========
The prefered option for flashing esp8266 device is via the official esptool. Documentation can be found
here; `esptool home page <https://docs.espressif.com/projects/esptool/en/latest/esp32/>`_
The prefered option for flashing GravityMon is using BrewFlasher, its a tools that support many brewing related firmwares for ESP8266 and ESP32. This works
on both Windows and Mac. You can download the latest version from here: `Brewflasher <https://www.brewflasher.com/>`_
Windows 10 should install a driver for the USB -> Serial automatically when you connect a esp8266.
Flashing on windows
*******************
The basic command for flashing on Windows is;
``esptool.py --port COM4 write_flash 0x0 firmware.bin``
If there are issues you can try do erase the flash first using this command;
``esptool.py --port COM4 erase_flash``
Serial Monitoring
*******************
To check output from the device (logs) there are several tools out there. I found this simple tool in the Windows Store called ``Serial Port Monitoring``.
Just select a baud rate of 115200, 8N1.
.. image:: images/serial.png
:width: 800
.. image:: images/brewflasher.png
:width: 600
:alt: Serial output
Binaries
********
@ -44,7 +24,6 @@ In the /bin directory you will find 2 different firmware builds;
This version also submits performance data to an influx database with detailed execution times.
In these versions all the html files are embedded in the binaries. The file system is currently only used for storing
the configuration file.
@ -52,6 +31,31 @@ If the software becomes so large the html files can be moved to the file system,
default (see compiling for details). This approach makes installation much easier and ensure that html files
and code is in sync.
Esptool
=======
The other option for flashing esp8266 device is via the official esptool. Documentation can be found
here; `esptool home page <https://docs.espressif.com/projects/esptool/en/latest/esp32/>`_
Windows 10 should install a driver for the USB -> Serial automatically when you connect a esp8266.
The basic command for flashing on Windows is;
``esptool.py --port COM4 write_flash 0x0 firmware.bin``
If there are issues you can try do erase the flash first using this command;
``esptool.py --port COM4 erase_flash``
Serial Monitoring
=================
To check output from the device (logs) there are several tools out there. I found this simple tool in the Windows Store called ``Serial Port Monitoring``.
Just select a baud rate of 115200, 8N1.
.. image:: images/serial.png
:width: 800
:alt: Serial output
Configuring WIFI
================