Cluster Commands: SL Works With All Hubs

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_APS_LINK_KEY_AUTH
 zcl sl-wwah enable-aps-link-key-auth [numberExemptClusters:1] [clusterId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_APS_LINK_KEY_AUTH
 zcl sl-wwah disable-aps-link-key-auth [numberExemptClusters:1] [clusterId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_APS_LINK_KEY_AUTH
 zcl sl-wwah query-aps-link-key-auth [clusterId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_REQUEST_NEW_APS_LINK_KEY
 zcl sl-wwah request-new-aps-link-key
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_APP_EVENT_RETRY_ALG
 zcl sl-wwah enable-app-event-retry-alg [firstBackoffTimeSeconds:1] [backoffSeqCommonRatio:1] [maxBackoffTimeSeconds:4] [maxRedeliveryAttempts:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_APP_EVENT_RETRY_ALG
 zcl sl-wwah disable-app-event-retry-alg
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_REQ_TIME
 zcl sl-wwah req-time
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_REJOIN_ALG
 zcl sl-wwah enable-rejoin-alg [fastRejoinTimeoutSeconds:2] [durationBetweenRejoinsSeconds:2] [fastRejoinFirstBackoffSeconds:2] [maxBackoffTimeSeconds:2] [maxBackoffIterations:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_REJOIN_ALG
 zcl sl-wwah disable-rejoin-alg
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_IAS_ENROLL_METHOD
 zcl sl-wwah set-ias-enroll-method [enrollmentMode:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_CLEAR_BINDING_TABLE
 zcl sl-wwah clear-binding-table
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_ROUTER_CHECKINS
 zcl sl-wwah enable-router-checkins [checkInInterval:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_ROUTER_CHECKINS
 zcl sl-wwah disable-router-checkins
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_MAC_POLL_CCA_WAIT_TIME
 zcl sl-wwah set-mac-poll-cca-wait-time [waitTime:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_PENDING_NETWORK_UPDATE
 zcl sl-wwah set-pending-network-update [channel:1] [panId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_REQUIRE_APS_ACK_UNICAST
 zcl sl-wwah enable-require-aps-ack-unicast [numberExemptClusters:1] [clusterId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_REQUIRE_APS_ACK_UNICAST
 zcl sl-wwah disable-require-aps-ack-unicast
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_APS_ACK_REQUIREMENT
 zcl sl-wwah query-aps-ack-requirement
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_DEBUG_REPORT
 zcl sl-wwah query-debug-report [debugReportId:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SURVEY_BEACONS
 zcl sl-wwah survey-beacons [standardBeacons:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_OTA_DOWNGRADES
 zcl sl-wwah disable-ota-downgrades
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_MGMT_LEAVE_WO_REJOIN
 zcl sl-wwah disable-mgmt-leave-wo-rejoin
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_TL_INTERPAN_MSG_SUPPORT
 zcl sl-wwah disable-tl-interpan-msg-support
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_PARENT_CLASSIFY
 zcl sl-wwah enable-parent-classify
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_PARENT_CLASSIFY
 zcl sl-wwah disable-parent-classify
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_TC_SEC_NTWK_KEY_ROT
 zcl sl-wwah enable-tc-sec-ntwk-key-rot
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_BAD_PARENT_RECOVERY
 zcl sl-wwah enable-bad-parent-recovery
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_BAD_PARENT_RECOVERY
 zcl sl-wwah disable-bad-parent-recovery
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_CONFIG_MODE
 zcl sl-wwah enable-config-mode
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_CONFIG_MODE
 zcl sl-wwah disable-config-mode
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_USE_TC_FOR_CLUSTER_SERVER
 zcl sl-wwah use-tc-for-cluster-server [numberOfClusters:1] [clusterId:2]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_TC_FOR_CLUSTER_SERVER
 zcl sl-wwah query-tc-for-cluster-server

Detailed Description

This group describes the CLI commands for the SL Works With All Hubs cluster. Listed below is a description of the cluster:

Silicon Labs proprietary attributes and commands for Works With All Hubs functional extensions.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_CLEAR_BINDING_TABLE

zcl sl-wwah clear-binding-table

  • Clear the binding table.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_APP_EVENT_RETRY_ALG

zcl sl-wwah disable-app-event-retry-alg

  • Disable WWAH App Event retry algorithm.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_APS_LINK_KEY_AUTH

zcl sl-wwah disable-aps-link-key-auth [numberExemptClusters:1] [clusterId:2]

  • Disable enforcement of APS-level security for all cluster commands.
    • numberExemptClusters - INT8U
    • clusterId - CLUSTER_ID
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_BAD_PARENT_RECOVERY

zcl sl-wwah disable-bad-parent-recovery

  • Disable WWAH Bad Parent Recovery feature.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_CONFIG_MODE

zcl sl-wwah disable-config-mode

  • Disable Configuration Mode.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_MGMT_LEAVE_WO_REJOIN

zcl sl-wwah disable-mgmt-leave-wo-rejoin

  • Causes device to ignore MGMT Leave Without Rejoin commands.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_OTA_DOWNGRADES

zcl sl-wwah disable-ota-downgrades

  • Disallow OTA downgrade of all device firmware components.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_PARENT_CLASSIFY

zcl sl-wwah disable-parent-classify

  • Disable WWAH Parent Classification advertisements.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_REJOIN_ALG

zcl sl-wwah disable-rejoin-alg

  • Disable WWAH rejoin algorithm.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_REQUIRE_APS_ACK_UNICAST

zcl sl-wwah disable-require-aps-ack-unicast

  • Roll back changes made by Require APS ACK on Unicasts.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_ROUTER_CHECKINS

zcl sl-wwah disable-router-checkins

  • Disable device from periodically checking connectivity with Zigbee Coordinator.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_DISABLE_TL_INTERPAN_MSG_SUPPORT

zcl sl-wwah disable-tl-interpan-msg-support

  • Causes device to ignore Touchlink Interpan messages.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_APP_EVENT_RETRY_ALG

zcl sl-wwah enable-app-event-retry-alg [firstBackoffTimeSeconds:1] [backoffSeqCommonRatio:1] [maxBackoffTimeSeconds:4] [maxRedeliveryAttempts:1]

  • Enable WWAH App Event retry algorithm.
    • firstBackoffTimeSeconds - INT8U
    • backoffSeqCommonRatio - INT8U
    • maxBackoffTimeSeconds - INT32U
    • maxRedeliveryAttempts - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_APS_LINK_KEY_AUTH

zcl sl-wwah enable-aps-link-key-auth [numberExemptClusters:1] [clusterId:2]

  • Enable enforcement of APS-level security for all cluster commands.
    • numberExemptClusters - INT8U
    • clusterId - CLUSTER_ID
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_BAD_PARENT_RECOVERY

zcl sl-wwah enable-bad-parent-recovery

  • Enable WWAH Bad Parent Recovery feature.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_CONFIG_MODE

zcl sl-wwah enable-config-mode

  • Enable Configuration Mode.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_PARENT_CLASSIFY

zcl sl-wwah enable-parent-classify

  • Enable WWAH Parent Classification advertisements.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_REJOIN_ALG

zcl sl-wwah enable-rejoin-alg [fastRejoinTimeoutSeconds:2] [durationBetweenRejoinsSeconds:2] [fastRejoinFirstBackoffSeconds:2] [maxBackoffTimeSeconds:2] [maxBackoffIterations:2]

  • Enable WWAH rejoin algorithm.
    • fastRejoinTimeoutSeconds - INT16U
    • durationBetweenRejoinsSeconds - INT16U
    • fastRejoinFirstBackoffSeconds - INT16U
    • maxBackoffTimeSeconds - INT16U
    • maxBackoffIterations - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_REQUIRE_APS_ACK_UNICAST

zcl sl-wwah enable-require-aps-ack-unicast [numberExemptClusters:1] [clusterId:2]

  • Require all unicast commands to have APS ACKs enabled.
    • numberExemptClusters - INT8U
    • clusterId - CLUSTER_ID
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_ROUTER_CHECKINS

zcl sl-wwah enable-router-checkins [checkInInterval:2]

  • Enable device to periodically check connectivity with Zigbee Coordinator.
    • checkInInterval - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_ENABLE_TC_SEC_NTWK_KEY_ROT

zcl sl-wwah enable-tc-sec-ntwk-key-rot

  • Process only network key rotation commands sent via unicast and encrypted by Trust Center Link Key.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_APS_ACK_REQUIREMENT

zcl sl-wwah query-aps-ack-requirement

  • Query whether unicast commands are required to have APS ACKs enabled.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_APS_LINK_KEY_AUTH

zcl sl-wwah query-aps-link-key-auth [clusterId:2]

  • Query status of APS-level security enforcement for a specified cluster.
    • clusterId - CLUSTER_ID
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_DEBUG_REPORT

zcl sl-wwah query-debug-report [debugReportId:1]

  • Query for specified debug report.
    • debugReportId - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_QUERY_TC_FOR_CLUSTER_SERVER

zcl sl-wwah query-tc-for-cluster-server

  • Causes device to send an appropriate Trust Center for Cluster Server Query Response command.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_REQ_TIME

zcl sl-wwah req-time

  • Trigger device to request current attribute values from Time Cluster server.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_REQUEST_NEW_APS_LINK_KEY

zcl sl-wwah request-new-aps-link-key

  • Trigger device to request a new APS link key from the Trust Center.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_IAS_ENROLL_METHOD

zcl sl-wwah set-ias-enroll-method [enrollmentMode:1]

#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_MAC_POLL_CCA_WAIT_TIME

zcl sl-wwah set-mac-poll-cca-wait-time [waitTime:1]

  • Set MAC poll CCA wait time.
    • waitTime - INT8U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SET_PENDING_NETWORK_UPDATE

zcl sl-wwah set-pending-network-update [channel:1] [panId:2]

  • Set pending network update parameters.
    • channel - INT8U
    • panId - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_SURVEY_BEACONS

zcl sl-wwah survey-beacons [standardBeacons:1]

  • Causes device to perform a scan for beacons advertising the device's network.
    • standardBeacons - BOOLEAN
#define EMBER_AF_DOXYGEN_CLI_COMMAND_S_L_WORKS_WITH_ALL_HUBS_USE_TC_FOR_CLUSTER_SERVER

zcl sl-wwah use-tc-for-cluster-server [numberOfClusters:1] [clusterId:2]

  • Use only the Trust Center as cluster server for the set of clusters specified.
    • numberOfClusters - INT8U
    • clusterId - CLUSTER_ID