Package org.osgi.service.zigbee.descriptors

Interface ZigBeeSimpleDescriptor

public interface ZigBeeSimpleDescriptor
This interface represents a simple descriptor as described in the ZigBee Specification.

The Simple Descriptor contains information specific to each endpoint present in the node.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getApplicationDeviceId()
    Returns the application device id as defined per profile.
    byte
    getApplicationDeviceVersion()
    Returns the version of the endpoint application.
    int
    getApplicationProfileId()
    Returns the application profile id.
    short
    getEndpoint()
    Returns the endpoint for which this descriptor is defined.
    int[]
    getInputClusters()
    Returns an array of input (server) cluster identifiers.
    int[]
    getOutputClusters()
    Returns an array of output (client) cluster identifiers.
    boolean
    providesInputCluster(int clusterId)
    Checks if this endpoint implements the given cluster id as an input cluster.
    boolean
    providesOutputCluster(int clusterId)
    Checks if this endpoint implements the given cluster id as an output cluster.

  • Method Details

    • getApplicationProfileId

      int getApplicationProfileId()
      Returns the application profile id.
      Returns:
      the application profile id.

    • getApplicationDeviceId

      int getApplicationDeviceId()
      Returns the application device id as defined per profile.
      Returns:
      the application device id as defined per profile.

    • getEndpoint

      short getEndpoint()
      Returns the endpoint for which this descriptor is defined.
      Returns:
      the endpoint for which this descriptor is defined.

    • getApplicationDeviceVersion

      byte getApplicationDeviceVersion()
      Returns the version of the endpoint application.
      Returns:
      the version of the endpoint application.

    • getInputClusters

      int[] getInputClusters()
      Returns an array of input (server) cluster identifiers.
      Returns:
      an array of input (server) cluster identifiers, returns an empty array if does not provides any input (server) clusters.

    • getOutputClusters

      int[] getOutputClusters()
      Returns an array of output (client) cluster identifiers.
      Returns:
      an array of output (client) cluster identifiers, returns an empty array if does not provides any output (client) clusters.

    • providesInputCluster

      boolean providesInputCluster(int clusterId)
      Checks if this endpoint implements the given cluster id as an input cluster.
      Parameters:
      clusterId - the cluster identifier.
      Returns:
      true if and only if this endpoint implements the given cluster id as an input cluster.

    • providesOutputCluster

      boolean providesOutputCluster(int clusterId)
      Checks if this endpoint implements the given cluster id as an output cluster.
      Parameters:
      clusterId - the cluster identifier.
      Returns:
      true if and only if this endpoint implements the given cluster id as an output cluster.