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
|
/**
* @file zcl.power.config.h
* @heading Power Configuration
* @brief ZCL Power Configuration cluster header
* ZCL 7 section 3.3
* ZCL 8 section 3.3
* @copyright Copyright [2009 - 2020] Exegin Technologies Limited. All rights reserved.
*/
#ifndef ZCL_POWER_H
# define ZCL_POWER_H
/* @PICS.ZCL.Power
* PC.S | Server | True
* PC.C | Client | True
*
* Server Attributes
* PC.S.A0000 | MainsVoltage | True | Optional
* PC.S.A0001 | MainsFrequency | True | Optional
* PC.S.A0010 | MainsAlarmMask | False | Optional
* PC.S.A0011 | MainsVoltageMinThreshold | True | Optional
* PC.S.A0012 | MainsVoltageMaxThreshold | True | Optional
* PC.S.A0013 | MainsVoltageDwellTripPoint | False | Optional
* PC.S.A0020 | BatteryVoltage | True | Optional
* PC.S.A0021 | BatteryPercentageRemaining | True | Optional
* PC.S.A0030 | BatteryManufacturer | True | Optional
* PC.S.A0031 | BatterySize | True | Optional
* PC.S.A0032 | BatteryAHrRating | True | Optional
* PC.S.A0033 | BatteryQuantity | True | Optional
* PC.S.A0034 | BatteryRatedVoltage | True | Optional
* PC.S.A0035 | BatteryAlarmMask | True | Optional
* PC.S.A0036 | BatteryVoltageMinThreshold | True | Optional
* PC.S.A0037 | BatteryVoltageThreshold1 | False | Optional
* PC.S.A0038 | BatteryVoltageThreshold2 | False | Optional
* PC.S.A0039 | BatteryVoltageThreshold3 | False | Optional
* PC.S.A003a | BatteryPercentageMinThreshold | True | Optional
* PC.S.A003b | BatteryPercentageThreshold1 | False | Optional
* PC.S.A003c | BatteryPercentageThreshold2 | False | Optional
* PC.S.A003d | BatteryPercentageThreshold3 | False | Optional
* PC.S.A003e | BatteryAlarmState | True | Optional
* PC.S.A0040 | BatteryVoltage - Second battery | False | Optional
* PC.S.A0041 | BatteryPercentageRemaining - Second battery | False | Optional
* PC.S.A0050 | BatteryManufacturer - Second battery | False | Optional
* PC.S.A0051 | BatterySize - Second battery | True | Optional
* PC.S.A0052 | BatteryAHrRating - Second battery | False | Optional
* PC.S.A0053 | BatteryQuantity - Second battery | False | Optional
* PC.S.A0054 | BatteryRatedVoltage - Second battery | False | Optional
* PC.S.A0055 | BatteryAlarmMask - Second battery | False | Optional
* PC.S.A0056 | BatteryVoltageMinThreshold - Second battery | False | Optional
* PC.S.A0057 | BatteryVoltageThreshold1 - Second battery | False | Optional
* PC.S.A0058 | BatteryVoltageThreshold2 - Second battery | False | Optional
* PC.S.A0059 | BatteryVoltageThreshold3 - Second battery | False | Optional
* PC.S.A005a | BatteryPercentageMinThreshold - Second battery | False | Optional
* PC.S.A005b | BatteryPercentageThreshold1 - Second battery | False | Optional
* PC.S.A005c | BatteryPercentageThreshold2 - Second battery | False | Optional
* PC.S.A005d | BatteryPercentageThreshold3 - Second battery | False | Optional
* PC.S.A005e | BatteryAlarmState - Second battery | False | Optional
* PC.S.A0060 | BatteryVoltage - Third Battery | False | Optional
* PC.S.A0061 | BatteryPercentageRemaining - Third Battery | False | Optional
* PC.S.A0070 | BatteryManufacturer - Third Battery | False | Optional
* PC.S.A0071 | BatterySize - Third Battery | True | Optional
* PC.S.A0072 | BatteryAHrRating - Third Battery | False | Optional
* PC.S.A0073 | BatteryQuantity - Third Battery | False | Optional
* PC.S.A0074 | BatteryRatedVoltage - Third Battery | False | Optional
* PC.S.A0075 | BatteryAlarmMask - Third Battery | False | Optional
* PC.S.A0076 | BatteryVoltageMinThreshold - Third Battery | False | Optional
* PC.S.A0077 | BatteryVoltageThreshold1 - Third Battery | False | Optional
* PC.S.A0078 | BatteryVoltageThreshold2 - Third Battery | False | Optional
* PC.S.A0079 | BatteryVoltageThreshold3 - Third Battery | False | Optional
* PC.S.A007a | BatteryPercentageMinThreshold - Third Battery | False | Optional
* PC.S.A007b | BatteryPercentageThreshold1 - Third Battery | False | Optional
* PC.S.A007c | BatteryPercentageThreshold2 - Third Battery | False | Optional
* PC.S.A007d | BatteryPercentageThreshold3 - Third Battery | False | Optional
* PC.S.A007e | BatteryAlarmState - Third Battery | False | Optional
* PC.S.Afffd | ClusterRevision | True
* PC.S.Afffe | AttributeReportingStatus | False
*
* Client Attributes
* PC.C.Afffd | ClusterRevision | True
* PC.C.Afffe | AttributeReportingStatus | False
*/
#include "zcl/zcl.h"
/** Power Configuration Server Attributes IDs */
enum ZbZclPowerConfigSvrAttrT {
ZCL_POWER_CONFIG_ATTR_MAINS_VOLTAGE = 0x0000, /**< MainsVoltage (Optional) */
ZCL_POWER_CONFIG_ATTR_MAINS_FREQ = 0x0001, /**< MainsFrequency (Optional) */
ZCL_POWER_CONFIG_ATTR_MAINS_ALARM_MASK = 0x0010, /**< MainsAlarmMask (Optional) */
ZCL_POWER_CONFIG_ATTR_MAINS_VOLT_MIN = 0x0011, /**< MainsVoltageMinThreshold (Optional) */
ZCL_POWER_CONFIG_ATTR_MAINS_VOLT_MAX = 0x0012, /**< MainsVoltageMaxThreshold (Optional) */
ZCL_POWER_CONFIG_ATTR_MAINS_VOLT_DWELL = 0x0013, /**< MainsVoltageDwellTripPoint (Optional) */
/* First battery */
ZCL_POWER_CONFIG_ATTR_BATTERY_VOLTAGE = 0x0020, /**< BatteryVoltage (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_PCT = 0x0021, /**< BatteryPercentageRemaining (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_MFR_NAME = 0x0030, /**< BatteryManufacturer (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_SIZE = 0x0031, /**< BatterySize (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_AHRRATING = 0x0032, /**< BatteryAHrRating (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_QUANTITY = 0x0033, /**< BatteryQuantity (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_RATED_VOLT = 0x0034, /**< BatteryRatedVoltage (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_ALARM_MASK = 0x0035, /**< BatteryAlarmMask (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_VOLT_MIN = 0x0036, /**< BatteryVoltageMinThreshold (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_VTHRESHOLD1 = 0x0037, /**< BatteryVoltageThreshold1 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_VTHRESHOLD2 = 0x0038, /**< BatteryVoltageThreshold2 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_VTHRESHOLD3 = 0x0039, /**< BatteryVoltageThreshold3 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_PCT_MIN = 0x003A, /**< BatteryPercentageMinThreshold (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_PTHRESHOLD1 = 0x003B, /**< BatteryPercentageThreshold1 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_PTHRESHOLD2 = 0x003C, /**< BatteryPercentageThreshold2 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_PTHRESHOLD3 = 0x003D, /**< BatteryPercentageThreshold3 (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY_ALARM_STATE = 0x003E, /**< BatteryAlarmState (Optional) */
/* Second battery */
ZCL_POWER_CONFIG_ATTR_BATTERY2_VOLTAGE = 0x0040, /**< BatteryVoltage - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_PCT = 0x0041, /**< BatteryPercentageRemaining - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_MFR_NAME = 0x0050, /**< BatteryManufacturer - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_SIZE = 0x0051, /**< BatterySize - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_AHRRATING = 0x0052, /**< BatteryAHrRating - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_QUANTITY = 0x0053, /**< BatteryQuantity - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_RATED_VOLT = 0x0054, /**< BatteryRatedVoltage - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_ALARM_MASK = 0x0055, /**< BatteryAlarmMask - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_VOLT_MIN = 0x0056, /**< BatteryVoltageMinThreshold - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_VTHRESHOLD1 = 0x0057, /**< BatteryVoltageThreshold1 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_VTHRESHOLD2 = 0x0058, /**< BatteryVoltageThreshold2 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_VTHRESHOLD3 = 0x0059, /**< BatteryVoltageThreshold3 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_PCT_MIN = 0x005A, /**< BatteryPercentageMinThreshold - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_PTHRESHOLD1 = 0x005B, /**< BatteryPercentageThreshold1 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_PTHRESHOLD2 = 0x005C, /**< BatteryPercentageThreshold2 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_PTHRESHOLD3 = 0x005D, /**< BatteryPercentageThreshold3 - Second battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY2_ALARM_STATE = 0x005E, /**< BatteryAlarmState - Second battery (Optional) */
/* Third battery */
ZCL_POWER_CONFIG_ATTR_BATTERY3_VOLTAGE = 0x0060, /**< BatteryVoltage - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_PCT = 0x0061, /**< BatteryPercentageRemaining - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_MFR_NAME = 0x0070, /**< BatteryManufacturer - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_SIZE = 0x0071, /**< BatterySize - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_AHRRATING = 0x0072, /**< BatteryAHrRating - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_QUANTITY = 0x0073, /**< BatteryQuantity - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_RATED_VOLT = 0x0074, /**< BatteryRatedVoltage - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_ALARM_MASK = 0x0075, /**< BatteryAlarmMask - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_VOLT_MIN = 0x0076, /**< BatteryVoltageMinThreshold - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_VTHRESHOLD1 = 0x0077, /**< BatteryVoltageThreshold1 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_VTHRESHOLD2 = 0x0078, /**< BatteryVoltageThreshold2 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_VTHRESHOLD3 = 0x0079, /**< BatteryVoltageThreshold3 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_PCT_MIN = 0x007A, /**< BatteryPercentageMinThreshold - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_PTHRESHOLD1 = 0x007B, /**< BatteryPercentageThreshold1 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_PTHRESHOLD2 = 0x007C, /**< BatteryPercentageThreshold2 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_PTHRESHOLD3 = 0x007D, /**< BatteryPercentageThreshold3 - Third Battery (Optional) */
ZCL_POWER_CONFIG_ATTR_BATTERY3_ALARM_STATE = 0x007E, /**< BatteryAlarmState - Third Battery (Optional) */
};
#define ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_LOW 0x01U
#define ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_HIGH 0x02U
#define ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_LOST 0x04U
#define ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_MASK 0x07U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_NO_BATTERY 0x00U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_BUILT_IN 0x01U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_OTHER 0x02U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_AA 0x03U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_AAA 0x04U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_C 0x05U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_D 0x06U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_CR2 0x07U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_CR123A 0x08U
#define ZCL_POWER_CONFIG_BATTERY_SIZE_UNKNOWN 0xffU
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_LOW 0x01U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_BATT_ALARM1 0x02U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_BATT_ALARM2 0x04U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_BATT_ALARM3 0x08U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_MASK 0x0fU
/* Battery Source 1 Alarm State */
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_1_MIN_THRESH 0x00000001U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_1_THRESH1 0x00000002U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_1_THRESH2 0x00000004U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_1_THRESH3 0x00000008U
/* Battery Source 2 Alarm State */
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_2_MIN_THRESH 0x00000400U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_2_THRESH1 0x00000800U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_2_THRESH2 0x00001000U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_2_THRESH3 0x00002000U
/* Battery Source 3 Alarm State */
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_3_MIN_THRESH 0x00100000U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_3_THRESH1 0x00200000U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_3_THRESH2 0x00400000U
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_3_THRESH3 0x00800000U
/* Mains power supply lost */
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_MAIN_LOST 0x40000000U
/* All */
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_MASK 0x40f03c0fU
/* Power Configuration default values */
#define ZCL_POWER_CONFIG_MAINS_ALARM_MASK_DEFAULT 0x00 /* none */
#define ZCL_POWER_CONFIG_MAINS_VOLT_MIN_DEFAULT 0x0000
#define ZCL_POWER_CONFIG_MAINS_VOLT_MAX_DEFAULT 0xFFFF
#define ZCL_POWER_CONFIG_BATTERY_PCT_DEFAULT 0x00
#define ZCL_POWER_CONFIG_BATTERY_SIZE_DEFAULT 0xFF
#define ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_DEFAULT 0x00
#define ZCL_POWER_CONFIG_BATTERY_VOLT_MIN_DEFAULT 0x0000
#define ZCL_POWER_CONFIG_BATTERY_PCT_MIN_DEFAULT 0x00
#define ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_DEFAULT 0x00000000
#define ZCL_POWER_CONFIG_BATTERY2_SIZE_DEFAULT 0xFF
#define ZCL_POWER_CONFIG_BATTERY3_SIZE_DEFAULT 0xFF
/* Power Configuration Client */
/**
* Create a new instance of the Power Configuration Client cluster
* @param zb Zigbee stack instance
* @param endpoint Endpoint on which to create cluster
* @return Cluster pointer, or NULL if there is an error
*/
struct ZbZclClusterT * ZbZclPowerConfigClientAlloc(struct ZigBeeT *zb, uint8_t endpoint);
/* Power Configuration Server */
/**
* Create a new instance of the Power Configuration Server cluster
* @param zb Zigbee stack instance
* @param endpoint Endpoint on which to create cluster
* @return Cluster pointer, or NULL if there is an error
*/
struct ZbZclClusterT * ZbZclPowerConfigServerAlloc(struct ZigBeeT *zb, uint8_t endpoint);
#endif
|
