没有合适的资源？快使用搜索试试~ 我知道了~
资源详情
资源评论
Z-Stack
ZigBee Cluster Library
Application Programming Interface
Document Number: SWRA197
Texas Instruments, Inc.
San Diego, California USA
Copyright 2006-2011 Texas Instruments, Inc. All rights reserved.
Z-Stack ZCL API SWRA197 Version 1.9
i Copyright © 2006-2011 Texas Instruments, Inc. All rights reserved.
Version Description Date
1.0 Initial release 12/07/2006
1.1 Added Compile Options 03/20/2007
1.2 Updated as per latest specs (Foundation 06027r06 and General 053936r05) 05/02/2007
1.3 Updated as per latest spec (075123r01ZB) 11/28/2007
1.4 Removed Logical Cluster IDs 03/31/2009
1.5 Added Protocol Interfaces functional domain 10/26/2009
1.6 Added 11073 Protocol Tunnel Cluster 12/18/2009
1.7 Added interface to retrieve raw AF message 04/05/2010
1.8 Updated 11073 Protocol Tunnel Cluster 09/29/2010
1.9
Added Closures functional domain,
Added zclGeneral_ReadSceneCountCB(),
Removed Smart Energy specific options from Compile Options
07/18/2011
Z-Stack ZCL API SWRA197 Version 1.9
TABLE OF CONTENTS
1. INTRODUCTION..............................................................................................................................................1
1.1 PURPOSE ..........................................................................................................................................................1
1.2 SCOPE ..............................................................................................................................................................1
1.3 ACRONYMS ......................................................................................................................................................1
1.4 APPLICABLE DOCUMENTS................................................................................................................................2
2. API OVERVIEW...............................................................................................................................................2
2.1 OVERVIEW .......................................................................................................................................................2
2.2 CLIENT/SERVER MODEL ..................................................................................................................................2
2.3 STACK DIAGRAM .............................................................................................................................................3
2.4 APPLICATION/PROFILE REGISTRATION ............................................................................................................3
2.5 APPLICATION CREATION..................................................................................................................................5
3. FOUNDATION LAYER ...................................................................................................................................7
3.1 INTRODUCTION ................................................................................................................................................7
3.2 SEND COMMAND..............................................................................................................................................7
3.3 SEND READ......................................................................................................................................................8
3.4 SEND READ RESPONSE.....................................................................................................................................9
3.5 SEND WRITE ....................................................................................................................................................9
3.6 SEND WRITE UNDIVIDED ...............................................................................................................................10
3.7 SEND WRITE RESPONSE .................................................................................................................................11
3.8 SEND WRITE NO RESPONSE ...........................................................................................................................11
3.9 SEND CONFIGURE REPORTING .......................................................................................................................12
3.10 SEND CONFIGURE REPORTING RESPONSE .................................................................................................12
3.11 SEND READ REPORTING CONFIGURATION.................................................................................................13
3.12 SEND READ REPORTING CONFIGURATION RESPONSE ...............................................................................14
3.13 SEND REPORT............................................................................................................................................14
3.14 SEND DEFAULT RESPONSE ........................................................................................................................15
3.15 SEND DISCOVER........................................................................................................................................15
3.16 SEND DISCOVER RESPONSE.......................................................................................................................16
3.17 REGISTER ATTRIBUTE LIST .......................................................................................................................16
3.18 REGISTER ATTRIBUTE DATA VALIDATION CALLBACK .............................................................................17
3.19 REGISTER CLUSTER LIBRARY HANDLER CALLBACK.................................................................................17
3.20 CLUSTER LIBRARY HANDLER CALLBACK .................................................................................................18
3.21 REGISTER CLUSTER OPTION LIST..............................................................................................................18
3.22 GET THE RAW AF INCOMING MESSAGE ....................................................................................................19
4. GENERAL FUNCTIONAL DOMAIN..........................................................................................................19
4.1 INTRODUCTION ..............................................................................................................................................19
4.2 SEND RESET TO FACTORY DEFAULTS (BASIC)...............................................................................................20
4.3 SEND IDENTIFY (IDENTIFY)............................................................................................................................20
4.4 SEND IDENTIFY QUERY (IDENTIFY)................................................................................................................21
4.5 SEND IDENTIFY QUERY RESPONSE (IDENTIFY) ..............................................................................................21
4.6 SEND ADD GROUP (GROUP)...........................................................................................................................22
4.7 SEND VIEW GROUP (GROUP) .........................................................................................................................22
4.8 SEND GET GROUP MEMBERSHIP (GROUP) .....................................................................................................23
4.9 SEND REMOVE GROUP (GROUP) ....................................................................................................................23
4.10 SEND REMOVE ALL GROUPS (GROUP) ......................................................................................................24
4.11 SEND ADD GROUP IF IDENTIFYING (GROUP).............................................................................................24
4.12 SEND ADD GROUP RESPONSE (GROUP).....................................................................................................25
4.13 SEND VIEW GROUP RESPONSE (GROUP) ...................................................................................................26
4.14 SEND GET GROUP MEMBERSHIP RESPONSE (GROUP) ...............................................................................26
4.15 SEND REMOVE GROUP RESPONSE (GROUP) ..............................................................................................27
ii
Copyright © 2006-2011 Texas Instruments, Inc. All rights reserved.
Z-Stack ZCL API SWRA197 Version 1.9
4.
16
SEND ADD SCENE (SCENE)........................................................................................................................27
4.17 SEND VIEW SCENE (SCENE) ......................................................................................................................28
4.18 SEND REMOVE SCENE (SCENE) .................................................................................................................28
4.19 SEND REMOVE ALL SCENES (SCENE)........................................................................................................29
4.20 SEND STORE SCENE (SCENE).....................................................................................................................30
4.21 SEND RECALL SCENE (SCENE) ..................................................................................................................30
4.22 SEND GET SCENE MEMBERSHIP (SCENE) ..................................................................................................31
4.23 SEND ADD SCENE RESPONSE (SCENE).......................................................................................................31
4.24 SEND VIEW SCENE RESPONSE (SCENE).....................................................................................................32
4.25 SEND REMOVE SCENE RESPONSE (SCENE)................................................................................................32
4.26 SEND REMOVE ALL SCENES (SCENE)........................................................................................................33
4.27 SEND STORE SCENE (SCENE).....................................................................................................................34
4.28 SEND GET SCENE MEMBERSHIP RESPONSE (SCENE).................................................................................34
4.29 SEND OFF (ON/OFF)..................................................................................................................................35
4.30 SEND ON (ON/OFF)...................................................................................................................................35
4.31 SEND TOGGLE (ON/OFF)...........................................................................................................................36
4.32 SEND MOVE TO LEVEL (LEVEL CONTROL)................................................................................................36
4.33 SEND MOVE (LEVEL CONTROL)................................................................................................................37
4.34 SEND STEP (LEVEL CONTROL) ..................................................................................................................37
4.35 SEND RESET ALARM (ALARM)..................................................................................................................38
4.36 SEND RESET ALL ALARMS (ALARM).........................................................................................................39
4.37 SEND GET ALARM (ALARM) .....................................................................................................................39
4.38 SEND RESET ALARM LOG (ALARM)..........................................................................................................40
4.39 SEND ALARM (ALARM).............................................................................................................................40
4.40 SEND GET ALARM RESPONSE (ALARM)....................................................................................................41
4.41 SEND SET ABSOLUTE LOCATION (RSSI LOCATION)..................................................................................41
4.42 SEND SET DEVICE CONFIGURATION (RSSI LOCATION).............................................................................42
4.43 SEND GET DEVICE CONFIGURATION (RSSI LOCATION)............................................................................42
4.44 SEND GET LOCATION DATA (RSSI LOCATION).........................................................................................43
4.45 SEND DEVICE CONFIGURATION RESPONSE (RSSI LOCATION) ..................................................................43
4.46 SEND LOCATION DATA RESPONSE (RSSI LOCATION)...............................................................................44
4.47 SEND LOCATION DATA NOTIFICATION (RSSI LOCATION) ........................................................................45
4.48 SEND COMPACT LOCATION DATA NOTIFICATION (RSSI LOCATION)........................................................45
4.49 SEND RSSI PING (RSSI LOCATION)..........................................................................................................46
4.50 ATTRIBUTE DATA VALIDATION CALLBACK ..............................................................................................46
4.51 REGISTER APPLICATION COMMAND CALLBACK .......................................................................................47
4.52 RESET TO FACTORY DEFAULTS CALLBACK...............................................................................................47
4.53 IDENTIFY CALLBACK.................................................................................................................................48
4.54 IDENTIFY RESPONSE CALLBACK ...............................................................................................................48
4.55 ON/OFF/TOGGLE CALLBACK.....................................................................................................................48
4.56 MOVE TO LEVEL CALLBACK .....................................................................................................................49
4.57 MOVE CALLBACK .....................................................................................................................................49
4.58 STEP CALLBACK........................................................................................................................................50
4.59 STEP CALLBACK........................................................................................................................................50
4.60 GROUP RESPONSE CALLBACK...................................................................................................................51
4.61 STORE SCENE CALLBACK..........................................................................................................................51
4.62 RECALL SCENE CALLBACK .......................................................................................................................52
4.63 SCENE RESPONSE CALLBACK....................................................................................................................52
4.64 ALARM CALLBACK ...................................................................................................................................53
4.65 LOCATION CALLBACK...............................................................................................................................54
4.66 LOCATION RESPONSE CALLBACK..............................................................................................................54
4.67 READ SCENE COUNT CALLBACK...............................................................................................................55
5. CLOSURES FUNCTIONAL DOMAIN ........................................................................................................56
5.1 INTRODUCTION ..............................................................................................................................................56
5.2 LOCK DOOR COMMAND.................................................................................................................................56
iii
Copyright © 2006-2011 Texas Instruments, Inc. All rights reserved.
Z-Stack ZCL API SWRA197 Version 1.9
iv Copyright © 2006-2011 Texas Instruments, Inc. All rights reserved.
5.3
UNLOCK DOOR COMMAND ............................................................................................................................56
5.4 DOOR LOCK RESPONSE COMMAND................................................................................................................57
5.5 UNLOCK DOOR RESPONSE .............................................................................................................................57
5.6 UP / OPEN COMMAND (WINDOW COVERING) ................................................................................................58
5.7 DOWN / CLOSE COMMAND (WINDOW COVERING).........................................................................................58
5.8 STOP COMMAND (WINDOW COVERING).........................................................................................................59
5.9 GO TO LIFT SETPOINT COMMAND (WINDOW COVERING) ..............................................................................59
5.10 GO TO LIFT VALUE COMMAND (WINDOW COVERING).............................................................................60
5.11 GO TO LIFT PERCENTAGE COMMAND (WINDOW COVERING) ...................................................................60
5.12 GO TO TILT SETPOINT COMMAND (WINDOW COVERING) .........................................................................61
5.13 GO TO TILT VALUE COMMAND (WINDOW COVERING).............................................................................61
5.14 GO TO TILT PERCENTAGE COMMAND (WINDOW COVERING) ...................................................................62
5.15 PROGRAM SETPOINT COMMAND (WINDOW COVERING) ...........................................................................63
5.16 DOOR LOCK CALLBACK ............................................................................................................................63
5.17 DOOR LOCK RESPONSE CALLBACK...........................................................................................................64
5.18 WINDOW COVERING SIMPLE CALLBACK...................................................................................................64
5.19 WINDOW COVERING GO TO PERCENTAGE CALLBACK..............................................................................64
5.20 WINDOW COVERING GO TO VALUE CALLBACK........................................................................................65
5.21 WINDOW COVERING GO TO SETPOINT CALLBACK ...................................................................................65
5.22 WINDOW COVERING PROGRAM SETPOINT CALLBACK..............................................................................65
6. PROTOCOL INTERFACES FUNCTIONAL DOMAIN.............................................................................66
6.1 INTRODUCTION ..............................................................................................................................................66
6.2 SEND MATCH PROTOCOL ADDRESS COMMAND (GENERIC TUNNEL) .............................................................67
6.3 SEND MATCH PROTOCOL ADDRESS RESPONSE (GENERIC TUNNEL) ..............................................................68
6.4 SEND ADVERTISE PROTOCOL ADDRESS COMMAND (GENERIC TUNNEL) .......................................................68
6.5 SEND BACNET TRANSFER NPDU COMMAND (BACNET PROTOCOL TUNNEL)..............................................69
6.6 SEND 11073 TRANSFER APDU COMMAND (11073 PROTOCOL TUNNEL).......................................................70
6.7 SEND 11073 CONNECT REQUEST COMMAND (11073 PROTOCOL TUNNEL)....................................................70
6.8 SEND 11073 DISCONNECT REQUEST COMMAND (11073 PROTOCOL TUNNEL)...............................................71
6.9 SEND 11073 CONNECT STATUS NOTIFICATION COMMAND (11073 PROTOCOL TUNNEL) ..............................72
6.10 REGISTER APPLICATION COMMAND CALLBACKS......................................................................................72
6.11 MATCH PROTOCOL ADDRESS CALLBACK .................................................................................................73
6.12 MATCH PROTOCOL ADDRESS RESPONSE CALLBACK ................................................................................73
6.13 ADVERTISE PROTOCOL ADDRESS CALLBACK ...........................................................................................74
6.14 BACNET TRANSFER NPDU CALLBACK ....................................................................................................74
6.15 11073 TRANSFER APDU CALLBACK ........................................................................................................75
6.16 11073 CONNECT REQUEST CALLBACK......................................................................................................75
6.17 11073 DISCONNECT REQUEST CALLBACK ................................................................................................76
6.18 11073 CONNECT STATUS NOTIFICATION CALLBACK ................................................................................76
7. COMPILE OPTIONS......................................................................................................................................77
L
IST OF FIGURES
FIGURE 1: STACK DIAGRAM...........................................................................................................................................3
剩余82页未读，继续阅读
安全验证
文档复制为VIP权益，开通VIP直接复制
信息提交成功
评论0
最新资源