Types used for alarm management. More...

#include "EventTypes.h"
#include "OCB.h"

Include dependency graph for AlarmTypes.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	alarm_s
	Data structure for alarm. More...

Macros
#define	ALARMCALLBACK(Name) extern void Name(void)
	Define implementation of alarm callback. More...

Typedefs
typedef void(*	pAlarmCallback) (void)
	Alarm callback type. More...

typedef volatile struct counter_s	AlarmBaseType
	Type for alarm base. More...

typedef AlarmBaseType *	AlarmBaseRefType
	Reference for alarm base. More...

typedef enum alarm_e	AlarmType
	Type for alarm reference. More...

Enumerations
enum	alarmActionType_e { ALARM_ACTION_TASK = 0, ALARM_ACTION_EVENT, ALARM_ACTION_CALLBACK, ALARM_ACTION_COUNTER }
	Alarm action type. More...

Detailed Description

Types used for alarm management.

Date: 2020-05-29

Author: Pascal Romahn

Copyright: This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Definition in file AlarmTypes.h.

Macro Definition Documentation

◆ ALARMCALLBACK

#define ALARMCALLBACK ( Name ) extern void Name(void)

Define implementation of alarm callback.

Define used for implementation of alarm callback. This should be used in the app implementation file. The callback must be defined in the app configuration using OS_CONFIG_ALARM_CALLBACK.

Parameters

Name	Name of the callback function

Definition at line 29 of file AlarmTypes.h.

Typedef Documentation

◆ AlarmBaseRefType

typedef AlarmBaseType* AlarmBaseRefType

Reference for alarm base.

Definition at line 44 of file AlarmTypes.h.

◆ AlarmBaseType

typedef volatile struct counter_s AlarmBaseType

Type for alarm base.

Definition at line 34 of file AlarmTypes.h.

◆ AlarmType

typedef enum alarm_e AlarmType

Type for alarm reference.

Definition at line 44 of file AlarmTypes.h.

◆ pAlarmCallback

typedef void(* pAlarmCallback) (void)

Alarm callback type.

Definition at line 34 of file AlarmTypes.h.

Enumeration Type Documentation

◆ alarmActionType_e

enum alarmActionType_e

Alarm action type.

Enumerator
ALARM_ACTION_TASK	Alarm activates task on expiration.
ALARM_ACTION_EVENT	Alarm sets event on expiration.
ALARM_ACTION_CALLBACK	Alarm calls callback on expiration.
ALARM_ACTION_COUNTER	Alarm increments counter on expiration.

Definition at line 54 of file AlarmTypes.h.

Data Structures

Macros

Typedefs

Enumerations