Ubuntu Platform API 3.0.0
A library helping with tight integration into the Ubuntu platform
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
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
35 typedef void UASensorsLight;
36
41 typedef void (*on_light_event_cb)(UASLightEvent* event,
42 void* context);
43
51
60 UASensorsLight* sensor);
61
70 UASensorsLight* sensor);
71
78 UBUNTU_DLL_PUBLIC uint32_t
80 UASensorsLight* sensor);
81
90 UASensorsLight* sensor,
91 float* value);
92
101 UASensorsLight* sensor,
102 float* value);
103
112 UASensorsLight* sensor,
113 float* value);
114
124 UASensorsLight* sensor,
126 void *ctx);
127
137 UASensorsLight* sensor,
138 uint32_t rate);
139
140#ifdef __cplusplus
141}
142#endif
143
144#endif /* UBUNTU_APPLICATION_SENSORS_LIGHT_H_ */
void UASLightEvent
Opaque type describing an ambient light sensor reading.
Definition: light.h:34
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_get_resolution(UASensorsLight *sensor, float *value)
Queries the numeric resolution supported by the sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_set_event_rate(UASensorsLight *sensor, uint32_t rate)
Set the sensor event delivery rate in nanoseconds..
void UASensorsLight
Opaque type that models the ambient light sensor.
Definition: light.h:35
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_disable(UASensorsLight *sensor)
Disables the supplied ambient light sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_enable(UASensorsLight *sensor)
Enables the supplied ambient light sensor.
UBUNTU_DLL_PUBLIC UASensorsLight * ua_sensors_light_new()
Create a new object for accessing the ambient light sensor.
UBUNTU_DLL_PUBLIC uint32_t ua_sensors_light_get_min_delay(UASensorsLight *sensor)
Queries the minimum delay between two readings for the supplied sensor.
UBUNTU_DLL_PUBLIC void ua_sensors_light_set_reading_cb(UASensorsLight *sensor, on_light_event_cb cb, void *ctx)
Set the callback to be invoked whenever a new sensor reading is available.
void(* on_light_event_cb)(UASLightEvent *event, void *context)
Callback type used by applications to subscribe to ambient light sensor events.
Definition: light.h:41
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_get_min_value(UASensorsLight *sensor, float *value)
Queries the minimum value that can be reported by the sensor.
UBUNTU_DLL_PUBLIC UStatus ua_sensors_light_get_max_value(UASensorsLight *sensor, float *value)
Queries the maximum value that can be reported by the sensor.
UbuntuStatus
Indicates the status of an operation.
Definition: status.h:27
#define UBUNTU_DLL_PUBLIC
Definition: visibility.h:26