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
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
|
/* Copyright [2019 - 2020] Exegin Technologies Limited. All rights reserved. */
#ifndef ZCL_ELEC_MEAS_H
#define ZCL_ELEC_MEAS_H
#include "zcl/zcl.h"
/*--------------------------------------------------------------------------
* DESCRIPTION
* Interface definition for the ZCL Electrical Measurement cluster.
*--------------------------------------------------------------------------
*/
/* PICS.ZCL.Electrical.Measurement
* EMR.S | True
* EMR.C | True
*
* Server Attributes
* EMR.S.A0000 | True
* EMR.S.A0100 | False
* EMR.S.A0101 | False
* EMR.S.A0102 | False
* EMR.S.A0103 | False
* EMR.S.A0104 | False
* EMR.S.A0105 | False
* EMR.S.A0106 | False
* EMR.S.A0107 | False
* EMR.S.A0108 | False
* EMR.S.A0200 | False
* EMR.S.A0201 | False
* EMR.S.A0202 | False
* EMR.S.A0203 | False
* EMR.S.A0204 | False
* EMR.S.A0205 | False
* EMR.S.A0300 | False
* EMR.S.A0301 | False
* EMR.S.A0302 | False
* EMR.S.A0303 | False
* EMR.S.A0304 | False
* EMR.S.A0305 | False
* EMR.S.A0306 | False
* EMR.S.A0307 | False
* EMR.S.A0308 | False
* EMR.S.A0309 | False
* EMR.S.A030a | False
* EMR.S.A030b | False
* EMR.S.A030c | False
* EMR.S.A030d | False
* EMR.S.A030e | False
* EMR.S.A030f | False
* EMR.S.A0310 | False
* EMR.S.A0311 | False
* EMR.S.A0312 | False
* EMR.S.A0400 | False
* EMR.S.A0401 | False
* EMR.S.A0402 | False
* EMR.S.A0403 | False
* EMR.S.A0404 | False
* EMR.S.A0405 | False
* EMR.S.A0501 | False
* EMR.S.A0502 | False
* EMR.S.A0503 | False
* EMR.S.A0505 | False
* EMR.S.A0506 | False
* EMR.S.A0507 | False
* EMR.S.A0508 | False
* EMR.S.A0509 | False
* EMR.S.A050a | False
* EMR.S.A050b | False
* EMR.S.A050c | False
* EMR.S.A050d | False
* EMR.S.A050e | False
* EMR.S.A050f | False
* EMR.S.A0510 | False
* EMR.S.A0511 | False
* EMR.S.A0512 | False
* EMR.S.A0513 | False
* EMR.S.A0514 | False
* EMR.S.A0515 | False
* EMR.S.A0516 | False
* EMR.S.A0517 | False
* EMR.S.A0600 | False
* EMR.S.A0601 | False
* EMR.S.A0602 | False
* EMR.S.A0603 | False
* EMR.S.A0604 | False
* EMR.S.A0605 | False
* EMR.S.A0700 | False
* EMR.S.A0701 | False
* EMR.S.A0702 | False
* EMR.S.A0800 | False
* EMR.S.A0801 | False
* EMR.S.A0802 | False
* EMR.S.A0803 | False
* EMR.S.A0804 | False
* EMR.S.A0805 | False
* EMR.S.A0806 | False
* EMR.S.A0807 | False
* EMR.S.A0808 | False
* EMR.S.A0809 | False
* EMR.S.A080a | False
* EMR.S.A0901 | False
* EMR.S.A0902 | False
* EMR.S.A0903 | False
* EMR.S.A0905 | False
* EMR.S.A0906 | False
* EMR.S.A0907 | False
* EMR.S.A0908 | False
* EMR.S.A0909 | False
* EMR.S.A090a | False
* EMR.S.A090b | False
* EMR.S.A090c | False
* EMR.S.A090d | False
* EMR.S.A090e | False
* EMR.S.A090f | False
* EMR.S.A0910 | False
* EMR.S.A0911 | False
* EMR.S.A0912 | False
* EMR.S.A0913 | False
* EMR.S.A0914 | False
* EMR.S.A0915 | False
* EMR.S.A0916 | False
* EMR.S.A0917 | False
* EMR.S.A0a01 | False
* EMR.S.A0a02 | False
* EMR.S.A0a03 | False
* EMR.S.A0a05 | False
* EMR.S.A0a06 | False
* EMR.S.A0a07 | False
* EMR.S.A0a08 | False
* EMR.S.A0a09 | False
* EMR.S.A0a0a | False
* EMR.S.A0a0b | False
* EMR.S.A0a0c | False
* EMR.S.A0a0d | False
* EMR.S.A0a0e | False
* EMR.S.A0a0f | False
* EMR.S.A0a10 | False
* EMR.S.A0a11 | False
* EMR.S.A0a12 | False
* EMR.S.A0a13 | False
* EMR.S.A0a14 | False
* EMR.S.A0a15 | False
* EMR.S.A0a16 | False
* EMR.S.A0a17 | False
* EMR.S.Afffd | True
* EMR.S.Afffe | False
* Commands Received
* EMR.S.C00.Rsp | depends on customer application
* EMR.S.C01.Rsp | depends on customer application
* Commands Generated
* EMR.S.C00.Tx | depends on customer application
* EMR.S.C01.Tx | depends on customer application
*
* Client Attributes
* DRLK.C.Afffd | True
* DRLK.C.Afffe | False
*
* Commands Received
* EMR.C.C00.Rsp | depends on customer application
* EMR.C.C01.Rsp | depends on customer application
*
* Commands Generated
* EMR.C.C00.Tx | True
* EMR.C.C01.Tx | True
*/
/* Attribute Identifiers */
enum {
ZCL_ELEC_MEAS_ATTR_MEAS_TYPE = 0x0000,
ZCL_ELEC_MEAS_ATTR_DC_VOLT = 0x0100,
ZCL_ELEC_MEAS_ATTR_DC_VOLT_MIN = 0x0101,
ZCL_ELEC_MEAS_ATTR_DC_VOLT_MAX = 0x0102,
ZCL_ELEC_MEAS_ATTR_DC_CURRENT = 0x0103,
ZCL_ELEC_MEAS_ATTR_DC_CURRENT_MIN = 0x0104,
ZCL_ELEC_MEAS_ATTR_DC_CURRENT_MAX = 0x0105,
ZCL_ELEC_MEAS_ATTR_DC_POWER = 0x0106,
ZCL_ELEC_MEAS_ATTR_DC_POWER_MIN = 0x0107,
ZCL_ELEC_MEAS_ATTR_DC_POWER_MAX = 0x0108,
ZCL_ELEC_MEAS_ATTR_DC_VOLT_MULTIPLIER = 0x0200,
ZCL_ELEC_MEAS_ATTR_DC_VOLT_DIVISOR = 0x0201,
ZCL_ELEC_MEAS_ATTR_DC_CURR_MULTIPLIER = 0x0202,
ZCL_ELEC_MEAS_ATTR_DC_CURR_DIVISOR = 0x0203,
ZCL_ELEC_MEAS_ATTR_DC_PWR_MULTIPLIER = 0x0204,
ZCL_ELEC_MEAS_ATTR_DC_PWR_DIVISOR = 0x0205,
ZCL_ELEC_MEAS_ATTR_AC_FREQ = 0x0300,
ZCL_ELEC_MEAS_ATTR_AC_FREQ_MIN = 0x0301,
ZCL_ELEC_MEAS_ATTR_AC_FREQ_MAX = 0x0302,
ZCL_ELEC_MEAS_ATTR_NEUTRAL_CURR = 0x0303,
ZCL_ELEC_MEAS_ATTR_TOTAL_ACTIVE_PWR = 0x0304,
ZCL_ELEC_MEAS_ATTR_TOTAL_REACTIVE_PWR = 0x0305,
ZCL_ELEC_MEAS_ATTR_TOTAL_APPARENT_PWR = 0x0306,
ZCL_ELEC_MEAS_ATTR_1ST_HARM_CURR = 0x0307,
ZCL_ELEC_MEAS_ATTR_3RD_HARM_CURR = 0x0308,
ZCL_ELEC_MEAS_ATTR_5TH_HARM_CURR = 0x0309,
ZCL_ELEC_MEAS_ATTR_7TH_HARM_CURR = 0x030a,
ZCL_ELEC_MEAS_ATTR_9TH_HARM_CURR = 0x030b,
ZCL_ELEC_MEAS_ATTR_11TH_HARM_CURR = 0x030c,
ZCL_ELEC_MEAS_ATTR_PHASE_1ST_HARM_CURR = 0x030d,
ZCL_ELEC_MEAS_ATTR_PHASE_3RD_HARM_CURR = 0x030e,
ZCL_ELEC_MEAS_ATTR_PHASE_5TH_HARM_CURR = 0x030f,
ZCL_ELEC_MEAS_ATTR_PHASE_7TH_HARM_CURR = 0x0310,
ZCL_ELEC_MEAS_ATTR_PHASE_9TH_HARM_CURR = 0x0311,
ZCL_ELEC_MEAS_ATTR_PHASE_11TH_HARM_CURR = 0x0312,
ZCL_ELEC_MEAS_ATTR_AC_FREQ_MULTIPLIER = 0x0400,
ZCL_ELEC_MEAS_ATTR_AC_FREQ_DIVISOR = 0x0401,
ZCL_ELEC_MEAS_ATTR_PWR_MULTIPLIER = 0x0402,
ZCL_ELEC_MEAS_ATTR_PWR_DIVISOR = 0x0403,
ZCL_ELEC_MEAS_ATTR_HARM_CURR_MULTIPLIER = 0x0404,
ZCL_ELEC_MEAS_ATTR_PHASE_CURR_MULTIPLIER = 0x0405,
ZCL_ELEC_MEAS_ATTR_LINE_CURR = 0x0501,
ZCL_ELEC_MEAS_ATTR_ACTIVE_CURR = 0x0502,
ZCL_ELEC_MEAS_ATTR_REACTIVE_CURR = 0x0503,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT = 0x0505,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MIN = 0x0506,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MAX = 0x0507,
ZCL_ELEC_MEAS_ATTR_RMS_CURR = 0x0508,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MIN = 0x0509,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MAX = 0x050a,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR = 0x050b,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MIN = 0x050c,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MAX = 0x050d,
ZCL_ELEC_MEAS_ATTR_REACTIVE_PWR = 0x050e,
ZCL_ELEC_MEAS_ATTR_APPARENT_PWR = 0x050f,
ZCL_ELEC_MEAS_ATTR_PWR_FACTOR = 0x0510,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_VOLT_PERIOD = 0x0511,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_OV_COUNT = 0x0512,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_UV_COUNT = 0x0513,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_OVER_PERIOD = 0x0514,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_UNDER_PERIOD = 0x0515,
ZCL_ELEC_MEAS_ATTR_VOLT_SAG_PERIOD = 0x0516,
ZCL_ELEC_MEAS_ATTR_VOLT_SWELL_PERIOD = 0x0517,
ZCL_ELEC_MEAS_ATTR_AC_VOLT_MULTIPLIER = 0x0600,
ZCL_ELEC_MEAS_ATTR_AC_VOLT_DIVISOR = 0x0601,
ZCL_ELEC_MEAS_ATTR_AC_CURR_MULT = 0x0602,
ZCL_ELEC_MEAS_ATTR_AC_CURR_DIVISOR = 0x0603,
ZCL_ELEC_MEAS_ATTR_AC_PWR_MULTIPLIER = 0x0604,
ZCL_ELEC_MEAS_ATTR_AC_PWR_DIVISOR = 0x0605,
ZCL_ELEC_MEAS_ATTR_DC_OL_ALARMS_MASK = 0x0700,
ZCL_ELEC_MEAS_ATTR_DC_VOLT_OL = 0x0701,
ZCL_ELEC_MEAS_ATTR_DC_CURR_OL = 0x0702,
ZCL_ELEC_MEAS_ATTR_AC_ALARMS_MASK = 0x0800,
ZCL_ELEC_MEAS_ATTR_AC_VOLT_OL = 0x0801,
ZCL_ELEC_MEAS_ATTR_AC_CURR_OL = 0x0802,
ZCL_ELEC_MEAS_ATTR_AC_ACTIVE_PWR_OL = 0x0803,
ZCL_ELEC_MEAS_ATTR_AC_REACTIVE_PWR_OL = 0x0804,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_OV = 0x0805,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_UV = 0x0806,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_OV = 0x0807,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_UV = 0x0808,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_SAG = 0x0809,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_SWELL = 0x080a,
ZCL_ELEC_MEAS_ATTR_LINE_CURR_B = 0x0901,
ZCL_ELEC_MEAS_ATTR_ACTIVE_CURR_B = 0x0902,
ZCL_ELEC_MEAS_ATTR_REACTIVE_CURR_B = 0x0903,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_B = 0x0905,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MIN_B = 0x0906,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MAX_B = 0x0907,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_B = 0x0908,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MIN_B = 0x0909,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MAX_B = 0x090a,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_B = 0x090b,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MIN_B = 0x090c,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MAX_B = 0x090d,
ZCL_ELEC_MEAS_ATTR_REACTIVE_PWR_B = 0x090e,
ZCL_ELEC_MEAS_ATTR_APPARENT_PWR_B = 0x090f,
ZCL_ELEC_MEAS_ATTR_PWR_FACTOR_B = 0x0910,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_VOLT_PERIOD_B = 0x0911,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_OV_B = 0x0912,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_UV_B = 0x0913,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_OVER_B = 0x0914,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_UNDER_B = 0x0915,
ZCL_ELEC_MEAS_ATTR_RMS_SAG_PERIOD_B = 0x0916,
ZCL_ELEC_MEAS_ATTR_RMS_SWELL_PERIOD_B = 0x0917,
ZCL_ELEC_MEAS_ATTR_LINE_CURR_C = 0x0a01,
ZCL_ELEC_MEAS_ATTR_ACTIVE_CURR_C = 0x0a02,
ZCL_ELEC_MEAS_ATTR_REACTIVE_CURR_C = 0x0a03,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_C = 0x0a05,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MIN_C = 0x0a06,
ZCL_ELEC_MEAS_ATTR_RMS_VOLT_MAX_C = 0x0a07,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_C = 0x0a08,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MIN_C = 0x0a0a,
ZCL_ELEC_MEAS_ATTR_RMS_CURR_MAX_C = 0x0a0a,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_C = 0x0a0C,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MIN_C = 0x0a0c,
ZCL_ELEC_MEAS_ATTR_ACTIVE_PWR_MAX_C = 0x0a0d,
ZCL_ELEC_MEAS_ATTR_REACTIVE_PWR_C = 0x0a0e,
ZCL_ELEC_MEAS_ATTR_APPARENT_PWR_C = 0x0a0f,
ZCL_ELEC_MEAS_ATTR_PWR_FACTOR_C = 0x0a10,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_VOLT_PERIOD_C = 0x0a11,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_OV_C = 0x0a12,
ZCL_ELEC_MEAS_ATTR_AVG_RMS_UV_C = 0x0a13,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_OVER_C = 0x0a14,
ZCL_ELEC_MEAS_ATTR_RMS_EXT_UNDER_C = 0x0a15,
ZCL_ELEC_MEAS_ATTR_RMS_SAG_PERIOD_C = 0x0a16,
ZCL_ELEC_MEAS_ATTR_RMS_SWELL_PERIOD_C = 0x0a17,
};
/* Default Values */
#define ZCL_ELEC_MEAS_DEFAULT_MEAS_TYPE 0x00000000
#define ZCL_ELEC_MEAS_DEFAULT_DC_MEAS 0x8000
#define ZCL_ELEC_MEAS_DEFAULT_DC_FORMATTING 0x0001
#define ZCL_ELEC_MEAS_DEFAULT_DC_OL_ALARMS_MASK 0x00
#define ZCL_ELEC_MEAS_DEFAULT_DC_VOLT_OL 0xffff
/* Min and Max Values */
#define ZCL_ELEC_MEAS_MIN_DC_MEAS 0x8001
#define ZCL_ELEC_MEAS_MAX_DC_MEAS 0x7fff
#define ZCL_ELEC_MEAS_MIN_DC_FORMATTING 0x0001
#define ZCL_ELEC_MEAS_MAX_DC_FORMATTING 0xffff
#define ZCL_ELEC_MEAS_MIN_OL_ALARMS_MASK 0x00
#define ZCL_ELEC_MEAS_MAX_OL_ALARMS_MASK 0x03
/* Client Generated Commands */
enum {
ZCL_ELEC_MEAS_CLI_GET_PROFILE_INFO = 0x00,
ZCL_ELEC_MEAS_CLI_GET_MEAS_PROFILE = 0x01
};
/* Server Generated Commands */
enum {
ZCL_ELEC_MEAS_SVR_GET_PROFILE_INFO_RSP = 0x00,
ZCL_ELEC_MEAS_SVR_GET_MEAS_PROFILE_RSP = 0x01
};
struct elec_meas_get_meas_profile_req_t {
uint16_t attr_id;
uint32_t start_time;
uint8_t num_intervals;
};
struct elec_meas_get_profile_info_rsp_t {
/* Profile count is the total number for supported profile, and the list of
* attributes is the list of attributes being profiled. This relationship has
* been interpreted as profile count holding the number of attributes in
* attribute list. */
uint8_t profile_count;
uint8_t profile_interval_period;
uint8_t max_num_intervals;
uint16_t *attr_list;
};
struct elec_meas_get_meas_profile_rsp_t {
uint32_t start_time;
uint8_t status;
uint8_t profile_interval_period;
uint8_t num_intervals_delivered;
uint8_t attr_id;
uint8_t *intervals;
};
struct zcl_elec_meas_callbacks_t {
enum ZclStatusCodeT (*get_profile_info)(struct ZbZclClusterT *clusterPtr, struct ZbZclAddrInfoT *src_info, void *arg);
enum ZclStatusCodeT (*get_meas_profile)(struct ZbZclClusterT *clusterPtr, struct elec_meas_get_meas_profile_req_t *cmd_req,
struct ZbZclAddrInfoT *src_info, void *arg);
};
/*---------------------------------------------------------------
* Electrical Measurement Function Declarations
*---------------------------------------------------------------
*/
/* Allocation Functions */
struct ZbZclClusterT * ZbZclElecMeasClientAlloc(struct ZigBeeT *zb, uint8_t endpoint);
struct ZbZclClusterT * ZbZclElecMeasServerAlloc(struct ZigBeeT *zb, uint8_t endpoint, struct zcl_elec_meas_callbacks_t *callbacks, void *arg);
/* Client Generated Commands */
enum ZclStatusCodeT ZbZclElecMeasClientGetProfileInfoReq(struct ZbZclClusterT *cluster, struct ZbApsAddrT *dst,
void (*callback)(struct ZbZclCommandRspT *rsp, void *arg), void *arg);
enum ZclStatusCodeT ZbZclElecMeasClientGetMeasProfileReq(struct ZbZclClusterT *cluster, struct ZbApsAddrT *dst,
struct elec_meas_get_meas_profile_req_t *get_meas_profile_req,
void (*callback)(struct ZbZclCommandRspT *rsp, void *arg), void *arg);
/* Server Reponse Commands */
enum ZclStatusCodeT ZbZclElecMeasServerSendProfileInfoRsp(struct ZbZclClusterT *clusterPtr, struct ZbZclAddrInfoT *dst_info,
struct elec_meas_get_profile_info_rsp_t *rsp);
enum ZclStatusCodeT ZbZclElecMeasServerSendMeasProfileRsp(struct ZbZclClusterT *clusterPtr, struct ZbZclAddrInfoT *dst_info,
struct elec_meas_get_meas_profile_rsp_t *rsp);
#endif /* _ZCL_ELEC_MEAS_H */
|
