ZCL Commands#

API for runtime subscription to ZCL commands.

Following a brief usage example that demonstrate how to subscribe to the ZCL "Level Control" cluster commands, client side, with no manufacturer ID. In this example we only handle only "Stop" command. The subscribed callback must return a value of:

• SL_ZIGBEE_ZCL_STATUS_SUCCESS if the received ZCL command was handled.

• SL_ZIGBEE_ZCL_STATUS_UNSUP_COMMAND if the received ZCL command was not handled.

void my_zcl_command_handler(sl_service_opcode_t opcode,
                            sl_service_function_context_t *context)
{
  assert(opcode == SL_SERVICE_FUNCTION_TYPE_ZCL_COMMAND);

  sl_zigbee_af_cluster_command_t *cmd = (sl_zigbee_af_cluster_command_t *)context->data;

  switch (cmd->commandId) {
    case ZCL_STOP_COMMAND_ID:
    {
      // ZCL command structs and parsing functions are implemented in the
      // generated zap-cluster-command-parser.[c,h] files.
      sl_zcl_level_control_cluster_stop_command_t cmd_data;

      if (zcl_decode_level_control_cluster_stop_command(cmd, &cmd_data)
          != SL_ZIGBEE_ZCL_STATUS_SUCCESS) {
        return SL_ZIGBEE_ZCL_STATUS_UNSUP_COMMAND;
      }

      // Handle the command here

      // Send a default response back to the client
      sl_zigbee_af_send_default_response(SL_ZIGBEE_ZCL_STATUS_SUCCESS);

      return SL_ZIGBEE_ZCL_STATUS_SUCCESS;
    }
  }

  return SL_ZIGBEE_ZCL_STATUS_UNSUP_COMMAND;
}

void app_init(void)
{
  sl_zigbee_subscribe_to_zcl_commands(ZCL_LEVEL_CONTROL_CLUSTER_ID,
                                      0xFFFF, // not manufacturer specific
                                      ZCL_DIRECTION_SERVER_TO_CLIENT,
                                      my_zcl_command_handler);
}