Ubuntu Platform API  2.5.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
proximity.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Ricardo Mendoza <ricardo.mendoza@canonical.com>
17  */
18 
19 #ifndef UBUNTU_APPLICATION_SENSORS_PROXIMITY_H_
20 #define UBUNTU_APPLICATION_SENSORS_PROXIMITY_H_
21 
22 #include <ubuntu/status.h>
23 #include <ubuntu/visibility.h>
24 
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
35  typedef void UASensorsProximity;
36 
41  typedef void (*on_proximity_event_cb)(UASProximityEvent* event,
42  void* context);
43 
49  UBUNTU_DLL_PUBLIC UASensorsProximity*
51 
60  UASensorsProximity* sensor);
61 
70  UASensorsProximity* sensor);
71 
78  UBUNTU_DLL_PUBLIC uint32_t
80  UASensorsProximity* sensor);
81 
90  UASensorsProximity* sensor,
91  float* value);
92 
101  UASensorsProximity* sensor,
102  float* value);
103 
112  UASensorsProximity* sensor,
113  float* value);
114 
122  UBUNTU_DLL_PUBLIC void
124  UASensorsProximity* sensor,
126  void *ctx);
127 
137  UASensorsProximity* sensor,
138  uint32_t rate);
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif /* UBUNTU_APPLICATION_SENSORS_PROXIMITY_H_ */
void UASProximityEvent
Opaque type describing an accelerometer reading.
Definition: proximity.h:45
UbuntuStatus
Indicates the status of an operation.
Definition: status.h:26
UBUNTU_DLL_PUBLIC UASensorsProximity * ua_sensors_proximity_new()
Create a new object for accessing the proximity sensor.
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_set_event_rate(UASensorsProximity *sensor, uint32_t rate)
Set the sensor event delivery rate in nanoseconds..
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.
void(* on_proximity_event_cb)(UASProximityEvent *event, void *context)
Callback type used by applications to subscribe to proximity sensor events.
Definition: proximity.h:41
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_enable(UASensorsProximity *sensor)
Enables the supplied proximity sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_proximity_disable(UASensorsProximity *sensor)
Disables the supplied proximity 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.
void UASensorsProximity
Opaque type that models the proximity sensor.
Definition: proximity.h:35
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.
UBUNTU_DLL_PUBLIC uint32_t ua_sensors_proximity_get_min_delay(UASensorsProximity *sensor)
Queries the minimum delay between two readings for the supplied sensor.