Changes between Version 9 and Version 10 of WikiStart


Ignore:
Timestamp:
2013-10-31 22:01:40 (11 years ago)
Author:
nlrb
Comment:

Updated for v0.4

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v9 v10  
    22[[PageOutline]][[Image(OpenThermGatewayPlugin.png)]] 
    33\\ 
     4\\ 
    45Vera plugin to control the !OpenTherm Gateway (see http://otgw.tclcode.com/) designed by Schelte Bron. 
    56Discussion on the hardware and firmware can be found on http://www.domoticaforum.eu/viewforum.php?f=75. The !OpenTherm Gateway hardware can be ordered via http://www.opentherm-gateway.com/. 
     7\\ 
    68 
    79== Supported features == 
    8 [[Image(Screenshot_03_Control.png, 50%, right)]] 
     10[[Image(Screenshot_04_Control.png, 50%, right)]] 
    911 * Monitor !OpenTherm settings 
    1012   * !OpenTherm version 2.3 messages supported 
     
    5759 
    5860== Monitor screenshot (UI5) == 
    59 [[Image(Screenshot_03_Monitor.png)]]  
     61[[Image(Screenshot_04_Monitor.png)]]  
    6062 
    6163== Installation == 
     
    6769 
    6870== Configuration == 
    69 [[Image(Screenshot_03_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab. 
    70 * '''Plugin options''' 
    71   * Communicate using UART - visible when connected via a serial interface 
    72   * Communicate using IP - visible when connected via an IP address 
    73   * Generate debug logging & files - when 'On' will generate logging in the LuaUPnP.log file and will create an otg_msg.txt file 
    74   * Outside temperature sensor - select an temperature sensor to use for the OT= command; temperature updates will be sent to the Gateway 
    75 * '''Gateway configuration''' 
    76   * Operating mode 
    77   * Domestic hot water enable 
    78   * Non-significant transitions 
    79   * Reference voltage 
    80   * LED A-D function 
     71=== Settings === 
     72[[Image(Screenshot_04_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab. 
     73* Communicate using UART - visible when connected via a serial interface 
     74* Communicate using IP - visible when connected via an IP address 
     75* Generate debug logging & files - select whether messages are logged in otg_msg.txt file and the logging level in the LuaUPnP.log file 
     76* Outside temperature sensor - select an temperature sensor to use for the OT= command; temperature updates will be sent to the Gateway 
     77* Humidity room sensor - select a humidity device to have the value displayed on the thermostat (if the thermostat supports ventilation control; value will be sent via SR=78: command) 
     78* Use child device for temperature - select which messages will create a child device (only temperaturevalues are supported) 
     79* Show monitor bar indicator - Select what type (or none) indicator bar will be used in the monitor tab 
     80 
     81=== Hardware === 
     82[[Image(Screenshot_04_Hardware.png, 50%, right)]]The following settings are available in the 'Hardware' tab. 
     83* Operating mode - Gateway or Monitor; this should be set to 'Gateway' for all functions to be available. 
     84* Non-significant transitions - Select whether checking for error 01 is on or off 
     85* Reference voltage - Select the reference voltage setting (reference voltage is used as a threshold for the comparators) 
     86* LED A-D or A-F function (A-F as of firmware 4) - Select a function for each LED on the Gateway 
     87  * Receiving an Opentherm message from the thermostat or boiler 
     88  * Transmitting an Opentherm message to the thermostat or boiler 
     89  * Transmitting or receiving a message on the master interface 
     90  * Transmitting or receiving a message on the slave interface 
     91  * Remote setpoint override is active 
     92  * Flame is on 
     93  * Central heating is on 
     94  * Hot water is on 
     95  * Comfort mode (Domestic Hot Water Enable) is on 
     96  * Transmission error has been detected 
     97  * Boiler requires maintenance 
     98  * Thermostat requests a raised power level (firmware 4 only) 
    8199 
    82100== Usage == 
    83 [[Image(Screenshot_03_Device.png, right)]] 
     101[[Image(Screenshot_04_Device.png, right)]] 
    84102* 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'. 
    85103* Pressing the 'Heat' button will send a 'TC=' command, making the current setpoint constant instead of temporary. 
     
    104122* !PluginVersion - version number of the plugin 
    105123* !PluginDebug - 0: debug off; 1: debug on 
    106 * !LogPath - path to write log file to 
     124* !PluginLogPath - path to write log file to 
     125* !PluginHaveChildren - empty: none; otherwise list of message IDs that will create a child device 
     126* !PluginMonitorBars - 0: none; 1: single color; 2: temperature relative 
     127* !PluginOutsideSensor - empty: none; otherwise device ID of temperature sensor 
     128* !PluginHumiditySensor - empty: none; otherwise device ID of humidity sensor 
     129* !PluginEcoMeasureState - empty: none; otherwise a combination of [ADHW], [ATMP], [DTMP] 
     130* !PluginPartitionDevice - empty: none; otherwise device ID of alarm partition device 
     131* PluginArmedAwayDHW - 0: No; 1: disable; 2: automatic 
     132* !PluginArmedAwayTemp - 0: no change; x: set to x degrees; -x: lower x degrees 
     133* !PluginDoorWindowDevices - empty: none; otherwise comma separated list of door device ID 
     134* !PluginDoorWindowTemp - 0: no change; x: set to x degrees; -x: lower x degrees 
     135* !PluginDoorWindowMinutes - number of minutes to wait before evaluating conditions 
     136* !PluginDoorWindowOutside - 0: ignore; 1: needs to be colder outside than inside 
     137 
     138[[Image(Screenshot_04_ChildDevice.png, right)]] 
     139Currently not all !OpenTherm messages have associated variables in which the value is stored. The following messages do. If a child device is created, then the value is written to the Gateway variable as well as the '!CurrentTemperature' variable of the child device. 
     140* 1: !ControlSetpoint 
     141* 5: !FaultCode 
     142* 9: !RemoteOverrideRoomSetpoint 
     143* 14: !MaxRelativeModulationLevel 
     144* 16: !CurrentSetpoint 
     145* 17: !RelativeModulationLevel 
     146* 18: CHWaterPressure 
     147* 24: !CurrentTemperature 
     148* 25: !BoilerWaterTemperature 
     149* 26: DHWTemperature 
     150* 27: !OutsideTemperature 
     151* 28: !ReturnWaterTemperature 
     152* 32: DHW2Temperature 
     153* 56: DHWSetpoint 
     154* 57: MaxCHWaterSetpoint 
     155* 100: !RemoteOverrideFunction 
     156 
     157=== Gateway === 
    107158* !GatewayMode - 0: Monitor; 1: Gateway 
    108159* !CommandResponse - contains the response of a free format command 
    109 === Gateway === 
    110160* Errors - contains comma separated list of Error 01 - Error 04 
    111161=== !OpenTherm ===