#include <ubuntu/status.h>
#include <ubuntu/visibility.h>
#include <ubuntu/application/sensors/event/magnetic.h>
Go to the source code of this file.
Typedefs | |
typedef void | UASensorsMagnetic |
Opaque type that models the Magnetic field. More... | |
typedef void(* | on_magnetic_event_cb) (UASMagneticEvent *event, void *context) |
Callback type used by applications to subscribe to magnetic sensor events. More... | |
Functions | |
UBUNTU_DLL_PUBLIC UASensorsMagnetic * | ua_sensors_magnetic_new () |
Create a new object for accessing the magnetic field sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_enable (UASensorsMagnetic *sensor) |
Enables the supplied magnetic field sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_disable (UASensorsMagnetic *sensor) |
Disables the supplied magnetic field sensor. More... | |
UBUNTU_DLL_PUBLIC uint32_t | ua_sensors_magnetic_get_min_delay (UASensorsMagnetic *sensor) |
Queries the minimum delay between two readings for the supplied sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_get_min_value (UASensorsMagnetic *sensor, float *value) |
Queries the minimum value that can be reported by the sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_get_max_value (UASensorsMagnetic *sensor, float *value) |
Queries the maximum value that can be reported by the sensor. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_get_resolution (UASensorsMagnetic *sensor, float *value) |
Queries the numeric resolution supported by the sensor. More... | |
UBUNTU_DLL_PUBLIC void | ua_sensors_magnetic_set_reading_cb (UASensorsMagnetic *sensor, on_magnetic_event_cb cb, void *ctx) |
Set the callback to be invoked whenever a new sensor reading is available. More... | |
UBUNTU_DLL_PUBLIC UStatus | ua_sensors_magnetic_set_event_rate (UASensorsMagnetic *sensor, uint32_t rate) |
Set the sensor event delivery rate in nanoseconds.. More... | |
typedef void(* on_magnetic_event_cb) (UASMagneticEvent *event, void *context) |
Callback type used by applications to subscribe to magnetic sensor events.
Definition at line 39 of file magnetic.h.
typedef void UASensorsMagnetic |
Opaque type that models the Magnetic field.
Definition at line 33 of file magnetic.h.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_disable | ( | UASensorsMagnetic * | sensor | ) |
Disables the supplied magnetic field sensor.
[in] | sensor | The sensor instance to be disabled. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_enable | ( | UASensorsMagnetic * | sensor | ) |
Enables the supplied magnetic field sensor.
[in] | sensor | The sensor instance to be enabled. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_get_max_value | ( | UASensorsMagnetic * | sensor, |
float * | value | ||
) |
Queries the maximum value that can be reported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC uint32_t ua_sensors_magnetic_get_min_delay | ( | UASensorsMagnetic * | sensor | ) |
Queries the minimum delay between two readings for the supplied sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_get_min_value | ( | UASensorsMagnetic * | sensor, |
float * | value | ||
) |
Queries the minimum value that can be reported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_get_resolution | ( | UASensorsMagnetic * | sensor, |
float * | value | ||
) |
Queries the numeric resolution supported by the sensor.
[in] | sensor | The sensor instance to be queried. |
UBUNTU_DLL_PUBLIC UASensorsMagnetic* ua_sensors_magnetic_new | ( | ) |
Create a new object for accessing the magnetic field sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_magnetic_set_event_rate | ( | UASensorsMagnetic * | sensor, |
uint32_t | rate | ||
) |
Set the sensor event delivery rate in nanoseconds..
[in] | sensor | The sensor instance to be modified. |
[in] | rate | The new event delivery rate. |
UBUNTU_DLL_PUBLIC void ua_sensors_magnetic_set_reading_cb | ( | UASensorsMagnetic * | sensor, |
on_magnetic_event_cb | cb, | ||
void * | ctx | ||
) |
Set the callback to be invoked whenever a new sensor reading is available.
[in] | sensor | The sensor instance to associate the callback with. |
[in] | cb | The callback to be invoked. |
[in] | ctx | The context supplied to the callback invocation. |