Z-Wave Protocol Controller Reference
ZPC Attribute Resolver

ZPC part of the attribute resolver. More...

Collaboration diagram for ZPC Attribute Resolver:

Modules

 ZPC Attribute Resolver Fixtured
 ZPC Attribute Resolver fixtures.
 
 ZPC Attribute Resolver Internals
 Internal functions for the ZPC Attribute Resolver.
 

Typedefs

typedef void(* zpc_resolver_event_notification_function_t) (attribute_store_node_t node, resolver_rule_type_t rule_type, zpc_resolver_event_t event)
 

Enumerations

enum  zpc_resolver_event_t {
  FRAME_SENT_EVENT_OK_NO_SUPERVISION , FRAME_SENT_EVENT_OK_SUPERVISION_SUCCESS , FRAME_SENT_EVENT_OK_SUPERVISION_NO_SUPPORT , FRAME_SENT_EVENT_OK_SUPERVISION_WORKING ,
  FRAME_SENT_EVENT_OK_SUPERVISION_FAIL , FRAME_SENT_EVENT_FAIL
}
 

Functions

sl_status_t register_send_event_handler (attribute_store_type_t type, zpc_resolver_event_notification_function_t function)
 Registers a custom function for sent events. The ZPC Resolver will call this function and will not execute the default sent data complete handling for a given type when a handler is registered. More...
 
sl_status_t unregister_send_event_handler (attribute_store_type_t type, zpc_resolver_event_notification_function_t function)
 unregisters a custom function for sent events. More...
 

Detailed Description

ZPC part of the attribute resolver.

The ZPC Attribute resolver is in charge of sending frames and listening for Send data callbacks in the context of resolving attributes. It then relays resolution information to the attribute_resolver

Typedef Documentation

◆ zpc_resolver_event_notification_function_t

typedef void(* zpc_resolver_event_notification_function_t) (attribute_store_node_t node, resolver_rule_type_t rule_type, zpc_resolver_event_t event)

Enumeration Type Documentation

◆ zpc_resolver_event_t

Enumerator
FRAME_SENT_EVENT_OK_NO_SUPERVISION 

Frame was delivered to the node without supervision.

FRAME_SENT_EVENT_OK_SUPERVISION_SUCCESS 

Frame was delivered to the node with Supervision, and it responded with SUPERVISION_REPORT_SUCCESS.

FRAME_SENT_EVENT_OK_SUPERVISION_NO_SUPPORT 

Frame was delivered to the node with Supervision, and it responded with SUPERVISION_REPORT_NO_SUPPORT.

FRAME_SENT_EVENT_OK_SUPERVISION_WORKING 

Frame was delivered to the node with Supervision, and it responded with SUPERVISION_REPORT_WORKING.

FRAME_SENT_EVENT_OK_SUPERVISION_FAIL 

Frame was delivered to the node with Supervision, and it responded with SUPERVISION_REPORT_FAIL.

FRAME_SENT_EVENT_FAIL 

Frame was not delivered to the node.

Function Documentation

◆ register_send_event_handler()

sl_status_t register_send_event_handler ( attribute_store_type_t  type,
zpc_resolver_event_notification_function_t  function 
)

Registers a custom function for sent events. The ZPC Resolver will call this function and will not execute the default sent data complete handling for a given type when a handler is registered.

Parameters
typeThe attribute store type for which the custom handler will take care
functionThe function to invoke when a send data complete event occurred.
Returns
sl_status_t indicating the outcome of the registration. Only one handler can be registered at a time.
Here is the caller graph for this function:

◆ unregister_send_event_handler()

sl_status_t unregister_send_event_handler ( attribute_store_type_t  type,
zpc_resolver_event_notification_function_t  function 
)

unregisters a custom function for sent events.

Parameters
typeThe attribute store type for the custom handler
functionThe function that was registered as a handler.
Returns
SL_STATUS_OK