Alarm

Overview

Functions and callback-prototypes needed for handling the Profinet alarms.

Typedefs
typedef void(*	PN_API_IOD_asyncReqDoneCbf) (PN_API_IOD_Handle_t *const pnHandle, const uint32_t arNum, const PN_API_IOD_AlarmType_t alarmType, const uint32_t api, PN_API_IOD_DevAddr_t *const addr, const uint32_t status, const uint16_t diagnosisTag)
	Callback function prototype to acknowledge an asynchronous request issued by the user application to the Profinet stack. Currently, only alarms are implemented as asynchronous requests.
typedef void(*	PN_API_IOD_devAlarmCbf) (PN_API_IOD_Handle_t *const pnHandle, const PN_API_IOD_DevAlarmData_t *devAlarmData)
	Callback function prototype to notify an alarm that has been received from the IO controller.

Functions
uint32_t	PN_API_IOD_sendProcessAlarm (PN_API_IOD_Handle_t *const pnHandle, const uint32_t api, PN_API_IOD_DevAddr_t *const addr, uint8_t *const data, const uint32_t dataSize, const uint16_t identUserStruct, const uint32_t userHandle)
	This function notifies the IO controller of a process alarm unique to this submodule.
uint32_t	PN_API_IOD_sendStatusAlarm (PN_API_IOD_Handle_t *const pnHandle, const uint32_t api, PN_API_IOD_DevAddr_t *const addr, uint8_t *const data, const uint32_t dataSize, const uint16_t identUserStruct, const uint32_t userHandle)
	This function notifies the IO controller of a status alarm unique to this submodule.
uint32_t	PN_API_IOD_sendUploadRetrievalAlarm (PN_API_IOD_Handle_t *const pnHandle, const uint32_t api, PN_API_IOD_DevAddr_t *const addr, uint8_t *const data, const uint32_t dataSize, const uint32_t userHandle)
	This function sends an event to a central parameter server. As a result of this event, the server runs a record read service to retrieve a set of parameters from the device or a record write service to transmit a set of parameters to it. Part of the alarm data header indicates which record index is being utilized and whether the data is intended to be written or read.
uint32_t	PN_API_IOD_sendRetOfSubAlarm (PN_API_IOD_Handle_t *const pnHandle, const uint32_t api, PN_API_IOD_DevAddr_t *const addr, const uint32_t userHandle)
	The function sends a “Return of Submodule” alarm to the IO controller. The alarm is triggered when the status of IOPS/IOCS changes from “BAD” to “GOOD”. The IO controller does not reparameterize the submodule.
#define	PN_API_IOD_CM_ALARM_PRIORITY_LOW   0
	Alarm priority low.
#define	PN_API_IOD_CM_ALARM_PRIORITY_HIGH   1
	Alarm priority high.
#define	PN_API_IOD_CM_ALARM_TYPE_DIAGNOSIS   0x0001
	Diagnosis alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_PROCESS   0x0002
	Process alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_PULL   0x0003
	Pull alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_PLUG   0x0004
	Plug alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_STATUS   0x0005
	Status alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_UPDATE   0x0006
	Update alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_MEDIA_REDUNDANCY   0x0007
	Media redunduncy alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_CTRL_BY_SUPERVISOR   0x0008
	Controlled by supervisor alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_RELEASED   0x0009
	Released by supervisor (old).
#define	PN_API_IOD_CM_ALARM_TYPE_PLUG_WRONG   0x000A
	Plug wrong alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_RETURN_OF_SUBMODULE   0x000B
	Return of submodule alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_DIAGNOSIS_DISAPPEARS   0x000C
	Diagnosis disappears alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_MCR_MISMATCH   0x000D
	Multicast communication mismatch.
#define	PN_API_IOD_CM_ALARM_TYPE_PORT_DATA_CHANGED   0x000E
	Port data changed alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_SYNC_DATA_CHANGED   0x000F
	Sync data changed alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_ISOCHRONE_MODE_PROB   0x0010
	Isochronous mode problem alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_NETWORK_COMP_PROB   0x0011
	Network component problem alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_TIME_DATA_CHANGED   0x0012
	Time data changed alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_DFP_PROB   0x0013
	DFP problem alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_MRPD_PROB   0x0014
	MRPD problem alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X0015   0x0015
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_MULTIPLE_IF   0x0016
	Multiple interface mismatch alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X0017   0x0017
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X0018   0x0018
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X0019   0x0019
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X001A   0x001A
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X001B   0x001B
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X001C   0x001C
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_RESERVED_0X001D   0x001D
	Reserved.
#define	PN_API_IOD_CM_ALARM_TYPE_UPLOAD_AND_STORAGE   0x001E
	Upload and storage alarm.
#define	PN_API_IOD_CM_ALARM_TYPE_PULL_MODULE   0x001F
	Pull module alarm.