This branch is no longer under development by myself.
Future versions will be available from http://www.comfortforums.com/forum136/ which include web management interface and support for a dedicated UCM under development with Cytech
UPNP / SmartThings support for the Cytech Comfort system
This repository contains the necessary files and installation notes to expose elements of the Cytech Comfort alarm system via UPNP and onward to Samsung SmartThings
Little testing has been performed so far.
Please see the bottom of this document to see details of the latest changes and a change history
- It may not work, or it may work but be unstable, just because it works for me doesn't mean it will work for you. I will endeavour to support anyone who is willing to try it, but remember I have a day job and this is something I have built because it's kinda fun.
- The current implementation requires your Comfort sign-in code to be in clear text in the configuration file. I will encrypt this at some point and resolve this. DO NOT send your configuration file to anyone without first removing your sign in code from this file.
- Functionality is currently limited to Zones and Outputs and UPNP is tailored to support Samsung SmartThings - I am planning on adding WeMo emulation for native support by many other client devices (such as amazon echo etc) but unless you have Samsung SmartThings you will either not get a fat lot from this or will need to develop your own client handlers.
- Do not rely on this interface for critical applications - the Comfort alarm is an extremely robust system. It has taken many years of development to get to this point. Do not think that this solution can replace critical functions you have or would like to script in your Comfort system. I would say it's fine for automating those things that are nice to have, but don't rely on it to turn on your sprinklers in the event of a fire!
- It is under constant development. Configuration files and other elements may change at any point, including the removal or replacement of services it currently exposes. Do not expect any current configuration you have setup to work in future versions and please read any release notes before updating to the current version.
- Cytech Comfort system
- UCM with Ethernet (any variant should work, I have tested with UCM/Eth and UCM/Eth3).
- Raspberry Pi Model B (or similar - instructions below are for the original Model B. I have tested on Model B and B2)
- Static IP addresses on both UCM and Raspberry Pi
- Samsung SmartThings (I have tested on V2 hub, it may work on v1)
Download Raspbian Jessie Lite image from https://www.raspberrypi.org/downloads/
Flash SD card following instructions https://www.raspberrypi.org/documentation/installation/installing-images/README.md
Insert SD Card into RPi and connect to it using SSH
-
On Windows download PuTTY username: pi host: raspberry password: raspberry
-
On Mac / Linux use SSH pi@raspberry
when prompted, enter the password raspberry
Configure RPi
$ sudo raspi-config
-> Expand filesystem
-> Change User Password
* Set a new passwordFinish and reboot when prompted
Reconnect and do the following
$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo raspi-config
-> Boot Options
-> B1 - Console
* set to console, not desktop or scratch
-> Advanced-Options
-> Hostname
* Set hostname to something appropriate
-> SSH
* Enable remote access
-> Memory Split
* Set GPU memory to 16Finish and reboot when prompted
Reconnect and do the following
$ sudo apt-get install git
** Check for latest version on nodejs.org website, instructions below are for v6.9.1 **
$ wget https://nodejs.org/dist/v6.9.1/node-v6.9.1-linux-armv6l.tar.xz
$ tar -xvf node-v6.9.1-linux-armv6l.tar.xz
$ cd node-v6.9.1-linux-armv6l/
$ sudo cp -R * /usr/localCheck it is installed correctly
$ Node -v
v4.6.1Install Dependancies
This installation will add node modules locally (i.e. in a subdirectory of the current directory). At a minimum create a directory to run the code from within the home folder of the user you are logged in as:
mkdir ~\alarm
cd ~\alarm $ npm install net
$ npm install peer-upnp
$ npm install fs
$ npm install path
$ npm install util
$ npm install properties-parser
$ npm install http
$ npm install express
$ npm install pm2 -g** I have had to make some changes to the UPNP modules in order to support SmartThings, these need to be applied over the existing modules **
Navigate to the ~/alarm/node_modules/peer-ssdp/lib directory, rename peer-ssdp.js to peer-ssdp.js.old and upload the peer-ssdp.js found in this repository in its place
Navigate to the ~/alarm/node_modules/peer-upnp/lib directory, rename peer-upnp.js to peer-upnp.js.old and upload the peer-upnp.js found in this repository in its place
Copy alarm.js, alarm-client.js and alarm.config from this repository into the directory created earlier (~/alarm)
Copy your Comfigurator file used to configure the Comfort system into the same directory. * Please note, it is essential that this file is the xml variant (cclx), use a recent version of Comfigurator to convert it if necessary *
Using a text editor (such as nano), edit the configuration file and update the settings to match your configuration:
nano alarm.config
You can start the UPNP interface with the following command line
$ node alarm
It may take a few moments for things to happen, it has to read the config file, the Comfigurator config file and then instantiate UPNP devices for each of the comfort devices. It should then attempt to login to the alarm using the user specified in the configuration. You may see warnings related to emitters, you can safely ignore those at this time.
Open another connection to the Raspberry Pi, navigate to the directory in which you installed the code (cd ~/alarm) and start the test client (node alarm-client). If all is well it will discover the alarm UPNP devices and subscribe to events. Zone events will then be displayed as part of the output.
well done, you have managed to make sense of my notes and now have your alarm inputs and outputs available as UPNP devices
If you are happy all is working as it should, you can exit the test app and the UPNP app by using CTRL-C in their respective windows and restart the alarm UPNP app with the following to allow it to run in the background and persist when you disconnect from the Pi
$ pm2 start alarm.js
You can monitor it by using
$ pm2 show alarm or
$ pm2 monit alarm
You can stop it by using
$ pm2 stop alarm
There is a SmartApp and 5 DeviceHandlers required for SmartThings to make sense of the alarm.
The process for installing the SmartApp and DeviceHandlers is basically the same, you will need to login to the online portal using your SmartThings credentials (for the UK the URL is :https://graph-eu01-euwest1.api.smartthings.com/)
From this repository, view and copy into your clipboard all the code for the ComfortSmartApp.groovy file
From the online portal, do the following
1. Select 'My SmartApps' from the menu
2. Click '+ New SmartApp'
3. Click 'From Code'
4. Paste the code from the clipboard into the window
5. Click 'Create'
6. Click 'Save'
7. Click 'Publish' -> 'For Me'
From each of the files ComfortAlarmBridge.groovy, ComfortAlarmZone.groovy, ComfortAlarmOutput.groovy, ComfortAlarmCounter.groovy and ComfortAlarmFlag.groovy (one at a time), do the following:
1. Copy the code to the clipboard by viewing it
2. Select 'My Device Handlers'
3. Click '+ Create New Device Handler'
4. Click 'From Code'
5. Paste the code from the clipboard into the window
6. Click 'Create'
7. Click 'Save'
8. Click 'Publish' -> 'For Me'
From your SmartThings app on your mobile phone, click 'MarketPlace' -> 'SmartApps', scroll to the bottom and select 'My Apps' then select 'Cytech Zone UPNP Manager v1'. Ensure the Search Target is 'urn:www.cytech.com:service' and click 'next'. It will then start the discovery process (please allow a few minutes for all the devices to be found), clicking on the 'Select Devices' will allow you to select the devices you wish to instantiate, once selected 'Done' will start to create them.
You should now find all the zones and outputs you selected are represented in 'Things' in 'My Home' and can be interacted with and included in logic as any other motion sensor or switch can in SmartThings.
You will also find a device called 'Comfort Bridge', this element is the receiver of asynchronous events from the Comfort system. It will show the average events per minute from the alarm to SmartThings.
Newly discovered devices will take a few minutes to receive an update from the alarm, once they have properly subscribed, events should be received in near real time (within <1 sec)
These notes do not include configuring the software to restart on reboot - this is left as an exercise for the reader (I may add notes later, pm2 is your friend)
2/11/16
Added support for Counters and Flags.
This update replaces the existing alarm.js and alarm.config as well as updates to all Device Handlers and the Smart App.
Users of previous versions of this client will need to review and re-apply configuration changes to the alarm.config as you will now need to explicitly define each of the elements to be exposed, please see the notes within the configuration file for more information. It is highly recommended that only the devices you wish to have controlled in SmartThings are exposed in order to reduce the load on both the Pi and the UCM.
To update, replace the existing alarm.js and alarm.config on the Pi and restart the client as below from the installation directory.
pm2 stop alarm
pm2 start alarm
Existing Device Handlers and the Smart App should be overwritten by the updated content, saved and published. There is no need to remove and completely redo discovery, opening the existing SmartApp as found in Automations -> SmartApps and redoing discovery will add the new devices without messing up existing elements. Any devices not needed can be removed on a device by device basis using the preferences cog in the device details page.
Counters are represented as switches with variable levels (akin to dimmable bulbs), the On and Off function as used by other SmartApps can be configured to a set the counter to a specific value or to increment / decrement the counter in the device preferences.
Outputs are represented as switches, the function of On as exposed to other SmartApps can be configured to be On, Flash or FlashOnce in the device preferences
Flags are represented as switches.
Responses and Alarm state (with appropriate permissions) are in development, configuration of which can be seen in the alarm.config.