Package org.osgi.service.zigbee
Interface ZCLEventListener
-
public interface ZCLEventListener
This interface represents a listener to events from ZigBee Device nodes.- Author:
- $Id: 97ceea3483027ce77b199906de490f2659796a8b $
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTRIBUTE_DATA_TYPE
Property key for the optional attribute data type of an attribute reporting configuration record, cf.static java.lang.String
MAX_REPORT_INTERVAL
Property key for the optional maximum interval, in seconds between issuing reports of the attribute.static java.lang.String
MIN_REPORT_INTERVAL
Property key for the optional minimum interval, in seconds between issuing reports of the attribute.static java.lang.String
REPORTABLE_CHANGE
Property key for the optional maximum change to the attribute that will result in a report being issued.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
notifyEvent(ZigBeeEvent event)
Notifies the reception of an event.void
notifyTimeOut(int timeout)
Notifies that the timeout is elapsed.void
onFailure(ZCLException e)
Notifies that a failure has occurred.
-
-
-
Field Detail
-
ATTRIBUTE_DATA_TYPE
static final java.lang.String ATTRIBUTE_DATA_TYPE
Property key for the optional attribute data type of an attribute reporting configuration record, cf. ZCL Figure 2.16 Format of the Attribute Reporting Configuration Record.- See Also:
- Constant Field Values
-
MIN_REPORT_INTERVAL
static final java.lang.String MIN_REPORT_INTERVAL
Property key for the optional minimum interval, in seconds between issuing reports of the attribute. A ZigBee Event Listener service can declare the minimum frequency at which events it wants notifications.- See Also:
- Constant Field Values
-
MAX_REPORT_INTERVAL
static final java.lang.String MAX_REPORT_INTERVAL
Property key for the optional maximum interval, in seconds between issuing reports of the attribute. A ZigBee Event Listener service can declare the maximum frequency at which events it wants notifications.- See Also:
- Constant Field Values
-
REPORTABLE_CHANGE
static final java.lang.String REPORTABLE_CHANGE
Property key for the optional maximum change to the attribute that will result in a report being issued. A ZigBee Event Listener service can declare the maximum frequency at which events it wants notifications.- See Also:
- Constant Field Values
-
-
Method Detail
-
notifyEvent
void notifyEvent(ZigBeeEvent event)
Notifies the reception of an event. This method is called asynchronously.- Parameters:
event
- a set of events.
-
onFailure
void onFailure(ZCLException e)
Notifies that a failure has occurred.That is, when either a
ZCLException.UNSUPPORTED_ATTRIBUTE
,ZCLException.UNREPORTABLE_TYPE
,ZCLException.INVALID_VALUE
, orZCLException.INVALID_DATA_TYPE
status occurs.- Parameters:
e
- the ZCLException.
-
notifyTimeOut
void notifyTimeOut(int timeout)
Notifies that the timeout is elapsed. No event will be received in the interval.- Parameters:
timeout
- the timeout in seconds.
-
-