EventDistributor#

EEventDistributorStatus#

EEventDistributorStatus

Defines return values from EventDistributorConfigure.

zaf_event_distributor_cc_event_handler_handler_v1_t#

typedef void(* zaf_event_distributor_cc_event_handler_handler_v1_t) (const uint8_t, const void *) )(const uint8_t, const void *)

zaf_event_distributor_cc_event_handler_map_latest_t#

typedef zaf_event_distributor_cc_event_handler_map_v1_t zaf_event_distributor_cc_event_handler_map_latest_t

Redefine latest version to a common define called latest.

EEventDistributorStatus#

typedef enum EEventDistributorStatus EEventDistributorStatus

Defines return values from EventDistributorConfigure.

EventDistributorEventHandler#

typedef void(* EventDistributorEventHandler) (void) )(void)

Defines callback pointer for Event handler.

Typedef to simplify syntax.

SEventDistributor#

typedef struct SEventDistributor SEventDistributor

EventDistributor object.

All content is private.

zaf_event_distributor_init#

void zaf_event_distributor_init (void )

Initializes the ZAF Event Distributor component.

This function invokes EventDistributorConfig().

zaf_event_distributor_get#

const SEventDistributor * zaf_event_distributor_get (void )

Gets the events distributor.

Each variation (NCP,SOC) must implement it's own event distributor table

Returns

• const SEventDistributor

zaf_event_distributor_distribute#

bool zaf_event_distributor_distribute (void )

Distributes events.

Wraps EventDistributorDistribute().

Returns

• true In case of success

• false In case of error

zaf_event_distributor_app_zw_rx#

void zaf_event_distributor_app_zw_rx (SZwaveReceivePackage * RxPackage)

Used by the application to handle protocol received events.

zaf_event_distributor_app_zw_command_status#

void zaf_event_distributor_app_zw_command_status (SZwaveCommandStatusPackage * Status)

Used by the application to handle protocol command status.

zaf_event_distributor_app_state_change#

void zaf_event_distributor_app_state_change (void )

Used by the application to handle state changes in the NCP state machine.

zaf_event_distributor_app_serial_data_rx#

void zaf_event_distributor_app_serial_data_rx (void )

Used by the application to handle serial data received.

zaf_event_distributor_app_serial_timeout#

void zaf_event_distributor_app_serial_timeout (void )

Used by the application to handle serial timeout.

zaf_event_distributor_app_event_manager#

void zaf_event_distributor_app_event_manager (const uint8_t event)

Used by the application to handle application/system received events.

zaf_event_distributor_is_primary_controller#

uint8_t zaf_event_distributor_is_primary_controller (void )

Used by application to verify if it is a primary controller.

Returns

• uint8_t 1 if it is primary controller else 0

zaf_event_distributor_enqueue_app_event#

bool zaf_event_distributor_enqueue_app_event (const uint8_t event)

Enqueues an event in the application queue.

Returns

• Returns true if the event was enqueued and false otherwise.

zaf_event_distributor_enqueue_app_event_from_isr#

bool zaf_event_distributor_enqueue_app_event_from_isr (const uint8_t event)

Enqueues an event in the application queue.

Returns

• Returns true if the event was enqueued and false otherwise.

zaf_event_distributor_enqueue_cc_event#

bool zaf_event_distributor_enqueue_cc_event (const uint16_t command_class, const uint8_t event, const void * data)

Enqueues an event in the command class event queue.

Returns

• Returns true if the event was enqueued and false otherwise.

zaf_event_distributor_enqueue_cc_event_from_isr#

bool zaf_event_distributor_enqueue_cc_event_from_isr (const uint16_t command_class, const uint8_t event, const void * data)

Enqueues an event in the command class event queue.

Returns

• Returns true if the event was enqueued and false otherwise.

EventDistributorConfig#

EEventDistributorStatus EventDistributorConfig (SEventDistributor * pThis, uint8_t iEventHandlerTableSize, const EventDistributorEventHandler * pEventHandlerTable, void(*)(void) pNoEvent)

Configures the EventDistributor.

Configure must be called before calling any other EventDistributor methods. EventDistributor supports reconfiguration at all times.

EventDistributorDistribute#

uint32_t EventDistributorDistribute (const SEventDistributor * pThis, uint32_t iEventWait, uint32_t NotificationClearMask)

Waits for Task notification and calls event handlers matching the set notification bits.

Method returns when a notification has arrived (or waiting timed out) and any pending events has been handled.

Returns

• uint32_t Task notification value. All bits handled by EventDistributor are set to zero.

ZAF_EVENT_DISTRIBUTOR_CC_EVENT_HANDLER_SECTION#

#define ZAF_EVENT_DISTRIBUTOR_CC_EVENT_HANDLER_SECTION

"zw_zaf_event_distributor_cc_event_handler"

Section name.

ZAF_EVENT_DISTRIBUTOR_REGISTER_CC_EVENT_HANDLER#

#define ZAF_EVENT_DISTRIBUTOR_REGISTER_CC_EVENT_HANDLER

Registers a custom event handler for a specific command class.