==============================================================================
_____ _ _ _____ _____ _____
| | ___ _____ ___ _ _ | |_ |_| _____ ___ | _ || ||_ _|
| --|| . || || . || | || _|| || || -_| | __|| --| | |
|_____||___||_|_|_|| _||___||_| |_||_|_|_||___| |__| |_____| |_|
|_|
_____ _ _____ _____ ____ _____
| _ | _ _ | |_ ___ | || || \ | __|
| || | || _|| . | | | | || | || | || __|
|__|__||___||_| |___| |_|_|_||_____||____/ |_____|
_____ _____ _____ ____ _____ _____
| __ || __|| _ || \ | || __|
| -|| __|| || | || | | || __|
|__|__||_____||__|__||____/ |_|_|_||_____|
COMPUTIME PCT AUTO MODE DRIVER README
==============================================================================
------------------------------------------------------------------------------
==============================================================================
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 CTW218HA thermostat driver makes Computime CTW218 thermostats
interoperable with the ZigBee Cluster Library Thermostat cluster. It
also provides interoperability with version 1.0 of the Energy Day
Trader application.
Thermostat cluster details
.--------------------------.
Although the CTW218 already supports the Thermostat cluster (0x0201),
it does not support a full auto mode. Auto mode is required for
thermostats that have both heating and cooling system modes. The
driver simulates an auto mode on the gateway itself that makes the
thermostat behave as if it did have an auto mode.
Energy Day Trader interoperability details
.------------------------------------------.
The iPhone Energy Day Trader application only interacts with
thermostat clusters on endpoints with the Home Automation profile
(0x0104). The Computime CTW218 puts its Thermostat cluster on an
endpoint with the smart energy profile. The driver provides a work
around that makes the thermostat clusters appear as if they are on a
home automation endpoint, so that Energy Day Trader users will be able
to interact with them.
2. REQUIREMENTS
===============
Gateway Requirements
.--------------------.
1) SE Framework v1.3.0 or 1.3.1
2) Gateway radio firmware v[![INSERT TESTED RADIO FIRMWARE]!]
3) Gateway firmware v[![INSERT TESTED GATEWAY FIRMWARE]!]
Thermostat Requirements
.-----------------------.
1) Computime CTW218 thermostat
2) Firmware version: CTW2181-V1.0506
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
Computime driver will be installed.
idigi_username The username of the iDigi user who owns the gateway where the
CTW218HA 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 CTW218HA.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 CTW218HA.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/CTW218HA.zip
computime_ha_endpoint
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
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).
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
EnergateVirtualHAThermostatEndpoint
0x12
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
h. Click the send link at the top of the screen.
3) The Computime CTW218 is now ready to work with the Energy Day Trader mobile
app. 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 Z100 Home Automation driver. The iDigi platform supports web interface
calls. All web service calls for installing the Z100 Home Automation 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 Z100HA.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 and
{{BASE 64 ENCODED DATA}} is the Z100HA.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 the CTW218 doesn't function as expected. This could mean:
1) The CTW218 does not function properly in the Energy Day Trader mobile app.
a. The CTW218 does not show up a thermostat device.
b. The Day Trader application does not display the current temperature,
current setpoints, ... etc. of the CTW218.
c. The Day Trader application does not allow modification of the current
temperature, current setpoints, ... etc. of the CTW218.
2) The Thermostat Cluster and/or Fan Control cluster attributes of the CTW218
are not present in the iDigi Energy APIs.
Resolving issues with the Energy Day Trader Application
.-------------------------------------------------------.
Problems using the CTW218 with the Energy Day Trader Application might be
solved using the following suggestions.
1) An issue with the internet connection may be causing the problem.
Solution: Make sure the device running the Energy Day Trader Mobile app is
connected to the internet.
2) The list of devices in the Energy Day Trader is being cached, so updates
to the CTW218 aren't being propogated to the device.
Solution: Clear the device cache. In the device list portion of the
application, push the refresh button at the bottom of screen.
3) The CTW218 driver installation did not complete successfully. To verify
that this is the issue, click on the CTW218 device in the device list
on the Energy Day Trader Application. Click the `identify` button in the
bottom center of the screen.
a. If the [![INSERT COLOR OF LIGHT]!] light on the top of the CTW218 turns
on, then it is likely that the CTW218 driver installation did not
complete successfully.
Continue to `further troubleshooting`.
b. If the light does not turn on, some other problem exists.
Contact Digi support.
Further troubleshooting
.-----------------------.
It is possible that these problems are the result of an unsuccessful or
incomplete installation of the CTW218HA driver.
1) If you followed the manual or advanced installations, 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 CTW218HA
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
Xbee Protocol
.-------------.
1) ZigBee Protocol Specification
2) ZigBee Cluster Library Specification
3) ZigBee Home Automation Public Application Profile