A ESP8266 devkit firmware for the Nodoshop version of the Opentherm Gateway (OTGW)
License: MIT License
Port to ESP32 compatible chips'.
Hello there,
I think that will be good, that possible to send a webhook, if one of the value (like CH ) is On/Off
For example, if we want to switch a external heating pump via Shelly relay on a different floor. Of course it possibe to do this with MQTT, but not sure that everybody install a broker and smart home center (like HA) that if only switch a pump...
I found some library that possible to use it, like:
I'm using default passwords generated by MQTT Broker integration in HomAssistant. Is there a chance to extend length of MQTT password to something like 96 characters?
Hello
I have managed to compile files and uploaded ESP8266 using Arduino IDE.
I can login into otgw.local. When I click PIC firmware nothing is displayed, and info “ No version found” at the bottom
When I click Device Info I can see data among which “Pic connected = false”
Hence I have uploaded PIC with getway.hex using otmonitor connected to OTGW gateway via FDDI/USB.
I have performed TEST#1(diagnoze.hex) with 4 LEDs connected to the PIC and they are flashing. I do not have boiler nor thermostat so can not do more tests,
I can connect from otmonitor to OTGW gateway via FDDI and send a command like AA=70 , I can see response.
However while otmonitor is connected to OTGW gateway via TCP/IP (port 25238), when send command AA=70, no response.
Seems like ESP8266 is not connected with PIC☹. Any hints on how/what to check would be welcome.
PS. I am able to connect to OTGW monitor via telnet as well but not sure what to debug?
it is possible to choose between a DS18B20 or a DHT22 on the GPIO connection. In addition to the temperature, you can also measure the humidity in the room. That would be great.
Hello there,
On NodeMCU, a lot of free GPIO is exist if we connect OTGW. I thinking that possible to integrate a relay module, that working pararel with CH state. This state basically is state of the boiler internal pump ON/OFF.
Or if we use two relay, it possible the do the same with H2 parameter.
The Reason is that lot of boiler not support official relay module (some yes, like Baxi) and in this case the people use pipe thermostat, to turn on/off floor heating external pump, or heating circle valve.
First: complements for your software. It is looking very nice.
Would it be possible to add a configurable NTP hostname?
Or use the gateway address if the NTP server is not reachable.
After a firewall NTP is not working now.
Right now 'output sensors' use the the GPIO Sensors Interval setting.
OTGW-firmware/OTGW-firmware.ino
Lines 38 to 39 in 05df1bd
Although probably not a real issue, this can cause strange/unexpected behavior.
I suggest to create a new interval var for the ouputs and remove the TODO line upon completion.
For integration with OpenHAB it would be great to have a "flexible" way of making unique a setting, to prevent a lot of configuration when changing out NodeMCU's.
After changing settings, I found out I have to reboot. Obviously, but is not mentioned. Maybe good suggestion?
Hi,
I have flash the Otgw with this version to interact with HomeAssistant.
I see in the MQTT broker a lot of traffic from the OTGW.
Is there an option to for example remove first the data points that are not available from the Opentherm data?
Hi,
I tried to send OTGW/command CS=52 but nothing happens on the OTGW side, can you explain how can we send commands via MQTT or API.
I tried to send a command from the OTMonitor and it appear in the log as sent but nothing happens, It's like the Nodemcu is not sending the commands.
Thanks
@rvdbreemen et. al., thanks a lot for your efforts on this nice project, much appreciated!
In the current setup values are published to the MQTT server at a pretty high frequency (multiple times/sec). This is nice for debugging, but puts quite some load on the system and is probably not really necessary for most users.
Would it be an idea to set a publishing interval on the data (e.g. every 30 secs) and maybe have a debugging mode for publishing values like otmessage?
Unrelated, but maybe of interest: there is an excellent and very mature project that has comparable functionality for the Bosch (and related brands like Nefit) EMS bus. It might be beneficial to talk to @proddy, the creator of that one to compare notes.
Hi,
I flash both files on the 0.7.0 release on my nodemcu, it flash it as expected with no error. Afterwards I see the OTGW node active and I set the wifi successfully. I can ping it on my network and it response. Then I tried to connect to the web UI via IP address to setup the Mqtt but it does not response, like the web server is not active. Am I doing something wrong?
Thanks
Thanks for again a upgrade, good work!
What I wonder is if it is necessary to always update mklittlefs while update OTGW-firmware.
I don't think so, only after updating to 0.7.2. Maybe you could mention that in the readme file.
This wil prevent need to download your settings, because updating mklittlefs loose your settings.
Thanks!
Would it be possible to add some control over the LEDs?
I have the Nodo OTGW in the clear case + NodeMCU. There are 3 LEDs that flash non-stop, one green one on the board and two blue ones on the MCU.
The green one isn't so bad but the two NodeMCU ones are pretty aggressive.
Perhaps some option to disable the flashing, or reduce the brightness or rate?
The software is working, I see the values in in the MQTT broker. About one thing i'm not clear, the webpages:
What can I do with the the web pages? The main pages shows 'Wait! retrieving local messages .....' The settings page shows noting. There is a setting.ini file created, but it only contains the host name. Only the 'FSexplorer ESP' works. Is that right?
When I set eg the room tempereature or the Outside temperature in a MQTT message, I see a command message appear in MQTT but it never is executed.
The release is use is: 0.8.4+f39b68a (02-05-2021)
The used message for publication is:
mosquitto_pub -t "OTGW/set/otgw-8CAAB5747B11/command" -m "TT= 18.5"
mosquitto_pub -t "OTGW/set/otgw-8CAAB5747B11/command" -m "OT= 17.5"
And this is what the debug produces:
[00:21:04][ 11520| 8120] checkOTGWcmd(1059): CmdQueue: Checking if command is in in queue [PR: O=T16.50] (12)
[00:21:04][ 11632| 8120] checkOTGWcmd(1070): CmdQueue: Checking [PR]==>[0]:[TT=18.5] from queue
[00:21:04][ 11632| 8120] checkOTGWcmd(1070): CmdQueue: Checking [PR]==>[1]:[OT= 17.5] from queue
[00:21:04][ 14376| 10064] handleOTGWqu(1019): CmdQueue: Checking due in queue slot[0]:[1264525]<[995158]
[00:21:04][ 13032| 10064] handleOTGWqu(1019): CmdQueue: Checking due in queue slot[1]:[1264525]<[1212508]
HI,
I am currently ordering the parts to build my own opentherm gateway, using this firmware.
I am however a little bit confused by the new board (v2.3) of nodoshop.
There it is mentioned the new board (2.3) runs with a WeMos D1 Mini, instead of the always mentioned NodeMCU on this page.
Is the current firmware (9.0) supported for the WeMos D1 mini, or should I still get the NodeMcu
to be clear we are talkingg about this: https://www.nodo-shop.nl/nl/home/213-wemos-d1-mini.html (which is recommended by them) or https://www.nodo-shop.nl/nl/home/189-nodemcu.html?search_query=nodemcu&results=2
many thanks in advance!
I have updated to latest git (self compiled) and tried latest release v0.6.1 download and i get the follwing javascript error:
on firefox:
Uncaught TypeError: document.getElementById(...) is null
bootsTrapMain http://192.168.1.151/index.js:37
EventHandlerNonNull* http://192.168.1.151/index.html:61
index.js:37:14
bootsTrapMain http://192.168.1.151/index.js:37
(Async: EventHandlerNonNull)
<anonymous> http://192.168.1.151/index.html:61
on chrome:
index.js:37 Uncaught TypeError: Cannot read property 'addEventListener' of null
at bootsTrapMain (index.js:37)
bootsTrapMain @ index.js:37
load (async)
(anonymous) @ (index):61
the page stays empty for the rest.
I checked that the version of the index.js is 0.6.1.
I re-uploaded the spiff.bin
I flashed latest version (0.8.1).
I decided to do a clean update, so erased the flash, flashed both files of the 0.8.1 using the command from the wiki.
Logged into wifi, configured wifi.
Rebooted and logged into web and configured mqtt and the others.
I can see the webinterface, under device info it indicates it is connected to mqtt.
I don't see anything published to mqtt, also otmonitor cannot connect ( connection refused).
I can connect to port 23, and I see messages going by.
This is device info:
Developer Robert van den Breemen
NodeMCU Firmware Version 0.8.1+92f10cb (14-03-2021)
OTGW PIC Firmware Version 4.2.5
Compiled on (date/time) Mar 14 2021 14:56:26
HostName OTGW
IP address 192.168.1.151
MAC address **
Free Heap Memory (bytes) 18328
Max. Free Memory (bytes) 16568
Unique Chip ID *****
Arduino Core Version 2_7_4
Espressif SDK Version 2.2.2-dev(38a443e)
CPU speed (MHz) 160
Sketch Size (bytes) 504.781
Free Sketch Space (bytes) 1540
Flash ID 00164020
Flash Chip Size (MB) 4
Real Flash Chip Size (MB) 4
LittleFSsize 2
Flash Chip Speed (MHz) 40
Flash Mode DIO
Board Type ESP8266_NODEMCU
Wifi Network (SSID) ***
Wifi Receive Power (dB) -55
MQTT Connected true
NTP Enable true
NTP Timezone Europe/Amsterdam
Uptime since boot 0(d)-00:03(H:m)
Last Reset Reason Power On
Nr. Reboots 3
I am a bit lost how to debug this.
Hi @rvdbreemen,
I recently purchased a OTGW (v2.0) and NodeMCU from Nodo Shop.
With firmware v0.4 from https://otgw.tclcode.com/download/otgwmcu.zip works fine.
When i use your firmware v0.8.5+dc3dc14, the NodeMCU resets every 10 seconds for about 15-30 minutes and eventually starts working and doesn't reset anymore. The PIC is on v5.1.
I've tried with the boiler and thermostat connected and disconnected, with the same result.
Without the NodeMCU the Gateway works fine and the boiler and thermostat can communicate.
When it resets, all 4 LEDs light up on the Gateway board (red/orange/green/green) for about half second.
When the NodeMCU resets, LED1 lights up for 1-3 seconds until WiFi gets connected, while LED2 stays lit until the NodeMCU resets again.
If i connect it via USB to my laptop it's working fine (disconnected from the gateway :D).
The last reset reason in the Web server is listed as: "External System".
It's like a watchdog resets it because of a software fault it detects.
I wasn't able to find any logs or a way to enable them.
I connected to it on port 23 but i don't get any output for the few seconds it is connected to WiFi.
The issue seems to be similar to #56.
Thanks in advance for your help.
Hi @rvdbreemen,
After an OTA upgrade from v0.8.5 to v0.9.0 the Web server became very slow.
After disabling MQTT it got fast again. Re-enabling MQTT makes it slow again.
I've downgraded from v0.9.0 to v0.8.6 and didn't see web server slowness anymore with MQTT enabled.
In v0.9.0 MQTT appears disconnected and in Mosquitto broker i see successful connection attempts and disconnections every few seconds.
I've also noticed that in v0.9.0 Board type changed from ESP8266_NODEMCU to ESP8266_NODEMCUUnknownboard
P.S. There's a typo as well, should be Thermostat instead of Thermostate.
Thanks in advance for your help in getting this issue solved. :)
I have 2 dallas temperature sensors connected to gpio10. After upgrading to 0.9.0 the sensors don't show in mqtt.
I downgraded the .ino file to 0.8.6 and there working again.
I'm trying to build with arduino-cli, which works fine after installing some libs which are not added as git submodules yet.
After building there is a /tmp/arduino-sketch-* folder, which contains the OTGW-firmware.bin.
But there is no OTGW-firmware.mklittlefs.bin file to be found, how can I build this file ?
Some details on how I setup and build with arduino-cli, which might be useful for the wiki.
I removed the esp8266 git submodule as I use the esp8266 url, just like in the arduino GUI.
# setup
git submodule sync --recursive
git submodule update --init --recursive --progress
arduino-cli config init --additional-urls https://arduino.esp8266.com/stable/package_esp8266com_index.json
arduino-cli core update-index
arduino-cli core install esp8266:esp8266
arduino-cli lib install acetime time
# build
arduino-cli compile --clean --fqbn esp8266:esp8266:d1_mini --libraries Arduino/libraries --verbose
Hi, I've got an issue with the settings page. It was working fine at first, but ever since I activated MQTT, it won't load anymore and is stuck on Loading..., any idea what's going on?
Tried brave and firefox, same result.
Currently using version 0.8.3. Previously I was able to send this request:
POST http://otgw.local/api/v1/otgw/command/CS=0
this would turn off boiler if nothing is using it.
Now it no longer works, I can send :
POST http://otgw.local/api/v1/otgw/command/CS=1
and it updates fine, but 0 is ignored.
Hello,
I would like to ask which NodeMcu`s pins are not used by OTGW software?
I want to use a free pin of NodeMcu (and add in the code) to turn on/off the water circulation pump
Revision 0.8.4+f39b68a (02-05-2021)
I post command (outside temperature) at a 1 minute interval through the command topic on MQTT. This works perfectly for about 18 days, after that the OTGW does not listen to the command topic anymore. Publishing it's own topics to the broker remains operational without issues. Sending commands through the network port with the opentherm gateway application also remains operational, so it appears to be in the MQTT handling.
After a reboot of the ESP all works well again.
It would be great to also support DS18B20 sensoren directly connected to the nodeMCU
-configure GPIO pin with connected OneWire sensors
-read out temp value (per connected sensor)
-sent (each) temp value over mqtt
With the default configuration of the nodo shop configuration, ESPEasy is supported. However ESPEasy doesn't allow other devices connected to the nodeMCU when it is configured to readout the OTGW connected PIC via serial interface. As next to the readings of the boiler via OTGW I also want to readout the temperatures of each underfloor heating group I currently need to place an extra ESP device only for this purpose. When possible I would like to combine both ESP purposes to one ESP configuration
Hello,
Is seems that the OTGW-firmware is a hour behind. Due to DST-setting?
I don't know where is get its time from, but all my other ESP's get the right time.
And the boiler time is also correct.
Thank you!
HI trying to upgrade the PIC trough the web interface, nothing happens and the telnet session displays this 👍
13:35:43][ 17304| 15968] upgradepic (1251): Action: upgrade gateway.hex 5.1
[13:35:43][ 16584| 15968] upgradepicno(1150): Start PIC upgrade now.
[13:35:53][ 18296| 16304] fwupgradedon(1165): Upgrade finished: Errorcode = 9 - 10 retries, 0 errors
[13:35:54][ 18296| 16304] resetOTGW ( 65): Received firmware version: [?] [4.3] (3)
[13:35:54][ 16952| 16304] resetOTGW ( 72): Current firmware version: 4.3
This is what the logs shows on a attempt to upgrade
What am i doing wrong, and how to fix it ?
Hi,
Is it possible to implement all known OpenTherm Data-ID's? I have a Brink Renovent Excellent 300 HRU/WTW which supports OpenTherm and the ability of parsing ventilation / heat-recovery Data-ID's would be nice.
Greetings,
STemplar
I'am using 0.8.2+095b077 (25-03-2021) but the values in the Web UI are still not updated.
For example: Room Temperature Setpoint is still 20.5°C, even if I see other values in Domoticz (using LAN interface) if I change the setpoint on the thermostat.
Is there a possibility to mark out all the MQTT topics you don't use/need?
E.g. my boiler does not support cooling, but OTGW Firmware does send out the MQTT messages:
> OTGW/value/otgw-ECFABC05B55B/cooling_enable
> OTGW/value/otgw-ECFABC05B55B/cooling
I tried to disable them in mqttha.cfg, but no succes
Thank you
Hi,
To update my gateway from a serial to a network connection I purchased a NodeMCU and flashed it according to the wiki. Unfortunately it immediately gets stuck in a boot loop. If I connect to the serial output it constantly outputs the following on a loop:
Booting....[0.9.0+21bea01 (06-11-2021)]
�$l�H2�xn�GW=R
[OTGW firmwa�O4d��GW=R
[OTGW firmwar
|4`,l$$p0t�W=R
[OTGW firmwar�O,`l$l`:iGW=R
[OTGW firmware�pYbfrzD>�GW=R
[OTGW firmware�O,hl,p�(GW=R
[OTGW firmware 0l�CGS{D>�
Htxv`lld$pt�W=R
[OTGW firmware 2$l��l,x�GW=R
[OTGW firmware t4`,l$$pt�W=R
[OTGW firmware -�$l�Hl$xo�GW=R
[OTGW firmware -t|4`,l$4b:IGW=R
[OTGW firmware - |4`,l$4b8IGW=R
[OTGW firmware - Nodoshop version]
Booting....[0.9.0+21bea01 (06-11-2021)]
Last reset reason: [External System]
Attempting to connect to WiFi network
Start Wifi ...
AutoConnect to: EO,`l$4b8�W=R
[OTGW firmware - N��`l$4b:IGW=R
[OTGW firmware - NoH�WAMME@>�GW=R
[OTGW firmware - No�l�Hl,HZGW=R
[OTGW firmware - NodHtxwamldH�t�W=R
The OTGW firmware lines are printed relatively slowly (1 line every ~500ms). Sometimes the Attempting to connect lines appear on a loop as well. It does not matter if the device is placed in the gateway or only connected to the USB. I tried the following things:
All produce the exact same behavior, which would lead me to the conclusion that I received a defective board. However If I flash an example program using the Arduino IDE, it works immediately.
Is there anything I can try? Did I do something wrong, or did I get a wrong version of the NodeMCU?
Please let me know if more info is needed. Thanks in advance!
Hello there, Now i use OTGW with espeasy + serial server. If i read correctly, this FW is able to get a more sophisticated method (send datas with MQTT)
It sound good to me!
But i would like to ask some questions.
My NodeMCU is work really strange with espeasy, when send data with ser2net, the board is not answering from the ping and the web interface is not accessable some sec. I think the reason that send to much data same time with the serial and it is to much the NodeMCU. i hope with your firmware is not happen bacuse with MQTT (like tasmota) i never experience this.
The Remeha boilers (and other brands too) can send fault and parameter codes to the thermostat. It is done by using the Transparent Slave Parameters. Only Thermostats of the same brand know which fault or parameter codes corresponds with a certain OEM fault code / (TSP) value.
A nice feature woult be being able to make a JSON-file with a crosstab which pairs the OpenTherm values and the corresponding description from the manuals.
Class 1: Control and Status Information
register 5 {flag8 u8} "Application-specific flags" (correponds with the Remeha E:xx fault codes.)
register 72 {flag8 u8} "Fault flags/code V/H"
register 73 {u16} "OEM diagnostic code V/H"
register 102 {flag8 u8} "Solar storage fault flags"
register 115 {u16} "OEM diagnostic code"
Class 2: Configuration Information
register 3 {flag8 u8} "Slave configuration"
register 74 {flag8 u8} "Configuration/memberid V/H"
register 103 {flag8 u8} "Solar storage config/memberid"
Class 6: Transparent Slave Parameters
register 11 {u8 u8} "TSP setting" (correponds with the Remeha Pxx parameter codes.)
register 89 {u8 u8} "TSP setting V/H"
register 106 {u8 u8} "TSP setting solar storage"
Class 7: Fault History Data
register 13 {u8 u8} "Fault buffer entry"
register 91 {u8 u8} "Fault buffer entry V/H"
register 108 {u8 u8} "Fault buffer entry solar storage"
Hello there,
Now is possible to set the MQTT server via UI and that is wonderful! But now, it only support a unencrypted connection. So if we would like to a secure connection a remote GW, need a relay server locally. (it will be a problem, if that is a weekend house and no any infrastructure, only internet connection)
So please, if possible, add a SSL option to you firmware.
Thanks!
Some examle:
https://github.com/flespi-software/ESP8266_mqtts
https://gist.github.com/eLement87/133cddc5bd0472daf5cb35a20bfd811e
Hi,
How can I configure OTGW settings using MQTT (especially room setpoint)? Retrieving values is working fine but how do I set them? If I publish something to, for instance, OTGW/TrSet nothing happens.
I am using home assistant, MQTT auto discovery works fine but it seems also here only sensors are added and nothing to actually control the thermostat or am I missing something?
Thanks!
Originally posted by @jaspersonneveldt in #28
Hi,
I did fill by MQTT Home Assistant prefix: domoticz.
when I fill it with domoticz/in some messages are not updated. What is right to do. I can’t use the otgw mqtt plug-in because I have an user and password.
anton
Is it possible to create an option to switch on/off the blinking of the bleu status led?
Thank you!
From soem reasons my wemos reatarts 2-3 times a day. There is no significant impact due to that an of course it is no surrprise that after restarting wemos it will lose data capured from OTGW but is it possible to have configurable routine that will execute set of predefined opentherm read commands so rather than wait for thermostat to do so values will be available after wemos restart. I can achive same setting soem commands in HA to be sent to Reat API however it woudl be nice to have such configurability and self "recovery" after restart.
I know other option could be to store latest values in memory however not sure it is best approach due to flash lifecycle in such case.
The state topics sent to home assistant discovery are hard coded, they should be set the to <topic prefix> variable
For example
Line 3 in 379e735
"state_topic": "OTGW/fault"
should be:
"state_topic": topic_prefix_variable +"/fault"
This is also true for the home assistant discovery topic. It defaults to homeassistant but a user has the option to change this. A config option/var should be available to set it.
Hello Robert,
Very good you're busy with the OTGW firmware. I've used it for two week with pleasure.
2 months ago I ran in some problems. I started when I wanted to upgrade the PIC to fw 5.1. I assumed I bricked the PIC as the Nodemcu works fine dismounted, but seems to reboot every 15 sec when mounted on the OTGW board. So first I sent the PIC to NODO and they were so kind to put fw 5.1 on it. But still no luck. Then I decided to buy a fresh OTGW board, which worked fine for 2 weeks with fw 5.1 and 0.8.3 running on homeassistant. But then it stopped again. And I have exact the same sympton as with the old board. Nodemcu of the board works fine. I put a FTDI cable on both boards and that seems also to work fine, when running OTmonitor. So the board with PIC seem okay. So then put the old fw on the Nodemcu (R147) and everything worked again, also mounted on the OTGW board. It looks like that something on the OTGW board triggers a reset. Is there a GPIO which has to be configured in the 0.8.3 firmware or something? I read on the tweakers forum someone with same issue but didn't see a solution in the thread.
NodeMCU Firmware Version0.8.3+2fa1f1f (05-04-2021)
OTGW PIC Firmware Version 5.1
Compiled on (date/time)Apr 5 2021 21:56:13
Already thanks for taking the time to read.
Edwin
Prevent unauthorised access to NodeMCU/OTGW
Hi Rvdbreemen,
Thanks for this project. I'm trying to connect the Bocsh Boiler and the HomeAssistant with this OTGW-firmware.
But I couldn't buy "the Nodoshop NodeMCU/ESP8266 version of the OpenTherm Gateway" from China. I'll diy an OT adapter and connect it to NodeMCU.
Could you help to share the connection info between the NodeMCU and OT adapter?
I just find below port definitions in OTGW-firmware.h.
#define I2CSCL D1
#define I2CSDA D2
#define BUTTON D3
#define PICRST D5
Thanks,
Laughing
Display messages as they come in (see otgwmcu)
Robert first of all great work on this software. Did you thought about expanding it with integration to Blynk ?
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.