Security 0 Inclusion state machine

Interface to Z-Wave S0 Inclusion State Machine. More...

Collaboration diagram for Security 0 Inclusion state machine:

Enumerations
enum	s0_bootstrap_state_t {   S0_INC_IDLE , S0_AWAITING_SCHEME_REPORT , S0_HANDLE_SCHEME_REPORT , S0_AWAITING_KEY_VERIFY ,   S0_HANDLE_NET_KEY_VERIFY , S0_AWAITING_2SCHEME_REPORT }

Functions
void	s0_bootstrapping_start (const zwave_controller_connection_info_t *conn, uint8_t is_controller)
	Start the S0 add node process. More...
void	s0_bootstrapping_stop (void)
	Stop the S0 bootstrapping timers. More...
void	s0_scheme_report_received (uint8_t scheme, zwave_node_id_t from_node)
	This function is used to notify the S0 Inclusion state machine that S0 Scheme report frame was received. More...
void	s0_network_key_verify_received (zwave_node_id_t from_node)
	This function is used to notify the S0 Inclusion state machine that S0 network key verify frame was received. More...
void	s0_set_callback (s0_on_bootstrapping_complete_cb cb)
	Set callback function for the S0 bootstrap. This callback function is copied internally into S0 and called when S0 bootstrap is complete. More...
s0_bootstrap_state_t	get_s0_sm_state ()
	Get the state of S0 Bootstrap state machine. More...

Detailed Description

Interface to Z-Wave S0 Inclusion State Machine.

Enumeration Type Documentation

s0_bootstrap_state_t

enum s0_bootstrap_state_t

Enumerator
S0_INC_IDLE
S0_AWAITING_SCHEME_REPORT
S0_HANDLE_SCHEME_REPORT
S0_AWAITING_KEY_VERIFY
S0_HANDLE_NET_KEY_VERIFY
S0_AWAITING_2SCHEME_REPORT

Function Documentation

get_s0_sm_state()

s0_bootstrap_state_t get_s0_sm_state

(

)

Get the state of S0 Bootstrap state machine.

s0_bootstrapping_start()

void s0_bootstrapping_start	(	const zwave_controller_connection_info_t *	conn,
		uint8_t	is_controller
	)

Start the S0 add node process.

Calling this function will make the S0 FSM start the bootstrap process of a newly added node. This must be called right after ADD_NODE_DONE event for nodes supporting COMMAND_CLASS_SECURITY

Parameters

conn	zwave_controller_connection_info_t structure
is_controller	If the node being included controller. To do extra S0 boot strapping steps for controllers

Here is the call graph for this function:

Here is the caller graph for this function:

s0_bootstrapping_stop()

void s0_bootstrapping_stop

(

void

)

Stop the S0 bootstrapping timers.

Here is the call graph for this function:

Here is the caller graph for this function:

s0_network_key_verify_received()

void s0_network_key_verify_received

(

zwave_node_id_t

from_node

)

This function is used to notify the S0 Inclusion state machine that S0 network key verify frame was received.

Here is the call graph for this function:

Here is the caller graph for this function:

s0_scheme_report_received()

void s0_scheme_report_received	(	uint8_t	scheme,
		zwave_node_id_t	from_node
	)

This function is used to notify the S0 Inclusion state machine that S0 Scheme report frame was received.

Here is the call graph for this function:

Here is the caller graph for this function:

s0_set_callback()

void s0_set_callback

(

s0_on_bootstrapping_complete_cb

cb

)

Set callback function for the S0 bootstrap. This callback function is copied internally into S0 and called when S0 bootstrap is complete.

Here is the caller graph for this function: