Package org.osgi.service.zigbee.descriptions

Interface ZCLCommandDescription

public interface ZCLCommandDescription
This interface represents a ZCLCommandDescription.

  • Method Details

    • getId

      short getId()
      Returns the command identifier.
      Returns:
      the command identifier.

    • getName

      String getName()
      Returns the command name.
      Returns:
      the command name.

    • getShortDescription

      String getShortDescription()
      Returns the command functional description.
      Returns:
      the command functional description.

    • isMandatory

      boolean isMandatory()
      Checks if this command it mandatory.
      Returns:
      true, if and only if the command is mandatory.

    • getParameterDescriptions

      ZCLParameterDescription[] getParameterDescriptions()
      Returns an array of the parameter descriptions.
      Returns:
      an array of the parameter descriptions.

    • isClusterSpecificCommand

      boolean isClusterSpecificCommand()
      Returns:
      the isClusterSpecificCommand value.

    • getManufacturerCode

      int getManufacturerCode()
      Returns the manufacturer code. Default value is: -1 (no code).
      Returns:
      the manufacturer code.

    • isManufacturerSpecific

      boolean isManufacturerSpecific()
      Checks if the command is manufacturer specific.
      Returns:
      true if end only if getManufacturerCode() is not. -1.

    • isClientServerDirection

      boolean isClientServerDirection()
      Checks if this is a server-side command (that is going from the client to server direction).
      Returns:
      the isClientServerDirection value.