Ubuntu Platform API
3.0.0
A library helping with tight integration into the Ubuntu platform
|
|
Go to the documentation of this file.
19 #ifndef UBUNTU_APPLICATION_SENSORS_PROXIMITY_H_
20 #define UBUNTU_APPLICATION_SENSORS_PROXIMITY_H_
void UASensorsProximity
Opaque type that models the proximity sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_get_max_value(UASensorsProximity *sensor, float *value)
Queries the maximum value that can be reported by the sensor.
UBUNTU_DLL_PUBLIC uint32_t ua_sensors_proximity_get_min_delay(UASensorsProximity *sensor)
Queries the minimum delay between two readings for the supplied sensor.
UBUNTU_DLL_PUBLIC void ua_sensors_proximity_set_reading_cb(UASensorsProximity *sensor, on_proximity_event_cb cb, void *ctx)
Set the callback to be invoked whenever a new sensor reading is available.
UbuntuStatus
Indicates the status of an operation.
#define UBUNTU_DLL_PUBLIC
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_enable(UASensorsProximity *sensor)
Enables the supplied proximity sensor.
void UASProximityEvent
Opaque type describing an accelerometer reading.
void(* on_proximity_event_cb)(UASProximityEvent *event, void *context)
Callback type used by applications to subscribe to proximity sensor events.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_set_event_rate(UASensorsProximity *sensor, uint32_t rate)
Set the sensor event delivery rate in nanoseconds..
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_get_resolution(UASensorsProximity *sensor, float *value)
Queries the numeric resolution supported by the sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_get_min_value(UASensorsProximity *sensor, float *value)
Queries the minimum value that can be reported by the sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_disable(UASensorsProximity *sensor)
Disables the supplied proximity sensor.
UBUNTU_DLL_PUBLIC UASensorsProximity * ua_sensors_proximity_new()
Create a new object for accessing the proximity sensor.