ProSoft Technology MVI56E-LDM User Manual
Page 6
Contents
ControlLogix Platform ♦ "C" Programmable
Developer's Manual
Linux Application Development Module
Page 6 of 264
ProSoft Technology, Inc.
March 12, 2014
4.15
Tag_Sample............................................................................................................ 53
4.16
Sample Applications ............................................................................................... 55
4.17
Ethernet Communications Sample ......................................................................... 56
4.18
Serial Application Sample ....................................................................................... 61
5
CIP API Functions
70
5.1
CIP API Initialization Functions ............................................................................... 73
OCXcip_Open ............................................................................................................................. 73
OCXcip_OpenNB ........................................................................................................................ 74
OCXcip_Close ............................................................................................................................. 77
5.2
Object Registration ................................................................................................. 79
OCXcip_RegisterAssemblyObj ................................................................................................... 79
OCXcip_UnregisterAssemblyObj ................................................................................................ 82
5.3
Special Callback Registration ................................................................................. 84
OCXcip_RegisterFatalFaultRtn ................................................................................................... 84
OCXcip_RegisterResetReqRtn ................................................................................................... 86
5.4
CIP Callback Functions .......................................................................................... 88
connect_proc ............................................................................................................................... 88
service_proc ................................................................................................................................ 93
fatalfault_proc .............................................................................................................................. 97
5.5
Connected Data Transfer ....................................................................................... 99
OCXcip_WriteConnected ............................................................................................................ 99
OCXcip_ReadConnected .......................................................................................................... 101
OCXcip_ImmediateOutput ........................................................................................................ 103
OCXcip_WaitForRxData ........................................................................................................... 105
OCXcip_WriteConnectedComplete ........................................................................................... 107
5.6
Tag Access Functions .......................................................................................... 110
OCXcip_AccessTagData ........................................................................................................... 110
OCXcip_AccessTagDataAbortable ........................................................................................... 113
OCXcip_CreateTagDbHandle ................................................................................................... 114
OCXcip_DeleteTagDbHandle ................................................................................................... 115
OCXcip_SetTagDbOptions ....................................................................................................... 116
OCXcip_BuildTagDb ................................................................................................................. 119
OCXcip_TestTagDbVer ............................................................................................................. 121
OCXcip_GetSymbolInfo ............................................................................................................ 123
OCXcip_GetStructInfo ............................................................................................................... 126
OCXcip_GetStructMbrInfo ......................................................................................................... 129
OCXcip_GetTagDbTagInfo ....................................................................................................... 132
OCXcip_AccessTagDataDb ...................................................................................................... 135
5.7
Messaging ............................................................................................................. 138
OCXcip_GetDeviceIdObject ...................................................................................................... 139
OCXcip_GetDeviceICPObject ................................................................................................... 142
OCXcip_GetDeviceIdStatus ...................................................................................................... 145
OCXcip_GetExDeviceObject..................................................................................................... 149
OCXcip_GetWCTime ................................................................................................................ 152
OCXcip_SetWCTime ................................................................................................................. 156
OCXcip_GetWCTimeUTC ......................................................................................................... 159
OCXcip_SetWCTimeUTC ......................................................................................................... 163
5.8
Miscellaneous Functions ...................................................................................... 166
OCXcip_GetIdObject ................................................................................................................. 167
OCXcip_SetIdObject ................................................................................................................. 169
OCXcip_GetActiveNodeTable ................................................................................................... 171