Publication 1756-RM004B-EN-P - October 2000
4-4 CIP Messaging API
CIP API Functions
The CIP API library functions are listed in table 4.B. Details for each
function are provided in the following sections.
Table 4.B CIP API Library Functions
Function Category Function Name Description
Initialization MVIcip_Open Initialize access to the CIP API Initialization
MVIcip_Close Terminate access to the CIP API
Object Registration MVIcip_RegisterAssemblyObj Register all instances of the Assembly Object, enabling
other devices in the CIP system to establish
connections with the object. Callbacks are used to
handle connection and service requests.
MVIcip_UnregisterAssemblyObj Unregister all instances of the Assembly Object that
had previously been registered. Subsequent
connection requests to the object will be refused.
Connected Data Transfer MVIcip_WriteConnected Write data to a connection
MVIcip_ReadConnected Read data from a connection
Callback Functions connect_proc Application function called by the CIP API when a
connection request is received for the registered object
service_proc Application function called by the CIP API when a
message is received for the registered object
rxdata_proc Application function called by the CIP API when data is
received on an open connection
fatalfault_proc Application function called if the backplane device
driver detects a fatal fault condition
flashupdate_proc Application function called when flash update is
initiated
resetrequest_proc Application function called when a module reset
request is received
Special Callback
Registration
MVIcip_RegisterReset ReqRtn Register a reset request handler routine
MVIcip_RegisterFatalFaultRtn Register a fatal fault handler routine
MVIcip_RegisterFlashUpdateRtn Register a flash update callback routine
Miscellaneous MVIcip_GetIdObject Return data from the module’s Identity Object
MVIcip_GetVersionInfo Get the CIP API version information
MVIcip_SetUserLED Set the state of a user LED
MVIcip_SetModuleStatus Set the state of the status LED
MVIcip_ErrorString Get a text description of an error code
MVIcip_GetSetupMode Get the state of the setup jumper
MVIcip_GetConsoleMode Get the state of the console (programming port PRT1)
MVIcip_Sleep Suspend task for specified time
To Next Page
Loading...
