Cogent CIF Driver for Hilscher Fieldbus CIF Cards

Version 6.4

April 04, 2008

Interface specifications for the command set of the CIF Driver.

Cogent software is source-code compatible among the Linux, QNX 6, and QNX 4 operating systems.
Go to the Cogent Web Site.
Copyright, trademark, and software license information.

Table of Contents

1. Introduction
1.1. System Requirements
1.2. Hardware Installation
1.3. Driver Installation
1.3.1. QNX 4
1.3.2. QNX 6
1.3.3. Linux
1.3.4. Installed file locations
1.4. Fieldbus-Related Card Configuration
1.4.1. Default Configuration
1.4.2. Downloading Configuration to the Card
1.5. Driver Configuration
1.5.1. Common Configuration Commands
1.5.2. Sample Configuration File
1.6. Initial Startup
1.6.1. Licensing the CIF Driver
1.6.2. Running the CIF Driver
1.6.3. Testing communication to I/O
1.7. Cogent Product Integration
1.8. Where can I get help?

2. Overview
2.1. System Overview
2.1.1. Driver Interfaces
2.1.2. Data Model
2.1.3. User Application Interface Model
2.2. Dataflow and Synchronization
2.2.1. Data Transfer between Fieldbus and Card
2.2.2. Data Transfer between Card and Driver
2.2.3. Data Transfer between Card and Points
2.3. Error Handling

3. API Specifications

4. Direct Interface Specifications
4.1. Structure Definitions
4.2. Message Format

5. Cascade DataHub Interface

6. Command Interface
6.1. Syntax
6.2. Generic Command Responses
6.3. Configuration File
6.4. Interactive Interface

A. Test Scenario
A.1. The Test Environment
A.2. Cascade Architecture
A.2.1. Inputs
A.2.2. Outputs
A.3. The testbed.cfg Configuration File
A.4. Test Application for the CIF Driver
A.5. Typical Test Application Output
B. Summary of Reported Errors
D. GNU General Public License
E. GNU Lesser General Public License

I. Command Reference
add - allows a point to be added to a group.
analog - creates a point of type analog.
apropos - lists all driver commands.
aproposPnts - gets a list of current point names.
aproposSyntax - gives command usage.
attachName - (Deprecated as of Version 4.0) publishes the driver name to the QNX name server.
attachNS - attaches the driver to the Cascade NameServer.
bufferActiveLength - queries or sets the number of active bytes of a buffer.
bufferDescribe - verifies the allocation of data buffers.
bufferUpdate - triggers an I/O cycle of the buffers.
bufferUpdateGroups - triggers an I/O cycle of buffers and point groups.
cardComState - sets or queries the card bus communication state.
cardDescribe - provides a list of the cards available.
cardEnable - sets or queries card enable status.
cardGroup - sets or queries assignments of groups to cards.
cardInit - initializes CIF cards.
cardIoStatus - provides process I/O data exchange status for cards.
cardPoll - sets up or queries card polling parameters.
cardProfile - produces a detailed profile of card attributes.
cardReset - performs a COLD or WARM reset of one or more cards.
cardSwapByteOrder - controls byte order of 16-bit point access.
cardTaskParms - sets or queries the protocol task parameters for CIF cards.
cardTaskState - provides fieldbus device status for cards.
cardVersion - extracts firmware information from a card.
cifDownloadCfg - downloads a Sycon configuration file to the specified card.
cifTelegram - provides formatted access to the CIF message data interface.
cifTelegramBin - sends a telegram and waits for a response.
cifTelegramBinReceive - waits for any telegram to arrive.
cifTelegramBinSend - sends a telegram, and returns immediately without waiting for a reply.
cifTelegramFmt - creates a named format string for cifTelgram.
cycle - changes the cycle time of a point.
cycleModify - queries, changes, or sets the cycle time of a point.
datahub - connects to the Cascade DataHub.
debug - controls amount of debug output.
define - assigns a symbol name to a constant.
describePnt - describes the attributes of a point.
describePntAddr - describes a point's address.
devGet - gives read access to card buffers for low-level debugging.
devSet - gives write access to card buffers for low-level debugging.
digital - creates a point of type digital.
disable - clears the enabled attribute of points.
drcif_ad - starts the CIF Driver.
enable - sets the enabled attribute of points.
errorDescription - provides the text associated with an error code.
exit - shuts down the driver.
group - creates a point of type group.
heartbeat - creates a point of type heartbeat.
include - reads a configuration file.
license - activates the commercial license.
licenseFile - enables the driver license, using a license file.
point - reports datahub exceptions on a point, and writes them.
read - reads the value of a point.
readable - sets the readable attribute of a point.
remove - removes a point from a group.
schedParms - queries or sets the OS scheduling parameters of the driver.
segmentDefine - defines the attributes of a buffer segment.
segmentDescribe - describes the segments of a buffer.
statusPointDefine - names a driver status point.
statusPointValue - gives the value of a driver status point.
taskstarted, taskdied - reserved nserve commands to indicate the start or death of a process.
type - creates macro-like definitions.
typeDesc - associates a descriptive string with a command name.
updateStatus - forces the card flags to be read and processed.
version - reports the version number of the driver.
write - writes a new value to a point.
writable - sets the writable attribute of a point.

List of Figures

2.1. System Architecture
2.2. Driver Block Data Flow
A.1. Test Scenario Field I/O modules
A.2. Test Panel