Z-Stack API Reference  8.31.00.00
ZCL Basic Cluster

Macros

#define ATTRID_BASIC_ZCL_VERSION   0x0000
 
#define ATTRID_BASIC_APPLICATION_VERSION   0x0001
 
#define ATTRID_BASIC_STACK_VERSION   0x0002
 
#define ATTRID_BASIC_HW_VERSION   0x0003
 
#define ATTRID_BASIC_MANUFACTURER_NAME   0x0004
 
#define ATTRID_BASIC_MODEL_IDENTIFIER   0x0005
 
#define ATTRID_BASIC_DATE_CODE   0x0006
 
#define ATTRID_BASIC_POWER_SOURCE   0x0007
 
#define ATTRID_BASIC_GENERIC_DEVICE_CLASS   0x0008
 
#define ATTRID_BASIC_GENERIC_DEVICE_TYPE   0x0009
 
#define ATTRID_BASIC_PRODUCT_CODE   0x000A
 
#define ATTRID_BASIC_PRODUCT_URL   0x000B
 
#define ATTRID_BASIC_MANUFACTURER_VERSION_DETAILS   0x000C
 
#define ATTRID_BASIC_SERIAL_NUMBER   0x000D
 Vendor specific human readable (displayable) serial number.
 
#define ATTRID_BASIC_PRODUCT_LABEL   0x000E
 Vendor specific human readable (displayable) product label.
 
#define ATTRID_BASIC_LOCATION_DESCRIPTION   0x0010
 
#define ATTRID_BASIC_PHYSICAL_ENVIRONMENT   0x0011
 
#define ATTRID_BASIC_DEVICE_ENABLED   0x0012
 
#define ATTRID_BASIC_ALARM_MASK   0x0013
 
#define ATTRID_BASIC_DISABLE_LOCAL_CONFIG   0x0014
 
#define ATTRID_BASIC_SW_BUILD_ID   0x4000
 
#define POWER_SOURCE_UNKNOWN   0x00
 
#define POWER_SOURCE_MAINS_1_PHASE   0x01
 
#define POWER_SOURCE_MAINS_3_PHASE   0x02
 
#define POWER_SOURCE_BATTERY   0x03
 
#define POWER_SOURCE_DC   0x04
 
#define POWER_SOURCE_EMERG_MAINS_CONST_PWR   0x05
 
#define POWER_SOURCE_EMERG_MAINS_XFER_SW   0x06
 
#define POWER_SOURCE_PRIMARY   0x7F
 
#define POWER_SOURCE_SECONDARY   0x80
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_BUILDING_AUTOMATION   0x00
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_REMOTE_CONTROL   0x01
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_SMART_ENERGY   0x02
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_HEALTH_CARE   0x03
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_HOME_AUTOMATION   0x04
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_INPUT_DEVICE   0x05
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_LIGHT_LINK   0X06
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_RETAIL_SERVICES   0x07
 
#define APPLICATION_PROFILE_TYPE_ZIGBEE_TELECOM_SERVICES   0X08
 
#define PHY_UNSPECIFIED_ENV   0x00
 
#define PHY_MIRROR_CAPACITY_ENV   0x01
 
#define PHY_BAR   0x02
 
#define PHY_COURTYARD   0x03
 
#define PHY_BATHROOM   0x04
 
#define PHY_BEDROOM   0x05
 
#define PHY_BILIARD_ROOM   0x06
 
#define PHY_UTILITY_TOOM   0x07
 
#define PHY_CELLAR   0x08
 
#define PHY_STORAGE_CLOSET   0x09
 
#define PHY_THEATER   0x0A
 
#define PHY_OFFICE   0x0B
 
#define PHY_DECK   0x0C
 
#define PHY_DEN   0x0D
 
#define PHY_DINING_ROOM   0x0E
 
#define PHY_ELECTRICAL_ROOM   0x0F
 
#define PHY_ELEVTOR   0x10
 
#define PHY_ENTRY   0x11
 
#define PHY_FAMILLY_ROOM   0x12
 
#define PHY_MAIN_FLOOR   0x13
 
#define PHY_UPSTAIRS   0x14
 
#define PHY_DOWNSTAIRS   0x15
 
#define PHY_BASEMENT_LOWER   0x16
 
#define PHY_GALLERY   0x17
 
#define PHY_GAME_ROOM   0x18
 
#define PHY_GARAGE   0x19
 
#define PHY_GYM   0x1A
 
#define PHY_HALLWAY   0x1B
 
#define PHY_HOUSE   0x1C
 
#define PHY_KITCHEN   0x1D
 
#define PHY_LAUNDRY_ROOM   0x1E
 
#define PHY_LIBRARY   0x1F
 
#define PHY_MASTER_BEDROOM   0x20
 
#define PHY_MUD_ROOM   0x21
 
#define PHY_NURSERY   0x22
 
#define PHY_PANTRY   0x23
 
#define PHY_OFFICE2   0x24
 
#define PHY_OUTSIDE   0x25
 
#define PHY_POOL   0x26
 
#define PHY_PORCH   0x27
 
#define PHY_SEWING_ROOM   0x28
 
#define PHY_SITTING_ROOM   0x29
 
#define PHY_STAIRWAY   0x2A
 
#define PHY_YARD   0x2B
 
#define PHY_ATTIC   0x2C
 
#define PHY_HOT_TUB   0x2D
 
#define PHY_LIVING_ROOM   0x2E
 
#define PHY_SAUNA   0x2F
 
#define PHY_SHOP_WORKSHOP   0x30
 
#define PHY_GUEST_BEDROOM   0x31
 
#define PHY_GUEST_BATH   0x32
 
#define PHY_POWDER_ROOM   0x33
 
#define PHY_BACK_YARD   0x34
 
#define PHY_FRONT_YARD   0x35
 
#define PHY_PATIO   0x36
 
#define PHY_DRIVEWAY   0x37
 
#define PHY_SUN_ROOM   0x38
 
#define PHY_LIVING_ROOM2   0x39
 
#define PHY_SPA   0x3A
 
#define PHY_WIRLPOOL   0x3B
 
#define PHY_SHED   0x3C
 
#define PHY_EQUIPMENT_STORAGE   0x3D
 
#define PHY_HOBBY_CRAFT_ROOM   0x3E
 
#define PHY_FOUNTAIN   0x3F
 
#define PHY_POND   0x40
 
#define PHY_RECEPTION_ROOM   0x41
 
#define PHY_BREAKFAST_ROOM   0x42
 
#define PHY_NOOK   0x43
 
#define PHY_GARDEN   0x44
 
#define PHY_BALCONY   0x45
 
#define PHY_PANIC_ROOM   0x46
 
#define PHY_TERACE   0x47
 
#define PHY_ROOF   0x48
 
#define PHY_TOILET   0x49
 
#define PHY_TOILET_MAIN   0x4A
 
#define PHY_OUTSIDE_TOILET   0x4B
 
#define PHY_SHOWER_ROOM   0x4C
 
#define PHY_STUDY   0x4D
 
#define PHY_FRONT_GARDEN   0x4E
 
#define PHY_BACK_GARDEN   0x4F
 
#define PHY_KETTLE   0x50
 
#define PHY_TELEVISION   0x51
 
#define PHY_STOVE   0x52
 
#define PHY_MICROWAVE   0x53
 
#define PHY_TOASTER   0x54
 
#define PHY_VACUUM   0x55
 
#define PHY_APPLIANCE   0x56
 
#define PHY_FRONT_DOOR   0x57
 
#define PHY_BACK_DOOR   0x58
 
#define PHY_FRIDGE_DOOR   0x59
 
#define PHY_MEDICATION_CABINET_DOOR   0x60
 
#define PHY_WARDROBE_DOOR   0x61
 
#define PHY_FRONT_CUPBOARD_DOOR   0x62
 
#define PHY_OTHER_DOOR   0x63
 
#define PHY_WAITING_ROOM   0x64
 
#define PHY_TRAGE_ROOM   0x65
 
#define PHY_DOCTORS_OFFICE   0x66
 
#define PHY_PATIENTS_PROVATE_ROOM   0x67
 
#define PHY_CONSULTATION_ROOM   0x68
 
#define PHY_NURSE_STATION   0x69
 
#define PHY_WARD   0x6A
 
#define PHY_CORRIDOR   0x6B
 
#define PHY_OPERATING_THEATHRE   0x6C
 
#define PHY_DENTAL_SURGERY_ROOM   0x6D
 
#define PHY_MEDICAL_IMAGING_ROOM   0x6E
 
#define PHY_DECONTAMINATION_ROOM   0x6F
 
#define PHY_ATRIUM   0x70
 
#define PHY_MIRROR   0x71
 
#define PHY_UNKNOWN_ENV   0xFF
 
#define DEVICE_DISABLED   0x00
 
#define DEVICE_ENABLED   0x01
 
#define ALARM_MASK_GENERAL_HW_FAULT   0x01
 
#define ALARM_MASK_GENERAL_SW_FAULT   0x02
 
#define COMMAND_BASIC_RESET_TO_FACTORY_DEFAULTS   0x00
 

Detailed Description

Macro Definition Documentation

§ ATTRID_BASIC_ALARM_MASK

#define ATTRID_BASIC_ALARM_MASK   0x0013

The AlarmMask attribute is 8 bits in length and specifies which of a number of general alarms MAY be generated.

§ ATTRID_BASIC_APPLICATION_VERSION

#define ATTRID_BASIC_APPLICATION_VERSION   0x0001

The ApplicationVersion attribute is 8 bits in length and specifies the version number of the application software contained in the device.

§ ATTRID_BASIC_DATE_CODE

#define ATTRID_BASIC_DATE_CODE   0x0006

The DateCode attribute is a character string with a maximum length of 16 bytes. The first 8 characters specify the date of manufacturer of the device in international date notation according to ISO 8601.

§ ATTRID_BASIC_DEVICE_ENABLED

#define ATTRID_BASIC_DEVICE_ENABLED   0x0012

The DeviceEnabled attribute is a Boolean and specifies whether the device is enabled or disabled.

§ ATTRID_BASIC_DISABLE_LOCAL_CONFIG

#define ATTRID_BASIC_DISABLE_LOCAL_CONFIG   0x0014

The DisableLocalConfig attribute allows a number of local device configuration functions to be disabled.

§ ATTRID_BASIC_GENERIC_DEVICE_CLASS

#define ATTRID_BASIC_GENERIC_DEVICE_CLASS   0x0008

The GenericDeviceClass attribute defines the field of application of the GenericDeviceType attribute.

§ ATTRID_BASIC_GENERIC_DEVICE_TYPE

#define ATTRID_BASIC_GENERIC_DEVICE_TYPE   0x0009

The GenericDeviceType attribute allows an application to show an icon on a rich user interface

§ ATTRID_BASIC_HW_VERSION

#define ATTRID_BASIC_HW_VERSION   0x0003

The HWVersion attribute is 8 bits in length and specifies the version number of the hardware of the device.

§ ATTRID_BASIC_LOCATION_DESCRIPTION

#define ATTRID_BASIC_LOCATION_DESCRIPTION   0x0010

The LocationDescription attribute is a maximum of 16 bytes in length and describes the physical location of the device as a character string.

§ ATTRID_BASIC_MANUFACTURER_NAME

#define ATTRID_BASIC_MANUFACTURER_NAME   0x0004

The ManufacturerName attribute is a maximum of 32 bytes in length and specifies the name of the manufacturer as a character string.

§ ATTRID_BASIC_MANUFACTURER_VERSION_DETAILS

#define ATTRID_BASIC_MANUFACTURER_VERSION_DETAILS   0x000C

Vendor specific human readable (displayable) string representing the versions of one of more program images supported on the device.

§ ATTRID_BASIC_MODEL_IDENTIFIER

#define ATTRID_BASIC_MODEL_IDENTIFIER   0x0005

The ModelIdentifier attribute is a maximum of 32 bytes in length and specifies the model number (or other identifier) assigned by the manufacturer as a character string.

§ ATTRID_BASIC_PHYSICAL_ENVIRONMENT

#define ATTRID_BASIC_PHYSICAL_ENVIRONMENT   0x0011

The PhysicalEnvironment attribute is 8 bits in length and specifies the type of physical environment in which the device will operate.

§ ATTRID_BASIC_POWER_SOURCE

#define ATTRID_BASIC_POWER_SOURCE   0x0007

The PowerSource attribute is 8 bits in length and specifies the source(s) of power available to the device.

§ ATTRID_BASIC_PRODUCT_CODE

#define ATTRID_BASIC_PRODUCT_CODE   0x000A

The ProductCode attribute allows an application to specify a code for the product.

§ ATTRID_BASIC_PRODUCT_URL

#define ATTRID_BASIC_PRODUCT_URL   0x000B

The ProductURL attribute specifies a link to a web page containing specific product information.

§ ATTRID_BASIC_STACK_VERSION

#define ATTRID_BASIC_STACK_VERSION   0x0002

The StackVersion attribute is 8 bits in length and specifies the version number of the implementation of the stack contained in the device.

§ ATTRID_BASIC_SW_BUILD_ID

#define ATTRID_BASIC_SW_BUILD_ID   0x4000

The SWBuildID attribute represents a detailed, manufacturer-specific reference to the version of the software.

§ ATTRID_BASIC_ZCL_VERSION

#define ATTRID_BASIC_ZCL_VERSION   0x0000

The ZCLVersion attribute represents a published set of foundation items, such as global commands and functional descriptions.

§ COMMAND_BASIC_RESET_TO_FACTORY_DEFAULTS

#define COMMAND_BASIC_RESET_TO_FACTORY_DEFAULTS   0x00

On receipt of this command, the device resets all the attributes of all its clusters to their factory defaults.