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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
// Copyright (c) 2017 Akos Kiss.
//
// Licensed under the BSD 3-Clause License
// <LICENSE.md or https://opensource.org/licenses/BSD-3-Clause>.
// This file may not be copied, modified, or distributed except
// according to those terms.
use std::error::Error;
use std::os::raw::c_uint;
use std::slice;
use std::sync::Arc;
use delegate::bmx;
use framework::{cb, nil, ns};
use gatt_service::BluetoothGATTService;
use objc::runtime::{NO, Object, YES};
use utils::{NO_CHARACTERISTIC_FOUND, NOT_SUPPORTED_ERROR, cbx, wait};
#[derive(Clone, Debug)]
pub struct BluetoothGATTCharacteristic {
pub(crate) service: Arc<BluetoothGATTService>,
pub(crate) characteristic: *mut Object,
}
// TODO: implement std::fmt::Debug and/or std::fmt::Display instead of derive?
impl BluetoothGATTCharacteristic {
pub fn new(service: Arc<BluetoothGATTService>, uuid: String) -> BluetoothGATTCharacteristic {
// NOTE: It can happen that there is no characteristic for the given UUID, in that case
// self.characteristic will be nil and all methods that return a Result will return
// Err(Box::from(NO_CHARACTERISTIC_FOUND)), while others will return some meaningless value.
let characteristic = Self::characteristic_by_uuid(service.service, &uuid);
if characteristic == nil {
warn!(
"BluetoothGATTCharacteristic::new found no characteristic for UUID {}",
uuid
);
}
BluetoothGATTCharacteristic {
service: service.clone(),
characteristic,
}
}
fn characteristic_by_uuid(service: *mut Object, uuid: &String) -> *mut Object {
if service != nil {
let chars = cb::service_characteristics(service);
for i in 0..ns::array_count(chars) {
let c = ns::array_objectatindex(chars, i);
if cbx::uuid_to_canonical_uuid_string(cb::attribute_uuid(c)) == *uuid {
return c;
}
}
}
nil
}
pub fn get_id(&self) -> String {
trace!("BluetoothGATTCharacteristic::get_id");
self.get_uuid().unwrap_or_default()
}
pub fn get_uuid(&self) -> Result<String, Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::get_uuid");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let uuid_string =
cbx::uuid_to_canonical_uuid_string(cb::attribute_uuid(self.characteristic));
debug!("BluetoothGATTCharacteristic::get_uuid -> {}", uuid_string);
Ok(uuid_string)
}
pub fn get_value(&self) -> Result<Vec<u8>, Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::get_value");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let value = cb::characteristic_value(self.characteristic);
let length = ns::data_length(value);
if length == 0 {
return Ok(vec![]);
}
let bytes = ns::data_bytes(value);
let v = unsafe { slice::from_raw_parts(bytes, length as usize).to_vec() };
debug!("BluetoothGATTCharacteristic::get_value -> {:?}", v);
Ok(v)
}
pub fn read_value(&self) -> Result<Vec<u8>, Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::read_value");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let events = bmx::peripheralevents(
self.service.device.adapter.delegate,
self.service.device.peripheral,
)?;
let key = bmx::valueupdatedkey(self.characteristic);
let t = wait::get_timestamp();
cb::peripheral_readvalueforcharacteristic(
self.service.device.peripheral,
self.characteristic,
);
wait::wait_or_timeout(|| {
let nsnumber = ns::dictionary_objectforkey(events, key);
(nsnumber != nil) && (ns::number_unsignedlonglongvalue(nsnumber) >= t)
})?;
self.get_value()
}
pub fn write_value(&self, values: Vec<u8>) -> Result<(), Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::write_value");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let events = bmx::peripheralevents(
self.service.device.adapter.delegate,
self.service.device.peripheral,
)?;
let key = bmx::valuewrittenkey(self.characteristic);
let t = wait::get_timestamp();
cb::peripheral_writevalue_forcharacteristic(
self.service.device.peripheral,
ns::data(values.as_ptr(), values.len() as c_uint),
self.characteristic,
);
wait::wait_or_timeout(|| {
let nsnumber = ns::dictionary_objectforkey(events, key);
(nsnumber != nil) && (ns::number_unsignedlonglongvalue(nsnumber) >= t)
})?;
Ok(())
}
pub fn is_notifying(&self) -> Result<bool, Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::is_notifying");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let notifying = cb::characteristic_isnotifying(self.characteristic);
debug!("BluetoothGATTCharacteristic::is_notifying -> {}", notifying);
Ok(notifying != NO)
}
pub fn start_notify(&self) -> Result<(), Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::start_notify");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
cb::peripheral_setnotifyvalue_forcharacteristic(
self.service.device.peripheral,
YES,
self.characteristic,
);
Ok(())
}
pub fn stop_notify(&self) -> Result<(), Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::stop_notify");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
cb::peripheral_setnotifyvalue_forcharacteristic(
self.service.device.peripheral,
NO,
self.characteristic,
);
Ok(())
}
pub fn get_gatt_descriptors(&self) -> Result<Vec<String>, Box<dyn Error>> {
warn!("BluetoothGATTCharacteristic::get_gatt_descriptors");
Err(Box::from(NOT_SUPPORTED_ERROR))
}
pub fn get_flags(&self) -> Result<Vec<String>, Box<dyn Error>> {
trace!("BluetoothGATTCharacteristic::get_flags");
if self.characteristic == nil {
return Err(Box::from(NO_CHARACTERISTIC_FOUND));
}
let flags = cb::characteristic_properties(self.characteristic);
// NOTE: It is not documented anywhere what strings to return. Strings below were
// reverse-engineered from the sources of blurdroid.
let mut v = vec![];
if (flags & cb::CHARACTERISTICPROPERTY_BROADCAST) != 0 {
v.push(String::from("broadcast"));
}
if (flags & cb::CHARACTERISTICPROPERTY_READ) != 0 {
v.push(String::from("read"));
}
if (flags & cb::CHARACTERISTICPROPERTY_WRITEWITHOUTRESPONSE) != 0 {
v.push(String::from("write-without-response"));
}
if (flags & cb::CHARACTERISTICPROPERTY_WRITE) != 0 {
v.push(String::from("write"));
}
if (flags & cb::CHARACTERISTICPROPERTY_NOTIFY) != 0 {
v.push(String::from("notify"));
}
if (flags & cb::CHARACTERISTICPROPERTY_INDICATE) != 0 {
v.push(String::from("indicate"));
}
if (flags & cb::CHARACTERISTICPROPERTY_AUTHENTICATEDSIGNEDWRITES) != 0 {
v.push(String::from("authenticated-signed-writes"));
}
debug!("BluetoothGATTCharacteristic::get_flags -> {:?}", v);
Ok(v)
}
}
|
