Package org.osgi.service.zigbee

Class ZigBeeDataTypes

java.lang.Object
org.osgi.service.zigbee.ZigBeeDataTypes
public class ZigBeeDataTypes extends Object
This class contains the constants that are used internally by these API to represent the ZCL data types.

These constants do not match the values used in the ZigBee specification, but follow the rules below:

  • bit 0-3: if bit 6 is one, these bits represents the size of the data type in bytes.
  • bit 6: if set to 1 bits 0-3 represents the size of the data type in bytes.

Related documentation: [1] ZigBee Cluster Library specification, Document 075123r04ZB, May 29, 2012.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    ARRAY
    According to ZigBee Cluster Library [1], an Array is an ordered sequence of zero or more elements, all of the same data type.
    static final short
    ATTRIBUTE_ID
    The type of an attribute identifier.
    static final short
    BACNET_OID
    According to ZigBee Cluster Library [1], the BACnet OID data type is included to allow interworking with BACnet.
    static final short
    BAG
    According to ZigBee Cluster Library [1], a Bag behaves exactly the same as a Set, except that two elements may have the same value.
    static final short
    BITMAP_16
    Bitmap16-bit
    static final short
    BITMAP_24
    Bitmap 24-bit
    static final short
    BITMAP_32
    Bitmap 32-bit
    static final short
    BITMAP_40
    Bitmap 40-bit
    static final short
    BITMAP_48
    Bitmap 48-bit
    static final short
    BITMAP_56
    Bitmap 56-bit
    static final short
    BITMAP_64
    Bitmap 64-bit
    static final short
    BITMAP_8
    According to ZigBee Cluster Library [1], the Bitmap type holds logical values, one per bit, depending on its length.
    static final short
    BOOLEAN
    According to ZigBee Cluster Library [1], the Boolean type represents a logical value, either FALSE (0x00) or TRUE (0x01).
    static final short
    CHARACTER_STRING
    According to ZigBee Cluster Library [1], the Character String data type contains data octets encoding characters according to the language and character set field of the complex descriptor.
    static final short
    CLUSTER_ID
    The type of a cluster identifier.
    static final short
    DATE
    The Date data type format is specified in section 2.5.2.20 of ZigBee Cluster Specification [1].
    static final short
    ENUMERATION_16
    Enumeration 16-bit
    static final short
    ENUMERATION_8
    According to ZigBee Cluster Library [1], the Enumeration type represents an index into a lookup table to determine the final value.
    static final short
    FLOATING_DOUBLE
    According to ZigBee Cluster Library [1], the format of the double precision data type is based on the IEEE 754 standard for binary floating-point arithmetic.
    static final short
    FLOATING_SEMI
    According to ZigBee Cluster Library [1], the ZigBee semi-precision number format is based on the IEEE 754 standard for binary floating-point arithmetic.
    static final short
    FLOATING_SINGLE
    According to ZigBee Cluster Library [1], the format of the single precision data type is based on the IEEE 754 standard for binary floating-point arithmetic.
    static final short
    GENERAL_DATA_16
    General Data 16-bit
    static final short
    GENERAL_DATA_24
    General Data 24-bit
    static final short
    GENERAL_DATA_32
    General Data 32-bit
    static final short
    GENERAL_DATA_40
    General Data 40-bit
    static final short
    GENERAL_DATA_48
    General Data 48-bit
    static final short
    GENERAL_DATA_56
    General Data 56-bit
    static final short
    GENERAL_DATA_64
    General Data 64-bit
    static final short
    GENERAL_DATA_8
    According to ZigBee Cluster Library [1], the General Data type may be used when a data element is needed but its use does not conform to any of other types.
    static final short
    IEEE_ADDRESS
    According to ZigBee Cluster Library [1], the IEEE Address data type is a 64-bit IEEE address that is unique to every ZigBee device.
    static final short
    LONG_CHARACTER_STRING
    According to ZigBee Cluster Library [1], the Long Character String data type contains data octets encoding characters according to the language and character set field of the complex descriptor.
    static final short
    LONG_OCTET_STRING
    According to ZigBee Cluster Library [1], the Long Octet String data type contains data in application-defined formats.
    static final short
    NO_DATA
    According to ZigBee Cluster Library [1], the no data type represents an attribute with no associated data.
    static final short
    OCTET_STRING
    According to ZigBee Cluster Library [1], the Octet String data type contains data in application-defined formats.
    static final short
    SECURITY_KEY_128
    According to ZigBee Cluster Library [1], the 128-bit Security Key data type is for use in ZigBee security, and may take any 128-bit value.
    static final short
    SET
    According to ZigBee Cluster Library [1], a Set is a collection of elements with no associated order.
    static final short
    SIGNED_INTEGER_16
    Signed Integer 16-bit
    static final short
    SIGNED_INTEGER_24
    Signed Integer 24-bit
    static final short
    SIGNED_INTEGER_32
    Signed Integer 32-bit
    static final short
    SIGNED_INTEGER_40
    Signed Integer 40-bit
    static final short
    SIGNED_INTEGER_48
    Signed Integer 48-bit
    static final short
    SIGNED_INTEGER_56
    Signed Integer 56-bit
    static final short
    SIGNED_INTEGER_64
    Signed Integer 64-bit
    static final short
    SIGNED_INTEGER_8
    According to ZigBee Cluster Library [1], the Signed Integer type represents a signed integer with a decimal range of -(2^7-1) to 2^7-1, - (2^15-1) to 2^15-1, -(2^23-1) to 2^23-1, -(2^31-1) to 2^31-1, -(2^39-1) to 2^39-1, -(2^47-1) to 2^47-1, -(2^55-1) to 2^55-1, or -(2^63-1) to 2^63-1, depending on its length.
    static final short
    STRUCTURE
    According to ZigBee Cluster Library [1], a Structure is an ordered sequence of elements, which may be of different data types.
    static final short
    TIME_OF_DAY
    The Time of Day data type format is specified in section 2.5.2.19 of ZCL specification [1].
    static final short
    UNKNOWN
    The UNKNOWN type is used when the data type is unknown.
    static final short
    UNSIGNED_INTEGER_16
    Unsigned Integer 16-bit
    static final short
    UNSIGNED_INTEGER_24
    Unsigned Integer 24-bit
    static final short
    UNSIGNED_INTEGER_32
    Unsigned Integer 32-bit
    static final short
    UNSIGNED_INTEGER_40
    Unsigned Integer 40-bit
    static final short
    UNSIGNED_INTEGER_48
    Unsigned Integer 48-bit
    static final short
    UNSIGNED_INTEGER_56
    Unsigned Integer 56-bit
    static final short
    UNSIGNED_INTEGER_64
    Unsigned Integer 64-bit
    static final short
    UNSIGNED_INTEGER_8
    According to ZigBee Cluster Library [1], the Unsigned Integer type represents an unsigned integer with a decimal range of 0 to 2^8-1, 0 to 2^16-1, 0 to 2^24-1, 0 to 2^32-1, 0 to 2^40-1, 0 to 2^48-1, 0 to 2^56-1, or 0 to 2^64-1, depending on its length.
    static final short
    UTC_TIME
    According to ZigBee Cluster Library [1], UTCTime is an unsigned 32-bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 2000 UTC (Universal Coordinated Time).

  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • NO_DATA

      public static final short NO_DATA
      According to ZigBee Cluster Library [1], the no data type represents an attribute with no associated data.
      See Also:

    • GENERAL_DATA_8

      public static final short GENERAL_DATA_8
      According to ZigBee Cluster Library [1], the General Data type may be used when a data element is needed but its use does not conform to any of other types. The General Data type is defined with several sizes: 8, 16, 24, 32, 40, 48, 56 and 64 bits.
      See Also:

    • GENERAL_DATA_16

      public static final short GENERAL_DATA_16
      General Data 16-bit
      See Also:

    • GENERAL_DATA_24

      public static final short GENERAL_DATA_24
      General Data 24-bit
      See Also:

    • GENERAL_DATA_32

      public static final short GENERAL_DATA_32
      General Data 32-bit
      See Also:

    • GENERAL_DATA_40

      public static final short GENERAL_DATA_40
      General Data 40-bit
      See Also:

    • GENERAL_DATA_48

      public static final short GENERAL_DATA_48
      General Data 48-bit
      See Also:

    • GENERAL_DATA_56

      public static final short GENERAL_DATA_56
      General Data 56-bit
      See Also:

    • GENERAL_DATA_64

      public static final short GENERAL_DATA_64
      General Data 64-bit
      See Also:

    • BOOLEAN

      public static final short BOOLEAN
      According to ZigBee Cluster Library [1], the Boolean type represents a logical value, either FALSE (0x00) or TRUE (0x01). The value 0xff represents an invalid value of this type. All other values of this type are forbidden.
      See Also:

    • BITMAP_8

      public static final short BITMAP_8
      According to ZigBee Cluster Library [1], the Bitmap type holds logical values, one per bit, depending on its length. There is no value that represents an invalid value of this type. The Bitmap type is defined with several sizes: 8, 16, 24, 32, 40, 48, 56 and 64 bits.
      See Also:

    • BITMAP_16

      public static final short BITMAP_16
      Bitmap16-bit
      See Also:

    • BITMAP_24

      public static final short BITMAP_24
      Bitmap 24-bit
      See Also:

    • BITMAP_32

      public static final short BITMAP_32
      Bitmap 32-bit
      See Also:

    • BITMAP_40

      public static final short BITMAP_40
      Bitmap 40-bit
      See Also:

    • BITMAP_48

      public static final short BITMAP_48
      Bitmap 48-bit
      See Also:

    • BITMAP_56

      public static final short BITMAP_56
      Bitmap 56-bit
      See Also:

    • BITMAP_64

      public static final short BITMAP_64
      Bitmap 64-bit
      See Also:

    • UNSIGNED_INTEGER_8

      public static final short UNSIGNED_INTEGER_8
      According to ZigBee Cluster Library [1], the Unsigned Integer type represents an unsigned integer with a decimal range of 0 to 2^8-1, 0 to 2^16-1, 0 to 2^24-1, 0 to 2^32-1, 0 to 2^40-1, 0 to 2^48-1, 0 to 2^56-1, or 0 to 2^64-1, depending on its length. The values that represents an invalid value of this type are 0xff, 0xffff, 0xffffff, 0xffffffff, 0xffffffffff, 0xffffffffffff, 0xffffffffffffff and 0xffffffffffffffff respectively. This type is defined with several sizes: 8, 16, 24, 32, 40, 48, 56 and 64 bits.
      See Also:

    • UNSIGNED_INTEGER_16

      public static final short UNSIGNED_INTEGER_16
      Unsigned Integer 16-bit
      See Also:

    • UNSIGNED_INTEGER_24

      public static final short UNSIGNED_INTEGER_24
      Unsigned Integer 24-bit
      See Also:

    • UNSIGNED_INTEGER_32

      public static final short UNSIGNED_INTEGER_32
      Unsigned Integer 32-bit
      See Also:

    • UNSIGNED_INTEGER_40

      public static final short UNSIGNED_INTEGER_40
      Unsigned Integer 40-bit
      See Also:

    • UNSIGNED_INTEGER_48

      public static final short UNSIGNED_INTEGER_48
      Unsigned Integer 48-bit
      See Also:

    • UNSIGNED_INTEGER_56

      public static final short UNSIGNED_INTEGER_56
      Unsigned Integer 56-bit
      See Also:

    • UNSIGNED_INTEGER_64

      public static final short UNSIGNED_INTEGER_64
      Unsigned Integer 64-bit
      See Also:

    • SIGNED_INTEGER_8

      public static final short SIGNED_INTEGER_8
      According to ZigBee Cluster Library [1], the Signed Integer type represents a signed integer with a decimal range of -(2^7-1) to 2^7-1, - (2^15-1) to 2^15-1, -(2^23-1) to 2^23-1, -(2^31-1) to 2^31-1, -(2^39-1) to 2^39-1, -(2^47-1) to 2^47-1, -(2^55-1) to 2^55-1, or -(2^63-1) to 2^63-1, depending on its length. The values that represents an invalid value of this type are 0x80, 0x8000, 0x800000, 0x80000000, 0x8000000000, 0x800000000000, 0x80000000000000 and 0x8000000000000000 respectively. This type is defined with several sizes: 8, 16, 24, 32, 40, 48, 56 and 64 bits.
      See Also:

    • SIGNED_INTEGER_16

      public static final short SIGNED_INTEGER_16
      Signed Integer 16-bit
      See Also:

    • SIGNED_INTEGER_24

      public static final short SIGNED_INTEGER_24
      Signed Integer 24-bit
      See Also:

    • SIGNED_INTEGER_32

      public static final short SIGNED_INTEGER_32
      Signed Integer 32-bit
      See Also:

    • SIGNED_INTEGER_40

      public static final short SIGNED_INTEGER_40
      Signed Integer 40-bit
      See Also:

    • SIGNED_INTEGER_48

      public static final short SIGNED_INTEGER_48
      Signed Integer 48-bit
      See Also:

    • SIGNED_INTEGER_56

      public static final short SIGNED_INTEGER_56
      Signed Integer 56-bit
      See Also:

    • SIGNED_INTEGER_64

      public static final short SIGNED_INTEGER_64
      Signed Integer 64-bit
      See Also:

    • ENUMERATION_8

      public static final short ENUMERATION_8
      According to ZigBee Cluster Library [1], the Enumeration type represents an index into a lookup table to determine the final value. The values 0xff and 0xffff represent invalid values of the 8-bit and 16-bit types respectively.
      See Also:

    • ENUMERATION_16

      public static final short ENUMERATION_16
      Enumeration 16-bit
      See Also:

    • FLOATING_SEMI

      public static final short FLOATING_SEMI
      According to ZigBee Cluster Library [1], the ZigBee semi-precision number format is based on the IEEE 754 standard for binary floating-point arithmetic.
      See Also:

    • FLOATING_SINGLE

      public static final short FLOATING_SINGLE
      According to ZigBee Cluster Library [1], the format of the single precision data type is based on the IEEE 754 standard for binary floating-point arithmetic.
      See Also:

    • FLOATING_DOUBLE

      public static final short FLOATING_DOUBLE
      According to ZigBee Cluster Library [1], the format of the double precision data type is based on the IEEE 754 standard for binary floating-point arithmetic.
      See Also:

    • OCTET_STRING

      public static final short OCTET_STRING
      According to ZigBee Cluster Library [1], the Octet String data type contains data in application-defined formats.
      See Also:

    • CHARACTER_STRING

      public static final short CHARACTER_STRING
      According to ZigBee Cluster Library [1], the Character String data type contains data octets encoding characters according to the language and character set field of the complex descriptor.
      See Also:

    • LONG_OCTET_STRING

      public static final short LONG_OCTET_STRING
      According to ZigBee Cluster Library [1], the Long Octet String data type contains data in application-defined formats.
      See Also:

    • LONG_CHARACTER_STRING

      public static final short LONG_CHARACTER_STRING
      According to ZigBee Cluster Library [1], the Long Character String data type contains data octets encoding characters according to the language and character set field of the complex descriptor.
      See Also:

    • ARRAY

      public static final short ARRAY
      According to ZigBee Cluster Library [1], an Array is an ordered sequence of zero or more elements, all of the same data type. This data type may be any ZCL defined data type, including Array, Structure, Bag or Set. The total nesting depth is limited to 15.
      See Also:

    • STRUCTURE

      public static final short STRUCTURE
      According to ZigBee Cluster Library [1], a Structure is an ordered sequence of elements, which may be of different data types. Each data type may be any ZCL defined data type, including Array, Structure, Bag or Set. The total nesting depth is limited to 15.
      See Also:

    • SET

      public static final short SET
      According to ZigBee Cluster Library [1], a Set is a collection of elements with no associated order. Each element has the same data type, which may be any ZCL defined data type, including Array, Structure, Bag or Set. The nesting depth is limited to 15.
      See Also:

    • BAG

      public static final short BAG
      According to ZigBee Cluster Library [1], a Bag behaves exactly the same as a Set, except that two elements may have the same value.
      See Also:

    • TIME_OF_DAY

      public static final short TIME_OF_DAY
      The Time of Day data type format is specified in section 2.5.2.19 of ZCL specification [1].
      See Also:

    • DATE

      public static final short DATE
      The Date data type format is specified in section 2.5.2.20 of ZigBee Cluster Specification [1].
      See Also:

    • UTC_TIME

      public static final short UTC_TIME
      According to ZigBee Cluster Library [1], UTCTime is an unsigned 32-bit value representing the number of seconds since 0 hours, 0 minutes, 0 seconds, on the 1st of January, 2000 UTC (Universal Coordinated Time). The value that represents an invalid value of this type is 0xffffffffff.
      See Also:

    • CLUSTER_ID

      public static final short CLUSTER_ID
      The type of a cluster identifier.
      See Also:

    • ATTRIBUTE_ID

      public static final short ATTRIBUTE_ID
      The type of an attribute identifier.
      See Also:

    • BACNET_OID

      public static final short BACNET_OID
      According to ZigBee Cluster Library [1], the BACnet OID data type is included to allow interworking with BACnet. The format is described in the referenced standard.
      See Also:

    • IEEE_ADDRESS

      public static final short IEEE_ADDRESS
      According to ZigBee Cluster Library [1], the IEEE Address data type is a 64-bit IEEE address that is unique to every ZigBee device. A value of 0xffffffffffffffff indicates that the address is unknown.
      See Also:

    • SECURITY_KEY_128

      public static final short SECURITY_KEY_128
      According to ZigBee Cluster Library [1], the 128-bit Security Key data type is for use in ZigBee security, and may take any 128-bit value.
      See Also:

    • UNKNOWN

      public static final short UNKNOWN
      The UNKNOWN type is used when the data type is unknown.
      See Also: