artik_sensor_light Struct Reference
SENSOR LIGHT devices data structure. More...
#include <sensor/artik_sensor.h>
Data Fields | |
| artik_error(* | request )(artik_sensor_handle *handle, artik_sensor_config *config) |
| Request a LIGHT SENSOR instance. More... | |
| artik_error(* | release )(artik_sensor_handle handle) |
| Release a TEMPERATURE SYS SENSOR instance. More... | |
| artik_error(* | get_intensity )(artik_sensor_handle handle, int *store) |
| get_intensity permit to return the percent of the environement brightness More... | |
Detailed Description
Structure which serve as an interface for requested SENSOR device
- Examples:
- sensor_test/artik_sensor_test.c.
Definition at line 316 of file artik_sensor.h.
Field Documentation
| artik_error(* artik_sensor_light::get_intensity) (artik_sensor_handle handle, int *store) |
- Parameters
-
[in] handle handle tied to the requested LIGHT communication module instance to be released. This handle is returned by the 'get_light_sensor' function. [in] store permit to save the result of the function.
- Returns
- S_OK and store the value into the parameter on success, error code otherwise
- Examples:
- sensor_test/artik_sensor_test.c.
Definition at line 351 of file artik_sensor.h.
| artik_error(* artik_sensor_light::release) (artik_sensor_handle handle) |
- Parameters
-
[in] handle handle tied to the requested LIGHT instance to be released. This handle is returned by the 'request' function.
- Returns
- S_OK on success, error code otherwise
- Examples:
- sensor_test/artik_sensor_test.c.
Definition at line 337 of file artik_sensor.h.
| artik_error(* artik_sensor_light::request) (artik_sensor_handle *handle, artik_sensor_config *config) |
- Parameters
-
[in] handle handle tied to the requested LIGHT instance to be released. This handle is returned by the 'request' function. [in,out] config config is the configuration structure.
- Returns
- S_OK on success, error code otherwise
Definition at line 327 of file artik_sensor.h.
The documentation for this struct was generated from the following file:
- inc/sensor/artik_sensor.h
Last updated on: