gitpages

InnuendoPi · Dec 22, 2023 · 28f97e5 · 28f97e5
1 parent 1c5c3f9
commit 28f97e5
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 24 deletions.
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -18,7 +18,7 @@ Most of the functions of the firmware are self-explanatory. The addition or dele
 
 Note: sensor calibration is an optional task. A two-point calibrtation is recommended espacially for mash tune sensors.
 
-The firmware provides an easy option for sensor calibration. Three options availble:
+The firmware provides an easy option for sensor calibration. Three options available:
 
     * no calibration
 
@@ -33,36 +33,38 @@ The firmware provides an easy option for sensor calibration. Three options avail
 A two point calibration provides a more accurate correction of each sensor by re-scaling it at two poinst instad of just one (constant offset). All you need is your mash tune, a calibrated temperature sensor and a cbpi4 mash profil, which includes two mash steps: at 40°C (low mashin temperature) and at 78°C (mashout temperature). Set both mash step timers to something lik 3 to 5 minutes. Fill your mash tune with water. If possible turn on agitator. Now start the two step mash profile in CraftbeerPi4. When temperatur 40°C is reached measure the temperature with a calibrated sensor. The difference between sensor value and calibrated temperatur sensor is offset 1. Repeat measurement when 78°C is reached. The difference is offset 2. In a two-point calibration it is very important to do the first measure at exactly 40°C and the second measure at exactly 78°C!
 
 Calibration example:
-Measurement
-![sencal1](img/sensor_calibration2.jpg)
 
-Sensor setting
-![sencal2](img/sensor_calibration.jpg)
+![Measurement](img/sensor_calibration2.jpg)
+
+![Sensor settings](img/sensor_calibration.jpg)
 
 ## Misc settings
 
 ![misc](img/misc.jpg)
 
 **Piezo Buzzer:**
 
-A piezo buzzer can only be connected to PIN D8. A piezo buzzer is optional. The firmware supports 4 different signals: ON, OFF, OK and ERROR
+A piezo buzzer can only be connected to GPIO D8. A piezo buzzer is optional. The firmware supports 4 different audio signals: ON, OFF, OK and ERROR
 
 **HMI display:**
 
 If you want to use a display check jumper settings J1 and J2 first. GPIOs D1 and D2 are used for TX and RX.
 
 **mDNS:**
 
-Multicast DNS is used to resolve hostnames to IP addresses in small networks. A mDNS name can be used instead of the IP address to open the mqttdevice web interface in a browser. Default mDNS name is mqttdevice. Open the configuration panel <http://mqttdevice.local> in your web browser. The name is freely selectable. The mDNS name must be unique in local network and must not contain any spaces or special characters. Please note: if you use two or more MQTTDevices you must change default mDNS "mqttdevice" into an unique identifier! Reboot your mqttdevice after changing mDNS.
+Multicast DNS is used to resolve hostnames to IP addresses in small networks. A mDNS name can be used instead of the IP address to open the mqttdevice web interface in a browser. Default mDNS name is mqttdevice. Open the configuration panel <http://mqttdevice.local> in your web browser. The name is freely selectable. The mDNS name must be unique in local network and must not contain any spaces or special characters. Please note: if you use two or more MQTTDevices you must change default mDNS "mqttdevice" into an unique identifier! Reboot your mqttdevice after changing mDNS. mDNS names are not case sensitive.
+
+**IP address MQTT Server (CBPi):**
 
 ![mqtt](img/mqtt.jpg)
 
-**IP address MQTT Server (CBPi):**
+Enter IP address, Port and credentials of your MQTT broker. In most cases, this is likely to be mosquitto on your RaspberryPi. The default port is 1883.
+
+_Important: the firmware MQTTDevice tries constantly to establish a connection with the MQTT broker. If the MQTT broker is not available, this will severely affect the speed of the MQTT device (web interface)._
 
-On this page you have to enter IP address, Port and credentials of your MQTT broker. In most cases, this is likely to be mosquitto on the CBPi. The default port is 1883.
-Important: the firmware MQTTDevice tries constantly to establish a connection with the MQTT broker. If the MQTT broker is not available, this will severely affect the speed of the MQTT device (web interface).
+**EVENTS:**
 
-The event manager handles events and misconduct. Handling of malfunctions (event handling) is deactivated in the standard setting!
+The event manager handles events and misconducts. Handling of malfunctions (event handling) is deactivated in the standard setting! Events are optional advanced topics. It is recommended to start your MQTTDevice setup with disabled events.
 
 Events are
 

diff --git a/docs/Flashen.md b/docs/Flashen.md
@@ -1,9 +1,9 @@
 # ▶️ Flash firmware
 
-With the help of esptool.exe (<https://github.com/igrr/esptool-ck/releases>) in the github tools subfolder, the firmware can be flashed onto the ESP module. The ESPTool is available for different operating systems.
+With the help of esptool.exe (<https://github.com/igrr/esptool-ck/releases>), the firmware can be flashed onto the ESP module. The ESPTool is available for different operating systems.
 ESPtool-ck Copyright (C) 2014 Christian Klippel <[email protected]>. This code is licensed under GPL v2.
 
-The USB driver CH341SER is required under Win10: <http://www.wch.cn/download/CH341SER_ZIP.html>
+The USB driver CH341SER is required under Win10/11: <http://www.wch.cn/download/CH341SER_ZIP.html>
 
 Example for an ESP8266 module of the type Wemos D1 mini with 4MB Flash connected via USB as COM3
 

diff --git a/docs/MQTT-CBPi4.md b/docs/MQTT-CBPi4.md
@@ -1,8 +1,6 @@
 # MQTT CraftbeerPi4
 
-MQTT installation and configuration is described here in detail: <https://openbrewing.gitbook.io/craftbeerpi4_support/readme/craftbeerpi-4-server/mqtt-connectivity>
-
-After CBPi4 restart MQTT is available for sensors and actors
+After setup MQTT connectivity for CBPi4 MQTT is available for sensors and actors. Please follow the instructions on CBPi4 gitbook.
 
 ![MQTT sensor](img/mqttSensor.jpg)
 
@@ -12,4 +10,4 @@ Please note the dot in PayloadDictionary: Sensor.Value (Sensor dot Value)
 
 ![MQTT actor](img/mqttAktor.jpg)
 
-MQTT mosquitto installtion and configuration for windows is nearly the same. If MQTT actors and sensors are used instead of GPIOs hardware, craftbeerpi4 can be installed on ms windows systems.
+MQTT mosquitto installtion and configuration for windows is nearly the same. If MQTT actors and sensors are used instead of GPIOs hardware, craftbeerpi4 can be installed on Microsoft windows systems.
diff --git a/docs/backup.md b/docs/backup.md
@@ -8,7 +8,7 @@ It is recommended to make a backup after configuration is completed. MQTT backup
 
 ## Explorer
 
-If you want to work with files directly you can use the file explorer. The file explorer can be reached via the web browser <http://mqttdevice/edit>. File explorer offers editor functions. You can check, view and edit files types like txt, json or css. 
+If you want to work with files directly you can use the file explorer. The file explorer can be reached via the web browser <http://mqttdevice/edit>. File explorer offers editor functions. You can check, view and edit files types like txt, json or css.
 
 ![File explorer](img/explorer.jpg)
 

diff --git a/docs/installation.md b/docs/installation.md
@@ -2,12 +2,10 @@
 
 While installation of MQTTDevice is very easy you need some prerequisite.
 
-## Prerequisite
+## Prerequisite CraftbeerPi4
 
-    1. CraftbeerPi4
+The installation and configuration of CraftbeerPi4 is described here: <https://openbrewing.gitbook.io/craftbeerpi4_support/readme/server-installation>. Version 4.0.1.11 or above is required. Earlier versions do not support MQTT actors.
 
-    The installation and configuration of CraftbeerPi4 is described here: <https://openbrewing.gitbook.io/craftbeerpi4_support/master/server-installation>. Version 4.0.1.11 or above is required. Earlier versions do not support MQTT actors.
+## Prerequisite MQTT Broker
 
-    2. MQTT Broker
-
-    The MQTT protocol is used for communication between CraftbeerPi and MQTTDevice. Sensors send temperature values to CraftbeerPi and CraftbeerPi sends commands to actors (e.g. switch agitator on / off). The MQTT protocol requires a MQTT broker. Please follow the instructions on craftbeerpi gitbook to install and configure a MQTT broker like mosquitto.
+The MQTT protocol is used for communication between CraftbeerPi and MQTTDevice. Sensors send temperature values to CraftbeerPi and CraftbeerPi sends commands to actors (e.g. switch agitator on / off). The MQTT protocol requires a MQTT broker. Please follow the instructions on craftbeerpi gitbook to install and configure a MQTT broker like mosquitto: <https://openbrewing.gitbook.io/craftbeerpi4_support/readme/craftbeerpi-4-server/mqtt-connectivity>