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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
/**
* Author: Sven Gothel <sgothel@jausoft.com>
* Copyright (c) 2020 Gothel Software e.K.
* Copyright (c) 2020 ZAFENA AB
*
* Author: Andrei Vasiliu <andrei.vasiliu@intel.com>
* Copyright (c) 2016 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.tinyb;
import java.util.List;
public interface BluetoothManager
{
/** Find a BluetoothObject of a type matching type. If parameters name,
* identifier and parent are not null, the returned object will have to
* match them.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter type specify the type of the object you are
* waiting for, NONE means anything.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @parameter timeoutMS the function will return after timeout time in milliseconds, a
* value of zero means wait forever. If object is not found during this time null will be returned.
* @return An object matching the name, identifier, parent or null if not found before
* timeout expires or event is canceled.
*/
public BluetoothObject find(BluetoothType type, String name, String identifier, BluetoothObject parent, long timeoutMS);
/** Find a BluetoothObject of a type matching type. If parameters name,
* identifier and parent are not null, the returned object will have to
* match them.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter type specify the type of the object you are
* waiting for, NONE means anything.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @return An object matching the name, identifier and parent.
*/
public BluetoothObject find(BluetoothType type, String name, String identifier, BluetoothObject parent);
/** Find a BluetoothObject of type T. If parameters name, identifier and
* parent are not null, the returned object will have to match them.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @parameter timeoutMS the function will return after timeout time in milliseconds, a
* value of zero means wait forever. If object is not found during this time null will be returned.
* @return An object matching the name, identifier, parent or null if not found before
* timeout expires or event is canceled.
*/
public <T extends BluetoothObject> T find(String name, String identifier, BluetoothObject parent, long timeoutMS);
/** Find a BluetoothObject of type T. If parameters name, identifier and
* parent are not null, the returned object will have to match them.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @return An object matching the name, identifier and parent.
*/
public <T extends BluetoothObject> T find(String name, String identifier, BluetoothObject parent);
/** Return a BluetoothObject of a type matching type. If parameters name,
* identifier and parent are not null, the returned object will have to
* match them. Only objects which are already in the system will be returned.
* @parameter type specify the type of the object you are
* waiting for, NONE means anything.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @return An object matching the name, identifier, parent or null if not found.
*/
public BluetoothObject getObject(BluetoothType type, String name,
String identifier, BluetoothObject parent);
/** Return a List of BluetoothObject of a type matching type. If parameters name,
* identifier and parent are not null, the returned object will have to
* match them. Only objects which are already in the system will be returned.
* @parameter type specify the type of the object you are
* waiting for, NONE means anything.
* @parameter name optionally specify the name of the object you are
* waiting for (for Adapter or Device)
* @parameter identifier optionally specify the identifier of the object you are
* waiting for (UUID for GattService, GattCharacteristic or GattDescriptor, address
* for Adapter or Device)
* @parameter parent optionally specify the parent of the object you are
* waiting for
* @return A vector of object matching the name, identifier, parent.
*/
public List<BluetoothObject> getObjects(BluetoothType type, String name,
String identifier, BluetoothObject parent);
/** Returns a list of BluetoothAdapters available in the system
* @return A list of BluetoothAdapters available in the system
*/
public List<BluetoothAdapter> getAdapters();
/** Returns a list of discovered BluetoothDevices
* @return A list of discovered BluetoothDevices
*/
public List<BluetoothDevice> getDevices();
/** Returns a list of available BluetoothGattServices
* @return A list of available BluetoothGattServices
*/
public List<BluetoothGattService> getServices();
/** Sets a default adapter to use for discovery.
* @return TRUE if the device was set
*/
public boolean setDefaultAdapter(BluetoothAdapter adapter);
/** Gets the default adapter to use for discovery.
* <p>
* System default is the last detected adapter at initialisation.
* </p>
* @return the used default adapter
*/
public BluetoothAdapter getDefaultAdapter();
/** Turns on device discovery on the default adapter if it is disabled.
* @return TRUE if discovery was successfully enabled
*/
public boolean startDiscovery() throws BluetoothException;
/** Turns off device discovery on the default adapter if it is enabled.
* @return TRUE if discovery was successfully disabled
*/
public boolean stopDiscovery() throws BluetoothException;
/** Returns if the discovers is running or not.
* @return TRUE if discovery is running
*/
public boolean getDiscovering() throws BluetoothException;
/**
* Release the native memory associated with this object and all related Bluetooth resources.
* The object should not be used following a call to close
* <p>
* Shutdown method is intended to allow a clean Bluetooth state at program exist.
* </p>
*/
public void shutdown();
}
|
