==============================================================================
_____ __ _ _______ _
/ ____| / _| | |__ __| | |
| | ___ _ __ ___ | |_ ___ _ __| |_ | | ___ _ _ ___| |__
| | / _ \| '_ ` _ \| _/ _ \| '__| __|| |/ _ \| | | |/ __| '_ \
| |____| (_) | | | | | | || (_) | | | |_ | | (_) | |_| | (__| | | |
\_____|\___/|_| |_| |_|_| \___/|_| \__||_|\___/ \__,_|\___|_| |_|
______ _____ _ _____ _
|___ // ____| | |_ _| | |
/ /| | | | | | _ __ | |_ ___ _ __ ___ _ __
/ / | | | | | | | '_ \| __|/ _ \ '__/ _ \| '_ \
/ /__| |____| |____ _| |_| | | | |_| __/ | | (_) | |_) |
/_____|\_____|______| |_____|_| |_|\__|\___|_| \___/| .__/
_____ ______ _____ __ __ ______ | |
| __ \| ____| /\ | __ \| \/ | ____| |_|
| |__) | |__ / \ | | | | \ / | |__
| _ /| __| / /\ \ | | | | |\/| | __|
| | \ \| |____ / ____ \| |__| | | | | |____
|_| \_\______/_/ \_\_____/|_| |_|______|
CARRIER COMFORT TOUCH PCT HOME AUTOMATION INTEROPERABILITY DRIVER
==============================================================================
------------------------------------------------------------------------------
==============================================================================
LICENSE
=======
Copyright (c) 2009-2010 Digi International Inc., All Rights Reserved
This software contains proprietary and confidential information of Digi
International Inc. By accepting transfer of this copy, Recipient agrees
to retain this software in confidence, to prevent disclosure to others,
and to make no use of this software other than that for which it was
delivered. This is an published copyrighted work of Digi International
Inc. Except as permitted by federal law, 17 USC 117, copying is strictly
prohibited.
Restricted Rights Legend
Use, duplication, or disclosure by the Government is subject to
restrictions set forth in sub-paragraph (c)(1)(ii) of The Rights in
Technical Data and Computer Software clause at DFARS 252.227-7031 or
subparagraphs (c)(1) and (2) of the Commercial Computer Software -
Restricted Rights at 48 CFR 52.227-19, as applicable.
Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
0. CONTENTS
===========
1. ABOUT
2. REQUIREMENTS
3. INSTALLATION
4. TROUBLESHOOTING
5. REFERENCE DOCUMENTATION
1. ABOUT
=========
The ComfortTouch thermostat driver exposes properties of the Carrier
ComfortTouch thermostat through the ZigBee Cluster Library Thermostat
and Fan Control clusters.
The ComfortTouch thermostats do not natively support the Fan Control
and Thermostat clusters as defined in the ZigBee Cluster Library (ZCL)
specification. These thermostats do, however, expose Carrier's
manufacturer specific ComfortChoice command set. This driver creates a
virtual endpoint on ComfortTouch thermostats that maps Carrier's
manufacturer specific protocol to the ZCL Thermostat and Fan Control
clusters.
The addition of these two clusters allows access to the ComfortTouch
thermostat via Digi's Energy APIs.
2. REQUIREMENTS
===============
The ComfortTouch driver has been tested with the following devices.
Digi X2 Esp or Aux Gateway
.--------------------------.
1) SE Framework v1.3.0 or 1.3.1
2) Gateway radio firmware 0x3123
3) Gateway firmware 2.10.0.3
Carrier ComfortTouch Thermostat
.-------------------------------.
1) Software version: NTS01.14.11
3. INSTALLATION
===============
Option 1: Python Installation Script (requires Python 2.4+ or a
Windows machine)
Option 2: Manual Installation with iDigi
Option 3: Advanced Installation
Option 1: Python Installation Script
.------------------------------------.
REQUIREMENTS:
1) Python 2.4+
-- OR --
2) Windows XP or higher
INSTRUCTIONS:
There are two installer scripts provided in the install package
(product code: [![INSERT PRODUCT CODE HERE]!]). The first is a python
script named `install.py` and is found in the base directory. The
second is a windows executable (`install.exe`) found in the Windows
directory. Both scripts must be run from the command line as follows:
usage: %prog digi_url idigi_username idigi_password gateway_id
idigi_url The iDigi instance associated with the gateway where the
Comfort Touch driver will be installed.
idigi_username The username of the iDigi user who owns the gateway where the
ComfortTouchHA driver will be installed.
idigi_password The password for idigi_username.
gateway_id The last six digits of the MAC address of the gateway where the
driver will be installed.
Option 2: Manual Installation
.-----------------------------.
1) Upload ComfortTouchHA.zip (found in the base directory of the installation
package) to the gateway using iDigi.
a. Login to iDigi using your iDigi username and password.
b. Open the devices page by clicking the device link on the left-hand menu.
c. Double click on the target gateway. A device properties tab will open.
d. Under the device properties tab click `Python`.
e. Click the upload file icon (file icon with an up arrow).
f. Select ComfortTouchHA.zip from the installation directory.
g. Click OK.
2) Configure the gateway.
a. Open the web services console by clicking the `Web Services Console`
link on the left-hand menu.
b. Next to HTTP Method click the `POST` option.
c. Paste the following XML into the text box, replacing {{GATEWAY_ID}}
with the last six digits of the gateway's mac address (usually present
on the bottom of the gateway).
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
WEB/python/ComfortTouchHA.zip
comfort_choice_virtual_thermostat
comfort_choice_cluster
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
d. Click the send link at the top of the screen.
e. Wait 10 seconds.
f. Clear the text box.
g. Paste the following XML into the text box, replacing {{GATEWAY ID}}
with the last six digits of the gateway's mac address (usually present
on the bottom of the gateway).
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
ComfortChoiceMSPCluster
ComfortChoiceThermostatCluster_client
ComfortChoiceFanControlCluster_client
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
h. Click the send link at the top of the screen.
3) The ComfortTouch thermostat will now work with the Digi Energy
APIs. If you run into any difficulties after installation, look at
the TROUBLESHOOTING section of this readme.
Advanced Installation
.---------------------.
More advanced installers may create their own scripts for updating a gateway
with the ComfortTouch HA driver. The iDigi platform supports web interface
calls. All web service calls for installing the ComfortTouch HA driver
target the url `http://{{your idigi instance url}}/ws/sci` and use the HTTP
POST method. The iDigi web services are authenticated using basic http
authentication with the credentials associated with the iDigi account that
owns the target gateway.
1) Upload ComfortTouchHA.zip to the target gateway using the following
sci request where
{{GATEWAY ID}} is the last 6 digits of the target gateway's mac
address
{{BASE 64 ENCODED DATA}} is the ComfortTouchHA.zip file bytes
encoded using base 64 encoding
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
%s
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2) Configure the target gateway.
a. Send an sci request with the XML from Manual Install 1e.
b. Wait 10 seconds.
a. Send an sci request with the XML from Manual Install 1g.
TROUBLESHOOTING
===============
This section describes what to do once the installation has been complete
if Thermostat and Fan Control cluster attributes aren't exposed via the
Digi Energy APIs.
It is possible that these problems are the result of an unsuccessful or
incomplete installation of the ComfortTouchHA driver.
1) If you followed the manual or advanced installation instructions,
make sure that each step was followed closely.
2) Attempt rebooting the gateway by holding down the reset button on
the side of the gateway for 3 seconds. Wait 3 minutes. If this does
not resolve the issues continue to step 3.
3) In the networks section of iDigi, right click on the gateway the
ComfortTouchHA driver was installed on. Select `Rediscover (clear cache)`
and wait for the discovery process to complete.
4) If none of steps 1-3 solved the problem, contact Digi support.
RELATED DOCUMENTATION
=====================
Digi Products
.-------------.
1) iDigi User's guide
2) iDigi Web services programming guide
ZigBee Protocol
.---------------.
1) ZigBee Protocol Specification
2) ZigBee Cluster Library Specification
3) ZigBee Home Automation Public Application Profile