errorDescexception an error description.

□ Creates a APSException containing only a description, but no error codes. If issued on this exception the getErrorCode() and getZigBeeErrorCode() methods return the UNKNOWN_ERROR constant.

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the APSException(int, int, String) constructor, passing UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDescAn error description which explain the type of problem.

□ Creates a APSException containing a specific errorCode. Using this constructor with errorCode set to UNKNOWN_ERROR is equivalent to call APSException(String).

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.

zigBeeErrorCodeThe actual APS status code or UNKNOWN_ERROR if this status is unknown.

errorDescAn error description which explain the type of problem.

□ Creates a APSException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to UNKNOWN_ERROR is equivalent to call APSException(String).

□ Gets the current value of the attribute.

As described in section 2.4.1.3 Effect on Receipt of the ZCL specification, a Read attributes command can have the following status: ZCLException.SUCCESS, ZCLException.UNSUPPORTED_ATTRIBUTE, or ZCLException.INVALID_VALUE.

ReturnsA promise representing the completion of this asynchronous call. The response object returned by Promise.getValue() is the requested attribute value in the relevant Java data type (see getDataType() method and ZCLDataTypeDescription.getJavaDataType()) or in byte[] if getDataType() returns null. The response object is null if an ZCLException.UNSUPPORTED_ATTRIBUTE or ZCLException.INVALID_VALUE error occurs and the adequate ZCLException is returned by Promise.getFailure() .

valuethe Java value to set.

□ Sets the current value of the attribute.

As described in section 2.4.3.3 Effect on Receipt of the ZCL specification, a Write attributes command may return the following status: ZCLException.SUCCESS, ZCLException.UNSUPPORTED_ATTRIBUTE, ZCLException.INVALID_DATA_TYPE, ZCLException.READ_ONLY, ZCLException.INVALID_VALUE, or ZDPException.NOT_AUTHORIZED.

ReturnsA promise representing the completion of this asynchronous call. Promise.getFailure() returns null if the attribute value has been successfully written. The adequate ZigBeeException is returned otherwise.

□ Returns the data type of this attribute.

ReturnsThe attribute data type. It may be null if the data type is not retrievable (issue with read attribute and discover attributes commands).

□ Returns the ID of this attribute.

Returnsthe attribute identifier (that is, the attribute's ID).

□ Returns the manufacturer code of this attribute.

ReturnsThe manufacturer code that defined this attribute, if the attribute does not belong to any manufacture extension then it returns -1.

□ Checks if the attribute is manufacturer specific.

Returns true if and only if this attribute is related to a manufacturer extension.

attributeIdthe ZCL attribute identifier.

□ Returns the cluster ZCLAttribute identifying that matches the given attributeId. ZCLCluster.getAttribute(int, int) method retrieves manufacturer-specific attributes.

ReturnsA promise representing the completion of this asynchronous call. In case of success in getting the attribute, the promise will be resolved with a ZCLAttribute instance. If attributeId do not exist in the cluster, then the promise fails with a ZCLException with status code ZCLException.UNSUPPORTED_ATTRIBUTE.

attributeIdthe ZCL attribute identifier

codethe manufacturer code of the attribute to be retrieved. If -1 is used, the method behaves exactly like ZCLCluster.getAttribute(int)

□ Retrieves a ZCLAttribute object for a manufacturer specific attribute. If the code parameter is -1 it behaves like the ZCLCluster.getAttribute(int) and retrieves the non-manufacturer specific attribute attributeId.

ReturnsA Promise representing the completion of this asynchronous call. The promise will be resolved with the requested ZCLAttribute. If a command such as ZCL Read Attributes or Discover Attributes has already been called once by the ZigBee host, the Promise can be quickly resolved. The resolution may be longer the first time one of the ZCLCluster methods to get one or all attributes is successfully called. If attributeId do not exist in the cluster, then the promise fails with a ZCLException with status code ZCLException.UNSUPPORTED_ATTRIBUTE

□ Returns an array of ZCLAttribute objects representing all this cluster's attributes.

This method returns only standard attributes. To retrieve manufacturer specific attributes use method ZCLCluster.getAttributes(int)

ReturnsA Promise representing the completion of this asynchronous call. The promise will be resolved with an array of ZCLAttribute objects.

codeThe the manufacturer code. Pass -1 to retrieve standard (that is, non-manufacturer specific) attributes.

□ Returns an array of ZCLAttribute objects representing all the specific manufacturer attributes available on the cluster.

This method behaves like the ZCLCluster.getAttributes() method if the passed value is -1.

ReturnsA Promise representing the completion of this asynchronous call. The promise will be resolved with an array of ZCLAttribute objects. If a command such as ZCL Read Attributes or Discover Attributes has already been called once by the ZigBee host, the Promise can be quickly resolved. The resolution may be longer the first time one of the ZCLCluster methods to get one or all attributes is successfully called.

□ Returns an array of all the commandIds of the ZCLCluster.

This method is implemented for ZCL devices compliant version equal or later than 1.2 of the Home Automation Profile or other profiles that adds a general command that enables discovery of command identifiers. When the device implements a profile that does not support this feature, the promise fails with a ZCLException with code ZCLException.GENERAL_COMMAND_NOT_SUPPORTED.

ReturnsA Promise representing the completion of this asynchronous call. The promise will be resolved with short[] containing the command identifiers supported by the cluster.

□ Returns the identifier of this cluster.

Returnsthe cluster identifier.

frameThe frame containing the command to issue.

□ Invokes a command on this cluster with a ZCLFrame. The returned promise provides the invocation response in an asynchronous way. The source endpoint is not specified in this method call. To send the appropriate message on the network, the base driver must generate a source endpoint. The latter must not correspond to any exported endpoint.

ReturnsA promise representing the completion of this asynchronous call. Promise.getValue() returns the response ZCLFrame.

frameThe frame containing the command to issue.

exportedServicePID: the source endpoint of the command request. In targeted situations, the source endpoint is the valid service PID of an exported endpoint.

□ Invokes a command on this cluster. This method is to be used by applications when the targeted device has to distinguish between source endpoints of the message. For instance, alarms cluster (see 3.11 Alarms Cluster in [ZCL]) generated events are differently interpreted if they come from the oven or from the intrusion alert system.

ReturnsA promise representing the completion of this asynchronous call. Promise.getValue() returns the response ZCLFrame.

attributesAn array of ZCLAttributeInfo.

□ Reads a list of attributes by issuing a ZCL Read Attributes command. The attribute list is provided in terms of an array of ZCLAttributeInfo objects.

As described in section 2.4.1.3 Effect on Receipt of the ZCL specification, a Read Attributes command results in a list of attribute status records comprising a mix of successful and unsuccessful attribute reads.

The method returns a promise. The object used to resolve the Promise is a Map<Integer, ZCLReadStatusRecord>. For each Map entry, the key contains the attribute identifier and the value, a ZigBee Read Attributes Status Record, which is made of the status of the read of this attribute, the ZigBee data type of the attribute and the attribute value in the corresponding Java wrapper type (or null in case of an unsupported attribute or in case of an invalid value). For attributes which data type serialization is not supported (that is, ZCLDataTypeDescription.getJavaDataType() returns null), the value is of type byte[].

When the list of attributes do not fit into a single ZCLFrame, ZigBee clusters truncate the list of attributes returned in the response. The client has to check the Map of results to send a new request for the attributes which values are missing. In export situations, the base driver may truncate the read attribute command response sent to networked devices in order to obey the rules.

NOTE: According to the ZigBee Specification all the attributes must be standard attributes or belong to the same manufacturer code, otherwise the promise must fail with a IllegalArgumentException exception.

ReturnsA promise representing the completion of this asynchronous call. The promise may fail with an IllegalArgumentException if the array size is 0 or if one of the array entries is null or not valid. An IllegalArgumentException is also thrown if some of ZCLAttributeInfo are manufacturer specific and other are standard, or even if there are mix of attributes with different manufacturer specific code. If the passed argument is null the promise must fail with a NullPointerException.

undivided true if an undivided write attributes command is requested, false if not.

attributesAndValuesA Map<ZCLAttributeInfo, Object> of attributes and values to be written. For ZCLAttributeInfo objects which serialization is not supported (that is, getDataType().getJavaDataType() returns null), the value must be of type byte[].

□ Writes a set of attributes on the cluster using the ZCL Write Attributes or the Write Attributes Undivided commands, according to the passed undivided parameter.

The promise resolves with a Map<Integer, Integer>. If all the attributes have been written successfully, the map is empty. In case of failure in writing specific attribute(s), the map is filled with entries related to those attributes. Every key is set with the id of an attribute that was not written successfully, every value with the status returned in the associated write attribute response record accordingly re-mapped to one of the constants defined in the ZCLException class.

According to the ZigBee Specification all the attributes must be standard attributes or, if manufacturer-specific they must have the same manufacturer code, otherwise an IllegalArgumentException occurs.

ReturnsA promise representing the completion of this asynchronous call. If resolved successfully the promise may return an empty Map<Integer, Integer>. Otherwise the map will be filled with the status information about the attributes that were not written. The key represents the attributeID and the value the status present in the corresponding attribute record returned by the ZCL Write Attributes response message. The original ZCL status values must be re-mapped to the list of status values listed in the ZCLException class. The promise may fail with an IllegalArgumentException if some of ZCLAttributeInfo are manufacturer specific and other are standard, or even if there are mix of attributes with different manufacturer specific code.

□ Returns a promise holding the response.

ReturnsA Promise holding the ZCLFrame response, or a failure exception if this is not a success response.

□ Checks if this is a terminal close event.

Returns true if this is a terminal close event.

□ Closes this response, indicating that no further responses are needed. Any buffered responses will be discarded, and a close event will be sent to a handler if it is registered.

handlerA handler to process ZCLCommandResponse objects

□ Registers a handler that will be called for each of the received responses. Only one handler may be registered. Any responses that arrive before a handler is registered will be buffered and pushed into the handler when it is registered. If the handler returns false from its accept method then the handler will be released and no further events will be delivered. Any remaining buffered events will be discarded, and this object marked as closed. If the handler does not close the stream early then the ZigBee service implementation will eventually send a close event.

Throws IllegalStateException– if a handler has already been registered, or if this object has been closed (a ZCLCommandResponse which returns true from ZCLCommandResponse.isEnd(). After a close event the handler function will be dereferenced.

eventa set of events.

□ Notifies the reception of an event. This method is called asynchronously.

timeoutthe timeout in seconds.

□ Notifies that the timeout is elapsed. No event will be received in the interval.

ethe ZCLException.

□ Notifies that a failure has occurred.

That is, when either a ZCLException.UNSUPPORTED_ATTRIBUTE, ZCLException.UNREPORTABLE_TYPE, ZCLException.INVALID_VALUE, or ZCLException.INVALID_DATA_TYPE status occurs.

errorDescexception error description.

□ Creates a ZCLException containing only a description, but no error codes. If issued on this exception the getErrorCode() and getZigBeeErrorCode() methods return the UNKNOWN_ERROR constant.

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the ZCLException(int, int, String) constructor, passing UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDescAn error description which explain the type of problem.

□ Creates a ZCLException containing a specific errorCode. Using this constructor with errorCode set to UNKNOWN_ERROR is equivalent to call ZCLException(String).

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.

zigBeeErrorCodeThe actual ZCL status code or UNKNOWN_ERROR if this status is unknown.

errorDescAn error description which explain the type of problem.

□ Creates a ZCLException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to UNKNOWN_ERROR is equivalent to call ZCLException(String).

□ Returns a byte array containing the raw ZCL frame, suitable to be sent on the wire. The returned byte array contains the whole ZCL Frame, including the ZCL Frame Header and the ZCL Frame payload.

Returnsa byte array containing a raw ZCL frame, suitable to be sent on the wire. Any modifications issued on the returned array must not affect the internal representation of the ZCLFrame interface implementation.

bufferThe buffer where to copy the raw ZCL frame.

□ Copy in the passed array the internal raw ZCLFrame.

ReturnsThe actual number of bytes copied.

□ Returns ZigBeeDataInput for reading the ZCLFrame payload content. Every call to this method returns a different instance. The returned instances must not share the current position to the underlying ZCLFrame payload.

Returnsa DataInput for the payload of the ZCLFrame. This method does not generate a copy of the payload.

Throws IllegalStateException– if the InputStream is not available.

□ Returns the header of this frame.

Returnsthe header of this frame.

□ Retrieve the current size of the internal raw frame (that is the size of the byte[] that would be returned if calling the getBytes() method.

ReturnsThe size of the raw ZCL frame.

□ Returns the command identifier of this frame.

Returnsthe command identifier of this frame.

□ Returns the Frame Control field of this frame.

Returnsthe frame control field of this frame.

□ Returns the manufacturer code of this frame.

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

□ Returns the transaction Sequence Number of this frame.

Returnsthe transaction sequence number of this frame.

□ Checks the client server direction of the frame.

Returnsthe isClientServerDirection value.

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

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

□ Checks if the default response is disabled.

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

□ Checks if the frame is manufacturer specific.

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

□ Returns the ZCLAttributeInfo related to the reading operation.

Returnsthe ZCLAttributeInfo related to the reading operation.

□ Returns the potential failure of the reading operation.

Returnsnull in case of success, otherwise the ZigBeeException specifying the failing of the reading.

□ Returns the value of the related read attribute.

Returnsnull in case of failure or invalid data, otherwise the Java Object representing the ZigBee value.

errorDescexception error description.

□ Creates a ZDPException containing only a description, but no error codes. If issued on this exception the getErrorCode() and getZigBeeErrorCode() methods return the UNKNOWN_ERROR constant.

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface. In this case if the native ZigBee error code is known, it is preferred to use the ZDPException(int, int, String) constructor, passing UNKNOWN_ERROR as first parameter and the native ZigBee error as the second.

errorDescAn error description which explain the type of problem.

□ Creates a ZDPException containing a specific errorCode. Using this constructor with errorCode set to UNKNOWN_ERROR is equivalent to call ZDPException(String).

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface. In this case the zigBeeErrorCode parameter must be the actual status code returned by the ZigBee stack.

zigBeeErrorCodeThe actual ZDP status code or UNKNOWN_ERROR if this status is unknown.

errorDescAn error description which explain the type of problem.

□ Creates a ZDPException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to UNKNOWN_ERROR is equivalent to call ZDPException(String).

□ Returns the ZigBeeDataInput of the payload of this frame.

Returnsthe ZigBeeDataInput of the payload of the ZDPFrame. This method, in contrary to getPayload(), doesn't require to create a copy of the payload.

Throws IllegalStateException– if a ZigBeeDataInput stream cannot be returned because the underlying ZDPFrame implementation was not correctly initialized.

□ Returns a copy of the payload of this frame.

ReturnsA copy of the payload of this frame.

□ Returns the clusterId this response refers to.

Returnsthe clusterId this response refers to.

□ Returns the ZDPFrame containing the response.

Returnsthe ZDPFrame containing the response.

□ Reads a byte from the DataInput Stream.

Returnsthe byte read from the data input.

Throws EOFException– When the end of the input has been reached and there are no more data to read.

IOException– If an I/O error occurs.

lenthe number of bytes to read.

□ Reads the specified amount of bytes from the underlying stream and return a copy of them. If the number of available bytes is less than the requested len, it throws an EOFException.

Returnsreturn a copy of the bytes contained in the stream.

Throws EOFException– if there are not at least len bytes left on the data input.

IOException– If an I/O error occurs.

□ Reads a number of type Double.

Returnsa decoded double.

Throws EOFException– if there are not at least size 8 bytes left on the data input.

IOException– If an I/O error occurs.

sizeexpected value for this parameter are 2 or 4 depending if reading ZigBeeDataTypes.FLOATING_SEMI or ZigBeeDataTypes.FLOATING_SINGLE.

□ Reads a number of type Float.

ReturnsThe float number read from the data input.

Throws EOFException– if there are not at least size bytes left on the data input.

IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not in the allowed range.

sizethe number of bytes that have to be read. Allowed values for this parameter are in the range [1, 4].

□ Reads an integer of the specified size. The sign bit of the size-bytes integer is left-extended. In other words if a readInt(2) is issued and the byte read are 0x01, 0x02 and 0xf0, the method returns 0xfff00201. For this reason if the 4 bytes read from the stream represent an unsigned value, to get the expected value the and bitwise operator must be used:

int u = readInt(3) & 0xffffff;

Returnsthe integer read from the data input.

Throws EOFException– When the end of the input has been reached and there are no more data to read.

IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not in the allowed range.

sizethe number of bytes that have to be read. Allowed values for this parameter are in the range [1, 8].

□ Reads a certain amount of bytes and returns a long. The sign bit of the read size-bytes long is left-extended. In other words if a readLong(2) is issued and the byte read are 0x01 and 0xf0, the method returns 0xfffffffffffff001L. For this reason if the 2 bytes read from the stream represent an unsigned value, to get the expected value the and bitwise operator must be used:

long u = readLong(2) & 0xffff;

ReturnsThe long value read from the data input.

Throws EOFException– if there are not at least size bytes left on the data input.

IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not in the allowed range.

valueThe value to append.

□ Appends a byte to the data output.

To avoid losing information, the passed value must be in the range [-128, 127] for signed numbers and [0, 255] for unsigned numbers.

bytesA buffer containing the bytes to append to the data output stream.

lengthThe length in bytes that have to be actually appended.

□ Appends on the Data Output Stream a byte array. The byte array is written on the data output starting from the byte at index 0.

Throws IOException– If an I/O error occurs.

IllegalArgumentException– If the passed buffer is null or shorter than length bytes.

valueThe double value to append.

□ Appends on the Data Output Stream a double value.

Throws IOException– If an I/O error occurs.

valueThe float value to append.

sizeThe size in bytes that have to be actually appended. The size must be 2 for semi precision floats or 4 for standard precision floats (see the ZigBee Cluster Library specifications).

□ Appends on the Data Output Stream a float value.

Throws IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not within the allowed range.

valueThe integer value to append

sizeThe size in bytes that have to be actually appended. The size must be in the range [1,4].

□ Appends an int value to the data output.

To avoid losing information, according to the size argument, the passed long value if it represents a signed number must fit in the range [ -2^(size * 8 - 1), -2^(size * 8 - 1) - 1].

For unsigned numbers it should fit in the range [ 0, -2^(size * 8) - 1].

For instance if size is 2 the correct range for signed numbers is [0xffff8000, 0x7fff] (that is, [-32768, +32767]), whereas for unsigned numbers is [0L, 0xffff].

Although this method allows write even 1 byte of the passed int value, it is suggested to use the writeByte(byte) because this latter could be implemented in a more efficient way.

Throws IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not within the allowed range.

valueThe long value to append

sizeThe size in bytes that have to be actually appended. The size must be in the range [1,8].

□ Appends a long to the data output.

To avoid losing information, according to the size argument, the passed long value if it represents a signed number must fit in the range [ -2^(size * 8 - 1), -2^(size * 8 - 1) - 1].

For unsigned numbers it should fit in the range [ 0, -2^(size * 8) - 1].

For instance if size is 3 the correct range for signed numbers is [0xffffffffff800000L, 0x7fffffL] (that is, [-21474836448, +2147483647]), whereas for unsigned numbers is [0L, 0xffffffL].

Although this method allows write even 1 byte of the passed long value, it is suggested to use the writeByte(byte) because this latter could be implemented in a more efficient way.

Throws IOException– If an I/O error occurs.

IllegalArgumentException– If the passed size is not within the allowed range.

servicePidthe PID of the endpoint to bind to

clusterIdthe cluster identifier to bind to

□ Adds the following entry in the Binding Table of the device:

this.getNodeAddress(), this.getId(), clusterId, device.getNodeAddress(), device.getId()

As described in "Table 2.7 APSME-BIND.confirm Parameters" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a binding request can have the following results: APSException.SUCCESS, APSException.ILLEGAL_REQUEST, APSException.TABLE_FULL, APSException.NOT_SUPPORTED.

ReturnsA promise representing the completion of this asynchronous call. Promise.getFailure() returns null if the cluster has been successfully bound. The adequate ZigBeeEndpoint is returned otherwise.

clusterIdthe cluster identifier of the targeted bindings.

□ Returns bound endpoints (identified by their service PIDs) on a specific cluster ID. It is implemented on the base driver with Mgmt_Bind_req command. It is implemented without a command request in local endpoints.

As described in "Table 2.129 Fields of the Mgmt_Bind_rsp Command" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a Mgmt_Bind_rsp command can have the following status: APSException.NOT_SUPPORTED or any status code returned from the APSME-GET.confirm primitive (see APSException).

ReturnsA promise representing the completion of this asynchronous call. Promise.getValue() returns a List of the bound endpoint service PIDs if the command is successful. The response object is null and the adequate APSException is returned by Promise.getFailure() otherwise.

clientClusterIdThe client(output) cluster identifier.

□ Returns the client cluster identified by the cluster identifier.

Returnsthe client(output) cluster identified by the cluster identifier, or null if the given id is not listed in the simple descriptor.

Throws IllegalArgumentException– If the passed argument is outside the range [0, 0xffff].

□ Returns an array of client (output) clusters.

Returnsan array of client (output) clusters, returns an empty array if does not provides any clients clusters.

□ Returns the identifier of this endpoint, that is the Endpoint ID.

Returnsthe identifier of this endpoint, value ranges from 1 to 240.

□ Returns the IEEE Address of the node containing this endpoint.

Returnsthe IEEE Address of the node containing this endpoint.

serverClusterIdThe server(input) cluster identifier.

□ Returns the server (input) cluster identified by the given identifier.

Returnsthe server (input) cluster identified by the given identifier, or null if the given id is not listed in the simple descriptor.

Throws IllegalArgumentException– If the passed argument is outside the range [0, 0xffff].

□ Returns an array of server (input) clusters.

Returnsan array of server (input) clusters, returns an empty array if it does not provide any server cluster.

□ Returns the simple descriptor of this endpoint. As described in "Table 2.93 Fields of the Simple_Desc_rsp Command" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a simple_decr request can have the following status: ZDPException.SUCCESS, ZDPException.INVALID_EP, ZDPException.NOT_ACTIVE, ZDPException.DEVICE_NOT_FOUND, ZDPException.INV_REQUESTTYPE or ZDPException.NO_DESCRIPTOR.

ReturnsA promise representing the completion of this asynchronous call. Promise.getValue() returns the node simple descriptor ZigBeeSimpleDescriptor in case of success and Promise.getFailure() returns the adequate ZDPException otherwise.

eA device ZigBeeException the occurred exception.

□ Notifies that the base driver is unable to export this endpoint. This method is called by the base driver and used to give details about issues preventing the export of an endpoint.

servicePidThe pid of the service to unbind.

clusterIdThe cluster identifier to unbind.

□ Removes the following entry in the Binding Table of the device if it exists:

this.getNodeAddress(), this.getId(), clusterId, device.getNodeAddress(), device.getId()

As described in "Table 2.9 APSME-UNBIND.confirm Parameters" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, an unbind request can have the following results: APSException.SUCCESS, APSException.ILLEGAL_REQUEST, APSException.INVALID_BINDING.

ReturnsA promise representing the completion of this asynchronous call. Promise.getFailure() returns null if the cluster has been successfully bound. The adequate APSException is returned otherwise.

□ Returns the attribute identifier (that is, the attribute's ID).

Returnsthe attribute identifier (that is, the attribute's ID).

□ Returns the cluster id associated to this ZigBeeEvent.

Returnsthe cluster id.

□ Returns the endpoint identifier.

Returnsthe endpoint identifier.

□ Returns the ZigBee device node IEEE Address.

Returnsthe ZigBee device node IEEE Address.

□ Returns an object containing the new value of the related ZigBee attribute.

Returnsan object containing the new value for the ZigBee attribute that has changed.

errorDescexception error description.

□ Creates a ZigBeeException containing only a description, but no error codes. If issued on this exception the getErrorCode() and getZigBeeErrorCode() methods return the UNKNOWN_ERROR constant.

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR if the actual error is not listed in this interface.

errorDescAn error description which explain the type of problem.

□ Creates a ZigBeeException containing a specific errorCode. Using this constructor with errorCode set to UNKNOWN_ERROR is equivalent to call ZigBeeException(String).

errorCodeOne of the error codes defined in this interface or UNKNOWN_ERROR the actual error is not covered in this interface.

zigBeeErrorCodeThe actual status code or UNKNOWN_ERROR if this status is unknown.

errorDescAn error description which explain the type of problem.

□ Creates a ZigBeeException containing a specific errorCode or zigBeeErrorCode. Using this constructor with both the errorCode and zigBeeErrorCode set to UNKNOWN_ERROR is equivalent to call ZigBeeException(String).

□ Returns the error code.

Returnsthe error code.

□ Returns the potential ZigBee error code.

ReturnsOne of the error codes defined above. If the returned error code is UNKNOWN_ERROR and the hasZigBeeErrorCode() returns true then the getZigBeeErrorCode() provides the actual ZigBee error code returned by the device.

□ Checks if this exception has a ZigBee error code.

Returnstrue if the ZigBeeException convey also the actual error code returned by the ZigBee stack.

□ Returns the 16-bit group address.

Returnsthe 16-bit group address.

clusterIda cluster identifier.

framea command frame sequence.

□ Sends a ZCL frame to the group represented by this service. The returned stream will provide the invocation response(s) in an asynchronous way.

The source endpoint is not specified in this method call. To send the appropriate message on the network, the base driver must generate a source endpoint. The latter must not correspond to any exported endpoint.

Returnsa ZCLCommandResponseStream to collect every ZCL frame one after the other in case of multiple responses.

clusterIda cluster identifier.

framea command frame sequence.

exportedServicePID: the source endpoint of the command request. In targeted situations, the source endpoint is the valid service PID of an exported endpoint.

□ Sends a ZCL frame to the ZigBee group represented by this service. The returned stream will provide the invocation response(s) in an asynchronous way.

This method is to be used by applications when the targeted device has to distinguish between source endpoints of the message. For instance, alarms cluster (see 3.11 Alarms Cluster in [ZCL]) generated events are differently interpreted if they come from the oven or from the intrusion alert system.

Returnsa ZCLCommandResponseStream to collect every ZCL frame one after the other in case of multiple responses.

pidString representing the service PID of the ZigBeeEndpoint to add to this Group.

□ Requests an endpoint to join this group. This method may be invoked on exported and imported endpoints. In the former case, the ZigBee Base Driver should rely on the APSME-ADD-GROUP API defined by the ZigBee Specification, or it will use the proper commands of the Groups cluster of the ZigBee Specification Library. As described in "Table 2.15 APSME-ADD-GROUP.confirm Parameters" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, an add_group request can have the following status: APSException.SUCCESS, APSException.INVALID_PARAMETER or APSException.TABLE_FULL. When the joining is performed remotely on an imported ZigBeeEndpoint, it may also fail because the command is not supported by the remote endpoint, or because the remote device cannot perform the operation at the moment (see ZCLException).

ReturnsA promise representing the completion of this asynchronous call. Promise.getFailure() returns null if the cluster has been successfully bound. The adequate ZigBeeException is returned otherwise.

pidString representing the service PID of the ZigBeeEndpoint to remove from this Group.

□ Requests an endpoint to leave this group. This method may be invoked on exported and imported endpoints. In the former case, the ZigBee Base Driver should rely on the APSME-REMOVE-GROUP API defined by the ZigBee Specification, or it will use the proper commands of the Groups cluster of the ZigBee Specification Library. As described in "Table 2.17 APSME-REMOVE-GROUP.confirm Parameters" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a remove_group request can have the following status: APSException.SUCCESS, APSException.INVALID_GROUP or APSException.INVALID_PARAMETER. When the command is invoked remotely on an imported ZigBeeEndpoint, it may also fail because the command is not supported by the remote endpoint, or because the remote device cannot perform the operation at the moment (see ZCLException).

ReturnsA promise representing the completion of this asynchronous call. Promise.getFailure() returns null if the cluster has been successfully bound. The adequate ZigBeeException is returned otherwise.

clusterIDThe cluster ID this ZCL frame must be sent to.

frameA ZCL Frame.

□ Broadcasts a ZCL frame to the cluster ID of all the nodes of the ZigBee network. The setBroadcastRadius(short) method, may be used to limit the broadcast radius used in the subsequent broadcast calls.

Returnsa response stream instance that collects and allows the caller to be asynchronously notified about the ZCLFrame responses sent back by the ZigBee nodes.

clusterIDThe cluster ID.

frameA ZCL Frame.

exportedServicePIDthe source endpoint of the command request. In targeted situations, the source endpoint is the valid service PID of an exported endpoint.

□ Broadcasts a ZCL frame to the cluster ID of all the nodes of the ZigBee network. The passed exportedServicePID allows to force the source endpoint of the message sent to be the endpoint id of the exported ZigBeeEndPoint service having the specified service.pid property.

Returnsa response stream instance that collects and allows the caller to be asynchronously notified about the ZCLFrame responses sent back by the ZigBee nodes.

See Also Setting the broadcast radius.

groupAddressthe address of the group to create.

□ Creates a ZigBeeGroup service that has not yet been discovered by the ZigBee Base Driver or that does not exist on the ZigBee network yet.

Throws Exception– when a ZigBeeGroup service with the same groupAddress already exists.

□ Returns the current broadcast radius value.

Returnsthe current broadcast radius value.

□ Returns the current network channel.

Returnsthe current network channel.

Throws Exception– Any exception related to the communication with the chip.

□ Returns the currently configured channel mask.

Returnsthe currently configured channel mask.

Throws Exception– Any exception related to the communication with the chip.

□ Returns the current value set for the communication timeout.

Returnsthe current value set for the communication timeout expressed in milliseconds.

□ Returns the current preconfigured link key.

Returnsthe current preconfigured link key.

Throws Exception– Any exception related to the communication with the chip.

□ Returns the network security level.

Returnsthe network security level, that is, 0 if security is disabled, an int code if enabled (see "Table 4.38 Security Levels Available to the NWK, and APS Layers" of the ZigBee specification").

Throws Exception– Any exception related to the communication with the chip.

□ Checks the host's start/stop state.

Returnstrue if the host is started.

durationThe time during which associations are permitted.

□ Indicates if a ZigBee device can join the network.

Broadcasts a Mgmt_Permit_req to all routers and the coordinator. If the duration argument is not equal to zero or 0xFF, the argument is a number of seconds and joining is permitted until it counts down to zero, after which time, joining is not permitted. If the duration is set to zero, joining is not permitted. If set to 0xFF, joining is permitted indefinitely or until another Mgmt_Permit_Joining_req is received by the coordinator.

As described in "Table 2.133 Fields of the Mgmt_Permit_Joining_rsp Command" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a permitJoin request can have the following status: ZDPException.SUCCESS, ZDPException.INV_REQUESTTYPE, ZDPException.NOT_AUTHORIZED or any status code returned from the NLMEPERMITJOINING.confirm primitive.

Throws Exception– Any exception related to the communication with the chip.

□ Forces a new network scan. It checks that the ZigBeeNode services are still representing an available node on the network. It also updates the whole representation of all nodes (endpoints, clusters, descriptors, attributes).

ReturnsA promise representing the completion of this asynchronous call. In case of success the promise will resolve with Boolean.TRUE otherwise the promise is failed with an exception.

Throws Exception– Any exception related to the communication with the chip.

broadcastRadius- is the number of routers that the messages are allowed to cross. Radius value is in the range from 0 to 0xff.

□ Sets the broadcast radius value. By default the ZigBeeHost must use UNLIMITED_BROADCAST_RADIUS as default value for the broadcast.

Throws IllegalArgumentException– if set with a value out of the expected range.

IllegalStateException– if set when the ZigBeeHost is "running".

maskA value representing the channel mask.

□ Sets a new configured channel mask.

As described in "Table 2.13 APSME-SET.confirm Parameters" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, a set request can have the following status: APSException.SUCCESS, APSException.INVALID_PARAMETER or APSException.UNSUPPORTED_ATTRIBUTE.

Throws IllegalStateException– If the host is already started.

IOException– for serial communication exception.

timeoutthe number of milliseconds before firing a timeout exception.

□ Sets the timeout for the communication sent through this device.

extendedPanIdThe network Extended PAN identifier(EPID)

□ Sets the extendedPanId.

Throws IllegalStateException– If the host is already started.

logicalNodeTypeThe logical node type.

□ Sets the host logical node type. ZigBee defines three different types of node: ZigBeeNode.COORDINATOR, ZigBeeNode.ROUTER and ZigBeeNode.ZED.

Throws IllegalStateException– If the host is already started.

Exception– Any exception related to the communication with the chip.

panIdThe network Personal Area Network identifier (PAN ID)

□ Sets the panId.

Throws IllegalArgumentException– if set with a value out of the expected range [0x0000, 0xffff].

IllegalStateException– If the host is already started.

□ Starts the host. If the host is a ZigBeeNode.COORDINATOR, then it can be started with or without ZigBeeNode.PAN_ID and ZigBeeNode.EXTENDED_PAN_ID (that is, if no PAN_ID, and Extended PAN_ID are given, then they will be automatically generated and then added to the service properties).

If the host is a ZigBeeNode.ROUTER, or a ZigBeeNode.ZED, then the host may start without a registered ZigBeeNode.PAN_ID property; the property will be set when the host will find and join a ZigBee network.

The host status must be persistent, that is, if the host was started, then the host must starts again when the bundle restarts. In addition, the values of channel, pan id, extended pan id, and host PID must remain the same.

Throws Exception– Any exception related to the communication with the chip.

□ Stops the host.

Throws Exception– Any exception related to the communication with the chip.

channelThe network channel.

□ Updates the network channel. 802.15.4 and ZigBee divide the 2.4GHz band into 16 channels, numbered from 11 to 26.

As described in "Table 2.4.3.3.9 Mgmt_NWK_Update_req" of the ZigBee specification 1_053474r17ZB_TSC-ZigBee-Specification.pdf, this request is sent as broadcast by the network manager with a ScanDuration to be set with the channel parameter.

Throws IllegalStateException– If the host is started, or the host is not a network manager.

IOException– for serial communication exception.

□ Returns the depth field of the NeighborTableList Record Format.

Returnsthe tree-depth of device.

□ Returns the Link Quality Indicator. See the LQI field of the NeighborTableList Record Format.

Returnsthe Link Quality Indicator estimated by ZigBeeNode returning this for communicating with ZigBeeNode identified by the getNeighbor().

□ Returns the Service.PID referring to the ZigBeeNode representing a neighbor.

Returnsthe Service.PID referring to the ZigBeeNode representing a neighbor.

□ Returns the relationship with the neighbor. See the Relationship field of the NeighborTableList Record Format.

Returnsthe relationship between ZigBeeNode returning this LQI and the ZigBeeNode identified by the getNeighbor().

clusterIDthe cluster ID the broadcast message is directed.

framea ZCL Frame that contains the command that have to be broadcast to the specific cluster of all the endpoints running on the node.

□ Broadcasts a given ZCL Frame to cluster clusterID on all the ZigBeeEndpoint that are running on this node (endpoint broadcasting).

Returnsa response stream instance that collects and allows a client to be asynchronously notified about the ZCLFrame responses sent back by the ZigBee nodes.

clusterIDthe cluster ID the broadcast message is directed.

framea ZCL Frame that contains the command that have to be broadcast to the specific cluster of all the endpoints running on the node.

exportedServicePIDthe source endpoint of the command request. In targeted situations, the source endpoint is the valid service PID of an exported endpoint.

□ Broadcasts a given ZCL Frame to cluster clusterID on all the ZigBeeEndpoint that are running on this node (endpoint broadcasting). The source endpoint of the APS message sent, is set to the endpoint identifier of the exportedServicePID service.

Returnsa response stream instance that collects and allows the caller to be asynchronously notified about the ZCLFrame responses sent back by the ZigBee nodes.

□ Retrieves the ZigBee node Complex Descriptor.

As described in Table 2.92 Fields of the Complex_Desc_rsp Command of the ZigBee specification, a Complex_Desc_rsp command can return with the following status codes:

ReturnsA promise representing the completion of this asynchronous call. It will be used in order to return the complex descriptor ZigBeeComplexDescriptor. If the ZDP Complex_Desc_rsp do not return success, the promise must fail with a ZDPException exception with the correct status code.

□ Returns the array of the endpoints hosted by this node.

Returnsthe array of the endpoints hosted by this node, returns an empty array if this node does not host any endpoint.

□ Returns the network Extended PAN identifier (EPID).

Returnsthe network Extended PAN identifier (EPID).

□ Returns the OSGi service PID of the ZigBee Host that is on the network of this node.

Returnsthe OSGi service PID of the ZigBee Host that is on the network of this node.

□ Returns the ZigBee device node IEEE Address of this node.

Returnsthe ZigBee device node IEEE Address of this node.

□ Retrieves the link quality information to the neighbor nodes.

An implementation of this method may use the Mgmt_Lqi_req and Mgmt_Lqi_rsp messages to retrieve the Link Quality table (also known as NeighborTableList in the ZigBee Specification).

The method limit the Link Quality table to the ZigBeeNode service discovered.

In case of failure, the target device may report error code ZDPException.NOT_SUPPORTED.

ReturnsA promise representing the completion of this asynchronous call. It will be resolved with the result of this operation. In case of success the resolved value will be a Map containing the Service.PID as String key of the ZigBeeNode service and the value the ZigBeeLinkQuality for that node. In case of errors the promise must fail with the correct ZDPException.

□ Returns the current network address (alias short-address) of this node.

Returnsthe current network address of this node.

□ Retrieves the ZigBee node Node Descriptor. As described in Table 2.91 Fields of the Node_Desc_rsp Command of the ZigBee specification, a Node_Desc_rsp command can return with the following status codes:

ReturnsA promise representing the completion of this asynchronous call. It will be used in order to return the node descriptor ZigBeeNodeDescriptor. If the ZDP Node_Desc_rsp do not return success, the promise must fail with a ZDPException exception with the correct status code.

□ Returns the network Personal Area Network identifier (PAN ID).

Returnsthe network Personal Area Network identifier (PAN ID).

□ Retrieves the ZigBee node Power Descriptor. As described in Table 2.92 Fields of the Power_Desc_rsp Command of the ZigBee specification, a Power_Desc_rsp command can return with the following status codes:

ReturnsA promise representing the completion of this asynchronous call. It will be used in order to return the node power descriptor ZigBeePowerDescriptor. If the ZDP Power_Desc_rsp do not return success, the promise must fail with a ZDPException exception with the correct status code.

□ Retrieves the routing table information of the node. This routing table is also known as RoutingTableList in the ZigBee Specification.

An implementation of this method may use the Mgmt_Rtg_req ZDP command to retrieve the Routing Table .

The target device may report a status code ZDPException.NOT_SUPPORTED in case of failure.

ReturnsA promise representing the completion of this asynchronous call. In case of success, the resolved value will be a Map containing the Service.PID as String key of the ZigBeeNode service and the value the ZigBeeRoute for that node. In case of failure a ZDPException exception with the correct status code must be used to fail the promise.

□ Returns the user description of this node. As described in Table 2.97 Fields of the User_Desc_rsp Command of the ZigBee specification, a User_Desc_rsp may return the following status:

ReturnsA promise representing the completion of this asynchronous call. It will be used in order to return the node user description (String). In case of errors the promise will fail with a ZDPException exception containing the response status code value.

clusterIdReqthe cluster Id of the ZDPFrame that will be sent to the device.

expectedClusterIdRspthe expected cluster Id of the response to the ZDPFrame sent.

messagethe ZDPFrame containing the message.

□ Sends the ZDPFrame to this ZigBeeNode with the specified cluster id. This method expects a specific cluster in the response to the request.

ReturnsA promise representing the completion of this asynchronous call. In case of success the promise resolves with the response ZDPFrame.

clusterIdReqthe cluster Id of the ZDPFrame that will be sent to the device.

messagethe ZDPFrame containing the message.

□ Sends the ZDPFrame to this ZigBeeNode with the specified cluster id. This method expects a specific cluster in the response to the request. This method considers that the 0x8000 + clusterIdReq is the clusterId expected from messaged received for the message sent by this request.

ReturnsA promise representing the completion of this asynchronous call. In case of success the promise resolves with the response ZDPFrame.

□ Requests this node to leave the ZigBee network.

As described in Table 2.131 Fields of the Mgmt_Leave_rsp Command of the ZigBee specification, a Mgmt_Leave_rsp ZDP command may return the following status values:

ReturnsA promise representing the completion of this asynchronous call. In case of success, the promise is resolved with a null value, otherwise with the correct ZDPException exception.

rejoin true if the device being asked to leave from the current parent is requested to rejoin the network. Otherwise, false.

removeChildren true if the device being asked to leave the network is also being asked to remove its child devices, if any. Otherwise, false.

□ Requests the device to leave the network.

As described in Table 2.131 Fields of the Mgmt_Leave_rsp Command of the ZigBee specification, a Mgmt_Leave_rsp command could return the following status values:

ReturnsA promise representing the completion of this asynchronous call. In case of success, the ZigBeeNode service must be unregistered, first and then the promise may be resolved with a null value, otherwise with the correct ZDPException exception.

userDescriptionthe user description.

□ Sets the user description of this node. As described in Table 2.137 ZDP Enumerations Description of the ZigBee specification, a Set_User_Desc_rsp request may return the following status:

ReturnsA promise representing the completion of this asynchronous call. In case of success the promise returns a null value. In case of errors the promise must fail with a ZDPException exception containing the response status code value.

□ Returns the service PID of the ZigBeeNode as destination of this route entry.

Returnsthe service PID of the ZigBeeNode as destination of this route entry.

□ Returns the service PID of the ZigBeeNode to send the data for reaching the destination.

Returnsthe service PID of the ZigBeeNode to send the data for reaching the destination.

□ Returns the status of this route.

Returnsthe status of this route (or routing link) as defined by ZigBee Specification: ACTIVE, DISCOVERY_UNDERWAY, DISCOVERY_FAILED, INACTIVE, VALIDATION_UNDERWAY.

□ Returns the attribute default value.

Returnsthe attribute default value.

□ Returns the attribute name.

Returnsthe attribute name.

□ Returns the attribute functional description.

Returnsthe attribute functional description.

□ Checks if this attribute is mandatory.

Returnstrue, if and only if the attribute is mandatory.

□ Checks if this attribute is part of a scene.

Returnstrue if the attribute is part of a scene (cluster), false otherwise.

□ Checks if this attribute is read-only.

Returnstrue if the attribute is read only, false otherwise (that is, if the attribute is read/write or optionally writable (R*W)).

□ Checks if this attribute is reportable.

Returnstrue if and only if the attribute support subscription.

□ Returns an array of the attribute descriptions.

Returnsan array of the attribute descriptions.

□ Returns an array of the generated command descriptions.

Returnsan array of the generated command descriptions.

□ Returns an array of the command descriptions.

Returnsan array of the command descriptions.

Returnsthe cluster identifier.

□ Returns an array of the received command description.

Returnsan array of the received command description.

□ Returns the command identifier.

Returnsthe command identifier.

□ Returns the manufacturer code. Default value is: -1 (no code).

Returnsthe manufacturer code.

□ Returns the command name.

Returnsthe command name.

□ Returns an array of the parameter descriptions.

Returnsan array of the parameter descriptions.

□ Returns the command functional description.

Returnsthe command functional description.

□ Checks if this is a server-side command (that is going from the client to server direction).

Returnsthe isClientServerDirection value.

Returnsthe isClusterSpecificCommand value.

□ Checks if this command it mandatory.

Returnstrue, if and only if the command is mandatory.

□ Checks if the command is manufacturer specific.

Returns true if end only if getManufacturerCode() is not. -1.

□ Returns the data type identifier.

Returnsthe data type identifier. The data types identifiers supported by this specification are defined in the ZigBeeDataTypes interface.

□ Returns the corresponding Java type class.

Returnsthe corresponding Java type class.

□ Returns the associated data type name.

Returnsthe associated data type name string.

□ Checks if the data type is analog.

Returnstrue, if the data type is Analog, otherwise is Discrete.

□ Returns the client cluster description.

Returnsthe client cluster description.

□ Returns the cluster functional description.

Returnsthe cluster functional description.

□ Returns the cluster functional domain.

Returnsthe cluster functional domain.

□ Returns the cluster identifier.

Returnsthe cluster identifier.

□ Returns the cluster name.

Returnsthe cluster name.

□ Returns the server cluster description.

Returnsthe server cluster description.

□ Returns the parameter data type.

Returnsthe parameter data type.

isthe ZigBeeDataInput from where the value of data type is read from.

□ Deserializes a value from the passed ZigBeeDataInput stream.

ReturnsAn object that represents the deserialized value of data. Returns null if the read value represents the Invalid Value for the specific ZigBee data type.

Throws NullPointerException– If ZigBeeDataInput parameter is null.

IOException– If an I/O error occurs while reading the ZigBeeDataInput. An EOFException is thrown if the data input stream end is reached while deserializing the data type.

osa ZigBeeDataOutput stream where to the passed value will be appended. This parameter cannot be null. If null a NullPointerException must be thrown.

valueThe value that have to be serialized on the output stream. If null is passed this method outputs on the stream the ZigBee invalid value related the specific data type. If the data type do not allow any invalid value and the passed value is null an IllegalArgumentException is thrown.

□ Serializes a ZigBee data type into a ZigBeeDataOutput stream. An implementation of this method must throw an IllegalArgumentException if the passed value does not belong to the expected class or its value exceeds the possible values allowed (in terms of range or length).

An implementation of this method must interpret (where it makes sense) a null value as the request to serialize the so called Invalid Value.

Throws IOException– If an I/O error occurs while writing on the ZigBeeDataOutput. The EOFException may be thrown if there is no more space on the data output for serializing the passed value.

NullPointerException– If ZigBeeDataOutput parameter is null.

IllegalArgumentException– If the passed value parameter does not belong to the expected class or its value exceeds the possible values allowed (range or length).

□ Returns an array of client cluster descriptions.

Returnsan array of client cluster descriptions.

□ Returns the device identifier.

Returnsthe device identifier.

□ Returns the device name.

Returnsthe device name.

□ Returns the profile identifier.

Returnsthe profile identifier.

□ Returns an array of server cluster descriptions.

Returnsan array of server cluster descriptions.

□ Returns the device version.

Returnsthe device version.

deviceIdIdentifier of the device.

versionThe version of the application profile.

□ Returns the description of a device identified by its identifier and its version.

ReturnsThe associated device description.

□ Returns the encoding used by characters in the character set.

Returnsthe encoding used by characters in the character set.

□ Returns the Device URL.

Returnsthe Device URL.

□ Returns the icon field.

Returnsthe icon field.

□ Returns the icon URL.

Returnsthe icon URL.

□ Returns the language code used for character strings.

Returnsthe language code used for character strings.

□ Returns the manufacturer name.

Returnsthe manufacturer name.

□ Returns the model name.

Returnsthe model name.

□ Returns the serial number.

Returnsthe serial number.

□ Checks if the radio band is 2.4GHz.

Returns true if and only if the radio is operating in the frequency band 2400MHz to 2483MHz.

□ Checks if the radio band is 868MHz.

Returns true if and only if the radio is operating in the frequency band 868 to 868.6 MHz.

□ Checks if the radio band is 900MHz.

Returns true if and only if the radio is operating in the frequency band 908MHz to 928MHz.

□ Checks if the device is address allocate.

Returnstrue if the device is address allocate or false otherwise.

□ Checks if this node is capable of becoming PAN coordinator.

Returnstrue if this node is capable of becoming PAN coordinator or false otherwise.

□ Checks if this node a Full Function Device (FFD).

Returnstrue if this node a Full Function Device (FFD), false otherwise (it is a Reduced Function Device, RFD).

□ Checks if the current power source is mains power.

Returnstrue if the current power source is mains power or false otherwise.

□ Checks if the device does not disable its receiver to conserve power during idle periods.

Returnstrue if the device does not disable its receiver to conserve power during idle periods or false otherwise.

□ Checks if the device is capable of sending and receiving secured frames

Returnstrue if the device is capable of sending and receiving secured frames or false otherwise.

□ Returns the radio frequency band the node is currently operating on.

Returnsreturns the information about the radio frequency band the node is currently operating on.

□ Returns the logical type of the described node.

Returnsone of: ZigBeeNode.COORDINATOR, ZigBeeNode.ROUTER, ZigBeeNode.ZED.

□ Returns the MAC Capability Flags field information.

Returnsthe MAC Capability Flags field information.

□ Returns the manufacturer code of the described node.

Returnsthe manufacturer code of the described node.

□ Returns the maximum buffer size of the described node.

Returnsthe maximum buffer size of the described node.

□ Returns the maximum incoming transfer size of the described node.

Returnsthe maximum incoming transfer size of the described node.

□ Returns the maximum outgoing transfer size of the described node.

Returnsthe maximum outgoing transfer size of the described node.

□ Returns the server mask of the described node.

Returnsthe server mask of the described node.

□ Checks if a complex descriptor is available.

Returnstrue if a complex descriptor is available or false otherwise.

□ Checks if extended active endpoint list is available.

Returnstrue if extended active endpoint list is available or false otherwise.

□ Checks if extended simple descriptor is available.

Returnstrue if extended simple descriptor is available or false otherwise.

□ Checks if a user descriptor is available.

Returnstrue if a user descriptor is available or false otherwise.

□ Returns the current power mode.

Returnsthe current power mode.

□ Returns the current power source field of the Power Descriptor.

Returnsthe current power source field of the Power Descriptor.

□ Returns the current power source level.

Returnsthe current power source level. May be one of CRITICAL_LEVEL, LOW_LEVEL, MIDDLE_LEVEL, FULL_LEVEL.

□ Checks if constant (mains) power is available.

Returnstrue if constant (mains) power is available or false otherwise.

□ Checks if the currently selected power source is the disposable battery.

Returns true if the currently selected power source is the disposable battery.

□ Checks if a disposable battery is available.

Returnstrue if a disposable battery is available or false otherwise.

□ Checks if the currently selected power source is the mains power.

Returns true if the currently selected power source is the mains power.

□ Checks if the receiver is on when the device is simulated.

Returns true if the Current Power Mode field tells that the receiver is on when the device is stimulated by pressing a button, for instance.

□ Checks if the Current Power Mode field is periodically on.

Returns true if the Current Power Mode field is periodically on.

□ Checks if the currently selected power source is the rechargeable battery.

Returns true if the currently selected power source is the rechargeable battery.

□ Checks if a rechargeable battery is available.

Returnstrue if a rechargeable battery is available or false otherwise.

□ Checks if synchronized with the receiver on-when-idle subfield of the node descriptor.

Returns true if the Current Power Mode field is synchronized on idle.

□ Checks if the server is a Backup Binding Table Cache.

Returns true if and only if the server is a Backup Binding Table Cache.

□ Checks if the server is a Backup Discovery Cache.

Returns true if and only if the server is a Backup Discovery Cache.

□ Checks if the server is a Backup Trust Center.

Returns true if and only if the server is a Backup Trust Center.

□ Checks if the server is a Network Manager.

Returns true if and only if the server is a Network Manager.

□ Checks if the server is a Primary Binding Table Cache.

Returns true if and only if the server is a Primary Binding Table Cache.

□ Checks if the server is a Primary Discovery Cache.

Returns true if and only if the server is a Primary Discovery Cache.

□ Checks if the server is a Primary Trust Center.

Returns true if and only if the server is a Primary Trust Center.

□ Returns the application device id as defined per profile.

Returnsthe application device id as defined per profile.

□ Returns the version of the endpoint application.

Returnsthe version of the endpoint application.

□ Returns the application profile id.

Returnsthe application profile id.

□ Returns the endpoint for which this descriptor is defined.

Returnsthe endpoint for which this descriptor is defined.

□ Returns an array of input (server) cluster identifiers.

Returnsan array of input (server) cluster identifiers, returns an empty array if does not provides any input (server) clusters.

□ Returns an array of output (client) cluster identifiers.

Returnsan array of output (client) cluster identifiers, returns an empty array if does not provides any output (client) clusters.

clusterIdthe cluster identifier.

□ Checks if this endpoint implements the given cluster id as an input cluster.

Returnstrue if and only if this endpoint implements the given cluster id as an input cluster.

clusterIdthe cluster identifier.

□ Checks if this endpoint implements the given cluster id as an output cluster.

Returnstrue if and only if this endpoint implements the given cluster id as an output cluster.

□ Returns the data type identifier.

Returnsthe data type identifier. The data types identifiers supported by this specification are defined in the ZigBeeDataTypes interface.

□ Gets a singleton instance of this class.

Returnsthe singleton instance.

□ Returns the corresponding Java type class.

Returnsthe corresponding Java type class.

□ Returns the associated data type name.

Returnsthe associated data type name string.

□ Checks if the data type is analog.

Returnstrue, if the data type is Analog, otherwise is Discrete.

isthe ZigBeeDataInput from where the value of data type is read from.

□ Deserializes a value from the passed ZigBeeDataInput stream.

ReturnsAn object that represents the deserialized value of data. Returns null if the read value represents the Invalid Value for the specific ZigBee data type.

Throws IOException– If an I/O error occurs while reading the ZigBeeDataInput. An EOFException is thrown if the data input stream end is reached while deserializing the data type.

□ Returns the data type identifier.

Returnsthe data type identifier. The data types identifiers supported by this specification are defined in the ZigBeeDataTypes interface.

□ Gets a singleton instance of this class.

Returnsthe singleton instance.

□ Returns the corresponding Java type class.

Returnsthe corresponding Java type class.

□ Returns the associated data type name.

Returnsthe associated data type name string.

□ Checks if the data type is analog.

Returnstrue, if the data type is Analog, otherwise is Discrete.