Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard
CmpIoMgr Interfaces Library Documentation ¶ Company : System Title : CmpIoMgr Interfaces Version : 3.5.19.30 Categories : System|SysLibs Author : CODESYS Development GmbH Description [ 1 ] ¶ This library provides access to the IO manager of the runtime system. Contents: ¶ Config Types BaseTypeInformation (GVL) BusIndependentParameterIDs (GVL) ConnectorFlags (GVL) ConnectorOptions (GVL) ConnectorTypes (GVL) DriverPropertyFlags (GVL) IoConfigChannelMap (Struct) IoConfigConnector (Struct) IoConfigConnectorMap (Struct) IoConfigParameter (Struct) IoConfigTaskMap (Struct) LockScopes (GVL) ParameterValueFlags (GVL) TaskMapTypes (GVL) ICmpEventMgr EVTPARAM_CmpIoMgr (Struct) EventIDs (GVL) ICmpIoDrv BusCycleType (GVL) Indices and tables ¶ [ 1 ] Based on CmpIoMgr_Itfs.library, last modified 22.09.2023, 10:42:59. LibDoc 4.4.0.0-b.37 The content file CmpIoMgr_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 22.09.2023, 10:43:00.
Config Types ¶ BaseTypeInformation (GVL) BusIndependentParameterIDs (GVL) ConnectorFlags (GVL) ConnectorOptions (GVL) ConnectorTypes (GVL) DriverPropertyFlags (GVL) IoConfigChannelMap (Struct) IoConfigConnector (Struct) IoConfigConnectorMap (Struct) IoConfigParameter (Struct) IoConfigTaskMap (Struct) LockScopes (GVL) ParameterValueFlags (GVL) TaskMapTypes (GVL)
BaseTypeInformation (GVL) ¶ Base type and swapping information for io channels InOut: Scope Name Type Initial Comment Constant CMLBT_Mask WORD 16#FF The low byte contains the base clase of the io channel CMLBT_IS_SET WORD 16#100 If this bit is set, the base type information is valid CMLBT_ENABLE WORD 16#8000 Enable flag, if this bit is set to 1, the swapping must be disabled.
BusIndependentParameterIDs (GVL) ¶ Fieldbus independent parameters InOut: Scope Name Type Initial Comment Constant FIP_NETX_DEVICE UDINT 16#70000000 Parameter to identify netX devices.TRUE indicates a netX device. FIP_WATCHDOG UDINT 16#70000001 Master Watchdog TIME. 0 deactivates the watchdog, 1-0xFFFF sets the watchdog TIME. FIP_NETX_SLOT_NUMBER UDINT 16#70000002 Slot number of the NetX device e.g. PCI slot FIP_NETX_CHANNEL_NUMBER UDINT 16#70000003 A NetX chip may have up to four communication channels. FIP_BUS_ON_TIMEOUT UDINT 16#70000004 Wait time for the BUS_ON signal of the master in the IO Driver. If it is set to 0, the IO driver does not wait for the BUS ON signal. FIP_DEVICENAME UDINT 16#70000010 Name of the device, if target setting deviceconfiguration:enableAdditionalParameters is set to TRUE. FIP_DEVICEIDENTIFICATION_HASH UDINT 16#70000011 Hashcode of DeviceIdentification, if target setting deficeconfiguration:enableAdditionalParameters is set to TRUE. FIP_UPDATE_IO_IN_STOP UDINT 16#70000012 Value of UpdateIOInStop (see PLC settings). FIP_SAFETY_PROTOCOL UDINT 16#70000018 Used for Safety. Describing the used protocols. FIP_CONFIG_VERSION UDINT 16#70001000 Contains the version of the fieldbus config schema e.g. 16#03050100 for V3.5.1.0 FIP_NUMBER_OF_SAFETY_PROTOCOLS UDINT 16#7F000018 Number of parameters beginning at 0x7f000019 (max. 256 Parameters) describing the used safety protocols. FIP_FIRST_SAFETY_PROTOCOL_PARAM UDINT 16#7F000019 First Safety Protocol Parameter FIP_LAST_SAFETY_PROTOCOL_PARAM UDINT 16#7F000118 Last Safety Protocol Parameter
ConnectorFlags (GVL) ¶ Connector flags: Flags that specifies diagnostic informations of a connector InOut: Scope Name Type Initial Comment Constant CF_ENABLE WORD 16#1 Connector enabled CF_DIAG_PROVIDER WORD 16#2 Connector provides diagnosis for the associated device. CF_DEVICE_ENABLED WORD 16#4 Only valid if CF_DIAG_PROVIDER is set. Specifies if device is currently enabled (used by Reconfigure). CF_DEMOLICENSE_ACTIVE WORD 16#8 Demo License is active CF_DRIVER_AVAILABLE WORD 16#10 A driver is available CF_CONNECTOR_FOUND WORD 16#20 Connector found (device detected) CF_CONNECTOR_CONFIGURED WORD 16#40 Connector configured CF_CONNECTOR_ACTIVE WORD 16#80 Connector active CF_CONNECTOR_BUS_ERROR WORD 16#100 Bus error CF_CONNECTOR_ERROR WORD 16#200 General connector error CF_CONNECTOR_DIAGNOSTIC_AVAILABLE WORD 16#400 Diagnostic information available CF_CONNECTOR_PASSIVE WORD 16#800 Passive mode of the second master in redundancy systems CF_ERROR_CLEARED WORD 16#1000 An Error was automatically cleared by the driver
ConnectorOptions (GVL) ¶ Connector options: Options to specify properties of a connector InOut: Scope Name Type Initial Comment Constant CO_NONE WORD 16#0 No option CO_SCAN_PENDING_SUPPORTED WORD 16#1 Scan the IO-configuration with segmented transfer is supported. In this case, the call of IoDrvScanModules() can return ERR_PENDING to get further calls to transmit more scan results.
ConnectorTypes (GVL) ¶ Types of connectors. “0x8000..0x8FFF” are Special Connectors InOut: Scope Name Type Initial Comment Constant CT_PROGRAMMABLE WORD 16#1000 Programmable connector (can be programmed by CoDeSys) CT_PARAMETRIZABLE WORD 16#2000 Connector is only parametrizable CT_CAN_BUS WORD 16#F CANbus CT_CAN_MASTER WORD 16#10 CANopen Master CT_CAN_SLAVE WORD 16#11 CANopen Local Device CT_CAN_DEVICE WORD 16#12 CANopen Remote Device CT_CANOPEN_SAFETY WORD 16#15 CANopen Safety CT_J1939_MANAGER WORD 16#18 J1939 Manager CT_J1939_ECU WORD 16#19 J1939 ECU CT_CANOPEN_SAFETY_SLAVE WORD 16#1A CANopen Safety Slave CT_PROFIBUS_MASTER WORD 16#20 Profibus Master CT_PROFIBUS_SLAVE WORD 16#21 Profibus Slave CT_PROFIBUS_DEVICE WORD 16#22 Profibus Device CT_PROFIBUS_MOD_MASTER WORD 16#23 Profibus modular Master CT_PROFIBUS_MOD_SLAVE WORD 16#24 Profibus modular Slave CT_DEVICENET_MASTER WORD 16#30 Profibus DeviceNet Master CT_DEVICENET_SLAVE WORD 16#31 Profibus DeviceNet Slave CT_DEVICENET_DEVICE WORD 16#32 DeviceNet Device CT_ETHERCAT_MASTER WORD 16#40 EtherCAT Master CT_ETHERCAT_SLAVE WORD 16#41 EtherCAT Slave CT_ETHERCAT_DEVICE WORD 16#42 EtherCAT Device CT_ENIP_SCANNER WORD 16#64 EtherNet/IP Scanner CT_ENIP_REMOTE_ADAPTER WORD 16#65 EtherNet/IP Remote Adapter CT_PCI_MASTER WORD 16#100 PCI Master CT_PCI_SLAVE WORD 16#101 PCI Slave
DriverPropertyFlags (GVL) ¶ InOut: Scope Name Type Initial Comment Constant DRVPROP_CONSISTENCY DWORD 16#1 IO-driver realizes bit-consistency by its own (atomar bit access). If this flag is 0, the bit-consistency is provided by the IO-Manager. DRVPROP_WATCHDOG DWORD 16#2 The io driver needs a cyclic call TO the IoDrvWatchdogTrigger INTERFACE FUNCTION. The io manager will call the io driver approximately every Watchdogtime/2. The Watchdogtime must be set in the IoConfig parameters (ID 0x70000001). ATTENTION: The io manager will pass a NULL pointer as parameter pConnector to the IIoDrv interface function IoDrvWatchdogTrigger. If this flag is 0, the driver must trigger the watchdog itself. DRVPROP_REDUNDANCY DWORD 16#4 IO-driver can support redundancy. If the flag DRVPROP_REDUNDANCY is 1, the redundancy is provided by the IO-Manager. DRVPROP_ACTIVE DWORD 16#8 If the flag DRVPROP_ACTIVE is 1, the master is active otherwise passive. DRVPROP_ERROR_ACTIVE DWORD 16#10 The flag DRVPROP_ERROR_ACTIVE is used to tell the redundancy component that the active master has an error and it should switchover (only on active plc). DRVPROP_ERROR_PASSIVE DWORD 16#20 The flag DRVPROP_ERROR_PASSIVE can be set to inform redundancy component that the communication was lost. DRVPROP_BACKGROUND_GETDIAG DWORD 16#40 If this property is set, the interface function IoDrvGetModuleDiagnosis() of the driver is called cyclically from a background task. NOTE: In this case, IoDrvGetModuleDiagnosis is called with: IoDrvGetModuleDiagnosis(hIoDrv, NULL); This must be handled correctly in the IO-driver! DRVPROP_NO_SYNC DWORD 16#80 Disable synchronization for ReadInputs/WriteOutputs/StartBusCycle in the I/O Manager (CmpIoMgr). In this case the I/O driver has to implement the synchronization of these functions itself. CmpIoMgr provides the following functions that can be used by the I/O driver for synchronization: IoMgrLockEnter(), IoMgrLockLeave()
IoConfigChannelMap (STRUCT) ¶ TYPE IoConfigChannelMap : STRUCT Mapping information for a single channel. Every I/O-channel is described as a parameter, but with special meanings. The datatype of a channel can be simple (BOOL, BYTE, WORD, etc.) or array of simple types. InOut: Name Type Comment pParameter POINTER TO IoConfigParameter Pointer to the parameter description. pbyIecAddress POINTER TO BYTE Pointer to the parameter in the process image on the IEC side. wParameterBitOffset WORD Bitoffset of the device. wIecAddressBitOffset WORD Bitoffset of pbyIecAddress in the IEC process image. wSize WORD Size in bits of the channel. wDummy WORD This parameter is now used for the base type information. This information is needed for a correct swapping action. – wBaseTypeInformation : WORD; – compiler relies on the name ‘wDummy’ here dwDriverSpecific XWORD Driver specific entry. Reserved for the usage in the driver.
