sensor.h File Reference

Generic sensor (measurement reading) functions. More...

#include <stdbool.h>

Go to the source code of this file.

Typedefs
typedef struct _SensorData	SensorData
	Single sensor internal data structure.
typedef SensorData *	Sensor
	Opaque reference to sensor internal data structure.

Functions
Sensor	Sensor_Init (const char *configName)
	Creates and initializes sensor data structure based on given information.
void	Sensor_End (Sensor sensor)
	Deallocates internal data of given sensor.
double	Sensor_Update (Sensor sensor)
	Performs single reading and processing of signal measured by given sensor.
bool	Sensor_HasError (Sensor sensor)
	Calls underlying signal reading implementation (plugin) to check for errors on given sensor.
void	Sensor_Reset (Sensor sensor)
	Resets signal processing state and possible sensor device errors.
void	Sensor_SetOffset (Sensor sensor)
	Sets given sensor to offset acquisition mode.
void	Sensor_SetCalibration (Sensor sensor)
	Sets given sensor to range calibration mode.
void	Sensor_SetMeasurement (Sensor sensor)
	Sets given sensor to measurement/operation mode.

Detailed Description

Generic sensor (measurement reading) functions.

Interface for configurable sensor reading and state change. Specific underlying implementation (plug-in) and further configuration are defined as explained in Sensor Configuration

Function Documentation

Sensor_End()

void Sensor_End

(

Sensor

sensor

)

Deallocates internal data of given sensor.

Parameters

[in]

sensor

reference to sensor

Sensor_HasError()

bool Sensor_HasError

(

Sensor

sensor

)

Calls underlying signal reading implementation (plugin) to check for errors on given sensor.

Parameters

[in]

sensor

reference to sensor

Returns

true on detected error, false otherwise

Sensor_Init()

Sensor Sensor_Init

(

const char *

configName

)

Creates and initializes sensor data structure based on given information.

Parameters

[in]

configName

name of file containing configuration parameters, as explained at Sensor Configuration

Returns

reference/pointer to newly created and initialized sensor data structure

Sensor_Reset()

void Sensor_Reset

(

Sensor

sensor

)

Resets signal processing state and possible sensor device errors.

Parameters

[in]

sensor

reference to sensor

Sensor_SetCalibration()

void Sensor_SetCalibration

(

Sensor

sensor

)

Sets given sensor to range calibration mode.

Parameters

[in]

sensor

reference to sensor

Sensor_SetMeasurement()

void Sensor_SetMeasurement

(

Sensor

sensor

)

Sets given sensor to measurement/operation mode.

Parameters

[in]

sensor

reference to sensor

Sensor_SetOffset()

void Sensor_SetOffset

(

Sensor

sensor

)

Sets given sensor to offset acquisition mode.

Parameters

[in]

sensor

reference to sensor

Sensor_Update()

double Sensor_Update

(

Sensor

sensor

)

Performs single reading and processing of signal measured by given sensor.

Parameters

[in]

sensor

reference to sensor

Returns

current value of processed signal (0.0 on erros)