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

GET_MODULE_DIFF_BLOCK

Type	Function block
Description	The function block can be used to read out module difference blocks (ModuleDiffBlock) for Profinet devices. A ModuleDiffBlock contains information about the differences between the real hardware configuration and the expected configuration (configuration set by the engineering tool) as well as diagnosis information. Reading ModuleDiffBlocks is triggered with a rising edge at the REQ input. A rising edge at the NEW output indicates that new ModuleDiffBlocks are available.
Notes	Function blocks of this type have to be instantiated. The instance name of the function block has to be declared in the 'Variables' table of the POU where the FB is going to be used. The instance name must be unique within the POU.
Parameters	Inputs REQ Data type: BOOL Description: With REQ = TRUE the function block is executed and the outputs will then be updated. After successful execution of the function block, REQ must be set to FALSE to execute the function block again. The outputs will be reset by a falling edge at REQ. AR_USER_ID Data type: WORD Description: Application Relation (AR) User ID of the Profinet device. Input/Output MODULE_DIFF_BLOCK Data type: ANY Description: Structure or array of structure for a module difference. With an array of structure several modules can be queried in one cycle. (See below for the description of the structure.) Outputs DONE Data type: BOOL Description: Indicates whether the function block has been successfully executed. TRUE: Function block was executed without errors. The NEW output indicates whether a new difference block is available. FALSE: An error occurred during execution of the function block (ERROR = TRUE). The STATUS output indicates the error code. BUSY Data type: BOOL Description: Indicates whether the function block is currently executed and waits for an answer from the Profinet controller. The output remains TRUE as long as the function block is executed. TRUE: Function block is currently executed and waits for an answer from the firmware. FALSE: Function block was executed. The outputs DONE and ERROR indicate the whether the execution was successful or not. ERROR Data type: BOOL Description: Indicates whether an error occurred when executing the function block. TRUE: Error occurred. The STATUS output indicates the error code. FALSE: No error occurred. STATUS Data type: DWORD Description: Internal status of the function block. Only valid for ERROR = TRUE. See below for the description of the possible error codes. NEW Data type: BOOL Description: A rising edge indicates that new module differences are available. If TRUE, the input is also reset to FALSE after REQ has been reset to FALSE. MORE_AVAILABLE Data type: BOOL Description: TRUE: There are more differences available for the AR. The differences can be read with a further rising edge at the REQ input. FALSE: There are no other module differences available for the AR.
MODULE_DIFF_BLOCK content	MODULE_DIFF_BLOCK structure Structure element Data type Description AR_USER_ID WORD AR user ID of the Profinet device API DWORD Application Process Identifier SLOT WORD Number of the slot where the module is inserted IDENT_NUMBER DWORD Identification number of the module STATE WORD Module status (see below for the description of the possible values) SUBMODULE_COUNT WORD Number of submodules of the module SUBMODULES ARRAY[0..63] OF SUBMODULE See below SUBMODULE structure Structure element Data type Description NODE_ID DWORD Node ID of the submodule SUBSLOT WORD Number of the subslot where the submodule is inserted IDENT_NUMBER DWORD Identification number of the submodule STATE WORD Submodule status (see below for the decryption of the possible values) Module STATE values The block element STATE in the MODULE_DIFF_BLOCK structure describes the module status. It can contain the following values: Value Description 0x0000 No module (e.g., module is not inserted). 0x0001 Incorrect module inserted (e.g., identification number wrong). 0x0002 Module is correct, but at least one submodule is locked, wrong, or missing. 0x0003 Module is not the same as requested. The IO device was able to adapt itself to the module through its own knowledge. Submodule STATE values The bit-coded block element STATE in the SUBMODULE structure describes the submodule status. It contains multiple information which have to be read by applying different bit masks on the value. For example, applying bit mask 0x0010 on the value extracts bit 4 (MaintenanceRequired) as shown in the table below. Evaluation of format indicator (bit 15) The meaning of the bits of the SubmoduleState value is dependent on the value of the format indicator (bit 15). The following applies: Bit 15 (0x8000) is set: The SubmoduleState consists of the SubmoduleState.IdentInfo, SubmoduleState.ARInfo, and SubmoduleState.AddInfo. Bit 15 is not set: The SubmoduleState contains unformatted detail information. SubmoduleState Bit Bit mask Description 0 - 2 0x0007 Additional information (AddInfo) 0 No additional information. None of the options defined for this field are activated. 1 Takeover is not allowed. This submodule is not available for takeover by IO Supervisor AR. 2 - 7 Reserved 3 0x0008 Advice (QualifiedInfo) 0 No advice available for this submodule. 1 At least one advice is available for this submodule. 4 0x0010 Maintenance required (MaintenanceRequired) 0 No maintenance request available for this submodule. 1 At least one maintenance request is available for this submodule. 5 0x0020 Maintenance demanded (MaintenanceDemanded) 0 No maintenance demand available for this submodule. 1 At least one maintenance demand is available for this submodule. 6 0x0040 Diagnosis (DiagInfo) 0 No diagnosis data available for this submodule. 1 There is diagnosis data available for this submodule. The diagnosis data can be read using the corresponding records or IDiagnosisQueryService. 7 - 10 0x0780 AR information (ARInfo) 0 AR is the owner of the submodule. 1 Application Ready pending. This AR is owner of the submodule, but it is blocked (e.g., parameter checking pending). 2 AR is not the owner of the submodule. It is blocked by higher-level services. 3 AR is not the owner of the submodule. It is blocked by IO controller. 4 AR is not the owner of the submodule. It is blocked by IO supervisor. 5 - 15 Reserved 11 - 14 0x7800 Identification information (IdentInfo) 0 OK 1 Submodule is not the same as configured, but compatible. 2 Incorrect submodule 3 No submodule 4 - 15 Reserved 15 0x8000 Format indicator 0 Submodule contains unformatted detail information (see the following table). 1 SubmoduleState consists of SubmoduleState.IdentInfo, SubmoduleState.ARInfo, and SubmoduleState.AddInfo. Meaning of the state value when the format indicator (bit 15) is 0 (Bit mask 0x7FFF applied on the STATE value.) Value Description 0x0000 No submodule 0x0001 Incorrect submodule 0x0002 AR is not the owner of the submodule. It is owned by another IO Supervisor AR. 0x0004 Application Ready pending 0x0007 Submodule is not the same as configured, but compatible.
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).