CIF API
- Michael Trensch
- Robert Mayer (Deactivated)
The CIF API is the common CIF/COM Application Programming Interface (CIF API) and describes the containing functions, offered for all Hilscher standard devices based on EC1 controller hardware.
Aim of the API is to provide applications a target and fieldbus independent programming interface to Hilscher hardware running a standard Hilscher fieldbus protocol or
firmware which meet the Hilscher EC1 dual port memory (DPM) definitions.
The API is designed to give the user easy access to all of the communication board functionalities.
In addition, Hilscher also offers a free of charge CIF C-Toolkit (C-source code based) which can be integrated in own applications or used to write own drivers based on the Hilscher EC1 DPM definitions.
The CIF API is based on a single C header file (CIFUSER.H) containing all necessary information like data structure, constant and prototype definitions.
And it is offered by any CIF device driver from Hilscher.
Note: The API description can be found in the "CIF Device Driver - Windows" manual.
API Function Overview
Function Group | Function | Description |
|---|---|---|
Initialization | DevOpenDriver() | Links an application to the device driver |
DevCloseDriver() | Closes a Link to the driver | |
DevInitBoard () | Links an application to a board | |
DevExitBoard() | Closes a Link to a board | |
|
|
|
Device control | DevReset() | Reset a board |
DevSetHostState() | Sets/Clears the information bit for host is running | |
DevTriggerWatchDog() | Serves the watchdog function of a board | |
|
|
|
Message Data Transfer | DevPutMessage() | Transfer a message to the board |
DevGetMessage() | Reads a message from a board | |
DevGetMBXState() | Read the actual mailbox state | |
|
|
|
IO Data Transfer | DevExchangeIO() | Put/Get IO data from/to a board |
DevExchangeIOEx() | Put/Get IO data from/to a COM module | |
DevExchangeIOErr() | Put/Get IO data from/to a board including state information | |
DevReadSendData() | Read back IO data from the send area | |
|
|
|
Protocol Information / Configuration | DevPutTaskParameter() | Writes the parameters for a communication task |
DevGetTaskParameter() | Reads the parameters from a communication task | |
DevGetTaskState() | Read all task states from a board | |
|
|
|
Device Information | DevGetBoardInfo() | Read global board information |
DevGetInfo() | Reads the various information from a board | |
|
|
|
Other | DevReadWriteDPMRaw() | Read/write to/from the last Kbytes of a DPM |
|
|
|
System Function | DevDownload() | Firmware/Configuration download |
| Document Type | Title | Contents | Rev | Date | File Type |
|---|---|---|---|---|---|
| Programming Reference Guide | cif Device Driver - Windows.pdf | CIF API description | 14 | 02-2013 |