Alarmnotification - Siemens Simatic S7-1500 Function Manual

User interfaces (API)
7.6 API IInstances
7.6.8.3

AlarmNotification

AlarmNotification()
This function triggers diagnostic alarms according to the PROFINET standard.
Each call of this function calls the OB 82 once, regardless of the number and the severity
level of the transferred diagnostic entries.
Table 7- 246 AlarmNotification() - Native C++
Syntax
Parameters
Return values
232
ERuntimeErrorCode AlarmNotification(
UINT16 in_HardwareIdentifier,
UINT16 in_ModuleState,
UINT16 in_NumberOfDiagnosisEvents,
SDiagExtChannelDescription* in_ArrayOfDiagnosisEvents,
UINT16* out_SequenceNumber
);
•
UINT16 in_HardwareIdentifier:
The hardware identifier of the module or submodule which sends the diagnos-
tics entry.
The identifier must belong to a hardware component in the currently loaded
project.
•
UINT16 in_ModuleState:
Module status. The following statuses are valid:
DMODULE_STATE_OK,
DMODULE_STATE_ERROR,
DMODULE_STATE_MAINT_DEMANDED,
DMODULE_STATE_MAINT_REQUIRED
•
UINT16 in_NumberOfDiagnosisEvents:
Multiple diagnostic entries can be sent to the CPU with a single API call.
Valid range: 0 to 16. 0 means that no diagnostics entry should appear for the
submodule or the channel.
•
SDiagExtChannelDescription* in_ArrayOfDiagnosisEvents:
Pointer to a field with diagnostic entries. The field must match the number of
diagnostic entries. It can also be a zero pointer. For definitions, see SDi-
agExtChannelDescription (Page 324).
•
UINT16* out_SequenceNumber:
PLCSIM Advanced assigns a unique consecutive number to each interrupt
event.
According to PROFINET standard the sequence number is 10 bits wide (1 to
7FF ). When the highest number is reached the numbering starts again at 1.
H
Runtime error code
SREC_OK
SREC_INTERFACE_REMOVED
SREC_DOES_NOT_EXIST
SREC_INDEX_OUT_OF_RANGE
SREC_WRONG_MODULE_TYPE
SREC_WRONG_ARGUMENT
SREC_TIMEOUT
Condition
The function is successful.
The instance is not registered in Runtime Manager.
No hardware identifier of the module.
The field size of
in_ArrayOfDiagnosisEvents
less than the number of the currently available
diagnostic events.
The channel number does not exist for the module.
The value for the module status is invalid.
The function does not return on time.
Function Manual, 12/2017, A5E37039512-AB
is
S7-PLCSIM Advanced