merge main changes

merge main changes

Author: munzili

.gitignore

@@ -6,3 +6,7 @@
 src/setup.h
 private/
 .vscode/settings.json
+contrib/ldd_decoder/bin/
+contrib/ldd_decoder/obj/
+contrib/ldd_decoder/label_defines.*
+src/my_setup.h

.travis.yml

@@ -1,6 +1,6 @@
 language: python
 python:
-    - "3.7"
+    - "3.9"
 
 # Cache PlatformIO packages using Travis CI container-based infrastructure
 sudo: false
@@ -12,13 +12,13 @@ cache:
 env:
 
 install:
+    - pip install --upgrade pip setuptools importlib-metadata
     - pip install -U platformio
-    - pio update
+    - pio pkg install
+    - pio pkg update
 
-    #
-    # Libraries from PlatformIO Library Registry:
-    #
-    - pio lib -g install 89 6246
 
 script:
-    - pio ci --board=esp32doit-devkit-v1 --board=m5stick-c --lib="." src
+    # Don't build native, used only for unit tests
+    - pio ci --project-conf=platformio.ini --lib="." -e nodemcuv2 -e esp32 -e m5stickc -e m5stickcplus src
+    - pio test -e native -v

README.md

@@ -3,7 +3,7 @@
 <hr/>
 
 <p align="center">
-<a href="https://travis-ci.com/raomin/ESPAltherma"><img src="https://img.shields.io/travis/com/raomin/espaltherma?style=for-the-badge" /></a>
+<a href="https://travis-ci.com/raomin/ESPAltherma"><img src="https://app.travis-ci.com/raomin/ESPAltherma.svg?branch=main&status=passed" /></a>
 &nbsp;
 <img src="https://img.shields.io/github/last-commit/raomin/ESPAltherma?style=for-the-badge" />
 &nbsp;
@@ -16,15 +16,15 @@
 
 <hr/>
 
-<p><b>ESPAltherma</b> is a solution to monitor Daikin Altherma / ROTEX / HOVAL Belaria heat pump activity using just Arduino on an <b>ESP32</b> Microcontroller.</p>
+<p><b>ESPAltherma</b> is a solution to monitor Daikin Altherma / ROTEX / HOVAL Belaria heat pump activity using just Arduino on an <b>ESP32</b> or <b>ESP8266</b> Microcontroller.</p>
 
 _If this project has any value for you, please consider [buying me a 🍺](https://www.buymeacoffee.com/raomin) or even better [sponsoring ESPAltherma](https://github.com/sponsors/raomin/)!. I don't do this for money but it feels good to get some support! Thanks :)_ 
 
 ## Features
 
   <ul style="list-style-position: inside;">
     <li>Connects with the serial port of Altherma on port X10A.</li>
-    <li>Needs just an ESP32, no need for extra hardware.</li>
+    <li>Needs just an ESP32, no need for extra hardware. ESP8266 is also supported.</li>
     <li>Queries the Altherma for selected values at defined interval.</li>
     <li>Converts and formalizes all values in a JSON message sent over MQTT.</li>
     <li>Easily integrates with Home Assistant's MQTT auto-discovery.</li>
@@ -42,7 +42,7 @@ _If this project has any value for you, please consider [buying me a 🍺](https
 ## Hardware
 
 - A Daikin Altherma or Daikin Altherma based heat pump (ROTEX, HOVAL Belaria...)
-- An ESP32 *I recommend the M5StickC, it has an integrated display, a magnet, fits well next to the board and is properly isolated. But any ESP32 should work.*
+- An ESP32 or ESP8266 *I recommend an ESP32, more precisely the M5StickC, it has an integrated display, a magnet, fits well next to the board and is properly isolated. But any ESP32 should work. A support is added for esp8266.*
 - 5 pins JST EH 2.5mm connector (or 4 Dupont wires M-F)
 
 ## Software
@@ -60,12 +60,13 @@ _If this project has any value for you, please consider [buying me a 🍺](https
 2. Optional - If you are using an **M5StickC** (or M5Stack), select the corresponding environment from the status bar:
 Click  ![end m5](doc/images/defaultenv.png) and select **env:M5StickC** on the top. The status bar should display ![end m5](doc/images/m5envv.png)
 For **M5StickCPlus** select **env:M5StickCPlus**
+If you are using an **ESP8266** select the `nodemcuv2` environement.
 
 3. Edit the file `src/setup.h` as follows:
     - enter your wifi and mqtt settings
-    - select your RX TX GPIO pins connected to the X10A port. *The ESP32 has 3 serial ports. The first one, Serial0 is reserved for ESP<-USB->PC communication and ESP Altherma uses the Serial0 for logging (as any other project would do). So if you open the serial monitor on your PC, you'll see some debug from ESPAltherma. ESP32 can map any GPIO to the serial ports. Do NOT use the main Serial0 GPIOs RX0/TX0.*
+    - select your RX TX GPIO pins connected to the X10A port. *The ESP32 has 3 serial ports. The first one, Serial0 is reserved for ESP<-USB->PC communication and ESP Altherma uses the Serial0 for logging (as any other project would do). So if you open the serial monitor on your PC, you'll see some debug from ESPAltherma. ESP32 can map any GPIO to the serial ports. Do NOT use the main Serial0 GPIOs RX0/TX0.* * The ESP8266 only has 1.5 Serial ports so it uses a software based serial driver. You can choose any pins, but some will stop you from being able to use the console*
 
-      Try to stick to the RX2/TX2 of your board (probably GPIO16/GPIO17). **For M5StickC or M5StickCPlus, 26 and 36 will automatically be used if you selected the corresponding environment**.
+      For ESP32 try to stick to the RX2/TX2 of your board (probably GPIO16/GPIO17). **For M5StickC or M5StickCPlus, 26 and 36 will automatically be used if you selected the corresponding environment**. For ESP8266 pins 4 & 5 (D2 & D1 on the NodeMCUv2) are known to work well. 
 
     - uncomment the `#include` line corresponding to your heat pump. E.g.
 
@@ -91,11 +92,11 @@ For **M5StickCPlus** select **env:M5StickCPlus**
     ```
 
 4. Now open and edit the file you just uncommented, e.g. `include/def/ALTHERMA(HYBRID).h` (or the one under the language chosen) as follow:
-    Uncomment each line of the values you are interested in. *Try not to get everything as it will turn into a very big mqtt message*
+    Uncomment each line of the values you are interested in. *Try not to get everything as it will turn into a very big mqtt message*. 
   
     ```c++
     ...
-    LabelDef PROGMEM labelDefs[] = {
+    LabelDef labelDefs[] = {
     //  {0x00,0,801,0,-1,"*Refrigerant type"},
     {0x60,0,304,1,-1,"Data Enable/Disable"}, //<-- This value will be queried and reported
     // {0x60,1,152,1,-1,"Indoor Unit Address"},
@@ -109,26 +110,22 @@ For **M5StickCPlus** select **env:M5StickCPlus**
     
     A wiki page is available [here](https://github.com/raomin/ESPAltherma/wiki/Information-about-Values) where everyone can comment on the values and their definition.
 
-5. You're ready to go! Connect your ESP32 and click -> Upload! Or run on the command line:
-
-    ```bash
-    $ pio run --environment <your environment> --target upload
-    ````
+5. You're ready to go! Connect your ESP32/ESP8266 and click -> Upload! Or press `F1` and select -> `PlatformIO: Upload`
 
 ## Step 2: Connecting to the Heat pump
 
 1. Turn OFF your heat pump at the circuit breaker.
 2. Unscrew your pannel to access the main PCB of your unit.
-3. Localize the X10A connector on your the PCB. This is the serial port on the main PCB.
-4. Using the 5 pin connector or 4 Dupont wires, connect the ESP32 as follow. Pay attention to the orientation of the socket.
+3. Localize the X10A connector on your the PCB. This is the serial port on the main PCB. If your installation include a bi-zone module, the X10A port is occupied with a connector to the Bi-Zone module. You should then connect to the X12A port on the bi-zone module. Pins are identical to the X10A.
+4. Using the 5 pin connector or 4 Dupont wires, connect the ESP as follow. Pay attention to the orientation of the socket.
 
 ### Daikin Altherma 4 pin X10A Connection
 
 ![The X10A connector](doc/images/schematics.png)
 
 | X10A | ESP32 |
 | ---- | ----- |
-| 1-5V | 5V - VIN *Can supply voltage for the ESP32 :)* |
+| 1-5V | 5V - VIN *Can supply voltage for the ESP :)* |
 | 2-TX | `RX_PIN` *Default GPIO 16. Prefer RX2 of your board.* |
 | 3-RX | `TX_PIN` *Default GPIO 17. Prefer TX2 of your board.* |
 | 4-NC | Not connected |
@@ -142,7 +139,7 @@ Some heat pumps (ROTEX) have an X10A port which connects differently:
 
 ![](doc/images/rotexX10A.png)
 
-Some users reported that the 5V from their ROTEX was not enough to power their ESP32. In this case, use an USB charger to power the ESP32. The 5V from the X10A is then not needed. Whatever you do, **make sure you keep a wire connecting the GND of the ESP32 to the GND pin of the X10A (even if you power your ESP32 with a USB charger)!!**
+Some users reported that the 5V from their ROTEX was not enough to power their ESP32/ESP8266. In this case, use an USB charger to power the ESP32/ESP8266. The 5V from the X10A is then not needed. Whatever you do, **make sure you keep a wire connecting the GND of the ESP32/ESP8266 to the GND pin of the X10A (even if you power your ESP32/ESP8266 with a USB charger)!!**
 
 
 5. Cross check twice the connections and turn on your heat pump. Two new entities AlthermaSensor and AlthermaSwitch should appear in Home Assistant. AlthermaSensor holds the values as attributes.
@@ -205,18 +202,33 @@ Note: Smart Grid needs to be switched ON in the heatpump configuration menu, oth
 
 # Troubleshooting
 
-## Specific issues
+## Specific issues with M5
 
 - If, when using an M5StickC (or M5Stack), the ESP32 is unresponsive, upload fails etc. Make sure that you change the ![default env on pio](doc/images/defaultenv.png) environment to ![end m5](doc/images/m5envv.png) on the status bar. Otherwise the default serial port in setup.h conflicts with the PSRAM of M5.
 
 ## Generic issues
 
 Possible generic issues could be: improper wifi signal, unsupported protocol, unsupported GPIOs for Serial (stick to default RX2/TX2).
 
-ESPAltherma generates logs on the main serial port (USB). Connect to the ESP32 and open the serial monitor on Platformio.
+ESPAltherma generates logs on the main serial port (USB) and on the screen of the M5. Connect to the ESP32 and open the serial monitor on Platformio.
 
 ESPAltherma also generates logs on MQTT. If Wifi and MQTT is not the issue, look at the logs on the topic `espaltherma/log`. You can see them on Home Assistant through  Configuration -> Integration -> MQTT -> Config -> Listen to a topic. 
 
+## Logs show 'Timeout on register' with value 0x15 0xea or 'Error 0x15 0xEA returned from HP'
+
+`0x15 0xea` is the reply from the heatpump to say it does not understand the protocol.
+If you have an older Altherma heat pump (around 2010 or before) it is probably using the older S protocol.
+To activate it, at the end of `setup.h` change `#define PROTOCOL 'I'` to `#define PROTOCOL 'S'`
+Also select the `def/PROTOCOL_S_ROTEX.h` or `def/PROTOCOL_S.h` definition file.
+
+## Logs show 'Time out! Check connection' 'Wrong CRC on registry...'
+
+This means that the communication is wrong. Usual suspects: 
+
+1. Un-conected GND: whatever you do, the GND of the ESP should always be connected to the GND of the Altherma. So, if you power your ESP with a USB charger (or your computer), make sure you also connect the GND from the ESP to your GND of the Altherma.
+2. If not GND, then it's alway the Dupont cable. A faulty dupont cable is a VERY COMMON cause of issue. You can have a perfectly looking cable, they are not the best to do connection on the X10A connector (although much more common than an EH JST 5pin). So, change your cable. You can also use a common 2.54 female long header, plug it to the X10A connector and then your dupont cable to the long pins of the header.
+![pic of header](doc/images/header.png)
+
 ## Note on voltage
 
 The serial port of X10A is TTL 5V, where the ESP32 is 3.3V. Your ESP32 might not be 5V tolerant. If you want to play it safe, you should use a level shifter to convert Daikin TX - RX ESP line from 5V to 3.3V.
@@ -319,13 +331,13 @@ When put in terms of ESPAltherma variables, the COP can be define as a sensor li
 
 Not directly. It might be possible to change registry values using the serial port but I'm not aware of this. If you know, comment on [the dedicated issue](/../../issues/1).
 
-However, ESPAltherma, supports an extra GPIO to control a relay that you can plug as *external On Off thermostat*. See [**Controling your Daikin Altherma heat pump**](#controling-your-daikin-altherma-heat-pump).
+However, ESPAltherma, supports an extra GPIO to control a relay that you can plug as *external On/Off thermostat*. See [**Controling your Daikin Altherma heat pump**](#controling-your-daikin-altherma-heat-pump).
 
 If you want to configure your heat pump using an arduino, you can interact with the P1P2 serial protocol (the one of the digital thermostats) using the [nice work on P1P2Serial](https://github.com/Arnold-n/P1P2Serial) of Arnold Niessen.
 
 ## Where can I get more info on the protocol used?
 
-It took quite some time to reverse engineering the protocol. If you're interested, I documented my findings [here](doc/Daikin%20I%20Protocol.md).
+It took quite some time to reverse engineer the protocol. If you're interested, I documented my findings [here](doc/Daikin%20I%20protocol.md).
 
 ## Is it safe? Can I break my machine?
 
@@ -389,8 +401,13 @@ You can also [sponsor this project](https://github.com/sponsors/raomin/) (ie reg
 
 ## ❤ Sponsors ❤
 
-<a href="https://github.com/freddydeschepper">@freddydeschepper</a>
-<a href="https://github.com/qwirx">@qris (Chris Wilson)</a>
+<a href="https://github.com/freddydeschepper">@freddydeschepper</a><br/>
+<a href="https://github.com/qris">@qris (Chris Wilson)</a><br/>
+<a href="https://github.com/mauromorello">@mauromorello (Mauro Morello)</a><br/>
+<a href="https://github.com/kloni">@kloni (Tom Klonikowski)</a><br/>
+<a href="https://github.com/tarmor1">@tarmor1</a><br/>
+<a href="https://github.com/EvertJob">@EvertJob (toppe)</a><br/>
+<a href="https://github.com/FusisCaesar">@FusisCaesar</a><br/>
 
 # License
 ESPAltherma is licensed under ![MIT Licence](https://img.shields.io/github/license/raomin/ESPAltherma.svg?style=for-the-badge)

contrib/README.md

@@ -0,0 +1,7 @@
+This folder contains various scripts & resources useful to hack Rotex/Daikin heat pumps.
+
+Nothing fancy, quite some hard-coded values to change depending on your setup. Hope it helps anyway and saves you some time!
+
+# Links
+
+Official Daikin diagnostic tools (required by those scripts) can be found here: https://www.thermalsupplyinc.com/daikin-service-checkers/

contrib/hp_emulator.py

@@ -0,0 +1,51 @@
+"""
+Heat pump simulator.
+
+Can be done locally using com0com driver on windows: https://sourceforge.net/projects/com0com/
+
+Create a virtual COM ports pair (COM6/7 in this example).
+Connect Daikin DChecker to COM7, this script to COM6 (simulating the HP).
+"""
+
+import time
+import serial
+
+def main():
+    ser = serial.Serial('COM8', 9600, timeout=0.1,
+                    parity=serial.PARITY_EVEN, stopbits=1)
+    while True:
+        data = ser.read(100)
+        if data:
+            print(f"Received: {data}") 
+            reply = None
+            # Reply to S protocol
+            if data == b'\x02\x53\xaa':
+                print("Match 53!")
+                reply = b"\x53\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\xab"
+            elif data == b'\x02\x50\xad':
+                print("Match 50!")
+                # 6 only
+                reply = b"\x50\x01\x00\x00\x00\xae"
+            elif data == b'\x02\x54\xa9':
+                print("Match 54!")
+                reply = b"\x54\xb4\x0d\xa8\x17\xd0\x18\x24\x1d\x3c\x2c\x01\x00\x20\x00\x00\x00\x79"
+            elif data == b'\x02\x55\xa8':
+                print("Match 55!")
+                reply = b"\x55\x01\x00\x00\x00\x00\x1e\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x8b"
+            elif data == b'\x02\x56\xa7':
+                print("Match 56!")
+                # 6 only
+                reply = b"\x56\x01\x00\x00\x00\xa8"
+            else:
+                print("Error reply...")
+                reply = b"\x15\xea"
+
+            if reply:
+                ser.write(reply)
+
+        else:
+            time.sleep(0.1)
+
+if __name__ == "__main__":
+    main()
+

contrib/ktb_decoder.py

@@ -0,0 +1,52 @@
+"""
+Decoder of ktb files, used by official Daikin service Checker.
+ktb stands for "KishuTable".
+"""
+import glob
+import argparse
+    # private byte[] DecodeType3Data(byte[] data)
+    # {
+    #   byte[] numArray = new byte[data.Length];
+    #   for (int index = 0; index < data.Length; ++index)
+    #   {
+    #     byte num = (byte) (((int) data[index] >> 4 & 15) + ((int) data[index] << 4 & 240));
+    #     numArray[index] = ~num;
+    #   }
+    #   return numArray;
+    # }
+
+def decode_d3(src: bytes) -> bytes:
+    """"Magic" taken from DecodeType3Data in D3Command.cs."""
+    decoded = bytes([~((src_byte >> 4 & 15) + (src_byte << 4 & 240)) % 256 for src_byte in src])
+
+    return decoded
+
+def parse_cli() -> argparse.Namespace:
+    """Parse command line options."""
+    example_text = """
+    python .\\bin\\ktb_decoder.py set_decoded.txt 'C:\\\\Program Files (x86)\\\\Daikin\\\\Checker4\\\\D3Model_en\\\\*.set'
+    python .\\bin\\ktb_decoder.py ktb_decoded.txt 'C:\\\\Program Files (x86)\\\\Daikin\\\\Checker4\\\\D3Model_en\\\\*.ktb'
+    """
+    parser = argparse.ArgumentParser(epilog=example_text)
+    parser.add_argument('outfile', type=str,
+                    help='Output file')
+    parser.add_argument('infiles', type=str,
+                    help='Input files pattern (glob supported)')
+    args = parser.parse_args()
+    return args
+
+def main():
+    args = parse_cli()
+    with open(args.outfile, "wb") as output_file:
+        for filepath in glob.iglob(args.infiles):
+            separator = f"========== {filepath} =========="
+            print(separator)
+            with open(filepath, "rb") as f:
+                f_bytes = f.read()
+                # print(f_bytes)
+                decoded = decode_d3(f_bytes)
+                print(decoded.decode("utf-8", "backslashreplace"))
+                output_file.write(separator.encode() + b"\n\n" + decoded + b"\n\n")
+
+if __name__ == "__main__":
+    main()

contrib/ldd_decoder/Program.cs

@@ -0,0 +1,54 @@
+using System;
+using Dchecker.Models;
+using System.IO;
+using System.Text;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+
+namespace ldd_decoder
+{
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            // Decode binary LDD
+            Console.WriteLine("Decoding LDD file...");
+            LabelDefine[] labeldefines = DataConvModel.DeserializeLabelDefine(
+                "D:\\Dchecker3_V3602\\Dchecker3\\Storage\\DataModule\\Conv\\S\\en\\DEFAULT.ldd");
+
+            // Export it to CSV
+            Console.WriteLine("Exporting CSV...");
+            string outDir = Directory.GetCurrentDirectory();
+            bool res = new DataConvModel(new SamplingInfo()).SaveLabelDefine(
+                "label_defines.csv", labeldefines, false, outDir);
+
+            // Format corresponding ESPAltherma def include file
+            Console.WriteLine("Generating ESPAltherma def include file...");
+            GenerateDefInclude("label_defines.h", labeldefines, outDir);
+
+            Console.WriteLine("Done.");
+        }
+
+        static void GenerateDefInclude(string fileName, LabelDefine[] defines, string folder = null)
+        {
+            StringBuilder stringBuilder = new StringBuilder(
+                "#include \"labeldef.h\"\n// Generated def file\nLabelDef labelDefs[] = {\n");
+
+            foreach (LabelDefine define in defines)
+            {
+                // {0x50,0,217,1,-1,"Operation Mode"},
+                stringBuilder.Append(String.Format("{{0x{0:X},{1},{2},{3},-1,\"{4}\"}},\n", Encoding.Default.GetBytes(define.DataId)[0], define.Offset, define.ConvId, define.Bytes, define.LabelStr));
+                
+
+                //stringBuilder.Append(Environment.NewLine);
+            }
+            stringBuilder.Append("};\n");
+            using (StreamWriter streamWriter = new StreamWriter(folder + "\\" + fileName, false, Encoding.GetEncoding("utf-8")))
+            {
+                streamWriter.Write((object)stringBuilder);
+                streamWriter.Close();
+            }
+        }
+    }
+}