Logo
Developing with ZBOSS for Zigbee
zb_zcl_calendar_publish_special_days_payload_s Struct Reference

#include <zb_zcl_calendar.h>

Data Fields

zb_uint32_t provider_id
 
zb_uint32_t issuer_event_id
 
zb_uint32_t issuer_calendar_id
 
zb_uint32_t start_time
 
zb_uint8_t calendar_type
 
zb_uint8_t total_number_of_special_days
 
zb_uint8_t command_index
 
zb_uint8_t total_number_of_commands
 
zb_zcl_calendar_special_day_entry_tspecial_day_entry
 
zb_uint8_t number_of_entries_in_this_command
 

Detailed Description

PublishSpecialDays command payload.

See also
SE spec, subclause D.9.2.3.5

Field Documentation

§ calendar_type

zb_uint8_t zb_zcl_calendar_publish_special_days_payload_s::calendar_type

An 8-bit enumeration identifying the type of calendar this day profile belongs to. Generation Meters shall use the ‘Received’ Calendar.

See also
zb_zcl_calendar_calendar_type_t

§ command_index

zb_uint8_t zb_zcl_calendar_publish_special_days_payload_s::command_index

The Command Index is used to count the payload fragments in the case where the entire payload does not fit into one message. The Command Index starts at 0 and is incremented for each fragment belonging to the same command.

§ issuer_calendar_id

zb_uint32_t zb_zcl_calendar_publish_special_days_payload_s::issuer_calendar_id

Unique identifier generated by the commodity Supplier. All parts of a calendar instance shall have the same Issuer Calendar ID.

§ issuer_event_id

zb_uint32_t zb_zcl_calendar_publish_special_days_payload_s::issuer_event_id

Unique identifier generated by the commodity provider. When new information is provided that replaces older information for the same time period, this field allows devices to determine which information is newer.

§ number_of_entries_in_this_command

zb_uint8_t zb_zcl_calendar_publish_special_days_payload_s::number_of_entries_in_this_command

An 8-bit integer representing the number of Special Day entries in this command

§ provider_id

zb_uint32_t zb_zcl_calendar_publish_special_days_payload_s::provider_id

An unsigned 32-bit field containing a unique identifier for the commodity provider.

§ special_day_entry

zb_zcl_calendar_special_day_entry_t* zb_zcl_calendar_publish_special_days_payload_s::special_day_entry

A SpecialDayEntry consists of the Special Day Date and a reference (Day ID Ref) to the related Day Profile entry. The dates of the Special Day Table must be arranged in ascending order.

See also
zb_zcl_calendar_special_day_entry_t

§ start_time

zb_uint32_t zb_zcl_calendar_publish_special_days_payload_s::start_time

A UTC Time field to denote the time at which the Special Day Table becomes valid. A start date/time of 0x00000000 shall indicate that the command should be executed immediately.

§ total_number_of_commands

zb_uint8_t zb_zcl_calendar_publish_special_days_payload_s::total_number_of_commands

In the case where the entire payload does not fit into one message, the Total Number of Commands field indicates the total number of sub-commands in the message.

§ total_number_of_special_days

zb_uint8_t zb_zcl_calendar_publish_special_days_payload_s::total_number_of_special_days

An 8-bit integer representing the total number of Special Day entries in this Special Day Table


The documentation for this struct was generated from the following file: