Developing with ZBOSS for Zigbee
Time cluster attributes

Macros

#define ZB_ZCL_TIME_TIME_STATUS_MASTER_BIT_IS_SET(val)   ((val) & (1 << ZB_ZCL_TIME_MASTER))
 
#define ZB_ZCL_TIME_TIME_STATUS_SYNCHRONIZED_BIT_IS_SET(val)   ((val) & (1 << ZB_ZCL_TIME_SYNCHRONIZED))
 
#define ZB_ZCL_TIME_TIME_STATUS_MASTER_ZONE_DST_BIT_IS_SET(val)   ((val) & (1 << ZB_ZCL_TIME_MASTER_ZONE_DST))
 
#define ZB_ZCL_TIME_TIME_STATUS_SUPERSEDING_BIT_IS_SET(val)   ((val) & (1 << ZB_ZCL_TIME_SUPERSEDING))
 
#define ZB_ZCL_TIME_TIME_INVALID_VALUE   ((zb_time_t)0xFFFFFFFF)
 Invalid value of Time attribute.
 
#define ZB_ZCL_TIME_TIME_DEFAULT_VALUE   ZB_ZCL_TIME_TIME_INVALID_VALUE
 Default value for Time attribute.
 
#define ZB_ZCL_TIME_TIME_MIN_VALUE   ((zb_time_t)0x0)
 Minimum value for Time attribute.
 
#define ZB_ZCL_TIME_TIME_MAX_VALUE   ((zb_time_t)0xFFFFFFFE)
 Maximum value for Time attribute.
 
#define ZB_ZCL_TIME_TIME_STATUS_DEFAULT_VALUE   0x00
 Default value for Time Status attribute.
 
#define ZB_ZCL_TIME_TIME_ZONE_DEFAULT_VALUE   0x00000000
 Default value for Time Zone attribute.
 
#define ZB_ZCL_TIME_DST_START_DEFAULT_VALUE   ((zb_uint32_t)0xFFFFFFFF)
 Default value for DstStart attribute.
 
#define ZB_ZCL_TIME_DST_END_DEFAULT_VALUE   ((zb_uint32_t)0xFFFFFFFF)
 Default value for DstEnd attribute.
 
#define ZB_ZCL_TIME_DST_SHIFT_DEFAULT_VALUE   0x00000000
 Default value for Dst Shift attribute.
 
#define ZB_ZCL_TIME_STANDARD_TIME_DEFAULT_VALUE   ((zb_uint32_t)0xFFFFFFFF)
 Default value for StandardTime attribute.
 
#define ZB_ZCL_TIME_LOCAL_TIME_DEFAULT_VALUE   ((zb_uint32_t)0xFFFFFFFF)
 Default value for LocalTime attribute.
 
#define ZB_ZCL_TIME_LAST_SET_TIME_DEFAULT_VALUE   0xffffffff
 Default value for Last Set Time attribute.
 
#define ZB_ZCL_TIME_VALID_UNTIL_TIME_DEFAULT_VALUE   0xffffffff
 Default value for Valid Until Time attribute.
 
#define ZB_ZCL_DECLARE_TIME_ATTRIB_LIST(attr_list, time, time_status, time_zone, dst_start, dst_end, dst_shift, standard_time, local_time, last_set_time, valid_until_time)
 Declare attribute list for Time cluster. More...
 

Enumerations

enum  zb_zcl_time_attr_e {
  ZB_ZCL_ATTR_TIME_TIME_ID = 0x0000, ZB_ZCL_ATTR_TIME_TIME_STATUS_ID = 0x0001, ZB_ZCL_ATTR_TIME_TIME_ZONE_ID = 0x0002, ZB_ZCL_ATTR_TIME_DST_START_ID = 0x0003,
  ZB_ZCL_ATTR_TIME_DST_END_ID = 0x0004, ZB_ZCL_ATTR_TIME_DST_SHIFT_ID = 0x0005, ZB_ZCL_ATTR_TIME_STANDARD_TIME_ID = 0x0006, ZB_ZCL_ATTR_TIME_LOCAL_TIME_ID = 0x0007,
  ZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID = 0x0008, ZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID = 0x0009
}
 Time cluster attribute identifiers. More...
 
enum  zb_zcl_time_time_status_e { ZB_ZCL_TIME_MASTER = 0, ZB_ZCL_TIME_SYNCHRONIZED = 1, ZB_ZCL_TIME_MASTER_ZONE_DST = 2, ZB_ZCL_TIME_SUPERSEDING = 3 }
 Permissible values for Time Status attribute,. More...
 

Detailed Description

Macro Definition Documentation

◆ ZB_ZCL_DECLARE_TIME_ATTRIB_LIST

#define ZB_ZCL_DECLARE_TIME_ATTRIB_LIST (   attr_list,
  time,
  time_status,
  time_zone,
  dst_start,
  dst_end,
  dst_shift,
  standard_time,
  local_time,
  last_set_time,
  valid_until_time 
)
Value:
ZB_ZCL_START_DECLARE_ATTRIB_LIST(attr_list) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_TIME_ID, (time)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_TIME_STATUS_ID, (time_status)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_TIME_ZONE_ID, (time_zone)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_DST_START_ID, (dst_start)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_DST_END_ID, (dst_end)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_DST_SHIFT_ID, (dst_shift)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_STANDARD_TIME_ID, (standard_time)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_LOCAL_TIME_ID, (local_time)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID, (last_set_time)) \
ZB_ZCL_SET_ATTR_DESC(ZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID, (valid_until_time)) \
ZB_ZCL_FINISH_DECLARE_ATTRIB_LIST

Declare attribute list for Time cluster.

Parameters
attr_list- attribute list name
time- pointer to variable to store Time attribute value
time_status- pointer to variable to store Time Status attribute value
time_zone- pointer to variable to store Time Zone attribute value
dst_start- pointer to variable to store Dst Start attribute value
dst_end- pointer to variable to store Dst End attribute value
dst_shift- pointer to variable to store Dst Shift attribute value
standard_time- pointer to variable to store Standard Time attribute value
local_time- pointer to variable to store Local Time attribute value
last_set_time- pointer to variable to store Last Set Time attribute value
valid_until_time- pointer to variable to store Valid Until Time attribute value

◆ ZB_ZCL_TIME_TIME_STATUS_MASTER_BIT_IS_SET

#define ZB_ZCL_TIME_TIME_STATUS_MASTER_BIT_IS_SET (   val)    ((val) & (1 << ZB_ZCL_TIME_MASTER))

Check if Master bit of TimeStatus attribute is set.

Parameters
val- 8-bit that contains value of TimeStatus attribute
Returns
zb_uint8_t value greater then 0 if Master bit is set, and return 0 otherwise.
See also
zb_zcl_time_time_status_e

◆ ZB_ZCL_TIME_TIME_STATUS_MASTER_ZONE_DST_BIT_IS_SET

#define ZB_ZCL_TIME_TIME_STATUS_MASTER_ZONE_DST_BIT_IS_SET (   val)    ((val) & (1 << ZB_ZCL_TIME_MASTER_ZONE_DST))

Check if MasterZoneDST bit of TimeStatus attribute is set.

Parameters
val- 8-bit that contains value of TimeStatus attribute
Returns
zb_uint8_t value greater then 0 if MasterZoneDST bit is set, and return 0 otherwise.
See also
zb_zcl_time_time_status_e

◆ ZB_ZCL_TIME_TIME_STATUS_SUPERSEDING_BIT_IS_SET

#define ZB_ZCL_TIME_TIME_STATUS_SUPERSEDING_BIT_IS_SET (   val)    ((val) & (1 << ZB_ZCL_TIME_SUPERSEDING))

Check if Superseding bit of TimeStatus attribute is set.

Parameters
val- 8-bit that contains value of TimeStatus attribute
Returns
zb_uint8_t value greater then 0 if Superseding bit is set, and return 0 otherwise.
See also
zb_zcl_time_time_status_e

◆ ZB_ZCL_TIME_TIME_STATUS_SYNCHRONIZED_BIT_IS_SET

#define ZB_ZCL_TIME_TIME_STATUS_SYNCHRONIZED_BIT_IS_SET (   val)    ((val) & (1 << ZB_ZCL_TIME_SYNCHRONIZED))

Check if Synchronized bit of TimeStatus attribute is set.

Parameters
val- 8-bit that contains value of TimeStatus attribute
Returns
zb_uint8_t value greater then 0 if Synchronized bit is set, and return 0 otherwise.
See also
zb_zcl_time_time_status_e

Enumeration Type Documentation

◆ zb_zcl_time_attr_e

Time cluster attribute identifiers.

See also
ZCL spec, subclause 3.12.2.2
Enumerator
ZB_ZCL_ATTR_TIME_TIME_ID 

Time attribute.

ZB_ZCL_ATTR_TIME_TIME_STATUS_ID 

Time Status attribute.

ZB_ZCL_ATTR_TIME_TIME_ZONE_ID 

Time Zone attribute.

ZB_ZCL_ATTR_TIME_DST_START_ID 

Dst Start attribute.

ZB_ZCL_ATTR_TIME_DST_END_ID 

Dst End attribute.

ZB_ZCL_ATTR_TIME_DST_SHIFT_ID 

Dst Shift attribute.

ZB_ZCL_ATTR_TIME_STANDARD_TIME_ID 

Standard Time attribute.

ZB_ZCL_ATTR_TIME_LOCAL_TIME_ID 

Local Time attribute.

ZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID 

Last Set Time attribute.

ZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID 

Valid Until Time attribute.

◆ zb_zcl_time_time_status_e

Permissible values for Time Status attribute,.

See also
ZCL spec, subclause 3.12.2.2.2
Enumerator
ZB_ZCL_TIME_MASTER 

Master value

ZB_ZCL_TIME_SYNCHRONIZED 

Synchronized value

ZB_ZCL_TIME_MASTER_ZONE_DST 

Master Zone Dst value

ZB_ZCL_TIME_SUPERSEDING 

Superseding value

ZB_ZCL_ATTR_TIME_DST_END_ID
@ ZB_ZCL_ATTR_TIME_DST_END_ID
Dst End attribute.
Definition: zb_zcl_time.h:153
ZB_ZCL_ATTR_TIME_DST_START_ID
@ ZB_ZCL_ATTR_TIME_DST_START_ID
Dst Start attribute.
Definition: zb_zcl_time.h:151
ZB_ZCL_ATTR_TIME_TIME_ID
@ ZB_ZCL_ATTR_TIME_TIME_ID
Time attribute.
Definition: zb_zcl_time.h:145
ZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID
@ ZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID
Last Set Time attribute.
Definition: zb_zcl_time.h:161
ZB_ZCL_ATTR_TIME_TIME_STATUS_ID
@ ZB_ZCL_ATTR_TIME_TIME_STATUS_ID
Time Status attribute.
Definition: zb_zcl_time.h:147
ZB_ZCL_ATTR_TIME_LOCAL_TIME_ID
@ ZB_ZCL_ATTR_TIME_LOCAL_TIME_ID
Local Time attribute.
Definition: zb_zcl_time.h:159
ZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID
@ ZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID
Valid Until Time attribute.
Definition: zb_zcl_time.h:163
ZB_ZCL_ATTR_TIME_TIME_ZONE_ID
@ ZB_ZCL_ATTR_TIME_TIME_ZONE_ID
Time Zone attribute.
Definition: zb_zcl_time.h:149
ZB_ZCL_ATTR_TIME_DST_SHIFT_ID
@ ZB_ZCL_ATTR_TIME_DST_SHIFT_ID
Dst Shift attribute.
Definition: zb_zcl_time.h:155
ZB_ZCL_ATTR_TIME_STANDARD_TIME_ID
@ ZB_ZCL_ATTR_TIME_STANDARD_TIME_ID
Standard Time attribute.
Definition: zb_zcl_time.h:157