Comfort Home Automation/ Security System Forums Home
Home Search search Menu menu Not logged in - Login | Register

Configuring UCM/Zwave3
 Moderated by: slychiu
 New Topic   Printer Friendly 
 Rate Topic 
AuthorPost
 Posted: Friday Dec 25th, 2015 09:45 am
   
1st Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

These instructions can also be found in the UCM/Zwave Manual http://www.cytech.biz/product_details.php?item_id=230


Other topics include Use the latest Comfigurator for this
In the Modules tab right-click on UCM and select SCAN for UCMs. Enter your user code in the login box. The Scan results are shown below (typical). The Z-Wave UCM should be shown in the UCMs list.




After scanning you can check from the UCM's page if there is a newer version available (on Latest Version column) and upgrade it by right-clicking the respective UCM/Zwave on the left pane under UCM's folder and select 'Check for Firmware Updates'. Note that you need an Internet connection for this function.


Note
When using UCM/ETHxx for Comfigurator connection, the Connection Time-out in CS-Manager should be set to 5 minutes while setting up UCM/Zwave to avoid time-out while reading and Writing to EEPROM in UCM/Z-Wave.

Click on the UCM icon on the left Panel corresponding to Z-Wave to show the Z-Wave Configuration screen below.



Before the Z-Wave network has been learned, the Chip Type, Chip Version, Controller Type, Z-Wave Module Info, Home ID, Node ID will be blank, 0 or Unknown.
The tabs on the top of the screen are explained as follows;

Read From EEPROM
This reads the Z-wave configuration and Register assignment from the UCM/Zwave EEPROM (U2). Read from EEPROM is automatically performed after a Learn operation

Write to EEPROM
Write the Comfort Registers (Counter/Sensor/Response/Output/Virtual Input) mapping assignments to the UCM/Zwave EEPROM (U2 IC). This is necessary after changing the register assignments. Note that READ from EEPROM or LEARN operation is required before assigning registers  and writing to EEPROM. Writing to EEPROM does NOT change the Z-wave properties, it affects only the Register  assignments to Comfort.

Reset (Reset to Factory Default)
This resets the UCM/Zwave to Factory Default including the Z-wave properties and Counter assignments, i.e. it clears the UCM/Zwave EEPROM.
This does not remove or exclude the UCM/Zwave from a Z-wave network. See the section on Leaving the Z-Wave Network for instructions on how to do so. AVOID the 'RESET' to default button without first leaving the network OTHERWISE A NEW LEARN OPERATION WILL ADD A DUPLICATE NODE to the Z-Wave Network. This button is only used as a last resort when the UCM/Zwave has been removed physically from the network without having excluded it first.

Learn (Learn Z-Wave Network)
This button is used to Include the UCM/Zwave into the Z-Wave network, to learn or copy the Z-wave network configuration from a Primary Controller, as well as to leave (be Excluded from) the network. The detailed instructions are in the next section "Inclusion/Replication in Z-wave Network"

Create Virtual Node
This allows a Z-Wave Virtual Node to be created. The purpose of Virtual Nodes is to allow association with another Zwave device so that it can send commands to Comfort.  Instructions are given later.

UCM/Zwave Status
When the Zwave screen is in focus, the UCM/Zwave status information is shown in the status bar on bottom left of Comfigurator screen as shown below.




The possible Status values in the status bar and their meanings are listed below
  • "Normal/No error" - UCM/Zwave is in a Zwave Network with no error.
  • "EEPROM missing/faulty" - U2 EEPROM missing.
  • "EEPROM insufficient capacity" - U2 EEPROM problem.
  • "EEPROM data invalid" - Zwave data in the U2 EEPROM is invalid.
  • "Communication error between UCM baseboard and Z-wave sub-module" - Problem with the Zwave submodule.
  • "UCM/Zwave not in any Network" - UCM/Zwave has not gone through "Learn"
  • "Waiting to receive network data" - Seen during the Learn Process.
  • "Receiving network data" - Seen during the Learn Process.
  • "Writing EEPROM" - Seen during the Learn Process.
  • "Learn process success" - Learn has been completed.
  • "Learn process completed with errors" - Error in Learn. Repeat learning.
  • "Command transmitted - Waiting for ACK" - A Z-Wave command has been transmitted and is waiting for a response from the Z-Wave network.
  • "Z-Wave network busy/jammed (RF transmit error)" - Indicates there is a Z-Wave network problem.
  • "Unknown Transmit Error"
  • "Please wait.  Backing up Z-Wave module data first... xx% completed"
  • "Z-Wave module data is bad.  Restoring it now... xx% completed)"
  • "Restoring Z-Wave module data completed."
  • "Learn mode has ended. Checking if restoring Z-Wave module data is needed..."
  • "Comfort response contains invalid node."
  • "Comfort response contains virtual node."
  • "Comfort response contains non-supported Command Class in node."
  • "Z-Wave transmit queue overflow"
  • "Transmit complete without ACK"
  • "Too many Z-Wave commands to process"
  • "Z-Wave admin buffer overflow"




Last edited on Friday Dec 25th, 2015 11:35 am by slychiu



 Posted: Friday Dec 25th, 2015 10:26 am
   
2nd Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

Inclusion/Replication in Z-Wave Network
The UCM/Zwave acts as a Secondary (Bridge) Controller in the Z-Wave network. It must first be Included in a Z-Wave network and it must learn (Copy) the Z-wave network from the primary controller (usually a remote control e.g. MK Astral LRC14S) which has been used to set up the Z-Wave Network.  This uses the 'Learn' button in Z-Wave Configurator.
  • Ensure that the Z-Wave network is already set up and functioning correctly before including the UCM/Zwave into the network. The UCM/Zwave acts as a Secondary Controller in the Z-Wave network. It needs to learn the Z-Wave network from the Primary Controller (remote control) which was used initially to set up the network.
  • Check that the  UCM/Zwave is not part of another Z-wave network.  You can check the Zwave status using Comfigurator by pressing the 'Get Status' button on the Zwave Configurator Menu. The message "UCM/Zwave not in any network" should be seen in the status bar. This should be the case for a new UCM/Zwave from the factory. If the UCM/Zwave has previously been included the status message should be "Normal/No Error".
  • If the UCM/Zwave has already been included in a different network, it should be removed from the existing Z-Wave network before being included into a new network (see instructions in "Leaving a Zwave Network")  If the UCM/Zwave is not in a network but the EEPROM has been written with data from a previous network, then Reset the EEPROM to Default (See instructions in "Reset UCM/Zwave to Default".)
  • Important - Make sure that all Z-wave modules are connected to power during learning, otherwise, the multichannel properties of these nodes will not be discovered,  as the UCM/Zwave needs to query the individual Zwave nodes. Plug in wall modules should be plugged in and the power switched on. It is not necessary to switch on the loads or lights connected to the Z-Wave module.
  • Press the 'Learn' button. Press 'Yes' to continue. The Status bar will show "Backing up Z-wave module data first...". Wait until you see "Waiting to receive network data" on the status bar.
  • Activate the sending of system information from the controller using the procedures given by the Z-Wave device manufacturer. The section at the back called "Inclusion and Replication for various Manufacturers" shows examples of how to do this.
  • During the transfer, the status bar will show "Receiving network data." 
    The status bar will show "Writing EEPROM" when the received Z-Wave network data is being written to the UCM/Zwave EEPROM after the UCM/Zwave has received the network data.
  • Upon completion, the status bar  shows "Learn Process Success".  In the event of error, the status bar will show "Learn Process Completed with Errors"
    When completed, Comfigurator will automatically start reading the data from EEPROM as shown in the popup window.


  • When completed, the Z-wave Configuration screen will show the Z-wave Ids in the network.  The operation described includes the UCM/Zwave into the network and Replicates the Z-wave network from the Primary Controller.
  • If a new Z-wave mode is added to the network or a node has been removed by the primary controller, repeat the Learn process with all Z-wave modules with power applied.
Note
  • If the UCM/Zwave is already in the Z-Wave network, repeating the LEARN process described above will update the UCM/Zwave with latest Z-Wave node information so there is no harm in doing this.
  • Do NOT learn a different Z-Wave network before leaving the existing network.
The screenshot below shows what the configuration screen looks like after the learning Process.




The meaning of the fields in UCM/Zwave Properties is explained below;
Z-Wave Chip Type and Version.
This is information about the Z-Wave Module hardware

Controller Type
Should show Bridge Controller. Older UCM/Zwave1 modules may show Static Controller. This will not be able to assign Virtual Nodes so the extra function of the UCM/Zwave3 will not be available. This can be upgraded to Bridge Controller by buying a ZW03 plug in Submodule to replace the Z-Wave  submodule.
Z-Wave Module Info
This is the Z-Wave Library Version on the submodule (not the UCM/Zwave Firmware).
The minimum Library version is 3.22 for Z-Wave Switches with Multi-channel Class, e.g. multi-gang MK Astral or Vitrum to be identified correctly.  In Library Version 2.40, the Multi-channel Class device is identified wrongly as Basic Class. The newer Z-Wave Library i.e. 3.22 and above fixed the bug on 2.40. Cytech will upgrade the Z-Wave Library without charge, except for the cost of transport. Please contact support@cytech.biz for assistance.
Home ID
This is the 32 bit unique ID of the network assigned by the Primary controller
Node ID
This is the Node ID of the UCM/Zwave 1 to 232 assigned by the Primary controller during inclusion (Learn).
Poll Time/ Smart Polling
This is the time interval in 10 seconds interval for the UCM/Zwave to poll the relevant Z-Wave nodes for status to be mapped to counters. Nodes without "Listening" Property and Virtual Nodes will NOT be polled regardless of the Poll Time setting. Controllers are polled (from Zwave 7.016 onwards). Setting Poll Time to 255 means there will be no polling.

From Zwave 7.072 onwards if Poll Time is 0, "Smart" Polling is activated. The Zwave nodes are polled when required by Comfort  e.g. in Control Menu or by iPhone/iPad/android app. If there is no Zwave activity, the nodes are polled less frequently. This is the recommended setting.





 Posted: Friday Dec 25th, 2015 10:37 am
   
3rd Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

Z-Wave Mapping
Click on the Z-Wave Mapping tab. This shows the Z-Wave nodes in a typical  network. In the example, Node 1 is the Primary controller. Node 6 is a Slave - Switch Binary, which is a Z-wave appliance module. Node 8 Static Controller is the UCM/Zwave3.
The colours indicate what type of node is shown;
  • Controllers - Gray
  • UCM/Zwave Controller (as in Properties Page Node ID) - Blue
  • Virtual Nodes - green
  • Slaves - Normal (black)
The screenshot below shows the different colours available in Comfigurator.


The  Comments field can be used to identify the Z-wave Node which is saved in the UCM/Zwave EEPROM.

A Z-Wave (controller or Slave) Node can be assigned to a Comfort Counter for monitoring by polling. Click on the UCM/Zwave in the left pane to show its properties in the right pane. The screen below shows a Z-Wave Mapping table with Node 5 as Routing Slave - Routing Sensor Binary.



Node Types
Node Types are Basic, Multichannel, Virtual or Sensor. This is read-only.
  • Basic means it is a normal Z-wave Node.
  • Multichannel means it is a multichannel device with more than 1 output.
  • Virtual means it is a Virtual Node created by UCM/Zwave.
  • Sensor means it supports the Zwave Multilevel sensor command class (e.g. Door sensor, Temperature and power sensor)
A Multichannel node is shown below;



In the right pane, select a Counter or Flag to be mapped to the Zwave node. Unassigned counter or flag numbers are set to 255. The assigned counter/flag will be updated with the value 0 to 255 of the Z-wave device, where 0 means off, 255 means ON, and 1 to 254 means a dimming level.

For Zwave 7.072 - Note the counters mapped to Multilevel Switch e.g. Nodes 2,4,5 etc. above will have values of 0 to 254 corresponding to levels 0 to 99 for Zwave and vice versa. This conversion allows the Comfort app to use the full scale sliders from 0 to 255. Setting a counter to 255 will turn on the multilevel switch to the last remembered value. Note that this does not apply to Binary switches e.g. Node 3 above.

The counter or flag mapped to the Zwave node in this way is updated by UCM/Zwave polling the node. Counters and Flags should be mapped only when their status is required in Comfort, because UCM/Zwave will poll these mapped nodes  which causes unnecessary additional delay and RF traffic.
Multi-channel devices are supported (Multichannel Command Class) for up to 8 channels for devices with more than 1 output.  For Multichannel nodes, each channel can only be mapped to the same register type, e.g. Counter or Flag, and not a combination of both.

After the Counters and flags have been assigned, remember to press the button 'Write to EEPROM'. After the Write operation is completed, the UCM/Zwave will automatically reset itself.

The "Switch Device On" and "Switch Device Off" buttons allow identification of control of the Z-Wave device for the purpose of testing. For multichannel devices, only channel 1 is addressed by this button.

Make sure that all the Z-wave devices are powered on  during the learning process, otherwise the properties of the node will not be discovered. Also if any polled Zwave device is switched off during operation, this will cause a delay in the polling cycle of up to 7 seconds due to waiting for  the device to respond.

The Control Menu can be used to monitor the status of the Z-wave device by selecting Feedback Type = Counter and selecting the Counter assigned, as shown below



From UCM/Zwave 7.061, setting values into counters and flags which are mapped to Z-Wave nodes will set the Z-Wave device to  the counter value. See "Sending Z-Wave Commands via Counter/flag"

Listening
This indicates if the slave is a Listening Type. Listening means that the slave is always powered on and so can be polled by UCM/ZWave. If the slave is not listening, it may only turn on periodically like a motion sensor or temperature sensor. Non-listening devices will not be polled.

Register Type
When the node type is Virtual Node, Register Type can be Counters, Sensors, Virtual Inputs, Outputs, Responses, Arm and Panic. Refer to "Mapping Comfort Registers to Virtual Nodes". For non-virtual Nodes, only Counter and Flag can be selected.

Virtual Node Info - SEND
This button is used to associate the virtual node with a button or another routing slave. This is described below.


Last edited on Friday Dec 25th, 2015 10:45 am by slychiu



 Posted: Friday Dec 25th, 2015 10:56 am
   
4th Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

Setting up Virtual Nodes

Virtual Nodes are Z-Wave nodes created within UCM/Zwave. The purpose of Virtual  Nodes is to allow other Z-wave devices (e.g. switches or remote controls) to send commands to Comfort or Zwave sensors to send Sensor values to Comfort Sensors. Note that there is no difference to the Zwave network between normal nodes and Virtual nodes on UCM/Zwave.

The UCM/Zwave3 is able to assign up to 128 Virtual Nodes to itself. To create a virtual node, use the primary controller to Include a new Node. For MK LRC14S, press and hold the INC button at the back until the led above it turns on to show it is in Inclusion Mode. Press the 'Create Virtual Node' button in Zwave Configurator. This adds a Z-Wave Node to the network, which is a Virtual Node in UCM/Zwave. The leds on the UCM/Zwave will blink during the process.

If the operation fails, a message "Request Failed" pops  up. This could be due to the Primary Controller not in Inclusion mode. If successful, Comfigurator will automatically read the new Zwave Network from EEPROM.

More virtual nodes can be added in the same way, with the Primary Controller in Inclusion mode. When completed press and hold INC on the MK LRC14S to turn off the Include LED.  

Note that adding Virtual Nodes creates the nodes in the Z-Wave network. You need to Associate the virtual nodes to make them useful.




The screenshot example above has 3 virtual nodes 8, 9, 13 which appear in green to indicate virtual node. Note that the Node Type is Virtual. Virtual Nodes are NOT polled.

Virtual Nodes can be polled by other Zwave nodes to get the status of the mapped Comfort register

Associating Virtual Nodes to Controller Buttons
In order to make the Virtual Node useful, it must be associated with another device e.g. a button on the remote controller and/or a Routing Slave. Remember that a Virtual Node appears to other Zwave devices like another Z-wave Slave device.
  1. Put the controller into Associate Mode. For MK LRC14S, press and hold the ASC button until its LED stays on.
  2. Press the button on the primary controller to be associated e.g. for MK LRC14S, press one of the group/appliance buttons 
  3. Select the Virtual Node in Zwave Configurator and press its Virtual Node Info - SEND button seen in the right pane for the selected Virtual Node (Do NOT press the 'Send Node Info' button in the top menu). This is equivalent to pressing a button on a light switch to associate with the primary controller. The leds on the UCM/Zwave will blink during the process. The leds on the primary controller will also show the progress of the association.
There is no need to update the network using the 'Learn' button after Association because the network information has not changed. Association creates a relationship between two nodes (a Controller or Routing Slave and a Slave). Note that the same button on the primary controller can be associated with several physical as well as Virtual nodes in the network.

Associating Virtual Nodes to Routing Slaves
Routing Slaves are able to send information like their own state to the Z-Wave network without being polled by the UCM/Zwave.
  1. A local button used to toggle the state of a switch can send its state to the network. This can be used to update the state of the Comfort register when its state changes.
  2. A Satellite slave (i.e. a switch button which is not directly connected to a load) can be programmed to control Comfort.
  3. To use a Primary Controller to associate a Routing Slave to a Virtual Node; The procedure below is for the MK LR14S controller - other devices will have their own procedure which is found in their instruction manuals.
  4. Put the Controller into Association Mode by pressing and hold the ASC button until its ASC led turns on Yellow.
  5. Press the button on the Target slave node to be associated, i.e. UCM/Zwave. This is the Virtual Node Info - SEND button. The ASC led will flash green 3 times to indicate receiving of the target device data.
  6. Repeat for other target devices to be associated with the Source device, i.e. other Z-Wave slave devices. A source device can be associated with many target devices.
  7. Press and release (not HOLD) the ASC button. The ASC led will turn Red to indicate that the next device to be received will be the source node.
  8. Press the button on the source slave node to be associated to the Virtual Node.
  9. The ASC led will flash green 2 times to indicate receiving of the source slave data and will turn off to indicate exit from Association Mode.
Note that Routing Slaves associated with Virtual Nodes will update the Virtual node (which has its own mapping). Hence the associated Routing Slave should NOT be mapped to any Counter.

Associating Virtual Nodes to Controller + Routing Slaves
A virtual node can be associated with controller buttons and a routing slave. For example a remote control is used to control a Z-wave light switch. The remote control needs to be associated to the Zwave light which is a Routing slave. We want to map a Comfort counter to the light so that the status of the device can be updated instantaneously regardless of whether the device is controlled by the controller, or by its local switch.
This can be done by associating the Controller button to the Virtual node AND associating the same virtual node with the Z-wave device as described above.

Mapping Comfort Registers to Virtual Nodes
For each virtual node that has been associated through the primary controller, select  a Register Type as Counter, Sensor, Virtual Input, Output, Response, Arm, or Panic.



Counter
Select Counter 0 to 254 and a Counter Name to map to the Virtual Node. Counter 255 is default which means NO Counter. When a command is sent from the associated button or device, a value of 0 for OFF, 255 for ON, or 1 to 99 for level is updated to the counter. The associated Counter Response will be activated, hence allowing a Zwave device to control Comfort.

Sensor
Select Sensor and a Sensor Name to map to the Virtual Node. The sensor value from the Zwave Sensor will be written into the mapped Comfort Sensor. The associated Sensor Response will be activated, hence allowing a Zwave device to control Comfort. Every Comfort Sensor can have a Sensor Response which is activated when a sensor change is received from Zwave.

Virtual Input
Select Virtual Input and an Input/Zone Name to map to the Virtual Node. When a command is sent from the associated button or device, the associated zone will be set to ON or OFF just like being activated by a physical Input. In Security > Zone/Inputs, the mapped zone will be shown as Virtual, and the physical zone will be disabled and will have no effect. The zone will behave according to the Zone Type settings and will trigger Zone Responses and activate its Alarm Type as well. This allows a Z-Wave door/window/motion sensor to trigger a zone in Comfort.

Output
Select Output and an Output Name to map to the Virtual Node. When a command is sent from the associated button or device, an ON command will turn on the mapped output and an OFF command will turn off the mapped output.

Response
Select Response and a Response Name to map to the Virtual Node. When a command is sent from the associated button or device,  it will trigger the mapped Response. This is similar to the Counter and Sensor mapping except that a Response is triggered directly without updating a counter or sensor. Also the value of the command i.e. 0 for OFF, 255 for ON, 1 to 99 for level is sent as a Parameter to the Response so that the Response can act on the value received, e.g.
  If Last Action Value = 0 then
  ...
  Else
    ...
  End If
It is recommended not to map to Responses because when responses are edited, the Response number can change. When mapping to Responses, remember to Write to EEPROM to ensure Response number changes are updated.

Arm
Select Arm and a Mode Away, Night, Day, or Vacation to arm the security system to. When a command is sent from the associated button or device, it will arm the system to the specified mode regardless of off or on command.

Panic
If panic is selected (no additional parameters) the command will immediately activate a panic alarm

Write to EEPROM
After mapping Comfort Registers to all virtual nodes, do Write to EEPROM. This may take a while depending on the number of nodes.




Save File
Always remember to save your cclx file after any change in order to avoid losing your work.

Last edited on Friday Dec 25th, 2015 10:56 am by slychiu



 Posted: Friday Dec 25th, 2015 10:59 am
   
5th Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

Leaving the Z-wave Network - Exclusion
If the UCM/Zwave3 is to be removed from the Z-Wave network, either physically because the module is to be taken away or if the module is in place but is not to take part in any Z-Wave operations, it must be excluded using the Primary Controller. If it is not excluded, the UCM/Zwave will continue to occupy a Node ID in the network and associated devices will try to send messages to it.

Before excluding the UCM/Zwave from a network, be sure to first exclude all Virtual Nodes created by UCM/Zwave.

The following procedure shows how to Exclude Virtual Nodes from the network. The  procedure depends on the Primary controller being used. Here the steps for MK LRC14S are described.
  1. Press and hold the EXC button until its yellow LED remains on.
  2. Select the Virtual Node in Zwave Configurator and press the Virtual Node Info - SEND button seen in the right pane for the selected Virtual Node (Do NOT press the Send Node Info button in the top menu).  
  3. The leds on the UCM/Zwave will blink.
  4. Repeat until all Virtual Nodes are excluded.
  5. Press the EXC button again on the controller to exit from the Exclude Mode.
The following procedure shows how to Exclude the UCM/Zwave from the network.
  1. Press and hold the EXC button until its yellow LED remains on.
  2. Press the Learn Button on the Z-Wave Configurator.
  3. The leds on the UCM/Zwave will blink.
  4. There will be a message "Invalid data in EEPROM. Please Learn Again"
  5. Press the EXC button again to exit from the Exclude Mode.
Reset UCM/Zwave to Default Settings
This is done only when the UCM/Zwave from a network has data in its EEPROM because it has not been excluded from the other network. The proper procedure is always to Exclude the UCM/Zwave from a network before removing the UCM/Zwave to another site. See previous section on Leaving the Z-Wave Network. In short, never "RESET UCM/Zwave to Default Settings" without first Excluding it from the Zwave Network.
  1. Use Comfigurator > Modules Tab, UCM and click on the UCM icon on list of UCMs on the left pane corresponding to the UCM/Zwave. The Z-Wave Configuration Screen is seen.
  2. Press 'Reset' button on the top row, select 'Yes' to continue and login with the Comfort user code (default: 1234). This clears the UCM/Zwave EEPROM to blank or default configuration. Pressing the 'Status Off' button will show "UCM/Zwave not in a network" on the status bar.
The next topics will show how to send Commands to Zwave

Last edited on Friday Dec 25th, 2015 11:01 am by slychiu



 Posted: Friday Dec 25th, 2015 11:37 am
   
6th Post
slychiu
Administrator


Joined: Saturday Apr 29th, 2006
Location: Singapore
Posts: 4853
Status: 
Offline

  back to top

These are the instructions on how to program the UCM/Zwave using Comfigurator

Other topics include



 Current time is 04:30 am
Top




UltraBB 1.172 Copyright © 2007-2014 Data 1 Systems