Difference between revisions of "ZWave"

From LinuxMCE
Jump to: navigation, search
(removed 0810 workaround as no longer required (bug fixed!))
(Implementation)
 
(48 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
{{Versioninfo|810Status=Working|810UpdatedDate=12th May 2010|810UpdatedBy=sambuca}}
 
{| align="right"
 
{| align="right"
 
   | __TOC__
 
   | __TOC__
 
   |}
 
   |}
 +
[[Category: Automation]]
 
[[Category: RF Control]]
 
[[Category: RF Control]]
 
[[Category: ZWave]]
 
[[Category: ZWave]]
 
[[Category: Programmer's Guide]]
 
[[Category: Programmer's Guide]]
 +
[[Category: Documentation]]
  
 
Z-Wave™ is a wireless RF-based communications technology designed for residential and light commercial control and status reading applications such as meter reading, lighting and appliance control, HVAC, access control, intruder and fire detection.
 
Z-Wave™ is a wireless RF-based communications technology designed for residential and light commercial control and status reading applications such as meter reading, lighting and appliance control, HVAC, access control, intruder and fire detection.
Line 10: Line 13:
 
== Overview ==
 
== Overview ==
 
The support from LinuxMCE system is represented by an executable '''ZWave''' (it's placed in /usr/pluto/bin) which is the device implementation and a '''DeviceTemplate (1754)''' which is used to create LinuxMCE Devices for ZWave.
 
The support from LinuxMCE system is represented by an executable '''ZWave''' (it's placed in /usr/pluto/bin) which is the device implementation and a '''DeviceTemplate (1754)''' which is used to create LinuxMCE Devices for ZWave.
 +
There are high speed (4x 40kbps) and standard speed Z-Wave devices.
  
Look at the [[:Category:ZWave|Z-Wave Wiki Category]] to see pages for different Z-Wave devices.
+
For information about what hardware to get look at [[Z-Wave Getting Started]], or check out the [[:Category:ZWave|Z-Wave Wiki Category]].
 
+
The source code is available in LinuxMCE's SVN repository: http://svn.linuxmce.org/svn/branches/LinuxMCE-0810/src/ZWave.
+
 
+
== Implementation ==
+
=== Open version ===
+
The new open Z-Wave driver will be included in the upcoming 0810 release.
+
 
+
A 32bit binary of the new Z-Wave driver for 0710 can be found here: http://vt100.at/files/ZWave-0.0.2-0710-32bit.bz2
+
Just swap with the existing /usr/pluto/bin/ZWave and quick reload the router.
+
 
+
=== New Fiire driver ===
+
Fiire also provides a new Z-Wave driver, it is binary only: [[Fiire ZWave Patch]]
+
 
+
=== Old version ===
+
This is the version shipped with 0710. The source code for the old version is not available as it depends on proprietary files from Zensys.
+
 
+
== Interfaces ==
+
=== Supported ===
+
* [[ACT Homepro ZCS000]]
+
* [[ACT Homepro ZCS010]]
+
* [[ACT Homepro ZCS101]]
+
* [[ACT Homepro ZCS201]]
+
* [[ACT Homepro ZCU000]]
+
* [[ACT Homepro ZCU010]]
+
* [[Aeon Labs Z-Wave Interface with built-In Inclusion Remote]]
+
* [[Intermatic HA22]]
+
* [[Intermatic HA23C]]
+
* [[Intermatic HA20C]]
+
* [[MCV_Z-Wave_Dongle|Mi Casa Verde USB + Inclusion Controller in one]]
+
* [[Seluxit viaSENS Homecontroller]]
+
* [[Tricklestar 300ZW-US-W]]
+
* [[Tricklestar 300ZW-EU-W]]
+
* [[Z~Series USB Stick with Z-Wave]] (Australian / New Zealand Z-Wave)
+
 
+
=== UNSUPPORTED ===
+
'''those don't work'''
+
 
+
* [[ACT Homepro ZCU101]]
+
* [[ACT Homepro ZCU201]]
+
  
 
== How to install and use ZWave ==
 
== How to install and use ZWave ==
 
=== Automatic installation - Lighting Wizard ===
 
=== Automatic installation - Lighting Wizard ===
The [[Lighting Wizard]] allows you to easily integrate LinuxMCE into your Z-Wave network. It is started after you plug in the Z-Wave dongle. Just follow the onscreen instructions.
+
The [[Lighting Wizard]] allows you to easily integrate LinuxMCE into your Z-Wave network. It is started after you plug in the Z-Wave dongle. Just follow the onscreen instructions. However the Lighting Wizard does not support SUC/SIS mode (see below) and because of this is now not the best way to include ZWave devices into your ZWave network. If you have a ZWave USB interface and an Inclusion Controller that supports SUC/SIS mode then this is the recommended configuration to use.
  
=== Manual Setup using SIS Mode with the Tricklestar Remote ===
+
=== SUC/SIS Mode (recommended) ===
SIS mode currently needs either the Seluxit ViaSens ZWave USB controller installed or the new Tricklestar USB Controller (see here for info on installing this controller [[ZWave_DeviceTemplate_PlugAndPlay | ZWave Device Template Plug'n'Play]]). Please note that you cannot currently use the Lighting Wizard when configuring SIS mode. You will also need to update to a current version of the new Open ZWave binary.
+
In SUC/SIS mode, LMCE adds your devices automatically as you include them into the Z-Wave network. Inclusion can be done using an inclusion remote or the "Add Node" command in LMCE (this option is really only successful in smaller test installations or possibly in smaller apartments for example). LMCE will assign new Node ids to the included devices and will add them in the Device tree under your ZWave USB interface. The following procedure requires that your ZWave USB interface and your Inclusion Device are compatible with SUC/SIS (**See the note at the bottom of this section);
  
# Firstly reset your ZWave USB controller so that you can start to add devices in SIS mode. Use Web Admin ->Wizard->Devices->Interfaces and find the device called 'ZWave' and click its 'Advanced' button. In the next screen click on 'Send command to device' and then select 'Reset' from the drop-down list, Tick 'Delivery Confirmation' and then click 'Send Message'. Now if you see 'Message received OK' your ZWave USB controller has been successfully reset.
+
#To use the SUC/SIS mode, send a "Reset" command to the ZWave USB interface.
# Next we need to include your Tricklestar remote into your ZWave network. Firstly we need to set the remote into Configuration Mode (see also the manual) this is done with the little switch on the bottom side next to the USB connector. Then do the following button presses on the Tricklestar remote which should be in close proximity to the ZWave USB interface - Press and hold the Remotes top most button down until you see a Green LED light up then release the button and press it briefly again. The Green LED should now be blinking slowly (if it isn't then repeat this step again). Now back in Web Admin use the 'Send Command to Device' screen again and select 'Download Configuration' from the drop-down. Now click 'Send Message' and watch the slowly flashing Green LED on the remote. If the LED stops flashing and glows continuously green for a few seconds then you have succeeded in including the Remote. However if you see a Red LED displayed continuously for a few secs something went wrong - in this case please repeat this whole step again. Assuming you got a Green LED at the end of this step you should (after waiting a couple of minutes for the inclusion prcess to finish) do a reload router before continuing. NOTE: If it does not work that way, try sending the 'Download Configuration' command first and then press and hold the Remotes top most button down until it goes green and the press the same button again shortly, that way around it worked better for me (was a tip from Hari).
+
##For LinuxMCE systems 1004 and below:
# Next we can Include each of your ZWave devices into the ZWave network (before starting to include devices it is important that they are located and fixed in their final locations). Using the Tricklestar remote go to each ZWave device (again you should be in close proximity to each device as you Include them) and do the following;
+
###In the web admin, go to Advanced -> Configuration -> Devices, find the ZWave device in the tree, select it, click "Send Command To Device" in the right pane.
## Press and hold the Remotes top most button down until you see a Green LED light up then release the button and press it briefly again. The Green LED should now be blinking slowly (if it isn't then repeat this step again).
+
###Select "Reset" and click Send Message. (Reset will remove all devices from you Z-Wave network).
## Now briefly press the Inclusion button on the device you are including. You should see the remotes Green LED stop flashing and glow continuously Green for a few seconds. If you did then you have succeeded in including the device. However if you see a Red LED displayed continuously for a few secs something went wrong - in this case please repeat this whole step again.
+
##For LinuxMCE systems 1204 and above (which uses the Open Zwave library's):
## Repeat the step above for each ZWave device would like to include in your ZWave network.
+
###In the web admin, go to Advanced -> Configuration -> Devices, find the ZWave device in the tree, select it, click "Send Command To Device" in the right pane.
# After including your last ZWave device, go back to Web Admin, do a reload router (or maybe two if LinuxMCE tells you to) and select Wizards->Devices->Lights. You should now see all the devices you included have been auto-magically added to the 'Wizard: Lights' screen! This is power of SIS mode! Now you can change your device names in the 'Description' field, select which 'Room' they are actually in and use 'PK_FloorplanObjectType' drop-down to select the floor plan icon they will display when placed on the floor plan etc. When you have updated this info for each ZWave device click 'Update' at the bottom of the screen.
+
###Select "Reset", in the "Data" field enter "ResetController" and click Send Message. (Reset will remove all devices from you Z-Wave network).
# If devices are not added automatically - meaning there is no popup on the Orbiters showing "added new device X" - then you can try this. If you have added logging you wil see in /var/log/pluto/*_ZWave.log" that lightswitches are detected by the USB controller because it shows up like this "Got basic report from node X, value: X". After addind the first device go to the USB Controller and do a 'Download Configuration' like above again - but this time '''without''' doing a 'reset' first. Then do a quick reload router once or twice and try adding the next device. Now it should work.
+
#Next do a Reload Router (**This reload is essential**).
 +
#When using SUC/SIS mode you must add an Inclusion Controller as the 2nd device in your ZWave network (the first device being the ZWave USB interface itself). An Inclusion Controller is the device you use to include ZWave devices into the ZWave network - this might be your ZWave remote control or possibly a wireless wall switch as these can often do double duty as an Inclusion Controller. You can add additional Inclusion Controllers or indeed any other ZWave devices at any time in the future as needed, and they will be added to your Device Tree automatically for you - this is the unique power of SUC/SIS.
 +
##'''If using a Tricklestar Remote:'''
 +
###First select 'Add node' from the 'Send to this device the command' drop-down menu and click Send Message (there is no need to fill in any values in this screen).  
 +
###Next put the remote in configuration mode, then press and hold up until the LED flashes green, then press up four times. The LED will begin flashing green. Once added, the remote LED should start flashing faster then go steady green indicating success. If it goes red then reset the remote (hold up til green, then hold up 10 seconds until 3 color LED), and redo step 1-2.  
 +
##'''If not using a Tricklestar remote:'''
 +
###Select 'Add node' from the 'Send to this device the command' drop-down menu and click Send Message (there is no need to fill in any values in this screen).
 +
###Next bring your Inclusion Controller close to your Core's/MD's ZWave USB interface and click once on its button or paddle (if a Wireless light switch) to include it into the ZWave Network. Your device should now indicate a successful inclusion if not repeat the last step.
 +
###You should see a ZWave device added message momentarily appear in the top left hand corner of your Orbiters display
 +
###Some users have reported the need to do a reload at this step. However this should not normally be required if you saw the ZWave added message from the previous step.
 +
#If your Inclusion Remote indicated a successful inclusion you are now ready to start including light switches and other devices using the device you added as an Inclusion Controller (ie your ZWave remote or a wireless Light Switch) - and '''not''' the 'Add Node' command in Web Admin.
 +
#Place your inclusion controller device into Inclusion Mode (consult the devices manual for the details of how to include devices using it).
 +
#Now while holding it close to the device you want to include press any button on the front of that device (usually one of the paddles on a light switch for example).
 +
#Wait for the successful inclusion indication on the device you are including and if you have an Orbiter or Web Orbiter nearby you should also see a brief announcement that device was added successfully. A few seconds later a router reload screen will pop up on your Orbiter's displays. (**If you'r adding several devices to your ZWave network then you can continue to add them and then do a single reload after adding the last device - this is an important reload so dont forget this step.**)
 +
#Now you can move to the next device and include it.
 +
#Keep doing this until all of your devices are included. With SUC/SIS there is no need to include all of your ZWave devices in one hit. You can stop and continue another time without any issues. So adding some more devices months into the future is simple and easy to do.
 +
#After including your last ZWave device don't forget to do a reload router
 +
#Check in Web Admin's Wizard->Devices->Lights page or click on 'Show Devices Tree' at the bottom of the left hand frame to make sure all of your included devices are present.(**if not do a reload router and wait a about 60 secs then check again).
  
Of course at anytime when you want to add some new ZWave devices to your installation just do the inclusion steps above with the remote & the device your adding - you dont need to add all your devices in one go. Each time you include a new device just do a reload router and auto-magically it will be in your ZWave devices tree.
+
* Note: When including devices using SUC/SIS mode always start by including the devices that are closest to where the Core's ZWave USB interface is located and finish with the device that is furthest away. This enables the inclusion process to utilise the ZWave mesh network to communicate with the Core's ZWave USB interface.
  
Note, you should never do the download config again after you have initially added the USB controller to the Tricklestar remote. To add a new node just put the Tricklestar into config mode with the switch and then add the new nodes with the "up till flash- up" procedure. Same for device removal. The Tricklestar will notify the USB controller about the change. This is automatically detected by LinuxMCE and you will see a popup on all orbiters with the new zwave node id.
+
* Not all ZWave interfaces support SIS mode. See the page of the individual interface to check, here is a list of interfaces [[Z-Wave Getting Started#Interface]].
  
=== Manual Excluding devices using SIS Mode with the Tricklestar Remote ===
+
==== How to add multi-paddle Multi-level Light Switches/Dimmers ====
  
Why do I have to do this ? (Quote from hari)
+
Some newer ZWave multi-paddle Light Switches & dimmers are built around the multi-level command classes present in the latest Zensys ZWave API ([[MK Honeywell Astral]] products are an example of this new type of device). These devices will function perfectly with the SUC/SIS mode but will need a small amount of manual configuration for paddles 2 & above. These devices typically will not have their 2nd paddle added automatically when they are included into your ZWave network ie only the 1st paddle will appear in your device tree. In time this limitation will be removed from the ZWave driver but for now please follow the simple manual procedure described below for adding the 2nd paddle to your device tree;
Z-Wave is a mesh. The routing table is updated at inclusion/exclusion. When you move stuff around without following the procedure (except portable devices like remote controllers) you can get network problems.
+
  
# Put the Configuration Switch of the Trickestar Remote in “Configuration Mode” like this. Press-and-hold “Up” Operation button for 2 seconds to enter Configuration Mode. LED Indicator will illuminate Green. Short-press the “Down” Operation Button one time to put the device into Exclusion Mode. The Green LED should now be blinking slowly (if it isn't then repeat this step again).
+
#After including your multi-paddle light switch or dimmer (see the SUC/SIS section above) make a note of its ZWave Node ID.
# Press the Exclusion Initiator of the Device to be Excluded (normally the same button as the Inclusion Initiator).
+
##To do this look in Web Admin's Wizard->Devices->Lights page to get the Node ID - see the value listed for each light in the 'Port/Channel Number' field.
# LED Indicator on the Remote will illuminate Green when device is successfully excluded and illuminate Red if the operation is unsuccessful. Orbiters will show a message that the device is removed.
+
#Now we need to add a new device for the right hand paddle;
# Repeat steps 2-4 for each Device to be Excluded from the Network.
+
##'''If your adding a right hand paddle for a Light Switch:'''
# After Excluding all the devices that you would like to remove, go back to Web Admin, do a reload router and select Wizards->Devices->Lights. The Excluded devices should now be gone.
+
###Click on 'Show Devices Tree' (at the bottom of the left hand frame) and click on the 'ZWave' item under the 'Core' in the tree.
 +
###In the right hand pane you should now see the 'Advanced' screen for your ZWave interface
 +
###Now click on 'Create Child Device'
 +
###You should now see the 'Add Child Device' screen and should click on the 'Pick device template' button.
 +
###The 'Pick device template' window should now be visible.
 +
###Click on the 'Device Template' drop down and select 'Light Switch (on/off)' from the list. You should now see the number '37' appear to the right of the drop down list (this is the templates ID).
 +
###Now click on 'Pick Device Template'
 +
###A new 'Light Switch (on/off)' device will now be added to the end of the list of child devices under your ZWave interface in the devices tree.
 +
##'''If your adding a right hand paddle for a Dimmer:'''
 +
###Click on 'Show Devices Tree' (at the bottom of the left hand frame) and click on the 'ZWave' item under the 'Core' in the tree.
 +
###In the right hand pane you should now see the 'Advanced' screen for your ZWave interface
 +
###Now click on 'Create Child Device'
 +
###You should now see the 'Add Child Device' screen and should click on the 'Pick device template' button.
 +
###The 'Pick device template' window should now be visible.
 +
###Click on the 'Device Template' drop down and select 'Light Switch (Dimmable)' from the list. You should now see the number '38' appear to the right of the drop down list (this is the templates ID).
 +
###Now click on 'Pick Device Template'
 +
###A new 'Light Switch (on/off)' device will now be added to the end of the list of child devices under your ZWave interface in the devices tree.
 +
#You should now have a new Light Switch or Dimmer device in your devices tree - click on its entry in the tree.
 +
#In the right hand pane you will now see the Advanced info for your new device - we need to modify some values for this new device;
 +
##Modify the 'Description' field so that it describes clearly what this device is ie something like 'Master Bed Dimmer (paddle-2)' (this text is displayed in the Devices Tree)
 +
##Now select a 'Room' from the Room drop down and tick any Entertainment Areas this Light should be added too.
 +
##Next scroll down to the 'Device Data' section at the bottom of the screen and choose a floor Plan icon from the 'PK_FloorplanObjectType' drop down (this determines what icon will be displayed in the lighting floor plan for this specific light).
 +
##Finally you need to set the 'Port/Channel Number' field to link this device with light switch/dimmer it is assigned to. Add the Node ID you made a note of in Step 1 to the field followed by a '/' and a number. If this is paddle-2 then the number after the '/' would be '2'. So if the Node ID was '16' you should now have the string '16/2' in the field. If you multi-paddle light/dimmer has more than two paddles then increment the value by '1' for each additional paddle.
 +
##The final step is to click 'Save' to save the changes you have made to the device.
 +
#Now go to the Wizards->Devices->Lights page and test your new light switch/dimmer paddle - use the 'ON', 'OFF' & '50%' buttons.
 +
 
 +
=== Alternate setup of [[Tricklestar Remote]] (not recommended) ===
  
 
=== Manual setup / Download configuration ===
 
=== Manual setup / Download configuration ===
 
Once you have successfully installed the ZWave USB controller and it is seen on LinuxMCE ([[media:zwave_homepro_interface.png]]), you can proceed by populating the ZWave network information to LinuxMCE.
 
Once you have successfully installed the ZWave USB controller and it is seen on LinuxMCE ([[media:zwave_homepro_interface.png]]), you can proceed by populating the ZWave network information to LinuxMCE.
  
# Add your ZWave devices to your master ZWave master remote controller (like ZTH200)
+
# Add your ZWave devices to your master ZWave master remote controller (like [[ZTH200]])
 
#* Once the devices are added to remote and verified they are working (you can control them with your remote controller), you need to copy the ZWave network information to LinuxMCE.
 
#* Once the devices are added to remote and verified they are working (you can control them with your remote controller), you need to copy the ZWave network information to LinuxMCE.
# Go to LinuxMCE admin page (<nowiki>"http://192.168.80.1/pluto-admin/"</nowiki>), then choose "Wizard -> Devices -> Interfaces -> [your ZWave controller] -> Advanced".
+
# Go to LinuxMCE admin page (<nowiki>"http://dcerouter/lmce-admin/"</nowiki>), then choose "Wizard -> Devices -> Interfaces -> [your ZWave controller] -> Advanced".
 
## On the device page select "Send command to device".
 
## On the device page select "Send command to device".
 
## Select command "Download Configuration" and choose "Send Message".
 
## Select command "Download Configuration" and choose "Send Message".
Line 100: Line 107:
 
You should do quick reload (Wizard -> Restart -> Quick Reload Router) in order to use the newly added devices with LinuxMCE. Once you have done that you should be able to control (like switching on/off) the devices under the  Light ([[Media:zwave_lights.png]]).
 
You should do quick reload (Wizard -> Restart -> Quick Reload Router) in order to use the newly added devices with LinuxMCE. Once you have done that you should be able to control (like switching on/off) the devices under the  Light ([[Media:zwave_lights.png]]).
  
== PIR (Binary Sensor) support ==
+
== Setting associations ==
 +
If you use SIS mode, associations will be set automatically, so that LMCE is always associated with each new device. This allows LMCE to receive messages when a device changes state.
 +
 
 +
The web interface allows you to create associations between devices (I believe this requires SIS mode, not sure).
 +
Click "Show device tree" then navigate to your z-wave controller (under CORE) and select "Send command to device". A popup window will show and you can choose the "Set Association" command.
 +
Enter three parameters:
 +
* the zwave NodeID of the source device, the one that will send the command
 +
* the group in the source device that will trigger the send (typically the button number on a multi-paddle switch)
 +
* the NodeID(s) device(s)
 +
Example: 5 / 2 / 7,8  would cause devices 7 and 8 to turn on when you press button 2 of device 5
 +
 
 +
== Tweak advanced ZWave settings ==
 +
If you want to tweak some specific settings of your ZWave devices then read [[Tweak_advanced_ZWave_settings|this article]].
 +
 
 +
== Update node information ==
 +
You can request a manual update of the node information (command classes). To do this open the advanced page of the main ZWave device and send command to device. Send a "Resync node" command with the node id of the node you want to update the information from.
 +
 
 +
It should normally not be necessary to do this, as the node information is updated at the first reload after it was added. However, it can be useful if for some reason the node information was not correctly set or if you have replaced a node which may have other command classes.
 +
 
 +
= Implementation =
 +
== OpenZWave version ==
 +
This in included in 1204 and onwards.
 +
The source code is available in LinuxMCE's SVN repository: http://svn.linuxmce.org/svn/branches/LinuxMCE-0810/src/ZWave-OZW.
 +
 
 +
== Open version ==
 +
The new open Z-Wave driver is included in the 0810 and 1004 release.
 +
The source code is available in LinuxMCE's SVN repository: http://svn.linuxmce.org/svn/branches/LinuxMCE-0810/src/ZWave.
  
[[ACT Homepro Motion Detector]]
+
== To know ==
 +
If after a new install you have problems with your current zwave network, it may be useful to make a complete reset of this network and complete it with a reset of all the devices.
 +
The reset of devices can be done with an exclusion command (find those in your devices books).
  
 
== Z-Wave API documentation ==
 
== Z-Wave API documentation ==
  
 
[[ZWave API]]
 
[[ZWave API]]

Latest revision as of 21:25, 25 April 2014

Version Status Date Updated Updated By
710 Unknown N/A N/A
810 Working 12th May 2010 sambuca
1004 Unknown N/A N/A
1204 Unknown N/A N/A
1404 Unknown N/A N/A
Usage Information

Z-Wave™ is a wireless RF-based communications technology designed for residential and light commercial control and status reading applications such as meter reading, lighting and appliance control, HVAC, access control, intruder and fire detection.

Overview

The support from LinuxMCE system is represented by an executable ZWave (it's placed in /usr/pluto/bin) which is the device implementation and a DeviceTemplate (1754) which is used to create LinuxMCE Devices for ZWave. There are high speed (4x 40kbps) and standard speed Z-Wave devices.

For information about what hardware to get look at Z-Wave Getting Started, or check out the Z-Wave Wiki Category.

How to install and use ZWave

Automatic installation - Lighting Wizard

The Lighting Wizard allows you to easily integrate LinuxMCE into your Z-Wave network. It is started after you plug in the Z-Wave dongle. Just follow the onscreen instructions. However the Lighting Wizard does not support SUC/SIS mode (see below) and because of this is now not the best way to include ZWave devices into your ZWave network. If you have a ZWave USB interface and an Inclusion Controller that supports SUC/SIS mode then this is the recommended configuration to use.

SUC/SIS Mode (recommended)

In SUC/SIS mode, LMCE adds your devices automatically as you include them into the Z-Wave network. Inclusion can be done using an inclusion remote or the "Add Node" command in LMCE (this option is really only successful in smaller test installations or possibly in smaller apartments for example). LMCE will assign new Node ids to the included devices and will add them in the Device tree under your ZWave USB interface. The following procedure requires that your ZWave USB interface and your Inclusion Device are compatible with SUC/SIS (**See the note at the bottom of this section);

  1. To use the SUC/SIS mode, send a "Reset" command to the ZWave USB interface.
    1. For LinuxMCE systems 1004 and below:
      1. In the web admin, go to Advanced -> Configuration -> Devices, find the ZWave device in the tree, select it, click "Send Command To Device" in the right pane.
      2. Select "Reset" and click Send Message. (Reset will remove all devices from you Z-Wave network).
    2. For LinuxMCE systems 1204 and above (which uses the Open Zwave library's):
      1. In the web admin, go to Advanced -> Configuration -> Devices, find the ZWave device in the tree, select it, click "Send Command To Device" in the right pane.
      2. Select "Reset", in the "Data" field enter "ResetController" and click Send Message. (Reset will remove all devices from you Z-Wave network).
  2. Next do a Reload Router (**This reload is essential**).
  3. When using SUC/SIS mode you must add an Inclusion Controller as the 2nd device in your ZWave network (the first device being the ZWave USB interface itself). An Inclusion Controller is the device you use to include ZWave devices into the ZWave network - this might be your ZWave remote control or possibly a wireless wall switch as these can often do double duty as an Inclusion Controller. You can add additional Inclusion Controllers or indeed any other ZWave devices at any time in the future as needed, and they will be added to your Device Tree automatically for you - this is the unique power of SUC/SIS.
    1. If using a Tricklestar Remote:
      1. First select 'Add node' from the 'Send to this device the command' drop-down menu and click Send Message (there is no need to fill in any values in this screen).
      2. Next put the remote in configuration mode, then press and hold up until the LED flashes green, then press up four times. The LED will begin flashing green. Once added, the remote LED should start flashing faster then go steady green indicating success. If it goes red then reset the remote (hold up til green, then hold up 10 seconds until 3 color LED), and redo step 1-2.
    2. If not using a Tricklestar remote:
      1. Select 'Add node' from the 'Send to this device the command' drop-down menu and click Send Message (there is no need to fill in any values in this screen).
      2. Next bring your Inclusion Controller close to your Core's/MD's ZWave USB interface and click once on its button or paddle (if a Wireless light switch) to include it into the ZWave Network. Your device should now indicate a successful inclusion if not repeat the last step.
      3. You should see a ZWave device added message momentarily appear in the top left hand corner of your Orbiters display
      4. Some users have reported the need to do a reload at this step. However this should not normally be required if you saw the ZWave added message from the previous step.
  4. If your Inclusion Remote indicated a successful inclusion you are now ready to start including light switches and other devices using the device you added as an Inclusion Controller (ie your ZWave remote or a wireless Light Switch) - and not the 'Add Node' command in Web Admin.
  5. Place your inclusion controller device into Inclusion Mode (consult the devices manual for the details of how to include devices using it).
  6. Now while holding it close to the device you want to include press any button on the front of that device (usually one of the paddles on a light switch for example).
  7. Wait for the successful inclusion indication on the device you are including and if you have an Orbiter or Web Orbiter nearby you should also see a brief announcement that device was added successfully. A few seconds later a router reload screen will pop up on your Orbiter's displays. (**If you'r adding several devices to your ZWave network then you can continue to add them and then do a single reload after adding the last device - this is an important reload so dont forget this step.**)
  8. Now you can move to the next device and include it.
  9. Keep doing this until all of your devices are included. With SUC/SIS there is no need to include all of your ZWave devices in one hit. You can stop and continue another time without any issues. So adding some more devices months into the future is simple and easy to do.
  10. After including your last ZWave device don't forget to do a reload router
  11. Check in Web Admin's Wizard->Devices->Lights page or click on 'Show Devices Tree' at the bottom of the left hand frame to make sure all of your included devices are present.(**if not do a reload router and wait a about 60 secs then check again).
  • Note: When including devices using SUC/SIS mode always start by including the devices that are closest to where the Core's ZWave USB interface is located and finish with the device that is furthest away. This enables the inclusion process to utilise the ZWave mesh network to communicate with the Core's ZWave USB interface.

How to add multi-paddle Multi-level Light Switches/Dimmers

Some newer ZWave multi-paddle Light Switches & dimmers are built around the multi-level command classes present in the latest Zensys ZWave API (MK Honeywell Astral products are an example of this new type of device). These devices will function perfectly with the SUC/SIS mode but will need a small amount of manual configuration for paddles 2 & above. These devices typically will not have their 2nd paddle added automatically when they are included into your ZWave network ie only the 1st paddle will appear in your device tree. In time this limitation will be removed from the ZWave driver but for now please follow the simple manual procedure described below for adding the 2nd paddle to your device tree;

  1. After including your multi-paddle light switch or dimmer (see the SUC/SIS section above) make a note of its ZWave Node ID.
    1. To do this look in Web Admin's Wizard->Devices->Lights page to get the Node ID - see the value listed for each light in the 'Port/Channel Number' field.
  2. Now we need to add a new device for the right hand paddle;
    1. If your adding a right hand paddle for a Light Switch:
      1. Click on 'Show Devices Tree' (at the bottom of the left hand frame) and click on the 'ZWave' item under the 'Core' in the tree.
      2. In the right hand pane you should now see the 'Advanced' screen for your ZWave interface
      3. Now click on 'Create Child Device'
      4. You should now see the 'Add Child Device' screen and should click on the 'Pick device template' button.
      5. The 'Pick device template' window should now be visible.
      6. Click on the 'Device Template' drop down and select 'Light Switch (on/off)' from the list. You should now see the number '37' appear to the right of the drop down list (this is the templates ID).
      7. Now click on 'Pick Device Template'
      8. A new 'Light Switch (on/off)' device will now be added to the end of the list of child devices under your ZWave interface in the devices tree.
    2. If your adding a right hand paddle for a Dimmer:
      1. Click on 'Show Devices Tree' (at the bottom of the left hand frame) and click on the 'ZWave' item under the 'Core' in the tree.
      2. In the right hand pane you should now see the 'Advanced' screen for your ZWave interface
      3. Now click on 'Create Child Device'
      4. You should now see the 'Add Child Device' screen and should click on the 'Pick device template' button.
      5. The 'Pick device template' window should now be visible.
      6. Click on the 'Device Template' drop down and select 'Light Switch (Dimmable)' from the list. You should now see the number '38' appear to the right of the drop down list (this is the templates ID).
      7. Now click on 'Pick Device Template'
      8. A new 'Light Switch (on/off)' device will now be added to the end of the list of child devices under your ZWave interface in the devices tree.
  3. You should now have a new Light Switch or Dimmer device in your devices tree - click on its entry in the tree.
  4. In the right hand pane you will now see the Advanced info for your new device - we need to modify some values for this new device;
    1. Modify the 'Description' field so that it describes clearly what this device is ie something like 'Master Bed Dimmer (paddle-2)' (this text is displayed in the Devices Tree)
    2. Now select a 'Room' from the Room drop down and tick any Entertainment Areas this Light should be added too.
    3. Next scroll down to the 'Device Data' section at the bottom of the screen and choose a floor Plan icon from the 'PK_FloorplanObjectType' drop down (this determines what icon will be displayed in the lighting floor plan for this specific light).
    4. Finally you need to set the 'Port/Channel Number' field to link this device with light switch/dimmer it is assigned to. Add the Node ID you made a note of in Step 1 to the field followed by a '/' and a number. If this is paddle-2 then the number after the '/' would be '2'. So if the Node ID was '16' you should now have the string '16/2' in the field. If you multi-paddle light/dimmer has more than two paddles then increment the value by '1' for each additional paddle.
    5. The final step is to click 'Save' to save the changes you have made to the device.
  5. Now go to the Wizards->Devices->Lights page and test your new light switch/dimmer paddle - use the 'ON', 'OFF' & '50%' buttons.

Alternate setup of Tricklestar Remote (not recommended)

Manual setup / Download configuration

Once you have successfully installed the ZWave USB controller and it is seen on LinuxMCE (media:zwave_homepro_interface.png), you can proceed by populating the ZWave network information to LinuxMCE.

  1. Add your ZWave devices to your master ZWave master remote controller (like ZTH200)
    • Once the devices are added to remote and verified they are working (you can control them with your remote controller), you need to copy the ZWave network information to LinuxMCE.
  2. Go to LinuxMCE admin page ("http://dcerouter/lmce-admin/"), then choose "Wizard -> Devices -> Interfaces -> [your ZWave controller] -> Advanced".
    1. On the device page select "Send command to device".
    2. Select command "Download Configuration" and choose "Send Message".
      • Leave the data and file fields as blank
  3. Now LinuxMCE is waiting for the ZWave information and you should send a copy of the ZWave network with your master remote controller to LinuxMCE.
    • If you are using HomePro remote controller this is done by selecting: "Setup -> Copy Remote Ctrl. -> Send Information -> Identical Copy". Once you have done that, the remote will show "Sending information..." and after successful sending it will return to clock screen (this shouldn't take more than couple of minutes).
    • You can monitor the process by watching the Zwave log file on LinuxMCE (usually "/var/log/pluto/*ZWave.log"). Unfortunately the admin page doesn't give much information of what is being done and is everything going smoothly. If the process is successfully, you should see the LinuxMCE communicating with the USB controller
    • Make sure the sending remote controller is near enough the USB receiver, otherwise nothing will happen.
  4. Go to device tree (Show devices tree) and you should see (Media:zwave_devices_tree.png) the newly added ZWave modules/devices on the tree under "CORE -> ZWave".

You should do quick reload (Wizard -> Restart -> Quick Reload Router) in order to use the newly added devices with LinuxMCE. Once you have done that you should be able to control (like switching on/off) the devices under the Light (Media:zwave_lights.png).

Setting associations

If you use SIS mode, associations will be set automatically, so that LMCE is always associated with each new device. This allows LMCE to receive messages when a device changes state.

The web interface allows you to create associations between devices (I believe this requires SIS mode, not sure). Click "Show device tree" then navigate to your z-wave controller (under CORE) and select "Send command to device". A popup window will show and you can choose the "Set Association" command. Enter three parameters:

  • the zwave NodeID of the source device, the one that will send the command
  • the group in the source device that will trigger the send (typically the button number on a multi-paddle switch)
  • the NodeID(s) device(s)

Example: 5 / 2 / 7,8 would cause devices 7 and 8 to turn on when you press button 2 of device 5

Tweak advanced ZWave settings

If you want to tweak some specific settings of your ZWave devices then read this article.

Update node information

You can request a manual update of the node information (command classes). To do this open the advanced page of the main ZWave device and send command to device. Send a "Resync node" command with the node id of the node you want to update the information from.

It should normally not be necessary to do this, as the node information is updated at the first reload after it was added. However, it can be useful if for some reason the node information was not correctly set or if you have replaced a node which may have other command classes.

Implementation

OpenZWave version

This in included in 1204 and onwards. The source code is available in LinuxMCE's SVN repository: http://svn.linuxmce.org/svn/branches/LinuxMCE-0810/src/ZWave-OZW.

Open version

The new open Z-Wave driver is included in the 0810 and 1004 release. The source code is available in LinuxMCE's SVN repository: http://svn.linuxmce.org/svn/branches/LinuxMCE-0810/src/ZWave.

To know

If after a new install you have problems with your current zwave network, it may be useful to make a complete reset of this network and complete it with a reset of all the devices. The reset of devices can be done with an exclusion command (find those in your devices books).

Z-Wave API documentation

ZWave API