Clusters
Application Framework API Reference > ZCL over IP

Data Structures

struct EmberZclClusterSpec_t

Macros

#define EMBER_ZCL_MANUFACTURER_CODE_NULL 0x0000
#define EMBER_ZCL_CLUSTER_NULL (( EmberZclClusterId_t )-1)

Typedefs

typedef uint16_t EmberZclManufacturerCode_t
typedef uint16_t EmberZclClusterId_t

Enumerations

enum EmberZclRole_t {
EMBER_ZCL_ROLE_CLIENT = 0,
EMBER_ZCL_ROLE_SERVER = 1
}

Functions

int32_t emberZclCompareClusterSpec (const EmberZclClusterSpec_t *s1, const EmberZclClusterSpec_t *s2)
bool emberZclAreClusterSpecsEqual (const EmberZclClusterSpec_t *s1, const EmberZclClusterSpec_t *s2)
void emberZclReverseClusterSpec (const EmberZclClusterSpec_t *s1, EmberZclClusterSpec_t *s2)

Detailed Description

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

See zcl-core.h for source code.

Macro Definition Documentation

#define EMBER_ZCL_CLUSTER_NULL   (( EmberZclClusterId_t )-1)

A distinguished value that represents a null (invalid) cluster identifier.

#define EMBER_ZCL_MANUFACTURER_CODE_NULL   0x0000

A distinguished value that represents a null (invalid) manufacturer code.

Typedef Documentation

typedef uint16_t EmberZclClusterId_t

A cluster identifier.

typedef uint16_t EmberZclManufacturerCode_t

A manufacturer code.

Enumeration Type Documentation

enum EmberZclRole_t

Defines possible roles of a cluster.

Enumerator
EMBER_ZCL_ROLE_CLIENT

Cluster is a client.

EMBER_ZCL_ROLE_SERVER

Cluster is a server.

Function Documentation

bool emberZclAreClusterSpecsEqual ( const EmberZclClusterSpec_t * s1,
const EmberZclClusterSpec_t * s2
)

This function compares two cluster specifications.

Parameters
s1 A cluster specification to be compared
s2 A cluster specification to be compared
Returns
true if both cluster specifications are equal, false otherwise.
int32_t emberZclCompareClusterSpec ( const EmberZclClusterSpec_t * s1,
const EmberZclClusterSpec_t * s2
)

This function compares two cluster specifications.

Parameters
s1 A cluster specification to be compared
s2 A cluster specification to be compared
Returns
void emberZclReverseClusterSpec ( const EmberZclClusterSpec_t * s1,
EmberZclClusterSpec_t * s2
)

This function reverses cluster specifications.

Parameters
s1 A cluster specification used for reversing
s2 A cluster specification to be reversed

This function changes EmberZclRole_t of s2 to be opposite of s1 . It also sets EmberZclManufacturerCode_t and EmberZclClusterId_t of s2 to be the same as s1 .