/* groovylint-disable CompileStatic, DuplicateListLiteral, DuplicateMapLiteral, DuplicateStringLiteral, ImplicitClosureParameter, MethodCount, MethodSize, NglParseError, NoDouble, PublicMethodsBeforeNonPublicMethods, StaticMethodsBeforeInstanceMethods, UnnecessaryGetter, UnnecessarySetter, UnusedImport */
/**
* Tuya Zigbee TRVs and Thermostats - Device Driver for Hubitat Elevation
*
* https://community.hubitat.com/t/release-tuya-zigbee-thermostats-and-trvs-driver/128916
*
* 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.
*
* ver. 3.3.0 2024-06-07 kkossev - separate new 'Tuya Zigbee Thermostat' driver for Tuya Thermostats and TRVs.
* ver. 3.3.1 2024-07-09 kkossev - driver renamed to 'Tuya Zigbee TRVs and Thermostats'
* ver. 3.3.2 2024-07-18 kkossev - added AVATTO_TRV06_TRV16_ME167_ME168_TRV profile; added '_TZE200_bvrlmajk' as 'AVATTO TRV-07'; added 'IMMAX_Neo Lite TRV 07732L' profile; temperaturePollingInterval disabled for Tuya TRVs
* 'Battery Voltage to Percentage' and 'Minimum time between reports' are hidden;
* ver. 3.3.3 2024-08-01 kkossev - added _TZE200_g9a3awaj 'AVATTO_ZWT07_BATTERY_THERMOSTAT'
* ver. 3.4.0 2024-10-05 kkossev - added to HPM
* ver. 3.4.1 2024-10-26 kkossev - fixed exception in sendDigitalEventIfNeeded when the attribute is not found (level); added faultAlarm attribute; added TRV602 profile (TS0601 _TZE200_rtrmfadk)
* added TRV602Z profile (TS0601 _TZE204_ltwbm23f); queryAllTuyaDP() when refreshing TRV602 and TRV602Z;
* ver. 3.4.2 2024-11-12 kkossev - added TS0601 _TZE204_xnbkhhdr (_TZE200_viy9ihs7 _TZE200_viy9ihs7) thermostat profile 'AVATTO_ZWT198_ZWT100-BH_THERMOSTAT'
* ver. 3.5.0 2025-02-16 kkossev - restored sendCommand and setPar; added brightness attribute; added checkIfIsDuplicated; added Resend failed commands : setThermostatMode and heatingSetpoint retries; added forceManual prefrence
* ver. 3.5.1 2025-04-08 kkossev - urgent fix for java.lang.CloneNotSupportedException
* ver. 3.5.2 2025-05-25 kkossev - HE platfrom version 2.4.1.x decimal preferences patch/workaround.
* ver. 3.5.3 2025-10-03 kkossev - added TS0601 _TZE204_lpedvtvr into new 'MOES_RING_THERMOSTAT' profile
* ver. 3.6.0 2025-12-13 kkossev - addeed new 'Beok BOT-R15W Zigbee Thermostat Cool' TS0601 _TZE284_agcxaw3f @guy.mayhew;
* [digital] / [physical] heatingSetpoint event types; _TZE204_aoclfnxz fingerprint correction;
* added TS0601 _TZE204_6ewjlefg VRF/VRV THERMOSTAT @gnat666 (testing)
* ver. 3.6.1 2026-02-08 kkossev - (dev. branch) TS0601 _TZE284_agcxaw3f standard device profile and improvements; STEEDSMT_VRF_VRV_THERMOSTAT commented out; added MOES_ZHT_S03_THERMOSTAT profile for TS0601 _TZE204_zxkwaztm (Moes ZHT‑S03)
* BOT_R15W_ZB_THERMOSTAT refactored;
*
* TODO: check all calibrationTemp vs temperatureCalibration attributes and unify;
* TODO: Tuya VRF Gateway : https://github.com/Koenkk/zigbee2mqtt/issues/18570 https://github.com/Koenkk/zigbee2mqtt/issues/23514
* TODO: THE STATIC DEVICE PROFILE V3 CODE SIZE is nearly its LIMIT - refactoring needed ! (same as the mmWave driver - dynamic loading of V4 JSON profiles ...)
*/
static String version() { '3.6.1' }
static String timeStamp() { '2026/02/08 11:47 PM' }
@Field static final Boolean _DEBUG = false
import groovy.transform.Field
import hubitat.device.HubMultiAction
import hubitat.device.Protocol
import hubitat.zigbee.zcl.DataType
import java.util.concurrent.ConcurrentHashMap
import groovy.json.JsonOutput
import java.math.RoundingMode
deviceType = 'Thermostat'
@Field static final String DEVICE_TYPE = 'Thermostat'
metadata {
definition(
name: 'Tuya Zigbee TRVs and Thermostats',
importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/development/Drivers/Zigbee%20TRV/Tuya_Zigbee_Thermostat_lib_included.groovy',
namespace: 'kkossev', author: 'Krassimir Kossev', singleThreaded: true)
{
// TODO - add all other models attributes possible values
attribute 'antiFreeze', 'enum', ['off', 'on'] // TUYA_SASWELL_TRV, AVATTO_TRV06_TRV16_ME167_ME168_TRV,
attribute 'batteryVoltage', 'number'
attribute 'boostTime', 'number' // BRT-100
attribute 'calibrated', 'enum', ['false', 'true'] // Aqara E1
attribute 'brightness', 'enum', ['off', 'low', 'medium', 'high'] // BEOK/AVATTO
attribute 'calibrationTemp', 'number' // BRT-100, Sonoff
attribute 'childLock', 'enum', ['off', 'on'] // BRT-100, Aqara E1, Sonoff, AVATTO
attribute 'comfortTemp', 'number' // TRV602Z, IMMAX_Neo Lite TRV 07732L
attribute 'controlMode', 'enum', ['PID', 'OnOff'] // TRV602Z
attribute 'ecoMode', 'enum', ['off', 'on'] // BRT-100
attribute 'ecoTemp', 'number' // BRT-100, TRV602Z
attribute 'emergencyHeating', 'enum', ['off', 'on'] // BRT-100
attribute 'emergencyHeatingTime', 'number' // BRT-100
attribute 'floorTemperature', 'number' // AVATTO/MOES floor thermostats
attribute 'frostProtectionTemperature', 'number' // Sonoff
attribute 'hysteresis', 'number' // AVATTO, Virtual thermostat
attribute 'level', 'number' // BRT-100
attribute 'maxHeatingSetpoint', 'number' // BRT-100, Sonoff, AVATTO
attribute 'minHeatingSetpoint', 'number' // BRT-100, Sonoff, AVATTO
attribute 'sensor', 'enum', ['internal', 'external', 'both'] // Aqara E1, AVATTO
attribute 'systemMode', 'enum', ['off', 'on'] // Aqara E1, AVATTO, MOES ZHT-S03
attribute 'valveAlarm', 'enum', ['false', 'true'] // Aqara E1
attribute 'valveDetection', 'enum', ['off', 'on'] // Aqara E1
//attribute 'weeklyProgram', 'number' // BRT-100 commented out 2026-02-08
attribute 'windowOpenDetection', 'enum', ['off', 'on'] // BRT-100, Aqara E1, Sonoff
attribute 'windowsState', 'enum', ['open', 'closed'] // BRT-100, Aqara E1
attribute 'batteryLowAlarm', 'enum', ['batteryOK', 'batteryLow'] // TUYA_SASWELL
attribute 'faultAlarm', 'enum', ['clear', 'faultSensor', 'faultMotor', 'faultLowBatt', 'faultUgLowBatt', 'error'] // TUYA
attribute 'motorThrust', 'enum', ['strong', 'middle', 'weak'] // TRV602Z
attribute 'fanSpeed', 'enum', ['auto', 'low', 'medium', 'high'] // VRF/VRV Thermostat
attribute 'sound', 'enum', ['off', 'on'] // BEOK BOT-R15W, BEOK thermostats
attribute 'temperatureCalibration', 'number' // Thermostat temperature offset
attribute 'operationMode', 'enum', ['heating', 'cooling'] // BEOK BOT-R15W (heating/cooling selection)
// Aqaura E1 attributes TODO - consolidate a common set of attributes
// Note: used by multiple device profiles; keep this list broad.
attribute 'preset', 'enum', ['manual', 'auto', 'temporary', 'away', 'temporary manual', 'program', 'eco'] // TODO - remove?
attribute 'awayPresetTemperature', 'number'
command 'sendCommand', [
[name:'command', type: 'STRING', description: 'command name', constraints: ['STRING']],
[name:'val', type: 'STRING', description: 'command parameter value', constraints: ['STRING']]
]
command 'setPar', [
[name:'par', type: 'STRING', description: 'preference parameter name', constraints: ['STRING']],
[name:'val', type: 'STRING', description: 'preference parameter value', constraints: ['STRING']]
]
if (_DEBUG) { command 'testT', [[name: 'testT', type: 'STRING', description: 'testT', defaultValue : '']] }
// itterate through all the figerprints and add them on the fly
deviceProfilesV3.each { profileName, profileMap ->
if (profileMap.fingerprints != null) {
profileMap.fingerprints.each {
fingerprint it
}
}
}
}
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.'
// the rest of the preferences are inputed from the deviceProfile maps in the deviceProfileLib
if (advancedOptions == true) {
input (name: 'resendFailed', type: 'bool', title: 'Resend failed commands', description: 'If the thermostat does not change the Setpoint or Mode as expected, then commands will be resent automatically', defaultValue: false)
input (name: 'forceManual', type: 'bool', title: 'Force Manual Mode', description: 'If the thermostat changes into schedule mode, then it automatically reverts back to manual mode', defaultValue: false)
}
}
}
@Field static final Integer MaxRetries = 5
@Field static final Integer NOT_SET = -1
public boolean isBotR15w() { return getDeviceProfile() == 'BOT_R15W_ZB_THERMOSTAT' }
@Field static final Map deviceProfilesV3 = [ // https://github.com/jacekk015/zha_quirks
// BRT-100-B0
// https://github.com/Koenkk/zigbee-herdsman-converters/blob/47f56c19a3fdec5f23e74f805ff640a931721099/src/devices/moes.ts#L282
// TODO - what is the difference between 'holidays' mode and 'ecoMode' ? Which one to use to substitute the 'off' mode ?
'MOES_BRT-100' : [
description : 'MOES BRT-100 TRV',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'13', 'boostTime':'103', 'calibrationTemp':'105', 'ecoTemp':'107', 'minHeatingSetpoint':'109', 'maxHeatingSetpoint':'108'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_b6wax7g0', deviceJoinName: 'MOES BRT-100 TRV']
],
commands : [/*"pollTuya":"pollTuya","autoPollThermostat":"autoPollThermostat",*/ 'sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:3, defVal:'1', step:1, scale:1, map:[0: 'auto', 1: 'heat', 2: 'TempHold', 3: 'holidays'] , unit:'', title:'Thermostat Mode', description:'Thermostat mode'],
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:45.0, defVal:20.0, step:1.0, scale:1, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:-10.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'],
[dp:4, name:'emergencyHeating', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Emergency Heating', description:'Emergency heating'],
[dp:5, name:'emergencyHeatingTime', type:'number', rw: 'rw', min:0, max:720 , defVal:15, step:15, scale:1, unit:'minutes', title:'Emergency Heating Timer', description:'Emergency heating timer'],
[dp:7, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'heating', 1:'idle'] , unit:'', description:'Thermostat Operating State(working state)'],
[dp:8, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Window detection'],
[dp:9, name:'windowsState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'open', 1:'closed'] , unit:'', title:'', description:'Window state'],
[dp:13, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child lock'],
[dp:14, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:101, name:'weeklyProgram', type:'number', rw: 'ro', min:0, max:9999, defVal:0, step:1, scale:1, unit:'', description:'Weekly program'],
[dp:103, name:'boostTime', type:'number', rw: 'rw', min:100, max:900 , defVal:100, step:1, scale:1, unit:'seconds', title:'Boost Timer', description:'Boost timer'],
[dp:104, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Valve level'],
[dp:105, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:00.0, step:1, scale:1, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'],
[dp:106, name:'ecoMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Eco mode', description:'Eco mode'],
[dp:107, name:'ecoTemp', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:7.0, step:1.0, scale:1, unit:'°C', title: 'Eco Temperature', description:'Eco temperature'],
[dp:108, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:45.0, defVal:35.0, step:1.0, scale:1, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:109, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:1.0, scale:1, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['pollTuya'],
deviceJoinName: 'MOES BRT-100 TRV',
configuration : [:]
],
// TUYA_SASWELL
// https://github.com/jacekk015/zha_quirks/blob/main/trv_saswell.py https://github.com/jacekk015/zha_quirks?tab=readme-ov-file#trv_saswellpy
// https://github.com/Koenkk/zigbee-herdsman-converters/blob/11e06a1b28a7ea2c3722c515f0ef3a148e81a3c3/src/devices/saswell.ts#L37
// TODO - what is the difference between 'holidays' mode and 'ecoMode' ? Which one to use to substitute the 'off' mode ?
'TUYA_SASWELL_TRV' : [
description : 'Tuya Saswell TRV (not tested!)',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'40', 'calibrationTemp':'27'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_0dvm9mva', deviceJoinName: 'TRV RTX ZB-RT1'], // https://community.hubitat.com/t/zigbee-radiator-trv-rtx-zb-rt1/129812?u=kkossev
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_yw7cahqs', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_c88teujp', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_azqp6ssj', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_9gvruqf5', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_zuhszj9s', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_zr9c0day', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_h4cgnbzg', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_exfrnlow', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_9m4kmbfu', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_3yp57tby', deviceJoinName: 'TUYA_SASWELL TRV'], // not tested
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_mz5y07w2', deviceJoinName: 'Garza Smart TRV'] // not tested //https://github.com/zigpy/zha-device-handlers/issues/2486
],
commands : ['limescaleProtect':'limescaleProtect', 'printFingerprints':'printFingerprints', 'resetStats':'', 'refresh':'', 'customRefresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:8, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Open Window Detection support'], // SASWELL_WINDOW_DETECT_ATTR
[dp:10, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Anti-Freeze', description:'Anti-Freeze support'], // SASWELL_ANTI_FREEZE_ATTR
[dp:27, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-6.0, max:6.0, defVal:0.0, step:1, scale:1, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'], // SASWELL_TEMP_CORRECTION_ATTR = 0x021B # uint32 - temp correction 539 (27 dec)
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child Lock setting support. Please remember that CL has to be set manually on the device. This only controls if locking is possible at all'], // SASWELL_CHILD_LOCK_ATTR
[dp:101, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:1, defVal:'1', step:1, scale:1, map:[0: 'off', 1: 'heat'] , unit:'', title:'Thermostat Mode', description:'Thermostat mode'], // SASWELL_ONOFF_ATTR = 0x0165 # [0/1] on/off 357 (101 dec)
[dp:102, name:'temperature', type:'decimal', rw: 'ro', min:-10.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'], // SASWELL_ROOM_TEMP_ATTR = 0x0266 # uint32 - current room temp 614 (102 dec)
[dp:103, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:30.0, defVal:20.0, step:1.0, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'], // SASWELL_TARGET_TEMP_ATTR = 0x0267 # uint32 - target temp 615 (103 dec)
[dp:105, name:'batteryLowAlarm', type:'enum', dt: '01', rw: 'r0', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'batteryOK', 1:'batteryLow'] , unit:'', description:'Battery low'], // SASWELL_BATTERY_ALARM_ATTR = 0x569 # [0/1] on/off - battery low 1385 (105 dec)
[dp:106, name:'awayMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Away Mode', description:'Away Mode On/Off support'], // SASWELL_AWAY_MODE_ATTR = 0x016A # [0/1] on/off 362 (106 dec)
[dp:108, name:'scheduleMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Schedule Mode', description:'Schedule Mode On/Off support'], // SASWELL_SCHEDULE_MODE_ATTR = 0x016C # [0/1] on/off 364 (108 dec)
[dp:130, name:'limescaleProtect', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Limescale Protect', description:'Limescale Protection support'], // SASWELL_LIMESCALE_PROTECT_ATTR
// missing ! [dp:7, name:'thermostatOperatingState', type:"enum", rw: "rw", min:0, max:1 , defVal:"0", step:1, scale:1, map:[0:"heating", 1:"idle"] , unit:"", description:'Thermostat Operating State(working state)'],
],
supportedThermostatModes: ['off', 'heat'],
refresh: ['pollTuya'],
deviceJoinName: 'TUYA_SASWELL TRV',
configuration : [:]
],
// https://github.com/Koenkk/zigbee2mqtt/issues/18872#issuecomment-1869439394 Few words to note that _TZE200_rxntag7i TS0601 / Tuya - Avatto TRV16 does not fit to ME168 TRV model.
'AVATTO_TRV06_TRV16_ME167_ME168_TRV' : [
description : 'AVATTO TRV6/TRV16/ME167/ME168 TRV', // AVATTO TRV06
// _TZE200_bvu2wnxz
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['childLock':'7', 'antiFreeze':'36', 'limescaleProtect':'39', 'calibrationTemp':'47'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_p3dbf6qs', deviceJoinName: 'Avatto ME168 TRV06'], // https://community.hubitat.com/t/release-tuya-wall-mount-thermostat-water-electric-floor-heating-zigbee-driver/87050/249?u=kkossev
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_rxntag7i', deviceJoinName: 'Avatto ME168 TRV16'], // https://community.hubitat.com/t/beta-tuya-zigbee-thermostats-and-trvs-driver/128916/39?u=kkossev
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_6rdj8dzm', deviceJoinName: 'Avatto ME167 TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0004,0005,EF00,0000', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_bvu2wnxz', deviceJoinName: 'Avatto ME167 TRV'],
],
commands : ["pollTuya":"pollTuya","autoPollThermostat":"autoPollThermostat", 'sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:2, defVal:'1', step:1, scale:1, map:[0: 'auto', 1: 'heat', 2: 'off'] , title:'Thermostat Mode', description:'Thermostat mode'], // 'system_mode'
[dp:3, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'heating', 1:'idle'] , unit:'', description:'Thermostat Operating State(working state)'], // running_state
[dp:4, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:1.0, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:5, name:'temperature', type:'decimal', rw: 'ro', min:0.0, max:50.0, defVal:20.0, step:1.0, scale:10, unit:'°C', description:'Temperature'], // current_heating_setpoint
[dp:7, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child lock'],
[dp:35, name:'batteryLowAlarm', type:'enum', dt: '01', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'lowBattery', 1:'sensorFault'], description:'Alarm'], // fault_alarm tuya.valueConverter.errorOrBatteryLow]
[dp:36, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze support'], // frost_protection'
[dp:39, name:'limescaleProtect', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Limescale Protect', description:'Limescale Protection support'], // scale_protection
[dp:47, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-3.0, max:3.0, defVal:0.0, step:1, scale:1, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'], // local_temperature_calibration
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'AVATTO TRV6/TRV16/ME167/ME168 TRV',
configuration : [:]
],
'AVATTO-TRV07' : [ // https://github.com/eteodun/Avatto-TRV07-TS0601-_TZE200_bvrlmajk/blob/main/tuyats601.js
description : 'AVATTO TRV-07 (not tested!)',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'12', 'calibrationTemp':'101', 'minHeatingSetpoint':'15', 'maxHeatingSetpoint':'16', 'brightness':'111', 'orientation':'113', 'ecoMode':'114'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_bvrlmajk', deviceJoinName: 'AVATTO TRV-07']
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:3, defVal:'1', step:1, scale:1, map:[0: 'auto', 1: 'heat', 2: 'off', 3: 'emergency heat'] , unit:'', title:'Thermostat Mode', description:'Thermostat mode'],
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:-10.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'],
[dp:6, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'heating', 1:'idle'], unit:'', description:'Thermostat Operating State(working state)'],
[dp:7, name:'windowsState', type:'enum', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'open', 1:'closed'] , unit:'', title:'', description:'Window state'],
[dp:8, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Window detection'],
[dp:12, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child lock'],
[dp:13, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:14, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'clear', 1:'faultSensor', 2:'faultMotor', 4:'faultLowBatt', 8:'faultUgLowBatt'], description:'Fault alarm'],
[dp:15, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:1.0, scale:10, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
[dp:16, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:45.0, defVal:35.0, step:1.0, scale:10, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:101, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-10.0, max:19.0, defVal:0.0, step:0.1, scale:10, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'],
[dp:108, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:10, scale:10, unit:'%', description:'Valve level'], // valve open degree
[dp:109, name:'model', type:'number', rw: 'ro', description:'Manufacturer model'], // STRING!
[dp:110, name:'motorThrust', type:'enum', rw: 'ro', defVal:'1', map:[0:'strong', 1:'middle', 2:'weak'], description:'Motor thrust'],
[dp:111, name:'brightness', type:'enum', rw: 'rw', defVal:'1', map:[0:'high', 1:'medium', 2:'low'], title:'Display Brightness', description:'Display brightness'],
[dp:112, name:'softVersion', type:'number', rw: 'ro', description:'Software version'],
[dp:113, name:'orientation', type:'enum', rw: 'rw', defVal:'1', map:[0:'up', 1:'right', 2:'down', 3:'left'], title:'Screen Orientation', description:'Screen orientation'],
[dp:114, name:'ecoMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Eco mode', description:'Eco mode'],
[dp:115, name:'switchDeviation', type:'decimal', rw: 'ro', min:0.5, max:5.0, defVal:1.0, step:10, scale:10, unit:'°C', description:'Valve level'], // ECO mode only?
// ^^^^ "system_mode": { "type": "enum", "range": [ "comfort_mode", "Eco_mode" ] },
//{'comfort': tuya.enum(0), 'eco': tuya.enum(1)}
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['pollTuya'],
deviceJoinName: 'AVATTO TRV-07',
configuration : [:]
],
'Tuya_TRV602' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/f7cb1f160f07fcca7a354429cad9d63c7272ea85/src/devices/tuya.ts#L3285-L3348
description : 'Tuya TRV602 TRV',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'12', /*'calibrationTemp':'101',*/ 'minHeatingSetpoint':'15', 'maxHeatingSetpoint':'16', 'brightness':'111', 'orientation':'113', 'ecoMode':'114'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_rtrmfadk', deviceJoinName: 'Tuya TRV602'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:3, defVal:'1', step:1, scale:1, map:[0: 'auto', 1: 'heat', 2: 'off', 3: 'emergency heat'] , unit:'', title:'Thermostat Mode', description:'Thermostat mode'], // 'system_mode'
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:-10.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'],
[dp:6, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'idle', 1:'heating'], description:'Thermostat Operating State(working state)'],
[dp:7, name:'windowsState', type:'enum', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'closed', 1:'open'], title:'', description:'Window state'],
[dp:8, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Window detection'],
[dp:12, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child lock'],
[dp:13, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:14, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'clear', 1:'error'], description:'Fault alarm'],
[dp:15, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:1.0, scale:10, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
[dp:16, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:45.0, defVal:35.0, step:1.0, scale:10, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:101, name:'calibrationTemp', type:'decimal', rw: 'ro', min:-10.0, max:19.0, defVal:0.0, step:0.1, scale:1, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'],
// ^^^^^ calibrationTemp is temporary made read-only !! https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/src/lib/tuya.ts#L845
[dp:108, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:10, scale:10, unit:'%', description:'Valve level'], // valve open degree
[dp:111, name:'brightness', type:'enum', rw: 'rw', defVal:'1', map:[0:'high', 1:'medium', 2:'low'], title:'Display Brightness', description:'Display brightness'],
[dp:113, name:'orientation', type:'enum', rw: 'rw', defVal:'1', map:[0:'up', 1:'right', 2:'down', 3:'left'], title:'Screen Orientation', description:'Screen orientation'],
[dp:114, name:'ecoMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Eco mode', description:'Eco mode'], // {'comfort': tuya.enum(0), 'eco': tuya.enum(1)}
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['queryAllTuyaDP'],
deviceJoinName: 'Tuya TRV602 TRV',
configuration : [:]
],
'Tuya_TRV602Z' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/af278d3a520a3fb37e7417f41e613cc39c485ea9/src/devices/tuya.ts#L5117C62-L5241
description : 'Tuya TRV602Z TRV',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['controlMode':'127', 'childLock':'7', 'minHeatingSetpoint':'10', 'maxHeatingSetpoint':'9', 'windowOpenDetection':'14', 'calibrationTemp':'47', 'brightness':'111','orientation':'113', 'comfortTemp':'119', 'ecoTemp':'120'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE204_ltwbm23f', deviceJoinName: 'Tuya TRV602Z TRV'] // https://s.click.aliexpress.com/e/_DDZf6Md
],
commands : ["pollTuya":"pollTuya","autoPollThermostat":"autoPollThermostat", 'sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:5, defVal:'3', step:1, scale:1, map:[
0: 'off', // standby: tuya.enum(0),
1: 'antifrost', // antifrost: tuya.enum(1),
2: 'eco', // eco: tuya.enum(2),
3: 'heat', // comfort: tuya.enum(3),
4: 'auto', // auto: tuya.enum(4),
5: 'emergency heat', // on: tuya.enum(5),
] , title:'Thermostat Mode', description:'Thermostat mode'], // 'system_mode' [0: 'auto', 1: 'heat', 2: 'off', 3: 'emergency heat']
//[dp:3, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'heating', 1:'idle'] , unit:'', description:'Thermostat Operating State(working state)'], // running_state
[dp:4, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:5, name:'temperature', type:'decimal', rw: 'ro', min:0.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'], // current_heating_setpoint
[dp:6, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:7, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:9, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:45.0, defVal:35.0, step:1.0, scale:10, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:10, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:1.0, scale:10, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
[dp:14, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Window detection'],
[dp:15, name:'windowsState', type:'enum', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'closed', 1:'open'], title:'', description:'Window state'],
[dp:47, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-3.0, max:3.0, defVal:0.0, step:1, scale:1, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'], // local_temperature_calibration
// ^^ check! ^^^ tuya.valueConverter.localTempCalibration1
[dp:110, name:'motorThrust', type:'enum', rw: 'ro', defVal:'1', map:[0:'strong', 1:'middle', 2:'weak'], description:'Motor thrust'],
[dp:111, name:'brightness', type:'enum', rw: 'rw', defVal:'1', map:[0:'high', 1:'medium', 2:'low'], title:'Display Brightness', description:'Display brightness'],
[dp:113, name:'orientation', type:'enum', rw: 'rw', defVal:'1', map:[0:'up', 1:'right', 2:'down', 3:'left'], title:'Screen Orientation', description:'Screen orientation'],
[dp:114, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:10, scale:10, unit:'%', description:'Valve level'], // valve open degree (position)
[dp:119, name:'comfortTemp', type:'decimal', rw: 'rw', min:5.0, max:30.0, defVal:20.0, step:1.0, scale:10, unit:'°C', title: 'Comfort Temperature', description:'Comfort temperature'],
[dp:120, name:'ecoTemp', type:'decimal', rw: 'rw', min:5.0, max:30.0, defVal:7.0, step:1.0, scale:10, unit:'°C', title: 'Eco Temperature', description:'Eco temperature'],
[dp:127, name:'controlMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'PID', 1:'onOff'] , unit:'', title:'Control Mode', description:'PID - valve smooth control from 0% to 100%
onOff - 0.5 degrees above or below, valve either 0% or 100%'], // 'system_mode', { comfort: 0, eco:(1) }
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['queryAllTuyaDP'],
deviceJoinName: 'Tuya TRV602Z TRV',
configuration : [:]
],
'IMMAX_Neo Lite TRV 07732L' : [
description : 'IMMAX_Neo Lite TRV 07732L (not tested!)',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'13', 'boostTime':'103', 'calibrationTemp':'105', 'ecoTemp':'107', 'minHeatingSetpoint':'109', 'maxHeatingSetpoint':'108'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_rufdtfyv', deviceJoinName: 'Immax 07732L TRV'], // https://community.hubitat.com/t/release-tuya-wall-mount-thermostat-water-electric-floor-heating-zigbee-driver/87050/232?u=kkossev
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:1.0, max:70.0, defVal:20.0, step:0.5, scale:1, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:0.0, max:70.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'],
[dp:4, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:7, defVal:'2', step:1, scale:1, map:[0: 'holiday', 1: 'auto', 2: 'manual', 3: 'comfort', 4: 'eco', 5: 'BOOST', 6: 'temp_auto', 7: 'Valve'] , unit:'', title:'Auto Mode Type', description:'Auto mode type'], // mode
[dp:7, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:13, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'clear', 1:'err1', 2:'err2', 3:'err3', 4:'err4', 5:'err5'], description:'Fault alarm'],
[dp:44, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:0.0, step:1, scale:10, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'],
[dp:102, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:1.0, max:15.0, defVal:10.0, step:1.0, scale:1, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
[dp:103, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:16.0, max:70.0, defVal:35.0, step:1.0, scale:1, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:104, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Window Detection', description:'Window detection'], // Window Parameter
[dp:105, name:'boostTime', type:'number', rw: 'rw', min:100, max:900 , defVal:100, step:1, scale:1, unit:'seconds', title:'Boost Timer', description:'Boost timer'],
[dp:106, name:'valveSet', type:'enum', dt: '01', rw: 'rw', min:0, max:2 , defVal:'0', step:1, scale:1, map:[0:'normal', 1:'forceOpen', 2:'forceClose'], title:'Valve Set', description:'Valve set'],
[dp:107, name:'comfortTemp', type:'decimal', rw: 'rw', min:1.0, max:70.0, defVal:20.0, step:1.0, scale:1, unit:'°C', title: 'Comfort Temperature', description:'Comfort temperature'],
[dp:108, name:'ecoTemp', type:'decimal', rw: 'rw', min:1.0, max:70.0, defVal:18.0, step:1.0, scale:1, unit:'°C', title: 'Eco Temperature', description:'Eco temperature'],
[dp:109, name:'valveStatus', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Valve status'], // Valve Status ?
[dp:110, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:111, name:'autoModeType', type:'enum', rw: 'rw', min:0, max:7, defVal:'2', step:1, scale:1, map:[0: 'holiday', 1: 'auto', 2: 'manual', 3: 'comfort', 4: 'eco', 5: 'BOOST', 6: 'temp_auto', 7: 'Valve'] , unit:'', title:'Auto Mode Type', description:'Auto mode type'], // mode
[dp:112, name:'workdaySet', type:'number', rw: 'ro', description:'Workday Set'],
[dp:113, name:'restdaySet', type:'number', rw: 'ro', description:'Restday Set'],
[dp:114, name:'holidayTemp', type:'decimal', rw: 'rw', min:1.0, max:70.0, defVal:20.0, step:1.0, scale:1, unit:'°C', title: 'Holiday Temperature', description:'Holiday temperature'],
[dp:115, name:'windowsState', type:'enum', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'open', 1:'closed'] , unit:'', title:'', description:'Window state'],
[dp:116, name:'autoLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'], title:'Auto Lock', description:'Auto lock'],
[dp:117, name:'holidayDays', type:'number', rw: 'ro', description:'Holiday Days'], /// 1..30
[dp:118, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:10, scale:1, unit:'%', description:'Valve level'], // Valve Opening
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['pollTuya'],
deviceJoinName: 'IMMAX_Neo Lite TRV 07732L',
configuration : [:]
],
'TUYA_HY367_HY368_HY369_TRV' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/a615c8077123197a6d30aac334160e5dd4cf1058/src/devices/tuya.ts#L3018
description : 'TUYA_HY367_HY368_HY369_TRV (not tested!)',
device : [models: ['TS0601'], type: 'TRV', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['windowOpenDetection':'8', 'childLock':'12', 'boostTime':'103', 'calibrationTemp':'101', 'minHeatingSetpoint':'15', 'maxHeatingSetpoint':'16', 'brightness':'111', 'orientation':'113', 'ecoMode':'114'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_ckud7u2l', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_ywdxldoj', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_do5qy8zo', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_cwnjrr72', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_pvvbommb', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_9sfg7gm0', deviceJoinName: 'TUYA HomeCloud TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_2atgpdho', deviceJoinName: 'TUYA HY367 TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_cpmgn2cf', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'], // https://community.hubitat.com/t/release-tuya-wall-mount-thermostat-water-electric-floor-heating-zigbee-driver/87050/253?u=kkossev
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_znlqjmih', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_8thwkzxl', deviceJoinName: 'TUYA Tervix eva2 TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_4eeyebrt', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE200_lpwgshtl', deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'thermostatMode', type:'enum', rw: 'rw', min:0, max:3, defVal:'1', step:1, scale:1, map:[0: 'auto', 1: 'heat', 2: 'off', 3: 'emergency heat'] , unit:'', title:'Thermostat Mode', description:'Thermostat mode'],
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:-10.0, max:50.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Temperature'],
[dp:6, name:'thermostatOperatingState', type:'enum', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'heating', 1:'idle'], unit:'', description:'Thermostat Operating State(working state)'],
[dp:7, name:'windowsState', type:'enum', rw: 'ro', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'open', 1:'closed'] , unit:'', title:'', description:'Window state'],
[dp:8, name:'windowOpenDetection', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Window Detection', description:'Window detection'],
[dp:12, name:'childLock', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Child Lock', description:'Child lock'],
[dp:13, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:14, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'active', 1:'clear'], description:'Fault alarm'],
[dp:15, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:1.0, scale:10, unit:'°C', title: 'Minimum Temperature', description:'Minimum temperature'],
[dp:16, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:45.0, defVal:35.0, step:1.0, scale:10, unit:'°C', title: 'Maximum Temperature', description:'Maximum temperature'],
[dp:101, name:'calibrationTemp', type:'decimal', rw: 'rw', min:-3.0, max:3.0, defVal:00.0, step:0.1, scale:10, unit:'°C', title:'Calibration Temperature', description:'Calibration Temperature'],
[dp:108, name:'level', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Valve level'], // position
[dp:111, name:'brightness', type:'enum', rw: 'rw', defVal:'1', map:[0:'high', 1:'medium', 2:'low'], title:'Display Brightness', description:'Display brightness'],
[dp:113, name:'orientation', type:'enum', rw: 'rw', defVal:'1', map:[0:'up', 1:'right', 2:'down', 3:'left'], title:'Screen Orientation', description:'Screen orientation'],
[dp:114, name:'ecoMode', type:'enum', dt: '01', rw: 'rw', min:0, max:1 , defVal:'0', step:1, scale:1, map:[0:'off', 1:'on'] , unit:'', title:'Eco mode', description:'Eco mode'],
// or Hysteresis ?
//{'comfort': tuya.enum(0), 'eco': tuya.enum(1)}
],
supportedThermostatModes: ['off', 'heat', 'auto', 'emergency heat', 'eco'],
refresh: ['pollTuya'],
deviceJoinName: 'TUYA_HY367_HY368_HY369_TRV',
configuration : [:]
],
// ---------------------------------------------------- thermostats ----------------------------------------------------
'TUYA/AVATTO_ME81H_THERMOSTAT' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/3ec951e4c16310be29cec0473030827fb9a5bc23/src/devices/moes.ts#L97-L165
description : 'Tuya/Avatto/Moes ME81H Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [childLock:'40', minHeatingSetpoint:'26', maxHeatingSetpoint:'19', sensor:'43', antiFreeze:'103', hysteresis:'106', temperatureCalibration:'105'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_ye5jkfsb", controllerType: "ZGB", deviceJoinName: 'AVATTO ME81H Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_ztvwu4nk", deviceJoinName: 'Tuya Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_5toc8efa", deviceJoinName: 'Tuya Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_5toc8efa", deviceJoinName: 'Tuya Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_aoclfnxz", deviceJoinName: 'Tuya Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_u9bfwha0", deviceJoinName: 'Tuya Thermostat'],
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_u9bfwha0", deviceJoinName: 'Tuya Thermostat']
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/a4a2ac2e382508fc911d721edbb9d4fa308a68bb/lib/tuya.js#L326-L339
[dp:1, name:'systemMode', type:'enum', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'],
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto'], description:'Thermostat Working Mode'], // moesHold: 2,
[dp:16, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:99.0, defVal:20.0, step:1.0, scale:1, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'], // moesHeatingSetpoint: 16,
[dp:19, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:30.0, max:95.0, defVal:40.0, step:1.0, scale:1, unit:'°C', title: 'Maximum Heating Setpoint', description:'Maximum heating setpoint'], // moesMaxTemp: 18,
[dp:23, name:'temperatureScale', type:'enum', rw: 'rw', defVal:'0', map:[0:'Celsius', 1:'Fahrenheit'] , unit:'', description:'Thermostat Operating State(working state)'], // temperature scale temp_unit_convert Enum { "range": [ "c", "f" ] }
[dp:24, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:1 , unit:'°C', description:'Temperature'], // moesLocalTemp: 24,
[dp:26, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:20.0, defVal:10.0, step:1.0, scale:1, unit:'°C', title: 'Minimum Heating Setpoint', description:'Minimum heating setpoint'],
[dp:27, name:'temperatureCorrection', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:0.0, step:1, scale:1, unit:'°C', title:'Temperature Correction', description:'Temperature correction'], // moesTempCalibration: 27,
[dp:36, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[0:'heating', 1:'idle'] , unit:'', description:'Thermostat Operating State(working state)'], // state of the valve valve_state Enum { "range": [ "open", "close" ] }
[dp:39, name:'reset', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Reset', description:'Reset'],
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'], // moesChildLock: 40,
[dp:43, name:'sensor', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'internal', 1:'external', 2:'both'], title:'Sensor Selection', description:'Sensor Selection'], // sensor_choose Enum { "range": [ "in", "out" ] }
[dp:45, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'], // fault alarm Bitmap { "label": [ "e1", "e2", "e3" ] } // etopErrorStatus: 13,
[dp:101, name:'floorTemperature', type:'decimal', rw: 'ro', min:0.0, max:99.0, defVal:20.0, step:0.5, scale:1 , unit:'°C', description:'Temperature'], // moesLocalTemp: 24,
[dp:103, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze support'],
[dp:104, name:'programmingMode', type:'enum', rw: 'ro', defVal:'0', map:[0:'off', 1:'two weekends', 2:'one weeked', 3:'no weekends'], title:'Programming Mode', description:'Programming Mode'],
[dp:105, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:-2.0, step:1, scale:1, unit:'°C', title:'Temperature Calibration', description:'Temperature calibration'],
[dp:106, name:'hysteresis', type:'decimal', rw: 'rw', min:1.0, max:5.0, defVal:1.0, step:1.0, scale:1, title: 'Hysteresis', description:'hysteresis'] // moesDeadZoneTemp: 20,
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'Tuya/Avatto/Moes ME81H Thermostat',
configuration : [:]
],
// TODO - AVATTO (ZWT100) WT198/ZWT100-BH - https://github.com/Koenkk/zigbee-herdsman-converters/blob/34de76fe3d1ffb2aa6dbcd712ceb5178f38712f9/src/devices/tuya.ts#L4338C51-L4338C67 https://www.aliexpress.com/i/3256802774365245.html
'TUYA/MOES_BHT-002_THERMOSTAT' : [ // probably also BSEED ? TODO - check!
description : 'Tuya/Moes BHT-002-GCLZB Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false], // model: 'BHT-002-GCLZB'
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [childLock:'40', minHeatingSetpoint:'26', maxHeatingSetpoint:'19', sensor:'43', antiFreeze:'103', hysteresis:'106', temperatureCalibration:'105'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_aoclfnxz", controllerType: "ZGB", deviceJoinName: 'Moes BHT series Thermostat'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'],
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto', 2:'auto+manual'], description:'Thermostat Working Mode'], // 2:auto w/ temporary changed setpoint
// check for dp:3 !!!! TODO
// check for dp:13 !!!! TODO
[dp:16, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:99.0, defVal:20.0, step:1.0, scale:1, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:19, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:30.0, max:95.0, defVal:40.0, step:1.0, scale:1, unit:'°C', title: 'Maximum Heating Setpoint', description:'Maximum heating setpoint'],
// check for DP:20 !!!! TODO
[dp:23, name:'temperatureScale', type:'enum', rw: 'rw', defVal:'0', map:[0:'Celsius', 1:'Fahrenheit'] , unit:'', description:'Thermostat Operating State(working state)'],
[dp:24, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:10 , unit:'°C', description:'Temperature'], // scale 10 !
[dp:26, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:20.0, defVal:10.0, step:1.0, scale:1, unit:'°C', title: 'Minimum Heating Setpoint', description:'Minimum heating setpoint'],
[dp:27, name:'temperatureCorrection', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:0.0, step:1, scale:1, unit:'°C', title:'Temperature Correction', description:'Temperature correction'],
// check for DP:30 !!!! TODO
[dp:36, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[0:'heating', 1:'idle'] , unit:'', description:'Thermostat Operating State(working state)'],
[dp:39, name:'reset', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Reset', description:'Reset'],
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:43, name:'sensor', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'internal', 1:'external', 2:'both'], title:'Sensor Selection', description:'Sensor Selection'],
[dp:45, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'],
[dp:101, name:'floorTemperature', type:'decimal', rw: 'ro', min:0.0, max:99.0, defVal:20.0, step:0.5, scale:1 , unit:'°C', description:'Temperature'],
// check for DP:102 !!!! TODO
[dp:103, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze support'],
[dp:104, name:'programmingMode', type:'enum', rw: 'ro', defVal:'0', map:[0:'off', 1:'two weekends', 2:'one weeked', 3:'no weekends'], title:'Programming Mode', description:'Programming Mode'],
[dp:105, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.0, max:9.0, defVal:-2.0, step:1, scale:1, unit:'°C', title:'Temperature Calibration', description:'Temperature calibration'],
[dp:106, name:'hysteresis', type:'decimal', rw: 'rw', min:1.0, max:5.0, defVal:1.0, step:1.0, scale:1, title: 'Hysteresis', description:'hysteresis']
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'Moes Thermostat',
configuration : [:]
],
'TUYA/BEOK_THERMOSTAT' : [
description : 'Tuya/Beok X5H-GB-B Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false], // model: 'BHT-002-GCLZB'
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [sound:'7', childLock:'40', /*maxHeatingSetpoint:'19',*/ sensor:'43', antiFreeze:'10', hysteresis:'101', temperatureCalibration:'27', brightness:'104', outputReverse:'103', protectionTemperature:'102'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_2ekuz3dz", controllerType: "ZGB", deviceJoinName: 'Beok X5H-GB-B Thermostat'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt: '01', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'],
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto', 2:'auto+manual'], description:'Thermostat Working Mode'], // 2:auto w/ temporary changed setpoint
[dp:3, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[0:'idle', 1:'heating'] , unit:'', description:'Thermostat Operating State(working state)'],
[dp:7, name:'sound', type:'enum', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'] , unit:'', title: 'Sound', description:'Sound on/off'],
[dp:10, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze support'],
[dp:16, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:0.5, max:60.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'], // scale : x 10 !!
[dp:19, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:35.0, max:95.0, defVal:40.0, step:0.5, scale:10, unit:'°C', title: 'Maximum Heating Setpoint', description:'Maximum heating setpoint'],
// ^^^^^^^^^^^^^^^^^^ sets the heatingSetpoint !!!!!!!!!!!! ^^^^^^^^^ TODO
[dp:24, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:10 , unit:'°C', description:'Temperature'], // scale 10 !
[dp:27, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.9, max:9.9, defVal:-2.0, step:1, scale:10, unit:'°C', title:'Temperature Correction', description:'Temperature correction'],
[dp:30, name:'weeklyProgram', type:'number', rw: 'ro', description:'weeklyProgram'],
[dp:31, name:'programmingMode', type:'enum', rw: 'ro', defVal:'0', map:[0:'off', 1:'5_2 (two weekends)', 2:'6_1 (one weeked)', 3:'7 (no weekends)'], title:'Programming Mode', description:'Programming Mode'],
[dp:39, name:'reset', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Reset', description:'Reset'],
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:43, name:'sensor', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'internal', 1:'external', 2:'both'], title:'Sensor Selection', description:'Sensor Selection'], // only in/out for BEOK
[dp:45, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'],
[dp:101, name:'hysteresis', type:'decimal', rw: 'rw', min:1.0, max:9.5, defVal:1.0, step:0.5, scale:10, title: 'Hysteresis', description:'hysteresis'],
[dp:102, name:'protectionTemperature', type:'decimal', rw: 'rw', min:20.0, max:80.0, defVal:70.0, step:1.0, scale:1, unit:'°C', title: 'Protection Temperature Limit', description:'Protection Temperature Limit'],
[dp:103, name:'outputReverse', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Output Reverse', description:'Output reverse'],
[dp:104, name:'brightness', type:'enum', rw: 'rw', defVal:'2', min:0, max:3, map:[0:'off', 1:'low', 2:'medium', 3:'high'], title:'LCD Brightness', description:'LCD brightness']
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'Beok X5H-GB-B Thermostat', // pairing - hold the Up button for 5 seconds while the thermostat is off.
configuration : [:]
],
'AVATTO_ZWT07_BATTERY_THERMOSTAT' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/c70ee5c41c0c1a4d9e36cf5527d8079e502edf98/src/devices/tuya.ts#L4231-L4274
description : 'Avatto ZWT07 Battery Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [childLock:'40', minHeatingSetpoint:'18', maxHeatingSetpoint:'19', sensor:'43', antiFreeze:'10', hysteresis:'106', temperatureCalibration:'109'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_g9a3awaj", controllerType: "ZGB", deviceJoinName: 'Avatto ZWT07 Battery Thermostat'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt: '01', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'], //'system_mode', 'switch'
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[1:'heat', 0:'auto'], description:'Thermostat Working Mode'], // 'preset', 'mode'
[dp:9, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:10, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze / Frost Protection'], // 'frost_protection'
[dp:16, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:95.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'], // moesHeatingSetpoint: 16,
[dp:18, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:20.0, defVal:5.0, step:1.0, scale:10, unit:'°C', title: 'Minimum Heating Setpoint', description:'Minimum heating setpoint'],
[dp:19, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:21.0, max:95.0, defVal:50.0, step:1.0, scale:10, unit:'°C', title: 'Maximum Heating Setpoint', description:'Maximum heating setpoint'], // moesMaxTemp: 18,
[dp:24, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:10 , unit:'°C', description:'Temperature'], // 'local_temperature'
[dp:31, name:'programmingMode', type:'enum', rw: 'ro', defVal:'0', map:[0:'5/2', 1:'6/1', 2:'7/0'], title:'Programming Mode', description:'Programming Mode'], // workday settings
[dp:36, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[1:'heating', 0:'idle'] , unit:'', description:'Thermostat Operating State(working state)'], // 'running_state' valve state?
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'], // moesChildLock: 40,
[dp:45, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'], // fault alarm Bitmap { "label": [ "e1", "e2", "e3" ] } // etopErrorStatus: 13,
[dp:67, name:'heatingSchedule', type:'number', rw: 'ro', description:'Heating Schedule'],
[dp:105, name:'model', type:'number', rw: 'ro', description:'Model'], // mfg_model String
[dp:109, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.9, max:9.9, defVal:0.0, step:1, scale:10, unit:'°C', title:'Temperature Calibration', description:'Temperature calibration'],
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'Avatto ZWT07 Battery Thermostat',
configuration : [:]
],
'AVATTO_ZWT198_ZWT100-BH_THERMOSTAT' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/8705f77d83dcfa42e9ccc3ad284070abcf7cff00/src/devices/tuya.ts#L6331
description : 'Avatto ZWT198/ZWT100-BH Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [childLock:'9', minHeatingSetpoint:'16', maxHeatingSetpoint:'15', sensor:'106', antiFreeze:'102', hysteresis:'107', temperatureCalibration:'19', brightness:'110'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_xnbkhhdr", controllerType: "ZGB", deviceJoinName: 'Avatto ZWT198/ZWT100-BH Thermostat'], // https://community.hubitat.com/t/avatto-thermostat-driver-note-working-cirrectly/145261?u=kkossev
[profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_lzriup1j", controllerType: "ZGB", deviceJoinName: 'Avatto ZWT198/ZWT100-BH Thermostat'], // https://community.hubitat.com/t/avatto-thermostat-driver-note-working-cirrectly/145261?u=kkossev
[profileId:"0104", endpointId:"01", inClusters:"0004,0005,EF00,0000", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE200_viy9ihs7", controllerType: "ZGB", deviceJoinName: 'Avatto ZWT198/ZWT100-BH Thermostat'], // https://community.hubitat.com/t/avatto-thermostat-driver-note-working-cirrectly/145261?u=kkossev
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt: '01', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'], //'system_mode', 'switch'
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:10 , unit:'°C', description:'Temperature'], // 'local_temperature'
[dp:4, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto', 2:'auto+manual'], description:'Thermostat Working Mode'], // 'preset', 'mode'
// TODO - preProc for _TZE200_viy9ihs7 // https://github.com/Koenkk/zigbee2mqtt/issues/21353#issuecomment-1938328429
[dp:9, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:11, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'],
[dp:15, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:90.0, defVal:60.0, step:0.5, scale:10, unit:'°C', title:'Maximum Heating Setpoint', description:'Maximum heating setpoint'],
[dp:16, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:15.0, defVal:10.0, step:0.5, scale:10, unit:'°C', title:'Minimum Heating Setpoint', description:'Minimum heating setpoint'], // 'dp16 is listed in Tuya, but no communication from device'
[dp:19, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.9, max:9.9, defVal:0.0, step:1, scale:10, unit:'°C', title:'Temperature Calibration', description:'Temperature calibration'],
[dp:101, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[1:'heating', 0:'idle'] , unit:'', description:'Thermostat Operating State(working state)'], // 'running_state' valve state?
[dp:102, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Anti-Freeze', description:'Anti-Freeze / Frost Protection'], // 'frost_protection'
[dp:103, name:'reset', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Factory Reset', description:'Full factory reset, use with caution!'],
[dp:106, name:'sensor', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'internal', 1:'external', 2:'both'], title:'Sensor Selection', description:'Sensor Selection'], // only in/out for BEOK
[dp:107, name:'hysteresis', type:'decimal', rw: 'rw', min:1.0, max:9.5, defVal:1.0, step:0.5, scale:10, title: 'Hysteresis', description:'hysteresis'],
[dp:109, name:'heatingSchedule', type:'number', rw: 'ro', description:'Heating Schedule'],
[dp:110, name:'brightness', type:'enum', rw: 'rw', defVal:'2', map:[0:'off', 1:'low', 2:'medium', 3:'high'], title:'LCD Brightness', description:'LCD brightness']
],
supportedThermostatModes: ['off', 'heat', 'auto'],
refresh: ['pollTuya'],
deviceJoinName: 'Avatto ZWT198/ZWT100-BH Thermostat',
configuration : [:]
],
'MOES_RING_THERMOSTAT' : [ // https://github.com/Koenkk/zigbee-herdsman-converters/blob/0f787aecb1fc85230d9c1d70d90aa8c04d4490f2/src/devices/moes.ts#L1401-L1501
description : 'Moes Ring Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : ['childLock':'39', 'minHeatingSetpoint':'18', 'maxHeatingSetpoint':'34', 'sensor':'32', 'hysteresis':'110', 'ecoTemp':'113', 'temperatureCalibration':'101', 'brightness':'48', 'screenTime':'114', 'highProtectTemperature':'111', 'lowProtectTemperature':'112'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_lpedvtvr", deviceJoinName: 'Moes Ring Thermostat']
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt: '01', rw: 'rw', defVal:'1', map:[0:'off', 1:'on'], title:'Thermostat Switch', description:'Thermostat switch (system mode)'],
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto+manual', 2:'auto', 3:'eco'], title:'Thermostat Mode', description:'Preset mode'],
[dp:16, name:'temperature', type:'decimal', rw: 'ro', min:-20.0, max:60.0, defVal:20.0, step:0.1, scale:10, unit:'°C', description:'Measured temperature'],
[dp:18, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:1.0, max:15.0, defVal:5.0, step:0.5, scale:10, unit:'°C', title:'Minimum Heating Setpoint', description:'Minimum comfort temperature limit'],
[dp:32, name:'sensor', type:'enum', rw: 'rw', defVal:'0', map:[0:'internal', 1:'dual', 2:'external'], title:'Sensor Selection', description:'Temperature sensor mode'],
[dp:34, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:35.0, max:45.0, defVal:45.0, step:0.5, scale:10, unit:'°C', title:'Maximum Heating Setpoint', description:'Maximum comfort temperature limit'],
[dp:39, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:47, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[0:'heating', 1:'idle'], description:'Thermostat operating state'],
[dp:48, name:'brightness', type:'number', rw: 'rw', min:0, max:100, defVal:100, step:1, unit:'%', title:'Backlight Brightness', description:'Display backlight brightness'],
[dp:50, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:45.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title:'Current Heating Setpoint', description:'Target heating setpoint'],
[dp:101, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-10.0, max:10.0, defVal:0.0, step:1.0, scale:1, unit:'°C', title:'Temperature Calibration', description:'Temperature calibration offset'],
[dp:109, name:'floorTemperature', type:'decimal', rw: 'ro', min:0.0, max:70.0, defVal:20.0, step:0.5, scale:10, unit:'°C', description:'Floor temperature'],
[dp:110, name:'hysteresis', type:'decimal', rw: 'rw', min:0.5, max:5.0, defVal:1.0, step:0.5, scale:10, title:'Temperature Deadzone', description:'Temperature delta before heating engages'],
[dp:111, name:'highProtectTemperature', type:'decimal', rw: 'rw', min:10.0, max:70.0, defVal:50.0, step:1.0, scale:10, unit:'°C', title:'High Protect Temperature', description:'High temperature protection threshold'],
[dp:112, name:'lowProtectTemperature', type:'decimal', rw: 'rw', min:0.0, max:10.0, defVal:5.0, step:0.5, scale:10, unit:'°C', title:'Low Protect Temperature', description:'Low temperature protection threshold'],
[dp:113, name:'ecoTemp', type:'decimal', rw: 'rw', min:10.0, max:30.0, defVal:18.0, step:0.5, scale:10, unit:'°C', title:'Eco Temperature', description:'Temperature used in Eco preset'],
[dp:114, name:'screenTime', type:'enum', rw: 'rw', defVal:'2', map:[0:'10 seconds', 1:'20 seconds', 2:'30 seconds', 3:'40 seconds', 4:'50 seconds', 5:'60 seconds'], title:'Screen Timeout', description:'Screen backlight timeout'],
[dp:115, name:'rgbLight', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'RGB Accent Light', description:'Enable the RGB accent light'],
],
supportedThermostatModes: ['off', 'heat', 'auto', 'eco' ],
refresh: ['pollTuya'],
deviceJoinName: 'Moes Ring Thermostat',
configuration : [:]
],
// Moes ZHT-S03 wall thermostat (_TZE204_zxkwaztm)
// https://github.com/Koenkk/zigbee-herdsman-converters/blob/c72493edd5c8818ab0f8d4a8832bf18dac3db172/src/devices/moes.ts#L26
'MOES_ZHT_S03_THERMOSTAT' : [
description : 'Moes ZHT-S03 Zigbee Wall Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint': true, 'ThermostatMode': true, 'TemperatureMeasurement': true],
preferences : [hysteresis:'112', temperatureCalibration:'109', childLock:'40', antiFreeze:'10'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE204_zxkwaztm', deviceJoinName: 'Moes ZHT-S03 Thermostat'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt:'01', rw:'rw', defVal:'1', map:[0:'off', 1:'on'], title:'System Mode', description:'System mode (off/heat)'],
[dp:2, name:'thermostatMode', type:'enum', rw:'rw', defVal:'0', map:[0:'auto', 1:'heat'], title:'Thermostat Mode', description:'Preset (auto/manual)'],
[dp:10, name:'antiFreeze', type:'enum', dt:'01', rw:'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Frost Protection', description:'Antifreeze function'],
[dp:16, name:'heatingSetpoint', type:'decimal', rw:'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title:'Current Heating Setpoint', description:'Current heating setpoint'],
[dp:24, name:'temperature', type:'decimal', rw:'ro', defVal:20.0, scale:10, unit:'°C', description:'Local temperature'],
[dp:31, name:'programmingMode', type:'enum', rw:'ro', defVal:'0', map:[0:'mon_fri', 1:'mon_sat', 2:'mon_sun'], title:'Working Day', description:'Workday setting'],
[dp:36, name:'thermostatOperatingState', type:'enum', rw:'ro', defVal:'0', map:[0:'idle', 1:'heating', 2:'cooling'], description:'Running state (idle/heating/cooling?)'],
[dp:40, name:'childLock', type:'enum', dt:'01', rw:'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:109, name:'temperatureCalibration', type:'decimal', rw:'rw', min:-9.9, max:9.9, defVal:0.0, step:0.1, scale:10, unit:'°C', title:'Local Temperature Calibration', description:'Local temperature calibration'],
[dp:112, name:'hysteresis', type:'decimal', rw:'rw', min:0.1, max:10.0, defVal:1.0, step:0.1, scale:10, unit:'°C', title:'Temperature Delta', description:'Delta between temperature and setpoint to trigger heat'],
// Schedule placeholders (Z2M uses ZWT198_schedule conversion; needs custom parsing/encoding)
[dp:67, name:'scheduleWeekday', type:'number', rw:'ro', description:'Schedule weekday (placeholder; ZWT198_schedule)'],
[dp:68, name:'scheduleHoliday', type:'number', rw:'ro', description:'Schedule holiday (placeholder; ZWT198_schedule)'],
],
supportedThermostatModes: ['off', 'heat', 'auto', 'on'],
refresh: ['pollTuya'],
deviceJoinName: 'Moes ZHT-S03 Thermostat',
configuration : [:]
],
// BOT-R15W-Zigbee (_TZE284_agcxaw3f)
// Based on https://github.com/Koenkk/zigbee-herdsman-converters/issues/10644#issue-3583460679
'BOT_R15W_ZB_THERMOSTAT' : [
description : 'Beok BOT-R15W Zigbee Thermostat',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'battery', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatCoolingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatMode': true, 'ThermostatSetpoint': true, 'TemperatureMeasurement': true],
preferences : [childLock:'9', minHeatingSetpoint:'16', maxHeatingSetpoint:'15', hysteresis:'112', temperatureCalibration:'19', antiFreeze:'102', sound:'114', operationMode:'111'],
fingerprints : [
[profileId:'0104', endpointId:'01', inClusters:'0000,0004,0005,EF00,ED00', outClusters:'0019,000A', model:'TS0601', manufacturer:'_TZE284_agcxaw3f', deviceJoinName: 'Beok BOT-R15W Thermostat']
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
[dp:1, name:'systemMode', type:'enum', dt:'01', rw: 'rw', defVal:'1', map:[0:'off', 1:'on'], title:'System Mode', description:'System mode (off/on)'],
[dp:2, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:35.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title:'Current Heating Setpoint', description:'Target temperature'],
[dp:3, name:'temperature', type:'decimal', rw: 'ro', min:0.0, max:60.0, defVal:20.0, step:0.1, scale:10, unit:'°C', description:'Current room temperature'],
[dp:4, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heat', 1:'auto', 2:'auto+manual', 3:'eco'], title:'Thermostat Mode', description:'Thermostat mode'], // Preset modes: 0: heat, 1: auto+manual, 2: auto, 3: eco (Z2M mapping; device may differ)
[dp:9, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:15, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:15.0, max:40.0, defVal:32.0, step:0.5, scale:10, unit:'°C', title:'Maximum Temperature Limit', description:'Maximum set temperature'],
[dp:16, name:'minHeatingSetpoint', type:'decimal', rw: 'rw', min:5.0, max:20.0, defVal:10.0, step:0.5, scale:10, unit:'°C', title:'Minimum Temperature Limit', description:'Minimum set temperature'],
[dp:19, name:'temperatureCalibration', type:'decimal', rw: 'rw', min:-9.9, max:9.9, defVal:0.0, step:0.1, scale:10, unit:'°C', title:'Local Temperature Calibration', description:'Temperature calibration offset'],
[dp:101, name:'thermostatOperatingState', type:'enum', rw: 'ro', defVal:'0', map:[0:'idle', 1:'heating'], description:'Running state (idle/active)'],
[dp:102, name:'antiFreeze', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Frost Protection', description:'Antifreeze function'],
[dp:111, name:'operationMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'heating', 1:'cooling'], title:'Operation Mode', description:'Switch between heating and cooling modes'],
[dp:112, name:'hysteresis', type:'decimal', rw: 'rw', min:0.5, max:10.0, defVal:1.0, step:0.5, scale:10, unit:'°C', title:'Temperature Delta', description:'Delta between temperature and setpoint to trigger active heating/cooling'],
[dp:113, name:'battery', type:'number', rw: 'ro', min:0, max:100, defVal:100, step:1, scale:1, unit:'%', description:'Battery level'],
[dp:114, name:'sound', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Sound', description:'Beep sound on/off'],
],
supportedThermostatModes: ['off', 'heat', 'auto', 'eco', 'cool'],
refresh: ['pollTuya'],
configuration : [:]
],
/*
'STEEDSMT_VRF_VRV_THERMOSTAT' : [ // https://www.aliexpress.us/item/3256809455660487.html https://community.hubitat.com/t/release-tuya-zigbee-thermostats-and-trvs-driver/128916/127?u=kkossev
// Work In Progress - not tested yet! Not all DPs are known!
description : 'STEEDSMT VRF/VRV Thermostat BVRF-L001',
device : [models: ['TS0601'], type: 'Thermostat', powerSource: 'ac', isSleepy:false],
capabilities : ['ThermostatHeatingSetpoint': true, 'ThermostatOperatingState': true, 'ThermostatSetpoint':true, 'ThermostatMode':true],
preferences : [childLock:'40', maxHeatingSetpoint:'19', sensor:'43', temperatureCalibration:'27', fanSpeed:'49'],
fingerprints : [
[profileId:"0104", endpointId:"01", inClusters:"0000,0004,0005,EF00", outClusters:"0019,000A", model:"TS0601", manufacturer:"_TZE204_6ewjlefg", controllerType: "ZGB", deviceJoinName: 'STEEDSMT VRF/VRV Thermostat BVRF-L001'],
],
commands : ['sendSupportedThermostatModes':'', 'setHeatingSetpoint':'', 'resetStats':'', 'refresh':'', 'initialize':'', 'updateAllPreferences': '', 'resetPreferencesToDefaults':'', 'validateAndFixPreferences':''],
tuyaDPs : [
// working OK (more or less... some DPs need testing)
[dp:1, name:'systemMode', type:'enum', dt: '01', rw: 'rw', defVal:'1', map:[0: 'off', 1: 'on'], title:'Thermostat Switch', description:'Thermostat Switch (system mode)'],
[dp:2, name:'thermostatMode', type:'enum', rw: 'rw', defVal:'0', map:[0:'cool', 1:'heat', 2:'fanOnly', 3:'waterDroplet'], description:'Thermostat Working Mode'],
// thermostatOperatingState is to be tested - cooling/heating/idle ? or dp 101 ? or dp 36?
[dp:3, name:'thermostatOperatingState', type:'enum', rw: 'rw', defVal:'0', map:[0:'idle', 1:'heating', 2:'cooling', 3: 'unknown3', 4:'unknown4'] , unit:'', description:'Thermostat Operating State(working state)'],
// Adjusting the Heating Setpoint from Hubitat seem to be correctly transfer
// ??? But then adjust Setpoint from the Panel only allows like a 2 to 0 degC (reversed?) scale, which it doesnt like, so defaults to 16degC setpoint ???
// Setting a Cooling Setpoint doesn’t seem to change anything
[dp:16, name:'heatingSetpoint', type:'decimal', rw: 'rw', min:0.5, max:60.0, defVal:20.0, step:0.5, scale:10, unit:'°C', title: 'Current Heating Setpoint', description:'Current heating setpoint'], // scale : x 10 !!
[dp:24, name:'temperature', type:'decimal', rw: 'ro', defVal:20.0, scale:10 , unit:'°C', description:'Temperature'], // scale 10 !
[dp:27, name:'temperatureCalibration', type:'number', rw: 'rw', min:-9, max:9, defVal:0, step:1, scale:1, unit:'°C', title:'Temperature Correction', description:'Temperature correction'],
// Preferences – Temperature Correction = -0.5 seems to be the right adjustment for showing measured temp on the panel, but this setting makes big changes to panel displayed temp i.e. 0.1 = approx 1degC correction
[dp:49, name:'fanSpeed', type:'enum', rw: 'rw', defVal:'0', map:[0:'auto', 1:'low', 2:'medium', 3:'unknown'], title:'Fan Speed', description:'Fan Speed'],
// unknown / probably not working at all
[dp:19, name:'maxHeatingSetpoint', type:'decimal', rw: 'rw', min:35.0, max:95.0, defVal:40.0, step:0.5, scale:10, unit:'°C', title: 'Maximum Heating Setpoint', description:'Maximum heating setpoint'],
[dp:39, name:'reset', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Reset', description:'Reset'],
[dp:40, name:'childLock', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'off', 1:'on'], title:'Child Lock', description:'Child lock'],
[dp:43, name:'sensor', type:'enum', dt: '01', rw: 'rw', defVal:'0', map:[0:'internal', 1:'external', 2:'both'], title:'Sensor Selection', description:'Sensor Selection'], // only in/out for BEOK
[dp:45, name:'faultAlarm', type:'enum', rw: 'ro', defVal:'0', map:[0:'e1', 1:'e2', 2:'e3'], title:'Fault Alarm Selection', description:'Fault alarm'],
],
supportedThermostatModes: ['off', 'cool', 'heat', 'fanOnly', 'waterDroplet'],
refresh: ['pollTuya'],
configuration : [:]
],
*/
]
/*
* -----------------------------------------------------------------------------
* thermostat cluster 0x0201
* called from parseThermostatCluster() in the main code ...
* -----------------------------------------------------------------------------
*/
void customParseThermostatCluster(final Map descMap) {
final Integer value = safeToInt(hexStrToUnsignedInt(descMap.value))
logTrace "customParseThermostatCluster: zigbee received Thermostat cluster (0x0201) attribute 0x${descMap.attrId} value ${value} (raw ${descMap.value})"
if (descMap == null || descMap == [:] || descMap.cluster == null || descMap.attrId == null || descMap.value == null) { logTrace 'descMap is missing cluster, attribute or value!'; return }
boolean result = processClusterAttributeFromDeviceProfile(descMap)
if ( result == false ) {
logWarn "parseThermostatClusterThermostat: received unknown Thermostat cluster (0x0201) attribute 0x${descMap.attrId} (value ${descMap.value})"
}
}
List pollTuya() {
logDebug 'pollTuya() called!'
// check if the device is online
if (device.currentState('healthStatus')?.value != 'online') {
logWarn 'pollTuya: device is offline, skipping pollTuya()'
return []
}
sendDigitalEventIfNeeded('temperature')
sendDigitalEventIfNeeded('heatingSetpoint')
sendDigitalEventIfNeeded('level')
ping()
return []
}
//
// called from updated() in the main code
void customUpdated() {
//ArrayList cmds = []
logDebug 'customUpdated: ...'
//if (setting?.advancedOptions == true) {
logInfo "Force manual is ${settings?.forceManual}; Resend failed is ${settings?.resendFailed}"
if (settings?.resendFailed == true) {
logInfo 'resendFailed is enabled!'
runEvery1Minute('receiveCheck')
}
else {
logInfo 'resendFailed is disabled'
unschedule('receiveCheck')
}
//}
//
if (settings?.forcedProfile != null) {
//logDebug "current state.deviceProfile=${state.deviceProfile}, settings.forcedProfile=${settings?.forcedProfile}, getProfileKey()=${getProfileKey(settings?.forcedProfile)}"
if (getProfileKey(settings?.forcedProfile) != state.deviceProfile) {
logWarn "changing the device profile from ${state.deviceProfile} to ${getProfileKey(settings?.forcedProfile)}"
state.deviceProfile = getProfileKey(settings?.forcedProfile)
//initializeVars(fullInit = false)
customInitializeVars(fullInit = false)
resetPreferencesToDefaults(debug = true)
logInfo 'press F5 to refresh the page'
}
}
else {
logDebug 'forcedProfile is not set'
}
final int pollingInterval = (settings.temperaturePollingInterval as Integer) ?: 0
if (pollingInterval > 0) {
logInfo "updatedThermostat: scheduling temperature polling every ${pollingInterval} seconds"
scheduleThermostatPolling(pollingInterval)
}
else {
unScheduleThermostatPolling()
logInfo 'updatedThermostat: thermostat polling is disabled!'
}
// Itterates through all settings
logDebug 'updatedThermostat: updateAllPreferences()...'
updateAllPreferences()
}
List customRefresh() {
List cmds = refreshFromDeviceProfileList()
logDebug "customRefresh: ${cmds} "
return cmds
}
List customConfigure() {
List cmds = []
logDebug "customConfigure() : ${cmds} (not implemented!)"
return cmds
}
// called from initializeDevice in the commonLib code
List customInitializeDevice() {
List cmds = []
logDebug "customInitializeDevice: nothing to initialize for device group ${getDeviceProfile()}"
return cmds
}
void customInitializeVars(final boolean fullInit=false) {
logDebug "customInitializeVars(${fullInit})"
if (state.deviceProfile == null) {
setDeviceNameAndProfile() // in deviceProfileiLib.groovy
}
thermostatInitializeVars(fullInit)
if (fullInit == true) {
resetPreferencesToDefaults()
}
// for Tuya TRVs and thermostats - change the default polling method to 0 'disabled'
if (fullInit || settings?.temperaturePollingInterval == null) { device.updateSetting('temperaturePollingInterval', [value: '0', type: 'enum']) }
if (fullInit || settings?.resendFailed == null) { device.updateSetting('resendFailed', [value: 'false', type: 'bool']) }
if (fullInit || settings?.forceManual == null) { device.updateSetting('forceManual', [value: 'false', type: 'bool']) }
}
// called from initializeVars() in the main code ...
void customInitEvents(final boolean fullInit=false) {
logDebug "customInitEvents(${fullInit})"
thermostatInitEvents(fullInit)
if (settings?.resendFailed == true) {
logInfo 'resendFailed is enabled!'
runEvery1Minute('receiveCheck') // KK: check
}
else {
logInfo 'resendFailed is disabled'
unschedule('receiveCheck')
}
}
// called from processFoundItem (processTuyaDPfromDeviceProfile and ) processClusterAttributeFromDeviceProfile in deviceProfileLib when a Zigbee message was found defined in the device profile map
//
void customProcessDeviceProfileEvent(final Map descMap, final String name, final valueScaled, final String unitText, final String descText) {
logTrace "customProcessDeviceProfileEvent(${name}, ${valueScaled}) called"
Map eventMap = [name: name, value: valueScaled, unit: unitText, descriptionText: descText, type: 'physical', isStateChange: true]
switch (name) {
case 'temperature' :
handleTemperatureEvent(valueScaled as Float)
break
case 'humidity' :
handleHumidityEvent(valueScaled)
break
case 'heatingSetpoint' :
if (isBotR15w() && ((device.currentValue('thermostatMode') == 'cool') || (device.currentValue('operationMode') == 'cooling'))) {
sendCoolingSetpointEvent(valueScaled)
}
else {
sendHeatingSetpointEvent(valueScaled)
}
break
case 'thermostatOperatingState' :
// BOT-R15W uses dp101 for "running_state" (idle/active). If operationMode is cooling, translate active->cooling.
if (device.currentValue('operationMode') == 'cooling' && valueScaled == 'heating') {
eventMap.value = 'cooling'
eventMap.descriptionText = "thermostatOperatingState is cooling"
}
sendEvent(eventMap)
logInfo "${eventMap.descriptionText}"
break
case 'operationMode' :
sendEvent(eventMap)
logInfo "${descText}"
// keep Hubitat thermostatMode aligned with the active operationMode (cooling/heating)
if (isBotR15w() && device.currentValue('thermostatMode') != 'off') {
String tm = (valueScaled == 'cooling') ? 'cool' : 'heat'
sendEvent(name: 'thermostatMode', value: tm, isStateChange: true, descriptionText: "thermostatMode is ${tm}", type: 'physical')
state.lastThermostatMode = tm
}
break
case 'systemMode' : // Aqara E1 and AVATTO thermostat (off/on)
sendEvent(eventMap)
logInfo "${descText}"
if (valueScaled == 'on') { // should be initialized with 'unknown' value
String lastThermostatMode = state.lastThermostatMode
sendEvent(name: 'thermostatMode', value: lastThermostatMode, isStateChange: true, description: 'TRV systemMode is on', type: 'digital')
}
else {
sendEvent(name: 'thermostatMode', value: 'off', isStateChange: true, description: 'TRV systemMode is off', type: 'digital')
}
break
case 'thermostatMode' : // AVATTO send the thermostat mode a second after being switched off - ignore it !
if (isBotR15w()) {
String tm = valueScaled
if (tm == 'heat' && device.currentValue('operationMode') == 'cooling') {
tm = 'cool'
}
eventMap.value = tm
eventMap.descriptionText = "thermostatMode is ${tm}"
sendEvent(eventMap)
logInfo "${eventMap.descriptionText}"
state.lastThermostatMode = tm
break
}
if (device.currentValue('systemMode') == 'off' ) {
logWarn "customProcessDeviceProfileEvent: ignoring the thermostatMode ${valueScaled} event, because the systemMode is off"
}
else {
sendEvent(eventMap)
logInfo "${descText}"
state.lastThermostatMode = valueScaled
}
// added 02/16/2025
if (settings?.forceManual == true) {
if (valueScaled == 'auto') {
logWarn "customProcessDeviceProfileEvent: forceManual is enabled! Changing the thermostatMode from auto to heat"
runIn(1, 'heat')
}
}
break
case 'ecoMode' : // BRT-100 - simulate OFF mode ?? or keep the ecoMode on ?
sendEvent(eventMap)
logInfo "${descText}"
if (valueScaled == 'on') { // ecoMode is on
sendEvent(name: 'thermostatMode', value: 'eco', isStateChange: true, description: 'BRT-100 ecoMode is on', type: 'digital')
sendEvent(name: 'thermostatOperatingState', value: 'idle', isStateChange: true, description: 'BRT-100 ecoMode is on', type: 'digital')
state.lastThermostatMode = 'eco'
}
else {
sendEvent(name: 'thermostatMode', value: 'heat', isStateChange: true, description: 'BRT-100 ecoMode is off')
state.lastThermostatMode = 'heat'
}
break
case 'emergencyHeating' : // BRT-100
sendEvent(eventMap)
logInfo "${descText}"
if (valueScaled == 'on') { // the valve shoud be completely open, however the level and the working states are NOT updated! :(
sendEvent(name: 'thermostatMode', value: 'emergency heat', isStateChange: true, description: 'BRT-100 emergencyHeating is on')
sendEvent(name: 'thermostatOperatingState', value: 'heating', isStateChange: true, description: 'BRT-100 emergencyHeating is on')
}
else {
sendEvent(name: 'thermostatMode', value: 'heat', isStateChange: true, description: 'BRT-100 emergencyHeating is off')
}
break
case 'level' : // BRT-100
sendEvent(eventMap)
logInfo "${descText}"
if (valueScaled == 0) { // the valve is closed
sendEvent(name: 'thermostatOperatingState', value: 'idle', isStateChange: true, description: 'BRT-100 valve is closed')
}
else {
sendEvent(name: 'thermostatOperatingState', value: 'heating', isStateChange: true, description: 'BRT-100 valve is open %{valueScaled} %')
}
break
default :
sendEvent(name : name, value : valueScaled, unit:unitText, descriptionText: descText, type: 'physical', isStateChange: true) // attribute value is changed - send an event !
//if (!doNotTrace) {
logDebug "event ${name} sent w/ value ${valueScaled}"
logInfo "${descText}" // send an Info log also (because value changed ) // TODO - check whether Info log will be sent also for spammy DPs ?
//}
break
}
}
void customParseTuyaCluster(final Map descMap) {
boolean isDuplicated = false
/* TODO
int dp = zigbee.convertHexToInt(descMap?.data[2])
int fncmd = getTuyaAttributeValue(descMap?.data, 0) // PATCH! zero-based index
if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == '0B') { // ZCL Command Default Response
setLastRx( NOT_SET, NOT_SET) // -1
}
else if (descMap?.clusterInt == CLUSTER_TUYA && dp != 24) { // Tuya set time command
if (checkIfIsDuplicated( dp, fncmd )) {
logDebug "(duplicate) dp=${dp} fncmd=${fncmd} command=${descMap?.command} data = ${descMap?.data}"
state.stats['dupeCtr'] = (state.stats['dupeCtr'] ?: 0) + 1
isDuplicated = true
}
else {
logDebug "${device.displayName} dp_id=${dp_id} dp=${dp} fncmd=${fncmd}"
setLastRx( dp, fncmd)
}
}
*/
if (isDuplicated == false) {
standardParseTuyaCluster(descMap) // defined in commonLib
}
}
// receiveCheck() is unconditionally scheduled Every1Minute from installed() ..
void receiveCheck() {
logDebug "receiveCheck() called"
modeReceiveCheck()
setpointReceiveCheck()
setBrightnessReceiveCheck()
}
// NOT ACTIVATED !!! Needs a dedicated setBrightness() command ?
// Brightness checking is also called every 1 minute from receiveCheck()
void setBrightnessReceiveCheck() {
if (settings?.resendFailed == false ) { return }
if (state.lastTx.isSetBrightnessReq == false) { return }
if (state.lastTx.setBrightness != NOT_SET && ((state.lastTx.setBrightness as String) != (state.lastRx.setBrightness as String))) {
state.lastTx.setBrightnessRetries = (state.lastTx.setBrightnessRetries ?: 0) + 1
if (state.lastTx.setBrightnessRetries < MaxRetries) {
logWarn "setBrightnessReceiveCheck(${state.lastTx.setBrightness}) failed (last received is still ${state.lastRx.setBrightness})"
logDebug "resending setBrightness command : ${state.lastTx.setBrightness} (retry# ${state.lastTx.setBrightnessRetries}) of ${MaxRetries}"
state.stats.txFailCtr = (state.stats.txFailCtr ?: 0) + 1
//setBrightness(lastTxMap.setBrightness)
setPar('brightness', state.lastTx.setBrightness)
}
else {
logWarn "setBrightnessReceiveCheck(${state.lastTx.setBrightness}) giving up retrying"
state.lastTx.isSetBrightnessReq = false
state.lastTx.setBrightnessRetries = 0
}
}
else {
logDebug "setBrightnessReceiveCheck brightness was changed successfuly to (${state.lastTx.setBrightness}). No need for further checks."
state.lastTx.setBrightness = NOT_SET
state.lastTx.isSetBrightnessReq = false
}
}
import java.math.RoundingMode
def localTempCalibration1 = [
from: { long raw ->
// device-specific: positives are small; huge means "wrapped negative"
if (raw > 55L) raw -= 0x100000000L
return raw / 10 // BigDecimal in Groovy
},
to: { BigDecimal v ->
if (v == 0) return 0L
long scaled = (v * 10).setScale(0, RoundingMode.HALF_UP).longValue()
if (scaled < 0L) return scaled + 0x100000000L
return scaled
},
]
def localTempCalibration2 = [
from: { long raw ->
return raw
},
to: { long v ->
if (v < 0L) return v + 0x100000000L
return v
},
]
def localTempCalibration3 = [
from: { long raw ->
// standard signed-32 detection
if (raw > 0x7FFFFFFFL) raw -= 0x100000000L
return raw / 10
},
to: { BigDecimal v ->
if (v == 0) return 0L
long scaled = (v * 10).setScale(0, RoundingMode.HALF_UP).longValue()
if (scaled < 0L) return scaled + 0x100000000L
return scaled
},
]
void testT(String par) {
log.trace "testT(${par}) : DEVICE.preferences = ${DEVICE.preferences}"
Map result
if (DEVICE != null && DEVICE.preferences != null && DEVICE.preferences != [:]) {
(DEVICE.preferences).each { key, value ->
log.trace "testT: ${key} = ${value}"
result = inputIt(key, debug = true)
logDebug "inputIt: ${result}"
}
}
}
// /////////////////////////////////////////////////////////////////// Libraries //////////////////////////////////////////////////////////////////////
// ~~~~~ start include (144) kkossev.commonLib ~~~~~
/* groovylint-disable CompileStatic, DuplicateListLiteral, DuplicateMapLiteral, DuplicateNumberLiteral, DuplicateStringLiteral, ImplicitClosureParameter, ImplicitReturnStatement, InsecureRandom, LineLength, MethodCount, MethodReturnTypeRequired, MethodSize, NglParseError, NoDouble, ParameterName, PublicMethodsBeforeNonPublicMethods, StaticMethodsBeforeInstanceMethods, UnnecessaryGetter, UnnecessaryGroovyImport, UnnecessaryObjectReferences, UnnecessaryPackageReference, UnnecessaryPublicModifier, UnnecessarySetter, UnusedImport, UnusedPrivateMethod, VariableName */ // library marker kkossev.commonLib, line 1
library( // library marker kkossev.commonLib, line 2
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Common ZCL Library', name: 'commonLib', namespace: 'kkossev', // library marker kkossev.commonLib, line 3
importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/refs/heads/development/Libraries/commonLib.groovy', documentationLink: 'https://github.com/kkossev/Hubitat/wiki/libraries-commonLib', // library marker kkossev.commonLib, line 4
version: '4.0.3' // library marker kkossev.commonLib, line 5
) // library marker kkossev.commonLib, line 6
/* // library marker kkossev.commonLib, line 7
* Common ZCL Library // library marker kkossev.commonLib, line 8
* // library marker kkossev.commonLib, line 9
* Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.commonLib, line 10
* in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.commonLib, line 11
* // library marker kkossev.commonLib, line 12
* http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.commonLib, line 13
* // library marker kkossev.commonLib, line 14
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.commonLib, line 15
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.commonLib, line 16
* for the specific language governing permissions and limitations under the License. // library marker kkossev.commonLib, line 17
* // library marker kkossev.commonLib, line 18
* This library is inspired by @w35l3y work on Tuya device driver (Edge project). // library marker kkossev.commonLib, line 19
* For a big portions of code all credits go to Jonathan Bradshaw. // library marker kkossev.commonLib, line 20
* // library marker kkossev.commonLib, line 21
* // library marker kkossev.commonLib, line 22
* ver. 1.0.0 2022-06-18 kkossev - first beta version // library marker kkossev.commonLib, line 23
* .............................. // library marker kkossev.commonLib, line 24
* ver. 3.5.2 2025-08-13 kkossev - Status attribute renamed to _status_ // library marker kkossev.commonLib, line 25
* ver. 4.0.0 2025-09-17 kkossev - deviceProfileV4; HOBEIAN as Tuya device; customInitialize() hook; // library marker kkossev.commonLib, line 26
* ver. 4.0.1 2025-10-14 kkossev - added clusters 0xFC80 and 0xFC81 // library marker kkossev.commonLib, line 27
* ver. 4.0.2 2025-10-18 kkossev - added tuyaDelay in sendTuyaCommand() // library marker kkossev.commonLib, line 28
* ver. 4.0.3 2025-10-18 kkossev - added ignoreDuplicatedZigbeeMessages setting; DIGITAL_TIMER increased to 5000 ms // library marker kkossev.commonLib, line 29
* // library marker kkossev.commonLib, line 30
* TODO: change the offline threshold to 2 // library marker kkossev.commonLib, line 31
* TODO: add GetInfo (endpoints list) command (in the 'Tuya Device' driver?) // library marker kkossev.commonLib, line 32
* TODO: make the configure() without parameter smart - analyze the State variables and call delete states.... call ActiveAndpoints() or/amd initialize() or/and configure() // library marker kkossev.commonLib, line 33
* TODO: check - offlineCtr is not increasing? (ZBMicro); // library marker kkossev.commonLib, line 34
* TODO: check deviceCommandTimeout() // library marker kkossev.commonLib, line 35
* TODO: when device rejoins the network, read the battery percentage again (probably in custom handler, not for all devices) // library marker kkossev.commonLib, line 36
* TODO: refresh() to include updating the softwareBuild data version // library marker kkossev.commonLib, line 37
* TODO: map the ZCL powerSource options to Hubitat powerSource options // library marker kkossev.commonLib, line 38
* TODO: MOVE ZDO counters to health state? // library marker kkossev.commonLib, line 39
* TODO: refresh() to bypass the duplicated events and minimim delta time between events checks // library marker kkossev.commonLib, line 40
* TODO: Versions of the main module + included libraries (in the 'Tuya Device' driver?) // library marker kkossev.commonLib, line 41
* TODO: disableDefaultResponse for Tuya commands // library marker kkossev.commonLib, line 42
* // library marker kkossev.commonLib, line 43
*/ // library marker kkossev.commonLib, line 44
String commonLibVersion() { '4.0.3' } // library marker kkossev.commonLib, line 46
String commonLibStamp() { '2025/12/06 10:51 PM' } // library marker kkossev.commonLib, line 47
import groovy.transform.Field // library marker kkossev.commonLib, line 49
import hubitat.device.HubMultiAction // library marker kkossev.commonLib, line 50
import hubitat.device.Protocol // library marker kkossev.commonLib, line 51
import hubitat.helper.HexUtils // library marker kkossev.commonLib, line 52
import hubitat.zigbee.zcl.DataType // library marker kkossev.commonLib, line 53
import java.util.concurrent.ConcurrentHashMap // library marker kkossev.commonLib, line 54
import groovy.json.JsonOutput // library marker kkossev.commonLib, line 55
import groovy.transform.CompileStatic // library marker kkossev.commonLib, line 56
import java.math.BigDecimal // library marker kkossev.commonLib, line 57
metadata { // library marker kkossev.commonLib, line 59
if (_DEBUG) { // library marker kkossev.commonLib, line 60
command 'test', [[name: 'test', type: 'STRING', description: 'test', defaultValue : '']] // library marker kkossev.commonLib, line 61
command 'testParse', [[name: 'testParse', type: 'STRING', description: 'testParse', defaultValue : '']] // library marker kkossev.commonLib, line 62
command 'tuyaTest', [ // library marker kkossev.commonLib, line 63
[name:'dpCommand', type: 'STRING', description: 'Tuya DP Command', constraints: ['STRING']], // library marker kkossev.commonLib, line 64
[name:'dpValue', type: 'STRING', description: 'Tuya DP value', constraints: ['STRING']], // library marker kkossev.commonLib, line 65
[name:'dpType', type: 'ENUM', constraints: ['DP_TYPE_VALUE', 'DP_TYPE_BOOL', 'DP_TYPE_ENUM'], description: 'DP data type'] // library marker kkossev.commonLib, line 66
] // library marker kkossev.commonLib, line 67
} // library marker kkossev.commonLib, line 68
// common capabilities for all device types // library marker kkossev.commonLib, line 70
capability 'Configuration' // library marker kkossev.commonLib, line 71
capability 'Refresh' // library marker kkossev.commonLib, line 72
capability 'HealthCheck' // library marker kkossev.commonLib, line 73
capability 'PowerSource' // powerSource - ENUM ["battery", "dc", "mains", "unknown"] // library marker kkossev.commonLib, line 74
// common attributes for all device types // library marker kkossev.commonLib, line 76
attribute 'healthStatus', 'enum', ['unknown', 'offline', 'online'] // library marker kkossev.commonLib, line 77
attribute 'rtt', 'number' // library marker kkossev.commonLib, line 78
attribute '_status_', 'string' // library marker kkossev.commonLib, line 79
// common commands for all device types // library marker kkossev.commonLib, line 81
command 'configure', [[name:'⚙️ Advanced administrative and diagnostic commands • Use only when troubleshooting or reconfiguring the device', type: 'ENUM', constraints: ConfigureOpts.keySet() as List]] // library marker kkossev.commonLib, line 82
command 'ping', [[name:'📡 Test device connectivity and measure response time • Updates the RTT attribute with round-trip time in milliseconds']] // library marker kkossev.commonLib, line 83
command 'refresh', [[name:"🔄 Query the device for current state and update the attributes. • ⚠️ Battery-powered 'sleepy' devices may not respond!"]] // library marker kkossev.commonLib, line 84
// trap for Hubitat F2 bug // library marker kkossev.commonLib, line 86
fingerprint profileId:'0104', endpointId:'F2', inClusters:'', outClusters:'', model:'unknown', manufacturer:'unknown', deviceJoinName: 'Zigbee device affected by Hubitat F2 bug' // library marker kkossev.commonLib, line 87
preferences { // library marker kkossev.commonLib, line 89
// txtEnable and logEnable moved to the custom driver settings - copy& paste there ... // library marker kkossev.commonLib, line 90
//input name: 'txtEnable', type: 'bool', title: 'Enable descriptionText logging', defaultValue: true, description: 'Enables command logging.' // library marker kkossev.commonLib, line 91
//input name: 'logEnable', type: 'bool', title: 'Enable debug logging', defaultValue: true, description: 'Turns on debug logging for 24 hours.' // library marker kkossev.commonLib, line 92
if (device) { // library marker kkossev.commonLib, line 94
input name: 'advancedOptions', type: 'bool', title: 'Advanced Options', description: 'The advanced options should be already automatically set in an optimal way for your device...Click on the "Save and Close" button when toggling this option!', defaultValue: false // library marker kkossev.commonLib, line 95
if (advancedOptions == true) { // library marker kkossev.commonLib, line 96
input name: 'healthCheckMethod', type: 'enum', title: 'Healthcheck Method', options: HealthcheckMethodOpts.options, defaultValue: HealthcheckMethodOpts.defaultValue, required: true, description: 'Method to check device online/offline status.' // library marker kkossev.commonLib, line 97
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"' // library marker kkossev.commonLib, line 98
input name: 'ignoreDuplicatedZigbeeMessages', type: 'bool', title: 'Ignore Duplicated Zigbee Messages', defaultValue: false, description: 'Ignore identical Zigbee attribute reports received within short time periods to reduce log spam and redundant processing' // library marker kkossev.commonLib, line 99
input name: 'traceEnable', type: 'bool', title: 'Enable trace logging', defaultValue: false, description: 'Turns on detailed extra trace logging for 30 minutes.' // library marker kkossev.commonLib, line 100
} // library marker kkossev.commonLib, line 101
} // library marker kkossev.commonLib, line 102
} // library marker kkossev.commonLib, line 103
} // library marker kkossev.commonLib, line 104
@Field static final Integer IGNORE_DUPLICATED_ZIGBEE_MESSAGES_TIMER = 1000 // 1 second // library marker kkossev.commonLib, line 106
@Field static final Integer DIGITAL_TIMER = 5000 // command was sent by this driver // library marker kkossev.commonLib, line 107
@Field static final Integer REFRESH_TIMER = 6000 // refresh time in miliseconds // library marker kkossev.commonLib, line 108
@Field static final Integer DEBOUNCING_TIMER = 300 // ignore switch events // library marker kkossev.commonLib, line 109
@Field static final Integer COMMAND_TIMEOUT = 10 // timeout time in seconds // library marker kkossev.commonLib, line 110
@Field static final Integer MAX_PING_MILISECONDS = 10000 // rtt more than 10 seconds will be ignored // library marker kkossev.commonLib, line 111
@Field static final String UNKNOWN = 'UNKNOWN' // library marker kkossev.commonLib, line 112
@Field static final Integer DEFAULT_MIN_REPORTING_TIME = 10 // send the report event no more often than 10 seconds by default // library marker kkossev.commonLib, line 113
@Field static final Integer DEFAULT_MAX_REPORTING_TIME = 3600 // library marker kkossev.commonLib, line 114
@Field static final Integer PRESENCE_COUNT_THRESHOLD = 3 // missing 3 checks will set the device healthStatus to offline // library marker kkossev.commonLib, line 115
@Field static final int DELAY_MS = 200 // Delay in between zigbee commands // library marker kkossev.commonLib, line 116
@Field static final Integer INFO_AUTO_CLEAR_PERIOD = 60 // automatically clear the Info attribute after 60 seconds // library marker kkossev.commonLib, line 117
@Field static final Map HealthcheckMethodOpts = [ // used by healthCheckMethod // library marker kkossev.commonLib, line 119
defaultValue: 1, options: [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] // library marker kkossev.commonLib, line 120
] // library marker kkossev.commonLib, line 121
@Field static final Map HealthcheckIntervalOpts = [ // used by healthCheckInterval // library marker kkossev.commonLib, line 122
defaultValue: 240, options: [2: 'Every 2 Mins', 10: 'Every 10 Mins', 30: 'Every 30 Mins', 60: 'Every 1 Hour', 240: 'Every 4 Hours', 720: 'Every 12 Hours'] // library marker kkossev.commonLib, line 123
] // library marker kkossev.commonLib, line 124
@Field static final Map ConfigureOpts = [ // library marker kkossev.commonLib, line 126
'*** LOAD ALL DEFAULTS ***' : [key:0, function: 'loadAllDefaults'], // library marker kkossev.commonLib, line 127
'Configure the device' : [key:2, function: 'configureNow'], // library marker kkossev.commonLib, line 128
'Reset Statistics' : [key:9, function: 'resetStatistics'], // library marker kkossev.commonLib, line 129
' -- ' : [key:3, function: 'configureHelp'], // library marker kkossev.commonLib, line 130
'Delete All Preferences' : [key:4, function: 'deleteAllSettings'], // library marker kkossev.commonLib, line 131
'Delete All Current States' : [key:5, function: 'deleteAllCurrentStates'], // library marker kkossev.commonLib, line 132
'Delete All Scheduled Jobs' : [key:6, function: 'deleteAllScheduledJobs'], // library marker kkossev.commonLib, line 133
'Delete All State Variables' : [key:7, function: 'deleteAllStates'], // library marker kkossev.commonLib, line 134
'Delete All Child Devices' : [key:8, function: 'deleteAllChildDevices'], // library marker kkossev.commonLib, line 135
' - ' : [key:1, function: 'configureHelp'] // library marker kkossev.commonLib, line 136
] // library marker kkossev.commonLib, line 137
public boolean isVirtual() { device.controllerType == null || device.controllerType == '' } // library marker kkossev.commonLib, line 139
/** // library marker kkossev.commonLib, line 141
* Parse Zigbee message // library marker kkossev.commonLib, line 142
* @param description Zigbee message in hex format // library marker kkossev.commonLib, line 143
*/ // library marker kkossev.commonLib, line 144
public void parse(final String description) { // library marker kkossev.commonLib, line 145
Map stateCopy = state // .clone() throws java.lang.CloneNotSupportedException in HE platform version 2.4.1.155 ! // library marker kkossev.commonLib, line 147
checkDriverVersion(stateCopy) // +1 ms // library marker kkossev.commonLib, line 148
if (state.stats != null) { state.stats?.rxCtr= (state.stats?.rxCtr ?: 0) + 1 } else { state.stats = [:] } // updateRxStats(state) // +1 ms // library marker kkossev.commonLib, line 149
if (state.lastRx != null) { state.lastRx?.timeStamp = unix2formattedDate(now()) } else { state.lastRx = [:] } // library marker kkossev.commonLib, line 150
unscheduleCommandTimeoutCheck(state) // library marker kkossev.commonLib, line 151
setHealthStatusOnline(state) // +2 ms // library marker kkossev.commonLib, line 152
if (description?.startsWith('zone status') || description?.startsWith('zone report')) { // library marker kkossev.commonLib, line 154
logDebug "parse: zone status: $description" // library marker kkossev.commonLib, line 155
if (this.respondsTo('customParseIasMessage')) { customParseIasMessage(description) } // library marker kkossev.commonLib, line 156
else if (this.respondsTo('standardParseIasMessage')) { standardParseIasMessage(description) } // library marker kkossev.commonLib, line 157
else if (this.respondsTo('parseIasMessage')) { parseIasMessage(description) } // library marker kkossev.commonLib, line 158
else { logDebug "ignored IAS zone status (no IAS parser) description: $description" } // library marker kkossev.commonLib, line 159
return // library marker kkossev.commonLib, line 160
} // library marker kkossev.commonLib, line 161
else if (description?.startsWith('enroll request')) { // library marker kkossev.commonLib, line 162
logDebug "parse: enroll request: $description" // library marker kkossev.commonLib, line 163
/* 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). */ // library marker kkossev.commonLib, line 164
if (settings?.logEnable) { logInfo 'Sending IAS enroll response...' } // library marker kkossev.commonLib, line 165
List cmds = zigbee.enrollResponse() + zigbee.readAttribute(0x0500, 0x0000) // library marker kkossev.commonLib, line 166
logDebug "enroll response: ${cmds}" // library marker kkossev.commonLib, line 167
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 168
return // library marker kkossev.commonLib, line 169
} // library marker kkossev.commonLib, line 170
if (isTuyaE00xCluster(description) == true || otherTuyaOddities(description) == true) { // +15 ms // library marker kkossev.commonLib, line 172
return // library marker kkossev.commonLib, line 173
} // library marker kkossev.commonLib, line 174
final Map descMap = myParseDescriptionAsMap(description) // +5 ms // library marker kkossev.commonLib, line 175
if (!isChattyDeviceReport(descMap)) { logDebug "parse: descMap = ${descMap} description=${description }" } // library marker kkossev.commonLib, line 177
if (isSpammyDeviceReport(descMap)) { return } // +20 mS (both) // library marker kkossev.commonLib, line 178
if (descMap.profileId == '0000') { // library marker kkossev.commonLib, line 180
parseZdoClusters(descMap) // library marker kkossev.commonLib, line 181
return // library marker kkossev.commonLib, line 182
} // library marker kkossev.commonLib, line 183
if (descMap.isClusterSpecific == false) { // library marker kkossev.commonLib, line 184
parseGeneralCommandResponse(descMap) // library marker kkossev.commonLib, line 185
return // library marker kkossev.commonLib, line 186
} // library marker kkossev.commonLib, line 187
// // library marker kkossev.commonLib, line 188
if (standardAndCustomParseCluster(descMap, description)) { return } // library marker kkossev.commonLib, line 189
// // library marker kkossev.commonLib, line 190
switch (descMap.clusterInt as Integer) { // library marker kkossev.commonLib, line 191
case 0x000C : // special case : ZigUSB // Aqara TVOC Air Monitor; Aqara Cube T1 Pro; // library marker kkossev.commonLib, line 192
if (this.respondsTo('customParseAnalogInputClusterDescription')) { // library marker kkossev.commonLib, line 193
customParseAnalogInputClusterDescription(descMap, description) // ZigUSB // library marker kkossev.commonLib, line 194
descMap.remove('additionalAttrs')?.each { final Map map -> customParseAnalogInputClusterDescription(descMap + map, description) } // library marker kkossev.commonLib, line 195
} // library marker kkossev.commonLib, line 196
break // library marker kkossev.commonLib, line 197
case 0x0300 : // Patch - need refactoring of the standardParseColorControlCluster ! // library marker kkossev.commonLib, line 198
if (this.respondsTo('standardParseColorControlCluster')) { // library marker kkossev.commonLib, line 199
standardParseColorControlCluster(descMap, description) // library marker kkossev.commonLib, line 200
descMap.remove('additionalAttrs')?.each { final Map map -> standardParseColorControlCluster(descMap + map, description) } // library marker kkossev.commonLib, line 201
} // library marker kkossev.commonLib, line 202
break // library marker kkossev.commonLib, line 203
default: // library marker kkossev.commonLib, line 204
if (settings.logEnable) { // library marker kkossev.commonLib, line 205
logWarn "parse: zigbee received unknown cluster:${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 206
} // library marker kkossev.commonLib, line 207
break // library marker kkossev.commonLib, line 208
} // library marker kkossev.commonLib, line 209
} // library marker kkossev.commonLib, line 210
@Field static final Map ClustersMap = [ // library marker kkossev.commonLib, line 212
0x0000: 'Basic', 0x0001: 'Power', 0x0003: 'Identify', 0x0004: 'Groups', 0x0005: 'Scenes', 0x0006: 'OnOff', 0x0007:'onOffConfiguration', 0x0008: 'LevelControl', // library marker kkossev.commonLib, line 213
0x000C: 'AnalogInput', 0x0012: 'MultistateInput', 0x0020: 'PollControl', 0x0102: 'WindowCovering', 0x0201: 'Thermostat', 0x0204: 'ThermostatConfig',/*0x0300: 'ColorControl',*/ // library marker kkossev.commonLib, line 214
0x0400: 'Illuminance', 0x0402: 'Temperature', 0x0405: 'Humidity', 0x0406: 'Occupancy', 0x042A: 'Pm25', 0x0500: 'IAS', 0x0702: 'Metering', // library marker kkossev.commonLib, line 215
0x0B04: 'ElectricalMeasure', 0xE001: 'E0001', 0xE002: 'E002', 0xEC03: 'EC03', 0xEF00: 'Tuya', 0xFC03: 'FC03', 0xFC11: 'FC11', 0xFC7E: 'AirQualityIndex', // Sensirion VOC index // library marker kkossev.commonLib, line 216
0xFC80: 'FC80', 0xFC81: 'FC81', 0xFCC0: 'XiaomiFCC0' // library marker kkossev.commonLib, line 217
] // library marker kkossev.commonLib, line 218
// first try calling the custom parser, if not found, call the standard parser // library marker kkossev.commonLib, line 220
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.commonLib, line 221
boolean standardAndCustomParseCluster(Map descMap, final String description) { // library marker kkossev.commonLib, line 222
Integer clusterInt = descMap.clusterInt as Integer // library marker kkossev.commonLib, line 223
String clusterName = ClustersMap[clusterInt] ?: UNKNOWN // library marker kkossev.commonLib, line 224
if (clusterName == null || clusterName == UNKNOWN) { // library marker kkossev.commonLib, line 225
logWarn "standardAndCustomParseCluster: zigbee received unknown cluster:0x${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 226
return false // library marker kkossev.commonLib, line 227
} // library marker kkossev.commonLib, line 228
String customParser = "customParse${clusterName}Cluster" // library marker kkossev.commonLib, line 229
// check if a custom parser is defined in the custom driver. If found there, the standard parser should be called within that custom parser, if needed // library marker kkossev.commonLib, line 230
if (this.respondsTo(customParser)) { // library marker kkossev.commonLib, line 231
this."${customParser}"(descMap) // library marker kkossev.commonLib, line 232
descMap.remove('additionalAttrs')?.each { final Map map -> this."${customParser}"(descMap + map) } // library marker kkossev.commonLib, line 233
return true // library marker kkossev.commonLib, line 234
} // library marker kkossev.commonLib, line 235
String standardParser = "standardParse${clusterName}Cluster" // library marker kkossev.commonLib, line 236
// if no custom parser is defined, try the standard parser (if exists), eventually defined in the included library file // library marker kkossev.commonLib, line 237
if (this.respondsTo(standardParser)) { // library marker kkossev.commonLib, line 238
this."${standardParser}"(descMap) // library marker kkossev.commonLib, line 239
descMap.remove('additionalAttrs')?.each { final Map map -> this."${standardParser}"(descMap + map) } // library marker kkossev.commonLib, line 240
return true // library marker kkossev.commonLib, line 241
} // library marker kkossev.commonLib, line 242
if (device?.getDataValue('model') != 'ZigUSB' && descMap.cluster != '0300') { // patch! // library marker kkossev.commonLib, line 243
logWarn "standardAndCustomParseCluster: Missing ${standardParser} or ${customParser} handler for cluster:0x${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 244
} // library marker kkossev.commonLib, line 245
return false // library marker kkossev.commonLib, line 246
} // library marker kkossev.commonLib, line 247
// not used - throws exception : error groovy.lang.MissingPropertyException: No such property: rxCtr for class: java.lang.String on line 1568 (method parse) // library marker kkossev.commonLib, line 249
private static void updateRxStats(final Map state) { // library marker kkossev.commonLib, line 250
if (state.stats != null) { state.stats['rxCtr'] = (state.stats['rxCtr'] ?: 0) + 1 } else { state.stats = [:] } // +5ms // library marker kkossev.commonLib, line 251
} // library marker kkossev.commonLib, line 252
public boolean isChattyDeviceReport(final Map descMap) { // when @CompileStatis is slower? // library marker kkossev.commonLib, line 254
if (_TRACE_ALL == true) { return false } // library marker kkossev.commonLib, line 255
if (this.respondsTo('isSpammyDPsToNotTrace')) { // defined in deviceProfileLib // library marker kkossev.commonLib, line 256
return isSpammyDPsToNotTrace(descMap) // library marker kkossev.commonLib, line 257
} // library marker kkossev.commonLib, line 258
return false // library marker kkossev.commonLib, line 259
} // library marker kkossev.commonLib, line 260
public boolean isSpammyDeviceReport(final Map descMap) { // library marker kkossev.commonLib, line 262
if (_TRACE_ALL == true) { return false } // library marker kkossev.commonLib, line 263
if (this.respondsTo('isSpammyDPsToIgnore')) { // defined in deviceProfileLib // library marker kkossev.commonLib, line 264
return isSpammyDPsToIgnore(descMap) // library marker kkossev.commonLib, line 265
} // library marker kkossev.commonLib, line 266
return false // library marker kkossev.commonLib, line 267
} // library marker kkossev.commonLib, line 268
@Field static final Map ZdoClusterEnum = [ // library marker kkossev.commonLib, line 270
0x0002: 'Node Descriptor Request', 0x0005: 'Active Endpoints Request', 0x0006: 'Match Descriptor Request', 0x0022: 'Unbind Request', 0x0013: 'Device announce', 0x0034: 'Management Leave Request', // library marker kkossev.commonLib, line 271
0x8002: 'Node Descriptor Response', 0x8004: 'Simple Descriptor Response', 0x8005: 'Active Endpoints Response', 0x801D: 'Extended Simple Descriptor Response', 0x801E: 'Extended Active Endpoint Response', // library marker kkossev.commonLib, line 272
0x8021: 'Bind Response', 0x8022: 'Unbind Response', 0x8023: 'Bind Register Response', 0x8034: 'Management Leave Response' // library marker kkossev.commonLib, line 273
] // library marker kkossev.commonLib, line 274
// ZDO (Zigbee Data Object) Clusters Parsing // library marker kkossev.commonLib, line 276
private void parseZdoClusters(final Map descMap) { // library marker kkossev.commonLib, line 277
if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 278
final Integer clusterId = descMap.clusterInt as Integer // library marker kkossev.commonLib, line 279
final String clusterName = ZdoClusterEnum[clusterId] ?: "UNKNOWN_CLUSTER (0x${descMap.clusterId})" // library marker kkossev.commonLib, line 280
final String statusHex = ((List)descMap.data)[1] // library marker kkossev.commonLib, line 281
final Integer statusCode = hexStrToUnsignedInt(statusHex) // library marker kkossev.commonLib, line 282
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${statusHex}" // library marker kkossev.commonLib, line 283
final String clusterInfo = "${device.displayName} Received ZDO ${clusterName} (0x${descMap.clusterId}) status ${statusName}" // library marker kkossev.commonLib, line 284
List cmds = [] // library marker kkossev.commonLib, line 285
switch (clusterId) { // library marker kkossev.commonLib, line 286
case 0x0005 : // library marker kkossev.commonLib, line 287
state.stats['activeEpRqCtr'] = (state.stats['activeEpRqCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 288
if (settings?.logEnable) { log.debug "${clusterInfo}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, data:${descMap.data})" } // library marker kkossev.commonLib, line 289
// send the active endpoint response // library marker kkossev.commonLib, line 290
cmds += ["he raw ${device.deviceNetworkId} 0 0 0x8005 {00 00 00 00 01 01} {0x0000}"] // library marker kkossev.commonLib, line 291
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 292
break // library marker kkossev.commonLib, line 293
case 0x0006 : // library marker kkossev.commonLib, line 294
state.stats['matchDescCtr'] = (state.stats['matchDescCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 295
if (settings?.logEnable) { log.debug "${clusterInfo}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, Input cluster count:${descMap.data[5]} Input cluster: 0x${descMap.data[7] + descMap.data[6]})" } // library marker kkossev.commonLib, line 296
cmds += ["he raw ${device.deviceNetworkId} 0 0 0x8006 {00 00 00 00 00} {0x0000}"] // library marker kkossev.commonLib, line 297
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 298
break // library marker kkossev.commonLib, line 299
case 0x0013 : // device announcement // library marker kkossev.commonLib, line 300
state.stats['rejoinCtr'] = (state.stats['rejoinCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 301
if (settings?.logEnable) { log.debug "${clusterInfo}, rejoinCtr= ${state.stats['rejoinCtr']}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, Device network ID: ${descMap.data[2] + descMap.data[1]}, Capability Information: ${descMap.data[11]})" } // library marker kkossev.commonLib, line 302
break // library marker kkossev.commonLib, line 303
case 0x8004 : // simple descriptor response // library marker kkossev.commonLib, line 304
if (settings?.logEnable) { log.debug "${clusterInfo}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, status:${descMap.data[1]}, lenght:${hubitat.helper.HexUtils.hexStringToInt(descMap.data[4])}" } // library marker kkossev.commonLib, line 305
if (this.respondsTo('parseSimpleDescriptorResponse')) { parseSimpleDescriptorResponse(descMap) } // library marker kkossev.commonLib, line 306
break // library marker kkossev.commonLib, line 307
case 0x8005 : // endpoint response // library marker kkossev.commonLib, line 308
String endpointCount = descMap.data[4] // library marker kkossev.commonLib, line 309
String endpointList = descMap.data[5] // library marker kkossev.commonLib, line 310
if (settings?.logEnable) { log.debug "${clusterInfo}, (endpoint response) endpointCount = ${endpointCount} endpointList = ${endpointList}" } // library marker kkossev.commonLib, line 311
break // library marker kkossev.commonLib, line 312
case 0x8021 : // bind response // library marker kkossev.commonLib, line 313
if (settings?.logEnable) { log.debug "${clusterInfo}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, Status: ${descMap.data[1] == '00' ? 'Success' : 'Failure'})" } // library marker kkossev.commonLib, line 314
break // library marker kkossev.commonLib, line 315
case 0x0002 : // Node Descriptor Request // library marker kkossev.commonLib, line 316
case 0x0036 : // Permit Joining Request // library marker kkossev.commonLib, line 317
case 0x8022 : // unbind request // library marker kkossev.commonLib, line 318
case 0x8034 : // leave response // library marker kkossev.commonLib, line 319
if (settings?.logEnable) { log.debug "${device.displayName} Unprocessed ZDO command: cluster=${descMap.clusterId} command=${descMap.command} attrId=${descMap.attrId} value=${descMap.value} data=${descMap.data}" } // library marker kkossev.commonLib, line 320
break // library marker kkossev.commonLib, line 321
default : // library marker kkossev.commonLib, line 322
if (settings?.logEnable) { log.warn "${device.displayName} Unprocessed ZDO command: cluster=${descMap.clusterId} command=${descMap.command} attrId=${descMap.attrId} value=${descMap.value} data=${descMap.data}" } // library marker kkossev.commonLib, line 323
break // library marker kkossev.commonLib, line 324
} // library marker kkossev.commonLib, line 325
if (this.respondsTo('customParseZdoClusters')) { customParseZdoClusters(descMap) } // library marker kkossev.commonLib, line 326
} // library marker kkossev.commonLib, line 327
// Zigbee General Command Parsing // library marker kkossev.commonLib, line 329
private void parseGeneralCommandResponse(final Map descMap) { // library marker kkossev.commonLib, line 330
final int commandId = hexStrToUnsignedInt(descMap.command) // library marker kkossev.commonLib, line 331
switch (commandId) { // library marker kkossev.commonLib, line 332
case 0x01: parseReadAttributeResponse(descMap); break // library marker kkossev.commonLib, line 333
case 0x04: parseWriteAttributeResponse(descMap); break // library marker kkossev.commonLib, line 334
case 0x07: parseConfigureResponse(descMap); break // library marker kkossev.commonLib, line 335
case 0x09: parseReadReportingConfigResponse(descMap); break // library marker kkossev.commonLib, line 336
case 0x0B: parseDefaultCommandResponse(descMap); break // library marker kkossev.commonLib, line 337
default: // library marker kkossev.commonLib, line 338
final String commandName = ZigbeeGeneralCommandEnum[commandId] ?: "UNKNOWN_COMMAND (0x${descMap.command})" // library marker kkossev.commonLib, line 339
final String clusterName = clusterLookup(descMap.clusterInt) // library marker kkossev.commonLib, line 340
final String status = descMap.data in List ? ((List)descMap.data).last() : descMap.data // library marker kkossev.commonLib, line 341
final int statusCode = hexStrToUnsignedInt(status) // library marker kkossev.commonLib, line 342
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" // library marker kkossev.commonLib, line 343
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 344
log.warn "zigbee ${commandName} ${clusterName} error: ${statusName}" // library marker kkossev.commonLib, line 345
} else if (settings.logEnable) { // library marker kkossev.commonLib, line 346
log.trace "zigbee ${commandName} ${clusterName}: ${descMap.data}" // library marker kkossev.commonLib, line 347
} // library marker kkossev.commonLib, line 348
break // library marker kkossev.commonLib, line 349
} // library marker kkossev.commonLib, line 350
} // library marker kkossev.commonLib, line 351
// Zigbee Read Attribute Response Parsing // library marker kkossev.commonLib, line 353
private void parseReadAttributeResponse(final Map descMap) { // library marker kkossev.commonLib, line 354
final List data = descMap.data as List // library marker kkossev.commonLib, line 355
final String attribute = data[1] + data[0] // library marker kkossev.commonLib, line 356
final int statusCode = hexStrToUnsignedInt(data[2]) // library marker kkossev.commonLib, line 357
final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data}" // library marker kkossev.commonLib, line 358
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 359
logWarn "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} error: ${status}" // library marker kkossev.commonLib, line 360
} // library marker kkossev.commonLib, line 361
else { // library marker kkossev.commonLib, line 362
logDebug "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} response: ${status} ${data}" // library marker kkossev.commonLib, line 363
} // library marker kkossev.commonLib, line 364
} // library marker kkossev.commonLib, line 365
// Zigbee Write Attribute Response Parsing // library marker kkossev.commonLib, line 367
private void parseWriteAttributeResponse(final Map descMap) { // library marker kkossev.commonLib, line 368
final String data = descMap.data in List ? ((List)descMap.data).first() : descMap.data // library marker kkossev.commonLib, line 369
final int statusCode = hexStrToUnsignedInt(data) // library marker kkossev.commonLib, line 370
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data}" // library marker kkossev.commonLib, line 371
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 372
logWarn "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute error: ${statusName}" // library marker kkossev.commonLib, line 373
} // library marker kkossev.commonLib, line 374
else { // library marker kkossev.commonLib, line 375
logDebug "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute response: ${statusName}" // library marker kkossev.commonLib, line 376
} // library marker kkossev.commonLib, line 377
} // library marker kkossev.commonLib, line 378
// Zigbee Configure Reporting Response Parsing - command 0x07 // library marker kkossev.commonLib, line 380
private void parseConfigureResponse(final Map descMap) { // library marker kkossev.commonLib, line 381
// TODO - parse the details of the configuration respose - cluster, min, max, delta ... // library marker kkossev.commonLib, line 382
final String status = ((List)descMap.data).first() // library marker kkossev.commonLib, line 383
final int statusCode = hexStrToUnsignedInt(status) // library marker kkossev.commonLib, line 384
if (statusCode == 0x00 && settings.enableReporting != false) { // library marker kkossev.commonLib, line 385
state.reportingEnabled = true // library marker kkossev.commonLib, line 386
} // library marker kkossev.commonLib, line 387
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" // library marker kkossev.commonLib, line 388
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 389
log.warn "zigbee configure reporting error: ${statusName} ${descMap.data}" // library marker kkossev.commonLib, line 390
} else { // library marker kkossev.commonLib, line 391
logDebug "zigbee configure reporting response: ${statusName} ${descMap.data}" // library marker kkossev.commonLib, line 392
} // library marker kkossev.commonLib, line 393
} // library marker kkossev.commonLib, line 394
// Parses the response of reading reporting configuration - command 0x09 // library marker kkossev.commonLib, line 396
private void parseReadReportingConfigResponse(final Map descMap) { // library marker kkossev.commonLib, line 397
int status = zigbee.convertHexToInt(descMap.data[0]) // Status: Success (0x00) // library marker kkossev.commonLib, line 398
//def attr = zigbee.convertHexToInt(descMap.data[3])*256 + zigbee.convertHexToInt(descMap.data[2]) // Attribute: OnOff (0x0000) // library marker kkossev.commonLib, line 399
if (status == 0) { // library marker kkossev.commonLib, line 400
//def dataType = zigbee.convertHexToInt(descMap.data[4]) // Data Type: Boolean (0x10) // library marker kkossev.commonLib, line 401
int min = zigbee.convertHexToInt(descMap.data[6]) * 256 + zigbee.convertHexToInt(descMap.data[5]) // library marker kkossev.commonLib, line 402
int max = zigbee.convertHexToInt(descMap.data[8] + descMap.data[7]) // library marker kkossev.commonLib, line 403
int delta = 0 // library marker kkossev.commonLib, line 404
if (descMap.data.size() >= 10) { // library marker kkossev.commonLib, line 405
delta = zigbee.convertHexToInt(descMap.data[10] + descMap.data[9]) // library marker kkossev.commonLib, line 406
} // library marker kkossev.commonLib, line 407
else { // library marker kkossev.commonLib, line 408
logTrace "descMap.data.size = ${descMap.data.size()}" // library marker kkossev.commonLib, line 409
} // library marker kkossev.commonLib, line 410
logDebug "Received Read Reporting Configuration Response (0x09) for cluster:${descMap.clusterId} attribute:${descMap.data[3] + descMap.data[2]}, data=${descMap.data} (Status: ${descMap.data[0] == '00' ? 'Success' : 'Failure'}) min=${min} max=${max} delta=${delta}" // library marker kkossev.commonLib, line 411
} // library marker kkossev.commonLib, line 412
else { // library marker kkossev.commonLib, line 413
logWarn "Not Found (0x8b) Read Reporting Configuration Response for cluster:${descMap.clusterId} attribute:${descMap.data[3] + descMap.data[2]}, data=${descMap.data} (Status: ${descMap.data[0] == '00' ? 'Success' : 'Failure'})" // library marker kkossev.commonLib, line 414
} // library marker kkossev.commonLib, line 415
} // library marker kkossev.commonLib, line 416
private Boolean executeCustomHandler(String handlerName, Object handlerArgs) { // library marker kkossev.commonLib, line 418
if (!this.respondsTo(handlerName)) { // library marker kkossev.commonLib, line 419
logTrace "executeCustomHandler: function ${handlerName} not found" // library marker kkossev.commonLib, line 420
return false // library marker kkossev.commonLib, line 421
} // library marker kkossev.commonLib, line 422
// execute the customHandler function // library marker kkossev.commonLib, line 423
Boolean result = false // library marker kkossev.commonLib, line 424
try { // library marker kkossev.commonLib, line 425
result = "$handlerName"(handlerArgs) // library marker kkossev.commonLib, line 426
} // library marker kkossev.commonLib, line 427
catch (e) { // library marker kkossev.commonLib, line 428
logWarn "executeCustomHandler: Exception '${e}'caught while processing $handlerName($handlerArgs) (val=${fncmd}))" // library marker kkossev.commonLib, line 429
return false // library marker kkossev.commonLib, line 430
} // library marker kkossev.commonLib, line 431
//logDebug "customSetFunction result is ${fncmd}" // library marker kkossev.commonLib, line 432
return result // library marker kkossev.commonLib, line 433
} // library marker kkossev.commonLib, line 434
// Zigbee Default Command Response Parsing // library marker kkossev.commonLib, line 436
private void parseDefaultCommandResponse(final Map descMap) { // library marker kkossev.commonLib, line 437
final List data = descMap.data as List // library marker kkossev.commonLib, line 438
final String commandId = data[0] // library marker kkossev.commonLib, line 439
final int statusCode = hexStrToUnsignedInt(data[1]) // library marker kkossev.commonLib, line 440
final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data[1]}" // library marker kkossev.commonLib, line 441
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 442
logWarn "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} error: ${status}" // library marker kkossev.commonLib, line 443
} else { // library marker kkossev.commonLib, line 444
logDebug "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} response: ${status}" // library marker kkossev.commonLib, line 445
// ZigUSB has its own interpretation of the Zigbee standards ... :( // library marker kkossev.commonLib, line 446
if (this.respondsTo('customParseDefaultCommandResponse')) { // library marker kkossev.commonLib, line 447
customParseDefaultCommandResponse(descMap) // library marker kkossev.commonLib, line 448
} // library marker kkossev.commonLib, line 449
} // library marker kkossev.commonLib, line 450
} // library marker kkossev.commonLib, line 451
// Zigbee Attribute IDs // library marker kkossev.commonLib, line 453
@Field static final int ATTRIBUTE_READING_INFO_SET = 0x0000 // library marker kkossev.commonLib, line 454
@Field static final int FIRMWARE_VERSION_ID = 0x4000 // library marker kkossev.commonLib, line 455
@Field static final int PING_ATTR_ID = 0x01 // library marker kkossev.commonLib, line 456
@Field static final Map ZigbeeStatusEnum = [ // library marker kkossev.commonLib, line 458
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', // library marker kkossev.commonLib, line 459
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' // library marker kkossev.commonLib, line 460
] // library marker kkossev.commonLib, line 461
@Field static final Map ZigbeeGeneralCommandEnum = [ // library marker kkossev.commonLib, line 463
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', // library marker kkossev.commonLib, line 464
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', // library marker kkossev.commonLib, line 465
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', // library marker kkossev.commonLib, line 466
0x14: 'Discover Commands Generated Response', 0x15: 'Discover Attributes Extended', 0x16: 'Discover Attributes Extended Response' // library marker kkossev.commonLib, line 467
] // library marker kkossev.commonLib, line 468
@Field static final int ROLLING_AVERAGE_N = 10 // library marker kkossev.commonLib, line 470
private BigDecimal approxRollingAverage(BigDecimal avgPar, BigDecimal newSample) { // library marker kkossev.commonLib, line 471
BigDecimal avg = avgPar // library marker kkossev.commonLib, line 472
if (avg == null || avg == 0) { avg = newSample } // library marker kkossev.commonLib, line 473
avg -= avg / ROLLING_AVERAGE_N // library marker kkossev.commonLib, line 474
avg += newSample / ROLLING_AVERAGE_N // library marker kkossev.commonLib, line 475
return avg // library marker kkossev.commonLib, line 476
} // library marker kkossev.commonLib, line 477
private void handlePingResponse() { // library marker kkossev.commonLib, line 479
Long now = new Date().getTime() // library marker kkossev.commonLib, line 480
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 481
state.lastRx['checkInTime'] = now // library marker kkossev.commonLib, line 482
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: '0').toInteger() // library marker kkossev.commonLib, line 484
if (timeRunning > 0 && timeRunning < MAX_PING_MILISECONDS) { // library marker kkossev.commonLib, line 485
state.stats['pingsOK'] = (state.stats['pingsOK'] ?: 0) + 1 // library marker kkossev.commonLib, line 486
if (timeRunning < safeToInt((state.stats['pingsMin'] ?: '999'))) { state.stats['pingsMin'] = timeRunning } // library marker kkossev.commonLib, line 487
if (timeRunning > safeToInt((state.stats['pingsMax'] ?: '0'))) { state.stats['pingsMax'] = timeRunning } // library marker kkossev.commonLib, line 488
state.stats['pingsAvg'] = approxRollingAverage(safeToDouble(state.stats['pingsAvg']), safeToDouble(timeRunning)) as int // library marker kkossev.commonLib, line 489
sendRttEvent() // library marker kkossev.commonLib, line 490
} // library marker kkossev.commonLib, line 491
else { // library marker kkossev.commonLib, line 492
logWarn "unexpected ping timeRunning=${timeRunning} " // library marker kkossev.commonLib, line 493
} // library marker kkossev.commonLib, line 494
state.states['isPing'] = false // library marker kkossev.commonLib, line 495
} // library marker kkossev.commonLib, line 496
/* // library marker kkossev.commonLib, line 498
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 499
* Standard clusters reporting handlers // library marker kkossev.commonLib, line 500
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 501
*/ // library marker kkossev.commonLib, line 502
@Field static final Map powerSourceOpts = [ defaultValue: 0, options: [0: 'unknown', 1: 'mains', 2: 'mains', 3: 'battery', 4: 'dc', 5: 'emergency mains', 6: 'emergency mains']] // library marker kkossev.commonLib, line 503
// Zigbee Basic Cluster Parsing 0x0000 - called from the main parse method // library marker kkossev.commonLib, line 505
private void standardParseBasicCluster(final Map descMap) { // library marker kkossev.commonLib, line 506
Long now = new Date().getTime() // library marker kkossev.commonLib, line 507
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 508
state.lastRx['checkInTime'] = now // library marker kkossev.commonLib, line 509
boolean isPing = state.states?.isPing ?: false // library marker kkossev.commonLib, line 510
switch (descMap.attrInt as Integer) { // library marker kkossev.commonLib, line 511
case 0x0000: // library marker kkossev.commonLib, line 512
logDebug "Basic cluster: ZCLVersion = ${descMap?.value}" // library marker kkossev.commonLib, line 513
break // library marker kkossev.commonLib, line 514
case PING_ATTR_ID: // 0x01 - Using 0x01 read as a simple ping/pong mechanism // library marker kkossev.commonLib, line 515
if (isPing) { // library marker kkossev.commonLib, line 516
handlePingResponse() // library marker kkossev.commonLib, line 517
} // library marker kkossev.commonLib, line 518
else { // library marker kkossev.commonLib, line 519
logTrace "Tuya check-in message (attribute ${descMap.attrId} reported: ${descMap.value})" // library marker kkossev.commonLib, line 520
} // library marker kkossev.commonLib, line 521
break // library marker kkossev.commonLib, line 522
case 0x0004: // library marker kkossev.commonLib, line 523
logDebug "received device manufacturer ${descMap?.value}" // library marker kkossev.commonLib, line 524
// received device manufacturer IKEA of Sweden // library marker kkossev.commonLib, line 525
String manufacturer = device.getDataValue('manufacturer') // library marker kkossev.commonLib, line 526
if ((manufacturer == null || manufacturer == 'unknown') && (descMap?.value != null)) { // library marker kkossev.commonLib, line 527
logWarn "updating device manufacturer from ${manufacturer} to ${descMap?.value}" // library marker kkossev.commonLib, line 528
device.updateDataValue('manufacturer', descMap?.value) // library marker kkossev.commonLib, line 529
} // library marker kkossev.commonLib, line 530
break // library marker kkossev.commonLib, line 531
case 0x0005: // library marker kkossev.commonLib, line 532
if (isPing) { // library marker kkossev.commonLib, line 533
handlePingResponse() // library marker kkossev.commonLib, line 534
} // library marker kkossev.commonLib, line 535
else { // library marker kkossev.commonLib, line 536
logDebug "received device model ${descMap?.value}" // library marker kkossev.commonLib, line 537
// received device model Remote Control N2 // library marker kkossev.commonLib, line 538
String model = device.getDataValue('model') // library marker kkossev.commonLib, line 539
if ((model == null || model == 'unknown') && (descMap?.value != null)) { // library marker kkossev.commonLib, line 540
logWarn "updating device model from ${model} to ${descMap?.value}" // library marker kkossev.commonLib, line 541
device.updateDataValue('model', descMap?.value) // library marker kkossev.commonLib, line 542
} // library marker kkossev.commonLib, line 543
} // library marker kkossev.commonLib, line 544
break // library marker kkossev.commonLib, line 545
case 0x0007: // library marker kkossev.commonLib, line 546
String powerSourceReported = powerSourceOpts.options[descMap?.value as int] // library marker kkossev.commonLib, line 547
logDebug "received Power source ${powerSourceReported} (${descMap?.value})" // library marker kkossev.commonLib, line 548
String currentPowerSource = device.getDataValue('powerSource') // library marker kkossev.commonLib, line 549
if (currentPowerSource == null || currentPowerSource == 'unknown') { // library marker kkossev.commonLib, line 550
logInfo "updating device powerSource from ${currentPowerSource} to ${powerSourceReported}" // library marker kkossev.commonLib, line 551
sendEvent(name: 'powerSource', value: powerSourceReported, type: 'physical') // library marker kkossev.commonLib, line 552
} // library marker kkossev.commonLib, line 553
break // library marker kkossev.commonLib, line 554
case 0xFFDF: // library marker kkossev.commonLib, line 555
logDebug "Tuya check-in (Cluster Revision=${descMap?.value})" // library marker kkossev.commonLib, line 556
break // library marker kkossev.commonLib, line 557
case 0xFFE2: // library marker kkossev.commonLib, line 558
logDebug "Tuya check-in (AppVersion=${descMap?.value})" // library marker kkossev.commonLib, line 559
break // library marker kkossev.commonLib, line 560
case [0xFFE0, 0xFFE1, 0xFFE3, 0xFFE4] : // library marker kkossev.commonLib, line 561
logTrace "Tuya attribute ${descMap?.attrId} value=${descMap?.value}" // library marker kkossev.commonLib, line 562
break // library marker kkossev.commonLib, line 563
case 0xFFFE: // library marker kkossev.commonLib, line 564
logTrace "Tuya attributeReportingStatus (attribute FFFE) value=${descMap?.value}" // library marker kkossev.commonLib, line 565
break // library marker kkossev.commonLib, line 566
case FIRMWARE_VERSION_ID: // 0x4000 // library marker kkossev.commonLib, line 567
final String version = descMap.value ?: 'unknown' // library marker kkossev.commonLib, line 568
log.info "device firmware version is ${version}" // library marker kkossev.commonLib, line 569
updateDataValue('softwareBuild', version) // library marker kkossev.commonLib, line 570
break // library marker kkossev.commonLib, line 571
default: // library marker kkossev.commonLib, line 572
logWarn "zigbee received unknown Basic cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.commonLib, line 573
break // library marker kkossev.commonLib, line 574
} // library marker kkossev.commonLib, line 575
} // library marker kkossev.commonLib, line 576
private void standardParsePollControlCluster(final Map descMap) { // library marker kkossev.commonLib, line 578
switch (descMap.attrInt as Integer) { // library marker kkossev.commonLib, line 579
case 0x0000: logDebug "PollControl cluster: CheckInInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 580
case 0x0001: logDebug "PollControl cluster: LongPollInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 581
case 0x0002: logDebug "PollControl cluster: ShortPollInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 582
case 0x0003: logDebug "PollControl cluster: FastPollTimeout = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 583
case 0x0004: logDebug "PollControl cluster: CheckInIntervalMin = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 584
case 0x0005: logDebug "PollControl cluster: LongPollIntervalMin = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 585
case 0x0006: logDebug "PollControl cluster: FastPollTimeoutMax = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 586
default: logDebug "zigbee received unknown PollControl cluster attribute 0x${descMap.attrId} (value ${descMap.value})" ; break // library marker kkossev.commonLib, line 587
} // library marker kkossev.commonLib, line 588
} // library marker kkossev.commonLib, line 589
public void clearIsDigital() { state.states['isDigital'] = false } // library marker kkossev.commonLib, line 591
void switchDebouncingClear() { state.states['debounce'] = false } // library marker kkossev.commonLib, line 592
void isRefreshRequestClear() { state.states['isRefresh'] = false } // library marker kkossev.commonLib, line 593
Map myParseDescriptionAsMap(String description) { // library marker kkossev.commonLib, line 595
Map descMap = [:] // library marker kkossev.commonLib, line 596
try { // library marker kkossev.commonLib, line 597
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 598
} // library marker kkossev.commonLib, line 599
catch (e1) { // library marker kkossev.commonLib, line 600
logWarn "exception ${e1} caught while parseDescriptionAsMap myParseDescriptionAsMap description: ${description}" // library marker kkossev.commonLib, line 601
// try alternative custom parsing // library marker kkossev.commonLib, line 602
descMap = [:] // library marker kkossev.commonLib, line 603
try { // library marker kkossev.commonLib, line 604
descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> // library marker kkossev.commonLib, line 605
List pair = entry.split(':') // library marker kkossev.commonLib, line 606
[(pair.first().trim()): pair.last().trim()] // library marker kkossev.commonLib, line 607
} // library marker kkossev.commonLib, line 608
} // library marker kkossev.commonLib, line 609
catch (e2) { // library marker kkossev.commonLib, line 610
logWarn "exception ${e2} caught while parsing using an alternative method myParseDescriptionAsMap description: ${description}" // library marker kkossev.commonLib, line 611
return [:] // library marker kkossev.commonLib, line 612
} // library marker kkossev.commonLib, line 613
logDebug "alternative method parsing success: descMap=${descMap}" // library marker kkossev.commonLib, line 614
} // library marker kkossev.commonLib, line 615
return descMap // library marker kkossev.commonLib, line 616
} // library marker kkossev.commonLib, line 617
// return true if the messages is processed here, and further processing in the main parse method should be cancelled ! // library marker kkossev.commonLib, line 619
// return false if the cluster is not a Tuya cluster // library marker kkossev.commonLib, line 620
private boolean isTuyaE00xCluster(String description) { // library marker kkossev.commonLib, line 621
if (description == null || !(description.indexOf('cluster: E000') >= 0 || description.indexOf('cluster: E001') >= 0)) { // library marker kkossev.commonLib, line 622
return false // library marker kkossev.commonLib, line 623
} // library marker kkossev.commonLib, line 624
// try to parse ... // library marker kkossev.commonLib, line 625
//logDebug "Tuya cluster: E000 or E001 - try to parse it..." // library marker kkossev.commonLib, line 626
Map descMap = [:] // library marker kkossev.commonLib, line 627
try { // library marker kkossev.commonLib, line 628
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 629
logDebug "TuyaE00xCluster Desc Map: ${descMap}" // library marker kkossev.commonLib, line 630
} // library marker kkossev.commonLib, line 631
catch (e) { // library marker kkossev.commonLib, line 632
logDebug "exception caught while parsing description: ${description}" // library marker kkossev.commonLib, line 633
logDebug "TuyaE00xCluster Desc Map: ${descMap}" // library marker kkossev.commonLib, line 634
// cluster E001 is the one that is generating exceptions... // library marker kkossev.commonLib, line 635
return true // library marker kkossev.commonLib, line 636
} // library marker kkossev.commonLib, line 637
if (descMap.cluster == 'E000' && descMap.attrId in ['D001', 'D002', 'D003']) { // library marker kkossev.commonLib, line 639
logDebug "Tuya Specific cluster ${descMap.cluster} attribute ${descMap.attrId} value is ${descMap.value}" // library marker kkossev.commonLib, line 640
} // library marker kkossev.commonLib, line 641
else if (descMap.cluster == 'E001' && descMap.attrId == 'D010') { // library marker kkossev.commonLib, line 642
if (settings?.logEnable) { logInfo "power on behavior is ${powerOnBehaviourOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } // library marker kkossev.commonLib, line 643
} // library marker kkossev.commonLib, line 644
else if (descMap.cluster == 'E001' && descMap.attrId == 'D030') { // library marker kkossev.commonLib, line 645
if (settings?.logEnable) { logInfo "swith type is ${switchTypeOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } // library marker kkossev.commonLib, line 646
} // library marker kkossev.commonLib, line 647
else { // library marker kkossev.commonLib, line 648
logDebug "unprocessed TuyaE00xCluster Desc Map: $descMap" // library marker kkossev.commonLib, line 649
return false // library marker kkossev.commonLib, line 650
} // library marker kkossev.commonLib, line 651
return true // processed // library marker kkossev.commonLib, line 652
} // library marker kkossev.commonLib, line 653
// return true if processed here, and further processing in the main parse method should be cancelled ! // library marker kkossev.commonLib, line 655
private boolean otherTuyaOddities(final String description) { // library marker kkossev.commonLib, line 656
/* // library marker kkossev.commonLib, line 657
if (description.indexOf('cluster: 0000') >= 0 && description.indexOf('attrId: 0004') >= 0) { // library marker kkossev.commonLib, line 658
if (logEnable) log.debug "${device.displayName} skipping Tuya parse of cluster 0 attrId 4" // parseDescriptionAsMap throws exception when processing Tuya cluster 0 attrId 4 // library marker kkossev.commonLib, line 659
return true // library marker kkossev.commonLib, line 660
} // library marker kkossev.commonLib, line 661
*/ // library marker kkossev.commonLib, line 662
Map descMap = [:] // library marker kkossev.commonLib, line 663
try { // library marker kkossev.commonLib, line 664
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 665
} // library marker kkossev.commonLib, line 666
catch (e1) { // library marker kkossev.commonLib, line 667
logWarn "exception ${e1} caught while parseDescriptionAsMap otherTuyaOddities description: ${description}" // library marker kkossev.commonLib, line 668
// try alternative custom parsing // library marker kkossev.commonLib, line 669
descMap = [:] // library marker kkossev.commonLib, line 670
try { // library marker kkossev.commonLib, line 671
descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> // library marker kkossev.commonLib, line 672
List pair = entry.split(':') // library marker kkossev.commonLib, line 673
[(pair.first().trim()): pair.last().trim()] // library marker kkossev.commonLib, line 674
} // library marker kkossev.commonLib, line 675
} // library marker kkossev.commonLib, line 676
catch (e2) { // library marker kkossev.commonLib, line 677
logWarn "exception ${e2} caught while parsing using an alternative method otherTuyaOddities description: ${description}" // library marker kkossev.commonLib, line 678
return true // library marker kkossev.commonLib, line 679
} // library marker kkossev.commonLib, line 680
logDebug "alternative method parsing success: descMap=${descMap}" // library marker kkossev.commonLib, line 681
} // library marker kkossev.commonLib, line 682
//if (logEnable) {log.trace "${device.displayName} Checking Tuya Oddities Desc Map: $descMap"} // library marker kkossev.commonLib, line 683
if (descMap.attrId == null) { // library marker kkossev.commonLib, line 684
//logDebug "otherTuyaOddities: descMap = ${descMap}" // library marker kkossev.commonLib, line 685
//if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${descMap.clusterId} NO ATTRIBUTE, skipping" // library marker kkossev.commonLib, line 686
return false // library marker kkossev.commonLib, line 687
} // library marker kkossev.commonLib, line 688
boolean bWasAtLeastOneAttributeProcessed = false // library marker kkossev.commonLib, line 689
boolean bWasThereAnyStandardAttribite = false // library marker kkossev.commonLib, line 690
// attribute report received // library marker kkossev.commonLib, line 691
List attrData = [[cluster: descMap.cluster ,attrId: descMap.attrId, value: descMap.value, status: descMap.status]] // library marker kkossev.commonLib, line 692
descMap.additionalAttrs.each { // library marker kkossev.commonLib, line 693
attrData << [cluster: descMap.cluster, attrId: it.attrId, value: it.value, status: it.status] // library marker kkossev.commonLib, line 694
} // library marker kkossev.commonLib, line 695
attrData.each { // library marker kkossev.commonLib, line 696
if (it.status == '86') { // library marker kkossev.commonLib, line 697
logWarn "Tuya Cluster ${descMap.cluster} unsupported attrId ${it.attrId}" // library marker kkossev.commonLib, line 698
// TODO - skip parsing? // library marker kkossev.commonLib, line 699
} // library marker kkossev.commonLib, line 700
switch (it.cluster) { // library marker kkossev.commonLib, line 701
case '0000' : // library marker kkossev.commonLib, line 702
if (it.attrId in ['FFE0', 'FFE1', 'FFE2', 'FFE4']) { // library marker kkossev.commonLib, line 703
logTrace "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" // library marker kkossev.commonLib, line 704
bWasAtLeastOneAttributeProcessed = true // library marker kkossev.commonLib, line 705
} // library marker kkossev.commonLib, line 706
else if (it.attrId in ['FFFE', 'FFDF']) { // library marker kkossev.commonLib, line 707
logTrace "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" // library marker kkossev.commonLib, line 708
bWasAtLeastOneAttributeProcessed = true // library marker kkossev.commonLib, line 709
} // library marker kkossev.commonLib, line 710
else { // library marker kkossev.commonLib, line 711
//logDebug "otherTuyaOddities? - Cluster ${descMap.cluster} attrId ${it.attrId} value ${it.value}) N/A, skipping" // library marker kkossev.commonLib, line 712
bWasThereAnyStandardAttribite = true // library marker kkossev.commonLib, line 713
} // library marker kkossev.commonLib, line 714
break // library marker kkossev.commonLib, line 715
default : // library marker kkossev.commonLib, line 716
//if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${it.cluster} N/A, skipping" // library marker kkossev.commonLib, line 717
break // library marker kkossev.commonLib, line 718
} // switch // library marker kkossev.commonLib, line 719
} // for each attribute // library marker kkossev.commonLib, line 720
return bWasAtLeastOneAttributeProcessed && !bWasThereAnyStandardAttribite // library marker kkossev.commonLib, line 721
} // library marker kkossev.commonLib, line 722
public String intTo16bitUnsignedHex(int value) { // library marker kkossev.commonLib, line 724
String hexStr = zigbee.convertToHexString(value.toInteger(), 4) // library marker kkossev.commonLib, line 725
return new String(hexStr.substring(2, 4) + hexStr.substring(0, 2)) // library marker kkossev.commonLib, line 726
} // library marker kkossev.commonLib, line 727
public String intTo8bitUnsignedHex(int value) { // library marker kkossev.commonLib, line 729
return zigbee.convertToHexString(value.toInteger(), 2) // library marker kkossev.commonLib, line 730
} // library marker kkossev.commonLib, line 731
/* // library marker kkossev.commonLib, line 733
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 734
* Tuya cluster EF00 specific code // library marker kkossev.commonLib, line 735
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 736
*/ // library marker kkossev.commonLib, line 737
private static int getCLUSTER_TUYA() { 0xEF00 } // library marker kkossev.commonLib, line 738
private static int getSETDATA() { 0x00 } // library marker kkossev.commonLib, line 739
private static int getSETTIME() { 0x24 } // library marker kkossev.commonLib, line 740
// Tuya Commands // library marker kkossev.commonLib, line 742
private static int getTUYA_REQUEST() { 0x00 } // library marker kkossev.commonLib, line 743
private static int getTUYA_REPORTING() { 0x01 } // library marker kkossev.commonLib, line 744
private static int getTUYA_QUERY() { 0x02 } // library marker kkossev.commonLib, line 745
private static int getTUYA_STATUS_SEARCH() { 0x06 } // library marker kkossev.commonLib, line 746
private static int getTUYA_TIME_SYNCHRONISATION() { 0x24 } // library marker kkossev.commonLib, line 747
// tuya DP type // library marker kkossev.commonLib, line 749
private static String getDP_TYPE_RAW() { '01' } // [ bytes ] // library marker kkossev.commonLib, line 750
private static String getDP_TYPE_BOOL() { '01' } // [ 0/1 ] // library marker kkossev.commonLib, line 751
private static String getDP_TYPE_VALUE() { '02' } // [ 4 byte value ] // library marker kkossev.commonLib, line 752
private static String getDP_TYPE_STRING() { '03' } // [ N byte string ] // library marker kkossev.commonLib, line 753
private static String getDP_TYPE_ENUM() { '04' } // [ 0-255 ] // library marker kkossev.commonLib, line 754
private static String getDP_TYPE_BITMAP() { '05' } // [ 1,2,4 bytes ] as bits // library marker kkossev.commonLib, line 755
private void syncTuyaDateTime() { // library marker kkossev.commonLib, line 757
// The data format for time synchronization, including standard timestamps and local timestamps. Standard timestamp (4 bytes) local timestamp (4 bytes) Time synchronization data format: The standard timestamp is the total number of seconds from 00:00:00 on January 01, 1970 GMT to the present. // library marker kkossev.commonLib, line 758
// For example, local timestamp = standard timestamp + number of seconds between standard time and local time (including time zone and daylight saving time). // Y2K = 946684800 // library marker kkossev.commonLib, line 759
long offset = 0 // library marker kkossev.commonLib, line 760
int offsetHours = 0 // library marker kkossev.commonLib, line 761
Calendar cal = Calendar.getInstance() //it return same time as new Date() // library marker kkossev.commonLib, line 762
int hour = cal.get(Calendar.HOUR_OF_DAY) // library marker kkossev.commonLib, line 763
try { // library marker kkossev.commonLib, line 764
offset = location.getTimeZone().getOffset(new Date().getTime()) // library marker kkossev.commonLib, line 765
offsetHours = (offset / 3600000) as int // library marker kkossev.commonLib, line 766
logDebug "timezone offset of current location is ${offset} (${offsetHours} hours), current hour is ${hour} h" // library marker kkossev.commonLib, line 767
} catch (e) { // library marker kkossev.commonLib, line 768
log.error "${device.displayName} cannot resolve current location. please set location in Hubitat location setting. Setting timezone offset to zero" // library marker kkossev.commonLib, line 769
} // library marker kkossev.commonLib, line 770
// // library marker kkossev.commonLib, line 771
List cmds = zigbee.command(CLUSTER_TUYA, SETTIME, '0008' + zigbee.convertToHexString((int)(now() / 1000), 8) + zigbee.convertToHexString((int)((now() + offset) / 1000), 8)) // library marker kkossev.commonLib, line 772
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 773
logDebug "Tuya device time synchronized to ${unix2formattedDate(now())} (${cmds})" // library marker kkossev.commonLib, line 774
} // library marker kkossev.commonLib, line 775
// called from the main parse method when the cluster is 0xEF00 and no custom handler is defined // library marker kkossev.commonLib, line 777
public void standardParseTuyaCluster(final Map descMap) { // library marker kkossev.commonLib, line 778
if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == '24') { //getSETTIME // library marker kkossev.commonLib, line 779
syncTuyaDateTime() // library marker kkossev.commonLib, line 780
} // library marker kkossev.commonLib, line 781
else if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == '0B') { // ZCL Command Default Response // library marker kkossev.commonLib, line 782
String clusterCmd = descMap?.data[0] // library marker kkossev.commonLib, line 783
String status = descMap?.data[1] // library marker kkossev.commonLib, line 784
logDebug "device has received Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data}" // library marker kkossev.commonLib, line 785
if (status != '00') { // library marker kkossev.commonLib, line 786
logWarn "ATTENTION! manufacturer = ${device.getDataValue('manufacturer')} unsupported Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data} !!!" // library marker kkossev.commonLib, line 787
} // library marker kkossev.commonLib, line 788
} // library marker kkossev.commonLib, line 789
else if ((descMap?.clusterInt == CLUSTER_TUYA) && (descMap?.command == '01' || descMap?.command == '02' || descMap?.command == '05' || descMap?.command == '06')) { // library marker kkossev.commonLib, line 790
int dataLen = descMap?.data.size() // library marker kkossev.commonLib, line 791
//log.warn "dataLen=${dataLen}" // library marker kkossev.commonLib, line 792
//def transid = zigbee.convertHexToInt(descMap?.data[1]) // "transid" is just a "counter", a response will have the same transid as the command // library marker kkossev.commonLib, line 793
if (dataLen <= 5) { // library marker kkossev.commonLib, line 794
logWarn "unprocessed short Tuya command response: dp_id=${descMap?.data[3]} dp=${descMap?.data[2]} fncmd_len=${fncmd_len} data=${descMap?.data})" // library marker kkossev.commonLib, line 795
return // library marker kkossev.commonLib, line 796
} // library marker kkossev.commonLib, line 797
boolean isSpammyDeviceProfileDefined = this.respondsTo('isSpammyDeviceProfile') // check if the method exists 05/21/2024 // library marker kkossev.commonLib, line 798
for (int i = 0; i < (dataLen - 4); ) { // library marker kkossev.commonLib, line 799
int dp = zigbee.convertHexToInt(descMap?.data[2 + i]) // "dp" field describes the action/message of a command frame // library marker kkossev.commonLib, line 800
int dp_id = zigbee.convertHexToInt(descMap?.data[3 + i]) // "dp_identifier" is device dependant // library marker kkossev.commonLib, line 801
int fncmd_len = zigbee.convertHexToInt(descMap?.data[5 + i]) // library marker kkossev.commonLib, line 802
int fncmd = getTuyaAttributeValue(descMap?.data, i) // // library marker kkossev.commonLib, line 803
if (!isChattyDeviceReport(descMap) && isSpammyDeviceProfileDefined && !isSpammyDeviceProfile()) { // library marker kkossev.commonLib, line 804
logDebug "standardParseTuyaCluster: command=${descMap?.command} dp_id=${dp_id} dp=${dp} (0x${descMap?.data[2 + i]}) fncmd=${fncmd} fncmd_len=${fncmd_len} (index=${i})" // library marker kkossev.commonLib, line 805
} // library marker kkossev.commonLib, line 806
standardProcessTuyaDP(descMap, dp, dp_id, fncmd) // library marker kkossev.commonLib, line 807
i = i + fncmd_len + 4 // library marker kkossev.commonLib, line 808
} // library marker kkossev.commonLib, line 809
} // library marker kkossev.commonLib, line 810
else { // library marker kkossev.commonLib, line 811
logWarn "standardParseTuyaCluster: unprocessed Tuya cluster command ${descMap?.command} data=${descMap?.data}" // library marker kkossev.commonLib, line 812
} // library marker kkossev.commonLib, line 813
} // library marker kkossev.commonLib, line 814
// called from the standardParseTuyaCluster method for each DP chunk in the messages (usually one, but could be multiple DPs in one message) // library marker kkossev.commonLib, line 816
void standardProcessTuyaDP(final Map descMap, final int dp, final int dp_id, final int fncmd, final int dp_len=0) { // library marker kkossev.commonLib, line 817
logTrace "standardProcessTuyaDP: checking customProcessTuyaDp dp=${dp} dp_id=${dp_id} fncmd=${fncmd} dp_len=${dp_len}" // library marker kkossev.commonLib, line 818
if (this.respondsTo('customProcessTuyaDp')) { // library marker kkossev.commonLib, line 819
//logTrace 'standardProcessTuyaDP: customProcessTuyaDp exists, calling it...' // library marker kkossev.commonLib, line 820
if (customProcessTuyaDp(descMap, dp, dp_id, fncmd, dp_len) == true) { // library marker kkossev.commonLib, line 821
return // EF00 DP has been processed in the custom handler - we are done! // library marker kkossev.commonLib, line 822
} // library marker kkossev.commonLib, line 823
} // library marker kkossev.commonLib, line 824
// check if DeviceProfile processing method exists (deviceProfieLib should be included in the main driver) // library marker kkossev.commonLib, line 825
if (this.respondsTo(processTuyaDPfromDeviceProfile)) { // library marker kkossev.commonLib, line 826
//logTrace 'standardProcessTuyaDP: processTuyaDPfromDeviceProfile exists, calling it...' // library marker kkossev.commonLib, line 827
if (this.respondsTo('isInCooldown') && isInCooldown()) { // library marker kkossev.commonLib, line 828
logDebug "standardProcessTuyaDP: device is in cooldown, skipping processing of dp=${dp} dp_id=${dp_id} fncmd=${fncmd} dp_len=${dp_len}" // library marker kkossev.commonLib, line 829
return // library marker kkossev.commonLib, line 830
} // library marker kkossev.commonLib, line 831
if (this.respondsTo('ensureCurrentProfileLoaded')) { // library marker kkossev.commonLib, line 832
ensureCurrentProfileLoaded() // library marker kkossev.commonLib, line 833
} // library marker kkossev.commonLib, line 834
if (processTuyaDPfromDeviceProfile(descMap, dp, dp_id, fncmd, dp_len) == true) { // library marker kkossev.commonLib, line 835
return // sucessfuly processed the new way - we are done. (version 3.0) // library marker kkossev.commonLib, line 836
} // library marker kkossev.commonLib, line 837
} // library marker kkossev.commonLib, line 838
logWarn "NOT PROCESSED Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" // library marker kkossev.commonLib, line 839
} // library marker kkossev.commonLib, line 840
public int getTuyaAttributeValue(final List _data, final int index) { // library marker kkossev.commonLib, line 842
int retValue = 0 // library marker kkossev.commonLib, line 843
if (_data.size() >= 6) { // library marker kkossev.commonLib, line 844
int dataLength = zigbee.convertHexToInt(_data[5 + index]) // library marker kkossev.commonLib, line 845
if (dataLength == 0) { return 0 } // library marker kkossev.commonLib, line 846
int power = 1 // library marker kkossev.commonLib, line 847
for (i in dataLength..1) { // library marker kkossev.commonLib, line 848
retValue = retValue + power * zigbee.convertHexToInt(_data[index + i + 5]) // library marker kkossev.commonLib, line 849
power = power * 256 // library marker kkossev.commonLib, line 850
} // library marker kkossev.commonLib, line 851
} // library marker kkossev.commonLib, line 852
return retValue // library marker kkossev.commonLib, line 853
} // library marker kkossev.commonLib, line 854
public List getTuyaCommand(String dp, String dp_type, String fncmd, int tuyaCmdDefault = SETDATA) { return sendTuyaCommand(dp, dp_type, fncmd, tuyaCmdDefault) } // library marker kkossev.commonLib, line 856
public List sendTuyaCommand(String dp, String dp_type, String fncmd, int tuyaCmdDefault = SETDATA) { // library marker kkossev.commonLib, line 858
List cmds = [] // library marker kkossev.commonLib, line 859
int ep = safeToInt(state.destinationEP) // library marker kkossev.commonLib, line 860
if (ep == null || ep == 0) { ep = 1 } // library marker kkossev.commonLib, line 861
int tuyaCmd // library marker kkossev.commonLib, line 862
// added 07/01/2024 - deviceProfilesV3 device key tuyaCmd:04 : owerwrite all sendTuyaCommand calls for a specfic device profile, if specified! // library marker kkossev.commonLib, line 863
if (this.respondsTo('getDEVICE') && getDEVICE()?.device?.tuyaCmd != null) { // library marker kkossev.commonLib, line 864
tuyaCmd = getDEVICE().device.tuyaCmd // library marker kkossev.commonLib, line 865
} // library marker kkossev.commonLib, line 866
else { // library marker kkossev.commonLib, line 867
tuyaCmd = tuyaCmdDefault // 0x00 is the default command for most of the Tuya devices, except some .. // library marker kkossev.commonLib, line 868
} // library marker kkossev.commonLib, line 869
// Get delay from device profile or use default // library marker kkossev.commonLib, line 870
int tuyaDelay = DEVICE?.device?.tuyaDelay as Integer ?: 201 // library marker kkossev.commonLib, line 871
cmds = zigbee.command(CLUSTER_TUYA, tuyaCmd, [destEndpoint :ep], delay = tuyaDelay, PACKET_ID + dp + dp_type + zigbee.convertToHexString((int)(fncmd.length() / 2), 4) + fncmd ) // library marker kkossev.commonLib, line 872
logDebug "${device.displayName} getTuyaCommand (dp=$dp fncmd=$fncmd dp_type=$dp_type) = ${cmds}" // library marker kkossev.commonLib, line 873
return cmds // library marker kkossev.commonLib, line 874
} // library marker kkossev.commonLib, line 875
private String getPACKET_ID() { return zigbee.convertToHexString(new Random().nextInt(65536), 4) } // library marker kkossev.commonLib, line 877
public void tuyaTest(String dpCommand, String dpValue, String dpTypeString ) { // library marker kkossev.commonLib, line 879
String dpType = dpTypeString == 'DP_TYPE_VALUE' ? DP_TYPE_VALUE : dpTypeString == 'DP_TYPE_BOOL' ? DP_TYPE_BOOL : dpTypeString == 'DP_TYPE_ENUM' ? DP_TYPE_ENUM : null // library marker kkossev.commonLib, line 880
String dpValHex = dpTypeString == 'DP_TYPE_VALUE' ? zigbee.convertToHexString(dpValue as int, 8) : dpValue // library marker kkossev.commonLib, line 881
if (settings?.logEnable) { log.warn "${device.displayName} sending TEST command=${dpCommand} value=${dpValue} ($dpValHex) type=${dpType}" } // library marker kkossev.commonLib, line 882
sendZigbeeCommands( sendTuyaCommand(dpCommand, dpType, dpValHex) ) // library marker kkossev.commonLib, line 883
} // library marker kkossev.commonLib, line 884
public List tuyaBlackMagic() { // library marker kkossev.commonLib, line 887
int ep = safeToInt(state.destinationEP ?: 01) // library marker kkossev.commonLib, line 888
if (ep == null || ep == 0) { ep = 1 } // library marker kkossev.commonLib, line 889
logInfo 'tuyaBlackMagic()...' // library marker kkossev.commonLib, line 890
return zigbee.readAttribute(0x0000, [0x0004, 0x000, 0x0001, 0x0005, 0x0007, 0xfffe], [destEndpoint :ep], delay = 200) // library marker kkossev.commonLib, line 891
} // library marker kkossev.commonLib, line 892
public List queryAllTuyaDP() { // library marker kkossev.commonLib, line 894
logTrace 'queryAllTuyaDP()' // library marker kkossev.commonLib, line 895
List cmds = zigbee.command(0xEF00, 0x03) // library marker kkossev.commonLib, line 896
return cmds // library marker kkossev.commonLib, line 897
} // library marker kkossev.commonLib, line 898
public void aqaraBlackMagic() { // library marker kkossev.commonLib, line 900
List cmds = [] // library marker kkossev.commonLib, line 901
if (this.respondsTo('customAqaraBlackMagic')) { // library marker kkossev.commonLib, line 902
cmds = customAqaraBlackMagic() // library marker kkossev.commonLib, line 903
} // library marker kkossev.commonLib, line 904
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 905
logDebug 'sending aqaraBlackMagic()' // library marker kkossev.commonLib, line 906
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 907
return // library marker kkossev.commonLib, line 908
} // library marker kkossev.commonLib, line 909
logDebug 'aqaraBlackMagic() was SKIPPED' // library marker kkossev.commonLib, line 910
} // library marker kkossev.commonLib, line 911
// Invoked from configure() // library marker kkossev.commonLib, line 913
public List initializeDevice() { // library marker kkossev.commonLib, line 914
List cmds = [] // library marker kkossev.commonLib, line 915
logInfo 'initializeDevice...' // library marker kkossev.commonLib, line 916
if (this.respondsTo('customInitializeDevice')) { // library marker kkossev.commonLib, line 917
List customCmds = customInitializeDevice() // library marker kkossev.commonLib, line 918
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 919
} // library marker kkossev.commonLib, line 920
else { logDebug 'no customInitializeDevice method defined' } // library marker kkossev.commonLib, line 921
logDebug "initializeDevice(): cmds=${cmds}" // library marker kkossev.commonLib, line 922
return cmds // library marker kkossev.commonLib, line 923
} // library marker kkossev.commonLib, line 924
// Invoked from configure() // library marker kkossev.commonLib, line 926
public List configureDevice() { // library marker kkossev.commonLib, line 927
List cmds = [] // library marker kkossev.commonLib, line 928
logInfo 'configureDevice...' // library marker kkossev.commonLib, line 929
if (this.respondsTo('customConfigureDevice')) { // library marker kkossev.commonLib, line 930
List customCmds = customConfigureDevice() // library marker kkossev.commonLib, line 931
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 932
} // library marker kkossev.commonLib, line 933
else { logDebug 'no customConfigureDevice method defined' } // library marker kkossev.commonLib, line 934
// sendZigbeeCommands(cmds) changed 03/04/2024 // library marker kkossev.commonLib, line 935
logDebug "configureDevice(): cmds=${cmds}" // library marker kkossev.commonLib, line 936
return cmds // library marker kkossev.commonLib, line 937
} // library marker kkossev.commonLib, line 938
/* // library marker kkossev.commonLib, line 940
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 941
* Hubitat default handlers methods // library marker kkossev.commonLib, line 942
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 943
*/ // library marker kkossev.commonLib, line 944
List customHandlers(final List customHandlersList) { // library marker kkossev.commonLib, line 946
List cmds = [] // library marker kkossev.commonLib, line 947
if (customHandlersList != null && !customHandlersList.isEmpty()) { // library marker kkossev.commonLib, line 948
customHandlersList.each { handler -> // library marker kkossev.commonLib, line 949
if (this.respondsTo(handler)) { // library marker kkossev.commonLib, line 950
List customCmds = this."${handler}"() // library marker kkossev.commonLib, line 951
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 952
} // library marker kkossev.commonLib, line 953
} // library marker kkossev.commonLib, line 954
} // library marker kkossev.commonLib, line 955
return cmds // library marker kkossev.commonLib, line 956
} // library marker kkossev.commonLib, line 957
public void refresh() { // library marker kkossev.commonLib, line 959
logDebug "refresh()... DEVICE_TYPE is ${DEVICE_TYPE} model=${device.getDataValue('model')} manufacturer=${device.getDataValue('manufacturer')}" // library marker kkossev.commonLib, line 960
checkDriverVersion(state) // library marker kkossev.commonLib, line 961
List cmds = [], customCmds = [] // library marker kkossev.commonLib, line 962
if (this.respondsTo('customRefresh')) { // if there is a customRefresh() method defined in the main driver, call it // library marker kkossev.commonLib, line 963
customCmds = customRefresh() // library marker kkossev.commonLib, line 964
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } else { logDebug 'no customRefresh method defined' } // library marker kkossev.commonLib, line 965
} // library marker kkossev.commonLib, line 966
else { // call all known libraryRefresh methods // library marker kkossev.commonLib, line 967
customCmds = customHandlers(['onOffRefresh', 'groupsRefresh', 'batteryRefresh', 'levelRefresh', 'temperatureRefresh', 'humidityRefresh', 'illuminanceRefresh']) // library marker kkossev.commonLib, line 968
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } else { logDebug 'no libraries refresh() defined' } // library marker kkossev.commonLib, line 969
} // library marker kkossev.commonLib, line 970
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 971
logDebug "refresh() cmds=${cmds}" // library marker kkossev.commonLib, line 972
setRefreshRequest() // 3 seconds // library marker kkossev.commonLib, line 973
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 974
} // library marker kkossev.commonLib, line 975
else { // library marker kkossev.commonLib, line 976
logDebug "no refresh() commands defined for device type ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 977
} // library marker kkossev.commonLib, line 978
} // library marker kkossev.commonLib, line 979
public void setRefreshRequest() { if (state.states == null) { state.states = [:] } ; state.states['isRefresh'] = true; runInMillis(REFRESH_TIMER, 'clearRefreshRequest', [overwrite: true]) } // library marker kkossev.commonLib, line 981
public void clearRefreshRequest() { if (state.states == null) { state.states = [:] } ; state.states['isRefresh'] = false } // library marker kkossev.commonLib, line 982
public void clearInfoEvent() { sendInfoEvent('clear') } // library marker kkossev.commonLib, line 983
public void sendInfoEvent(String info=null) { // library marker kkossev.commonLib, line 985
if (info == null || info == 'clear') { // library marker kkossev.commonLib, line 986
logDebug 'clearing the Status event' // library marker kkossev.commonLib, line 987
sendEvent(name: '_status_', value: 'clear', type: 'digital') // library marker kkossev.commonLib, line 988
} // library marker kkossev.commonLib, line 989
else { // library marker kkossev.commonLib, line 990
logInfo "${info}" // library marker kkossev.commonLib, line 991
sendEvent(name: '_status_', value: info, type: 'digital') // library marker kkossev.commonLib, line 992
runIn(INFO_AUTO_CLEAR_PERIOD, 'clearInfoEvent') // automatically clear the Info attribute after 1 minute // library marker kkossev.commonLib, line 993
} // library marker kkossev.commonLib, line 994
} // library marker kkossev.commonLib, line 995
public void ping() { // library marker kkossev.commonLib, line 997
if (state.lastTx == null ) { state.lastTx = [:] } ; state.lastTx['pingTime'] = new Date().getTime() // library marker kkossev.commonLib, line 998
if (state.states == null ) { state.states = [:] } ; state.states['isPing'] = true // library marker kkossev.commonLib, line 999
scheduleCommandTimeoutCheck() // library marker kkossev.commonLib, line 1000
int pingAttr = (device.getDataValue('manufacturer') == 'SONOFF') ? 0x05 : PING_ATTR_ID // library marker kkossev.commonLib, line 1001
if (isVirtual()) { runInMillis(10, 'virtualPong') } // library marker kkossev.commonLib, line 1002
else if (device.getDataValue('manufacturer') == 'Aqara') { // library marker kkossev.commonLib, line 1003
logDebug 'Aqara device ping...' // library marker kkossev.commonLib, line 1004
sendZigbeeCommands(zigbee.readAttribute(zigbee.BASIC_CLUSTER, pingAttr, [destEndpoint: 0x01], 0) ) // library marker kkossev.commonLib, line 1005
} // library marker kkossev.commonLib, line 1006
else { sendZigbeeCommands(zigbee.readAttribute(zigbee.BASIC_CLUSTER, pingAttr, [:], 0) ) } // library marker kkossev.commonLib, line 1007
logDebug 'ping...' // library marker kkossev.commonLib, line 1008
} // library marker kkossev.commonLib, line 1009
private void virtualPong() { // library marker kkossev.commonLib, line 1011
logDebug 'virtualPing: pong!' // library marker kkossev.commonLib, line 1012
Long now = new Date().getTime() // library marker kkossev.commonLib, line 1013
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: '0').toInteger() // library marker kkossev.commonLib, line 1014
if (timeRunning > 0 && timeRunning < MAX_PING_MILISECONDS) { // library marker kkossev.commonLib, line 1015
state.stats['pingsOK'] = (state.stats['pingsOK'] ?: 0) + 1 // library marker kkossev.commonLib, line 1016
if (timeRunning < safeToInt((state.stats['pingsMin'] ?: '9999'))) { state.stats['pingsMin'] = timeRunning } // library marker kkossev.commonLib, line 1017
if (timeRunning > safeToInt((state.stats['pingsMax'] ?: '0'))) { state.stats['pingsMax'] = timeRunning } // library marker kkossev.commonLib, line 1018
state.stats['pingsAvg'] = approxRollingAverage(safeToDouble(state.stats['pingsAvg']), safeToDouble(timeRunning)) as int // library marker kkossev.commonLib, line 1019
sendRttEvent() // library marker kkossev.commonLib, line 1020
} // library marker kkossev.commonLib, line 1021
else { // library marker kkossev.commonLib, line 1022
logWarn "unexpected ping timeRunning=${timeRunning} " // library marker kkossev.commonLib, line 1023
} // library marker kkossev.commonLib, line 1024
state.states['isPing'] = false // library marker kkossev.commonLib, line 1025
unscheduleCommandTimeoutCheck(state) // library marker kkossev.commonLib, line 1026
} // library marker kkossev.commonLib, line 1027
public void sendRttEvent( String value=null) { // library marker kkossev.commonLib, line 1029
Long now = new Date().getTime() // library marker kkossev.commonLib, line 1030
if (state.lastTx == null ) { state.lastTx = [:] } // library marker kkossev.commonLib, line 1031
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: now).toInteger() // library marker kkossev.commonLib, line 1032
String descriptionText = "Round-trip time is ${timeRunning} ms (min=${state.stats['pingsMin']} max=${state.stats['pingsMax']} average=${state.stats['pingsAvg']})" // library marker kkossev.commonLib, line 1033
if (value == null) { // library marker kkossev.commonLib, line 1034
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1035
sendEvent(name: 'rtt', value: timeRunning, descriptionText: descriptionText, unit: 'ms', type: 'physical') // library marker kkossev.commonLib, line 1036
} // library marker kkossev.commonLib, line 1037
else { // library marker kkossev.commonLib, line 1038
descriptionText = "Round-trip time : ${value}" // library marker kkossev.commonLib, line 1039
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1040
sendEvent(name: 'rtt', value: value, descriptionText: descriptionText, type: 'physical') // library marker kkossev.commonLib, line 1041
} // library marker kkossev.commonLib, line 1042
} // library marker kkossev.commonLib, line 1043
private String clusterLookup(final Object cluster) { // library marker kkossev.commonLib, line 1045
if (cluster != null) { // library marker kkossev.commonLib, line 1046
return zigbee.clusterLookup(cluster.toInteger()) ?: "private cluster 0x${intToHexStr(cluster.toInteger())}" // library marker kkossev.commonLib, line 1047
} // library marker kkossev.commonLib, line 1048
logWarn 'cluster is NULL!' // library marker kkossev.commonLib, line 1049
return 'NULL' // library marker kkossev.commonLib, line 1050
} // library marker kkossev.commonLib, line 1051
private void scheduleCommandTimeoutCheck(int delay = COMMAND_TIMEOUT) { // library marker kkossev.commonLib, line 1053
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1054
state.states['isTimeoutCheck'] = true // library marker kkossev.commonLib, line 1055
runIn(delay, 'deviceCommandTimeout') // library marker kkossev.commonLib, line 1056
} // library marker kkossev.commonLib, line 1057
// unschedule() is a very time consuming operation : ~ 5 milliseconds per call ! // library marker kkossev.commonLib, line 1059
void unscheduleCommandTimeoutCheck(final Map state) { // can not be static :( // library marker kkossev.commonLib, line 1060
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1061
if (state.states['isTimeoutCheck'] == true) { // library marker kkossev.commonLib, line 1062
state.states['isTimeoutCheck'] = false // library marker kkossev.commonLib, line 1063
unschedule('deviceCommandTimeout') // library marker kkossev.commonLib, line 1064
} // library marker kkossev.commonLib, line 1065
} // library marker kkossev.commonLib, line 1066
void deviceCommandTimeout() { // library marker kkossev.commonLib, line 1068
logWarn 'no response received (sleepy device or offline?)' // library marker kkossev.commonLib, line 1069
sendRttEvent('timeout') // library marker kkossev.commonLib, line 1070
state.stats['pingsFail'] = (state.stats['pingsFail'] ?: 0) + 1 // library marker kkossev.commonLib, line 1071
if (state.health?.isHealthCheck == true) { // library marker kkossev.commonLib, line 1072
logWarn 'device health check failed!' // library marker kkossev.commonLib, line 1073
state.health?.checkCtr3 = (state.health?.checkCtr3 ?: 0 ) + 1 // library marker kkossev.commonLib, line 1074
if (state.health?.checkCtr3 >= PRESENCE_COUNT_THRESHOLD) { // library marker kkossev.commonLib, line 1075
if ((device.currentValue('healthStatus') ?: 'unknown') != 'offline' ) { // library marker kkossev.commonLib, line 1076
sendHealthStatusEvent('offline') // library marker kkossev.commonLib, line 1077
} // library marker kkossev.commonLib, line 1078
} // library marker kkossev.commonLib, line 1079
state.health['isHealthCheck'] = false // library marker kkossev.commonLib, line 1080
} // library marker kkossev.commonLib, line 1081
} // library marker kkossev.commonLib, line 1082
private void scheduleDeviceHealthCheck(final int intervalMins, final int healthMethod) { // library marker kkossev.commonLib, line 1084
if (healthMethod == 1 || healthMethod == 2) { // library marker kkossev.commonLib, line 1085
String cron = getCron( intervalMins * 60 ) // library marker kkossev.commonLib, line 1086
schedule(cron, 'deviceHealthCheck') // library marker kkossev.commonLib, line 1087
logDebug "deviceHealthCheck is scheduled every ${intervalMins} minutes" // library marker kkossev.commonLib, line 1088
} // library marker kkossev.commonLib, line 1089
else { // library marker kkossev.commonLib, line 1090
logWarn 'deviceHealthCheck is not scheduled!' // library marker kkossev.commonLib, line 1091
unschedule('deviceHealthCheck') // library marker kkossev.commonLib, line 1092
} // library marker kkossev.commonLib, line 1093
} // library marker kkossev.commonLib, line 1094
private void unScheduleDeviceHealthCheck() { // library marker kkossev.commonLib, line 1096
unschedule('deviceHealthCheck') // library marker kkossev.commonLib, line 1097
device.deleteCurrentState('healthStatus') // library marker kkossev.commonLib, line 1098
logWarn 'device health check is disabled!' // library marker kkossev.commonLib, line 1099
} // library marker kkossev.commonLib, line 1100
// called when any event was received from the Zigbee device in the parse() method. // library marker kkossev.commonLib, line 1102
private void setHealthStatusOnline(Map state) { // library marker kkossev.commonLib, line 1103
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1104
state.health['checkCtr3'] = 0 // library marker kkossev.commonLib, line 1105
if (!((device.currentValue('healthStatus') ?: 'unknown') in ['online'])) { // library marker kkossev.commonLib, line 1106
sendHealthStatusEvent('online') // library marker kkossev.commonLib, line 1107
logInfo 'is now online!' // library marker kkossev.commonLib, line 1108
} // library marker kkossev.commonLib, line 1109
} // library marker kkossev.commonLib, line 1110
private void deviceHealthCheck() { // library marker kkossev.commonLib, line 1112
checkDriverVersion(state) // library marker kkossev.commonLib, line 1113
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1114
int ctr = state.health['checkCtr3'] ?: 0 // library marker kkossev.commonLib, line 1115
if (ctr >= PRESENCE_COUNT_THRESHOLD) { // library marker kkossev.commonLib, line 1116
if ((device.currentValue('healthStatus') ?: 'unknown') != 'offline' ) { // library marker kkossev.commonLib, line 1117
logWarn 'not present!' // library marker kkossev.commonLib, line 1118
sendHealthStatusEvent('offline') // library marker kkossev.commonLib, line 1119
} // library marker kkossev.commonLib, line 1120
} // library marker kkossev.commonLib, line 1121
else { // library marker kkossev.commonLib, line 1122
logDebug "deviceHealthCheck - online (notPresentCounter=${(ctr + 1)})" // library marker kkossev.commonLib, line 1123
} // library marker kkossev.commonLib, line 1124
state.health['checkCtr3'] = ctr + 1 // library marker kkossev.commonLib, line 1125
// added 03/06/2025 // library marker kkossev.commonLib, line 1126
if (settings?.healthCheckMethod as int == 2) { // library marker kkossev.commonLib, line 1127
state.health['isHealthCheck'] = true // library marker kkossev.commonLib, line 1128
ping() // proactively ping the device... // library marker kkossev.commonLib, line 1129
} // library marker kkossev.commonLib, line 1130
} // library marker kkossev.commonLib, line 1131
private void sendHealthStatusEvent(final String value) { // library marker kkossev.commonLib, line 1133
String descriptionText = "healthStatus changed to ${value}" // library marker kkossev.commonLib, line 1134
sendEvent(name: 'healthStatus', value: value, descriptionText: descriptionText, isStateChange: true, type: 'digital') // library marker kkossev.commonLib, line 1135
if (value == 'online') { // library marker kkossev.commonLib, line 1136
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1137
} // library marker kkossev.commonLib, line 1138
else { // library marker kkossev.commonLib, line 1139
if (settings?.txtEnable) { log.warn "${device.displayName}} ${descriptionText}" } // library marker kkossev.commonLib, line 1140
} // library marker kkossev.commonLib, line 1141
} // library marker kkossev.commonLib, line 1142
// Invoked by Hubitat when the driver configuration is updated // library marker kkossev.commonLib, line 1144
void updated() { // library marker kkossev.commonLib, line 1145
logInfo 'updated()...' // library marker kkossev.commonLib, line 1146
checkDriverVersion(state) // library marker kkossev.commonLib, line 1147
logInfo"driver version ${driverVersionAndTimeStamp()}" // library marker kkossev.commonLib, line 1148
unschedule() // library marker kkossev.commonLib, line 1149
if (settings.logEnable) { // library marker kkossev.commonLib, line 1151
logTrace(settings.toString()) // library marker kkossev.commonLib, line 1152
runIn(86400, 'logsOff') // library marker kkossev.commonLib, line 1153
} // library marker kkossev.commonLib, line 1154
if (settings.traceEnable) { // library marker kkossev.commonLib, line 1155
logTrace(settings.toString()) // library marker kkossev.commonLib, line 1156
runIn(1800, 'traceOff') // library marker kkossev.commonLib, line 1157
} // library marker kkossev.commonLib, line 1158
final int healthMethod = (settings.healthCheckMethod as Integer) ?: 0 // library marker kkossev.commonLib, line 1160
if (healthMethod == 1 || healthMethod == 2) { // [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] // library marker kkossev.commonLib, line 1161
// schedule the periodic timer // library marker kkossev.commonLib, line 1162
final int interval = (settings.healthCheckInterval as Integer) ?: 0 // library marker kkossev.commonLib, line 1163
if (interval > 0) { // library marker kkossev.commonLib, line 1164
//log.trace "healthMethod=${healthMethod} interval=${interval}" // library marker kkossev.commonLib, line 1165
log.info "scheduling health check every ${interval} minutes by ${HealthcheckMethodOpts.options[healthCheckMethod as int]} method" // library marker kkossev.commonLib, line 1166
scheduleDeviceHealthCheck(interval, healthMethod) // library marker kkossev.commonLib, line 1167
} // library marker kkossev.commonLib, line 1168
} // library marker kkossev.commonLib, line 1169
else { // library marker kkossev.commonLib, line 1170
unScheduleDeviceHealthCheck() // unschedule the periodic job, depending on the healthMethod // library marker kkossev.commonLib, line 1171
log.info 'Health Check is disabled!' // library marker kkossev.commonLib, line 1172
} // library marker kkossev.commonLib, line 1173
if (this.respondsTo('customUpdated')) { // library marker kkossev.commonLib, line 1174
customUpdated() // library marker kkossev.commonLib, line 1175
} // library marker kkossev.commonLib, line 1176
sendInfoEvent('updated') // library marker kkossev.commonLib, line 1178
} // library marker kkossev.commonLib, line 1179
private void logsOff() { // library marker kkossev.commonLib, line 1181
logInfo 'debug logging disabled...' // library marker kkossev.commonLib, line 1182
device.updateSetting('logEnable', [value: 'false', type: 'bool']) // library marker kkossev.commonLib, line 1183
} // library marker kkossev.commonLib, line 1184
private void traceOff() { // library marker kkossev.commonLib, line 1185
logInfo 'trace logging disabled...' // library marker kkossev.commonLib, line 1186
device.updateSetting('traceEnable', [value: 'false', type: 'bool']) // library marker kkossev.commonLib, line 1187
} // library marker kkossev.commonLib, line 1188
public void configure(String command) { // library marker kkossev.commonLib, line 1190
logInfo "configure(${command})..." // library marker kkossev.commonLib, line 1191
if (!(command in (ConfigureOpts.keySet() as List))) { // library marker kkossev.commonLib, line 1192
logWarn "configure: command ${command} must be one of these : ${ConfigureOpts.keySet() as List}" // library marker kkossev.commonLib, line 1193
return // library marker kkossev.commonLib, line 1194
} // library marker kkossev.commonLib, line 1195
// // library marker kkossev.commonLib, line 1196
String func // library marker kkossev.commonLib, line 1197
try { // library marker kkossev.commonLib, line 1198
func = ConfigureOpts[command]?.function // library marker kkossev.commonLib, line 1199
"$func"() // library marker kkossev.commonLib, line 1200
} // library marker kkossev.commonLib, line 1201
catch (e) { // library marker kkossev.commonLib, line 1202
logWarn "Exception ${e} caught while processing $func($value)" // library marker kkossev.commonLib, line 1203
return // library marker kkossev.commonLib, line 1204
} // library marker kkossev.commonLib, line 1205
logInfo "executed '${func}'" // library marker kkossev.commonLib, line 1206
} // library marker kkossev.commonLib, line 1207
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.commonLib, line 1209
void configureHelp(final String val) { // library marker kkossev.commonLib, line 1210
if (settings?.txtEnable) { log.warn "${device.displayName} configureHelp: select one of the commands in this list!" } // library marker kkossev.commonLib, line 1211
} // library marker kkossev.commonLib, line 1212
public void loadAllDefaults() { // library marker kkossev.commonLib, line 1214
logDebug 'loadAllDefaults() !!!' // library marker kkossev.commonLib, line 1215
deleteAllSettings() // library marker kkossev.commonLib, line 1216
deleteAllCurrentStates() // library marker kkossev.commonLib, line 1217
deleteAllScheduledJobs() // library marker kkossev.commonLib, line 1218
deleteAllStates() // library marker kkossev.commonLib, line 1219
deleteAllChildDevices() // library marker kkossev.commonLib, line 1220
initialize() // library marker kkossev.commonLib, line 1222
configureNow() // calls also configureDevice() // bug fixed 04/03/2024 // library marker kkossev.commonLib, line 1223
updated() // library marker kkossev.commonLib, line 1224
sendInfoEvent('All Defaults Loaded! F5 to refresh') // library marker kkossev.commonLib, line 1225
} // library marker kkossev.commonLib, line 1226
private void configureNow() { // library marker kkossev.commonLib, line 1228
configure() // library marker kkossev.commonLib, line 1229
} // library marker kkossev.commonLib, line 1230
/** // library marker kkossev.commonLib, line 1232
* Send configuration parameters to the device // library marker kkossev.commonLib, line 1233
* Invoked when device is first installed and when the user updates the configuration TODO // library marker kkossev.commonLib, line 1234
* @return sends zigbee commands // library marker kkossev.commonLib, line 1235
*/ // library marker kkossev.commonLib, line 1236
void configure() { // library marker kkossev.commonLib, line 1237
List cmds = [] // library marker kkossev.commonLib, line 1238
if (state.stats == null) { state.stats = [:] } ; state.stats.cfgCtr = (state.stats.cfgCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1239
logInfo "configure()... cfgCtr=${state.stats.cfgCtr}" // library marker kkossev.commonLib, line 1240
logDebug "configure(): settings: $settings" // library marker kkossev.commonLib, line 1241
if (isTuya()) { // library marker kkossev.commonLib, line 1242
cmds += tuyaBlackMagic() // library marker kkossev.commonLib, line 1243
} // library marker kkossev.commonLib, line 1244
aqaraBlackMagic() // zigbee commands are sent here! // library marker kkossev.commonLib, line 1245
List initCmds = initializeDevice() // library marker kkossev.commonLib, line 1246
if (initCmds != null && !initCmds.isEmpty()) { cmds += initCmds } // library marker kkossev.commonLib, line 1247
List cfgCmds = configureDevice() // library marker kkossev.commonLib, line 1248
if (cfgCmds != null && !cfgCmds.isEmpty()) { cmds += cfgCmds } // library marker kkossev.commonLib, line 1249
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 1250
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 1251
logDebug "configure(): sent cmds = ${cmds}" // library marker kkossev.commonLib, line 1252
sendInfoEvent('sent device configuration') // library marker kkossev.commonLib, line 1253
} // library marker kkossev.commonLib, line 1254
else { // library marker kkossev.commonLib, line 1255
logDebug "configure(): no commands defined for device type ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 1256
} // library marker kkossev.commonLib, line 1257
} // library marker kkossev.commonLib, line 1258
// Invoked when the device is installed with this driver automatically selected. // library marker kkossev.commonLib, line 1260
void installed() { // library marker kkossev.commonLib, line 1261
if (state.stats == null) { state.stats = [:] } ; state.stats.instCtr = (state.stats.instCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1262
logInfo "installed()... instCtr=${state.stats.instCtr}" // library marker kkossev.commonLib, line 1263
// populate some default values for attributes // library marker kkossev.commonLib, line 1264
sendEvent(name: 'healthStatus', value: 'unknown', descriptionText: 'device was installed', type: 'digital') // library marker kkossev.commonLib, line 1265
sendEvent(name: 'powerSource', value: 'unknown', descriptionText: 'device was installed', type: 'digital') // library marker kkossev.commonLib, line 1266
sendInfoEvent('installed') // library marker kkossev.commonLib, line 1267
runIn(3, 'updated') // library marker kkossev.commonLib, line 1268
runIn(5, 'queryPowerSource') // library marker kkossev.commonLib, line 1269
} // library marker kkossev.commonLib, line 1270
private void queryPowerSource() { // library marker kkossev.commonLib, line 1272
sendZigbeeCommands(zigbee.readAttribute(zigbee.BASIC_CLUSTER, 0x0007, [:], 0)) // library marker kkossev.commonLib, line 1273
} // library marker kkossev.commonLib, line 1274
// Invoked from 'LoadAllDefaults' // library marker kkossev.commonLib, line 1276
private void initialize() { // library marker kkossev.commonLib, line 1277
if (state.stats == null) { state.stats = [:] } ; state.stats.initCtr = (state.stats.initCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1278
logDebug "initialize()... initCtr=${state.stats.initCtr}" // library marker kkossev.commonLib, line 1279
if (device.getDataValue('powerSource') == null) { // library marker kkossev.commonLib, line 1280
logDebug "initializing device powerSource 'unknown'" // library marker kkossev.commonLib, line 1281
sendEvent(name: 'powerSource', value: 'unknown', type: 'digital') // library marker kkossev.commonLib, line 1282
} // library marker kkossev.commonLib, line 1283
if (this.respondsTo('customInitialize')) { customInitialize() } // library marker kkossev.commonLib, line 1284
initializeVars(fullInit = true) // library marker kkossev.commonLib, line 1285
updateTuyaVersion() // library marker kkossev.commonLib, line 1286
updateAqaraVersion() // library marker kkossev.commonLib, line 1287
} // library marker kkossev.commonLib, line 1288
/* // library marker kkossev.commonLib, line 1290
*----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 1291
* kkossev drivers commonly used functions // library marker kkossev.commonLib, line 1292
*----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 1293
*/ // library marker kkossev.commonLib, line 1294
static Integer safeToInt(Object val, Integer defaultVal=0) { // library marker kkossev.commonLib, line 1296
return "${val}"?.isInteger() ? "${val}".toInteger() : defaultVal // library marker kkossev.commonLib, line 1297
} // library marker kkossev.commonLib, line 1298
static Double safeToDouble(Object val, Double defaultVal=0.0) { // library marker kkossev.commonLib, line 1300
return "${val}"?.isDouble() ? "${val}".toDouble() : defaultVal // library marker kkossev.commonLib, line 1301
} // library marker kkossev.commonLib, line 1302
static BigDecimal safeToBigDecimal(Object val, BigDecimal defaultVal=0.0) { // library marker kkossev.commonLib, line 1304
return "${val}"?.isBigDecimal() ? "${val}".toBigDecimal() : defaultVal // library marker kkossev.commonLib, line 1305
} // library marker kkossev.commonLib, line 1306
public void sendZigbeeCommands(List cmd) { // library marker kkossev.commonLib, line 1308
if (cmd == null || cmd.isEmpty()) { // library marker kkossev.commonLib, line 1309
logWarn "sendZigbeeCommands: list is empty! cmd=${cmd}" // library marker kkossev.commonLib, line 1310
return // library marker kkossev.commonLib, line 1311
} // library marker kkossev.commonLib, line 1312
hubitat.device.HubMultiAction allActions = new hubitat.device.HubMultiAction() // library marker kkossev.commonLib, line 1313
cmd.each { // library marker kkossev.commonLib, line 1314
if (it == null || it.isEmpty() || it == 'null') { // library marker kkossev.commonLib, line 1315
logWarn "sendZigbeeCommands it: no commands to send! it=${it} (cmd=${cmd})" // library marker kkossev.commonLib, line 1316
return // library marker kkossev.commonLib, line 1317
} // library marker kkossev.commonLib, line 1318
allActions.add(new hubitat.device.HubAction(it, hubitat.device.Protocol.ZIGBEE)) // library marker kkossev.commonLib, line 1319
if (state.stats != null) { state.stats['txCtr'] = (state.stats['txCtr'] ?: 0) + 1 } else { state.stats = [:] } // library marker kkossev.commonLib, line 1320
} // library marker kkossev.commonLib, line 1321
if (state.lastTx != null) { state.lastTx['cmdTime'] = now() } else { state.lastTx = [:] } // library marker kkossev.commonLib, line 1322
sendHubCommand(allActions) // library marker kkossev.commonLib, line 1323
logDebug "sendZigbeeCommands: sent cmd=${cmd}" // library marker kkossev.commonLib, line 1324
} // library marker kkossev.commonLib, line 1325
private String driverVersionAndTimeStamp() { version() + ' ' + timeStamp() + ((_DEBUG) ? ' (debug version!) ' : ' ') + "(${device.getDataValue('model')} ${device.getDataValue('manufacturer')}) (${getModel()} ${location.hub.firmwareVersionString})" } // library marker kkossev.commonLib, line 1327
private String getDeviceInfo() { // library marker kkossev.commonLib, line 1329
return "model=${device.getDataValue('model')} manufacturer=${device.getDataValue('manufacturer')} destinationEP=${state.destinationEP ?: UNKNOWN} deviceProfile=${state.deviceProfile ?: UNKNOWN}" // library marker kkossev.commonLib, line 1330
} // library marker kkossev.commonLib, line 1331
public String getDestinationEP() { // [destEndpoint:safeToInt(getDestinationEP())] // library marker kkossev.commonLib, line 1333
return state.destinationEP ?: device.endpointId ?: '01' // library marker kkossev.commonLib, line 1334
} // library marker kkossev.commonLib, line 1335
//@CompileStatic // library marker kkossev.commonLib, line 1337
public void checkDriverVersion(final Map stateCopy) { // library marker kkossev.commonLib, line 1338
if (stateCopy.driverVersion == null || driverVersionAndTimeStamp() != stateCopy.driverVersion) { // library marker kkossev.commonLib, line 1339
logDebug "checkDriverVersion: updating the settings from the current driver version ${stateCopy.driverVersion} to the new version ${driverVersionAndTimeStamp()}" // library marker kkossev.commonLib, line 1340
sendInfoEvent("Updated to version ${driverVersionAndTimeStamp()} from version ${stateCopy.driverVersion ?: 'unknown'}") // library marker kkossev.commonLib, line 1341
state.driverVersion = driverVersionAndTimeStamp() // library marker kkossev.commonLib, line 1342
initializeVars(false) // library marker kkossev.commonLib, line 1343
updateTuyaVersion() // library marker kkossev.commonLib, line 1344
updateAqaraVersion() // library marker kkossev.commonLib, line 1345
if (this.respondsTo('customcheckDriverVersion')) { customcheckDriverVersion(stateCopy) } // library marker kkossev.commonLib, line 1346
} // library marker kkossev.commonLib, line 1347
if (state.states == null) { state.states = [:] } ; if (state.lastRx == null) { state.lastRx = [:] } ; if (state.lastTx == null) { state.lastTx = [:] } ; if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 1348
} // library marker kkossev.commonLib, line 1349
// credits @thebearmay // library marker kkossev.commonLib, line 1351
String getModel() { // library marker kkossev.commonLib, line 1352
try { // library marker kkossev.commonLib, line 1353
/* groovylint-disable-next-line UnnecessaryGetter, UnusedVariable */ // library marker kkossev.commonLib, line 1354
String model = getHubVersion() // requires >=2.2.8.141 // library marker kkossev.commonLib, line 1355
} catch (ignore) { // library marker kkossev.commonLib, line 1356
try { // library marker kkossev.commonLib, line 1357
httpGet("http://${location.hub.localIP}:8080/api/hubitat.xml") { res -> // library marker kkossev.commonLib, line 1358
model = res.data.device.modelName // library marker kkossev.commonLib, line 1359
return model // library marker kkossev.commonLib, line 1360
} // library marker kkossev.commonLib, line 1361
} catch (ignore_again) { // library marker kkossev.commonLib, line 1362
return '' // library marker kkossev.commonLib, line 1363
} // library marker kkossev.commonLib, line 1364
} // library marker kkossev.commonLib, line 1365
} // library marker kkossev.commonLib, line 1366
// credits @thebearmay // library marker kkossev.commonLib, line 1368
boolean isCompatible(Integer minLevel) { //check to see if the hub version meets the minimum requirement ( 7 or 8 ) // library marker kkossev.commonLib, line 1369
String model = getModel() // Rev C-7 // library marker kkossev.commonLib, line 1370
String[] tokens = model.split('-') // library marker kkossev.commonLib, line 1371
String revision = tokens.last() // library marker kkossev.commonLib, line 1372
return (Integer.parseInt(revision) >= minLevel) // library marker kkossev.commonLib, line 1373
} // library marker kkossev.commonLib, line 1374
void deleteAllStatesAndJobs() { // library marker kkossev.commonLib, line 1376
state.clear() // clear all states // library marker kkossev.commonLib, line 1377
unschedule() // library marker kkossev.commonLib, line 1378
device.deleteCurrentState('*') // library marker kkossev.commonLib, line 1379
device.deleteCurrentState('') // library marker kkossev.commonLib, line 1380
log.info "${device.displayName} jobs and states cleared. HE hub is ${getHubVersion()}, version is ${location.hub.firmwareVersionString}" // library marker kkossev.commonLib, line 1382
} // library marker kkossev.commonLib, line 1383
void resetStatistics() { // library marker kkossev.commonLib, line 1385
runIn(1, 'resetStats') // library marker kkossev.commonLib, line 1386
sendInfoEvent('Statistics are reset. Refresh the web page') // library marker kkossev.commonLib, line 1387
} // library marker kkossev.commonLib, line 1388
// called from initializeVars(true) and resetStatistics() // library marker kkossev.commonLib, line 1390
void resetStats() { // library marker kkossev.commonLib, line 1391
logDebug 'resetStats...' // library marker kkossev.commonLib, line 1392
state.stats = [:] ; state.states = [:] ; state.lastRx = [:] ; state.lastTx = [:] ; state.health = [:] // library marker kkossev.commonLib, line 1393
if (this.respondsTo('groupsLibVersion')) { state.zigbeeGroups = [:] } // library marker kkossev.commonLib, line 1394
state.stats.rxCtr = 0 ; state.stats.txCtr = 0 // library marker kkossev.commonLib, line 1395
state.states['isDigital'] = false ; state.states['isRefresh'] = false ; state.states['isPing'] = false // library marker kkossev.commonLib, line 1396
state.health['offlineCtr'] = 0 ; state.health['checkCtr3'] = 0 // library marker kkossev.commonLib, line 1397
if (this.respondsTo('customResetStats')) { customResetStats() } // library marker kkossev.commonLib, line 1398
logInfo 'statistics reset!' // library marker kkossev.commonLib, line 1399
} // library marker kkossev.commonLib, line 1400
void initializeVars( boolean fullInit = false ) { // library marker kkossev.commonLib, line 1402
logDebug "InitializeVars()... fullInit = ${fullInit}" // library marker kkossev.commonLib, line 1403
if (fullInit == true ) { // library marker kkossev.commonLib, line 1404
state.clear() // library marker kkossev.commonLib, line 1405
unschedule() // library marker kkossev.commonLib, line 1406
resetStats() // library marker kkossev.commonLib, line 1407
if (this.respondsTo('setDeviceNameAndProfile')) { setDeviceNameAndProfile() } // library marker kkossev.commonLib, line 1408
//state.comment = 'Works with Tuya Zigbee Devices' // library marker kkossev.commonLib, line 1409
logInfo 'all states and scheduled jobs cleared!' // library marker kkossev.commonLib, line 1410
state.driverVersion = driverVersionAndTimeStamp() // library marker kkossev.commonLib, line 1411
logInfo "DEVICE_TYPE = ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 1412
state.deviceType = DEVICE_TYPE // library marker kkossev.commonLib, line 1413
sendInfoEvent('Initialized') // library marker kkossev.commonLib, line 1414
} // library marker kkossev.commonLib, line 1415
if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 1417
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1418
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 1419
if (state.lastTx == null) { state.lastTx = [:] } // library marker kkossev.commonLib, line 1420
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1421
if (fullInit || settings?.txtEnable == null) { device.updateSetting('txtEnable', true) } // library marker kkossev.commonLib, line 1423
if (fullInit || settings?.logEnable == null) { device.updateSetting('logEnable', DEFAULT_DEBUG_LOGGING ?: false) } // library marker kkossev.commonLib, line 1424
if (fullInit || settings?.traceEnable == null) { device.updateSetting('traceEnable', false) } // library marker kkossev.commonLib, line 1425
if (fullInit || settings?.advancedOptions == null) { device.updateSetting('advancedOptions', [value:false, type:'bool']) } // library marker kkossev.commonLib, line 1426
if (fullInit || settings?.healthCheckMethod == null) { device.updateSetting('healthCheckMethod', [value: HealthcheckMethodOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.commonLib, line 1427
if (fullInit || settings?.healthCheckInterval == null) { device.updateSetting('healthCheckInterval', [value: HealthcheckIntervalOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.commonLib, line 1428
if (fullInit || settings?.ignoreDuplicatedZigbeeMessages == null) { device.updateSetting('ignoreDuplicatedZigbeeMessages', false) } // library marker kkossev.commonLib, line 1429
if (fullInit || settings?.voltageToPercent == null) { device.updateSetting('voltageToPercent', false) } // library marker kkossev.commonLib, line 1430
if (device.currentValue('healthStatus') == null) { sendHealthStatusEvent('unknown') } // library marker kkossev.commonLib, line 1432
// common libraries initialization // library marker kkossev.commonLib, line 1434
executeCustomHandler('batteryInitializeVars', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1435
executeCustomHandler('motionInitializeVars', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1436
executeCustomHandler('groupsInitializeVars', fullInit) // library marker kkossev.commonLib, line 1437
executeCustomHandler('illuminanceInitializeVars', fullInit) // library marker kkossev.commonLib, line 1438
executeCustomHandler('onOfInitializeVars', fullInit) // library marker kkossev.commonLib, line 1439
executeCustomHandler('energyInitializeVars', fullInit) // library marker kkossev.commonLib, line 1440
// // library marker kkossev.commonLib, line 1441
executeCustomHandler('deviceProfileInitializeVars', fullInit) // must be before the other deviceProfile initialization handlers! // library marker kkossev.commonLib, line 1442
executeCustomHandler('initEventsDeviceProfile', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1443
// // library marker kkossev.commonLib, line 1444
// custom device driver specific initialization should be at the end // library marker kkossev.commonLib, line 1445
executeCustomHandler('customInitializeVars', fullInit) // library marker kkossev.commonLib, line 1446
executeCustomHandler('customCreateChildDevices', fullInit) // library marker kkossev.commonLib, line 1447
executeCustomHandler('customInitEvents', fullInit) // library marker kkossev.commonLib, line 1448
final String mm = device.getDataValue('model') // library marker kkossev.commonLib, line 1450
if (mm != null) { logTrace " model = ${mm}" } // library marker kkossev.commonLib, line 1451
else { logWarn ' Model not found, please re-pair the device!' } // library marker kkossev.commonLib, line 1452
final String ep = device.getEndpointId() // library marker kkossev.commonLib, line 1453
if ( ep != null) { // library marker kkossev.commonLib, line 1454
//state.destinationEP = ep // library marker kkossev.commonLib, line 1455
logTrace " destinationEP = ${ep}" // library marker kkossev.commonLib, line 1456
} // library marker kkossev.commonLib, line 1457
else { // library marker kkossev.commonLib, line 1458
logWarn ' Destination End Point not found, please re-pair the device!' // library marker kkossev.commonLib, line 1459
//state.destinationEP = "01" // fallback // library marker kkossev.commonLib, line 1460
} // library marker kkossev.commonLib, line 1461
} // library marker kkossev.commonLib, line 1462
// not used!? // library marker kkossev.commonLib, line 1464
void setDestinationEP() { // library marker kkossev.commonLib, line 1465
String ep = device.getEndpointId() // library marker kkossev.commonLib, line 1466
if (ep != null && ep != 'F2') { state.destinationEP = ep ; logDebug "setDestinationEP() destinationEP = ${state.destinationEP}" } // library marker kkossev.commonLib, line 1467
else { logWarn "setDestinationEP() Destination End Point not found or invalid(${ep}), activating the F2 bug patch!" ; state.destinationEP = '01' } // fallback EP // library marker kkossev.commonLib, line 1468
} // library marker kkossev.commonLib, line 1469
void logDebug(final String msg) { if (settings?.logEnable) { log.debug "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1471
void logInfo(final String msg) { if (settings?.txtEnable) { log.info "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1472
void logWarn(final String msg) { if (settings?.logEnable) { log.warn "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1473
void logTrace(final String msg) { if (settings?.traceEnable) { log.trace "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1474
void logError(final String msg) { if (settings?.txtEnable) { log.error "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1475
// _DEBUG mode only // library marker kkossev.commonLib, line 1477
void getAllProperties() { // library marker kkossev.commonLib, line 1478
log.trace 'Properties:' ; device.properties.each { it -> log.debug it } // library marker kkossev.commonLib, line 1479
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 // library marker kkossev.commonLib, line 1480
} // library marker kkossev.commonLib, line 1481
// delete all Preferences // library marker kkossev.commonLib, line 1483
void deleteAllSettings() { // library marker kkossev.commonLib, line 1484
String preferencesDeleted = '' // library marker kkossev.commonLib, line 1485
settings.each { it -> preferencesDeleted += "${it.key} (${it.value}), " ; device.removeSetting("${it.key}") } // library marker kkossev.commonLib, line 1486
logDebug "Deleted settings: ${preferencesDeleted}" // library marker kkossev.commonLib, line 1487
logInfo 'All settings (preferences) DELETED' // library marker kkossev.commonLib, line 1488
} // library marker kkossev.commonLib, line 1489
// delete all attributes // library marker kkossev.commonLib, line 1491
void deleteAllCurrentStates() { // library marker kkossev.commonLib, line 1492
String attributesDeleted = '' // library marker kkossev.commonLib, line 1493
device.properties.supportedAttributes.each { it -> attributesDeleted += "${it}, " ; device.deleteCurrentState("$it") } // library marker kkossev.commonLib, line 1494
logDebug "Deleted attributes: ${attributesDeleted}" ; logInfo 'All current states (attributes) DELETED' // library marker kkossev.commonLib, line 1495
} // library marker kkossev.commonLib, line 1496
// delete all State Variables // library marker kkossev.commonLib, line 1498
void deleteAllStates() { // library marker kkossev.commonLib, line 1499
String stateDeleted = '' // library marker kkossev.commonLib, line 1500
state.each { it -> stateDeleted += "${it.key}, " } // library marker kkossev.commonLib, line 1501
state.clear() // library marker kkossev.commonLib, line 1502
logDebug "Deleted states: ${stateDeleted}" ; logInfo 'All States DELETED' // library marker kkossev.commonLib, line 1503
} // library marker kkossev.commonLib, line 1504
void deleteAllScheduledJobs() { // library marker kkossev.commonLib, line 1506
unschedule() ; logInfo 'All scheduled jobs DELETED' // library marker kkossev.commonLib, line 1507
} // library marker kkossev.commonLib, line 1508
void deleteAllChildDevices() { // library marker kkossev.commonLib, line 1510
getChildDevices().each { child -> log.info "${device.displayName} Deleting ${child.deviceNetworkId}" ; deleteChildDevice(child.deviceNetworkId) } // library marker kkossev.commonLib, line 1511
sendInfoEvent 'All child devices DELETED' // library marker kkossev.commonLib, line 1512
} // library marker kkossev.commonLib, line 1513
void testParse(String par) { // library marker kkossev.commonLib, line 1515
//read attr - raw: DF8D0104020A000029280A, dni: DF8D, endpoint: 01, cluster: 0402, size: 0A, attrId: 0000, encoding: 29, command: 0A, value: 280A // library marker kkossev.commonLib, line 1516
log.trace '------------------------------------------------------' // library marker kkossev.commonLib, line 1517
log.warn "testParse - START (${par})" // library marker kkossev.commonLib, line 1518
parse(par) // library marker kkossev.commonLib, line 1519
log.warn "testParse - END (${par})" // library marker kkossev.commonLib, line 1520
log.trace '------------------------------------------------------' // library marker kkossev.commonLib, line 1521
} // library marker kkossev.commonLib, line 1522
Object testJob() { // library marker kkossev.commonLib, line 1524
log.warn 'test job executed' // library marker kkossev.commonLib, line 1525
} // library marker kkossev.commonLib, line 1526
/** // library marker kkossev.commonLib, line 1528
* Calculates and returns the cron expression // library marker kkossev.commonLib, line 1529
* @param timeInSeconds interval in seconds // library marker kkossev.commonLib, line 1530
*/ // library marker kkossev.commonLib, line 1531
String getCron(int timeInSeconds) { // library marker kkossev.commonLib, line 1532
//schedule("${rnd.nextInt(59)} ${rnd.nextInt(9)}/${intervalMins} * ? * * *", 'ping') // library marker kkossev.commonLib, line 1533
// TODO: runEvery1Minute runEvery5Minutes runEvery10Minutes runEvery15Minutes runEvery30Minutes runEvery1Hour runEvery3Hours // library marker kkossev.commonLib, line 1534
final Random rnd = new Random() // library marker kkossev.commonLib, line 1535
int minutes = (timeInSeconds / 60 ) as int // library marker kkossev.commonLib, line 1536
int hours = (minutes / 60 ) as int // library marker kkossev.commonLib, line 1537
if (hours > 23) { hours = 23 } // library marker kkossev.commonLib, line 1538
String cron // library marker kkossev.commonLib, line 1539
if (timeInSeconds < 60) { cron = "*/$timeInSeconds * * * * ? *" } // library marker kkossev.commonLib, line 1540
else { // library marker kkossev.commonLib, line 1541
if (minutes < 60) { cron = "${rnd.nextInt(59)} ${rnd.nextInt(9)}/$minutes * ? * *" } // library marker kkossev.commonLib, line 1542
else { cron = "${rnd.nextInt(59)} ${rnd.nextInt(59)} */$hours ? * *" } // library marker kkossev.commonLib, line 1543
} // library marker kkossev.commonLib, line 1544
return cron // library marker kkossev.commonLib, line 1545
} // library marker kkossev.commonLib, line 1546
// credits @thebearmay // library marker kkossev.commonLib, line 1548
String formatUptime() { // library marker kkossev.commonLib, line 1549
return formatTime(location.hub.uptime) // library marker kkossev.commonLib, line 1550
} // library marker kkossev.commonLib, line 1551
String formatTime(int timeInSeconds) { // library marker kkossev.commonLib, line 1553
if (timeInSeconds == null) { return UNKNOWN } // library marker kkossev.commonLib, line 1554
int days = (timeInSeconds / 86400).toInteger() // library marker kkossev.commonLib, line 1555
int hours = ((timeInSeconds % 86400) / 3600).toInteger() // library marker kkossev.commonLib, line 1556
int minutes = ((timeInSeconds % 3600) / 60).toInteger() // library marker kkossev.commonLib, line 1557
int seconds = (timeInSeconds % 60).toInteger() // library marker kkossev.commonLib, line 1558
return "${days}d ${hours}h ${minutes}m ${seconds}s" // library marker kkossev.commonLib, line 1559
} // library marker kkossev.commonLib, line 1560
boolean isTuya() { // library marker kkossev.commonLib, line 1562
if (!device) { return true } // fallback - added 04/03/2024 // library marker kkossev.commonLib, line 1563
String model = device.getDataValue('model') // library marker kkossev.commonLib, line 1564
String manufacturer = device.getDataValue('manufacturer') // library marker kkossev.commonLib, line 1565
/* groovylint-disable-next-line UnnecessaryTernaryExpression */ // library marker kkossev.commonLib, line 1566
return ((model?.startsWith('TS') && manufacturer?.startsWith('_T')) || model == 'HOBEIAN') ? true : false // library marker kkossev.commonLib, line 1567
} // library marker kkossev.commonLib, line 1568
void updateTuyaVersion() { // library marker kkossev.commonLib, line 1570
if (!isTuya()) { logTrace 'not Tuya' ; return } // library marker kkossev.commonLib, line 1571
final String application = device.getDataValue('application') // library marker kkossev.commonLib, line 1572
if (application != null) { // library marker kkossev.commonLib, line 1573
Integer ver // library marker kkossev.commonLib, line 1574
try { ver = zigbee.convertHexToInt(application) } // library marker kkossev.commonLib, line 1575
catch (e) { logWarn "exception caught while converting application version ${application} to tuyaVersion"; return } // library marker kkossev.commonLib, line 1576
final String str = ((ver & 0xC0) >> 6).toString() + '.' + ((ver & 0x30) >> 4).toString() + '.' + (ver & 0x0F).toString() // library marker kkossev.commonLib, line 1577
if (device.getDataValue('tuyaVersion') != str) { // library marker kkossev.commonLib, line 1578
device.updateDataValue('tuyaVersion', str) // library marker kkossev.commonLib, line 1579
logInfo "tuyaVersion set to $str" // library marker kkossev.commonLib, line 1580
} // library marker kkossev.commonLib, line 1581
} // library marker kkossev.commonLib, line 1582
} // library marker kkossev.commonLib, line 1583
boolean isAqara() { return device.getDataValue('model')?.startsWith('lumi') ?: false } // library marker kkossev.commonLib, line 1585
void updateAqaraVersion() { // library marker kkossev.commonLib, line 1587
if (!isAqara()) { logTrace 'not Aqara' ; return } // library marker kkossev.commonLib, line 1588
String application = device.getDataValue('application') // library marker kkossev.commonLib, line 1589
if (application != null) { // library marker kkossev.commonLib, line 1590
String str = '0.0.0_' + String.format('%04d', zigbee.convertHexToInt(application.take(2))) // library marker kkossev.commonLib, line 1591
if (device.getDataValue('aqaraVersion') != str) { // library marker kkossev.commonLib, line 1592
device.updateDataValue('aqaraVersion', str) // library marker kkossev.commonLib, line 1593
logInfo "aqaraVersion set to $str" // library marker kkossev.commonLib, line 1594
} // library marker kkossev.commonLib, line 1595
} // library marker kkossev.commonLib, line 1596
} // library marker kkossev.commonLib, line 1597
String unix2formattedDate(Long unixTime) { // library marker kkossev.commonLib, line 1599
try { // library marker kkossev.commonLib, line 1600
if (unixTime == null) { return null } // library marker kkossev.commonLib, line 1601
/* groovylint-disable-next-line NoJavaUtilDate */ // library marker kkossev.commonLib, line 1602
Date date = new Date(unixTime.toLong()) // library marker kkossev.commonLib, line 1603
return date.format('yyyy-MM-dd HH:mm:ss.SSS', location.timeZone) // library marker kkossev.commonLib, line 1604
} catch (e) { // library marker kkossev.commonLib, line 1605
logDebug "Error formatting date: ${e.message}. Returning current time instead." // library marker kkossev.commonLib, line 1606
return new Date().format('yyyy-MM-dd HH:mm:ss.SSS', location.timeZone) // library marker kkossev.commonLib, line 1607
} // library marker kkossev.commonLib, line 1608
} // library marker kkossev.commonLib, line 1609
Long formattedDate2unix(String formattedDate) { // library marker kkossev.commonLib, line 1611
try { // library marker kkossev.commonLib, line 1612
if (formattedDate == null) { return null } // library marker kkossev.commonLib, line 1613
Date date = Date.parse('yyyy-MM-dd HH:mm:ss.SSS', formattedDate) // library marker kkossev.commonLib, line 1614
return date.getTime() // library marker kkossev.commonLib, line 1615
} catch (e) { // library marker kkossev.commonLib, line 1616
logDebug "Error parsing formatted date: ${formattedDate}. Returning current time instead." // library marker kkossev.commonLib, line 1617
return now() // library marker kkossev.commonLib, line 1618
} // library marker kkossev.commonLib, line 1619
} // library marker kkossev.commonLib, line 1620
static String timeToHMS(final int time) { // library marker kkossev.commonLib, line 1622
int hours = (time / 3600) as int // library marker kkossev.commonLib, line 1623
int minutes = ((time % 3600) / 60) as int // library marker kkossev.commonLib, line 1624
int seconds = time % 60 // library marker kkossev.commonLib, line 1625
return "${hours}h ${minutes}m ${seconds}s" // library marker kkossev.commonLib, line 1626
} // library marker kkossev.commonLib, line 1627
// ~~~~~ end include (144) kkossev.commonLib ~~~~~
// ~~~~~ start include (176) kkossev.onOffLib ~~~~~
/* groovylint-disable CompileStatic, CouldBeSwitchStatement, DuplicateListLiteral, DuplicateMapLiteral, DuplicateNumberLiteral, DuplicateStringLiteral, ImplicitClosureParameter, ImplicitReturnStatement, Instanceof, LineLength, MethodCount, MethodSize, NoDouble, NoFloat, NoWildcardImports, ParameterCount, ParameterName, PublicMethodsBeforeNonPublicMethods, UnnecessaryElseStatement, UnnecessaryGetter, UnnecessaryObjectReferences, UnnecessaryPublicModifier, UnnecessarySetter, UnusedImport */ // library marker kkossev.onOffLib, line 1
library( // library marker kkossev.onOffLib, line 2
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Zigbee OnOff Cluster Library', name: 'onOffLib', namespace: 'kkossev', // library marker kkossev.onOffLib, line 3
importUrl: 'https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/onOffLib.groovy', documentationLink: '', // library marker kkossev.onOffLib, line 4
version: '3.2.3' // library marker kkossev.onOffLib, line 5
) // library marker kkossev.onOffLib, line 6
/* // library marker kkossev.onOffLib, line 7
* Zigbee OnOff Cluster Library // library marker kkossev.onOffLib, line 8
* // library marker kkossev.onOffLib, line 9
* Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.onOffLib, line 10
* in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.onOffLib, line 11
* // library marker kkossev.onOffLib, line 12
* http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.onOffLib, line 13
* // library marker kkossev.onOffLib, line 14
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.onOffLib, line 15
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.onOffLib, line 16
* for the specific language governing permissions and limitations under the License. // library marker kkossev.onOffLib, line 17
* // library marker kkossev.onOffLib, line 18
* ver. 3.2.0 2024-06-04 kkossev - commonLib 3.2.1 allignment; if isRefresh then sendEvent with isStateChange = true // library marker kkossev.onOffLib, line 19
* ver. 3.2.1 2024-06-07 kkossev - the advanced options are excpluded for DEVICE_TYPE Thermostat // library marker kkossev.onOffLib, line 20
* ver. 3.2.2 2024-06-29 kkossev - added on/off control for Tuya device profiles with 'switch' dp; // library marker kkossev.onOffLib, line 21
* ver. 3.2.3 2025-12-06 kkossev - fixed a bug in off() and on() methods where clearIsDigital() was called too early // library marker kkossev.onOffLib, line 22
* // library marker kkossev.onOffLib, line 23
* TODO: // library marker kkossev.onOffLib, line 24
*/ // library marker kkossev.onOffLib, line 25
static String onOffLibVersion() { '3.2.3' } // library marker kkossev.onOffLib, line 27
static String onOffLibStamp() { '2025/12/06 10:45 PM' } // library marker kkossev.onOffLib, line 28
@Field static final Boolean _THREE_STATE = true // library marker kkossev.onOffLib, line 30
metadata { // library marker kkossev.onOffLib, line 32
capability 'Actuator' // library marker kkossev.onOffLib, line 33
capability 'Switch' // library marker kkossev.onOffLib, line 34
if (_THREE_STATE == true) { // library marker kkossev.onOffLib, line 35
attribute 'switch', 'enum', SwitchThreeStateOpts.options.values() as List // library marker kkossev.onOffLib, line 36
} // library marker kkossev.onOffLib, line 37
// no commands // library marker kkossev.onOffLib, line 38
preferences { // library marker kkossev.onOffLib, line 39
if (settings?.advancedOptions == true && device != null && !(DEVICE_TYPE in ['Device', 'Thermostat'])) { // library marker kkossev.onOffLib, line 40
input(name: 'ignoreDuplicated', type: 'bool', title: 'Ignore Duplicated Switch Events', description: 'Some switches and plugs send periodically the switch status as a heart-beet ', defaultValue: true) // library marker kkossev.onOffLib, line 41
input(name: 'alwaysOn', type: 'bool', title: 'Always On', description: 'Disable switching off plugs and switches that must stay always On', defaultValue: false) // library marker kkossev.onOffLib, line 42
if (_THREE_STATE == true) { // library marker kkossev.onOffLib, line 43
input name: 'threeStateEnable', type: 'bool', title: 'Enable three-states events', description: 'Experimental multi-state switch events', defaultValue: false // library marker kkossev.onOffLib, line 44
} // library marker kkossev.onOffLib, line 45
} // library marker kkossev.onOffLib, line 46
} // library marker kkossev.onOffLib, line 47
} // library marker kkossev.onOffLib, line 48
@Field static final Map SwitchThreeStateOpts = [ // library marker kkossev.onOffLib, line 50
defaultValue: 0, options: [0: 'off', 1: 'on', 2: 'switching_off', 3: 'switching_on', 4: 'switch_failure'] // library marker kkossev.onOffLib, line 51
] // library marker kkossev.onOffLib, line 52
@Field static final Map powerOnBehaviourOptions = [ // library marker kkossev.onOffLib, line 54
'0': 'switch off', '1': 'switch on', '2': 'switch last state' // library marker kkossev.onOffLib, line 55
] // library marker kkossev.onOffLib, line 56
@Field static final Map switchTypeOptions = [ // library marker kkossev.onOffLib, line 58
'0': 'toggle', '1': 'state', '2': 'momentary' // library marker kkossev.onOffLib, line 59
] // library marker kkossev.onOffLib, line 60
private boolean isCircuitBreaker() { device.getDataValue('manufacturer') in ['_TZ3000_ky0fq4ho'] } // library marker kkossev.onOffLib, line 62
/* // library marker kkossev.onOffLib, line 64
* ----------------------------------------------------------------------------- // library marker kkossev.onOffLib, line 65
* on/off cluster 0x0006 TODO - move to a library !!!!!!!!!!!!!!! // library marker kkossev.onOffLib, line 66
* ----------------------------------------------------------------------------- // library marker kkossev.onOffLib, line 67
*/ // library marker kkossev.onOffLib, line 68
void standardParseOnOffCluster(final Map descMap) { // library marker kkossev.onOffLib, line 69
/* // library marker kkossev.onOffLib, line 70
if (this.respondsTo('customParseOnOffCluster')) { // library marker kkossev.onOffLib, line 71
customParseOnOffCluster(descMap) // library marker kkossev.onOffLib, line 72
} // library marker kkossev.onOffLib, line 73
else */ // library marker kkossev.onOffLib, line 74
if (descMap.attrId == '0000') { // library marker kkossev.onOffLib, line 75
if (descMap.value == null || descMap.value == 'FFFF') { logDebug "parseOnOffCluster: invalid value: ${descMap.value}"; return } // invalid or unknown value // library marker kkossev.onOffLib, line 76
int rawValue = hexStrToUnsignedInt(descMap.value) // library marker kkossev.onOffLib, line 77
sendSwitchEvent(rawValue) // library marker kkossev.onOffLib, line 78
} // library marker kkossev.onOffLib, line 79
else if (descMap.attrId in ['4000', '4001', '4002', '4004', '8000', '8001', '8002', '8003']) { // library marker kkossev.onOffLib, line 80
parseOnOffAttributes(descMap) // library marker kkossev.onOffLib, line 81
} // library marker kkossev.onOffLib, line 82
else { // library marker kkossev.onOffLib, line 83
if (descMap.attrId != null) { logWarn "standardParseOnOffCluster: unprocessed attrId ${descMap.attrId}" } // library marker kkossev.onOffLib, line 84
else { logDebug "standardParseOnOffCluster: skipped processing OnOff cluster (attrId is ${descMap.attrId})" } // ZigUSB has its own interpretation of the Zigbee standards ... :( // library marker kkossev.onOffLib, line 85
} // library marker kkossev.onOffLib, line 86
} // library marker kkossev.onOffLib, line 87
void toggleX() { // library marker kkossev.onOffLib, line 89
String descriptionText = 'central button switch is ' // library marker kkossev.onOffLib, line 90
String state = '' // library marker kkossev.onOffLib, line 91
if ((device.currentState('switch')?.value ?: 'n/a') == 'off') { // library marker kkossev.onOffLib, line 92
state = 'on' // library marker kkossev.onOffLib, line 93
} // library marker kkossev.onOffLib, line 94
else { // library marker kkossev.onOffLib, line 95
state = 'off' // library marker kkossev.onOffLib, line 96
} // library marker kkossev.onOffLib, line 97
descriptionText += state // library marker kkossev.onOffLib, line 98
sendEvent(name: 'switch', value: state, descriptionText: descriptionText, type: 'physical', isStateChange: true) // library marker kkossev.onOffLib, line 99
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 100
} // library marker kkossev.onOffLib, line 101
void off() { // library marker kkossev.onOffLib, line 103
if (this.respondsTo('customOff')) { customOff() ; return } // library marker kkossev.onOffLib, line 104
if ((settings?.alwaysOn ?: false) == true) { logWarn "AlwaysOn option for ${device.displayName} is enabled , the command to switch it OFF is ignored!" ; return } // library marker kkossev.onOffLib, line 105
List cmds = [] // library marker kkossev.onOffLib, line 106
// added 06/29/2024 - control Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 107
if (this.respondsTo(getDEVICE)) { // defined in deviceProfileLib // library marker kkossev.onOffLib, line 108
Map switchMap = getAttributesMap('switch') // library marker kkossev.onOffLib, line 109
int onOffValue = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? 0 : 1 // library marker kkossev.onOffLib, line 110
if (switchMap != null && switchMap != [:]) { // library marker kkossev.onOffLib, line 111
cmds = sendTuyaParameter(switchMap, 'switch', onOffValue) // library marker kkossev.onOffLib, line 112
logTrace "off() Tuya cmds=${cmds}" // library marker kkossev.onOffLib, line 113
} // library marker kkossev.onOffLib, line 114
} // library marker kkossev.onOffLib, line 115
if (cmds.size() == 0) { // if not Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 116
cmds = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? zigbee.off() : zigbee.on() // library marker kkossev.onOffLib, line 117
} // library marker kkossev.onOffLib, line 118
String currentState = device.currentState('switch')?.value ?: 'n/a' // library marker kkossev.onOffLib, line 120
logDebug "off() currentState=${currentState}" // library marker kkossev.onOffLib, line 121
if (_THREE_STATE == true && settings?.threeStateEnable == true) { // library marker kkossev.onOffLib, line 122
if (currentState == 'off') { // library marker kkossev.onOffLib, line 123
runIn(1, 'refresh', [overwrite: true]) // library marker kkossev.onOffLib, line 124
} // library marker kkossev.onOffLib, line 125
String value = SwitchThreeStateOpts.options[2] // 'switching_on' // library marker kkossev.onOffLib, line 126
String descriptionText = "${value}" // library marker kkossev.onOffLib, line 127
if (logEnable) { descriptionText += ' (2)' } // library marker kkossev.onOffLib, line 128
sendEvent(name: 'switch', value: value, descriptionText: descriptionText, type: 'digital', isStateChange: true) // library marker kkossev.onOffLib, line 129
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 130
} // library marker kkossev.onOffLib, line 131
state.states['isDigital'] = true // library marker kkossev.onOffLib, line 132
runInMillis(DIGITAL_TIMER, clearIsDigital, [overwrite: true]) // library marker kkossev.onOffLib, line 133
sendZigbeeCommands(cmds) // library marker kkossev.onOffLib, line 134
} // library marker kkossev.onOffLib, line 135
void on() { // library marker kkossev.onOffLib, line 137
if (this.respondsTo('customOn')) { customOn() ; return } // library marker kkossev.onOffLib, line 138
List cmds = [] // library marker kkossev.onOffLib, line 139
// added 06/29/2024 - control Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 140
if (this.respondsTo(getDEVICE)) { // defined in deviceProfileLib // library marker kkossev.onOffLib, line 141
Map switchMap = getAttributesMap('switch') // library marker kkossev.onOffLib, line 142
int onOffValue = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? 1 : 0 // library marker kkossev.onOffLib, line 143
if (switchMap != null && switchMap != [:]) { // library marker kkossev.onOffLib, line 144
cmds = sendTuyaParameter(switchMap, 'switch', onOffValue) // library marker kkossev.onOffLib, line 145
logTrace "on() Tuya cmds=${cmds}" // library marker kkossev.onOffLib, line 146
} // library marker kkossev.onOffLib, line 147
} // library marker kkossev.onOffLib, line 148
if (cmds.size() == 0) { // if not Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 149
cmds = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? zigbee.on() : zigbee.off() // library marker kkossev.onOffLib, line 150
} // library marker kkossev.onOffLib, line 151
String currentState = device.currentState('switch')?.value ?: 'n/a' // library marker kkossev.onOffLib, line 152
logDebug "on() currentState=${currentState}" // library marker kkossev.onOffLib, line 153
if (_THREE_STATE == true && settings?.threeStateEnable == true) { // library marker kkossev.onOffLib, line 154
if ((device.currentState('switch')?.value ?: 'n/a') == 'on') { // library marker kkossev.onOffLib, line 155
runIn(1, 'refresh', [overwrite: true]) // library marker kkossev.onOffLib, line 156
} // library marker kkossev.onOffLib, line 157
String value = SwitchThreeStateOpts.options[3] // 'switching_on' // library marker kkossev.onOffLib, line 158
String descriptionText = "${value}" // library marker kkossev.onOffLib, line 159
if (logEnable) { descriptionText += ' (2)' } // library marker kkossev.onOffLib, line 160
sendEvent(name: 'switch', value: value, descriptionText: descriptionText, type: 'digital', isStateChange: true) // library marker kkossev.onOffLib, line 161
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 162
} // library marker kkossev.onOffLib, line 163
state.states['isDigital'] = true // library marker kkossev.onOffLib, line 164
runInMillis(DIGITAL_TIMER, clearIsDigital, [overwrite: true]) // library marker kkossev.onOffLib, line 165
sendZigbeeCommands(cmds) // library marker kkossev.onOffLib, line 166
} // library marker kkossev.onOffLib, line 167
void sendSwitchEvent(int switchValuePar) { // library marker kkossev.onOffLib, line 169
int switchValue = safeToInt(switchValuePar) // library marker kkossev.onOffLib, line 170
if (settings?.inverceSwitch != null && settings?.inverceSwitch == true) { // library marker kkossev.onOffLib, line 171
switchValue = (switchValue == 0x00) ? 0x01 : 0x00 // library marker kkossev.onOffLib, line 172
} // library marker kkossev.onOffLib, line 173
String value = (switchValue == null) ? 'unknown' : (switchValue == 0x00) ? 'off' : (switchValue == 0x01) ? 'on' : 'unknown' // library marker kkossev.onOffLib, line 174
Map map = [:] // library marker kkossev.onOffLib, line 175
boolean isRefresh = state.states['isRefresh'] ?: false // library marker kkossev.onOffLib, line 176
boolean debounce = state.states['debounce'] ?: false // library marker kkossev.onOffLib, line 177
String lastSwitch = state.states['lastSwitch'] ?: 'unknown' // library marker kkossev.onOffLib, line 178
if (value == lastSwitch && (debounce || (settings.ignoreDuplicated ?: false)) && !isRefresh) { // library marker kkossev.onOffLib, line 179
logDebug "Ignored duplicated switch event ${value}" // library marker kkossev.onOffLib, line 180
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 181
return // library marker kkossev.onOffLib, line 182
} // library marker kkossev.onOffLib, line 183
logTrace "value=${value} lastSwitch=${state.states['lastSwitch']}" // library marker kkossev.onOffLib, line 184
boolean isDigital = state.states['isDigital'] ?: false // library marker kkossev.onOffLib, line 185
map.type = isDigital ? 'digital' : 'physical' // library marker kkossev.onOffLib, line 186
if (lastSwitch != value) { // library marker kkossev.onOffLib, line 187
logDebug "switch state changed from ${lastSwitch} to ${value}" // library marker kkossev.onOffLib, line 188
state.states['debounce'] = true // library marker kkossev.onOffLib, line 189
state.states['lastSwitch'] = value // library marker kkossev.onOffLib, line 190
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 191
} else { // library marker kkossev.onOffLib, line 192
state.states['debounce'] = true // library marker kkossev.onOffLib, line 193
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 194
} // library marker kkossev.onOffLib, line 195
map.name = 'switch' // library marker kkossev.onOffLib, line 196
map.value = value // library marker kkossev.onOffLib, line 197
if (isRefresh) { // library marker kkossev.onOffLib, line 198
map.descriptionText = "${device.displayName} is ${value} [Refresh]" // library marker kkossev.onOffLib, line 199
map.isStateChange = true // library marker kkossev.onOffLib, line 200
} else { // library marker kkossev.onOffLib, line 201
map.descriptionText = "${device.displayName} is ${value} [${map.type}]" // library marker kkossev.onOffLib, line 202
} // library marker kkossev.onOffLib, line 203
logInfo "${map.descriptionText}" // library marker kkossev.onOffLib, line 204
sendEvent(map) // library marker kkossev.onOffLib, line 205
if (this.respondsTo('customSwitchEventPostProcesing')) { // library marker kkossev.onOffLib, line 206
customSwitchEventPostProcesing(map) // library marker kkossev.onOffLib, line 207
} // library marker kkossev.onOffLib, line 208
} // library marker kkossev.onOffLib, line 209
void parseOnOffAttributes(final Map it) { // library marker kkossev.onOffLib, line 211
logDebug "OnOff attribute ${it.attrId} cluster ${it.cluster } reported: value=${it.value}" // library marker kkossev.onOffLib, line 212
/* groovylint-disable-next-line VariableTypeRequired */ // library marker kkossev.onOffLib, line 213
String mode // library marker kkossev.onOffLib, line 214
String attrName // library marker kkossev.onOffLib, line 215
if (it.value == null) { // library marker kkossev.onOffLib, line 216
logDebug "OnOff attribute ${it.attrId} cluster ${it.cluster } skipping NULL value status=${it.status}" // library marker kkossev.onOffLib, line 217
return // library marker kkossev.onOffLib, line 218
} // library marker kkossev.onOffLib, line 219
int value = zigbee.convertHexToInt(it.value) // library marker kkossev.onOffLib, line 220
switch (it.attrId) { // library marker kkossev.onOffLib, line 221
case '4000' : // non-Tuya GlobalSceneControl (bool), read-only // library marker kkossev.onOffLib, line 222
attrName = 'Global Scene Control' // library marker kkossev.onOffLib, line 223
mode = value == 0 ? 'off' : value == 1 ? 'on' : null // library marker kkossev.onOffLib, line 224
break // library marker kkossev.onOffLib, line 225
case '4001' : // non-Tuya OnTime (UINT16), read-only // library marker kkossev.onOffLib, line 226
attrName = 'On Time' // library marker kkossev.onOffLib, line 227
mode = value // library marker kkossev.onOffLib, line 228
break // library marker kkossev.onOffLib, line 229
case '4002' : // non-Tuya OffWaitTime (UINT16), read-only // library marker kkossev.onOffLib, line 230
attrName = 'Off Wait Time' // library marker kkossev.onOffLib, line 231
mode = value // library marker kkossev.onOffLib, line 232
break // library marker kkossev.onOffLib, line 233
case '4003' : // non-Tuya "powerOnState" (ENUM8), read-write, default=1 // library marker kkossev.onOffLib, line 234
attrName = 'Power On State' // library marker kkossev.onOffLib, line 235
mode = value == 0 ? 'off' : value == 1 ? 'on' : value == 2 ? 'Last state' : 'UNKNOWN' // library marker kkossev.onOffLib, line 236
break // library marker kkossev.onOffLib, line 237
case '8000' : // command "childLock", [[name:"Child Lock", type: "ENUM", description: "Select Child Lock mode", constraints: ["off", "on"]]] // library marker kkossev.onOffLib, line 238
attrName = 'Child Lock' // library marker kkossev.onOffLib, line 239
mode = value == 0 ? 'off' : 'on' // library marker kkossev.onOffLib, line 240
break // library marker kkossev.onOffLib, line 241
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" ]]] // library marker kkossev.onOffLib, line 242
attrName = 'LED mode' // library marker kkossev.onOffLib, line 243
if (isCircuitBreaker()) { // library marker kkossev.onOffLib, line 244
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 // library marker kkossev.onOffLib, line 245
} // library marker kkossev.onOffLib, line 246
else { // library marker kkossev.onOffLib, line 247
mode = value == 0 ? 'Disabled' : value == 1 ? 'Lit when On' : value == 2 ? 'Lit when Off' : value == 3 ? 'Freeze' : null // library marker kkossev.onOffLib, line 248
} // library marker kkossev.onOffLib, line 249
break // library marker kkossev.onOffLib, line 250
case '8002' : // command "powerOnState", [[name:"Power On State", type: "ENUM", description: "Select Power On State", constraints: ["off","on", "Last state"]]] // library marker kkossev.onOffLib, line 251
attrName = 'Power On State' // library marker kkossev.onOffLib, line 252
mode = value == 0 ? 'off' : value == 1 ? 'on' : value == 2 ? 'Last state' : null // library marker kkossev.onOffLib, line 253
break // library marker kkossev.onOffLib, line 254
case '8003' : // Over current alarm // library marker kkossev.onOffLib, line 255
attrName = 'Over current alarm' // library marker kkossev.onOffLib, line 256
mode = value == 0 ? 'Over Current OK' : value == 1 ? 'Over Current Alarm' : null // library marker kkossev.onOffLib, line 257
break // library marker kkossev.onOffLib, line 258
default : // library marker kkossev.onOffLib, line 259
logWarn "Unprocessed Tuya OnOff attribute ${it.attrId} cluster ${it.cluster } reported: value=${it.value}" // library marker kkossev.onOffLib, line 260
return // library marker kkossev.onOffLib, line 261
} // library marker kkossev.onOffLib, line 262
if (settings?.logEnable) { logInfo "${attrName} is ${mode}" } // library marker kkossev.onOffLib, line 263
} // library marker kkossev.onOffLib, line 264
List onOffRefresh() { // library marker kkossev.onOffLib, line 266
logDebug 'onOffRefresh()' // library marker kkossev.onOffLib, line 267
List cmds = zigbee.readAttribute(0x0006, 0x0000, [:], delay = 100) // library marker kkossev.onOffLib, line 268
return cmds // library marker kkossev.onOffLib, line 269
} // library marker kkossev.onOffLib, line 270
void onOfInitializeVars( boolean fullInit = false ) { // library marker kkossev.onOffLib, line 272
logDebug "onOfInitializeVars()... fullInit = ${fullInit}" // library marker kkossev.onOffLib, line 273
if (fullInit || settings?.ignoreDuplicated == null) { device.updateSetting('ignoreDuplicated', true) } // library marker kkossev.onOffLib, line 274
if (fullInit || settings?.alwaysOn == null) { device.updateSetting('alwaysOn', false) } // library marker kkossev.onOffLib, line 275
if ((fullInit || settings?.threeStateEnable == null) && _THREE_STATE == true) { device.updateSetting('threeStateEnable', false) } // library marker kkossev.onOffLib, line 276
} // library marker kkossev.onOffLib, line 277
// ~~~~~ end include (176) kkossev.onOffLib ~~~~~
// ~~~~~ start include (171) kkossev.batteryLib ~~~~~
/* groovylint-disable CompileStatic, CouldBeSwitchStatement, DuplicateListLiteral, DuplicateNumberLiteral, DuplicateStringLiteral, ImplicitClosureParameter, ImplicitReturnStatement, Instanceof, LineLength, MethodCount, MethodSize, NoDouble, NoFloat, NoJavaUtilDate, NoWildcardImports, ParameterCount, ParameterName, PublicMethodsBeforeNonPublicMethods, UnnecessaryElseStatement, UnnecessaryGetter, UnnecessaryObjectReferences, UnnecessaryPublicModifier, UnnecessarySetter, UnusedImport */ // library marker kkossev.batteryLib, line 1
library( // library marker kkossev.batteryLib, line 2
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Zigbee Battery Library', name: 'batteryLib', namespace: 'kkossev', // library marker kkossev.batteryLib, line 3
importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/refs/heads/development/Libraries/batteryLib.groovy', documentationLink: 'https://github.com/kkossev/Hubitat/wiki/libraries-batteryLib', // library marker kkossev.batteryLib, line 4
version: '3.2.3' // library marker kkossev.batteryLib, line 5
) // library marker kkossev.batteryLib, line 6
/* // library marker kkossev.batteryLib, line 7
* Zigbee Battery Library // library marker kkossev.batteryLib, line 8
* // library marker kkossev.batteryLib, line 9
* Licensed Virtual the Apache License, Version 2.0 // library marker kkossev.batteryLib, line 10
* // library marker kkossev.batteryLib, line 11
* ver. 3.0.0 2024-04-06 kkossev - added batteryLib.groovy // library marker kkossev.batteryLib, line 12
* ver. 3.0.1 2024-04-06 kkossev - customParsePowerCluster bug fix // library marker kkossev.batteryLib, line 13
* ver. 3.0.2 2024-04-14 kkossev - batteryPercentage bug fix (was x2); added bVoltCtr; added battertRefresh // library marker kkossev.batteryLib, line 14
* ver. 3.2.0 2024-05-21 kkossev - commonLib 3.2.0 allignment; added lastBattery; added handleTuyaBatteryLevel // library marker kkossev.batteryLib, line 15
* ver. 3.2.1 2024-07-06 kkossev - added tuyaToBatteryLevel and handleTuyaBatteryLevel; added batteryInitializeVars // library marker kkossev.batteryLib, line 16
* ver. 3.2.2 2024-07-18 kkossev - added BatteryVoltage and BatteryDelay device capability checks // library marker kkossev.batteryLib, line 17
* ver. 3.2.3 2025-07-13 kkossev - bug fix: corrected runIn method name from 'sendDelayedBatteryEvent' to 'sendDelayedBatteryPercentageEvent' // library marker kkossev.batteryLib, line 18
* // library marker kkossev.batteryLib, line 19
* TODO: add an Advanced Option resetBatteryToZeroWhenOffline // library marker kkossev.batteryLib, line 20
* TODO: battery voltage low/high limits configuration // library marker kkossev.batteryLib, line 21
*/ // library marker kkossev.batteryLib, line 22
static String batteryLibVersion() { '3.2.3' } // library marker kkossev.batteryLib, line 24
static String batteryLibStamp() { '2025/07/13 7:45 PM' } // library marker kkossev.batteryLib, line 25
metadata { // library marker kkossev.batteryLib, line 27
capability 'Battery' // library marker kkossev.batteryLib, line 28
attribute 'batteryVoltage', 'number' // library marker kkossev.batteryLib, line 29
attribute 'lastBattery', 'date' // last battery event time - added in 3.2.0 05/21/2024 // library marker kkossev.batteryLib, line 30
// no commands // library marker kkossev.batteryLib, line 31
preferences { // library marker kkossev.batteryLib, line 32
if (device && advancedOptions == true) { // library marker kkossev.batteryLib, line 33
if ('BatteryVoltage' in DEVICE?.capabilities) { // library marker kkossev.batteryLib, line 34
input name: 'voltageToPercent', type: 'bool', title: 'Battery Voltage to Percentage', defaultValue: false, description: 'Convert battery voltage to battery Percentage remaining.' // library marker kkossev.batteryLib, line 35
} // library marker kkossev.batteryLib, line 36
if ('BatteryDelay' in DEVICE?.capabilities) { // library marker kkossev.batteryLib, line 37
input(name: 'batteryDelay', type: 'enum', title: 'Battery Events Delay', description:'Select the Battery Events Delay
(default is no delay)', options: DelayBatteryOpts.options, defaultValue: DelayBatteryOpts.defaultValue) // library marker kkossev.batteryLib, line 38
} // library marker kkossev.batteryLib, line 39
} // library marker kkossev.batteryLib, line 40
} // library marker kkossev.batteryLib, line 41
} // library marker kkossev.batteryLib, line 42
@Field static final Map DelayBatteryOpts = [ defaultValue: 0, options: [0: 'No delay', 30: '30 seconds', 3600: '1 hour', 14400: '4 hours', 28800: '8 hours', 43200: '12 hours']] // library marker kkossev.batteryLib, line 44
public void standardParsePowerCluster(final Map descMap) { // library marker kkossev.batteryLib, line 46
if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value // library marker kkossev.batteryLib, line 47
final int rawValue = hexStrToUnsignedInt(descMap.value) // library marker kkossev.batteryLib, line 48
if (descMap.attrId == '0020') { // battery voltage // library marker kkossev.batteryLib, line 49
state.lastRx['batteryTime'] = new Date().getTime() // library marker kkossev.batteryLib, line 50
state.stats['bVoltCtr'] = (state.stats['bVoltCtr'] ?: 0) + 1 // library marker kkossev.batteryLib, line 51
sendBatteryVoltageEvent(rawValue) // library marker kkossev.batteryLib, line 52
if ((settings.voltageToPercent ?: false) == true) { // library marker kkossev.batteryLib, line 53
sendBatteryVoltageEvent(rawValue, convertToPercent = true) // library marker kkossev.batteryLib, line 54
} // library marker kkossev.batteryLib, line 55
} // library marker kkossev.batteryLib, line 56
else if (descMap.attrId == '0021') { // battery percentage // library marker kkossev.batteryLib, line 57
state.lastRx['batteryTime'] = new Date().getTime() // library marker kkossev.batteryLib, line 58
state.stats['battCtr'] = (state.stats['battCtr'] ?: 0) + 1 // library marker kkossev.batteryLib, line 59
if (isTuya()) { // library marker kkossev.batteryLib, line 60
sendBatteryPercentageEvent(rawValue) // library marker kkossev.batteryLib, line 61
} // library marker kkossev.batteryLib, line 62
else { // library marker kkossev.batteryLib, line 63
sendBatteryPercentageEvent((rawValue / 2) as int) // library marker kkossev.batteryLib, line 64
} // library marker kkossev.batteryLib, line 65
} // library marker kkossev.batteryLib, line 66
else { // library marker kkossev.batteryLib, line 67
logWarn "customParsePowerCluster: zigbee received unknown Power cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.batteryLib, line 68
} // library marker kkossev.batteryLib, line 69
} // library marker kkossev.batteryLib, line 70
public void sendBatteryVoltageEvent(final int rawValue, boolean convertToPercent=false) { // library marker kkossev.batteryLib, line 72
logDebug "batteryVoltage = ${(double)rawValue / 10.0} V" // library marker kkossev.batteryLib, line 73
final Date lastBattery = new Date() // library marker kkossev.batteryLib, line 74
Map result = [:] // library marker kkossev.batteryLib, line 75
BigDecimal volts = safeToBigDecimal(rawValue) / 10G // library marker kkossev.batteryLib, line 76
if (rawValue != 0 && rawValue != 255) { // library marker kkossev.batteryLib, line 77
BigDecimal minVolts = 2.2 // library marker kkossev.batteryLib, line 78
BigDecimal maxVolts = 3.2 // library marker kkossev.batteryLib, line 79
BigDecimal pct = (volts - minVolts) / (maxVolts - minVolts) // library marker kkossev.batteryLib, line 80
int roundedPct = Math.round(pct * 100) // library marker kkossev.batteryLib, line 81
if (roundedPct <= 0) { roundedPct = 1 } // library marker kkossev.batteryLib, line 82
if (roundedPct > 100) { roundedPct = 100 } // library marker kkossev.batteryLib, line 83
if (convertToPercent == true) { // library marker kkossev.batteryLib, line 84
result.value = Math.min(100, roundedPct) // library marker kkossev.batteryLib, line 85
result.name = 'battery' // library marker kkossev.batteryLib, line 86
result.unit = '%' // library marker kkossev.batteryLib, line 87
result.descriptionText = "battery is ${roundedPct} %" // library marker kkossev.batteryLib, line 88
} // library marker kkossev.batteryLib, line 89
else { // library marker kkossev.batteryLib, line 90
result.value = volts // library marker kkossev.batteryLib, line 91
result.name = 'batteryVoltage' // library marker kkossev.batteryLib, line 92
result.unit = 'V' // library marker kkossev.batteryLib, line 93
result.descriptionText = "battery is ${volts} Volts" // library marker kkossev.batteryLib, line 94
} // library marker kkossev.batteryLib, line 95
result.type = 'physical' // library marker kkossev.batteryLib, line 96
result.isStateChange = true // library marker kkossev.batteryLib, line 97
logInfo "${result.descriptionText}" // library marker kkossev.batteryLib, line 98
sendEvent(result) // library marker kkossev.batteryLib, line 99
sendEvent(name: 'lastBattery', value: lastBattery) // library marker kkossev.batteryLib, line 100
} // library marker kkossev.batteryLib, line 101
else { // library marker kkossev.batteryLib, line 102
logWarn "ignoring BatteryResult(${rawValue})" // library marker kkossev.batteryLib, line 103
} // library marker kkossev.batteryLib, line 104
} // library marker kkossev.batteryLib, line 105
public void sendBatteryPercentageEvent(final int batteryPercent, boolean isDigital=false) { // library marker kkossev.batteryLib, line 107
if ((batteryPercent as int) == 255) { // library marker kkossev.batteryLib, line 108
logWarn "ignoring battery report raw=${batteryPercent}" // library marker kkossev.batteryLib, line 109
return // library marker kkossev.batteryLib, line 110
} // library marker kkossev.batteryLib, line 111
final Date lastBattery = new Date() // library marker kkossev.batteryLib, line 112
Map map = [:] // library marker kkossev.batteryLib, line 113
map.name = 'battery' // library marker kkossev.batteryLib, line 114
map.timeStamp = now() // library marker kkossev.batteryLib, line 115
map.value = batteryPercent < 0 ? 0 : batteryPercent > 100 ? 100 : (batteryPercent as int) // library marker kkossev.batteryLib, line 116
map.unit = '%' // library marker kkossev.batteryLib, line 117
map.type = isDigital ? 'digital' : 'physical' // library marker kkossev.batteryLib, line 118
map.descriptionText = "${map.name} is ${map.value} ${map.unit}" // library marker kkossev.batteryLib, line 119
map.isStateChange = true // library marker kkossev.batteryLib, line 120
// // library marker kkossev.batteryLib, line 121
Object latestBatteryEvent = device.currentState('battery') // library marker kkossev.batteryLib, line 122
Long latestBatteryEventTime = latestBatteryEvent != null ? latestBatteryEvent.getDate().getTime() : now() // library marker kkossev.batteryLib, line 123
//log.debug "battery latest state timeStamp is ${latestBatteryTime} now is ${now()}" // library marker kkossev.batteryLib, line 124
int timeDiff = ((now() - latestBatteryEventTime) / 1000) as int // library marker kkossev.batteryLib, line 125
if (settings?.batteryDelay == null || (settings?.batteryDelay as int) == 0 || timeDiff > (settings?.batteryDelay as int)) { // library marker kkossev.batteryLib, line 126
// send it now! // library marker kkossev.batteryLib, line 127
sendDelayedBatteryPercentageEvent(map) // library marker kkossev.batteryLib, line 128
sendEvent(name: 'lastBattery', value: lastBattery) // library marker kkossev.batteryLib, line 129
} // library marker kkossev.batteryLib, line 130
else { // library marker kkossev.batteryLib, line 131
int delayedTime = (settings?.batteryDelay as int) - timeDiff // library marker kkossev.batteryLib, line 132
map.delayed = delayedTime // library marker kkossev.batteryLib, line 133
map.descriptionText += " [delayed ${map.delayed} seconds]" // library marker kkossev.batteryLib, line 134
map.lastBattery = lastBattery // library marker kkossev.batteryLib, line 135
logDebug "this battery event (${map.value}%) will be delayed ${delayedTime} seconds" // library marker kkossev.batteryLib, line 136
runIn(delayedTime, 'sendDelayedBatteryPercentageEvent', [overwrite: true, data: map]) // library marker kkossev.batteryLib, line 137
} // library marker kkossev.batteryLib, line 138
} // library marker kkossev.batteryLib, line 139
private void sendDelayedBatteryPercentageEvent(Map map) { // library marker kkossev.batteryLib, line 141
logInfo "${map.descriptionText}" // library marker kkossev.batteryLib, line 142
//map.each {log.trace "$it"} // library marker kkossev.batteryLib, line 143
sendEvent(map) // library marker kkossev.batteryLib, line 144
sendEvent(name: 'lastBattery', value: map.lastBattery) // library marker kkossev.batteryLib, line 145
} // library marker kkossev.batteryLib, line 146
/* groovylint-disable-next-line UnusedPrivateMethod */ // library marker kkossev.batteryLib, line 148
private void sendDelayedBatteryVoltageEvent(Map map) { // library marker kkossev.batteryLib, line 149
logInfo "${map.descriptionText}" // library marker kkossev.batteryLib, line 150
//map.each {log.trace "$it"} // library marker kkossev.batteryLib, line 151
sendEvent(map) // library marker kkossev.batteryLib, line 152
sendEvent(name: 'lastBattery', value: map.lastBattery) // library marker kkossev.batteryLib, line 153
} // library marker kkossev.batteryLib, line 154
public int tuyaToBatteryLevel(int fncmd) { // library marker kkossev.batteryLib, line 156
int rawValue = fncmd // library marker kkossev.batteryLib, line 157
switch (fncmd) { // library marker kkossev.batteryLib, line 158
case 0: rawValue = 100; break // Battery Full // library marker kkossev.batteryLib, line 159
case 1: rawValue = 75; break // Battery High // library marker kkossev.batteryLib, line 160
case 2: rawValue = 50; break // Battery Medium // library marker kkossev.batteryLib, line 161
case 3: rawValue = 25; break // Battery Low // library marker kkossev.batteryLib, line 162
case 4: rawValue = 100; break // Tuya 3 in 1 -> USB powered // library marker kkossev.batteryLib, line 163
// for all other values >4 we will use the raw value, expected to be the real battery level 4..100% // library marker kkossev.batteryLib, line 164
} // library marker kkossev.batteryLib, line 165
return rawValue // library marker kkossev.batteryLib, line 166
} // library marker kkossev.batteryLib, line 167
public void handleTuyaBatteryLevel(int fncmd) { // library marker kkossev.batteryLib, line 169
int rawValue = tuyaToBatteryLevel(fncmd) // library marker kkossev.batteryLib, line 170
sendBatteryPercentageEvent(rawValue) // library marker kkossev.batteryLib, line 171
} // library marker kkossev.batteryLib, line 172
public void batteryInitializeVars( boolean fullInit = false ) { // library marker kkossev.batteryLib, line 174
logDebug "batteryInitializeVars()... fullInit = ${fullInit}" // library marker kkossev.batteryLib, line 175
if (device.hasCapability('Battery')) { // library marker kkossev.batteryLib, line 176
if (fullInit || settings?.voltageToPercent == null) { device.updateSetting('voltageToPercent', false) } // library marker kkossev.batteryLib, line 177
if (fullInit || settings?.batteryDelay == null) { device.updateSetting('batteryDelay', [value: DelayBatteryOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.batteryLib, line 178
} // library marker kkossev.batteryLib, line 179
} // library marker kkossev.batteryLib, line 180
public List batteryRefresh() { // library marker kkossev.batteryLib, line 182
List cmds = [] // library marker kkossev.batteryLib, line 183
cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay = 100) // battery voltage // library marker kkossev.batteryLib, line 184
cmds += zigbee.readAttribute(0x0001, 0x0021, [:], delay = 100) // battery percentage // library marker kkossev.batteryLib, line 185
return cmds // library marker kkossev.batteryLib, line 186
} // library marker kkossev.batteryLib, line 187
// ~~~~~ end include (171) kkossev.batteryLib ~~~~~
// ~~~~~ start include (172) kkossev.temperatureLib ~~~~~
/* groovylint-disable CompileStatic, CouldBeSwitchStatement, DuplicateListLiteral, DuplicateNumberLiteral, DuplicateStringLiteral, ImplicitClosureParameter, ImplicitReturnStatement, Instanceof, LineLength, MethodCount, MethodSize, NoDouble, NoFloat, NoWildcardImports, ParameterCount, ParameterName, PublicMethodsBeforeNonPublicMethods, UnnecessaryElseStatement, UnnecessaryGetter, UnnecessaryObjectReferences, UnnecessaryPublicModifier, UnnecessarySetter, UnusedImport */ // library marker kkossev.temperatureLib, line 1
library( // library marker kkossev.temperatureLib, line 2
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Zigbee Temperature Library', name: 'temperatureLib', namespace: 'kkossev', // library marker kkossev.temperatureLib, line 3
importUrl: 'https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/temperatureLib.groovy', documentationLink: '', // library marker kkossev.temperatureLib, line 4
version: '3.3.1' // library marker kkossev.temperatureLib, line 5
) // library marker kkossev.temperatureLib, line 6
/* // library marker kkossev.temperatureLib, line 7
* Zigbee Temperature Library // library marker kkossev.temperatureLib, line 8
* // library marker kkossev.temperatureLib, line 9
* Licensed Virtual the Apache License, Version 2.0 // library marker kkossev.temperatureLib, line 10
* // library marker kkossev.temperatureLib, line 11
* ver. 3.0.0 2024-04-06 kkossev - added temperatureLib.groovy // library marker kkossev.temperatureLib, line 12
* ver. 3.0.1 2024-04-19 kkossev - temperature rounding fix // library marker kkossev.temperatureLib, line 13
* ver. 3.2.0 2024-05-28 kkossev - commonLib 3.2.0 allignment; added temperatureRefresh() // library marker kkossev.temperatureLib, line 14
* ver. 3.2.1 2024-06-07 kkossev - excluded maxReportingTime for mmWaveSensor and Thermostat // library marker kkossev.temperatureLib, line 15
* ver. 3.2.2 2024-07-06 kkossev - fixed T/H clusters attribute different than 0 (temperature, humidity MeasuredValue) bug // library marker kkossev.temperatureLib, line 16
* ver. 3.2.3 2024-07-18 kkossev - added 'ReportingConfiguration' capability check for minReportingTime and maxReportingTime // library marker kkossev.temperatureLib, line 17
* ver. 3.3.0 2025-09-15 kkossev - commonLib 4.0.0 allignment; added temperatureOffset // library marker kkossev.temperatureLib, line 18
* ver. 3.3.1 2025-10-31 kkossev - bugfix: isRefresh was not checked if temperature delta < 0.1 // library marker kkossev.temperatureLib, line 19
* // library marker kkossev.temperatureLib, line 20
* TODO: unschedule('sendDelayedTempEvent') only if needed (add boolean flag to sendDelayedTempEvent()) // library marker kkossev.temperatureLib, line 21
* TODO: check for negative temperature values in standardParseTemperatureCluster() // library marker kkossev.temperatureLib, line 22
*/ // library marker kkossev.temperatureLib, line 23
static String temperatureLibVersion() { '3.3.1' } // library marker kkossev.temperatureLib, line 25
static String temperatureLibStamp() { '2025/10/31 3:13 PM' } // library marker kkossev.temperatureLib, line 26
metadata { // library marker kkossev.temperatureLib, line 28
capability 'TemperatureMeasurement' // library marker kkossev.temperatureLib, line 29
// no commands // library marker kkossev.temperatureLib, line 30
preferences { // library marker kkossev.temperatureLib, line 31
if (device && advancedOptions == true) { // library marker kkossev.temperatureLib, line 32
if ('ReportingConfiguration' in DEVICE?.capabilities) { // library marker kkossev.temperatureLib, line 33
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 // library marker kkossev.temperatureLib, line 34
if (!(deviceType in ['mmWaveSensor', 'Thermostat', 'TRV'])) { // library marker kkossev.temperatureLib, line 35
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 // library marker kkossev.temperatureLib, line 36
} // library marker kkossev.temperatureLib, line 37
} // library marker kkossev.temperatureLib, line 38
} // library marker kkossev.temperatureLib, line 39
input name: 'temperatureOffset', type: 'decimal', title: 'Temperature Offset', description: 'Adjust temperature by this many degrees', range: '-100..100', defaultValue: 0 // library marker kkossev.temperatureLib, line 40
} // library marker kkossev.temperatureLib, line 41
} // library marker kkossev.temperatureLib, line 42
void standardParseTemperatureCluster(final Map descMap) { // library marker kkossev.temperatureLib, line 44
if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value // library marker kkossev.temperatureLib, line 45
if (descMap.attrId == '0000') { // library marker kkossev.temperatureLib, line 46
int value = hexStrToSignedInt(descMap.value) // library marker kkossev.temperatureLib, line 47
handleTemperatureEvent(value / 100.0F as BigDecimal) // library marker kkossev.temperatureLib, line 48
} // library marker kkossev.temperatureLib, line 49
else { // library marker kkossev.temperatureLib, line 50
logWarn "standardParseTemperatureCluster() - unknown attribute ${descMap.attrId} value=${descMap.value}" // library marker kkossev.temperatureLib, line 51
} // library marker kkossev.temperatureLib, line 52
} // library marker kkossev.temperatureLib, line 53
void handleTemperatureEvent(BigDecimal temperaturePar, boolean isDigital=false) { // library marker kkossev.temperatureLib, line 55
Map eventMap = [:] // library marker kkossev.temperatureLib, line 56
BigDecimal temperature = safeToBigDecimal(temperaturePar).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 57
if (state.stats != null) { state.stats['tempCtr'] = (state.stats['tempCtr'] ?: 0) + 1 } else { state.stats = [:] } // library marker kkossev.temperatureLib, line 58
eventMap.name = 'temperature' // library marker kkossev.temperatureLib, line 59
if (location.temperatureScale == 'F') { // library marker kkossev.temperatureLib, line 60
temperature = ((temperature * 1.8) + 32).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 61
eventMap.unit = '\u00B0F' // library marker kkossev.temperatureLib, line 62
} // library marker kkossev.temperatureLib, line 63
else { // library marker kkossev.temperatureLib, line 64
eventMap.unit = '\u00B0C' // library marker kkossev.temperatureLib, line 65
} // library marker kkossev.temperatureLib, line 66
BigDecimal tempCorrected = (temperature + safeToBigDecimal(settings?.temperatureOffset ?: 0)).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 67
eventMap.value = tempCorrected.setScale(1, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 68
BigDecimal lastTemp = device.currentValue('temperature') ?: 0 // library marker kkossev.temperatureLib, line 69
logTrace "lastTemp=${lastTemp} tempCorrected=${tempCorrected} delta=${Math.abs(lastTemp - tempCorrected)}" // library marker kkossev.temperatureLib, line 70
boolean isRefresh = state.states['isRefresh'] == true // library marker kkossev.temperatureLib, line 72
if (!isRefresh && Math.abs(lastTemp - tempCorrected) < 0.1) { // library marker kkossev.temperatureLib, line 74
logDebug "skipped temperature ${tempCorrected}, less than delta 0.1 (lastTemp=${lastTemp})" // library marker kkossev.temperatureLib, line 75
return // library marker kkossev.temperatureLib, line 76
} // library marker kkossev.temperatureLib, line 77
eventMap.type = isDigital == true ? 'digital' : 'physical' // library marker kkossev.temperatureLib, line 78
eventMap.descriptionText = "${eventMap.name} is ${eventMap.value} ${eventMap.unit}" // library marker kkossev.temperatureLib, line 79
if (isRefresh) { // library marker kkossev.temperatureLib, line 80
eventMap.descriptionText += ' [refresh]' // library marker kkossev.temperatureLib, line 81
eventMap.isStateChange = true // library marker kkossev.temperatureLib, line 82
} // library marker kkossev.temperatureLib, line 83
Integer timeElapsed = Math.round((now() - (state.lastRx['tempTime'] ?: now())) / 1000) // library marker kkossev.temperatureLib, line 84
Integer minTime = settings?.minReportingTime ?: DEFAULT_MIN_REPORTING_TIME // library marker kkossev.temperatureLib, line 85
Integer timeRamaining = (minTime - timeElapsed) as Integer // library marker kkossev.temperatureLib, line 86
if (timeElapsed >= minTime) { // library marker kkossev.temperatureLib, line 87
logInfo "${eventMap.descriptionText}" // library marker kkossev.temperatureLib, line 88
unschedule('sendDelayedTempEvent') //get rid of stale queued reports // library marker kkossev.temperatureLib, line 89
state.lastRx['tempTime'] = now() // library marker kkossev.temperatureLib, line 90
sendEvent(eventMap) // library marker kkossev.temperatureLib, line 91
} // library marker kkossev.temperatureLib, line 92
else { // queue the event // library marker kkossev.temperatureLib, line 93
eventMap.type = 'delayed' // library marker kkossev.temperatureLib, line 94
logDebug "${device.displayName} DELAYING ${timeRamaining} seconds event : ${eventMap}" // library marker kkossev.temperatureLib, line 95
runIn(timeRamaining, 'sendDelayedTempEvent', [overwrite: true, data: eventMap]) // library marker kkossev.temperatureLib, line 96
} // library marker kkossev.temperatureLib, line 97
} // library marker kkossev.temperatureLib, line 98
void sendDelayedTempEvent(Map eventMap) { // library marker kkossev.temperatureLib, line 100
logInfo "${eventMap.descriptionText} (${eventMap.type})" // library marker kkossev.temperatureLib, line 101
state.lastRx['tempTime'] = now() // TODO - -(minReportingTimeHumidity * 2000) // library marker kkossev.temperatureLib, line 102
sendEvent(eventMap) // library marker kkossev.temperatureLib, line 103
} // library marker kkossev.temperatureLib, line 104
List temperatureLibInitializeDevice() { // library marker kkossev.temperatureLib, line 106
List cmds = [] // library marker kkossev.temperatureLib, line 107
cmds += zigbee.configureReporting(zigbee.TEMPERATURE_MEASUREMENT_CLUSTER, 0 /*TEMPERATURE_MEASUREMENT_MEASURED_VALUE_ATTRIBUTE*/, DataType.INT16, 15, 300, 100 /* 100=0.1도*/) // 402 - temperature // library marker kkossev.temperatureLib, line 108
logDebug "temperatureLibInitializeDevice() cmds=${cmds}" // library marker kkossev.temperatureLib, line 109
return cmds // library marker kkossev.temperatureLib, line 110
} // library marker kkossev.temperatureLib, line 111
List temperatureRefresh() { // library marker kkossev.temperatureLib, line 113
List cmds = [] // library marker kkossev.temperatureLib, line 114
cmds += zigbee.readAttribute(0x0402, 0x0000, [:], delay = 200) // library marker kkossev.temperatureLib, line 115
return cmds // library marker kkossev.temperatureLib, line 116
} // library marker kkossev.temperatureLib, line 117
// ~~~~~ end include (172) kkossev.temperatureLib ~~~~~
// ~~~~~ start include (142) kkossev.deviceProfileLib ~~~~~
library( // library marker kkossev.deviceProfileLib, line 1
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Device Profile Library', name: 'deviceProfileLib', namespace: 'kkossev', // library marker kkossev.deviceProfileLib, line 2
importUrl: 'https://raw.githubusercontent.com/kkossev/Hubitat/refs/heads/development/Libraries/deviceProfileLib.groovy', documentationLink: 'https://github.com/kkossev/Hubitat/wiki/libraries-deviceProfileLib', // library marker kkossev.deviceProfileLib, line 3
version: '3.5.4' // library marker kkossev.deviceProfileLib, line 4
) // library marker kkossev.deviceProfileLib, line 5
/* // library marker kkossev.deviceProfileLib, line 6
* Device Profile Library (V3) // library marker kkossev.deviceProfileLib, line 7
* // library marker kkossev.deviceProfileLib, line 8
* Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.deviceProfileLib, line 9
* in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.deviceProfileLib, line 10
* // library marker kkossev.deviceProfileLib, line 11
* http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.deviceProfileLib, line 12
* // library marker kkossev.deviceProfileLib, line 13
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.deviceProfileLib, line 14
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.deviceProfileLib, line 15
* for the specific language governing permissions and limitations under the License. // library marker kkossev.deviceProfileLib, line 16
* // library marker kkossev.deviceProfileLib, line 17
* ver. 1.0.0 2023-11-04 kkossev - added deviceProfileLib (based on Tuya 4 In 1 driver) // library marker kkossev.deviceProfileLib, line 18
* ver. 3.0.0 2023-11-27 kkossev - fixes for use with commonLib; added processClusterAttributeFromDeviceProfile() method; added validateAndFixPreferences() method; inputIt bug fix; signedInt Preproc method; // library marker kkossev.deviceProfileLib, line 19
* ver. 3.0.1 2023-12-02 kkossev - release candidate // library marker kkossev.deviceProfileLib, line 20
* ver. 3.0.2 2023-12-17 kkossev - inputIt moved to the preferences section; setfunction replaced by customSetFunction; Groovy Linting; // library marker kkossev.deviceProfileLib, line 21
* ver. 3.0.4 2024-03-30 kkossev - more Groovy Linting; processClusterAttributeFromDeviceProfile exception fix; // library marker kkossev.deviceProfileLib, line 22
* ver. 3.1.0 2024-04-03 kkossev - more Groovy Linting; deviceProfilesV3, enum pars bug fix; // library marker kkossev.deviceProfileLib, line 23
* ver. 3.1.1 2024-04-21 kkossev - deviceProfilesV3 bug fix; tuyaDPs list of maps bug fix; resetPreferencesToDefaults bug fix; // library marker kkossev.deviceProfileLib, line 24
* ver. 3.1.2 2024-05-05 kkossev - added isSpammyDeviceProfile() // library marker kkossev.deviceProfileLib, line 25
* ver. 3.1.3 2024-05-21 kkossev - skip processClusterAttributeFromDeviceProfile if cluster or attribute or value is missing // library marker kkossev.deviceProfileLib, line 26
* ver. 3.2.0 2024-05-25 kkossev - commonLib 3.2.0 allignment; // library marker kkossev.deviceProfileLib, line 27
* ver. 3.2.1 2024-06-06 kkossev - Tuya Multi Sensor 4 In 1 (V3) driver allignment (customProcessDeviceProfileEvent); getDeviceProfilesMap bug fix; forcedProfile is always shown in preferences; // library marker kkossev.deviceProfileLib, line 28
* ver. 3.3.0 2024-06-29 kkossev - empty preferences bug fix; zclWriteAttribute delay 50 ms; added advanced check in inputIt(); fixed 'Cannot get property 'rw' on null object' bug; fixed enum attributes first event numeric value bug; // library marker kkossev.deviceProfileLib, line 29
* ver. 3.3.1 2024-07-06 kkossev - added powerSource event in the initEventsDeviceProfile // library marker kkossev.deviceProfileLib, line 30
* ver. 3.3.2 2024-08-18 kkossev - release 3.3.2 // library marker kkossev.deviceProfileLib, line 31
* ver. 3.3.3 2024-08-18 kkossev - sendCommand and setPar commands commented out; must be declared in the main driver where really needed // library marker kkossev.deviceProfileLib, line 32
* ver. 3.3.4 2024-09-28 kkossev - fixed exceptions in resetPreferencesToDefaults() and initEventsDeviceProfile() // library marker kkossev.deviceProfileLib, line 33
* ver. 3.4.0 2025-02-02 kkossev - deviceProfilesV3 optimizations (defaultFingerprint); is2in1() mod // library marker kkossev.deviceProfileLib, line 34
* ver. 3.4.1 2025-02-02 kkossev - setPar help improvements; // library marker kkossev.deviceProfileLib, line 35
* ver. 3.4.2 2025-03-24 kkossev - added refreshFromConfigureReadList() method; documentation update; getDeviceNameAndProfile uses DEVICE.description instead of deviceJoinName // library marker kkossev.deviceProfileLib, line 36
* ver. 3.4.3 2025-04-25 kkossev - HE platfrom version 2.4.1.x decimal preferences patch/workaround. // library marker kkossev.deviceProfileLib, line 37
* ver. 3.5.0 2025-08-14 kkossev - zclWriteAttribute() support for forced destinationEndpoint in the attributes map // library marker kkossev.deviceProfileLib, line 38
* ver. 3.5.1 2025-09-15 kkossev - commonLib ver 4.0.0 allignment; log.trace leftover removed; // library marker kkossev.deviceProfileLib, line 39
* ver. 3.5.2 2025-10-04 kkossev - SIMULATED_DEVICE_MODEL and SIMULATED_DEVICE_MANUFACTURER added (for testing with simulated devices) // library marker kkossev.deviceProfileLib, line 40
* ver. 3.5.3 2025-12-06 kkossev - added digital/physical type to events in customProcessDeviceProfileEvent() // library marker kkossev.deviceProfileLib, line 41
* ver. 3.5.4 2026-02-04 kkossev - changed inputIt min param rounding to floor instead of ceil // library marker kkossev.deviceProfileLib, line 42
* // library marker kkossev.deviceProfileLib, line 43
* TODO - remove the 2-in-1 patch ! // library marker kkossev.deviceProfileLib, line 44
* TODO - add updateStateUnknownDPs (from the 4-in-1 driver) // library marker kkossev.deviceProfileLib, line 45
* TODO - when [refresh], send Info logs for parameters that are not events or preferences // library marker kkossev.deviceProfileLib, line 46
* TODO: refactor sendAttribute ! sendAttribute exception bug fix for virtual devices; check if String getObjectClassName(Object o) is in 2.3.3.137, can be used? // library marker kkossev.deviceProfileLib, line 47
* TODO: add _DEBUG command (for temporary switching the debug logs on/off) // library marker kkossev.deviceProfileLib, line 48
* TODO: allow NULL parameters default values in the device profiles // library marker kkossev.deviceProfileLib, line 49
* TODO: handle preferences of a type TEXT // library marker kkossev.deviceProfileLib, line 50
* // library marker kkossev.deviceProfileLib, line 51
*/ // library marker kkossev.deviceProfileLib, line 52
static String deviceProfileLibVersion() { '3.5.4' } // library marker kkossev.deviceProfileLib, line 54
static String deviceProfileLibStamp() { '2026/02/04 8:02 AM' } // library marker kkossev.deviceProfileLib, line 55
import groovy.json.* // library marker kkossev.deviceProfileLib, line 56
import groovy.transform.Field // library marker kkossev.deviceProfileLib, line 57
import hubitat.zigbee.clusters.iaszone.ZoneStatus // library marker kkossev.deviceProfileLib, line 58
import hubitat.zigbee.zcl.DataType // library marker kkossev.deviceProfileLib, line 59
import java.util.concurrent.ConcurrentHashMap // library marker kkossev.deviceProfileLib, line 60
import groovy.transform.CompileStatic // library marker kkossev.deviceProfileLib, line 62
metadata { // library marker kkossev.deviceProfileLib, line 64
// no capabilities // library marker kkossev.deviceProfileLib, line 65
// no attributes // library marker kkossev.deviceProfileLib, line 66
/* // library marker kkossev.deviceProfileLib, line 67
// copy the following commands to the main driver, if needed // library marker kkossev.deviceProfileLib, line 68
command 'sendCommand', [ // library marker kkossev.deviceProfileLib, line 69
[name:'command', type: 'STRING', description: 'command name', constraints: ['STRING']], // library marker kkossev.deviceProfileLib, line 70
[name:'val', type: 'STRING', description: 'command parameter value', constraints: ['STRING']] // library marker kkossev.deviceProfileLib, line 71
] // library marker kkossev.deviceProfileLib, line 72
command 'setPar', [ // library marker kkossev.deviceProfileLib, line 73
[name:'par', type: 'STRING', description: 'preference parameter name', constraints: ['STRING']], // library marker kkossev.deviceProfileLib, line 74
[name:'val', type: 'STRING', description: 'preference parameter value', constraints: ['STRING']] // library marker kkossev.deviceProfileLib, line 75
] // library marker kkossev.deviceProfileLib, line 76
*/ // library marker kkossev.deviceProfileLib, line 77
preferences { // library marker kkossev.deviceProfileLib, line 78
if (device) { // library marker kkossev.deviceProfileLib, line 79
input(name: 'forcedProfile', type: 'enum', title: 'Device Profile', description: 'Manually 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 80
// itterate over DEVICE.preferences map and inputIt all // library marker kkossev.deviceProfileLib, line 81
if (DEVICE != null && DEVICE?.preferences != null && DEVICE?.preferences != [:] && DEVICE?.device?.isDepricated != true) { // library marker kkossev.deviceProfileLib, line 82
(DEVICE?.preferences).each { key, value -> // library marker kkossev.deviceProfileLib, line 83
Map inputMap = inputIt(key) // library marker kkossev.deviceProfileLib, line 84
if (inputMap != null && inputMap != [:]) { // library marker kkossev.deviceProfileLib, line 85
input inputMap // library marker kkossev.deviceProfileLib, line 86
} // library marker kkossev.deviceProfileLib, line 87
} // library marker kkossev.deviceProfileLib, line 88
} // library marker kkossev.deviceProfileLib, line 89
} // library marker kkossev.deviceProfileLib, line 90
} // library marker kkossev.deviceProfileLib, line 91
} // library marker kkossev.deviceProfileLib, line 92
private boolean is2in1() { return getDeviceProfile().startsWith('TS0601_2IN1') } // patch! // library marker kkossev.deviceProfileLib, line 94
public String getDeviceProfile() { state?.deviceProfile ?: 'UNKNOWN' } // library marker kkossev.deviceProfileLib, line 96
public Map getDEVICE() { deviceProfilesV3 != null ? deviceProfilesV3[getDeviceProfile()] : deviceProfilesV2 != null ? deviceProfilesV2[getDeviceProfile()] : [:] } // library marker kkossev.deviceProfileLib, line 97
public Set getDeviceProfiles() { deviceProfilesV3 != null ? deviceProfilesV3?.keySet() : deviceProfilesV2 != null ? deviceProfilesV2?.keySet() : [] } // library marker kkossev.deviceProfileLib, line 98
public List getDeviceProfilesMap() { // library marker kkossev.deviceProfileLib, line 100
if (deviceProfilesV3 == null) { // library marker kkossev.deviceProfileLib, line 101
if (deviceProfilesV2 == null) { return [] } // library marker kkossev.deviceProfileLib, line 102
return deviceProfilesV2.values().description as List // library marker kkossev.deviceProfileLib, line 103
} // library marker kkossev.deviceProfileLib, line 104
List activeProfiles = [] // library marker kkossev.deviceProfileLib, line 105
deviceProfilesV3.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 106
if ((profileMap.device?.isDepricated ?: false) != true) { // library marker kkossev.deviceProfileLib, line 107
activeProfiles.add(profileMap.description ?: '---') // library marker kkossev.deviceProfileLib, line 108
} // library marker kkossev.deviceProfileLib, line 109
} // library marker kkossev.deviceProfileLib, line 110
return activeProfiles // library marker kkossev.deviceProfileLib, line 111
} // library marker kkossev.deviceProfileLib, line 112
// ---------------------------------- deviceProfilesV3 helper functions -------------------------------------------- // library marker kkossev.deviceProfileLib, line 114
/** // library marker kkossev.deviceProfileLib, line 116
* Returns the profile key for a given profile description. // library marker kkossev.deviceProfileLib, line 117
* @param valueStr The profile description to search for. // library marker kkossev.deviceProfileLib, line 118
* @return The profile key if found, otherwise null. // library marker kkossev.deviceProfileLib, line 119
*/ // library marker kkossev.deviceProfileLib, line 120
public String getProfileKey(final String valueStr) { // library marker kkossev.deviceProfileLib, line 121
if (deviceProfilesV3 != null) { return deviceProfilesV3.find { _, profileMap -> profileMap.description == valueStr }?.key } // library marker kkossev.deviceProfileLib, line 122
else if (deviceProfilesV2 != null) { return deviceProfilesV2.find { _, profileMap -> profileMap.description == valueStr }?.key } // library marker kkossev.deviceProfileLib, line 123
else { return null } // library marker kkossev.deviceProfileLib, line 124
} // library marker kkossev.deviceProfileLib, line 125
/** // library marker kkossev.deviceProfileLib, line 127
* Finds the preferences map for the given parameter. // library marker kkossev.deviceProfileLib, line 128
* @param param The parameter to find the preferences map for. // library marker kkossev.deviceProfileLib, line 129
* @param debug Whether or not to output debug logs. // library marker kkossev.deviceProfileLib, line 130
* @return returns either tuyaDPs or attributes map, depending on where the preference (param) is found // library marker kkossev.deviceProfileLib, line 131
* @return empty map [:] if param is not defined for this device. // library marker kkossev.deviceProfileLib, line 132
*/ // library marker kkossev.deviceProfileLib, line 133
private Map getPreferencesMapByName(final String param, boolean debug=false) { // library marker kkossev.deviceProfileLib, line 134
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 135
if (!(param in DEVICE?.preferences)) { if (debug) { log.warn "getPreferencesMapByName: preference ${param} not defined for this device!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 136
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 137
def preference // library marker kkossev.deviceProfileLib, line 138
try { // library marker kkossev.deviceProfileLib, line 139
preference = DEVICE?.preferences["$param"] // library marker kkossev.deviceProfileLib, line 140
if (debug) { log.debug "getPreferencesMapByName: preference ${param} found. value is ${preference}" } // library marker kkossev.deviceProfileLib, line 141
if (preference in [true, false]) { // library marker kkossev.deviceProfileLib, line 142
// find the preference in the tuyaDPs map // library marker kkossev.deviceProfileLib, line 143
logDebug "getPreferencesMapByName: preference ${param} is boolean" // library marker kkossev.deviceProfileLib, line 144
return [:] // no maps for predefined preferences ! // library marker kkossev.deviceProfileLib, line 145
} // library marker kkossev.deviceProfileLib, line 146
if (safeToInt(preference, -1) > 0) { //if (preference instanceof Number) { // library marker kkossev.deviceProfileLib, line 147
int dp = safeToInt(preference) // library marker kkossev.deviceProfileLib, line 148
//if (debug) log.trace "getPreferencesMapByName: param ${param} preference ${preference} is number (${dp})" // library marker kkossev.deviceProfileLib, line 149
foundMap = DEVICE?.tuyaDPs.find { it.dp == dp } // library marker kkossev.deviceProfileLib, line 150
} // library marker kkossev.deviceProfileLib, line 151
else { // cluster:attribute // library marker kkossev.deviceProfileLib, line 152
//if (debug) { log.trace "${DEVICE?.attributes}" } // library marker kkossev.deviceProfileLib, line 153
foundMap = DEVICE?.attributes.find { it.at == preference } // library marker kkossev.deviceProfileLib, line 154
} // library marker kkossev.deviceProfileLib, line 155
// TODO - could be also 'true' or 'false' ... // library marker kkossev.deviceProfileLib, line 156
} catch (e) { // library marker kkossev.deviceProfileLib, line 157
if (debug) { log.warn "getPreferencesMapByName: exception ${e} caught when getting preference ${param} !" } // library marker kkossev.deviceProfileLib, line 158
return [:] // library marker kkossev.deviceProfileLib, line 159
} // library marker kkossev.deviceProfileLib, line 160
if (debug) { log.debug "getPreferencesMapByName: foundMap = ${foundMap}" } // library marker kkossev.deviceProfileLib, line 161
return foundMap // library marker kkossev.deviceProfileLib, line 162
} // library marker kkossev.deviceProfileLib, line 163
public Map getAttributesMap(String attribName, boolean debug=false) { // library marker kkossev.deviceProfileLib, line 165
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 166
List'], // library marker kkossev.deviceProfileLib, line 208
if (parMap?.defVal == null) { logDebug "no default value for preference ${parName} !" ; return } // continue // library marker kkossev.deviceProfileLib, line 209
if (debug) { log.info "setting par ${parMap.name} defVal = ${parMap.defVal} (type:${parMap.type})" } // library marker kkossev.deviceProfileLib, line 210
String str = parMap.name // library marker kkossev.deviceProfileLib, line 211
device.updateSetting("$str", [value:parMap.defVal as String, type:parMap.type]) // library marker kkossev.deviceProfileLib, line 212
} // library marker kkossev.deviceProfileLib, line 213
logInfo 'Preferences reset to default values' // library marker kkossev.deviceProfileLib, line 214
} // library marker kkossev.deviceProfileLib, line 215
/** // library marker kkossev.deviceProfileLib, line 217
* Returns a list of valid parameters per model based on the device preferences. // library marker kkossev.deviceProfileLib, line 218
* // library marker kkossev.deviceProfileLib, line 219
* @return List of valid parameters. // library marker kkossev.deviceProfileLib, line 220
*/ // library marker kkossev.deviceProfileLib, line 221
private List getValidParsPerModel() { // library marker kkossev.deviceProfileLib, line 222
List validPars = [] // library marker kkossev.deviceProfileLib, line 223
if (DEVICE?.preferences != null && DEVICE?.preferences != [:]) { // library marker kkossev.deviceProfileLib, line 224
// use the preferences to validate the parameters // library marker kkossev.deviceProfileLib, line 225
validPars = DEVICE?.preferences.keySet().toList() // library marker kkossev.deviceProfileLib, line 226
} // library marker kkossev.deviceProfileLib, line 227
return validPars // library marker kkossev.deviceProfileLib, line 228
} // library marker kkossev.deviceProfileLib, line 229
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 231
private def getScaledPreferenceValue(String preference, Map dpMap) { // TODO - not used ??? // library marker kkossev.deviceProfileLib, line 232
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 233
def value = settings."${preference}" // library marker kkossev.deviceProfileLib, line 234
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 235
def scaledValue // library marker kkossev.deviceProfileLib, line 236
if (value == null) { // library marker kkossev.deviceProfileLib, line 237
logDebug "getScaledPreferenceValue: preference ${preference} not found!" // library marker kkossev.deviceProfileLib, line 238
return null // library marker kkossev.deviceProfileLib, line 239
} // library marker kkossev.deviceProfileLib, line 240
switch (dpMap.type) { // library marker kkossev.deviceProfileLib, line 241
case 'number' : // library marker kkossev.deviceProfileLib, line 242
scaledValue = safeToInt(value) // library marker kkossev.deviceProfileLib, line 243
break // library marker kkossev.deviceProfileLib, line 244
case 'decimal' : // library marker kkossev.deviceProfileLib, line 245
scaledValue = safeToDouble(value) // library marker kkossev.deviceProfileLib, line 246
if (dpMap.scale != null && dpMap.scale != 1) { // library marker kkossev.deviceProfileLib, line 247
scaledValue = Math.round(scaledValue * dpMap.scale) // library marker kkossev.deviceProfileLib, line 248
} // library marker kkossev.deviceProfileLib, line 249
break // library marker kkossev.deviceProfileLib, line 250
case 'bool' : // library marker kkossev.deviceProfileLib, line 251
scaledValue = value == 'true' ? 1 : 0 // library marker kkossev.deviceProfileLib, line 252
break // library marker kkossev.deviceProfileLib, line 253
case 'enum' : // library marker kkossev.deviceProfileLib, line 254
//logWarn "getScaledPreferenceValue: ENUM preference ${preference} type:${dpMap.type} value = ${value} dpMap.scale=${dpMap.scale}" // library marker kkossev.deviceProfileLib, line 255
if (dpMap.map == null) { // library marker kkossev.deviceProfileLib, line 256
logDebug "getScaledPreferenceValue: preference ${preference} has no map defined!" // library marker kkossev.deviceProfileLib, line 257
return null // library marker kkossev.deviceProfileLib, line 258
} // library marker kkossev.deviceProfileLib, line 259
scaledValue = value // library marker kkossev.deviceProfileLib, line 260
if (dpMap.scale != null && safeToInt(dpMap.scale) != 1) { // library marker kkossev.deviceProfileLib, line 261
scaledValue = Math.round(safeToDouble(scaledValue ) * safeToInt(dpMap.scale)) // library marker kkossev.deviceProfileLib, line 262
} // library marker kkossev.deviceProfileLib, line 263
break // library marker kkossev.deviceProfileLib, line 264
default : // library marker kkossev.deviceProfileLib, line 265
logDebug "getScaledPreferenceValue: preference ${preference} has unsupported type ${dpMap.type}!" // library marker kkossev.deviceProfileLib, line 266
return null // library marker kkossev.deviceProfileLib, line 267
} // library marker kkossev.deviceProfileLib, line 268
//logDebug "getScaledPreferenceValue: preference ${preference} value = ${value} scaledValue = ${scaledValue} (scale=${dpMap.scale})" // library marker kkossev.deviceProfileLib, line 269
return scaledValue // library marker kkossev.deviceProfileLib, line 270
} // library marker kkossev.deviceProfileLib, line 271
// called from customUpdated() method in the custom driver // library marker kkossev.deviceProfileLib, line 273
// TODO !!!!!!!!!! - refactor it !!! IAS settings do not use Tuya DPs !!! // library marker kkossev.deviceProfileLib, line 274
public void updateAllPreferences() { // library marker kkossev.deviceProfileLib, line 275
logDebug "updateAllPreferences: preferences=${DEVICE?.preferences}" // library marker kkossev.deviceProfileLib, line 276
if (DEVICE?.preferences == null || DEVICE?.preferences == [:]) { // library marker kkossev.deviceProfileLib, line 277
logDebug "updateAllPreferences: no preferences defined for device profile ${getDeviceProfile()}" // library marker kkossev.deviceProfileLib, line 278
return // library marker kkossev.deviceProfileLib, line 279
} // library marker kkossev.deviceProfileLib, line 280
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 281
def preferenceValue // int or String for enums // library marker kkossev.deviceProfileLib, line 282
// itterate over the preferences map and update the device settings // library marker kkossev.deviceProfileLib, line 283
(DEVICE?.preferences).each { name, dp -> // library marker kkossev.deviceProfileLib, line 284
Map foundMap = getPreferencesMapByName(name, false) // library marker kkossev.deviceProfileLib, line 285
logDebug "updateAllPreferences: foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 286
if (foundMap != null && foundMap != [:]) { // library marker kkossev.deviceProfileLib, line 287
// preferenceValue = getScaledPreferenceValue(name, foundMap) // library marker kkossev.deviceProfileLib, line 288
preferenceValue = settings."${name}" // library marker kkossev.deviceProfileLib, line 289
logTrace"preferenceValue = ${preferenceValue}" // library marker kkossev.deviceProfileLib, line 290
if (foundMap.type == 'enum' && foundMap.scale != null && foundMap.scale != 1 && foundMap.scale != 0) { // library marker kkossev.deviceProfileLib, line 291
// scale the value // library marker kkossev.deviceProfileLib, line 292
preferenceValue = (safeToDouble(preferenceValue) / safeToInt(foundMap.scale)) as double // library marker kkossev.deviceProfileLib, line 293
} // library marker kkossev.deviceProfileLib, line 294
if (preferenceValue != null) { // library marker kkossev.deviceProfileLib, line 295
setPar(name, preferenceValue.toString()) // library marker kkossev.deviceProfileLib, line 296
} // library marker kkossev.deviceProfileLib, line 297
else { logDebug "updateAllPreferences: preference ${name} is not set (preferenceValue was null)" ; return } // library marker kkossev.deviceProfileLib, line 298
} // library marker kkossev.deviceProfileLib, line 299
else { logDebug "warning: couldn't find map for preference ${name}" ; return } // TODO - supress the warning if the preference was boolean true/false // library marker kkossev.deviceProfileLib, line 300
} // library marker kkossev.deviceProfileLib, line 301
return // library marker kkossev.deviceProfileLib, line 302
} // library marker kkossev.deviceProfileLib, line 303
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 305
def divideBy100(int val) { return (val as int) / 100 } // library marker kkossev.deviceProfileLib, line 306
int multiplyBy100(int val) { return (val as int) * 100 } // library marker kkossev.deviceProfileLib, line 307
int divideBy10(int val) { // library marker kkossev.deviceProfileLib, line 308
if (val > 10) { return (val as int) / 10 } // library marker kkossev.deviceProfileLib, line 309
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 310
} // library marker kkossev.deviceProfileLib, line 311
int multiplyBy10(int val) { return (val as int) * 10 } // library marker kkossev.deviceProfileLib, line 312
int divideBy1(int val) { return (val as int) / 1 } //tests // library marker kkossev.deviceProfileLib, line 313
int signedInt(int val) { // library marker kkossev.deviceProfileLib, line 314
if (val > 127) { return (val as int) - 256 } // library marker kkossev.deviceProfileLib, line 315
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 316
} // library marker kkossev.deviceProfileLib, line 317
int invert(int val) { // library marker kkossev.deviceProfileLib, line 318
if (settings.invertMotion == true) { return val == 0 ? 1 : 0 } // library marker kkossev.deviceProfileLib, line 319
else { return val } // library marker kkossev.deviceProfileLib, line 320
} // library marker kkossev.deviceProfileLib, line 321
// called from setPar and sendAttribite methods for non-Tuya DPs // library marker kkossev.deviceProfileLib, line 323
private List zclWriteAttribute(Map attributesMap, int scaledValue) { // library marker kkossev.deviceProfileLib, line 324
if (attributesMap == null || attributesMap == [:]) { logWarn "attributesMap=${attributesMap}" ; return [] } // library marker kkossev.deviceProfileLib, line 325
List cmds = [] // library marker kkossev.deviceProfileLib, line 326
Map map = [:] // library marker kkossev.deviceProfileLib, line 327
// cluster:attribute // library marker kkossev.deviceProfileLib, line 328
try { // library marker kkossev.deviceProfileLib, line 329
map['cluster'] = hubitat.helper.HexUtils.hexStringToInt((attributesMap.at).split(':')[0]) as Integer // library marker kkossev.deviceProfileLib, line 330
map['attribute'] = hubitat.helper.HexUtils.hexStringToInt((attributesMap.at).split(':')[1]) as Integer // library marker kkossev.deviceProfileLib, line 331
map['dt'] = (attributesMap.dt != null && attributesMap.dt != '') ? hubitat.helper.HexUtils.hexStringToInt(attributesMap.dt) as Integer : null // library marker kkossev.deviceProfileLib, line 332
map['mfgCode'] = attributesMap.mfgCode ? attributesMap.mfgCode as String : null // library marker kkossev.deviceProfileLib, line 333
map['ep'] = (attributesMap.ep != null && attributesMap.ep != '') ? hubitat.helper.HexUtils.hexStringToInt(attributesMap.ep) as Integer : null // library marker kkossev.deviceProfileLib, line 334
} // library marker kkossev.deviceProfileLib, line 335
catch (e) { logWarn "setPar: Exception caught while splitting cluser and attribute $customSetFunction($scaledValue) (val=${val})) : '${e}' " ; return [] } // library marker kkossev.deviceProfileLib, line 336
// dt (data type) is obligatory when writing to a cluster... // library marker kkossev.deviceProfileLib, line 337
if (attributesMap.rw != null && attributesMap.rw == 'rw' && map.dt == null) { // library marker kkossev.deviceProfileLib, line 338
map.dt = attributesMap.type in ['number', 'decimal'] ? DataType.INT16 : DataType.ENUM8 // library marker kkossev.deviceProfileLib, line 339
logDebug "cluster:attribute ${attributesMap.at} is read-write, but no data type (dt) is defined! Assuming 0x${zigbee.convertToHexString(map.dt, 2)}" // library marker kkossev.deviceProfileLib, line 340
} // library marker kkossev.deviceProfileLib, line 341
if ((map.mfgCode != null && map.mfgCode != '') || (map.ep != null && map.ep != '')) { // library marker kkossev.deviceProfileLib, line 342
Map mfgCode = map.mfgCode != null ? ['mfgCode':map.mfgCode] : [:] // library marker kkossev.deviceProfileLib, line 343
Map ep = map.ep != null ? ['destEndpoint':map.ep] : [:] // library marker kkossev.deviceProfileLib, line 344
Map mapOptions = [:] // library marker kkossev.deviceProfileLib, line 345
if (mfgCode) mapOptions.putAll(mfgCode) // library marker kkossev.deviceProfileLib, line 346
if (ep) mapOptions.putAll(ep) // library marker kkossev.deviceProfileLib, line 347
//log.trace "$mapOptions" // library marker kkossev.deviceProfileLib, line 348
cmds = zigbee.writeAttribute(map.cluster as int, map.attribute as int, map.dt as int, scaledValue, mapOptions, delay = 50) // library marker kkossev.deviceProfileLib, line 349
} // library marker kkossev.deviceProfileLib, line 350
else { // library marker kkossev.deviceProfileLib, line 351
cmds = zigbee.writeAttribute(map.cluster as int, map.attribute as int, map.dt as int, scaledValue, [:], delay = 50) // library marker kkossev.deviceProfileLib, line 352
} // library marker kkossev.deviceProfileLib, line 353
return cmds // library marker kkossev.deviceProfileLib, line 354
} // library marker kkossev.deviceProfileLib, line 355
/** // library marker kkossev.deviceProfileLib, line 357
* Called from setPar() method only! // library marker kkossev.deviceProfileLib, line 358
* Validates the parameter value based on the given dpMap type and scales it if needed. // library marker kkossev.deviceProfileLib, line 359
* // library marker kkossev.deviceProfileLib, line 360
* @param dpMap The map containing the parameter type, minimum and maximum values. // library marker kkossev.deviceProfileLib, line 361
* @param val The value to be validated and scaled. // library marker kkossev.deviceProfileLib, line 362
* @return The validated and scaled value if it is within the specified range, null otherwise. // library marker kkossev.deviceProfileLib, line 363
*/ // library marker kkossev.deviceProfileLib, line 364
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 365
private def validateAndScaleParameterValue(Map dpMap, String val) { // library marker kkossev.deviceProfileLib, line 366
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 367
def value // validated value - integer, floar // library marker kkossev.deviceProfileLib, line 368
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 369
def scaledValue // // library marker kkossev.deviceProfileLib, line 370
//logDebug "validateAndScaleParameterValue: dpMap=${dpMap} val=${val}" // library marker kkossev.deviceProfileLib, line 371
switch (dpMap.type) { // library marker kkossev.deviceProfileLib, line 372
case 'number' : // library marker kkossev.deviceProfileLib, line 373
// TODO - negative values ! // library marker kkossev.deviceProfileLib, line 374
// TODO - better conversion to integer! // library marker kkossev.deviceProfileLib, line 375
value = safeToInt(val, 0) // library marker kkossev.deviceProfileLib, line 376
//scaledValue = value // library marker kkossev.deviceProfileLib, line 377
// scale the value - added 10/26/2023 also for integer values ! // library marker kkossev.deviceProfileLib, line 378
if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 379
scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 380
} // library marker kkossev.deviceProfileLib, line 381
else { // library marker kkossev.deviceProfileLib, line 382
scaledValue = value // library marker kkossev.deviceProfileLib, line 383
} // library marker kkossev.deviceProfileLib, line 384
break // library marker kkossev.deviceProfileLib, line 385
case 'decimal' : // library marker kkossev.deviceProfileLib, line 387
value = safeToDouble(val, 0.0) // library marker kkossev.deviceProfileLib, line 388
// scale the value // library marker kkossev.deviceProfileLib, line 389
if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 390
scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 391
} // library marker kkossev.deviceProfileLib, line 392
else { // library marker kkossev.deviceProfileLib, line 393
scaledValue = value // library marker kkossev.deviceProfileLib, line 394
} // library marker kkossev.deviceProfileLib, line 395
break // library marker kkossev.deviceProfileLib, line 396
case 'bool' : // library marker kkossev.deviceProfileLib, line 398
if (val == '0' || val == 'false') { value = scaledValue = 0 } // library marker kkossev.deviceProfileLib, line 399
else if (val == '1' || val == 'true') { value = scaledValue = 1 } // library marker kkossev.deviceProfileLib, line 400
else { // library marker kkossev.deviceProfileLib, line 401
logInfo "bool parameter ${val}. value must be one of 0 1 false true" // library marker kkossev.deviceProfileLib, line 402
return null // library marker kkossev.deviceProfileLib, line 403
} // library marker kkossev.deviceProfileLib, line 404
break // library marker kkossev.deviceProfileLib, line 405
case 'enum' : // library marker kkossev.deviceProfileLib, line 406
// enums are always integer values // library marker kkossev.deviceProfileLib, line 407
// check if the scaling is different than 1 in dpMap // library marker kkossev.deviceProfileLib, line 408
logTrace "validateAndScaleParameterValue: enum parameter ${val}. dpMap=${dpMap}" // library marker kkossev.deviceProfileLib, line 409
Integer scale = safeToInt(dpMap.scale) // library marker kkossev.deviceProfileLib, line 410
if (scale != null && scale != 0 && scale != 1) { // library marker kkossev.deviceProfileLib, line 411
// we have a float parameter input - convert it to int // library marker kkossev.deviceProfileLib, line 412
value = safeToDouble(val, -1.0) // library marker kkossev.deviceProfileLib, line 413
scaledValue = (value * safeToInt(dpMap.scale)) as Integer // library marker kkossev.deviceProfileLib, line 414
} // library marker kkossev.deviceProfileLib, line 415
else { // library marker kkossev.deviceProfileLib, line 416
value = scaledValue = safeToInt(val, -1) // library marker kkossev.deviceProfileLib, line 417
} // library marker kkossev.deviceProfileLib, line 418
if (scaledValue == null || scaledValue < 0) { // library marker kkossev.deviceProfileLib, line 419
// get the keys of dpMap.map as a List // library marker kkossev.deviceProfileLib, line 420
//List keys = dpMap.map.keySet().toList() // library marker kkossev.deviceProfileLib, line 421
//logDebug "${device.displayName} validateAndScaleParameterValue: enum parameter ${val}. value must be one of ${keys}" // library marker kkossev.deviceProfileLib, line 422
// find the key for the value // library marker kkossev.deviceProfileLib, line 423
String key = dpMap.map.find { it.value == val }?.key // library marker kkossev.deviceProfileLib, line 424
logTrace "validateAndScaleParameterValue: enum parameter ${val}. key=${key}" // library marker kkossev.deviceProfileLib, line 425
if (key == null) { // library marker kkossev.deviceProfileLib, line 426
logInfo "invalid enum parameter ${val}. value must be one of ${dpMap.map}" // library marker kkossev.deviceProfileLib, line 427
return null // library marker kkossev.deviceProfileLib, line 428
} // library marker kkossev.deviceProfileLib, line 429
value = scaledValue = key as Integer // library marker kkossev.deviceProfileLib, line 430
//return null // library marker kkossev.deviceProfileLib, line 431
} // library marker kkossev.deviceProfileLib, line 432
break // library marker kkossev.deviceProfileLib, line 433
default : // library marker kkossev.deviceProfileLib, line 434
logWarn "validateAndScaleParameterValue: unsupported dpMap type ${parType}" // library marker kkossev.deviceProfileLib, line 435
return null // library marker kkossev.deviceProfileLib, line 436
} // library marker kkossev.deviceProfileLib, line 437
//logTrace "validateAndScaleParameterValue before checking scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 438
// check if the value is within the specified range // library marker kkossev.deviceProfileLib, line 439
if ((dpMap.min != null && value < dpMap.min) || (dpMap.max != null && value > dpMap.max)) { // library marker kkossev.deviceProfileLib, line 440
logWarn "${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 441
return null // library marker kkossev.deviceProfileLib, line 442
} // library marker kkossev.deviceProfileLib, line 443
//logTrace "validateAndScaleParameterValue returning scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 444
return scaledValue // library marker kkossev.deviceProfileLib, line 445
} // library marker kkossev.deviceProfileLib, line 446
/** // library marker kkossev.deviceProfileLib, line 448
* Sets the value of a parameter for a device. // library marker kkossev.deviceProfileLib, line 449
* // library marker kkossev.deviceProfileLib, line 450
* @param par The parameter name. // library marker kkossev.deviceProfileLib, line 451
* @param val The parameter value. // library marker kkossev.deviceProfileLib, line 452
* @return true if the parameter was successfully set, false otherwise. // library marker kkossev.deviceProfileLib, line 453
*/ // library marker kkossev.deviceProfileLib, line 454
public boolean setPar(final String parPar=null, final String val=null ) { // library marker kkossev.deviceProfileLib, line 455
List cmds = [] // library marker kkossev.deviceProfileLib, line 456
//Boolean validated = false // library marker kkossev.deviceProfileLib, line 457
logDebug "setPar(${parPar}, ${val})" // library marker kkossev.deviceProfileLib, line 458
if (DEVICE?.preferences == null || DEVICE?.preferences == [:]) { return false } // library marker kkossev.deviceProfileLib, line 459
if (parPar == null /*|| !(par in getValidParsPerModel())*/) { logInfo "setPar: 'parameter' must be one of these : ${getValidParsPerModel()}"; return false } // library marker kkossev.deviceProfileLib, line 460
String par = parPar.trim() // library marker kkossev.deviceProfileLib, line 461
Map dpMap = getPreferencesMapByName(par, false) // get the map for the parameter // library marker kkossev.deviceProfileLib, line 462
if ( dpMap == null || dpMap == [:]) { logInfo "setPar: tuyaDPs map not found for parameter ${par}"; return false } // library marker kkossev.deviceProfileLib, line 463
if (val == null) { logInfo "setPar: 'value' must be specified for parameter ${par} in the range ${dpMap.min} to ${dpMap.max}"; return false } // library marker kkossev.deviceProfileLib, line 464
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 465
def scaledValue = validateAndScaleParameterValue(dpMap, val as String) // convert the val to the correct type and scale it if needed // library marker kkossev.deviceProfileLib, line 466
if (scaledValue == null) { // library marker kkossev.deviceProfileLib, line 467
logTrace "$dpMap ${dpMap.map}" // library marker kkossev.deviceProfileLib, line 468
String helpTxt = "setPar: invalid parameter ${par} value ${val}." // library marker kkossev.deviceProfileLib, line 469
if (dpMap.min != null && dpMap.max != null) { helpTxt += " Must be in the range ${dpMap.min} to ${dpMap.max}" } // library marker kkossev.deviceProfileLib, line 470
if (dpMap.map != null) { helpTxt += " Must be one of ${dpMap.map}" } // library marker kkossev.deviceProfileLib, line 471
logInfo helpTxt // library marker kkossev.deviceProfileLib, line 472
return false // library marker kkossev.deviceProfileLib, line 473
} // library marker kkossev.deviceProfileLib, line 474
// if there is a dedicated set function, use it // library marker kkossev.deviceProfileLib, line 476
String capitalizedFirstChar = par[0].toUpperCase() + par[1..-1] // library marker kkossev.deviceProfileLib, line 477
String customSetFunction = "customSet${capitalizedFirstChar}" // library marker kkossev.deviceProfileLib, line 478
if (this.respondsTo(customSetFunction)) { // library marker kkossev.deviceProfileLib, line 479
logDebug "setPar: found customSetFunction=${setFunction}, scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 480
// execute the customSetFunction // library marker kkossev.deviceProfileLib, line 481
try { cmds = "$customSetFunction"(scaledValue) } // library marker kkossev.deviceProfileLib, line 482
catch (e) { logWarn "setPar: Exception caught while processing $customSetFunction($scaledValue) (val=${val})) : '${e}'" ; return false } // library marker kkossev.deviceProfileLib, line 483
logDebug "customSetFunction result is ${cmds}" // library marker kkossev.deviceProfileLib, line 484
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 485
logInfo "setPar: (1) successfluly executed setPar $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 486
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 487
return true // library marker kkossev.deviceProfileLib, line 488
} // library marker kkossev.deviceProfileLib, line 489
else { // library marker kkossev.deviceProfileLib, line 490
logWarn "setPar: customSetFunction $customSetFunction($scaledValue) returned null or empty list" // library marker kkossev.deviceProfileLib, line 491
// continue with the default processing // library marker kkossev.deviceProfileLib, line 492
} // library marker kkossev.deviceProfileLib, line 493
} // library marker kkossev.deviceProfileLib, line 494
if (isVirtual()) { // library marker kkossev.deviceProfileLib, line 495
// set a virtual attribute // library marker kkossev.deviceProfileLib, line 496
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 497
def valMiscType // library marker kkossev.deviceProfileLib, line 498
logDebug "setPar: found virtual attribute ${par} value ${val}" // library marker kkossev.deviceProfileLib, line 499
if (dpMap.type == 'enum') { // library marker kkossev.deviceProfileLib, line 500
// find the key for the value // library marker kkossev.deviceProfileLib, line 501
String key = dpMap.map.find { it.value == val }?.key // library marker kkossev.deviceProfileLib, line 502
logTrace "setPar: enum parameter ${val}. key=${key}" // library marker kkossev.deviceProfileLib, line 503
if (key == null) { // library marker kkossev.deviceProfileLib, line 504
logInfo "setPar: invalid virtual enum parameter ${val}. value must be one of ${dpMap.map}" // library marker kkossev.deviceProfileLib, line 505
return false // library marker kkossev.deviceProfileLib, line 506
} // library marker kkossev.deviceProfileLib, line 507
valMiscType = dpMap.map[key as int] // library marker kkossev.deviceProfileLib, line 508
logTrace "setPar: enum parameter ${val}. key=${key} valMiscType=${valMiscType} dpMap.map=${dpMap.map}" // library marker kkossev.deviceProfileLib, line 509
device.updateSetting("$par", [value:key as String, type:dpMap.type]) // library marker kkossev.deviceProfileLib, line 510
} // library marker kkossev.deviceProfileLib, line 511
else { // library marker kkossev.deviceProfileLib, line 512
valMiscType = val // library marker kkossev.deviceProfileLib, line 513
device.updateSetting("$par", [value:valMiscType, type:dpMap.type]) // library marker kkossev.deviceProfileLib, line 514
} // library marker kkossev.deviceProfileLib, line 515
String descriptionText = "${par} set to ${valMiscType}${dpMap.unit ?: ''} [virtual]" // library marker kkossev.deviceProfileLib, line 516
sendEvent(name:par, value:valMiscType, unit:dpMap.unit ?: '', isDigital: true) // library marker kkossev.deviceProfileLib, line 517
logInfo descriptionText // library marker kkossev.deviceProfileLib, line 518
return true // library marker kkossev.deviceProfileLib, line 519
} // library marker kkossev.deviceProfileLib, line 520
// check whether this is a tuya DP or a cluster:attribute parameter // library marker kkossev.deviceProfileLib, line 522
boolean isTuyaDP // library marker kkossev.deviceProfileLib, line 523
/* groovylint-disable-next-line Instanceof */ // library marker kkossev.deviceProfileLib, line 525
try { isTuyaDP = dpMap.dp instanceof Number } // library marker kkossev.deviceProfileLib, line 526
catch (e) { logWarn"setPar: (1) exception ${e} caught while checking isNumber() preference ${preference}" ; isTuyaDP = false } // library marker kkossev.deviceProfileLib, line 527
if (dpMap.dp != null && isTuyaDP) { // library marker kkossev.deviceProfileLib, line 528
// Tuya DP // library marker kkossev.deviceProfileLib, line 529
cmds = sendTuyaParameter(dpMap, par, scaledValue) // library marker kkossev.deviceProfileLib, line 530
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 531
logWarn "setPar: sendTuyaParameter par ${par} scaledValue ${scaledValue} returned null or empty list" // library marker kkossev.deviceProfileLib, line 532
return false // library marker kkossev.deviceProfileLib, line 533
} // library marker kkossev.deviceProfileLib, line 534
else { // library marker kkossev.deviceProfileLib, line 535
logInfo "setPar: (2) sending parameter $par ($val (scaledValue=${scaledValue}))" // library marker kkossev.deviceProfileLib, line 536
sendZigbeeCommands(cmds) // library marker kkossev.deviceProfileLib, line 537
return false // library marker kkossev.deviceProfileLib, line 538
} // library marker kkossev.deviceProfileLib, line 539
} // library marker kkossev.deviceProfileLib, line 540
else if (dpMap.at != null) { // library marker kkossev.deviceProfileLib, line 541
// cluster:attribute // library marker kkossev.deviceProfileLib, line 542
logDebug "setPar: found at=${dpMap.at} dt=${dpMap.dt} mfgCode=${dpMap.mfgCode} scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 543
int signedIntScaled = convertSignedInts(scaledValue, dpMap) // library marker kkossev.deviceProfileLib, line 544
cmds = zclWriteAttribute(dpMap, signedIntScaled) // library marker kkossev.deviceProfileLib, line 545
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 546
logWarn "setPar: failed to write cluster:attribute ${dpMap.at} value ${scaledValue}" // library marker kkossev.deviceProfileLib, line 547
return false // library marker kkossev.deviceProfileLib, line 548
} // library marker kkossev.deviceProfileLib, line 549
} // library marker kkossev.deviceProfileLib, line 550
else { logWarn "setPar: invalid dp or at value ${dpMap.dp} for parameter ${par}" ; return false } // library marker kkossev.deviceProfileLib, line 551
logInfo "setPar: (3) successfluly executed setPar $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 552
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 553
return true // library marker kkossev.deviceProfileLib, line 554
} // library marker kkossev.deviceProfileLib, line 555
// 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 557
// TODO - reuse it !!! // library marker kkossev.deviceProfileLib, line 558
/* groovylint-disable-next-line MethodParameterTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 559
public List sendTuyaParameter( Map dpMap, String par, tuyaValue) { // library marker kkossev.deviceProfileLib, line 560
//logDebug "sendTuyaParameter: trying to send parameter ${par} value ${tuyaValue}" // library marker kkossev.deviceProfileLib, line 561
List cmds = [] // library marker kkossev.deviceProfileLib, line 562
if (dpMap == null) { logWarn "sendTuyaParameter: tuyaDPs map not found for parameter ${par}" ; return [] } // library marker kkossev.deviceProfileLib, line 563
String dp = zigbee.convertToHexString(dpMap.dp, 2) // library marker kkossev.deviceProfileLib, line 564
if (dpMap.dp <= 0 || dpMap.dp >= 256) { // library marker kkossev.deviceProfileLib, line 565
logWarn "sendTuyaParameter: invalid dp ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 566
return [] // library marker kkossev.deviceProfileLib, line 567
} // library marker kkossev.deviceProfileLib, line 568
String dpType // library marker kkossev.deviceProfileLib, line 569
if (dpMap.dt == null) { // library marker kkossev.deviceProfileLib, line 570
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 571
} // library marker kkossev.deviceProfileLib, line 572
else { // library marker kkossev.deviceProfileLib, line 573
dpType = dpMap.dt // "01" - bool, "02" - enum, "03" - value // library marker kkossev.deviceProfileLib, line 574
} // library marker kkossev.deviceProfileLib, line 575
if (dpType == null) { // library marker kkossev.deviceProfileLib, line 576
logWarn "sendTuyaParameter: invalid dpType ${dpMap.type} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 577
return [] // library marker kkossev.deviceProfileLib, line 578
} // library marker kkossev.deviceProfileLib, line 579
// sendTuyaCommand // library marker kkossev.deviceProfileLib, line 580
String dpValHex = dpType == DP_TYPE_VALUE ? zigbee.convertToHexString(tuyaValue as int, 8) : zigbee.convertToHexString(tuyaValue as int, 2) // library marker kkossev.deviceProfileLib, line 581
logDebug "sendTuyaParameter: sending parameter ${par} dpValHex ${dpValHex} (raw=${tuyaValue}) Tuya dp=${dp} dpType=${dpType} " // library marker kkossev.deviceProfileLib, line 582
if (dpMap.tuyaCmd != null ) { // library marker kkossev.deviceProfileLib, line 583
cmds = sendTuyaCommand( dp, dpType, dpValHex, dpMap.tuyaCmd as int) // library marker kkossev.deviceProfileLib, line 584
} // library marker kkossev.deviceProfileLib, line 585
else { // library marker kkossev.deviceProfileLib, line 586
cmds = sendTuyaCommand( dp, dpType, dpValHex) // library marker kkossev.deviceProfileLib, line 587
} // library marker kkossev.deviceProfileLib, line 588
return cmds // library marker kkossev.deviceProfileLib, line 589
} // library marker kkossev.deviceProfileLib, line 590
private int convertSignedInts(int val, Map dpMap) { // library marker kkossev.deviceProfileLib, line 592
if (dpMap.dt == '0x28') { // library marker kkossev.deviceProfileLib, line 593
if (val > 127) { return (val as int) - 256 } // library marker kkossev.deviceProfileLib, line 594
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 595
} // library marker kkossev.deviceProfileLib, line 596
else if (dpMap.dt == '0x29') { // library marker kkossev.deviceProfileLib, line 597
if (val > 32767) { return (val as int) - 65536 } // library marker kkossev.deviceProfileLib, line 598
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 599
} // library marker kkossev.deviceProfileLib, line 600
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 601
} // library marker kkossev.deviceProfileLib, line 602
/* groovylint-disable-next-line MethodParameterTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 604
public boolean sendAttribute(String par=null, val=null ) { // library marker kkossev.deviceProfileLib, line 605
List cmds = [] // library marker kkossev.deviceProfileLib, line 606
//Boolean validated = false // library marker kkossev.deviceProfileLib, line 607
logDebug "sendAttribute(${par}, ${val})" // library marker kkossev.deviceProfileLib, line 608
if (par == null || DEVICE?.preferences == null || DEVICE?.preferences == [:]) { logDebug 'DEVICE.preferences is empty!' ; return false } // library marker kkossev.deviceProfileLib, line 609
Map dpMap = getAttributesMap(par, false) // get the map for the attribute // library marker kkossev.deviceProfileLib, line 611
l//log.trace "sendAttribute: dpMap=${dpMap}" // library marker kkossev.deviceProfileLib, line 612
if (dpMap == null || dpMap?.isEmpty()) { logWarn "sendAttribute: map not found for parameter ${par}"; return false } // library marker kkossev.deviceProfileLib, line 613
if (val == null) { logWarn "sendAttribute: 'value' must be specified for parameter ${par} in the range ${dpMap.min} to ${dpMap.max}"; return false } // library marker kkossev.deviceProfileLib, line 614
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 615
def scaledValue = validateAndScaleParameterValue(dpMap, val as String) // convert the val to the correct type and scale it if needed // library marker kkossev.deviceProfileLib, line 616
if (scaledValue == null) { logWarn "sendAttribute: invalid parameter value ${val}. Must be in the range ${dpMap.min} to ${dpMap.max}"; return false } // library marker kkossev.deviceProfileLib, line 617
logDebug "sendAttribute: parameter ${par} value ${val}, type ${dpMap.type} validated and scaled to ${scaledValue} type=${dpMap.type}" // library marker kkossev.deviceProfileLib, line 618
// if there is a dedicated set function, use it // library marker kkossev.deviceProfileLib, line 619
String capitalizedFirstChar = par[0].toUpperCase() + par[1..-1] // library marker kkossev.deviceProfileLib, line 620
String customSetFunction = "customSet${capitalizedFirstChar}" // library marker kkossev.deviceProfileLib, line 621
if (this.respondsTo(customSetFunction) /*&& !(customSetFunction in ["setHeatingSetpoint", "setCoolingSetpoint", "setThermostatMode"])*/) { // library marker kkossev.deviceProfileLib, line 622
logDebug "sendAttribute: found customSetFunction=${customSetFunction}, scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 623
// execute the customSetFunction // library marker kkossev.deviceProfileLib, line 624
try { // library marker kkossev.deviceProfileLib, line 625
cmds = "$customSetFunction"(scaledValue) // library marker kkossev.deviceProfileLib, line 626
} // library marker kkossev.deviceProfileLib, line 627
catch (e) { // library marker kkossev.deviceProfileLib, line 628
logWarn "sendAttribute: Exception '${e}'caught while processing $customSetFunction($scaledValue) (val=${val}))" // library marker kkossev.deviceProfileLib, line 629
return false // library marker kkossev.deviceProfileLib, line 630
} // library marker kkossev.deviceProfileLib, line 631
logDebug "customSetFunction result is ${cmds}" // library marker kkossev.deviceProfileLib, line 632
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 633
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 634
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 635
return true // library marker kkossev.deviceProfileLib, line 636
} // library marker kkossev.deviceProfileLib, line 637
else { // library marker kkossev.deviceProfileLib, line 638
logDebug "sendAttribute: customSetFunction $customSetFunction($scaledValue) returned null or empty list, continue with the default processing" // library marker kkossev.deviceProfileLib, line 639
// continue with the default processing // library marker kkossev.deviceProfileLib, line 640
} // library marker kkossev.deviceProfileLib, line 641
} // library marker kkossev.deviceProfileLib, line 642
else { // library marker kkossev.deviceProfileLib, line 643
logDebug "sendAttribute: SKIPPED customSetFunction ${customSetFunction}, continue with the default processing" // library marker kkossev.deviceProfileLib, line 644
} // library marker kkossev.deviceProfileLib, line 645
// check whether this is a tuya DP or a cluster:attribute parameter or a virtual device // library marker kkossev.deviceProfileLib, line 646
if (isVirtual()) { // library marker kkossev.deviceProfileLib, line 647
// send a virtual attribute // library marker kkossev.deviceProfileLib, line 648
logDebug "sendAttribute: found virtual attribute ${par} value ${val}" // library marker kkossev.deviceProfileLib, line 649
// patch !! // library marker kkossev.deviceProfileLib, line 650
if (par == 'heatingSetpoint') { // library marker kkossev.deviceProfileLib, line 651
sendHeatingSetpointEvent(val) // library marker kkossev.deviceProfileLib, line 652
} // library marker kkossev.deviceProfileLib, line 653
else { // library marker kkossev.deviceProfileLib, line 654
String descriptionText = "${par} is ${val} [virtual]" // library marker kkossev.deviceProfileLib, line 655
sendEvent(name:par, value:val, isDigital: true) // library marker kkossev.deviceProfileLib, line 656
logInfo descriptionText // library marker kkossev.deviceProfileLib, line 657
} // library marker kkossev.deviceProfileLib, line 658
return true // library marker kkossev.deviceProfileLib, line 659
} // library marker kkossev.deviceProfileLib, line 660
else { // library marker kkossev.deviceProfileLib, line 661
logTrace "sendAttribute: not a virtual device (device.controllerType = ${device.controllerType}), continue " // library marker kkossev.deviceProfileLib, line 662
} // library marker kkossev.deviceProfileLib, line 663
boolean isTuyaDP // library marker kkossev.deviceProfileLib, line 664
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 665
def preference = dpMap.dp // TODO - remove it? // library marker kkossev.deviceProfileLib, line 666
try { // library marker kkossev.deviceProfileLib, line 667
isTuyaDP = dpMap.dp instanceof Number // check if dpMap.dp is a number // library marker kkossev.deviceProfileLib, line 668
} // library marker kkossev.deviceProfileLib, line 669
catch (e) { // library marker kkossev.deviceProfileLib, line 670
if (debug) { log.warn "sendAttribute: exception ${e} caught while checking isNumber() preference ${preference}" } // library marker kkossev.deviceProfileLib, line 671
return false // library marker kkossev.deviceProfileLib, line 672
} // library marker kkossev.deviceProfileLib, line 673
if (dpMap.dp != null && isTuyaDP) { // library marker kkossev.deviceProfileLib, line 674
// Tuya DP // library marker kkossev.deviceProfileLib, line 675
cmds = sendTuyaParameter(dpMap, par, scaledValue) // library marker kkossev.deviceProfileLib, line 676
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 677
logWarn "sendAttribute: sendTuyaParameter par ${par} scaledValue ${scaledValue} returned null or empty list" // library marker kkossev.deviceProfileLib, line 678
return false // library marker kkossev.deviceProfileLib, line 679
} // library marker kkossev.deviceProfileLib, line 680
else { // library marker kkossev.deviceProfileLib, line 681
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($val (scaledValue=${scaledValue}))" // library marker kkossev.deviceProfileLib, line 682
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 683
return true // library marker kkossev.deviceProfileLib, line 684
} // library marker kkossev.deviceProfileLib, line 685
} // library marker kkossev.deviceProfileLib, line 686
/* groovylint-disable-next-line EmptyIfStatement */ // library marker kkossev.deviceProfileLib, line 687
else if (dpMap.at != null && dpMap.at == 'virtual') { // library marker kkossev.deviceProfileLib, line 688
// send a virtual attribute // library marker kkossev.deviceProfileLib, line 689
} // library marker kkossev.deviceProfileLib, line 690
else if (dpMap.at != null) { // library marker kkossev.deviceProfileLib, line 691
// cluster:attribute // library marker kkossev.deviceProfileLib, line 692
cmds = zclWriteAttribute(dpMap, scaledValue) // library marker kkossev.deviceProfileLib, line 693
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 694
logWarn "sendAttribute: failed to write cluster:attribute ${dpMap.at} value ${scaledValue}" // library marker kkossev.deviceProfileLib, line 695
return false // library marker kkossev.deviceProfileLib, line 696
} // library marker kkossev.deviceProfileLib, line 697
} // library marker kkossev.deviceProfileLib, line 698
else { // library marker kkossev.deviceProfileLib, line 699
logWarn "sendAttribute: invalid dp or at value ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 700
return false // library marker kkossev.deviceProfileLib, line 701
} // library marker kkossev.deviceProfileLib, line 702
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 703
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 704
return true // library marker kkossev.deviceProfileLib, line 705
} // library marker kkossev.deviceProfileLib, line 706
/** // library marker kkossev.deviceProfileLib, line 708
* SENDS a list of Zigbee commands to be sent to the device. // library marker kkossev.deviceProfileLib, line 709
* @param command - The command to send. Must be one of the commands defined in the DEVICE.commands map. // library marker kkossev.deviceProfileLib, line 710
* @param val - The value to send with the command, can be null. // library marker kkossev.deviceProfileLib, line 711
* @return true on success, false otherwise. // library marker kkossev.deviceProfileLib, line 712
*/ // library marker kkossev.deviceProfileLib, line 713
public boolean sendCommand(final String command_orig=null, final String val_orig=null) { // library marker kkossev.deviceProfileLib, line 714
//logDebug "sending command ${command}(${val}))" // library marker kkossev.deviceProfileLib, line 715
final String command = command_orig?.trim() // library marker kkossev.deviceProfileLib, line 716
final String val = val_orig?.trim() // library marker kkossev.deviceProfileLib, line 717
List cmds = [] // library marker kkossev.deviceProfileLib, line 718
Map supportedCommandsMap = DEVICE?.commands as Map // library marker kkossev.deviceProfileLib, line 719
if (supportedCommandsMap == null || supportedCommandsMap?.isEmpty()) { // library marker kkossev.deviceProfileLib, line 720
logInfo "sendCommand: no commands defined for device profile ${getDeviceProfile()} !" // library marker kkossev.deviceProfileLib, line 721
return false // library marker kkossev.deviceProfileLib, line 722
} // library marker kkossev.deviceProfileLib, line 723
// TODO: compare ignoring the upper/lower case of the command. // library marker kkossev.deviceProfileLib, line 724
List supportedCommandsList = DEVICE?.commands?.keySet() as List // library marker kkossev.deviceProfileLib, line 725
// check if the command is defined in the DEVICE commands map // library marker kkossev.deviceProfileLib, line 726
if (command == null || !(command in supportedCommandsList)) { // library marker kkossev.deviceProfileLib, line 727
logInfo "sendCommand: the command ${(command ?: '')} for device profile '${DEVICE?.description}' must be one of these : ${supportedCommandsList}" // library marker kkossev.deviceProfileLib, line 728
return false // library marker kkossev.deviceProfileLib, line 729
} // library marker kkossev.deviceProfileLib, line 730
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 731
def func, funcResult // library marker kkossev.deviceProfileLib, line 732
try { // library marker kkossev.deviceProfileLib, line 733
func = DEVICE?.commands.find { it.key == command }.value // library marker kkossev.deviceProfileLib, line 734
// added 01/25/2025 : the commands now can be shorted : instead of a map kay and value 'printFingerprints':'printFingerprints' we can skip the value when it is the same: 'printFingerprints:' - the value is the same as the key // library marker kkossev.deviceProfileLib, line 735
if (func == null || func == '') { // library marker kkossev.deviceProfileLib, line 736
func = command // library marker kkossev.deviceProfileLib, line 737
} // library marker kkossev.deviceProfileLib, line 738
if (val != null && val != '') { // library marker kkossev.deviceProfileLib, line 739
logInfo "executed $func($val)" // library marker kkossev.deviceProfileLib, line 740
funcResult = "${func}"(val) // library marker kkossev.deviceProfileLib, line 741
} // library marker kkossev.deviceProfileLib, line 742
else { // library marker kkossev.deviceProfileLib, line 743
logInfo "executed $func()" // library marker kkossev.deviceProfileLib, line 744
funcResult = "${func}"() // library marker kkossev.deviceProfileLib, line 745
} // library marker kkossev.deviceProfileLib, line 746
} // library marker kkossev.deviceProfileLib, line 747
catch (e) { // library marker kkossev.deviceProfileLib, line 748
logWarn "sendCommand: Exception '${e}' caught while processing $func(${val})" // library marker kkossev.deviceProfileLib, line 749
return false // library marker kkossev.deviceProfileLib, line 750
} // library marker kkossev.deviceProfileLib, line 751
// funcResult is expected to be list of commands to be sent to the device, but can also return boolean or null // library marker kkossev.deviceProfileLib, line 752
// check if the result is a list of commands // library marker kkossev.deviceProfileLib, line 753
/* groovylint-disable-next-line Instanceof */ // library marker kkossev.deviceProfileLib, line 754
if (funcResult instanceof List) { // library marker kkossev.deviceProfileLib, line 755
cmds = funcResult // library marker kkossev.deviceProfileLib, line 756
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 757
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 758
} // library marker kkossev.deviceProfileLib, line 759
} // library marker kkossev.deviceProfileLib, line 760
else if (funcResult == null) { // library marker kkossev.deviceProfileLib, line 761
return false // library marker kkossev.deviceProfileLib, line 762
} // library marker kkossev.deviceProfileLib, line 763
else { // library marker kkossev.deviceProfileLib, line 764
logDebug "sendCommand: $func(${val}) returned ${funcResult} instead of a list of commands!" // library marker kkossev.deviceProfileLib, line 765
return false // library marker kkossev.deviceProfileLib, line 766
} // library marker kkossev.deviceProfileLib, line 767
return true // library marker kkossev.deviceProfileLib, line 768
} // library marker kkossev.deviceProfileLib, line 769
/** // library marker kkossev.deviceProfileLib, line 771
* 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 772
* 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 773
* It then checks if the input parameter is a boolean value and skips it if it is. // library marker kkossev.deviceProfileLib, line 774
* The method also checks if the input parameter is a number and sets the isTuyaDP flag accordingly. // library marker kkossev.deviceProfileLib, line 775
* If the input parameter is read-only, the method returns null. // library marker kkossev.deviceProfileLib, line 776
* 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 777
* If the input parameter type is not supported, the method returns null. // library marker kkossev.deviceProfileLib, line 778
* @param param The input parameter to be checked. // library marker kkossev.deviceProfileLib, line 779
* @param debug A boolean flag indicating whether to log debug messages or not. // library marker kkossev.deviceProfileLib, line 780
* @return A map containing the input details. // library marker kkossev.deviceProfileLib, line 781
*/ // library marker kkossev.deviceProfileLib, line 782
public Map inputIt(String paramPar, boolean debug = false) { // library marker kkossev.deviceProfileLib, line 783
String param = paramPar.trim() // library marker kkossev.deviceProfileLib, line 784
Map input = [:] // library marker kkossev.deviceProfileLib, line 785
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 786
if (!(param in DEVICE?.preferences)) { if (debug) { log.warn "inputIt: preference ${param} not defined for this device!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 787
Object preference // library marker kkossev.deviceProfileLib, line 788
try { preference = DEVICE?.preferences["$param"] } // library marker kkossev.deviceProfileLib, line 789
catch (e) { if (debug) { log.warn "inputIt: exception ${e} caught while parsing preference ${param} value ${preference}" } ; return [:] } // library marker kkossev.deviceProfileLib, line 790
// check for boolean values // library marker kkossev.deviceProfileLib, line 791
try { if (preference in [true, false]) { if (debug) { log.warn "inputIt: preference ${param} is boolean value ${preference} - skipping it for now!" } ; return [:] } } // library marker kkossev.deviceProfileLib, line 792
catch (e) { if (debug) { log.warn "inputIt: exception ${e} caught while checking for boolean values preference ${param} value ${preference}" } ; return [:] } // library marker kkossev.deviceProfileLib, line 793
/* // library marker kkossev.deviceProfileLib, line 794
// TODO - check if this is neccessary? isTuyaDP is not defined! // library marker kkossev.deviceProfileLib, line 795
try { isTuyaDP = preference.isNumber() } // library marker kkossev.deviceProfileLib, line 796
catch (e) { if (debug) { log.warn "inputIt: exception ${e} caught while checking isNumber() preference ${param} value ${preference}" } ; return [:] } // library marker kkossev.deviceProfileLib, line 797
*/ // library marker kkossev.deviceProfileLib, line 798
//if (debug) log.debug "inputIt: preference ${param} found. value is ${preference} isTuyaDP=${isTuyaDP}" // library marker kkossev.deviceProfileLib, line 799
foundMap = getPreferencesMapByName(param) // library marker kkossev.deviceProfileLib, line 800
//if (debug) log.debug "foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 801
if (foundMap == null || foundMap?.isEmpty()) { if (debug) { log.warn "inputIt: map not found for param '${param}'!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 802
if (foundMap.rw != 'rw') { if (debug) { log.warn "inputIt: param '${param}' is read only!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 803
if (foundMap.advanced != null && foundMap.advanced == true && settings.advancedOptions != true) { // library marker kkossev.deviceProfileLib, line 804
if (debug) { log.debug "inputIt: param '${param}' is advanced!" } // library marker kkossev.deviceProfileLib, line 805
return [:] // library marker kkossev.deviceProfileLib, line 806
} // library marker kkossev.deviceProfileLib, line 807
input.name = foundMap.name // library marker kkossev.deviceProfileLib, line 808
input.type = foundMap.type // bool, enum, number, decimal // library marker kkossev.deviceProfileLib, line 809
input.title = foundMap.title // library marker kkossev.deviceProfileLib, line 810
//input.description = (foundMap.description ?: foundMap.title)?.replaceAll(/<\/?b>/, '') // if description is not defined, use the title // library marker kkossev.deviceProfileLib, line 811
input.description = foundMap.description ?: '' // if description is not defined, skip it // library marker kkossev.deviceProfileLib, line 812
if (input.type in ['number', 'decimal']) { // library marker kkossev.deviceProfileLib, line 813
if (foundMap.min != null && foundMap.max != null) { // library marker kkossev.deviceProfileLib, line 814
//input.range = "${foundMap.min}..${foundMap.max}" // library marker kkossev.deviceProfileLib, line 815
input.range = "${Math.floor(foundMap.min) as int}..${Math.ceil(foundMap.max) as int}" // library marker kkossev.deviceProfileLib, line 816
} // library marker kkossev.deviceProfileLib, line 817
if (input.range != null && input.description != null) { // library marker kkossev.deviceProfileLib, line 818
if (input.description != '') { input.description += '
' } // library marker kkossev.deviceProfileLib, line 819
input.description += "Range: ${input.range}" // library marker kkossev.deviceProfileLib, line 820
if (foundMap.unit != null && foundMap.unit != '') { // library marker kkossev.deviceProfileLib, line 821
input.description += " (${foundMap.unit})" // library marker kkossev.deviceProfileLib, line 822
} // library marker kkossev.deviceProfileLib, line 823
} // library marker kkossev.deviceProfileLib, line 824
} // library marker kkossev.deviceProfileLib, line 825
/* groovylint-disable-next-line SpaceAfterClosingBrace */ // library marker kkossev.deviceProfileLib, line 826
else if (input.type == 'enum') { // library marker kkossev.deviceProfileLib, line 827
input.options = foundMap.map // library marker kkossev.deviceProfileLib, line 828
}/* // library marker kkossev.deviceProfileLib, line 829
else if (input.type == "bool") { // library marker kkossev.deviceProfileLib, line 830
input.options = ["true", "false"] // library marker kkossev.deviceProfileLib, line 831
}*/ // library marker kkossev.deviceProfileLib, line 832
else { // library marker kkossev.deviceProfileLib, line 833
if (debug) { log.warn "inputIt: unsupported type ${input.type} for param '${param}'!" } // library marker kkossev.deviceProfileLib, line 834
return [:] // library marker kkossev.deviceProfileLib, line 835
} // library marker kkossev.deviceProfileLib, line 836
if (input.defVal != null) { // library marker kkossev.deviceProfileLib, line 837
input.defVal = foundMap.defVal // library marker kkossev.deviceProfileLib, line 838
} // library marker kkossev.deviceProfileLib, line 839
return input // library marker kkossev.deviceProfileLib, line 840
} // library marker kkossev.deviceProfileLib, line 841
/** // library marker kkossev.deviceProfileLib, line 843
* Returns the device name and profile based on the device model and manufacturer. // library marker kkossev.deviceProfileLib, line 844
* @param model The device model (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 845
* @param manufacturer The device manufacturer (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 846
* @return A list containing the device name and profile. // library marker kkossev.deviceProfileLib, line 847
*/ // library marker kkossev.deviceProfileLib, line 848
public List getDeviceNameAndProfile(String model=null, String manufacturer=null) { // library marker kkossev.deviceProfileLib, line 849
String deviceName = UNKNOWN, deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 850
String deviceModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 851
String deviceManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 852
if (_DEBUG && SIMULATED_DEVICE_MODEL != null && SIMULATED_DEVICE_MANUFACTURER != null) { // library marker kkossev.deviceProfileLib, line 853
deviceModel = SIMULATED_DEVICE_MODEL // library marker kkossev.deviceProfileLib, line 854
deviceManufacturer = SIMULATED_DEVICE_MANUFACTURER // library marker kkossev.deviceProfileLib, line 855
logWarn "getDeviceNameAndProfile: using SIMULATED_DEVICE_MODEL ${SIMULATED_DEVICE_MODEL} and SIMULATED_DEVICE_MANUFACTURER ${SIMULATED_DEVICE_MANUFACTURER} in _DEBUG mode" // library marker kkossev.deviceProfileLib, line 856
} // library marker kkossev.deviceProfileLib, line 857
deviceProfilesV3.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 858
profileMap.fingerprints.each { fingerprint -> // library marker kkossev.deviceProfileLib, line 859
if (fingerprint.model == deviceModel && fingerprint.manufacturer == deviceManufacturer) { // library marker kkossev.deviceProfileLib, line 860
deviceProfile = profileName // library marker kkossev.deviceProfileLib, line 861
deviceName = fingerprint.deviceJoinName ?: deviceProfilesV3[deviceProfile].description ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 862
logDebug "found exact match for model ${deviceModel} manufacturer ${deviceManufacturer} : profileName=${deviceProfile} deviceName =${deviceName}" // library marker kkossev.deviceProfileLib, line 863
return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 864
} // library marker kkossev.deviceProfileLib, line 865
} // library marker kkossev.deviceProfileLib, line 866
} // library marker kkossev.deviceProfileLib, line 867
if (deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 868
logWarn "getDeviceNameAndProfile: NOT FOUND! deviceName =${deviceName} profileName=${deviceProfile} for model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 869
} // library marker kkossev.deviceProfileLib, line 870
return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 871
} // library marker kkossev.deviceProfileLib, line 872
// called from initializeVars( fullInit = true) // library marker kkossev.deviceProfileLib, line 874
public void setDeviceNameAndProfile(String model=null, String manufacturer=null) { // library marker kkossev.deviceProfileLib, line 875
def (String deviceName, String deviceProfile) = getDeviceNameAndProfile(model, manufacturer) // library marker kkossev.deviceProfileLib, line 876
if (deviceProfile == null || deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 877
logInfo "unknown model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 878
// don't change the device name when unknown // library marker kkossev.deviceProfileLib, line 879
state.deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 880
} // library marker kkossev.deviceProfileLib, line 881
String dataValueModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 882
String dataValueManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 883
if (deviceName != NULL && deviceName != UNKNOWN) { // library marker kkossev.deviceProfileLib, line 884
device.setName(deviceName) // library marker kkossev.deviceProfileLib, line 885
state.deviceProfile = deviceProfile // library marker kkossev.deviceProfileLib, line 886
device.updateSetting('forcedProfile', [value:deviceProfilesV3[deviceProfile]?.description, type:'enum']) // library marker kkossev.deviceProfileLib, line 887
logInfo "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was set to : deviceProfile=${deviceProfile} : deviceName=${deviceName}" // library marker kkossev.deviceProfileLib, line 888
} else { // library marker kkossev.deviceProfileLib, line 889
logInfo "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was not found!" // library marker kkossev.deviceProfileLib, line 890
} // library marker kkossev.deviceProfileLib, line 891
} // library marker kkossev.deviceProfileLib, line 892
public List refreshFromConfigureReadList(List refreshList) { // library marker kkossev.deviceProfileLib, line 894
logDebug "refreshFromConfigureReadList(${refreshList})" // library marker kkossev.deviceProfileLib, line 895
List cmds = [] // library marker kkossev.deviceProfileLib, line 896
if (refreshList != null && !refreshList.isEmpty()) { // library marker kkossev.deviceProfileLib, line 897
//List refreshList = DEVICE.refresh // library marker kkossev.deviceProfileLib, line 898
for (String k : refreshList) { // library marker kkossev.deviceProfileLib, line 899
k = k.replaceAll('\\[|\\]', '') // library marker kkossev.deviceProfileLib, line 900
if (k != null) { // library marker kkossev.deviceProfileLib, line 901
// check whether the string in the refreshList matches an attribute name in the DEVICE.attributes list // library marker kkossev.deviceProfileLib, line 902
Map map = DEVICE.attributes.find { it.name == k } // library marker kkossev.deviceProfileLib, line 903
if (map != null) { // library marker kkossev.deviceProfileLib, line 904
Map mfgCode = map.mfgCode != null ? ['mfgCode':map.mfgCode] : [:] // library marker kkossev.deviceProfileLib, line 905
cmds += zigbee.readAttribute(hubitat.helper.HexUtils.hexStringToInt((map.at).split(':')[0]), hubitat.helper.HexUtils.hexStringToInt((map.at).split(':')[1]), mfgCode, delay = 100) // library marker kkossev.deviceProfileLib, line 906
} // library marker kkossev.deviceProfileLib, line 907
// check whether the string in the refreshList matches a method defined somewhere in the code // library marker kkossev.deviceProfileLib, line 908
if (this.respondsTo(k)) { // library marker kkossev.deviceProfileLib, line 909
cmds += this."${k}"() // library marker kkossev.deviceProfileLib, line 910
} // library marker kkossev.deviceProfileLib, line 911
} // library marker kkossev.deviceProfileLib, line 912
} // library marker kkossev.deviceProfileLib, line 913
} // library marker kkossev.deviceProfileLib, line 914
return cmds // library marker kkossev.deviceProfileLib, line 915
} // library marker kkossev.deviceProfileLib, line 916
// called from customRefresh() in the device drivers // library marker kkossev.deviceProfileLib, line 918
public List refreshFromDeviceProfileList() { // library marker kkossev.deviceProfileLib, line 919
logDebug 'refreshFromDeviceProfileList()' // library marker kkossev.deviceProfileLib, line 920
List cmds = [] // library marker kkossev.deviceProfileLib, line 921
if (DEVICE?.refresh != null) { // library marker kkossev.deviceProfileLib, line 922
List refreshList = DEVICE.refresh // library marker kkossev.deviceProfileLib, line 923
for (String k : refreshList) { // library marker kkossev.deviceProfileLib, line 924
k = k.replaceAll('\\[|\\]', '') // library marker kkossev.deviceProfileLib, line 925
if (k != null) { // library marker kkossev.deviceProfileLib, line 926
// check whether the string in the refreshList matches an attribute name in the DEVICE.attributes list // library marker kkossev.deviceProfileLib, line 927
Map map = DEVICE.attributes.find { it.name == k } // library marker kkossev.deviceProfileLib, line 928
if (map != null) { // library marker kkossev.deviceProfileLib, line 929
Map mfgCode = map.mfgCode != null ? ['mfgCode':map.mfgCode] : [:] // library marker kkossev.deviceProfileLib, line 930
cmds += zigbee.readAttribute(hubitat.helper.HexUtils.hexStringToInt((map.at).split(':')[0]), hubitat.helper.HexUtils.hexStringToInt((map.at).split(':')[1]), mfgCode, delay = 100) // library marker kkossev.deviceProfileLib, line 931
} // library marker kkossev.deviceProfileLib, line 932
// check whether the string in the refreshList matches a method defined somewhere in the code // library marker kkossev.deviceProfileLib, line 933
if (this.respondsTo(k)) { // library marker kkossev.deviceProfileLib, line 934
cmds += this."${k}"() // library marker kkossev.deviceProfileLib, line 935
} // library marker kkossev.deviceProfileLib, line 936
} // library marker kkossev.deviceProfileLib, line 937
} // library marker kkossev.deviceProfileLib, line 938
} // library marker kkossev.deviceProfileLib, line 939
return cmds // library marker kkossev.deviceProfileLib, line 940
} // library marker kkossev.deviceProfileLib, line 941
// TODO! - remove? // library marker kkossev.deviceProfileLib, line 943
List refreshDeviceProfile() { // library marker kkossev.deviceProfileLib, line 944
List cmds = [] // library marker kkossev.deviceProfileLib, line 945
if (cmds == []) { cmds = ['delay 299'] } // library marker kkossev.deviceProfileLib, line 946
logDebug "refreshDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 947
return cmds // library marker kkossev.deviceProfileLib, line 948
} // library marker kkossev.deviceProfileLib, line 949
// TODO ! - remove? // library marker kkossev.deviceProfileLib, line 951
List configureDeviceProfile() { // library marker kkossev.deviceProfileLib, line 952
List cmds = [] // library marker kkossev.deviceProfileLib, line 953
logDebug "configureDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 954
if (cmds == []) { cmds = ['delay 299'] } // library marker kkossev.deviceProfileLib, line 955
return cmds // library marker kkossev.deviceProfileLib, line 956
} // library marker kkossev.deviceProfileLib, line 957
// TODO! - remove? // library marker kkossev.deviceProfileLib, line 959
List initializeDeviceProfile() { // library marker kkossev.deviceProfileLib, line 960
List cmds = [] // library marker kkossev.deviceProfileLib, line 961
logDebug "initializeDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 962
if (cmds == []) { cmds = ['delay 299',] } // library marker kkossev.deviceProfileLib, line 963
return cmds // library marker kkossev.deviceProfileLib, line 964
} // library marker kkossev.deviceProfileLib, line 965
public void deviceProfileInitializeVars(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 967
logDebug "deviceProfileInitializeVars(${fullInit})" // library marker kkossev.deviceProfileLib, line 968
if (state.deviceProfile == null) { // library marker kkossev.deviceProfileLib, line 969
setDeviceNameAndProfile() // library marker kkossev.deviceProfileLib, line 970
} // library marker kkossev.deviceProfileLib, line 971
} // library marker kkossev.deviceProfileLib, line 972
public void initEventsDeviceProfile(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 974
String ps = DEVICE?.device?.powerSource // library marker kkossev.deviceProfileLib, line 975
logDebug "initEventsDeviceProfile(${fullInit}) for deviceProfile=${state.deviceProfile} DEVICE?.device?.powerSource=${ps} ps.isEmpty()=${ps?.isEmpty()}" // library marker kkossev.deviceProfileLib, line 976
if (ps != null && !ps.isEmpty()) { // library marker kkossev.deviceProfileLib, line 977
sendEvent(name: 'powerSource', value: ps, descriptionText: "Power Source set to '${ps}'", type: 'digital') // library marker kkossev.deviceProfileLib, line 978
} // library marker kkossev.deviceProfileLib, line 979
} // library marker kkossev.deviceProfileLib, line 980
///////////////////////////// Tuya DPs ///////////////////////////////// // library marker kkossev.deviceProfileLib, line 982
// // library marker kkossev.deviceProfileLib, line 984
// called from parse() // library marker kkossev.deviceProfileLib, line 985
// returns: true - do not process this message if the spammy DP is defined in the spammyDPsToIgnore element of the active Device Profile // library marker kkossev.deviceProfileLib, line 986
// false - the processing can continue // library marker kkossev.deviceProfileLib, line 987
// // library marker kkossev.deviceProfileLib, line 988
public boolean isSpammyDPsToIgnore(Map descMap) { // library marker kkossev.deviceProfileLib, line 989
//log.trace "isSpammyDPsToIgnore: ${state.deviceProfile == 'TS0225_LINPTECH_RADAR'} ${descMap.cluster == 'E002'} ${descMap.attrId == 'E00A'} ${settings?.ignoreDistance == true}" // library marker kkossev.deviceProfileLib, line 990
if (state.deviceProfile == 'TS0225_LINPTECH_RADAR' && descMap.cluster == 'E002' && descMap.attrId == 'E00A' && settings?.ignoreDistance == true) { return true } // library marker kkossev.deviceProfileLib, line 991
if (!(descMap?.clusterId == 'EF00' && (descMap?.command in ['01', '02']))) { return false } // library marker kkossev.deviceProfileLib, line 992
if (descMap?.data?.size <= 2) { return false } // library marker kkossev.deviceProfileLib, line 993
int dp = zigbee.convertHexToInt(descMap.data[2]) // library marker kkossev.deviceProfileLib, line 994
List spammyList = deviceProfilesV3[getDeviceProfile()]?.spammyDPsToIgnore as List // library marker kkossev.deviceProfileLib, line 995
return (spammyList != null && (dp in spammyList) && ((settings?.ignoreDistance ?: false) == true)) // library marker kkossev.deviceProfileLib, line 996
} // library marker kkossev.deviceProfileLib, line 997
// // library marker kkossev.deviceProfileLib, line 999
// called from processTuyaDP(), processTuyaDPfromDeviceProfile(), isChattyDeviceReport() // library marker kkossev.deviceProfileLib, line 1000
// returns: true - do not generate Debug log messages if the chatty DP is defined in the spammyDPsToNotTrace element of the active Device Profile // library marker kkossev.deviceProfileLib, line 1001
// false - debug logs can be generated // library marker kkossev.deviceProfileLib, line 1002
// // library marker kkossev.deviceProfileLib, line 1003
public boolean isSpammyDPsToNotTrace(Map descMap) { // library marker kkossev.deviceProfileLib, line 1004
//log.trace "isSpammyDPsToNotTrace: ${state.deviceProfile == 'TS0225_LINPTECH_RADAR'} ${descMap.cluster == 'E002'} ${descMap.attrId == 'E00A'} ${settings?.ignoreDistance == true}" // library marker kkossev.deviceProfileLib, line 1005
if (state.deviceProfile == 'TS0225_LINPTECH_RADAR' && descMap.cluster == 'E002' && descMap.attrId == 'E00A' && settings?.ignoreDistance == true) { return true } // library marker kkossev.deviceProfileLib, line 1006
if (!(descMap?.clusterId == 'EF00' && (descMap?.command in ['01', '02']))) { return false } // library marker kkossev.deviceProfileLib, line 1007
if (descMap?.data?.size <= 2) { return false } // library marker kkossev.deviceProfileLib, line 1008
int dp = zigbee.convertHexToInt(descMap.data[2]) // library marker kkossev.deviceProfileLib, line 1009
List spammyList = deviceProfilesV3[getDeviceProfile()]?.spammyDPsToNotTrace as List // library marker kkossev.deviceProfileLib, line 1010
return (spammyList != null && (dp in spammyList)) // library marker kkossev.deviceProfileLib, line 1011
} // library marker kkossev.deviceProfileLib, line 1012
// all DPs are spammy - sent periodically! (this function is not used?) // library marker kkossev.deviceProfileLib, line 1014
public boolean isSpammyDeviceProfile() { // library marker kkossev.deviceProfileLib, line 1015
if (deviceProfilesV3 == null || deviceProfilesV3[getDeviceProfile()] == null) { return false } // library marker kkossev.deviceProfileLib, line 1016
Boolean isSpammy = deviceProfilesV3[getDeviceProfile()]?.device?.isSpammy ?: false // library marker kkossev.deviceProfileLib, line 1017
return isSpammy // library marker kkossev.deviceProfileLib, line 1018
} // library marker kkossev.deviceProfileLib, line 1019
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.deviceProfileLib, line 1021
private List