diff --git a/src_docs/source/conf.py b/src_docs/source/conf.py index 00fa6c6..d447760 100644 --- a/src_docs/source/conf.py +++ b/src_docs/source/conf.py @@ -18,11 +18,11 @@ # -- Project information ----------------------------------------------------- project = 'KegMon' -copyright = '2022-23, Magnus Persson' +copyright = '2022-2024, Magnus Persson' author = 'Magnus Persson' # The full version, including alpha/beta/rc tags -release = '0.8.0' +release = '1.0.0' # -- General configuration --------------------------------------------------- @@ -49,7 +49,7 @@ # html_theme = 'furo' html_logo = "images/kegmon_logo.png" -html_title = "KegMon v0.8.0" +html_title = "KegMon v1.0.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/configuration.rst b/src_docs/source/configuration.rst index 7dab78e..bfaae8e 100644 --- a/src_docs/source/configuration.rst +++ b/src_docs/source/configuration.rst @@ -34,8 +34,6 @@ Device - Settings Device - Hardware ***************** -TODO: Missing hardware screen dump - .. image:: images/view_device_hardware.png :width: 600 :alt: Device Hardware @@ -75,6 +73,21 @@ the factor for estimating the weight. The third step is to validate that everything works, place anohter thing with a know weight and check the measured value. If you are satisfied then you are done. +Device - Stability +****************** + +.. image:: images/view_device_stability.png + :width: 600 + :alt: Serial console + +Information page that can determine the stability of your hardware build. + +I have found that some of my hardware builds was not really stable so I added this +feature to check the scale build before doing the final assembly. + +If you keep the browser open you can also see the history of the values (raw, kalman & stable). This can help to show +how your scale varies over time. Data is only stored in the browser so any refresh or page change will delete the graphs. + Device - Wifi ************* @@ -106,8 +119,8 @@ Device - Wifi This is the amount of time allowed for a wifi connect. -Tap Settings -************ +Taps - Settings +*************** .. image:: images/view_taps_settings.png :width: 600 @@ -121,7 +134,7 @@ Tap Settings * **Beer FG**: Used in formula for calculating the beer volume. FG has a slight impact on the weight / volume unit. If not defined 1 will be used for calculations. -Tap Settings +Taps - Beers ************ .. image:: images/view_taps_beers.png @@ -130,12 +143,22 @@ Tap Settings Shows information about beers on tap. Use the buttons to import from brewspy or brewfather. +Taps - History +************** + +.. image:: images/view_taps_history.png + :width: 600 + :alt: Tap history + +Shows information about the latest pours per tapbeers on tap. + + Integration - Home Assistant **************************** .. image:: images/view_integration_ha.png :width: 600 - :alt: Home Assistant + :alt: Home Assistant integration Setting for MQTT server that is used by Home Assistant. @@ -148,43 +171,53 @@ Integration - Brewfather API and User keys for access to brewfather + Integration - Brewspy ********************* .. image:: images/view_integration_brewspy.png :width: 600 - :alt: Brewspy + :alt: Brewspy integration + +Brewspy tokens for keg 1 & keg 2. + +Click on the taplist and the tap you want to connect. Under webhook URL copy the +last code and enter that into kegmon. + +.. note:: + This will not work on ESP8266 due to lack of RAM for using SSL connections. -Brewspy tokens for keg 1 & keg 2. Integration - Barhelper *********************** .. image:: images/view_integration_barhelper.png :width: 600 - :alt: Barhelper + :alt: Barhelper integration Barhelper API keys and name of monitors. +You can get the API key from the settings part of Barhelper and enter this into +kegmon. Make a copy of it since you will not be able to retrieve it again. -History -******* - -TODO: Not yet implemented in new UI +The name of the monitors does not need to be registered, they will be added +after the first run. Just connect the tap/keg to the monitor and the level will +be the same as in kegmon. +.. note:: + On ESP8266 the device will use a NON-SSL endpoint to send the data since there is + not enough memory. -Stability -********* -TODO: Not yet implemented in new UI +Integration - Influx +******************** -Information page that can determine the stability of your hardware build. +.. image:: images/view_integration_influx.png + :width: 600 + :alt: Influx integration -I have found that some of my hardware builds was not really stable so I added this -feature to check the scale build before doing the final assembly. +Sends scale and internal parameters to an influx db v2 for debugging and detailed analysis. -If you keep the browser open you can also see the history of the values (raw, kalman & stable). This can help to show -how your scale varies over time. Data is only stored in the browser so any refresh or page change will delete the graphs. Serial console ************** diff --git a/src_docs/source/images/view_device_calibration.png b/src_docs/source/images/view_device_calibration.png index 980693f..eeebe36 100644 Binary files a/src_docs/source/images/view_device_calibration.png and b/src_docs/source/images/view_device_calibration.png differ diff --git a/src_docs/source/images/view_device_hardware.png b/src_docs/source/images/view_device_hardware.png index b6c424f..b808734 100644 Binary files a/src_docs/source/images/view_device_hardware.png and b/src_docs/source/images/view_device_hardware.png differ diff --git a/src_docs/source/images/view_device_settings.png b/src_docs/source/images/view_device_settings.png index da5df1f..cacea42 100644 Binary files a/src_docs/source/images/view_device_settings.png and b/src_docs/source/images/view_device_settings.png differ diff --git a/src_docs/source/images/view_device_stability.png b/src_docs/source/images/view_device_stability.png new file mode 100644 index 0000000..efc306b Binary files /dev/null and b/src_docs/source/images/view_device_stability.png differ diff --git a/src_docs/source/images/view_device_wifi.png b/src_docs/source/images/view_device_wifi.png index ffc7332..8110cb5 100644 Binary files a/src_docs/source/images/view_device_wifi.png and b/src_docs/source/images/view_device_wifi.png differ diff --git a/src_docs/source/images/view_home.png b/src_docs/source/images/view_home.png index 68f07a3..3e393af 100644 Binary files a/src_docs/source/images/view_home.png and b/src_docs/source/images/view_home.png differ diff --git a/src_docs/source/images/view_integration_barhelper.png b/src_docs/source/images/view_integration_barhelper.png index 4b56e30..894b7c8 100644 Binary files a/src_docs/source/images/view_integration_barhelper.png and b/src_docs/source/images/view_integration_barhelper.png differ diff --git a/src_docs/source/images/view_integration_brewfather.png b/src_docs/source/images/view_integration_brewfather.png index 15c2670..cf0e435 100644 Binary files a/src_docs/source/images/view_integration_brewfather.png and b/src_docs/source/images/view_integration_brewfather.png differ diff --git a/src_docs/source/images/view_integration_brewspy.png b/src_docs/source/images/view_integration_brewspy.png index 5bdd2f1..13fc11c 100644 Binary files a/src_docs/source/images/view_integration_brewspy.png and b/src_docs/source/images/view_integration_brewspy.png differ diff --git a/src_docs/source/images/view_integration_ha.png b/src_docs/source/images/view_integration_ha.png index 68b2827..ad22fb8 100644 Binary files a/src_docs/source/images/view_integration_ha.png and b/src_docs/source/images/view_integration_ha.png differ diff --git a/src_docs/source/images/view_integration_influx.png b/src_docs/source/images/view_integration_influx.png new file mode 100644 index 0000000..1438e0f Binary files /dev/null and b/src_docs/source/images/view_integration_influx.png differ diff --git a/src_docs/source/images/view_other_about.png b/src_docs/source/images/view_other_about.png index 265b105..cf1507a 100644 Binary files a/src_docs/source/images/view_other_about.png and b/src_docs/source/images/view_other_about.png differ diff --git a/src_docs/source/images/view_other_backup.png b/src_docs/source/images/view_other_backup.png index dcbf662..b736d57 100644 Binary files a/src_docs/source/images/view_other_backup.png and b/src_docs/source/images/view_other_backup.png differ diff --git a/src_docs/source/images/view_other_firmware.png b/src_docs/source/images/view_other_firmware.png index 9a52ee3..c539c51 100644 Binary files a/src_docs/source/images/view_other_firmware.png and b/src_docs/source/images/view_other_firmware.png differ diff --git a/src_docs/source/images/view_other_serial.png b/src_docs/source/images/view_other_serial.png index 311c206..468730e 100644 Binary files a/src_docs/source/images/view_other_serial.png and b/src_docs/source/images/view_other_serial.png differ diff --git a/src_docs/source/images/view_other_support.png b/src_docs/source/images/view_other_support.png index 5425907..217dd92 100644 Binary files a/src_docs/source/images/view_other_support.png and b/src_docs/source/images/view_other_support.png differ diff --git a/src_docs/source/images/view_other_tools.png b/src_docs/source/images/view_other_tools.png index c0cc3ca..6e8cbcb 100644 Binary files a/src_docs/source/images/view_other_tools.png and b/src_docs/source/images/view_other_tools.png differ diff --git a/src_docs/source/images/view_taps_beers.png b/src_docs/source/images/view_taps_beers.png index fcb75ca..2dcae8a 100644 Binary files a/src_docs/source/images/view_taps_beers.png and b/src_docs/source/images/view_taps_beers.png differ diff --git a/src_docs/source/images/view_taps_history.png b/src_docs/source/images/view_taps_history.png index a344ef9..0536dee 100644 Binary files a/src_docs/source/images/view_taps_history.png and b/src_docs/source/images/view_taps_history.png differ diff --git a/src_docs/source/images/view_taps_settings.png b/src_docs/source/images/view_taps_settings.png index 5ef78f3..6c088c1 100644 Binary files a/src_docs/source/images/view_taps_settings.png and b/src_docs/source/images/view_taps_settings.png differ