Plugin Commands: Sub-GHz Server
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_PRINT
plugin sub-ghz channel-change print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_SET
plugin sub-ghz channel-change set [value:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_PRINT
plugin sub-ghz channel-mask print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_SET
plugin sub-ghz channel-mask set [mask1:4] [mask2:4] [mask3:4] [mask4:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CLIENT_STATUS
plugin sub-ghz client-status [nodeId:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_PRINT
plugin sub-ghz limits print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_SET
plugin sub-ghz limits set [limited:2] [critical:2] [suspended:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_SUSPEND_ZCL_MESSAGES
plugin sub-ghz suspend-zcl-messages [nodeId:2] [ep:1] [period:1]

Detailed Description

The Sub-GHz commands provide commands for sub-GHz duty cycle, power management and frequency agility.

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_PRINT

plugin sub-ghz channel-change print

  • Print out the status of the sub-GHz channel change attribute.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_SET

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_CHANGE_SET

plugin sub-ghz channel-change set [value:4]

  • Set the status of the sub-GHz channel change attribute.
    • value - INT32U - Channel change attribute (bit mask)

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_PRINT

plugin sub-ghz channel-mask print

  • Print out the status of all sub-GHz channel masks.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_SET

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CHANNEL_MASK_SET

plugin sub-ghz channel-mask set [mask1:4] [mask2:4] [mask3:4] [mask4:4]

  • Set one or more sub-GHz channel mask(s).
    • mask1 - INT32U - Channel 28 mask
    • mask2 - INT32U - Channel 29 mask
    • mask3 - INT32U - Channel 30 mask
    • mask4 - INT32U - Channel 31 mask

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CLIENT_STATUS

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_CLIENT_STATUS

plugin sub-ghz client-status [nodeId:2]

  • Print the given Sub-GHZ given client's current status.
    • nodeId - INT16U - Client's Node ID of the given client

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_PRINT

plugin sub-ghz limits print

  • Print the current Duty Cycle limits.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_SET

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_LIMITS_SET

plugin sub-ghz limits set [limited:2] [critical:2] [suspended:2]

  • Set the Duty Cycle limits.
    • limited - INT16U - 'Limited' Duty Cycle state threshold in % * 100 (i.e. 150 = 1.5%)
    • critical - INT16U - 'Critical' Duty Cycle state threshold in % * 100
    • suspended - INT16U - 'Suspended' Duty Cycle state threshold in % * 100

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_SUSPEND_ZCL_MESSAGES

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_SUB_GHZ_SERVER_PLUGIN_SUB_GHZ_SUSPEND_ZCL_MESSAGES

plugin sub-ghz suspend-zcl-messages [nodeId:2] [ep:1] [period:1]

  • Send the SuspendZCLMessages command to the given client.
    • nodeId - INT16U - Node ID of the given client
    • ep - INT8U - Endpoint of the given client
    • period - INT8U - Period in minutes