summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/ZCL/include/zclDemandResponseCluster.h
blob: a3b9e23c640b8b0c4f25a30decbfbd6410763340 (plain)
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
/************************************************************************//**
  \file zclDemandResponseCluster.h

  \brief
    The header file describes the Demand Response Cluster.

  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal
    History:
    03.02.09 A. Mandychev - Created.
******************************************************************************/

#ifndef _ZCLDEMANDRESPONSECLUSTER_H
#define _ZCLDEMANDRESPONSECLUSTER_H

/******************************************************************************
                        Includes section
******************************************************************************/
#include <zcl.h>
#include <clusters.h>

/******************************************************************************
                        Defines section
******************************************************************************/
/**
 * \brief Demand Response Server Cluster attributes amount.
*/
#define DRLC_CLUSTER_SERVER_ATTRIBUTES_AMOUNT     0

/**
 * \brief Demand Response Client Cluster attributes amount.
*/
#define DRLC_CLUSTER_CLIENT_ATTRIBUTES_AMOUNT     4

/**
 * \brief Demand Response Cluster commands amount.
*/
#define DRLC_CLUSTER_COMMANDS_AMOUNT  5

/**
 * \brief Demand Response Server Cluster commands identifiers.
*/
#define LOAD_CONTROL_EVENT_COMMAND_ID               0x00
#define CANCEL_LOAD_CONTROL_EVENT_COMMAND_ID        0x01
#define CANCEL_ALL_LOAD_CONTROL_EVENTS_COMMAND_ID   0x02

/**
 * \brief Demand Response Client Cluster commands identifiers.
*/
#define REPORT_EVENT_STATUS_COMMAND_ID              0x00
#define GET_SCHEDULED_EVENTS_COMMAND_ID             0x01

/**
 * \brief Report event status identifiers
 */
#define REPORT_EVENT_STATUS_COMMAND_RECEIVED    0x01
#define REPORT_EVENT_STATUS_EVENT_STARTED       0x02
#define REPORT_EVENT_STATUS_EVENT_COMPLETED     0x03
#define REPORT_EVENT_STATUS_EVENT_CANCELED      0x06
#define REPORT_EVENT_STATUS_INVALID_CANCEL_COMMAND_DEFAULT      0xF8

#define DEFINE_DRLC_CLUSTER_COMMANDS(clLoadControlEventInd,           \
                                     clCancelLoadControlEventInd,     \
                                     clCancelAllLoadControlEventsInd, \
                                     clReportEventStatusInd,          \
                                     clGetScheduledEventsInd) \
  DEFINE_COMMAND(loadControlEventCommand,           0x00, COMMAND_OPTIONS(SERVER_TO_CLIENT, ZCL_THERE_IS_RELEVANT_RESPONSE, ZCL_COMMAND_ACK), clLoadControlEventInd), \
  DEFINE_COMMAND(cancelLoadControlEventCommand,     0x01, COMMAND_OPTIONS(SERVER_TO_CLIENT, ZCL_THERE_IS_NO_RELEVANT_RESPONSE, ZCL_COMMAND_ACK), clCancelLoadControlEventInd), \
  DEFINE_COMMAND(cancelAllLoadControlEventsCommand, 0x02, COMMAND_OPTIONS(SERVER_TO_CLIENT, ZCL_THERE_IS_NO_RELEVANT_RESPONSE, ZCL_COMMAND_ACK), clCancelAllLoadControlEventsInd), \
  DEFINE_COMMAND(reportEventStatusCommand,          0x00, COMMAND_OPTIONS(CLIENT_TO_SERVER, ZCL_THERE_IS_NO_RELEVANT_RESPONSE, ZCL_COMMAND_ACK), clReportEventStatusInd), \
  DEFINE_COMMAND(getScheduledEventsCommand,         0x01, COMMAND_OPTIONS(CLIENT_TO_SERVER, ZCL_THERE_IS_NO_RELEVANT_RESPONSE, ZCL_COMMAND_ACK), clGetScheduledEventsInd)




#define DEFINE_DRLC_CLUSTER_CLIENT_ATTRIBUTES() \
  DEFINE_ATTRIBUTE(utilityEnrolmentGroupAttr, ZCL_READWRITE_ATTRIBUTE, CCPU_TO_LE16(0x0000), ZCL_U8BIT_DATA_TYPE_ID),        \
  DEFINE_ATTRIBUTE(startRandomizeMinutesAttr, ZCL_READWRITE_ATTRIBUTE, CCPU_TO_LE16(0x0001), ZCL_U8BIT_DATA_TYPE_ID),        \
  DEFINE_ATTRIBUTE(endRandomizeMinutesAttr, ZCL_READWRITE_ATTRIBUTE, CCPU_TO_LE16(0x0002), ZCL_U8BIT_DATA_TYPE_ID),        \
  DEFINE_ATTRIBUTE(deviceClassValueAttr, ZCL_READONLY_ATTRIBUTE, CCPU_TO_LE16(0x0003), ZCL_16BIT_BITMAP_DATA_TYPE_ID)

#define DRLC_CLUSTER_ZCL_SERVER_CLUSTER_TYPE(clattributes, clcommands) \
  { \
    .id = DEMAND_RESPONSE_AND_LOAD_CONTROL_CLUSTER_ID, \
    .options = {.type = ZCL_SERVER_CLUSTER_TYPE, .security = ZCL_APPLICATION_LINK_KEY_CLUSTER_SECURITY}, \
    .attributesAmount = DRLC_CLUSTER_SERVER_ATTRIBUTES_AMOUNT, \
    .attributes = NULL, \
    .commandsAmount = DRLC_CLUSTER_COMMANDS_AMOUNT, \
    .commands = (uint8_t *) clcommands \
  }

#define DRLC_CLUSTER_ZCL_CLIENT_CLUSTER_TYPE(clattributes, clcommands) \
  { \
    .id = DEMAND_RESPONSE_AND_LOAD_CONTROL_CLUSTER_ID, \
    .options = {.type = ZCL_CLIENT_CLUSTER_TYPE, .security = ZCL_APPLICATION_LINK_KEY_CLUSTER_SECURITY}, \
    .attributesAmount = DRLC_CLUSTER_CLIENT_ATTRIBUTES_AMOUNT, \
    .attributes = (uint8_t *) clattributes, \
    .commandsAmount = DRLC_CLUSTER_COMMANDS_AMOUNT, \
    .commands = (uint8_t *) clcommands \
  }

#define DEFINE_DRLC_CLUSTER(cltype, clattributes, clcommands) \
  DRLC_CLUSTER_##cltype(clattributes, clcommands)

//! Signature type. AMI r15 profile spec., D.2.3.3.1.1.
#define ZCL_ECDSA_SIGNATURE_TYPE 0x01
//! Signature length. AMI r15 profile spec., D.2.3.3.1.1.
#define REPORT_EVENT_STATUS_SIGNATURE_LENGTH 42

/******************************************************************************
                    Types section
******************************************************************************/

BEGIN_PACK

/**
 * \brief Device Class type.
*/
typedef struct PACK
{
  LITTLE_ENDIAN_OCTET(8,(
    uint16_t hvacCompressor : 1,
    uint16_t stripHeaters : 1,
    uint16_t waterHeater : 1,
    uint16_t poolPump : 1,
    uint16_t smartAppliances : 1,
    uint16_t irrigationPump : 1,
    uint16_t managedCommercAndIndustrLoads : 1,
    uint16_t simpleMiscLoads : 1
  ))
  LITTLE_ENDIAN_OCTET(5,(
    uint16_t exteriorLighting : 1,
    uint16_t interiorLighting : 1,
    uint16_t electricalVehicle : 1,
    uint16_t generationSystem : 1,
    uint16_t reserved : 4
  ))
} ZCL_DeviceClass_t;

/**
 * \brief Device Class type.
*/
typedef struct PACK
{
  LITTLE_ENDIAN_OCTET(3,(
    uint8_t randStartTime : 1,
    uint8_t randEndTime : 1,
    uint8_t reserved : 6
  ))
} ZCL_EventControl_t;

/**
 * \brief The Load Control Event Command Payload.
*/
typedef struct PACK
{
  uint32_t  issuerEventId;
  ZCL_DeviceClass_t  deviceClass;
  uint8_t   utilityEnrolmentGroup;
  uint32_t  startTime;
  uint16_t  durationInMinutes;
  uint8_t   criticalityLevel;
  uint8_t   coolingTemperatureOffset;
  uint8_t   heatingTemperatureOffset;
  uint16_t  coolingTemperatureSetPoint;
  uint16_t  heatingTemperatureSetPoint;
  int8_t    avrgLoadAdjstPercentage;
  uint8_t   dutyCycle;
  ZCL_EventControl_t eventControl;
} ZCL_LoadControlEvent_t;

/**
 * \brief The Cancel Control type.
*/
typedef struct PACK
{
  LITTLE_ENDIAN_OCTET(2,(
    uint8_t randomizeEnd : 1,
    uint8_t reserved : 7
  ))
} ZCL_CancelControl_t;

/**
 * \brief The Cancel Load Control Event Command Payload.
*/
typedef struct PACK
{
  uint32_t  issuerEventId;
  ZCL_DeviceClass_t  deviceClass;
  uint8_t   utilityEnrolmentGroup;
  ZCL_CancelControl_t  cancelControl;
  ZCL_UTCTime_t  effectiveTime;
} ZCL_CancelLoadControlEvent_t;

typedef struct PACK
{
  ZCL_CancelControl_t cancelControl; // ZCL_U8BIT_BITMAP_TYPE_ID
} ZCL_CancelAllLoadControlEvents_t;

typedef struct PACK
{
  //! Utility Enrolment Group Attribute descriptor
  struct PACK
  {
    ZCL_AttributeId_t id;                         //!<Attribute Id (0x0200)
    uint8_t           type;                       //!<Attribute data type (8 bit Bitmap)
    uint8_t           properties;                 //!<Attribute properties bitmask
    uint8_t           utilityEnrolmentGroup;
  } utilityEnrolmentGroupAttr;

  //! Start Randomize Minutes Attribute descriptor
  struct PACK
  {
    ZCL_AttributeId_t id;                         //!<Attribute Id (0x0200)
    uint8_t           type;                       //!<Attribute data type (8 bit Bitmap)
    uint8_t           properties;                 //!<Attribute properties bitmask
    uint8_t           startRandomizeMinutes;
  } startRandomizeMinutesAttr;

  //! End Randomize Minutes Attribute descriptor
  struct PACK
  {
    ZCL_AttributeId_t id;                         //!<Attribute Id (0x0200)
    uint8_t           type;                       //!<Attribute data type (8 bit Bitmap)
    uint8_t           properties;                 //!<Attribute properties bitmask
    uint8_t           endRandomizeMinutes;
  } endRandomizeMinutesAttr;

  //! Device Class Value Attribute descriptor
  struct PACK
  {
    ZCL_AttributeId_t   id;                         //!<Attribute Id (0x0200)
    uint8_t             type;                       //!<Attribute data type (8 bit Bitmap)
    uint8_t             properties;                 //!<Attribute properties bitmask
    ZCL_DeviceClass_t   deviceClassValue;
  } deviceClassValueAttr;

} ZCL_DemandResponseClientClusterAttributes_t;

/**
 * \brief Report event status type.
*/
typedef struct PACK
{
  uint32_t            issuerEventId;
  uint8_t             eventStatus;
  ZCL_UTCTime_t       eventStatusTime;
  uint8_t             criticalityLevelApplied;
  uint16_t            coolingTemperatureSetPointApplied;
  uint16_t            heatingTemperatureSetPointApplied;
  int8_t              avrgLoadAdjstPercentageApplied;
  uint8_t             dutyCycleApplied;
  ZCL_EventControl_t  eventControl;
  uint8_t             signatureType;
  uint8_t             signature[REPORT_EVENT_STATUS_SIGNATURE_LENGTH];
} ZCL_ReportEventStatus_t;

/**
 * \brief Get scheduled events type.
*/
typedef struct PACK
{
  ZCL_UTCTime_t startTime;
  uint8_t       numberOfEvents;
} ZCL_GetScheduledEvents_t;

END_PACK

/**
 * \brief ZCL Demand Response Cluster Commands.
*/
typedef struct
{
  //! Load Control Event Command descriptor
  struct
  {
    ZCL_CommandId_t       id;       //!<Command Id (0x00)
    ZclCommandOptions_t   options;  //!<Command options
    /**
      \brief Command indication handler
      \param payloadLength - length of payload in cotets
      \param payload - payload
      \return none
    */
    ZCL_Status_t (*loadControlEvent)(ZCL_Addressing_t *addressing, uint8_t payloadLength, ZCL_LoadControlEvent_t *payload);
  } loadControlEventCommand;

  //! Cancel Load Control Event Command descriptor
  struct
  {
    ZCL_CommandId_t       id;       //!<Command Id (0x01)
    ZclCommandOptions_t   options;  //!<Command options
    /**
      \brief Command indication handler
      \param payloadLength - length of payload in cotets
      \param payload - payload
      \return none
    */
    ZCL_Status_t (*cancelLoadControlEvent)(ZCL_Addressing_t *addressing, uint8_t payloadLength, ZCL_CancelLoadControlEvent_t *payload);
  } cancelLoadControlEventCommand;

  //! Confirm Key Data Request Command descriptor
  struct
  {
    ZCL_CommandId_t       id;       //!<Command Id (0x02)
    ZclCommandOptions_t   options;  //!<Command options
    /**
      \brief Command indication handler
      \param payloadLength - length of payload in cotets
      \param payload - payload
      \return none
    */
    ZCL_Status_t (*cancelAllLoadControlEvents)(ZCL_Addressing_t *addressing, uint8_t payloadLength, ZCL_CancelAllLoadControlEvents_t *payload);
  } cancelAllLoadControlEventsCommand;
  //! Report Event Status Command descriptor
  struct
  {
    ZCL_CommandId_t       id;       //!<Command Id (0x01)
    ZclCommandOptions_t   options;  //!<Command options
    /**
      \brief Command indication handler
      \param payloadLength - length of payload in cotets
      \param payload - payload
      \return none
    */
    ZCL_Status_t (*reportEventStatus)(ZCL_Addressing_t *addressing, uint8_t payloadLength, ZCL_ReportEventStatus_t *payload);
  } reportEventStatusCommand;

  //! Confirm Key Data Request Command descriptor
  struct
  {
    ZCL_CommandId_t       id;       //!<Command Id (0x02)
    ZclCommandOptions_t   options;  //!<Command options
    /**
      \brief Command indication handler
      \param payloadLength - length of payload in cotets
      \param payload - payload
      \return none
    */
    ZCL_Status_t (*getScheduledEvents)(ZCL_Addressing_t *addressing, uint8_t payloadLength, ZCL_GetScheduledEvents_t *payload);
  } getScheduledEventsCommand;

} ZCL_DemandResponseAndLoadControlClusterCommands_t;

#endif /*_ZCLDEMANDRESPONSECLUSTER_H*/