ZIC2410 User Guide Profile and ZigBee™ Cluster Library (ZCL) for
Contents
1. 3 1 FRAME FORMAT a SS 1 ZCL ET Format gn J me EE ee Ee See ZCL Header ZCL Payload 3 1 1 Frame Control Field Table 2 Frame Control Field Manufacturer Disable Default e Frame Type o 0 Command acts across the entire profile Command ID field has the value compliant to ZCL standard o 1 Command is specific to a cluster Command ID field has the value defined in defined cluster e Manufacturer Specific o 1 There is a Manufacturer Code in the ZCL header o 0 There is no Manufacturer Code field in the ZCL header e Direction o 1 Server to Client o 0 Client to Server e Disable Default Response o 0 Receiver sends Response Command o 1 Receiver doesn t send Response Command Rev B Document No 0005 05 08 04 001 Page 4 of 12 Z C2410 Profile and ZigBee Cluster Library 3 1 2 Manufacturer Code Field When the profile cluster and attribute defined by the manufacturer are used the Manufacturer Code provided from ZigBee Alliance should be included and the Manufacturer Specific sub field of the Frame Control field should be 1 3 1 3 Transaction Sequence Number Field The sequence number of the frame is increased by 1 for every new ZCL frame generated 3 1 4 Command ID Field Display command of frame When subfield of Frame Type is 0 value defined in standard should be included When it is 1 command defined in each cluster should be used 3 2 FRAME PAYLOAD It consists of payload of ZCL command The2. Attribute ID and command ID are defined in this range Reserved Itis a manufacturer specific application profile which a user can define 0xC000 OxFFFF In this case the Cluster ID Device ID Attribute ID and Command ID can be set as required The Profile ID of a home automation profile is 0x0104 Rev B Document No 0005 05 08 04 001 Page 6 of 12 Z C2410 Profile and ZigBee Cluster Library 4 2 ENDPOINT EndPoint has a value 1 240 set randomly when creating the profile 4 3 DEVICE ID Device ID is 16 bit field which shows the device type in the profile Table 5 Device ID Reserved In a standard profile each device ID should have a value from 0x0000 to OxBFFF A Manufacturer Specific profile can have a value from 0x0000 to OxFFFF Note For a Home Automation profile the Device ID s are defined in Table 6 Table 6 Device ID for Home Automation profile Device Group Device Description Device ID 0x0000 0x0001 0x0002 0x0003 0x0004 Generic Configuration Tool 0x0005 Remote Control 0x0006 Combined Interface 0x0007 Range Extender 0x0008 0x0009 0x0100 Dimmer Switch 0x0104 Color Dimmer Switch 0x0105 Light Sensor 0x0106 Occupancy Sensor 0x0107 Shade Shade 0x0200 Closures Shade Controller 0x0201 HVAC Lighting 0x0303 0x0306 Intruder Alarm Systems IAS Zone 0x0402 IAS Warning Device 0x0403 4 4 CLUSTER ID A cluster is responsible for data communication The size of cl
3. Switch 8 bit Action Enumera OFF tion 0x00 0x0010 0x30 ON 0x01 Toggle 0x02 Figure 5 Home Automation Profile Example 5 1 ON OFF LIGHT DEVICE e Endpoint ID Determined as a random value from 1 to 240 Figure 5 above it is set to 0x10 e Device ID Setto 0x0100 meaning an On Off Light device see Table 6 e Cluster ID Set to 0x0006 meaning an On Off cluster see Table 8 e Attribute ID The On Off Attribute is defined in the On Off cluster and is Ox0000 e Data Type and Attribute Data The On Off Attribute of the On Off cluster does not define the data type and the attribute type Instead the operation is determined by the command ID of the ZCL header The Frame Type of the ZCL Header should be set to 1 a SE 13 ZCL a Format In the example shown in Bits 8 8 O16 6 Mariable EE ee ee A ID Frame TES Control Code Sequence Number ZCL Header ZCL Payload e Command ID When the Frame Type is 1 it will be the same as the ZCL command For this type of device there are three 0x00 OFF 0x01 ON 0x02 Toggle Rev B Document No 0005 05 08 04 001 Page 11 of 12 Z C2410 Profile and ZigBee Cluster Library 5 2 ON OFF LIGHT SWITCH DEVICE e Endpoint ID Determined as a random value from 1 to 240 In the example shown in Figure 5 above it is set to 0x11 e Device ID Set to 0x0103 meaning an On Off Light Switch device see Table 6 e Cluster ID Set to 0x0007 meaning an On Off Swi
4. payload format is different based on the Command ID The following shows the payload format for the major commands 3 2 1 Read Attributes It is used to read the attribute value of a remote device Table 3 Read Attributes Octets variable 2 2 2 ZCL Header Attribute ID 1 Attribute ID 2 eel Attribute ID n 3 2 1 1 Header FrameType 0 Command ID 0x00 3 2 2 Read Attribute Response It is used when the device which receives Read aa aaa responds Octets variable variable variable Variable E attribute es attribute Ss attribute ZCL Header status record 1 status record 2 status record n 3 2 2 1 Header FrameType 0 Command ID 0x01 Rev B Document No 0005 05 08 04 001 Page 5 of 12 Z C2410 Profile and ZigBee Cluster Library 4 PROFILE A Profile is a collection of device descriptions which together form a cooperative application The Profile defines the data exchange form for the application functions of a ZigBee physical device A Profile consists of one or more EndPoints each with one or more clusters anda vertical structure of the attributes The device which requests a command sends data based on the requested application function The device which receives the data analyzes the endpoint cluster and attribute of the received packet and then performs the functions defined in the attribute Profile Endpoint DevicelD Endpoint Devicel
5. California Eastern Laboratories Z1C2410 Series Z1IC2410 User Guide Profile and ZigBee Cluster Library ZCL for the CEL ZigBee Stack 0005 05 08 04 001 Rev B Z C2410 Profile and ZigBee Cluster Library Table of Contents 1 INTRODUCTION and DURDOGSE ee EN ENKEN EEN 3 2 ZigBee2006 LAYER and FRAME STRUCTURE sseeseeeeees 3 3 ZigBee CLUSTER LIBRARY ZCL EE 4 d Ss WK RPI FORMAT WEE 4 3 1 Frame Ole 1 1a TE CT EE 4 3 1 2 Manufacturer Code Ereld sccccccceccuceecnccuccucnecencusnucnecuecuseuseneuseusneseneuseusnusneseesesenseesss 5 3 1 3 Transaction Sequence Number Field s1ccccssssccncneescnensennsneenensnecnensssenensessenanes 5 GE dE Command ID FICO SE 5 3 2 FRAME PAYLOAD EEN 5 321 Read FIDO EE 5 3 2 2 Read Attribute ReSponsSe 1 cccsssccccnescncnencccnsnssensnsnennesssennsesenensnenesssennssssonensseenssens 5 4 PROFILE eege 6 4 1 PROFILE ID WEEN 6 42 EIN CR EEN D 43 DEVICE ID BEEN D 4A SECHSTEN ee ee ee D 4 5 ATTRIBUTE ID 2 0 cece cece nents cece cece eee ee cee ee seen ene ceseeeneneneaseseaeeeaeneuseeeaeeueeneas 8 AG COMMAND ID EE 9 4 7 ATTRIBUTE DATA TYPE ID ww KN ENK KENNEN EN ENKEN EN ENKEN KKK EN EN ENKEN H 48 eh SET EEN 10 5 HOME AUTOMATION PROFILE an Example s seseneennnnenenenennnn 11 5 1 ON OFF LIGHT DEVICE 2 ccccececececececececececececececececacecucecucececucececececeees 11 5 2 ON OFF LIGHT SWITCH DEVICE ccc eeeeeeeeeeeeeeeneeenenenene
6. D Cluster Cluster eg DataType AttData Attribute DataType AttData Figure 4 the Structure of a Profile When the application layer requests a command by sending data the APS DATA reg primitive is used This primitive sets the endpoint of the remote device designated by the command and sets the Cluster ID as a parameter of the primitive In addition the data in the APS payload is sent after constructing the information as an attribute attribute data type attribute data in ZCL format The receiving device receives the APS DATA ind primitive and analyzes the endpoint first If the endpoint is O it is a command for the ZDP and the command is processed in the ZDO lf the endpoint is not 0 it is a command for the ZCL The analyzed information of the attribute is compared to its own profile by analyzing the Cluster ID parameter of the APS DATA ind and the APS Payload If it matches its own profile the corresponding attribute is controlled or its status is changed 4 1 PROFILE ID Profile ID is a unique 16 bit field assigned to each profile and used in applications As shown in Table 4 below the ID is assigned based whether it is a ZigBee standard or a manufacturer specific application profile Table 4 Profile ID The ZigBee standard application profile defined by the ZigBee Alliance 0x0000 Ox7FFF When a standard profile is used the Cluster ID Device ID
7. a should include the manufacturer code 4 6 COMMAND ID lt commands the operation of attribute in cluster and the size of it is 8 bit Standard command ID has the value from 0x00 0x7F When using manufacturer specific command full range can be used and ZCL data should include manufacturer code Table 10 Command ID Command ID OOOO o o Despi O O 0x00 0x7F Standard ZigBee command 0x80 OxFF Table 11 shows the standard cluster commands Table 11 Standard Cluster Command Command ID Name Design 0x03 Write Attribute undivided PO 0x05 Write Attribute No Response 0x06 Configure Reporing fF e eonigue Reporing Response o Read Reporting Configuration The response for Read enone 0x09 Response _ o O O E eo a 4 7 ATTRIBUTE DATA TYPE ID It determines the type of attribute data and the size is 8 bit According to this value the size of the attribute is determined Table 12 Data Type ID s Type Class Data TypeID__ Type Length Octet neS 0x00 NoDaa DL 0x08 amp bitData o General Data x09 16 bitData 2 00A Taben TI 00B 32btData ri LI Oxt8 Bhitbimap IL Bitmap 0x19 Li btmep 2 TI OXIA 4bitbimap LI a Unsigned Unsigned 8 bit integer Integer Unsigned 16 bit integer OxFFFF Rev B Document No 0005 05 08 04 001 Page 9 of 12 Z C2410 Profile and ZigBee Cluster Library Data Type ID Length Octet Unsigned 24 bit integer OxFFFFFF Unsign
8. ed 32 bit integer OxFF OxFFFF Not a Number Signed 8 bit integer Signed 16 bit integer Signed 32 bit integer Enumeration 8 bit enumeration 16 bit enumeration 0x38 Semi precision Floating point Single precision Not a Number Double precision Not a Number Octet String dee OxFF in first octet String Character String GE E OxFF in first octet Time lt E edia 4 oE N I Dee OxFFFFFFFF OxES Custer ID OxFFFF Identifier OE9 AttributeID 2 LEE i O DEA BACnet OID XRF Miscellaneous ett EE Address Lg LEET Unknown mt Unknown 0 WE 4 8 ATTRIBUTE DATA Defined as the data used in an attribute its size is determined by the attribute data type Signed Integer Signed 24 bit integer O Rev B Document No 0005 05 08 04 001 Page 10 of 12 Z C2410 Profile and ZigBee Cluster Library 5 HOME AUTOMATION PROFILE an Example Figure 5 is an example for a home automation profile which includes an On Off Light device and an On Off Light Switch device Profile Endpoint DevicelD Cluster Attribute DataType AttData Home Automati 0x10 Seat On Off _ On Off on 0x01 00 0x0006 0x0000 0x0104 On Off On Off Switch 8 bit gei Light Switch Type Enumera Toggle Switch Config tion 0x00 0x0103 0x0007 0x0000 0x30 Momentary 0x01
9. nenenenenenenenenens 12 6 REVISION HISTORY geen 12 Rev B Document No 0005 05 08 04 001 Page 2 of 12 Z C2410 Profile and ZigBee Cluster Library 1 INTRODUCTION and PURPOSE This document explains the ZigBee Cluster Library ZCL and the ZigBee Device Profile ZDP in the CEL ZigBee Stack The CEL ZigBee Stack supports the IEEE 802 15 4 and ZigBee2006 standards The CEL ZigBee Stack includes Application Program Interface API functions to support the functionality defined in the ZigBee standard and the communication functions defined in the IEEE 802 15 4 2 ZigBee2006 LAYER and FRAME STRUCTURE Figure 1 and Figure 2 show ZigBee2006 layers and frame structures for each layer ZigBee Specification ZDO Data Transfer EPO paar ES 7ieBee2006 Frame Structures Rev B Document No 0005 05 08 04 001 Page 3 of 12 Z C2410 Profile and ZigBee Cluster Library 3 ZigBee CLUSTER LIBRARY ZCL The ZCL defines the format of the Application Support Layer APS Payload ASDU when exchanging data in an application layer When sending and receiving data using the APS data primitives APS DATA reg APS DATA ind if the endpoint is 0 the data is for the ZigBee Device Profile ZDP and is processed in the ZigBee Device Object ZDO When the endpoint is not 0 data is processed in the application layer Currently the APS Payload follows the ZCL format as shown in Figure 3 and Table 1 Figure 3 Application Support Layer Structure
10. tch Config cluster see Table 8 e Attribute ID On Off Switch Config cluster defines the Switch Type Ox0000 and the Switch Action 0x0010 attribute e Data Type Two attributes in the On Off Switch Config cluster are defined as 8 bit Enumeration 0x30 types see Table 12 e Attribute Data Attribute data is also defined for each attribute in On Off Switch Config cluster The Switch type attribute can have the value of 0x00 Toggle and 0x01 Momentary The Switch action attribute can have the value of 0x00 OFF 0x01 ON 0x02 Toggle 6 REVISION HISTORY Reed 3Sep08 Released gt B_ 13Jan09 Updated Figure 1 Rev B Document No 0005 05 08 04 001 Page 12 of 12
11. uster ID is 16 bit One cluster has one or more attributes which physically execute the commands When the profile is generated a cluster is defined as an input or output with the direction not yet determined Rev B Document No 0005 05 08 04 001 Page 7 of 12 Z C2410 Profile and ZigBee Cluster Library The direction of the profile cluster is determined based on the purpose of the device established during the ZDO configuration process Table 7 Cluster ID Cluster ID fC Description 0x0000 Ox7FFF ZigBee standard cluster 0x8000 OxFBFF OxEC00 OxFEFF ee Specific Used when a required cluster is not defined as a standard The ZigBee standard clusters are defined in Table 8 ke ee 8 ZigBee Standard Clusters Functional Domain so EISES Name Basic O det o EON HVAC Measurement and sensing Security and safety 4 5 ATTRIBUTE ID An Attribute in a cluster is responsible for the special command The size of the attribute ID is 16 bit ZCL standard cluster defines an attribute based on the cluster and assigns its attribute ID Table 9 Attribute ID Attribute O OO Deeeton O O O OO Rev B Document No 0005 05 08 04 001 Page 8 of 12 Z C2410 Profile and ZigBee Cluster Library An attribute defined in the ZCL has a defined value When the profile is defined the attribute and the attribute ID should also be defined On the other hand a manufacturer specific attribute has a value of OxOO00 OxFFFF and the ZCL dat
Download Pdf Manuals
Related Search