↓

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_gyro Struct Reference

SENSOR GYROMETER devices data structure. More...

#include <sensor/artik_sensor.h>

Data Fields

artik_error(* request )(artik_sensor_handle *handle, artik_sensor_config *config)
 Request a GYROMETER SENSOR instance. More...
 
artik_error(* release )(artik_sensor_handle handle)
 Release the SENSOR instance. More...
 
artik_error(* get_yaw )(artik_sensor_handle handle, int *store)
 get_yaw permit to return the Yaw as measured by the sensor More...
 
artik_error(* get_roll )(artik_sensor_handle handle, int *store)
 get_roll returns the Roll value as measured by the sensor More...
 
artik_error(* get_pitch )(artik_sensor_handle handle, int *store)
 get_pitch returns the Pitch value as measured by the sensor More...
 

Detailed Description

Structure which serve as an interface for requested SENSOR device

Examples:
sensor_test/artik_sensor_test.c.

Definition at line 194 of file artik_sensor.h.

Field Documentation

artik_error(* artik_sensor_gyro::get_pitch) (artik_sensor_handle handle, int *store)
Parameters
[in]handlehandle tied to the requested GYROMETER communication module instance to be released. This handle is returned by the 'get_gyro_sensor' function.
[in]storepermit 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 257 of file artik_sensor.h.

artik_error(* artik_sensor_gyro::get_roll) (artik_sensor_handle handle, int *store)
Parameters
[in]handlehandle tied to the requested GYROMETER communication module instance to be released. This handle is returned by the 'get_gyro_sensor' function.
[in]storepermit 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 243 of file artik_sensor.h.

artik_error(* artik_sensor_gyro::get_yaw) (artik_sensor_handle handle, int *store)
Parameters
[in]handlehandle tied to the requested GYROMETER communication module instance to be released. This handle is returned by the 'get_gyro_sensor' function.
[in]storepermit 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 229 of file artik_sensor.h.

artik_error(* artik_sensor_gyro::release) (artik_sensor_handle handle)
Parameters
[in]handlehandle tied to the requested GYROMETER instance to be released. This handle is returned by the 'request' function.
Returns
S_OK on success, error code otherwise

Definition at line 216 of file artik_sensor.h.

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

Definition at line 205 of file artik_sensor.h.

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