OpenTherm Gateway Plugin for HomeSeer HS4 Manual Introduction Thank you for using the OpenTherm Gateway Plugin for HS4! This plugin can be used to communicate with an OpenTherm Gateway (OTGW). OTGW is an open source gateway by Schelte Bron that you can build yourself (or buy from a few webshops) and connect in between your OpenTherm thermostat and boiler or compatible devices. Please see Requirements for more info. Please note that, despite its name, the OpenTherm protocol is not an open standard.
Installation/Configuration 1. Install and activate the plugin like any other plugin. If you’re new to HS4, here is how: • Go to your HomeSeer Web Control page. • Use the Plugin dropdown and choose Add. • Use the (2nd) Search bar, or scroll to OTGW Plugin. • Choose Install. • In Plugins > Installed use the toggle to turn on the plugin. 2. Configure: • Go to Plugins > OTGW Plugin > Add OpenTherm Gateway. • Follow the steps: o Choose Continue at the introduction step. o Enter the IPv4 address of the OTGW.
Devices and Features There are quite a lot of (feature) devices being created. This chapter gives you more information on them. Given the amount of possible features it’s not really doable to list them all. But here is some general information. Features that are related to an OpenTherm MsgID Most features have a MsgID reference. This is the ID which is used in the OpenTherm protocol. These IDs carry different information. All of these are converted to feature values. • Byte values from -127..128 or 0..255.
• • • • • Each Error feature has a button to reset the feature value to 0 (It’s not sent to the OTGW). Gateway State. The state can be Unknown (if the state has not been changed through the plugin yet), Monitor Mode, or Gateway Mode. The feature has buttons to send commands Monitor Mode (GW=0), Gateway Mode (GW=1) or Reset the OTGW (GW=R). See: https://otgw.tclcode.com/firmware.html#cmdgw Status will be updated after the OTGW has sent corresponding response (GW: 0 or GW: 1).
Sending a Command While some features have buttons to send commands, I decided to not create a feature for every possible command. Mainly to keep the number of features to a minimum (kind of), but mostly because not every OpenTherm device supports every command and some commands are only available on an OTGW with a certain type of PIC or a certain firmware version. These features would be not be useful for everybody. Besides, some commands have to be used with care.
Modifying a Gateway To modify the IP address, port and/or name of a previously added OTGW you can use the Modify OpenTherm Gateway page as follows: • Go to Plugins > OTGW Plugin > Modify OpenTherm Gateway. • Follow the steps: o Choose Continue at the introduction step. o Pick the OTGW you want to modify from the dropdown. Choose Continue. o Modify the IPv4 address of the OTGW, if needed. Choose Continue. o Modify the port number that goes with that IP address, if needed. Choose Continue.
Serial Connection Although this plugin does not natively support using a serial connection (USB/COM/TTY), there are ways to connect an OTGW that has no LAN/Wi-Fi yet: 1. Use a free COM/TTY port to IP address redirector to connect. They can easily be found through an internet search engine. 2. Use Schelte Bron’s Opentherm Monitor to connect via serial port (Options > Connection > Serial port. Set the radio button and choose the Serial device).
Support If you have a question about this plugin or want to report a bug, please use the dedicated sub-forum on https://forums.homeseer.com/ Everything about the OTGW can be found here: https://otgw.tclcode.com/ And a forum about the OTGW, where the creator is present as moderator: https://domoticaforum.eu/viewforum.php?f=75 Changelog Version 1.0.5.0 1.0.4.0 1.0.3.0 1.0.2.0 1.0.1.0 1.0.0.0 Remark Fixed Log flooding and HS4 slowdown when OT message is empty/null (usually when another client connects).
