1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ANDROID_SENSORS_PORT_H_
#define ANDROID_SENSORS_PORT_H_
/*
* Encapsulates exchange protocol between the sensor emulator, and an application
* running on an Android device that provides sensor values, and is connected to
* the host via USB.
*/
#include "android/android-device.h"
/* Declares sensors port descriptor. */
typedef struct AndroidSensorsPort AndroidSensorsPort;
/* Creates sensors port, and connects it to the device.
* Param:
* opaque - An opaque pointer that is passed back to the callback routines.
* Return:
* Initialized device descriptor on success, or NULL on failure. If failure is
* returned from this routine, 'errno' indicates the reason for failure. If this
* routine successeds, a connection is established with the sensor reading
* application on the device.
*/
extern AndroidSensorsPort* sensors_port_create(void* opaque);
/* Disconnects from the sensors port, and destroys the descriptor. */
extern void sensors_port_destroy(AndroidSensorsPort* asp);
/* Initializes sensors on the connected device. */
extern int sensors_port_init_sensors(AndroidSensorsPort* asp);
/* Checks if port is connected to a sensor reading application on the device.
* Note that connection can go out and then be restored at any time after
* sensors_port_create API succeeded.
*/
extern int sensors_port_is_connected(AndroidSensorsPort* asp);
/* Enables events from a particular sensor.
* Param:
* asp - Android sensors port instance returned from sensors_port_create.
* name - Name of the sensor to enable events on. If this parameter is "all",
* then events on all sensors will be enabled.
* Return:
* Zero on success, failure otherwise.
*/
extern int sensors_port_enable_sensor(AndroidSensorsPort* asp, const char* name);
/* Disables events from a particular sensor.
* Param:
* asp - Android sensors port instance returned from sensors_port_create.
* name - Name of the sensor to disable events on. If this parameter is "all",
* then events on all sensors will be disable.
* Return:
* Zero on success, failure otherwise.
*/
extern int sensors_port_disable_sensor(AndroidSensorsPort* asp, const char* name);
/* Queries the connected application to start delivering sensor events.
* Param:
* asp - Android sensors port instance returned from sensors_port_create.
* Return:
* Zero on success, failure otherwise.
*/
extern int sensors_port_start(AndroidSensorsPort* asp);
/* Queries the connected application to stop delivering sensor events.
* Param:
* asp - Android sensors port instance returned from sensors_port_create.
* Return:
* Zero on success, failure otherwise.
*/
extern int sensors_port_stop(AndroidSensorsPort* asp);
#endif /* ANDROID_SENSORS_PORT_H_ */
|
