Sensor

Sensor Library. More...

Modules

Accelerometer Data Types
Accelerometer sensor data types.
 
Air Quality Sensor Data Types
Air quality sensor data types.
 
Gyroscope Data Types
Gyroscope sensor data types.
 
Hygrometer Data Types
Hygrometer sensor data types.
 
Light Sensor Data Types
Light sensor data types.
 
Magnetometery Data Types
Magnetometer sensor data types.
 
Thermometer Data Types
Thermometer sensor data types.
 

Macros

#define SENSOR_LIB_REGISTER_SENSOR_TYPE(name, id)
 Register a sensor type with the sensor library.
 

Enumerations

enum  sensor_id_t {
  SENSOR_ACCELEROMETER,
  SENSOR_HYGROMETER,
  SENSOR_THERMOMETER,
  SENSOR_GYROSCOPE,
  SENSOR_MAGNETOMETER
}
 Sensor id enumeration. More...
 

Functions

zos_result_t sensor_init (sensor_id_t sensor_id, const void *config)
 Initialise sensor driver. More...
 
zos_result_t sensor_has_new_data (sensor_id_t sensor_id, zos_bool_t *has_data)
 Poll sensor to see if new data is available. More...
 
zos_result_t sensor_get_data (sensor_id_t sensor_id, void *data)
 Get latest data from sensor. More...
 

Detailed Description

Sensor Library.

Enumeration Type Documentation

Sensor id enumeration.

Enumerator
SENSOR_ACCELEROMETER 

Accelerometer.

SENSOR_HYGROMETER 

Hygrometer.

SENSOR_THERMOMETER 

Thermometer.

SENSOR_GYROSCOPE 

Gyroscope.

SENSOR_MAGNETOMETER 

Magnetometer.

Function Documentation

zos_result_t sensor_get_data ( sensor_id_t  sensor_id,
void *  data 
)

Get latest data from sensor.

Parameters
[in]sensor_idID of sensor to initialise
[out]dataData from sensor (specific to sensor device)
Returns
zos_result_t
zos_result_t sensor_has_new_data ( sensor_id_t  sensor_id,
zos_bool_t has_data 
)

Poll sensor to see if new data is available.

Parameters
[in]sensor_idID of sensor to initialise
[out]has_dataTrue if there is new data available
Returns
zos_result_t
zos_result_t sensor_init ( sensor_id_t  sensor_id,
const void *  config 
)

Initialise sensor driver.

Parameters
[in]sensor_idID of sensor to initialise
[in]configconfig used by initialisation function (specific to device)
Returns
zos_result_t