Ubuntu Platform API  1.0.0
A library helping with tight integration into the Ubuntu platform
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
light.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_LIGHT_H_
20 #define UBUNTU_APPLICATION_SENSORS_LIGHT_H_
21 
22 #include <ubuntu/status.h>
23 #include <ubuntu/visibility.h>
24 
25 #include <ubuntu/application/sensors/event/light.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
35  typedef void UASensorsLight;
36 
41  typedef void (*on_light_event_cb)(UASLightEvent* event,
42  void* context);
43 
49  UBUNTU_DLL_PUBLIC UASensorsLight*
50  ua_sensors_light_new();
51 
58  UBUNTU_DLL_PUBLIC UStatus
59  ua_sensors_light_enable(
60  UASensorsLight* sensor);
61 
68  UBUNTU_DLL_PUBLIC UStatus
69  ua_sensors_light_disable(
70  UASensorsLight* sensor);
71 
78  UBUNTU_DLL_PUBLIC uint32_t
79  ua_sensors_light_get_min_delay(
80  UASensorsLight* sensor);
81 
88  UBUNTU_DLL_PUBLIC float
89  ua_sensors_light_get_min_value(
90  UASensorsLight* sensor);
91 
98  UBUNTU_DLL_PUBLIC float
99  ua_sensors_light_get_max_value(
100  UASensorsLight* sensor);
101 
108  UBUNTU_DLL_PUBLIC float
109  ua_sensors_light_get_resolution(
110  UASensorsLight* sensor);
111 
119  UBUNTU_DLL_PUBLIC void
120  ua_sensors_light_set_reading_cb(
121  UASensorsLight* sensor,
122  on_light_event_cb cb,
123  void *ctx);
124 
125 #ifdef __cplusplus
126 }
127 #endif
128 
129 #endif /* UBUNTU_APPLICATION_SENSORS_LIGHT_H_ */