Event Manager#

Enumerations#

enum

_EVENT_SYSTEM_ {

EVENT_SYSTEM_RESET = DEFINE_EVENT_SYSTEM_NBR

EVENT_SYSTEM_LEARNMODE_START

EVENT_SYSTEM_LEARNMODE_FINISHED

EVENT_SYSTEM_LEARNMODE_STOP

EVENT_SYSTEM_LEARNMODE_TOGGLE

EVENT_SYSTEM_WATCHDOG_RESET

EVENT_SYSTEM_OTA_START

EVENT_SYSTEM_LEARNMODE_DSK_START

EVENT_SYSTEM_FLUSHMEM_READY

EVENT_SYSTEM_SMARTSTART_IN_PROGRESS

EVENT_SYSTEM_EMPTY

}

System events.

enum

_BUTTON_EVENT_ {

EVENT_PB1_DOWN = DEFINE_EVENT_KEY_NBR

EVENT_PB1_UP

EVENT_PB1_SHORT_PRESS

EVENT_PB1_HOLD

EVENT_PB1_LONG_PRESS

EVENT_PB2_DOWN

EVENT_PB2_UP

EVENT_PB2_SHORT_PRESS

EVENT_PB2_HOLD

EVENT_PB2_LONG_PRESS

EVENT_PB3_DOWN

EVENT_PB3_UP

EVENT_PB3_SHORT_PRESS

EVENT_PB3_HOLD

EVENT_PB3_LONG_PRESS

EVENT_PB4_DOWN

EVENT_PB4_UP

EVENT_PB4_SHORT_PRESS

EVENT_PB4_HOLD

EVENT_PB4_LONG_PRESS

EVENT_PB5_DOWN

EVENT_PB5_UP

EVENT_PB5_SHORT_PRESS

EVENT_PB5_HOLD

EVENT_PB5_LONG_PRESS

EVENT_PB6_DOWN

EVENT_PB6_UP

EVENT_PB6_SHORT_PRESS

EVENT_PB6_HOLD

EVENT_PB6_LONG_PRESS

EVENT_SLIDER1_DOWN

EVENT_SLIDER1_UP

EVENT_SLIDER1_SHORT_PRESS

EVENT_SLIDER1_HOLD

EVENT_SLIDER1_LONG_PRESS

EVENT_BTN_MAX

}

Button events.

Typedefs#

typedef enum _EVENT_SYSTEM_

EVENT_SYSTEM

System events.

typedef enum _BUTTON_EVENT_

BUTTON_EVENT

Button events.

Functions#

void

ZAF_eventSchedulerInit(void(*pApplicationStateMachine)(uint8_t))

Initializes event scheduler.

bool

ZCB_eventSchedulerEventAdd(uint8_t event)

Adds a given event to the event queue.

bool

ZCB_eventScheduler(void)

Processes events.

bool

ZAF_jobEnqueue(uint8_t event)

Adds a given event to the job queue.

bool

ZAF_jobDequeue(uint8_t *pEvent)

Deque job queue.

uint8_t

ZAF_jobQueueCount(void)

Get number of events on queue.

Macros#

#define

DEFINE_EVENT_WAKEUP_NBR 0x01

Event groups for application state event machine.

#define

DEFINE_EVENT_KEYPAD_NBR 0x10

#define

DEFINE_EVENT_IR_NBR 0x20

#define

DEFINE_EVENT_SYSTEM_NBR 0x30

#define

DEFINE_EVENT_KEY_NBR 0x40

Event group for keys 0x40 - 0x6F.

#define

DEFINE_EVENT_APP_NBR 0x70

Event group for zaf 0x80 - 0xFF.

#define

BTN_EVENT_FILTER (btnEvent)

#define

EventSchedulerInit ZAF_eventSchedulerInit

#define

ZCB_EventSchedulerEventAdd ZCB_eventSchedulerEventAdd

#define

ZCB_EventScheduler ZCB_eventScheduler

#define

ZCB_EventEnqueue ZAF_jobEnqueue

#define

ZCB_EventDequeue ZAF_jobDequeue

Enumeration Documentation#

_EVENT_SYSTEM_#

_EVENT_SYSTEM_

System events.

Enumerator
EVENT_SYSTEM_RESET
EVENT_SYSTEM_LEARNMODE_START
EVENT_SYSTEM_LEARNMODE_FINISHED
EVENT_SYSTEM_LEARNMODE_STOP
EVENT_SYSTEM_LEARNMODE_TOGGLE
EVENT_SYSTEM_WATCHDOG_RESET
EVENT_SYSTEM_OTA_START
EVENT_SYSTEM_LEARNMODE_DSK_START
EVENT_SYSTEM_FLUSHMEM_READY
EVENT_SYSTEM_SMARTSTART_IN_PROGRESS
EVENT_SYSTEM_EMPTY

Definition at line 40 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

_BUTTON_EVENT_#

_BUTTON_EVENT_

Button events.

NB: For every button there MUST be the following events in this order: DOWN, UP, SHORT_PRESS, HOLD, LONG_PRESS The macros BTN_EVENT_xxx in board.h depends on it.

Enumerator
EVENT_PB1_DOWN
EVENT_PB1_UP
EVENT_PB1_SHORT_PRESS
EVENT_PB1_HOLD
EVENT_PB1_LONG_PRESS
EVENT_PB2_DOWN
EVENT_PB2_UP
EVENT_PB2_SHORT_PRESS
EVENT_PB2_HOLD
EVENT_PB2_LONG_PRESS
EVENT_PB3_DOWN
EVENT_PB3_UP
EVENT_PB3_SHORT_PRESS
EVENT_PB3_HOLD
EVENT_PB3_LONG_PRESS
EVENT_PB4_DOWN
EVENT_PB4_UP
EVENT_PB4_SHORT_PRESS
EVENT_PB4_HOLD
EVENT_PB4_LONG_PRESS
EVENT_PB5_DOWN
EVENT_PB5_UP
EVENT_PB5_SHORT_PRESS
EVENT_PB5_HOLD
EVENT_PB5_LONG_PRESS
EVENT_PB6_DOWN
EVENT_PB6_UP
EVENT_PB6_SHORT_PRESS
EVENT_PB6_HOLD
EVENT_PB6_LONG_PRESS
EVENT_SLIDER1_DOWN
EVENT_SLIDER1_UP
EVENT_SLIDER1_SHORT_PRESS
EVENT_SLIDER1_HOLD
EVENT_SLIDER1_LONG_PRESS
EVENT_BTN_MAX	EVENT_BTN_MAX define the last enum type.

Definition at line 62 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

Typedef Documentation#

EVENT_SYSTEM#

typedef enum _EVENT_SYSTEM_ EVENT_SYSTEM

System events.

Definition at line 53 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

BUTTON_EVENT#

typedef enum _BUTTON_EVENT_ BUTTON_EVENT

Button events.

NB: For every button there MUST be the following events in this order: DOWN, UP, SHORT_PRESS, HOLD, LONG_PRESS The macros BTN_EVENT_xxx in board.h depends on it.

Definition at line 100 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

Function Documentation#

ZAF_eventSchedulerInit#

void ZAF_eventSchedulerInit (void(*)(uint8_t) pApplicationStateMachine)

Initializes event scheduler.

Parameters

N/A pApplicationStateMachine

Definition at line 108 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_eventSchedulerEventAdd#

bool ZCB_eventSchedulerEventAdd (uint8_t event)

Adds a given event to the event queue.

Parameters

N/A

event

A given event.

Returns

true if given event is added to queue, false if queue full.

Definition at line 117 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_eventScheduler#

bool ZCB_eventScheduler (void )

Processes events.

Parameters

N/A

Definition at line 124 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZAF_jobEnqueue#

bool ZAF_jobEnqueue (uint8_t event)

Adds a given event to the job queue.

Parameters

N/A

event

A given event.

Returns

true if given event is added to queue, false if queue full.

Definition at line 133 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZAF_jobDequeue#

bool ZAF_jobDequeue (uint8_t * pEvent)

Deque job queue.

Parameters

[out]

pEvent

return event from the queue.

Returns

false if queue is empty else true.

Definition at line 142 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZAF_jobQueueCount#

uint8_t ZAF_jobQueueCount (void )

Get number of events on queue.

Parameters

N/A

Returns

number of events on queue

Definition at line 149 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

Macro Definition Documentation#

DEFINE_EVENT_WAKEUP_NBR#

#define DEFINE_EVENT_WAKEUP_NBR

Value:

0x01

Event groups for application state event machine.

Definition at line 22 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

DEFINE_EVENT_KEYPAD_NBR#

#define DEFINE_EVENT_KEYPAD_NBR

Value:

0x10

Definition at line 23 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

DEFINE_EVENT_IR_NBR#

#define DEFINE_EVENT_IR_NBR

Value:

0x20

Definition at line 24 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

DEFINE_EVENT_SYSTEM_NBR#

#define DEFINE_EVENT_SYSTEM_NBR

Value:

0x30

Definition at line 25 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

DEFINE_EVENT_KEY_NBR#

#define DEFINE_EVENT_KEY_NBR

Value:

0x40

Event group for keys 0x40 - 0x6F.

Definition at line 30 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

DEFINE_EVENT_APP_NBR#

#define DEFINE_EVENT_APP_NBR

Value:

0x70

Event group for zaf 0x80 - 0xFF.

Definition at line 35 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

BTN_EVENT_FILTER#

#define BTN_EVENT_FILTER

Value:

(btnEvent)

Definition at line 102 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

EventSchedulerInit#

#define EventSchedulerInit

Value:

ZAF_eventSchedulerInit

Definition at line 104 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_EventSchedulerEventAdd#

#define ZCB_EventSchedulerEventAdd

Value:

ZCB_eventSchedulerEventAdd

Definition at line 111 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_EventScheduler#

#define ZCB_EventScheduler

Value:

ZCB_eventScheduler

Definition at line 120 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_EventEnqueue#

#define ZCB_EventEnqueue

Value:

ZAF_jobEnqueue

Definition at line 127 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h

ZCB_EventDequeue#

#define ZCB_EventDequeue

Value:

ZAF_jobDequeue

Definition at line 136 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZAF/ApplicationUtilities/ev_man.h