= The !OpenTherm Gateway plugin for Vera =
[[PageOutline]][[Image(OpenThermGatewayPlugin.png)]]

== Supported features ==
[[Image(Screenshot_03_Control.png, 50%, right)]]
 * Monitor !OpenTherm settings
   * !OpenTherm version 2.2 messages supported
 * Thermostat control in Gateway mode
 * Override room temperature setpoint
 * Get outside temparture from Vera sensor
 * Show firmware version of the Gateway
 * Send date and time command
 * Send free command
 * Monitor protocol errors (and reset error count)
 * Change Gateway configuration through the plugin
 * Send notifications on boiler events

== Version history ==
* 0.1 September 27, 2013
  * initial version
* 0.2 September 28, 2013
  * monitoring of Gateway
  * control outside temperature value
  * send TT and TC commands
* 0.3 October 5, 2013
  * added sending of free format commands
  * get/update configuration of the gateway
  * added extra values to display
  * added error counters to display
  * display firmware version
  * Send date/time or free format command
  * Full support of all !OpenTherm messages
  * Separate variables for hb/lb possible
  * Made variable names more consistent
  * Updated monitor display (e.g. bold on value change)
  * Added notifications

== Monitor screenshot (UI5) ==
[[Image(Screenshot_03_Monitor.png)]] 

== Installation ==
* Go to Apps -> Develop Apps -> Create device
* Fill out 'D_OpenThermGateway.xml' under 'Upnp Device Filename'
* Fill out the IP address or select the serial parent device
* Press 'Create'
* Press 'Reload'

== Configuration ==
[[Image(Screenshot_03_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab.
* '''Plugin options'''
  * Communicate using UART - visible when connected via a serial interface
  * Communicate using IP - visible when connected via an IP address
  * Generate debug logging & files - when 'On' will generate logging in the LuaUPnP.log file and will create an otg_msg.txt file
  * Outside temperature sensor - select an temperature sensor to use for the OT= command; temperature updates will be sent to the Gateway
* '''Gateway configuration'''
  * Operating mode
  * Domestic hot water enable
  * Non-significant transitions
  * Reference voltage
  * LED A-D function

== Usage ==
[[Image(Screenshot_03_Device.png, right)]]
* Changing a temperature setpoint in the UI will send a 'TT=' command to the Gateway. The Gateway will use this to force a 'Remote override room setpoint'.
* Pressing the 'Heat' button will send a 'TC=' command, making the current setpoint constant instead of temporary.
* Pressing the 'Off' button will remove the remote override room setpoint, by sending a TT=0 command.

Please note that the display will show a decimal value, but Vera can only handle integer values (i.e. you can only set the Thermostat to 21°C in the UI and not to 21.5°C. You can set a value of e.g. 21.34°C via the function '!SetCurrentSetpoint'.
== Notifications ==
[[Image(Screenshot_03_Notifications.png, 50%, right)]]
The following notifications are currently available.
* Central heating goes on or off
* Domestic hot water goes on or off
* Cooling goes on or off
* Central heating 2nd circuit goes on or off
* Flame goes on or off
* Fault indication
* Diagnostic indication
* Ambient temperature goes above
* Ambient temperature goes below

== Variables ==
=== Plugin ===
* !PluginVersion - version number of the plugin
* !PluginDebug - 0: debug off; 1: debug on
* !LogPath - path to write log file to
* !GatewayMode - 0: Monitor; 1: Gateway
* !CommandResponse - contains the response of a free format command
=== Gateway ===
* Errors - contains comma separated list of Error 01 - Error 04
=== !OpenTherm ===
Flag variables (status, config, fault) are always either 0 or 1.
==== Status variables ====
* StatusCHEnabled - Central heating enable
* StatusCHEnabled- Central heating enable
* StatusDHWEnabled - Domestic hot water enable
* !StatusCoolEnabled - Cooling enable
* StatusOTCActive - Outside temp. comp. active
* StatusCH2Enabled - Central heating 2 enable
* !StatusFault - Fault indication
* StatusCHMode - Central heating mode
* StatusDHWMode - Domestic hot water mode
* !StatusFlame - Flame status
* !StatusCooling - Cooling status
* StatusCH2Mode - Central heating 2 mode
* !StatusDiagnostic - Diagnostic indication
==== Config flag variables ====
* ConfigDHWpresent - Domestic hot water present
* !ConfigControlType - Control type (modulating on/off)
* !ConfigCooling - Cooling supported
* ConfigDHW - Domestic hot water storage tank
* !ConfigMasterPump - Master low-off & pump control allowed
* ConfigCH2 - Central heating 2 present

==== Fault flag variables ====

* !FaultServiceRequest - Service request
* !FaultLockoutReset - Lockout-reset
* !FaultLowWaterPress - Low water pressure
* !FaultGasFlame - Gas/flame fault
* !FaultAirPress - Air pressure fault
* !FaultOverTemp - Water over-temperature