/** * Aqara E1 Thermostat - 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-09 kkossev - buttonDimmerLib library; added IKEA Styrbar E2001/E2002, IKEA on/off switch E1743, IKEA remote control E1810; added Identify cluster; Ranamed 'Zigbee Button Dimmer'; bugfix - Styrbar ignore button 1; IKEA RODRET E2201 key #4 changed to key #2; added IKEA TRADFRI open/close remote E1766; added thermostatLib; added xiaomiLib * ver. 2.1.5 2023-11-03 kkossev - (dev. branch) Aqara E1 thermostat; added deviceProfileLib; * * TODO: auto turn off Debug messages 15 seconds after installing the new device * TODO: Aqara TVOC: implement battery level/percentage * TODO: check catchall: 0000 0006 00 00 0040 00 E51C 00 00 0000 00 00 01FDFF040101190000 (device object UNKNOWN_CLUSTER (0x0006) error: 0xFD) * 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/11/04 11:26 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 @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', //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_E1_Thermostat_lib_included.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', 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"]) { capability "Actuator" } if (deviceType in ["Device", "THSensor", "LightSensor", "MotionSensor",/* "AirQuality",*/ "Thermostat", "Fingerbot", "ButtonDimmer", "AqaraCube", "IRBlaster"]) { 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"]) { capability "Switch" if (_THREE_STATE == true) { attribute "switch", "enum", SwitchThreeStateOpts.options.values() as List } } if (deviceType in ["Dimmer", "ButtonDimmer"]) { capability "SwitchLevel" } /* if (deviceType in ["Fingerbot"]) { capability "PushableButton" } */ 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 ["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'] } def isAqaraTVOC() { (device?.getDataValue('model') ?: 'n/a') in ['lumi.airmonitor.acn01'] } 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 0x0102 : // window covering parseWindowCoveringCluster(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 0xFCC0 : // XIAOMI_CLUSTER_ID 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.clusterId} 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. * ----------------------------------------------------------------------------- */ void parseXiaomiCluster(final Map descMap) { if (xiaomiLibVersion() != null) { parseXiaomiClusterLib(descMap) } else { logWarn "Xiaomi cluster 0xFCC0" } } /* @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 */ // TODO - move to xiaomiLib // TODO - move to thermostatLib // TODO - move to aqaraQubeLib @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 ) { if ((batteryPercent as int) == 255) { logWarn "ignoring battery report raw=${batteryPercent}" return } 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 ["Thermostat"]) { thermostatOff(); 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 ["Thermostat"]) { thermostatOn(); 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})" if (DEVICE_TYPE in ["ButtonDimmer"]) { setLevelButtonDimmer(value, transitionTime); return } else { 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 * ----------------------------------------------------------------------------- */ void parsePm25Cluster(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()) //logDebug "pm25 float value = ${floatValue}" handlePm25Event(floatValue as Integer) } void handlePm25Event( Integer pm25, Boolean isDigital=false ) { def eventMap = [:] if (state.stats != null) state.stats['pm25Ctr'] = (state.stats['pm25Ctr'] ?: 0) + 1 else state.stats=[:] double pm25AsDouble = safeToDouble(pm25) + safeToDouble(settings?.pm25Offset ?: 0) if (pm25AsDouble <= 0.0 || pm25AsDouble > 999.0) { logWarn "ignored invalid pm25 ${pm25} (${pm25AsDouble})" return } eventMap.value = Math.round(pm25AsDouble) eventMap.name = "pm25" eventMap.unit = "\u03BCg/m3" //"mg/m3" eventMap.type = isDigital == true ? "digital" : "physical" eventMap.isStateChange = true eventMap.descriptionText = "${eventMap.name} is ${pm25AsDouble.round()} ${eventMap.unit}" Integer timeElapsed = Math.round((now() - (state.lastRx['pm25Time'] ?: now()))/1000) Integer minTime = settings?.minReportingTimePm25 ?: DEFAULT_MIN_REPORTING_TIME Integer timeRamaining = (minTime - timeElapsed) as Integer if (timeElapsed >= minTime) { logInfo "${eventMap.descriptionText}" unschedule("sendDelayedPm25Event") state.lastRx['pm25Time'] = now() sendEvent(eventMap) } else { eventMap.type = "delayed" logDebug "DELAYING ${timeRamaining} seconds event : ${eventMap}" runIn(timeRamaining, 'sendDelayedPm25Event', [overwrite: true, data: eventMap]) } } private void sendDelayedPm25Event(Map eventMap) { logInfo "${eventMap.descriptionText} (${eventMap.type})" state.lastRx['pm25Time'] = now() // TODO - -(minReportingTimeHumidity * 2000) sendEvent(eventMap) } /* * ----------------------------------------------------------------------------- * 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}" } /* * ----------------------------------------------------------------------------- * Window Covering Cluster 0x0102 * ----------------------------------------------------------------------------- */ void parseWindowCoveringCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (DEVICE_TYPE in ["ButtonDimmer"]) { parseWindowCoveringClusterButtonDimmer(descMap) } else { logWarn "parseWindowCoveringCluster: don't know how to handle descMap=${descMap}" } } /* * ----------------------------------------------------------------------------- * thermostat cluster 0x0201 * ----------------------------------------------------------------------------- */ void parseThermostatCluster(final Map descMap) { if (state.lastRx == null) { state.lastRx = [:] } if (DEVICE_TYPE in ["Thermostat"]) { parseThermostatClusterThermostat(descMap) } else { logWarn "parseThermostatCluster: don't know how to handle descMap=${descMap}" } } // ------------------------------------------------------------------------------------------------------------------------- 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 } 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() } // 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 if (DEVICE_TYPE in ["Thermostat"]) { cmds += refreshThermostat() } 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) } } 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: " ", isDigital: true) } else { logInfo "${info}" sendEvent(name: "Info", value: info, isDigital: true) 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", isDigital: true) } else { descriptionText = "Round-trip time : ${value}" logInfo "${descriptionText}" sendEvent(name: "rtt", value: value, descriptionText: descriptionText, isDigital: true) } } /** * 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, isDigital: true) 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() } if (DEVICE_TYPE in ["Thermostat"]) { updatedThermostat() } 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() updated() // calls also configureDevice() 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 ["Thermostat"]) { initVarsThermostat(fullInit); initEventsThermostat(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 (141) kkossev.xiaomiLib ~~~~~ library ( // library marker kkossev.xiaomiLib, line 1 base: "driver", // library marker kkossev.xiaomiLib, line 2 author: "Krassimir Kossev", // library marker kkossev.xiaomiLib, line 3 category: "zigbee", // library marker kkossev.xiaomiLib, line 4 description: "Xiaomi Library", // library marker kkossev.xiaomiLib, line 5 name: "xiaomiLib", // library marker kkossev.xiaomiLib, line 6 namespace: "kkossev", // library marker kkossev.xiaomiLib, line 7 importUrl: "https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/xiaomiLib.groovy", // library marker kkossev.xiaomiLib, line 8 version: "1.0.1", // library marker kkossev.xiaomiLib, line 9 documentationLink: "" // library marker kkossev.xiaomiLib, line 10 ) // library marker kkossev.xiaomiLib, line 11 /* // library marker kkossev.xiaomiLib, line 12 * Xiaomi Library // library marker kkossev.xiaomiLib, line 13 * // library marker kkossev.xiaomiLib, line 14 * Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.xiaomiLib, line 15 * in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.xiaomiLib, line 16 * // library marker kkossev.xiaomiLib, line 17 * http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.xiaomiLib, line 18 * // library marker kkossev.xiaomiLib, line 19 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.xiaomiLib, line 20 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.xiaomiLib, line 21 * for the specific language governing permissions and limitations under the License. // library marker kkossev.xiaomiLib, line 22 * // library marker kkossev.xiaomiLib, line 23 * ver. 1.0.0 2023-09-09 kkossev - added xiaomiLib // library marker kkossev.xiaomiLib, line 24 * ver. 1.0.1 2023-11-03 kkossev - (dev. branch) // library marker kkossev.xiaomiLib, line 25 * // library marker kkossev.xiaomiLib, line 26 * TODO: // library marker kkossev.xiaomiLib, line 27 */ // library marker kkossev.xiaomiLib, line 28 def xiaomiLibVersion() {"1.0.1"} // library marker kkossev.xiaomiLib, line 31 def xiaomiLibStamp() {"2023/11/04 10:17 PM"} // library marker kkossev.xiaomiLib, line 32 // no metadata for this library! // library marker kkossev.xiaomiLib, line 34 @Field static final int XIAOMI_CLUSTER_ID = 0xFCC0 // library marker kkossev.xiaomiLib, line 36 // Zigbee Attributes // library marker kkossev.xiaomiLib, line 38 @Field static final int DIRECTION_MODE_ATTR_ID = 0x0144 // library marker kkossev.xiaomiLib, line 39 @Field static final int MODEL_ATTR_ID = 0x05 // library marker kkossev.xiaomiLib, line 40 @Field static final int PRESENCE_ACTIONS_ATTR_ID = 0x0143 // library marker kkossev.xiaomiLib, line 41 @Field static final int PRESENCE_ATTR_ID = 0x0142 // library marker kkossev.xiaomiLib, line 42 @Field static final int REGION_EVENT_ATTR_ID = 0x0151 // library marker kkossev.xiaomiLib, line 43 @Field static final int RESET_PRESENCE_ATTR_ID = 0x0157 // library marker kkossev.xiaomiLib, line 44 @Field static final int SENSITIVITY_LEVEL_ATTR_ID = 0x010C // library marker kkossev.xiaomiLib, line 45 @Field static final int SET_EDGE_REGION_ATTR_ID = 0x0156 // library marker kkossev.xiaomiLib, line 46 @Field static final int SET_EXIT_REGION_ATTR_ID = 0x0153 // library marker kkossev.xiaomiLib, line 47 @Field static final int SET_INTERFERENCE_ATTR_ID = 0x0154 // library marker kkossev.xiaomiLib, line 48 @Field static final int SET_REGION_ATTR_ID = 0x0150 // library marker kkossev.xiaomiLib, line 49 @Field static final int TRIGGER_DISTANCE_ATTR_ID = 0x0146 // library marker kkossev.xiaomiLib, line 50 @Field static final int XIAOMI_RAW_ATTR_ID = 0xFFF2 // library marker kkossev.xiaomiLib, line 51 @Field static final int XIAOMI_SPECIAL_REPORT_ID = 0x00F7 // library marker kkossev.xiaomiLib, line 52 @Field static final Map MFG_CODE = [ mfgCode: 0x115F ] // library marker kkossev.xiaomiLib, line 53 // Xiaomi Tags // library marker kkossev.xiaomiLib, line 55 @Field static final int DIRECTION_MODE_TAG_ID = 0x67 // library marker kkossev.xiaomiLib, line 56 @Field static final int SENSITIVITY_LEVEL_TAG_ID = 0x66 // library marker kkossev.xiaomiLib, line 57 @Field static final int SWBUILD_TAG_ID = 0x08 // library marker kkossev.xiaomiLib, line 58 @Field static final int TRIGGER_DISTANCE_TAG_ID = 0x69 // library marker kkossev.xiaomiLib, line 59 @Field static final int PRESENCE_ACTIONS_TAG_ID = 0x66 // library marker kkossev.xiaomiLib, line 60 @Field static final int PRESENCE_TAG_ID = 0x65 // library marker kkossev.xiaomiLib, line 61 // called from parseXiaomiCluster() in the main code ... // library marker kkossev.xiaomiLib, line 63 // // library marker kkossev.xiaomiLib, line 64 void parseXiaomiClusterLib(final Map descMap) { // library marker kkossev.xiaomiLib, line 65 if (settings.logEnable) { // library marker kkossev.xiaomiLib, line 66 //log.trace "zigbee received xiaomi cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.xiaomiLib, line 67 } // library marker kkossev.xiaomiLib, line 68 if (DEVICE_TYPE in ["Thermostat"]) { // library marker kkossev.xiaomiLib, line 69 parseXiaomiClusterThermostatLib(descMap) // library marker kkossev.xiaomiLib, line 70 return // library marker kkossev.xiaomiLib, line 71 } // library marker kkossev.xiaomiLib, line 72 // TODO - refactor AqaraCube specific code // library marker kkossev.xiaomiLib, line 73 // TODO - refactor FP1 specific code // library marker kkossev.xiaomiLib, line 74 switch (descMap.attrInt as Integer) { // library marker kkossev.xiaomiLib, line 75 case 0x0009: // Aqara Cube T1 Pro // library marker kkossev.xiaomiLib, line 76 if (DEVICE_TYPE in ["AqaraCube"]) { logDebug "AqaraCube 0xFCC0 attribute 0x009 value is ${hexStrToUnsignedInt(descMap.value)}" } // library marker kkossev.xiaomiLib, line 77 else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } // library marker kkossev.xiaomiLib, line 78 break // library marker kkossev.xiaomiLib, line 79 case 0x00FC: // FP1 // library marker kkossev.xiaomiLib, line 80 log.info "unknown attribute - resetting?" // library marker kkossev.xiaomiLib, line 81 break // library marker kkossev.xiaomiLib, line 82 case PRESENCE_ATTR_ID: // 0x0142 FP1 // library marker kkossev.xiaomiLib, line 83 final Integer value = hexStrToUnsignedInt(descMap.value) // library marker kkossev.xiaomiLib, line 84 parseXiaomiClusterPresence(value) // library marker kkossev.xiaomiLib, line 85 break // library marker kkossev.xiaomiLib, line 86 case PRESENCE_ACTIONS_ATTR_ID: // 0x0143 FP1 // library marker kkossev.xiaomiLib, line 87 final Integer value = hexStrToUnsignedInt(descMap.value) // library marker kkossev.xiaomiLib, line 88 parseXiaomiClusterPresenceAction(value) // library marker kkossev.xiaomiLib, line 89 break // library marker kkossev.xiaomiLib, line 90 case REGION_EVENT_ATTR_ID: // 0x0151 FP1 // library marker kkossev.xiaomiLib, line 91 // Region events can be sent fast and furious so buffer them // library marker kkossev.xiaomiLib, line 92 final Integer regionId = HexUtils.hexStringToInt(descMap.value[0..1]) // library marker kkossev.xiaomiLib, line 93 final Integer value = HexUtils.hexStringToInt(descMap.value[2..3]) // library marker kkossev.xiaomiLib, line 94 if (settings.logEnable) { // library marker kkossev.xiaomiLib, line 95 log.debug "xiaomi: region ${regionId} action is ${value}" // library marker kkossev.xiaomiLib, line 96 } // library marker kkossev.xiaomiLib, line 97 if (device.currentValue("region${regionId}") != null) { // library marker kkossev.xiaomiLib, line 98 RegionUpdateBuffer.get(device.id).put(regionId, value) // library marker kkossev.xiaomiLib, line 99 runInMillis(REGION_UPDATE_DELAY_MS, 'updateRegions') // library marker kkossev.xiaomiLib, line 100 } // library marker kkossev.xiaomiLib, line 101 break // library marker kkossev.xiaomiLib, line 102 case SENSITIVITY_LEVEL_ATTR_ID: // 0x010C FP1 // library marker kkossev.xiaomiLib, line 103 final Integer value = hexStrToUnsignedInt(descMap.value) // library marker kkossev.xiaomiLib, line 104 log.info "sensitivity level is '${SensitivityLevelOpts.options[value]}' (0x${descMap.value})" // library marker kkossev.xiaomiLib, line 105 device.updateSetting('sensitivityLevel', [value: value.toString(), type: 'enum']) // library marker kkossev.xiaomiLib, line 106 break // library marker kkossev.xiaomiLib, line 107 case TRIGGER_DISTANCE_ATTR_ID: // 0x0146 FP1 // library marker kkossev.xiaomiLib, line 108 final Integer value = hexStrToUnsignedInt(descMap.value) // library marker kkossev.xiaomiLib, line 109 log.info "approach distance is '${ApproachDistanceOpts.options[value]}' (0x${descMap.value})" // library marker kkossev.xiaomiLib, line 110 device.updateSetting('approachDistance', [value: value.toString(), type: 'enum']) // library marker kkossev.xiaomiLib, line 111 break // library marker kkossev.xiaomiLib, line 112 case DIRECTION_MODE_ATTR_ID: // 0x0144 FP1 // library marker kkossev.xiaomiLib, line 113 final Integer value = hexStrToUnsignedInt(descMap.value) // library marker kkossev.xiaomiLib, line 114 log.info "monitoring direction mode is '${DirectionModeOpts.options[value]}' (0x${descMap.value})" // library marker kkossev.xiaomiLib, line 115 device.updateSetting('directionMode', [value: value.toString(), type: 'enum']) // library marker kkossev.xiaomiLib, line 116 break // library marker kkossev.xiaomiLib, line 117 case 0x0148 : // Aqara Cube T1 Pro - Mode // library marker kkossev.xiaomiLib, line 118 if (DEVICE_TYPE in ["AqaraCube"]) { parseXiaomiClusterAqaraCube(descMap) } // library marker kkossev.xiaomiLib, line 119 else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } // library marker kkossev.xiaomiLib, line 120 break // library marker kkossev.xiaomiLib, line 121 case 0x0149: // (329) Aqara Cube T1 Pro - i side facing up (0..5) // library marker kkossev.xiaomiLib, line 122 if (DEVICE_TYPE in ["AqaraCube"]) { parseXiaomiClusterAqaraCube(descMap) } // library marker kkossev.xiaomiLib, line 123 else { logDebug "XiaomiCluster unknown attribute ${descMap.attrInt} value raw = ${hexStrToUnsignedInt(descMap.value)}" } // library marker kkossev.xiaomiLib, line 124 break // library marker kkossev.xiaomiLib, line 125 case XIAOMI_SPECIAL_REPORT_ID: // 0x00F7 sent every 55 minutes // library marker kkossev.xiaomiLib, line 126 final Map tags = decodeXiaomiTags(descMap.value) // library marker kkossev.xiaomiLib, line 127 parseXiaomiClusterTags(tags) // library marker kkossev.xiaomiLib, line 128 if (isAqaraCube()) { // library marker kkossev.xiaomiLib, line 129 sendZigbeeCommands(refreshAqaraCube()) // library marker kkossev.xiaomiLib, line 130 } // library marker kkossev.xiaomiLib, line 131 break // library marker kkossev.xiaomiLib, line 132 case XIAOMI_RAW_ATTR_ID: // 0xFFF2 FP1 // library marker kkossev.xiaomiLib, line 133 final byte[] rawData = HexUtils.hexStringToByteArray(descMap.value) // library marker kkossev.xiaomiLib, line 134 if (rawData.size() == 24 && settings.enableDistanceDirection) { // library marker kkossev.xiaomiLib, line 135 final int degrees = rawData[19] // library marker kkossev.xiaomiLib, line 136 final int distanceCm = (rawData[17] << 8) | (rawData[18] & 0x00ff) // library marker kkossev.xiaomiLib, line 137 if (settings.logEnable) { // library marker kkossev.xiaomiLib, line 138 log.debug "location ${degrees}°, ${distanceCm}cm" // library marker kkossev.xiaomiLib, line 139 } // library marker kkossev.xiaomiLib, line 140 runIn(1, 'updateLocation', [ data: [ degrees: degrees, distanceCm: distanceCm ] ]) // library marker kkossev.xiaomiLib, line 141 } // library marker kkossev.xiaomiLib, line 142 break // library marker kkossev.xiaomiLib, line 143 default: // library marker kkossev.xiaomiLib, line 144 log.warn "zigbee received unknown xiaomi cluster 0xFCC0 attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.xiaomiLib, line 145 break // library marker kkossev.xiaomiLib, line 146 } // library marker kkossev.xiaomiLib, line 147 } // library marker kkossev.xiaomiLib, line 148 void parseXiaomiClusterTags(final Map tags) { // library marker kkossev.xiaomiLib, line 150 tags.each { final Integer tag, final Object value -> // library marker kkossev.xiaomiLib, line 151 switch (tag) { // library marker kkossev.xiaomiLib, line 152 case 0x01: // battery voltage // library marker kkossev.xiaomiLib, line 153 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} battery voltage is ${value/1000}V (raw=${value})" // library marker kkossev.xiaomiLib, line 154 break // library marker kkossev.xiaomiLib, line 155 case 0x03: // library marker kkossev.xiaomiLib, line 156 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} device temperature is ${value}°" // library marker kkossev.xiaomiLib, line 157 break // library marker kkossev.xiaomiLib, line 158 case 0x05: // library marker kkossev.xiaomiLib, line 159 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} RSSI is ${value}" // library marker kkossev.xiaomiLib, line 160 break // library marker kkossev.xiaomiLib, line 161 case 0x06: // library marker kkossev.xiaomiLib, line 162 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} LQI is ${value}" // library marker kkossev.xiaomiLib, line 163 break // library marker kkossev.xiaomiLib, line 164 case 0x08: // SWBUILD_TAG_ID: // library marker kkossev.xiaomiLib, line 165 final String swBuild = '0.0.0_' + (value & 0xFF).toString().padLeft(4, '0') // library marker kkossev.xiaomiLib, line 166 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} swBuild is ${swBuild} (raw ${value})" // library marker kkossev.xiaomiLib, line 167 device.updateDataValue("aqaraVersion", swBuild) // library marker kkossev.xiaomiLib, line 168 break // library marker kkossev.xiaomiLib, line 169 case 0x0a: // library marker kkossev.xiaomiLib, line 170 String nwk = intToHexStr(value as Integer,2) // library marker kkossev.xiaomiLib, line 171 if (state.health == null) { state.health = [:] } // library marker kkossev.xiaomiLib, line 172 String oldNWK = state.health['parentNWK'] ?: 'n/a' // library marker kkossev.xiaomiLib, line 173 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} Parent NWK is ${nwk}" // library marker kkossev.xiaomiLib, line 174 if (oldNWK != nwk ) { // library marker kkossev.xiaomiLib, line 175 logWarn "parentNWK changed from ${oldNWK} to ${nwk}" // library marker kkossev.xiaomiLib, line 176 state.health['parentNWK'] = nwk // library marker kkossev.xiaomiLib, line 177 state.health['nwkCtr'] = (state.health['nwkCtr'] ?: 0) + 1 // library marker kkossev.xiaomiLib, line 178 } // library marker kkossev.xiaomiLib, line 179 break // library marker kkossev.xiaomiLib, line 180 case 0x0b: // library marker kkossev.xiaomiLib, line 181 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} light level is ${value}" // library marker kkossev.xiaomiLib, line 182 break // library marker kkossev.xiaomiLib, line 183 case 0x64: // library marker kkossev.xiaomiLib, line 184 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} temperature is ${value/100} (raw ${value})" // Aqara TVOC // library marker kkossev.xiaomiLib, line 185 // TODO - also smoke gas/density if UINT ! // library marker kkossev.xiaomiLib, line 186 break // library marker kkossev.xiaomiLib, line 187 case 0x65: // library marker kkossev.xiaomiLib, line 188 if (isAqaraFP1()) { logDebug "xiaomi decode PRESENCE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 189 else { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} humidity is ${value/100} (raw ${value})" } // Aqara TVOC // library marker kkossev.xiaomiLib, line 190 break // library marker kkossev.xiaomiLib, line 191 case 0x66: // library marker kkossev.xiaomiLib, line 192 if (isAqaraFP1()) { logDebug "xiaomi decode SENSITIVITY_LEVEL_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 193 else if (isAqaraTVOC()) { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} airQualityIndex is ${value}" } // Aqara TVOC level (in ppb) // library marker kkossev.xiaomiLib, line 194 else { logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} presure is ${value}" } // library marker kkossev.xiaomiLib, line 195 break // library marker kkossev.xiaomiLib, line 196 case 0x67: // library marker kkossev.xiaomiLib, line 197 if (isAqaraFP1()) { logDebug "xiaomi decode DIRECTION_MODE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 198 else { logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } // Aqara TVOC: // library marker kkossev.xiaomiLib, line 199 // air quality (as 6 - #stars) ['excellent', 'good', 'moderate', 'poor', 'unhealthy'][val - 1] // library marker kkossev.xiaomiLib, line 200 break // library marker kkossev.xiaomiLib, line 201 case 0x69: // library marker kkossev.xiaomiLib, line 202 if (isAqaraFP1()) { logDebug "xiaomi decode TRIGGER_DISTANCE_TAG_ID tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 203 else { logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 204 break // library marker kkossev.xiaomiLib, line 205 case 0x6a: // library marker kkossev.xiaomiLib, line 206 if (isAqaraFP1()) { logDebug "xiaomi decode FP1 unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 207 else { logDebug "xiaomi decode MOTION SENSITIVITY tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 208 break // library marker kkossev.xiaomiLib, line 209 case 0x6b: // library marker kkossev.xiaomiLib, line 210 if (isAqaraFP1()) { logDebug "xiaomi decode FP1 unknown tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 211 else { logDebug "xiaomi decode MOTION LED tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 212 break // library marker kkossev.xiaomiLib, line 213 case 0x95: // library marker kkossev.xiaomiLib, line 214 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} energy is ${value}" // library marker kkossev.xiaomiLib, line 215 break // library marker kkossev.xiaomiLib, line 216 case 0x96: // library marker kkossev.xiaomiLib, line 217 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} voltage is ${value}" // library marker kkossev.xiaomiLib, line 218 break // library marker kkossev.xiaomiLib, line 219 case 0x97: // library marker kkossev.xiaomiLib, line 220 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} current is ${value}" // library marker kkossev.xiaomiLib, line 221 break // library marker kkossev.xiaomiLib, line 222 case 0x98: // library marker kkossev.xiaomiLib, line 223 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} power is ${value}" // library marker kkossev.xiaomiLib, line 224 break // library marker kkossev.xiaomiLib, line 225 case 0x9b: // library marker kkossev.xiaomiLib, line 226 if (isAqaraCube()) { // library marker kkossev.xiaomiLib, line 227 logDebug "Aqara cubeMode tag: 0x${intToHexStr(tag, 1)} is '${AqaraCubeModeOpts.options[value as int]}' (${value})" // library marker kkossev.xiaomiLib, line 228 sendAqaraCubeOperationModeEvent(value as int) // library marker kkossev.xiaomiLib, line 229 } // library marker kkossev.xiaomiLib, line 230 else { logDebug "xiaomi decode CONSUMER CONNECTED tag: 0x${intToHexStr(tag, 1)}=${value}" } // library marker kkossev.xiaomiLib, line 231 break // library marker kkossev.xiaomiLib, line 232 default: // library marker kkossev.xiaomiLib, line 233 logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.xiaomiLib, line 234 } // library marker kkossev.xiaomiLib, line 235 } // library marker kkossev.xiaomiLib, line 236 } // library marker kkossev.xiaomiLib, line 237 /** // library marker kkossev.xiaomiLib, line 240 * Reads a specified number of little-endian bytes from a given // library marker kkossev.xiaomiLib, line 241 * ByteArrayInputStream and returns a BigInteger. // library marker kkossev.xiaomiLib, line 242 */ // library marker kkossev.xiaomiLib, line 243 private static BigInteger readBigIntegerBytes(final ByteArrayInputStream stream, final int length) { // library marker kkossev.xiaomiLib, line 244 final byte[] byteArr = new byte[length] // library marker kkossev.xiaomiLib, line 245 stream.read(byteArr, 0, length) // library marker kkossev.xiaomiLib, line 246 BigInteger bigInt = BigInteger.ZERO // library marker kkossev.xiaomiLib, line 247 for (int i = byteArr.length - 1; i >= 0; i--) { // library marker kkossev.xiaomiLib, line 248 bigInt |= (BigInteger.valueOf((byteArr[i] & 0xFF) << (8 * i))) // library marker kkossev.xiaomiLib, line 249 } // library marker kkossev.xiaomiLib, line 250 return bigInt // library marker kkossev.xiaomiLib, line 251 } // library marker kkossev.xiaomiLib, line 252 /** // library marker kkossev.xiaomiLib, line 254 * Decodes a Xiaomi Zigbee cluster attribute payload in hexadecimal format and // library marker kkossev.xiaomiLib, line 255 * returns a map of decoded tag number and value pairs where the value is either a // library marker kkossev.xiaomiLib, line 256 * BigInteger for fixed values or a String for variable length. // library marker kkossev.xiaomiLib, line 257 */ // library marker kkossev.xiaomiLib, line 258 private static Map decodeXiaomiTags(final String hexString) { // library marker kkossev.xiaomiLib, line 259 final Map results = [:] // library marker kkossev.xiaomiLib, line 260 final byte[] bytes = HexUtils.hexStringToByteArray(hexString) // library marker kkossev.xiaomiLib, line 261 new ByteArrayInputStream(bytes).withCloseable { final stream -> // library marker kkossev.xiaomiLib, line 262 while (stream.available() > 2) { // library marker kkossev.xiaomiLib, line 263 int tag = stream.read() // library marker kkossev.xiaomiLib, line 264 int dataType = stream.read() // library marker kkossev.xiaomiLib, line 265 Object value // library marker kkossev.xiaomiLib, line 266 if (DataType.isDiscrete(dataType)) { // library marker kkossev.xiaomiLib, line 267 int length = stream.read() // library marker kkossev.xiaomiLib, line 268 byte[] byteArr = new byte[length] // library marker kkossev.xiaomiLib, line 269 stream.read(byteArr, 0, length) // library marker kkossev.xiaomiLib, line 270 value = new String(byteArr) // library marker kkossev.xiaomiLib, line 271 } else { // library marker kkossev.xiaomiLib, line 272 int length = DataType.getLength(dataType) // library marker kkossev.xiaomiLib, line 273 value = readBigIntegerBytes(stream, length) // library marker kkossev.xiaomiLib, line 274 } // library marker kkossev.xiaomiLib, line 275 results[tag] = value // library marker kkossev.xiaomiLib, line 276 } // library marker kkossev.xiaomiLib, line 277 } // library marker kkossev.xiaomiLib, line 278 return results // library marker kkossev.xiaomiLib, line 279 } // library marker kkossev.xiaomiLib, line 280 def refreshXiaomi() { // library marker kkossev.xiaomiLib, line 283 List cmds = [] // library marker kkossev.xiaomiLib, line 284 if (cmds == []) { cmds = ["delay 299"] } // library marker kkossev.xiaomiLib, line 285 return cmds // library marker kkossev.xiaomiLib, line 286 } // library marker kkossev.xiaomiLib, line 287 def configureXiaomi() { // library marker kkossev.xiaomiLib, line 289 List cmds = [] // library marker kkossev.xiaomiLib, line 290 logDebug "configureThermostat() : ${cmds}" // library marker kkossev.xiaomiLib, line 291 if (cmds == []) { cmds = ["delay 299"] } // no , // library marker kkossev.xiaomiLib, line 292 return cmds // library marker kkossev.xiaomiLib, line 293 } // library marker kkossev.xiaomiLib, line 294 def initializeXiaomi() // library marker kkossev.xiaomiLib, line 296 { // library marker kkossev.xiaomiLib, line 297 List cmds = [] // library marker kkossev.xiaomiLib, line 298 logDebug "initializeXiaomi() : ${cmds}" // library marker kkossev.xiaomiLib, line 299 if (cmds == []) { cmds = ["delay 299",] } // library marker kkossev.xiaomiLib, line 300 return cmds // library marker kkossev.xiaomiLib, line 301 } // library marker kkossev.xiaomiLib, line 302 void initVarsXiaomi(boolean fullInit=false) { // library marker kkossev.xiaomiLib, line 304 logDebug "initVarsXiaomi(${fullInit})" // library marker kkossev.xiaomiLib, line 305 } // library marker kkossev.xiaomiLib, line 306 void initEventsXiaomi(boolean fullInit=false) { // library marker kkossev.xiaomiLib, line 308 logDebug "initEventsXiaomi(${fullInit})" // library marker kkossev.xiaomiLib, line 309 } // library marker kkossev.xiaomiLib, line 310 // ~~~~~ end include (141) kkossev.xiaomiLib ~~~~~ // ~~~~~ start include (140) kkossev.thermostatLib ~~~~~ library ( // library marker kkossev.thermostatLib, line 1 base: "driver", // library marker kkossev.thermostatLib, line 2 author: "Krassimir Kossev", // library marker kkossev.thermostatLib, line 3 category: "zigbee", // library marker kkossev.thermostatLib, line 4 description: "Thermostat Library", // library marker kkossev.thermostatLib, line 5 name: "thermostatLib", // library marker kkossev.thermostatLib, line 6 namespace: "kkossev", // library marker kkossev.thermostatLib, line 7 importUrl: "https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/thermostatLib.groovy", // library marker kkossev.thermostatLib, line 8 version: "1.0.2", // library marker kkossev.thermostatLib, line 9 documentationLink: "" // library marker kkossev.thermostatLib, line 10 ) // library marker kkossev.thermostatLib, line 11 /* // library marker kkossev.thermostatLib, line 12 * Zigbee Button Dimmer -Library // library marker kkossev.thermostatLib, line 13 * // library marker kkossev.thermostatLib, line 14 * Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.thermostatLib, line 15 * in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.thermostatLib, line 16 * // library marker kkossev.thermostatLib, line 17 * http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.thermostatLib, line 18 * // library marker kkossev.thermostatLib, line 19 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.thermostatLib, line 20 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.thermostatLib, line 21 * for the specific language governing permissions and limitations under the License. // library marker kkossev.thermostatLib, line 22 * // library marker kkossev.thermostatLib, line 23 * ver. 1.0.0 2023-09-07 kkossev - added thermostatLib // library marker kkossev.thermostatLib, line 24 * ver. 1.0.1 2023-09-09 kkossev - added temperaturePollingInterval // library marker kkossev.thermostatLib, line 25 * ver. 1.0.2 2023-11-03 kkossev - (dev. branch) - system_mode off/heat; // library marker kkossev.thermostatLib, line 26 * // library marker kkossev.thermostatLib, line 27 * TODO: temperature event for 20 degrees bug? // library marker kkossev.thermostatLib, line 28 * TODO: debugLogss off not scheduled bug? // library marker kkossev.thermostatLib, line 29 * TODO: thermostat polling scheduled bug? // library marker kkossev.thermostatLib, line 30 */ // library marker kkossev.thermostatLib, line 31 def thermostatLibVersion() {"1.0.2"} // library marker kkossev.thermostatLib, line 33 def thermostatLibStamp() {"2023/11/04 10:17 PM"} // library marker kkossev.thermostatLib, line 34 //import groovy.transform.Field // library marker kkossev.thermostatLib, line 36 metadata { // library marker kkossev.thermostatLib, line 38 capability "ThermostatHeatingSetpoint" // library marker kkossev.thermostatLib, line 39 //capability "ThermostatCoolingSetpoint" // library marker kkossev.thermostatLib, line 40 capability "ThermostatOperatingState" // library marker kkossev.thermostatLib, line 41 capability "ThermostatSetpoint" // library marker kkossev.thermostatLib, line 42 capability "ThermostatMode" // library marker kkossev.thermostatLib, line 43 //capability "Thermostat" // library marker kkossev.thermostatLib, line 44 /* // library marker kkossev.thermostatLib, line 46 capability "Actuator" // library marker kkossev.thermostatLib, line 47 capability "Refresh" // library marker kkossev.thermostatLib, line 48 capability "Sensor" // library marker kkossev.thermostatLib, line 49 capability "Temperature Measurement" // library marker kkossev.thermostatLib, line 50 capability "Thermostat" // library marker kkossev.thermostatLib, line 51 capability "ThermostatHeatingSetpoint" // library marker kkossev.thermostatLib, line 52 capability "ThermostatCoolingSetpoint" // library marker kkossev.thermostatLib, line 53 capability "ThermostatOperatingState" // library marker kkossev.thermostatLib, line 54 capability "ThermostatSetpoint" // library marker kkossev.thermostatLib, line 55 capability "ThermostatMode" // library marker kkossev.thermostatLib, line 56 */ // library marker kkossev.thermostatLib, line 57 // Aqara E1 thermostat attributes // library marker kkossev.thermostatLib, line 59 attribute "system_mode", 'enum', SystemModeOpts.options.values() as List // library marker kkossev.thermostatLib, line 60 attribute "preset", 'enum', PresetOpts.options.values() as List // library marker kkossev.thermostatLib, line 61 attribute "window_detection", 'enum', WindowDetectionOpts.options.values() as List // library marker kkossev.thermostatLib, line 62 attribute "valve_detection", 'enum', ValveDetectionOpts.options.values() as List // library marker kkossev.thermostatLib, line 63 attribute "valve_alarm", 'enum', ValveAlarmOpts.options.values() as List // library marker kkossev.thermostatLib, line 64 attribute "child_lock", 'enum', ChildLockOpts.options.values() as List // library marker kkossev.thermostatLib, line 65 attribute "away_preset_temperature", 'number' // library marker kkossev.thermostatLib, line 66 attribute "window_open", 'enum', WindowOpenOpts.options.values() as List // library marker kkossev.thermostatLib, line 67 attribute "calibrated", 'enum', CalibratedOpts.options.values() as List // library marker kkossev.thermostatLib, line 68 attribute "sensor", 'enum', SensorOpts.options.values() as List // library marker kkossev.thermostatLib, line 69 attribute "battery", 'number' // library marker kkossev.thermostatLib, line 70 command "preset", [[name:"select preset option", type: "ENUM", constraints: ["--- select ---"]+PresetOpts.options.values() as List]] // library marker kkossev.thermostatLib, line 72 if (_DEBUG) { command "testT", [[name: "testT", type: "STRING", description: "testT", defaultValue : ""]] } // library marker kkossev.thermostatLib, line 74 // TODO - add Sonoff TRVZB fingerprint // library marker kkossev.thermostatLib, line 76 //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' // library marker kkossev.thermostatLib, line 78 // fingerprints are inputed from the deviceProfile maps // library marker kkossev.thermostatLib, line 79 // https://github.com/Koenkk/zigbee-herdsman-converters/blob/6339b6034de34f8a633e4f753dc6e506ac9b001c/src/devices/xiaomi.ts#L3197 // library marker kkossev.thermostatLib, line 81 // https://github.com/Smanar/deconz-rest-plugin/blob/6efd103c1a43eb300a19bf3bf3745742239e9fee/devices/xiaomi/xiaomi_lumi.airrtc.agl001.json // library marker kkossev.thermostatLib, line 82 // https://github.com/dresden-elektronik/deconz-rest-plugin/issues/6351 // library marker kkossev.thermostatLib, line 83 preferences { // library marker kkossev.thermostatLib, line 84 input name: 'temperaturePollingInterval', type: 'enum', title: 'Temperature polling interval', options: TemperaturePollingIntervalOpts.options, defaultValue: TemperaturePollingIntervalOpts.defaultValue, required: true, description: 'Changes how often the hub will poll the TRV for faster temperature reading updates.' // library marker kkossev.thermostatLib, line 85 } // library marker kkossev.thermostatLib, line 86 } // library marker kkossev.thermostatLib, line 87 @Field static final Map TemperaturePollingIntervalOpts = [ // library marker kkossev.thermostatLib, line 89 defaultValue: 600, // library marker kkossev.thermostatLib, line 90 options : [0: 'Disabled', 60: 'Every minute (not recommended)', 120: 'Every 2 minutes', 300: 'Every 5 minutes', 600: 'Every 10 minutes', 900: 'Every 15 minutes', 1800: 'Every 30 minutes', 3600: 'Every 1 hour'] // library marker kkossev.thermostatLib, line 91 ] // library marker kkossev.thermostatLib, line 92 @Field static final Map SystemModeOpts = [ //system_mode // library marker kkossev.thermostatLib, line 94 defaultValue: 1, // library marker kkossev.thermostatLib, line 95 options : [0: 'off', 1: 'heat'] // library marker kkossev.thermostatLib, line 96 ] // library marker kkossev.thermostatLib, line 97 @Field static final Map PresetOpts = [ // preset // library marker kkossev.thermostatLib, line 98 defaultValue: 1, // library marker kkossev.thermostatLib, line 99 options : [0: 'manual', 1: 'auto', 2: 'away'] // library marker kkossev.thermostatLib, line 100 ] // library marker kkossev.thermostatLib, line 101 @Field static final Map WindowDetectionOpts = [ // window_detection // library marker kkossev.thermostatLib, line 102 defaultValue: 1, // library marker kkossev.thermostatLib, line 103 options : [0: 'off', 1: 'on'] // library marker kkossev.thermostatLib, line 104 ] // library marker kkossev.thermostatLib, line 105 @Field static final Map ValveDetectionOpts = [ // valve_detection // library marker kkossev.thermostatLib, line 106 defaultValue: 1, // library marker kkossev.thermostatLib, line 107 options : [0: 'off', 1: 'on'] // library marker kkossev.thermostatLib, line 108 ] // library marker kkossev.thermostatLib, line 109 @Field static final Map ValveAlarmOpts = [ // valve_alarm // library marker kkossev.thermostatLib, line 110 defaultValue: 1, // library marker kkossev.thermostatLib, line 111 options : [0: false, 1: true] // library marker kkossev.thermostatLib, line 112 ] // library marker kkossev.thermostatLib, line 113 @Field static final Map ChildLockOpts = [ // child_lock // library marker kkossev.thermostatLib, line 114 defaultValue: 1, // library marker kkossev.thermostatLib, line 115 options : [0: 'unlock', 1: 'lock'] // library marker kkossev.thermostatLib, line 116 ] // library marker kkossev.thermostatLib, line 117 @Field static final Map WindowOpenOpts = [ // window_open // library marker kkossev.thermostatLib, line 118 defaultValue: 1, // library marker kkossev.thermostatLib, line 119 options : [0: false, 1: true] // library marker kkossev.thermostatLib, line 120 ] // library marker kkossev.thermostatLib, line 121 @Field static final Map CalibratedOpts = [ // calibrated // library marker kkossev.thermostatLib, line 122 defaultValue: 1, // library marker kkossev.thermostatLib, line 123 options : [0: false, 1: true] // library marker kkossev.thermostatLib, line 124 ] // library marker kkossev.thermostatLib, line 125 @Field static final Map SensorOpts = [ // child_lock // library marker kkossev.thermostatLib, line 126 defaultValue: 1, // library marker kkossev.thermostatLib, line 127 options : [0: 'internal', 1: 'external'] // library marker kkossev.thermostatLib, line 128 ] // library marker kkossev.thermostatLib, line 129 @Field static final Map deviceProfilesV2 = [ // library marker kkossev.thermostatLib, line 131 // isAqaraTRV() // library marker kkossev.thermostatLib, line 132 "AQARA_E1_TRV" : [ // library marker kkossev.thermostatLib, line 133 description : "Aqara E1`Thermostat model SRTS-A01", // library marker kkossev.thermostatLib, line 134 models : ["LUMI"], // library marker kkossev.thermostatLib, line 135 device : [type: "TRV", powerSource: "battery", isSleepy:false], // library marker kkossev.thermostatLib, line 136 capabilities : ["ThermostatHeatingSetpoint": true, "ThermostatOperatingState": true, "ThermostatSetpoint":true, "ThermostatMode":true], // library marker kkossev.thermostatLib, line 137 preferences : ["window_detection":"0xFCC0:0x0273", "valve_detection":"0xFCC0:0x0274",, "child_lock":"0xFCC0:0x0277", "away_preset_temperature":"0xFCC0:0x0279", "window_open":"0xFCC0:0x027A", "calibrated":"0xFCC0:0x027B", "sensor":"0xFCC0:0x027E"], // library marker kkossev.thermostatLib, line 139 fingerprints : [ // library marker kkossev.thermostatLib, line 140 [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"] // library marker kkossev.thermostatLib, line 141 ], // library marker kkossev.thermostatLib, line 142 commands : ["resetStats":"resetStats", 'refresh':'refresh', "initialize":"initialize", "updateAllPreferences": "updateAllPreferences", "resetPreferencesToDefaults":"resetPreferencesToDefaults", "validateAndFixPreferences":"validateAndFixPreferences"], // library marker kkossev.thermostatLib, line 143 tuyaDPs : [:], // library marker kkossev.thermostatLib, line 144 attributes : [ // library marker kkossev.thermostatLib, line 145 [at:"0xFCC0:0x040A", name:'battery', type:"number", dt: "0x21", rw: "ro", min:0, max:100, step:1, scale:1, unit:"%", description:'Battery percentage remaining'], // library marker kkossev.thermostatLib, line 146 [at:"0xFCC0:0x0271", name:'system_mode', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "System Mode", description:'System Mode'], // library marker kkossev.thermostatLib, line 147 [at:"0xFCC0:0x0272", name:'preset', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "rw", min:0, max:2, step:1, scale:1, map:[0: "manual", 1: "auto", 2: "away"], unit:"", title: "Preset", description:'Preset'], // library marker kkossev.thermostatLib, line 148 [at:"0xFCC0:0x0273", name:'window_detection', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "rw", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "off", 1: "on"], unit:"", title: "Window Detection", description:'Window detection'], // library marker kkossev.thermostatLib, line 149 [at:"0xFCC0:0x0274", name:'valve_detection', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "rw", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "off", 1: "on"], unit:"", title: "Valve Detection", description:'Valve detection'], // library marker kkossev.thermostatLib, line 150 [at:"0xFCC0:0x0275", name:'valve_alarm', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "ro", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "false", 1: "true"], unit:"", title: "Valve Alarm", description:'Valve alarm'], // library marker kkossev.thermostatLib, line 151 [at:"0xFCC0:0x0277", name:'child_lock', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "rw", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "unlock", 1: "lock"], unit:"", title: "Child Lock", description:'Child lock'], // library marker kkossev.thermostatLib, line 152 [at:"0xFCC0:0x0279", name:'away_preset_temperature', type:"decimal", dt: "0x23", mfgCode:"0x115f", rw: "rw", min:5.0, max:35.0, defaultValue:5.0, step:0.5, scale:100, unit:"°C", title: "Away Preset Temperature", description:'Away preset temperature'], // library marker kkossev.thermostatLib, line 153 [at:"0xFCC0:0x027A", name:'window_open', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "ro", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "false", 1: "true"], unit:"", title: "Window Open", description:'Window open'], // library marker kkossev.thermostatLib, line 154 [at:"0xFCC0:0x027B", name:'calibrated', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "ro", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "false", 1: "true"], unit:"", title: "Calibrated", description:'Calibrated'], // library marker kkossev.thermostatLib, line 155 [at:"0xFCC0:0x027E", name:'sensor', type:"enum", dt: "0x20", mfgCode:"0x115f", rw: "ro", min:0, max:1, defaultValue:"0", step:1, scale:1, map:[0: "internal", 1: "external"], unit:"", title: "Sensor", description:'Sensor'], // library marker kkossev.thermostatLib, line 156 // // library marker kkossev.thermostatLib, line 157 [at:"0x0201:0x0000", name:'temperature', type:"decimal", dt: "0x21", rw: "ro", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Temperature", description:'Measured temperature'], // library marker kkossev.thermostatLib, line 158 [at:"0x0201:0x0011", name:'coolingSetpoint', type:"decimal", dt: "0x21", rw: "rw", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Cooling Setpoint", description:'cooling setpoint'], // library marker kkossev.thermostatLib, line 159 [at:"0x0201:0x0012", name:'heatingSetpoint', type:"decimal", dt: "0x21", rw: "rw", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Current Heating Setpoint", description:'Current heating setpoint'], // library marker kkossev.thermostatLib, line 160 [at:"0x0201:0x001C", name:'mode', type:"enum", dt: "0x20", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: " Mode", description:'System Mode ?'], // library marker kkossev.thermostatLib, line 161 // ^^^^ TODO - check if this is the same as system_mode // library marker kkossev.thermostatLib, line 162 [at:"0x0201:0x001E", name:'thermostatRunMode', type:"enum", dt: "0x20", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatRunMode", description:'thermostatRunMode'], // library marker kkossev.thermostatLib, line 163 // ^^ TODO // library marker kkossev.thermostatLib, line 164 [at:"0x0201:0x0020", name:'battery2', type:"number", dt: "0x20", rw: "ro", min:0, max:100, step:1, scale:1, unit:"%", description:'Battery percentage remaining'], // library marker kkossev.thermostatLib, line 165 // ^^ TODO // library marker kkossev.thermostatLib, line 166 [at:"0x0201:0x0023", name:'thermostatHoldMode', type:"enum", dt: "0x20", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatHoldMode", description:'thermostatHoldMode'], // library marker kkossev.thermostatLib, line 167 // ^^ TODO // library marker kkossev.thermostatLib, line 168 [at:"0x0201:0x0029", name:'thermostatOperatingState', type:"enum", dt: "0x20", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatOperatingState", description:'thermostatOperatingState'], // library marker kkossev.thermostatLib, line 169 // ^^ TODO // library marker kkossev.thermostatLib, line 170 [at:"0x0201:0xFFF2", name:'unknown', type:"number", dt: "0x21", rw: "ro", min:0, max:100, step:1, scale:1, unit:"%", description:'Battery percentage remaining'], // library marker kkossev.thermostatLib, line 171 ], // library marker kkossev.thermostatLib, line 172 deviceJoinName: "Aqara E1 Thermostat", // library marker kkossev.thermostatLib, line 173 configuration : [:] // library marker kkossev.thermostatLib, line 174 ], // library marker kkossev.thermostatLib, line 175 "UNKNOWN" : [ // library marker kkossev.thermostatLib, line 177 description : "GENERIC TRV", // library marker kkossev.thermostatLib, line 178 models : ["*"], // library marker kkossev.thermostatLib, line 179 device : [type: "TRV", powerSource: "battery", isSleepy:false], // library marker kkossev.thermostatLib, line 180 capabilities : ["ThermostatHeatingSetpoint": true, "ThermostatOperatingState": true, "ThermostatSetpoint":true, "ThermostatMode":true], // library marker kkossev.thermostatLib, line 181 preferences : [], // library marker kkossev.thermostatLib, line 183 fingerprints : [], // library marker kkossev.thermostatLib, line 184 commands : ["resetStats":"resetStats", 'refresh':'refresh', "initialize":"initialize", "updateAllPreferences": "updateAllPreferences", "resetPreferencesToDefaults":"resetPreferencesToDefaults", "validateAndFixPreferences":"validateAndFixPreferences"], // library marker kkossev.thermostatLib, line 185 tuyaDPs : [:], // library marker kkossev.thermostatLib, line 186 attributes : [ // library marker kkossev.thermostatLib, line 187 [at:"0x0201:0x0000", name:'temperature', type:"decimal", dt: "UINT16", rw: "ro", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Temperature", description:'Measured temperature'], // library marker kkossev.thermostatLib, line 188 [at:"0x0201:0x0011", name:'coolingSetpoint', type:"decimal", dt: "UINT16", rw: "rw", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Cooling Setpoint", description:'cooling setpoint'], // library marker kkossev.thermostatLib, line 189 [at:"0x0201:0x0012", name:'heatingSetpoint', type:"decimal", dt: "UINT16", rw: "rw", min:5.0, max:35.0, step:0.5, scale:100, unit:"°C", title: "Current Heating Setpoint", description:'Current heating setpoint'], // library marker kkossev.thermostatLib, line 190 [at:"0x0201:0x001C", name:'mode', type:"enum", dt: "UINT8", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: " Mode", description:'System Mode ?'], // library marker kkossev.thermostatLib, line 191 [at:"0x0201:0x001E", name:'thermostatRunMode', type:"enum", dt: "UINT8", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatRunMode", description:'thermostatRunMode'], // library marker kkossev.thermostatLib, line 192 [at:"0x0201:0x0020", name:'battery2', type:"number", dt: "UINT16", rw: "ro", min:0, max:100, step:1, scale:1, unit:"%", description:'Battery percentage remaining'], // library marker kkossev.thermostatLib, line 193 [at:"0x0201:0x0023", name:'thermostatHoldMode', type:"enum", dt: "UINT8", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatHoldMode", description:'thermostatHoldMode'], // library marker kkossev.thermostatLib, line 194 [at:"0x0201:0x0029", name:'thermostatOperatingState', type:"enum", dt: "UINT8", rw: "rw", min:0, max:1, step:1, scale:1, map:[0: "off", 1: "heat"], unit:"", title: "thermostatOperatingState", description:'thermostatOperatingState'], // library marker kkossev.thermostatLib, line 195 ], // library marker kkossev.thermostatLib, line 196 deviceJoinName: "UNKWNOWN TRV", // library marker kkossev.thermostatLib, line 197 configuration : [:] // library marker kkossev.thermostatLib, line 198 ] // library marker kkossev.thermostatLib, line 199 ] // library marker kkossev.thermostatLib, line 201 void thermostatEvent(eventName, value, raw) { // library marker kkossev.thermostatLib, line 205 sendEvent(name: eventName, value: value, type: "physical") // library marker kkossev.thermostatLib, line 206 logInfo "${eventName} is ${value} (raw ${raw})" // library marker kkossev.thermostatLib, line 207 } // library marker kkossev.thermostatLib, line 208 // called from parseXiaomiClusterLib in xiaomiLib.groovy (xiaomi cluster 0xFCC0 ) // library marker kkossev.thermostatLib, line 210 // // library marker kkossev.thermostatLib, line 211 void parseXiaomiClusterThermostatLib(final Map descMap) { // library marker kkossev.thermostatLib, line 212 //logWarn "parseXiaomiClusterThermostatLib: received xiaomi cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.thermostatLib, line 213 final Integer raw // library marker kkossev.thermostatLib, line 214 final String value // library marker kkossev.thermostatLib, line 215 switch (descMap.attrInt as Integer) { // library marker kkossev.thermostatLib, line 216 case 0x040a: // E1 battery - read only // library marker kkossev.thermostatLib, line 217 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 218 thermostatEvent("battery", raw, raw) // library marker kkossev.thermostatLib, line 219 break // library marker kkossev.thermostatLib, line 220 case 0x00F7 : // XIAOMI_SPECIAL_REPORT_ID: 0x00F7 sent every 55 minutes // library marker kkossev.thermostatLib, line 221 final Map tags = decodeXiaomiTags(descMap.value) // library marker kkossev.thermostatLib, line 222 parseXiaomiClusterThermostatTags(tags) // library marker kkossev.thermostatLib, line 223 break // library marker kkossev.thermostatLib, line 224 case 0x0271: // result['system_mode'] = {1: 'heat', 0: 'off'}[value]; (heating state) - rw // library marker kkossev.thermostatLib, line 225 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 226 value = SystemModeOpts.options[raw as int] // library marker kkossev.thermostatLib, line 227 thermostatEvent("system_mode", value, raw) // library marker kkossev.thermostatLib, line 228 break; // library marker kkossev.thermostatLib, line 229 case 0x0272: // result['preset'] = {2: 'away', 1: 'auto', 0: 'manual'}[value]; - rw ['manual', 'auto', 'holiday'] // library marker kkossev.thermostatLib, line 230 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 231 value = PresetOpts.options[raw as int] // library marker kkossev.thermostatLib, line 232 thermostatEvent("preset", value, raw) // library marker kkossev.thermostatLib, line 233 break; // library marker kkossev.thermostatLib, line 234 case 0x0273: // result['window_detection'] = {1: 'ON', 0: 'OFF'}[value]; - rw // library marker kkossev.thermostatLib, line 235 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 236 value = WindowDetectionOpts.options[raw as int] // library marker kkossev.thermostatLib, line 237 thermostatEvent("window_detection", value, raw) // library marker kkossev.thermostatLib, line 238 break; // library marker kkossev.thermostatLib, line 239 case 0x0274: // result['valve_detection'] = {1: 'ON', 0: 'OFF'}[value]; -rw // library marker kkossev.thermostatLib, line 240 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 241 value = ValveDetectionOpts.options[raw as int] // library marker kkossev.thermostatLib, line 242 thermostatEvent("valve_detection", value, raw) // library marker kkossev.thermostatLib, line 243 break; // library marker kkossev.thermostatLib, line 244 case 0x0275: // result['valve_alarm'] = {1: true, 0: false}[value]; - read only! // library marker kkossev.thermostatLib, line 245 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 246 value = ValveAlarmOpts.options[raw as int] // library marker kkossev.thermostatLib, line 247 thermostatEvent("valve_alarm", value, raw) // library marker kkossev.thermostatLib, line 248 break; // library marker kkossev.thermostatLib, line 249 case 0x0277: // result['child_lock'] = {1: 'LOCK', 0: 'UNLOCK'}[value]; - rw // library marker kkossev.thermostatLib, line 250 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 251 value = ChildLockOpts.options[raw as int] // library marker kkossev.thermostatLib, line 252 thermostatEvent("child_lock", value, raw) // library marker kkossev.thermostatLib, line 253 break; // library marker kkossev.thermostatLib, line 254 case 0x0279: // result['away_preset_temperature'] = (value / 100).toFixed(1); - rw // library marker kkossev.thermostatLib, line 255 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 256 value = raw / 100 // library marker kkossev.thermostatLib, line 257 thermostatEvent("away_preset_temperature", value, raw) // library marker kkossev.thermostatLib, line 258 break; // library marker kkossev.thermostatLib, line 259 case 0x027a: // result['window_open'] = {1: true, 0: false}[value]; - read only // library marker kkossev.thermostatLib, line 260 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 261 value = WindowOpenOpts.options[raw as int] // library marker kkossev.thermostatLib, line 262 thermostatEvent("window_open", value, raw) // library marker kkossev.thermostatLib, line 263 break; // library marker kkossev.thermostatLib, line 264 case 0x027b: // result['calibrated'] = {1: true, 0: false}[value]; - read only // library marker kkossev.thermostatLib, line 265 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 266 value = CalibratedOpts.options[raw as int] // library marker kkossev.thermostatLib, line 267 thermostatEvent("calibrated", value, raw) // library marker kkossev.thermostatLib, line 268 break; // library marker kkossev.thermostatLib, line 269 case 0x0276: // unknown // library marker kkossev.thermostatLib, line 270 case 0x027c: // unknown // library marker kkossev.thermostatLib, line 271 case 0x027d: // unknown // library marker kkossev.thermostatLib, line 272 case 0x0280: // unknown // library marker kkossev.thermostatLib, line 273 case 0xfff2: // unknown // library marker kkossev.thermostatLib, line 274 case 0x00ff: // unknown // library marker kkossev.thermostatLib, line 275 case 0x00f7: // unknown // library marker kkossev.thermostatLib, line 276 case 0xfff2: // unknown // library marker kkossev.thermostatLib, line 277 case 0x00FF: // library marker kkossev.thermostatLib, line 278 try { // library marker kkossev.thermostatLib, line 279 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 280 logDebug "Aqara E1 TRV unknown attribute ${descMap.attrInt} value raw = ${raw}" // library marker kkossev.thermostatLib, line 281 } // library marker kkossev.thermostatLib, line 282 catch (e) { // library marker kkossev.thermostatLib, line 283 logWarn "exception caught while processing Aqara E1 TRV unknown attribute ${descMap.attrInt} descMap.value = ${descMap.value}" // library marker kkossev.thermostatLib, line 284 } // library marker kkossev.thermostatLib, line 285 break; // library marker kkossev.thermostatLib, line 286 case 0x027e: // result['sensor'] = {1: 'external', 0: 'internal'}[value]; - read only? // library marker kkossev.thermostatLib, line 287 raw = hexStrToUnsignedInt(descMap.value) // library marker kkossev.thermostatLib, line 288 value = SensorOpts.options[raw as int] // library marker kkossev.thermostatLib, line 289 thermostatEvent("sensor", value, raw) // library marker kkossev.thermostatLib, line 290 break; // library marker kkossev.thermostatLib, line 291 default: // library marker kkossev.thermostatLib, line 292 logWarn "parseXiaomiClusterThermostatLib: received unknown xiaomi cluster 0xFCC0 attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.thermostatLib, line 293 break // library marker kkossev.thermostatLib, line 294 } // library marker kkossev.thermostatLib, line 295 } // library marker kkossev.thermostatLib, line 296 // called from parseXiaomiClusterThermostatLib // library marker kkossev.thermostatLib, line 298 void parseXiaomiClusterThermostatTags(final Map tags) { // library marker kkossev.thermostatLib, line 299 tags.each { final Integer tag, final Object value -> // library marker kkossev.thermostatLib, line 300 switch (tag) { // library marker kkossev.thermostatLib, line 301 case 0x01: // battery voltage // library marker kkossev.thermostatLib, line 302 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} battery voltage is ${value/1000}V (raw=${value})" // library marker kkossev.thermostatLib, line 303 break // library marker kkossev.thermostatLib, line 304 case 0x03: // library marker kkossev.thermostatLib, line 305 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} device internal chip temperature is ${value}° (ignore it!)" // library marker kkossev.thermostatLib, line 306 break // library marker kkossev.thermostatLib, line 307 case 0x05: // library marker kkossev.thermostatLib, line 308 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} RSSI is ${value}" // library marker kkossev.thermostatLib, line 309 break // library marker kkossev.thermostatLib, line 310 case 0x06: // library marker kkossev.thermostatLib, line 311 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} LQI is ${value}" // library marker kkossev.thermostatLib, line 312 break // library marker kkossev.thermostatLib, line 313 case 0x08: // SWBUILD_TAG_ID: // library marker kkossev.thermostatLib, line 314 final String swBuild = '0.0.0_' + (value & 0xFF).toString().padLeft(4, '0') // library marker kkossev.thermostatLib, line 315 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} swBuild is ${swBuild} (raw ${value})" // library marker kkossev.thermostatLib, line 316 device.updateDataValue("aqaraVersion", swBuild) // library marker kkossev.thermostatLib, line 317 break // library marker kkossev.thermostatLib, line 318 case 0x0a: // library marker kkossev.thermostatLib, line 319 String nwk = intToHexStr(value as Integer,2) // library marker kkossev.thermostatLib, line 320 if (state.health == null) { state.health = [:] } // library marker kkossev.thermostatLib, line 321 String oldNWK = state.health['parentNWK'] ?: 'n/a' // library marker kkossev.thermostatLib, line 322 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} Parent NWK is ${nwk}" // library marker kkossev.thermostatLib, line 323 if (oldNWK != nwk ) { // library marker kkossev.thermostatLib, line 324 logWarn "parentNWK changed from ${oldNWK} to ${nwk}" // library marker kkossev.thermostatLib, line 325 state.health['parentNWK'] = nwk // library marker kkossev.thermostatLib, line 326 state.health['nwkCtr'] = (state.health['nwkCtr'] ?: 0) + 1 // library marker kkossev.thermostatLib, line 327 } // library marker kkossev.thermostatLib, line 328 break // library marker kkossev.thermostatLib, line 329 case 0x0d: // library marker kkossev.thermostatLib, line 330 logDebug "xiaomi decode E1 thermostat unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 331 break // library marker kkossev.thermostatLib, line 332 case 0x11: // library marker kkossev.thermostatLib, line 333 logDebug "xiaomi decode E1 thermostat unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 334 break // library marker kkossev.thermostatLib, line 335 case 0x64: // library marker kkossev.thermostatLib, line 336 logDebug "xiaomi decode tag: 0x${intToHexStr(tag, 1)} temperature is ${value/100} (raw ${value})" // Aqara TVOC // library marker kkossev.thermostatLib, line 337 break // library marker kkossev.thermostatLib, line 338 case 0x65: // library marker kkossev.thermostatLib, line 339 logDebug "xiaomi decode E1 thermostat unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 340 break // library marker kkossev.thermostatLib, line 341 case 0x66: // library marker kkossev.thermostatLib, line 342 logDebug "xiaomi decode E1 thermostat temperature tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 343 handleTemperatureEvent(value/100.0) // library marker kkossev.thermostatLib, line 344 break // library marker kkossev.thermostatLib, line 345 case 0x67: // library marker kkossev.thermostatLib, line 346 logDebug "xiaomi decode E1 thermostat heatingSetpoint tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 347 break // library marker kkossev.thermostatLib, line 348 case 0x68: // library marker kkossev.thermostatLib, line 349 logDebug "xiaomi decode E1 thermostat unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 350 break // library marker kkossev.thermostatLib, line 351 case 0x69: // library marker kkossev.thermostatLib, line 352 logDebug "xiaomi decode E1 thermostat battery tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 353 break // library marker kkossev.thermostatLib, line 354 case 0x6a: // library marker kkossev.thermostatLib, line 355 logDebug "xiaomi decode E1 thermostat unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 356 break // library marker kkossev.thermostatLib, line 357 default: // library marker kkossev.thermostatLib, line 358 logDebug "xiaomi decode unknown tag: 0x${intToHexStr(tag, 1)}=${value}" // library marker kkossev.thermostatLib, line 359 } // library marker kkossev.thermostatLib, line 360 } // library marker kkossev.thermostatLib, line 361 } // library marker kkossev.thermostatLib, line 362 /* // library marker kkossev.thermostatLib, line 365 * ----------------------------------------------------------------------------- // library marker kkossev.thermostatLib, line 366 * thermostat cluster 0x0201 // library marker kkossev.thermostatLib, line 367 * called from parseThermostatCluster() in the main code ... // library marker kkossev.thermostatLib, line 368 * ----------------------------------------------------------------------------- // library marker kkossev.thermostatLib, line 369 */ // library marker kkossev.thermostatLib, line 370 void parseThermostatClusterThermostat(final Map descMap) { // library marker kkossev.thermostatLib, line 372 final Integer value = safeToInt(hexStrToUnsignedInt(descMap.value)) // library marker kkossev.thermostatLib, line 373 if (settings.logEnable) { // library marker kkossev.thermostatLib, line 374 log.trace "zigbee received Thermostat cluster (0x0201) attribute 0x${descMap.attrId} value ${value} (raw ${descMap.value})" // library marker kkossev.thermostatLib, line 375 } // library marker kkossev.thermostatLib, line 376 switch (descMap.attrInt as Integer) { // library marker kkossev.thermostatLib, line 378 case 0x000: // temperature // library marker kkossev.thermostatLib, line 379 logDebug "temperature = ${value/100.0} (raw ${value})" // library marker kkossev.thermostatLib, line 380 handleTemperatureEvent(value/100.0) // library marker kkossev.thermostatLib, line 381 break // library marker kkossev.thermostatLib, line 382 case 0x0011: // cooling setpoint // library marker kkossev.thermostatLib, line 383 logInfo "cooling setpoint = ${value/100.0} (raw ${value})" // library marker kkossev.thermostatLib, line 384 break // library marker kkossev.thermostatLib, line 385 case 0x0012: // heating setpoint // library marker kkossev.thermostatLib, line 386 logInfo "heating setpoint = ${value/100.0} (raw ${value})" // library marker kkossev.thermostatLib, line 387 handleHeatingSetpointEvent(value/100.0) // library marker kkossev.thermostatLib, line 388 break // library marker kkossev.thermostatLib, line 389 case 0x001c: // mode // library marker kkossev.thermostatLib, line 390 logInfo "mode = ${value} (raw ${value})" // library marker kkossev.thermostatLib, line 391 break // library marker kkossev.thermostatLib, line 392 case 0x001e: // thermostatRunMode // library marker kkossev.thermostatLib, line 393 logInfo "thermostatRunMode = ${value} (raw ${value})" // library marker kkossev.thermostatLib, line 394 break // library marker kkossev.thermostatLib, line 395 case 0x0020: // battery // library marker kkossev.thermostatLib, line 396 logInfo "battery = ${value} (raw ${value})" // library marker kkossev.thermostatLib, line 397 break // library marker kkossev.thermostatLib, line 398 case 0x0023: // thermostatHoldMode // library marker kkossev.thermostatLib, line 399 logInfo "thermostatHoldMode = ${value} (raw ${value})" // library marker kkossev.thermostatLib, line 400 break // library marker kkossev.thermostatLib, line 401 case 0x0029: // thermostatOperatingState // library marker kkossev.thermostatLib, line 402 logInfo "thermostatOperatingState = ${value} (raw ${value})" // library marker kkossev.thermostatLib, line 403 break // library marker kkossev.thermostatLib, line 404 case 0xfff2: // unknown // library marker kkossev.thermostatLib, line 405 logDebug "Aqara E1 TRV unknown attribute ${descMap.attrInt} value raw = ${value}" // library marker kkossev.thermostatLib, line 406 break; // library marker kkossev.thermostatLib, line 407 default: // library marker kkossev.thermostatLib, line 408 log.warn "zigbee received unknown Thermostat cluster (0x0201) attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.thermostatLib, line 409 break // library marker kkossev.thermostatLib, line 410 } // library marker kkossev.thermostatLib, line 411 } // library marker kkossev.thermostatLib, line 412 def handleHeatingSetpointEvent( temperature ) { // library marker kkossev.thermostatLib, line 414 setHeatingSetpoint(temperature) // library marker kkossev.thermostatLib, line 415 } // library marker kkossev.thermostatLib, line 416 // ThermostatHeatingSetpoint command // library marker kkossev.thermostatLib, line 418 // sends TuyaCommand and checks after 4 seconds // library marker kkossev.thermostatLib, line 419 // 1°C steps. (0.5°C setting on the TRV itself, rounded for zigbee interface) // library marker kkossev.thermostatLib, line 420 def setHeatingSetpoint( temperature ) { // library marker kkossev.thermostatLib, line 421 def previousSetpoint = device.currentState('heatingSetpoint')?.value ?: 0 // library marker kkossev.thermostatLib, line 422 double tempDouble // library marker kkossev.thermostatLib, line 423 //logDebug "setHeatingSetpoint temperature = ${temperature} as int = ${temperature as int} (previousSetpointt = ${previousSetpoint})" // library marker kkossev.thermostatLib, line 424 if (true) { // library marker kkossev.thermostatLib, line 425 //logDebug "0.5 C correction of the heating setpoint${temperature}" // library marker kkossev.thermostatLib, line 426 tempDouble = safeToDouble(temperature) // library marker kkossev.thermostatLib, line 427 tempDouble = Math.round(tempDouble * 2) / 2.0 // library marker kkossev.thermostatLib, line 428 } // library marker kkossev.thermostatLib, line 429 else { // library marker kkossev.thermostatLib, line 430 if (temperature != (temperature as int)) { // library marker kkossev.thermostatLib, line 431 if ((temperature as double) > (previousSetpoint as double)) { // library marker kkossev.thermostatLib, line 432 temperature = (temperature + 0.5 ) as int // library marker kkossev.thermostatLib, line 433 } // library marker kkossev.thermostatLib, line 434 else { // library marker kkossev.thermostatLib, line 435 temperature = temperature as int // library marker kkossev.thermostatLib, line 436 } // library marker kkossev.thermostatLib, line 437 logDebug "corrected heating setpoint ${temperature}" // library marker kkossev.thermostatLib, line 438 } // library marker kkossev.thermostatLib, line 439 tempDouble = temperature // library marker kkossev.thermostatLib, line 440 } // library marker kkossev.thermostatLib, line 441 def maxTemp = settings?.maxThermostatTemp ?: 50 // library marker kkossev.thermostatLib, line 442 def minTemp = settings?.minThermostatTemp ?: 5 // library marker kkossev.thermostatLib, line 443 if (tempDouble > maxTemp ) tempDouble = maxTemp // library marker kkossev.thermostatLib, line 444 if (tempDouble < minTemp) tempDouble = minTemp // library marker kkossev.thermostatLib, line 445 tempDouble = tempDouble.round(1) // library marker kkossev.thermostatLib, line 446 Map eventMap = [name: "heatingSetpoint", value: tempDouble, unit: "\u00B0"+"C"] // library marker kkossev.thermostatLib, line 447 eventMap.descriptionText = "heatingSetpoint is ${tempDouble}" // library marker kkossev.thermostatLib, line 448 sendHeatingSetpointEvent(eventMap) // library marker kkossev.thermostatLib, line 449 eventMap = [name: "thermostatSetpoint", value: tempDouble, unit: "\u00B0"+"C"] // library marker kkossev.thermostatLib, line 450 eventMap.descriptionText = null // library marker kkossev.thermostatLib, line 451 sendHeatingSetpointEvent(eventMap) // library marker kkossev.thermostatLib, line 452 updateDataValue("lastRunningMode", "heat") // library marker kkossev.thermostatLib, line 453 // // library marker kkossev.thermostatLib, line 454 zigbee.writeAttribute(0x0201, 0x12, 0x29, (tempDouble * 100) as int) // raw:F6690102010A1200299808, dni:F669, endpoint:01, cluster:0201, size:0A, attrId:0012, encoding:29, command:0A, value:0898, clusterInt:513, attrInt:18 // library marker kkossev.thermostatLib, line 455 } // library marker kkossev.thermostatLib, line 456 private void sendHeatingSetpointEvent(Map eventMap) { // library marker kkossev.thermostatLib, line 458 if (eventMap.descriptionText != null) { logInfo "${eventMap.descriptionText}" } // library marker kkossev.thermostatLib, line 459 sendEvent(eventMap) // library marker kkossev.thermostatLib, line 460 } // library marker kkossev.thermostatLib, line 461 // TODO - not called // library marker kkossev.thermostatLib, line 463 void processTuyaDpThermostat(descMap, dp, dp_id, fncmd) { // library marker kkossev.thermostatLib, line 464 switch (dp) { // library marker kkossev.thermostatLib, line 466 case 0x01 : // on/off // library marker kkossev.thermostatLib, line 467 sendSwitchEvent(fncmd) // library marker kkossev.thermostatLib, line 468 break // library marker kkossev.thermostatLib, line 469 default : // library marker kkossev.thermostatLib, line 470 logWarn "NOT PROCESSED Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" // library marker kkossev.thermostatLib, line 471 break // library marker kkossev.thermostatLib, line 472 } // library marker kkossev.thermostatLib, line 473 } // library marker kkossev.thermostatLib, line 474 def preset( preset ) { // library marker kkossev.thermostatLib, line 477 logDebug "preset(${preset}) called!" // library marker kkossev.thermostatLib, line 478 if (preset == "auto") { // library marker kkossev.thermostatLib, line 479 setPresetMode("auto") // hand symbol NOT shown // library marker kkossev.thermostatLib, line 480 } // library marker kkossev.thermostatLib, line 481 else if (preset == "manual") { // library marker kkossev.thermostatLib, line 482 setPresetMode("manual") // hand symbol is shown on the LCD // library marker kkossev.thermostatLib, line 483 } // library marker kkossev.thermostatLib, line 484 else if (preset == "away") { // library marker kkossev.thermostatLib, line 485 setPresetMode("away") // 5 degreees // library marker kkossev.thermostatLib, line 486 } // library marker kkossev.thermostatLib, line 487 else { // library marker kkossev.thermostatLib, line 488 logWarn "preset: unknown preset ${preset}" // library marker kkossev.thermostatLib, line 489 } // library marker kkossev.thermostatLib, line 490 } // library marker kkossev.thermostatLib, line 491 def setPresetMode(mode) { // library marker kkossev.thermostatLib, line 493 List cmds = [] // library marker kkossev.thermostatLib, line 494 logDebug "sending setPresetMode(${mode})" // library marker kkossev.thermostatLib, line 495 if (isAqaraTRV()) { // library marker kkossev.thermostatLib, line 496 // {'manual': 0, 'auto': 1, 'away': 2}), type: 0x20} // library marker kkossev.thermostatLib, line 497 if (mode == "auto") { // library marker kkossev.thermostatLib, line 498 cmds = zigbee.writeAttribute(0xFCC0, 0x0272, 0x20, 0x01, [mfgCode: 0x115F], delay=200) // library marker kkossev.thermostatLib, line 499 } // library marker kkossev.thermostatLib, line 500 else if (mode == "manual") { // library marker kkossev.thermostatLib, line 501 cmds = zigbee.writeAttribute(0xFCC0, 0x0272, 0x20, 0x00, [mfgCode: 0x115F], delay=200) // library marker kkossev.thermostatLib, line 502 } // library marker kkossev.thermostatLib, line 503 else if (mode == "away") { // library marker kkossev.thermostatLib, line 504 cmds = zigbee.writeAttribute(0xFCC0, 0x0272, 0x20, 0x02, [mfgCode: 0x115F], delay=200) // library marker kkossev.thermostatLib, line 505 } // library marker kkossev.thermostatLib, line 506 else { // library marker kkossev.thermostatLib, line 507 logWarn "setPresetMode: Aqara TRV unknown preset ${mode}" // library marker kkossev.thermostatLib, line 508 } // library marker kkossev.thermostatLib, line 509 } // library marker kkossev.thermostatLib, line 510 else { // library marker kkossev.thermostatLib, line 511 // TODO - set generic thermostat mode // library marker kkossev.thermostatLib, line 512 log.warn "setPresetMode NOT IMPLEMENTED" // library marker kkossev.thermostatLib, line 513 return // library marker kkossev.thermostatLib, line 514 } // library marker kkossev.thermostatLib, line 515 if (cmds == []) { cmds = ["delay 299"] } // library marker kkossev.thermostatLib, line 516 sendZigbeeCommands(cmds) // library marker kkossev.thermostatLib, line 517 } // library marker kkossev.thermostatLib, line 519 def setThermostatMode( mode ) { // library marker kkossev.thermostatLib, line 521 List cmds = [] // library marker kkossev.thermostatLib, line 522 logDebug "sending setThermostatMode(${mode})" // library marker kkossev.thermostatLib, line 523 //state.mode = mode // library marker kkossev.thermostatLib, line 524 if (isAqaraTRV()) { // library marker kkossev.thermostatLib, line 525 // TODO - set Aqara E1 thermostat mode // library marker kkossev.thermostatLib, line 526 switch(mode) { // library marker kkossev.thermostatLib, line 527 case "off": // library marker kkossev.thermostatLib, line 528 cmds = zigbee.writeAttribute(0xFCC0, 0x0271, 0x20, 0x00, [mfgCode: 0x115F], delay=200) // 'off': 0, 'heat': 1 // library marker kkossev.thermostatLib, line 529 break // library marker kkossev.thermostatLib, line 530 case "heat": // library marker kkossev.thermostatLib, line 531 cmds = zigbee.writeAttribute(0xFCC0, 0x0271, 0x20, 0x01, [mfgCode: 0x115F], delay=200) // 'off': 0, 'heat': 1 // library marker kkossev.thermostatLib, line 532 break // library marker kkossev.thermostatLib, line 533 default: // library marker kkossev.thermostatLib, line 534 logWarn "setThermostatMode: unknown AqaraTRV mode ${mode}" // library marker kkossev.thermostatLib, line 535 break // library marker kkossev.thermostatLib, line 536 } // library marker kkossev.thermostatLib, line 537 } // library marker kkossev.thermostatLib, line 538 else { // library marker kkossev.thermostatLib, line 539 // TODO - set generic thermostat mode // library marker kkossev.thermostatLib, line 540 log.warn "setThermostatMode NOT IMPLEMENTED" // library marker kkossev.thermostatLib, line 541 return // library marker kkossev.thermostatLib, line 542 } // library marker kkossev.thermostatLib, line 543 if (cmds == []) { cmds = ["delay 299"] } // library marker kkossev.thermostatLib, line 544 sendZigbeeCommands(cmds) // library marker kkossev.thermostatLib, line 545 } // library marker kkossev.thermostatLib, line 546 def setCoolingSetpoint(temperature){ // library marker kkossev.thermostatLib, line 548 logDebug "setCoolingSetpoint(${temperature}) called!" // library marker kkossev.thermostatLib, line 549 if (temperature != (temperature as int)) { // library marker kkossev.thermostatLib, line 550 temperature = (temperature + 0.5 ) as int // library marker kkossev.thermostatLib, line 551 logDebug "corrected temperature: ${temperature}" // library marker kkossev.thermostatLib, line 552 } // library marker kkossev.thermostatLib, line 553 sendEvent(name: "coolingSetpoint", value: temperature, unit: "\u00B0"+"C") // library marker kkossev.thermostatLib, line 554 } // library marker kkossev.thermostatLib, line 555 def heat(){ // library marker kkossev.thermostatLib, line 558 setThermostatMode("heat") // library marker kkossev.thermostatLib, line 559 } // library marker kkossev.thermostatLib, line 560 def thermostatOff(){ // library marker kkossev.thermostatLib, line 562 setThermostatMode("off") // library marker kkossev.thermostatLib, line 563 } // library marker kkossev.thermostatLib, line 564 def thermostatOn() { // library marker kkossev.thermostatLib, line 566 heat() // library marker kkossev.thermostatLib, line 567 } // library marker kkossev.thermostatLib, line 568 def setThermostatFanMode(fanMode) { sendEvent(name: "thermostatFanMode", value: "${fanMode}", descriptionText: getDescriptionText("thermostatFanMode is ${fanMode}")) } // library marker kkossev.thermostatLib, line 570 def auto() { setThermostatMode("auto") } // library marker kkossev.thermostatLib, line 571 def emergencyHeat() { setThermostatMode("emergency heat") } // library marker kkossev.thermostatLib, line 572 def cool() { setThermostatMode("cool") } // library marker kkossev.thermostatLib, line 573 def fanAuto() { setThermostatFanMode("auto") } // library marker kkossev.thermostatLib, line 574 def fanCirculate() { setThermostatFanMode("circulate") } // library marker kkossev.thermostatLib, line 575 def fanOn() { setThermostatFanMode("on") } // library marker kkossev.thermostatLib, line 576 def sendThermostatOperatingStateEvent( st ) { // library marker kkossev.thermostatLib, line 578 sendEvent(name: "thermostatOperatingState", value: st) // library marker kkossev.thermostatLib, line 579 state.lastThermostatOperatingState = st // library marker kkossev.thermostatLib, line 580 } // library marker kkossev.thermostatLib, line 581 void sendSupportedThermostatModes() { // library marker kkossev.thermostatLib, line 583 def supportedThermostatModes = [] // library marker kkossev.thermostatLib, line 584 supportedThermostatModes = ["off", "heat", "auto"] // library marker kkossev.thermostatLib, line 585 logInfo "supportedThermostatModes: ${supportedThermostatModes}" // library marker kkossev.thermostatLib, line 586 sendEvent(name: "supportedThermostatModes", value: JsonOutput.toJson(supportedThermostatModes), isStateChange: true) // library marker kkossev.thermostatLib, line 587 } // library marker kkossev.thermostatLib, line 588 /** // library marker kkossev.thermostatLib, line 591 * Schedule thermostat polling // library marker kkossev.thermostatLib, line 592 * @param intervalMins interval in seconds // library marker kkossev.thermostatLib, line 593 */ // library marker kkossev.thermostatLib, line 594 private void scheduleThermostatPolling(final int intervalSecs) { // library marker kkossev.thermostatLib, line 595 String cron = getCron( intervalSecs ) // library marker kkossev.thermostatLib, line 596 logDebug "cron = ${cron}" // library marker kkossev.thermostatLib, line 597 schedule(cron, 'autoPollThermostat') // library marker kkossev.thermostatLib, line 598 } // library marker kkossev.thermostatLib, line 599 private void unScheduleThermostatPolling() { // library marker kkossev.thermostatLib, line 601 unschedule('autoPollThermostat') // library marker kkossev.thermostatLib, line 602 } // library marker kkossev.thermostatLib, line 603 /** // library marker kkossev.thermostatLib, line 605 * Scheduled job for polling device specific attribute(s) // library marker kkossev.thermostatLib, line 606 */ // library marker kkossev.thermostatLib, line 607 void autoPollThermostat() { // library marker kkossev.thermostatLib, line 608 logDebug "autoPollThermostat()..." // library marker kkossev.thermostatLib, line 609 checkDriverVersion() // library marker kkossev.thermostatLib, line 610 List cmds = [] // library marker kkossev.thermostatLib, line 611 if (state.states == null) state.states = [:] // library marker kkossev.thermostatLib, line 612 //state.states["isRefresh"] = true // library marker kkossev.thermostatLib, line 613 cmds += zigbee.readAttribute(0x0201, 0x0000, [:], delay=3500) // 0x0000=local temperature, 0x0011=cooling setpoint, 0x0012=heating setpoint, 0x001B=controlledSequenceOfOperation, 0x001C=system mode (enum8 ) // library marker kkossev.thermostatLib, line 615 if (cmds != null && cmds != [] ) { // library marker kkossev.thermostatLib, line 617 sendZigbeeCommands(cmds) // library marker kkossev.thermostatLib, line 618 } // library marker kkossev.thermostatLib, line 619 } // library marker kkossev.thermostatLib, line 620 // // library marker kkossev.thermostatLib, line 622 // called from updated() in the main code ... // library marker kkossev.thermostatLib, line 623 void updatedThermostat() { // library marker kkossev.thermostatLib, line 624 logDebug "updatedThermostat()..." // library marker kkossev.thermostatLib, line 625 // // library marker kkossev.thermostatLib, line 626 if (settings?.forcedProfile != null) { // library marker kkossev.thermostatLib, line 627 logDebug "current state.deviceProfile=${state.deviceProfile}, settings.forcedProfile=${settings?.forcedProfile}, getProfileKey()=${getProfileKey(settings?.forcedProfile)}" // library marker kkossev.thermostatLib, line 628 if (getProfileKey(settings?.forcedProfile) != state.deviceProfile) { // library marker kkossev.thermostatLib, line 629 logWarn "changing the device profile from ${state.deviceProfile} to ${getProfileKey(settings?.forcedProfile)}" // library marker kkossev.thermostatLib, line 630 state.deviceProfile = getProfileKey(settings?.forcedProfile) // library marker kkossev.thermostatLib, line 631 //initializeVars(fullInit = false) // library marker kkossev.thermostatLib, line 632 initVarsThermostat(fullInit = false) // library marker kkossev.thermostatLib, line 633 resetPreferencesToDefaults(debug=true) // library marker kkossev.thermostatLib, line 634 logInfo "press F5 to refresh the page" // library marker kkossev.thermostatLib, line 635 } // library marker kkossev.thermostatLib, line 636 } // library marker kkossev.thermostatLib, line 637 else { // library marker kkossev.thermostatLib, line 638 logDebug "forcedProfile is not set" // library marker kkossev.thermostatLib, line 639 } // library marker kkossev.thermostatLib, line 640 final int pollingInterval = (settings.temperaturePollingInterval as Integer) ?: 0 // library marker kkossev.thermostatLib, line 641 if (pollingInterval > 0) { // library marker kkossev.thermostatLib, line 642 logInfo "updatedThermostat: scheduling temperature polling every ${pollingInterval} seconds" // library marker kkossev.thermostatLib, line 643 scheduleThermostatPolling(pollingInterval) // library marker kkossev.thermostatLib, line 644 } // library marker kkossev.thermostatLib, line 645 else { // library marker kkossev.thermostatLib, line 646 unScheduleThermostatPolling() // library marker kkossev.thermostatLib, line 647 logInfo "updatedThermostat: thermostat polling is disabled!" // library marker kkossev.thermostatLib, line 648 } // library marker kkossev.thermostatLib, line 649 } // library marker kkossev.thermostatLib, line 650 def refreshThermostat() { // library marker kkossev.thermostatLib, line 652 List cmds = [] // library marker kkossev.thermostatLib, line 653 //cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay=200) // battery voltage (E1 does not send percentage) // library marker kkossev.thermostatLib, line 654 cmds += zigbee.readAttribute(0x0201, [0x0000, 0x0011, 0x0012, 0x001B, 0x001C], [:], delay=3500) // 0x0000=local temperature, 0x0011=cooling setpoint, 0x0012=heating setpoint, 0x001B=controlledSequenceOfOperation, 0x001C=system mode (enum8 ) // library marker kkossev.thermostatLib, line 655 cmds += zigbee.readAttribute(0xFCC0, [0x0271, 0x0272, 0x0273, 0x0274, 0x0275, 0x0277, 0x0279, 0x027A, 0x027B, 0x027E], [mfgCode: 0x115F], delay=3500) // library marker kkossev.thermostatLib, line 657 cmds += zigbee.readAttribute(0xFCC0, 0x040a, [mfgCode: 0x115F], delay=500) // library marker kkossev.thermostatLib, line 658 // stock Generic Zigbee Thermostat Refresh answer: // library marker kkossev.thermostatLib, line 660 // raw:F669010201441C0030011E008600000029640A2900861B0000300412000029540B110000299808, dni:F669, endpoint:01, cluster:0201, size:44, attrId:001C, encoding:30, command:01, value:01, clusterInt:513, attrInt:28, additionalAttrs:[[status:86, attrId:001E, attrInt:30], [value:0A64, encoding:29, attrId:0000, consumedBytes:5, attrInt:0], [status:86, attrId:0029, attrInt:41], [value:04, encoding:30, attrId:001B, consumedBytes:4, attrInt:27], [value:0B54, encoding:29, attrId:0012, consumedBytes:5, attrInt:18], [value:0898, encoding:29, attrId:0011, consumedBytes:5, attrInt:17]] // library marker kkossev.thermostatLib, line 661 // conclusion : binding and reporting configuration for this Aqara E1 thermostat does nothing... We need polling mechanism for faster updates of the internal temperature readings. // library marker kkossev.thermostatLib, line 662 if (cmds == []) { cmds = ["delay 299"] } // library marker kkossev.thermostatLib, line 663 logDebug "refreshThermostat: ${cmds} " // library marker kkossev.thermostatLib, line 664 return cmds // library marker kkossev.thermostatLib, line 665 } // library marker kkossev.thermostatLib, line 666 def configureThermostat() { // library marker kkossev.thermostatLib, line 668 List cmds = [] // library marker kkossev.thermostatLib, line 669 // TODO !! // library marker kkossev.thermostatLib, line 670 logDebug "configureThermostat() : ${cmds}" // library marker kkossev.thermostatLib, line 671 if (cmds == []) { cmds = ["delay 299"] } // no , // library marker kkossev.thermostatLib, line 672 return cmds // library marker kkossev.thermostatLib, line 673 } // library marker kkossev.thermostatLib, line 674 def initializeThermostat() // library marker kkossev.thermostatLib, line 676 { // library marker kkossev.thermostatLib, line 677 List cmds = [] // library marker kkossev.thermostatLib, line 678 int intMinTime = 300 // library marker kkossev.thermostatLib, line 679 int intMaxTime = 600 // report temperature every 10 minutes ! // library marker kkossev.thermostatLib, line 680 logDebug "configuring cluster 0x0201 ..." // library marker kkossev.thermostatLib, line 682 cmds += ["zdo bind 0x${device.deviceNetworkId} 0x01 0x01 0x0201 {${device.zigbeeId}} {}", "delay 251", ] // library marker kkossev.thermostatLib, line 683 //cmds += zigbee.configureReporting(0x0201, 0x0012, 0x29, intMinTime as int, intMaxTime as int, 0x01, [:], delay=541) // library marker kkossev.thermostatLib, line 684 //cmds += zigbee.configureReporting(0x0201, 0x0000, 0x29, 20, 120, 0x01, [:], delay=542) // library marker kkossev.thermostatLib, line 685 cmds += ["he cr 0x${device.deviceNetworkId} 0x01 0x0201 0x0012 0x29 1 600 {}", "delay 551", ] // library marker kkossev.thermostatLib, line 687 cmds += ["he cr 0x${device.deviceNetworkId} 0x01 0x0201 0x0000 0x29 20 300 {}", "delay 551", ] // library marker kkossev.thermostatLib, line 688 cmds += ["he cr 0x${device.deviceNetworkId} 0x01 0x0201 0x001C 0x30 1 600 {}", "delay 551", ] // library marker kkossev.thermostatLib, line 689 cmds += zigbee.reportingConfiguration(0x0201, 0x0012, [:], 551) // read it back - doesn't work // library marker kkossev.thermostatLib, line 691 cmds += zigbee.reportingConfiguration(0x0201, 0x0000, [:], 552) // read it back - doesn't wor // library marker kkossev.thermostatLib, line 692 cmds += zigbee.reportingConfiguration(0x0201, 0x001C, [:], 552) // read it back - doesn't wor // library marker kkossev.thermostatLib, line 693 logDebug "initializeThermostat() : ${cmds}" // library marker kkossev.thermostatLib, line 696 if (cmds == []) { cmds = ["delay 299",] } // library marker kkossev.thermostatLib, line 697 return cmds // library marker kkossev.thermostatLib, line 698 } // library marker kkossev.thermostatLib, line 699 void initVarsThermostat(boolean fullInit=false) { // library marker kkossev.thermostatLib, line 702 logDebug "initVarsThermostat(${fullInit})" // library marker kkossev.thermostatLib, line 703 if (state.deviceProfile == null) { // library marker kkossev.thermostatLib, line 704 setDeviceNameAndProfile() // in deviceProfileiLib.groovy // library marker kkossev.thermostatLib, line 705 } // library marker kkossev.thermostatLib, line 706 if (fullInit == true || state.lastThermostatMode == null) state.lastThermostatMode = "unknown" // library marker kkossev.thermostatLib, line 708 if (fullInit == true || state.lastThermostatOperatingState == null) state.lastThermostatOperatingState = "unknown" // library marker kkossev.thermostatLib, line 709 if (fullInit || settings?.temperaturePollingInterval == null) device.updateSetting('temperaturePollingInterval', [value: TemperaturePollingIntervalOpts.defaultValue.toString(), type: 'enum']) // library marker kkossev.thermostatLib, line 710 if (fullInit == true) { // library marker kkossev.thermostatLib, line 712 resetPreferencesToDefaults() // library marker kkossev.thermostatLib, line 713 } // library marker kkossev.thermostatLib, line 714 // // library marker kkossev.thermostatLib, line 715 } // library marker kkossev.thermostatLib, line 717 void initEventsThermostat(boolean fullInit=false) { // library marker kkossev.thermostatLib, line 720 sendSupportedThermostatModes() // library marker kkossev.thermostatLib, line 721 sendEvent(name: "supportedThermostatFanModes", value: JsonOutput.toJson(["auto"]), isStateChange: true) // library marker kkossev.thermostatLib, line 722 sendEvent(name: "thermostatMode", value: "heat", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 723 sendEvent(name: "thermostatFanMode", value: "auto", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 724 state.lastThermostatMode = "heat" // library marker kkossev.thermostatLib, line 725 sendThermostatOperatingStateEvent( "idle" ) // library marker kkossev.thermostatLib, line 726 sendEvent(name: "thermostatOperatingState", value: "idle", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 727 sendEvent(name: "thermostatSetpoint", value: 12.3, unit: "\u00B0"+"C", isStateChange: true, description: "inital attribute setting") // Google Home compatibility // library marker kkossev.thermostatLib, line 728 sendEvent(name: "heatingSetpoint", value: 12.3, unit: "\u00B0"+"C", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 729 sendEvent(name: "coolingSetpoint", value: 34.5, unit: "\u00B0"+"C", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 730 sendEvent(name: "temperature", value: 23.4, unit: "\u00B0"+"C", isStateChange: true, description: "inital attribute setting") // library marker kkossev.thermostatLib, line 731 updateDataValue("lastRunningMode", "heat") // library marker kkossev.thermostatLib, line 732 } // library marker kkossev.thermostatLib, line 734 private getDescriptionText(msg) { // library marker kkossev.thermostatLib, line 736 def descriptionText = "${device.displayName} ${msg}" // library marker kkossev.thermostatLib, line 737 if (settings?.txtEnable) log.info "${descriptionText}" // library marker kkossev.thermostatLib, line 738 return descriptionText // library marker kkossev.thermostatLib, line 739 } // library marker kkossev.thermostatLib, line 740 def testT(par) { // library marker kkossev.thermostatLib, line 742 logWarn "testT(${par})" // library marker kkossev.thermostatLib, line 743 } // library marker kkossev.thermostatLib, line 744 // ~~~~~ end include (140) kkossev.thermostatLib ~~~~~ // ~~~~~ start include (142) kkossev.deviceProfileLib ~~~~~ library ( // library marker kkossev.deviceProfileLib, line 1 base: "driver", // library marker kkossev.deviceProfileLib, line 2 author: "Krassimir Kossev", // library marker kkossev.deviceProfileLib, line 3 category: "zigbee", // library marker kkossev.deviceProfileLib, line 4 description: "Device Profile Library", // library marker kkossev.deviceProfileLib, line 5 name: "deviceProfileLib", // library marker kkossev.deviceProfileLib, line 6 namespace: "kkossev", // library marker kkossev.deviceProfileLib, line 7 importUrl: "https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/deviceProfileLib.groovy", // library marker kkossev.deviceProfileLib, line 8 version: "1.0.0", // library marker kkossev.deviceProfileLib, line 9 documentationLink: "" // library marker kkossev.deviceProfileLib, line 10 ) // library marker kkossev.deviceProfileLib, line 11 /* // library marker kkossev.deviceProfileLib, line 12 * Device Profile Library // library marker kkossev.deviceProfileLib, line 13 * // library marker kkossev.deviceProfileLib, line 14 * Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.deviceProfileLib, line 15 * in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.deviceProfileLib, line 16 * // library marker kkossev.deviceProfileLib, line 17 * http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.deviceProfileLib, line 18 * // library marker kkossev.deviceProfileLib, line 19 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.deviceProfileLib, line 20 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.deviceProfileLib, line 21 * for the specific language governing permissions and limitations under the License. // library marker kkossev.deviceProfileLib, line 22 * // library marker kkossev.deviceProfileLib, line 23 * ver. 1.0.0 2023-11-04 kkossev - added deviceProfileLib (based on Tuya 4 In 1 driver) // library marker kkossev.deviceProfileLib, line 24 * ver. 1.0.1 2023-11-04 kkossev - (dev. branch) // library marker kkossev.deviceProfileLib, line 25 * // library marker kkossev.deviceProfileLib, line 26 * TODO: setPar refactoring // library marker kkossev.deviceProfileLib, line 27 */ // library marker kkossev.deviceProfileLib, line 28 def deviceProfileLibVersion() {"1.0.1"} // library marker kkossev.deviceProfileLib, line 30 def deviceProfileLibtamp() {"2023/11/05 9:45 AM"} // library marker kkossev.deviceProfileLib, line 31 metadata { // library marker kkossev.deviceProfileLib, line 33 // no capabilities // library marker kkossev.deviceProfileLib, line 34 // no attributes // library marker kkossev.deviceProfileLib, line 35 command "sendCommand", [[name: "sendCommand", type: "STRING", constraints: ["STRING"], description: "send device commands"]] // library marker kkossev.deviceProfileLib, line 36 command "setPar", [ // library marker kkossev.deviceProfileLib, line 37 [name:"par", type: "STRING", description: "preference parameter name", constraints: ["STRING"]], // library marker kkossev.deviceProfileLib, line 38 [name:"val", type: "STRING", description: "preference parameter value", constraints: ["STRING"]] // library marker kkossev.deviceProfileLib, line 39 ] // library marker kkossev.deviceProfileLib, line 40 // // library marker kkossev.deviceProfileLib, line 41 // itterate over DEVICE.preferences map and inputIt all! // library marker kkossev.deviceProfileLib, line 42 (DEVICE.preferences).each { key, value -> // library marker kkossev.deviceProfileLib, line 43 if (inputIt(key) != null) { // library marker kkossev.deviceProfileLib, line 44 input inputIt(key) // library marker kkossev.deviceProfileLib, line 45 } // library marker kkossev.deviceProfileLib, line 46 } // library marker kkossev.deviceProfileLib, line 47 preferences { // library marker kkossev.deviceProfileLib, line 48 if (advancedOptions == true) { // library marker kkossev.deviceProfileLib, line 49 input (name: "forcedProfile", type: "enum", title: "Device Profile", description: "Forcely change the Device Profile, if the model/manufacturer was not recognized automatically.
Warning! Manually setting a device profile may not always work!", options: getDeviceProfilesMap()) // library marker kkossev.deviceProfileLib, line 50 } // library marker kkossev.deviceProfileLib, line 51 } // library marker kkossev.deviceProfileLib, line 52 } // library marker kkossev.deviceProfileLib, line 53 def getDeviceGroup() { state.deviceProfile ?: "UNKNOWN" } // library marker kkossev.deviceProfileLib, line 55 def getDEVICE() { deviceProfilesV2[getDeviceGroup()] } // library marker kkossev.deviceProfileLib, line 56 def getDeviceProfiles() { deviceProfilesV2.keySet() } // library marker kkossev.deviceProfileLib, line 57 def getDeviceProfilesMap() {deviceProfilesV2.values().description as List} // library marker kkossev.deviceProfileLib, line 58 /** // library marker kkossev.deviceProfileLib, line 61 * Returns the profile key for a given profile description. // library marker kkossev.deviceProfileLib, line 62 * @param valueStr The profile description to search for. // library marker kkossev.deviceProfileLib, line 63 * @return The profile key if found, otherwise null. // library marker kkossev.deviceProfileLib, line 64 */ // library marker kkossev.deviceProfileLib, line 65 def getProfileKey(String valueStr) { // library marker kkossev.deviceProfileLib, line 66 def key = null // library marker kkossev.deviceProfileLib, line 67 deviceProfilesV2.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 68 if (profileMap.description.equals(valueStr)) { // library marker kkossev.deviceProfileLib, line 69 key = profileName // library marker kkossev.deviceProfileLib, line 70 } // library marker kkossev.deviceProfileLib, line 71 } // library marker kkossev.deviceProfileLib, line 72 return key // library marker kkossev.deviceProfileLib, line 73 } // library marker kkossev.deviceProfileLib, line 74 /** // library marker kkossev.deviceProfileLib, line 76 * Finds the preferences map for the given parameter. // library marker kkossev.deviceProfileLib, line 77 * @param param The parameter to find the preferences map for. // library marker kkossev.deviceProfileLib, line 78 * @param debug Whether or not to output debug logs. // library marker kkossev.deviceProfileLib, line 79 * @return returns either tuyaDPs or attributes map, depending on where the preference (param) is found // library marker kkossev.deviceProfileLib, line 80 * @return null if param is not defined for this device. // library marker kkossev.deviceProfileLib, line 81 */ // library marker kkossev.deviceProfileLib, line 82 def getPreferencesMap( String param, boolean debug=false ) { // library marker kkossev.deviceProfileLib, line 83 Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 84 if (!(param in DEVICE.preferences)) { // library marker kkossev.deviceProfileLib, line 85 if (debug) log.warn "getPreferencesMap: preference ${param} not defined for this device!" // library marker kkossev.deviceProfileLib, line 86 return null // library marker kkossev.deviceProfileLib, line 87 } // library marker kkossev.deviceProfileLib, line 88 def preference // library marker kkossev.deviceProfileLib, line 89 try { // library marker kkossev.deviceProfileLib, line 90 preference = DEVICE.preferences["$param"] // library marker kkossev.deviceProfileLib, line 91 if (debug) log.debug "getPreferencesMap: preference ${param} found. value is ${preference}" // library marker kkossev.deviceProfileLib, line 92 if (preference in [true, false]) { // library marker kkossev.deviceProfileLib, line 93 // find the preference in the tuyaDPs map // library marker kkossev.deviceProfileLib, line 94 logDebug "getPreferencesMap: preference ${param} is boolean" // library marker kkossev.deviceProfileLib, line 95 return null // no maps for predefined preferences ! // library marker kkossev.deviceProfileLib, line 96 } // library marker kkossev.deviceProfileLib, line 97 if (preference.isNumber()) { // library marker kkossev.deviceProfileLib, line 98 // find the preference in the tuyaDPs map // library marker kkossev.deviceProfileLib, line 99 int dp = safeToInt(preference) // library marker kkossev.deviceProfileLib, line 100 def dpMaps = DEVICE.tuyaDPs // library marker kkossev.deviceProfileLib, line 101 foundMap = dpMaps.find { it.dp == dp } // library marker kkossev.deviceProfileLib, line 102 } // library marker kkossev.deviceProfileLib, line 103 else { // cluster:attribute // library marker kkossev.deviceProfileLib, line 104 if (debug) log.trace "${DEVICE.attributes}" // library marker kkossev.deviceProfileLib, line 105 def dpMaps = DEVICE.tuyaDPs // library marker kkossev.deviceProfileLib, line 106 foundMap = DEVICE.attributes.find { it.at == preference } // library marker kkossev.deviceProfileLib, line 107 } // library marker kkossev.deviceProfileLib, line 108 // TODO - could be also 'true' or 'false' ... // library marker kkossev.deviceProfileLib, line 109 } catch (Exception e) { // library marker kkossev.deviceProfileLib, line 110 if (debug) log.warn "getPreferencesMap: exception ${e} caught when getting preference ${param} !" // library marker kkossev.deviceProfileLib, line 111 return null // library marker kkossev.deviceProfileLib, line 112 } // library marker kkossev.deviceProfileLib, line 113 if (debug) log.debug "getPreferencesMap: foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 114 return foundMap // library marker kkossev.deviceProfileLib, line 115 } // library marker kkossev.deviceProfileLib, line 116 /** // library marker kkossev.deviceProfileLib, line 118 * Resets the device preferences to their default values. // library marker kkossev.deviceProfileLib, line 119 * @param debug A boolean indicating whether to output debug information. // library marker kkossev.deviceProfileLib, line 120 */ // library marker kkossev.deviceProfileLib, line 121 def resetPreferencesToDefaults(boolean debug=false ) { // library marker kkossev.deviceProfileLib, line 122 Map preferences = DEVICE?.preferences // library marker kkossev.deviceProfileLib, line 123 if (preferences == null) { // library marker kkossev.deviceProfileLib, line 124 logWarn "Preferences not found!" // library marker kkossev.deviceProfileLib, line 125 return // library marker kkossev.deviceProfileLib, line 126 } // library marker kkossev.deviceProfileLib, line 127 Map parMap = [:] // library marker kkossev.deviceProfileLib, line 128 preferences.each{ parName, mapValue -> // library marker kkossev.deviceProfileLib, line 129 if (debug) log.trace "$parName $mapValue" // library marker kkossev.deviceProfileLib, line 130 // TODO - could be also 'true' or 'false' ... // library marker kkossev.deviceProfileLib, line 131 if (mapValue in [true, false]) { // library marker kkossev.deviceProfileLib, line 132 logDebug "Preference ${parName} is predefined -> (${mapValue})" // library marker kkossev.deviceProfileLib, line 133 // TODO - set the predefined value // library marker kkossev.deviceProfileLib, line 134 /* // library marker kkossev.deviceProfileLib, line 135 if (debug) log.info "par ${parName} defaultValue = ${parMap.defaultValue}" // library marker kkossev.deviceProfileLib, line 136 device.updateSetting("${parMap.name}",[value:parMap.defaultValue, type:parMap.type]) // library marker kkossev.deviceProfileLib, line 137 */ // library marker kkossev.deviceProfileLib, line 138 return // continue // library marker kkossev.deviceProfileLib, line 139 } // library marker kkossev.deviceProfileLib, line 140 // find the individual preference map // library marker kkossev.deviceProfileLib, line 141 parMap = getPreferencesMap(parName, false) // library marker kkossev.deviceProfileLib, line 142 if (parMap == null) { // library marker kkossev.deviceProfileLib, line 143 logWarn "Preference ${parName} not found in tuyaDPs or attributes map!" // library marker kkossev.deviceProfileLib, line 144 return // continue // library marker kkossev.deviceProfileLib, line 145 } // library marker kkossev.deviceProfileLib, line 146 // parMap = [at:0xE002:0xE005, name:staticDetectionSensitivity, type:number, dt:UINT8, rw:rw, min:0, max:5, step:1, scale:1, unit:x, title:Static Detection Sensitivity, description:Static detection sensitivity] // library marker kkossev.deviceProfileLib, line 147 if (parMap.defaultValue == null) { // library marker kkossev.deviceProfileLib, line 148 logWarn "no default value for preference ${parName} !" // library marker kkossev.deviceProfileLib, line 149 return // continue // library marker kkossev.deviceProfileLib, line 150 } // library marker kkossev.deviceProfileLib, line 151 if (debug) log.info "par ${parName} defaultValue = ${parMap.defaultValue}" // library marker kkossev.deviceProfileLib, line 152 device.updateSetting("${parMap.name}",[value:parMap.defaultValue, type:parMap.type]) // library marker kkossev.deviceProfileLib, line 153 } // library marker kkossev.deviceProfileLib, line 154 logInfo "Preferences reset to default values" // library marker kkossev.deviceProfileLib, line 155 } // library marker kkossev.deviceProfileLib, line 156 /** // library marker kkossev.deviceProfileLib, line 158 * Returns a list of valid parameters per model based on the device preferences. // library marker kkossev.deviceProfileLib, line 159 * // library marker kkossev.deviceProfileLib, line 160 * @return List of valid parameters. // library marker kkossev.deviceProfileLib, line 161 */ // library marker kkossev.deviceProfileLib, line 162 def getValidParsPerModel() { // library marker kkossev.deviceProfileLib, line 163 List validPars = [] // library marker kkossev.deviceProfileLib, line 164 if (DEVICE?.preferences != null && DEVICE?.preferences != [:]) { // library marker kkossev.deviceProfileLib, line 165 // use the preferences to validate the parameters // library marker kkossev.deviceProfileLib, line 166 validPars = DEVICE.preferences.keySet().toList() // library marker kkossev.deviceProfileLib, line 167 } // library marker kkossev.deviceProfileLib, line 168 return validPars // library marker kkossev.deviceProfileLib, line 169 } // library marker kkossev.deviceProfileLib, line 170 /** // library marker kkossev.deviceProfileLib, line 173 * Called from setPar() method only! // library marker kkossev.deviceProfileLib, line 174 * Validates the parameter value based on the given dpMap type and scales it if needed. // library marker kkossev.deviceProfileLib, line 175 * // library marker kkossev.deviceProfileLib, line 176 * @param dpMap The map containing the parameter type, minimum and maximum values. // library marker kkossev.deviceProfileLib, line 177 * @param val The value to be validated and scaled. // library marker kkossev.deviceProfileLib, line 178 * @return The validated and scaled value if it is within the specified range, null otherwise. // library marker kkossev.deviceProfileLib, line 179 */ // library marker kkossev.deviceProfileLib, line 180 def validateAndScaleParameterValue(Map dpMap, String val) { // library marker kkossev.deviceProfileLib, line 181 def value = null // validated value - integer, floar // library marker kkossev.deviceProfileLib, line 182 def scaledValue = null // library marker kkossev.deviceProfileLib, line 183 logDebug "validateAndScaleParameterValue dpMap=${dpMap} val=${val}" // library marker kkossev.deviceProfileLib, line 184 switch (dpMap.type) { // library marker kkossev.deviceProfileLib, line 185 case "number" : // library marker kkossev.deviceProfileLib, line 186 value = safeToInt(val, -1) // library marker kkossev.deviceProfileLib, line 187 scaledValue = value // library marker kkossev.deviceProfileLib, line 188 // scale the value - added 10/26/2023 also for integer values ! // library marker kkossev.deviceProfileLib, line 189 if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 190 scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 191 } // library marker kkossev.deviceProfileLib, line 192 break // library marker kkossev.deviceProfileLib, line 193 case "decimal" : // library marker kkossev.deviceProfileLib, line 194 value = safeToDouble(val, -1.0) // library marker kkossev.deviceProfileLib, line 195 // scale the value // library marker kkossev.deviceProfileLib, line 196 if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 197 scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 198 } // library marker kkossev.deviceProfileLib, line 199 break // library marker kkossev.deviceProfileLib, line 200 case "bool" : // library marker kkossev.deviceProfileLib, line 201 if (val == '0' || val == 'false') { value = scaledValue = 0 } // library marker kkossev.deviceProfileLib, line 202 else if (val == '1' || val == 'true') { value = scaledValue = 1 } // library marker kkossev.deviceProfileLib, line 203 else { // library marker kkossev.deviceProfileLib, line 204 log.warn "${device.displayName} sevalidateAndScaleParameterValue: bool parameter ${val}. value must be one of 0 1 false true" // library marker kkossev.deviceProfileLib, line 205 return null // library marker kkossev.deviceProfileLib, line 206 } // library marker kkossev.deviceProfileLib, line 207 break // library marker kkossev.deviceProfileLib, line 208 case "enum" : // library marker kkossev.deviceProfileLib, line 209 // val could be both integer or float value ... check if the scaling is different than 1 in dpMap // library marker kkossev.deviceProfileLib, line 210 if (dpMap.scale != null && safeToInt(dpMap.scale) != 1) { // library marker kkossev.deviceProfileLib, line 212 // we have a float parameter input - convert it to int // library marker kkossev.deviceProfileLib, line 213 value = safeToDouble(val, -1.0) // library marker kkossev.deviceProfileLib, line 214 scaledValue = (value * safeToInt(dpMap.scale)) as Integer // library marker kkossev.deviceProfileLib, line 215 } // library marker kkossev.deviceProfileLib, line 216 else { // library marker kkossev.deviceProfileLib, line 217 value = scaledValue = safeToInt(val, -1) // library marker kkossev.deviceProfileLib, line 218 } // library marker kkossev.deviceProfileLib, line 219 if (scaledValue == null || scaledValue < 0) { // library marker kkossev.deviceProfileLib, line 220 // get the keys of dpMap.map as a List // library marker kkossev.deviceProfileLib, line 221 List keys = dpMap.map.keySet().toList() // library marker kkossev.deviceProfileLib, line 222 log.warn "${device.displayName} validateAndScaleParameterValue: enum parameter ${val}. value must be one of ${keys}" // library marker kkossev.deviceProfileLib, line 223 return null // library marker kkossev.deviceProfileLib, line 224 } // library marker kkossev.deviceProfileLib, line 225 break // library marker kkossev.deviceProfileLib, line 226 default : // library marker kkossev.deviceProfileLib, line 227 logWarn "validateAndScaleParameterValue: unsupported dpMap type ${parType}" // library marker kkossev.deviceProfileLib, line 228 return null // library marker kkossev.deviceProfileLib, line 229 } // library marker kkossev.deviceProfileLib, line 230 //log.warn "validateAndScaleParameterValue before checking scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 231 // check if the value is within the specified range // library marker kkossev.deviceProfileLib, line 232 if ((dpMap.min != null && value < dpMap.min) || (dpMap.max != null && value > dpMap.max)) { // library marker kkossev.deviceProfileLib, line 233 log.warn "${device.displayName} validateAndScaleParameterValue: invalid ${dpMap.name} parameter value ${value} (scaled ${scaledValue}). Value must be within ${dpMap.min} and ${dpMap.max}" // library marker kkossev.deviceProfileLib, line 234 return null // library marker kkossev.deviceProfileLib, line 235 } // library marker kkossev.deviceProfileLib, line 236 //log.warn "validateAndScaleParameterValue returning scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 237 return scaledValue // library marker kkossev.deviceProfileLib, line 238 } // library marker kkossev.deviceProfileLib, line 239 /** // library marker kkossev.deviceProfileLib, line 241 * Sets the parameter value for the device. // library marker kkossev.deviceProfileLib, line 242 * @param par The name of the parameter to set. // library marker kkossev.deviceProfileLib, line 243 * @param val The value to set the parameter to. // library marker kkossev.deviceProfileLib, line 244 * @return Nothing. // library marker kkossev.deviceProfileLib, line 245 */ // library marker kkossev.deviceProfileLib, line 246 def setPar( par=null, val=null ) // library marker kkossev.deviceProfileLib, line 247 { // library marker kkossev.deviceProfileLib, line 248 if (DEVICE?.preferences == null || DEVICE?.preferences == [:]) { // library marker kkossev.deviceProfileLib, line 249 return null // library marker kkossev.deviceProfileLib, line 250 } // library marker kkossev.deviceProfileLib, line 251 // new method // library marker kkossev.deviceProfileLib, line 252 logDebug "setPar new method: setting parameter ${par} to ${val}" // library marker kkossev.deviceProfileLib, line 253 ArrayList cmds = [] // library marker kkossev.deviceProfileLib, line 254 Boolean validated = false // library marker kkossev.deviceProfileLib, line 255 if (par == null) { // library marker kkossev.deviceProfileLib, line 256 log.warn "${device.displayName} setPar: 'parameter' must be one of these : ${getValidParsPerModel()}" // library marker kkossev.deviceProfileLib, line 257 return // library marker kkossev.deviceProfileLib, line 258 } // library marker kkossev.deviceProfileLib, line 259 if (!(par in getValidParsPerModel())) { // library marker kkossev.deviceProfileLib, line 260 log.warn "${device.displayName} setPar: parameter '${par}' must be one of these : ${getValidParsPerModel()}" // library marker kkossev.deviceProfileLib, line 261 return // library marker kkossev.deviceProfileLib, line 262 } // library marker kkossev.deviceProfileLib, line 263 // find the tuayDPs map for the par // library marker kkossev.deviceProfileLib, line 264 Map dpMap = getPreferencesMap(par, false) // library marker kkossev.deviceProfileLib, line 265 if ( dpMap == null ) { // library marker kkossev.deviceProfileLib, line 266 log.warn "${device.displayName} setPar: tuyaDPs map not found for parameter ${par}" // library marker kkossev.deviceProfileLib, line 267 return // library marker kkossev.deviceProfileLib, line 268 } // library marker kkossev.deviceProfileLib, line 269 if (val == null) { // library marker kkossev.deviceProfileLib, line 270 log.warn "${device.displayName} setPar: 'value' must be specified for parameter ${par} in the range ${dpMap.min} to ${dpMap.max}" // library marker kkossev.deviceProfileLib, line 271 return // library marker kkossev.deviceProfileLib, line 272 } // library marker kkossev.deviceProfileLib, line 273 // convert the val to the correct type and scale it if needed // library marker kkossev.deviceProfileLib, line 274 def scaledValue = validateAndScaleParameterValue(dpMap, val as String) // library marker kkossev.deviceProfileLib, line 275 if (scaledValue == null) { // library marker kkossev.deviceProfileLib, line 276 log.warn "${device.displayName} setPar: invalid parameter value ${val}. Must be in the range ${dpMap.min} to ${dpMap.max}" // library marker kkossev.deviceProfileLib, line 277 return // library marker kkossev.deviceProfileLib, line 278 } // library marker kkossev.deviceProfileLib, line 279 // update the device setting // library marker kkossev.deviceProfileLib, line 280 // TODO: decide whether the setting must be updated here, or after it is echeod back from the device // library marker kkossev.deviceProfileLib, line 281 try { // library marker kkossev.deviceProfileLib, line 282 device.updateSetting("$par", [value:val, type:dpMap.type]) // library marker kkossev.deviceProfileLib, line 283 } // library marker kkossev.deviceProfileLib, line 284 catch (e) { // library marker kkossev.deviceProfileLib, line 285 logWarn "setPar: Exception '${e}'caught while updateSetting $par($val) type=${dpMap.type}" // library marker kkossev.deviceProfileLib, line 286 return // library marker kkossev.deviceProfileLib, line 287 } // library marker kkossev.deviceProfileLib, line 288 logDebug "parameter ${par} value ${val}, type ${dpMap.type} validated and scaled to ${scaledValue} type=${dpMap.type}" // library marker kkossev.deviceProfileLib, line 289 // if there is a dedicated set function, use it // library marker kkossev.deviceProfileLib, line 290 String capitalizedFirstChar = par[0].toUpperCase() + par[1..-1] // library marker kkossev.deviceProfileLib, line 291 String setFunction = "set${capitalizedFirstChar}" // library marker kkossev.deviceProfileLib, line 292 if (this.respondsTo(setFunction)) { // library marker kkossev.deviceProfileLib, line 293 logDebug "setPar: found setFunction=${setFunction}, scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 294 // execute the setFunction // library marker kkossev.deviceProfileLib, line 295 try { // library marker kkossev.deviceProfileLib, line 296 cmds = "$setFunction"(scaledValue) // library marker kkossev.deviceProfileLib, line 297 } // library marker kkossev.deviceProfileLib, line 298 catch (e) { // library marker kkossev.deviceProfileLib, line 299 logWarn "setPar: Exception '${e}'caught while processing $setFunction($scaledValue) (val=${val}))" // library marker kkossev.deviceProfileLib, line 300 return // library marker kkossev.deviceProfileLib, line 301 } // library marker kkossev.deviceProfileLib, line 302 logDebug "setFunction result is ${cmds}" // library marker kkossev.deviceProfileLib, line 303 if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 304 logInfo "setPar: successfluly executed setPar $setFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 305 sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 306 return // library marker kkossev.deviceProfileLib, line 307 } // library marker kkossev.deviceProfileLib, line 308 else { // library marker kkossev.deviceProfileLib, line 309 logWarn "setPar: setFunction $setFunction($scaledValue) returned null or empty list" // library marker kkossev.deviceProfileLib, line 310 // continue with the default processing // library marker kkossev.deviceProfileLib, line 311 } // library marker kkossev.deviceProfileLib, line 312 } // library marker kkossev.deviceProfileLib, line 313 // check whether this is a tuya DP or a cluster:attribute parameter // library marker kkossev.deviceProfileLib, line 314 if (dpMap.dp != null && dpMap.dp.isNumber()) { // library marker kkossev.deviceProfileLib, line 315 // Tuya DP // library marker kkossev.deviceProfileLib, line 316 cmds = sendTuyaParameter(dpMap, par, scaledValue) // library marker kkossev.deviceProfileLib, line 317 if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 318 logWarn "setPar: sendTuyaParameter par ${par} scaledValue ${scaledValue} returned null or empty list" // library marker kkossev.deviceProfileLib, line 319 return // library marker kkossev.deviceProfileLib, line 320 } // library marker kkossev.deviceProfileLib, line 321 else { // library marker kkossev.deviceProfileLib, line 322 logInfo "setPar: successfluly executed setPar $setFunction($val (scaledValue=${scaledValue}))" // library marker kkossev.deviceProfileLib, line 323 sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 324 return // library marker kkossev.deviceProfileLib, line 325 } // library marker kkossev.deviceProfileLib, line 326 } // library marker kkossev.deviceProfileLib, line 327 else if (dpMap.at != null) { // library marker kkossev.deviceProfileLib, line 328 // cluster:attribute // library marker kkossev.deviceProfileLib, line 329 int cluster // library marker kkossev.deviceProfileLib, line 330 int attribute // library marker kkossev.deviceProfileLib, line 331 int dt // library marker kkossev.deviceProfileLib, line 332 int mfgCode // library marker kkossev.deviceProfileLib, line 333 try { // library marker kkossev.deviceProfileLib, line 334 cluster = hubitat.helper.HexUtils.hexStringToInt(dpMap.at.split(":")[0]) // library marker kkossev.deviceProfileLib, line 335 attribute = hubitat.helper.HexUtils.hexStringToInt(dpMap.at.split(":")[1]) // library marker kkossev.deviceProfileLib, line 336 dt = hubitat.helper.HexUtils.hexStringToInt(dpMap.dt) // library marker kkossev.deviceProfileLib, line 337 mfgCode = dpMap.mfgCode != null ? hubitat.helper.HexUtils.hexStringToInt(dpMap.mfgCode) : null // library marker kkossev.deviceProfileLib, line 338 } // library marker kkossev.deviceProfileLib, line 339 catch (e) { // library marker kkossev.deviceProfileLib, line 340 logWarn "setPar: Exception '${e}'caught while splitting cluser and attribute $setFunction($scaledValue) (val=${val}))" // library marker kkossev.deviceProfileLib, line 341 return // library marker kkossev.deviceProfileLib, line 342 } // library marker kkossev.deviceProfileLib, line 343 Map mapMfCode = ["mfgCode":mfgCode] // library marker kkossev.deviceProfileLib, line 344 logDebug "setPar: found cluster=${cluster} attribute=${attribute} dt=${dpMap.dt} mapMfCode=${mapMfCode} scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 345 if (mfgCode != null) { // library marker kkossev.deviceProfileLib, line 346 cmds = zigbee.writeAttribute(cluster, attribute, dt, scaledValue, mapMfCode, delay=200) // library marker kkossev.deviceProfileLib, line 347 } // library marker kkossev.deviceProfileLib, line 348 else { // library marker kkossev.deviceProfileLib, line 349 cmds = zigbee.writeAttribute(cluster, attribute, dt, scaledValue, [:], delay=200) // library marker kkossev.deviceProfileLib, line 350 } // library marker kkossev.deviceProfileLib, line 351 } // library marker kkossev.deviceProfileLib, line 352 else { // library marker kkossev.deviceProfileLib, line 353 logWarn "setPar: invalid dp or at value ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 354 return // library marker kkossev.deviceProfileLib, line 355 } // library marker kkossev.deviceProfileLib, line 356 logInfo "setPar: successfluly executed setPar $setFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 359 sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 360 return // library marker kkossev.deviceProfileLib, line 361 } // library marker kkossev.deviceProfileLib, line 362 // function to send a Tuya command to data point taken from dpMap with value tuyaValue and type taken from dpMap // library marker kkossev.deviceProfileLib, line 364 // TODO - reuse it !!! // library marker kkossev.deviceProfileLib, line 365 def sendTuyaParameter( Map dpMap, String par, tuyaValue) { // library marker kkossev.deviceProfileLib, line 366 //logDebug "sendTuyaParameter: trying to send parameter ${par} value ${tuyaValue}" // library marker kkossev.deviceProfileLib, line 367 ArrayList cmds = [] // library marker kkossev.deviceProfileLib, line 368 if (dpMap == null) { // library marker kkossev.deviceProfileLib, line 369 log.warn "${device.displayName} sendTuyaParameter: tuyaDPs map not found for parameter ${par}" // library marker kkossev.deviceProfileLib, line 370 return null // library marker kkossev.deviceProfileLib, line 371 } // library marker kkossev.deviceProfileLib, line 372 String dp = zigbee.convertToHexString(dpMap.dp, 2) // library marker kkossev.deviceProfileLib, line 373 if (dpMap.dp <= 0 || dpMap.dp >= 256) { // library marker kkossev.deviceProfileLib, line 374 log.warn "${device.displayName} sendTuyaParameter: invalid dp ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 375 return null // library marker kkossev.deviceProfileLib, line 376 } // library marker kkossev.deviceProfileLib, line 377 String dpType = dpMap.type == "bool" ? DP_TYPE_BOOL : dpMap.type == "enum" ? DP_TYPE_ENUM : (dpMap.type in ["value", "number", "decimal"]) ? DP_TYPE_VALUE: null // library marker kkossev.deviceProfileLib, line 378 //log.debug "dpType = ${dpType}" // library marker kkossev.deviceProfileLib, line 379 if (dpType == null) { // library marker kkossev.deviceProfileLib, line 380 log.warn "${device.displayName} sendTuyaParameter: invalid dpType ${dpMap.type} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 381 return null // library marker kkossev.deviceProfileLib, line 382 } // library marker kkossev.deviceProfileLib, line 383 // sendTuyaCommand // library marker kkossev.deviceProfileLib, line 384 def dpValHex = dpType == DP_TYPE_VALUE ? zigbee.convertToHexString(tuyaValue as int, 8) : zigbee.convertToHexString(tuyaValue as int, 2) // library marker kkossev.deviceProfileLib, line 385 logDebug "sendTuyaParameter: sending parameter ${par} dpValHex ${dpValHex} (raw=${tuyaValue}) Tuya dp=${dp} dpType=${dpType} " // library marker kkossev.deviceProfileLib, line 386 cmds = sendTuyaCommand( dp, dpType, dpValHex) // library marker kkossev.deviceProfileLib, line 387 return cmds // library marker kkossev.deviceProfileLib, line 388 } // library marker kkossev.deviceProfileLib, line 389 /** // library marker kkossev.deviceProfileLib, line 391 * Sends a command to the device. // library marker kkossev.deviceProfileLib, line 392 * @param command The command to send. Must be one of the commands defined in the DEVICE.commands map. // library marker kkossev.deviceProfileLib, line 393 * @param val The value to send with the command. // library marker kkossev.deviceProfileLib, line 394 * @return void // library marker kkossev.deviceProfileLib, line 395 */ // library marker kkossev.deviceProfileLib, line 396 def sendCommand( command=null, val=null ) // library marker kkossev.deviceProfileLib, line 397 { // library marker kkossev.deviceProfileLib, line 398 //logDebug "sending command ${command}(${val}))" // library marker kkossev.deviceProfileLib, line 399 ArrayList cmds = [] // library marker kkossev.deviceProfileLib, line 400 def supportedCommandsMap = DEVICE.commands // library marker kkossev.deviceProfileLib, line 401 if (supportedCommandsMap == null || supportedCommandsMap == []) { // library marker kkossev.deviceProfileLib, line 402 logWarn "sendCommand: no commands defined for device profile ${getDeviceGroup()} !" // library marker kkossev.deviceProfileLib, line 403 return // library marker kkossev.deviceProfileLib, line 404 } // library marker kkossev.deviceProfileLib, line 405 // TODO: compare ignoring the upper/lower case of the command. // library marker kkossev.deviceProfileLib, line 406 def supportedCommandsList = DEVICE.commands.keySet() as List // library marker kkossev.deviceProfileLib, line 407 // check if the command is defined in the DEVICE commands map // library marker kkossev.deviceProfileLib, line 408 if (command == null || !(command in supportedCommandsList)) { // library marker kkossev.deviceProfileLib, line 409 logWarn "sendCommand: the command ${(command ?: '')} for device profile '${DEVICE.description}' must be one of these : ${supportedCommandsList}" // library marker kkossev.deviceProfileLib, line 410 return // library marker kkossev.deviceProfileLib, line 411 } // library marker kkossev.deviceProfileLib, line 412 def func // library marker kkossev.deviceProfileLib, line 413 try { // library marker kkossev.deviceProfileLib, line 414 func = DEVICE.commands.find { it.key == command }.value // library marker kkossev.deviceProfileLib, line 415 if (val != null) { // library marker kkossev.deviceProfileLib, line 416 cmds = "${func}"(val) // library marker kkossev.deviceProfileLib, line 417 logInfo "executed $func($val)" // library marker kkossev.deviceProfileLib, line 418 } // library marker kkossev.deviceProfileLib, line 419 else { // library marker kkossev.deviceProfileLib, line 420 cmds = "${func}"() // library marker kkossev.deviceProfileLib, line 421 logInfo "executed $func()" // library marker kkossev.deviceProfileLib, line 422 } // library marker kkossev.deviceProfileLib, line 423 } // library marker kkossev.deviceProfileLib, line 424 catch (e) { // library marker kkossev.deviceProfileLib, line 425 logWarn "sendCommand: Exception '${e}' caught while processing $func(${val})" // library marker kkossev.deviceProfileLib, line 426 return // library marker kkossev.deviceProfileLib, line 427 } // library marker kkossev.deviceProfileLib, line 428 if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 429 sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 430 } // library marker kkossev.deviceProfileLib, line 431 } // library marker kkossev.deviceProfileLib, line 432 /** // library marker kkossev.deviceProfileLib, line 434 * This method takes a string parameter and a boolean debug flag as input and returns a map containing the input details. // library marker kkossev.deviceProfileLib, line 435 * The method checks if the input parameter is defined in the device preferences and returns null if it is not. // library marker kkossev.deviceProfileLib, line 436 * It then checks if the input parameter is a boolean value and skips it if it is. // library marker kkossev.deviceProfileLib, line 437 * The method also checks if the input parameter is a number and sets the isTuyaDP flag accordingly. // library marker kkossev.deviceProfileLib, line 438 * If the input parameter is read-only, the method returns null. // library marker kkossev.deviceProfileLib, line 439 * The method then populates the input map with the name, type, title, description, range, options, and default value of the input parameter. // library marker kkossev.deviceProfileLib, line 440 * If the input parameter type is not supported, the method returns null. // library marker kkossev.deviceProfileLib, line 441 * @param param The input parameter to be checked. // library marker kkossev.deviceProfileLib, line 442 * @param debug A boolean flag indicating whether to log debug messages or not. // library marker kkossev.deviceProfileLib, line 443 * @return A map containing the input details. // library marker kkossev.deviceProfileLib, line 444 */ // library marker kkossev.deviceProfileLib, line 445 def inputIt( String param, boolean debug=false ) { // library marker kkossev.deviceProfileLib, line 446 Map input = [:] // library marker kkossev.deviceProfileLib, line 447 Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 448 if (!(param in DEVICE.preferences)) { // library marker kkossev.deviceProfileLib, line 449 if (debug) log.warn "inputIt: preference ${param} not defined for this device!" // library marker kkossev.deviceProfileLib, line 450 return null // library marker kkossev.deviceProfileLib, line 451 } // library marker kkossev.deviceProfileLib, line 452 def preference // library marker kkossev.deviceProfileLib, line 453 boolean isTuyaDP // library marker kkossev.deviceProfileLib, line 454 try { // library marker kkossev.deviceProfileLib, line 455 preference = DEVICE.preferences["$param"] // library marker kkossev.deviceProfileLib, line 456 } // library marker kkossev.deviceProfileLib, line 457 catch (e) { // library marker kkossev.deviceProfileLib, line 458 if (debug) log.warn "inputIt: exception ${e} caught while parsing preference ${param} value ${preference}" // library marker kkossev.deviceProfileLib, line 459 return null // library marker kkossev.deviceProfileLib, line 460 } // library marker kkossev.deviceProfileLib, line 461 // check for boolean values // library marker kkossev.deviceProfileLib, line 462 try { // library marker kkossev.deviceProfileLib, line 463 if (preference in [true, false]) { // library marker kkossev.deviceProfileLib, line 464 if (debug) log.warn "inputIt: preference ${param} is boolean value ${preference} - skipping it for now!" // library marker kkossev.deviceProfileLib, line 465 return null // library marker kkossev.deviceProfileLib, line 466 } // library marker kkossev.deviceProfileLib, line 467 } // library marker kkossev.deviceProfileLib, line 468 catch (e) { // library marker kkossev.deviceProfileLib, line 469 if (debug) log.warn "inputIt: exception ${e} caught while checking for boolean values preference ${param} value ${preference}" // library marker kkossev.deviceProfileLib, line 470 return null // library marker kkossev.deviceProfileLib, line 471 } // library marker kkossev.deviceProfileLib, line 472 try { // library marker kkossev.deviceProfileLib, line 474 isTuyaDP = preference.isNumber() // library marker kkossev.deviceProfileLib, line 475 } // library marker kkossev.deviceProfileLib, line 476 catch (e) { // library marker kkossev.deviceProfileLib, line 477 if (debug) log.warn "inputIt: exception ${e} caught while checking isNumber() preference ${param} value ${preference}" // library marker kkossev.deviceProfileLib, line 478 return null // library marker kkossev.deviceProfileLib, line 479 } // library marker kkossev.deviceProfileLib, line 480 //if (debug) log.debug "inputIt: preference ${param} found. value is ${preference} isTuyaDP=${isTuyaDP}" // library marker kkossev.deviceProfileLib, line 482 foundMap = getPreferencesMap(param) // library marker kkossev.deviceProfileLib, line 483 //if (debug) log.debug "foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 484 if (foundMap == null) { // library marker kkossev.deviceProfileLib, line 485 if (debug) log.warn "inputIt: map not found for param '${param}'!" // library marker kkossev.deviceProfileLib, line 486 return null // library marker kkossev.deviceProfileLib, line 487 } // library marker kkossev.deviceProfileLib, line 488 if (foundMap.rw != "rw") { // library marker kkossev.deviceProfileLib, line 489 if (debug) log.warn "inputIt: param '${param}' is read only!" // library marker kkossev.deviceProfileLib, line 490 return null // library marker kkossev.deviceProfileLib, line 491 } // library marker kkossev.deviceProfileLib, line 492 input.name = foundMap.name // library marker kkossev.deviceProfileLib, line 493 input.type = foundMap.type // bool, enum, number, decimal // library marker kkossev.deviceProfileLib, line 494 input.title = foundMap.title // library marker kkossev.deviceProfileLib, line 495 input.description = foundMap.description // library marker kkossev.deviceProfileLib, line 496 if (input.type in ["number", "decimal"]) { // library marker kkossev.deviceProfileLib, line 497 if (foundMap.min != null && foundMap.max != null) { // library marker kkossev.deviceProfileLib, line 498 input.range = "${foundMap.min}..${foundMap.max}" // library marker kkossev.deviceProfileLib, line 499 } // library marker kkossev.deviceProfileLib, line 500 if (input.range != null && input.description !=null) { // library marker kkossev.deviceProfileLib, line 501 input.description += "
Range: ${input.range}" // library marker kkossev.deviceProfileLib, line 502 if (foundMap.unit != null && foundMap.unit != "") { // library marker kkossev.deviceProfileLib, line 503 input.description += " (${foundMap.unit})" // library marker kkossev.deviceProfileLib, line 504 } // library marker kkossev.deviceProfileLib, line 505 } // library marker kkossev.deviceProfileLib, line 506 } // library marker kkossev.deviceProfileLib, line 507 else if (input.type == "enum") { // library marker kkossev.deviceProfileLib, line 508 input.options = foundMap.map // library marker kkossev.deviceProfileLib, line 509 }/* // library marker kkossev.deviceProfileLib, line 510 else if (input.type == "bool") { // library marker kkossev.deviceProfileLib, line 511 input.options = ["true", "false"] // library marker kkossev.deviceProfileLib, line 512 }*/ // library marker kkossev.deviceProfileLib, line 513 else { // library marker kkossev.deviceProfileLib, line 514 if (debug) log.warn "inputIt: unsupported type ${input.type} for param '${param}'!" // library marker kkossev.deviceProfileLib, line 515 return null // library marker kkossev.deviceProfileLib, line 516 } // library marker kkossev.deviceProfileLib, line 517 if (input.defaultValue != null) { // library marker kkossev.deviceProfileLib, line 518 input.defaultValue = foundMap.defaultValue // library marker kkossev.deviceProfileLib, line 519 } // library marker kkossev.deviceProfileLib, line 520 return input // library marker kkossev.deviceProfileLib, line 521 } // library marker kkossev.deviceProfileLib, line 522 /** // library marker kkossev.deviceProfileLib, line 525 * Returns the device name and profile based on the device model and manufacturer. // library marker kkossev.deviceProfileLib, line 526 * @param model The device model (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 527 * @param manufacturer The device manufacturer (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 528 * @return A list containing the device name and profile. // library marker kkossev.deviceProfileLib, line 529 */ // library marker kkossev.deviceProfileLib, line 530 def getDeviceNameAndProfile( model=null, manufacturer=null) { // library marker kkossev.deviceProfileLib, line 531 def deviceName = UNKNOWN // library marker kkossev.deviceProfileLib, line 532 def deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 533 String deviceModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 534 String deviceManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 535 deviceProfilesV2.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 536 profileMap.fingerprints.each { fingerprint -> // library marker kkossev.deviceProfileLib, line 537 if (fingerprint.model == deviceModel && fingerprint.manufacturer == deviceManufacturer) { // library marker kkossev.deviceProfileLib, line 538 deviceProfile = profileName // library marker kkossev.deviceProfileLib, line 539 deviceName = fingerprint.deviceJoinName ?: deviceProfilesV2[deviceProfile].deviceJoinName ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 540 logDebug "found exact match for model ${deviceModel} manufacturer ${deviceManufacturer} : profileName=${deviceProfile} deviceName =${deviceName}" // library marker kkossev.deviceProfileLib, line 541 return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 542 } // library marker kkossev.deviceProfileLib, line 543 } // library marker kkossev.deviceProfileLib, line 544 } // library marker kkossev.deviceProfileLib, line 545 if (deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 546 logWarn "NOT FOUND! deviceName =${deviceName} profileName=${deviceProfile} for model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 547 } // library marker kkossev.deviceProfileLib, line 548 return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 549 } // library marker kkossev.deviceProfileLib, line 550 // called from initializeVars( fullInit = true) // library marker kkossev.deviceProfileLib, line 552 def setDeviceNameAndProfile( model=null, manufacturer=null) { // library marker kkossev.deviceProfileLib, line 553 def (String deviceName, String deviceProfile) = getDeviceNameAndProfile(model, manufacturer) // library marker kkossev.deviceProfileLib, line 554 if (deviceProfile == null || deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 555 logWarn "unknown model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 556 // don't change the device name when unknown // library marker kkossev.deviceProfileLib, line 557 state.deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 558 } // library marker kkossev.deviceProfileLib, line 559 def dataValueModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 560 def dataValueManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 561 if (deviceName != NULL && deviceName != UNKNOWN ) { // library marker kkossev.deviceProfileLib, line 562 device.setName(deviceName) // library marker kkossev.deviceProfileLib, line 563 state.deviceProfile = deviceProfile // library marker kkossev.deviceProfileLib, line 564 device.updateSetting("forcedProfile", [value:deviceProfilesV2[deviceProfile].description, type:"enum"]) // library marker kkossev.deviceProfileLib, line 565 //logDebug "after : forcedProfile = ${settings.forcedProfile}" // library marker kkossev.deviceProfileLib, line 566 logInfo "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was set to : deviceProfile=${deviceProfile} : deviceName=${deviceName}" // library marker kkossev.deviceProfileLib, line 567 } else { // library marker kkossev.deviceProfileLib, line 568 logWarn "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was not found!" // library marker kkossev.deviceProfileLib, line 569 } // library marker kkossev.deviceProfileLib, line 570 } // library marker kkossev.deviceProfileLib, line 571 def refreshDeviceProfile() { // library marker kkossev.deviceProfileLib, line 573 List cmds = [] // library marker kkossev.deviceProfileLib, line 574 if (cmds == []) { cmds = ["delay 299"] } // library marker kkossev.deviceProfileLib, line 575 logDebug "refreshDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 576 return cmds // library marker kkossev.deviceProfileLib, line 577 } // library marker kkossev.deviceProfileLib, line 578 def configureDeviceProfile() { // library marker kkossev.deviceProfileLib, line 580 List cmds = [] // library marker kkossev.deviceProfileLib, line 581 logDebug "configureDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 582 if (cmds == []) { cmds = ["delay 299"] } // no , // library marker kkossev.deviceProfileLib, line 583 return cmds // library marker kkossev.deviceProfileLib, line 584 } // library marker kkossev.deviceProfileLib, line 585 def initializeDeviceProfile() // library marker kkossev.deviceProfileLib, line 587 { // library marker kkossev.deviceProfileLib, line 588 List cmds = [] // library marker kkossev.deviceProfileLib, line 589 logDebug "initializeDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 590 if (cmds == []) { cmds = ["delay 299",] } // library marker kkossev.deviceProfileLib, line 591 return cmds // library marker kkossev.deviceProfileLib, line 592 } // library marker kkossev.deviceProfileLib, line 593 void initVarsDeviceProfile(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 595 logDebug "initVarsDeviceProfile(${fullInit})" // library marker kkossev.deviceProfileLib, line 596 if (state.deviceProfile == null) { // library marker kkossev.deviceProfileLib, line 597 setDeviceNameAndProfile() // library marker kkossev.deviceProfileLib, line 598 } // library marker kkossev.deviceProfileLib, line 599 } // library marker kkossev.deviceProfileLib, line 600 void initEventsDeviceProfile(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 602 logDebug "initEventsDeviceProfile(${fullInit})" // library marker kkossev.deviceProfileLib, line 603 } // library marker kkossev.deviceProfileLib, line 604 // ~~~~~ end include (142) kkossev.deviceProfileLib ~~~~~