Z-Wave Controller keyset utility

Small utility allowing to process keyset structures. More...

Collaboration diagram for Z-Wave Controller keyset utility:

Functions
zwave_controller_encapsulation_scheme_t	zwave_controller_get_highest_encapsulation (zwave_keyset_t keyset)
	Get the hight encapsulation supported by a given key set. More...
bool	zwave_controller_encapsulation_scheme_greater_equal (zwave_controller_encapsulation_scheme_t k, zwave_controller_encapsulation_scheme_t v)
	Function to tell whether scheme k is greater or equal to scheme v. More...
zwave_keyset_t	zwave_controller_get_key_from_encapsulation (zwave_controller_encapsulation_scheme_t encapsulation)
	Get the Z-Wave Key used for a given encapsulation. More...

Detailed Description

Small utility allowing to process keyset structures.

This utility is used to retrieve the list of keys that is granted to the ZPC or any node in the network. It can also convert a keyset to the corresponding highest encapsulation scheme that can be used for a transmission.

Function Documentation

zwave_controller_encapsulation_scheme_greater_equal()

bool zwave_controller_encapsulation_scheme_greater_equal	(	zwave_controller_encapsulation_scheme_t	k,
		zwave_controller_encapsulation_scheme_t	v
	)

Function to tell whether scheme k is greater or equal to scheme v.

Parameters

k	The first zwave_controller_encapsulation_scheme_t variable.
v	The second zwave_controller_encapsulation_scheme_t variable.

Returns

bool True if k is greater or equal to v; otherwise false

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_controller_get_highest_encapsulation()

zwave_controller_encapsulation_scheme_t zwave_controller_get_highest_encapsulation

(

zwave_keyset_t

keyset

)

Get the hight encapsulation supported by a given key set.

Parameters

keyset

zwave_keyset_t representing the set of granted keys to a node

Returns

zwave_controller_encapsulation_scheme_t value representing the highest granted key. Note that ZWAVE_CONTROLLER_ENCAPSULATION_NETWORK_SCHEME will not be returned.

Here is the caller graph for this function:

zwave_controller_get_key_from_encapsulation()

zwave_keyset_t zwave_controller_get_key_from_encapsulation

(

zwave_controller_encapsulation_scheme_t

encapsulation

)

Get the Z-Wave Key used for a given encapsulation.

Parameters

encapsulation

zwave_controller_encapsulation_scheme_t Encapsulation scheme value

Returns

zwave_keyset_t with only 1 key.

Here is the caller graph for this function: