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
|
/**
* 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.direct_bt;
import java.util.Iterator;
import java.util.List;
/**
* Provides access to Bluetooth GATT characteristic. Follows the BlueZ adapter API
* available at: http://git.kernel.org/cgit/bluetooth/bluez.git/tree/doc/gatt-api.txt
*/
public interface BTGattService extends BTObject
{
@Override
public BTGattService clone();
/** Find a BluetoothGattCharacteristic. If parameter UUID is not null,
* the returned object will have to match it.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter UUID optionally specify the UUID of the BluetoothGattCharacteristic 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 UUID or null if not found before
* timeout expires or event is canceled.
*/
public BTGattChar find(String UUID, long timeoutMS);
/** Find a BluetoothGattCharacteristic. If parameter UUID is not null,
* the returned object will have to match it.
* It will first check for existing objects. It will not turn on discovery
* or connect to devices.
* @parameter UUID optionally specify the UUID of the BluetoothGattDescriptor you are
* waiting for
* @return An object matching the UUID or null if not found before
* timeout expires or event is canceled.
*/
public BTGattChar find(String UUID);
/* D-Bus property accessors: */
/** Get the UUID of this service
* @return The 128 byte UUID of this service, NULL if an error occurred
*/
public String getUUID();
/** Returns the device to which this service belongs to.
* @return The device.
*/
public BTDevice getDevice();
/** Returns true if this service is a primary service, false if secondary.
* @return true if this service is a primary service, false if secondary.
*/
public boolean getPrimary();
/** Returns a list of BTGattChar this service exposes.
* @return A list of BTGattChar exposed by this service
*/
public List<BTGattChar> getChars();
/**
* Adds the given {@link BTGattCharListener} to the {@link BTDevice}
* and {@link BTGattChar#enableNotificationOrIndication(boolean[])} for all {@link BTGattChar} instances.
* @param listener {@link BTGattCharListener} to add to the {@link BTDevice}.
* It is important to have hte listener's {@link BTGattCharListener#getAssociatedChar() associated characteristic} == null,
* otherwise the listener can't be used for all characteristics.
* @return true if successful, otherwise false
* @throws IllegalArgumentException if listener's {@link BTGattCharListener#getAssociatedChar() associated characteristic}
* is not null.
* @since 2.0.0
* @implNote not implemented in tinyb.dbus
* @see BTGattChar#enableNotificationOrIndication(boolean[])
* @see BTDevice#addCharacteristicListener(BTGattCharListener, BTGattChar)
*/
public static boolean addCharListenerToAll(final BTDevice device, final List<BTGattService> services,
final BTGattCharListener listener) {
if( null == listener ) {
throw new IllegalArgumentException("listener argument null");
}
if( null != listener.getAssociatedChar() ) {
throw new IllegalArgumentException("listener's associated characteristic is not null");
}
final boolean res = device.addCharListener(listener);
for(final Iterator<BTGattService> is = services.iterator(); is.hasNext(); ) {
final BTGattService s = is.next();
final List<BTGattChar> characteristics = s.getChars();
for(final Iterator<BTGattChar> ic = characteristics.iterator(); ic.hasNext(); ) {
ic.next().enableNotificationOrIndication(new boolean[2]);
}
}
return res;
}
/**
* Removes the given {@link BTGattCharListener} from the {@link BTDevice}.
* @param listener {@link BTGattCharListener} to remove from the {@link BTDevice}.
* @return true if successful, otherwise false
* @since 2.0.0
* @implNote not implemented in tinyb.dbus
* @see BTGattChar#configNotificationIndication(boolean, boolean, boolean[])
* @see BTDevice#removeCharacteristicListener(BTGattCharListener)
*/
public static boolean removeCharListenerFromAll(final BTDevice device, final List<BTGattService> services,
final BTGattCharListener listener) {
for(final Iterator<BTGattService> is = services.iterator(); is.hasNext(); ) {
final BTGattService s = is.next();
final List<BTGattChar> characteristics = s.getChars();
for(final Iterator<BTGattChar> ic = characteristics.iterator(); ic.hasNext(); ) {
ic.next().configNotificationIndication(false /* enableNotification */, false /* enableIndication */, new boolean[2]);
}
}
return device.removeCharListener(listener);
}
/**
* Removes all {@link BTGattCharListener} from the {@link BTDevice}.
* @return count of removed {@link BTGattCharListener}
* @since 2.0.0
* @implNote not implemented in tinyb.dbus
* @see BTGattChar#configNotificationIndication(boolean, boolean, boolean[])
* @see BTDevice#removeAllCharacteristicListener()
*/
public static int removeAllCharListener(final BTDevice device, final List<BTGattService> services) {
for(final Iterator<BTGattService> is = services.iterator(); is.hasNext(); ) {
final BTGattService s = is.next();
final List<BTGattChar> characteristics = s.getChars();
for(final Iterator<BTGattChar> ic = characteristics.iterator(); ic.hasNext(); ) {
ic.next().configNotificationIndication(false /* enableNotification */, false /* enableIndication */, new boolean[2]);
}
}
return device.removeAllCharListener();
}
}
|
