Top Description Methods
org.osgi.service.zigbee

public Interface ZCLHeader


This interface represents the ZCL Frame Header.
Author
$Id: 69b3f887ad1d7065820715473e1a25669c3f1885 $

Method Summary

Modifier and TypeMethod and Description
public short

Returns:

the command identifier of this frame.
getCommandId
()

Returns the command identifier of this frame.

public short

Returns:

the frame control field of this frame.
getFrameControlField
()

Returns the Frame Control field of this frame.

public int

Returns:

the manufacturer code if the ZCL Frame is manufacturer specific, otherwise returns -1.
getManufacturerCode
()

Returns the manufacturer code of this frame.

public byte

Returns:

the transaction sequence number of this frame.
getSequenceNumber
()

Returns the transaction Sequence Number of this frame.

public boolean

Returns:

the isClientServerDirection value.
isClientServerDirection
()

Checks the client server direction of the frame.

public boolean

Returns:

true if the frame control field states that the command is cluster specific. Returns false otherwise.
isClusterSpecificCommand
()

Checks the frame Type Sub-field of the frame control field.

public boolean

Returns:

true if the ZCL Header Frame Control Field "Disable Default Response Sub-field" is 1. Returns false otherwise.
isDefaultResponseDisabled
()

Checks if the default response is disabled.

public boolean

Returns:

true if the ZCL frame is manufacturer specific (that is, the Manufacturer Specific Sub-field of the ZCL Frame Control Field is 1.
isManufacturerSpecific
()

Checks if the frame is manufacturer specific.

Method Detail

getCommandIdback to summary
public short getCommandId()

Returns the command identifier of this frame.

Returns:short

the command identifier of this frame.

getFrameControlFieldback to summary
public short getFrameControlField()

Returns the Frame Control field of this frame.

Returns:short

the frame control field of this frame.

getManufacturerCodeback to summary
public int getManufacturerCode()

Returns the manufacturer code of this frame.

Returns:int

the manufacturer code if the ZCL Frame is manufacturer specific, otherwise returns -1.

getSequenceNumberback to summary
public byte getSequenceNumber()

Returns the transaction Sequence Number of this frame.

Returns:byte

the transaction sequence number of this frame.

isClientServerDirectionback to summary
public boolean isClientServerDirection()

Checks the client server direction of the frame.

Returns:boolean

the isClientServerDirection value.

isClusterSpecificCommandback to summary
public boolean isClusterSpecificCommand()

Checks the frame Type Sub-field of the frame control field.

Returns:boolean

true if the frame control field states that the command is cluster specific. Returns false otherwise.

isDefaultResponseDisabledback to summary
public boolean isDefaultResponseDisabled()

Checks if the default response is disabled.

Returns:boolean

true if the ZCL Header Frame Control Field "Disable Default Response Sub-field" is 1. Returns false otherwise.

isManufacturerSpecificback to summary
public boolean isManufacturerSpecific()

Checks if the frame is manufacturer specific.

Returns:boolean

true if the ZCL frame is manufacturer specific (that is, the Manufacturer Specific Sub-field of the ZCL Frame Control Field is 1.