↓

Filter results by

Older Versions

Older API versions are available as a download. To view, extract the file and open the index.html file in a web browser.

Data Fields
artik_sensor_module Struct Reference

SENSOR module operations. More...

#include <sensor/artik_sensor.h>

Data Fields

artik_error(* request )(artik_sensor_config *config, artik_sensor_handle *handle, artik_sensor_ops *sensor)
 Request a SENSOR instance. More...
 
artik_sensor_config *(* list )(void)
 List all sensor configuration for a SENSOR instance. More...
 
artik_sensor_config *(* get_sensor )(unsigned int index, artik_sensor_device_t type)
 Get a device sensor config for instanciate a SENSOR device. More...
 
artik_sensor_config *(* get_accelerometer_sensor )(unsigned int index)
 Get Accelerometer config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_humidity_sensor )(unsigned int index)
 Get Humidity sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_light_sensor )(unsigned int index)
 Get Light sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_temperature_sensor )(unsigned int index)
 Get Temperature sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_proximity_sensor )(unsigned int index)
 Get Proximity sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_flame_sensor )(unsigned int index)
 Get Flame sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_pressure_sensor )(unsigned int index)
 Get Pressure sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_gyro_sensor )(unsigned int index)
 Get Gyro sensor config for instantiating a Sensor device. More...
 
artik_sensor_config *(* get_hall_sensor )(unsigned int index)
 Get Hall sensor config for instantiating a Sensor device. More...
 

Detailed Description

Structure containing all the exposed operations exposed by the module to operate on a SENSOR instance

Examples:
sensor_test/artik_sensor_test.c.

Definition at line 618 of file artik_sensor.h.

Field Documentation

artik_sensor_config*(* artik_sensor_module::get_accelerometer_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 666 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_flame_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise

Definition at line 718 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_gyro_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 738 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_hall_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 748 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_humidity_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 676 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_light_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 686 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_pressure_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 728 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_proximity_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise

Definition at line 708 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_sensor) (unsigned int index, artik_sensor_device_t type)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
[in]typeType is the type of the Sensor device
Returns
S_OK on success, NULL otherwise

Definition at line 655 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::get_temperature_sensor) (unsigned int index)
Parameters
[in]indexIndex of the sensor in the configuration table of a Sensor device.
Returns
S_OK on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 697 of file artik_sensor.h.

artik_sensor_config*(* artik_sensor_module::list) (void)
Returns
The config list for the platform on success, NULL otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 645 of file artik_sensor.h.

artik_error(* artik_sensor_module::request) (artik_sensor_config *config, artik_sensor_handle *handle, artik_sensor_ops *sensor)
Parameters
[in,out]configConfiguration to apply to the requested SENSOR.
[in,out]handleHandle tied to the requested SENSOR instance filled by the function.
[in]sensorSensor tied to the requested SENSOR Device instance to be released. This sensor is stored statically in artik_a5_platform.h or artik_a10_platform with the specific config structure.
Returns
S_OK on success, error code otherwise
Examples:
sensor_test/artik_sensor_test.c.

Definition at line 636 of file artik_sensor.h.

The documentation for this struct was generated from the following file:
Last updated on: