Endpoints
Application Framework API Reference > ZCL over IP

Macros

#define EMBER_ZCL_ENDPOINT_MIN 0x01
#define EMBER_ZCL_ENDPOINT_MAX 0xF0
#define EMBER_ZCL_ENDPOINT_NULL (( EmberZclEndpointId_t )-1)
#define EMBER_ZCL_ENDPOINT_INDEX_NULL (( EmberZclEndpointIndex_t )-1)
#define EMBER_ZCL_DEVICE_ID_NULL (( EmberZclDeviceId_t )-1)

Typedefs

typedef uint8_t EmberZclEndpointId_t
typedef uint8_t EmberZclEndpointIndex_t
typedef uint16_t EmberZclDeviceId_t

Functions

EmberZclEndpointIndex_t emberZclEndpointIdToIndex ( EmberZclEndpointId_t endpointId, const EmberZclClusterSpec_t *clusterSpec)
EmberZclEndpointId_t emberZclEndpointIndexToId ( EmberZclEndpointIndex_t index, const EmberZclClusterSpec_t *clusterSpec)

Detailed Description

See zcl-core-types.h for source code.

See zcl-core.h for source code.

Macro Definition Documentation

#define EMBER_ZCL_DEVICE_ID_NULL   (( EmberZclDeviceId_t )-1)

A distinguished value that represents a null (invalid) device identifer.

#define EMBER_ZCL_ENDPOINT_INDEX_NULL   (( EmberZclEndpointIndex_t )-1)

A distinguished value that represents a null (invalid) endpoint index.

#define EMBER_ZCL_ENDPOINT_MAX   0xF0

A maximum endpoint identifer value.

#define EMBER_ZCL_ENDPOINT_MIN   0x01

A minimum endpoint identifer value.

#define EMBER_ZCL_ENDPOINT_NULL   (( EmberZclEndpointId_t )-1)

A distinguished value that represents a null (invalid) endpoint identifer.

Typedef Documentation

typedef uint16_t EmberZclDeviceId_t

A device identifier.

typedef uint8_t EmberZclEndpointId_t

An endpoint identifier.

typedef uint8_t EmberZclEndpointIndex_t

An endpoint index.

Function Documentation

EmberZclEndpointIndex_t emberZclEndpointIdToIndex ( EmberZclEndpointId_t endpointId,
const EmberZclClusterSpec_t * clusterSpec
)

This function finds the endpoint index for the specified endpoint identifier and cluster specification.

Parameters
endpointId An endpoint identifier
clusterSpec A cluster specification or NULL
Returns
An endpoint index or EMBER_ZCL_ENDPOINT_INDEX_NULL if no match is found.

This function searches the endpoint table and returns the endpoint index for the entry that matches the specified endpoint identifier and cluster specification. If clusterSpec is NULL, match on endpointId only.

Note
The endpoint index is the zero-based relative position of an endpoint among the subset of endpoints that support the specified cluster. For example, an index of 3 refers to the fourth endpoint that supports the specified cluster. The value of endpoint index for a given endpoint identifier may be different for different clusters.
See also
emberZclEndpointIndexToId()
EmberZclEndpointId_t emberZclEndpointIndexToId ( EmberZclEndpointIndex_t index,
const EmberZclClusterSpec_t * clusterSpec
)

This function finds the endpoint identifier for the specified endpoint index and cluster specification.

Parameters
index An endpoint index
clusterSpec A cluster specification or NULL
Returns
An endpoint identifier or EMBER_ZCL_ENDPOINT_NULL if no match is found.

This function searches the endpoint table and returns the endpoint identifier for the entry that matches the specified endpoint index and cluster specification. If clusterSpec is NULL, match on index only.

Note
The endpoint index is the zero-based relative position of an endpoint among the subset of endpoints that support the specified cluster. For example, an index of 3 refers to the fourth endpoint that supports the specified cluster. The value of endpoint index for a given endpoint identifier may be different for different clusters.
See also
emberZclEndpointIdToIndex()