/** * Tuya Smart Siren Zigbee - Device Driver for Hubitat Elevation * * https://community.hubitat.com/t/dynamic-capabilities-commands-and-attributes-for-drivers/98342 * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License * for the specific language governing permissions and limitations under the License. * * This driver is inspired by @w35l3y work on Tuya device driver (Edge project). * For a big portions of code all credits go to Jonathan Bradshaw. * * ver. 2.0.0 2023-05-08 kkossev - Initial test version (VINDSTYRKA driver) * ver. 2.0.1 2023-05-27 kkossev - another test version (Aqara TVOC Air Monitor driver) * ver. 2.0.2 2023-05-29 kkossev - Just another test version (Aqara E1 thermostat driver) (not ready yet!); added 'Advanced Options'; Xiaomi cluster decoding; added temperatureScale and tVocUnit'preferences; temperature rounding bug fix * ver. 2.0.3 2023-06-10 kkossev - Tuya Zigbee Fingerbot * ver. 2.0.4 2023-06-29 kkossev - Tuya Zigbee Switch; Tuya Zigbee Button Dimmer; Tuya Zigbee Dimmer; Tuya Zigbee Light Sensor; * ver. 2.0.5 2023-07-02 kkossev - Tuya Zigbee Button Dimmer: added Debounce option; added VoltageToPercent option for battery; added reverseButton option; healthStatus bug fix; added Zigbee Groups' command; added switch moode (dimmer/scene) for TS004F * ver. 2.0.6 2023-07-09 kkossev - Tuya Zigbee Light Sensor: added min/max reporting time; illuminance threshold; added lastRx checkInTime, batteryTime, battCtr; added illuminanceCoeff; checkDriverVersion() bug fix; * ver. 2.1.0 2023-07-15 kkossev - Libraries first introduction for the Aqara Cube T1 Pro driver; Fingerbot driver; Aqara devices: store NWK in states; aqaraVersion bug fix; * ver. 2.1.1 2023-07-16 kkossev - Aqara Cube T1 Pro fixes and improvements; implemented configure() and loadAllDefaults commands; * ver. 2.1.2 2023-07-23 kkossev - VYNDSTIRKA library; Switch library; Fingerbot library; IR Blaster Library; fixed the exponential (3E+1) temperature representation bug; * ver. 2.1.3 2023-08-28 kkossev - ping() improvements; added ping OK, Fail, Min, Max, rolling average counters; added clearStatistics(); added updateTuyaVersion() updateAqaraVersion(); added HE hub model and platform version; Tuya mmWave Radar driver; processTuyaDpFingerbot; added Momentary capability for Fingerbot * ver. 2.1.4 2023-09-02 kkossev - buttonDimmerLib library; added IKEA Styrbar E2001/E2002, IKEA on/off switch E1743, IKEA remote control E1810; added Identify cluster; Ranamed 'Zigbee Button Dimmer' * ver. 2.1.5 2023-09-04 kkossev - (dev. branch) VINDSTYRKA: removed airQualityLevel, added thresholds; airQualityIndex replaced by sensirionVOCindex; new 'Tuya Smart Siren Zigbee' driver (playSound bug fixed); * * TODO: refresh() to update the platform version .. * TODO: auto turn off Debug messages 15 seconds after installing the new device * TODO: Aqara TVOC: implement battery level/percentage * TODO: skip thresholds checking for T,H,I ... on maxReportingTime * TODO: measure PTT for on/off commands * TODO: add rejonCtr to statistics * TODO: implement Get Device Info command * TODO: continue the work on the 'device' capability (this project main goal!) * TODO: state timesamps in human readable form * TODO: parse the details of the configuration respose - cluster, min, max, delta ... * TODO: battery min/max voltage preferences * TODO: Configure: add custom Notes */ static String version() { "2.1.5" } static String timeStamp() {"2023/09/03 8:45 PM"} @Field static final Boolean _DEBUG = false import groovy.transform.Field import hubitat.device.HubMultiAction import hubitat.device.Protocol import hubitat.helper.HexUtils import hubitat.zigbee.zcl.DataType import java.util.concurrent.ConcurrentHashMap import groovy.json.JsonOutput /* * To switch between driver types : * 1. Copy this code * 2. From HE 'Drivers Code' select 'New Driver' * 3. Paste the copied code * 4. Comment out the previous device type and un-comment the new device type in these lines that define : * deviceType * DEVICE_TYPE * #include libraries * name (in the metadata definition section) * 5. Save */ //deviceType = "Device" //@Field static final String DEVICE_TYPE = "Device" //#include kkossev.zigbeeScenes //deviceType = "AirQuality" //@Field static final String DEVICE_TYPE = "AirQuality" //#include kkossev.airQualityLib //deviceType = "Fingerbot" //@Field static final String DEVICE_TYPE = "Fingerbot" //#include kkossev.tuyaFingerbotLib //deviceType = "Thermostat" //@Field static final String DEVICE_TYPE = "Thermostat" //deviceType = "Switch" //@Field static final String DEVICE_TYPE = "Switch" //#include kkossev.tuyaZigbeeSwitchLib //deviceType = "Dimmer" //@Field static final String DEVICE_TYPE = "Dimmer" //deviceType = "ButtonDimmer" //@Field static final String DEVICE_TYPE = "ButtonDimmer" //#include kkossev.buttonDimmerLib //deviceType = "LightSensor" //@Field static final String DEVICE_TYPE = "LightSensor" //deviceType = "Bulb" //@Field static final String DEVICE_TYPE = "Bulb" //deviceType = "Relay" //@Field static final String DEVICE_TYPE = "Relay" //deviceType = "Plug" //@Field static final String DEVICE_TYPE = "Plug" //deviceType = "MotionSensor" //@Field static final String DEVICE_TYPE = "MotionSensor" //deviceType = "THSensor" //@Field static final String DEVICE_TYPE = "THSensor" //deviceType = "AqaraCube" //@Field static final String DEVICE_TYPE = "AqaraCube" //#include kkossev.aqaraCubeT1ProLib //deviceType = "IRBlaster" //@Field static final String DEVICE_TYPE = "IRBlaster" //#include kkossev.irBlasterLib //deviceType = "Radar" //@Field static final String DEVICE_TYPE = "Radar" //#include kkossev.tuyaRadarLib deviceType = "Alarm" @Field static final String DEVICE_TYPE = "Alarm" @Field static final Boolean _THREE_STATE = true metadata { definition ( //name: 'Tuya Zigbee Device', //name: 'VINDSTYRKA Air Quality Monitor', //name: 'Aqara TVOC Air Quality Monitor', //name: 'Tuya Zigbee Fingerbot', //name: 'Aqara E1 Thermostat', //name: 'Tuya Zigbee Switch', //name: 'Tuya Zigbee Dimmer', //name: 'Zigbee Button Dimmer', //name: 'Tuya Zigbee Light Sensor', //name: 'Tuya Zigbee Bulb', //name: 'Tuya Zigbee Relay', //name: 'Tuya Zigbee Plug V2', //name: 'Aqara Cube T1 Pro', //name: 'Tuya Zigbee IR Blaster', //name: 'Tuya mmWave Radar', name: 'Tuya Smart Siren Zigbee', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Device%20Driver/Tuya%20Zigbee%20Device.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/VINDSTYRKA%20Air%20Quality%20Monitor/VINDSTYRKA_Air_Quality_Monitor_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Aqara%20TVOC%20Air%20Quality%20Monitor/Aqara_TVOC_Air_Quality_Monitor_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Fingerbot/Tuya_Zigbee_Fingerbot_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Aqara%20E1%20Thermostat/Aqara%20E1%20Thermostat.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Plug/Tuya%20Zigbee%20Plug%20V2.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Switch/Tuya%20Zigbee%20Switch.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Dimmer/Tuya%20Zigbee%20Dimmer.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Zigbee%20Button%20Dimmer/Zigbee_Button_Dimmer_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Zigbee%20Light%20Sensor/Tuya%20Zigbee%20Light%20Sensor.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Aqara%20Cube%20T1%20Pro/Aqara_Cube_T1_Pro_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya_Zigbee_IR_Blaster/Tuya_Zigbee_IR_Blaster_lib_included.groovy', //importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Multi%20Sensor%204%20In%201/Tuya_mmWave_Radar.groovy', importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Tuya%20Smart%20Siren%20Zigbee/Tuya_Smart_Siren_Zigbee_lib_included.groovy', namespace: 'kkossev', author: 'Krassimir Kossev', singleThreaded: true ) { if (_DEBUG) { command 'test', [[name: "test", type: "STRING", description: "test", defaultValue : ""]] command 'parseTest', [[name: "parseTest", type: "STRING", description: "parseTest", defaultValue : ""]] command "tuyaTest", [ [name:"dpCommand", type: "STRING", description: "Tuya DP Command", constraints: ["STRING"]], [name:"dpValue", type: "STRING", description: "Tuya DP value", constraints: ["STRING"]], [name:"dpType", type: "ENUM", constraints: ["DP_TYPE_VALUE", "DP_TYPE_BOOL", "DP_TYPE_ENUM"], description: "DP data type"] ] } // common capabilities for all device types capability 'Configuration' capability 'Refresh' capability 'Health Check' // common attributes for all device types attribute 'healthStatus', 'enum', ['unknown', 'offline', 'online'] attribute "rtt", "number" attribute "Info", "string" // common commands for all device types // removed from version 2.0.6 //command "initialize", [[name: "Manually initialize the device after switching drivers. \n\r ***** Will load device default values! *****"]] // do NOT declare Initialize capability! command "configure", [[name:"normally it is not needed to configure anything", type: "ENUM", constraints: ["--- select ---"]+ConfigureOpts.keySet() as List]] // deviceType specific capabilities, commands and attributes if (deviceType in ["Device"]) { if (_DEBUG) { command "getAllProperties", [[name: "Get All Properties"]] } } if (_DEBUG || (deviceType in ["Dimmer", "ButtonDimmer", "Switch", "Valve"])) { command "zigbeeGroups", [ [name:"command", type: "ENUM", constraints: ZigbeeGroupsOpts.options.values() as List], [name:"value", type: "STRING", description: "Group number", constraints: ["STRING"]] ] } if (deviceType in ["Device", "THSensor", "MotionSensor", "LightSensor", "AirQuality", "Thermostat", "AqaraCube", "Radar"]) { capability "Sensor" } if (deviceType in ["Device", "MotionSensor", "Radar"]) { capability "MotionSensor" } if (deviceType in ["Device", "Switch", "Relay", "Plug", "Outlet", "Thermostat", "Fingerbot", "Dimmer", "Bulb", "IRBlaster", "Alarm"]) { capability "Actuator" } if (deviceType in ["Device", "THSensor", "LightSensor", "MotionSensor",/* "AirQuality",*/ "Thermostat", "Fingerbot", "ButtonDimmer", "AqaraCube", "IRBlaster", "Alarm"]) { capability "Battery" attribute "batteryVoltage", "number" } if (deviceType in ["Thermostat"]) { capability "ThermostatHeatingSetpoint" } if (deviceType in ["Plug", "Outlet"]) { capability "Outlet" } if (deviceType in ["Device", "Switch", "Plug", "Outlet", "Dimmer", "Fingerbot", "Alarm"]) { capability "Switch" if (_THREE_STATE == true) { attribute "switch", "enum", SwitchThreeStateOpts.options.values() as List } } if (deviceType in ["Dimmer", "ButtonDimmer"]) { capability "SwitchLevel" } if (deviceType in ["Button", "ButtonDimmer", "AqaraCube"]) { capability "PushableButton" capability "DoubleTapableButton" capability "HoldableButton" capability "ReleasableButton" } if (deviceType in ["Device", "Fingerbot"]) { capability "Momentary" } if (deviceType in ["Device", "THSensor", "AirQuality", "Thermostat"]) { capability "TemperatureMeasurement" } if (deviceType in ["Device", "THSensor", "AirQuality"]) { capability "RelativeHumidityMeasurement" } if (deviceType in ["Device", "LightSensor", "Radar"]) { capability "IlluminanceMeasurement" } if (deviceType in ["AirQuality"]) { capability "AirQuality" // Attributes: airQualityIndex - NUMBER, range:0..500 } // trap for Hubitat F2 bug fingerprint profileId:"0104", endpointId:"F2", inClusters:"", outClusters:"", model:"unknown", manufacturer:"unknown", deviceJoinName: "Zigbee device affected by Hubitat F2 bug" if (deviceType in ["Thermostat"]) { fingerprint profileId:"0104", endpointId:"01", inClusters:"0000,0001,0003,FCC0,000A,0201", outClusters:"0003,FCC0,0201", model:"lumi.airrtc.agl001", manufacturer:"LUMI", deviceJoinName: "Aqara E1 Thermostat" // model: 'SRTS-A01' } if (deviceType in ["LightSensor"]) { fingerprint profileId:"0104", endpointId:"01", inClusters:"0000,0400,0001,0500", outClusters:"0019,000A", model:"TS0222", manufacturer:"_TYZB01_4mdqxxnn", deviceJoinName: "Tuya Illuminance Sensor TS0222" fingerprint profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_khx7nnka", deviceJoinName: "Tuya Illuminance Sensor TS0601" fingerprint profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_yi4jtqq1", deviceJoinName: "Tuya Illuminance Sensor TS0601" } } preferences { input name: 'txtEnable', type: 'bool', title: 'Enable descriptionText logging', defaultValue: true, description: 'Enables command logging.' input name: 'logEnable', type: 'bool', title: 'Enable debug logging', defaultValue: true, description: 'Turns on debug logging for 24 hours.' if (advancedOptions == true || advancedOptions == false) { // groovy ... if (device.hasCapability("TemperatureMeasurement") || device.hasCapability("RelativeHumidityMeasurement") || device.hasCapability("IlluminanceMeasurement")) { input name: "minReportingTime", type: "number", title: "Minimum time between reports", description: "Minimum reporting interval, seconds (1..300)", range: "1..300", defaultValue: DEFAULT_MIN_REPORTING_TIME input name: "maxReportingTime", type: "number", title: "Maximum time between reports", description: "Maximum reporting interval, seconds (120..10000)", range: "120..10000", defaultValue: DEFAULT_MAX_REPORTING_TIME } if (device.hasCapability("IlluminanceMeasurement")) { input name: "illuminanceThreshold", type: "number", title: "Illuminance Reporting Threshold", description: "Illuminance reporting threshold, range (1..255)
Bigger values will result in less frequent reporting", range: "1..255", defaultValue: DEFAULT_ILLUMINANCE_THRESHOLD input name: "illuminanceCoeff", type: "decimal", title: "Illuminance Correction Coefficient", description: "Illuminance correction coefficient, range (0.10..10.00)", range: "0.10..10.00", defaultValue: 1.00 } } input name: 'advancedOptions', type: 'bool', title: 'Advanced Options', description: "These advanced options should be already automatically set in an optimal way for your device...", defaultValue: false if (advancedOptions == true || advancedOptions == true) { input name: 'healthCheckMethod', type: 'enum', title: 'Healthcheck Method', options: HealthcheckMethodOpts.options, defaultValue: HealthcheckMethodOpts.defaultValue, required: true, description: \ 'Method to check device online/offline status.' //if (healthCheckMethod != null && safeToInt(healthCheckMethod.value) != 0) { input name: 'healthCheckInterval', type: 'enum', title: 'Healthcheck Interval', options: HealthcheckIntervalOpts.options, defaultValue: HealthcheckIntervalOpts.defaultValue, required: true, description: \ 'How often the hub will check the device health.
3 consecutive failures will result in status "offline"' //} if (device.hasCapability("Battery")) { input name: 'voltageToPercent', type: 'bool', title: 'Battery Voltage to Percentage', defaultValue: false, description: 'Convert battery voltage to battery Percentage remaining.' } if ((deviceType in ["Switch", "Plug", "Dimmer"]) && _THREE_STATE == true) { input name: 'threeStateEnable', type: 'bool', title: 'Enable three-states events', description: 'What\'s wrong with the three-state concept?', defaultValue: false } } } } @Field static final Integer DIGITAL_TIMER = 1000 // command was sent by this driver @Field static final Integer REFRESH_TIMER = 5000 // refresh time in miliseconds @Field static final Integer DEBOUNCING_TIMER = 300 // ignore switch events @Field static final Integer COMMAND_TIMEOUT = 10 // timeout time in seconds @Field static final Integer MAX_PING_MILISECONDS = 10000 // rtt more than 10 seconds will be ignored @Field static final String UNKNOWN = "UNKNOWN" @Field static final Integer DEFAULT_MIN_REPORTING_TIME = 10 // send the report event no more often than 10 seconds by default @Field static final Integer DEFAULT_MAX_REPORTING_TIME = 3600 @Field static final Integer PRESENCE_COUNT_THRESHOLD = 3 // missing 3 checks will set the device healthStatus to offline @Field static final int DELAY_MS = 200 // Delay in between zigbee commands @Field static final Integer DEFAULT_ILLUMINANCE_THRESHOLD = 5 @Field static final Integer INFO_AUTO_CLEAR_PERIOD = 30 // automatically clear the Info attribute after 30 seconds @Field static final Map HealthcheckMethodOpts = [ // used by healthCheckMethod defaultValue: 1, options : [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] ] @Field static final Map HealthcheckIntervalOpts = [ // used by healthCheckInterval defaultValue: 240, options : [10: 'Every 10 Mins', 30: 'Every 30 Mins', 60: 'Every 1 Hour', 240: 'Every 4 Hours', 720: 'Every 12 Hours'] ] @Field static final Map SwitchThreeStateOpts = [ defaultValue: 0, options : [0: 'off', 1: 'on', 2: 'switching_off', 3: 'switching_on', 4: 'switch_failure'] ] @Field static final Map ZigbeeGroupsOptsDebug = [ defaultValue: 0, options : [99: '--- select ---', 0: 'Add group', 1: 'View group', 2: 'Get group membership', 3: 'Remove group', 4: 'Remove all groups', 5: 'Add group if identifying'] ] @Field static final Map ZigbeeGroupsOpts = [ defaultValue: 0, options : [99: '--- select ---', 0: 'Add group', 2: 'Get group membership', 3: 'Remove group', 4: 'Remove all groups'] ] def isChattyDeviceReport(description) {return false /*(description?.contains("cluster: FC7E")) */} def isVINDSTYRKA() { (device?.getDataValue('model') ?: 'n/a') in ['VINDSTYRKA'] } // TODO - conflict w/ the lib! def isAqaraTVOC() { (device?.getDataValue('model') ?: 'n/a') in ['lumi.airmonitor.acn01'] } // TODO - conflict w/ the lib! def isAqaraTRV() { (device?.getDataValue('model') ?: 'n/a') in ['lumi.airrtc.agl001'] } def isAqaraFP1() { (device?.getDataValue('model') ?: 'n/a') in ['lumi.motion.ac01'] } def isFingerbot() { (device?.getDataValue('manufacturer') ?: 'n/a') in ['_TZ3210_dse8ogfy'] } def isAqaraCube() { (device?.getDataValue('model') ?: 'n/a') in ['lumi.remote.cagl02'] } /** * Parse Zigbee message * @param description Zigbee message in hex format */ void parse(final String description) { checkDriverVersion() if (!isChattyDeviceReport(description)) { logDebug "parse: ${description}" } if (state.stats != null) state.stats['rxCtr'] = (state.stats['rxCtr'] ?: 0) + 1 else state.stats=[:] unschedule('deviceCommandTimeout') setHealthStatusOnline() if (description?.startsWith('zone status') || description?.startsWith('zone report')) { logDebug "parse: zone status: $description" if (true /*isHL0SS9OAradar() && _IGNORE_ZCL_REPORTS == true*/) { // TODO! logDebug "ignored IAS zone status" return } else { parseIasMessage(description) // TODO! } } else if (description?.startsWith('enroll request')) { logDebug "parse: enroll request: $description" /* The Zone Enroll Request command is generated when a device embodying the Zone server cluster wishes to be enrolled as an active alarm device. It must do this immediately it has joined the network (during commissioning). */ if (settings?.logEnable) logInfo "Sending IAS enroll response..." ArrayList cmds = zigbee.enrollResponse() + zigbee.readAttribute(0x0500, 0x0000) logDebug "enroll response: ${cmds}" sendZigbeeCommands( cmds ) } if (isTuyaE00xCluster(description) == true || otherTuyaOddities(description) == true) { return } final Map descMap = myParseDescriptionAsMap(description) if (descMap.profileId == '0000') { parseZdoClusters(descMap) return } if (descMap.isClusterSpecific == false) { parseGeneralCommandResponse(descMap) return } if (!isChattyDeviceReport(description)) {logDebug "descMap = ${descMap}"} // final String clusterName = clusterLookup(descMap.clusterInt) final String attribute = descMap.attrId ? " attribute 0x${descMap.attrId} (value ${descMap.value})" : '' //if (settings.logEnable) { log.trace "zigbee received ${clusterName} message" + attribute } switch (descMap.clusterInt as Integer) { case zigbee.BASIC_CLUSTER: // 0x0000 parseBasicCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseBasicCluster(descMap + map) } break case zigbee.POWER_CONFIGURATION_CLUSTER: // 0x0001 parsePowerCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parsePowerCluster(descMap + map) } break case zigbee.IDENTIFY_CLUSTER: // 0x0003 parseIdentityCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseIdentityCluster(descMap + map) } break case zigbee.GROUPS_CLUSTER: // 0x0004 parseGroupsCluster(descMap) descMap.remove('additionalAttrs')?.each {final Map map -> parseGroupsCluster(descMap + map) } break case zigbee.SCENES_CLUSTER: // 0x0005 parseScenesCluster(descMap) descMap.remove('additionalAttrs')?.each {final Map map -> parseScenesCluster(descMap + map) } break case zigbee.ON_OFF_CLUSTER: // 0x0006 parseOnOffCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseOnOffCluster(descMap + map) } break case zigbee.LEVEL_CONTROL_CLUSTER: // 0x0008 parseLevelControlCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseLevelControlCluster(descMap + map) } break case 0x000C : // Aqara TVOC Air Monitor; Aqara Cube T1 Pro parseAnalogInputCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseAnalogInputCluster(descMap + map) } break case 0x0012 : // Aqara Cube - Multistate Input parseMultistateInputCluster(descMap) break case 0x0201 : // Aqara E1 TRV parseThermostatCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseThermostatCluster(descMap + map) } break case zigbee.ILLUMINANCE_MEASUREMENT_CLUSTER : //0x0400 parseIlluminanceCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseIlluminanceCluster(descMap + map) } break case zigbee.TEMPERATURE_MEASUREMENT_CLUSTER : //0x0402 parseTemperatureCluster(descMap) break case zigbee.RELATIVE_HUMIDITY_MEASUREMENT_CLUSTER : //0x0405 parseHumidityCluster(descMap) break case 0x042A : // pm2.5 parsePm25Cluster(descMap) break case zigbee.ELECTRICAL_MEASUREMENT_CLUSTER: parseElectricalMeasureCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseElectricalMeasureCluster(descMap + map) } break case zigbee.METERING_CLUSTER: parseMeteringCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseMeteringCluster(descMap + map) } break case 0xE002 : parseE002Cluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseE002Cluster(descMap + map) } break case 0xEF00 : // Tuya famous cluster parseTuyaCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map map -> parseTuyaCluster(descMap + map) } break case 0xfc7e : // tVOC 'Sensirion VOC index' https://sensirion.com/media/documents/02232963/6294E043/Info_Note_VOC_Index.pdf parseAirQualityIndexCluster(descMap) break case XIAOMI_CLUSTER_ID : // 0xFCC0 Xiaomi cluster parseXiaomiCluster(descMap) descMap.remove('additionalAttrs')?.each { final Map m -> parseXiaomiCluster(descMap + m) } break default: if (settings.logEnable) { logWarn "zigbee received unknown cluster:${descMap.cluster} message (${descMap})" } break } } /** * ZDO (Zigbee Data Object) Clusters Parsing * @param descMap Zigbee message in parsed map format */ void parseZdoClusters(final Map descMap) { final Integer clusterId = descMap.clusterInt as Integer final String clusterName = ZdoClusterEnum[clusterId] ?: "UNKNOWN_CLUSTER (0x${descMap.clusterId})" final String statusHex = ((List)descMap.data)[1] final Integer statusCode = hexStrToUnsignedInt(statusHex) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${statusHex}" if (statusCode > 0x00) { logWarn "parseZdoClusters: ZDO ${clusterName} error: ${statusName} (statusCode: 0x${statusHex})" } else { logDebug "parseZdoClusters: ZDO ${clusterName} success: ${descMap.data}" } } /** * Zigbee General Command Parsing * @param descMap Zigbee message in parsed map format */ void parseGeneralCommandResponse(final Map descMap) { final int commandId = hexStrToUnsignedInt(descMap.command) switch (commandId) { case 0x01: // read attribute response parseReadAttributeResponse(descMap) break case 0x04: // write attribute response parseWriteAttributeResponse(descMap) break case 0x07: // configure reporting response parseConfigureResponse(descMap) break case 0x09: // read reporting configuration response parseReadReportingConfigResponse(descMap) break case 0x0B: // default command response parseDefaultCommandResponse(descMap) break default: final String commandName = ZigbeeGeneralCommandEnum[commandId] ?: "UNKNOWN_COMMAND (0x${descMap.command})" final String clusterName = clusterLookup(descMap.clusterInt) final String status = descMap.data in List ? ((List)descMap.data).last() : descMap.data final int statusCode = hexStrToUnsignedInt(status) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" if (statusCode > 0x00) { log.warn "zigbee ${commandName} ${clusterName} error: ${statusName}" } else if (settings.logEnable) { log.trace "zigbee ${commandName} ${clusterName}: ${descMap.data}" } break } } /** * Zigbee Read Attribute Response Parsing * @param descMap Zigbee message in parsed map format */ void parseReadAttributeResponse(final Map descMap) { final List data = descMap.data as List final String attribute = data[1] + data[0] final int statusCode = hexStrToUnsignedInt(data[2]) final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data}" if (statusCode > 0x00) { logWarn "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} error: ${status}" } else { logDebug "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} response: ${status} ${data}" } } /** * Zigbee Write Attribute Response Parsing * @param descMap Zigbee message in parsed map format */ void parseWriteAttributeResponse(final Map descMap) { final String data = descMap.data in List ? ((List)descMap.data).first() : descMap.data final int statusCode = hexStrToUnsignedInt(data) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data}" if (statusCode > 0x00) { logWarn "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute error: ${statusName}" } else { logDebug "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute response: ${statusName}" } } /** * Zigbee Configure Reporting Response Parsing * @param descMap Zigbee message in parsed map format */ void parseConfigureResponse(final Map descMap) { // TODO - parse the details of the configuration respose - cluster, min, max, delta ... final String status = ((List)descMap.data).first() final int statusCode = hexStrToUnsignedInt(status) if (statusCode == 0x00 && settings.enableReporting != false) { state.reportingEnabled = true } final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" if (statusCode > 0x00) { log.warn "zigbee configure reporting error: ${statusName} ${descMap.data}" } else { logDebug "zigbee configure reporting response: ${statusName} ${descMap.data}" } } /** * Zigbee Default Command Response Parsing * @param descMap Zigbee message in parsed map format */ void parseDefaultCommandResponse(final Map descMap) { final List data = descMap.data as List final String commandId = data[0] final int statusCode = hexStrToUnsignedInt(data[1]) final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data[1]}" if (statusCode > 0x00) { logWarn "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} error: ${status}" } else { logDebug "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} response: ${status}" } } // Zigbee Attribute IDs @Field static final int AC_CURRENT_DIVISOR_ID = 0x0603 @Field static final int AC_CURRENT_MULTIPLIER_ID = 0x0602 @Field static final int AC_FREQUENCY_ID = 0x0300 @Field static final int AC_POWER_DIVISOR_ID = 0x0605 @Field static final int AC_POWER_MULTIPLIER_ID = 0x0604 @Field static final int AC_VOLTAGE_DIVISOR_ID = 0x0601 @Field static final int AC_VOLTAGE_MULTIPLIER_ID = 0x0600 @Field static final int ACTIVE_POWER_ID = 0x050B @Field static final int ATTRIBUTE_READING_INFO_SET = 0x0000 @Field static final int FIRMWARE_VERSION_ID = 0x4000 @Field static final int PING_ATTR_ID = 0x01 @Field static final int POWER_ON_OFF_ID = 0x0000 @Field static final int POWER_RESTORE_ID = 0x4003 @Field static final int RMS_CURRENT_ID = 0x0508 @Field static final int RMS_VOLTAGE_ID = 0x0505 @Field static final Map ZigbeeStatusEnum = [ 0x00: 'Success', 0x01: 'Failure', 0x02: 'Not Authorized', 0x80: 'Malformed Command', 0x81: 'Unsupported COMMAND', 0x85: 'Invalid Field', 0x86: 'Unsupported Attribute', 0x87: 'Invalid Value', 0x88: 'Read Only', 0x89: 'Insufficient Space', 0x8A: 'Duplicate Exists', 0x8B: 'Not Found', 0x8C: 'Unreportable Attribute', 0x8D: 'Invalid Data Type', 0x8E: 'Invalid Selector', 0x94: 'Time out', 0x9A: 'Notification Pending', 0xC3: 'Unsupported Cluster' ] @Field static final Map ZdoClusterEnum = [ 0x0002: 'Node Descriptor Request', 0x0005: 'Active Endpoints Request', 0x0006: 'Match Descriptor Request', 0x0022: 'Unbind Request', 0x0013: 'Device announce', 0x0034: 'Management Leave Request', 0x8002: 'Node Descriptor Response', 0x8004: 'Simple Descriptor Response', 0x8005: 'Active Endpoints Response', 0x801D: 'Extended Simple Descriptor Response', 0x801E: 'Extended Active Endpoint Response', 0x8021: 'Bind Response', 0x8022: 'Unbind Response', 0x8023: 'Bind Register Response', 0x8034: 'Management Leave Response' ] @Field static final Map ZigbeeGeneralCommandEnum = [ 0x00: 'Read Attributes', 0x01: 'Read Attributes Response', 0x02: 'Write Attributes', 0x03: 'Write Attributes Undivided', 0x04: 'Write Attributes Response', 0x05: 'Write Attributes No Response', 0x06: 'Configure Reporting', 0x07: 'Configure Reporting Response', 0x08: 'Read Reporting Configuration', 0x09: 'Read Reporting Configuration Response', 0x0A: 'Report Attributes', 0x0B: 'Default Response', 0x0C: 'Discover Attributes', 0x0D: 'Discover Attributes Response', 0x0E: 'Read Attributes Structured', 0x0F: 'Write Attributes Structured', 0x10: 'Write Attributes Structured Response', 0x11: 'Discover Commands Received', 0x12: 'Discover Commands Received Response', 0x13: 'Discover Commands Generated', 0x14: 'Discover Commands Generated Response', 0x15: 'Discover Attributes Extended', 0x16: 'Discover Attributes Extended Response' ] /* * ----------------------------------------------------------------------------- * Xiaomi cluster 0xFCC0 parser. * ----------------------------------------------------------------------------- */ @Field static final int XIAOMI_CLUSTER_ID = 0xFCC0 // Zigbee Attributes @Field static final int DIRECTION_MODE_ATTR_ID = 0x0144 @Field static final int MODEL_ATTR_ID = 0x05 @Field static final int PRESENCE_ACTIONS_ATTR_ID = 0x0143 @Field static final int PRESENCE_ATTR_ID = 0x0142 @Field static final int REGION_EVENT_ATTR_ID = 0x0151 @Field static final int RESET_PRESENCE_ATTR_ID = 0x0157 @Field static final int SENSITIVITY_LEVEL_ATTR_ID = 0x010C @Field static final int SET_EDGE_REGION_ATTR_ID = 0x0156 @Field static final int SET_EXIT_REGION_ATTR_ID = 0x0153 @Field static final int SET_INTERFERENCE_ATTR_ID = 0x0154 @Field static final int SET_REGION_ATTR_ID = 0x0150 @Field static final int TRIGGER_DISTANCE_ATTR_ID = 0x0146 @Field static final int XIAOMI_RAW_ATTR_ID = 0xFFF2 @Field static final int XIAOMI_SPECIAL_REPORT_ID = 0x00F7 @Field static final Map MFG_CODE = [ mfgCode: 0x115F ] // Xiaomi Tags @Field static final int DIRECTION_MODE_TAG_ID = 0x67 @Field static final int SENSITIVITY_LEVEL_TAG_ID = 0x66 @Field static final int SWBUILD_TAG_ID = 0x08 @Field static final int TRIGGER_DISTANCE_TAG_ID = 0x69 @Field static final int PRESENCE_ACTIONS_TAG_ID = 0x66 @Field static final int PRESENCE_TAG_ID = 0x65 void parseXiaomiCluster(final Map descMap) { if (settings.logEnable) { //log.trace "zigbee received xiaomi cluster attribute 0x${descMap.attrId} (value ${descMap.value})" } switch (descMap.attrInt as Integer) { case 0x0009: // Aqara Cube T1 Pro if (DEVICE_TYPE in ["AqaraCube"]) { logDebug "AqaraCube 0xFCC0 attribute 0x009 value is ${hexStrToUnsignedInt(descMap.value)}" } else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } break case 0x00FC: // FP1 log.info "unknown attribute - resetting?" break case PRESENCE_ATTR_ID: // 0x0142 FP1 final Integer value = hexStrToUnsignedInt(descMap.value) parseXiaomiClusterPresence(value) break case PRESENCE_ACTIONS_ATTR_ID: // 0x0143 FP1 final Integer value = hexStrToUnsignedInt(descMap.value) parseXiaomiClusterPresenceAction(value) break case REGION_EVENT_ATTR_ID: // 0x0151 FP1 // Region events can be sent fast and furious so buffer them final Integer regionId = HexUtils.hexStringToInt(descMap.value[0..1]) final Integer value = HexUtils.hexStringToInt(descMap.value[2..3]) if (settings.logEnable) { log.debug "xiaomi: region ${regionId} action is ${value}" } if (device.currentValue("region${regionId}") != null) { RegionUpdateBuffer.get(device.id).put(regionId, value) runInMillis(REGION_UPDATE_DELAY_MS, 'updateRegions') } break case SENSITIVITY_LEVEL_ATTR_ID: // 0x010C FP1 final Integer value = hexStrToUnsignedInt(descMap.value) log.info "sensitivity level is '${SensitivityLevelOpts.options[value]}' (0x${descMap.value})" device.updateSetting('sensitivityLevel', [value: value.toString(), type: 'enum']) break case TRIGGER_DISTANCE_ATTR_ID: // 0x0146 FP1 final Integer value = hexStrToUnsignedInt(descMap.value) log.info "approach distance is '${ApproachDistanceOpts.options[value]}' (0x${descMap.value})" device.updateSetting('approachDistance', [value: value.toString(), type: 'enum']) break case DIRECTION_MODE_ATTR_ID: // 0x0144 FP1 final Integer value = hexStrToUnsignedInt(descMap.value) log.info "monitoring direction mode is '${DirectionModeOpts.options[value]}' (0x${descMap.value})" device.updateSetting('directionMode', [value: value.toString(), type: 'enum']) break case 0x0148 : // Aqara Cube T1 Pro - Mode if (DEVICE_TYPE in ["AqaraCube"]) { parseXiaomiClusterAqaraCube(descMap) } else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } break case 0x0149: // (329) Aqara Cube T1 Pro - i side facing up (0..5) if (DEVICE_TYPE in ["AqaraCube"]) { parseXiaomiClusterAqaraCube(descMap) } else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } break case XIAOMI_SPECIAL_REPORT_ID: // 0x00F7 sent every 55 minutes final Map tags = decodeXiaomiTags(descMap.value) parseXiaomiClusterTags(tags) if (isAqaraCube()) { sendZigbeeCommands(refreshAqaraCube()) } break case XIAOMI_RAW_ATTR_ID: // 0xFFF2 FP1 final byte[] rawData = HexUtils.hexStringToByteArray(descMap.value) if (rawData.size() == 24 && settings.enableDistanceDirection) { final int degrees = rawData[19] final int distanceCm = (rawData[17] << 8) | (rawData[18] & 0x00ff) if (settings.logEnable) { log.debug "location ${degrees}°, ${distanceCm}cm" } runIn(1, 'updateLocation', [ data: [ degrees: degrees, distanceCm: distanceCm ] ]) } break case 0x0271: // result['system_mode'] = {1: 'heat', 0: 'off'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "system_mode raw = ${value}" break; case 0x0272: // result['preset'] = {2: 'away', 1: 'auto', 0: 'manual'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "preset raw = ${value}" break; case 0x0273: // result['window_detection'] = {1: 'ON', 0: 'OFF'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "window_detection raw = ${value}" break; case 0x0274: // result['valve_detection'] = {1: 'ON', 0: 'OFF'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "valve_detection raw = ${value}" break; case 0x0275: // result['valve_alarm'] = {1: true, 0: false}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "valve_alarm raw = ${value}" break; case 0x0277: // result['child_lock'] = {1: 'LOCK', 0: 'UNLOCK'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "child_lock raw = ${value}" break; case 0x0279: // result['away_preset_temperature'] = (value / 100).toFixed(1); final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "away_preset_temperature raw = ${value}" break; case 0x027a: // result['window_open'] = {1: true, 0: false}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "window_open raw = ${value}" break; case 0x027b: // result['calibrated'] = {1: true, 0: false}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "calibrated raw = ${value}" break; case 0x0276: // unknown case 0x027c: // unknown case 0x027d: // unknown case 0x0280: // unknown case 0xfff2: // unknown case 0x00ff: // unknown case 0x00f7: // unknown case 0xfff2: // unknown try { final Integer value = hexStrToUnsignedInt(descMap.value) logDebug "Aqara E1 TRV unknown attribute ${descMap.attrInt} value raw = ${value}" } catch (e) { logWarn "exception caught while processing Aqara E1 TRV unknown attribute ${descMap.attrInt} descMap.value = ${descMap.value}" } break; case 0x027e: // result['sensor'] = {1: 'external', 0: 'internal'}[value]; final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "sensor raw = ${value}" break; case 0x040a: // E1 battery final Integer value = hexStrToUnsignedInt(descMap.value) logInfo "battery raw = ${value}" break case 0x00FF: // unknown break default: log.warn "zigbee received unknown xiaomi cluster 0xFCC0 attribute 0x${descMap.attrId} (value ${descMap.value})" break } } void parseXiaomiClusterTags(final Map tags) { tags.each { final Integer tag, final Object value -> switch (tag) { case 0x01: // battery voltage logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} battery voltage is ${value/1000}V (raw=${value})" break case 0x03: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} device temperature is ${value}°" break case 0x05: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} RSSI is ${value}" break case 0x06: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} LQI is ${value}" break case 0x08: // SWBUILD_TAG_ID: final String swBuild = '0.0.0_' + (value & 0xFF).toString().padLeft(4, '0') logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} swBuild is ${swBuild} (raw ${value})" device.updateDataValue("aqaraVersion", swBuild) break case 0x0a: String nwk = intToHexStr(value as Integer,2) if (state.health == null) { state.health = [:] } String oldNWK = state.health['parentNWK'] ?: 'n/a' logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} Parent NWK is ${nwk}" if (oldNWK != nwk ) { logWarn "parentNWK changed from ${oldNWK} to ${nwk}" state.health['parentNWK'] = nwk state.health['nwkCtr'] = (state.health['nwkCtr'] ?: 0) + 1 } break case 0x0b: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} light level is ${value}" break case 0x64: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} temperature is ${value/100} (raw ${value})" // Aqara TVOC // TODO - also smoke gas/density if UINT ! break case 0x65: if (isAqaraFP1()) { logDebug "xiaomi decode PRESENCE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } else { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} humidity is ${value/100} (raw ${value})" } // Aqara TVOC break case 0x66: if (isAqaraFP1()) { logDebug "xiaomi decode SENSITIVITY_LEVEL_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } else if (isAqaraTVOC()) { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} airQualityIndex is ${value}" } // Aqara TVOC level (in ppb) else { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} presure is ${value}" } break case 0x67: if (isAqaraFP1()) { logDebug "xiaomi decode DIRECTION_MODE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } else { logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } // Aqara TVOC: // air quality (as 6 - #stars) ['excellent', 'good', 'moderate', 'poor', 'unhealthy'][val - 1] break case 0x69: if (isAqaraFP1()) { logDebug "xiaomi decode TRIGGER_DISTANCE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } else { logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } break case 0x6a: if (isAqaraFP1()) { logDebug "xiaomi decode FP1 unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } else { logDebug "xiaomi decode MOTION SENSITIVITY tag: 0x${intToHexStr(tag, 1)}=${value}" } break case 0x6b: if (isAqaraFP1()) { logDebug "xiaomi decode FP1 unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } else { logDebug "xiaomi decode MOTION LED tag: 0x${intToHexStr(tag, 1)}=${value}" } break case 0x95: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} energy is ${value}" break case 0x96: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} voltage is ${value}" break case 0x97: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} current is ${value}" break case 0x98: logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} power is ${value}" break case 0x9b: if (isAqaraCube()) { logDebug "Aqara cubeMode tag: 0x${intToHexStr(tag, 1)} is '${AqaraCubeModeOpts.options[value as int]}' (${value})" sendAqaraCubeOperationModeEvent(value as int) } else { logDebug "xiaomi decode CONSUMER CONNECTED tag: 0x${intToHexStr(tag, 1)}=${value}" } break default: logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } } } /** * Reads a specified number of little-endian bytes from a given * ByteArrayInputStream and returns a BigInteger. */ private static BigInteger readBigIntegerBytes(final ByteArrayInputStream stream, final int length) { final byte[] byteArr = new byte[length] stream.read(byteArr, 0, length) BigInteger bigInt = BigInteger.ZERO for (int i = byteArr.length - 1; i >= 0; i--) { bigInt |= (BigInteger.valueOf((byteArr[i] & 0xFF) << (8 * i))) } return bigInt } /** * Decodes a Xiaomi Zigbee cluster attribute payload in hexadecimal format and * returns a map of decoded tag number and value pairs where the value is either a * BigInteger for fixed values or a String for variable length. */ private static Map decodeXiaomiTags(final String hexString) { final Map results = [:] final byte[] bytes = HexUtils.hexStringToByteArray(hexString) new ByteArrayInputStream(bytes).withCloseable { final stream -> while (stream.available() > 2) { int tag = stream.read() int dataType = stream.read() Object value if (DataType.isDiscrete(dataType)) { int length = stream.read() byte[] byteArr = new byte[length] stream.read(byteArr, 0, length) value = new String(byteArr) } else { int length = DataType.getLength(dataType) value = readBigIntegerBytes(stream, length) } results[tag] = value } } return results } @Field static final int ROLLING_AVERAGE_N = 10 double approxRollingAverage (double avg, double new_sample) { if (avg == null || avg == 0) { avg = new_sample} avg -= avg / ROLLING_AVERAGE_N avg += new_sample / ROLLING_AVERAGE_N // TOSO: try Method II : New average = old average * (n-1)/n + new value /n return avg } /* * ----------------------------------------------------------------------------- * Standard clusters reporting handlers * ----------------------------------------------------------------------------- */ @Field static final Map powerSourceOpts = [ defaultValue: 0, options: [0: 'unknown', 1: 'mains', 2: 'mains', 3: 'battery', 4: 'dc', 5: 'emergency mains', 6: 'emergency mains']] /** * Zigbee Basic Cluster Parsing 0x0000 * @param descMap Zigbee message in parsed map format */ void parseBasicCluster(final Map descMap) { def now = new Date().getTime() if (state.lastRx == null) { state.lastRx = [:] } if (state.lastTx == null) { state.lastTx = [:] } if (state.states == null) { state.states = [:] } if (state.stats == null) { state.stats = [:] } state.lastRx["checkInTime"] = now switch (descMap.attrInt as Integer) { case 0x0000: logDebug "Basic cluster: ZCLVersion = ${descMap?.value}" break case PING_ATTR_ID: // 0x01 - Using 0x01 read as a simple ping/pong mechanism boolean isPing = state.states["isPing"] ?: false if (isPing) { def timeRunning = now.toInteger() - (state.lastTx["pingTime"] ?: '0').toInteger() if (timeRunning > 0 && timeRunning < MAX_PING_MILISECONDS) { state.stats['pingsOK'] = (state.stats['pingsOK'] ?: 0) + 1 if (timeRunning < safeToInt((state.stats['pingsMin'] ?: '999'))) { state.stats['pingsMin'] = timeRunning } if (timeRunning > safeToInt((state.stats['pingsMax'] ?: '0'))) { state.stats['pingsMax'] = timeRunning } state.stats['pingsAvg'] = approxRollingAverage(safeToDouble(state.stats['pingsAvg']),safeToDouble(timeRunning)) as int sendRttEvent() } else { logWarn "unexpected ping timeRunning=${timeRunning} " } state.states["isPing"] = false } else { logDebug "Tuya check-in message (attribute ${descMap.attrId} reported: ${descMap.value})" } break case 0x0004: logDebug "received device manufacturer ${descMap?.value}" // received device manufacturer IKEA of Sweden def manufacturer = device.getDataValue("manufacturer") if ((manufacturer == null || manufacturer == "unknown") && (descMap?.value != null) ) { logWarn "updating device manufacturer from ${manufacturer} to ${descMap?.value}" device.updateDataValue("manufacturer", descMap?.value) } break case 0x0005: logDebug "received device model ${descMap?.value}" // received device model Remote Control N2 def model = device.getDataValue("model") if ((model == null || model == "unknown") && (descMap?.value != null) ) { logWarn "updating device model from ${model} to ${descMap?.value}" device.updateDataValue("model", descMap?.value) } break case 0x0007: def powerSourceReported = powerSourceOpts.options[descMap?.value as int] logDebug "received Power source ${powerSourceReported} (${descMap?.value})" //powerSourceEvent( powerSourceReported ) break case 0xFFDF: logDebug "Tuya check-in (Cluster Revision=${descMap?.value})" break case 0xFFE2: logDebug "Tuya check-in (AppVersion=${descMap?.value})" break case [0xFFE0, 0xFFE1, 0xFFE3, 0xFFE4] : logDebug "Tuya unknown attribute ${descMap?.attrId} value=${descMap?.value}" break case 0xFFFE: logDebug "Tuya attributeReportingStatus (attribute FFFE) value=${descMap?.value}" break case FIRMWARE_VERSION_ID: // 0x4000 final String version = descMap.value ?: 'unknown' log.info "device firmware version is ${version}" updateDataValue('softwareBuild', version) break default: logWarn "zigbee received unknown Basic cluster attribute 0x${descMap.attrId} (value ${descMap.value})" break } } /* * ----------------------------------------------------------------------------- * power cluster 0x0001 * ----------------------------------------------------------------------------- */ void parsePowerCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value if (descMap.attrId in ["0020", "0021"]) { state.lastRx["batteryTime"] = new Date().getTime() state.stats["battCtr"] = (state.stats["battCtr"] ?: 0 ) + 1 } final long rawValue = hexStrToUnsignedInt(descMap.value) if (descMap.attrId == "0020") { sendBatteryVoltageEvent(rawValue) if ((settings.voltageToPercent ?: false) == true) { sendBatteryVoltageEvent(rawValue, convertToPercent=true) } } else if (descMap.attrId == "0021") { sendBatteryPercentageEvent(rawValue * 2) } else { logWarn "zigbee received unknown Power cluster attribute 0x${descMap.attrId} (value ${descMap.value})" } } def sendBatteryVoltageEvent(rawValue, Boolean convertToPercent=false) { logDebug "batteryVoltage = ${(double)rawValue / 10.0} V" def result = [:] def volts = rawValue / 10 if (!(rawValue == 0 || rawValue == 255)) { def minVolts = 2.2 def maxVolts = 3.2 def pct = (volts - minVolts) / (maxVolts - minVolts) def roundedPct = Math.round(pct * 100) if (roundedPct <= 0) roundedPct = 1 if (roundedPct >100) roundedPct = 100 if (convertToPercent == true) { result.value = Math.min(100, roundedPct) result.name = 'battery' result.unit = '%' result.descriptionText = "battery is ${roundedPct} %" } else { result.value = volts result.name = 'batteryVoltage' result.unit = 'V' result.descriptionText = "battery is ${volts} Volts" } result.type = 'physical' result.isStateChange = true logInfo "${result.descriptionText}" sendEvent(result) } else { logWarn "ignoring BatteryResult(${rawValue})" } } def sendBatteryPercentageEvent( batteryPercent, isDigital=false ) { def map = [:] map.name = 'battery' map.timeStamp = now() map.value = batteryPercent < 0 ? 0 : batteryPercent > 100 ? 100 : (batteryPercent as int) map.unit = '%' map.type = isDigital ? 'digital' : 'physical' map.descriptionText = "${map.name} is ${map.value} ${map.unit}" map.isStateChange = true // def latestBatteryEvent = device.latestState('battery', skipCache=true) def latestBatteryEventTime = latestBatteryEvent != null ? latestBatteryEvent.getDate().getTime() : now() //log.debug "battery latest state timeStamp is ${latestBatteryTime} now is ${now()}" def timeDiff = ((now() - latestBatteryEventTime) / 1000) as int if (settings?.batteryDelay == null || (settings?.batteryDelay as int) == 0 || timeDiff > (settings?.batteryDelay as int)) { // send it now! sendDelayedBatteryPercentageEvent(map) } else { def delayedTime = (settings?.batteryDelay as int) - timeDiff map.delayed = delayedTime map.descriptionText += " [delayed ${map.delayed} seconds]" logDebug "this battery event (${map.value}%) will be delayed ${delayedTime} seconds" runIn( delayedTime, 'sendDelayedBatteryEvent', [overwrite: true, data: map]) } } private void sendDelayedBatteryPercentageEvent(Map map) { logInfo "${map.descriptionText}" //map.each {log.trace "$it"} sendEvent(map) } private void sendDelayedBatteryVoltageEvent(Map map) { logInfo "${map.descriptionText}" //map.each {log.trace "$it"} sendEvent(map) } /* * ----------------------------------------------------------------------------- * Zigbee Identity Cluster 0x0003 * ----------------------------------------------------------------------------- */ void parseIdentityCluster(final Map descMap) { logDebug "unprocessed parseIdentityCluster" } /* * ----------------------------------------------------------------------------- * Zigbee Scenes Cluster 0x005 * ----------------------------------------------------------------------------- */ void parseScenesCluster(final Map descMap) { if (DEVICE_TYPE in ["ButtonDimmer"]) { parseScenesClusterButtonDimmer(descMap) } else { logWarn "unprocessed ScenesCluste attribute ${descMap.attrId}" } } /* * ----------------------------------------------------------------------------- * Zigbee Groups Cluster Parsing 0x004 ZigbeeGroupsOpts * ----------------------------------------------------------------------------- */ void parseGroupsCluster(final Map descMap) { // :catchall: 0104 0004 01 01 0040 00 F396 01 00 0000 00 01 00C005, profileId:0104, clusterId:0004, clusterInt:4, sourceEndpoint:01, destinationEndpoint:01, options:0040, messageType:00, dni:F396, isClusterSpecific:true, isManufacturerSpecific:false, manufacturerId:0000, command:00, direction:01, data:[00, C0, 05]] logDebug "parseGroupsCluster: command=${descMap.command} data=${descMap.data}" if (state.zigbeeGroups == null) state.zigbeeGroups = [:] switch (descMap.command as Integer) { case 0x00: // Add group 0x0001 – 0xfff7 final List data = descMap.data as List final int statusCode = hexStrToUnsignedInt(data[0]) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data[0]}" final String groupId = data[2] + data[1] final int groupIdInt = hexStrToUnsignedInt(groupId) if (statusCode > 0x00) { logWarn "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId 0x${groupId} (${groupIdInt}) error: ${statusName}" } else { logDebug "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId 0x${groupId} (${groupIdInt}) statusCode: ${statusName}" // add the group to state.zigbeeGroups['groups'] if not exist int groupCount = state.zigbeeGroups['groups'].size() for (int i=0; i data = descMap.data as List final int statusCode = hexStrToUnsignedInt(data[0]) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data[0]}" final String groupId = data[2] + data[1] final int groupIdInt = hexStrToUnsignedInt(groupId) if (statusCode > 0x00) { logWarn "zigbee response View group ${groupIdInt} (0x${groupId}) error: ${statusName}" } else { logInfo "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId ${groupIdInt} (0x${groupId}) statusCode: ${statusName}" } break case 0x02: // Get group membership final List data = descMap.data as List final int capacity = hexStrToUnsignedInt(data[0]) final int groupCount = hexStrToUnsignedInt(data[1]) final Set groups = [] for (int i = 0; i < groupCount; i++) { int pos = (i * 2) + 2 String group = data[pos + 1] + data[pos] groups.add(hexStrToUnsignedInt(group)) } state.zigbeeGroups['groups'] = groups state.zigbeeGroups['capacity'] = capacity logInfo "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groups ${groups} groupCount: ${groupCount} capacity: ${capacity}" break case 0x03: // Remove group logInfo "received Remove group GROUPS cluster command: ${descMap.command} (${descMap})" final List data = descMap.data as List final int statusCode = hexStrToUnsignedInt(data[0]) final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data[0]}" final String groupId = data[2] + data[1] final int groupIdInt = hexStrToUnsignedInt(groupId) if (statusCode > 0x00) { logWarn "zigbee response remove group ${groupIdInt} (0x${groupId}) error: ${statusName}" } else { logDebug "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId ${groupIdInt} (0x${groupId}) statusCode: ${statusName}" } // remove it from the states, even if status code was 'Not Found' def index = state.zigbeeGroups['groups'].indexOf(groupIdInt) if (index >= 0) { state.zigbeeGroups['groups'].remove(index) logDebug "Zigbee group ${groupIdInt} (0x${groupId}) removed" } break case 0x04: //Remove all groups logInfo "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId 0x${groupId} statusCode: ${statusName}" logWarn "not implemented!" break case 0x05: // Add group if identifying // add group membership in a particular group for one or more endpoints on the receiving device, on condition that it is identifying itself. Identifying functionality is controlled using the identify cluster, (see 3.5). logInfo "received zigbee GROUPS cluster response for command: ${descMap.command} \'${ZigbeeGroupsOpts.options[descMap.command as int]}\' : groupId 0x${groupId} statusCode: ${statusName}" logWarn "not implemented!" break default: logWarn "received unknown GROUPS cluster command: ${descMap.command} (${descMap})" break } } List addGroupMembership(groupNr) { List cmds = [] final Integer group = safeToInt(groupNr) if (group < 1 || group > 0xFFF7) { logWarn "addGroupMembership: invalid group ${groupNr}" return } final String groupHex = DataType.pack(group, DataType.UINT16, true) cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x00, [:], DELAY_MS, "${groupHex} 00") logDebug "addGroupMembership: adding group ${group} to ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } List viewGroupMembership(groupNr) { List cmds = [] final Integer group = safeToInt(groupNr) final String groupHex = DataType.pack(group, DataType.UINT16, true) cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x01, [:], DELAY_MS, "${groupHex} 00") logDebug "viewGroupMembership: zigbeeGroups is ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } List getGroupMembership(dummy) { List cmds = [] cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x02, [:], DELAY_MS, "00") logDebug "getGroupMembership: zigbeeGroups is ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } List removeGroupMembership(groupNr) { List cmds = [] final Integer group = safeToInt(groupNr) if (group < 1 || group > 0xFFF7) { logWarn "removeGroupMembership: invalid group ${groupNr}" return } final String groupHex = DataType.pack(group, DataType.UINT16, true) cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x03, [:], DELAY_MS, "${groupHex} 00") logDebug "removeGroupMembership: deleting group ${group} from ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } List removeAllGroups(groupNr) { List cmds = [] final Integer group = safeToInt(groupNr) final String groupHex = DataType.pack(group, DataType.UINT16, true) cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x04, [:], DELAY_MS, "${groupHex} 00") logDebug "removeAllGroups: zigbeeGroups is ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } List notImplementedGroups(groupNr) { List cmds = [] final Integer group = safeToInt(groupNr) final String groupHex = DataType.pack(group, DataType.UINT16, true) logWarn "notImplementedGroups: zigbeeGroups is ${state.zigbeeGroups['groups']} cmds=${cmds}" return cmds } @Field static final Map GroupCommandsMap = [ "--- select ---" : [ min: null, max: null, type: 'none', defaultValue: 99, function: 'GroupCommandsHelp'], "Add group" : [ min: 1, max: 0xFFF7, type: 'number', defaultValue: 0, function: 'addGroupMembership'], "View group" : [ min: 0, max: 0xFFF7, type: 'number', defaultValue: 1, function: 'viewGroupMembership'], "Get group membership" : [ min: null, max: null, type: 'none', defaultValue: 2, function: 'getGroupMembership'], "Remove group" : [ min: 0, max: 0xFFF7, type: 'number', defaultValue: 3, function: 'removeGroupMembership'], "Remove all groups" : [ min: null, max: null, type: 'none', defaultValue: 4, function: 'removeAllGroups'], "Add group if identifying" : [ min: 1, max: 0xFFF7, type: 'number', defaultValue: 5, function: 'notImplementedGroups'] ] /* @Field static final Map ZigbeeGroupsOpts = [ defaultValue: 0, options : [99: '--- select ---', 0: 'Add group', 1: 'View group', 2: 'Get group membership', 3: 'Remove group', 4: 'Remove all groups', 5: 'Add group if identifying'] ] */ def zigbeeGroups( command=null, par=null ) { logInfo "executing command \'${command}\', parameter ${par}" ArrayList cmds = [] if (state.zigbeeGroups == null) state.zigbeeGroups = [:] if (state.zigbeeGroups['groups'] == null) state.zigbeeGroups['groups'] = [] def value Boolean validated = false if (command == null || !(command in (GroupCommandsMap.keySet() as List))) { logWarn "zigbeeGroups: command ${command} must be one of these : ${GroupCommandsMap.keySet() as List}" return } value = GroupCommandsMap[command]?.type == "number" ? safeToInt(par, -1) : 0 if (GroupCommandsMap[command]?.type == 'none' || (value >= GroupCommandsMap[command]?.min && value <= GroupCommandsMap[command]?.max)) validated = true if (validated == false && GroupCommandsMap[command]?.min != null && GroupCommandsMap[command]?.max != null) { log.warn "zigbeeGroups: command command parameter ${par} must be within ${GroupCommandsMap[command]?.min} and ${GroupCommandsMap[command]?.max} " return } // def func // try { func = GroupCommandsMap[command]?.function def type = GroupCommandsMap[command]?.type // device.updateSetting("$par", [value:value, type:type]) // TODO !!! cmds = "$func"(value) // } // catch (e) { // logWarn "Exception ${e} caught while processing $func($value)" // return // } logDebug "executed $func($value)" sendZigbeeCommands( cmds ) } def GroupCommandsHelp( val ) { logWarn "GroupCommands: select one of the commands in this list!" } /* * ----------------------------------------------------------------------------- * on/off cluster 0x0006 * ----------------------------------------------------------------------------- */ void parseOnOffCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (DEVICE_TYPE in ["ButtonDimmer"]) { parseOnOffClusterButtonDimmer(descMap) } else if (descMap.attrId == "0000") { if (descMap.value == null || descMap.value == 'FFFF') { logDebug "parseOnOffCluster: invalid value: ${descMap.value}"; return } // invalid or unknown value final long rawValue = hexStrToUnsignedInt(descMap.value) sendSwitchEvent(rawValue) } else if (descMap.attrId in ["4000", "4001", "4002", "4004", "8000", "8001", "8002", "8003"]) { parseOnOffAttributes(descMap) } else { logWarn "unprocessed OnOffCluster attribute ${descMap.attrId}" } } def clearIsDigital() { state.states["isDigital"] = false } def switchDebouncingClear() { state.states["debounce"] = false } def isRefreshRequestClear() { state.states["isRefresh"] = false } def toggle() { def descriptionText = "central button switch is " def state = "" if ((device.currentState('switch')?.value ?: 'n/a') == 'off' ) { state = "on" } else { state = "off" } descriptionText += state sendEvent(name: "switch", value: state, descriptionText: descriptionText, type: "physical", isStateChange: true) logInfo "${descriptionText}" } def off() { if (DEVICE_TYPE in ["Alarm"]) { offAlarm(); return } if ((settings?.alwaysOn ?: false) == true) { logWarn "AlwaysOn option for ${device.displayName} is enabled , the command to switch it OFF is ignored!" return } if (state.states == null) { state.states = [:] } state.states["isDigital"] = true logDebug "Switching ${device.displayName} Off" def cmds = zigbee.off() /* if (device.getDataValue("model") == "HY0105") { cmds += zigbee.command(0x0006, 0x00, "", [destEndpoint: 0x02]) } else if (state.model == "TS0601") { if (isDinRail() || isRTXCircuitBreaker()) { cmds = sendTuyaCommand("10", DP_TYPE_BOOL, "00") } else { cmds = zigbee.command(0xEF00, 0x0, "00010101000100") } } else if (isHEProblematic()) { cmds = ["he cmd 0x${device.deviceNetworkId} 0x01 0x0006 0 {}","delay 200"] logWarn "isHEProblematic() : sending off() : ${cmds}" } else if (device.endpointId == "F2") { cmds = ["he cmd 0x${device.deviceNetworkId} 0x01 0x0006 0 {}","delay 200"] } */ if (_THREE_STATE == true && settings?.threeStateEnable == true) { if ((device.currentState('switch')?.value ?: 'n/a') == 'off' ) { runIn(1, 'refresh', [overwrite: true]) } def value = SwitchThreeStateOpts.options[2] // 'switching_on' def descriptionText = "${value} (2)" sendEvent(name: "switch", value: value, descriptionText: descriptionText, type: "digital", isStateChange: true) logInfo "${descriptionText}" } else { logWarn "_THREE_STATE=${_THREE_STATE} settings?.threeStateEnable=${settings?.threeStateEnable}" } runInMillis( DIGITAL_TIMER, clearIsDigital, [overwrite: true]) sendZigbeeCommands(cmds) } def on() { if (DEVICE_TYPE in ["Alarm"]) { onAlarm(); return } if (state.states == null) { state.states = [:] } state.states["isDigital"] = true logDebug "Switching ${device.displayName} On" def cmds = zigbee.on() /* if (device.getDataValue("model") == "HY0105") { cmds += zigbee.command(0x0006, 0x01, "", [destEndpoint: 0x02]) } else if (state.model == "TS0601") { if (isDinRail() || isRTXCircuitBreaker()) { cmds = sendTuyaCommand("10", DP_TYPE_BOOL, "01") } else { cmds = zigbee.command(0xEF00, 0x0, "00010101000101") } } else if (isHEProblematic()) { cmds = ["he cmd 0x${device.deviceNetworkId} 0x01 0x0006 1 {}","delay 200"] logWarn "isHEProblematic() : sending off() : ${cmds}" } else if (device.endpointId == "F2") { cmds = ["he cmd 0x${device.deviceNetworkId} 0x01 0x0006 1 {}","delay 200"] } */ if (_THREE_STATE == true && settings?.threeStateEnable == true) { if ((device.currentState('switch')?.value ?: 'n/a') == 'on' ) { runIn(1, 'refresh', [overwrite: true]) } def value = SwitchThreeStateOpts.options[3] // 'switching_on' def descriptionText = "${value} (3)" sendEvent(name: "switch", value: value, descriptionText: descriptionText, type: "digital", isStateChange: true) logInfo "${descriptionText}" } else { logWarn "_THREE_STATE=${_THREE_STATE} settings?.threeStateEnable=${settings?.threeStateEnable}" } runInMillis( DIGITAL_TIMER, clearIsDigital, [overwrite: true]) sendZigbeeCommands(cmds) } def sendSwitchEvent( switchValue ) { def value = (switchValue == null) ? 'unknown' : (switchValue == 0x00) ? 'off' : (switchValue == 0x01) ? 'on' : 'unknown' def map = [:] boolean bWasChange = false boolean debounce = state.states["debounce"] ?: false def lastSwitch = state.states["lastSwitch"] ?: "unknown" if (debounce == true && value == lastSwitch) { // some devices send only catchall events, some only readattr reports, but some will fire both... logDebug "Ignored duplicated switch event ${value}" runInMillis( DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) return null } else { //log.trace "value=${value} lastSwitch=${state.states['lastSwitch']}" } def isDigital = state.states["isDigital"] map.type = isDigital == true ? "digital" : "physical" if (lastSwitch != value ) { bWasChange = true logDebug "switch state changed from ${lastSwitch} to ${value}" state.states["debounce"] = true state.states["lastSwitch"] = value runInMillis( DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) } else { state.states["debounce"] = true runInMillis( DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) } map.name = "switch" map.value = value boolean isRefresh = state.states["isRefresh"] ?: false if (isRefresh == true) { map.descriptionText = "${device.displayName} is ${value} [Refresh]" map.isStateChange = true } else { map.descriptionText = "${device.displayName} is ${value} [${map.type}]" } logInfo "${map.descriptionText}" sendEvent(map) clearIsDigital() } @Field static final Map powerOnBehaviourOptions = [ '0': 'switch off', '1': 'switch on', '2': 'switch last state' ] @Field static final Map switchTypeOptions = [ '0': 'toggle', '1': 'state', '2': 'momentary' ] Map myParseDescriptionAsMap( String description ) { def descMap = [:] try { descMap = zigbee.parseDescriptionAsMap(description) } catch (e1) { logWarn "exception ${e1} caught while parseDescriptionAsMap myParseDescriptionAsMap description: ${description}" // try alternative custom parsing descMap = [:] try { descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> def pair = entry.split(':') [(pair.first().trim()): pair.last().trim()] } } catch (e2) { logWarn "exception ${e2} caught while parsing using an alternative method myParseDescriptionAsMap description: ${description}" return [:] } logDebug "alternative method parsing success: descMap=${descMap}" } return descMap } boolean isTuyaE00xCluster( String description ) { if(description == null || !(description.indexOf('cluster: E000') >= 0 || description.indexOf('cluster: E001') >= 0)) { return false } // try to parse ... //logDebug "Tuya cluster: E000 or E001 - try to parse it..." def descMap = [:] try { descMap = zigbee.parseDescriptionAsMap(description) logDebug "TuyaE00xCluster Desc Map: ${descMap}" } catch ( e ) { logDebug "exception caught while parsing description: ${description}" logDebug "TuyaE00xCluster Desc Map: ${descMap}" // cluster E001 is the one that is generating exceptions... return true } if (descMap.cluster == "E000" && descMap.attrId in ["D001", "D002", "D003"]) { logDebug "Tuya Specific cluster ${descMap.cluster} attribute ${descMap.attrId} value is ${descMap.value}" } else if (descMap.cluster == "E001" && descMap.attrId == "D010") { if (settings?.logEnable) { logInfo "power on behavior is ${powerOnBehaviourOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } } else if (descMap.cluster == "E001" && descMap.attrId == "D030") { if (settings?.logEnable) { logInfo "swith type is ${switchTypeOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } } else { logDebug "unprocessed TuyaE00xCluster Desc Map: $descMap" return false } return true // processed } // return true if further processing in the main parse method should be cancelled ! boolean otherTuyaOddities( String description ) { /* if (description.indexOf('cluster: 0000') >= 0 && description.indexOf('attrId: 0004') >= 0) { if (logEnable) log.debug "${device.displayName} skipping Tuya parse of cluster 0 attrId 4" // parseDescriptionAsMap throws exception when processing Tuya cluster 0 attrId 4 return true } */ def descMap = [:] try { descMap = zigbee.parseDescriptionAsMap(description) } catch (e1) { logWarn "exception ${e1} caught while parseDescriptionAsMap otherTuyaOddities description: ${description}" // try alternative custom parsing descMap = [:] try { descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> def pair = entry.split(':') [(pair.first().trim()): pair.last().trim()] } } catch (e2) { logWarn "exception ${e2} caught while parsing using an alternative method otherTuyaOddities description: ${description}" return true } logDebug "alternative method parsing success: descMap=${descMap}" } //if (logEnable) {log.trace "${device.displayName} Checking Tuya Oddities Desc Map: $descMap"} if (descMap.attrId == null ) { //logDebug "otherTuyaOddities: descMap = ${descMap}" //if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${descMap.clusterId} NO ATTRIBUTE, skipping" return false } boolean bWasAtLeastOneAttributeProcessed = false boolean bWasThereAnyStandardAttribite = false // attribute report received List attrData = [[cluster: descMap.cluster ,attrId: descMap.attrId, value: descMap.value, status: descMap.status]] descMap.additionalAttrs.each { attrData << [cluster: descMap.cluster, attrId: it.attrId, value: it.value, status: it.status] //log.trace "Tuya oddity: filling in attrData ${attrData}" } attrData.each { //log.trace "each it=${it}" def map = [:] if (it.status == "86") { logWarn "Tuya Cluster ${descMap.cluster} unsupported attrId ${it.attrId}" // TODO - skip parsing? } switch (it.cluster) { case "0000" : if (it.attrId in ["FFE0", "FFE1", "FFE2", "FFE4"]) { logDebug "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" bWasAtLeastOneAttributeProcessed = true } else if (it.attrId in ["FFFE", "FFDF"]) { logDebug "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" bWasAtLeastOneAttributeProcessed = true } else { //logDebug "otherTuyaOddities? - Cluster ${descMap.cluster} attrId ${it.attrId} value ${it.value}) N/A, skipping" bWasThereAnyStandardAttribite = true } break default : //if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${it.cluster} N/A, skipping" break } // switch } // for each attribute return bWasAtLeastOneAttributeProcessed && !bWasThereAnyStandardAttribite } private boolean isCircuitBreaker() { device.getDataValue("manufacturer") in ["_TZ3000_ky0fq4ho"] } private boolean isRTXCircuitBreaker() { device.getDataValue("manufacturer") in ["_TZE200_abatw3kj"] } def parseOnOffAttributes( it ) { logDebug "OnOff attribute ${it.attrId} cluster ${it.cluster } reported: value=${it.value}" def mode def attrName if (it.value == null) { logDebug "OnOff attribute ${it.attrId} cluster ${it.cluster } skipping NULL value status=${it.status}" return } def value = zigbee.convertHexToInt(it.value) switch (it.attrId) { case "4000" : // non-Tuya GlobalSceneControl (bool), read-only attrName = "Global Scene Control" mode = value == 0 ? "off" : value == 1 ? "on" : null break case "4001" : // non-Tuya OnTime (UINT16), read-only attrName = "On Time" mode = value break case "4002" : // non-Tuya OffWaitTime (UINT16), read-only attrName = "Off Wait Time" mode = value break case "4003" : // non-Tuya "powerOnState" (ENUM8), read-write, default=1 attrName = "Power On State" mode = value == 0 ? "off" : value == 1 ? "on" : value == 2 ? "Last state" : "UNKNOWN" break case "8000" : // command "childLock", [[name:"Child Lock", type: "ENUM", description: "Select Child Lock mode", constraints: ["off", "on"]]] attrName = "Child Lock" mode = value == 0 ? "off" : "on" break case "8001" : // command "ledMode", [[name:"LED mode", type: "ENUM", description: "Select LED mode", constraints: ["Disabled", "Lit when On", "Lit when Off", "Always Green", "Red when On; Green when Off", "Green when On; Red when Off", "Always Red" ]]] attrName = "LED mode" if (isCircuitBreaker()) { mode = value == 0 ? "Always Green" : value == 1 ? "Red when On; Green when Off" : value == 2 ? "Green when On; Red when Off" : value == 3 ? "Always Red" : null } else { mode = value == 0 ? "Disabled" : value == 1 ? "Lit when On" : value == 2 ? "Lit when Off" : value == 3 ? "Freeze": null } break case "8002" : // command "powerOnState", [[name:"Power On State", type: "ENUM", description: "Select Power On State", constraints: ["off","on", "Last state"]]] attrName = "Power On State" mode = value == 0 ? "off" : value == 1 ? "on" : value == 2 ? "Last state" : null break case "8003" : // Over current alarm attrName = "Over current alarm" mode = value == 0 ? "Over Current OK" : value == 1 ? "Over Current Alarm" : null break default : logWarn "Unprocessed Tuya OnOff attribute ${it.attrId} cluster ${it.cluster } reported: value=${it.value}" return } if (settings?.logEnable) { logInfo "${attrName} is ${mode}" } } def sendButtonEvent(buttonNumber, buttonState, isDigital=false) { def event = [name: buttonState, value: buttonNumber.toString(), data: [buttonNumber: buttonNumber], descriptionText: "button $buttonNumber was $buttonState", isStateChange: true, type: isDigital==true ? 'digital' : 'physical'] if (txtEnable) {log.info "${device.displayName} $event.descriptionText"} sendEvent(event) } def push() { // Momentary capability logDebug "push momentary" if (DEVICE_TYPE in ["Fingerbot"]) { pushFingerbot(); return } logWarn "push() not implemented for ${(DEVICE_TYPE)}" } def push(buttonNumber) { //pushableButton capability if (DEVICE_TYPE in ["Fingerbot"]) { pushFingerbot(buttonNumber); return } sendButtonEvent(buttonNumber, "pushed", isDigital=true) } def doubleTap(buttonNumber) { sendButtonEvent(buttonNumber, "doubleTapped", isDigital=true) } def hold(buttonNumber) { sendButtonEvent(buttonNumber, "held", isDigital=true) } def release(buttonNumber) { sendButtonEvent(buttonNumber, "released", isDigital=true) } void sendNumberOfButtonsEvent(numberOfButtons) { sendEvent(name: "numberOfButtons", value: numberOfButtons, isStateChange: true, type: "digital") } void sendSupportedButtonValuesEvent(supportedValues) { sendEvent(name: "supportedButtonValues", value: JsonOutput.toJson(supportedValues), isStateChange: true, type: "digital") } /* * ----------------------------------------------------------------------------- * Level Control Cluster 0x0008 * ----------------------------------------------------------------------------- */ void parseLevelControlCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (DEVICE_TYPE in ["ButtonDimmer"]) { parseLevelControlClusterButtonDimmer(descMap) } else if (descMap.attrId == "0000") { if (descMap.value == null || descMap.value == 'FFFF') { logDebug "parseLevelControlCluster: invalid value: ${descMap.value}"; return } // invalid or unknown value final long rawValue = hexStrToUnsignedInt(descMap.value) sendLevelControlEvent(rawValue) } else { logWarn "unprocessed LevelControl attribute ${descMap.attrId}" } } def sendLevelControlEvent( rawValue ) { def value = rawValue as int if (value <0) value = 0 if (value >100) value = 100 def map = [:] def isDigital = state.states["isDigital"] map.type = isDigital == true ? "digital" : "physical" map.name = "level" map.value = value boolean isRefresh = state.states["isRefresh"] ?: false if (isRefresh == true) { map.descriptionText = "${device.displayName} is ${value} [Refresh]" map.isStateChange = true } else { map.descriptionText = "${device.displayName} was set ${value} [${map.type}]" } logInfo "${map.descriptionText}" sendEvent(map) clearIsDigital() } /** * Get the level transition rate * @param level desired target level (0-100) * @param transitionTime transition time in seconds (optional) * @return transition rate in 1/10ths of a second */ private Integer getLevelTransitionRate(final Integer desiredLevel, final Integer transitionTime = null) { int rate = 0 final Boolean isOn = device.currentValue('switch') == 'on' Integer currentLevel = (device.currentValue('level') as Integer) ?: 0 if (!isOn) { currentLevel = 0 } // Check if 'transitionTime' has a value if (transitionTime > 0) { // Calculate the rate by converting 'transitionTime' to BigDecimal, multiplying by 10, and converting to Integer rate = transitionTime * 10 } else { // Check if the 'levelUpTransition' setting has a value and the current level is less than the desired level if (((settings.levelUpTransition ?: 0) as Integer) > 0 && currentLevel < desiredLevel) { // Set the rate to the value of the 'levelUpTransition' setting converted to Integer rate = settings.levelUpTransition.toInteger() } // Check if the 'levelDownTransition' setting has a value and the current level is greater than the desired level else if (((settings.levelDownTransition ?: 0) as Integer) > 0 && currentLevel > desiredLevel) { // Set the rate to the value of the 'levelDownTransition' setting converted to Integer rate = settings.levelDownTransition.toInteger() } } logDebug "using level transition rate ${rate}" return rate } // Command option that enable changes when off @Field static final String PRE_STAGING_OPTION = '01 01' /** * Constrain a value to a range * @param value value to constrain * @param min minimum value (default 0) * @param max maximum value (default 100) * @param nullValue value to return if value is null (default 0) */ private static BigDecimal constrain(final BigDecimal value, final BigDecimal min = 0, final BigDecimal max = 100, final BigDecimal nullValue = 0) { if (min == null || max == null) { return value } return value != null ? max.min(value.max(min)) : nullValue } /** * Constrain a value to a range * @param value value to constrain * @param min minimum value (default 0) * @param max maximum value (default 100) * @param nullValue value to return if value is null (default 0) */ private static Integer constrain(final Object value, final Integer min = 0, final Integer max = 100, final Integer nullValue = 0) { if (min == null || max == null) { return value as Integer } return value != null ? Math.min(Math.max(value as Integer, min) as Integer, max) : nullValue } // Delay before reading attribute (when using polling) @Field static final int POLL_DELAY_MS = 1000 /** * If the device is polling, delay the execution of the provided commands * @param delayMs delay in milliseconds * @param commands commands to execute * @return list of commands to be sent to the device */ private List ifPolling(final int delayMs = 0, final Closure commands) { if (state.reportingEnabled == false) { final int value = Math.max(delayMs, POLL_DELAY_MS) return ["delay ${value}"] + (commands() as List) as List } return [] } def intTo16bitUnsignedHex(value) { def hexStr = zigbee.convertToHexString(value.toInteger(),4) return new String(hexStr.substring(2, 4) + hexStr.substring(0, 2)) } def intTo8bitUnsignedHex(value) { return zigbee.convertToHexString(value.toInteger(), 2) } /** * Send 'switchLevel' attribute event * @param isOn true if light is on, false otherwise * @param level brightness level (0-254) */ private List setLevelPrivate(final Object value, final Integer rate = 0, final Integer delay = 0, final Boolean levelPreset = false) { List cmds = [] final Integer level = constrain(value) final String hexLevel = DataType.pack(Math.round(level * 2.54).intValue(), DataType.UINT8) final String hexRate = DataType.pack(rate, DataType.UINT16, true) final int levelCommand = levelPreset ? 0x00 : 0x04 if (device.currentValue('switch') == 'off' && level > 0 && levelPreset == false) { // If light is off, first go to level 0 then to desired level cmds += zigbee.command(zigbee.LEVEL_CONTROL_CLUSTER, 0x00, [destEndpoint:safeToInt(getDestinationEP())], delay, "00 0000 ${PRE_STAGING_OPTION}") } // Payload: Level | Transition Time | Options Mask | Options Override // Options: Bit 0x01 enables pre-staging level /* cmds += zigbee.command(zigbee.LEVEL_CONTROL_CLUSTER, levelCommand, [destEndpoint:safeToInt(getDestinationEP())], delay, "${hexLevel} ${hexRate} ${PRE_STAGING_OPTION}") + ifPolling(DELAY_MS + (rate * 100)) { zigbee.levelRefresh(0) } */ int duration = 10 // TODO !!! String endpointId = "01" // TODO !!! cmds += ["he cmd 0x${device.deviceNetworkId} 0x${endpointId} 0x0008 4 { 0x${intTo8bitUnsignedHex(level)} 0x${intTo16bitUnsignedHex(duration)} }",] return cmds } /** * Set Level Command * @param value level percent (0-100) * @param transitionTime transition time in seconds * @return List of zigbee commands */ void /*List*/ setLevel(final Object value, final Object transitionTime = null) { logInfo "setLevel (${value}, ${transitionTime})" final Integer rate = getLevelTransitionRate(value as Integer, transitionTime as Integer) scheduleCommandTimeoutCheck() /*return*/ sendZigbeeCommands ( setLevelPrivate(value, rate)) } /* * ----------------------------------------------------------------------------- * Illuminance cluster 0x0400 * ----------------------------------------------------------------------------- */ void parseIlluminanceCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value final long value = hexStrToUnsignedInt(descMap.value) def lux = value > 0 ? Math.round(Math.pow(10,(value/10000))) : 0 handleIlluminanceEvent(lux) } void handleIlluminanceEvent( illuminance, Boolean isDigital=false ) { def eventMap = [:] if (state.stats != null) state.stats['illumCtr'] = (state.stats['illumCtr'] ?: 0) + 1 else state.stats=[:] eventMap.name = "illuminance" Integer illumCorrected = Math.round((illuminance * ((settings?.illuminanceCoeff ?: 1.00) as float))) eventMap.value = illumCorrected eventMap.type = isDigital ? "digital" : "physical" eventMap.unit = "lx" eventMap.descriptionText = "${eventMap.name} is ${eventMap.value} ${eventMap.unit}" Integer timeElapsed = Math.round((now() - (state.lastRx['illumTime'] ?: now()))/1000) Integer minTime = settings?.minReportingTime ?: DEFAULT_MIN_REPORTING_TIME Integer timeRamaining = (minTime - timeElapsed) as Integer Integer lastIllum = device.currentValue("illuminance") ?: 0 Integer delta = Math.abs(lastIllum- illumCorrected) if (delta < ((settings?.illuminanceThreshold ?: DEFAULT_ILLUMINANCE_THRESHOLD) as int)) { logDebug "skipped illuminance ${illumCorrected}, less than delta ${settings?.illuminanceThreshold} (lastIllum=${lastIllum})" return } if (timeElapsed >= minTime) { logInfo "${eventMap.descriptionText}" unschedule("sendDelayedIllumEvent") //get rid of stale queued reports state.lastRx['illumTime'] = now() sendEvent(eventMap) } else { // queue the event eventMap.type = "delayed" logDebug "${device.displayName} delaying ${timeRamaining} seconds event : ${eventMap}" runIn(timeRamaining, 'sendDelayedIllumEvent', [overwrite: true, data: eventMap]) } } private void sendDelayedIllumEvent(Map eventMap) { logInfo "${eventMap.descriptionText} (${eventMap.type})" state.lastRx['illumTime'] = now() // TODO - -(minReportingTimeHumidity * 2000) sendEvent(eventMap) } @Field static final Map tuyaIlluminanceOpts = [0: 'low', 1: 'medium', 2: 'high'] /* * ----------------------------------------------------------------------------- * temperature * ----------------------------------------------------------------------------- */ void parseTemperatureCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value final long value = hexStrToUnsignedInt(descMap.value) handleTemperatureEvent(value/100.0F as Float) } void handleTemperatureEvent( Float temperature, Boolean isDigital=false ) { def eventMap = [:] if (state.stats != null) state.stats['tempCtr'] = (state.stats['tempCtr'] ?: 0) + 1 else state.stats=[:] eventMap.name = "temperature" def Scale = location.temperatureScale if (Scale == "F") { temperature = (temperature * 1.8) + 32 eventMap.unit = "\u00B0"+"F" } else { eventMap.unit = "\u00B0"+"C" } def tempCorrected = (temperature + safeToDouble(settings?.temperatureOffset ?: 0)) as Float eventMap.value = (Math.round(tempCorrected * 10) / 10.0) as Float eventMap.type = isDigital == true ? "digital" : "physical" //eventMap.isStateChange = true eventMap.descriptionText = "${eventMap.name} is ${eventMap.value} ${eventMap.unit}" Integer timeElapsed = Math.round((now() - (state.lastRx['tempTime'] ?: now()))/1000) Integer minTime = settings?.minReportingTime ?: DEFAULT_MIN_REPORTING_TIME Integer timeRamaining = (minTime - timeElapsed) as Integer if (timeElapsed >= minTime) { logInfo "${eventMap.descriptionText}" unschedule("sendDelayedTempEvent") //get rid of stale queued reports state.lastRx['tempTime'] = now() sendEvent(eventMap) } else { // queue the event eventMap.type = "delayed" logDebug "${device.displayName} DELAYING ${timeRamaining} seconds event : ${eventMap}" runIn(timeRamaining, 'sendDelayedTempEvent', [overwrite: true, data: eventMap]) } } private void sendDelayedTempEvent(Map eventMap) { logInfo "${eventMap.descriptionText} (${eventMap.type})" state.lastRx['tempTime'] = now() // TODO - -(minReportingTimeHumidity * 2000) sendEvent(eventMap) } /* * ----------------------------------------------------------------------------- * humidity * ----------------------------------------------------------------------------- */ void parseHumidityCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value final long value = hexStrToUnsignedInt(descMap.value) handleHumidityEvent(value/100.0F as Float) } void handleHumidityEvent( Float humidity, Boolean isDigital=false ) { def eventMap = [:] if (state.stats != null) state.stats['humiCtr'] = (state.stats['humiCtr'] ?: 0) + 1 else state.stats=[:] double humidityAsDouble = safeToDouble(humidity) + safeToDouble(settings?.humidityOffset ?: 0) if (humidityAsDouble <= 0.0 || humidityAsDouble > 100.0) { logWarn "ignored invalid humidity ${humidity} (${humidityAsDouble})" return } eventMap.value = Math.round(humidityAsDouble) eventMap.name = "humidity" eventMap.unit = "% RH" eventMap.type = isDigital == true ? "digital" : "physical" //eventMap.isStateChange = true eventMap.descriptionText = "${eventMap.name} is ${humidityAsDouble.round(1)} ${eventMap.unit}" Integer timeElapsed = Math.round((now() - (state.lastRx['humiTime'] ?: now()))/1000) Integer minTime = settings?.minReportingTime ?: DEFAULT_MIN_REPORTING_TIME Integer timeRamaining = (minTime - timeElapsed) as Integer if (timeElapsed >= minTime) { logInfo "${eventMap.descriptionText}" unschedule("sendDelayedHumidityEvent") state.lastRx['humiTime'] = now() sendEvent(eventMap) } else { eventMap.type = "delayed" logDebug "DELAYING ${timeRamaining} seconds event : ${eventMap}" runIn(timeRamaining, 'sendDelayedHumidityEvent', [overwrite: true, data: eventMap]) } } private void sendDelayedHumidityEvent(Map eventMap) { logInfo "${eventMap.descriptionText} (${eventMap.type})" state.lastRx['humiTime'] = now() // TODO - -(minReportingTimeHumidity * 2000) sendEvent(eventMap) } /* * ----------------------------------------------------------------------------- * Electrical Measurement Cluster 0x0702 * ----------------------------------------------------------------------------- */ void parseElectricalMeasureCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value def value = hexStrToUnsignedInt(descMap.value) if (DEVICE_TYPE in ["Switch"]) { parseElectricalMeasureClusterSwitch(descMap) } else { logWarn "parseElectricalMeasureCluster is NOT implemented1" } } /* * ----------------------------------------------------------------------------- * Metering Cluster 0x0B04 * ----------------------------------------------------------------------------- */ void parseMeteringCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value def value = hexStrToUnsignedInt(descMap.value) if (DEVICE_TYPE in ["Switch"]) { parseMeteringClusterSwitch(descMap) } else { logWarn "parseMeteringCluster is NOT implemented1" } } /* * ----------------------------------------------------------------------------- * pm2.5 - cluster 0x042A * ----------------------------------------------------------------------------- */ void parsePm25Cluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value if (DEVICE_TYPE in ["AirQuality"]) { def value = hexStrToUnsignedInt(descMap.value) Float floatValue = Float.intBitsToFloat(value.intValue()) //logDebug "pm25 float value = ${floatValue}" handlePm25Event(floatValue as Integer) // in airQualityLib } else { logWarn "parsePm25Cluster: not handled!" } } /* * ----------------------------------------------------------------------------- * Analog Input Cluster 0x000C * ----------------------------------------------------------------------------- */ void parseAnalogInputCluster(final Map descMap) { if (DEVICE_TYPE in ["AirQuality"]) { parseAirQualityIndexCluster(descMap) } else if (DEVICE_TYPE in ["AqaraCube"]) { parseAqaraCubeAnalogInputCluster(descMap) } else { logWarn "parseAnalogInputCluster: don't know how to handle descMap=${descMap}" } } /* * ----------------------------------------------------------------------------- * Multistate Input Cluster 0x0012 * ----------------------------------------------------------------------------- */ void parseMultistateInputCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value def value = hexStrToUnsignedInt(descMap.value) Float floatValue = Float.intBitsToFloat(value.intValue()) if (DEVICE_TYPE in ["AqaraCube"]) { parseMultistateInputClusterAqaraCube(descMap) } else { handleMultistateInputEvent(value as Integer) } } void handleMultistateInputEvent( Integer value, Boolean isDigital=false ) { def eventMap = [:] eventMap.value = value eventMap.name = "multistateInput" eventMap.unit = "" eventMap.type = isDigital == true ? "digital" : "physical" eventMap.descriptionText = "${eventMap.name} is ${eventMap.value} ${eventMap.unit}" sendEvent(eventMap) logInfo "${eventMap.descriptionText}" } /* * ----------------------------------------------------------------------------- * thermostat cluster 0x0201 * ----------------------------------------------------------------------------- */ void parseThermostatCluster(final Map descMap) { final Integer value = safeToInt(hexStrToUnsignedInt(descMap.value)) if (settings.logEnable) { log.trace "zigbee received Thermostat cluster (0x0201) attribute 0x${descMap.attrId} value ${value} (raw ${descMap.value})" } switch (descMap.attrInt as Integer) { case 0x000: // temperature logInfo "temperature = ${value/100.0} (raw ${value})" handleTemperatureEvent(value/100.0) break case 0x0011: // cooling setpoint logInfo "cooling setpoint = ${value/100.0} (raw ${value})" break case 0x0012: // heating setpoint logInfo "heating setpoint = ${value/100.0} (raw ${value})" handleHeatingSetpointEvent(value/100.0) break case 0x001c: // mode logInfo "mode = ${value} (raw ${value})" break case 0x001e: // thermostatRunMode logInfo "thermostatRunMode = ${value} (raw ${value})" break case 0x0020: // battery logInfo "battery = ${value} (raw ${value})" break case 0x0023: // thermostatHoldMode logInfo "thermostatHoldMode = ${value} (raw ${value})" break case 0x0029: // thermostatOperatingState logInfo "thermostatOperatingState = ${value} (raw ${value})" break case 0xfff2: // unknown logDebug "Aqara E1 TRV unknown attribute ${descMap.attrInt} value raw = ${value}" break; default: log.warn "zigbee received unknown Thermostat cluster (0x0201) attribute 0x${descMap.attrId} (value ${descMap.value})" break } } def handleHeatingSetpointEvent( temperature ) { setHeatingSetpoint(temperature) } // ThermostatHeatingSetpoint command // sends TuyaCommand and checks after 4 seconds // 1°C steps. (0.5°C setting on the TRV itself, rounded for zigbee interface) def setHeatingSetpoint( temperature ) { def previousSetpoint = device.currentState('heatingSetpoint')?.value ?: 0 double tempDouble logDebug "setHeatingSetpoint temperature = ${temperature} as int = ${temperature as int} (previousSetpointt = ${previousSetpoint})" if (true) { logDebug "0.5 C correction of the heating setpoint${temperature}" tempDouble = safeToDouble(temperature) tempDouble = Math.round(tempDouble * 2) / 2.0 } else { if (temperature != (temperature as int)) { if ((temperature as double) > (previousSetpoint as double)) { temperature = (temperature + 0.5 ) as int } else { temperature = temperature as int } logDebug "corrected heating setpoint ${temperature}" } tempDouble = temperature } def maxTemp = settings?.maxThermostatTemp ?: 50 def minTemp = settings?.minThermostatTemp ?: 5 if (tempDouble > maxTemp ) tempDouble = maxTemp if (tempDouble < minTemp) tempDouble = minTemp tempDouble = tempDouble.round(1) Map eventMap = [name: "heatingSetpoint", value: tempDouble, unit: "\u00B0"+"C"] eventMap.descriptionText = "heatingSetpoint is ${tempDouble}" sendHeatingSetpointEvent(eventMap) eventMap = [name: "thermostatSetpoint", value: tempDouble, unit: "\u00B0"+"C"] eventMap.descriptionText = null sendHeatingSetpointEvent(eventMap) updateDataValue("lastRunningMode", "heat") // zigbee.writeAttribute(0x0201, 0x12, 0x29, (tempDouble * 100) as int) } private void sendHeatingSetpointEvent(Map eventMap) { if (eventMap.descriptionText != null) { logInfo "${eventMap.descriptionText}" } sendEvent(eventMap) } // ------------------------------------------------------------------------------------------------------------------------- def parseE002Cluster( descMap ) { if (DEVICE_TYPE in ["Radar"]) { parseE002ClusterRadar(descMap) } else { logWarn "Unprocessed cluster 0xE002 command ${descMap.command} attrId ${descMap.attrId} value ${value} (0x${descMap.value})" } } /* * ----------------------------------------------------------------------------- * Tuya cluster EF00 specific code * ----------------------------------------------------------------------------- */ private static getCLUSTER_TUYA() { 0xEF00 } private static getSETDATA() { 0x00 } private static getSETTIME() { 0x24 } // Tuya Commands private static getTUYA_REQUEST() { 0x00 } private static getTUYA_REPORTING() { 0x01 } private static getTUYA_QUERY() { 0x02 } private static getTUYA_STATUS_SEARCH() { 0x06 } private static getTUYA_TIME_SYNCHRONISATION() { 0x24 } // tuya DP type private static getDP_TYPE_RAW() { "01" } // [ bytes ] private static getDP_TYPE_BOOL() { "01" } // [ 0/1 ] private static getDP_TYPE_VALUE() { "02" } // [ 4 byte value ] private static getDP_TYPE_STRING() { "03" } // [ N byte string ] private static getDP_TYPE_ENUM() { "04" } // [ 0-255 ] private static getDP_TYPE_BITMAP() { "05" } // [ 1,2,4 bytes ] as bits void parseTuyaCluster(final Map descMap) { if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == "24") { //getSETTIME logDebug "Tuya time synchronization request from device, descMap = ${descMap}" def offset = 0 try { offset = location.getTimeZone().getOffset(new Date().getTime()) //if (settings?.logEnable) log.debug "${device.displayName} timezone offset of current location is ${offset}" } catch(e) { logWarn "cannot resolve current location. please set location in Hubitat location setting. Setting timezone offset to zero" } def cmds = zigbee.command(CLUSTER_TUYA, SETTIME, "0008" +zigbee.convertToHexString((int)(now()/1000),8) + zigbee.convertToHexString((int)((now()+offset)/1000), 8)) logDebug "sending time data : ${cmds}" cmds.each{ sendHubCommand(new hubitat.device.HubAction(it, hubitat.device.Protocol.ZIGBEE)) } //if (state.txCounter != null) state.txCounter = state.txCounter + 1 } else if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == "0B") { // ZCL Command Default Response String clusterCmd = descMap?.data[0] def status = descMap?.data[1] logDebug "device has received Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data}" if (status != "00") { logWarn "ATTENTION! manufacturer = ${device.getDataValue("manufacturer")} unsupported Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data} !!!" } } else if ((descMap?.clusterInt == CLUSTER_TUYA) && (descMap?.command == "01" || descMap?.command == "02" || descMap?.command == "05" || descMap?.command == "06")) { def dataLen = descMap?.data.size() //log.warn "dataLen=${dataLen}" def transid = zigbee.convertHexToInt(descMap?.data[1]) // "transid" is just a "counter", a response will have the same transid as the command if (dataLen <= 5) { logWarn "unprocessed short Tuya command response: dp_id=${descMap?.data[3]} dp=${descMap?.data[2]} fncmd_len=${fncmd_len} data=${descMap?.data})" return } for (int i = 0; i < (dataLen-4); ) { def dp = zigbee.convertHexToInt(descMap?.data[2+i]) // "dp" field describes the action/message of a command frame def dp_id = zigbee.convertHexToInt(descMap?.data[3+i]) // "dp_identifier" is device dependant def fncmd_len = zigbee.convertHexToInt(descMap?.data[5+i]) def fncmd = getTuyaAttributeValue(descMap?.data, i) // logDebug "dp_id=${dp_id} dp=${dp} fncmd=${fncmd} fncmd_len=${fncmd_len} (index=${i})" processTuyaDP( descMap, dp, dp_id, fncmd) i = i + fncmd_len + 4; } } else { logWarn "unprocessed Tuya command ${descMap?.command}" } } void processTuyaDP(descMap, dp, dp_id, fncmd) { if (DEVICE_TYPE in ["Radar"]) { processTuyaDpRadar(descMap, dp, dp_id, fncmd); return } if (DEVICE_TYPE in ["Fingerbot"]) { processTuyaDpFingerbot(descMap, dp, dp_id, fncmd); return } if (DEVICE_TYPE in ["Alarm"]) { processTuyaDpAlarm(descMap, dp, dp_id, fncmd); return } switch (dp) { case 0x01 : // on/off if (DEVICE_TYPE in ["LightSensor"]) { logDebug "LightSensor BrightnessLevel = ${tuyaIlluminanceOpts[fncmd as int]} (${fncmd})" } else { sendSwitchEvent(fncmd) } break case 0x02 : if (DEVICE_TYPE in ["LightSensor"]) { handleIlluminanceEvent(fncmd) } else { logDebug "Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" } break case 0x04 : // battery sendBatteryPercentageEvent(fncmd) break default : logWarn "NOT PROCESSED Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" break } } private int getTuyaAttributeValue(ArrayList _data, index) { int retValue = 0 if (_data.size() >= 6) { int dataLength = _data[5+index] as Integer int power = 1; for (i in dataLength..1) { retValue = retValue + power * zigbee.convertHexToInt(_data[index+i+5]) power = power * 256 } } return retValue } private sendTuyaCommand(dp, dp_type, fncmd) { ArrayList cmds = [] def ep = safeToInt(state.destinationEP) if (ep==null || ep==0) ep = 1 def tuyaCmd = isFingerbot() ? 0x04 : SETDATA cmds += zigbee.command(CLUSTER_TUYA, tuyaCmd, [destEndpoint :ep], PACKET_ID + dp + dp_type + zigbee.convertToHexString((int)(fncmd.length()/2), 4) + fncmd ) logDebug "${device.displayName} sendTuyaCommand = ${cmds}" return cmds } private getPACKET_ID() { return zigbee.convertToHexString(new Random().nextInt(65536), 4) } def tuyaTest( dpCommand, dpValue, dpTypeString ) { ArrayList cmds = [] def dpType = dpTypeString=="DP_TYPE_VALUE" ? DP_TYPE_VALUE : dpTypeString=="DP_TYPE_BOOL" ? DP_TYPE_BOOL : dpTypeString=="DP_TYPE_ENUM" ? DP_TYPE_ENUM : null def dpValHex = dpTypeString=="DP_TYPE_VALUE" ? zigbee.convertToHexString(dpValue as int, 8) : dpValue if (settings?.logEnable) log.warn "${device.displayName} sending TEST command=${dpCommand} value=${dpValue} ($dpValHex) type=${dpType}" sendZigbeeCommands( sendTuyaCommand(dpCommand, dpType, dpValHex) ) } private getANALOG_INPUT_BASIC_CLUSTER() { 0x000C } private getANALOG_INPUT_BASIC_PRESENT_VALUE_ATTRIBUTE() { 0x0055 } def tuyaBlackMagic() { def ep = safeToInt(state.destinationEP ?: 01) if (ep==null || ep==0) ep = 1 return zigbee.readAttribute(0x0000, [0x0004, 0x000, 0x0001, 0x0005, 0x0007, 0xfffe], [destEndpoint :ep], delay=200) } void aqaraBlackMagic() { List cmds = [] if (isAqaraTVOC() || isAqaraTRV()) { cmds += ["he raw 0x${device.deviceNetworkId} 0 0 0x8002 {40 00 00 00 00 40 8f 5f 11 52 52 00 41 2c 52 00 00} {0x0000}", "delay 200",] cmds += "zdo bind 0x${device.deviceNetworkId} 0x01 0x01 0xFCC0 {${device.zigbeeId}} {}" cmds += "zdo bind 0x${device.deviceNetworkId} 0x01 0x01 0x0406 {${device.zigbeeId}} {}" cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay=200) // TODO: check - battery voltage if (isAqaraTVOC()) { cmds += zigbee.readAttribute(0xFCC0, [0x0102, 0x010C], [mfgCode: 0x115F], delay=200) // TVOC only } sendZigbeeCommands( cmds ) logDebug "sent aqaraBlackMagic()" } else { logDebug "aqaraBlackMagic() was SKIPPED" } } /** * initializes the device * Invoked from configure() * @return zigbee commands */ def initializeDevice() { ArrayList cmds = [] logInfo 'initializeDevice...' // start with the device-specific initialization first. if (DEVICE_TYPE in ["AirQuality"]) { return initializeDeviceAirQuality() } else if (DEVICE_TYPE in ["IRBlaster"]) { return initializeDeviceIrBlaster() } else if (DEVICE_TYPE in ["Radar"]) { return initializeDeviceRadar() } else if (DEVICE_TYPE in ["ButtonDimmer"]) { return initializeDeviceButtonDimmer() } else if (DEVICE_TYPE in ["Alarm"]) { return initializeDeviceAlarm() } // not specific device type - do some generic initializations if (DEVICE_TYPE in ["THSensor"]) { cmds += zigbee.configureReporting(zigbee.TEMPERATURE_MEASUREMENT_CLUSTER, 0 /*TEMPERATURE_MEASUREMENT_MEASURED_VALUE_ATTRIBUTE*/, DataType.INT16, 15, 300, 100 /* 100=0.1도*/) // 402 - temperature cmds += zigbee.configureReporting(zigbee.RELATIVE_HUMIDITY_MEASUREMENT_CLUSTER, 0 /*RALATIVE_HUMIDITY_MEASUREMENT_MEASURED_VALUE_ATTRIBUTE*/, DataType.UINT16, 15, 300, 400/*10/100=0.4%*/) // 405 - humidity } // if (cmds == []) { cmds = ["delay 299"] } return cmds } /** * configures the device * Invoked from updated() * @return zigbee commands */ def configureDevice() { ArrayList cmds = [] logInfo 'configureDevice...' if (DEVICE_TYPE in ["AirQuality"]) { cmds += configureDeviceAirQuality() } else if (DEVICE_TYPE in ["Fingerbot"]) { cmds += configureDeviceFingerbot() } else if (DEVICE_TYPE in ["AqaraCube"]) { cmds += configureDeviceAqaraCube() } else if (DEVICE_TYPE in ["Switch"]) { cmds += configureDeviceSwitch() } else if (DEVICE_TYPE in ["IRBlaster"]) { cmds += configureDeviceIrBlaster() } else if (DEVICE_TYPE in ["Radar"]) { cmds += configureDeviceRadar() } else if (DEVICE_TYPE in ["ButtonDimmer"]) { cmds += configureDeviceButtonDimmer() } if (cmds == []) { cmds = ["delay 277",] } sendZigbeeCommands(cmds) } /* * ----------------------------------------------------------------------------- * Hubitat default handlers methods * ----------------------------------------------------------------------------- */ def refresh() { logInfo "refresh()... DEVICE_TYPE is ${DEVICE_TYPE}" checkDriverVersion() List cmds = [] if (state.states == null) state.states = [:] state.states["isRefresh"] = true // device type specific refresh handlers if (DEVICE_TYPE in ["AqaraCube"]) { cmds += refreshAqaraCube() } else if (DEVICE_TYPE in ["Fingerbot"]) { cmds += refreshFingerbot() } else if (DEVICE_TYPE in ["AirQuality"]) { cmds += refreshAirQuality() } else if (DEVICE_TYPE in ["Switch"]) { cmds += refreshSwitch() } else if (DEVICE_TYPE in ["IRBlaster"]) { cmds += refreshIrBlaster() } else if (DEVICE_TYPE in ["Radar"]) { cmds += refreshRadar() } else { // generic refresh handling, based on teh device capabilities if (device.hasCapability("Battery")) { cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay=200) // battery voltage cmds += zigbee.readAttribute(0x0001, 0x0021, [:], delay=200) // battery percentage } if (DEVICE_TYPE in ["Plug", "Dimmer"]) { cmds += zigbee.readAttribute(0x0006, 0x0000, [:], delay=200) cmds += zigbee.command(zigbee.GROUPS_CLUSTER, 0x02, [:], DELAY_MS, '00') // Get group membership } if (DEVICE_TYPE in ["Dimmer"]) { cmds += zigbee.readAttribute(0x0008, 0x0000, [:], delay=200) } if (DEVICE_TYPE in ["THSensor", "AirQuality"]) { cmds += zigbee.readAttribute(0x0402, 0x0000, [:], delay=200) cmds += zigbee.readAttribute(0x0405, 0x0000, [:], delay=200) } if (DEVICE_TYPE in ["Thermostat"]) { // TODO - Aqara E1 specific refresh commands only 1 //cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay=200) // battery voltage (E1 does not send percentage) //cmds += zigbee.readAttribute(0x0201, 0x0000, [:], delay=100) // local temperature //cmds += zigbee.readAttribute(0x0201, 0x0011, [:], delay=100) // cooling setpoint //cmds += zigbee.readAttribute(0x0201, 0x0012, [:], delay=100) // heating setpoint cmds += zigbee.readAttribute(0x0201, [0x0000, 0x0011, 0x0012, 0x001C], [:], delay=100) // local temperature, cooling setpoint, heating setpoint, system mode (enum8 ) //cmds += zigbee.readAttribute(0x0201, 0x0015, [:], delay=100) // min heat setpoint limit - Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0016, [:], delay=100) // max heat setpoint limit = Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0017, [:], delay=100) // min cool setpoint limit - Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0018, [:], delay=100) // max cool setpoint limit - Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0019, [:], delay=100) // min setpoint dead band ?- Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x001C, [:], delay=100) // system mode (enum8 ) //cmds += zigbee.readAttribute(0x0201, 0x001E, [:], delay=100) // Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0020, [:], delay=100) // Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0023, [:], delay=100) // hold temperature (enum) on/off - Unsupported Attribute //cmds += zigbee.readAttribute(0x0201, 0x0029, [:], delay=100) // thermostat running mode - Unsupported Attribute cmds += zigbee.readAttribute(0x0202, 0x0000, [:], delay=100) } } runInMillis( REFRESH_TIMER, clearRefreshRequest, [overwrite: true]) // 3 seconds if (cmds != null && cmds != [] ) { sendZigbeeCommands(cmds) } else { logDebug "no refresh() commands defined for device type ${DEVICE_TYPE}" } } def clearRefreshRequest() { if (state.states == null) {state.states = [:] }; state.states["isRefresh"] = false } void clearInfoEvent() { sendInfoEvent('clear') } void sendInfoEvent(String info=null) { if (info == null || info == "clear") { logDebug "clearing the Info event" sendEvent(name: "Info", value: " ", descriptionText: "Info event", type: "digital") } else { logInfo "${info}" sendEvent(name: "Info", value: info, descriptionText: "Info event", type: "digital") runIn(INFO_AUTO_CLEAR_PERIOD, "clearInfoEvent") // automatically clear the Info attribute after 1 minute } } def ping() { if (!(isAqaraTVOC())) { if (state.lastTx == nill ) state.lastTx = [:] state.lastTx["pingTime"] = new Date().getTime() if (state.states == nill ) state.states = [:] state.states["isPing"] = true scheduleCommandTimeoutCheck() sendZigbeeCommands( zigbee.readAttribute(zigbee.BASIC_CLUSTER, 0x01, [:], 0) ) logDebug 'ping...' } else { // Aqara TVOC is sleepy or does not respond to the ping. logInfo "ping() command is not available for this sleepy device." sendRttEvent("n/a") } } /** * sends 'rtt'event (after a ping() command) * @param null: calculate the RTT in ms * value: send the text instead ('timeout', 'n/a', etc..) * @return none */ void sendRttEvent( String value=null) { def now = new Date().getTime() if (state.lastTx == null ) state.lastTx = [:] def timeRunning = now.toInteger() - (state.lastTx["pingTime"] ?: now).toInteger() def descriptionText = "Round-trip time is ${timeRunning} ms (min=${state.stats["pingsMin"]} max=${state.stats["pingsMax"]} average=${state.stats["pingsAvg"]})" if (value == null) { logInfo "${descriptionText}" sendEvent(name: "rtt", value: timeRunning, descriptionText: descriptionText, unit: "ms", type: "digital") } else { descriptionText = "Round-trip time : ${value}" logInfo "${descriptionText}" sendEvent(name: "rtt", value: value, descriptionText: descriptionText, type: "digital") } } /** * Lookup the cluster name from the cluster ID * @param cluster cluster ID * @return cluster name if known, otherwise "private cluster" */ private String clusterLookup(final Object cluster) { if (cluster != null) { return zigbee.clusterLookup(cluster.toInteger()) ?: "private cluster 0x${intToHexStr(cluster.toInteger())}" } else { logWarn "cluster is NULL!" return "NULL" } } private void scheduleCommandTimeoutCheck(int delay = COMMAND_TIMEOUT) { runIn(delay, 'deviceCommandTimeout') } void deviceCommandTimeout() { logWarn 'no response received (sleepy device or offline?)' sendRttEvent("timeout") state.stats['pingsFail'] = (state.stats['pingsFail'] ?: 0) + 1 } /** * Schedule a device health check * @param intervalMins interval in minutes */ private void scheduleDeviceHealthCheck(final int intervalMins, final int healthMethod) { if (healthMethod == 1 || healthMethod == 2) { String cron = getCron( intervalMins*60 ) schedule(cron, 'deviceHealthCheck') logDebug "deviceHealthCheck is scheduled every ${intervalMins} minutes" } else { logWarn "deviceHealthCheck is not scheduled!" unschedule('deviceHealthCheck') } } private void unScheduleDeviceHealthCheck() { unschedule('deviceHealthCheck') device.deleteCurrentState('healthStatus') logWarn "device health check is disabled!" } // called when any event was received from the Zigbee device in the parse() method. void setHealthStatusOnline() { if(state.health == null) { state.health = [:] } state.health['checkCtr3'] = 0 if (!((device.currentValue('healthStatus') ?: 'unknown') in ['online'])) { sendHealthStatusEvent('online') logInfo "is now online!" } } def deviceHealthCheck() { if (state.health == null) { state.health = [:] } def ctr = state.health['checkCtr3'] ?: 0 if (ctr >= PRESENCE_COUNT_THRESHOLD) { if ((device.currentValue("healthStatus") ?: 'unknown') != 'offline' ) { logWarn "not present!" sendHealthStatusEvent('offline') } } else { logDebug "deviceHealthCheck - online (notPresentCounter=${ctr})" } state.health['checkCtr3'] = ctr + 1 } void sendHealthStatusEvent(value) { def descriptionText = "healthStatus changed to ${value}" sendEvent(name: "healthStatus", value: value, descriptionText: descriptionText, isStateChange: true, type: "digital") if (value == 'online') { logInfo "${descriptionText}" } else { if (settings?.txtEnable) { log.warn "${device.displayName}} ${descriptionText}" } } } /** * Scheduled job for polling device specific attribute(s) */ void autoPoll() { logDebug "autoPoll()..." checkDriverVersion() List cmds = [] if (state.states == null) state.states = [:] //state.states["isRefresh"] = true if (DEVICE_TYPE in ["AirQuality"]) { cmds += zigbee.readAttribute(0xfc7e, 0x0000, [mfgCode: 0x117c], delay=200) // tVOC !! mfcode="0x117c" !! attributes: (float) 0: Measured Value; 1: Min Measured Value; 2:Max Measured Value; } if (cmds != null && cmds != [] ) { sendZigbeeCommands(cmds) } } /** * Invoked by Hubitat when the driver configuration is updated */ void updated() { logInfo 'updated...' logInfo "driver version ${driverVersionAndTimeStamp()}" unschedule() if (settings.logEnable) { logDebug settings runIn(86400, logsOff) } final int healthMethod = (settings.healthCheckMethod as Integer) ?: 0 if (healthMethod == 1 || healthMethod == 2) { // [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] // schedule the periodic timer final int interval = (settings.healthCheckInterval as Integer) ?: 0 if (interval > 0) { //log.trace "healthMethod=${healthMethod} interval=${interval}" log.info "scheduling health check every ${interval} minutes by ${HealthcheckMethodOpts.options[healthCheckMethod as int]} method" scheduleDeviceHealthCheck(interval, healthMethod) } } else { unScheduleDeviceHealthCheck() // unschedule the periodic job, depending on the healthMethod log.info "Health Check is disabled!" } if (DEVICE_TYPE in ["AirQuality"]) { updatedAirQuality() } if (DEVICE_TYPE in ["IRBlaster"]) { updatedIrBlaster() } configureDevice() // sends Zigbee commands sendInfoEvent("updated") } /** * Disable logging (for debugging) */ void logsOff() { logInfo "debug logging disabled..." device.updateSetting('logEnable', [value: 'false', type: 'bool']) } @Field static final Map ConfigureOpts = [ "Configure the device only" : [key:2, function: 'configure'], "Reset Statistics" : [key:9, function: 'resetStatistics'], " -- " : [key:3, function: 'configureHelp'], "Delete All Preferences" : [key:4, function: 'deleteAllSettings'], "Delete All Current States" : [key:5, function: 'deleteAllCurrentStates'], "Delete All Scheduled Jobs" : [key:6, function: 'deleteAllScheduledJobs'], "Delete All State Variables" : [key:7, function: 'deleteAllStates'], "Delete All Child Devices" : [key:8, function: 'deleteAllChildDevices'], " - " : [key:1, function: 'configureHelp'], "*** LOAD ALL DEFAULTS ***" : [key:0, function: 'loadAllDefaults'] ] def configure(command) { ArrayList cmds = [] logInfo "configure(${command})..." Boolean validated = false if (!(command in (ConfigureOpts.keySet() as List))) { logWarn "configure: command ${command} must be one of these : ${ConfigureOpts.keySet() as List}" return } // def func // try { func = ConfigureOpts[command]?.function cmds = "$func"() // } // catch (e) { // logWarn "Exception ${e} caught while processing $func($value)" // return // } logInfo "executed '${func}'" } def configureHelp( val ) { if (settings?.txtEnable) { log.warn "${device.displayName} configureHelp: select one of the commands in this list!" } } def loadAllDefaults() { logWarn "loadAllDefaults() !!!" deleteAllSettings() deleteAllCurrentStates() deleteAllScheduledJobs() deleteAllStates() deleteAllChildDevices() initialize() configure() sendInfoEvent("All Defaults Loaded!") } /** * Send configuration parameters to the device * Invoked when device is first installed and when the user updates the configuration * @return sends zigbee commands */ def configure() { ArrayList cmds = [] logInfo 'configure...' logDebug settings cmds += tuyaBlackMagic() if (isAqaraTVOC() || isAqaraTRV()) { aqaraBlackMagic() } cmds += initializeDevice() cmds += configureDevice() sendZigbeeCommands(cmds) sendInfoEvent("sent device configuration") } /** * Invoked by Hubitat when driver is installed */ void installed() { logInfo 'installed...' // populate some default values for attributes sendEvent(name: 'healthStatus', value: 'unknown') sendEvent(name: 'powerSource', value: 'unknown') sendInfoEvent("installed") runIn(3, 'updated') } /** * Invoked when initialize button is clicked */ void initialize() { logInfo 'initialize...' initializeVars(fullInit = true) updateTuyaVersion() updateAqaraVersion() } /* *----------------------------------------------------------------------------- * kkossev drivers commonly used functions *----------------------------------------------------------------------------- */ static Integer safeToInt(val, Integer defaultVal=0) { return "${val}"?.isInteger() ? "${val}".toInteger() : defaultVal } static Double safeToDouble(val, Double defaultVal=0.0) { return "${val}"?.isDouble() ? "${val}".toDouble() : defaultVal } void sendZigbeeCommands(ArrayList cmd) { logDebug "sendZigbeeCommands(cmd=$cmd)" hubitat.device.HubMultiAction allActions = new hubitat.device.HubMultiAction() cmd.each { allActions.add(new hubitat.device.HubAction(it, hubitat.device.Protocol.ZIGBEE)) if (state.stats != null) { state.stats['txCtr'] = (state.stats['txCtr'] ?: 0) + 1 } else { state.stats=[:] } } if (state.lastTx != null) { state.lastTx['cmdTime'] = now() } else { state.lastTx = [:] } sendHubCommand(allActions) } def driverVersionAndTimeStamp() { version() + ' ' + timeStamp() + ((_DEBUG) ? " (debug version!) " : " ") + "(${device.getDataValue('model')} ${device.getDataValue('manufacturer')}) (${getModel()} ${location.hub.firmwareVersionString}) "} def getDeviceInfo() { return "model=${device.getDataValue('model')} manufacturer=${device.getDataValue('manufacturer')} destinationEP=${state.destinationEP ?: UNKNOWN} deviceProfile=${state.deviceProfile ?: UNKNOWN}" } def getDestinationEP() { // [destEndpoint:safeToInt(getDestinationEP())] return state.destinationEP ?: device.endpointId ?: "01" } def checkDriverVersion() { if (state.driverVersion == null || driverVersionAndTimeStamp() != state.driverVersion) { logDebug "updating the settings from the current driver version ${state.driverVersion} to the new version ${driverVersionAndTimeStamp()}" sendInfoEvent("Updated to version ${driverVersionAndTimeStamp()}") state.driverVersion = driverVersionAndTimeStamp() initializeVars(fullInit = false) updateTuyaVersion() updateAqaraVersion() } else { // no driver version change } } // credits @thebearmay String getModel(){ try{ String model = getHubVersion() // requires >=2.2.8.141 } catch (ignore){ try{ httpGet("http://${location.hub.localIP}:8080/api/hubitat.xml") { res -> model = res.data.device.modelName return model } } catch(ignore_again) { return "" } } } // credits @thebearmay boolean isCompatible(Integer minLevel) { //check to see if the hub version meets the minimum requirement ( 7 or 8 ) String model = getModel() // Rev C-7 String[] tokens = model.split('-') String revision = tokens.last() return (Integer.parseInt(revision) >= minLevel) } /** * called from TODO * */ def deleteAllStatesAndJobs() { state.clear() // clear all states unschedule() device.deleteCurrentState('*') device.deleteCurrentState('') log.info "${device.displayName} jobs and states cleared. HE hub is ${getHubVersion()}, version is ${location.hub.firmwareVersionString}" } def resetStatistics() { runIn(1, "resetStats") sendInfoEvent("Statistics are reset. Refresh the web page") } /** * called from TODO * */ def resetStats() { logDebug "resetStats..." state.stats = [:] state.states = [:] state.lastRx = [:] state.lastTx = [:] state.health = [:] state.zigbeeGroups = [:] state.stats["rxCtr"] = 0 state.stats["txCtr"] = 0 state.states["isDigital"] = false state.states["isRefresh"] = false state.health["offlineCtr"] = 0 state.health["checkCtr3"] = 0 } /** * called from TODO * */ void initializeVars( boolean fullInit = false ) { logDebug "InitializeVars()... fullInit = ${fullInit}" if (fullInit == true ) { state.clear() unschedule() resetStats() //setDeviceNameAndProfile() //state.comment = 'Works with Tuya Zigbee Devices' logInfo "all states and scheduled jobs cleared!" state.driverVersion = driverVersionAndTimeStamp() logInfo "DEVICE_TYPE = ${DEVICE_TYPE}" state.deviceType = DEVICE_TYPE sendInfoEvent("Initialized") } if (state.stats == null) { state.stats = [:] } if (state.states == null) { state.states = [:] } if (state.lastRx == null) { state.lastRx = [:] } if (state.lastTx == null) { state.lastTx = [:] } if (state.health == null) { state.health = [:] } if (state.zigbeeGroups == null) { state.zigbeeGroups = [:] } if (fullInit || settings?.logEnable == null) device.updateSetting("logEnable", true) if (fullInit || settings?.txtEnable == null) device.updateSetting("txtEnable", true) if (fullInit || settings?.advancedOptions == null) device.updateSetting("advancedOptions", [value:false, type:"bool"]) if (fullInit || settings?.healthCheckMethod == null) device.updateSetting('healthCheckMethod', [value: HealthcheckMethodOpts.defaultValue.toString(), type: 'enum']) if (fullInit || settings?.healthCheckInterval == null) device.updateSetting('healthCheckInterval', [value: HealthcheckIntervalOpts.defaultValue.toString(), type: 'enum']) if (device.currentValue('healthStatus') == null) sendHealthStatusEvent('unknown') if (fullInit || settings?.threeStateEnable == null) device.updateSetting("threeStateEnable", false) if (fullInit || settings?.voltageToPercent == null) device.updateSetting("voltageToPercent", false) if (device.hasCapability("IlluminanceMeasurement")) { if (fullInit || settings?.minReportingTime == null) device.updateSetting("minReportingTime", [value:DEFAULT_MIN_REPORTING_TIME, type:"number"]) if (fullInit || settings?.maxReportingTime == null) device.updateSetting("maxReportingTime", [value:DEFAULT_MAX_REPORTING_TIME, type:"number"]) } if (device.hasCapability("IlluminanceMeasurement")) { if (fullInit || settings?.illuminanceThreshold == null) device.updateSetting("illuminanceThreshold", [value:DEFAULT_ILLUMINANCE_THRESHOLD, type:"number"]) if (fullInit || settings?.illuminanceCoeff == null) device.updateSetting("illuminanceCoeff", [value:1.00, type:"decimal"]) } // device specific initialization should be at the end if (DEVICE_TYPE in ["AirQuality"]) { initVarsAirQuality(fullInit) } if (DEVICE_TYPE in ["Fingerbot"]) { initVarsFingerbot(fullInit); initEventsFingerbot(fullInit) } if (DEVICE_TYPE in ["AqaraCube"]) { initVarsAqaraCube(fullInit); initEventsAqaraCube(fullInit) } if (DEVICE_TYPE in ["Switch"]) { initVarsSwitch(fullInit); initEventsSwitch(fullInit) } // none if (DEVICE_TYPE in ["IRBlaster"]) { initVarsIrBlaster(fullInit); initEventsIrBlaster(fullInit) } // none if (DEVICE_TYPE in ["Radar"]) { initVarsRadar(fullInit); initEventsRadar(fullInit) } // none if (DEVICE_TYPE in ["ButtonDimmer"]) { initVarsButtonDimmer(fullInit); initEventsButtonDimmer(fullInit) } if (DEVICE_TYPE in ["Alarm"]) { initVarsAlarm(fullInit); initEventsAlarm(fullInit) } def mm = device.getDataValue("model") if ( mm != null) { logDebug " model = ${mm}" } else { logWarn " Model not found, please re-pair the device!" } def ep = device.getEndpointId() if ( ep != null) { //state.destinationEP = ep logDebug " destinationEP = ${ep}" } else { logWarn " Destination End Point not found, please re-pair the device!" //state.destinationEP = "01" // fallback } } /** * called from TODO * */ def setDestinationEP() { def ep = device.getEndpointId() if (ep != null && ep != 'F2') { state.destinationEP = ep logDebug "setDestinationEP() destinationEP = ${state.destinationEP}" } else { logWarn "setDestinationEP() Destination End Point not found or invalid(${ep}), activating the F2 bug patch!" state.destinationEP = "01" // fallback EP } } def logDebug(msg) { if (settings.logEnable) { log.debug "${device.displayName} " + msg } } def logInfo(msg) { if (settings.txtEnable) { log.info "${device.displayName} " + msg } } def logWarn(msg) { if (settings.logEnable) { log.warn "${device.displayName} " + msg } } // _DEBUG mode only void getAllProperties() { log.trace 'Properties:' device.properties.each { it-> log.debug it } log.trace 'Settings:' settings.each { it-> log.debug "${it.key} = ${it.value}" // https://community.hubitat.com/t/how-do-i-get-the-datatype-for-an-app-setting/104228/6?u=kkossev } log.trace 'Done' } // delete all Preferences void deleteAllSettings() { settings.each { it-> logDebug "deleting ${it.key}" device.removeSetting("${it.key}") } logInfo "All settings (preferences) DELETED" } // delete all attributes void deleteAllCurrentStates() { device.properties.supportedAttributes.each { it-> logDebug "deleting $it" device.deleteCurrentState("$it") } logInfo "All current states (attributes) DELETED" } // delete all State Variables void deleteAllStates() { state.each { it-> logDebug "deleting state ${it.key}" } state.clear() logInfo "All States DELETED" } void deleteAllScheduledJobs() { unschedule() logInfo "All scheduled jobs DELETED" } void deleteAllChildDevices() { logDebug "deleteAllChildDevices : not implemented!" } def parseTest(par) { //read attr - raw: DF8D0104020A000029280A, dni: DF8D, endpoint: 01, cluster: 0402, size: 0A, attrId: 0000, encoding: 29, command: 0A, value: 280A log.warn "parseTest(${par})" parse(par) } def testJob() { log.warn "test job executed" } /** * Calculates and returns the cron expression * @param timeInSeconds interval in seconds */ def getCron( timeInSeconds ) { //schedule("${rnd.nextInt(59)} ${rnd.nextInt(9)}/${intervalMins} * ? * * *", 'ping') // TODO: runEvery1Minute runEvery5Minutes runEvery10Minutes runEvery15Minutes runEvery30Minutes runEvery1Hour runEvery3Hours final Random rnd = new Random() def minutes = (timeInSeconds / 60 ) as int def hours = (minutes / 60 ) as int if (hours > 23) { hours = 23 } String cron if (timeInSeconds < 60) { cron = "*/$timeInSeconds * * * * ? *" } else { if (minutes < 60) { cron = "${rnd.nextInt(59)} ${rnd.nextInt(9)}/$minutes * ? * *" } else { cron = "${rnd.nextInt(59)} ${rnd.nextInt(59)} */$hours ? * *" } } return cron } boolean isTuya() { def model = device.getDataValue("model") def manufacturer = device.getDataValue("manufacturer") if (model?.startsWith("TS") && manufacturer?.startsWith("_TZ")) { return true } return false } void updateTuyaVersion() { if (!isTuya()) { logDebug "not Tuya" return } def application = device.getDataValue("application") if (application != null) { Integer ver try { ver = zigbee.convertHexToInt(application) } catch (e) { logWarn "exception caught while converting application version ${application} to tuyaVersion" return } def str = ((ver&0xC0)>>6).toString() + "." + ((ver&0x30)>>4).toString() + "." + (ver&0x0F).toString() if (device.getDataValue("tuyaVersion") != str) { device.updateDataValue("tuyaVersion", str) logInfo "tuyaVersion set to $str" } } } boolean isAqara() { def model = device.getDataValue("model") def manufacturer = device.getDataValue("manufacturer") if (model?.startsWith("lumi")) { return true } return false } def updateAqaraVersion() { if (!isAqara()) { logDebug "not Aqara" return } def application = device.getDataValue("application") if (application != null) { def str = "0.0.0_" + String.format("%04d", zigbee.convertHexToInt(application.substring(0, Math.min(application.length(), 2)))); if (device.getDataValue("aqaraVersion") != str) { device.updateDataValue("aqaraVersion", str) logInfo "aqaraVersion set to $str" } } else { return null } } def test(par) { ArrayList cmds = [] log.warn "test... ${par}" handleTemperatureEvent(safeToDouble(par) as float) // sendZigbeeCommands(cmds) } // /////////////////////////////////////////////////////////////////// Libraries ////////////////////////////////////////////////////////////////////// // ~~~~~ start include (138) kkossev.tuyaAlarmLib ~~~~~ library ( // library marker kkossev.tuyaAlarmLib, line 1 base: "driver", // library marker kkossev.tuyaAlarmLib, line 2 author: "Krassimir Kossev", // library marker kkossev.tuyaAlarmLib, line 3 category: "zigbee", // library marker kkossev.tuyaAlarmLib, line 4 description: "Tuya Alarm Library", // library marker kkossev.tuyaAlarmLib, line 5 name: "tuyaAlarmLib", // library marker kkossev.tuyaAlarmLib, line 6 namespace: "kkossev", // library marker kkossev.tuyaAlarmLib, line 7 importUrl: "https://raw.githubusercontent.com/kkossev/hubitat/main/libraries/tuyaAlarmLib.groovy", // library marker kkossev.tuyaAlarmLib, line 8 version: "1.0.0", // library marker kkossev.tuyaAlarmLib, line 9 documentationLink: "" // library marker kkossev.tuyaAlarmLib, line 10 ) // library marker kkossev.tuyaAlarmLib, line 11 /* // library marker kkossev.tuyaAlarmLib, line 12 * tuyaAlarmLib - Tuya Alarm Library // library marker kkossev.tuyaAlarmLib, line 13 * // library marker kkossev.tuyaAlarmLib, line 14 * ver. 1.0.0 2023-09-03 kkossev - (dev. branch) - code transfered from "Tuya Smart Siren Zigbee" driver ver. 1.2.2 // library marker kkossev.tuyaAlarmLib, line 15 * ver. 1.0.1 2023-09-04 kkossev - (dev. branch) - battery percentage bug fix // library marker kkossev.tuyaAlarmLib, line 16 * // library marker kkossev.tuyaAlarmLib, line 17 * TODO: setDuration infoLog; setMelody infoLog; setVolume infoLog // library marker kkossev.tuyaAlarmLib, line 18 * // library marker kkossev.tuyaAlarmLib, line 19 */ // library marker kkossev.tuyaAlarmLib, line 20 def tuyaAlarmLibVersion() {"1.0.1"} // library marker kkossev.tuyaAlarmLib, line 22 def tuyaAlarmLibTimeStamp() {"2023/09/04 8:45 PM"} // library marker kkossev.tuyaAlarmLib, line 23 metadata { // library marker kkossev.tuyaAlarmLib, line 25 capability "Alarm" // alarm - ENUM ["strobe", "off", "both", "siren"]; Commands: both() off() siren() strobe() // library marker kkossev.tuyaAlarmLib, line 26 capability "Tone" // Commands: beep() // library marker kkossev.tuyaAlarmLib, line 27 capability "Chime" // soundEffects - JSON_OBJECT; soundName - STRING; status - ENUM ["playing", "stopped"]; Commands: playSound(soundnumber); soundnumber required (NUMBER) - Sound number to play; stop() // library marker kkossev.tuyaAlarmLib, line 28 capability "AudioVolume" //Attributes: mute - ENUM ["unmuted", "muted"] volume - NUMBER, unit:%; Commands: mute() setVolume(volumelevel) volumelevel required (NUMBER) - Volume level (0 to 100) unmute() volumeDown() volumeUp() // library marker kkossev.tuyaAlarmLib, line 29 //capability "TemperatureMeasurement" // library marker kkossev.tuyaAlarmLib, line 30 //capability "RelativeHumidityMeasurement" // library marker kkossev.tuyaAlarmLib, line 31 attribute "duration", "number" // library marker kkossev.tuyaAlarmLib, line 33 attribute "Info", "text" // library marker kkossev.tuyaAlarmLib, line 34 command "setMelody", [ // library marker kkossev.tuyaAlarmLib, line 36 [name:"alarmType", type: "ENUM", description: "Sound Type", constraints: soundTypeOptions], // library marker kkossev.tuyaAlarmLib, line 37 [name:"melodyNumber", type: "NUMBER", description: "Set the Melody Number 1..18"] // library marker kkossev.tuyaAlarmLib, line 38 ] // library marker kkossev.tuyaAlarmLib, line 39 command "setDuration", [ // library marker kkossev.tuyaAlarmLib, line 40 [name:"alarmType", type: "ENUM", description: "Sound Type", constraints: soundTypeOptions], // library marker kkossev.tuyaAlarmLib, line 41 [name:"alarmLength", type: "NUMBER", description: "Set the Duration in seconds 0..180"] // library marker kkossev.tuyaAlarmLib, line 42 ] // library marker kkossev.tuyaAlarmLib, line 43 command "setVolume", [ // library marker kkossev.tuyaAlarmLib, line 44 [name:"volumeType", type: "ENUM", description: "Sound Type", constraints: volumeTypeOptions], // library marker kkossev.tuyaAlarmLib, line 45 [name:"Volume", type: "ENUM", description: "Set the Volume", constraints: volumeNameOptions ] // library marker kkossev.tuyaAlarmLib, line 46 ] // library marker kkossev.tuyaAlarmLib, line 47 command "playSound", [ // library marker kkossev.tuyaAlarmLib, line 48 [name:"soundNumber", type: "NUMBER", description: "Melody Number, 1..18", isRequired: true], // library marker kkossev.tuyaAlarmLib, line 49 [name:"volumeLevel", type: "NUMBER", description: "Sound Volume level, 0..100 %"], // library marker kkossev.tuyaAlarmLib, line 50 [name:"duration", type: "NUMBER", description: "Duration is seconds"] // library marker kkossev.tuyaAlarmLib, line 51 ] // library marker kkossev.tuyaAlarmLib, line 52 fingerprint profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_t1blo2bj", deviceJoinName: "Tuya NEO Smart Siren" // vendor: 'Neo', model: 'NAS-AB02B2' // library marker kkossev.tuyaAlarmLib, line 54 // not working with this driver - use Markus's driver instead // library marker kkossev.tuyaAlarmLib, line 55 fingerprint profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A" ,model:"TS0601", manufacturer:"_TZE200_d0yu2xgi", deviceJoinName: "Tuya NEO Smart Siren T&H" // Neo NAS-AB02B0 // library marker kkossev.tuyaAlarmLib, line 56 fingerprint profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A" ,model:"TS0601", manufacturer:"_TYST11_d0yu2xgi", deviceJoinName: "Tuya NEO Smart Siren T&H" // not tested // library marker kkossev.tuyaAlarmLib, line 57 fingerprint profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A" ,model:"TS0601", manufacturer: "d0yu2xgi", deviceJoinName: "Tuya NEO Smart Siren T&H" // not tested // library marker kkossev.tuyaAlarmLib, line 58 fingerprint profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A" ,model:"TS0601", manufacturer:"_TZE204_t1blo2bj", deviceJoinName: "Tuya Smart Siren" // https://community.hubitat.com/t/release-tuya-smart-siren-zigbee-driver/91772/67?u=kkossev // library marker kkossev.tuyaAlarmLib, line 59 // https://github.com/zigpy/zha-device-handlers/issues/1379#issuecomment-1077772021 // library marker kkossev.tuyaAlarmLib, line 61 preferences { // library marker kkossev.tuyaAlarmLib, line 63 input (name: "beepVolume", type: "enum", title: "Beep Volume", description:"Select the volume used in the Beep command", defaultValue: "low", options: volumeNameOptions) // library marker kkossev.tuyaAlarmLib, line 64 // // library marker kkossev.tuyaAlarmLib, line 65 input (name: "alarmMelody", type: "enum", title: "Alarm default Melody", description:"Select the melody used in the Alarm commands", defaultValue: '12=Alarm Siren', options: melodiesOptions) // library marker kkossev.tuyaAlarmLib, line 66 input (name: "alarmSoundVolume", type: "enum", title: "Alarm default Volume", description:"Select the volume used in the Alarm commands", defaultValue: 'high', options: volumeNameOptions) // library marker kkossev.tuyaAlarmLib, line 67 input (name: "alarmSoundDuration", type: "number", title: "Alarm default Duration, seconds", description: "Select the duration used in the Alarm commands, seconds", range: "1..$TUYA_MAX_DURATION", defaultValue: TUYA_MAX_DURATION) // library marker kkossev.tuyaAlarmLib, line 68 // // library marker kkossev.tuyaAlarmLib, line 69 input (name: "playSoundMelody", type: "enum", title: "Play Sound (Chime) default Melody", description:"Select the default melody used in the playSound (Chime) command", defaultValue: TUYA_DEFAULT_MELODY, options: melodiesOptions) // library marker kkossev.tuyaAlarmLib, line 70 input (name: "playSoundVolume", type: "enum", title: "Play Sound (Chime) default Volume", description:"Select the default volume used in the playSound (Chime) command", defaultValue: TUYA_DEFAULT_VOLUME, options: volumeNameOptions) // library marker kkossev.tuyaAlarmLib, line 71 input (name: "playSoundDuration", type: "number", title: "Play Sound (Chime) default Duration, seconds", description: "Select the default duration used in the playSound (Chime) command, seconds", range: "1..$TUYA_MAX_DURATION", defaultValue: TUYA_DEFAULT_DURATION) // library marker kkossev.tuyaAlarmLib, line 72 // // library marker kkossev.tuyaAlarmLib, line 73 if (advancedOptions == true) { // library marker kkossev.tuyaAlarmLib, line 74 input (name: "restoreAlarmSettings", type: "bool", title: "Restore Default Alarm Settings", description: "After playing Beep or Chime sounds, the default Alarm settings will be restored after 7 seconds ", defaultValue: false) // library marker kkossev.tuyaAlarmLib, line 75 input (name: "presetBeepAndChimeSettings", type: "enum", title: "Preset Beep and Chime Settings", description: "Before playing Beep or Chime sounds, the preset Beep/Chime settings will be restored first", defaultValue: "fast", options:["fast", /*"slow",*/ "none"]) // library marker kkossev.tuyaAlarmLib, line 76 } // library marker kkossev.tuyaAlarmLib, line 77 } // library marker kkossev.tuyaAlarmLib, line 78 } // library marker kkossev.tuyaAlarmLib, line 80 def isNeo() { (device.getDataValue("manufacturer") in ['_TZE200_d0yu2xgi', '_TZE200_d0yu2xgi', 'd0yu2xgi']) } // library marker kkossev.tuyaAlarmLib, line 83 def isTuyaAlarm() { (device.getDataValue("manufacturer") in ['_TZE204_t1blo2bj']) } // library marker kkossev.tuyaAlarmLib, line 84 @Field static final Map disabledEnabledOptions = [ // library marker kkossev.tuyaAlarmLib, line 86 '0' : 'disabled', // library marker kkossev.tuyaAlarmLib, line 87 '1' : 'enabled' // library marker kkossev.tuyaAlarmLib, line 88 ] // library marker kkossev.tuyaAlarmLib, line 89 @Field static final Map temperatureScaleOptions = [ // library marker kkossev.tuyaAlarmLib, line 90 '0' : 'Fahrenheit', // library marker kkossev.tuyaAlarmLib, line 91 '1' : 'Celsius' // library marker kkossev.tuyaAlarmLib, line 92 ] // library marker kkossev.tuyaAlarmLib, line 93 @Field static final List volumeNameOptions = [ // library marker kkossev.tuyaAlarmLib, line 94 'low', // library marker kkossev.tuyaAlarmLib, line 95 'medium', // library marker kkossev.tuyaAlarmLib, line 96 'high' // library marker kkossev.tuyaAlarmLib, line 97 ] // library marker kkossev.tuyaAlarmLib, line 98 @Field static final List soundTypeOptions = [ 'alarm', 'chime'] // library marker kkossev.tuyaAlarmLib, line 99 @Field static final List volumeTypeOptions = [ 'alarm', 'chime', 'beep'] // library marker kkossev.tuyaAlarmLib, line 100 @Field static final LinkedHashMap volumeMapping = [ // library marker kkossev.tuyaAlarmLib, line 101 'low' : [ volume: '33', tuya: '0'], // library marker kkossev.tuyaAlarmLib, line 102 'medium' : [ volume: '66', tuya: '1'], // library marker kkossev.tuyaAlarmLib, line 103 'high' : [ volume: '100', tuya: '2'] // library marker kkossev.tuyaAlarmLib, line 104 ]// as ConfigObject // library marker kkossev.tuyaAlarmLib, line 105 @Field static final String TUYA_DEFAULT_VOLUME_NAME = 'medium' // library marker kkossev.tuyaAlarmLib, line 107 @Field static final Integer TUYA_DEFAULT_DURATION = 10 // library marker kkossev.tuyaAlarmLib, line 108 @Field static final Integer TUYA_MAX_DURATION = 180 // library marker kkossev.tuyaAlarmLib, line 109 @Field static final String TUYA_DEFAULT_MELODY_NAME = '2=Fur Elise' // library marker kkossev.tuyaAlarmLib, line 110 @Field static final Integer TUYA_MAX_MELODIES = 18 // library marker kkossev.tuyaAlarmLib, line 111 @Field static final List melodiesOptions = [ // library marker kkossev.tuyaAlarmLib, line 113 '1=Doorbell 1', // library marker kkossev.tuyaAlarmLib, line 114 '2=Fur Elise', // library marker kkossev.tuyaAlarmLib, line 115 '3=Westminster', // library marker kkossev.tuyaAlarmLib, line 116 '4=4 Key Chime', // library marker kkossev.tuyaAlarmLib, line 117 '5=William Tell', // library marker kkossev.tuyaAlarmLib, line 118 '6=Mozart Piano', // library marker kkossev.tuyaAlarmLib, line 119 '7=Space Alarm', // library marker kkossev.tuyaAlarmLib, line 120 '8=Klaxon', // library marker kkossev.tuyaAlarmLib, line 121 '9=meep meep', // library marker kkossev.tuyaAlarmLib, line 122 '10=Wheep', // library marker kkossev.tuyaAlarmLib, line 123 '11=Barking dog', // library marker kkossev.tuyaAlarmLib, line 124 '12=Alarm Siren', // library marker kkossev.tuyaAlarmLib, line 125 '13=Doorbell 2', // library marker kkossev.tuyaAlarmLib, line 126 '14=Old Phone', // library marker kkossev.tuyaAlarmLib, line 127 '15=Police Siren', // library marker kkossev.tuyaAlarmLib, line 128 '16=Evacuation bell', // library marker kkossev.tuyaAlarmLib, line 129 '17=Clock alarm', // library marker kkossev.tuyaAlarmLib, line 130 '18=Fire alarm' // library marker kkossev.tuyaAlarmLib, line 131 ] //as String[] // library marker kkossev.tuyaAlarmLib, line 132 // Constants // library marker kkossev.tuyaAlarmLib, line 134 @Field static final Integer TUYA_DP_VOLUME = 5 // library marker kkossev.tuyaAlarmLib, line 135 @Field static final Integer TUYA_DP_DURATION = 7 // library marker kkossev.tuyaAlarmLib, line 136 @Field static final Integer TUYA_DP_ALARM = 13 // library marker kkossev.tuyaAlarmLib, line 137 @Field static final Integer TUYA_DP_BATTERY = 15 // library marker kkossev.tuyaAlarmLib, line 138 @Field static final Integer TUYA_DP_MELODY = 21 // library marker kkossev.tuyaAlarmLib, line 139 @Field static final Integer NEO_DP_VOLUME = 116 // library marker kkossev.tuyaAlarmLib, line 141 @Field static final Integer NEO_DP_DURATION = 103 // library marker kkossev.tuyaAlarmLib, line 142 @Field static final Integer NEO_DP_ALARM = 104 // library marker kkossev.tuyaAlarmLib, line 143 @Field static final Integer NEO_DP_BATTERY = 101 // enum // library marker kkossev.tuyaAlarmLib, line 144 @Field static final Integer NEO_DP_MELODY = 102 // library marker kkossev.tuyaAlarmLib, line 145 private findVolumeByTuyaValue( fncmd ) { // library marker kkossev.tuyaAlarmLib, line 149 def volumeName = 'unknown' // library marker kkossev.tuyaAlarmLib, line 150 def volumePct = -1 // library marker kkossev.tuyaAlarmLib, line 151 volumeMapping.each{ k, v -> // library marker kkossev.tuyaAlarmLib, line 152 if (v.tuya as String == fncmd.toString()) { // library marker kkossev.tuyaAlarmLib, line 153 volumeName = k // library marker kkossev.tuyaAlarmLib, line 154 volumePct = v.volume // library marker kkossev.tuyaAlarmLib, line 155 } // library marker kkossev.tuyaAlarmLib, line 156 } // library marker kkossev.tuyaAlarmLib, line 157 return [volumeName, volumePct] // library marker kkossev.tuyaAlarmLib, line 158 } // library marker kkossev.tuyaAlarmLib, line 159 private findVolumeByPct( pct ) { // library marker kkossev.tuyaAlarmLib, line 161 def volumeName = 'unknown' // library marker kkossev.tuyaAlarmLib, line 162 def volumeTuya = -1 // library marker kkossev.tuyaAlarmLib, line 163 volumeMapping.each{ k, v -> // library marker kkossev.tuyaAlarmLib, line 164 if (v.volume as String == pct.toString()) { // library marker kkossev.tuyaAlarmLib, line 165 volumeName = k // library marker kkossev.tuyaAlarmLib, line 166 volumeTuya = v.tuya // library marker kkossev.tuyaAlarmLib, line 167 } // library marker kkossev.tuyaAlarmLib, line 168 } // library marker kkossev.tuyaAlarmLib, line 169 return [volumeName, volumeTuya] // library marker kkossev.tuyaAlarmLib, line 170 } // library marker kkossev.tuyaAlarmLib, line 171 private findVolumeByName( name ) { // library marker kkossev.tuyaAlarmLib, line 173 def volumeTuya = -1 // library marker kkossev.tuyaAlarmLib, line 174 def volumePct = -1 // library marker kkossev.tuyaAlarmLib, line 175 volumeMapping.each{ k, v -> // library marker kkossev.tuyaAlarmLib, line 176 if (k as String == name as String) { // library marker kkossev.tuyaAlarmLib, line 177 volumeTuya = safeToInt(v.tuya) // library marker kkossev.tuyaAlarmLib, line 178 volumePct = safeToInt(v.volume) // library marker kkossev.tuyaAlarmLib, line 179 } // library marker kkossev.tuyaAlarmLib, line 180 } // library marker kkossev.tuyaAlarmLib, line 181 return [volumeTuya, volumePct] // library marker kkossev.tuyaAlarmLib, line 182 } // library marker kkossev.tuyaAlarmLib, line 183 void processTuyaDpAlarm(descMap, dp, dp_id, fncmd) { // library marker kkossev.tuyaAlarmLib, line 186 logDebug "processTuyaDpAlarm: dp_id=${dp_id} dp=${dp} fncmd=${fncmd}" // library marker kkossev.tuyaAlarmLib, line 187 switch (dp) { // library marker kkossev.tuyaAlarmLib, line 188 case 0x74 : // Neo Siren Volume ['low', 'medium', 'high'] // library marker kkossev.tuyaAlarmLib, line 189 logDebug "Neo Siren Volume is (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 190 case TUYA_DP_VOLUME : // (05) volume [ENUM] 0:low 1: mid 2:high // library marker kkossev.tuyaAlarmLib, line 191 def volumeName = 'unknown' // library marker kkossev.tuyaAlarmLib, line 192 def volumePct = -1 // library marker kkossev.tuyaAlarmLib, line 193 (volumeName, volumePct) = findVolumeByTuyaValue( fncmd ) // library marker kkossev.tuyaAlarmLib, line 194 if (volumeName != 'unknown') { // library marker kkossev.tuyaAlarmLib, line 195 logDebug "confirmed volume ${volumeName} ${volumePct}% (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 196 sendVolumeEvent( volumePct ) // library marker kkossev.tuyaAlarmLib, line 197 } // library marker kkossev.tuyaAlarmLib, line 198 break // library marker kkossev.tuyaAlarmLib, line 199 case 0x67 : // Neo Alarm Duration 0..1800 seconds // library marker kkossev.tuyaAlarmLib, line 201 logDebug "received Neo Alarm duration ${fncmd}" // library marker kkossev.tuyaAlarmLib, line 202 case TUYA_DP_DURATION : // (07) duration [VALUE] in seconds // library marker kkossev.tuyaAlarmLib, line 203 logDebug "confirmed duration ${fncmd} s" // library marker kkossev.tuyaAlarmLib, line 204 sendEvent(name: "duration", value: fncmd, descriptionText: descriptionText, type: "physical") // library marker kkossev.tuyaAlarmLib, line 205 break // library marker kkossev.tuyaAlarmLib, line 206 case 0x68 : // Neo Alarm On 0x01 Off 0x00 // library marker kkossev.tuyaAlarmLib, line 208 logDebug "Neo Alarm status is ${fncmd}" // library marker kkossev.tuyaAlarmLib, line 209 case TUYA_DP_ALARM : // (13) alarm [BOOL] // library marker kkossev.tuyaAlarmLib, line 210 def value = fncmd == 0 ? "off" : fncmd == 1 ? (state.lastTx["lastCommand"] ?: "n/a") : "unknown" // library marker kkossev.tuyaAlarmLib, line 211 if (settings?.logEnable) logInfo "confirmed alarm state ${value} (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 212 if (value == "off") { // library marker kkossev.tuyaAlarmLib, line 213 sendEvent(name: "status", value: "stopped", type: "physical") // library marker kkossev.tuyaAlarmLib, line 214 if (settings?.restoreAlarmSettings == true) { // library marker kkossev.tuyaAlarmLib, line 215 if (device.currentValue("alarm", true) in ["beep", "playSound"]) { // library marker kkossev.tuyaAlarmLib, line 216 runIn( 7, restoreDefaultSettings, [overwrite: true]) // library marker kkossev.tuyaAlarmLib, line 217 } // library marker kkossev.tuyaAlarmLib, line 218 } // library marker kkossev.tuyaAlarmLib, line 219 } // library marker kkossev.tuyaAlarmLib, line 220 else { // library marker kkossev.tuyaAlarmLib, line 221 unschedule(restoreDefaultSettings) // library marker kkossev.tuyaAlarmLib, line 222 sendEvent(name: "status", value: "playing", type: "physical") // library marker kkossev.tuyaAlarmLib, line 223 } // library marker kkossev.tuyaAlarmLib, line 224 sendAlarmEvent(value) // library marker kkossev.tuyaAlarmLib, line 225 break // library marker kkossev.tuyaAlarmLib, line 226 case TUYA_DP_BATTERY : // (15) battery [VALUE] percentage // library marker kkossev.tuyaAlarmLib, line 227 logDebug "received TUYA_DP_BATTERY event fncmd=${fncmd}" // library marker kkossev.tuyaAlarmLib, line 228 sendBatteryPercentageEvent(fncmd) // library marker kkossev.tuyaAlarmLib, line 229 break // library marker kkossev.tuyaAlarmLib, line 230 case 0x66 : // Neo Alarm Melody 18 Max ? -> fncmd+1 ? TODO // library marker kkossev.tuyaAlarmLib, line 232 logDebug "received Neo Alarm melody ${fncmd}" // library marker kkossev.tuyaAlarmLib, line 233 case TUYA_DP_MELODY : // (21) melody [enum] 0..17 // library marker kkossev.tuyaAlarmLib, line 234 if (settings?.logEnable) logInfo "confirmed melody ${melodiesOptions[fncmd]} (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 235 sendEvent(name: "soundName", value: melodiesOptions[fncmd], descriptionText: descriptionText, type: "physical" ) // library marker kkossev.tuyaAlarmLib, line 236 break // library marker kkossev.tuyaAlarmLib, line 237 case 0x65 : // Neo Power Mode ['battery_full', 'battery_high', 'battery_medium', 'battery_low', 'usb'] // library marker kkossev.tuyaAlarmLib, line 239 if (settings?.logEnable) logInfo "Neo Power Mode is ${fncmd}" // library marker kkossev.tuyaAlarmLib, line 240 break // library marker kkossev.tuyaAlarmLib, line 241 case 0x69 : // Neo Temperature ( x10 ) // library marker kkossev.tuyaAlarmLib, line 242 if (settings?.logEnable) logInfo "Neo Temperature is ${fncmd/10.0} C (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 243 sendTemperatureEvent( fncmd/10.0 ) // library marker kkossev.tuyaAlarmLib, line 244 break // library marker kkossev.tuyaAlarmLib, line 245 case 0x6A : // Neo Humidity Level (x10 ) // library marker kkossev.tuyaAlarmLib, line 246 if (settings?.logEnable) logInfo "Neo Humidity Level is ${fncmd/10.0} %RH (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 247 sendHumidityEvent( fncmd/10.0 ) // library marker kkossev.tuyaAlarmLib, line 248 break // library marker kkossev.tuyaAlarmLib, line 249 case 0x6B : // Neo Min Alarm Temperature -20 .. 80 // library marker kkossev.tuyaAlarmLib, line 250 if (settings?.logEnable) logInfo "Neo Min Alarm Temperature is ${fncmd} C" // library marker kkossev.tuyaAlarmLib, line 251 break // library marker kkossev.tuyaAlarmLib, line 252 case 0x6C : // Neo Max Alarm Temperature -20 .. 80 // library marker kkossev.tuyaAlarmLib, line 253 if (settings?.logEnable) logInfo "Neo Max Alarm Temperature is ${fncmd} C" // library marker kkossev.tuyaAlarmLib, line 254 break // library marker kkossev.tuyaAlarmLib, line 255 case 0x6D : // Neo Min Alarm Humidity 1..100 // library marker kkossev.tuyaAlarmLib, line 256 if (settings?.logEnable) logInfo "Neo Min Alarm Humidity is ${fncmd} %RH" // library marker kkossev.tuyaAlarmLib, line 257 break // library marker kkossev.tuyaAlarmLib, line 258 case 0x6E : // Neo Max Alarm Humidity 1..100 // library marker kkossev.tuyaAlarmLib, line 259 if (settings?.logEnable) logInfo "Neo Max Alarm Humidity is ${fncmd} %RH" // library marker kkossev.tuyaAlarmLib, line 260 break // library marker kkossev.tuyaAlarmLib, line 261 case 0x70 : // Neo Temperature Unit (F 0x00, C 0x01) // library marker kkossev.tuyaAlarmLib, line 262 if (settings?.logEnable) logInfo "Neo Temperature Unit is ${temperatureScaleOptions[safeToInt(fncmd).toString()]} (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 263 break // library marker kkossev.tuyaAlarmLib, line 264 case 0x71 : // Neo Alarm by Temperature status // library marker kkossev.tuyaAlarmLib, line 265 if (settings?.logEnable) logInfo "Neo Alarm by Temperature status is ${disabledEnabledOptions[safeToInt(fncmd).toString()]} (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 266 break // library marker kkossev.tuyaAlarmLib, line 267 case 0x72 : // Neo Alarm by Humidity status // library marker kkossev.tuyaAlarmLib, line 268 if (settings?.logEnable) logInfo "Neo Alarm by Humidity status is ${disabledEnabledOptions[safeToInt(fncmd).toString()]} (${fncmd})" // library marker kkossev.tuyaAlarmLib, line 269 break // library marker kkossev.tuyaAlarmLib, line 270 case 0x73 : // Neo ??? // library marker kkossev.tuyaAlarmLib, line 271 if (settings?.logEnable) logInfo "Neo unknown parameter (x073) is ${fncmd}" // library marker kkossev.tuyaAlarmLib, line 272 break // library marker kkossev.tuyaAlarmLib, line 273 default : // library marker kkossev.tuyaAlarmLib, line 274 logWarn "NOT PROCESSED Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" // library marker kkossev.tuyaAlarmLib, line 275 break // library marker kkossev.tuyaAlarmLib, line 276 } // library marker kkossev.tuyaAlarmLib, line 277 } // library marker kkossev.tuyaAlarmLib, line 278 private wakeUpTuya() { // library marker kkossev.tuyaAlarmLib, line 281 logDebug "wakeUpTuya()" // library marker kkossev.tuyaAlarmLib, line 282 ping() // library marker kkossev.tuyaAlarmLib, line 283 //sendZigbeeCommands(zigbee.readAttribute(0x0000, 0x0005, [:], delay=50) ) // library marker kkossev.tuyaAlarmLib, line 284 } // library marker kkossev.tuyaAlarmLib, line 285 private combinedTuyaCommands(String cmds) { // library marker kkossev.tuyaAlarmLib, line 287 if (state.stats != null) { state.stats['txCtr'] = (state.stats['txCtr'] ?: 0) + 1 } else { state.stats=[:] } // library marker kkossev.tuyaAlarmLib, line 288 if (state.lastTx != null) { state.lastTx['cmdTime'] = now() } else { state.lastTx = [:] } // library marker kkossev.tuyaAlarmLib, line 289 return zigbee.command(CLUSTER_TUYA, SETDATA, [:], delay=200, PACKET_ID + cmds ) // library marker kkossev.tuyaAlarmLib, line 290 } // library marker kkossev.tuyaAlarmLib, line 291 private appendTuyaCommand(Integer dp, String dp_type, Integer fncmd) { // library marker kkossev.tuyaAlarmLib, line 293 Integer fncmdLen = dp_type== DP_TYPE_VALUE? 8 : 2 // library marker kkossev.tuyaAlarmLib, line 294 String cmds = zigbee.convertToHexString(dp, 2) + dp_type + zigbee.convertToHexString((int)(fncmdLen/2), 4) + zigbee.convertToHexString(fncmd, fncmdLen) // library marker kkossev.tuyaAlarmLib, line 295 //logDebug "appendTuyaCommand = ${cmds}" // library marker kkossev.tuyaAlarmLib, line 296 return cmds // library marker kkossev.tuyaAlarmLib, line 297 } // library marker kkossev.tuyaAlarmLib, line 298 void sendSimpleTuyaCommand(Integer command, String payload) { // library marker kkossev.tuyaAlarmLib, line 300 Random rnd = new Random() // library marker kkossev.tuyaAlarmLib, line 301 String fullPayload = "00${HexUtils.integerToHexString(rnd.nextInt(255),1)}" + payload // library marker kkossev.tuyaAlarmLib, line 302 sendSimpleZigbeeCommands(zigbeeCommand(0x01, 0xEF00, command, 101, fullPayload)) // library marker kkossev.tuyaAlarmLib, line 303 logDebug "Payload sent: ${fullPayload}" // library marker kkossev.tuyaAlarmLib, line 304 } // library marker kkossev.tuyaAlarmLib, line 305 void sendSimpleZigbeeCommands(ArrayList cmd) { // library marker kkossev.tuyaAlarmLib, line 307 logDebug "sendZigbeeCommands(cmd=${cmd})" // library marker kkossev.tuyaAlarmLib, line 308 hubitat.device.HubMultiAction allActions = new hubitat.device.HubMultiAction() // library marker kkossev.tuyaAlarmLib, line 309 cmd.each { // library marker kkossev.tuyaAlarmLib, line 310 allActions.add(new hubitat.device.HubAction(it, hubitat.device.Protocol.ZIGBEE)) // library marker kkossev.tuyaAlarmLib, line 311 } // library marker kkossev.tuyaAlarmLib, line 312 sendHubCommand(allActions) // library marker kkossev.tuyaAlarmLib, line 313 } // library marker kkossev.tuyaAlarmLib, line 314 ArrayList zigbeeCommand(Integer cluster, Integer command, Map additionalParams, int delay = 201, String... payload) { // library marker kkossev.tuyaAlarmLib, line 316 ArrayList cmd = zigbee.command(cluster, command, additionalParams, delay, payload) // library marker kkossev.tuyaAlarmLib, line 317 cmd[0] = cmd[0].replace('0xnull', '0x01') // library marker kkossev.tuyaAlarmLib, line 318 return cmd // library marker kkossev.tuyaAlarmLib, line 320 } // library marker kkossev.tuyaAlarmLib, line 321 String integerToHexString(BigDecimal value, Integer minBytes, boolean reverse=false) { // library marker kkossev.tuyaAlarmLib, line 323 return integerToHexString(value.intValue(), minBytes, reverse=reverse) // library marker kkossev.tuyaAlarmLib, line 324 } // library marker kkossev.tuyaAlarmLib, line 325 ArrayList zigbeeCommand(Integer endpoint, Integer cluster, Integer command, int delay = 203, String... payload) { // library marker kkossev.tuyaAlarmLib, line 327 zigbeeCommand(endpoint, cluster, command, [:], delay, payload) // library marker kkossev.tuyaAlarmLib, line 328 } // library marker kkossev.tuyaAlarmLib, line 329 ArrayList zigbeeCommand(Integer endpoint, Integer cluster, Integer command, Map additionalParams, int delay = 204, String... payload) { // library marker kkossev.tuyaAlarmLib, line 331 String mfgCode = "" // library marker kkossev.tuyaAlarmLib, line 332 if(additionalParams.containsKey("mfgCode")) { // library marker kkossev.tuyaAlarmLib, line 333 mfgCode = " {${HexUtils.integerToHexString(HexUtils.hexStringToInt(additionalParams.get("mfgCode")), 2)}}" // library marker kkossev.tuyaAlarmLib, line 334 } // library marker kkossev.tuyaAlarmLib, line 335 String finalPayload = payload != null && payload != [] ? payload[0] : "" // library marker kkossev.tuyaAlarmLib, line 336 String cmdArgs = "0x${device.deviceNetworkId} 0x${HexUtils.integerToHexString(endpoint, 1)} 0x${HexUtils.integerToHexString(cluster, 2)} " + // library marker kkossev.tuyaAlarmLib, line 337 "0x${HexUtils.integerToHexString(command, 1)} " + // library marker kkossev.tuyaAlarmLib, line 338 "{$finalPayload}" + // library marker kkossev.tuyaAlarmLib, line 339 "$mfgCode" // library marker kkossev.tuyaAlarmLib, line 340 ArrayList cmd = ["he cmd $cmdArgs", "delay $delay"] // library marker kkossev.tuyaAlarmLib, line 341 return cmd // library marker kkossev.tuyaAlarmLib, line 342 } // library marker kkossev.tuyaAlarmLib, line 343 String integerToHexString(Integer value, Integer minBytes, boolean reverse=false) { // library marker kkossev.tuyaAlarmLib, line 345 if(reverse == true) { // library marker kkossev.tuyaAlarmLib, line 346 return HexUtils.integerToHexString(value, minBytes).split("(?<=\\G..)").reverse().join() // library marker kkossev.tuyaAlarmLib, line 347 } else { // library marker kkossev.tuyaAlarmLib, line 348 return HexUtils.integerToHexString(value, minBytes) // library marker kkossev.tuyaAlarmLib, line 349 } // library marker kkossev.tuyaAlarmLib, line 350 } // library marker kkossev.tuyaAlarmLib, line 352 def offAlarm() { // library marker kkossev.tuyaAlarmLib, line 354 sendTuyaAlarm("off") // library marker kkossev.tuyaAlarmLib, line 355 } // library marker kkossev.tuyaAlarmLib, line 356 def onAlarm() { // library marker kkossev.tuyaAlarmLib, line 358 sendTuyaAlarm("on") // library marker kkossev.tuyaAlarmLib, line 359 } // library marker kkossev.tuyaAlarmLib, line 360 def both() { // library marker kkossev.tuyaAlarmLib, line 362 sendTuyaAlarm("both") // library marker kkossev.tuyaAlarmLib, line 363 } // library marker kkossev.tuyaAlarmLib, line 364 def strobe() { // library marker kkossev.tuyaAlarmLib, line 366 sendTuyaAlarm("strobe") // library marker kkossev.tuyaAlarmLib, line 367 } // library marker kkossev.tuyaAlarmLib, line 368 def siren() { // library marker kkossev.tuyaAlarmLib, line 370 sendTuyaAlarm( "siren") // library marker kkossev.tuyaAlarmLib, line 371 } // library marker kkossev.tuyaAlarmLib, line 372 def sendTuyaAlarm( commandName ) { // library marker kkossev.tuyaAlarmLib, line 374 logDebug "swithing alarm ${commandName} (presetBeepAndChimeSettings = ${settings?.presetBeepAndChimeSettings})" // library marker kkossev.tuyaAlarmLib, line 375 String cmds = "" // library marker kkossev.tuyaAlarmLib, line 376 state.lastTx["lastCommand"] = commandName // library marker kkossev.tuyaAlarmLib, line 377 def mode = settings?.presetBeepAndChimeSettings ?: "fast" // library marker kkossev.tuyaAlarmLib, line 378 switch (mode) { // library marker kkossev.tuyaAlarmLib, line 379 case "none" : // library marker kkossev.tuyaAlarmLib, line 380 if (commandName != "off") { // library marker kkossev.tuyaAlarmLib, line 381 sendSimpleTuyaCommand(0x00, isNeo() ? "6801000101" : "0D01000101") // library marker kkossev.tuyaAlarmLib, line 382 } // library marker kkossev.tuyaAlarmLib, line 383 else { // library marker kkossev.tuyaAlarmLib, line 384 sendSimpleTuyaCommand(0x00, isNeo() ? "6801000100" : "0D01000100") // library marker kkossev.tuyaAlarmLib, line 385 } // library marker kkossev.tuyaAlarmLib, line 386 break // library marker kkossev.tuyaAlarmLib, line 387 case "fast" : // library marker kkossev.tuyaAlarmLib, line 388 wakeUpTuya() // library marker kkossev.tuyaAlarmLib, line 389 if (commandName != "off") { // library marker kkossev.tuyaAlarmLib, line 390 // volume // library marker kkossev.tuyaAlarmLib, line 391 def volumeName = settings?.alarmSoundVolume ?: 'high' // library marker kkossev.tuyaAlarmLib, line 392 def volumeTuya = volumeNameOptions.indexOf(volumeName) // library marker kkossev.tuyaAlarmLib, line 393 if (volumeTuya >= 0 && volumeTuya <=2) { // library marker kkossev.tuyaAlarmLib, line 394 cmds += appendTuyaCommand( isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, DP_TYPE_ENUM, volumeTuya as int ) // library marker kkossev.tuyaAlarmLib, line 395 } // library marker kkossev.tuyaAlarmLib, line 396 // duration // library marker kkossev.tuyaAlarmLib, line 397 def durationTuya = safeToInt( settings?.alarmSoundDuration ) // library marker kkossev.tuyaAlarmLib, line 398 if (durationTuya >=1 && durationTuya <= TUYA_MAX_DURATION) { // library marker kkossev.tuyaAlarmLib, line 399 cmds += appendTuyaCommand( isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, DP_TYPE_VALUE, durationTuya as int ) // library marker kkossev.tuyaAlarmLib, line 400 } // library marker kkossev.tuyaAlarmLib, line 401 // melody // library marker kkossev.tuyaAlarmLib, line 402 def melodyName = settings?.alarmMelody ?: '12=Alarm Siren' // library marker kkossev.tuyaAlarmLib, line 403 def melodyTuya = melodiesOptions.indexOf(melodyName) // library marker kkossev.tuyaAlarmLib, line 404 if (melodyTuya >=0 && melodyTuya <= TUYA_MAX_MELODIES-1) { // library marker kkossev.tuyaAlarmLib, line 405 cmds += appendTuyaCommand( isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, DP_TYPE_ENUM, melodyTuya as int) // library marker kkossev.tuyaAlarmLib, line 406 } // library marker kkossev.tuyaAlarmLib, line 407 // play it // library marker kkossev.tuyaAlarmLib, line 408 unschedule(restoreDefaultSettings) // library marker kkossev.tuyaAlarmLib, line 409 cmds += appendTuyaCommand( isNeo() ? NEO_DP_ALARM : TUYA_DP_ALARM, DP_TYPE_BOOL, 1 ) // library marker kkossev.tuyaAlarmLib, line 410 sendZigbeeCommands( combinedTuyaCommands(cmds) ) // library marker kkossev.tuyaAlarmLib, line 411 } // library marker kkossev.tuyaAlarmLib, line 412 else { // library marker kkossev.tuyaAlarmLib, line 413 unschedule(restoreDefaultSettings) // library marker kkossev.tuyaAlarmLib, line 414 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_ALARM : TUYA_DP_ALARM, 2), DP_TYPE_BOOL, "00")) // library marker kkossev.tuyaAlarmLib, line 415 } // library marker kkossev.tuyaAlarmLib, line 416 break // library marker kkossev.tuyaAlarmLib, line 417 case "slow" : // library marker kkossev.tuyaAlarmLib, line 418 logWarn "NOT IMPLEMENTED!" // library marker kkossev.tuyaAlarmLib, line 419 break // library marker kkossev.tuyaAlarmLib, line 420 } // library marker kkossev.tuyaAlarmLib, line 421 } // library marker kkossev.tuyaAlarmLib, line 423 // capability "Tone" // library marker kkossev.tuyaAlarmLib, line 425 def beep() { // library marker kkossev.tuyaAlarmLib, line 426 String cmds = "" // library marker kkossev.tuyaAlarmLib, line 427 state.lastTx["lastCommand"] = "beep" // library marker kkossev.tuyaAlarmLib, line 428 logDebug "sending beep() beepVolume = ${settings?.beepVolume}" // library marker kkossev.tuyaAlarmLib, line 429 if (settings?.presetBeepAndChimeSettings == "none") { // library marker kkossev.tuyaAlarmLib, line 431 sendSimpleTuyaCommand(0x00, isNeo() ? "6801000101" : "0D01000101") // just turn the siren on! // TODO! // library marker kkossev.tuyaAlarmLib, line 432 } // library marker kkossev.tuyaAlarmLib, line 433 else { // library marker kkossev.tuyaAlarmLib, line 434 wakeUpTuya() // library marker kkossev.tuyaAlarmLib, line 435 Integer volumeTuya; Integer volumePct // library marker kkossev.tuyaAlarmLib, line 436 (volumeTuya, volumePct) = findVolumeByName(settings?.beepVolume ) // library marker kkossev.tuyaAlarmLib, line 437 if (volumeTuya >= 0 && volumeTuya <=2) { // library marker kkossev.tuyaAlarmLib, line 438 cmds += appendTuyaCommand( isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, DP_TYPE_ENUM, volumeTuya as int) // library marker kkossev.tuyaAlarmLib, line 439 } // library marker kkossev.tuyaAlarmLib, line 440 else { // library marker kkossev.tuyaAlarmLib, line 441 logWarn "volumeTuya <=2 is ${volumeTuya}, added cmds=${cmds} " // library marker kkossev.tuyaAlarmLib, line 442 } // library marker kkossev.tuyaAlarmLib, line 443 cmds += appendTuyaCommand( isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, DP_TYPE_VALUE, 1 ) // library marker kkossev.tuyaAlarmLib, line 444 cmds += appendTuyaCommand( isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, DP_TYPE_ENUM, 2 ) // library marker kkossev.tuyaAlarmLib, line 445 unschedule(restoreDefaultSettings) // library marker kkossev.tuyaAlarmLib, line 446 cmds += appendTuyaCommand( isNeo() ? NEO_DP_ALARM : TUYA_DP_ALARM, DP_TYPE_BOOL, 1 ) // library marker kkossev.tuyaAlarmLib, line 447 sendZigbeeCommands( combinedTuyaCommands(cmds) ) // library marker kkossev.tuyaAlarmLib, line 448 } // library marker kkossev.tuyaAlarmLib, line 449 } // library marker kkossev.tuyaAlarmLib, line 450 def restoreDefaultSettings() { // library marker kkossev.tuyaAlarmLib, line 452 wakeUpTuya() // library marker kkossev.tuyaAlarmLib, line 453 String cmds = "" // library marker kkossev.tuyaAlarmLib, line 454 // restore alarm volume // library marker kkossev.tuyaAlarmLib, line 455 def volumeName = settings?.alarmSoundVolume ?: 'high' // library marker kkossev.tuyaAlarmLib, line 456 def volumeTuya = volumeNameOptions.indexOf(volumeName) // library marker kkossev.tuyaAlarmLib, line 457 if (volumeTuya >= 0 && volumeTuya <=2) { // library marker kkossev.tuyaAlarmLib, line 458 cmds += appendTuyaCommand( isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, DP_TYPE_ENUM, volumeTuya as int ) // library marker kkossev.tuyaAlarmLib, line 459 } // library marker kkossev.tuyaAlarmLib, line 460 // restore alarm duration // library marker kkossev.tuyaAlarmLib, line 461 def durationTuya = safeToInt(settings?.alarmSoundDuration, TUYA_MAX_DURATION) // library marker kkossev.tuyaAlarmLib, line 462 if (durationTuya >=1 && durationTuya <= TUYA_MAX_DURATION) { // library marker kkossev.tuyaAlarmLib, line 463 cmds += appendTuyaCommand( isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, DP_TYPE_VALUE, durationTuya as int ) // library marker kkossev.tuyaAlarmLib, line 464 } // library marker kkossev.tuyaAlarmLib, line 465 // restore alarm melody // library marker kkossev.tuyaAlarmLib, line 466 def melodyName = settings?.alarmMelody ?: '12=Alarm Siren' // library marker kkossev.tuyaAlarmLib, line 467 def melodyTuya = melodiesOptions.indexOf(melodyName) // library marker kkossev.tuyaAlarmLib, line 468 if (melodyTuya >=0 && melodyTuya <= TUYA_MAX_MELODIES-1) { // library marker kkossev.tuyaAlarmLib, line 469 cmds += appendTuyaCommand( isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, DP_TYPE_ENUM, melodyTuya as int) // library marker kkossev.tuyaAlarmLib, line 470 } // library marker kkossev.tuyaAlarmLib, line 471 logDebug "restoring default settings volume=${volumeName}, duration=${durationTuya}, melody=${melodyName}" // library marker kkossev.tuyaAlarmLib, line 472 sendZigbeeCommands( combinedTuyaCommands(cmds) ) // library marker kkossev.tuyaAlarmLib, line 473 } // library marker kkossev.tuyaAlarmLib, line 474 //capability "AudioVolume" //Attributes: mute - ENUM ["unmuted", "muted"] volume - NUMBER, unit:%; Commands: mute() setVolume(volumelevel) volumelevel required (NUMBER) - Volume level (0 to 100) unmute() volumeDown() volumeUp() // library marker kkossev.tuyaAlarmLib, line 476 def mute() { // library marker kkossev.tuyaAlarmLib, line 477 sendEvent(name: "mute", value: "muted", type: "digital") // library marker kkossev.tuyaAlarmLib, line 478 } // library marker kkossev.tuyaAlarmLib, line 479 def unmute() { // library marker kkossev.tuyaAlarmLib, line 481 sendEvent(name: "mute", value: "unmuted", type: "digital") // library marker kkossev.tuyaAlarmLib, line 482 } // library marker kkossev.tuyaAlarmLib, line 483 def getNearestTuyaVolumeLevel( volumelevel ) { // library marker kkossev.tuyaAlarmLib, line 485 def nearestlevel = 0 // library marker kkossev.tuyaAlarmLib, line 486 if (volumelevel <= 33) nearestlevel = 33 // library marker kkossev.tuyaAlarmLib, line 487 else if (volumelevel <= 66) nearestlevel = 66 // library marker kkossev.tuyaAlarmLib, line 488 else nearestlevel = 100 // library marker kkossev.tuyaAlarmLib, line 489 return nearestlevel // library marker kkossev.tuyaAlarmLib, line 490 } // library marker kkossev.tuyaAlarmLib, line 491 def setVolumeLevel( volumelevel ) { // library marker kkossev.tuyaAlarmLib, line 493 // - Volume level (0 to 100) // library marker kkossev.tuyaAlarmLib, line 494 String cmds = "" // library marker kkossev.tuyaAlarmLib, line 495 def nearestlevel = getNearestTuyaVolumeLevel( volumelevel ) // library marker kkossev.tuyaAlarmLib, line 496 if (nearestlevel == 0 && device.currentValue("mute", true) == "unmuted") mute() // library marker kkossev.tuyaAlarmLib, line 497 else if (nearestlevel != 0 && device.currentValue("mute", true) == "muted") unmute() // library marker kkossev.tuyaAlarmLib, line 498 def volumeName // library marker kkossev.tuyaAlarmLib, line 499 def volumeTuya // library marker kkossev.tuyaAlarmLib, line 500 (volumeName, volumeTuya) = findVolumeByPct( nearestlevel ) // library marker kkossev.tuyaAlarmLib, line 501 logDebug "matched volumelevel=${volumelevel} to nearestLlevel=${nearestlevel} (volumeTuya=${volumeTuya})" // library marker kkossev.tuyaAlarmLib, line 502 if (settings?.presetBeepAndChimeSettings == "none") { // library marker kkossev.tuyaAlarmLib, line 504 switch(volumeName) { // library marker kkossev.tuyaAlarmLib, line 505 case "high": // library marker kkossev.tuyaAlarmLib, line 506 sendSimpleTuyaCommand(0x00, "0504000102") // library marker kkossev.tuyaAlarmLib, line 507 break // library marker kkossev.tuyaAlarmLib, line 508 case "medium": // library marker kkossev.tuyaAlarmLib, line 509 sendSimpleTuyaCommand(0x00, "0504000101") // library marker kkossev.tuyaAlarmLib, line 510 break // library marker kkossev.tuyaAlarmLib, line 511 default: // library marker kkossev.tuyaAlarmLib, line 512 sendSimpleTuyaCommand(0x00, "0504000100") // library marker kkossev.tuyaAlarmLib, line 513 break // library marker kkossev.tuyaAlarmLib, line 514 } // library marker kkossev.tuyaAlarmLib, line 515 } // library marker kkossev.tuyaAlarmLib, line 516 else { // library marker kkossev.tuyaAlarmLib, line 517 //state.volume = nearestlevel // library marker kkossev.tuyaAlarmLib, line 518 if (safeToInt(volumeTuya) >= 0) { // library marker kkossev.tuyaAlarmLib, line 519 cmds += appendTuyaCommand( isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, DP_TYPE_ENUM, safeToInt(volumeTuya) ) // library marker kkossev.tuyaAlarmLib, line 520 } // library marker kkossev.tuyaAlarmLib, line 521 logDebug "setting volume=${volumeName}" // library marker kkossev.tuyaAlarmLib, line 522 sendZigbeeCommands( combinedTuyaCommands(cmds) ) // library marker kkossev.tuyaAlarmLib, line 523 } // library marker kkossev.tuyaAlarmLib, line 524 } // library marker kkossev.tuyaAlarmLib, line 525 def volumeDown() { // library marker kkossev.tuyaAlarmLib, line 527 setVolumeLevel( (device.currentValue("volume") ?: 0 ) - 34) // library marker kkossev.tuyaAlarmLib, line 528 } // library marker kkossev.tuyaAlarmLib, line 529 def volumeUp() { // library marker kkossev.tuyaAlarmLib, line 531 setVolumeLevel( (device.currentValue("volume") ?: 0 ) + 33) // library marker kkossev.tuyaAlarmLib, line 532 } // library marker kkossev.tuyaAlarmLib, line 533 def playSound(soundnumberPar=null, volumeLevelPar=null, durationPar=null) { // library marker kkossev.tuyaAlarmLib, line 535 logWarn "playSound: soundnumberPar=${soundnumberPar} volumeLevelPar=${volumeLevelPar} durationPar=${durationPar}" // library marker kkossev.tuyaAlarmLib, line 536 def soundnumber = safeToInt(soundnumberPar) // library marker kkossev.tuyaAlarmLib, line 537 def volumeLevel = safeToInt(volumeLevelPar) // library marker kkossev.tuyaAlarmLib, line 538 def duration = safeToInt(durationPar) // library marker kkossev.tuyaAlarmLib, line 539 wakeUpTuya() // library marker kkossev.tuyaAlarmLib, line 540 String cmds = "" // library marker kkossev.tuyaAlarmLib, line 541 def volumeName; def volumeTuya; def volumePct // library marker kkossev.tuyaAlarmLib, line 542 if (soundnumber == null || soundnumber <= 0) { // use the default melody // library marker kkossev.tuyaAlarmLib, line 543 soundnumber = melodiesOptions.indexOf(settings?.playSoundMelody ?: TUYA_DEFAULT_MELODY_NAME ) + 1 // library marker kkossev.tuyaAlarmLib, line 544 logWarn "playSound: using the default soundnumber ${soundnumber}" // library marker kkossev.tuyaAlarmLib, line 545 } // library marker kkossev.tuyaAlarmLib, line 546 int soundNumberIndex = safeToInt(soundnumber) // library marker kkossev.tuyaAlarmLib, line 547 soundNumberIndex = soundNumberIndex < 1 ? 1 : soundNumberIndex > TUYA_MAX_MELODIES ? TUYA_MAX_MELODIES : soundNumberIndex; // library marker kkossev.tuyaAlarmLib, line 548 soundNumberIndex -= 1 // Tuya parameter is zero based ! // library marker kkossev.tuyaAlarmLib, line 549 // // library marker kkossev.tuyaAlarmLib, line 550 if (volumeLevel == null || volumeLevel <= 0) { // use the default playSoundVolume // library marker kkossev.tuyaAlarmLib, line 551 volumeName = settings?.playSoundVolume ?: TUYA_DEFAULT_VOLUME_NAME // library marker kkossev.tuyaAlarmLib, line 552 (volumeTuya, volumePct) = findVolumeByName( volumeName ) // library marker kkossev.tuyaAlarmLib, line 553 logWarn "playSound: using default Chime volume ${volumeName} (${volumeTuya})" // library marker kkossev.tuyaAlarmLib, line 554 } // library marker kkossev.tuyaAlarmLib, line 555 else { // library marker kkossev.tuyaAlarmLib, line 556 def nearestVolume = getNearestTuyaVolumeLevel( volumeLevel ) // library marker kkossev.tuyaAlarmLib, line 557 (volumeName, volumeTuya) = findVolumeByPct( nearestVolume ) // library marker kkossev.tuyaAlarmLib, line 558 } // library marker kkossev.tuyaAlarmLib, line 559 // // library marker kkossev.tuyaAlarmLib, line 560 if (duration == null || duration <= 0) { // library marker kkossev.tuyaAlarmLib, line 561 duration = settings?.playSoundDuration ?: TUYA_DEFAULT_DURATION as int // library marker kkossev.tuyaAlarmLib, line 562 logWarn "playSound: using the default duration ${duration}" // library marker kkossev.tuyaAlarmLib, line 563 } // library marker kkossev.tuyaAlarmLib, line 564 else { // library marker kkossev.tuyaAlarmLib, line 565 duration = duration <1 ? 1 : duration > TUYA_MAX_DURATION ? TUYA_MAX_DURATION : duration as int // library marker kkossev.tuyaAlarmLib, line 566 } // library marker kkossev.tuyaAlarmLib, line 567 if (volumeTuya < 0) { // library marker kkossev.tuyaAlarmLib, line 568 volumeTuya = 1 // medium // library marker kkossev.tuyaAlarmLib, line 569 logWarn "playSound: using the default volumeTuya ${volumeTuya}" // library marker kkossev.tuyaAlarmLib, line 570 } // library marker kkossev.tuyaAlarmLib, line 571 state.lastTx["lastCommand"] = "playSound" // library marker kkossev.tuyaAlarmLib, line 572 cmds += appendTuyaCommand( isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, DP_TYPE_ENUM, safeToInt(volumeTuya)) // library marker kkossev.tuyaAlarmLib, line 573 cmds += appendTuyaCommand( isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, DP_TYPE_VALUE, safeToInt(duration) ) // library marker kkossev.tuyaAlarmLib, line 574 cmds += appendTuyaCommand( isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, DP_TYPE_ENUM, soundNumberIndex) // library marker kkossev.tuyaAlarmLib, line 575 unschedule(restoreDefaultSettings) // library marker kkossev.tuyaAlarmLib, line 576 cmds += appendTuyaCommand( isNeo() ? NEO_DP_ALARM : TUYA_DP_ALARM, DP_TYPE_BOOL, 1 ) // library marker kkossev.tuyaAlarmLib, line 577 logDebug "playSound ${soundnumber} (${melodiesOptions.get(soundNumberIndex)}) index=${soundNumberIndex}, duration=${duration}, volume=${volumeName}(${volumeTuya})" // library marker kkossev.tuyaAlarmLib, line 578 sendZigbeeCommands( combinedTuyaCommands(cmds) ) // library marker kkossev.tuyaAlarmLib, line 579 } // library marker kkossev.tuyaAlarmLib, line 580 def stop() { // library marker kkossev.tuyaAlarmLib, line 582 off() // library marker kkossev.tuyaAlarmLib, line 583 } // library marker kkossev.tuyaAlarmLib, line 584 // capability "MusicPlayer" // library marker kkossev.tuyaAlarmLib, line 586 def pause() { // library marker kkossev.tuyaAlarmLib, line 587 } // library marker kkossev.tuyaAlarmLib, line 588 def play() { // library marker kkossev.tuyaAlarmLib, line 590 } // library marker kkossev.tuyaAlarmLib, line 591 def sendVolumeEvent( volume, isDigital=false ) { // library marker kkossev.tuyaAlarmLib, line 593 def map = [:] // library marker kkossev.tuyaAlarmLib, line 594 map.name = "volume" // library marker kkossev.tuyaAlarmLib, line 595 map.value = volume // library marker kkossev.tuyaAlarmLib, line 596 map.unit = "%" // library marker kkossev.tuyaAlarmLib, line 597 map.type = isDigital == true ? "digital" : "physical" // library marker kkossev.tuyaAlarmLib, line 598 map.descriptionText = "${map.name} is ${map.value}" // library marker kkossev.tuyaAlarmLib, line 599 if (((device.currentValue("volume") ?: 0 ) as int) != (volume as int)) { // library marker kkossev.tuyaAlarmLib, line 600 if (txtEnable) {log.info "${device.displayName} ${map.descriptionText}"} // library marker kkossev.tuyaAlarmLib, line 601 } // library marker kkossev.tuyaAlarmLib, line 602 sendEvent(map) // library marker kkossev.tuyaAlarmLib, line 603 } // library marker kkossev.tuyaAlarmLib, line 604 def sendAlarmEvent( mode, isDigital=false ) { // library marker kkossev.tuyaAlarmLib, line 606 def map = [:] // library marker kkossev.tuyaAlarmLib, line 607 map.name = "alarm" // library marker kkossev.tuyaAlarmLib, line 608 map.value = mode // library marker kkossev.tuyaAlarmLib, line 609 //map.unit = "Hz" // library marker kkossev.tuyaAlarmLib, line 610 map.type = isDigital == true ? "digital" : "physical" // library marker kkossev.tuyaAlarmLib, line 611 map.descriptionText = "${map.name} is ${map.value}" // library marker kkossev.tuyaAlarmLib, line 612 if (txtEnable) {log.info "${device.displayName} ${map.descriptionText}"} // library marker kkossev.tuyaAlarmLib, line 613 sendEvent(map) // library marker kkossev.tuyaAlarmLib, line 614 sendEvent(name: "switch", value: mode=="off"?"off":"on", descriptionText: map.descriptionText, type:"digital") // library marker kkossev.tuyaAlarmLib, line 615 } // library marker kkossev.tuyaAlarmLib, line 616 // TODO - use the main code! // library marker kkossev.tuyaAlarmLib, line 618 def sendTemperatureEvent( temperature, isDigital=false ) { // library marker kkossev.tuyaAlarmLib, line 619 def map = [:] // library marker kkossev.tuyaAlarmLib, line 620 map.name = "temperature" // library marker kkossev.tuyaAlarmLib, line 621 def Scale = location.temperatureScale // library marker kkossev.tuyaAlarmLib, line 622 if (Scale == "F") { // library marker kkossev.tuyaAlarmLib, line 623 temperature = (temperature * 1.8) + 32 // library marker kkossev.tuyaAlarmLib, line 624 map.unit = "\u00B0"+"F" // library marker kkossev.tuyaAlarmLib, line 625 } // library marker kkossev.tuyaAlarmLib, line 626 else { // library marker kkossev.tuyaAlarmLib, line 627 map.unit = "\u00B0"+"C" // library marker kkossev.tuyaAlarmLib, line 628 } // library marker kkossev.tuyaAlarmLib, line 629 def tempCorrected = temperature // library marker kkossev.tuyaAlarmLib, line 630 map.value = Math.round((tempCorrected - 0.05) * 10) / 10 // library marker kkossev.tuyaAlarmLib, line 631 map.type = isDigital == true ? "digital" : "physical" // library marker kkossev.tuyaAlarmLib, line 632 map.descriptionText = "${map.name} is ${tempCorrected} ${map.unit}" // library marker kkossev.tuyaAlarmLib, line 633 if (settings?.txtEnable) {log.info "${device.displayName} ${map.descriptionText}"} // library marker kkossev.tuyaAlarmLib, line 634 sendEvent(map) // library marker kkossev.tuyaAlarmLib, line 635 } // library marker kkossev.tuyaAlarmLib, line 636 // TODO - use the main code! // library marker kkossev.tuyaAlarmLib, line 638 def sendHumidityEvent( humidity, isDigital=false ) { // library marker kkossev.tuyaAlarmLib, line 639 def map = [:] // library marker kkossev.tuyaAlarmLib, line 640 def humidityAsDouble = safeToDouble(humidity) +safeToDouble(settings?.humidityOffset) // library marker kkossev.tuyaAlarmLib, line 641 humidityAsDouble = humidityAsDouble < 0.0 ? 0.0 : humidityAsDouble > 100.0 ? 100.0 : humidityAsDouble // library marker kkossev.tuyaAlarmLib, line 642 map.value = Math.round(humidityAsDouble) // library marker kkossev.tuyaAlarmLib, line 643 map.name = "humidity" // library marker kkossev.tuyaAlarmLib, line 644 map.unit = "% RH" // library marker kkossev.tuyaAlarmLib, line 645 map.type = isDigital == true ? "digital" : "physical" // library marker kkossev.tuyaAlarmLib, line 646 map.isStateChange = true // library marker kkossev.tuyaAlarmLib, line 647 map.descriptionText = "${map.name} is ${humidityAsDouble.round(1)} ${map.unit}" // library marker kkossev.tuyaAlarmLib, line 648 if (settings?.txtEnable) {log.info "${device.displayName} ${map.descriptionText}"} // library marker kkossev.tuyaAlarmLib, line 649 sendEvent(map) // library marker kkossev.tuyaAlarmLib, line 650 } // library marker kkossev.tuyaAlarmLib, line 651 void setMelody( alarmType, melodyNumber ) { // library marker kkossev.tuyaAlarmLib, line 654 int index = safeToInt( melodyNumber ) // library marker kkossev.tuyaAlarmLib, line 655 if (index < 1 || index> TUYA_MAX_MELODIES) { // library marker kkossev.tuyaAlarmLib, line 656 logWarn "melody number must be between 1 and ${TUYA_MAX_MELODIES}" // library marker kkossev.tuyaAlarmLib, line 657 return // library marker kkossev.tuyaAlarmLib, line 658 } // library marker kkossev.tuyaAlarmLib, line 659 index = index - 1 // library marker kkossev.tuyaAlarmLib, line 660 if (alarmType == 'alarm') { // library marker kkossev.tuyaAlarmLib, line 661 device.updateSetting("alarmMelody", [value:melodiesOptions[index], type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 662 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, 2), DP_TYPE_ENUM, zigbee.convertToHexString(index, 2))) // library marker kkossev.tuyaAlarmLib, line 663 } // library marker kkossev.tuyaAlarmLib, line 664 else if (alarmType == 'chime') { // library marker kkossev.tuyaAlarmLib, line 665 device.updateSetting("playSoundMelody", [value:melodiesOptions[index], type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 666 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_MELODY :TUYA_DP_MELODY, 2), DP_TYPE_ENUM, zigbee.convertToHexString(index, 2))) // library marker kkossev.tuyaAlarmLib, line 667 } // library marker kkossev.tuyaAlarmLib, line 668 else { // library marker kkossev.tuyaAlarmLib, line 669 logWarn "alarmType must be one of ${soundTypeOptions}" // library marker kkossev.tuyaAlarmLib, line 670 return // library marker kkossev.tuyaAlarmLib, line 671 } // library marker kkossev.tuyaAlarmLib, line 672 logDebug "setMelody ${alarmType} ${melodiesOptions[index]} (${index})" // library marker kkossev.tuyaAlarmLib, line 673 } // library marker kkossev.tuyaAlarmLib, line 674 void setDuration( alarmType, alarmLength) { // library marker kkossev.tuyaAlarmLib, line 676 int duration = safeToInt( alarmLength ) // library marker kkossev.tuyaAlarmLib, line 677 if (duration > TUYA_MAX_DURATION) duration = TUYA_MAX_DURATION // library marker kkossev.tuyaAlarmLib, line 678 if (duration < 1 ) duration = 1 // library marker kkossev.tuyaAlarmLib, line 679 logDebug "setAlarmDuration ${duration}" // library marker kkossev.tuyaAlarmLib, line 680 if (alarmType == 'alarm') { // library marker kkossev.tuyaAlarmLib, line 681 device.updateSetting("alarmSoundDuration", [value:duration, type:"number"]) // library marker kkossev.tuyaAlarmLib, line 682 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, 2), DP_TYPE_VALUE, zigbee.convertToHexString(duration, 8))) // library marker kkossev.tuyaAlarmLib, line 683 } // library marker kkossev.tuyaAlarmLib, line 684 else if (alarmType == 'chime') { // library marker kkossev.tuyaAlarmLib, line 685 device.updateSetting("playSoundDuration", [value:duration, type:"number"]) // library marker kkossev.tuyaAlarmLib, line 686 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_DURATION : TUYA_DP_DURATION, 2), DP_TYPE_VALUE, zigbee.convertToHexString(duration, 8))) // library marker kkossev.tuyaAlarmLib, line 687 } // library marker kkossev.tuyaAlarmLib, line 688 else { // library marker kkossev.tuyaAlarmLib, line 689 logWarn "alarmType must be one of ${soundTypeOptions}" // library marker kkossev.tuyaAlarmLib, line 690 } // library marker kkossev.tuyaAlarmLib, line 691 } // library marker kkossev.tuyaAlarmLib, line 692 void setVolume( volumeType, volumeName) { // library marker kkossev.tuyaAlarmLib, line 694 if (!(volumeType in volumeTypeOptions)) { // library marker kkossev.tuyaAlarmLib, line 695 logWarn "setVolume not supported type ${volumeType}, must be one of ${volumeTypeOptions}" // library marker kkossev.tuyaAlarmLib, line 696 return // library marker kkossev.tuyaAlarmLib, line 697 } // library marker kkossev.tuyaAlarmLib, line 698 if (!(volumeName in volumeNameOptions)) { // library marker kkossev.tuyaAlarmLib, line 699 logWarn "setVolume not supported type ${volumeType}, must be one of ${volumeNameOptions}" // library marker kkossev.tuyaAlarmLib, line 700 return // library marker kkossev.tuyaAlarmLib, line 701 } // library marker kkossev.tuyaAlarmLib, line 702 def volumePct = volumeMapping[volumeName].find{it.key=='volume'}.value // library marker kkossev.tuyaAlarmLib, line 703 def tuyaValue = volumeMapping[volumeName].find{it.key=='tuya'}.value // library marker kkossev.tuyaAlarmLib, line 704 //log.trace "volumeType=${volumeType} volumeName=${volumeName} volumePct=${volumePct}, tuyaValue=${tuyaValue} " // library marker kkossev.tuyaAlarmLib, line 705 switch (volumeName) { // library marker kkossev.tuyaAlarmLib, line 706 case "muted" : // library marker kkossev.tuyaAlarmLib, line 707 mute() // library marker kkossev.tuyaAlarmLib, line 708 return // library marker kkossev.tuyaAlarmLib, line 709 case "low" : // library marker kkossev.tuyaAlarmLib, line 710 case "medium" : // library marker kkossev.tuyaAlarmLib, line 711 case "high" : // library marker kkossev.tuyaAlarmLib, line 712 sendZigbeeCommands( sendTuyaCommand(zigbee.convertToHexString(isNeo() ? NEO_DP_VOLUME : TUYA_DP_VOLUME, 2), DP_TYPE_ENUM, zigbee.convertToHexString(tuyaValue as int, 2))) // library marker kkossev.tuyaAlarmLib, line 713 break // library marker kkossev.tuyaAlarmLib, line 714 default : // library marker kkossev.tuyaAlarmLib, line 715 logWarn "setVolume not supported parameter ${volume}" // library marker kkossev.tuyaAlarmLib, line 716 return // library marker kkossev.tuyaAlarmLib, line 717 } // library marker kkossev.tuyaAlarmLib, line 718 unmute() // library marker kkossev.tuyaAlarmLib, line 719 logDebug "setVolume ${volumeType} ${volumeName} ${volumePct}% (Tuya:${tuyaValue})" // library marker kkossev.tuyaAlarmLib, line 720 } // library marker kkossev.tuyaAlarmLib, line 721 def configureDeviceAlarm() { // library marker kkossev.tuyaAlarmLib, line 732 ArrayList cmds = [] // library marker kkossev.tuyaAlarmLib, line 733 logDebug 'configureDeviceAlarm() ' // library marker kkossev.tuyaAlarmLib, line 734 /* // library marker kkossev.tuyaAlarmLib, line 735 // https://forum.phoscon.de/t/aqara-tvoc-zhaairquality-data/1160/21 // library marker kkossev.tuyaAlarmLib, line 736 final int tScale = (settings.temperatureScale as Integer) ?: TemperatureScaleOpts.defaultValue // library marker kkossev.tuyaAlarmLib, line 737 final int tUnit = (settings.tVocUnut as Integer) ?: TvocUnitOpts.defaultValue // library marker kkossev.tuyaAlarmLib, line 738 logDebug "setting temperatureScale to ${TemperatureScaleOpts.options[tScale]} (${tScale})" // library marker kkossev.tuyaAlarmLib, line 739 int cfg = tUnit // library marker kkossev.tuyaAlarmLib, line 740 cfg |= (tScale << 4) // library marker kkossev.tuyaAlarmLib, line 741 cmds += zigbee.writeAttribute(0xFCC0, 0x0114, DataType.UINT8, cfg, [mfgCode: 0x115F], delay=200) // library marker kkossev.tuyaAlarmLib, line 742 cmds += zigbee.readAttribute(0xFCC0, 0x0114, [mfgCode: 0x115F], delay=200) // library marker kkossev.tuyaAlarmLib, line 743 */ // library marker kkossev.tuyaAlarmLib, line 744 return cmds // library marker kkossev.tuyaAlarmLib, line 745 } // library marker kkossev.tuyaAlarmLib, line 746 def initializeDeviceAlarm() { // library marker kkossev.tuyaAlarmLib, line 749 ArrayList cmds = [] // library marker kkossev.tuyaAlarmLib, line 750 // nothing to initialize? // library marker kkossev.tuyaAlarmLib, line 751 return cmds // library marker kkossev.tuyaAlarmLib, line 752 } // library marker kkossev.tuyaAlarmLib, line 753 void updatedAlarm() { // library marker kkossev.tuyaAlarmLib, line 755 if (isVINDSTYRKA()) { // library marker kkossev.tuyaAlarmLib, line 756 final int intervalAirQuality = (settings.airQualityIndexCheckInterval as Integer) ?: 0 // library marker kkossev.tuyaAlarmLib, line 757 if (intervalAirQuality > 0) { // library marker kkossev.tuyaAlarmLib, line 758 logInfo "updatedAirQuality: scheduling Air Quality Index check every ${intervalAirQuality} seconds" // library marker kkossev.tuyaAlarmLib, line 759 scheduleAirQualityIndexCheck(intervalAirQuality) // library marker kkossev.tuyaAlarmLib, line 760 } // library marker kkossev.tuyaAlarmLib, line 761 else { // library marker kkossev.tuyaAlarmLib, line 762 unScheduleAirQualityIndexCheck() // library marker kkossev.tuyaAlarmLib, line 763 logInfo "updatedAirQuality: Air Quality Index polling is disabled!" // library marker kkossev.tuyaAlarmLib, line 764 // 09/02/2023 // library marker kkossev.tuyaAlarmLib, line 765 device.deleteCurrentState("airQualityIndex") // library marker kkossev.tuyaAlarmLib, line 766 } // library marker kkossev.tuyaAlarmLib, line 767 } // library marker kkossev.tuyaAlarmLib, line 769 else { // library marker kkossev.tuyaAlarmLib, line 770 logDebug "updatedAirQuality: skipping airQuality polling " // library marker kkossev.tuyaAlarmLib, line 771 } // library marker kkossev.tuyaAlarmLib, line 772 } // library marker kkossev.tuyaAlarmLib, line 773 def refreshAlarm() { // library marker kkossev.tuyaAlarmLib, line 775 List cmds = [] // library marker kkossev.tuyaAlarmLib, line 776 if (isAqaraTVOC()) { // library marker kkossev.tuyaAlarmLib, line 777 // TODO - check what is available for VINDSTYRKA // library marker kkossev.tuyaAlarmLib, line 778 cmds += zigbee.readAttribute(0x042a, 0x0000, [:], delay=200) // pm2.5 attributes: (float) 0: Measured Value; 1: Min Measured Value; 2:Max Measured Value; 3:Tolerance // library marker kkossev.tuyaAlarmLib, line 779 cmds += zigbee.readAttribute(0xfc7e, 0x0000, [mfgCode: 0x117c], delay=200) // tVOC !! mfcode="0x117c" !! attributes: (float) 0: Measured Value; 1: Min Measured Value; 2:Max Measured Value; // library marker kkossev.tuyaAlarmLib, line 780 } // library marker kkossev.tuyaAlarmLib, line 781 else if (false) { // library marker kkossev.tuyaAlarmLib, line 782 // TODO - check what is available for Aqara // library marker kkossev.tuyaAlarmLib, line 783 } // library marker kkossev.tuyaAlarmLib, line 784 else { // library marker kkossev.tuyaAlarmLib, line 785 // TODO - unknown AirQuaility sensor - try all ?? // library marker kkossev.tuyaAlarmLib, line 786 } // library marker kkossev.tuyaAlarmLib, line 787 logDebug "refreshAirQuality() : ${cmds}" // library marker kkossev.tuyaAlarmLib, line 789 return cmds // library marker kkossev.tuyaAlarmLib, line 790 } // library marker kkossev.tuyaAlarmLib, line 791 def initVarsAlarm(boolean fullInit=false) { // library marker kkossev.tuyaAlarmLib, line 793 logDebug "initVarsAlarm(${fullInit})" // library marker kkossev.tuyaAlarmLib, line 794 device.updateSetting("beepVolume", [value:"low", type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 795 device.updateSetting("alarmMelody", [value:'12=Alarm Siren', type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 796 device.updateSetting("alarmSoundVolume", [value:'high', type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 797 device.updateSetting("alarmSoundDuration", [value:TUYA_MAX_DURATION, type:"number"]) // library marker kkossev.tuyaAlarmLib, line 798 device.updateSetting("playSoundMelody", [value:TUYA_DEFAULT_MELODY_NAME, type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 799 device.updateSetting("playSoundVolume", [value: TUYA_DEFAULT_VOLUME_NAME, type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 800 device.updateSetting("playSoundDuration", [value:TUYA_DEFAULT_DURATION, type:"number"]) // library marker kkossev.tuyaAlarmLib, line 801 device.updateSetting("restoreAlarmSettings", false) // library marker kkossev.tuyaAlarmLib, line 802 device.updateSetting("presetBeepAndChimeSettings", [value: "fast", type:"enum"]) // library marker kkossev.tuyaAlarmLib, line 803 } // library marker kkossev.tuyaAlarmLib, line 804 void initEventsAlarm(boolean fullInit=false) { // library marker kkossev.tuyaAlarmLib, line 806 // nothing to do ? // library marker kkossev.tuyaAlarmLib, line 807 unmute() // library marker kkossev.tuyaAlarmLib, line 808 } // library marker kkossev.tuyaAlarmLib, line 809 // ~~~~~ end include (138) kkossev.tuyaAlarmLib ~~~~~