zcl_basic.h File Reference

ZigBee Cluster Library; Basic Cluster (ZCL_CLUSTER_BASIC, 0x0000) More...

#include "zigbee/zcl.h"

Go to the source code of this file.

Macros
#define	ZCL_VERSION   0x01
	ZCL_VERSION is sent as ZCLVersion attribute. More...
#define	ZCL_BASIC_PS_BATTERY_BACKUP   0x80
	definition of b7 of PowerSource attribute (device has battery backup)
#define	ZCL_BASIC_CMD_FACTORY_DEFAULTS   0x00
	Single command of the Basic Server Cluster.
#define	ZCL_CLUST_ENTRY_BASIC_SERVER
	Macro used to add a Basic Cluster Server to an endpoint's cluster table. More...

Functions
int	_zcl_basic_server (const wpan_envelope_t FAR *envelope, void FAR *context)
	Handles commands for the Basic Server Cluster. More...

ZCL Basic Cluster Attribute IDs
#define	ZCL_BASIC_ATTR_ZCL_VERSION   0x0000
	ZCLVersion, UINT8, read-only.
#define	ZCL_BASIC_ATTR_APP_VERSION   0x0001
	ApplicationVersion, UINT8, read-only.
#define	ZCL_BASIC_ATTR_STACK_VERSION   0x0002
	StackVersion, UINT8, read-only.
#define	ZCL_BASIC_ATTR_HW_VERSION   0x0003
	HWVersion, UINT8, read-only.
#define	ZCL_BASIC_ATTR_MANUFACTURER_NAME   0x0004
	ManufacturerName, 32-char STRING, read-only.
#define	ZCL_BASIC_ATTR_MODEL_IDENTIFIER   0x0005
	ModelIdentifier, 32-char STRING, read-only.
#define	ZCL_BASIC_ATTR_DATE_CODE   0x0006
	DateCode, 16-char STRING, read-only.
#define	ZCL_BASIC_ATTR_POWER_SOURCE   0x0007
	PowerSource, ENUM8, read-only.
#define	ZCL_BASIC_ATTR_LOCATION_DESC   0x0010
	LocationDescription, 16-char STRING, r/w.
#define	ZCL_BASIC_ATTR_PHYSICAL_ENV   0x0011
	PhysicalEnvironment, ENUM8, r/w.
#define	ZCL_BASIC_ATTR_DEVICE_ENABLED   0x0012
	DeviceEnabled, BOOLEAN, r/w.
#define	ZCL_BASIC_ATTR_ALARM_MASK   0x0013
	AlarmMask, BITMAP8, r/w.
Enumerated values for b0-b6 of PowerSource attribute.
#define	ZCL_BASIC_PS_UNKNOWN   0x00
	Unknown.
#define	ZCL_BASIC_PS_SINGLE_PHASE   0x01
	Mains (single phase)
#define	ZCL_BASIC_PS_THREE_PHASE   0x02
	Mains (3 phase)
#define	ZCL_BASIC_PS_BATTERY   0x03
	Battery.
#define	ZCL_BASIC_PS_DC   0x04
	DC source.
#define	ZCL_BASIC_PS_EMERGENCY_CONST   0x05
	Emergency mains, constant power.
#define	ZCL_BASIC_PS_EMERGENCY_SWITCH   0x06
	Emergency mains, transfer switch.

Detailed Description

ZigBee Cluster Library; Basic Cluster (ZCL_CLUSTER_BASIC, 0x0000)

See zigbee/zcl_basic_attributes.h for an easy method to incorporate a Basic Cluster Server into an application.

Todo:

Explore how we would support the DeviceEnabled attribute. Does each application need to check it? Does the endpoint dispatcher need to know about it? What about clients?