chore(doc): move images to img subfolder instead of branch

tspopp · Jun 12, 2024 · ce890bd · ce890bd
1 parent a248336
commit ce890bd
Show file tree

Hide file tree

Showing 17 changed files with 16 additions and 16 deletions.
diff --git a/MQTT.md b/MQTT.md
@@ -42,7 +42,7 @@ Using the prefix, the `$root` topic is created, which is `$prefix/aquamqtt/` and
 | Operation Time Window B       | `$root/hmi/timerWindowB`           | string |      | e.g. 04:00-08:00                                                                                                                                                                       |
 | Current Time                  | `$root/hmi/time`                   | string |      | e.g 09:11:59                                                                                                                                                                           |
 | Current Date                  | `$root/hmi/date`                   | string |      | e.g 07.09.2023                                                                                                                                                                         |
-| Emergeny Mode Enabled         | `$root/hmi/emergencyMode`          | bool   |      |                                                                                                                                                                                        |
+| Emergency Mode Enabled        | `$root/hmi/emergencyMode`          | bool   |      |                                                                                                                                                                                        |
 | Heating Element Enabled       | `$root/hmi/heatingElementEnabled`  | bool   |      |                                                                                                                                                                                        |
 | Anti-Legionella Mode          | `$root/hmi/antiLegionellaPerMonth` | uint8  |      | 0 (off), 1 (once per month), etc                                                                                                                                                       |
 | Configuration AirDuct         | `$root/hmi/configAirduct`          | Enum   |      | INT/INT, INT/EXT, EXT/EXT                                                                                                                                                              |

diff --git a/PROTOCOL.md b/PROTOCOL.md
@@ -93,13 +93,13 @@ If an error message is requested by the HMI controller, the sequence contains an
 56ms idle
 ```
 
-<img src="../media/sequence.png?raw=true" width=100% height=100%>
+<img src="img/sequence.png?raw=true" width=100% height=100%>
 
 In case we disconnect the HMI controller during operation, we will notice that the 194 frame is no longer complete:
 
-<img src="../media/nohmi1.png?raw=true" width=100% height=100%>
+<img src="img/nohmi1.png?raw=true" width=100% height=100%>
 
-<img src="../media/nohmi2.png?raw=true" width=50% height=50%>
+<img src="img/nohmi2.png?raw=true" width=50% height=50%>
 
 Therefore, message 194 is completed by the HMI controller, whereas 193 and 67 are emitted by the main controller.
 
@@ -225,7 +225,7 @@ Example Table (Byte 19):
 Commands are executed by the HMI as soon as placeholder fields/values are replaced by command values. The HMI Controller
 awaits the change of the Main controller and then resets the placeholder fields to the previous placeholder value.
 
-##### Change Capactiy
+##### Change Capacity
 
 - Affected Byte Positions: 33, 34
 
@@ -460,8 +460,8 @@ Findings...
 
 ```
 5dec  | 0000 0101: Communication Enabled, PV enabled, No Circulation, Anti-Dry-Heating
-17dec | 0001 0001: Communication Enabled, PV disabled, Heat-Exchanger available, No Zirculation, No Anti-Dry-Heating
-20dec | 0001 0100: Communication Enabled, PV enabled, Heat Exchanger not available, No Zirculation, No Anti-Dry-Heating
+17dec | 0001 0001: Communication Enabled, PV disabled, Heat-Exchanger available, No Circulation, No Anti-Dry-Heating
+20dec | 0001 0100: Communication Enabled, PV enabled, Heat Exchanger not available, No Circulation, No Anti-Dry-Heating
 21dec | 0001 0101: Communication Enabled, PV enabled, No Circulation, No Anti-Dry-Heating
 23dec | 0001 0111: Communication Enabled, PV enabled, With Circulation Enabled, No Anti-Dry-Heating
 29dec | 0001 1101: Communication Disabled, PV enabled, Heat-Exchanger available, No Circulation, No Anti-Dry-Heating

diff --git a/README.md b/README.md
@@ -12,8 +12,8 @@ AquaMQTT is a project designed to monitor and control your DHW heat pump locally
 - Easily integrate AquaMQTT with smart home systems like [Home Assistant](https://www.home-assistant.io/).
 
 <p float="left">
-   <img src="../media/homeassistant.png?raw=true" width=35% height=35%>
-   <img src="../media/aquamqtt.jpg?raw=true" width=60% height=60%>
+   <img src="img/homeassistant.png?raw=true" width=35% height=35%>
+   <img src="img/aquamqtt.jpg?raw=true" width=60% height=60%>
 </p>
 
 

diff --git a/WIRING.md b/WIRING.md
@@ -27,11 +27,11 @@ Disassemble the heatpump as described within the chapter "**Opening the product
 
 Once disassembled you can locate the connector on the back side of the HMI Controller...
 
-<img src="../media/hmi_controller_back.jpg?raw=true" width=40% height=40%>
+<img src="img/hmi_controller_back.jpg?raw=true" width=40% height=40%>
 
 ... which is connected to the following port of the Main Controller:
 
-<img src="../media/main_controller.jpg?raw=true" width=40% height=40%>
+<img src="img/main_controller.jpg?raw=true" width=40% height=40%>
 
 - VCC 5V (green)
 - GND (red/brown)
@@ -44,13 +44,13 @@ The AquaMQTT Board intercepts the data line (white) and is using the provided VC
 
 Place the AquaMqtt Board to the back side of the hmi controller and connect the DHW HMI Connector with the original HMI controller. Match the connections accordingly:
 
-<img src="../media/installed.jpg?raw=true" width=40% height=40%>
+<img src="img/installed.jpg?raw=true" width=40% height=40%>
 
 ## Wiring
 
 Connect the original connector cable to the DHW Main Connector on the AquaMqtt Board as shown here:
 
-<img src="../media/wired_up.jpg?raw=true" width=40% height=40%>
+<img src="img/wired_up.jpg?raw=true" width=40% height=40%>
 
 ### Man-In-The-Middle Mode
 
@@ -74,4 +74,4 @@ In listener mode, the AquaMQTT board expects to read any serial information exch
 
     ```c++
     constexpr EOperationMode OPERATION_MODE = EOperationMode::LISTENER;
-    ```
+    ```
diff --git a/img/aquamqtt.jpg b/img/aquamqtt.jpg
diff --git a/img/board_back.png b/img/board_back.png
diff --git a/img/board_front.png b/img/board_front.png
diff --git a/img/hmi.jpg b/img/hmi.jpg
diff --git a/img/hmi_controller_back.jpg b/img/hmi_controller_back.jpg
diff --git a/img/homeassistant.png b/img/homeassistant.png
diff --git a/img/installed.jpg b/img/installed.jpg
diff --git a/img/main_controller.jpg b/img/main_controller.jpg
diff --git a/img/nohmi1.png b/img/nohmi1.png
diff --git a/img/nohmi2.png b/img/nohmi2.png
diff --git a/img/sequence.png b/img/sequence.png
diff --git a/img/wired_up.jpg b/img/wired_up.jpg
diff --git a/pcb/README.md b/pcb/README.md
@@ -6,9 +6,9 @@ individual [USART entities in One-Wire Mode](https://ww1.microchip.com/downloads
 The Arduino ESP32 on the board runs AquaMQTT, providing communication via WiFi/MQTT while being powerful enough to
 handle any time critical USART communication with the heat pumps hmi controller and main board.
 
-<img src="../../media/board_front.png?raw=true" width=40% height=40%>
+<img src="./../img/board_front.png?raw=true" width=40% height=40%>
 
-<img src="../../media/board_back.png?raw=true" width=40% height=40%>
+<img src="./../img/board_back.png?raw=true" width=40% height=40%>
 
 Additionally, an optional DS3231 Real Time Clock might be added to the board. This might be handy in case AquaMQTT will be ever used without any HMI at all. It would ensure a recovery with correct date and time after power outage and without WiFi.
 **Adding a RTC Module is experimental and untested!**