Skip to content

Commit 61e5db9

Browse files
tspopptspopp
committed
doc(readme): incorporated various feedback, add thermor aeromax rt+
1 parent 238c8de commit 61e5db9

File tree

3 files changed

+23
-18
lines changed

3 files changed

+23
-18
lines changed

‎AquaMQTT/README.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Listener" and "Man-in-the-Middle."
3636

3737
2. Configure WiFi and MQTT Settings:
3838

39-
Open the `config/ExampleConfiguration.h` file and update the following parameters to match your WiFi and MQTT broker
39+
Open the `include/config/ExampleConfiguration.h` [file](include/config/ExampleConfiguration.h) and update the following parameters to match your WiFi and MQTT broker
4040
settings:
4141

4242
```c++
@@ -59,7 +59,7 @@ Listener" and "Man-in-the-Middle."
5959
6060
Ensure that the WiFi SSID, password, MQTT broker address, and other parameters are correctly set.
6161
62-
Additionally, set the operation mode within `config/Configuration.h` to either LISTENER or MITM, depending of your [Wiring Configuration](../WIRING.md).
62+
Additionally, set the operation mode within `include/config/Configuration.h` to either LISTENER or MITM, depending of your [Wiring Configuration](../WIRING.md).
6363
6464
```c++
6565
constexpr EOperationMode OPERATION_MODE = EOperationMode::MITM;
@@ -85,6 +85,8 @@ Listener" and "Man-in-the-Middle."
8585

8686
**Note:** If you are using the cheaper esp32 [esp32-s3-devkit-c1](https://github.com/tspopp/AquaMQTT/issues/56) instead of the Arduino Nano ESP32, use the environment `esp32-s3-devkitc-1` instead of `arduino_nano_esp32`
8787

88+
**Hint:** If you have issues flashing Arduino Nano ESP32, just press the RST button multiple times quickly, until it starts blinking green. It shouldn't be needed, but if the esp is in some strange condition, it can be helpful. See Arduino Bootloader Mode in the official docs: https://docs.arduino.cc/tutorials/nano-esp32/cheat-sheet/
89+
8890
### Over-The-Air Update
8991

9092
1. Determine the IP-Address of your AquaMQTT device

‎DEVICES.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,23 @@
44

55
These devices have been tested succesfully by the community. Currently there are no insights if the software version indicitates compatibilty to the AquaMQTT implementation.
66

7-
| Name | HMI Software Version | Controller Software Version | Observed Protocol / Checksum | Other Information | Installation Date |
8-
|------------------------------------------------------------------------------------------------------|----------------------|-----------------------------|--------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------|
9-
| [Atlantic Calypso Split Inverter 270l (BmdOnline)](https://github.com/tspopp/AquaMQTT/issues/64) | F | G | [LEGACY](PROTOCOL.md) / XOR | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
10-
| [Atlantic Calypso VR (Arrnooo, Quentin90000, sebcaps)](https://github.com/tspopp/AquaMQTT/issues/67) | E | F | [LEGACY](PROTOCOL.md) | [Rev 2.0 PCB required](./pcb) | |
11-
| [Atlantic Explorer 270/V3 (Silmo)](https://github.com/tspopp/AquaMQTT/pull/52) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
12-
| [Atlantic Explorer (ALENOC)](https://github.com/tspopp/AquaMQTT/issues/14#issuecomment-2501636900) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
13-
| [Atlantic Odyssee Pi (FSlunkk)](https://github.com/tspopp/AquaMQTT/issues/68) | B | B | [ODYSSEE](PROTOCOL_ODYSSEE.md) / XOR | | 2015 |
14-
| [Atlantic Explorer V4](https://github.com/tspopp/AquaMQTT/issues/14) | B | B | [LEGACY](PROTOCOL.md) / CRC16 | | |
15-
| [Austria Email Explorer Evo 2](https://github.com/tspopp/AquaMQTT/issues/22) | ? | ? | [LEGACY](PROTOCOL.md) / CRC16 | | |
16-
| Austria Email Explorer Evo 2 260L + HX (Dominik) | B | B | [LEGACY](PROTOCOL.md) | | 2023 |
17-
| [Austria Email BWWP 200 WT SMART COZY (taloriko)](https://github.com/tspopp/AquaMQTT/issues/45) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
18-
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/18) | ? | ? | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
19-
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/51) | E | G | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
20-
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/80) | E | H | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) <br><br> Requires `DEFAULT_SERIAL_CONFIGURATION` set to `Serial_8N1` in `Configuration.h` | 2024 |
21-
| Windhager Aquawin Air 2 AWA272 (Gwabo) | E | E | [NEXT](PROTOCOL_NEXT.md) | | 2022? |
22-
| Windhager Aquawin Air 3 AWA273 | B | B | [LEGACY](PROTOCOL.md) / CRC16 | | 2021 |
7+
| Name | HMI Software Version | Controller Software Version | Observed Protocol / Checksum | Other Information | Installation Date |
8+
|------------------------------------------------------------------------------------------------------|----------------------|-----------------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|-------------------|
9+
| [Atlantic Calypso Split Inverter 270l (BmdOnline)](https://github.com/tspopp/AquaMQTT/issues/64) | F | G | [LEGACY](PROTOCOL.md) / XOR | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
10+
| [Atlantic Calypso VR (Arrnooo, Quentin90000, sebcaps)](https://github.com/tspopp/AquaMQTT/issues/67) | E | F | [LEGACY](PROTOCOL.md) | [Rev 2.0 PCB required](./pcb) | |
11+
| [Atlantic Explorer 270/V3 (Silmo)](https://github.com/tspopp/AquaMQTT/pull/52) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
12+
| [Atlantic Explorer (ALENOC)](https://github.com/tspopp/AquaMQTT/issues/14#issuecomment-2501636900) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
13+
| [Atlantic Odyssee Pi (FSlunkk)](https://github.com/tspopp/AquaMQTT/issues/68) | B | B | [ODYSSEE](PROTOCOL_ODYSSEE.md) / XOR | | 2015 |
14+
| [Atlantic Explorer V4](https://github.com/tspopp/AquaMQTT/issues/14) | B | B | [LEGACY](PROTOCOL.md) / CRC16 | | |
15+
| [Austria Email Explorer Evo 2](https://github.com/tspopp/AquaMQTT/issues/22) | ? | ? | [LEGACY](PROTOCOL.md) / CRC16 | | |
16+
| Austria Email Explorer Evo 2 260L + HX (Dominik) | B | B | [LEGACY](PROTOCOL.md) | | 2023 |
17+
| [Austria Email BWWP 200 WT SMART COZY (taloriko)](https://github.com/tspopp/AquaMQTT/issues/45) | E | E | [NEXT](PROTOCOL_NEXT.md) / XOR | | |
18+
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/18) | ? | ? | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
19+
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/51) | E | G | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) | |
20+
| [Thermor Aeromax 5](https://github.com/tspopp/AquaMQTT/issues/80) | E | H | [LEGACY](PROTOCOL.md) / CRC16 | [Rev 1.0 PCB: Adapter is recommended](./pcb) <br><br> Requires `DEFAULT_SERIAL_CONFIGURATION` set to `Serial_8N1` in `Configuration.h` | 2024 |
21+
| [Thermor Aeromax RT5+ (jonvelle)](https://github.com/tspopp/AquaMQTT/issues/98) | ? | ? | [ODYSSEE](PROTOCOL_ODYSSEE.md) | Requires `DEFAULT_SERIAL_CONFIGURATION` set to `Serial_8N1` in `Configuration.h` | |
22+
| Windhager Aquawin Air 2 AWA272 (Gwabo) | E | E | [NEXT](PROTOCOL_NEXT.md) | | 2022? |
23+
| Windhager Aquawin Air 3 AWA273 | B | B | [LEGACY](PROTOCOL.md) / CRC16 <br/> | | 2021 |
2324

2425

2526
## Potential compatible devices

‎pcb/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ This board uses tiny SMD SSOP parts (SN74LVC2T45) so self-soldering is most prob
4040
5. Verify matched parts (should be good out of the box)
4141
6. Verify component placement (should be good out of the box)
4242

43+
If there are any issues during production, [you may reference a successful previous order](https://github.com/tspopp/AquaMQTT/issues/96).
44+
4345
### Parts
4446

4547
| Item | Count | Estimated Cost |

0 commit comments

Comments
 (0)