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.

artik_sensor_pressure Struct Reference

SENSOR PRESSURE devices data structure. More...

#include <sensor/artik_sensor.h>

Data Fields

artik_error(* request )(artik_sensor_handle *handle, artik_sensor_config *config)
 Request a PRESSURE SENSOR instance. More...
 
artik_error(* release )(artik_sensor_handle handle)
 Release the PRESSURE SENSOR instance. More...
 
artik_error(* get_pressure )(artik_sensor_handle handle, int *store)
 get_pressure returns the atmospheric pressure in millibars More...
 

Detailed Description

Structure which serve as an interface for requested SENSOR device

Examples:
sensor_test/artik_sensor_test.c.

Definition at line 520 of file artik_sensor.h.

Field Documentation

artik_error(* artik_sensor_pressure::get_pressure) (artik_sensor_handle handle, int *store)
Parameters
[in]handleHandle tied to the requested PRESSURE SENSOR communication module instance to be released. This handle is returned by the 'get_pressure_sensor' function.
[out]storePointer to a variable returning 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 557 of file artik_sensor.h.

artik_error(* artik_sensor_pressure::release) (artik_sensor_handle handle)
Parameters
[in]handleHandle tied to the requested SENSOR 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 542 of file artik_sensor.h.

artik_error(* artik_sensor_pressure::request) (artik_sensor_handle *handle, artik_sensor_config *config)
Parameters
[in]handleHandle tied to the requested SENSOR instance to be released. This handle is returned by the 'request' function.
[in,out]configConfiguration structure.
Returns
S_OK on success, error code otherwise

Definition at line 531 of file artik_sensor.h.


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