Package org.osgi.service.zigbee

Interface ZigBeeLinkQuality

public interface ZigBeeLinkQuality
This interface represents an entry of the NeighborTableList.

See Table 2.126 NeighborTableList Record Format in ZIGBEE SPECIFICATION: 1_053474r17ZB_TSC-ZigBee-Specification.pdf.

"Consumers of this API must not implement this interface"

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CHILD_NEIGHBOR
    Constant value representing a child relationship between current ZigBeeNode and the neighbor.
    static final int
    OTHERS_NEIGHBOR
    Constant value representing a others relationship between current ZigBeeNode and the neighbor.
    static final int
    PARENT_NEIGHBOR
    Constant value representing a parent relationship between current ZigBeeNode and the neighbor.
    static final int
    PREVIOUS_CHILD_NEIGHBOR
    Constant value representing a previous child relationship between current ZigBeeNode and the neighbor.
    static final int
    SIBLING_NEIGHBOR
    Constant value representing a sibling relationship between current ZigBeeNode and the neighbor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDepth()
    Returns the depth field of the NeighborTableList Record Format.
    int
    getLQI()
    Returns the Link Quality Indicator.
    String
    getNeighbor()
    Returns the Service.PID referring to the ZigBeeNode representing a neighbor.
    int
    getRelationship()
    Returns the relationship with the neighbor.

  • Field Details

    • PARENT_NEIGHBOR

      static final int PARENT_NEIGHBOR
      Constant value representing a parent relationship between current ZigBeeNode and the neighbor.
      See Also:

    • CHILD_NEIGHBOR

      static final int CHILD_NEIGHBOR
      Constant value representing a child relationship between current ZigBeeNode and the neighbor.
      See Also:

    • SIBLING_NEIGHBOR

      static final int SIBLING_NEIGHBOR
      Constant value representing a sibling relationship between current ZigBeeNode and the neighbor.
      See Also:

    • OTHERS_NEIGHBOR

      static final int OTHERS_NEIGHBOR
      Constant value representing a others relationship between current ZigBeeNode and the neighbor.
      See Also:

    • PREVIOUS_CHILD_NEIGHBOR

      static final int PREVIOUS_CHILD_NEIGHBOR
      Constant value representing a previous child relationship between current ZigBeeNode and the neighbor.
      See Also:

  • Method Details

    • getNeighbor

      String getNeighbor()
      Returns the Service.PID referring to the ZigBeeNode representing a neighbor.
      Returns:
      the Service.PID referring to the ZigBeeNode representing a neighbor.

    • getLQI

      int getLQI()
      Returns the Link Quality Indicator. See the LQI field of the NeighborTableList Record Format.
      Returns:
      the Link Quality Indicator estimated by ZigBeeNode returning this for communicating with ZigBeeNode identified by the getNeighbor().

    • getDepth

      int getDepth()
      Returns the depth field of the NeighborTableList Record Format.
      Returns:
      the tree-depth of device.

    • getRelationship

      int getRelationship()
      Returns the relationship with the neighbor. See the Relationship field of the NeighborTableList Record Format.
      Returns:
      the relationship between ZigBeeNode returning this LQI and the ZigBeeNode identified by the getNeighbor().