sensors.h File Reference

Declarations of sensor types and sensors interface. More...

#include <pwrCtrl.h>
#include <lm73.h>
#include <tsl2550.h>
#include <battery.h>

Go to the source code of this file.

Functions
static result_t	BSP_OpenTemperatureSensor ()
	Opens temperature sensor.
static result_t	BSP_CloseTemperatureSensor ()
	Closes the temperature sensor.
static result_t	BSP_ReadTemperatureData (void(*f)(bool result, int16_t data))
	Reads data from the temperature sensor.
static result_t	BSP_OpenLightSensor ()
	Opens the light sensor.
static result_t	BSP_CloseLightSensor ()
	Closes the light sensor.
static result_t	BSP_ReadLightData (void(*f)(bool result, int16_t data))
	Reads data from the light sensor.
static result_t	BSP_OpenBatterySensor ()
	Opens the battery sensor.
static result_t	BSP_CloseBatterySensor ()
	Closes the battery sensor.
static result_t	BSP_ReadBatteryData (void(*callback)(uint8_t data))
	Reads data from battery sensor.

---

Detailed Description

Declarations of sensor types and sensors interface.

Definition in file sensors.h.

---

Function Documentation

static result_t BSP_CloseBatterySensor

(

)

[inline, static]

Closes the battery sensor.

Returns:

FAIL - sensor was not opened.
SUCCESS - otherwise.

Definition at line 151 of file sensors.h.

static result_t BSP_CloseLightSensor

(

)

[inline, static]

Closes the light sensor.

Returns:

FAIL - if a hardware error has occured or there is uncompleted ReadData request.
SUCCESS - otherwise.

Definition at line 102 of file sensors.h.

static result_t BSP_CloseTemperatureSensor

(

)

[inline, static]

Closes the temperature sensor.

Returns:

FAIL - if a hardware error has occured or there is uncompleted ReadData request.
SUCCESS - otherwise.

Definition at line 51 of file sensors.h.

static result_t BSP_OpenBatterySensor

(

)

[inline, static]

Opens the battery sensor.

Returns:

FAIL - sensor has been already open.
SUCCESS - otherwise.

Definition at line 135 of file sensors.h.

static result_t BSP_OpenLightSensor

(

)

[inline, static]

Opens the light sensor.

Returns:

FAIL - sensor has been already open.
SUCCESS - otherwise.

Definition at line 85 of file sensors.h.

static result_t BSP_OpenTemperatureSensor

(

)

[inline, static]

Opens temperature sensor.

Returns:

FAIL - sensor has been already open.
SUCCESS - otherwise.

Definition at line 34 of file sensors.h.

static result_t BSP_ReadBatteryData

(

void(*)(uint8_t data)

callback

)

[inline, static]

Reads data from battery sensor.

Parameters:

[in]

data

- sensor data.

Returns:

FAIL - previous request was not completed, or sensor was not opened.
SUCCESS - otherwise.

Definition at line 169 of file sensors.h.

static result_t BSP_ReadLightData

(

void(*)(bool result, int16_t data)

f

)

[inline, static]

Reads data from the light sensor.

Parameters:

[in]	result	- the result of the requested operation. true - operation finished successfully, false - some error has occured.
[in]	data	- sensor data.

Returns:

FAIL - previous request was not completed.
SUCCESS - otherwise.

Definition at line 124 of file sensors.h.

static result_t BSP_ReadTemperatureData

(

void(*)(bool result, int16_t data)

f

)

[inline, static]

Reads data from the temperature sensor.

Parameters:

[in]	result	- the result of the requested operation. true - operation finished successfully, false - some error has occured.
[in]	data	- sensor data.

Returns:

FAIL - previous request was not completed.
SUCCESS - otherwise.

Definition at line 73 of file sensors.h.

---