Rechercher par mot-clé

Commandes ZiGate

Commun

Direction Code du message Libelle message Format du message Réponse(s)
Zigate -> Obj 0x0008 Set heartBeat enable/disable (ZiGatev2 Firm v3.20) <enable/disable : uint8_t >

0 – disable (by default)
1 – enable

Status
Zigate -> Obj 0x0009 Get Network State (Firm v3.0d) Status
Network State Response
Zigate -> Obj 0x0010 Get Version Status
Version List
Zigate -> Obj 0x0011 Reset Status, followed by chip reset
Zigate -> Obj 0x0012 Erase Persistent Data Status
Zigate -> Obj 0x0013 ZLO/ZLL “Factory New” Reset No payload Status, followed by chip reset
Resets (“Factory New”) the Control Bridge but persists the frame counters.
Zigate -> Obj 0x0014 Permit Join Status, followed by “Permit join” status response
Zigate -> Obj 0x0015 Get devices list  Get devices authentified in the ZiGate’s PDM. Status, followed by “Get devices list” response
Zigate -> Obj 0x0016 Set Time server (v3.0f) <timestamp UTC: uint32_t> from 2000-01-01 00:00:00 Status
Zigate -> Obj 0x0017 GetTime server (v3.0f) Status
Get_timer_server_response
Zigate -> Obj 0x0018 SetLed (v3.0f) <on/off : uint8_t >

0 – Off
1- On

Status
Zigate -> Obj 0x0019 Set Certification (v3.0f) <type : uint8_t >

1- CE
2- FCC

Status
Zigate -> Obj 0x0020 Set Expended PANID <64-bit Extended PAN ID:uint64_t> Status
Zigate -> Obj 0x0021 Set Channel Mask <channel mask:uint32_t> Status
Zigate -> Obj 0x0022 Set Security State + Key <key type: uint8_t> Status
<key: data>
Zigate -> Obj 0x0023 Set device Type <device type: uint8_t> Status
Device Types:
0 = Coordinator
1 = Router
Zigate -> Obj 0x0024 Start Network Status
Network Joined / Formed
Zigate -> Obj 0x0025 Start Network Scan Status
Network Joined / Formed
Zigate -> Obj 0x0026 Remove Device <Parent IEEE address: uint64_t> Status
<Child IEEE address: uint64_t> Leave indication
Zigate -> Obj 0x0027 Enable Permissions Controlled Joins <Enable/Disable : uint8_t> Status
1 – Enable
2 – Disable
Zigate -> Obj 0x0028 Authenticate Device <IEEE address ; uint64_t> Status
<Key : 16 elements byte each> Authenticate response
Zigate -> Obj 0x0029 Out of Band Commissioning Data Request <Address of interest : uint64_t> Status
<Key : 16 elements byte each> Out of Band Commissioning Data Response
Zigate -> Obj 0x002B User Descriptor Set < target short address: uint16_t> Status
< Address of interest: uint16_t> User descriptor notify response
< string length: uint8_t>
<data: uint8_t stream >
Zigate -> Obj 0x002C User Descritpor Request < target short address: uint16_t> Status
< Address of interest: uint16_t> User Descriptor response
Zigate -> Obj 0x0531 Complex Descriptor request < target short address: uint16_t> Status
< Address of interest: uint16_t> Complex Descriptor Response
Zigate -> Obj 0x0030 Bind <target extended address: uint64_t> Status
<target endpoint: uint8_t> Bind response
<cluster ID: uint16_t>
<destination address mode: uint8_t>
<destination address:uint16_t or uint64_t>
<destination endpoint (value ignored for group address): uint8_t>
Zigate -> Obj 0x0031 Unbind <target extended address: uint64_t> Status
<target endpoint: uint8_t> Unbind response
<cluster ID: uint16_t>
<destination address mode: uint8_t>
<destination address: uint16_t or uint64_t>
<destination endpoint(value ignored for group address): uint8_t>
Zigate -> Obj 0x0040 Network Address request <target short address: uint16_t> <extended address:uint64_t> Status
<request type: uint8_t> Network Address response
<start index: uint8_t>
Request Type:
0 = Single Request
1 = Extended Request
Zigate -> Obj 0x0041 IEEE Address request <target short address: uint16_t> Status
<short address: uint16_t> IEEE Address response
<request type: uint8_t>
<start index: uint8_t>
Request Type:
0 = Single
1 = Extended
Zigate -> Obj 0x0042 Node Descriptor request <target short address: uint16_t> Status
Node Descriptor response
Zigate -> Obj 0x0043 Simple Descriptor request <target short address: uint16_t> Status
<endpoint: uint8_t> Simple Descriptor response
Zigate -> Obj 0x0044 Power Descriptor request <target short address: uint16_t> Status
Power Descriptor response
Zigate -> Obj 0x0045 Active Endpoint request <target short address: uint16_t> Status
Active Endpoint response
Zigate -> Obj 0x0046 Match Descriptor request <target short address: uint16_t> Status
<profile id: uint16_t> Match Descriptor response
<number of input clusters: uint8_t>
<input cluster list:data: each entry is uint16_t >
<number of output clusters: uint8_t>
<output cluster list:data: each entry is uint16_t>
Zigate -> Obj 0x0047 Management Leave request <target short address: uint16_t> Status
<extended address: uint64_t> Management Leave response
<Rejoin: uint8_t> Leave indication
<Remove Children: uint8_t>
Rejoin,
0 = Do not rejoin
1 = Rejoin
Remove Children
0 = Leave, do not remove children
1 = Leave, removing children
Zigate -> Obj 0x0049 Permit Joining request <target short address: uint16_t> Status
<interval: uint8_t>
<TCsignificance: uint8_t>
Target address: May be address of gateway node or broadcast (0xfffc)
Interval:
0 = Disable Joining
1 – 254 = Time in seconds to allow joins
255 = Allow all joins
TCsignificance:
0 = No change in authentication
1 = Authentication policy as spec
Zigate -> Obj 0x004A Management Network Update request <target short address: uint16_t> Status
<channel mask: uint32_t> Management Network Update response
<scan duration: uint8_t>
<scan count: uint8_t>
<network update ID: uint8_t>
<network manager short address: uint16_t>
Channel Mask:
Mask of channels to scan
Scan Duration:
0 – 0xFF Multiple of superframe duration.
Scan count:
Scan repeats 0 – 5
Network Update ID:
0 – 0xFF Transaction ID for scan
Zigate -> Obj 0x004B System Server Discovery request <target short address: uint16_t> Status
<Server mask: uint16_t> System Server Discovery response
Bitmask according to spec.
Zigate -> Obj 0x004C Leave Request <extended address: uint64_t> Status
<Rejoin: uint8_t> Leave indication Leave indication (0x8048)
<Remove Children: uint8_t>
Rejoin,
0 = Do not rejoin
1 = Rejoin
Remove Children
0 = Leave, do not remove children
1 = Leave, removing children
Zigate -> Obj 0x004E Management LQI request <Target Address : uint16_t> Status
<Start Index : uint8_t> Management LQI response
Zigate -> Obj 0x0051 Free PDM internal address map table (From v.322 ZiGate+) Status
Zigate -> Obj 0x0052 Get PDM child table size (From v.322 ZiGate+) Status
PDM child table size response

Group

Zigate -> Obj 0x0060 Add Group <address mode: uint8_t> Status
<target short address: uint16_t> Add Group response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group address: uint16_t>
Zigate -> Obj 0x0061 View Group <address mode: uint8_t> Status
<target short address: uint16_t> View Group response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group address: uint16_t >
Zigate -> Obj 0x0062 Get Group Membership <address mode: uint8_t> Status
<target short address: uint16_t> Get Group Membership response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group count: uint8_t>
<group list:data>
Zigate -> Obj 0x0063 Remove Group <address mode: uint8_t> Status
<target short address: uint16_t> Remove Group response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group address: uint16_t >
Zigate -> Obj 0x0064 Remove All Groups <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
Zigate -> Obj 0x0065 Add Group if identify <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group address: uint16_t >

Identify

Zigate -> Obj 0x0070 Identify Send <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<time: uint16_t>
Time: Seconds
Zigate -> Obj 0x0071 Identify Query <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>

Action Move

Zigate -> Obj 0x0080 Move to Level <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<onoff: uint8_t>
<mode: uint8_t>
<rate: uint8_t>
Zigate -> Obj 0x0081 Move to level with/without on/off <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<onoff : uint8_t>
<Level: uint8_t >
<Transition Time: uint16_t>
Zigate -> Obj 0x0082 Move Step <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<onoff: uint8_t>
<step mode: uint8_t >
<step size: uint8_t>
<Transition Time: uint16_t>
Zigate -> Obj 0x0083 Move Stop Move <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
Zigate -> Obj 0x0084 Move Stop with On Off <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<ONOFF : uint8_t>
<Options Mask : uint8_t> (optional)
<Options Override : uint8_t> (optional)

Action ON/OFF

Zigate -> Obj 0x0092 On/Off with no effects <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<command ID: uint8_t>
Command Id
0 – Off
1 – On
2 – Toggle
Zigate -> Obj 0x0093 On / Off Timed Send <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<onoff: uint8_t>
<on time: uint16_t>
<off time: uint16_t>
On / Off:
0 = Off
1 = On
Time: Seconds
Zigate -> Obj 0x0094 On / Off with effects Send <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<effect ID: uint8_t>
<effect gradient: uint8_t>

Scenes

Zigate -> Obj 0x00A0 View Scene <address mode: uint8_t> Status
<target short address: uint16_t> View Scene response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
Zigate -> Obj 0x00A1 Add Scene <address mode: uint8_t> Status
<target short address: uint16_t> Add Scene response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<transition time: uint16_t>
<scene name length: uint8_t>
<scene name max length: uint8_t>
<scene name data: data each element is uint8_t>
Zigate -> Obj 0x00A2 Remove Scene <address mode: uint8_t> Status
<target short address: uint16_t> Remove Scene response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
Zigate -> Obj 0x00A3 Remove all scenes <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
Zigate -> Obj 0x00A4 Store Scene <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
Zigate -> Obj 0x00A5 Recall Scene <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
Zigate -> Obj 0x00A6 Scene Membership request <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
Zigate -> Obj 0x00A7 Add Enhanced Scene <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<transition time: uint16_t>
<scene name: string>
<length: uint16_t>
<max length: uint16_t>
<data: data>
Zigate -> Obj 0x00A8 View Enhanced Host->Node Scene <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
Zigate -> Obj 0x00A9 Copy Scene <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<from group ID: uint16_t>
<from scene ID: uint8_t>
<to group ID: uint16_t>
<to scene ID: uint8_t>

Action Hue

Zigate -> Obj 0x00B0 Move to Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<hue: uint8_t>
<direction: uint8_t>
<transition time: uint16_t>
Zigate -> Obj 0x00B1 Move Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<rate: uint8_t>
Zigate -> Obj 0x00B2 Step Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<step size: uint8_t>
<transition time: uint8_t>
Zigate -> Obj 0x00B3 Move to saturation <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<saturation: uint8_t>
<transition time: uint16_t>
Zigate -> Obj 0x00B4 Move saturation <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<rate: uint8_t>
Zigate -> Obj 0x00B5 Step saturation <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<step size: uint8_t>
<transition time: uint8_t>
Zigate -> Obj 0x00B6 Move to hue and saturation <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<hue: uint8_t>
<saturation: uint8_t>
<transition time: uint16_t>
Zigate -> Obj 0x00B7 Move to colour <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<colour X: uint16_t>
<colour Y: uint16_t>
<transition time: uint16_t >
Zigate -> Obj 0x00B8 Move Colour <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<colour X: int16_t>
<colour Y: int16_t>
Zigate -> Obj 0x00B9 Step Colour <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<step X: int16_t>
<step Y: int16_t>
<transition time: uint16_t >
Zigate -> Obj 0x00BA Enhanced Move to Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<direction: uint8_t>
<Enhanced Hue: uint16_t>
<transition time: uint16_t>
Zigate -> Obj 0x00BB Enhanced Move Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<rate: uint8_t>
Zigate -> Obj 0x00BC Enhanced Step Hue <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<step size: uint8_t>
<transition time: uint8_t>
Zigate -> Obj 0x00BD Enhanced Move to hue and saturation <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<enhanced hue: uint32_t>
<saturation: uint32_t>
<transition time: uint8_t>
Zigate -> Obj 0x00BE Colour Loop Set <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<update flags: uint8_t>
<action: uint8_t>
<direction: uint8_t>
<time: uint8_t>
<start hue: uint32_t>
Zigate -> Obj 0x00BF Stop Move Step <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>

Action color

Zigate -> Obj 0x00C0 Move to colour temperature <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<colour temperature: uint16_t>
<transition time: uint16_t>
Zigate -> Obj 0x00C1 Move colour temperature <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<rate: uint16_t>
<minimum temperature: uint16_t>
<maximum temperature: uint16_t>
<options mask: uint8_t>
<options override: uint8_t>
Zigate -> Obj 0x00C2 Step colour temperature <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<mode: uint8_t>
<step size: uint16_t>
<transition time: uint16_t>
<minimum temperature: uint16_t>
<maximum temperature: uint16_t>

Action Touchlink

Zigate -> Obj 0x00D0 Initiate Touchlink Status
Zigate -> Obj 0x00D2 Touch link factory reset target Status

Identify Trigger Effect

Zigate -> Obj 0x00E0 Identify Trigger Effect <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<effect ID: uint8_t>
<effect gradient: uint8_t >

Action Lock / Unlock Door

Zigate -> Obj 0x00F0 Lock / Unlock Door <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<lock/unlock: uint8_t>
0 = Lock
1 = Unlock

Windows Covering

Zigate -> Obj 0x00FA Windows covering (v3.0f only) <address mode: uint8_t> Status
<target short address: uint16_t> Data indication
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<cluster command : uint8_t>
0 = Up/Open
1 = Down/Close
2 = Stop
4 = Go To Lift Value (extra cmd : Value in cm)
5 = Go To Lift Percentage (extra cmd : percentage 0-100)
7 = Go To Tilt Value (extra cmd : Value in cm)
8 = Go To Tilt Percentage (extra cmd : percentage 0-100)
<extra command : uint8_t or uint16_t >

 

Action Attribute

Zigate -> Obj 0x0100 Read Attribute request <address mode: uint8_t> Status
<target short address: uint16_t> Read Attribute response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Cluster id: uint16_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<number of attributes: uint8_t>
<attributes list: data list of uint16_t each>
Direction:
0 – from server to client
1 – from client to server
Manufacturer specific :
0 – No 1 – Yes
Zigate -> Obj 0x0110 Write Attribute request <address mode: uint8_t> Data Indication
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Cluster id: uint16_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<number of attributes: uint8_t>
<attributes list: data list of uint16_t each>
Attribute ID : uint16_t
Attribute Type : uint8_t
Attribute Data : byte[32]
Zigate -> Obj 0x0111 Write Attribute request IAS_WD (from v3.1a) <address mode: uint8_t> Data Indication
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<Warning Mode: uint8_t>
<Warning Duration: uint16_t>
<Strobe duty cycle : uint8_t>
<Strobe level : uint8_t>
Zigate -> Obj 0x0112 Write Attribute request IAS_WD Squawk (from v3.1a) <address mode: uint8_t> Data Indication
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<SquawkModeStrobeAndLevel uint8_t>
Zigate -> Obj 0x0120 Configure Reporting request <address mode: uint8_t> Status
<target short address: uint16_t> Configure Reporting response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Cluster id: uint16_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<number of attributes: uint8_t>
<attributes list: data list of uint16_t each>
Attribute direction : uint8_t
Attribute type : uint8_t
Attribute id : uint16_t
Min interval : uint16_t
Max interval : uint16_t
Timeout : uint16_t
Change : uint8_t
Zigate -> Obj 0x0122 Read Report Config request <address mode: uint8_t> Status
<target short address: uint16_t> Read Report Config response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Cluster id: uint16_t>
<direction: uint8_t>
<NumOfAttrInRequest: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<attributes list: data list>
Attribute direction : uint8_t
Attribute enum : uint16_t
Zigate -> Obj 0x0140 Attribute Discovery request <address mode: uint8_t> Status
<target short address: uint16_t> Attribute Discovery response
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Cluster id: uint16_t>
<Attribute id : uint16_t>
<direction: uint8_t>
<manufacturer specific: uint8_t>
<manufacturer id: uint16_t>
<Max number of identifiers: uint8_t>
Direction:
0 – from server to client
1 – from client to server
Manufacturer specific :
1 – Yes
0 – No
Zigate -> Obj 0x0302 PDM loaded (From 3.1d) 0

IAS Zone

Zigate -> Obj 0x0400 IAS Zone enroll response <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<Enroll response code: uint8_t>
<Zone id : uint8_t>
Obj -> Zigate 0x8401 Zone status change notification <sequence number: uint8_t> Status
<endpoint : uint8_t>
<cluster id: uint16_t>
<src address mode: uint8_t>
<src address: uint64_t or uint16_t based on address mode>
<zone status: uint16_t>

<extended status: uint8_t>

<zone id : uint8_t>

<delay: data each element uint16_t>

Requête APS

Zigate -> Obj 0x0530 Raw APS Data Request <address mode: uint8_t> Status
<target short address: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<cluster ID: uint16_t>
<profile ID: uint16_t>
<security mode: uint8_t>
<radius: uint8_t>
<data length: uint8_t>
<data: auint8_t>

AHI Control

Zigate -> Obj 0x0806 Set TX power (v30f uniquement) <value: uint8_t> Status
Zigate -> Obj 0x0807 Get TX power (v30f uniquement) Status

Réponses

Obj -> ZiGate 0x8000 Status <status:uint8_t> All status messages will have a sequence number sent back. Default of 0 for messages which are not transmitted over the air.
<sequence number: uint8_t>
<Packet Type: uint16_t>
Status:
0 = Success
1 = Incorrect parameters
2 = Unhandled command
3 = Command failed
4 = Busy (Node is carrying out a lengthy operation and is currently unable to handle the incoming command)
5 = Stack already started (no new configuration accepted)
128 – 244 = Failed (ZigBee event codes)

for 128 (0x80) please see Extended Code (From v3.1e)

Packet Type: The value of the initiating command request.
Obj -> ZiGate 0x8001 Log message <log level: uint8_t>
<log message : string>
Log Level :
Use the Linux / Unix log levels
0 = Emergency
1 = Alert
2 = Critical
3 = Error
4 = Warning
5 = Notice
6 = Information
7 = Debug
Obj-> ZiGate 0x8002 Data indication <status: uint8_t>
<Profile ID: uint16_t>
<cluster ID: uint16_t>
<source endpoint: uint8_t>
<destination endpoint: uint8_t>
<source address mode: uint8_t>
<source address: uint16_t or uint64_t>
<destination address mode: uint8_t>
<destination address: uint16_t or uint64_t>
<payload : data each element is uint8_t>
Obj-> ZiGate 0x8003 Liste des clusters de l’objet <source endpoint: uint8_t t>
<profile ID: uint16_t>
<cluster list: data each entry is uint16_t>
Obj-> ZiGate 0x8004 Liste des attributs de l’objet <source endpoint: uint8_t>
<profile ID: uint16_t>
<cluster ID: uint16_t>
<attribute list: data each entry is uint16_t>
Obj-> ZiGate 0x8005 Liste des commandes de l’objet <source endpoint: uint8_t>
<profile ID: uint16_t>
<cluster ID: uint16_t>
<command ID list:data each entry is uint8_t>
Obj-> ZiGate 0x8006 Non “Factory new” Restart Status –
0 – STARTUP
1 – RUNNING
2 – NFN_START
The node is provisioned from previous restart.
Obj-> ZiGate 0x8007 “Factory New” Restart Status –
0 – STARTUP
2 – NFN_START
6 – RUNNING
The node is not yet provisioned.
Obj-> ZiGate 0x8008 HeartBeat <UtcTime: uint32_t>
From ZiGateV2 (v3.20)
Obj-> ZiGate 0x8009 Network State response (Firm v3.0d) <Short Address: uint16_t>
<Extended Address: uint64_t>
<PAN ID: uint16_t>
<Ext PAN ID: uint64_t>
<Channel: uint8_t>
Obj-> ZiGate 0x8011 ACK DATA (From v3.1b) <Status: uint8_t>
<Destination address: uint16_t>
<Dest Endpoint : uint8_t>
<Cluster ID : uint16_t>
Obj-> ZiGate 0x8012 DATA_CONFIRM (From v3.1e) <Status: uint8_t>
<Src Endpoint: uint8_t>
<Dest Endpoint : uint8_t>
<Dest Addr mode: uint8_t>
<Destination address: uint16_t> OR <Destination IEEE address: uint64_t>
<APS Sequence number: uint8_t>
Obj-> ZiGate 0x8010 Version list <Major version number: uint16_t>
<Installer version number: uint16_t>
Obj-> ZiGate 0x8014 “Permit join” status response <Status: bool_t>
0 – Off
1 – On
Obj-> ZiGate 0x8015 “Get devices list” response
<device list – data each entry is 13 bytes>
<ID: uint8_t>

<Short address: uint16_t>

<IEEE address: uint64_t>

<Power source: bool_t> 0 – battery 1- AC power

<LinkQuality : uint8_t> 1-255

Obj-> ZiGate 0x8017 Get Time server Response (v3.0f) <Timestamp UTC: uint32_t> from 2000-01-01 00:00:00
Obj-> ZiGate 0x8024 Network joined / formed <status: uint8_t> 0 – Success
2- Error invalid parameter. If End device tries to form network. Should not be possible with ZiGate as it is Coordinator
4- Node is on network. ZiGate is already in network so network is already format
6- Commissioning in progress. If network forming is already in progress
<short address: uint16_t>
<extended address:uint64_t>
<channel: uint8_t>
Status:
0 = Joined existing network
1 = Formed new network
128 – 244 = Failed (ZigBee event codes)
Obj-> ZiGate 0x8028 Authenticate response <IEEE address of the Gateway: uint64_t>
<Encrypted Key : uint8_t 16 elements>
<MIC : uint8 4 elements>
<IEEE address of the initiating node : uint64_t>
<Active Key Sequence number : uint8_t>
<Channel : uint8_t>
<Short PAN Id : uint16_t>
<Extended PAN ID : uint64_t>
Obj-> ZiGate 0x802B User Descriptor Notify <Sequence number: uin8_t>
<status: uint8_t>
<Network address of interest: uint16_t>
Obj-> ZiGate 0x802C User Descriptor Response <Sequence number: uin8_t>
<status: uint8_t>
<network address of interest: uint16_6>
<length: uint8_t>
<data: uint8_t stream>
Obj-> ZiGate 0x8030 Bind response <Sequence number: uint8_t>
<status: uint8_t>
<Src address mode: uint8_t> (only from v3.1a)
<Src Address : uint16_t> (only from v3.1a)
Obj-> ZiGate 0x8031 Unbind response <Sequence number: uint8_t>
<status: uint8_t>
<Src address mode: uint8_t> (only from v3.1a)
<Src Address : uint16_t> (only from v3.1a)
Obj-> ZiGate 0x8035 PDM Event (From 3.1b) <event status: uint8_t>
<record ID: uint32_t>
Status events :

E_PDM_SYSTEM_EVENT_WEAR_COUNT_TRIGGER_VALUE_REACHED=0,
E_PDM_SYSTEM_EVENT_DESCRIPTOR_SAVE_FAILED,
E_PDM_SYSTEM_EVENT_PDM_NOT_ENOUGH_SPACE,
E_PDM_SYSTEM_EVENT_LARGEST_RECORD_FULL_SAVE_NO_LONGER_POSSIBLE,
E_PDM_SYSTEM_EVENT_SEGMENT_DATA_CHECKSUM_FAIL,
E_PDM_SYSTEM_EVENT_SEGMENT_SAVE_OK,
E_PDM_SYSTEM_EVENT_EEPROM_SEGMENT_HEADER_REPAIRED,
E_PDM_SYSTEM_EVENT_SYSTEM_INTERNAL_BUFFER_WEAR_COUNT_SWAP,
E_PDM_SYSTEM_EVENT_SYSTEM_DUPLICATE_FILE_SEGMENT_DETECTED,
E_PDM_SYSTEM_EVENT_SYSTEM_ERROR,
E_PDM_SYSTEM_EVENT_SEGMENT_PREWRITE,
E_PDM_SYSTEM_EVENT_SEGMENT_POSTWRITE,
E_PDM_SYSTEM_EVENT_SEQUENCE_DUPLICATE_DETECTED,
E_PDM_SYSTEM_EVENT_SEQUENCE_VERIFY_FAIL,
E_PDM_SYSTEM_EVENT_PDM_SMART_SAVE,
E_PDM_SYSTEM_EVENT_PDM_FULL_SAVE

Obj-> ZiGate 0x8531 Complex Descriptor response <Sequence number: uin8_t>
<status: uint8_t>
<Network address of interest: uint16_t>
<Length: uint8_t>
<xml tag: uint8_t>
<field count: uint8_t>
<field values: uint8_t stream>
Obj-> ZiGate 0x8040 Network Address response <Sequence number: uin8_t>
<status: uint8_t>
<IEEE address: uint64_t>
<short address: uint16_t>
<number of associated devices: uint8_t>
<start index: uint8_t>
<device list – data each entry is uint16_t>
Obj-> ZiGate 0x8041 IEEE Address response <Sequence number: uin8_t>
<status: uint8_t>
<IEEE address: uint64_t>
<short address: uint16_t>
<number of associated devices: uint8_t>
<start index: uint8_t>
<device list – data each entry is uint16_t>
Obj-> ZiGate 0x8042 Node Descriptor response <Sequence number: uint8_t>
<Status uint8_t>
<network address: uint16_t>
<manufacturer code: uint16_t>
<max Rx Size: uint16_t>
<max Tx Size: uint16_t>
<server mask: uint16_t>
<descriptor capability: uint8_t>
<mac flags: uint8_t>
<max buffer size: uint8_t >
<bit fields: uint16_t>
Bitfields:
Logical type (bits 0-2
0 – Coordinator
1 – Router
2 – End Device)
Complex descriptor available (bit 3)
User descriptor available (bit 4)
Reserved (bit 5-7)
APS flags (bit 8-10 – currently 0)
Frequency band(11-15 set to 3 (2.4Ghz))
Server mask bits:
0 – Primary trust center
1 – Back up trust center
2 – Primary binding cache
3 – Backup binding cache
4 – Primary discovery cache
5 – Backup discovery cache
6 – Network manager
7 to15 – Reserved
MAC capability
Bit 0 – Alternate PAN Coordinator
Bit 1 – Device Type
Bit 2 – Power source
Bit 3 – Receiver On when Idle
Bit 4-5 – Reserved
Bit 6 – Security capability
Bit 7 – Allocate Address
Descriptor capability:
0 – extended Active endpoint list available
1 – Extended simple descriptor list available
2 to 7 – Reserved
Obj-> ZiGate 0x8043 Simple Descriptor response <Sequence number: uint8_t>
<status: uint8_t>
<nwkAddress: uint16_t>
<length: uint8_t>
<endpoint: uint8_t>
<profile: uint16_t>
<device id: uint16_t>
<bit fields: uint8_t >
<InClusterCount: uint8_t >
<In cluster list: data each entry is uint16_t>
<OutClusterCount: uint8_t>
<Out cluster list: data each entry is uint16_t>
Bit fields:
Device version: 4 bits (bits 0-4)
Reserved: 4 bits (bits4-7)
Obj-> ZiGate 0x8044 Power Descriptor response <Sequence number: uin8_t>
<status : uint8_t>
<bit field : uint16_t>
Bit fields
0 to 3: current power mode
4 to 7: available power source
8 to 11: current power source
12 to15: current power source level
Obj-> ZiGate 0x8045 ctive Endpoint response <Sequence number: uint8_t>
<status: uint8_t>
<Address: uint16_t>
<endpoint count: uint8_t>
<active endpoint list: each data element of the type uint8_t >
Obj-> ZiGate 0x8046 Match Descriptor response <Sequence number: uint8_t>
<status: uint8_t>
<network address: uint16_t>
<length of list: uint8_t>
<match list: data each entry is uint8_t>
Obj-> ZiGate 0x8047 Management Leave response <Sequence number: uin8_t>
<status: uint8_t>
Obj-> ZiGate 0x8048 Leave indication <extended address: uint64_t>
<rejoin status: uint8_t>
Obj-> ZiGate 0x8049 Permit joining response <join status: uint8_t>
Obj-> ZiGate 0x804A Management Network Update response <Sequence number: uint8_t>
<status: uint8_t>
<total transmission: uint16_t>
<transmission failures: uint16_t>
<scanned channels: uint32_t >
<scanned channel list count: uint8_t>
<channel list: list each element is uint8_t>
<Src Address : uint16_t> ( only from v3.1a)
Obj-> ZiGate 0x804B System Server Discovery response <Sequence number: uint8_t>
<status: uint8_t>
<Server mask: uint16_t>
Bitmask according to spec.
Obj-> ZiGate 0x804E Management LQI response <Sequence number: uint8_t>
<status: uint8_t>
<Neighbour Table Entries : uint8_t>
<Neighbour Table List Count : uint8_t>
<Start Index : uint8_t>
<List of Entries elements described below :>
Note: If Neighbour Table list count is 0, there are no elements in the list.
NWK Address : uint16_t
Extended PAN ID : uint64_t
IEEE Address : uint64_t
Depth : uint_t
Link Quality : uint8_t
Bit map of attributes Described below: uint8_t
bit 0-1 Device Type
(0-Coordinator 1-Router 2-End Device)
bit 2-3 Permit Join status
(1- On 0-Off)
bit 4-5 Relationship
(0-Parent 1-Child 2-Sibling)
bit 6-7 Rx On When Idle status
(1-On 0-Off)
<Src Address : uint16_t> ( only from v3.1a)
Obj-> ZiGate 0x8052 Get PDM child table size response (From v.322 ZiGate+) <numberofchild: uint8_t>

<table width=”1821″>
<tbody>
<tr>
<td width=”87″>Obj-&gt; ZiGate</td>
<td width=”114″>0x804B</td>
<td width=”277″>System Server Discovery response</td>
<td width=”548″>&lt;Sequence number: uint8_t&gt;</td>
<td width=”795″></td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>&lt;status: uint8_t&gt;</td>
<td></td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>&lt;Server mask: uint16_t&gt;</td>
<td></td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>Bitmask according to spec.</td>
<td></td>
</tr>
</tbody>
</table>

Réponses GROUP

 

Obj-> ZiGate 0x8060 Add Group response <Sequence number: uint8_t> Status
<endpoint: uint8_t>
<Cluster id: uint16_t>
<status: uint8_t> (added only from 3.0f version)
<Group id :uint16_t> (added only from 3.0f version)
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x8061 View Group response <Sequence number: uint8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<status: uint8_t>
<Group id :uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x8062 Get Group Membership response <Sequence number: uint8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Src Addr: uint16_t> (added only from 3.0d version)
<capacity: uint8_t>
<Group count: uint8_t>
<List of Group id: list each data item uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x8063 Remove Group response <Sequence number: uin8_t> Status
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)
<status: uint8_t>
<Group id: uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)

Réponse Level Update

Obj-> ZiGate 0x8085 Level Update (added only from 3.0f version) <Sequence number: uin8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Src addr mode: uint8_t>
<Src Addr: uint16_t>
<status: uint8_t>

Réponse ON/OFF Update

Obj-> ZiGate 0x8095 ON/OFF (added only from 3.0f version) <Sequence number: uin8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Src addr mode: uint8_t>
<Src Addr: uint16_t>
<status: uint8_t>

Réponse Scenes Update

Obj-> ZiGate 0x80A7 scenes update (added only from 3.0f version) <Sequence number: uin8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Command: uint8_t>
<Direction: uint8_t>
<Attr1: uint8_t>
<Attr2: uint8_t>
<Attr3: uint8_t>

Réponses SCENE

Obj-> ZiGate 0x80A0 View Scene response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<transition time: uint16_t>
<scene name length: uint8_t>
<scene name max length: uint8_t>
<scene name data: data each element is uint8_t>
<extensions length: uint16_t>
<extensions max length: uint16_t>
<extensions data: data each element is uint8_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x80A1 Add Scene response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x80A2 Remove Scene response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x80A3 Remove All Scene response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<group ID: uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x80A4 Store Scene response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<group ID: uint16_t>
<scene ID: uint8_t>
<Src Addr: uint16_t> (added only from 3.0f version)
Obj-> ZiGate 0x80A6 Scene Membership response <sequence number: uint8_t>
<endpoint : uint8_t>
<cluster id: uint16_t>
<status: uint8_t>
<capacity: uint8_t>
<group ID: uint16_t>
<scene count: uint8_t>
<scene list: data each element uint8_t>
<Src Addr: uint16_t> (added only from 3.0f version)

Réponses Attributs

Obj-> ZiGate 0x8100 Read individual Attribute Response <Sequence number: uint8_t>
<Src address : uint16_t>
<Endpoint: uint8_t>
<Cluster id: uint16_t>
<Attribute Enum: uint16_t>
<Attribute status: uint8_t>
<Attribute data type: uint8_t>
<Size Of the attributes in bytes: uint16_t>
<Data byte list : stream of uint8_t>
Obj-> ZiGate 0x8101 Default response <Sequence number: uint8_t>
<endpoint: uint8_t>
<Cluster id: uint16_t>
<Command Id: uint8_t>
<Status code: uint8_t>
Obj-> ZiGate 0x8102 Report Individual Attribute response <Sequence number: uint8_t>
<Src address : uint16_t>
<Endpoint: uint8_t>
<Cluster id: uint16_t>
<Attribute Enum: uint16_t>
<Attribute status: uint8_t>
<Attribute data type: uint8_t>
<Size Of the attributes in bytes: uint16_t>
<Data byte list : stream of uint8_t>
Obj-> ZiGate 0x8110 Write Attribute Response <Sequence number: uint8_t>
<Src address : uint16_t>
<Endpoint: uint8_t>
<Cluster id: uint16_t>
<Attribute Enum: uint16_t>
<Attribute status: uint8_t>
<Attribute data type: uint8_t>
<Size Of the attributes in bytes: uint16_t>
<Data byte list : stream of uint8_t>

Warning : If payload size of 0x8120 packet is greater than 7 there is an attribute enum (uint16_t) between cluster and status

Obj-> ZiGate 0x8120 Configure Reporting response <Sequence number: uint8_t>
<Src address : uint16_t>
<Endpoint: uint8_t>
<Cluster id: uint16_t>
<Attribute Enum: uint16_t> (add in v3.0f) if payload > 7
<Status: uint8_t>
Obj-> ZiGate 0x8122 Read Report Config response <Sequence number: uint8_t>
<Src address : uint16_t>
<Src Endpoint: uint8_t>
<Cluster id: uint16_t>
<Status: uint8_t>
<Attribute type : uint8_t>
<Attribute enum: uint16_t>
<Max interval : uint16_t>
<Min interval : uint16_t>
Obj-> ZiGate 0x8140 Attribute Discovery response <complete: uint8_t>
<attribute type: uint8_t>
<attribute id: uint16_t>
<Src Addr: uint16_t> (added only from 3.0f version)
<Src EndPoint: uint8_t> (added only from 3.0f version)
<Cluster id: uint16_t> (added only from 3.0f version)

Router Discover

Obj-> ZiGate 0x8701 Router Discovery Confirm <nwk status: uint8_t>
<status: uint8_t>
<Target Short address : uint16_t>

Réponses APS

Obj-> ZiGate 0x8702 APS Data Confirm Fail (FROM v3.1e) <status: uint8_t>
<src endpoint: uint8_t>
<dst endpoint: uint8_t>
<dst address mode: uint8_t>
<destination address: uint64_t>
<seq number: uint8_t>

Device Announce

Obj-> ZiGate 0x004D Device announce < short address: uint16_t>
< IEEE address: uint64_t>
< MAC capability: uint8_t>
MAC capability
Bit 0 – Alternate PAN Coordinator
Bit 1 – Device Type
Bit 2 – Power source
Bit 3 – Receiver On when Idle
Bit 4,5 – Reserved
Bit 6 – Security capability
Bit 7 – Allocate Address
<Rejoin information : uint8_t> (from v3.1b)

Extended Error

 

Obj-> ZiGate 0x9999 Extended Error (from v3.1e) < Extended Status: uint8_t>

Extended Status :

0x80 Errors below are due to resource shortage, retrying may succeed OR There are no free Network PDUs. The number of NPDUs is set in the “Number of NPDUs” property of the “PDU Manager” section of the config editor
0x81 There are no free Application PDUs. The number of APDUs is set in the “Instances” property of the appropriate “APDU” child of the “PDU Manager” section of the config editor
0x82 There are no free simultaneous data request handles. The number of handles is set in the “Maximum Number of Simultaneous Data Requests” field of the “APS layer configuration” section of the config editor
0x83 There are no free APS acknowledgement handles. The number of handles is set in the “Maximum Number of Simultaneous Data Requests with Acks” field of the “APS layer configuration” section of the config editor
0x84 There are no free fragment record handles. The number of handles is set in the “Maximum Number of Transmitted Simultaneous Fragmented Messages” field of the “APS layer configuration” section of the config editor
0x85 There are no free MCPS request descriptors. There are 8 MCPS request descriptors. These are only ever likely to be exhausted under very heavy network load or when trying to transmit too many frames too close together.
0x86 The loop back send is currently busy. There can be only one loopback request at a time.
0x87 There are no free entries in the extended address table. The extended address table is configured in the config editor
0x88 The simple descriptor does not exist for this endpoint / cluster.
0x89 A bad parameter has been found while processing an APSDE request or response
0x8a No free Routing table entries left
0x8b No free BTR entries left.

more from v3.22(ZiGate+)
0xc0 FRAME_COUNTER_ERROR
0xc1 CCM_INVALID_ERROR
0xc2 UNKNOW_SRC_ADDR
0xc3 NO_KEY_DESCRIPTOR
0xc4 NULL_KEYDESCRIPTOR
0xc5 PDUM_ERROR
0xc6 NULL_EXT_ADDR
0xc7 ENCRYPT_NULL_DESCR
0xc8 ENCRYPT_FRAME_COUNTER_FAIL
0xc9 ENCRYPT_DEFAULT
0xca FRAME_COUNTER_EXPIRED

Translate »