- Communicate over MQTT protocol to simulate a TRUMA INETBOX
- new: Full control of TRUMA Combi-heater and TRUMA Aventa air conditioning modes.
- new: Support of different hw constellations via pin configuration tables
- new: Support of different mqtt ports and static IP-configuration
- new: Support of LAN-connections
- Input credentials over web-frontend
- Test mqtt-connectivity and lin-interface in web-frontend
- OTA-updating support with releasing
- Tested in different hw constellations (with ESP32 or RP2 pico w 2040)
- Include add-on: Optional Truma DuoControl over GPIO-connections
- Include add-on: Optional MPU6050 Sensor for spiritlevel-feature
- The requirements are a CPplus with a version number > C4.00.00 (see disclaimer-section)
The possibilities opened up by controlling the RV heating or the air condition via an mqtt-broker are manifold. The limits set by a simple SMS technology from the manufacturer are falling.
To establish communication between CPplus and the chip (e.g. ESP32 or RP2 pico), a LIN-UART converter is required. If you want to realise this, please refer to Electrics. However, there are now several suppliers who already have the converter on the board e.g. WoMoLin lin-interface, WoMoLin lin-controller.
It is very important to me to show here an out of the box solution that opens up these possibilities to everyone simply and easily - without special electrical and without programming knowledge. If you don't have the confidence to assemble the few components yourself, you can also ask me for ready-made modules.
Flexible debugging and the possibility to write log-files to solve problems is implemented.
The current version opens flexibility to use different hardware cofigurations.
The development of this software and also just the maintenance in the different variants has already cost many hours of time. This is only possible with your support. So if you use this software, I deserve more than a beer. Many thanks for this in advance. For this purpose, you will find the Sponsorship button on the right side of the page.
The software works on all ESP32 models and probably, with small adjustments (UART address, pins), also on other hardware. It also runs on a Raspberry Pi Pico W. I will not always mention the RP2 pico w explicitly in the following. The variations are bundled in tools.py and you can find the explanation under Run on different devices for details.
I have tested my solution for the ESP32/RP2 pico in different environments so far, including my own TRUMA/CPplus version. Most of the tests ran straight out of the box.
Please note that older versions of CPplus (e.g. C3.xx.xx) use a different protocol for communication with the inetbox. See the INIT menu <example given> on the CPplus to find the version numbers. Therefore, the data can be read but no commands can be set. If you still want to use the inetbox2mqtt, you can replace the CPplus with a newer one (e.g. C4.03.00). New CPplus can also control older TRUMA heaters (e.g. H5.xx.xx). Please note that other device types of the manufacturer use other control sequences. These are not currently supported. Several users have successfully taken this step, so the procedure can be recommended.
Please ensure that your tests are carried out with a clean electrical setup, preferably already in the proof of concept phase in a stable housing, in order to prevent short circuits or bad connections. Since the LIN connection has a plug, it is advisable to also realise the power supply via a plug. Most problems during realisation can be traced back to defective components due to short circuits or missing ground connections
Please note that this simulation only works on a CPplus to which NO Inetbox is connected. In particular, communication with a TRUMA INet X is not supported. TRUMA INet X is the successor of CPplus and contains inetbox functionalities
The LIN module for the ESP32/RP2 pico in the current version for the ESP32/RP2 pico w have proven to be very stable and CPplus-compatible. It's been going on for months now in various constellations.
Nevertheless, it should be mentioned here that I do not assume any liability or guarantee for its use.
The software is developed in micropython. After the first tests, I was amazed of how good and powerful the microPython.org platform is.
However, the software did not run with the latest stable kernel from July 2022 (among other things, the bytearray.hex was not implemented there yet). The latest kernels for various ports can be found in the download section. It is quite possible that the software can also run on other ports. If you have had this experience, please let us know. We can then amend the readme accordingly.
If you just want to get the inetbox2mqtt running on the RP2 pico w, this is the way to go.
For the simple 4M types of the ESP32-S this way does not work anymore. Here I ask you to use alternative 2.
The entire installation process should not take longer than 10 minutes. The installation does not have to take place in the final WLAN in which the inetbox2mqtt is to run later.
To do this, you first have to install an up to date microPython version, to be found at micropython/download. My tests were done with upython-version > 19.1-608.
You must enter the commands from the console line by line in the REPL interface. The last import command reloads the entire installation.
import network
st = network.WLAN(network.STA_IF)
st.active(True)
st.connect('<yourSSID>','<YourWifiPW>')
import mip
mip.install('github:mc0110/inetbox2mqtt/bootloader/main.py','/')
import main
The ESP32 with 4M memory does not have enough main storage in the standard micropython firmware to have all the software in memory. For this reason, some of the python modules have been precompiled and are already included in the firmware. Therefore, it is recommended to use the .bin file. Of course, all source files of the project are included, so that anyone can create the micropython firmware himself.
The .bin file contains both the python and the .py files. This allows the whole project to be flashed onto the ESP32 in one go. For this, you can use the esptool. In my case, it finds the serial port of the ESP32 automatically, but the port can also be specified. The ESP32 must be in programming mode (GPIO0 to GND at startup). The command to flash the complete .bin file to the ESP32 is:
esptool.py write_flash 0 flash_esp32_inetbox2mqtt_v265_4M.bin
Alternatively, you can also use the Adafruit online tool (of course only running with Chrome or Edge):
https://adafruit.github.io/Adafruit_WebSerial_ESPTool/
The offset 0x0 must then be entered here.
This is not a partition but the full image for the ESP32. The address 0x0 is not a typo.
There are two release numbers that must match, one in main.py and one in release.py. The update process looks at this and if the numbers are different, then the software is updated during the update.
We are very keen to support the application in the best possible way. Most of the changes were necessary to enable the realisation of a web frontend and the initial installation, the entry of the login data for Wifi connection and mqtt-broker and to test this connection and, from version 2.1.x, also to be able to test the LIN connection to CPplus. It is recommended as best practice to reinstall the application in the process if updating is also possible.
After rebooting the port (ESP32, RP2 pico w), an access point (ESP or PICO) is opened first. For the RP2 pico w, the password "password" is required. Please first establish a Wifi connection with the access point. Then you can access the chip in the browser at http://192.168.4.1 and enter the credentials. For details of the Wifimanager, please refer to mc0110/wifimanager.
We call this the OS mode -> i.e. an operating mode that is not the normal run mode but is necessary for tests and for entering the login data.
You have access to the entire file system with up, download and delete functions via a simple file manager.
You can also test the connectivity to the MQTT broker.
As of version 2.1.x, the LIN module - responsible for the TRUMA communication - is already fully executable in this mode. This is very helpful for debugging the electrical connection or for any adjustments.
In this mode, the TRUMA status elements can be queried about the overall status (see button STATUS) and the set command for the water heater (ON / OFF) can be set via buttons.
You can now also carry out the INIT process in this mode. Details are described below.
After entering the login credentials, the boot mode needs to be switched from "OS-Run" to "Normal-Run" to start full communication with the MQTT broker. Press on the "OS mode after reboot" button to toggle to the "Normal mode after reboot" state. (The button toggles between those two states and shows which mode will be started after the next reboot.)
After rebooting in "normal-run" mode, inetbox2mqtt is ready for use. If everything is correctly set up and the port is rebooted, it should connect to the MQTT broker with two confirmation messages.
For placing the files and creating the credentials on the port, it does not need to be connected to the CPplus. You can also swap between 2 different credential-files, e.g. you are working on your computer at home for configuring and then swap to the RV-credentials in your motorhome.
Now you can establish the connection between the port and the LIN bus.
The inetbox2mqtt must be registered once with the CPplus. This initialisation process is very important and without it the connection will not be established successfully.
Inetbox2mqtt must be in normal-run mode when you initialise the CPplus.
Let's have one further look at the INIT process:
Without inetbox2mqtt you find 2 entries in the INIT menu:
- TRUMA: Hx.00.nn
- CPplus: Cy.0z.00
To do this you have to select and confirm the menu item RESET in the CPplus menu and then also confirm the PR SET that appears. The display then shows a flickering INIT... -> example given.
If the INIT process was successful, then a third entry appears in the INIT menu for the inetbox
- TRUMA: Hx.00.nn
- CPplus: Cy.0z.00
- inetbox: T23.70.0
This process has to be carried out once, after which the connection can be terminated at any time and then resumed as long as no further INIT (RESET at CPplus) takes place.
Very, very important:
If you have already connected an inetbox to the CPplus, it is essential to carry out the INIT once without the inetbox. After that, there should only 2 entries be displayed. Then you can connect the inetbox2mqtt to perform another INIT.
The service/truma/control_status/# topics can be received. They include the current status of CPplus and TRUMA If your heater is off and you start with a set-command or with an input at the CPplus there is a delay of about 30sec before you'll see the first values. This is a normal behavior.
| Status Topic | Payload | Function |
|---|---|---|
| service/truma/control_status/# | subcribing all status-entries | |
| service/truma/control_status/alive | on/off | connection control |
| service/truma/control_status/clock | hh:mm | CPplus time |
| service/truma/control_status/release | x.y.z | release no |
| service/truma/control_status/current_temp_room | temperature in °C (0, 5-30°C) | show current room temperature |
| service/truma/control_status/target_temp_room | temperature in °C (0, 5-30°C) | show target room temperature |
| service/truma/control_status/current_temp_water | temperature in °C (0-70°C) | show current water temperature |
| service/truma/control_status/target_temp_water | temperature in °C (0-70°C) | show target water temperature |
| service/truma/control_status/energy_mix | gas, mix, electricity | heater mode of operation |
| service/truma/control_status/el_power_level | 0, 900, 1800 | heater electrical max. consumption |
| service/truma/control_status/heating_mode | off, eco, high | fan state |
| service/truma/control_status/aircon_operating_mode | off, vent, cool, hot, auto | aircon mode of operating |
| service/truma/control_status/aircon_vent_mode | low, mid, high, night, auto | aircon ventilator mode |
| service/truma/control_status/target_temp_aircon | temperature in °C (20 - 32°C) | show target aircon temp |
| service/truma/control_status/operating_status | 0 - 7 | TRUMA heater operation-mode (0,1 = off / 7 = running) |
| service/truma/control_status/error_code | 0-xx | TRUMA error codes |
| service/truma/control_status/release | xx.xx.xx | Software-Release-No |
If you want to set values, then you must use the corresponding set-topics. The list of set-topics and valid payloads can be found here.
| Set Topic | Payload | Function |
|---|---|---|
| service/truma/set/target_temp_room | temperature in °C (0, 5-30°C) | set target room temperature |
| service/truma/set/target_temp_water | 0, 40, 60, 200 | set target water temperature (= off, eco, high, boost) |
| service/truma/set/energy_mix | gas, mix, electricity | set mode of operation |
| service/truma/set/el_power_level | 0, 900, 1800 | set electrical max. consumption |
| service/truma/set/heating_mode | off, eco, high | set fan state (off only accepted, if room heater off) |
| service/truma/set/aircon_operating_mode | off, vent, cool, hot, auto | set aircon operating mode |
| service/truma/set/aircon_vent_mode | low, mid, high, night, auto | set aircon ventilation |
| service/truma/set/target_temp_aircon | temperature in °C (20-30°C) | set target aircon temperature |
| System commands | ||
| service/truma/set/reboot | 1 | reboot the port |
| service/truma/set/os_run | 1 | set mode OS-RUN |
| service/truma/set/ota_update | 1 | download current version from GITHUB, only recommended for RPI |
To switch on the room heating, target_temp_room > 4 and heating_mode = eco must be set together. For this purpose, the respective commands should be sent immediately after each other.
The same applies to energy_mix and el_power_level, which should be set together. Of course, only certain constellations of energy_mix and el_power_level make sense here if the heating has an electric and a combustion unit. The commands are the same for diesel and gas burners, by the way. Valid combinations are (gas-0, mix-900, mix-1800, electricity-900, electricity-1800).
For the Aventa aircon, only certain pairs of aircon_operating_mode and aircon_vent_mode payloads are possible (off-low, auto-auto, vent/cool/hot-low/mid/high).
The system commands are an extension of the command scope and allow restarting the port, changing the operating mode and updating the software status with the GITHUB release.
An example for a complete control system of a Smart Home solution can be found in the Docs - it shows the capability of bidirectional operation of Home Assistant. Bidirectional means that the values can be set in the CPplus display as well as in the Home Assistant frontend and are passed through in each case.
The operating mode is indicated by 2 GPIO outputs. This gives the option of displaying the current mode with 2 LEDs.
The LEDs are hardware-dependent and can be configured in tools.py.
'mqtt_led' indicates when the MQTT connection is up. 'lin_led' indicates when the connection to the CPplus is established.
The search for connection errors (e.g. missing LIN signal, swapping rx/tx, defective TJA 1020) can be very time-consuming and annoying. Therefore 'lin_led' has been supplemented to the extent that the LED already flickers slightly when signals are registered on the port rx line (equivalent is tx-output on the TJA 1020). This also happens before an CPplus INIT, in other words a registration of the inetbox2mqtt at the CPplus has taken place. In this way, it can be detected very quickly whether there are connection problems on the rx line. If the INIT process has taken place, the LED lights up brightly.
Attention: The CPplus does not transmit continuously, therefore transmission pauses of 15-25s are normal.
Another functionality has been added. This is an additional function, at the moment not implemented in INETBOX.
The status changes of two GPIO inputs (GPIO18 and GPIO19) and the GPIO outputs (GPIO22 and GPIO23) are now also published to the broker. The reaction time for status-changes is approx. 10s.
The associated topics are
- service/truma/control_center/duo_ctrl_gas_green
- service/truma/control_center/duo_ctrl_gas_red
- service/truma/control_center/duo_ctrl_i
- service/truma/control_center/duo_ctrl_ii
with the payloads ON/OFF. The outputs can be controlled with the SET commands
- service/truma/set/duo_ctrl_i
- service/truma/set/duo_ctrl_ii
Inputs and outputs are inverted, i.e. the inputs react with ON when connected to GND, the outputs switch to GND level when ON.
A second optional feature has been added. For leveling of an RV-car a MPU6050 IMU (inertial measurement unit) can be connected to the I2C bus.
Attention: The original version of this add-on used the GPIO00/01 for the I2C communication. Unfortunately, there is a conflict with the system UART (Tx=GPIO01). As a consequence, no debugging output was possible after initialising the I2C interface. It is important for all those who want to update to the current version that the pins for SDA and SCL have changed!
Different pins are required here:
For ESP32 please use I2C bus with SDA (GPIO26) and SCL (GPIO25). For RP2 pico w please use I2C bus 1 with SDA (GPIO02) and SCL (GPIO03).
Every 500ms the acceleration and gyroscopic values are read and combined and filtered by a Kalman-Filter. For the moment the result (pitch and roll angle) is published via MQTT every 10s.
The associated topics are
- service/spiritlevel/spirit_level_pitch
- service/spiritlevel/spirit_level_roll
Short digression: The CPplus only sends 0x18 (with parity it is 0xD8) requests if an INETBOX is registered. This can be recognised by the third entry in the index menu on the CPplus, among other things. The port answers these requests. Only when it receives 0x18 messages, the connection to the CPplus is established and the registration has taken place. This makes it easy to find out if there is an electrical problem. If the LED (GPIO14, see Status LEDs) is lit, communication with the CPplus is established. The port also outputs this as an "alive" topic via the MQTT connection (approx. every 60 sec): connection OK => payload: ON; connection not OK => payload: OFF.
To make it even easier to set up the INETBOX simulator together with the Home Assistant smarthome system, the auto-discovery function of home assistant is implemented.
After the port has connected to the MQTT broker, it sends the installation codes. If the Home Assistant server is also connected to the MQTT broker, the entities are all generated automatically. They all begin with 'truma_'. Since they are not persistent, this automatic generation also takes place when the Home Assistant server is restarted.
The Home Assistant's own MQTT broker, which is available as an add-on, can also be used. If you use other smart home systems, you can simply ignore the messages. In the docs, there is an example of a frontend solution in Home Assistant.
Micropython can be installed very easily on different ports (e.g. the RP2 pico W). Please use a current release (younger than 19.1 Oct.22) of Python here - analogous to the note for the ESP32. The installation is explained very well on the Foundation pages.
Fortunately, the entire inetbox2mqtt software also runs on the pico w chip. Please note, as mentioned above, that the UART uses different pins. There are now various boards with LIN-BUS controllers already integrated, but they require different pin assignments for UART and LEDs. In tools.py you will find the configuration for known and tested boards summarised in a static dict. It is only necessary to enter the name of the hw-config in arg.dat. For the RP2 pico W you need the entry:
hw=RP2
The software is based on the Github project INETBOX by Daniel Fett. Thanks to him, as well as the preliminary work of WoMoLIN, these cool projects have become possible.