OWLIFT C Library for Windows: Controling Sensor
OWLIFT C Library for Windows  1.9.3
Top Page
Functions
Controling Sensor

Functions

OwStatus_t OwLib_CommandGet (OwDev dev, UINT16 moduleID, UINT16 cmdIDBase, UINT16 *data, UINT16 ndata)
 
OwStatus_t OwLib_CommandSet (OwDev dev, UINT16 moduleID, UINT16 cmdIDBase, const UINT16 *data, UINT16 ndata)
 
OwStatus_t OwLib_CommandRun (OwDev dev, UINT16 moduleID, UINT16 cmdIDBase)
 

Detailed Description

Function Documentation

◆ OwLib_CommandGet()

OwStatus_t OwLib_CommandGet ( OwDev  dev,
UINT16  moduleID,
UINT16  cmdIDBase,
UINT16 *  data,
UINT16  ndata 
)

Executes the sensor's command as command type "GET", and reads registers as a result. See this document about sensor's commands.

Parameters
dev[in] The device handle.
moduleID[in] The Module ID.
cmdIDBase[in] The Command ID Base.
data[out] The array that receives registers' values. The array size must be greater than or equal to 'ndata'.
ndata[in] The number of the registers to read in WORDs. DATA 0 Register .. DATA 15 Register are readable. 'ndata' means the number of registers to read counting from DATA 0 Register. The byte order is host endian.
Returns
The error code.

◆ OwLib_CommandRun()

OwStatus_t OwLib_CommandRun ( OwDev  dev,
UINT16  moduleID,
UINT16  cmdIDBase 
)

Executes the sensor's command as command type "RUN". See this document about sensor's commands.

Parameters
dev[in] The device handle.
moduleID[in] The Module ID.
cmdIDBase[in] The Command ID Base.
Returns
The error code.

◆ OwLib_CommandSet()

OwStatus_t OwLib_CommandSet ( OwDev  dev,
UINT16  moduleID,
UINT16  cmdIDBase,
const UINT16 *  data,
UINT16  ndata 
)

Writes the specified value to the register, and executes the sensor's command as command type "SET". See this document about sensor's commands.

Parameters
dev[in] The device handle.
moduleID[in] The Module ID.
cmdIDBase[in] The Command ID Base.
data[in] The array that stores registers' values. The array size must be greater than or equal to 'ndata'.
ndata[in] The number of the registers to write in WORDs. DATA 0 Register .. DATA 15 Register are writable. 'ndata' means the number of registers to write counting from DATA 0 Register. The byte order is host endian.
Returns
The error code.