-
Notifications
You must be signed in to change notification settings - Fork 232
/
Copy pathHAPBLECharacteristicReadAndSerializeValue.c
343 lines (328 loc) · 15.8 KB
/
HAPBLECharacteristicReadAndSerializeValue.c
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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
// Copyright (c) 2015-2019 The HomeKit ADK Contributors
//
// Licensed under the Apache License, Version 2.0 (the “License”);
// you may not use this file except in compliance with the License.
// See [CONTRIBUTORS.md] for the list of HomeKit ADK project authors.
#include "HAP+Internal.h"
static const HAPLogObject logObject = { .subsystem = kHAP_LogSubsystem, .category = "BLECharacteristic" };
/**
* Serializes Char Value field of HAP-Characteristic-Read-Response.
*
* @param valueBytes Characteristic value.
* @param numValueBytes Length of characteristic value.
* @param responseWriter TLV writer.
*
* @return kHAPError_None If successful.
* @return kHAPError_OutOfResources If writer does not have enough capacity.
*
* @see HomeKit Accessory Protocol Specification R14
* Section 7.3.4.7 HAP-Characteristic-Read-Response
*/
HAP_RESULT_USE_CHECK
static HAPError SerializeCharValue(const void* valueBytes, size_t numValueBytes, HAPTLVWriterRef* responseWriter) {
HAPPrecondition(valueBytes);
HAPPrecondition(responseWriter);
// The maximum length of an HAP characteristic value shall be 64000 bytes.
// See HomeKit Accessory Protocol Specification R14
// Section 7.4.1.7 Maximum Payload Size
HAPPrecondition(numValueBytes <= 64000);
HAPError err;
err = HAPTLVWriterAppend(
responseWriter,
&(const HAPTLV) { .type = kHAPBLEPDUTLVType_Value,
.value = { .bytes = valueBytes, .numBytes = numValueBytes } });
if (err) {
HAPAssert(err == kHAPError_OutOfResources);
return err;
}
return kHAPError_None;
}
HAP_RESULT_USE_CHECK
HAPError HAPBLECharacteristicReadAndSerializeValue(
HAPAccessoryServerRef* server_,
HAPSessionRef* session,
const HAPCharacteristic* characteristic,
const HAPService* service,
const HAPAccessory* accessory,
HAPTLVWriterRef* responseWriter) {
HAPPrecondition(server_);
HAPAccessoryServer* server = (HAPAccessoryServer*) server_;
HAPPrecondition(session);
HAPPrecondition(characteristic);
HAPPrecondition(service);
HAPPrecondition(accessory);
HAPPrecondition(responseWriter);
HAPError err;
void* bytes;
size_t maxBytes;
HAPTLVWriterGetScratchBytes(responseWriter, &bytes, &maxBytes);
// Fetch characteristic value.
size_t numBytes;
switch (*((const HAPCharacteristicFormat*) characteristic)) {
case kHAPCharacteristicFormat_Data: {
// The maximum length of an HAP characteristic value shall be 64000 bytes.
// See HomeKit Accessory Protocol Specification R14
// Section 7.4.1.7 Maximum Payload Size
err = HAPDataCharacteristicHandleRead(
server_,
&(const HAPDataCharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
bytes,
maxBytes <= 64000 ? maxBytes : 64000,
&numBytes,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
}
goto serialized;
case kHAPCharacteristicFormat_Bool: {
if (maxBytes < sizeof(bool)) {
HAPLog(&logObject, "Not enough space to read %s value.", "Bool");
return kHAPError_OutOfResources;
}
bool characteristicValue;
err = HAPBoolCharacteristicHandleRead(
server_,
&(const HAPBoolCharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
b[0] = (uint8_t)(characteristicValue ? 1 : 0);
numBytes = sizeof(bool);
}
goto serialized;
case kHAPCharacteristicFormat_UInt8: {
if (maxBytes < sizeof(uint8_t)) {
HAPLog(&logObject, "Not enough space to read %s value.", "UInt8");
return kHAPError_OutOfResources;
}
uint8_t characteristicValue;
err = HAPUInt8CharacteristicHandleRead(
server_,
&(const HAPUInt8CharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
b[0] = characteristicValue;
numBytes = sizeof(uint8_t);
}
goto serialized;
case kHAPCharacteristicFormat_UInt16: {
if (maxBytes < sizeof(uint16_t)) {
HAPLog(&logObject, "Not enough space to read %s value.", "UInt16");
return kHAPError_OutOfResources;
}
uint16_t characteristicValue;
err = HAPUInt16CharacteristicHandleRead(
server_,
&(const HAPUInt16CharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
HAPWriteLittleUInt16(b, characteristicValue);
numBytes = sizeof(uint16_t);
}
goto serialized;
case kHAPCharacteristicFormat_UInt32: {
if (maxBytes < sizeof(uint32_t)) {
HAPLog(&logObject, "Not enough space to read %s value.", "UInt32");
return kHAPError_OutOfResources;
}
uint32_t characteristicValue;
err = HAPUInt32CharacteristicHandleRead(
server_,
&(const HAPUInt32CharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
HAPWriteLittleUInt32(b, characteristicValue);
numBytes = sizeof(uint32_t);
}
goto serialized;
case kHAPCharacteristicFormat_UInt64: {
if (maxBytes < sizeof(uint64_t)) {
HAPLog(&logObject, "Not enough space to read %s value.", "UInt64");
return kHAPError_OutOfResources;
}
uint64_t characteristicValue;
err = HAPUInt64CharacteristicHandleRead(
server_,
&(const HAPUInt64CharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
HAPWriteLittleUInt64(b, characteristicValue);
numBytes = sizeof(uint64_t);
}
goto serialized;
case kHAPCharacteristicFormat_Int: {
if (maxBytes < sizeof(int32_t)) {
HAPLog(&logObject, "Not enough space to read %s value.", "Int32");
return kHAPError_OutOfResources;
}
int32_t characteristicValue;
err = HAPIntCharacteristicHandleRead(
server_,
&(const HAPIntCharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint8_t* b = bytes;
HAPWriteLittleInt32(b, characteristicValue);
numBytes = sizeof(int32_t);
}
goto serialized;
case kHAPCharacteristicFormat_Float: {
if (maxBytes < sizeof(float)) {
HAPLog(&logObject, "Not enough space to read %s value.", "Float");
return kHAPError_OutOfResources;
}
float characteristicValue;
err = HAPFloatCharacteristicHandleRead(
server_,
&(const HAPFloatCharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
&characteristicValue,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
uint32_t bitPattern = HAPFloatGetBitPattern(characteristicValue);
uint8_t* b = bytes;
HAPWriteLittleUInt32(b, bitPattern);
numBytes = sizeof(float);
}
goto serialized;
case kHAPCharacteristicFormat_String: {
// The maximum length of an HAP characteristic value shall be 64000 bytes.
// See HomeKit Accessory Protocol Specification R14
// Section 7.4.1.7 Maximum Payload Size
err = HAPStringCharacteristicHandleRead(
server_,
&(const HAPStringCharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic = characteristic,
.service = service,
.accessory = accessory },
bytes,
maxBytes <= 64000 ? maxBytes : 64000,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
numBytes = HAPStringGetNumBytes(bytes);
}
goto serialized;
case kHAPCharacteristicFormat_TLV8: {
// The maximum length of an HAP characteristic value shall be 64000 bytes.
// See HomeKit Accessory Protocol Specification R14
// Section 7.4.1.7 Maximum Payload Size
HAPTLVWriterRef writer;
HAPTLVWriterCreate(&writer, bytes, maxBytes <= 64000 ? maxBytes : 64000);
err = HAPTLV8CharacteristicHandleRead(
server_,
&(const HAPTLV8CharacteristicReadRequest) { .transportType = kHAPTransportType_BLE,
.session = session,
.characteristic =
(const HAPTLV8Characteristic*) characteristic,
.service = service,
.accessory = accessory },
&writer,
server->context);
if (err) {
HAPAssert(
err == kHAPError_Unknown || err == kHAPError_InvalidState || err == kHAPError_OutOfResources ||
err == kHAPError_Busy);
return err;
}
void* tlvBytes;
HAPTLVWriterGetBuffer(&writer, &tlvBytes, &numBytes);
HAPAssert(tlvBytes == bytes);
}
goto serialized;
}
HAPFatalError();
serialized:
HAPAssert(numBytes <= maxBytes);
err = SerializeCharValue(bytes, numBytes, responseWriter);
if (err) {
HAPAssert(err == kHAPError_OutOfResources);
return err;
}
return kHAPError_None;
}