| 3 | | Trac is a '''minimalistic''' approach to '''web-based''' management of |
| 4 | | '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress. |
| | 4 | == Supported features == |
| | 5 | [[Image(Screenshot_03_Control.png, 50%, right)]] |
| | 6 | * Monitor !OpenTherm settings |
| | 7 | * !OpenTherm version 2.2 messages supported |
| | 8 | * Thermostat control in Gateway mode |
| | 9 | * Override room temperature setpoint |
| | 10 | * Get outside temparture from Vera sensor |
| | 11 | * Show firmware version of the Gateway |
| | 12 | * Send date and time command |
| | 13 | * Send free command |
| | 14 | * Monitor protocol errors (and reset error count) |
| | 15 | * Change Gateway configuration through the plugin |
| | 16 | * Send notifications on boiler events |
| 6 | | All aspects of Trac have been designed with the single goal to |
| 7 | | '''help developers write great software''' while '''staying out of the way''' |
| 8 | | and imposing as little as possible on a team's established process and |
| 9 | | culture. |
| | 18 | == Version history == |
| | 19 | * 0.1 September 27, 2013 |
| | 20 | * initial version |
| | 21 | * 0.2 September 28, 2013 |
| | 22 | * monitoring of Gateway |
| | 23 | * control outside temperature value |
| | 24 | * send TT and TC commands |
| | 25 | * 0.3 October 5, 2013 |
| | 26 | * added sending of free format commands |
| | 27 | * get/update configuration of the gateway |
| | 28 | * added extra values to display |
| | 29 | * added error counters to display |
| | 30 | * display firmware version |
| | 31 | * Send date/time or free format command |
| | 32 | * Full support of all !OpenTherm messages |
| | 33 | * Separate variables for hb/lb possible |
| | 34 | * Made variable names more consistent |
| | 35 | * Updated monitor display (e.g. bold on value change) |
| | 36 | * Added notifications |
| 22 | | You can use [wiki:TracAdmin trac-admin] to configure |
| 23 | | [http://trac.edgewall.org/ Trac] to better fit your project, especially in |
| 24 | | regard to ''components'', ''versions'' and ''milestones''. |
| | 48 | == Configuration == |
| | 49 | [[Image(Screenshot_03_Settings.png, 50%, right)]]The following settings are available in the 'Settings' tab. |
| | 50 | * '''Plugin options''' |
| | 51 | * Communicate using UART - visible when connected via a serial interface |
| | 52 | * Communicate using IP - visible when connected via an IP address |
| | 53 | * Generate debug logging & files - when 'On' will generate logging in the LuaUPnP.log file and will create an otg_msg.txt file |
| | 54 | * Outside temperature sensor - select an temperature sensor to use for the OT= command; temperature updates will be sent to the Gateway |
| | 55 | * '''Gateway configuration''' |
| | 56 | * Operating mode |
| | 57 | * Domestic hot water enable |
| | 58 | * Non-significant transitions |
| | 59 | * Reference voltage |
| | 60 | * LED A-D function |
| 27 | | TracGuide is a good place to start. |
| | 74 | == Variables == |
| | 75 | === Plugin === |
| | 76 | * !PluginVersion - version number of the plugin |
| | 77 | * !PluginDebug - 0: debug off; 1: debug on |
| | 78 | * !LogPath - path to write log file to |
| | 79 | * !GatewayMode - 0: Monitor; 1: Gateway |
| | 80 | * !CommandResponse - contains the response of a free format command |
| | 81 | === Gateway === |
| | 82 | * Errors - contains comma separated list of Error 01 - Error 04 |
| | 83 | === !OpenTherm === |
| | 84 | Flag variables (status, config, fault) are always either 0 or 1. |
| | 85 | ==== Status variables ==== |
| | 86 | * StatusCHEnabled - Central heating enable |
| | 87 | * StatusCHEnabled- Central heating enable |
| | 88 | * StatusDHWEnabled - Domestic hot water enable |
| | 89 | * !StatusCoolEnabled - Cooling enable |
| | 90 | * StatusOTCActive - Outside temp. comp. active |
| | 91 | * StatusCH2Enabled - Central heating 2 enable |
| | 92 | * !StatusFault - Fault indication |
| | 93 | * StatusCHMode - Central heating mode |
| | 94 | * StatusDHWMode - Domestic hot water mode |
| | 95 | * !StatusFlame - Flame status |
| | 96 | * !StatusCooling - Cooling status |
| | 97 | * StatusCH2Mode - Central heating 2 mode |
| | 98 | * !StatusDiagnostic - Diagnostic indication |
| | 99 | ==== Config flag variables ==== |
| | 100 | * ConfigDHWpresent - Domestic hot water present |
| | 101 | * !ConfigControlType - Control type (modulating on/off) |
| | 102 | * !ConfigCooling - Cooling supported |
| | 103 | * ConfigDHW - Domestic hot water storage tank |
| | 104 | * !ConfigMasterPump - Master low-off & pump control allowed |
| | 105 | * ConfigCH2 - Central heating 2 present |
| 32 | | == Starting Points == |
| 33 | | |
| 34 | | * TracGuide -- Built-in Documentation |
| 35 | | * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project |
| 36 | | * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions |
| 37 | | * TracSupport -- Trac Support |
| 38 | | |
| 39 | | For a complete list of local wiki pages, see TitleIndex. |
| | 109 | * !FaultServiceRequest - Service request |
| | 110 | * !FaultLockoutReset - Lockout-reset |
| | 111 | * !FaultLowWaterPress - Low water pressure |
| | 112 | * !FaultGasFlame - Gas/flame fault |
| | 113 | * !FaultAirPress - Air pressure fault |
| | 114 | * !FaultOverTemp - Water over-temperature |
