4.2 Zigbee Console Commands

activeEpReq < DstAddr > < nwkAddrOfInterest >

e.g.: activeEpReq 0x7766 0x7766

This console command requests the list of all active endpoints on a

remote device.

Here the DstAddr is the short / network address of the remote device to which Active_EP_req command (ClusterID=0x0005) will be send.

nwkAddrOfInterest is the short address of the remote device for which the active endpoint list is required.

This activeEpReq should be a unicast to the remote device itself or to an alternative device that contains the discovery information of the remote device

bindReq <addrMode> < DstAddr > < extDstAddrHigh > < extDstAddrLow > < ClusterId >

BindRsp 0

This console command requests a remote node to insert an entry to its binding table.

Here addrMode specifies the format of DstAddr.

Refer Address Mode table for more details.

DstAddr is the short address of the remote device.

extDstAddrHigh & extDstAddrLow is the extended address of the destination device.

ep is the destination endpoint for the binding entry.

ClusterId is the cluster on the source device that is bound to the destination.

bindReq2 < addrMode> < DstAddr > < extSrcAddrHigh > < extDstAddrHigh> < extDstAddrLow / GroupID> < ep_Src > < ep_Dst > < ClusterId >

BindRsp 0

This console command requests a remote node to insert an entry to its binding table.

Here addrMode specifies the format of DstAddr.

DstAddr is the short address of the remote device.

extSrcAddrHigh & extSrcAddrLow is the extended address of the source device. extDstAddrHigh & extSrcAddrLow is the extended address of the destination device.

Refer Address Mode table for more details.

ep_Src is the source endpoint for the binding entry.

ep_Dst is the destination endpoint for the binding entry.

ClusterId is the cluster on the source device that is bound to the destination.

ieeeAddrReq < dstAddr > < nwkAddOfInt > < reqType >

example: ieeeAddrReq 0x7011 0x7011 0

This console command requests the IEEE (extended) address of a remote node with a given short (network) address.

dstAddr is the short address of the remote device to which IEEE_addr_req command (ClusterID=0x0001) will be send.

nwkAddOfInt is the short address of the remote device for which the extended address (IEEE address) is required.

reqType is Request type for this command.

0 - SINGLE_RESPONSE_REQUESTTYPE - Only the address of the target device is requested

1 - EXTENDED_RESPONSE_REQUESTTYPE - Address of all target's child nodes (only end devices) are also requested.

macBanNode < extAddrHigh > < extAddrLow > < shortAddr > < cost > < rssi >

example: macBanNode 0xaabbccdd 0x11223344 0x7011 0xFF -100

This console command bans any frame from the node or correct link cost for all the frames.

extAddrHigh & extAddrLow - extended address of the node affected.

shortAddr - short address of the node affected. If the short address of banned node is unknown then pass 0xFFFE (MAC_NO_SHORT_ADDR).

cost - link cost value for all the frames received from the node. If node shall be baned - use link cost value 0xFF (LINK_COST_VALUE_NODE_BANNED).

macResetBanTable

example: macResetBanTable

Done

This console command reset the ban table and reloads from the config server.

matchDescReq < nwkAddr > < srcEp >

example: matchDescReq 0xFFFD 0x20

This Command launches a search for devices that have endpoints supporting at least one of the specified clusters.

nwkAddr: is the short / network address of the remote device to which Match_Desc_req command (ClusterID=0x0006) will be send.

srcEp is the endpoint to be found.

Here 0xFFFD is the broadcast address of the device which have rx on idle enabled. (RX_ON_WHEN_IDLE_ADDR)

NodeDescReq < dstnwkAddr > < nwkAddrOfInt >

example: NodeDescReq 0xb389 0xb389

This console command requests the node descriptor of a remote device. (Node descriptor contains information about the capabilities of the ZigBee node)

dstnwkAddr is the short address of the remote device to which Node_Desc_req command (ClusterID=0x0001) will be send.

nwkAddrOfInt is the short address of the remote device or to an alternative device for which the node descriptor is required.

nwkAddrReq < dstAddr > < ieeeAddOfIntHigh > < ieeeAddOfIntLow > < reqType >

nwkAddrReq 0xb670 0xaabbccdd 0x1223344 0

This console command requests the short address (network address) of a remote node with a given Extended address (IEEE address).

dstAddr is the short address of the remote device to which NWK_addr_req command (ClusterID=0x0000) will be send.

ieeeAddOfIntHigh & ieeeAddOfIntLow is the extended (IEEE) address to be matched by the Remote

Device.

reqType is Request type for this command.

0 - SINGLE_RESPONSE_REQUESTTYPE - Only the address of the target device is requested

1 - EXTENDED_RESPONSE_REQUESTTYPE - Addresses of all target's child nodes (only end devices) are also requested.

sendBeaconReq

example: sendBeaconReq

This console command sends a beacon request. All other coordinators and routers will respond with a beacon.

sendMgmtBindReq < address > < startIndex >

example: sendMgmtBindReq 0x2de0 0

MgmtBindRsp 0

This console command retrieves the content of the binding table from a remote device.

address is the short address of the remote device to which Mgmt_Bind_req command (ClusterID=0x0033) will be send.

startIndex is the starting Index for the requested elements of the Binding Table.

Here MgmtBindRsp 0 indicate success response.

sendMgmtLeaveReq < dstShortAddr > < devExtAddrHigh > < devExtAddrLow > < rejoin > < removeChildren >

example: sendMgmtLeaveReq 0xd108 0xaabbccdd 0x11223344 0 1

LeaveRsp 0

This console command requests network leave either for a current device or a remote device.

dstShortAddr is the short address of the remote device to which Mgmt_Leave_req command (ClusterID=0x0034) will be send.

devExtAddrHigh & devExtAddrLow is the extended address of the device that should leave the network.

rejoin = 1: the device being asked to leave from the current parent is requested to rejoin the network.

rejoin = 0: the device being asked to leave will not rejoin the network.

removeChildren = 1: the device being asked to leave the network is also being asked to remove its child devices. Otherwise, it has a value of 0.

Here LeaveRsp 0 indicate success response.

sendMgmtLqiReq < address > < startIndex >

example: sendMgmtLqiReq 0xd108 0

MgmtLqiRsp 0

This console command obtains the list of a remote device’s neighbors,

along with corresponding LQI values.

address: is the short address of remote device to which Mgmt_Lqi_req command (ClusterID=0x0031) will be send.

startIndex: is the Starting Index for the requested elements of the Neighbor Table

sendMgmtPermitJoin < dstAddr > < dur > < tcSig >

example: sendMgmtPermitJoin 0xd108 60 0

setPermitJoinRsp 0

This console command configures the target node to allow other nodes to enter the network via MAC association (joining the network for the first time) through this node.

dstAddr: is the short address of remote device to which Mgmt_Permit_Joining_req command (ClusterID=0x0036) will be send.

dur: is time span in seconds during which the ZigBee coordinator or router will allow associations. The value 0x00 or 0xff indicate that permission is disabled or enabled permanently, respectively.

tcSig = 1: indicating a request to change the Trust Center policy

sendNwkMgmtUpdateReq < channel > < scanDuration > < nwkAddr >

example: sendNwkMgmtUpdateReq 20 0xfe 0xd108

Update Done

This console command sends a remote device about the update of network configuration parameters such as channel, Scan duration,network address etc.

Channel: indicate which channels are to be scanned.

scanDuration = 0 to 5: (ZDO_MGMT_ED_SCAN_DUR_0 to ZDO_MGMT_ED_SCAN_DUR_5)request to perform an ED scan with duration depending exponentially on the parameter value.

scanDuration = 0xFE: request to change the working channel.

scanDuration = 0xFF: request to change the device scanChannels and nwkManagerAddr values to those contained in the request.

nwkAddr: is the short address of remote device to which Mgmt_NWK_Update_req command (ClusterID=0x0038) will be send.

The example shows the sendNwkMgmtUpdateReq command which request remote device 0xd108 to change the channel.

simpleDescReq < nwkAddr > < dstEp >

example: simpleDescReq 0xb670 0x23

This console command requests the simple descriptor of the specified endpoint on a remote node. The simple descriptor contains information specific to each endpoint contained in that node.

nwkAddr: is the short address of remote device to which Simple_Desc_req (ClusterID=0x0004) will be send.

dstEp: The endpoint on the destination.

unbindReq <addrMode> < DstAddr > < extDstAddrHigh > < extDstAddrLow > < ep > < ClusterId >

UnBindRsp 0

Requests a remote node to remove an entry from its binding table with the specified сlusterID, source and destination endpoint and extended address.

Here addrMode specifies the format of DstAddr.

Refer Address Mode table for more details.

DstAddr: is the short address of the remote device.

extDstAddrHigh & extDstAddrLow: is the extended address of the destination device.

ep: is the destination endpoint for the binding entry.

ClusterId: is the cluster on the source device that is bound to the destination.

unbindReq2 < addrMode> < DstAddr > < extSrcAddrHigh > < extDstAddrHigh> < extDstAddrLow / GroupID> < ep_Src > < ep_Dst > < ClusterId >

UnBindRsp 0

Requests a remote node to remove an entry from its binding table with the specified сlusterID, source and destination endpoint and extended address.

Here addrMode specifies the format of DstAddr. Refer Address Mode table for more details.

DstAddr: is the short address of the remote device.

extSrcAddrHigh & extSrcAddrLow: is the extended address of the source device.

extDstAddrHigh & extDstAddrLow: is the extended address of the destination device.

ep_Src: is the source endpoint for the binding entry.

ep_Dst: is the destination endpoint for the binding entry.

ClusterId: is the cluster on the source device that is bound to the destination.

Set as target(1)/initiator(0)

Sends the Get Group Membership command.(count)specifies how many group IDs following it should be considered, but five values must be provided as group IDs always.

Sends the Identify command to the specified node(s)

Sends the Identify Query command

Sends trigger effect command

Sends the Addr Group command to the specified node(s).

Sends the Addr Group If Identifying command(s).

Sends the Remove Group command to the specified node(s).

Sends the View Group command t

reset the target to factory new

Sends the Add Scene command

Sends the View Scene command

Sends the Remove Scene command

Sends the Remove All Scene command

Sends the Store Scene command

Sends the Recall Scene command

Sends the Store Scene command

Sends the Get Scene Membership command

Turn the specified light device(s) on or off

Sends off with effect command

Sends on the Recall Global scene command

Sends on with timed off

Send the Move to level (with On/Off) command

Send the Move (with On/Off) command

Send the Step (with On/Off) command

Send the Stop (with On/Off) command

IASACEArmCommand <addrMode> <addr> <ep> <ArmMode> <Arm/Code> <Zone/Id>

Sends IAS ACE Arm command to the CI(CIE) along with Arm mode with its code to the zoneId

IASACEBypassCommand <addrMode> <addr> <ep> <zone_numbers> <zone_id1> <zone_id2> <zone_id3> <arm_code_code>

Sends IAS ACE Bypass command with the listof zoneIds along with the code to the CI (CIE)

IASACEEmergencyCommand <addrMode> <addr> <ep>

Sends IAS ACE Emergency command to the CI (CIE)

IASACEFireCommand <addrMode> <addr> <ep>

Sends IAS ACE Fire command to the CI (CIE)

IASACEPanicCommand <addrMode> <addr> <ep>

Sends IAS ACE Panic command to the CI (CIE)

IASACEGetZoneIdMapCommand <addrMode> <addr> <ep>

Sends IAS ACE Get Zone Id Map command to the CI (CIE)

IASACEGetZoneIdInformationCommand <addrMode> <addr> <ep> <zone_id>

Sends IAS ACE Get Zone Information Command to get the complete information of the zoneId

IASACEGetPanelStatusCommand <addrMode> <addr> <ep>

Sends IAS ACE Get Panel Status command to the CI(CIE) to get the Panel's status

IASACEGetZoneStatusCommand <addrMode> <addr> <ep> <starting_zone_id> <max_number_zoneids> <zonestatus_maskflag> <zonestatus_mask>

Sends IAS ACE Get Zone Status Command to get the Zone status. The command would list the starting zoneId with the maximum number to read from there

ZoneEnrollReqCmd <addrMode> <addr> <ep> <zone_type> <manuf_code>

Sends IAS Zone Enroll Request Command to the CI (CIE) as part of Zone Enrollment

ZoneStatusChangeNotifiCmd <addrMode> <addr> <ep> <zonestatus> <ext_status>

Sends IAS Zone Status Change. a notification to the CI(CIE)

ZoneStatusChange <Device_Spec_Bits>

To change the internal zone status to trigger a change notification to the CI(CIE)

GetByPassZoneList <addrMode> <addr> <ep>

Sends IAS ACE GetByPassZone list which were already bypassed and part of the bypass table

setOccupancy <0- UnOccupied/ 1- Occupied>

Sets the Occupancy State either to Occupied / Unoccupied

clusterAttrInitDefault <ClusterID>

Inititalizes all Attributes to default value

setOccupancyState <state>

Sets the Occupancy state to either Occupied or Unoccupied

setOccupancySensorType <sensorType>

Sets the Occupancy Sensor Type

triggerAlarm <ClusterId> <alarmCode> <Raise/Clear>

Triggers Alarm either to Raise / Clear with the Alarm Code

setAlarmMask <ClusterId> <alarmMask>

Sets the Alarmmask

resetAlarms

Resets the alarm

Read reporting from specified cluster server

thermSetPointChange <addrMode> <addr> <ep> <setPtmode> <amount>

Sends thermostat Set Point Change Command along with the mode and amount

setUTCTime <dd:mm:yr:hr:min:sec>

Sets the UTC time

readTime

Reads the current time

setTimeZoneAndDST <timeZone> <dstStart> <dstEnd> <dstShift>

Sets the time zone and DST

Sets the time status of the device

resets the alarm with its code

alarmCmd <addrMode> <addr> <ep> <resetAllAlarm/getAlarm/resetAlarmLog>

Alarm Command which could be resetAllAlarm/getAlarm/resetAlarmLog

Sends Panel Status Changed Command to the Ace device with its status and seconds remaining for the change with actions to be taken w.r.t alarmstatus and its audible notification

Sends Zone status Changed command to the Ace device with its status along with audible details and zone label

Sends to initiate Normal Operating mode at the Ace device

Sends to initiate Test operating Mode at the Ace device with its duration for the same with its current zone sensitivity level

readAttribute < addrMode > < addr > < ep > < clusterId > < attrId >

e.g.: readAttribute -s 0x24b8 0x23 0x0006 0x0000

Attribute operation response received: status = 0x00

<-Read attribute (AttrId:0x0) response: success, Attr value = 0

This console command read value of specified attribute on specified cluster from remote device using.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the read attribute zcl command (ZCL_READ_ATTRIBUTES_COMMAND_ID) to be send.

ep: The endpoint on the remote device that is to be read.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be read.

attrId: Attribute ID of the Attribute that need to be read.

Here in example command, -s indicate that address mode is short address, 0x24b8 is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x00 is the attributeID for OnOff attribute

writeAttribute < addrMode > < addr > < ep > < clusterId > < attrId > < type > < attrValue1,2.. > < attrSize >

example: writeAttribute -s 0x24b8 0x23 0x0006 0x4001 0x21 0x01 0x02

Attribute operation response received: status = 0x00

<-Write attribute response: success

This console command sends Write Attribute command for specified attribute and cluster to a remote device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the writes attribute zcl command to be send (ZCL_WRITE_ATTRIBUTES_COMMAND_ID).

ep: The endpoint on the remote device that is to be written.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be written.

attrId: Attribute ID of the Attribute that need to be written.

type: Attribute Type

attrValue: attribute value that need to be written

attrSize: Size of the attribute data

Here in example command, -s indicate that address mode is short address, 0x24b8 is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x4001 is the attributeID for OnTime attribute, 0x21 is the attribute type (ZCL_U16BIT_DATA_TYPE_ID, refer ZCL_AttributeType_t in zigbee application for details)

0x01 is the attribute value and 0x02 is the size of attribute data.

writeAttributeNoResp < addrMode > < addr > < ep > < clusterId > < attrId > < type > < attrValue1,2.. > < attrSize >

example: writeAttributeNoResp -s 0x24b8 0x23 0x0006 0x4001 0x21 0x01 0x02

No Response

This console command sends Write Attribute command for specified attribute and cluster to a remote device and specifies the remote devices not to send a response.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the write attribute no response zcl command to be send (ZCL_WRITE_ATTRIBUTES_NO_RESPONSE_COMMAND_ID).

ep: The endpoint on the remote device that is to be written.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be written.

attrId: Attribute ID of the Attribute that need to be written.

type: Attribute Type

attrValue: attribute value that need to be written

attrSize: Size of the attribute data

Here in example command, -s indicate that address mode is short address, 0x24b8 is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x4001 is the attributeID for OnTime attribute, 0x21 is the attribute type (ZCL_U16BIT_DATA_TYPE_ID, refer ZCL_AttributeType_t in zigbee application for details)

0x01 is the attribute value and 0x02 is the size of attribute data.

configureReporting < addrMode > < addr > < ep > < clusterId > < attrId > < type > < min > < max >

eg: configureReporting -s 0x1593 0x23 0x0006 0x00 0x10 0x01 0x02

Attribute operation response received: status = 0x00

This console command is used to change the reporting timeout on the remote device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the configure reporting zcl command to be send (ZCL_CONFIGURE_REPORTING_COMMAND_ID).

ep: The endpoint on the remote device that is to be written.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be configured.

attrId: Attribute ID of the Attribute that need to be configured.

type: Attribute Type

min: the minimum reporting interval in seconds, between issuing reports of the specified attribute.

max: the maximum reporting interval in seconds, between issuing reports of the specified attribute

The min and max reporting interval field is 16 bits (Unsigned) in length.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x00 is the attributeID for OnOff attribute, 0x10 is the attribute type (ZCL_BOOLEAN_DATA_TYPE_ID, refer ZCL_AttributeType_t in zigbee application for details) 1 in the min reporting interval (1 sec) & 2 in the min reporting interval (2 sec)

configureReportingWRC < addrMode > < addr > < ep > < clusterId > < attrId > < type > < min > < max > < repChange >

eg: configureReportingWRC -s 0x1593 0x23 0x0006 0x00 0x10 0x01 0x02 0x00

Attribute operation response received: status = 0x00

This console command Sends configure reporting with reportable Change to specified cluster server.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the configure reporting zcl command to be send (ZCL_CONFIGURE_REPORTING_COMMAND_ID).

ep: The endpoint on the remote device that is to be written.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be configured.

attrId: Attribute ID of the Attribute that need to be configured.

type: Attribute Type

min: the minimum reporting interval in seconds, between issuing reports of the specified attribute.

max: the maximum reporting interval in seconds, between issuing reports of the specified attribute

The min and max reporting interval field is 16 bits in length.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x00 is the attributeID for OnOff attribute, 0x10 is the attribute type (ZCL_BOOLEAN_DATA_TYPE_ID, refer ZCL_AttributeType_t in zigbee application for details) 1 in the min reporting interval (1 sec) & 2 in the min reporting interval (2 sec)

readReporting < addrMode > < addr > < ep > < clusterId > < attrId >

eg: readReporting -s 0x1593 0x23 0x0006 0x00

Attribute operation response received: status = 0x00

<-Read Reporting Attribute (0x0) response: success

min = 1 max = 2 direction = 0 attributeType = 16 reportableChange = 0

This console command read reporting configuration from specified cluster server.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device for which the read reporting zcl command to be send (ZCL_READ_REPORTING_CONFIGURATION_COMMAND_ID).

ep: The endpoint on the remote device of which reporting configuration need to be read.

clusterId: Unsigned 16-bit Cluster identifier whose attribute need to be configured.

attrId: Attribute ID of the Attribute that need to be configured.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device i.e., extend color light,0x0006 is the OnOff ClusterID and 0x00 is the attributeID for OnOff attribute.

addGroup < addrMode > < addr > < ep > < gid >

example: addGroup -s 0x1593 0x23 0x1234

addGroupResponseInd()

This console command sends zcl Add Group command to remote device which allows the sending device to add group membership in a particular group for one or more endpoints on the receiving device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which addgroup zcl command to be send.

ep: The endpoint on the remote device that needs to be added in the group.

gid: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is theGroupID. This command will create/add device 0x1593 into Group 0x1234. The device can be controlled using GroupID also e.g.: onOff -g 0x1234 0x23 -toggle.

addGroupIfIdentifying < addrMode > < addr > < ep > < gid >

example: addGroupIfIdentifying -s 0x1593 0x23 0xabcd

No Response

This console command sends the Add Group If Identifying zcl command to remote device which allows the sending device to add group membership in a particular group for one or more endpoints on the receiving device, on condition that it is identifying itself. Identifying functionality is controlled using the identify cluster.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which addgroup zcl command to be send.

ep: The endpoint on the remote device that needs to be added in the group.

gid: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0xabcd is theGroupID.

getGroupMembership < addrMode > < addr > < ep > < count > < groupId1 > < groupId2 > < groupId3 > < groupId4 > < groupId5 >

e.g.: getGroupMembership -s 0x1593 0x23 1 0x1234 0 0 0 0

getGroupMembershipResponse()

groupCount = 1

groupId = 0x1234

This console command sends the Get Group Membership zcl command to remote device which allows the sending device to inquire about the group membership of the receiving device.

specifies how many

group IDs following it should be

considered, but five values must be

provided as group IDs always.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which get group membership zcl command to be send.

ep: The endpoint on the remote device.

count: specifies how many group IDs following it should be considered, but five values must be

provided as group IDs always.

groupId1 to groupId5: Unsigned 16-bit identifier for a group

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is count, 0x1234,0,0,0,0are the GroupID’s.

removeAllGroups < addrMode > < addr > < ep >

example: removeAllGroups -s 0x1593 0x23

No Response

This command sends Remove All Group zcl command to remote device which allows the sending device to direct the receiving device to remove all group associations.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which get remove all group zcl command to be send.

ep: The endpoint on the remote device.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device.

removeGroup < addrMode > < addr> < ep > < gid>

example: removeGroup -s 0x1593 0x23 0x1234

removeGroupResponseInd(): groupId = 0x1234

This command sends remove group zcl command to remote device which allows the sender to request the receiving device to remove the membership from the specified group.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which get remove group zcl command to be send.

ep: The endpoint on the remote device.

gid: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is theGroupID.

viewGroup < addrMode > < addr> < ep > < gid>

example: viewGroup -s 0x1593 0x23 0x1234

viewGroupResponse(): status = 0x00 groupId = 0x1234

This command sends view group zcl command to remote device which allow the sending device to request that the receiving device to respond

with a view group response command containing the information of the requested GroupID.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device to which get view group zcl command to be send.

ep: The endpoint on the remote device.

gid: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is theGroupID.

resetTargetToFN

example: resetTargetToFN

Status = 1

Reset the Touchlink target to factory new

setTargetType < type >

example: setTargetType 1

Done

This console commands set touchlink device type as target / initiator

1 – target

0 – initiator

SetbdbJoinUsesInstallCodeKey < value >

example: SetbdbJoinUsesInstallCodeKey 1

No Response

This console command sets the install code usage at the trust center.

1 - TC will allow only install code devices to join.

0 – otherwise.

resetToFactoryDefaults < addrMode > < addr > < ep >

example: resetToFactoryDefaults -s 0xcbb4 0x23

No Response

This console command reset all cluster attributes to factory defaults.

disableDefaultResp < value >

example: disableDefaultResp 1

No Response

This console command Disable/Enable default response for ZCL command

0 – enable

1 –disable

addSceneToDL < addrMode > < addr > < ep > < groupId > < sceneId > < transitionTime > < onOff > < level >

e.g.: addSceneToDL -s 0x8d7f 0x23 0x1234 0x10 60 1 0xff

Add scene response: status = 0x00

groupId = 0x1234

sceneId = 0x11

This console command sends scene zcl command to dimmable light device which allow the sending device to request that the dimmable light device to add an entry in its Scene Table with the given sceneID.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: 8-bit unique identifier within group groupId, which is used to identify this scene.

transitionTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

onOff: 1-bit onOff value 1 or 0.

level: 8-bit light brightness level (0 - 0xff, where 0xff is max brightness).

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is theGroupID. 0x10 is the sceneID, 60 is the transitionTime, 1 is the onOff value and 0xff is the light level.

Note: Ensure that a group with ID 0x1234 is created before executing this command (eg: addGroup -s 0x8d7f 0x23 0x1234).

addSceneToTH < addrMode > < addr > < ep > < groupId > < sceneId > < transitionTime > < occupiedCoolingSetpoint > < occupiedHeatingSetpoint > < systemMode >

No Response

This console command sends Add Scene zcl command to Thermostat device to add an entry in its Scene Table with the given sceneID.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: 8-bit unique identifier within group groupId, which is used to identify this scene.

transitionTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

occupiedCoolingSetpoint: signed 16-bit, Occupied Cooling Setpoint Attribute specifies the cooling mode setpoint when the room is occupied.

occupiedHeatingSetpoint: signed 16-bit, occupied Heating Setpoint Attribute specifies the heating mode setpoint when the room is occupied.

systemMode: (Unsigned 8-bit) System Mode attribute specifies the current operating mode of the thermostat.

Note: Ensure that a group is created before executing this command. (using addGroup console command).

getSceneMembership < addrMode > < addr > < ep > < groupId >

e.g.: getSceneMembership -s 0x8d7f 0x23 0x123

Note: No Response

This console command sends Get Scene Membership zcl command to remote device. The Get Scene Membership command can be used to find an unused scene number within the group.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address*, 0x1593* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is theGroupID.

move < addrMode > < addr > < ep > < mode > < rate > < onOff > < optMask > < optOvrd >

e.g. Down: move -s 0x3bb6 0x23 1 0x7f 0 0 0

e.g. Up: move -s 0x3bb6 0x23 0 0x7f 1 0 0

Observe the change in LED level in light (dimmable) device.

This console command sends Move zcl command to remote light device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

mode: move up or down.

0x00 – Up

0x01 – Down

rate: specifies the rate of movement in units per second.

onOff: 1-bit onOff value 1 - On or 0 - Off.

optMask: options mask

optOvrd: options override

Here in first example command, -s indicate that address mode is short address*,* 0x3bb6* is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the down mode. 0x7f is the rate. 1 indicates on/off and 0 & 0 are options mask and options override.

moveToLevel < addrMode > < addr > < ep > < level > < transitionTime > < onOff > < optMask > < optOvrd >

e.g.: moveToLevel -s 0xe015 0x23 0x7f 0x000c 1 0 0

Observe the change in LED level in light (dimmable) device.

This console command sends Move to level zcl command to remote device which request the remote light (dimmable) to move from its current level to the given level.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

level: unsigned 8-bit value which holds brightness level of the light(dimmable) device.

transitionTime: unsigned 16-bit value which specifies time taken to move to the new level.

onOff: 1-bit onOff value 1 - On or 0 - Off.

optMask: options mask

optOvrd: options override

Here in example command, -s indicate that address mode is short address, 0xe015 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x7f is the new brightness level for the light (dimmable). 0x000c is the transition time. 1 indicates on/off and 0 & 0 are options mask and options override.

offWithEffect < addrMode > < addr > < ep > < effectId > < effectVariant >

e.g: offWithEffect -s 0xe015 0x23 0x01 0x00

This console command sends Off With Effect zcl command to remote light device request the devices to be turned off using enhanced ways of fading.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

effectId: unsigned 8-bits in length and specifies the fading effect to use when switching the device off.

0 - Delayed All Off

1 - Dying Light

effectVariant: unsigned 8-bits in length and is used to indicate which variant of the effect.

Here in example command, -s indicate that address mode is short address, 0xe015 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x01 is the effectId

onWithRecallGlobalScene < addrMode > < addr > < ep >

e.g.: onWithRecallGlobalScene -s 0xbaf4 0x23

This console command sends on with Recall Global sceneI zcl command to remote device which request remote device to recall the settings when the device was turned off.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

Here in example command, -s indicate that address mode is short address, 0xbaf4 is the short address of the remote device, 0x23 is endpoint of the remote device.

onWithTimedOff < addrMode > < mode > < ep > < onOffCtrl > < onTime > < offWaitTime >

e.g.: onWithTimedOff -s 0xbaf4 0x23 0 300 0

This console command sends on with Timed Off scene zcl command which request the remote devices to be turned on for a specific duration (as specified in onTime duration) with a guarded off duration (offWaitTime).

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

onOffCtrl: Control field specifies whether the On with Timed Off command is to be processed unconditionally or only when the OnOff attribute is equal to 0x01.

0 - command shall be processed unconditionally.

1 – command shall accepted if the OnOff attribute is equal to 0x01.

onTime: unsigned 16-bit value which specifies the length of time (in 1/10ths second) that the device is to remain “on”.

offWaitTime: duration prevent turning back on the device for On with Timed Off commands received during this time.

Here in example command, -s indicate that address mode is short address, 0xbaf4 is the short address of the remote device, 0x23 is endpoint of the remote device. 0 is onOffCtrl which means On with Timed Off command is processed unconditionally. 300 is onTime of 30 seconds and 0 is the offWaitTime.

recallScene < addrMode > < addr > < ep > < groupId > < sceneId > < transitionTime >

e.g.: recallScene -s 0xbaf4 0x23 0x1234 0x10 3

This console command sends recall scene zcl command which request the remote devices to locate the entry in its Scene Table with the Group ID and Scene ID and then set the corresponding scene.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: 8-bit unique identifier within group groupId, which is used to identify this scene.

transitionTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

Here in example command, -s indicate that address mode is short address, 0xbaf4* is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is the GroupID. 0x10 is the sceneID and 3 is the transition time.

removeAllScenes < addrMode > < addr > < ep > < groupId >

e.g.: removeAllScenes -s 0x666e 0x23 0x1234

Remove all scenes response: status = 0x00

groupId = 0x1234

This console command sends remove all scene zcl command which request the remote devices to remove from its Scene Table all entries with this Group ID.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

Here in example command, -s indicate that address mode is short address, 0x666e is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is the GroupID.

removeScene < addrMode > < addr > < ep > < groupId > < sceneId >

eg: removeScene -s 0x666e 0x23 0x1234 0x10

Remove scene response: status = 0x00

groupId = 0x1234

sceneId = 0x10

This console command sends remove scene zcl command which request the remote devices to remove from its Scene Table the entry with this

Scene ID and group ID.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: unsigned 8-bit unique identifier within group.

Here in example command, -s indicate that address mode is short address, 0x666e is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is the GroupID. 0x10 is the sceneID.

step < addrMode > < addr > < ep > < mode > < stepSize > < transitionTime > < onOff > < optMask > < optOvrd >

e.g.: step -s 0x6776 0x23 0x00 0x0f 300 1 0 0

This console command sends step zcl command which request the remote devices to move from its current level in an up or down direction (mode) in stepSize. Each step command will increment / decrement brightness of the light device till reaches the maximum / minimum level allowed for the device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

mode: move up or down.

0x00 – Up.

0x01 – Down

stepSize: unsigned 8-bit value. stepsize is a change in the CurrentLevel by step size value.

transitionTime: Unsigned 16-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

onOff: 1-bit onOff value 1 or 0.

optMask: options mask

optOvrd: options override

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x00 indicates up mode. 0x0f is the stepsize, the brightness of the light will increase by 15(0x0f) units. 300 is the transition time. 1 is the onOff value. 0, 0 is the options mask and options override value.

stop < addrMode > < addr > < ep > < onOff > < optMask > < optOvrd >

e.g.: stop -s 0x6776 0x23 0 0 0

This console command sends stop zcl command which request the remote devices to terminate any Move to Level, Move or Step command

(and their 'with On/Off' variants) currently in process.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

mode: move up or down.

onOff: 1-bit onOff value 1 or 0.

optMask: options mask

optOvrd: options override

storeScene < addrMode > < addr > < ep > < groupId > < sceneId >

e.g.: storeScene -s 0x6776 0x23 0x1234 0x10

Store scene response: status = 0x00

groupId = 0x1234

sceneId = 0x10

This console command sends store scene zcl command which request the remote devices to add an entry in the Scene Table with the SceneID and Group ID given in the command, and all extension field sets corresponding to the current state of other clusters on the device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: unsigned 8-bit unique identifier within group.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is the GroupID. 0x10 is the sceneID.

triggerEffect < addrMode > < addr > < ep > < effectId > < effectVariant >

e.g: triggerEffect -s 0x6776 0x23 0x01 0

This console command sends trigger effect zcl command to remote device which allows the support of feedback to the user, such as a certain light effect. It is used to allow an implementation to provide visual feedback to the user under certain circumstances such as a color light turning green when it has successfully connected to a network.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

effectId: 8-bits in length and specifies the identify effect to use.

effectVariant: 8-bits in length and is used to indicate which variant of the effect, indicated in the effect identifier field.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the Breath effectId and 0 is the effectVariant.

viewScene < addrMode > < addr > < ep > < groupId > < sceneId >

e.g.: viewScene -s 0x6776 0x23 0x1234 0x10

View scene response: status = 0x00

groupId = 0x1234

sceneId = 0x10

transitionTime = 0x0000

This console command sends view scene zcl command to remote device. On receipt of this command, the remote device checks for the entry in scene table for specified sceneID and responds the scene information.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: unsigned 8-bit unique identifier within group.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1234 is the GroupID. 0x10 is the sceneID.

onOff < addrMode > < addr > < ep > < onOff_ID >

e.g.: onOff -s 0x6776 0x23 -toggle

This console command sends on, off or toggle zcl command, which request the remote devices to turn off or turn on or toggle the light.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

onOff_ID: hold on, off or toggle parameter.

-on : Turns on the light.

-off : Turns off the light.

-toggle: Toggle the light.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. ‘*-toggle*’ toggles the current state of the light.

identify < addrMode > < addr > < ep > < idTime >

e.g.: identify -s 0x6776 0x23 10

This console command sends identify zcl command to remote devices which request to the remote to start / stop identifying procedure. The identifying procedure consists of flashing a light with a period of 0.5 seconds which helps an observer to identify the device from several devices.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

idTime: specifies identification duration (in seconds) which device continues to identify.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 10 is the identify time in seconds.

identifyQuery < addrMode > < addr > < ep >

e.g.: identifyQuery -s 0x6776 0x23

This console command sends identify query zcl command to remote devices which allows the sending device to request the target or targets to respond if they are currently identifying themselves.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

moveToHue < addrMode > < addr > < ep > < hue > < direction > < transitTime > < optMask > < optOvrd >

e.g.: moveToHue -s 0x6776 0x23 0x5A 1 50 0 0

This console command sends move to hue zcl command to remote devices which request the remote device to move its current hue to the value given in the Hue field

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

hue: unsigned 8-bit hue value of light, ranges from 0 - 254.

direction: direction of the hue movement.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current hue to the requested hue (1/10ths of a second).

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x5A is new hue value. 1 is the direction to hue to fade (longest distance). 50 is the transition time i.e.seconds. 0, 0 is the options mask and options override value.

moveHue < addrMode > < addr > < ep > < moveMode > < rate > < optMask > < optOvrd >

e.g.: moveHue -s 0x6776 0x23 1 5 0 0

This console command sends move hue zcl command to remote devices which request the remote device to move its current hue in an up or down direction in a continuous fashion.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

moveMode: up or down direction of hue attribute.

rate: rate of movement of hue in steps per second.

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the moveMode for moving the hue attribute in up direction. 5 is the rate of change of hue in seconds. 0, 0 is the options mask and options override value.

stepHue < addrMode > < addr > < ep > < stepMode > < stepSize > < transitTime > < optMask > < optOvrd >

e.g.: stepHue -s 0x6776 0x23 1 0x1f 10 0 0

This console command sends step Hue zcl command which request the remote devices to move from its current hue (color) in an up or down direction (mode) in stepSize. Each step command will increment / decrement hue of the light device till reaches the maximum / minimum hue value allowed for the device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

stepMode: move up or down.

0x01 – Up.

0x03 – Down

stepSize: unsigned 8-bit value. stepsize is a change in the CurrentHue by step size value.

transitTime: Unsigned 8-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x6776 is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the Up direction. 0x1f (31) is the step size. 10 is the transition time. 0, 0 is the options mask and options override value.

moveToSaturation < addrMode > < addr > < ep > < saturation > < transitTime > < optMask > < optOvrd>

e.g.: moveToSaturation -s 0x1984 0x23 0xef 10 0 0

This console command sends move to saturation zcl command which request the remote devices to move from its current saturation to the value given in the Saturation field.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

saturation: unsigned 8-bit saturation value of light which ranges from range 0 to 254.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current saturation to the requested saturation (1/10ths of a second).

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x1984 is the short address of the remote device, 0x23 is endpoint of the remote device. 0xef is new hue value. 10 is the transition time. 0, 0 is the options mask and options override value.

moveSaturation < addrMode > < addr > < ep > < moveMode > < rate > < optMask > < optOvrd >

eg.: moveSaturation -s 0x1984 0x23 1 0x05 0 0

This console command sends move saturation zcl command to remote devices which request the remote device to move its current saturation in an up or down direction in a continuous fashion.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

moveMode: up or down direction of hue attribute.

rate: unsigned 8-bit, rate of movement of hue in steps per second.

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x1984 is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the Up moveMode for moving the saturation in up direction. 0x05 is the rate of change of hue in seconds. 0, 0 is the options mask and options override value.

stepSaturation < addrMode > < addr > < ep > < stepMode > < stepSize > < transitTime > < optMask > < optOvrd >

e.g.: stepSaturation -s 0x1984 0x23 1 0x1f 10 0 0

This console command sends step Saturation zcl command which requests the remote devices to move from its current saturation in an up or down direction (mode) in stepSize. Each step command will increment / decrement saturation of the light device till reaches the maximum / minimum saturation value allowed for the device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

stepMode: move up or down.

0x01 – Up.

0x03 – Down

stepSize: unsigned 8-bit value. stepsize is a change in the CurrentHue by step size value.

transitTime: Unsigned 16-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x1984 is the short address of the remote device, 0x23 is endpoint of the remote device. 1 is the Up direction. 0x1f (31) is the step size. 10 is the transition time. 0, 0 is the options mask and options override value.

moveToHueAndSaturation < addrMode > < addr > < ep > < hue > < saturation > < transitTime > < optMask > < optOvrd >

e.g.: moveToHueAndSaturation -s 0x1984 0x23 0x1f 0xef 10 0 0

This console command sends move to hue and saturation zcl command to remote devices which request the remote device to move its current hue and saturation to the value given in the Hue and Saturation field.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

hue: unsigned 8-bit hue value of light, ranges from 0 – 254.

saturation: unsigned 8-bit saturation value of light which ranges from range 0 to 254.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current saturation to the requested saturation (1/10ths of a second).

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x1984 is the short address of the remote device, 0x23 is endpoint of the remote device. 0x1f is new hue value and 0xef is the new saturation value. 10 is the transition time. 0, 0 is the options mask and options override value.

moveToColor < addrMode > < addr > < ep > < colorX > < colorY > < transitTime > < optMask > < optOvrd >

e.g.: moveToColor -s 0x1984 0x23 0xa501 0xca53 10 0 0

This console command sends move to hue and saturation zcl command to remote devices which request the remote device to move from its current color to the color given in the ColorX and ColorY fields.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

colorX: color given in the ColorX across the CIE xyY Color Space, range from 0 to 65279.

colorY: color given in the ColorY across the CIE xyY Color Space, range from 0 to 65279.

transitTime: Unsigned 16-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

optMask: options mask.

optOvrd: options override.

Here in example command, -s indicate that address mode is short address, 0x1984 is the short address of the remote device, 0x23 is endpoint of the remote device. 0xa501 0xca53 is the xy color. 10 is the transition time. 0, 0 is the options mask and options override value.

moveColor < addrMode > < addr > < ep > < rateX > < rateY > < optMask > < optOvrd >

e.g.: moveColor -s 0xfd3d 0x23 10 12 0 0

This console command sends move color zcl command to remote devices which request the remote device to move its current color in an up or down direction in a continuous fashion.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

rateX: signed 16-bit, rate of movement in steps per second for colorX.

rateY: signed 16-bit, rate of movement in steps per second for colorY.

optMask: options mask.

optOvrd: options override.

stepColor < addrMode > < addr > < ep > < stepX > < stepY > < transitTime > < optMask > < optOvrd >

e.g.: stepColor -s 0xfd3d 0x23 0x1f 0x1f 100 0 0

This console command sends step Color zcl command which request the remote devices to move from its current color by the color step indicated.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

stepX: signed 16-bit, specify the change to be added to the device's CurrentX attribute.

stepY: signed 16-bit, specify the change to be added to the device's CurrentY attribute.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

optMask: options mask.

optOvrd: options override.

moveToColorTemperature < addrMode > < addr > < ep > < colorTemp > < transitTime > < optMask > < optOvrd >

e.g.: moveToColorTemperature -s 0xfd3d 0x23 0x1fff 10 0 0

This console command sends move to color temperature zcl command which request the remote devices to move from its current color to the color given by the Color Temperature.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

colorTemp: unsigned 16-bit color temperature value ranges from range 1 to 65279

transitTime: Unsigned 16-bit time value which will take for the device to change from its current saturation to the requested saturation (1/10ths of a second).

enhancedMoveToHue < addrMode > < addr > < ep > < enhancedHue > < direction > < transitTime > < optMask > < optOvrd >

e.g.: enhancedMoveToHue -s 0xbc3c 0x23 0x7f00 1 500 0 0

This console command sends move to enhanced move to hue zcl command which requests light to be moved in a smooth continuous transition from their current hue to a target hue.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

enhancedHue: unsigned 16-bit value represents non-equidistant steps along the CIE 1931 color triangle, ranges (0x0000 to 0xffff)

direction: direction of the hue movement.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current hue to the requested hue (1/10ths of a second).

optMask: options mask.

optOvrd: options override.

enhancedMoveHue < addrMode > < addr > < ep > < moveMode > < rate > < optMask > < optOvrd >

e.g.: enhancedMoveHue -s 0x7db6 0x23 1 5 0 0

This console command sends enhanced move hue zcl command to remote devices which request the light to move from its current enhanced hue in an up or down direction in a continuous fashion.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

moveMode: up or down direction of hue attribute.

rate: unsigned 16-bit, rate of movement of hue in steps per second.

optMask: options mask.

optOvrd: options override.

enhancedStepHue < addrMode > < addr > < ep > < stepMode > < stepSize > < transitTime > < optMask > < optOvrd >

e.g.: enhancedStepHue -s 0xbc3c 0x23 0 0x1f 10 0 0

This console command sends enhanced step Hue zcl command which request the remote devices to move from its current enhanced hue in an up or down direction (mode) in stepSize. Each step command will increment / decrement hue of the light device till reaches the maximum / minimum enhanced hue value allowed for the device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

stepMode: move up or down.

0x01 – Up.

0x03 – Down

stepSize: unsigned 16-bit value. stepsize is a change in the enhanced current Hue by step size value.

transitTime: Unsigned 16-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

optMask: options mask.

optOvrd: options override.

enhancedMoveToHueAndSaturation < addrMode > < addr > < ep > < enhancedHue > < saturation > < transitTime > < optMask > < optOvrd >

e.g.: enhancedMoveToHueAndSaturation -s 0xbc3c 0x23 0x3fff 0xef 10 0 0

This console command sends enhanced move to hue and saturation zcl command to remote devices which request the remote device to move its enhanced current hue and saturation to the value given in the enhanced Hue and Saturation field.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

enhancedHue: unsigned 16-bit value represents non-equidistant steps along the CIE 1931 color triangle, ranges (0x0000 to 0xffff)

saturation: unsigned 8-bit saturation value of light which ranges from range 0 to 254.

transitTime: Unsigned 16-bit time value which will take for the device to change from its current saturation to the requested saturation (1/10ths of a second).

optMask: options mask.

optOvrd: options override.

colorLoopSet < addrMode > < addr > < ep > < updateFlags > < action > < direction > < time > < startHue > < optMask > < optOvrd >

e.g.: colorLoopSet -s 0xbc3c 0x23 0x0f 0x01 0x01 30 0xefff 0 0

This console command sends color loop set zcl command to remote devices which allows remote light to cycle through its

range of hues.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

updateFlags: unsigned 8-bit value that specifies which color loop attributes to update before the color loop is started.

* Bit 0 – Update Action

* Bit 1 - Update Direction

* Bit 2 - Update Time

* Bit 3 - Update Start Hue

* Bit 4-7 - Reserved

action: unsigned 8-bit value which specifies the action to take for the color loop if the Update Action sub-field of the Update Flags field is set to 1

* 0x00 - De-activate the color loop.

* 0x01 - Activate the color loop from the value in the ColorLoopStartEnhancedHue field.

* 0x02 - Activate the color loop from the value of the EnhancedCurrentHue attribute.

direction: specifies the direction for the color loop if the Update Direction

field of the Update Flags field is set to 1

* 0x00 - Decrement the hue in the color loop.

* 0x01 - Increment the hue in the color loop.

time: unsigned 16-bit value that specifies the number of seconds over which to perform a full color loop if the Update Time field of the Update Flags field is set to 1

startHue: unsigned 16-bit value that specifies the starting hue to use for the color loop if the Update Start Hue field of the Update Flags field is set to 1

optMask: options mask.

optOvrd: options override.

stopMoveStep < addrMode > < addr > < ep > < optMask > < optOvrd >

e.g.: stopMoveStep -s 0xbc3c 0x23 0 0

This console command sends stop move step zcl command to remote devices to terminate any Move to, Move or Step command currently in process.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

optMask: options mask.

optOvrd: options override.

moveColorTemperature < addrMode > < addr > < ep > < moveMode > < rate > < colorTempMin > < colorTempMax > < optMask > < optOvrd >

eg: moveColorTemperature -s 0xbc3c 0x23 0x01 60 0x000f 0xfe00 0 0

This console command sends stop move step zcl command to remote devices which request the remote device to move from its current color temperature in an up or down direction in a continuous fashion.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details. addr: is the short address of the remote device. ep: The endpoint on the remote device. moveMode: up or down direction of hue attribute.

rate: unsigned 16-bit value that holds the rate of movement of color temperature in steps per second. colorTempMin: unsigned 16-bit value that specifies the lower bound on the ColorTemperature attribute (range 1 to 65279). colorTempMax: unsigned 16-bit value that specifies the upper bound on the ColorTemperature attribute (range 1 to 65279). optMask: options mask. optOvrd: options override.

stepColorTemperature < addrMode > < addr > < ep > < stepMode > < stepSize > < transitTime > < colorTempMin > < colorTempMax > < optMask > < optOvrd >

e.g: stepColorTemperature -s 0xbc3c 0x23 0x00 0x01ff 10 0x000f 0xfe00 0 0

This console command sends step color temperature zcl command which request the remote devices to move its current color temperature in an up or down direction by one step.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

stepMode: move up or down.

0x01 – Up.

0x03 – Down

stepSize: unsigned 16-bit value that specifies the change to be added / subtracted from the current value of the device’s color temperature.

transitTime: Unsigned 16-bit time value in tenths of a second which will take for the device to change from its current state to the requested state.

colorTempMin: unsigned 16-bit value that specifies the lower bound on the ColorTemperature attribute (range 1 to 65279).

colorTempMax: unsigned 16-bit value that specifies the upper bound on the ColorTemperature attribute (range 1 to 65279).

optMask: options mask.

optOvrd: options override.

This console command sends enhanced add scene zcl command which allow the sending device to request that the light device to add an entry in its Scene Table with the given sceneID and parameter in the payload.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

group: Unsigned 16-bit identifier for a group.

scene: 8-bit unique identifier within group, which is used to identify this scene.

trTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

onOff: 1-bit onOff value 1 or 0.

level: 8-bit light brightness level (0 - 0xff, where 0xff is max brightness).

X: color given in the ColorX across the CIE xyY Color Space, range from 0 to 65279.

Y: color given in the ColorY across the CIE xyY Color Space, range from 0 to 65279.

enHue: unsigned 16-bit value represents non-equidistant steps along the CIE 1931 color triangle, ranges (0x0000 to 0xffff)

sat: unsigned 8-bit saturation value of light which ranges from range 0 to 254.

colorLoopActv: unsigned 8-bit value which specifies the action to take for the color loop. (refer colorLoopSet command-action parameter)

colorLoopDir: specifies the direction for the color loop

colorTemp: unsigned 16-bit color temperature value ranges from range 1 to 65279

This console command sends Enhanced Add Scene zcl command to Thermostat device to add an entry in its Scene Table with the given sceneID and parameter in the payload.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: 8-bit unique identifier within group, which is used to identify this scene.

transitionTime: Unsigned 16-bit time value which will take for the device to change from its current state to the requested state.

occupiedCoolingSetpoint: signed 16-bit, Occupied Cooling Setpoint Attribute specifies the cooling mode setpoint when the room is occupied.

occupiedHeatingSetpoint: signed 16-bit, occupied Heating Setpoint Attribute specifies the heating mode setpoint when the room is occupied.

systemMode: (Unsigned 8-bit) System Mode attribute specifies the current operating mode of the thermostat.

copyScene < addrMode > < addr > < ep > < mode > < groupFrom > < sceneFrom > < groupTo > < sceneTo >

e.g.: copyScene -s 0xbc3c 0x23 0x1234 0x10 0xabcd 0xa1

This console command sends copy scene zcl command to a remote device and request it to copy scenes from one group/scene identifier pair to

another group/scene identifier pair.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

mode: specify how the scene copy is to proceed.

1 - all scenes are to be copied.

0 – otherwise.

groupFrom: Unsigned 16-bit value which specifies the identifier of the group from which the scene is to be copied.

sceneFrom: Unsigned 8-bits value which specifies the identifier of the scene from which the scene is to be copied.

groupTo: Unsigned 16-bit value which specifies the identifier of the group to which the scene is to be copied.

sceneTo: Unsigned 8-bits value which specifies the identifier of the scene to which the scene is to be copied.

enhancedViewScene < addrMode > < addr > < ep > < groupId > < sceneId >

e.g.: enhancedViewScene -s 0xbc3c 0x23 0x1234 0x10

Enhanced view scene response: status = 0x00

groupId = 0x1234

sceneId = 0x10

transitionTime = 0x0258

This console command sends enhanced view scene zcl command to remote device. On receipt of this command, the remote device checks for the entry in scene table for specified sceneID and responds the scene information.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

groupId: Unsigned 16-bit identifier for a group.

sceneId: unsigned 8-bit unique identifier within group.

sendEndpointInfo < shortAddr > < ep >

e.g.: sendEndpointInfo 0xbc3c 0x23

This console command sends endpoint information zcl command. The endpoint information command is used to inform the remote endpoint about the general information of the local endpoint.

shortAddr: is the short address of the remote device.

ep: The endpoint on the remote device.

getGroupIdentifiers < shortAddr > < ep > < startIndex >

e.g.: getGroupIdentifiers 0xbc3c 0x23 0

getGroupIdentifiersResponseInd()

total=1, startIndex=0, count=1

group id=0x1234, type=0x00

This console command sends Get Group Identifiers zcl command. The get group identifiers request command is used to retrieve the actual group identifiers that the endpoint is using in its multicast communication in controlling different (remote) devices.

shortAddr: is the short address of the remote device.

ep: The endpoint on the remote device.

startIndex is the starting Index for the requested elements of the Group Table.

getEndpointList < shortAddr > < ep > < startIndex >

e.g.: getEndpointList 0xbc3c 0x23 0

getEndpointListResponseInd()

total=1, startIndex=0, count=1

endpoint networkAddress=0xbc3c, endpointId=0x23, profileId=0x0104, deviceId=0x010d, version=0x01

This console command sends Get endpoint list zcl command. The get endpoint list request command is used to retrieve addressing information for each endpoint the device is using in its unicast communication in controlling different (remote) devices.

shortAddr: is the short address of the remote device.

ep: The endpoint on the remote device.

startIndex is the starting Index for the requested elements.

setTimeStatus < master > < synchronized > < masterZoneDst > < superseding >

e.g.: setTimeStatus 1 1 1 0

This console command set the time status of this device.

master: This parameter set the master bit of the TimeStatus attribute. The Master bit specifies whether the real time clock corresponding to the Time attribute is internally set to the time standard.

1 – master clock

0 – not master clock

synchronized: This parameter set the synchronized bit of the TimeStatus attribute. The Synchronized bit specifies whether Time has been set over the ZigBee network to synchronize it to the time standard.

1 – synchronized

0 – not synchronized

masterZoneDst: This parameter set the masterZoneDst bit of the TimeStatus attribute. The MasterZoneDst bit specifies whether the TimeZone, DstStart, DstEnd and DstShift attributes are set internally to correct values for the location of the clock.

1 – master for Time Zone and DST

0 – not master for Time Zone and DST

superseding: This parameter set the Superseding bit of the TimeStatus attribute.

1 – time synchronization should be superseded.

0 - time synchronization should not be superseded.

This command updates ACE clients in the system of changes to panel status recorded by the ACE server.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

panel_status: 8-bit enum as described in below table

seconds_remaining: Indicates the number of seconds remaining for the server to be in the state indicated in the Panel Status

parameter.

audible_noti: Provide the ACE client with information on which type of audible notification it should make for the zone

status change.

IasAceZoneStatusChangedCommand < addrMode > < addr > < ep > < zoneId > < zone_status > < audible > < zone_label >

This command updates ACE clients in the system of changes to zone status recorded by the ACE server.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

zoneId: unsigned 8-bit parameter which is used to store information for each Zone enrolled by the CIE

zone_status: unsigned 8-bitvparameter which hold the current value of the ZoneStatus attribute.

audible: Provide the ACE client with information on which type of audible notification it should make for the zone status change.

This console command sends initiate Normal Operating mode at the Ace device.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

Sends to initiate Test operating Mode at the Ace device with its dutaion for the same with its current zone sensitivity level.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

Test_Mode_Duration: Specifies the duration, in seconds, for which the IAS Zone server will operate in its test mode.

Current_Zone_Sensitivity_Level: Specifies the sensitivity level the IAS Zone server will use for the duration of the Test Mode and with which it must update its CurrentZoneSensitivityLevel attribute.

This console command sends reset alarm zcl command to a remote device and request to resets a specific alarm. This is needed for some alarms that do not reset automatically.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

alarmId: specfies the alarm condition when alarm is generated.

This console command sends reset all alarm zcl command to a remote device and request to resets a all alarm.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

This console command sends reset alarm log zcl command to a remote device and request it to clear the alarm table.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

This console command sends reset alarm log zcl command to a remote device and request it to clear the alarm table.

addrMode: specifies the format of DstAddr. Refer Address Mode table for more details.

addr: is the short address of the remote device.

ep: The endpoint on the remote device.

onOffQ

e.g.: onOffQ

0

currentLevelQ

e.g.: currentLevelQ

127