Open Zwave - Revision history

Sambuca at 20:39, 25 April 2014

2014-04-25T20:39:47Z

←Older revision		Revision as of 20:39, 25 April 2014
Line 4:		Line 4:
	[[Category: Programmer's Guide]]		[[Category: Programmer's Guide]]
	[[Category: Documentation]]		[[Category: Documentation]]

			OpenZWave is a library implementing the ZWave protocol. LinuxMCE 1204 and onwards uses this library to add ZWave support.

	== Overview ==		== Overview ==
Line 12:		Line 14:

	This page is intended as a placeholder for notes and documentation on how to setup and configure the Z-Wave network with Open-Zwave.		This page is intended as a placeholder for notes and documentation on how to setup and configure the Z-Wave network with Open-Zwave.


	For information about what hardware to get look at [[Z-Wave Getting Started]], or check out the [[:Category:ZWave\|Z-Wave Wiki Category]].		For information about what hardware to get look at [[Z-Wave Getting Started]], or check out the [[:Category:ZWave\|Z-Wave Wiki Category]].


	== Configuring and setting up ==		== Configuring and setting up ==
Line 62:		Line 62:

	=== ZWave network update related ===		=== ZWave network update related ===
			Some of the following commands can be done from the [[Advanced ZWave]] page.

	The StatusReport command can be used for several different actions, depending on the parameter:		The StatusReport command can be used for several different actions, depending on the parameter:
	* NNU<nodeid> : RequestNodeNeighborUpdate		* NNU<nodeid> : RequestNodeNeighborUpdate

RayBe at 10:41, 14 March 2014

2014-03-14T10:41:11Z

←Older revision		Revision as of 10:41, 14 March 2014
Line 42:		Line 42:

	When starting a new ZWave network, it is recommended to first remove all node bindings to the controller, then reset the controller, to enable SUC/SIS mode.		When starting a new ZWave network, it is recommended to first remove all node bindings to the controller, then reset the controller, to enable SUC/SIS mode.
			Send the Reset command to the ZWave device, with the argument set to "ResetController". This will clear out all network data on the ZWave interface, and will delete all nodes.
	(if you have enabled SUC/SIS mode previously this will still apply and you can skip this step)		(if you have enabled SUC/SIS mode previously this will still apply and you can skip this step)
	~~Send the Reset command to the ZWave device, with the argument set to "ResetController". This will clear out all network data on the ZWave interface, and will delete all nodes.~~

RayBe: SUC/SIS now works

2014-03-14T10:40:14Z

SUC/SIS now works

←Older revision		Revision as of 10:40, 14 March 2014
Line 41:		Line 41:
	== How to install and use ZWave ==		== How to install and use ZWave ==

	When starting a new ZWave network, it is recommended to reset the controller ~~first~~, to enable SUC/SIS mode.		When starting a new ZWave network, it is recommended to first remove all node bindings to the controller, then reset the controller, to enable SUC/SIS mode.
			(if you have enabled SUC/SIS mode previously this will still apply and you can skip this step)
	Send the Reset command to the ZWave device, with the argument set to "ResetController". This will clear out all network data on the ZWave interface, and will delete all nodes.		Send the Reset command to the ZWave device, with the argument set to "ResetController". This will clear out all network data on the ZWave interface, and will delete all nodes.

	~~(currently, enabling SUC/SIS mode does not work on 1204 - but if you have enabled SUC/SIS mode previously this will still apply and you can skip this step)~~

	== Setting associations ==		== Setting associations ==

Sambuca: /* Polling of values */

2013-10-17T07:26:31Z

Polling of values

←Older revision		Revision as of 07:26, 17 October 2013
Line 74:		Line 74:
	As only some ZWave devices report their value to us, the ZWave DCE device will automatically tell OpenZWave to poll interesting values for us. This is the default and requires no setup by the user.		As only some ZWave devices report their value to us, the ZWave DCE device will automatically tell OpenZWave to poll interesting values for us. This is the default and requires no setup by the user.

	An alternative is to disable the automatic polling and set this on a per-value basis. This allows more flexibility in what values to poll and how often. If you use the default polling and have a lot of ZWave devices, you may find that updates to a particular value is too long apart. You can tweak this by specifying the values to poll by yourself.		An alternative is to disable the automatic polling and set this on a per-value basis. This allows more flexibility in what values to poll and how often. If you use the default polling and have a lot of ZWave devices, you may find that updates to a particular value is too long apart. You can tweak this by specifying the values to poll by yourself, avoiding uninteresting values.

			Turning on and off the automatic polling is done with the Polling device data on the advanced ZWave device page. (A reload is required after changing this). When automatic polling is off, you can look at the ZWave log to see what values it normally would poll for you. You can use this list to decide on what to poll.
			* Please note that turning off automatic polling does not remove current polling of values, it simply stops adding polling of new values/nodes that you add.

	Turning on and off the automatic polling is done with the Polling device data on the advanced ZWave device page. (A reload is required after changing this). When automatic polling is off, you can look at the ZWave log to see what values it normally would poll for you. You can use this list to decide on what to poll.

	Setting polling for a single value is done with the Set Polling State command. The argument descriptions for this command is not quite correct for 1204, as they are the same as in previous LMCE versions (they will/should be fixed in the future).		Setting polling for a single value is done with the Set Polling State command. The argument descriptions for this command is not quite correct for 1204, as they are the same as in previous LMCE versions (they will/should be fixed in the future).
Line 86:		Line 88:

	The polling status of each value is stored in the OpenZWave configuration file (/etc/openzwave/zwcfg_<...>.xml) and is loaded again at startup.		The polling status of each value is stored in the OpenZWave configuration file (/etc/openzwave/zwcfg_<...>.xml) and is loaded again at startup.

			If you already have a lot of nodes, you can turn off automatic polling, and use Set Polling State to disable polling for values that you are not interested in.

	== Update node information ==		== Update node information ==

Sambuca: /* Polling of values */

2013-10-17T07:20:51Z

Polling of values

←Older revision		Revision as of 07:20, 17 October 2013
Line 83:		Line 83:
	* Report: The polling state (1=poll, 0=no poll)		* Report: The polling state (1=poll, 0=no poll)
	* Always: Store the current polling setup (will store polling state for all devices/value, not only the one specified in this command)		* Always: Store the current polling setup (will store polling state for all devices/value, not only the one specified in this command)
	NodeID: Not used at the moment		* NodeID: Not used at the moment

			The polling status of each value is stored in the OpenZWave configuration file (/etc/openzwave/zwcfg_<...>.xml) and is loaded again at startup.

	== Update node information ==		== Update node information ==

Sambuca: /* Tweak advanced ZWave settings */

2013-10-17T07:17:22Z

Tweak advanced ZWave settings

@@ Line 62: / Line 62: @@
 == Tweak advanced ZWave settings ==
 The StatusReport command can be used for several different actions, depending on the parameter:
 * NNU<nodeid> : RequestNodeNeighborUpdate
@@ Line 69: / Line 70: @@
 You should know what you are doing before trying any of these.
 == Update node information ==

Sambuca: /* How to install and use ZWave */

2013-10-15T06:15:46Z

How to install and use ZWave

←Older revision		Revision as of 06:15, 15 October 2013
Line 40:		Line 40:

	== How to install and use ZWave ==		== How to install and use ZWave ==

			When starting a new ZWave network, it is recommended to reset the controller first, to enable SUC/SIS mode.

			Send the Reset command to the ZWave device, with the argument set to "ResetController". This will clear out all network data on the ZWave interface, and will delete all nodes.

			(currently, enabling SUC/SIS mode does not work on 1204 - but if you have enabled SUC/SIS mode previously this will still apply and you can skip this step)

	== Setting associations ==		== Setting associations ==

Sambuca: /* Tweak advanced ZWave settings */

2013-10-15T06:13:35Z

Tweak advanced ZWave settings

←Older revision		Revision as of 06:13, 15 October 2013
Line 55:		Line 55:

	== Tweak advanced ZWave settings ==		== Tweak advanced ZWave settings ==

			The StatusReport command can be used for several different actions, depending on the parameter:
			* NNU<nodeid> : RequestNodeNeighborUpdate
			* NU<nodeid> : RequestNetworkUpdate
			* HNN<nodeid> : HealNodeNetwork
			* HN : HealNetwork

			You should know what you are doing before trying any of these.

	== Update node information ==		== Update node information ==

Sambuca: /* Setting associations */

2013-10-15T06:10:07Z

Setting associations

←Older revision		Revision as of 06:10, 15 October 2013
Line 42:		Line 42:

	== Setting associations ==		== Setting associations ==
			You might need to set associations between your ZWave devices. The function of these associations can usually be found in your devices' manual. Generally, associations connects an action on one device with an action on another device. For instance, you can associate a button(switch) device with a dimmer device, and have the button control the dimmer.

			* Go to Advanced -> Configuration -> Devices this shows the device tree on the left
			* Click the top level Zwave device with "Device Template #: 1754"
			* Click Send command to device button for the popup-screen to appear
			Select Set Association and fill in the parameters:
			* NodeID: The node to set associations for
			* GroupID: The association group on the node to set. Different groups often have different meaning(or actions if you will)
			* Nodes List: a comma separated list of node IDs to associate to.

			To remove associations, use negative node ids in the Node List parameter.

	== Tweak advanced ZWave settings ==		== Tweak advanced ZWave settings ==

Sambuca: /* Configuring and setting up */

2013-10-15T06:04:32Z

Configuring and setting up

←Older revision		Revision as of 06:04, 15 October 2013
Line 28:		Line 28:
	* Adding a new device to the zwave network:		* Adding a new device to the zwave network:
	** Select '''Add Node'''		** Select '''Add Node'''
	* Stop adding a new device:		** Activate the inclusion mode on the device to include (usually triple click to send the "node info frame") - see your devices' manual for exact information
			* Stop adding a new device (if you want to cancel the command - no need to do this if you actually add a node):
	** Select '''Add Node'''		** Select '''Add Node'''
	** Set '''48 Value (int)''' to 5		** Set '''48 Value (int)''' to 5
	* Remove a Device		* Remove a Device
			** Select '''Remove Node'''
			** Send the "node info frame" from the device (usually triple click a button on the device) - see your devices' manual for exact information
			* Remove a Failed Device
	** Select '''Remove Node'''		** Select '''Remove Node'''
	** Set '''48 Value (int)''' to -<node_you_want_to_remove> e.g. '''-7''' to remove node 7		** Set '''48 Value (int)''' to -<node_you_want_to_remove> e.g. '''-7''' to remove node 7


	== How to install and use ZWave ==		== How to install and use ZWave ==