Qmix SDK  20200506
The software libraries for integration of all CETONI devices.
Channel Initialisation

Overview

Digital I/O module channel initialisation functions This group defines all functions to initialise digital I/O channels properly.

Each digital I/O device that is attached to the labbCAN bus offers a number of digital channels.

+ Collaboration diagram for Channel Initialisation:

Functions

LCDIO_Func long LCDIO_CALL LCDIO_GetInChanHandle (unsigned char Index, dev_hdl *pInChanHdl)
 Get digital input channel handle by its index. More...
 
LCDIO_Func long LCDIO_CALL LCDIO_GetNoOfInputChannels ()
 Query number of available digital input channels. More...
 
LCDIO_Func long LCDIO_CALL LCDIO_GetNoOfOutputChannels ()
 Query number of available digital output channels. More...
 
LCDIO_Func long LCDIO_CALL LCDIO_GetOutChanHandle (unsigned char Index, dev_hdl *pOutChanHdl)
 Get digital out channel handle by its index. More...
 
LCDIO_Func long LCDIO_CALL LCDIO_LookupInChanByName (const char *pChannelName, dev_hdl *pInChanHdl)
 Lookup for a digital input channel by its name. More...
 
LCDIO_Func long LCDIO_CALL LCDIO_LookupOutChanByName (const char *pChannelName, dev_hdl *pOutChanHdl)
 Lookup for an digital output channel by its name. More...
 

Function Documentation

◆ LCDIO_GetInChanHandle()

LCDIO_Func long LCDIO_CALL LCDIO_GetInChanHandle ( unsigned char  Index,
dev_hdl pInChanHdl 
)

Get digital input channel handle by its index.

Parameters
[in]IndexIndex into list of available digital input channels
[out]pInChanHdlHandle to input channel or 0 if the given index is out of range
Return values
-ERR_PARAM_RANGEIf the given device index is out of range
ERR_NOERRindicates success

◆ LCDIO_GetNoOfInputChannels()

LCDIO_Func long LCDIO_CALL LCDIO_GetNoOfInputChannels ( )

Query number of available digital input channels.

Return values
>=0 Number of available digital input channels
<0 Error code

◆ LCDIO_GetNoOfOutputChannels()

LCDIO_Func long LCDIO_CALL LCDIO_GetNoOfOutputChannels ( )

Query number of available digital output channels.

Return values
>=0 Number of available digital output channels
<0 Error code

◆ LCDIO_GetOutChanHandle()

LCDIO_Func long LCDIO_CALL LCDIO_GetOutChanHandle ( unsigned char  Index,
dev_hdl pOutChanHdl 
)

Get digital out channel handle by its index.

Parameters
[in]IndexIndex into list of available digital out channels
[out]pOutChanHdlHandle to output channel or 0 if the given index is out of range
Return values
-ERR_PARAM_RANGEIf the given device index is out of range
ERR_NOERRindicates success

◆ LCDIO_LookupInChanByName()

LCDIO_Func long LCDIO_CALL LCDIO_LookupInChanByName ( const char *  pChannelName,
dev_hdl pInChanHdl 
)

Lookup for a digital input channel by its name.

Parameters
[in]pChannelNameThe name to assign with this channel
[out]pInChanHdlHandle to input channel handle if the channel was successfully opened
Return values
-ERR_NODEVNo device with the given name found
ERR_NOERRindicates success

◆ LCDIO_LookupOutChanByName()

LCDIO_Func long LCDIO_CALL LCDIO_LookupOutChanByName ( const char *  pChannelName,
dev_hdl pOutChanHdl 
)

Lookup for an digital output channel by its name.

Parameters
[in]pChannelNameThe name to assign with this channel
[out]pOutChanHdlHandle to output channel handle if the channel was successfully opened
Return values
-ERR_NODEVNo device with the given name found
ERR_NOERRindicates success
Examples:
capi_dynamic_controller_test.cpp.