Zigbee Object

From Hubitat Documentation
Jump to: navigation, search

Description

The package name of this class is zigbee. So to use in an App or Driver you would reference it with zigbee.

clusterLookup

Return ZHA cluster information.

Signature

ZigbeeCluster clusterLookup(int value)
ZigbeeCluster clusterLookup(String value)

Parameters

value - the integer value to lookup
value - the hex string value to lookup

Returns

ZigbeeCluster - Cluster entry, null if no matching entry found.

Example

def zbc = zigbee.clusterLookup(0x0006)
def zbc = zigbee.clusterLookup("0x0006")
def zbc = zigbee.clusterLookup("0006")
zbc == ON_OFF_CLUSTER
zbc.clusterEnum == ON_OFF_CLUSTER
zbc.clusterLabel == On/Off
zbc.clusterInt == 6

on

Generate the on command for the on/off ZigBee cluster

Signature

List on()
List on(int delay)

Parameters

delay - the number of milliseconds to delay after sending the command, if omitted then the standard delay of 2000ms is used.

Returns

List - a list of zigbee commands to be sent to the device

Example

def cmds = zigbee.on(200)

off

Generate the off command for the on/off ZigBee cluster

Signature

List off()
List off(int delay)

Parameters

delay - the number of milliseconds to delay after sending the command, if omitted then the standard delay of 2000ms is used.

Returns

List - a list of zigbee commands to be sent to the device

Example

def cmds = zigbee.off(500)

groupOn

Generate the on command for the on/off ZigBee cluster for a group

Signature

List groupOn(Integer groupID)
List groupOn(Integer groupID, int delay)

Parameters

delay - the number of milliseconds to delay after sending the command, if omitted then the standard delay of 2000ms is used.

Returns

List - a list of zigbee commands to be sent to the group

Example

def cmds = zigbee.groupOn(0x0202, 200)

groupOff

Generate the off command for the on/off ZigBee cluster for a group

Signature

List groupOff(Integer groupID)
List groupOff(Integer groupID, int delay)

Parameters

delay - the number of milliseconds to delay after sending the command, if omitted then the standard delay of 2000ms is used.

Returns

List - a list of zigbee commands to be sent to the group

Example

def cmds = zigbee.groupOff(0x0156, 300)

parseDescriptionAsMap

Parse a zigbee message into a Map. This method currently handles messages that start with 'catchall' or 'read attr'

Signature

Map parseDescriptionAsMap(String description)

Parameters

description - the zigbee message to parse.

Returns

Map - a Map of key/value pairs that have been parsed from the zigbee message.

Example

def msgMap = zigbee.parseDescriptionAsMap("catchall: 0104 0008 0A 01 0140 00 1A67 00 00 0000 0B 01 0400")


Additional Methods to Document

List onOffConfig()
List onOffConfig(Integer minRefreshInterval, Integer maxRefreshInterval)
List levelRefresh()
List levelRefresh(int delay)
List levelConfig()
List colorTemperatureRefresh()
List colorTemperatureRefresh(int delay)
List colorTemperatureConfig()
List batteryConfig()
List refreshData(String attr1, String attr2)
List electricMeasurementPowerRefresh(int delay = STANDARD_DELAY_INT)
List setColorTemperature(BigDecimal value, int delay = STANDARD_DELAY_INT)
List setColorTemperature(String value ,int delay = STANDARD_DELAY_INT)
List setColorTemperature(Integer value, int delay = STANDARD_DELAY_INT)
List setGroupColorTemperature(Integer groupID, BigDecimal value, int delay = STANDARD_DELAY_INT)
List setGroupColorTemperature(Integer groupID, String value, int delay = STANDARD_DELAY_INT)
List setGroupColorTemperature(Integer groupID, Integer value, int delay = STANDARD_DELAY_INT)
List setSaturation(Integer value, int delay = STANDARD_DELAY_INT)
List setHue(Integer value, int delay = STANDARD_DELAY_INT)
List setColor(Map value, int delay = STANDARD_DELAY_INT)
List setLevel(BigDecimal level)
List setLevel(Integer level, Integer rate = 0xFFFF)
List setLevel(Integer level, Integer rate = 0xFFFF)
List setGroupLevel(Integer groupID, BigDecimal level)
List setGroupLevel(Integer groupID, Integer level)
List setGroupLevel(Integer groupID, BigDecimal level, BigDecimal rate)
List setGroupLevel(Integer groupID, Integer level, Integer rate)
List temperatureConfig()
List temperatureConfig(Integer minRefreshInterval, Integer maxRefreshInterval)
List configureReporting(Integer clusterId, Integer attributeId, Integer dataType, Integer minReportTime, Integer maxReportTime, Integer reportableChange = null, Map additionalParams=[:], int delay = STANDARD_DELAY_INT)
List enrollResponse()
List command(Integer cluster, Integer command, Map additionalParams, int delay = STANDARD_DELAY_INT, String... payload)
List command(Integer cluster, Integer command, String... payload)
List readAttribute(Integer cluster, Integer attributeId, Map additionalParams = [:], int delay = STANDARD_DELAY_INT)
List readAttribute(Integer cluster, List<Integer> attributeIds, Map additionalParams = [:], int delay = STANDARD_DELAY_INT)
List writeAttribute(Integer cluster, Integer attributeId, Integer dataType, Integer value, Map additionalParams = [:], int delay = STANDARD_DELAY_INT)
Map getEvent(String description)
Map getKnownDescription(String description)
ZoneStatus parseZoneStatus(String description)
SmartShield parse(String description)
String convertToHexString(Integer value, Integer width)
Integer convertHexToInt(String value)
String hex2String(String arg)
String swapOctets(String bytes)