-
Notifications
You must be signed in to change notification settings - Fork 2
/
ZHA_Devices.cpp
325 lines (305 loc) · 14.3 KB
/
ZHA_Devices.cpp
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
#include "ZHA_Devices.h"
#define DEBUG
ZHA_Device::ZHA_Device(uint8_t endpointId) {
_endpointId = endpointId;
}
void ZHA_Device::addInCluster(ZHA_Cluster *inCluster) {
_inClusters.add(inCluster);
}
void ZHA_Device::addOutCluster(ZHA_Cluster *outCluster) {
_outClusters.add(outCluster);
}
uint8_t ZHA_Device::getNumInClusters() {
return _inClusters.size();
}
uint8_t ZHA_Device::getNumOutClusters() {
return _outClusters.size();
}
ZHA_Cluster *ZHA_Device::getInCluster(uint8_t num) {
return _inClusters.get(num);
}
ZHA_Cluster *ZHA_Device::getOutCluster(uint8_t num) {
return _outClusters.get(num);
}
uint8_t ZHA_Device::getEndpointId() {
return _endpointId;
}
uint16_t ZHA_Device::getDeviceId() {
return _deviceId;
}
ZHA_Cluster *ZHA_Device::getInClusterById(uint16_t clusterId) {
for (uint8_t i = 0; i < _inClusters.size(); i++) {
if (_inClusters.get(i)->getClusterId() == clusterId) {
return _inClusters.get(i);
}
}
return NULL;
}
ZHA_Cluster *ZHA_Device::getOutClusterById(uint16_t clusterId) {
for (uint8_t i = 0; i < _outClusters.size(); i++) {
if (_outClusters.get(i)->getClusterId() == clusterId) {
return _outClusters.get(i);
}
}
return NULL;
}
bool
ZHA_Device::processGeneralCommand(uint8_t *frameData, uint8_t frameDataLength, uint16_t clusterId, uint8_t *payload,
uint8_t &payloadLength) {
/* Command and response ZCL header (not MFR specific)
------------------------------------------
| Bits: 8 | 8 | 8 |
|-----------------------------------------
| Frame Control | Frame ID | Command ID |
------------------------------------------
Response Frame Control Field
-------------------------------------------------------------------------------
| Bits: 3 | 1 | 1 | 1 | 2 |
|-----------------------------------------------------------------------------|
| Reserved | Disable Default Response | Direction | MFR specific | Frame Type |
|-----------------------------------------------------------------------------|
| 000 | 1 | 0/1 | 0 | 00 |
-------------------------------------------------------------------------------
*/
uint8_t frameId = frameData[1];
uint8_t command = frameData[2];
#ifdef DEBUG
String commandStr;
String responseStr;
#endif
ZHA_Cluster *cluster = getInClusterById(clusterId);
if (!cluster) {
return false;
}
if (command == ZCL_READ_ATTRIBUTES) {
/*
Command
-------------------------------------------------------------------------
| Bits: 24 | Bits: 16 | Bits: 16 | ... | Bits: 16 |
|-----------------------------------------------------------------------|
| ZCL Header | Attribute ID 1 | Attribute ID 2 | ... | Attribute ID n |
-------------------------------------------------------------------------
Response payload
---------------------------------------------------------------------------
| Bits: 8 | Variable | Variable | ... | Variable |
|-------------------------------------------------------------------------|
| ZCL Header | Read Attribute | Read Attribute | ... | Read Attribute |
| | Status Record 1 | Status Record 2 | | Status Record n |
---------------------------------------------------------------------------
Read Attribute Status Record
--------------------------------------------------
| Bits: 16 | 1 | 0/1 | 0/Variable |
--------------------------------------------------
| Attribute Id | Status | Data Type | Value |
--------------------------------------------------
*/
#ifdef DEBUG
commandStr += String("Read attributes ");
#endif
payloadLength = 3;
payload[0] = 0b00011000;
payload[1] = frameId;
payload[2] = ZCL_READ_ATTRIBUTES_RESPONSE;
for (uint8_t i = 3; i < frameDataLength; i += 2) {
uint16_t attrId = ((uint16_t) frameData[i + 1] << 8) | frameData[i];
#ifdef DEBUG
commandStr += String(attrId) + String(" ");
#endif
ZHA_Attribute *attr = cluster->getAttrById(attrId);
if (attr == NULL) {
/* attribute is undefined */
#ifdef DEBUG
responseStr += String("Attribute ") + String(attrId) + String(" unsupported\n");
#endif
copyHexL(&payload[payloadLength], attrId);
payload[payloadLength + 2] = STATUS_UNSUPPORTED_ATTRIBUTE;
payloadLength += 3;
} else {
copyHexL(&payload[payloadLength], attrId);
payload[payloadLength + 2] = STATUS_SUCCESS;
payload[payloadLength + 3] = attr->getAttrType();
payloadLength += 4;
payloadLength += attr->copyPayload((uint8_t *) &payload[payloadLength]);
#ifdef DEBUG
responseStr += String("Attribute ") + String(attrId) + String(" ") + attr->toString() + "\n";
#endif
}
}
#ifdef DEBUG
commandStr += String("from Cluster ") + String(clusterId);
Serial.println(commandStr);
Serial.println(responseStr);
#endif
return true;
} else if (command == ZCL_DISCOVER_ATTRIBUTES) {
/*
Command
-----------------------------------------------------------
| Bits: 24 | Bits: 16 | Bits: 8 |
|----------------------------------------------------------
| ZCL Header | Start Attribute ID | Maximum Attribute IDs |
-----------------------------------------------------------
Response payload
--------------------------------------------------------------------------------------------------
| Bits: 24 | 8 | Variable | Variable | ... | Variable |
|-------------------------------------------------------------------------------------------------
| ZCL Header | Discovery Complete | Attribute Info 1 | Attribute Info 2 | ... | Attribute Info n |
--------------------------------------------------------------------------------------------------
Attribute Info
----------------------------
| Bits: 16 | 1 |
----------------------------
| Attribute Id | Data Type |
----------------------------
*/
#ifdef DEBUG
commandStr += String("Discover attributes: Start: ");
#endif
payloadLength = 4;
payload[0] = 0b00011000;
payload[1] = frameId;
payload[2] = ZCL_DISCOVER_ATTRIBUTES_RESPONSE;
uint16_t first_attr = ((uint16_t) frameData[4] << 8) | frameData[3];
uint8_t max_attrs = frameData[5];
uint8_t attr_index = cluster->getAttrIndexById(first_attr);
uint8_t num_attrs = cluster->numAttributes();
#ifdef DEBUG
commandStr += String(first_attr) + String(" Max: ") + String(max_attrs) + String(" from cluster ") +
String(clusterId);
#endif
bool done = false;
ZHA_Attribute *attr;
for (uint8_t i = 0; i < max_attrs; i++) {
if ((attr_index == -1) || (i + attr_index + 1 > num_attrs)) {
done = true;
break;
}
attr = cluster->getAttrByIndex(i + attr_index);
copyHexL(&payload[payloadLength], attr->getAttrId());
payload[payloadLength + 2] = attr->getAttrType();
payloadLength += 3;
#ifdef DEBUG
responseStr += String("Attribute ") + String(attr->getAttrId()) + String(" Type: ") +
String(attr->getAttrType()) + "\n";
#endif
}
payload[3] = (uint8_t) done;
#ifdef DEBUG
if (done) {
responseStr += String("Discovery complete.");
} else {
responseStr += String("Discovery incomplete.");
};
Serial.println(commandStr);
Serial.println(responseStr);
#endif
return true;
} else if (command == ZCL_CONFIGURE_REPORTING) {
/*
Command
--------------------------------------------------------------------------------------
| Bits: 24 | Variable | Variable | ... | Variable |
|-------------------------------------------------------------------------------------
| ZCL Header | Attribute Record 1 | Attribute Record 2 | ... | Attribute Record n |
--------------------------------------------------------------------------------------
Attribute Record
----------------------------------------------------------------------------------------------------------------------------------------
| Bits: 8 | 16 | 0/8 | 0/16 | 0/16 | 0/Variable | 0/16 |
|---------------------------------------------------------------------------------------------------------------------------------------
| Direction | Attribute ID | Data Type | Minimum Reporting Interval | Maximum Reporting Interval | Reeportable Change | Timeout Period |
|---------------------------------------------------------------------------------------------------------------------------------------
If Direction is 0x00: Uses fields Attribute Id, Data Type, Minimum Reporting Interval, Maximum Reporting Interval, Reportable Change
Doesn't use field Timeout Period
If Direction is 0x01: Uses field Timeout Period
Doesn't use fields Data Type, Minimum Reporting Interval, Maximum Reporting Interval, Reportable Change
For discrete (non-analog) data types, Reportable Change field is omitted.
Response payload
-----------------------------------------------------------------------------------
| Bits: 24 | 32 | 32 | ... | 32 |
|----------------------------------------------------------------------------------
| ZCL Header | Attribute Record 1 | Attribute Record 2 | ... | Attribute Record n |
-----------------------------------------------------------------------------------
Attribute Record
--------------------------------------
| Bits: 8 | 8 | 16 |
--------------------------------------
| Status | Direction | Attribute ID |
--------------------------------------
TODO:
If all attributes are configured for reporting successfully, just return a single record with status SUCCESS.
*/
#ifdef DEBUG
commandStr += String("Configure reporting for attributes ");
#endif
payloadLength = 3;
payload[0] = 0b00011000;
payload[1] = frameId;
payload[2] = ZCL_CONFIGURE_REPORTING_RESPONSE;
uint8_t i = 3;
while (i < frameDataLength) {
if (frameData[i] == 0x00) {
/* send reports */
uint16_t attrId = ((uint16_t) frameData[i + 2] << 8) | frameData[i + 1];
ZHA_Attribute *attr = cluster->getAttrById(attrId);
#ifdef DEBUG
commandStr += String(attrId) + String(" ");
#endif
if (attr) {
uint8_t datatype = frameData[i + 3];
uint16_t minimum_interval = ((uint16_t) frameData[i + 5] << 8) | frameData[i + 4];
uint16_t maximum_interval = ((uint16_t) frameData[i + 7] << 8) | frameData[i + 6];
uint16_t reportable_change = 0x0000;
uint16_t timeout_period = 0x0000;
attr->configureReporting(datatype, minimum_interval, maximum_interval, reportable_change,
timeout_period);
i += 8;
payload[payloadLength++] = STATUS_SUCCESS;
payload[payloadLength++] = 0x00;
copyHexL(&payload[payloadLength++], attrId);
responseStr += String("Success");
}
} else if (frameData[i] == 0x01) {
/* receive reports */
}
}
#ifdef DEBUG
commandStr += String("from cluster ") + String(clusterId);
Serial.println(commandStr);
Serial.println(responseStr);
#endif
return true;
} else {
#ifdef DEBUG
Serial.print("Received unimplemented command ");
Serial.println(command);
#endif
return false;
}
}
bool ZHA_Device::processCommand(uint8_t *frameData, uint8_t frameDataLength, uint16_t clusterId, uint8_t *payload,
uint8_t &payloadLength) {
/* Frame layout
---------------------------------------------------------------------
| Bits: 8 | 0/16 | 8 | 8 | Variable |
|-------------------------------------------------------------------|
| Frame Control | MFR code | Frame ID | Command ID | Frame Payload |
---------------------------------------------------------------------
Frame Control Field
--------------------------------------------------------------------------------
} Bits: 3 | 1 | 1 | 1 | 2 |
|------------------------------------------------------------------------------|
| Reserverd | Disable Default Response | Direction | MFR specific | Frame Type |
--------------------------------------------------------------------------------
*/
uint8_t frametype = frameData[0] & 0b11;
if (frametype == 0b00) {
/* general command frame */
// Serial.println("general command");
return processGeneralCommand(frameData, frameDataLength, clusterId, payload, payloadLength);
} else if (frametype == 0b01) {
/* cluster specific command frame */
// Serial.println("cluster specific command");
ZHA_Cluster *cluster = getInClusterById(clusterId);
cluster->processCommand(frameData, frameDataLength);
}
}