OZW Class Reference

Public Types
typedef std::map< uint8_t, zwNode * >	zwNodeMap_t

Public Member Functions
	OZW ()
	~OZW ()
void	optionsCreate (std::string configPath="/etc/openzwave", std::string userConfigDir="", std::string cmdLine="")
void	optionAddInt (std::string name, int val)
void	optionAddBool (std::string name, bool val)
void	optionAddString (std::string name, std::string val, bool append)
void	optionsLock ()
bool	init (std::string devicePath, bool isHID=false)
void	dumpNodes (bool all=false)
std::string	getValueUnits (int nodeId, int index)
void	setValueUnits (int nodeId, int index, std::string text)
std::string	getValueLabel (int nodeId, int index)
void	setValueLabel (int nodeId, int index, std::string text)
std::string	getValueHelp (int nodeId, int index)
void	setValueHelp (int nodeId, int index, std::string text)
void	setValueAsString (int nodeId, int index, std::string val)
void	setValueAsBool (int nodeId, int index, bool val)
void	setValueAsByte (int nodeId, int index, uint8_t val)
void	setValueAsFloat (int nodeId, int index, float val)
void	setValueAsInt32 (int nodeId, int index, int32_t val)
void	setValueAsInt16 (int nodeId, int index, int16_t val)
void	setValueAsBytes (int nodeId, int index, uint8_t *val, uint8_t len)
int	getValueMin (int nodeId, int index)
int	getValueMax (int nodeId, int index)
bool	isValueReadOnly (int nodeId, int index)
bool	isValueWriteOnly (int nodeId, int index)
bool	isValueSet (int nodeId, int index)
bool	isValuePolled (int nodeId, int index)
std::string	getValueAsString (int nodeId, int index)
bool	getValueAsBool (int nodeId, int index)
uint8_t	getValueAsByte (int nodeId, int index)
float	getValueAsFloat (int nodeId, int index)
int	getValueAsInt32 (int nodeId, int index)
int	getValueAsInt16 (int nodeId, int index)
void	refreshValue (int nodeId, int index)
void	setDebug (bool enable)
bool	isNodeListeningDevice (int nodeId)
bool	isNodeFrequentListeningDevice (int nodeId)
bool	isNodeAwake (int nodeId)

Protected Member Functions
bool	getValueID (int nodeId, int index, OpenZWave::ValueID *vid)
void	lockNodes ()
void	unlockNodes ()

Constructor & Destructor Documentation

OZW

(

)

OZW constructor

~OZW

(

)

OZW Destructor

Member Function Documentation

void optionsCreate	(	std::string	configPath = "/etc/openzwave",
		std::string	userConfigDir = "",
		std::string	cmdLine = ""
	)

Start configuration with basic options. This must be called prior to init(), after the OZW() contructor is called.

Parameters

configPath	Set the location of the OpenZWave config directory, default is /etc/openzwave
userConfigDir	Set the path to the user configuration directory. This is the location of the zwcfg*.xml and option.xml files for the user (probably created by the OpenZWave Control Panel example application). The default is the current directory ("").
cmdLine	Specify command line formatted options to OpenZWave. The default is "".

void optionAddInt	(	std::string	name,
		int	val
	)

Add an integer Option. See the OpenZWave documentation for valid values.

Parameters

name	The name of the configuration option
val	The value to set it to

void optionAddBool	(	std::string	name,
		bool	val
	)

Add a boolean Option. See the OpenZWave documentation for valid values.

Parameters

name	The name of the configuration option
val	The value to set it to

void optionAddString	(	std::string	name,
		std::string	val,
		bool	append
	)

Add a string Option. See the OpenZWave documentation for valid values.

Parameters

name	The name of the configuration option
val	The value to set it to true to append to the option, false to override

void optionsLock

(

)

Lock the Options. This must be called after all options have been set, and before init() is called. If init() is called without locking the Options, init() will lock them itself. After the options have been locked, no further options can be specified.

bool init	(	std::string	devicePath,
		bool	isHID = false
	)

Initialize the ZWave network. This method will start a probe of all defined devices on the ZWave network and query essential information about them. This function will not return until either initialization has failed, or has succeeded far enough along for the following methods to work. Depending on the size an complexity of the ZWave network, this may take anywhere from seconds to several minutes to complete.

All Options (via option*()) must have been specified before this function is called. If the Options have not been locked via optionsLock() prior to calling init(), this method will lock them for you before proceeding.

Parameters

devicePath	The device path for the ZWave controller, typically something like /dev/ttyACM0, or similiar
isHID	true if this is a HID device, false otherwise (ie: a serial port like /dev/ttyACM0, /dev/ttyUSB0, etc). Default is false.

Returns

true if init succeeded, false otherwise

void dumpNodes

(

bool

all = false

)

Dump information about all configured nodes and their values to stdout. This is useful to determine what nodes are available, and the index (used for querying and seting values for them). In addition, it includes information about each value (type, current value, etc).

Parameters

all	set to true to dump information about all values available for each node. If false, only information about 'user' values (ignoring 'system' and 'configuration') are output. The default is false ('user' values only).

string getValueUnits	(	int	nodeId,
		int	index
	)

Return a string (which may be empty) indicating the Units of measure for a given value. For example, querying a temperature value may return "F" to indicate Fahrenheit.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.

Returns

A string containing the Unit of measure for the value

void setValueUnits	(	int	nodeId,
		int	index,
		std::string	text
	)

Set the text for the Units of measure for a value.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.
text	The text to set

string getValueLabel	(	int	nodeId,
		int	index
	)

Return a string (which may be empty) containing the user-freindly Label for a value.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.

Returns

A string containing the Value's label

void setValueLabel	(	int	nodeId,
		int	index,
		std::string	text
	)

Set the text for a Value's label.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.
text	The text to set

string getValueHelp	(	int	nodeId,
		int	index
	)

Return a string (which may be empty) indicating the Help text of a value, if available.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.

Returns

A string containing the Help text, if available

void setValueHelp	(	int	nodeId,
		int	index,
		std::string	text
	)

Set the text for a Value's help text.

Parameters

nodeId	The node ID to query
index	The value index (see dumpNodes()) of the value to query.
text	The text to set

void setValueAsString	(	int	nodeId,
		int	index,
		std::string	val
	)

Set the contents of a Value to a string. This should always succeed if the supplied content makes sense for a given value, regardless of the value's actual type.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the content to assign to the value referenced by nodeId, and index.

void setValueAsBool	(	int	nodeId,
		int	index,
		bool	val
	)

Set the contents of a Value, to a bool. This will fail, and an error message printed if the value type is not a boolean value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the boolean content to assign to the value referenced by nodeId, and index.

void setValueAsByte	(	int	nodeId,
		int	index,
		uint8_t	val
	)

Set the contents of a Value, to a byte. This will fail, and an error message printed if the value type is not a byte value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the byte content to assign to the value referenced by nodeId, and index.

void setValueAsFloat	(	int	nodeId,
		int	index,
		float	val
	)

Set the contents of a Value, to a float. This will fail, and an error message printed if the value type is not a float value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the float content to assign to the value referenced by nodeId, and index.

void setValueAsInt32	(	int	nodeId,
		int	index,
		int32_t	val
	)

Set the contents of a Value, to a 32 bit integer (int32). This will fail, and an error message printed if the value type is not an int32.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the int32 content to assign to the value referenced by nodeId, and index.

void setValueAsInt16	(	int	nodeId,
		int	index,
		int16_t	val
	)

Set the contents of a Value, to a 16 bit integer (int16). This will fail, and an error message printed if the value type is not an int16.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the int16 content to assign to the value referenced by nodeId, and index.

void setValueAsBytes	(	int	nodeId,
		int	index,
		uint8_t *	val,
		uint8_t	len
	)

Set the contents of a Value, to an array of bytes. This will fail, and an error message printed if the value type is not settable as an array of bytes.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
val	the byte array content to assign to the value referenced by nodeId, and index.
len	The length of the byte array

int getValueMin	(	int	nodeId,
		int	index
	)

Get the minimum allowed value for a node's Value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

The minumum allowed value

int getValueMax	(	int	nodeId,
		int	index
	)

Get the maximum allowed value for a node's Value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

The maximum allowed value

bool isValueReadOnly	(	int	nodeId,
		int	index
	)

Test whether a value is read-only.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

true if the value is read-only, false otherwise

bool isValueWriteOnly	(	int	nodeId,
		int	index
	)

Test whether a value is write only.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

true if the value is write-only, false otherwise

bool isValueSet	(	int	nodeId,
		int	index
	)

Test whether a value is really set on a node, and not a default value chosen by the OpenZWave library.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

true if the value is really set, false if a default value is being reported

bool isValuePolled	(	int	nodeId,
		int	index
	)

Test whether a value is being manually polled by the OpenZWave library. Most modern devices are never polled, rather they are configured to report changing values to the controller on their own at device specific intervals or when appropriate events (depending the device) have occured.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

true if the value is being maually polled, false otherwise being reported

string getValueAsString	(	int	nodeId,
		int	index
	)

Return the content of a value as a string. This should always succeed, regardless of the actual value type.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

A string representing the current contents of a value.

bool getValueAsBool	(	int	nodeId,
		int	index
	)

Return the content of a value as a booleang. This will fail, and an error message printed if the value type is not boolean.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

A boolean representing the current contents of a value.

uint8_t getValueAsByte	(	int	nodeId,
		int	index
	)

Return the content of a value as a byte. This will fail, and an error message printed if the value type is not a byte.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

A byte representing the current contents of a value.

float getValueAsFloat	(	int	nodeId,
		int	index
	)

Return the content of a value as a float. This will fail, and an error message printed if the value type is not a floating point value.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

A float representing the current contents of a value.

int getValueAsInt32	(	int	nodeId,
		int	index
	)

Return the content of a value as an int32. This will fail, and an error message printed if the value type is not an int32.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

An int32 representing the current contents of a value.

int getValueAsInt16	(	int	nodeId,
		int	index
	)

Return the content of a value as an int16. This will fail, and an error message printed if the value type is not an int16.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

Returns

An int16 representing the current contents of a value.

void refreshValue	(	int	nodeId,
		int	index
	)

Issue a refresh request for a value on a node. OpenZWave will query the value and update it's internal state when the device responds. Note, this happens asynchronously - it may take some time before the current value is reported to OpenZWave by the node. If the node is asleep, you may not get a current value for some time (or at all, depending on the device). This method will return immediately after the request has been queued.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.

void setDebug

(

bool

enable

)

Enable or disable some debugging output. Note, this will not affect OpenZWave's own debugging, which is usually set in the option.xml file.

Parameters

enable

true to enable debugging, false otherwise

bool isNodeListeningDevice

(

int

nodeId

)

Determine if a node is a listening device – in other words, the node never sleeps.

Parameters

nodeId

The node ID

Returns

true if the node never sleeps, false otherwise

bool isNodeFrequentListeningDevice

(

int

nodeId

)

Determine if a node is a frequent listening device – in other words, if the node is asleep, can it be woken by a beam.

Parameters

nodeId

The node ID

Returns

true if the node is a frequent listening device, false otherwise

bool isNodeAwake

(

int

nodeId

)

Determine if a node is awake.

Parameters

nodeId

The node ID

Returns

true if the node is awake, false otherwise

bool getValueID ( int  nodeId, int  index, OpenZWave::ValueID *  vid  )

protected

Based on a nodeId and a value index, lookup the corresponding OpenZWave ValueID.

Parameters

nodeId	The node ID
index	The value index (see dumpNodes()) of the value to query.
A	pointer to a ValueID that will be returned if successful

Returns

true of the nodeId and index was found, false otherwise

void lockNodes ( )

inlineprotected

Lock the m_zwNodeMap mutex to protect against changes made to the the the map by the OpenZWave notification handler. Always lock this mutex when acessing anything in the zwNodeMap map.

void unlockNodes ( )

inlineprotected

Unlock the m_zwNodeMap mutex after lockNodes() has been called.

---

The documentation for this class was generated from the following files:

• /iotdk/jenkins/workspace/upm-doc-stable/src/ozw/ozw.h
• /iotdk/jenkins/workspace/upm-doc-stable/src/ozw/ozw.cxx