CmpHilscherCIFX Library Documentation ¶ Company System Title CmpHilscherCIFX Version 3.5.18.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpHilscherCIFX Description 1 ¶ Interface to Hilscher NetX Toolkit. Contents: ¶ Constants CIFXCommandIds (GVL) CmdDefinitons (GVL) CommunicationClasses (GVL) DiagStates (GVL) DriverSpecific (GVL) InfoIDs (GVL) NetXErrorCodes (GVL) ProtocolClasses (GVL) Datastructs CIFX_BOARD (Struct) CIFX_BOARD_INFORMATION (Struct) CIFX_CHANNEL (Struct) CIFX_CHANNEL_INFORMATION (Struct) CIFX_COMMON_STATUS_BLOCK (Struct) CIFX_COMMON_STATUS_BLOCK_MASTER (Struct) CIFX_COM_DIAGNOSTICS (Struct) CIFX_DEV_INFO (Struct) CIFX_DIRECTORY_ENTRY (Struct) CIFX_ERROR_FIELD (Struct) CIFX_INDICATION_PARAM (Struct) CIFX_MASTER_DIAG (Struct) CIFX_MEMORY_INFORMATION (Struct) CIFX_PACKET (Struct) CmpHilscherCIFX PacketInterface SYSTEM_MEMORY_INFORMATION (Struct) SystemInfo TLR_PACKET_HEADER_T (Struct) EventMgr EVTPARAM_BeforeCheckFirmware (Struct) EVTPARAM_CIFX_GetFirmware (Struct) EVTPARAM_CIFX_LoadFirmware (Struct) EVTPARAM_CIFX_PacketParam (Struct) EVTPARAM_CIFX_xChannelClose (Struct) EVTPARAM_CIFX_xChannelOpen (Struct) EVTPARAM_DownloadProgress (Struct) EVTPARAM_PacketConfirmation (Struct) EVTPARAM_PacketIndication (Struct) EVTPARAM_PacketUnhandled (Struct) EVTPARAM_UploadProgress (Struct) EventIds (GVL) Functions CIFX_GetBusActivationBeforeReset (Function) CIFX_ResetConfigApplication (Function) Channel Driver NETX_UDINT_TO_STRINGHEX (Function) SysDevice Indices and tables ¶ 1 Based on CmpHilscherCIFX.library, last modified 01.04.2022, 08:13:28. LibDoc 4.4.0.0-b.27 The content file CmpHilscherCIFX.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 01.04.2022, 08:13:28.
Constants ¶ CIFXCommandIds (GVL) CmdDefinitons (GVL) CommunicationClasses (GVL) DiagStates (GVL) DriverSpecific (GVL) InfoIDs (GVL) NetXErrorCodes (GVL) ProtocolClasses (GVL)
CIFXCommandIds (GVL) ¶ InOut: Scope Name Type Initial Constant RCX_SET_WATCHDOG_TIME_REQ UDINT 16#2F04 CIFX_GET_SLAVE_HANDLE_REQ UDINT 16#2F08 CIFX_GET_SLAVE_HANDLE_CNF UDINT 16#2F09 CIFX_GET_SLAVE_CONNECT_INFO_REQ UDINT 16#2F0A CIFX_GET_SLAVE_CONNECT_INFO_CNF UDINT 16#2F0B
CmdDefinitons (GVL) ¶ InOut: Scope Name Type Initial Comment Constant CIFX_APPLICATION UDINT 16#20 CIFX_HOST_STATE_TIMEOUT UDINT 16#3E8 Timeout Definitions CIFX_BUS_STATE_TIMEOUT UDINT 16#3E8 CIFX_LOCK_TIMEOUT UDINT 16#7D0 CIFX_CONFIG_TIMEOUT UDINT 16#3E8 CIFX_INFO_CMD_SYSTEM_INFORMATION UDINT 1 Information commands CIFX_INFO_CMD_SYSTEM_INFO_BLOCK UDINT 2 CIFX_INFO_CMD_SYSTEM_CHANNEL_BLOCK UDINT 3 CIFX_INFO_CMD_SYSTEM_CONTROL_BLOCK UDINT 4 CIFX_INFO_CMD_SYSTEM_STATUS_BLOCK UDINT 5 CIFX_CMD_READ_DATA UDINT 1 General commands CIFX_CMD_WRITE_DATA UDINT 2 CIFX_HOST_STATE_NOT_READY UDINT 0 HOST mode definition CIFX_HOST_STATE_READY UDINT 1 CIFX_HOST_STATE_READ UDINT 2 CIFX_BUS_STATE_OFF UDINT 0 BUS state commands CIFX_BUS_STATE_ON UDINT 1 CIFX_BUS_STATE_GETSTATE UDINT 2 CIFX_WATCHDOG_STOP UDINT 0 WATCHDOG commands CIFX_WATCHDOG_START UDINT 1 CIFX_CONFIGURATION_UNLOCK UDINT 0 Configuration Lock commands CIFX_CONFIGURATION_LOCK UDINT 1 CIFX_CONFIGURATION_GETLOCKSTATE UDINT 2 CIFX_MEM_PTR_OPEN UDINT 1 Memory pointer commands CIFX_MEM_PTR_OPEN_USR UDINT 2 CIFX_MEM_PTR_CLOSE UDINT 3 CIFX_IO_INPUT_AREA UDINT 1 I/O area definition CIFX_IO_OUTPUT_AREA UDINT 2 CIFX_SYSTEMSTART UDINT 1 Reset definitions CIFX_CHANNELINIT UDINT 2 CIFX_DOWNLOAD_MODE_FIRMWARE UDINT 1 Download commands CIFX_DOWNLOAD_MODE_CONFIG UDINT 2 CIFX_DOWNLOAD_MODE_FILE UDINT 3 CIFX_QUEUE_FIFO UDINT 0 Queue modes CIFX_QUEUE_SRCID UDINT 1 CIFX_LIST_CONF_SLAVES UDINT 1 Diag Slave List CIFX_LIST_ACTV_SLAVES UDINT 2 CIFX_LIST_FAULTED_SLAVES UDINT 3 CIFX_SLAVE_STATE_UNDEFINED UDINT 0 Slave States CIFX_SLAVE_STATE_OK UDINT 1 CIFX_SLAVE_STATE_FAILED UDINT 2 CIFX_SYSCHANNEL_TYPE_UNDEFINED UDINT 16#0 System Channel Types CIFX_SYSCHANNEL_TYPE_NOT_AVAIL UDINT 16#1 CIFX_SYSCHANNEL_TYPE_RESERVED UDINT 16#2 CIFX_SYSCHANNEL_TYPE_SYSTEM UDINT 16#3 CIFX_SYSCHANNEL_TYPE_HANDSHAKE UDINT 16#4 CIFX_SYSCHANNEL_TYPE_COM UDINT 16#5 CIFX_SYSCHANNEL_TYPE_APP UDINT 16#6
CommunicationClasses (GVL) ¶ InOut: Scope Name Type Initial Constant RCX_COMM_CLASS_UNDEFINED UDINT 16#0 RCX_COMM_CLASS_UNCLASSIFIABLE UDINT 16#1 RCX_COMM_CLASS_MASTER UDINT 16#2 RCX_COMM_CLASS_SLAVE UDINT 16#3 RCX_COMM_CLASS_SCANNER UDINT 16#4 RCX_COMM_CLASS_ADAPTER UDINT 16#5 RCX_COMM_CLASS_MESSAGING UDINT 16#6 RCX_COMM_CLASS_CLIENT UDINT 16#7 RCX_COMM_CLASS_SERVER UDINT 16#8 RCX_COMM_CLASS_IO_CONTROLLER UDINT 16#9 RCX_COMM_CLASS_IO_DEVICE UDINT 16#A RCX_COMM_CLASS_IO_SUPERVISOR UDINT 16#B RCX_COMM_CLASS_GATEWAY UDINT 16#C RCX_COMM_CLASS_MONITOR UDINT 16#D RCX_COMM_CLASS_PRODUCER UDINT 16#E RCX_COMM_CLASS_CONSUMER UDINT 16#F RCX_COMM_CLASS_SWITCH UDINT 16#10 RCX_COMM_CLASS_HUB UDINT 16#11
DiagStates (GVL) ¶ InOut: Scope Name Type Initial Constant CIFX_STATE_OFFLINE BYTE 16#0 CIFX_STATE_STOP BYTE 16#40 CIFX_STATE_CLEAR BYTE 16#80 CIFX_STATE_OPERATE BYTE 16#C0 CIFX_COS_READY UDINT 16#1 CIFX_COS_RUNNING UDINT 16#2 CFIX_COS_BUSON UDINT 16#4 CIFX_COS_CONFIG_LOCKED UDINT 16#8 CIFX_COS_CONFIG_NEW UDINT 16#10 CIFX_COS_RESTART_REQUIERED UDINT 16#20 CIFX_COS_RESTART_ENABLED UDINT 16#40
DriverSpecific (GVL) ¶ InOut: Scope Name Type Initial Comment Constant MAX_CIFX_BORDS UDINT 10 CIFX_MAX_CHANNELS_OF_ONE_BOARD UDINT 4 4 Com Channels CLASSID_CCmpIoDrvCIFX UDINT 16#1002 CMPID_CmpIoDrvCifX UDINT 16#1004 CMP_VERSION UDINT 16#3050D00 CIFX_MAX_INFO_NAME_LENTH UDINT 16 CIFX_HEADER_SIZE UDINT 40 CIFX_MAX_PACKET_SIZE UDINT 1596 CIFX_MAX_DATA_SIZE UDINT (CIFX_MAX_PACKET_SIZE - CIFX_HEADER_SIZE) CIFX_BUSS_SYNC_DEV_CNTL BYTE 1 Control modes of the hilscher card CIFX_BUFFERED_DEV_CNTL BYTE 2 CIFX_UNCONTROLLED_CNTL BYTE 3 CIFX_BUFFERED_HOST_CNTL BYTE 4 CIFX_BUSSYNC_HOST_CNTL BYTE 5 CIFX_EXTBUF_HOST_CNTL BYTE 6
InfoIDs (GVL) ¶ InOut: Scope Name Type Initial Constant INFOID_NOMEMPTRINPUT UDINT 16#1 INFOID_NOMEMPTROUTPUT UDINT 16#2 INFOID_SETHOSTSTATEFAILED UDINT 16#3 INFOID_GETHOSTSTATEFAILED UDINT 16#4 INFOID_SETBUSSTATEFAILED UDINT 16#5 INFOID_ACTIVATEWRITE UDINT 16#6 INFOID_ACTIVATEREAD UDINT 16#7 INFOID_RESETFAILED UDINT 16#8 INFOID_RESETWATCHDOGFAILED UDINT 16#9 INFOID_APPDESTIDFAILED UDINT 16#A INFOID_GETEXTSTATEBLOCKFAILED UDINT 16#B INFOID_DUMPRESETSTART UDINT 16#C INFOID_DUMPRESETEND1 UDINT 16#D INFOID_DUMPRESETEND2 UDINT 16#E INFOID_SENDREQFAULTEDSLAVESHANDLEFAILED UDINT 16#F INFOID_REQFAULTEDSLAVESHANDLEFAILED UDINT 16#10 INFOID_DUMPUNLOCKSTART UDINT 16#11 INFOID_CONFIGSTILLLOCKED UDINT 16#12 INFOID_DUMPUNLOCK UDINT 16#13 INFOID_DUMPGETPTRSTART UDINT 16#14 INFOID_DUMPGETPTREND UDINT 16#15 INFOID_DUMPLOCKEND UDINT 16#16 INFOID_DUMPLOCKSTART UDINT 16#17 INFOID_NOFIRMWARE UDINT 16#18 INFOID_WDINACTIVE UDINT 16#19 INFOID_CONFIGUREWD UDINT 16#1A INFOID_MASTER_CON_MISSING UDINT 16#1B INFOID_OPT_DEACTIVATED UDINT 16#1C INFOID_WDEXCEEDED UDINT 16#1D INFOID_INSUFFICIENT_MEM UDINT 16#1E
NetXErrorCodes (GVL) ¶ InOut: Scope Name Type Initial Constant CIFX_NO_ERROR UDINT 16#0 CIFX_INVALID_POINTER UDINT 16#800A0001 CIFX_INVALID_BOARD UDINT 16#800A0002 CIFX_INVALID_CHANNEL UDINT 16#800A0003 CIFX_INVALID_HANDLE UDINT 16#800A0004 CIFX_INVALID_PARAMETER UDINT 16#800A0005 CIFX_INVALID_COMMAND UDINT 16#800A0006 CIFX_INVALID_BUFFERSIZE UDINT 16#800A0007 CIFX_INVALID_ACCESS_SIZE UDINT 16#800A0008 CIFX_FUNCTION_FAILED UDINT 16#800A0009 CIFX_FILE_OPEN_FAILED UDINT 16#800A000A CIFX_FILE_SIZE_ZERO UDINT 16#800A000B CIFX_FILE_LOAD_INSUFF_MEM UDINT 16#800A000C CIFX_FILE_READ_ERROR UDINT 16#800A000E CIFX_FILE_TYPE_INVALID UDINT 16#800A000F CIFX_FILE_NAME_INVALID UDINT 16#800A0010 CIFX_FUNCTION_NOT_AVAILABLE UDINT 16#800A0011 CIFX_BUFFER_TOO_SHORT UDINT 16#800A0012 CIFX_MEMORY_MAPPING_FAILED UDINT 16#800A0013 CIFX_DRV_NOT_INITIALIZED UDINT 16#800B0001 CIFX_DRV_INIT_STATE_ERROR UDINT 16#800B0002 CIFX_DRV_READ_STATE_ERROR UDINT 16#800B0003 CIFX_DRV_CMD_ACTIVE UDINT 16#800B0004 CIFX_DRV_DOWNLOAD_FAILED UDINT 16#800B0005 CIFX_DRV_WRONG_DRIVER_VERSION UDINT 16#800B0006 CIFX_DRV_DRIVER_NOT_LOADED UDINT 16#800B0030 CIFX_DRV_INIT_ERROR UDINT 16#800B0031 CIFX_DRV_CHANNEL_NOT_INITIALIZED UDINT 16#800B0032 CIFX_DRV_IO_CONTROL_FAILED UDINT 16#800B0033 CIFX_DRV_NOT_OPENED UDINT 16#800B0034 CIFX_DEV_DPM_ACCESS_ERROR UDINT 16#800C0010 CIFX_DEV_NOT_READY UDINT 16#800C0011 CIFX_DEV_NOT_RUNNING UDINT 16#800C0012 CIFX_DEV_WATCHDOG_FAILED UDINT 16#800C0013 CIFX_DEV_SYSERR UDINT 16#800C0015 CIFX_DEV_MAILBOX_FULL UDINT 16#800C0016 CIFX_DEV_PUT_TIMEOUT UDINT 16#800C0017 CIFX_DEV_GET_TIMEOUT UDINT 16#800C0018 CIFX_DEV_GET_NO_PACKET UDINT 16#800C0019 CIFX_DEV_RESET_TIMEOUT UDINT 16#800C0020 CIFX_DEV_NO_COM_FLAG UDINT 16#800C0021 CIFX_DEV_EXCHANGE_FAILED UDINT 16#800C0022 CIFX_DEV_EXCHANGE_TIMEOUT UDINT 16#800C0023 CIFX_DEV_COM_MODE_UNKNOWN UDINT 16#800C0024 CIFX_DEV_FUNCTION_FAILED UDINT 16#800C0025 CIFX_DEV_DPMSIZE_MISMATCH UDINT 16#800C0026 CIFX_DEV_STATE_MODE_UNKNOWN UDINT 16#800C0027 CIFX_DEV_HW_PORT_IS_USED UDINT 16#800C0028 CIFX_DEV_CONFIG_LOCK_TIMEOUT UDINT 16#800C0029 CIFX_DEV_CONFIG_UNLOCK_TIMEOUT UDINT 16#800C002A CIFX_DEV_HOST_STATE_SET_TIMEOUT UDINT 16#800C002B CIFX_DEV_HOST_STATE_CLEAR_TIMEOUT UDINT 16#800C002C CIFX_DEV_INITIALIZATION_TIMEOUT UDINT 16#800C002D CIFX_DEV_BUS_STATE_ON_TIMEOUT UDINT 16#800C002E CIFX_DEV_BUS_STATE_OFF_TIMEOUT UDINT 16#800C002F
ProtocolClasses (GVL) ¶ InOut: Scope Name Type Initial Constant RCX_PROT_CLASS_UNDEFINED UDINT 16#0 RCX_PROT_CLASS_3964R UDINT 16#1 RCX_PROT_CLASS_ASINTERFACE UDINT 16#2 RCX_PROT_CLASS_ASCII UDINT 16#3 RCX_PROT_CLASS_CANOPEN UDINT 16#4 RCX_PROT_CLASS_CCLINK UDINT 16#5 RCX_PROT_CLASS_COMPONET UDINT 16#6 RCX_PROT_CLASS_CONTROLNET UDINT 16#7 RCX_PROT_CLASS_DEVICENET UDINT 16#8 RCX_PROT_CLASS_ETHERCAT UDINT 16#9 RCX_PROT_CLASS_ETHERNET_IP UDINT 16#A RCX_PROT_CLASS_FOUNDATION_FB UDINT 16#B RCX_PROT_CLASS_FL_NET UDINT 16#C RCX_PROT_CLASS_INTERBUS UDINT 16#D RCX_PROT_CLASS_IO_LINK UDINT 16#E RCX_PROT_CLASS_LON UDINT 16#F RCX_PROT_CLASS_MODBUS_PLUS UDINT 16#10 RCX_PROT_CLASS_MODBUS_RTU UDINT 16#11 RCX_PROT_CLASS_OPEN_MODBUS_TCP UDINT 16#12 RCX_PROT_CLASS_PROFIBUS UDINT 16#13 RCX_PROT_CLASS_PROFIBUS_MPI UDINT 16#14 RCX_PROT_CLASS_PROFINET UDINT 16#15 RCX_PROT_CLASS_RK512 UDINT 16#16 RCX_PROT_CLASS_SERCOS_II UDINT 16#17 RCX_PROT_CLASS_SERCOS_III UDINT 16#18 RCX_PROT_CLASS_TCP_IP_UDP_IP UDINT 16#19 RCX_PROT_CLASS_POWERLINK UDINT 16#1A RCX_PROT_CLASS_HART UDINT 16#1B RCX_PROT_CLASS_OEM UDINT 16#FFF0
