• Home
• Function/Function Block Reference
• PLCnext Controller Function Blocks
• Profinet
• RECV_ALARM

RECV_ALARM

Type	Function block
Description	The function block is used to receive alarms of Profinet IO devices. The block is executed by REQ = TRUE. The MODE input controls the functionality of the function block.
Notes	All parameters have to be set. Only one instance of the function block can be used. When the function block is instantiated, the automatic alarm acknowledgment is disabled. The alarms are acknowledged when they are requested by the function block.
Parameters	Inputs REQ Data type: BOOL Description: With REQ = TRUE the function block is executed. If an error occurs during execution of the function block, the ERROR output is set to TRUE. The STATUS output indicates the error. MODE Data type: INT Description: MODE = 1 Receive all alarms of the Profinet IO devices/ARs. If an alarm is received, the outputs are set accordingly. MODE = 2 Receive alarms from one Profinet IO device/AR. Only the alarms of the Profinet IO device/AR which is specified with the F_ID input will be received. F_ID Data type: DWORD Description: Only required for MODE  = 2. Address of the Profinet IO device/AR as unique ID from which alarms are to be received. You can use the function block ADDRESS_TO_ID to convert the Profinet address structure ADDR into a unique ID. The 'Node ID' field in the 'Settings' editor under the 'Profinet sub module' category shows the F_ID value. To call this editor, double-click the Profinet module in the PLANT and then open the 'Settings' editor in the editors area. MLEN Data type: INT Description: Maximum length in bytes that can be used for the AINFO output as alarm information. If the alarm information exceeds this maximum value, an error message is generated. Input/Output TINFO Data type: ANY Description: Additional information on the alarm task. This information is customer-specific. Not supported. AINFO Data type: ANY Description: This structure contains all information on the received alarms. Offset Parameter Description 0-1 BlockType Reserved 2-3 BlockLength Block length 4-5 Version Version high byte 6-7 Type Alarm type 8-11 API Application Process Identifier 12-13 Slot Slot number 14-15 Subslot Subslot number 16-19 Source ID Module identification 20-23 Submodule Identification Submodule identification 24-25 Alarm Specifier See below 26-27 User Structure Identifier User structure identifier 28 or higher User Alarm info (0 to xxx byte) Alarm Specifier: Bit 15 Bit 14 Bit 13 Bit 12 Bit 11 Bit 0 to 10 ARDiagnosisState Reserved SubmoduleDiagnosisState ManufacturerDiagnosis ChannelDiagnosis SequenceNumber Outputs DONE Data type: BOOL Description: Indicates whether the function block has been successfully executed. TRUE: Function block executed without errors. The NEW output indicates whether a new alarm has been received. FALSE: An error occurred during execution of the function block. The STATUS output indicates the error code. BUSY Data type: BOOL Description: Indicates whether the function block is currently executed and waits for a response of the Profinet controller. The output remains TRUE as long as the function block is executed. ERROR Data type: BOOL Description: Indicates whether an error occurred when executing the function block. FALSE: No error occurred. TRUE: Error occurred. The STATUS output indicates the error code. NEW Data type: BOOL Description: A positive edge indicates the availability of new alarm information. STATUS Data type: DWORD Description: Internal status of the function block. Only valid for ERROR = TRUE (error occurred). See below for a description of the possible error codes. ID Data type: DWORD Description: Profinet IO device ID. You can use the ID_TO_ADDRESS function block to convert the ID into the Profinet address structure ADDR. LEN Data type: INT Description: If NEW = TRUE, the output indicates the length of the received AlarmInfo array within the AINFO structure.
Error codes	Error codes at the STATUS output Error code (hex) Meaning 0x0000 No error occurred. 0xF001 Too many instances used. 0xF002 Error during initialization of the function block. 0xF003 Invalid ID. 0xF004 Invalid HANDLE/ID. 0xF005 Resources conflict. 0xF006 A function block internal task could not be generated. 0xF007 Too many instances used. 0xF008 Invalid type of a parameter. 0xF009 Invalid parameter value. 0xF00A Unallowed parameter. 0xF00B Invalid length specified. 0xF00C ID could not be created (too many IDs). 0xF00D No entry found that matches the specified ID. 0xF00F No further entries found. 0xF010 Entry in use. 0xF011 Alarm acknowledgement could not be done. 0xF012 Error reading the AR parameters (1st time). 0xF013 Negative acknowledgement received for the execution of a Profinet service. 0xF014 Invalid length for parameter LEN/MLEN or/and data record in RECORD input/output too short. 0xF015 The service used to read the data record from the RECORD input/output could not be run. 0xF016 The service used to write the data record from the RECORD input/output could not be run. 0xF017 Service acknowledgement not received. 0xF018 Invalid INDEX used to access the data record in the RECORD input/output of the Profinet IO device, for example, INDEX greater than 0x7FFF. 0xF019 Unknown command code. 0xF01A Error when starting the Application Relation (AR). 0xF01B Error when stopping the Application Relation (AR). 0xF01C Notification of stopped Application Relation (AR) failed. 0xF01D Setting the "Drive BF" flag failed. 0xF01E Error reading the AR parameters (2nd time).