Siemens SIMATIC S7-1200

Extended instructions
9.6 Alarms
S7-1200 Programmable controller
436 System Manual, V4.2, 09/2016, A5E02486680-AK
9.6
Alarms
9.6.1
Gen_UsrMsg (Generate user diagnostic alarms)
Table 9- 126 Gen_UsrMsg instruction
LAD / FBD
SCL
Description
ret_val :=Gen_UsrMsg(
Mode:=_uint_in_,
TextID:=_uint_in_,
TextListID:=_uint_in_,
As-
socValues:=_struct_inout_);
You use the "Gen_UsrMsg" instruction to
generate a user diagnostic alarm that can be
either an incoming or outgoing alarm. By
means of user diagnostic alarms, you can
write a user entry to the diagnostics buffer and
send a corresponding alarm.
The entry in the diagnostic buffer is created
synchronously. Alarm transmission is asyn-
chronous.
If an error occurs during the execution of an
instruction, it is output via the parameter
RET_VAL.
Content of the alarm
A text list defines the content of the alarm:
● Define the text list you want to use with the parameter TextListID. For this purpose open
the dialog "Text lists" in the project navigation. Show the column "ID" in the dialog "Text
lists". Apply the ID at the parameter TextListID.
● Use the parameter TextID to select the text list entry you want to write in the diagnostic
buffer. For this purpose select an entry from the "Text lists entries" dialog by applying a
number from the columns "Range from / range to" at the parameter TextID. You must use
the same number from both the "Range from" and "Range to" columns for the text list
entry.
Refer to the STEP 7 Information System for detailed information about text lists.
Defining associated values
The text list entry defines new associated values to be added to the alarm:
● Add the following information to the text list entry to define associated values:
@<No. of the associated value><Element type><Format specification>@
● Use the system data type AssocValues to specify which associated value to add when
generating the alarm.
Refer to the STEP 7 Information System for detailed information about the structure of
associated values.