Changes between Version 13 and Version 14 of WikiStart


Ignore:
Timestamp:
2014-01-12 21:01:37 (6 years ago)
Author:
nlrb
Comment:

Updates for version 1.0

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v13 v14  
    88 
    99== Supported features == 
    10 [[Image(Screenshot_04_Control.png, 50%, right)]] 
     10[[Image(Screenshot_10_Control.png, 50%, right)]] 
    1111 * Monitor !OpenTherm settings 
    1212   * !OpenTherm version 2.3 messages supported 
     
    7272 
    7373== Monitor screenshot (UI5) == 
    74 [[Image(Screenshot_04_Monitor.png)]]  
     74[[Image(Screenshot_10_Monitor.png)]]  
    7575 
    7676== Installation == 
     
    8383== Configuration == 
    8484=== Settings === 
    85 [[Image(Screenshot_04_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab. 
     85[[Image(Screenshot_10_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab. 
    8686* Communicate using UART - visible when connected via a serial interface 
    8787* Communicate using IP - visible when connected via an IP address 
     
    9393 
    9494=== Hardware === 
    95 [[Image(Screenshot_06_Hardware.png, 50%, right)]]The following settings are available in the 'Hardware' tab. 
     95[[Image(Screenshot_10_Hardware.png, 50%, right)]]The following settings are available in the 'Hardware' tab. 
    9696* Operating mode - Gateway or Monitor; this should be set to 'Gateway' for all functions to be available. 
    9797* Non-significant transitions - Select whether checking for error 01 is on or off 
     
    114114 
    115115== Usage == 
    116 [[Image(Screenshot_04_Device.png, right)]] 
     116[[Image(Screenshot_10_Device.png, right)]] 
    117117* 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'. 
    118118* Pressing the 'Heat' button will send a 'TC=' command, making the current setpoint constant instead of temporary. 
     
    122122 
    123123== Eco features == 
    124 [[Image(Screenshot_06_Eco.png, 50%, right)]] 
     124[[Image(Screenshot_10_Eco.png, 50%, right)]] 
    125125=== Default Eco options === 
    126126The following Eco options are activated when the Eco mode is selected. 
     
    141141 
    142142== Notifications == 
    143 [[Image(Screenshot_03_Notifications.png, 50%, right)]] 
     143[[Image(Screenshot_10_Notifications.png, 50%, right)]] 
    144144The following notifications are currently available. 
    145145* Central heating goes on or off 
     
    159159* !PluginLogPath - path to write log file to 
    160160* !PluginHaveChildren - empty: none; otherwise list of message IDs that will create a child device 
     161* !PluginEmbedChildren - 0: child devices are separate; 1: child devices are embedded 
    161162* !PluginMonitorBars - 0: none; 1: single color; 2: temperature relative 
     163* !PluginUpdateClock - 0: no; 1: only time; 2: date and time; 3: date, time and year 
    162164* !PluginOutsideSensor - empty: none; otherwise device ID of temperature sensor 
    163165* !PluginHumiditySensor - empty: none; otherwise device ID of humidity sensor 
    164166* !PluginEcoMeasureState - empty: none; otherwise a combination of [ADHW], [ATMP], [DTMP] 
    165167* !PluginPartitionDevice - empty: none; otherwise device ID of alarm partition device 
     168* PluginEcoDHW - 0: No; 1: disable; 2: automatic 
     169* !PluginEcoTemp - 0: no change; x: set to x degrees; -x: lower x degrees 
    166170* PluginArmedAwayDHW - 0: No; 1: disable; 2: automatic 
    167171* !PluginArmedAwayTemp - 0: no change; x: set to x degrees; -x: lower x degrees 
     
    172176 
    173177[[Image(Screenshot_04_ChildDevice.png, right)]] 
    174 Currently 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. 
     178All !OpenTherm 2.3 messages have associated variables in which the value is stored. 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. 
    175179* 1: !ControlSetpoint 
    176 * 5: !FaultCode 
     180* 2 (lb): !MasterMemberId 
     181* 3 (lb): !SlaveMemberId 
     182* 4: !RemoteCommand 
     183* 5 (lb): !FaultCode 
     184* 7: !CoolingControlSignal 
     185* 8: CH2ControlSetpoint 
    177186* 9: !RemoteOverrideRoomSetpoint 
     187* 10 (hb): TSPNumber 
     188* 11 (hb): TSPIndex; (lb): TSPValue 
     189* 12 (hb): FHBSize 
     190* 13 (hb): FHBIndex; (lb): FHBValue 
    178191* 14: !MaxRelativeModulationLevel 
     192* 15 (hb): !MaxBoilerCapacity; (lb): !MinModulationLevel 
    179193* 16: !CurrentSetpoint 
    180194* 17: !RelativeModulationLevel 
    181195* 18: CHWaterPressure 
     196* 19: DHWFlowRate 
     197* 20: !DayTime 
     198* 21: Date 
     199* 22: Year 
     200* 23: CH2CurrentSetpoint 
    182201* 24: !CurrentTemperature 
    183202* 25: !BoilerWaterTemperature 
     
    185204* 27: !OutsideTemperature 
    186205* 28: !ReturnWaterTemperature 
     206* 29: !SolarStorageTemperature 
     207* 30: !SolarCollectorTemperature 
     208* 31: CH2FlowTemperature 
    187209* 32: DHW2Temperature 
     210* 33: !BoilerExhaustTemperature 
     211* 48: DHWBounadries 
     212* 49: CHBoundaries 
     213* 50: OTCBoundaries 
    188214* 56: DHWSetpoint 
    189215* 57: MaxCHWaterSetpoint 
     216* 58: OTCHeatCurveRatio 
     217* 70: VHStatus 
     218* 71 (hb): VHControlSetpoint 
     219* 72 (lb): VHFaultCode 
     220* 73: VHDiagnosticCode 
     221* 74 (lb): VHMemberId 
     222* 75: VHOpenThermVersion 
     223* 76 (hb): VHProductType; (lb): VHProductVersion 
     224* 77: !RelativeVentilation 
     225* 78: !RelativeHumidity 
     226* 79: CO2Level 
     227* 80: !SupplyInletTemperature 
     228* 81: !SupplyOutletTemperature 
     229* 82: !ExhaustInletTemperature 
     230* 83: !ExhaustOutletTemperature 
     231* 84: !ExhaustFanSpeed 
     232* 85: !InletFanSpeed 
     233* 86: VHRemoteParameter 
     234* 87: !NominalVentilation 
     235* 88 (hb): VHTSPSize 
     236* 89 (hb): VHTSPIndex; (lb): VHTSPValue 
     237* 90 (hb): VHFHBSize 
     238* 91 (hb): VHFHBIndex; (lb): VHFHBValue 
    190239* 100: !RemoteOverrideFunction 
     240* 115: OEMDiagnosticCode 
     241* 116: !StartsBurner 
     242* 117: StartsCHPump 
     243* 118: StartsHDWPump 
     244* 119: StartsBurnerDHW 
     245* 120: !HoursBurner 
     246* 121: HoursCHPump 
     247* 122: HoursDHWPump 
     248* 123: HoursPumpDHW 
     249* 124: !MasterOpenThermVersion 
     250* 125: !SlaveOpenThermVersion 
     251* 126 (hb): !MasterProductType; (lb): !MasterProductVersion 
     252* 127 (hb): !SlaveProductType; (lb): !SlaveProductVersion 
    191253 
    192254=== Gateway === 
     
    203265* StatusOTCActive - Outside temp. comp. active 
    204266* StatusCH2Enabled - Central heating 2 enable 
     267* !StatusSummerWinter - Summer/winter mode 
     268* StatusDHWBlocked - Domestic hot water blocking 
    205269* !StatusFault - Fault indication 
    206270* StatusCHMode - Central heating mode 
     
    210274* StatusCH2Mode - Central heating 2 mode 
    211275* !StatusDiagnostic - Diagnostic indication 
    212 ==== Config flag variables ==== 
     276==== Master Config flag variables ==== 
     277* !ConfigSmartPower - Smart power present 
     278==== Slave Config flag variables ==== 
    213279* ConfigDHWpresent - Domestic hot water present 
    214280* !ConfigControlType - Control type (modulating on/off) 
     
    217283* !ConfigMasterPump - Master low-off & pump control allowed 
    218284* ConfigCH2 - Central heating 2 present 
    219  
    220285==== Fault flag variables ==== 
    221  
    222286* !FaultServiceRequest - Service request 
    223287* !FaultLockoutReset - Lockout-reset 
     
    226290* !FaultAirPress - Air pressure fault 
    227291* !FaultOverTemp - Water over-temperature 
     292==== Remote flag variables ==== 
     293* RemoteDHWEnabled - DHW setpoint enable 
     294* RemoteMaxCHEnabled - Max. CH setpoint enable 
     295* RemoteDHWReadWrite - DHW setpoint read/write 
     296* RemoteMaxCHReadWrite - Max. CH setpoint read/write