CETONI SDK  20220623
The software libraries for integration of all CETONI devices.

Overview

Analog input channel functions This group defines all functions to measure analog input signals via various analog input channels.

+ Collaboration diagram for Analog Input:

Functions

LCAIO_Func long LCAIO_CALL LCAIO_GetInputSwScalingParam (dev_hdl InChanHdl, double *pScalingFactor, double *pScalingOffset)
 Query software scaling parameters. More...
 
LCAIO_Func long LCAIO_CALL LCAIO_ReadInput (dev_hdl InChanHdl, double *pfValue)
 Read analog input of this channel. More...
 
LCAIO_Func long LCAIO_CALL LCAIO_ReadStatus (dev_hdl InChanHdl, unsigned long *pdwStatus)
 Read additional status information from analog channel. More...
 
LCAIO_Func long LCAIO_CALL LCAIO_SetInputSwScalingOn (dev_hdl InChanHdl, int ScalingOn)
 Enable / disable software scaling. More...
 
LCAIO_Func long LCAIO_CALL LCAIO_SetInputSwScalingParam (dev_hdl InChanHdl, double ScalingFactor, double ScalingOffset)
 Set software scaling parameters. More...
 

Function Documentation

◆ LCAIO_GetInputSwScalingParam()

LCAIO_Func long LCAIO_CALL LCAIO_GetInputSwScalingParam ( dev_hdl  InChanHdl,
double *  pScalingFactor,
double *  pScalingOffset 
)

Query software scaling parameters.

Parameters
[in]InChanHdlValid handle of analog input channel
[out]pScalingFactorThe scaling factor multiplied with field value
[out]pScalingOffsetThe scaling offset added to field value
Return values
ERR_NOERRindicates success
-ERR_NOTSUPLinear scaling not supported (i.e. if channel uses a different kind of scaling like PT100 scaling)
See also
LCAIO_SetInputSwScalingParam(), LCAIO_SetInputSwScalingOn()

◆ LCAIO_ReadInput()

LCAIO_Func long LCAIO_CALL LCAIO_ReadInput ( dev_hdl  InChanHdl,
double *  pfValue 
)

Read analog input of this channel.

Parameters
[in]InChanHdlValid handle of analog input channel
[out]pfValueReturn analog input value
Returns
Error code - ERR_NOERR indicates success

◆ LCAIO_ReadStatus()

LCAIO_Func long LCAIO_CALL LCAIO_ReadStatus ( dev_hdl  InChanHdl,
unsigned long *  pdwStatus 
)

Read additional status information from analog channel.

Parameters
[in]InChanHdlValid handle of analog input channel
[out]pdwStatusReturns the status read from the channel
Returns
Error code - ERR_NOERR indicates success

◆ LCAIO_SetInputSwScalingOn()

LCAIO_Func long LCAIO_CALL LCAIO_SetInputSwScalingOn ( dev_hdl  InChanHdl,
int  ScalingOn 
)

Enable / disable software scaling.

Parameters
[in]InChanHdlValid handle of analog input channel
[in]ScalingOn1 = Scaling on, 0 = Scaling off
Returns
Error code - ERR_NOERR indicates success

◆ LCAIO_SetInputSwScalingParam()

LCAIO_Func long LCAIO_CALL LCAIO_SetInputSwScalingParam ( dev_hdl  InChanHdl,
double  ScalingFactor,
double  ScalingOffset 
)

Set software scaling parameters.

These parameters are used to scale the measured value from device. These scaling parameters are independent from the device scaling parameters and the scaling is performed on the local machine. Scaled Value = (Process Value * Scaling Factor) + Scaling Offset. The default value for Scaling Factor is 1 and for Scaling Offset is 0.

Parameters
[in]InChanHdlValid handle of analog input channel
[in]ScalingFactorThe scaling factor to multiply with field value
[in]ScalingOffsetThe scaling offset ro add to field value
Return values
ERR_NOERRindicates success
-ERR_NOTSUPLinear scaling not supported (i.e. if channel uses a different kind of scaling like PT100 scaling)
See also
LCAIO_GetInputSwScalingParam(), LCAIO_SetInputSwScalingOn()