/* groovylint-disable CompileStatic, DuplicateListLiteral, DuplicateMapLiteral, DuplicateStringLiteral, ImplicitClosureParameter, MethodCount, MethodSize, NglParseError, NoDouble, PublicMethodsBeforeNonPublicMethods, StaticMethodsBeforeInstanceMethods, UnnecessaryGetter, UnnecessarySetter, UnusedImport */
/**
* Tuya Zigbee Thermostat - Device Driver for Hubitat Elevation
*
* https://community.hubitat.com/t/dynamic-capabilities-commands-and-attributes-for-drivers/98342
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License
* for the specific language governing permissions and limitations under the License.
*
* 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-16 kkossev - (dev. branch) added AVATTO_TRV06_TRV16_ME167_ME168_TRV profile
*
* TODO: AVATTO - hide Battery Voltage to Percentage; Minimum time between reports; better descriptions for anti-freeze and limescaleProtect preferences
* TODO: BEOK - needs retries, the first command is lost sometimes! :( Battery Voltage to Percentage
* TODO: BEOK: check calibration and correction DPs !!!
* TODO: BEOK: do NOT synchronize the clock between 00:00 and 09:00 local time !!
* TODO: add powerSource capability
* TODO: add Info dummy preference to the driver with a hyperlink
* TODO: add state.thermostat for storing last attributes
* TODO: Healthcheck to be every hour (not 4 hours) for mains powered thermostats
* TODO: add 'force manual mode' preference (like in the wall thermostat driver)
* TODO: option to disable the Auto mode ! (like in the wall thermostat driver)
* TODO: verify if onoffLib is needed
* TODO: BRT-100 : what is emergencyHeatingTime and boostTime ?
* TODO: initializeDeviceThermostat() - configure in the device profile !
* TODO: partial match for the fingerprint (model if Tuya, manufacturer for the rest)
* TODO: add [refresh] for battery heatingSetpoint thermostatOperatingState events and logs
* TODO: autoPollThermostat: no polling for device profile UNKNOWN
* TODO: configure the reporting for the 0x0201:0x0000 temperature ! (300..3600)
* TODO: Ping the device on initialize
* TODO: add factoryReset command Basic -0x0000 (Server); command 0x00
* TODO: add option 'Simple TRV' (no additinal attributes)
* TODO: HomeKit - min and max temperature limits?
* TODO: add receiveCheck() methods for heatingSetpint and mode (option)
* TODO: separate the autoPoll commands from the refresh commands (lite)
* TODO: All TRVs - after emergency heat, restore the last mode and heatingSetpoint
* TODO: VIRTUAL thermostat - option to simualate the thermostatOperatingState
* TODO: UNKNOWN TRV - update the deviceProfile - separate 'Unknown Tuya' and 'Unknown ZCL'
*/
static String version() { '3.3.2' }
static String timeStamp() { '2024/07/16 9:56 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, AVATTO
attribute 'batteryVoltage', 'number'
attribute 'boostTime', 'number' // BRT-100
attribute 'calibrated', 'enum', ['false', 'true'] // Aqara E1
attribute 'calibrationTemp', 'number' // BRT-100, Sonoff
attribute 'childLock', 'enum', ['off', 'on'] // BRT-100, Aqara E1, Sonoff, AVATTO
attribute 'ecoMode', 'enum', ['off', 'on'] // BRT-100
attribute 'ecoTemp', 'number' // BRT-100
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
attribute 'valveAlarm', 'enum', ['false', 'true'] // Aqara E1
attribute 'valveDetection', 'enum', ['off', 'on'] // Aqara E1
attribute 'weeklyProgram', 'number' // BRT-100
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 'workingState', "enum", ["open", "closed"] // BRT-100
// Aqaura E1 attributes TODO - consolidate a common set of attributes
attribute 'preset', 'enum', ['manual', 'auto', 'away'] // TODO - remove?
attribute 'awayPresetTemperature', 'number'
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
}
}
@Field static final Map deviceProfilesV3 = [
// 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':'sendSupportedThermostatModes', 'setHeatingSetpoint':'setHeatingSetpoint', 'resetStats':'resetStats', 'refresh':'refresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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 fully working yet!)',
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':'resetStats', 'refresh':'refresh', 'customRefresh':'customRefresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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 : [:]
],
'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 TRV'],
[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':'sendSupportedThermostatModes', 'setHeatingSetpoint':'setHeatingSetpoint', 'resetStats':'resetStats', 'refresh':'refresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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:28, name:'scheduleMonday', type:'number', rw: 'ro', description:'Schedule Monday'],
[dp:29, name:'scheduleTuesday', type:'number', rw: 'ro', description:'Schedule Tueasday'],
[dp:30, name:'scheduleWednesday', type:'number', rw: 'ro', description:'Schedule Wednesday'],
[dp:31, name:'scheduleThursday', type:'number', rw: 'ro', description:'Schedule Thursday'],
[dp:32, name:'scheduleFriday', type:'number', rw: 'ro', description:'Schedule Friday'],
[dp:33, name:'scheduleSaturday', type:'number', rw: 'ro', description:'Schedule Saturday'],
[dp:34, name:'scheduleSunday', type:'number', rw: 'ro', description:'Schedule Sunday'],
[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 : [:]
],
// ---------------------------------------------------- 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:"0000,0004,0005,EF00", 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 : [/*"pollTuya":"pollTuya","autoPollThermostat":"autoPollThermostat",*/ 'sendSupportedThermostatModes':'sendSupportedThermostatModes', 'setHeatingSetpoint':'setHeatingSetpoint', 'resetStats':'resetStats', 'refresh':'refresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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: 'Avatto Thermostat',
configuration : [:]
],
'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':'sendSupportedThermostatModes', 'setHeatingSetpoint':'setHeatingSetpoint', 'resetStats':'resetStats', 'refresh':'refresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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':'sendSupportedThermostatModes', 'setHeatingSetpoint':'setHeatingSetpoint', 'resetStats':'resetStats', 'refresh':'refresh', 'initialize':'initialize', 'updateAllPreferences': 'updateAllPreferences', 'resetPreferencesToDefaults':'resetPreferencesToDefaults', 'validateAndFixPreferences':'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:1, name:'systemMode', type:'enum', rw: 'rw', defVal:'1', map:[0: 'on', 1: 'off'], 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', 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 : [:]
]
]
/*
* -----------------------------------------------------------------------------
* 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 (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()
}
}
// called from initializeVars() in the main code ...
void customInitEvents(final boolean fullInit=false) {
logDebug "customInitEvents(${fullInit})"
thermostatInitEvents(fullInit)
}
// called from processFoundItem (processTuyaDPfromDeviceProfile and ) processClusterAttributeFromDeviceProfile in deviceProfileLib when a Zigbee message was found defined in the device profile map
//
// TODO !
//
/* groovylint-disable-next-line MethodParameterTypeRequired, NoDef */
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' :
sendHeatingSetpointEvent(valueScaled)
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 (device.currentValue('systemMode') == 'off' ) {
logWarn "customProcessDeviceProfileEvent: ignoring the thermostatMode ${valueScaled} event, because the systemMode is off"
}
else {
sendEvent(eventMap)
logInfo "${descText}"
state.lastThermostatMode = valueScaled
}
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
/*
case "workingState" : // BRT-100 replaced with thermostatOperatingState
sendEvent(eventMap)
logInfo "${descText}"
if (valueScaled == "closed") { // the valve is closed
sendEvent(name: "thermostatOperatingState", value: "idle", isStateChange: true, description: "BRT-100 workingState is closed")
}
else {
sendEvent(name: "thermostatOperatingState", value: "heating", isStateChange: true, description: "BRT-100 workingState is open")
}
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 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/development/libraries/commonLib.groovy', documentationLink: '', // library marker kkossev.commonLib, line 4
version: '3.3.2' // 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
* ver. 2.0.0 2023-05-08 kkossev - first published version 2.x.x // library marker kkossev.commonLib, line 24
* ver. 2.1.6 2023-11-06 kkossev - last update on version 2.x.x // library marker kkossev.commonLib, line 25
* ver. 3.0.0 2023-11-16 kkossev - first version 3.x.x // library marker kkossev.commonLib, line 26
* ver. 3.0.1 2023-12-06 kkossev - info event renamed to Status; txtEnable and logEnable moved to the custom driver settings; 0xFC11 cluster; logEnable is false by default; checkDriverVersion is called on updated() and on healthCheck(); // library marker kkossev.commonLib, line 27
* ver. 3.0.2 2023-12-17 kkossev - configure() changes; Groovy Lint, Format and Fix v3.0.0 // library marker kkossev.commonLib, line 28
* ver. 3.0.3 2024-03-17 kkossev - more groovy lint; support for deviceType Plug; ignore repeated temperature readings; cleaned thermostat specifics; cleaned AirQuality specifics; removed IRBlaster type; removed 'radar' type; threeStateEnable initlilization // library marker kkossev.commonLib, line 29
* ver. 3.0.4 2024-04-02 kkossev - removed Button, buttonDimmer and Fingerbot specifics; batteryVoltage bug fix; inverceSwitch bug fix; parseE002Cluster; // library marker kkossev.commonLib, line 30
* ver. 3.0.5 2024-04-05 kkossev - button methods bug fix; configure() bug fix; handlePm25Event bug fix; // library marker kkossev.commonLib, line 31
* ver. 3.0.6 2024-04-08 kkossev - removed isZigUSB() dependency; removed aqaraCube() dependency; removed button code; removed lightSensor code; moved zigbeeGroups and level and battery methods to dedicated libs + setLevel bug fix; // library marker kkossev.commonLib, line 32
* ver. 3.0.7 2024-04-23 kkossev - tuyaMagic() for Tuya devices only; added stats cfgCtr, instCtr rejoinCtr, matchDescCtr, activeEpRqCtr; trace ZDO commands; added 0x0406 OccupancyCluster; reduced debug for chatty devices; // library marker kkossev.commonLib, line 33
* ver. 3.1.0 2024-04-28 kkossev - unnecesery unschedule() speed optimization; added syncTuyaDateTime(); tuyaBlackMagic() initialization bug fix. // library marker kkossev.commonLib, line 34
* ver. 3.1.1 2024-05-05 kkossev - getTuyaAttributeValue bug fix; added customCustomParseIlluminanceCluster method // library marker kkossev.commonLib, line 35
* ver. 3.2.0 2024-05-23 kkossev - standardParse____Cluster and customParse___Cluster methods; moved onOff methods to a new library; rename all custom handlers in the libs to statdndardParseXXX // library marker kkossev.commonLib, line 36
* ver. 3.2.1 2024-06-05 kkossev - 4 in 1 V3 compatibility; added IAS cluster; setDeviceNameAndProfile() fix; // library marker kkossev.commonLib, line 37
* ver. 3.2.2 2024-06-12 kkossev - removed isAqaraTRV_OLD() and isAqaraTVOC_OLD() dependencies from the lib; added timeToHMS(); metering and electricalMeasure clusters swapped bug fix; added cluster 0x0204; // library marker kkossev.commonLib, line 38
* ver. 3.3.0 2024-06-25 kkossev - fixed exception for unknown clusters; added cluster 0xE001; added powerSource - if 5 minutes after initialize() the powerSource is still unknown, query the device for the powerSource // library marker kkossev.commonLib, line 39
* ver. 3.3.1 2024-07-06 kkossev - removed isFingerbot() dependancy; added FC03 cluster (Frient); removed noDef from the linter; added customParseIasMessage and standardParseIasMessage; powerSource set to unknown on initialize(); // library marker kkossev.commonLib, line 40
* ver. 3.3.2 2024-07-12 kkossev - (dev.branch) added PollControl (0x0020) cluster; ping for SONOFF // library marker kkossev.commonLib, line 41
* // library marker kkossev.commonLib, line 42
* TODO: check deviceCommandTimeout() // library marker kkossev.commonLib, line 43
* TODO: offlineCtr is not increasing! (ZBMicro); // library marker kkossev.commonLib, line 44
* TODO: when device rejoins the network, read the battery percentage again (probably in custom handler, not for all devices) // library marker kkossev.commonLib, line 45
* TODO: refresh() to include updating the softwareBuild data version // library marker kkossev.commonLib, line 46
* TODO: map the ZCL powerSource options to Hubitat powerSource options // library marker kkossev.commonLib, line 47
* TODO: MOVE ZDO counters to health state? // library marker kkossev.commonLib, line 48
* TODO: refresh() to bypass the duplicated events and minimim delta time between events checks // library marker kkossev.commonLib, line 49
* TODO: Versions of the main module + included libraries (in the 'Tuya Device' driver?) // library marker kkossev.commonLib, line 50
* TODO: add GetInfo (endpoints list) command (in the 'Tuya Device' driver?) // library marker kkossev.commonLib, line 51
* TODO: disableDefaultResponse for Tuya commands // library marker kkossev.commonLib, line 52
* // library marker kkossev.commonLib, line 53
*/ // library marker kkossev.commonLib, line 54
String commonLibVersion() { '3.3.2' } // library marker kkossev.commonLib, line 56
String commonLibStamp() { '2024/07/12 8:53 PM' } // library marker kkossev.commonLib, line 57
import groovy.transform.Field // library marker kkossev.commonLib, line 59
import hubitat.device.HubMultiAction // library marker kkossev.commonLib, line 60
import hubitat.device.Protocol // library marker kkossev.commonLib, line 61
import hubitat.helper.HexUtils // library marker kkossev.commonLib, line 62
import hubitat.zigbee.zcl.DataType // library marker kkossev.commonLib, line 63
import java.util.concurrent.ConcurrentHashMap // library marker kkossev.commonLib, line 64
import groovy.json.JsonOutput // library marker kkossev.commonLib, line 65
import groovy.transform.CompileStatic // library marker kkossev.commonLib, line 66
import java.math.BigDecimal // library marker kkossev.commonLib, line 67
metadata { // library marker kkossev.commonLib, line 69
if (_DEBUG) { // library marker kkossev.commonLib, line 70
command 'test', [[name: 'test', type: 'STRING', description: 'test', defaultValue : '']] // library marker kkossev.commonLib, line 71
command 'testParse', [[name: 'testParse', type: 'STRING', description: 'testParse', defaultValue : '']] // library marker kkossev.commonLib, line 72
command 'tuyaTest', [ // library marker kkossev.commonLib, line 73
[name:'dpCommand', type: 'STRING', description: 'Tuya DP Command', constraints: ['STRING']], // library marker kkossev.commonLib, line 74
[name:'dpValue', type: 'STRING', description: 'Tuya DP value', constraints: ['STRING']], // library marker kkossev.commonLib, line 75
[name:'dpType', type: 'ENUM', constraints: ['DP_TYPE_VALUE', 'DP_TYPE_BOOL', 'DP_TYPE_ENUM'], description: 'DP data type'] // library marker kkossev.commonLib, line 76
] // library marker kkossev.commonLib, line 77
} // library marker kkossev.commonLib, line 78
// common capabilities for all device types // library marker kkossev.commonLib, line 80
capability 'Configuration' // library marker kkossev.commonLib, line 81
capability 'Refresh' // library marker kkossev.commonLib, line 82
capability 'HealthCheck' // library marker kkossev.commonLib, line 83
capability 'PowerSource' // powerSource - ENUM ["battery", "dc", "mains", "unknown"] // library marker kkossev.commonLib, line 84
// common attributes for all device types // library marker kkossev.commonLib, line 86
attribute 'healthStatus', 'enum', ['unknown', 'offline', 'online'] // library marker kkossev.commonLib, line 87
attribute 'rtt', 'number' // library marker kkossev.commonLib, line 88
attribute 'Status', 'string' // library marker kkossev.commonLib, line 89
// common commands for all device types // library marker kkossev.commonLib, line 91
command 'configure', [[name:'normally it is not needed to configure anything', type: 'ENUM', constraints: /*['--- select ---'] +*/ ConfigureOpts.keySet() as List]] // library marker kkossev.commonLib, line 92
// trap for Hubitat F2 bug // library marker kkossev.commonLib, line 94
fingerprint profileId:'0104', endpointId:'F2', inClusters:'', outClusters:'', model:'unknown', manufacturer:'unknown', deviceJoinName: 'Zigbee device affected by Hubitat F2 bug' // library marker kkossev.commonLib, line 95
preferences { // library marker kkossev.commonLib, line 97
// txtEnable and logEnable moved to the custom driver settings - coopy& paste there ... // library marker kkossev.commonLib, line 98
//input name: 'txtEnable', type: 'bool', title: 'Enable descriptionText logging', defaultValue: true, description: 'Enables command logging.' // library marker kkossev.commonLib, line 99
//input name: 'logEnable', type: 'bool', title: 'Enable debug logging', defaultValue: true, description: 'Turns on debug logging for 24 hours.' // library marker kkossev.commonLib, line 100
if (device) { // library marker kkossev.commonLib, line 102
input name: 'advancedOptions', type: 'bool', title: 'Advanced Options', description: 'These advanced options should be already automatically set in an optimal way for your device...', defaultValue: false // library marker kkossev.commonLib, line 103
if (advancedOptions == true) { // library marker kkossev.commonLib, line 104
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 105
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 106
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 107
} // library marker kkossev.commonLib, line 108
} // library marker kkossev.commonLib, line 109
} // library marker kkossev.commonLib, line 110
} // library marker kkossev.commonLib, line 111
@Field static final Integer DIGITAL_TIMER = 1000 // command was sent by this driver // library marker kkossev.commonLib, line 113
@Field static final Integer REFRESH_TIMER = 6000 // refresh time in miliseconds // library marker kkossev.commonLib, line 114
@Field static final Integer DEBOUNCING_TIMER = 300 // ignore switch events // library marker kkossev.commonLib, line 115
@Field static final Integer COMMAND_TIMEOUT = 10 // timeout time in seconds // library marker kkossev.commonLib, line 116
@Field static final Integer MAX_PING_MILISECONDS = 10000 // rtt more than 10 seconds will be ignored // library marker kkossev.commonLib, line 117
@Field static final String UNKNOWN = 'UNKNOWN' // library marker kkossev.commonLib, line 118
@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 119
@Field static final Integer DEFAULT_MAX_REPORTING_TIME = 3600 // library marker kkossev.commonLib, line 120
@Field static final Integer PRESENCE_COUNT_THRESHOLD = 3 // missing 3 checks will set the device healthStatus to offline // library marker kkossev.commonLib, line 121
@Field static final int DELAY_MS = 200 // Delay in between zigbee commands // library marker kkossev.commonLib, line 122
@Field static final Integer INFO_AUTO_CLEAR_PERIOD = 60 // automatically clear the Info attribute after 60 seconds // library marker kkossev.commonLib, line 123
@Field static final Map HealthcheckMethodOpts = [ // used by healthCheckMethod // library marker kkossev.commonLib, line 125
defaultValue: 1, options: [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] // library marker kkossev.commonLib, line 126
] // library marker kkossev.commonLib, line 127
@Field static final Map HealthcheckIntervalOpts = [ // used by healthCheckInterval // library marker kkossev.commonLib, line 128
defaultValue: 240, options: [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 129
] // library marker kkossev.commonLib, line 130
@Field static final Map ConfigureOpts = [ // library marker kkossev.commonLib, line 132
'Configure the device' : [key:2, function: 'configureNow'], // library marker kkossev.commonLib, line 133
'Reset Statistics' : [key:9, function: 'resetStatistics'], // library marker kkossev.commonLib, line 134
' -- ' : [key:3, function: 'configureHelp'], // library marker kkossev.commonLib, line 135
'Delete All Preferences' : [key:4, function: 'deleteAllSettings'], // library marker kkossev.commonLib, line 136
'Delete All Current States' : [key:5, function: 'deleteAllCurrentStates'], // library marker kkossev.commonLib, line 137
'Delete All Scheduled Jobs' : [key:6, function: 'deleteAllScheduledJobs'], // library marker kkossev.commonLib, line 138
'Delete All State Variables' : [key:7, function: 'deleteAllStates'], // library marker kkossev.commonLib, line 139
'Delete All Child Devices' : [key:8, function: 'deleteAllChildDevices'], // library marker kkossev.commonLib, line 140
' - ' : [key:1, function: 'configureHelp'], // library marker kkossev.commonLib, line 141
'*** LOAD ALL DEFAULTS ***' : [key:0, function: 'loadAllDefaults'] // library marker kkossev.commonLib, line 142
] // library marker kkossev.commonLib, line 143
public boolean isVirtual() { device.controllerType == null || device.controllerType == '' } // library marker kkossev.commonLib, line 145
/** // library marker kkossev.commonLib, line 147
* Parse Zigbee message // library marker kkossev.commonLib, line 148
* @param description Zigbee message in hex format // library marker kkossev.commonLib, line 149
*/ // library marker kkossev.commonLib, line 150
public void parse(final String description) { // library marker kkossev.commonLib, line 151
checkDriverVersion(state) // +1 ms // library marker kkossev.commonLib, line 152
updateRxStats(state) // +1 ms // library marker kkossev.commonLib, line 153
unscheduleCommandTimeoutCheck(state) // library marker kkossev.commonLib, line 154
setHealthStatusOnline(state) // +2 ms // library marker kkossev.commonLib, line 155
if (description?.startsWith('zone status') || description?.startsWith('zone report')) { // library marker kkossev.commonLib, line 157
logDebug "parse: zone status: $description" // library marker kkossev.commonLib, line 158
if (this.respondsTo('customParseIasMessage')) { customParseIasMessage(description) } // library marker kkossev.commonLib, line 159
else if (this.respondsTo('standardParseIasMessage')) { standardParseIasMessage(description) } // library marker kkossev.commonLib, line 160
else if (this.respondsTo('parseIasMessage')) { parseIasMessage(description) } // library marker kkossev.commonLib, line 161
else { logDebug "ignored IAS zone status (no IAS parser) description: $description" } // library marker kkossev.commonLib, line 162
return // library marker kkossev.commonLib, line 163
} // library marker kkossev.commonLib, line 164
else if (description?.startsWith('enroll request')) { // library marker kkossev.commonLib, line 165
logDebug "parse: enroll request: $description" // library marker kkossev.commonLib, line 166
/* 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 167
if (settings?.logEnable) { logInfo 'Sending IAS enroll response...' } // library marker kkossev.commonLib, line 168
List cmds = zigbee.enrollResponse() + zigbee.readAttribute(0x0500, 0x0000) // library marker kkossev.commonLib, line 169
logDebug "enroll response: ${cmds}" // library marker kkossev.commonLib, line 170
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 171
return // library marker kkossev.commonLib, line 172
} // library marker kkossev.commonLib, line 173
if (isTuyaE00xCluster(description) == true || otherTuyaOddities(description) == true) { // +15 ms // library marker kkossev.commonLib, line 175
return // library marker kkossev.commonLib, line 176
} // library marker kkossev.commonLib, line 177
final Map descMap = myParseDescriptionAsMap(description) // +5 ms // library marker kkossev.commonLib, line 178
if (!isChattyDeviceReport(descMap)) { logDebug "parse: descMap = ${descMap} description=${description }" } // library marker kkossev.commonLib, line 180
if (isSpammyDeviceReport(descMap)) { return } // +20 mS (both) // library marker kkossev.commonLib, line 181
if (descMap.profileId == '0000') { // library marker kkossev.commonLib, line 183
parseZdoClusters(descMap) // library marker kkossev.commonLib, line 184
return // library marker kkossev.commonLib, line 185
} // library marker kkossev.commonLib, line 186
if (descMap.isClusterSpecific == false) { // library marker kkossev.commonLib, line 187
parseGeneralCommandResponse(descMap) // library marker kkossev.commonLib, line 188
return // library marker kkossev.commonLib, line 189
} // library marker kkossev.commonLib, line 190
// // library marker kkossev.commonLib, line 191
if (standardAndCustomParseCluster(descMap, description)) { return } // library marker kkossev.commonLib, line 192
// // library marker kkossev.commonLib, line 193
switch (descMap.clusterInt as Integer) { // library marker kkossev.commonLib, line 194
case 0x000C : // special case : ZigUSB // Aqara TVOC Air Monitor; Aqara Cube T1 Pro; // library marker kkossev.commonLib, line 195
if (this.respondsTo('customParseAnalogInputClusterDescription')) { // library marker kkossev.commonLib, line 196
customParseAnalogInputClusterDescription(descMap, description) // ZigUSB // library marker kkossev.commonLib, line 197
descMap.remove('additionalAttrs')?.each { final Map map -> customParseAnalogInputClusterDescription(descMap + map, description) } // library marker kkossev.commonLib, line 198
} // library marker kkossev.commonLib, line 199
break // library marker kkossev.commonLib, line 200
case 0x0300 : // Patch - need refactoring of the standardParseColorControlCluster ! // library marker kkossev.commonLib, line 201
if (this.respondsTo('standardParseColorControlCluster')) { // library marker kkossev.commonLib, line 202
standardParseColorControlCluster(descMap, description) // library marker kkossev.commonLib, line 203
descMap.remove('additionalAttrs')?.each { final Map map -> standardParseColorControlCluster(descMap + map, description) } // library marker kkossev.commonLib, line 204
} // library marker kkossev.commonLib, line 205
break // library marker kkossev.commonLib, line 206
default: // library marker kkossev.commonLib, line 207
if (settings.logEnable) { // library marker kkossev.commonLib, line 208
logWarn "parse: zigbee received unknown cluster:${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 209
} // library marker kkossev.commonLib, line 210
break // library marker kkossev.commonLib, line 211
} // library marker kkossev.commonLib, line 212
} // library marker kkossev.commonLib, line 213
@Field static final Map ClustersMap = [ // library marker kkossev.commonLib, line 215
0x0000: 'Basic', 0x0001: 'Power', 0x0003: 'Identify', 0x0004: 'Groups', 0x0005: 'Scenes', 0x0006: 'OnOff', 0x0008: 'LevelControl', // library marker kkossev.commonLib, line 216
0x000C: 'AnalogInput', 0x0012: 'MultistateInput', 0x0020: 'PollControl', 0x0102: 'WindowCovering', 0x0201: 'Thermostat', 0x0204: 'ThermostatConfig',/*0x0300: 'ColorControl',*/ // library marker kkossev.commonLib, line 217
0x0400: 'Illuminance', 0x0402: 'Temperature', 0x0405: 'Humidity', 0x0406: 'Occupancy', 0x042A: 'Pm25', 0x0500: 'IAS', 0x0702: 'Metering', // library marker kkossev.commonLib, line 218
0x0B04: 'ElectricalMeasure', 0xE001: 'E0001', 0xE002: 'E002', 0xEC03: 'EC03', 0xEF00: 'Tuya', 0xFC03: 'FC03', 0xFC11: 'FC11', 0xFC7E: 'AirQualityIndex', // Sensirion VOC index // library marker kkossev.commonLib, line 219
0xFCC0: 'XiaomiFCC0', // library marker kkossev.commonLib, line 220
] // library marker kkossev.commonLib, line 221
// first try calling the custom parser, if not found, call the standard parser // library marker kkossev.commonLib, line 223
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.commonLib, line 224
boolean standardAndCustomParseCluster(Map descMap, final String description) { // library marker kkossev.commonLib, line 225
Integer clusterInt = descMap.clusterInt as Integer // library marker kkossev.commonLib, line 226
String clusterName = ClustersMap[clusterInt] ?: UNKNOWN // library marker kkossev.commonLib, line 227
if (clusterName == null || clusterName == UNKNOWN) { // library marker kkossev.commonLib, line 228
logWarn "standardAndCustomParseCluster: zigbee received unknown cluster:0x${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 229
return false // library marker kkossev.commonLib, line 230
} // library marker kkossev.commonLib, line 231
String customParser = "customParse${clusterName}Cluster" // library marker kkossev.commonLib, line 232
// 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 233
if (this.respondsTo(customParser)) { // library marker kkossev.commonLib, line 234
this."${customParser}"(descMap) // library marker kkossev.commonLib, line 235
descMap.remove('additionalAttrs')?.each { final Map map -> this."${customParser}"(descMap + map) } // library marker kkossev.commonLib, line 236
return true // library marker kkossev.commonLib, line 237
} // library marker kkossev.commonLib, line 238
String standardParser = "standardParse${clusterName}Cluster" // library marker kkossev.commonLib, line 239
// if no custom parser is defined, try the standard parser (if exists), eventually defined in the included library file // library marker kkossev.commonLib, line 240
if (this.respondsTo(standardParser)) { // library marker kkossev.commonLib, line 241
this."${standardParser}"(descMap) // library marker kkossev.commonLib, line 242
descMap.remove('additionalAttrs')?.each { final Map map -> this."${standardParser}"(descMap + map) } // library marker kkossev.commonLib, line 243
return true // library marker kkossev.commonLib, line 244
} // library marker kkossev.commonLib, line 245
if (device?.getDataValue('model') != 'ZigUSB' && descMap.cluster != '0300') { // patch! // library marker kkossev.commonLib, line 246
logWarn "standardAndCustomParseCluster: Missing ${standardParser} or ${customParser} handler for cluster:0x${descMap.cluster} (${descMap.clusterInt}) message (${descMap})" // library marker kkossev.commonLib, line 247
} // library marker kkossev.commonLib, line 248
return false // library marker kkossev.commonLib, line 249
} // library marker kkossev.commonLib, line 250
private static void updateRxStats(final Map state) { // library marker kkossev.commonLib, line 252
if (state.stats != null) { state.stats['rxCtr'] = (state.stats['rxCtr'] ?: 0) + 1 } else { state.stats = [:] } // +5ms // library marker kkossev.commonLib, line 253
} // library marker kkossev.commonLib, line 254
public boolean isChattyDeviceReport(final Map descMap) { // when @CompileStatis is slower? // library marker kkossev.commonLib, line 256
if (_TRACE_ALL == true) { return false } // library marker kkossev.commonLib, line 257
if (this.respondsTo('isSpammyDPsToNotTrace')) { // defined in deviceProfileLib // library marker kkossev.commonLib, line 258
return isSpammyDPsToNotTrace(descMap) // library marker kkossev.commonLib, line 259
} // library marker kkossev.commonLib, line 260
return false // library marker kkossev.commonLib, line 261
} // library marker kkossev.commonLib, line 262
public boolean isSpammyDeviceReport(final Map descMap) { // library marker kkossev.commonLib, line 264
if (_TRACE_ALL == true) { return false } // library marker kkossev.commonLib, line 265
if (this.respondsTo('isSpammyDPsToIgnore')) { // defined in deviceProfileLib // library marker kkossev.commonLib, line 266
return isSpammyDPsToIgnore(descMap) // library marker kkossev.commonLib, line 267
} // library marker kkossev.commonLib, line 268
return false // library marker kkossev.commonLib, line 269
} // library marker kkossev.commonLib, line 270
public boolean isSpammyTuyaRadar() { // library marker kkossev.commonLib, line 272
if (_TRACE_ALL == true) { return false } // library marker kkossev.commonLib, line 273
if (this.respondsTo('isSpammyDeviceProfile'())) { // defined in deviceProfileLib // library marker kkossev.commonLib, line 274
return isSpammyDeviceProfile() // library marker kkossev.commonLib, line 275
} // library marker kkossev.commonLib, line 276
return false // library marker kkossev.commonLib, line 277
} // library marker kkossev.commonLib, line 278
@Field static final Map ZdoClusterEnum = [ // library marker kkossev.commonLib, line 280
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 281
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 282
0x8021: 'Bind Response', 0x8022: 'Unbind Response', 0x8023: 'Bind Register Response', 0x8034: 'Management Leave Response' // library marker kkossev.commonLib, line 283
] // library marker kkossev.commonLib, line 284
// ZDO (Zigbee Data Object) Clusters Parsing // library marker kkossev.commonLib, line 286
private void parseZdoClusters(final Map descMap) { // library marker kkossev.commonLib, line 287
if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 288
final Integer clusterId = descMap.clusterInt as Integer // library marker kkossev.commonLib, line 289
final String clusterName = ZdoClusterEnum[clusterId] ?: "UNKNOWN_CLUSTER (0x${descMap.clusterId})" // library marker kkossev.commonLib, line 290
final String statusHex = ((List)descMap.data)[1] // library marker kkossev.commonLib, line 291
final Integer statusCode = hexStrToUnsignedInt(statusHex) // library marker kkossev.commonLib, line 292
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${statusHex}" // library marker kkossev.commonLib, line 293
final String clusterInfo = "${device.displayName} Received ZDO ${clusterName} (0x${descMap.clusterId}) status ${statusName}" // library marker kkossev.commonLib, line 294
List cmds = [] // library marker kkossev.commonLib, line 295
switch (clusterId) { // library marker kkossev.commonLib, line 296
case 0x0005 : // library marker kkossev.commonLib, line 297
state.stats['activeEpRqCtr'] = (state.stats['activeEpRqCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 298
if (settings?.logEnable) { log.debug "${clusterInfo}, data=${descMap.data} (Sequence Number:${descMap.data[0]}, data:${descMap.data})" } // library marker kkossev.commonLib, line 299
// send the active endpoint response // library marker kkossev.commonLib, line 300
cmds += ["he raw ${device.deviceNetworkId} 0 0 0x8005 {00 00 00 00 01 01} {0x0000}"] // library marker kkossev.commonLib, line 301
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 302
break // library marker kkossev.commonLib, line 303
case 0x0006 : // library marker kkossev.commonLib, line 304
state.stats['matchDescCtr'] = (state.stats['matchDescCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 305
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 306
cmds += ["he raw ${device.deviceNetworkId} 0 0 0x8006 {00 00 00 00 00} {0x0000}"] // library marker kkossev.commonLib, line 307
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 308
break // library marker kkossev.commonLib, line 309
case 0x0013 : // device announcement // library marker kkossev.commonLib, line 310
state.stats['rejoinCtr'] = (state.stats['rejoinCtr'] ?: 0) + 1 // library marker kkossev.commonLib, line 311
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 312
break // library marker kkossev.commonLib, line 313
case 0x8004 : // simple descriptor response // library marker kkossev.commonLib, line 314
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 315
//parseSimpleDescriptorResponse( descMap ) // library marker kkossev.commonLib, line 316
break // library marker kkossev.commonLib, line 317
case 0x8005 : // endpoint response // library marker kkossev.commonLib, line 318
String endpointCount = descMap.data[4] // library marker kkossev.commonLib, line 319
String endpointList = descMap.data[5] // library marker kkossev.commonLib, line 320
if (settings?.logEnable) { log.debug "${clusterInfo}, (endpoint response) endpointCount = ${endpointCount} endpointList = ${endpointList}" } // library marker kkossev.commonLib, line 321
break // library marker kkossev.commonLib, line 322
case 0x8021 : // bind response // library marker kkossev.commonLib, line 323
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 324
break // library marker kkossev.commonLib, line 325
case 0x8022 : //unbind request // library marker kkossev.commonLib, line 326
case 0x8034 : //leave response // library marker kkossev.commonLib, line 327
if (settings?.logEnable) { log.debug "${clusterInfo}" } // library marker kkossev.commonLib, line 328
break // library marker kkossev.commonLib, line 329
default : // library marker kkossev.commonLib, line 330
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 331
break // library marker kkossev.commonLib, line 332
} // library marker kkossev.commonLib, line 333
if (this.respondsTo('customParseZdoClusters')) { customParseZdoClusters(descMap) } // library marker kkossev.commonLib, line 334
} // library marker kkossev.commonLib, line 335
// Zigbee General Command Parsing // library marker kkossev.commonLib, line 337
private void parseGeneralCommandResponse(final Map descMap) { // library marker kkossev.commonLib, line 338
final int commandId = hexStrToUnsignedInt(descMap.command) // library marker kkossev.commonLib, line 339
switch (commandId) { // library marker kkossev.commonLib, line 340
case 0x01: parseReadAttributeResponse(descMap); break // library marker kkossev.commonLib, line 341
case 0x04: parseWriteAttributeResponse(descMap); break // library marker kkossev.commonLib, line 342
case 0x07: parseConfigureResponse(descMap); break // library marker kkossev.commonLib, line 343
case 0x09: parseReadReportingConfigResponse(descMap); break // library marker kkossev.commonLib, line 344
case 0x0B: parseDefaultCommandResponse(descMap); break // library marker kkossev.commonLib, line 345
default: // library marker kkossev.commonLib, line 346
final String commandName = ZigbeeGeneralCommandEnum[commandId] ?: "UNKNOWN_COMMAND (0x${descMap.command})" // library marker kkossev.commonLib, line 347
final String clusterName = clusterLookup(descMap.clusterInt) // library marker kkossev.commonLib, line 348
final String status = descMap.data in List ? ((List)descMap.data).last() : descMap.data // library marker kkossev.commonLib, line 349
final int statusCode = hexStrToUnsignedInt(status) // library marker kkossev.commonLib, line 350
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" // library marker kkossev.commonLib, line 351
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 352
log.warn "zigbee ${commandName} ${clusterName} error: ${statusName}" // library marker kkossev.commonLib, line 353
} else if (settings.logEnable) { // library marker kkossev.commonLib, line 354
log.trace "zigbee ${commandName} ${clusterName}: ${descMap.data}" // library marker kkossev.commonLib, line 355
} // library marker kkossev.commonLib, line 356
break // library marker kkossev.commonLib, line 357
} // library marker kkossev.commonLib, line 358
} // library marker kkossev.commonLib, line 359
// Zigbee Read Attribute Response Parsing // library marker kkossev.commonLib, line 361
private void parseReadAttributeResponse(final Map descMap) { // library marker kkossev.commonLib, line 362
final List data = descMap.data as List // library marker kkossev.commonLib, line 363
final String attribute = data[1] + data[0] // library marker kkossev.commonLib, line 364
final int statusCode = hexStrToUnsignedInt(data[2]) // library marker kkossev.commonLib, line 365
final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data}" // library marker kkossev.commonLib, line 366
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 367
logWarn "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} error: ${status}" // library marker kkossev.commonLib, line 368
} // library marker kkossev.commonLib, line 369
else { // library marker kkossev.commonLib, line 370
logDebug "zigbee read ${clusterLookup(descMap.clusterInt)} attribute 0x${attribute} response: ${status} ${data}" // library marker kkossev.commonLib, line 371
} // library marker kkossev.commonLib, line 372
} // library marker kkossev.commonLib, line 373
// Zigbee Write Attribute Response Parsing // library marker kkossev.commonLib, line 375
private void parseWriteAttributeResponse(final Map descMap) { // library marker kkossev.commonLib, line 376
final String data = descMap.data in List ? ((List)descMap.data).first() : descMap.data // library marker kkossev.commonLib, line 377
final int statusCode = hexStrToUnsignedInt(data) // library marker kkossev.commonLib, line 378
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${data}" // library marker kkossev.commonLib, line 379
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 380
logWarn "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute error: ${statusName}" // library marker kkossev.commonLib, line 381
} // library marker kkossev.commonLib, line 382
else { // library marker kkossev.commonLib, line 383
logDebug "zigbee response write ${clusterLookup(descMap.clusterInt)} attribute response: ${statusName}" // library marker kkossev.commonLib, line 384
} // library marker kkossev.commonLib, line 385
} // library marker kkossev.commonLib, line 386
// Zigbee Configure Reporting Response Parsing - command 0x07 // library marker kkossev.commonLib, line 388
private void parseConfigureResponse(final Map descMap) { // library marker kkossev.commonLib, line 389
// TODO - parse the details of the configuration respose - cluster, min, max, delta ... // library marker kkossev.commonLib, line 390
final String status = ((List)descMap.data).first() // library marker kkossev.commonLib, line 391
final int statusCode = hexStrToUnsignedInt(status) // library marker kkossev.commonLib, line 392
if (statusCode == 0x00 && settings.enableReporting != false) { // library marker kkossev.commonLib, line 393
state.reportingEnabled = true // library marker kkossev.commonLib, line 394
} // library marker kkossev.commonLib, line 395
final String statusName = ZigbeeStatusEnum[statusCode] ?: "0x${status}" // library marker kkossev.commonLib, line 396
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 397
log.warn "zigbee configure reporting error: ${statusName} ${descMap.data}" // library marker kkossev.commonLib, line 398
} else { // library marker kkossev.commonLib, line 399
logDebug "zigbee configure reporting response: ${statusName} ${descMap.data}" // library marker kkossev.commonLib, line 400
} // library marker kkossev.commonLib, line 401
} // library marker kkossev.commonLib, line 402
// Parses the response of reading reporting configuration - command 0x09 // library marker kkossev.commonLib, line 404
private void parseReadReportingConfigResponse(final Map descMap) { // library marker kkossev.commonLib, line 405
int status = zigbee.convertHexToInt(descMap.data[0]) // Status: Success (0x00) // library marker kkossev.commonLib, line 406
//def attr = zigbee.convertHexToInt(descMap.data[3])*256 + zigbee.convertHexToInt(descMap.data[2]) // Attribute: OnOff (0x0000) // library marker kkossev.commonLib, line 407
if (status == 0) { // library marker kkossev.commonLib, line 408
//def dataType = zigbee.convertHexToInt(descMap.data[4]) // Data Type: Boolean (0x10) // library marker kkossev.commonLib, line 409
int min = zigbee.convertHexToInt(descMap.data[6]) * 256 + zigbee.convertHexToInt(descMap.data[5]) // library marker kkossev.commonLib, line 410
int max = zigbee.convertHexToInt(descMap.data[8] + descMap.data[7]) // library marker kkossev.commonLib, line 411
int delta = 0 // library marker kkossev.commonLib, line 412
if (descMap.data.size() >= 10) { // library marker kkossev.commonLib, line 413
delta = zigbee.convertHexToInt(descMap.data[10] + descMap.data[9]) // library marker kkossev.commonLib, line 414
} // library marker kkossev.commonLib, line 415
else { // library marker kkossev.commonLib, line 416
logTrace "descMap.data.size = ${descMap.data.size()}" // library marker kkossev.commonLib, line 417
} // library marker kkossev.commonLib, line 418
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 419
} // library marker kkossev.commonLib, line 420
else { // library marker kkossev.commonLib, line 421
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 422
} // library marker kkossev.commonLib, line 423
} // library marker kkossev.commonLib, line 424
private Boolean executeCustomHandler(String handlerName, Object handlerArgs) { // library marker kkossev.commonLib, line 426
if (!this.respondsTo(handlerName)) { // library marker kkossev.commonLib, line 427
logTrace "executeCustomHandler: function ${handlerName} not found" // library marker kkossev.commonLib, line 428
return false // library marker kkossev.commonLib, line 429
} // library marker kkossev.commonLib, line 430
// execute the customHandler function // library marker kkossev.commonLib, line 431
Boolean result = false // library marker kkossev.commonLib, line 432
try { // library marker kkossev.commonLib, line 433
result = "$handlerName"(handlerArgs) // library marker kkossev.commonLib, line 434
} // library marker kkossev.commonLib, line 435
catch (e) { // library marker kkossev.commonLib, line 436
logWarn "executeCustomHandler: Exception '${e}'caught while processing $handlerName($handlerArgs) (val=${fncmd}))" // library marker kkossev.commonLib, line 437
return false // library marker kkossev.commonLib, line 438
} // library marker kkossev.commonLib, line 439
//logDebug "customSetFunction result is ${fncmd}" // library marker kkossev.commonLib, line 440
return result // library marker kkossev.commonLib, line 441
} // library marker kkossev.commonLib, line 442
// Zigbee Default Command Response Parsing // library marker kkossev.commonLib, line 444
private void parseDefaultCommandResponse(final Map descMap) { // library marker kkossev.commonLib, line 445
final List data = descMap.data as List // library marker kkossev.commonLib, line 446
final String commandId = data[0] // library marker kkossev.commonLib, line 447
final int statusCode = hexStrToUnsignedInt(data[1]) // library marker kkossev.commonLib, line 448
final String status = ZigbeeStatusEnum[statusCode] ?: "0x${data[1]}" // library marker kkossev.commonLib, line 449
if (statusCode > 0x00) { // library marker kkossev.commonLib, line 450
logWarn "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} error: ${status}" // library marker kkossev.commonLib, line 451
} else { // library marker kkossev.commonLib, line 452
logDebug "zigbee ${clusterLookup(descMap.clusterInt)} command 0x${commandId} response: ${status}" // library marker kkossev.commonLib, line 453
// ZigUSB has its own interpretation of the Zigbee standards ... :( // library marker kkossev.commonLib, line 454
if (this.respondsTo('customParseDefaultCommandResponse')) { // library marker kkossev.commonLib, line 455
customParseDefaultCommandResponse(descMap) // library marker kkossev.commonLib, line 456
} // library marker kkossev.commonLib, line 457
} // library marker kkossev.commonLib, line 458
} // library marker kkossev.commonLib, line 459
// Zigbee Attribute IDs // library marker kkossev.commonLib, line 461
@Field static final int ATTRIBUTE_READING_INFO_SET = 0x0000 // library marker kkossev.commonLib, line 462
@Field static final int FIRMWARE_VERSION_ID = 0x4000 // library marker kkossev.commonLib, line 463
@Field static final int PING_ATTR_ID = 0x01 // library marker kkossev.commonLib, line 464
@Field static final Map ZigbeeStatusEnum = [ // library marker kkossev.commonLib, line 466
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 467
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 468
] // library marker kkossev.commonLib, line 469
@Field static final Map ZigbeeGeneralCommandEnum = [ // library marker kkossev.commonLib, line 471
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 472
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 473
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 474
0x14: 'Discover Commands Generated Response', 0x15: 'Discover Attributes Extended', 0x16: 'Discover Attributes Extended Response' // library marker kkossev.commonLib, line 475
] // library marker kkossev.commonLib, line 476
@Field static final int ROLLING_AVERAGE_N = 10 // library marker kkossev.commonLib, line 478
private BigDecimal approxRollingAverage(BigDecimal avgPar, BigDecimal newSample) { // library marker kkossev.commonLib, line 479
BigDecimal avg = avgPar // library marker kkossev.commonLib, line 480
if (avg == null || avg == 0) { avg = newSample } // library marker kkossev.commonLib, line 481
avg -= avg / ROLLING_AVERAGE_N // library marker kkossev.commonLib, line 482
avg += newSample / ROLLING_AVERAGE_N // library marker kkossev.commonLib, line 483
return avg // library marker kkossev.commonLib, line 484
} // library marker kkossev.commonLib, line 485
void handlePingResponse() { // library marker kkossev.commonLib, line 487
Long now = new Date().getTime() // library marker kkossev.commonLib, line 488
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 489
state.lastRx['checkInTime'] = now // library marker kkossev.commonLib, line 490
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: '0').toInteger() // library marker kkossev.commonLib, line 492
if (timeRunning > 0 && timeRunning < MAX_PING_MILISECONDS) { // library marker kkossev.commonLib, line 493
state.stats['pingsOK'] = (state.stats['pingsOK'] ?: 0) + 1 // library marker kkossev.commonLib, line 494
if (timeRunning < safeToInt((state.stats['pingsMin'] ?: '999'))) { state.stats['pingsMin'] = timeRunning } // library marker kkossev.commonLib, line 495
if (timeRunning > safeToInt((state.stats['pingsMax'] ?: '0'))) { state.stats['pingsMax'] = timeRunning } // library marker kkossev.commonLib, line 496
state.stats['pingsAvg'] = approxRollingAverage(safeToDouble(state.stats['pingsAvg']), safeToDouble(timeRunning)) as int // library marker kkossev.commonLib, line 497
sendRttEvent() // library marker kkossev.commonLib, line 498
} // library marker kkossev.commonLib, line 499
else { // library marker kkossev.commonLib, line 500
logWarn "unexpected ping timeRunning=${timeRunning} " // library marker kkossev.commonLib, line 501
} // library marker kkossev.commonLib, line 502
state.states['isPing'] = false // library marker kkossev.commonLib, line 503
} // library marker kkossev.commonLib, line 504
/* // library marker kkossev.commonLib, line 506
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 507
* Standard clusters reporting handlers // library marker kkossev.commonLib, line 508
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 509
*/ // library marker kkossev.commonLib, line 510
@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 511
// Zigbee Basic Cluster Parsing 0x0000 - called from the main parse method // library marker kkossev.commonLib, line 513
private void standardParseBasicCluster(final Map descMap) { // library marker kkossev.commonLib, line 514
Long now = new Date().getTime() // library marker kkossev.commonLib, line 515
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 516
state.lastRx['checkInTime'] = now // library marker kkossev.commonLib, line 517
boolean isPing = state.states['isPing'] ?: false // library marker kkossev.commonLib, line 518
switch (descMap.attrInt as Integer) { // library marker kkossev.commonLib, line 519
case 0x0000: // library marker kkossev.commonLib, line 520
logDebug "Basic cluster: ZCLVersion = ${descMap?.value}" // library marker kkossev.commonLib, line 521
break // library marker kkossev.commonLib, line 522
case PING_ATTR_ID: // 0x01 - Using 0x01 read as a simple ping/pong mechanism // library marker kkossev.commonLib, line 523
if (isPing) { // library marker kkossev.commonLib, line 524
handlePingResponse() // library marker kkossev.commonLib, line 525
} // library marker kkossev.commonLib, line 526
else { // library marker kkossev.commonLib, line 527
logTrace "Tuya check-in message (attribute ${descMap.attrId} reported: ${descMap.value})" // library marker kkossev.commonLib, line 528
} // library marker kkossev.commonLib, line 529
break // library marker kkossev.commonLib, line 530
case 0x0004: // library marker kkossev.commonLib, line 531
logDebug "received device manufacturer ${descMap?.value}" // library marker kkossev.commonLib, line 532
// received device manufacturer IKEA of Sweden // library marker kkossev.commonLib, line 533
String manufacturer = device.getDataValue('manufacturer') // library marker kkossev.commonLib, line 534
if ((manufacturer == null || manufacturer == 'unknown') && (descMap?.value != null)) { // library marker kkossev.commonLib, line 535
logWarn "updating device manufacturer from ${manufacturer} to ${descMap?.value}" // library marker kkossev.commonLib, line 536
device.updateDataValue('manufacturer', descMap?.value) // library marker kkossev.commonLib, line 537
} // library marker kkossev.commonLib, line 538
break // library marker kkossev.commonLib, line 539
case 0x0005: // library marker kkossev.commonLib, line 540
if (isPing) { // library marker kkossev.commonLib, line 541
handlePingResponse() // library marker kkossev.commonLib, line 542
} // library marker kkossev.commonLib, line 543
else { // library marker kkossev.commonLib, line 544
logDebug "received device model ${descMap?.value}" // library marker kkossev.commonLib, line 545
// received device model Remote Control N2 // library marker kkossev.commonLib, line 546
String model = device.getDataValue('model') // library marker kkossev.commonLib, line 547
if ((model == null || model == 'unknown') && (descMap?.value != null)) { // library marker kkossev.commonLib, line 548
logWarn "updating device model from ${model} to ${descMap?.value}" // library marker kkossev.commonLib, line 549
device.updateDataValue('model', descMap?.value) // library marker kkossev.commonLib, line 550
} // library marker kkossev.commonLib, line 551
} // library marker kkossev.commonLib, line 552
break // library marker kkossev.commonLib, line 553
case 0x0007: // library marker kkossev.commonLib, line 554
String powerSourceReported = powerSourceOpts.options[descMap?.value as int] // library marker kkossev.commonLib, line 555
logDebug "received Power source ${powerSourceReported} (${descMap?.value})" // library marker kkossev.commonLib, line 556
String currentPowerSource = device.getDataValue('powerSource') // library marker kkossev.commonLib, line 557
if (currentPowerSource == null || currentPowerSource == 'unknown') { // library marker kkossev.commonLib, line 558
logInfo "updating device powerSource from ${currentPowerSource} to ${powerSourceReported}" // library marker kkossev.commonLib, line 559
sendEvent(name: 'powerSource', value: powerSourceReported, type: 'physical') // library marker kkossev.commonLib, line 560
} // library marker kkossev.commonLib, line 561
break // library marker kkossev.commonLib, line 562
case 0xFFDF: // library marker kkossev.commonLib, line 563
logDebug "Tuya check-in (Cluster Revision=${descMap?.value})" // library marker kkossev.commonLib, line 564
break // library marker kkossev.commonLib, line 565
case 0xFFE2: // library marker kkossev.commonLib, line 566
logDebug "Tuya check-in (AppVersion=${descMap?.value})" // library marker kkossev.commonLib, line 567
break // library marker kkossev.commonLib, line 568
case [0xFFE0, 0xFFE1, 0xFFE3, 0xFFE4] : // library marker kkossev.commonLib, line 569
logTrace "Tuya attribute ${descMap?.attrId} value=${descMap?.value}" // library marker kkossev.commonLib, line 570
break // library marker kkossev.commonLib, line 571
case 0xFFFE: // library marker kkossev.commonLib, line 572
logTrace "Tuya attributeReportingStatus (attribute FFFE) value=${descMap?.value}" // library marker kkossev.commonLib, line 573
break // library marker kkossev.commonLib, line 574
case FIRMWARE_VERSION_ID: // 0x4000 // library marker kkossev.commonLib, line 575
final String version = descMap.value ?: 'unknown' // library marker kkossev.commonLib, line 576
log.info "device firmware version is ${version}" // library marker kkossev.commonLib, line 577
updateDataValue('softwareBuild', version) // library marker kkossev.commonLib, line 578
break // library marker kkossev.commonLib, line 579
default: // library marker kkossev.commonLib, line 580
logWarn "zigbee received unknown Basic cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.commonLib, line 581
break // library marker kkossev.commonLib, line 582
} // library marker kkossev.commonLib, line 583
} // library marker kkossev.commonLib, line 584
private void standardParsePollControlCluster(final Map descMap) { // library marker kkossev.commonLib, line 586
switch (descMap.attrInt as Integer) { // library marker kkossev.commonLib, line 587
case 0x0000: logDebug "PollControl cluster: CheckInInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 588
case 0x0001: logDebug "PollControl cluster: LongPollInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 589
case 0x0002: logDebug "PollControl cluster: ShortPollInterval = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 590
case 0x0003: logDebug "PollControl cluster: FastPollTimeout = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 591
case 0x0004: logDebug "PollControl cluster: CheckInIntervalMin = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 592
case 0x0005: logDebug "PollControl cluster: LongPollIntervalMin = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 593
case 0x0006: logDebug "PollControl cluster: FastPollTimeoutMax = ${descMap?.value}" ; break // library marker kkossev.commonLib, line 594
default: logWarn "zigbee received unknown PollControl cluster attribute 0x${descMap.attrId} (value ${descMap.value})" ; break // library marker kkossev.commonLib, line 595
} // library marker kkossev.commonLib, line 596
} // library marker kkossev.commonLib, line 597
public void clearIsDigital() { state.states['isDigital'] = false } // library marker kkossev.commonLib, line 599
void switchDebouncingClear() { state.states['debounce'] = false } // library marker kkossev.commonLib, line 600
void isRefreshRequestClear() { state.states['isRefresh'] = false } // library marker kkossev.commonLib, line 601
Map myParseDescriptionAsMap(String description) { // library marker kkossev.commonLib, line 603
Map descMap = [:] // library marker kkossev.commonLib, line 604
try { // library marker kkossev.commonLib, line 605
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 606
} // library marker kkossev.commonLib, line 607
catch (e1) { // library marker kkossev.commonLib, line 608
logWarn "exception ${e1} caught while parseDescriptionAsMap myParseDescriptionAsMap description: ${description}" // library marker kkossev.commonLib, line 609
// try alternative custom parsing // library marker kkossev.commonLib, line 610
descMap = [:] // library marker kkossev.commonLib, line 611
try { // library marker kkossev.commonLib, line 612
descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> // library marker kkossev.commonLib, line 613
List pair = entry.split(':') // library marker kkossev.commonLib, line 614
[(pair.first().trim()): pair.last().trim()] // library marker kkossev.commonLib, line 615
} // library marker kkossev.commonLib, line 616
} // library marker kkossev.commonLib, line 617
catch (e2) { // library marker kkossev.commonLib, line 618
logWarn "exception ${e2} caught while parsing using an alternative method myParseDescriptionAsMap description: ${description}" // library marker kkossev.commonLib, line 619
return [:] // library marker kkossev.commonLib, line 620
} // library marker kkossev.commonLib, line 621
logDebug "alternative method parsing success: descMap=${descMap}" // library marker kkossev.commonLib, line 622
} // library marker kkossev.commonLib, line 623
return descMap // library marker kkossev.commonLib, line 624
} // library marker kkossev.commonLib, line 625
private boolean isTuyaE00xCluster(String description) { // library marker kkossev.commonLib, line 627
if (description == null || !(description.indexOf('cluster: E000') >= 0 || description.indexOf('cluster: E001') >= 0)) { // library marker kkossev.commonLib, line 628
return false // library marker kkossev.commonLib, line 629
} // library marker kkossev.commonLib, line 630
// try to parse ... // library marker kkossev.commonLib, line 631
//logDebug "Tuya cluster: E000 or E001 - try to parse it..." // library marker kkossev.commonLib, line 632
Map descMap = [:] // library marker kkossev.commonLib, line 633
try { // library marker kkossev.commonLib, line 634
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 635
logDebug "TuyaE00xCluster Desc Map: ${descMap}" // library marker kkossev.commonLib, line 636
} // library marker kkossev.commonLib, line 637
catch (e) { // library marker kkossev.commonLib, line 638
logDebug "exception caught while parsing description: ${description}" // library marker kkossev.commonLib, line 639
logDebug "TuyaE00xCluster Desc Map: ${descMap}" // library marker kkossev.commonLib, line 640
// cluster E001 is the one that is generating exceptions... // library marker kkossev.commonLib, line 641
return true // library marker kkossev.commonLib, line 642
} // library marker kkossev.commonLib, line 643
if (descMap.cluster == 'E000' && descMap.attrId in ['D001', 'D002', 'D003']) { // library marker kkossev.commonLib, line 645
logDebug "Tuya Specific cluster ${descMap.cluster} attribute ${descMap.attrId} value is ${descMap.value}" // library marker kkossev.commonLib, line 646
} // library marker kkossev.commonLib, line 647
else if (descMap.cluster == 'E001' && descMap.attrId == 'D010') { // library marker kkossev.commonLib, line 648
if (settings?.logEnable) { logInfo "power on behavior is ${powerOnBehaviourOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } // library marker kkossev.commonLib, line 649
} // library marker kkossev.commonLib, line 650
else if (descMap.cluster == 'E001' && descMap.attrId == 'D030') { // library marker kkossev.commonLib, line 651
if (settings?.logEnable) { logInfo "swith type is ${switchTypeOptions[safeToInt(descMap.value).toString()]} (${descMap.value})" } // library marker kkossev.commonLib, line 652
} // library marker kkossev.commonLib, line 653
else { // library marker kkossev.commonLib, line 654
logDebug "unprocessed TuyaE00xCluster Desc Map: $descMap" // library marker kkossev.commonLib, line 655
return false // library marker kkossev.commonLib, line 656
} // library marker kkossev.commonLib, line 657
return true // processed // library marker kkossev.commonLib, line 658
} // library marker kkossev.commonLib, line 659
// return true if further processing in the main parse method should be cancelled ! // library marker kkossev.commonLib, line 661
private boolean otherTuyaOddities(final String description) { // library marker kkossev.commonLib, line 662
/* // library marker kkossev.commonLib, line 663
if (description.indexOf('cluster: 0000') >= 0 && description.indexOf('attrId: 0004') >= 0) { // library marker kkossev.commonLib, line 664
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 665
return true // library marker kkossev.commonLib, line 666
} // library marker kkossev.commonLib, line 667
*/ // library marker kkossev.commonLib, line 668
Map descMap = [:] // library marker kkossev.commonLib, line 669
try { // library marker kkossev.commonLib, line 670
descMap = zigbee.parseDescriptionAsMap(description) // library marker kkossev.commonLib, line 671
} // library marker kkossev.commonLib, line 672
catch (e1) { // library marker kkossev.commonLib, line 673
logWarn "exception ${e1} caught while parseDescriptionAsMap otherTuyaOddities description: ${description}" // library marker kkossev.commonLib, line 674
// try alternative custom parsing // library marker kkossev.commonLib, line 675
descMap = [:] // library marker kkossev.commonLib, line 676
try { // library marker kkossev.commonLib, line 677
descMap += description.replaceAll('\\[|\\]', '').split(',').collectEntries { entry -> // library marker kkossev.commonLib, line 678
List pair = entry.split(':') // library marker kkossev.commonLib, line 679
[(pair.first().trim()): pair.last().trim()] // library marker kkossev.commonLib, line 680
} // library marker kkossev.commonLib, line 681
} // library marker kkossev.commonLib, line 682
catch (e2) { // library marker kkossev.commonLib, line 683
logWarn "exception ${e2} caught while parsing using an alternative method otherTuyaOddities description: ${description}" // library marker kkossev.commonLib, line 684
return true // library marker kkossev.commonLib, line 685
} // library marker kkossev.commonLib, line 686
logDebug "alternative method parsing success: descMap=${descMap}" // library marker kkossev.commonLib, line 687
} // library marker kkossev.commonLib, line 688
//if (logEnable) {log.trace "${device.displayName} Checking Tuya Oddities Desc Map: $descMap"} // library marker kkossev.commonLib, line 689
if (descMap.attrId == null) { // library marker kkossev.commonLib, line 690
//logDebug "otherTuyaOddities: descMap = ${descMap}" // library marker kkossev.commonLib, line 691
//if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${descMap.clusterId} NO ATTRIBUTE, skipping" // library marker kkossev.commonLib, line 692
return false // library marker kkossev.commonLib, line 693
} // library marker kkossev.commonLib, line 694
boolean bWasAtLeastOneAttributeProcessed = false // library marker kkossev.commonLib, line 695
boolean bWasThereAnyStandardAttribite = false // library marker kkossev.commonLib, line 696
// attribute report received // library marker kkossev.commonLib, line 697
List attrData = [[cluster: descMap.cluster ,attrId: descMap.attrId, value: descMap.value, status: descMap.status]] // library marker kkossev.commonLib, line 698
descMap.additionalAttrs.each { // library marker kkossev.commonLib, line 699
attrData << [cluster: descMap.cluster, attrId: it.attrId, value: it.value, status: it.status] // library marker kkossev.commonLib, line 700
} // library marker kkossev.commonLib, line 701
attrData.each { // library marker kkossev.commonLib, line 702
if (it.status == '86') { // library marker kkossev.commonLib, line 703
logWarn "Tuya Cluster ${descMap.cluster} unsupported attrId ${it.attrId}" // library marker kkossev.commonLib, line 704
// TODO - skip parsing? // library marker kkossev.commonLib, line 705
} // library marker kkossev.commonLib, line 706
switch (it.cluster) { // library marker kkossev.commonLib, line 707
case '0000' : // library marker kkossev.commonLib, line 708
if (it.attrId in ['FFE0', 'FFE1', 'FFE2', 'FFE4']) { // library marker kkossev.commonLib, line 709
logTrace "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" // library marker kkossev.commonLib, line 710
bWasAtLeastOneAttributeProcessed = true // library marker kkossev.commonLib, line 711
} // library marker kkossev.commonLib, line 712
else if (it.attrId in ['FFFE', 'FFDF']) { // library marker kkossev.commonLib, line 713
logTrace "Cluster ${descMap.cluster} Tuya specific attrId ${it.attrId} value ${it.value})" // library marker kkossev.commonLib, line 714
bWasAtLeastOneAttributeProcessed = true // library marker kkossev.commonLib, line 715
} // library marker kkossev.commonLib, line 716
else { // library marker kkossev.commonLib, line 717
//logDebug "otherTuyaOddities? - Cluster ${descMap.cluster} attrId ${it.attrId} value ${it.value}) N/A, skipping" // library marker kkossev.commonLib, line 718
bWasThereAnyStandardAttribite = true // library marker kkossev.commonLib, line 719
} // library marker kkossev.commonLib, line 720
break // library marker kkossev.commonLib, line 721
default : // library marker kkossev.commonLib, line 722
//if (logEnable) log.trace "${device.displayName} otherTuyaOddities - Cluster ${it.cluster} N/A, skipping" // library marker kkossev.commonLib, line 723
break // library marker kkossev.commonLib, line 724
} // switch // library marker kkossev.commonLib, line 725
} // for each attribute // library marker kkossev.commonLib, line 726
return bWasAtLeastOneAttributeProcessed && !bWasThereAnyStandardAttribite // library marker kkossev.commonLib, line 727
} // library marker kkossev.commonLib, line 728
public String intTo16bitUnsignedHex(int value) { // library marker kkossev.commonLib, line 730
String hexStr = zigbee.convertToHexString(value.toInteger(), 4) // library marker kkossev.commonLib, line 731
return new String(hexStr.substring(2, 4) + hexStr.substring(0, 2)) // library marker kkossev.commonLib, line 732
} // library marker kkossev.commonLib, line 733
public String intTo8bitUnsignedHex(int value) { // library marker kkossev.commonLib, line 735
return zigbee.convertToHexString(value.toInteger(), 2) // library marker kkossev.commonLib, line 736
} // library marker kkossev.commonLib, line 737
/* // library marker kkossev.commonLib, line 739
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 740
* Tuya cluster EF00 specific code // library marker kkossev.commonLib, line 741
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 742
*/ // library marker kkossev.commonLib, line 743
private static int getCLUSTER_TUYA() { 0xEF00 } // library marker kkossev.commonLib, line 744
private static int getSETDATA() { 0x00 } // library marker kkossev.commonLib, line 745
private static int getSETTIME() { 0x24 } // library marker kkossev.commonLib, line 746
// Tuya Commands // library marker kkossev.commonLib, line 748
private static int getTUYA_REQUEST() { 0x00 } // library marker kkossev.commonLib, line 749
private static int getTUYA_REPORTING() { 0x01 } // library marker kkossev.commonLib, line 750
private static int getTUYA_QUERY() { 0x02 } // library marker kkossev.commonLib, line 751
private static int getTUYA_STATUS_SEARCH() { 0x06 } // library marker kkossev.commonLib, line 752
private static int getTUYA_TIME_SYNCHRONISATION() { 0x24 } // library marker kkossev.commonLib, line 753
// tuya DP type // library marker kkossev.commonLib, line 755
private static String getDP_TYPE_RAW() { '01' } // [ bytes ] // library marker kkossev.commonLib, line 756
private static String getDP_TYPE_BOOL() { '01' } // [ 0/1 ] // library marker kkossev.commonLib, line 757
private static String getDP_TYPE_VALUE() { '02' } // [ 4 byte value ] // library marker kkossev.commonLib, line 758
private static String getDP_TYPE_STRING() { '03' } // [ N byte string ] // library marker kkossev.commonLib, line 759
private static String getDP_TYPE_ENUM() { '04' } // [ 0-255 ] // library marker kkossev.commonLib, line 760
private static String getDP_TYPE_BITMAP() { '05' } // [ 1,2,4 bytes ] as bits // library marker kkossev.commonLib, line 761
private void syncTuyaDateTime() { // library marker kkossev.commonLib, line 763
// 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 764
// 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 765
long offset = 0 // library marker kkossev.commonLib, line 766
int offsetHours = 0 // library marker kkossev.commonLib, line 767
Calendar cal = Calendar.getInstance() //it return same time as new Date() // library marker kkossev.commonLib, line 768
int hour = cal.get(Calendar.HOUR_OF_DAY) // library marker kkossev.commonLib, line 769
try { // library marker kkossev.commonLib, line 770
offset = location.getTimeZone().getOffset(new Date().getTime()) // library marker kkossev.commonLib, line 771
offsetHours = (offset / 3600000) as int // library marker kkossev.commonLib, line 772
logDebug "timezone offset of current location is ${offset} (${offsetHours} hours), current hour is ${hour} h" // library marker kkossev.commonLib, line 773
} catch (e) { // library marker kkossev.commonLib, line 774
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 775
} // library marker kkossev.commonLib, line 776
// // library marker kkossev.commonLib, line 777
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 778
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 779
logDebug "Tuya device time synchronized to ${unix2formattedDate(now())} (${cmds})" // library marker kkossev.commonLib, line 780
} // library marker kkossev.commonLib, line 781
// called from the main parse method when the cluster is 0xEF00 and no custom handler is defined // library marker kkossev.commonLib, line 783
public void standardParseTuyaCluster(final Map descMap) { // library marker kkossev.commonLib, line 784
if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == '24') { //getSETTIME // library marker kkossev.commonLib, line 785
syncTuyaDateTime() // library marker kkossev.commonLib, line 786
} // library marker kkossev.commonLib, line 787
else if (descMap?.clusterInt == CLUSTER_TUYA && descMap?.command == '0B') { // ZCL Command Default Response // library marker kkossev.commonLib, line 788
String clusterCmd = descMap?.data[0] // library marker kkossev.commonLib, line 789
String status = descMap?.data[1] // library marker kkossev.commonLib, line 790
logDebug "device has received Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data}" // library marker kkossev.commonLib, line 791
if (status != '00') { // library marker kkossev.commonLib, line 792
logWarn "ATTENTION! manufacturer = ${device.getDataValue('manufacturer')} unsupported Tuya cluster ZCL command 0x${clusterCmd} response 0x${status} data = ${descMap?.data} !!!" // library marker kkossev.commonLib, line 793
} // library marker kkossev.commonLib, line 794
} // library marker kkossev.commonLib, line 795
else if ((descMap?.clusterInt == CLUSTER_TUYA) && (descMap?.command == '01' || descMap?.command == '02' || descMap?.command == '05' || descMap?.command == '06')) { // library marker kkossev.commonLib, line 796
int dataLen = descMap?.data.size() // library marker kkossev.commonLib, line 797
//log.warn "dataLen=${dataLen}" // library marker kkossev.commonLib, line 798
//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 799
if (dataLen <= 5) { // library marker kkossev.commonLib, line 800
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 801
return // library marker kkossev.commonLib, line 802
} // library marker kkossev.commonLib, line 803
boolean isSpammyDeviceProfileDefined = this.respondsTo('isSpammyDeviceProfile') // check if the method exists 05/21/2024 // library marker kkossev.commonLib, line 804
for (int i = 0; i < (dataLen - 4); ) { // library marker kkossev.commonLib, line 805
int dp = zigbee.convertHexToInt(descMap?.data[2 + i]) // "dp" field describes the action/message of a command frame // library marker kkossev.commonLib, line 806
int dp_id = zigbee.convertHexToInt(descMap?.data[3 + i]) // "dp_identifier" is device dependant // library marker kkossev.commonLib, line 807
int fncmd_len = zigbee.convertHexToInt(descMap?.data[5 + i]) // library marker kkossev.commonLib, line 808
int fncmd = getTuyaAttributeValue(descMap?.data, i) // // library marker kkossev.commonLib, line 809
if (!isChattyDeviceReport(descMap) && isSpammyDeviceProfileDefined && !isSpammyDeviceProfile()) { // library marker kkossev.commonLib, line 810
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 811
} // library marker kkossev.commonLib, line 812
standardProcessTuyaDP(descMap, dp, dp_id, fncmd) // library marker kkossev.commonLib, line 813
i = i + fncmd_len + 4 // library marker kkossev.commonLib, line 814
} // library marker kkossev.commonLib, line 815
} // library marker kkossev.commonLib, line 816
else { // library marker kkossev.commonLib, line 817
logWarn "standardParseTuyaCluster: unprocessed Tuya cluster command ${descMap?.command} data=${descMap?.data}" // library marker kkossev.commonLib, line 818
} // library marker kkossev.commonLib, line 819
} // library marker kkossev.commonLib, line 820
// 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 822
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 823
logTrace "standardProcessTuyaDP: checking customProcessTuyaDp dp=${dp} dp_id=${dp_id} fncmd=${fncmd} dp_len=${dp_len}" // library marker kkossev.commonLib, line 824
if (this.respondsTo('customProcessTuyaDp')) { // library marker kkossev.commonLib, line 825
logTrace 'standardProcessTuyaDP: customProcessTuyaDp exists, calling it...' // library marker kkossev.commonLib, line 826
if (customProcessTuyaDp(descMap, dp, dp_id, fncmd, dp_len) == true) { // library marker kkossev.commonLib, line 827
return // EF00 DP has been processed in the custom handler - we are done! // library marker kkossev.commonLib, line 828
} // library marker kkossev.commonLib, line 829
} // library marker kkossev.commonLib, line 830
// check if DeviceProfile processing method exists (deviceProfieLib should be included in the main driver) // library marker kkossev.commonLib, line 831
if (this.respondsTo(processTuyaDPfromDeviceProfile)) { // library marker kkossev.commonLib, line 832
if (processTuyaDPfromDeviceProfile(descMap, dp, dp_id, fncmd, dp_len) == true) { // library marker kkossev.commonLib, line 833
return // sucessfuly processed the new way - we are done. (version 3.0) // library marker kkossev.commonLib, line 834
} // library marker kkossev.commonLib, line 835
} // library marker kkossev.commonLib, line 836
logWarn "NOT PROCESSED Tuya cmd: dp=${dp} value=${fncmd} descMap.data = ${descMap?.data}" // library marker kkossev.commonLib, line 837
} // library marker kkossev.commonLib, line 838
private int getTuyaAttributeValue(final List _data, final int index) { // library marker kkossev.commonLib, line 840
int retValue = 0 // library marker kkossev.commonLib, line 841
if (_data.size() >= 6) { // library marker kkossev.commonLib, line 842
int dataLength = zigbee.convertHexToInt(_data[5 + index]) // library marker kkossev.commonLib, line 843
if (dataLength == 0) { return 0 } // library marker kkossev.commonLib, line 844
int power = 1 // library marker kkossev.commonLib, line 845
for (i in dataLength..1) { // library marker kkossev.commonLib, line 846
retValue = retValue + power * zigbee.convertHexToInt(_data[index + i + 5]) // library marker kkossev.commonLib, line 847
power = power * 256 // library marker kkossev.commonLib, line 848
} // library marker kkossev.commonLib, line 849
} // library marker kkossev.commonLib, line 850
return retValue // library marker kkossev.commonLib, line 851
} // library marker kkossev.commonLib, line 852
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 854
public List sendTuyaCommand(String dp, String dp_type, String fncmd, int tuyaCmdDefault = SETDATA) { // library marker kkossev.commonLib, line 856
List cmds = [] // library marker kkossev.commonLib, line 857
int ep = safeToInt(state.destinationEP) // library marker kkossev.commonLib, line 858
if (ep == null || ep == 0) { ep = 1 } // library marker kkossev.commonLib, line 859
//int tuyaCmd = isFingerbot() ? 0x04 : SETDATA // library marker kkossev.commonLib, line 860
int tuyaCmd // library marker kkossev.commonLib, line 861
// 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 862
if (this.respondsTo('getDEVICE') && DEVICE?.device?.tuyaCmd != null) { // library marker kkossev.commonLib, line 863
tuyaCmd = DEVICE?.device?.tuyaCmd // library marker kkossev.commonLib, line 864
} // library marker kkossev.commonLib, line 865
else { // library marker kkossev.commonLib, line 866
tuyaCmd = /*isFingerbot() ? 0x04 : */ tuyaCmdDefault // 0x00 is the default command for most of the Tuya devices, except some .. // library marker kkossev.commonLib, line 867
} // library marker kkossev.commonLib, line 868
cmds = zigbee.command(CLUSTER_TUYA, tuyaCmd, [destEndpoint :ep], delay = 201, PACKET_ID + dp + dp_type + zigbee.convertToHexString((int)(fncmd.length() / 2), 4) + fncmd ) // library marker kkossev.commonLib, line 869
logDebug "${device.displayName} getTuyaCommand (dp=$dp fncmd=$fncmd dp_type=$dp_type) = ${cmds}" // library marker kkossev.commonLib, line 870
return cmds // library marker kkossev.commonLib, line 871
} // library marker kkossev.commonLib, line 872
private String getPACKET_ID() { return zigbee.convertToHexString(new Random().nextInt(65536), 4) } // library marker kkossev.commonLib, line 874
public void tuyaTest(String dpCommand, String dpValue, String dpTypeString ) { // library marker kkossev.commonLib, line 876
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 877
String dpValHex = dpTypeString == 'DP_TYPE_VALUE' ? zigbee.convertToHexString(dpValue as int, 8) : dpValue // library marker kkossev.commonLib, line 878
if (settings?.logEnable) { log.warn "${device.displayName} sending TEST command=${dpCommand} value=${dpValue} ($dpValHex) type=${dpType}" } // library marker kkossev.commonLib, line 879
sendZigbeeCommands( sendTuyaCommand(dpCommand, dpType, dpValHex) ) // library marker kkossev.commonLib, line 880
} // library marker kkossev.commonLib, line 881
//private getANALOG_INPUT_BASIC_CLUSTER() { 0x000C } // library marker kkossev.commonLib, line 883
//private getANALOG_INPUT_BASIC_PRESENT_VALUE_ATTRIBUTE() { 0x0055 } // library marker kkossev.commonLib, line 884
public List tuyaBlackMagic() { // library marker kkossev.commonLib, line 886
int ep = safeToInt(state.destinationEP ?: 01) // library marker kkossev.commonLib, line 887
if (ep == null || ep == 0) { ep = 1 } // library marker kkossev.commonLib, line 888
logInfo 'tuyaBlackMagic()...' // library marker kkossev.commonLib, line 889
return zigbee.readAttribute(0x0000, [0x0004, 0x000, 0x0001, 0x0005, 0x0007, 0xfffe], [destEndpoint :ep], delay = 200) // library marker kkossev.commonLib, line 890
} // library marker kkossev.commonLib, line 891
public void aqaraBlackMagic() { // library marker kkossev.commonLib, line 893
List cmds = [] // library marker kkossev.commonLib, line 894
if (this.respondsTo('customAqaraBlackMagic')) { // library marker kkossev.commonLib, line 895
cmds = customAqaraBlackMagic() // library marker kkossev.commonLib, line 896
} // library marker kkossev.commonLib, line 897
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 898
logDebug 'sending aqaraBlackMagic()' // library marker kkossev.commonLib, line 899
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 900
return // library marker kkossev.commonLib, line 901
} // library marker kkossev.commonLib, line 902
logDebug 'aqaraBlackMagic() was SKIPPED' // library marker kkossev.commonLib, line 903
} // library marker kkossev.commonLib, line 904
// Invoked from configure() // library marker kkossev.commonLib, line 906
public List initializeDevice() { // library marker kkossev.commonLib, line 907
List cmds = [] // library marker kkossev.commonLib, line 908
logInfo 'initializeDevice...' // library marker kkossev.commonLib, line 909
if (this.respondsTo('customInitializeDevice')) { // library marker kkossev.commonLib, line 910
List customCmds = customInitializeDevice() // library marker kkossev.commonLib, line 911
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 912
} // library marker kkossev.commonLib, line 913
logDebug "initializeDevice(): cmds=${cmds}" // library marker kkossev.commonLib, line 914
return cmds // library marker kkossev.commonLib, line 915
} // library marker kkossev.commonLib, line 916
// Invoked from configure() // library marker kkossev.commonLib, line 918
public List configureDevice() { // library marker kkossev.commonLib, line 919
List cmds = [] // library marker kkossev.commonLib, line 920
logInfo 'configureDevice...' // library marker kkossev.commonLib, line 921
if (this.respondsTo('customConfigureDevice')) { // library marker kkossev.commonLib, line 922
List customCmds = customConfigureDevice() // library marker kkossev.commonLib, line 923
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 924
} // library marker kkossev.commonLib, line 925
// sendZigbeeCommands(cmds) changed 03/04/2024 // library marker kkossev.commonLib, line 926
logDebug "configureDevice(): cmds=${cmds}" // library marker kkossev.commonLib, line 927
return cmds // library marker kkossev.commonLib, line 928
} // library marker kkossev.commonLib, line 929
/* // library marker kkossev.commonLib, line 931
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 932
* Hubitat default handlers methods // library marker kkossev.commonLib, line 933
* ----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 934
*/ // library marker kkossev.commonLib, line 935
List customHandlers(final List customHandlersList) { // library marker kkossev.commonLib, line 937
List cmds = [] // library marker kkossev.commonLib, line 938
if (customHandlersList != null && !customHandlersList.isEmpty()) { // library marker kkossev.commonLib, line 939
customHandlersList.each { handler -> // library marker kkossev.commonLib, line 940
if (this.respondsTo(handler)) { // library marker kkossev.commonLib, line 941
List customCmds = this."${handler}"() // library marker kkossev.commonLib, line 942
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } // library marker kkossev.commonLib, line 943
} // library marker kkossev.commonLib, line 944
} // library marker kkossev.commonLib, line 945
} // library marker kkossev.commonLib, line 946
return cmds // library marker kkossev.commonLib, line 947
} // library marker kkossev.commonLib, line 948
void refresh() { // library marker kkossev.commonLib, line 950
logDebug "refresh()... DEVICE_TYPE is ${DEVICE_TYPE} model=${device.getDataValue('model')} manufacturer=${device.getDataValue('manufacturer')}" // library marker kkossev.commonLib, line 951
checkDriverVersion(state) // library marker kkossev.commonLib, line 952
List cmds = [], customCmds = [] // library marker kkossev.commonLib, line 953
if (this.respondsTo('customRefresh')) { // if there is a customRefresh() method defined in the main driver, call it // library marker kkossev.commonLib, line 954
customCmds = customRefresh() // library marker kkossev.commonLib, line 955
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } else { logDebug 'no customRefresh method defined' } // library marker kkossev.commonLib, line 956
} // library marker kkossev.commonLib, line 957
else { // call all known libraryRefresh methods // library marker kkossev.commonLib, line 958
customCmds = customHandlers(['onOffRefresh', 'groupsRefresh', 'batteryRefresh', 'levelRefresh', 'temperatureRefresh', 'humidityRefresh', 'illuminanceRefresh']) // library marker kkossev.commonLib, line 959
if (customCmds != null && !customCmds.isEmpty()) { cmds += customCmds } else { logDebug 'no libraries refresh() defined' } // library marker kkossev.commonLib, line 960
} // library marker kkossev.commonLib, line 961
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 962
logDebug "refresh() cmds=${cmds}" // library marker kkossev.commonLib, line 963
setRefreshRequest() // 3 seconds // library marker kkossev.commonLib, line 964
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 965
} // library marker kkossev.commonLib, line 966
else { // library marker kkossev.commonLib, line 967
logDebug "no refresh() commands defined for device type ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 968
} // library marker kkossev.commonLib, line 969
} // library marker kkossev.commonLib, line 970
public void setRefreshRequest() { if (state.states == null) { state.states = [:] } ; state.states['isRefresh'] = true; runInMillis(REFRESH_TIMER, 'clearRefreshRequest', [overwrite: true]) } // library marker kkossev.commonLib, line 972
public void clearRefreshRequest() { if (state.states == null) { state.states = [:] } ; state.states['isRefresh'] = false } // library marker kkossev.commonLib, line 973
public void clearInfoEvent() { sendInfoEvent('clear') } // library marker kkossev.commonLib, line 974
public void sendInfoEvent(String info=null) { // library marker kkossev.commonLib, line 976
if (info == null || info == 'clear') { // library marker kkossev.commonLib, line 977
logDebug 'clearing the Status event' // library marker kkossev.commonLib, line 978
sendEvent(name: 'Status', value: 'clear', type: 'digital') // library marker kkossev.commonLib, line 979
} // library marker kkossev.commonLib, line 980
else { // library marker kkossev.commonLib, line 981
logInfo "${info}" // library marker kkossev.commonLib, line 982
sendEvent(name: 'Status', value: info, type: 'digital') // library marker kkossev.commonLib, line 983
runIn(INFO_AUTO_CLEAR_PERIOD, 'clearInfoEvent') // automatically clear the Info attribute after 1 minute // library marker kkossev.commonLib, line 984
} // library marker kkossev.commonLib, line 985
} // library marker kkossev.commonLib, line 986
public void ping() { // library marker kkossev.commonLib, line 988
if (state.lastTx == null ) { state.lastTx = [:] } ; state.lastTx['pingTime'] = new Date().getTime() // library marker kkossev.commonLib, line 989
if (state.states == null ) { state.states = [:] } ; state.states['isPing'] = true // library marker kkossev.commonLib, line 990
scheduleCommandTimeoutCheck() // library marker kkossev.commonLib, line 991
int pingAttr = (device.getDataValue('manufacturer') == 'SONOFF') ? 0x05 : PING_ATTR_ID // library marker kkossev.commonLib, line 992
if (isVirtual()) { runInMillis(10, 'virtualPong') } // library marker kkossev.commonLib, line 993
else { sendZigbeeCommands(zigbee.readAttribute(zigbee.BASIC_CLUSTER, pingAttr, [:], 0) ) } // library marker kkossev.commonLib, line 994
logDebug 'ping...' // library marker kkossev.commonLib, line 995
} // library marker kkossev.commonLib, line 996
private void virtualPong() { // library marker kkossev.commonLib, line 998
logDebug 'virtualPing: pong!' // library marker kkossev.commonLib, line 999
Long now = new Date().getTime() // library marker kkossev.commonLib, line 1000
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: '0').toInteger() // library marker kkossev.commonLib, line 1001
if (timeRunning > 0 && timeRunning < MAX_PING_MILISECONDS) { // library marker kkossev.commonLib, line 1002
state.stats['pingsOK'] = (state.stats['pingsOK'] ?: 0) + 1 // library marker kkossev.commonLib, line 1003
if (timeRunning < safeToInt((state.stats['pingsMin'] ?: '999'))) { state.stats['pingsMin'] = timeRunning } // library marker kkossev.commonLib, line 1004
if (timeRunning > safeToInt((state.stats['pingsMax'] ?: '0'))) { state.stats['pingsMax'] = timeRunning } // library marker kkossev.commonLib, line 1005
state.stats['pingsAvg'] = approxRollingAverage(safeToDouble(state.stats['pingsAvg']), safeToDouble(timeRunning)) as int // library marker kkossev.commonLib, line 1006
sendRttEvent() // library marker kkossev.commonLib, line 1007
} // library marker kkossev.commonLib, line 1008
else { // library marker kkossev.commonLib, line 1009
logWarn "unexpected ping timeRunning=${timeRunning} " // library marker kkossev.commonLib, line 1010
} // library marker kkossev.commonLib, line 1011
state.states['isPing'] = false // library marker kkossev.commonLib, line 1012
unscheduleCommandTimeoutCheck(state) // library marker kkossev.commonLib, line 1013
} // library marker kkossev.commonLib, line 1014
public void sendRttEvent( String value=null) { // library marker kkossev.commonLib, line 1016
Long now = new Date().getTime() // library marker kkossev.commonLib, line 1017
if (state.lastTx == null ) { state.lastTx = [:] } // library marker kkossev.commonLib, line 1018
int timeRunning = now.toInteger() - (state.lastTx['pingTime'] ?: now).toInteger() // library marker kkossev.commonLib, line 1019
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 1020
if (value == null) { // library marker kkossev.commonLib, line 1021
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1022
sendEvent(name: 'rtt', value: timeRunning, descriptionText: descriptionText, unit: 'ms', type: 'physical') // library marker kkossev.commonLib, line 1023
} // library marker kkossev.commonLib, line 1024
else { // library marker kkossev.commonLib, line 1025
descriptionText = "Round-trip time : ${value}" // library marker kkossev.commonLib, line 1026
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1027
sendEvent(name: 'rtt', value: value, descriptionText: descriptionText, type: 'physical') // library marker kkossev.commonLib, line 1028
} // library marker kkossev.commonLib, line 1029
} // library marker kkossev.commonLib, line 1030
private String clusterLookup(final Object cluster) { // library marker kkossev.commonLib, line 1032
if (cluster != null) { // library marker kkossev.commonLib, line 1033
return zigbee.clusterLookup(cluster.toInteger()) ?: "private cluster 0x${intToHexStr(cluster.toInteger())}" // library marker kkossev.commonLib, line 1034
} // library marker kkossev.commonLib, line 1035
logWarn 'cluster is NULL!' // library marker kkossev.commonLib, line 1036
return 'NULL' // library marker kkossev.commonLib, line 1037
} // library marker kkossev.commonLib, line 1038
private void scheduleCommandTimeoutCheck(int delay = COMMAND_TIMEOUT) { // library marker kkossev.commonLib, line 1040
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1041
state.states['isTimeoutCheck'] = true // library marker kkossev.commonLib, line 1042
runIn(delay, 'deviceCommandTimeout') // library marker kkossev.commonLib, line 1043
} // library marker kkossev.commonLib, line 1044
// unschedule() is a very time consuming operation : ~ 5 milliseconds per call ! // library marker kkossev.commonLib, line 1046
void unscheduleCommandTimeoutCheck(final Map state) { // can not be static :( // library marker kkossev.commonLib, line 1047
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1048
if (state.states['isTimeoutCheck'] == true) { // library marker kkossev.commonLib, line 1049
state.states['isTimeoutCheck'] = false // library marker kkossev.commonLib, line 1050
unschedule('deviceCommandTimeout') // library marker kkossev.commonLib, line 1051
} // library marker kkossev.commonLib, line 1052
} // library marker kkossev.commonLib, line 1053
void deviceCommandTimeout() { // library marker kkossev.commonLib, line 1055
logWarn 'no response received (sleepy device or offline?)' // library marker kkossev.commonLib, line 1056
sendRttEvent('timeout') // library marker kkossev.commonLib, line 1057
state.stats['pingsFail'] = (state.stats['pingsFail'] ?: 0) + 1 // library marker kkossev.commonLib, line 1058
} // library marker kkossev.commonLib, line 1059
private void scheduleDeviceHealthCheck(final int intervalMins, final int healthMethod) { // library marker kkossev.commonLib, line 1061
if (healthMethod == 1 || healthMethod == 2) { // library marker kkossev.commonLib, line 1062
String cron = getCron( intervalMins * 60 ) // library marker kkossev.commonLib, line 1063
schedule(cron, 'deviceHealthCheck') // library marker kkossev.commonLib, line 1064
logDebug "deviceHealthCheck is scheduled every ${intervalMins} minutes" // library marker kkossev.commonLib, line 1065
} // library marker kkossev.commonLib, line 1066
else { // library marker kkossev.commonLib, line 1067
logWarn 'deviceHealthCheck is not scheduled!' // library marker kkossev.commonLib, line 1068
unschedule('deviceHealthCheck') // library marker kkossev.commonLib, line 1069
} // library marker kkossev.commonLib, line 1070
} // library marker kkossev.commonLib, line 1071
private void unScheduleDeviceHealthCheck() { // library marker kkossev.commonLib, line 1073
unschedule('deviceHealthCheck') // library marker kkossev.commonLib, line 1074
device.deleteCurrentState('healthStatus') // library marker kkossev.commonLib, line 1075
logWarn 'device health check is disabled!' // library marker kkossev.commonLib, line 1076
} // library marker kkossev.commonLib, line 1077
// called when any event was received from the Zigbee device in the parse() method. // library marker kkossev.commonLib, line 1079
private void setHealthStatusOnline(Map state) { // library marker kkossev.commonLib, line 1080
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1081
state.health['checkCtr3'] = 0 // library marker kkossev.commonLib, line 1082
if (!((device.currentValue('healthStatus') ?: 'unknown') in ['online'])) { // library marker kkossev.commonLib, line 1083
sendHealthStatusEvent('online') // library marker kkossev.commonLib, line 1084
logInfo 'is now online!' // library marker kkossev.commonLib, line 1085
} // library marker kkossev.commonLib, line 1086
} // library marker kkossev.commonLib, line 1087
private void deviceHealthCheck() { // library marker kkossev.commonLib, line 1089
checkDriverVersion(state) // library marker kkossev.commonLib, line 1090
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1091
int ctr = state.health['checkCtr3'] ?: 0 // library marker kkossev.commonLib, line 1092
if (ctr >= PRESENCE_COUNT_THRESHOLD) { // library marker kkossev.commonLib, line 1093
if ((device.currentValue('healthStatus') ?: 'unknown') != 'offline' ) { // library marker kkossev.commonLib, line 1094
logWarn 'not present!' // library marker kkossev.commonLib, line 1095
sendHealthStatusEvent('offline') // library marker kkossev.commonLib, line 1096
} // library marker kkossev.commonLib, line 1097
} // library marker kkossev.commonLib, line 1098
else { // library marker kkossev.commonLib, line 1099
logDebug "deviceHealthCheck - online (notPresentCounter=${ctr})" // library marker kkossev.commonLib, line 1100
} // library marker kkossev.commonLib, line 1101
state.health['checkCtr3'] = ctr + 1 // library marker kkossev.commonLib, line 1102
} // library marker kkossev.commonLib, line 1103
private void sendHealthStatusEvent(final String value) { // library marker kkossev.commonLib, line 1105
String descriptionText = "healthStatus changed to ${value}" // library marker kkossev.commonLib, line 1106
sendEvent(name: 'healthStatus', value: value, descriptionText: descriptionText, isStateChange: true, type: 'digital') // library marker kkossev.commonLib, line 1107
if (value == 'online') { // library marker kkossev.commonLib, line 1108
logInfo "${descriptionText}" // library marker kkossev.commonLib, line 1109
} // library marker kkossev.commonLib, line 1110
else { // library marker kkossev.commonLib, line 1111
if (settings?.txtEnable) { log.warn "${device.displayName}} ${descriptionText}" } // library marker kkossev.commonLib, line 1112
} // library marker kkossev.commonLib, line 1113
} // library marker kkossev.commonLib, line 1114
// Invoked by Hubitat when the driver configuration is updated // library marker kkossev.commonLib, line 1116
void updated() { // library marker kkossev.commonLib, line 1117
logInfo 'updated()...' // library marker kkossev.commonLib, line 1118
checkDriverVersion(state) // library marker kkossev.commonLib, line 1119
logInfo"driver version ${driverVersionAndTimeStamp()}" // library marker kkossev.commonLib, line 1120
unschedule() // library marker kkossev.commonLib, line 1121
if (settings.logEnable) { // library marker kkossev.commonLib, line 1123
logTrace(settings.toString()) // library marker kkossev.commonLib, line 1124
runIn(86400, 'logsOff') // library marker kkossev.commonLib, line 1125
} // library marker kkossev.commonLib, line 1126
if (settings.traceEnable) { // library marker kkossev.commonLib, line 1127
logTrace(settings.toString()) // library marker kkossev.commonLib, line 1128
runIn(1800, 'traceOff') // library marker kkossev.commonLib, line 1129
} // library marker kkossev.commonLib, line 1130
final int healthMethod = (settings.healthCheckMethod as Integer) ?: 0 // library marker kkossev.commonLib, line 1132
if (healthMethod == 1 || healthMethod == 2) { // [0: 'Disabled', 1: 'Activity check', 2: 'Periodic polling'] // library marker kkossev.commonLib, line 1133
// schedule the periodic timer // library marker kkossev.commonLib, line 1134
final int interval = (settings.healthCheckInterval as Integer) ?: 0 // library marker kkossev.commonLib, line 1135
if (interval > 0) { // library marker kkossev.commonLib, line 1136
//log.trace "healthMethod=${healthMethod} interval=${interval}" // library marker kkossev.commonLib, line 1137
log.info "scheduling health check every ${interval} minutes by ${HealthcheckMethodOpts.options[healthCheckMethod as int]} method" // library marker kkossev.commonLib, line 1138
scheduleDeviceHealthCheck(interval, healthMethod) // library marker kkossev.commonLib, line 1139
} // library marker kkossev.commonLib, line 1140
} // library marker kkossev.commonLib, line 1141
else { // library marker kkossev.commonLib, line 1142
unScheduleDeviceHealthCheck() // unschedule the periodic job, depending on the healthMethod // library marker kkossev.commonLib, line 1143
log.info 'Health Check is disabled!' // library marker kkossev.commonLib, line 1144
} // library marker kkossev.commonLib, line 1145
if (this.respondsTo('customUpdated')) { // library marker kkossev.commonLib, line 1146
customUpdated() // library marker kkossev.commonLib, line 1147
} // library marker kkossev.commonLib, line 1148
sendInfoEvent('updated') // library marker kkossev.commonLib, line 1150
} // library marker kkossev.commonLib, line 1151
private void logsOff() { // library marker kkossev.commonLib, line 1153
logInfo 'debug logging disabled...' // library marker kkossev.commonLib, line 1154
device.updateSetting('logEnable', [value: 'false', type: 'bool']) // library marker kkossev.commonLib, line 1155
} // library marker kkossev.commonLib, line 1156
private void traceOff() { // library marker kkossev.commonLib, line 1157
logInfo 'trace logging disabled...' // library marker kkossev.commonLib, line 1158
device.updateSetting('traceEnable', [value: 'false', type: 'bool']) // library marker kkossev.commonLib, line 1159
} // library marker kkossev.commonLib, line 1160
public void configure(String command) { // library marker kkossev.commonLib, line 1162
logInfo "configure(${command})..." // library marker kkossev.commonLib, line 1163
if (!(command in (ConfigureOpts.keySet() as List))) { // library marker kkossev.commonLib, line 1164
logWarn "configure: command ${command} must be one of these : ${ConfigureOpts.keySet() as List}" // library marker kkossev.commonLib, line 1165
return // library marker kkossev.commonLib, line 1166
} // library marker kkossev.commonLib, line 1167
// // library marker kkossev.commonLib, line 1168
String func // library marker kkossev.commonLib, line 1169
try { // library marker kkossev.commonLib, line 1170
func = ConfigureOpts[command]?.function // library marker kkossev.commonLib, line 1171
"$func"() // library marker kkossev.commonLib, line 1172
} // library marker kkossev.commonLib, line 1173
catch (e) { // library marker kkossev.commonLib, line 1174
logWarn "Exception ${e} caught while processing $func($value)" // library marker kkossev.commonLib, line 1175
return // library marker kkossev.commonLib, line 1176
} // library marker kkossev.commonLib, line 1177
logInfo "executed '${func}'" // library marker kkossev.commonLib, line 1178
} // library marker kkossev.commonLib, line 1179
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.commonLib, line 1181
void configureHelp(final String val) { // library marker kkossev.commonLib, line 1182
if (settings?.txtEnable) { log.warn "${device.displayName} configureHelp: select one of the commands in this list!" } // library marker kkossev.commonLib, line 1183
} // library marker kkossev.commonLib, line 1184
public void loadAllDefaults() { // library marker kkossev.commonLib, line 1186
logWarn 'loadAllDefaults() !!!' // library marker kkossev.commonLib, line 1187
deleteAllSettings() // library marker kkossev.commonLib, line 1188
deleteAllCurrentStates() // library marker kkossev.commonLib, line 1189
deleteAllScheduledJobs() // library marker kkossev.commonLib, line 1190
deleteAllStates() // library marker kkossev.commonLib, line 1191
deleteAllChildDevices() // library marker kkossev.commonLib, line 1192
initialize() // library marker kkossev.commonLib, line 1194
configureNow() // calls also configureDevice() // bug fixed 04/03/2024 // library marker kkossev.commonLib, line 1195
updated() // library marker kkossev.commonLib, line 1196
sendInfoEvent('All Defaults Loaded! F5 to refresh') // library marker kkossev.commonLib, line 1197
} // library marker kkossev.commonLib, line 1198
private void configureNow() { // library marker kkossev.commonLib, line 1200
configure() // library marker kkossev.commonLib, line 1201
} // library marker kkossev.commonLib, line 1202
/** // library marker kkossev.commonLib, line 1204
* Send configuration parameters to the device // library marker kkossev.commonLib, line 1205
* Invoked when device is first installed and when the user updates the configuration TODO // library marker kkossev.commonLib, line 1206
* @return sends zigbee commands // library marker kkossev.commonLib, line 1207
*/ // library marker kkossev.commonLib, line 1208
void configure() { // library marker kkossev.commonLib, line 1209
List cmds = [] // library marker kkossev.commonLib, line 1210
if (state.stats == null) { state.stats = [:] } ; state.stats.cfgCtr = (state.stats.cfgCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1211
logInfo "configure()... cfgCtr=${state.stats.cfgCtr}" // library marker kkossev.commonLib, line 1212
logDebug "configure(): settings: $settings" // library marker kkossev.commonLib, line 1213
if (isTuya()) { // library marker kkossev.commonLib, line 1214
cmds += tuyaBlackMagic() // library marker kkossev.commonLib, line 1215
} // library marker kkossev.commonLib, line 1216
aqaraBlackMagic() // zigbee commands are sent here! // library marker kkossev.commonLib, line 1217
List initCmds = initializeDevice() // library marker kkossev.commonLib, line 1218
if (initCmds != null && !initCmds.isEmpty()) { cmds += initCmds } // library marker kkossev.commonLib, line 1219
List cfgCmds = configureDevice() // library marker kkossev.commonLib, line 1220
if (cfgCmds != null && !cfgCmds.isEmpty()) { cmds += cfgCmds } // library marker kkossev.commonLib, line 1221
if (cmds != null && !cmds.isEmpty()) { // library marker kkossev.commonLib, line 1222
sendZigbeeCommands(cmds) // library marker kkossev.commonLib, line 1223
logDebug "configure(): sent cmds = ${cmds}" // library marker kkossev.commonLib, line 1224
sendInfoEvent('sent device configuration') // library marker kkossev.commonLib, line 1225
} // library marker kkossev.commonLib, line 1226
else { // library marker kkossev.commonLib, line 1227
logDebug "configure(): no commands defined for device type ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 1228
} // library marker kkossev.commonLib, line 1229
} // library marker kkossev.commonLib, line 1230
// Invoked when the device is installed with this driver automatically selected. // library marker kkossev.commonLib, line 1232
void installed() { // library marker kkossev.commonLib, line 1233
if (state.stats == null) { state.stats = [:] } ; state.stats.instCtr = (state.stats.instCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1234
logInfo "installed()... instCtr=${state.stats.instCtr}" // library marker kkossev.commonLib, line 1235
// populate some default values for attributes // library marker kkossev.commonLib, line 1236
sendEvent(name: 'healthStatus', value: 'unknown', descriptionText: 'device was installed', type: 'digital') // library marker kkossev.commonLib, line 1237
sendEvent(name: 'powerSource', value: 'unknown', descriptionText: 'device was installed', type: 'digital') // library marker kkossev.commonLib, line 1238
sendInfoEvent('installed') // library marker kkossev.commonLib, line 1239
runIn(3, 'updated') // library marker kkossev.commonLib, line 1240
runIn(5, 'queryPowerSource') // library marker kkossev.commonLib, line 1241
} // library marker kkossev.commonLib, line 1242
private void queryPowerSource() { // library marker kkossev.commonLib, line 1244
sendZigbeeCommands(zigbee.readAttribute(zigbee.BASIC_CLUSTER, 0x0007, [:], 0)) // library marker kkossev.commonLib, line 1245
} // library marker kkossev.commonLib, line 1246
// Invoked from 'LoadAllDefaults' // library marker kkossev.commonLib, line 1248
private void initialize() { // library marker kkossev.commonLib, line 1249
if (state.stats == null) { state.stats = [:] } ; state.stats.initCtr = (state.stats.initCtr ?: 0) + 1 // library marker kkossev.commonLib, line 1250
logInfo "initialize()... initCtr=${state.stats.initCtr}" // library marker kkossev.commonLib, line 1251
if (device.getDataValue('powerSource') == null) { // library marker kkossev.commonLib, line 1252
logInfo "initializing device powerSource 'unknown'" // library marker kkossev.commonLib, line 1253
sendEvent(name: 'powerSource', value: 'unknown', type: 'digital') // library marker kkossev.commonLib, line 1254
} // library marker kkossev.commonLib, line 1255
initializeVars(fullInit = true) // library marker kkossev.commonLib, line 1256
updateTuyaVersion() // library marker kkossev.commonLib, line 1257
updateAqaraVersion() // library marker kkossev.commonLib, line 1258
} // library marker kkossev.commonLib, line 1259
/* // library marker kkossev.commonLib, line 1261
*----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 1262
* kkossev drivers commonly used functions // library marker kkossev.commonLib, line 1263
*----------------------------------------------------------------------------- // library marker kkossev.commonLib, line 1264
*/ // library marker kkossev.commonLib, line 1265
static Integer safeToInt(Object val, Integer defaultVal=0) { // library marker kkossev.commonLib, line 1267
return "${val}"?.isInteger() ? "${val}".toInteger() : defaultVal // library marker kkossev.commonLib, line 1268
} // library marker kkossev.commonLib, line 1269
static Double safeToDouble(Object val, Double defaultVal=0.0) { // library marker kkossev.commonLib, line 1271
return "${val}"?.isDouble() ? "${val}".toDouble() : defaultVal // library marker kkossev.commonLib, line 1272
} // library marker kkossev.commonLib, line 1273
static BigDecimal safeToBigDecimal(Object val, BigDecimal defaultVal=0.0) { // library marker kkossev.commonLib, line 1275
return "${val}"?.isBigDecimal() ? "${val}".toBigDecimal() : defaultVal // library marker kkossev.commonLib, line 1276
} // library marker kkossev.commonLib, line 1277
public void sendZigbeeCommands(List cmd) { // library marker kkossev.commonLib, line 1279
if (cmd == null || cmd.isEmpty()) { // library marker kkossev.commonLib, line 1280
logWarn "sendZigbeeCommands: list is empty! cmd=${cmd}" // library marker kkossev.commonLib, line 1281
return // library marker kkossev.commonLib, line 1282
} // library marker kkossev.commonLib, line 1283
hubitat.device.HubMultiAction allActions = new hubitat.device.HubMultiAction() // library marker kkossev.commonLib, line 1284
cmd.each { // library marker kkossev.commonLib, line 1285
if (it == null || it.isEmpty() || it == 'null') { // library marker kkossev.commonLib, line 1286
logWarn "sendZigbeeCommands it: no commands to send! it=${it} (cmd=${cmd})" // library marker kkossev.commonLib, line 1287
return // library marker kkossev.commonLib, line 1288
} // library marker kkossev.commonLib, line 1289
allActions.add(new hubitat.device.HubAction(it, hubitat.device.Protocol.ZIGBEE)) // library marker kkossev.commonLib, line 1290
if (state.stats != null) { state.stats['txCtr'] = (state.stats['txCtr'] ?: 0) + 1 } else { state.stats = [:] } // library marker kkossev.commonLib, line 1291
} // library marker kkossev.commonLib, line 1292
if (state.lastTx != null) { state.lastTx['cmdTime'] = now() } else { state.lastTx = [:] } // library marker kkossev.commonLib, line 1293
sendHubCommand(allActions) // library marker kkossev.commonLib, line 1294
logDebug "sendZigbeeCommands: sent cmd=${cmd}" // library marker kkossev.commonLib, line 1295
} // library marker kkossev.commonLib, line 1296
private String driverVersionAndTimeStamp() { version() + ' ' + timeStamp() + ((_DEBUG) ? ' (debug version!) ' : ' ') + "(${device.getDataValue('model')} ${device.getDataValue('manufacturer')}) (${getModel()} ${location.hub.firmwareVersionString})" } // library marker kkossev.commonLib, line 1298
private String getDeviceInfo() { // library marker kkossev.commonLib, line 1300
return "model=${device.getDataValue('model')} manufacturer=${device.getDataValue('manufacturer')} destinationEP=${state.destinationEP ?: UNKNOWN} deviceProfile=${state.deviceProfile ?: UNKNOWN}" // library marker kkossev.commonLib, line 1301
} // library marker kkossev.commonLib, line 1302
public String getDestinationEP() { // [destEndpoint:safeToInt(getDestinationEP())] // library marker kkossev.commonLib, line 1304
return state.destinationEP ?: device.endpointId ?: '01' // library marker kkossev.commonLib, line 1305
} // library marker kkossev.commonLib, line 1306
@CompileStatic // library marker kkossev.commonLib, line 1308
public void checkDriverVersion(final Map state) { // library marker kkossev.commonLib, line 1309
if (state.driverVersion == null || driverVersionAndTimeStamp() != state.driverVersion) { // library marker kkossev.commonLib, line 1310
logDebug "checkDriverVersion: updating the settings from the current driver version ${state.driverVersion} to the new version ${driverVersionAndTimeStamp()}" // library marker kkossev.commonLib, line 1311
sendInfoEvent("Updated to version ${driverVersionAndTimeStamp()}") // library marker kkossev.commonLib, line 1312
state.driverVersion = driverVersionAndTimeStamp() // library marker kkossev.commonLib, line 1313
initializeVars(false) // library marker kkossev.commonLib, line 1314
updateTuyaVersion() // library marker kkossev.commonLib, line 1315
updateAqaraVersion() // library marker kkossev.commonLib, line 1316
} // library marker kkossev.commonLib, line 1317
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1318
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 1319
if (state.lastTx == null) { state.lastTx = [:] } // library marker kkossev.commonLib, line 1320
if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 1321
} // library marker kkossev.commonLib, line 1322
// credits @thebearmay // library marker kkossev.commonLib, line 1324
String getModel() { // library marker kkossev.commonLib, line 1325
try { // library marker kkossev.commonLib, line 1326
/* groovylint-disable-next-line UnnecessaryGetter, UnusedVariable */ // library marker kkossev.commonLib, line 1327
String model = getHubVersion() // requires >=2.2.8.141 // library marker kkossev.commonLib, line 1328
} catch (ignore) { // library marker kkossev.commonLib, line 1329
try { // library marker kkossev.commonLib, line 1330
httpGet("http://${location.hub.localIP}:8080/api/hubitat.xml") { res -> // library marker kkossev.commonLib, line 1331
model = res.data.device.modelName // library marker kkossev.commonLib, line 1332
return model // library marker kkossev.commonLib, line 1333
} // library marker kkossev.commonLib, line 1334
} catch (ignore_again) { // library marker kkossev.commonLib, line 1335
return '' // library marker kkossev.commonLib, line 1336
} // library marker kkossev.commonLib, line 1337
} // library marker kkossev.commonLib, line 1338
} // library marker kkossev.commonLib, line 1339
// credits @thebearmay // library marker kkossev.commonLib, line 1341
boolean isCompatible(Integer minLevel) { //check to see if the hub version meets the minimum requirement ( 7 or 8 ) // library marker kkossev.commonLib, line 1342
String model = getModel() // Rev C-7 // library marker kkossev.commonLib, line 1343
String[] tokens = model.split('-') // library marker kkossev.commonLib, line 1344
String revision = tokens.last() // library marker kkossev.commonLib, line 1345
return (Integer.parseInt(revision) >= minLevel) // library marker kkossev.commonLib, line 1346
} // library marker kkossev.commonLib, line 1347
void deleteAllStatesAndJobs() { // library marker kkossev.commonLib, line 1349
state.clear() // clear all states // library marker kkossev.commonLib, line 1350
unschedule() // library marker kkossev.commonLib, line 1351
device.deleteCurrentState('*') // library marker kkossev.commonLib, line 1352
device.deleteCurrentState('') // library marker kkossev.commonLib, line 1353
log.info "${device.displayName} jobs and states cleared. HE hub is ${getHubVersion()}, version is ${location.hub.firmwareVersionString}" // library marker kkossev.commonLib, line 1355
} // library marker kkossev.commonLib, line 1356
void resetStatistics() { // library marker kkossev.commonLib, line 1358
runIn(1, 'resetStats') // library marker kkossev.commonLib, line 1359
sendInfoEvent('Statistics are reset. Refresh the web page') // library marker kkossev.commonLib, line 1360
} // library marker kkossev.commonLib, line 1361
// called from initializeVars(true) and resetStatistics() // library marker kkossev.commonLib, line 1363
void resetStats() { // library marker kkossev.commonLib, line 1364
logDebug 'resetStats...' // library marker kkossev.commonLib, line 1365
state.stats = [:] ; state.states = [:] ; state.lastRx = [:] ; state.lastTx = [:] ; state.health = [:] // library marker kkossev.commonLib, line 1366
if (this.respondsTo('groupsLibVersion')) { state.zigbeeGroups = [:] } // library marker kkossev.commonLib, line 1367
state.stats['rxCtr'] = 0 ; state.stats['txCtr'] = 0 // library marker kkossev.commonLib, line 1368
state.states['isDigital'] = false ; state.states['isRefresh'] = false ; state.states['isPing'] = false // library marker kkossev.commonLib, line 1369
state.health['offlineCtr'] = 0 ; state.health['checkCtr3'] = 0 // library marker kkossev.commonLib, line 1370
} // library marker kkossev.commonLib, line 1371
void initializeVars( boolean fullInit = false ) { // library marker kkossev.commonLib, line 1373
logDebug "InitializeVars()... fullInit = ${fullInit}" // library marker kkossev.commonLib, line 1374
if (fullInit == true ) { // library marker kkossev.commonLib, line 1375
state.clear() // library marker kkossev.commonLib, line 1376
unschedule() // library marker kkossev.commonLib, line 1377
resetStats() // library marker kkossev.commonLib, line 1378
if (deviceProfilesV3 != null && this.respondsTo('setDeviceNameAndProfile')) { setDeviceNameAndProfile() } // library marker kkossev.commonLib, line 1379
//state.comment = 'Works with Tuya Zigbee Devices' // library marker kkossev.commonLib, line 1380
logInfo 'all states and scheduled jobs cleared!' // library marker kkossev.commonLib, line 1381
state.driverVersion = driverVersionAndTimeStamp() // library marker kkossev.commonLib, line 1382
logInfo "DEVICE_TYPE = ${DEVICE_TYPE}" // library marker kkossev.commonLib, line 1383
state.deviceType = DEVICE_TYPE // library marker kkossev.commonLib, line 1384
sendInfoEvent('Initialized') // library marker kkossev.commonLib, line 1385
} // library marker kkossev.commonLib, line 1386
if (state.stats == null) { state.stats = [:] } // library marker kkossev.commonLib, line 1388
if (state.states == null) { state.states = [:] } // library marker kkossev.commonLib, line 1389
if (state.lastRx == null) { state.lastRx = [:] } // library marker kkossev.commonLib, line 1390
if (state.lastTx == null) { state.lastTx = [:] } // library marker kkossev.commonLib, line 1391
if (state.health == null) { state.health = [:] } // library marker kkossev.commonLib, line 1392
if (fullInit || settings?.txtEnable == null) { device.updateSetting('txtEnable', true) } // library marker kkossev.commonLib, line 1394
if (fullInit || settings?.logEnable == null) { device.updateSetting('logEnable', DEFAULT_DEBUG_LOGGING ?: false) } // library marker kkossev.commonLib, line 1395
if (fullInit || settings?.traceEnable == null) { device.updateSetting('traceEnable', false) } // library marker kkossev.commonLib, line 1396
if (fullInit || settings?.advancedOptions == null) { device.updateSetting('advancedOptions', [value:false, type:'bool']) } // library marker kkossev.commonLib, line 1397
if (fullInit || settings?.healthCheckMethod == null) { device.updateSetting('healthCheckMethod', [value: HealthcheckMethodOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.commonLib, line 1398
if (fullInit || settings?.healthCheckInterval == null) { device.updateSetting('healthCheckInterval', [value: HealthcheckIntervalOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.commonLib, line 1399
if (fullInit || settings?.voltageToPercent == null) { device.updateSetting('voltageToPercent', false) } // library marker kkossev.commonLib, line 1400
if (device.currentValue('healthStatus') == null) { sendHealthStatusEvent('unknown') } // library marker kkossev.commonLib, line 1402
// common libraries initialization // library marker kkossev.commonLib, line 1404
executeCustomHandler('batteryInitializeVars', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1405
executeCustomHandler('motionInitializeVars', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1406
executeCustomHandler('groupsInitializeVars', fullInit) // library marker kkossev.commonLib, line 1407
executeCustomHandler('illuminanceInitializeVars', fullInit) // library marker kkossev.commonLib, line 1408
executeCustomHandler('onOfInitializeVars', fullInit) // library marker kkossev.commonLib, line 1409
executeCustomHandler('energyInitializeVars', fullInit) // library marker kkossev.commonLib, line 1410
// // library marker kkossev.commonLib, line 1411
executeCustomHandler('deviceProfileInitializeVars', fullInit) // must be before the other deviceProfile initialization handlers! // library marker kkossev.commonLib, line 1412
executeCustomHandler('initEventsDeviceProfile', fullInit) // added 07/06/2024 // library marker kkossev.commonLib, line 1413
// // library marker kkossev.commonLib, line 1414
// custom device driver specific initialization should be at the end // library marker kkossev.commonLib, line 1415
executeCustomHandler('customInitializeVars', fullInit) // library marker kkossev.commonLib, line 1416
executeCustomHandler('customCreateChildDevices', fullInit) // library marker kkossev.commonLib, line 1417
executeCustomHandler('customInitEvents', fullInit) // library marker kkossev.commonLib, line 1418
final String mm = device.getDataValue('model') // library marker kkossev.commonLib, line 1420
if (mm != null) { logTrace " model = ${mm}" } // library marker kkossev.commonLib, line 1421
else { logWarn ' Model not found, please re-pair the device!' } // library marker kkossev.commonLib, line 1422
final String ep = device.getEndpointId() // library marker kkossev.commonLib, line 1423
if ( ep != null) { // library marker kkossev.commonLib, line 1424
//state.destinationEP = ep // library marker kkossev.commonLib, line 1425
logTrace " destinationEP = ${ep}" // library marker kkossev.commonLib, line 1426
} // library marker kkossev.commonLib, line 1427
else { // library marker kkossev.commonLib, line 1428
logWarn ' Destination End Point not found, please re-pair the device!' // library marker kkossev.commonLib, line 1429
//state.destinationEP = "01" // fallback // library marker kkossev.commonLib, line 1430
} // library marker kkossev.commonLib, line 1431
} // library marker kkossev.commonLib, line 1432
// not used!? // library marker kkossev.commonLib, line 1434
void setDestinationEP() { // library marker kkossev.commonLib, line 1435
String ep = device.getEndpointId() // library marker kkossev.commonLib, line 1436
if (ep != null && ep != 'F2') { state.destinationEP = ep ; logDebug "setDestinationEP() destinationEP = ${state.destinationEP}" } // library marker kkossev.commonLib, line 1437
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 1438
} // library marker kkossev.commonLib, line 1439
void logDebug(final String msg) { if (settings?.logEnable) { log.debug "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1441
void logInfo(final String msg) { if (settings?.txtEnable) { log.info "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1442
void logWarn(final String msg) { if (settings?.logEnable) { log.warn "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1443
void logTrace(final String msg) { if (settings?.traceEnable) { log.trace "${device.displayName} " + msg } } // library marker kkossev.commonLib, line 1444
// _DEBUG mode only // library marker kkossev.commonLib, line 1446
void getAllProperties() { // library marker kkossev.commonLib, line 1447
log.trace 'Properties:' ; device.properties.each { it -> log.debug it } // library marker kkossev.commonLib, line 1448
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 1449
} // library marker kkossev.commonLib, line 1450
// delete all Preferences // library marker kkossev.commonLib, line 1452
void deleteAllSettings() { // library marker kkossev.commonLib, line 1453
String preferencesDeleted = '' // library marker kkossev.commonLib, line 1454
settings.each { it -> preferencesDeleted += "${it.key} (${it.value}), " ; device.removeSetting("${it.key}") } // library marker kkossev.commonLib, line 1455
logDebug "Deleted settings: ${preferencesDeleted}" // library marker kkossev.commonLib, line 1456
logInfo 'All settings (preferences) DELETED' // library marker kkossev.commonLib, line 1457
} // library marker kkossev.commonLib, line 1458
// delete all attributes // library marker kkossev.commonLib, line 1460
void deleteAllCurrentStates() { // library marker kkossev.commonLib, line 1461
String attributesDeleted = '' // library marker kkossev.commonLib, line 1462
device.properties.supportedAttributes.each { it -> attributesDeleted += "${it}, " ; device.deleteCurrentState("$it") } // library marker kkossev.commonLib, line 1463
logDebug "Deleted attributes: ${attributesDeleted}" ; logInfo 'All current states (attributes) DELETED' // library marker kkossev.commonLib, line 1464
} // library marker kkossev.commonLib, line 1465
// delete all State Variables // library marker kkossev.commonLib, line 1467
void deleteAllStates() { // library marker kkossev.commonLib, line 1468
String stateDeleted = '' // library marker kkossev.commonLib, line 1469
state.each { it -> stateDeleted += "${it.key}, " } // library marker kkossev.commonLib, line 1470
state.clear() // library marker kkossev.commonLib, line 1471
logDebug "Deleted states: ${stateDeleted}" ; logInfo 'All States DELETED' // library marker kkossev.commonLib, line 1472
} // library marker kkossev.commonLib, line 1473
void deleteAllScheduledJobs() { // library marker kkossev.commonLib, line 1475
unschedule() ; logInfo 'All scheduled jobs DELETED' // library marker kkossev.commonLib, line 1476
} // library marker kkossev.commonLib, line 1477
void deleteAllChildDevices() { // library marker kkossev.commonLib, line 1479
getChildDevices().each { child -> log.info "${device.displayName} Deleting ${child.deviceNetworkId}" ; deleteChildDevice(child.deviceNetworkId) } // library marker kkossev.commonLib, line 1480
sendInfoEvent 'All child devices DELETED' // library marker kkossev.commonLib, line 1481
} // library marker kkossev.commonLib, line 1482
void testParse(String par) { // library marker kkossev.commonLib, line 1484
//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 1485
log.trace '------------------------------------------------------' // library marker kkossev.commonLib, line 1486
log.warn "testParse - START (${par})" // library marker kkossev.commonLib, line 1487
parse(par) // library marker kkossev.commonLib, line 1488
log.warn "testParse - END (${par})" // library marker kkossev.commonLib, line 1489
log.trace '------------------------------------------------------' // library marker kkossev.commonLib, line 1490
} // library marker kkossev.commonLib, line 1491
Object testJob() { // library marker kkossev.commonLib, line 1493
log.warn 'test job executed' // library marker kkossev.commonLib, line 1494
} // library marker kkossev.commonLib, line 1495
/** // library marker kkossev.commonLib, line 1497
* Calculates and returns the cron expression // library marker kkossev.commonLib, line 1498
* @param timeInSeconds interval in seconds // library marker kkossev.commonLib, line 1499
*/ // library marker kkossev.commonLib, line 1500
String getCron(int timeInSeconds) { // library marker kkossev.commonLib, line 1501
//schedule("${rnd.nextInt(59)} ${rnd.nextInt(9)}/${intervalMins} * ? * * *", 'ping') // library marker kkossev.commonLib, line 1502
// TODO: runEvery1Minute runEvery5Minutes runEvery10Minutes runEvery15Minutes runEvery30Minutes runEvery1Hour runEvery3Hours // library marker kkossev.commonLib, line 1503
final Random rnd = new Random() // library marker kkossev.commonLib, line 1504
int minutes = (timeInSeconds / 60 ) as int // library marker kkossev.commonLib, line 1505
int hours = (minutes / 60 ) as int // library marker kkossev.commonLib, line 1506
if (hours > 23) { hours = 23 } // library marker kkossev.commonLib, line 1507
String cron // library marker kkossev.commonLib, line 1508
if (timeInSeconds < 60) { cron = "*/$timeInSeconds * * * * ? *" } // library marker kkossev.commonLib, line 1509
else { // library marker kkossev.commonLib, line 1510
if (minutes < 60) { cron = "${rnd.nextInt(59)} ${rnd.nextInt(9)}/$minutes * ? * *" } // library marker kkossev.commonLib, line 1511
else { cron = "${rnd.nextInt(59)} ${rnd.nextInt(59)} */$hours ? * *" } // library marker kkossev.commonLib, line 1512
} // library marker kkossev.commonLib, line 1513
return cron // library marker kkossev.commonLib, line 1514
} // library marker kkossev.commonLib, line 1515
// credits @thebearmay // library marker kkossev.commonLib, line 1517
String formatUptime() { // library marker kkossev.commonLib, line 1518
return formatTime(location.hub.uptime) // library marker kkossev.commonLib, line 1519
} // library marker kkossev.commonLib, line 1520
String formatTime(int timeInSeconds) { // library marker kkossev.commonLib, line 1522
if (timeInSeconds == null) { return UNKNOWN } // library marker kkossev.commonLib, line 1523
int days = (timeInSeconds / 86400).toInteger() // library marker kkossev.commonLib, line 1524
int hours = ((timeInSeconds % 86400) / 3600).toInteger() // library marker kkossev.commonLib, line 1525
int minutes = ((timeInSeconds % 3600) / 60).toInteger() // library marker kkossev.commonLib, line 1526
int seconds = (timeInSeconds % 60).toInteger() // library marker kkossev.commonLib, line 1527
return "${days}d ${hours}h ${minutes}m ${seconds}s" // library marker kkossev.commonLib, line 1528
} // library marker kkossev.commonLib, line 1529
boolean isTuya() { // library marker kkossev.commonLib, line 1531
if (!device) { return true } // fallback - added 04/03/2024 // library marker kkossev.commonLib, line 1532
String model = device.getDataValue('model') // library marker kkossev.commonLib, line 1533
String manufacturer = device.getDataValue('manufacturer') // library marker kkossev.commonLib, line 1534
/* groovylint-disable-next-line UnnecessaryTernaryExpression */ // library marker kkossev.commonLib, line 1535
return (model?.startsWith('TS') && manufacturer?.startsWith('_T')) ? true : false // library marker kkossev.commonLib, line 1536
} // library marker kkossev.commonLib, line 1537
void updateTuyaVersion() { // library marker kkossev.commonLib, line 1539
if (!isTuya()) { logTrace 'not Tuya' ; return } // library marker kkossev.commonLib, line 1540
final String application = device.getDataValue('application') // library marker kkossev.commonLib, line 1541
if (application != null) { // library marker kkossev.commonLib, line 1542
Integer ver // library marker kkossev.commonLib, line 1543
try { ver = zigbee.convertHexToInt(application) } // library marker kkossev.commonLib, line 1544
catch (e) { logWarn "exception caught while converting application version ${application} to tuyaVersion"; return } // library marker kkossev.commonLib, line 1545
final String str = ((ver & 0xC0) >> 6).toString() + '.' + ((ver & 0x30) >> 4).toString() + '.' + (ver & 0x0F).toString() // library marker kkossev.commonLib, line 1546
if (device.getDataValue('tuyaVersion') != str) { // library marker kkossev.commonLib, line 1547
device.updateDataValue('tuyaVersion', str) // library marker kkossev.commonLib, line 1548
logInfo "tuyaVersion set to $str" // library marker kkossev.commonLib, line 1549
} // library marker kkossev.commonLib, line 1550
} // library marker kkossev.commonLib, line 1551
} // library marker kkossev.commonLib, line 1552
boolean isAqara() { return device.getDataValue('model')?.startsWith('lumi') ?: false } // library marker kkossev.commonLib, line 1554
void updateAqaraVersion() { // library marker kkossev.commonLib, line 1556
if (!isAqara()) { logTrace 'not Aqara' ; return } // library marker kkossev.commonLib, line 1557
String application = device.getDataValue('application') // library marker kkossev.commonLib, line 1558
if (application != null) { // library marker kkossev.commonLib, line 1559
String str = '0.0.0_' + String.format('%04d', zigbee.convertHexToInt(application.take(2))) // library marker kkossev.commonLib, line 1560
if (device.getDataValue('aqaraVersion') != str) { // library marker kkossev.commonLib, line 1561
device.updateDataValue('aqaraVersion', str) // library marker kkossev.commonLib, line 1562
logInfo "aqaraVersion set to $str" // library marker kkossev.commonLib, line 1563
} // library marker kkossev.commonLib, line 1564
} // library marker kkossev.commonLib, line 1565
} // library marker kkossev.commonLib, line 1566
String unix2formattedDate(Long unixTime) { // library marker kkossev.commonLib, line 1568
try { // library marker kkossev.commonLib, line 1569
if (unixTime == null) { return null } // library marker kkossev.commonLib, line 1570
/* groovylint-disable-next-line NoJavaUtilDate */ // library marker kkossev.commonLib, line 1571
Date date = new Date(unixTime.toLong()) // library marker kkossev.commonLib, line 1572
return date.format('yyyy-MM-dd HH:mm:ss.SSS', location.timeZone) // library marker kkossev.commonLib, line 1573
} catch (e) { // library marker kkossev.commonLib, line 1574
logDebug "Error formatting date: ${e.message}. Returning current time instead." // library marker kkossev.commonLib, line 1575
return new Date().format('yyyy-MM-dd HH:mm:ss.SSS', location.timeZone) // library marker kkossev.commonLib, line 1576
} // library marker kkossev.commonLib, line 1577
} // library marker kkossev.commonLib, line 1578
Long formattedDate2unix(String formattedDate) { // library marker kkossev.commonLib, line 1580
try { // library marker kkossev.commonLib, line 1581
if (formattedDate == null) { return null } // library marker kkossev.commonLib, line 1582
Date date = Date.parse('yyyy-MM-dd HH:mm:ss.SSS', formattedDate) // library marker kkossev.commonLib, line 1583
return date.getTime() // library marker kkossev.commonLib, line 1584
} catch (e) { // library marker kkossev.commonLib, line 1585
logDebug "Error parsing formatted date: ${formattedDate}. Returning current time instead." // library marker kkossev.commonLib, line 1586
return now() // library marker kkossev.commonLib, line 1587
} // library marker kkossev.commonLib, line 1588
} // library marker kkossev.commonLib, line 1589
static String timeToHMS(final int time) { // library marker kkossev.commonLib, line 1591
int hours = (time / 3600) as int // library marker kkossev.commonLib, line 1592
int minutes = ((time % 3600) / 60) as int // library marker kkossev.commonLib, line 1593
int seconds = time % 60 // library marker kkossev.commonLib, line 1594
return "${hours}h ${minutes}m ${seconds}s" // library marker kkossev.commonLib, line 1595
} // library marker kkossev.commonLib, line 1596
// ~~~~~ 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.2' // 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 - (dev.branch) added on/off control for Tuya device profiles with 'switch' dp; // library marker kkossev.onOffLib, line 21
* // library marker kkossev.onOffLib, line 22
* TODO: // library marker kkossev.onOffLib, line 23
*/ // library marker kkossev.onOffLib, line 24
static String onOffLibVersion() { '3.2.2' } // library marker kkossev.onOffLib, line 26
static String onOffLibStamp() { '2024/06/29 12:27 PM' } // library marker kkossev.onOffLib, line 27
@Field static final Boolean _THREE_STATE = true // library marker kkossev.onOffLib, line 29
metadata { // library marker kkossev.onOffLib, line 31
capability 'Actuator' // library marker kkossev.onOffLib, line 32
capability 'Switch' // library marker kkossev.onOffLib, line 33
if (_THREE_STATE == true) { // library marker kkossev.onOffLib, line 34
attribute 'switch', 'enum', SwitchThreeStateOpts.options.values() as List // library marker kkossev.onOffLib, line 35
} // library marker kkossev.onOffLib, line 36
// no commands // library marker kkossev.onOffLib, line 37
preferences { // library marker kkossev.onOffLib, line 38
if (settings?.advancedOptions == true && device != null && !(DEVICE_TYPE in ['Device', 'Thermostat'])) { // library marker kkossev.onOffLib, line 39
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 40
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 41
if (_THREE_STATE == true) { // library marker kkossev.onOffLib, line 42
input name: 'threeStateEnable', type: 'bool', title: 'Enable three-states events', description: 'Experimental multi-state switch events', defaultValue: false // library marker kkossev.onOffLib, line 43
} // library marker kkossev.onOffLib, line 44
} // library marker kkossev.onOffLib, line 45
} // library marker kkossev.onOffLib, line 46
} // library marker kkossev.onOffLib, line 47
@Field static final Map SwitchThreeStateOpts = [ // library marker kkossev.onOffLib, line 49
defaultValue: 0, options: [0: 'off', 1: 'on', 2: 'switching_off', 3: 'switching_on', 4: 'switch_failure'] // library marker kkossev.onOffLib, line 50
] // library marker kkossev.onOffLib, line 51
@Field static final Map powerOnBehaviourOptions = [ // library marker kkossev.onOffLib, line 53
'0': 'switch off', '1': 'switch on', '2': 'switch last state' // library marker kkossev.onOffLib, line 54
] // library marker kkossev.onOffLib, line 55
@Field static final Map switchTypeOptions = [ // library marker kkossev.onOffLib, line 57
'0': 'toggle', '1': 'state', '2': 'momentary' // library marker kkossev.onOffLib, line 58
] // library marker kkossev.onOffLib, line 59
private boolean isCircuitBreaker() { device.getDataValue('manufacturer') in ['_TZ3000_ky0fq4ho'] } // library marker kkossev.onOffLib, line 61
/* // library marker kkossev.onOffLib, line 63
* ----------------------------------------------------------------------------- // library marker kkossev.onOffLib, line 64
* on/off cluster 0x0006 TODO - move to a library !!!!!!!!!!!!!!! // library marker kkossev.onOffLib, line 65
* ----------------------------------------------------------------------------- // library marker kkossev.onOffLib, line 66
*/ // library marker kkossev.onOffLib, line 67
void standardParseOnOffCluster(final Map descMap) { // library marker kkossev.onOffLib, line 68
/* // library marker kkossev.onOffLib, line 69
if (this.respondsTo('customParseOnOffCluster')) { // library marker kkossev.onOffLib, line 70
customParseOnOffCluster(descMap) // library marker kkossev.onOffLib, line 71
} // library marker kkossev.onOffLib, line 72
else */ // library marker kkossev.onOffLib, line 73
if (descMap.attrId == '0000') { // library marker kkossev.onOffLib, line 74
if (descMap.value == null || descMap.value == 'FFFF') { logDebug "parseOnOffCluster: invalid value: ${descMap.value}"; return } // invalid or unknown value // library marker kkossev.onOffLib, line 75
int rawValue = hexStrToUnsignedInt(descMap.value) // library marker kkossev.onOffLib, line 76
sendSwitchEvent(rawValue) // library marker kkossev.onOffLib, line 77
} // library marker kkossev.onOffLib, line 78
else if (descMap.attrId in ['4000', '4001', '4002', '4004', '8000', '8001', '8002', '8003']) { // library marker kkossev.onOffLib, line 79
parseOnOffAttributes(descMap) // library marker kkossev.onOffLib, line 80
} // library marker kkossev.onOffLib, line 81
else { // library marker kkossev.onOffLib, line 82
if (descMap.attrId != null) { logWarn "standardParseOnOffCluster: unprocessed attrId ${descMap.attrId}" } // library marker kkossev.onOffLib, line 83
else { logDebug "standardParseOnOffCluster: skipped processing OnOIff cluster (attrId is ${descMap.attrId})" } // ZigUSB has its own interpretation of the Zigbee standards ... :( // library marker kkossev.onOffLib, line 84
} // library marker kkossev.onOffLib, line 85
} // library marker kkossev.onOffLib, line 86
void toggle() { // library marker kkossev.onOffLib, line 88
String descriptionText = 'central button switch is ' // library marker kkossev.onOffLib, line 89
String state = '' // library marker kkossev.onOffLib, line 90
if ((device.currentState('switch')?.value ?: 'n/a') == 'off') { // library marker kkossev.onOffLib, line 91
state = 'on' // library marker kkossev.onOffLib, line 92
} // library marker kkossev.onOffLib, line 93
else { // library marker kkossev.onOffLib, line 94
state = 'off' // library marker kkossev.onOffLib, line 95
} // library marker kkossev.onOffLib, line 96
descriptionText += state // library marker kkossev.onOffLib, line 97
sendEvent(name: 'switch', value: state, descriptionText: descriptionText, type: 'physical', isStateChange: true) // library marker kkossev.onOffLib, line 98
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 99
} // library marker kkossev.onOffLib, line 100
void off() { // library marker kkossev.onOffLib, line 102
if (this.respondsTo('customOff')) { customOff() ; return } // library marker kkossev.onOffLib, line 103
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 104
List cmds = [] // library marker kkossev.onOffLib, line 105
// added 06/29/2024 - control Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 106
if (this.respondsTo(getDEVICE)) { // defined in deviceProfileLib // library marker kkossev.onOffLib, line 107
Map switchMap = getAttributesMap('switch') // library marker kkossev.onOffLib, line 108
int onOffValue = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? 0 : 1 // library marker kkossev.onOffLib, line 109
if (switchMap != null && switchMap != [:]) { // library marker kkossev.onOffLib, line 110
cmds = sendTuyaParameter(switchMap, 'switch', onOffValue) // library marker kkossev.onOffLib, line 111
logTrace "off() Tuya cmds=${cmds}" // library marker kkossev.onOffLib, line 112
} // library marker kkossev.onOffLib, line 113
} // library marker kkossev.onOffLib, line 114
if (cmds.size() == 0) { // if not Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 115
cmds = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? zigbee.off() : zigbee.on() // library marker kkossev.onOffLib, line 116
} // library marker kkossev.onOffLib, line 117
String currentState = device.currentState('switch')?.value ?: 'n/a' // library marker kkossev.onOffLib, line 119
logDebug "off() currentState=${currentState}" // library marker kkossev.onOffLib, line 120
if (_THREE_STATE == true && settings?.threeStateEnable == true) { // library marker kkossev.onOffLib, line 121
if (currentState == 'off') { // library marker kkossev.onOffLib, line 122
runIn(1, 'refresh', [overwrite: true]) // library marker kkossev.onOffLib, line 123
} // library marker kkossev.onOffLib, line 124
String value = SwitchThreeStateOpts.options[2] // 'switching_on' // library marker kkossev.onOffLib, line 125
String descriptionText = "${value}" // library marker kkossev.onOffLib, line 126
if (logEnable) { descriptionText += ' (2)' } // library marker kkossev.onOffLib, line 127
sendEvent(name: 'switch', value: value, descriptionText: descriptionText, type: 'digital', isStateChange: true) // library marker kkossev.onOffLib, line 128
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 129
} // library marker kkossev.onOffLib, line 130
state.states['isDigital'] = true // library marker kkossev.onOffLib, line 131
runInMillis(DIGITAL_TIMER, clearIsDigital, [overwrite: true]) // library marker kkossev.onOffLib, line 132
sendZigbeeCommands(cmds) // library marker kkossev.onOffLib, line 133
} // library marker kkossev.onOffLib, line 134
void on() { // library marker kkossev.onOffLib, line 136
if (this.respondsTo('customOn')) { customOn() ; return } // library marker kkossev.onOffLib, line 137
List cmds = [] // library marker kkossev.onOffLib, line 138
// added 06/29/2024 - control Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 139
if (this.respondsTo(getDEVICE)) { // defined in deviceProfileLib // library marker kkossev.onOffLib, line 140
Map switchMap = getAttributesMap('switch') // library marker kkossev.onOffLib, line 141
int onOffValue = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? 1 : 0 // library marker kkossev.onOffLib, line 142
if (switchMap != null && switchMap != [:]) { // library marker kkossev.onOffLib, line 143
cmds = sendTuyaParameter(switchMap, 'switch', onOffValue) // library marker kkossev.onOffLib, line 144
logTrace "on() Tuya cmds=${cmds}" // library marker kkossev.onOffLib, line 145
} // library marker kkossev.onOffLib, line 146
} // library marker kkossev.onOffLib, line 147
if (cmds.size() == 0) { // if not Tuya 0xEF00 switch // library marker kkossev.onOffLib, line 148
cmds = (settings?.inverceSwitch == null || settings?.inverceSwitch == false) ? zigbee.on() : zigbee.off() // library marker kkossev.onOffLib, line 149
} // library marker kkossev.onOffLib, line 150
String currentState = device.currentState('switch')?.value ?: 'n/a' // library marker kkossev.onOffLib, line 151
logDebug "on() currentState=${currentState}" // library marker kkossev.onOffLib, line 152
if (_THREE_STATE == true && settings?.threeStateEnable == true) { // library marker kkossev.onOffLib, line 153
if ((device.currentState('switch')?.value ?: 'n/a') == 'on') { // library marker kkossev.onOffLib, line 154
runIn(1, 'refresh', [overwrite: true]) // library marker kkossev.onOffLib, line 155
} // library marker kkossev.onOffLib, line 156
String value = SwitchThreeStateOpts.options[3] // 'switching_on' // library marker kkossev.onOffLib, line 157
String descriptionText = "${value}" // library marker kkossev.onOffLib, line 158
if (logEnable) { descriptionText += ' (2)' } // library marker kkossev.onOffLib, line 159
sendEvent(name: 'switch', value: value, descriptionText: descriptionText, type: 'digital', isStateChange: true) // library marker kkossev.onOffLib, line 160
logInfo "${descriptionText}" // library marker kkossev.onOffLib, line 161
} // library marker kkossev.onOffLib, line 162
state.states['isDigital'] = true // library marker kkossev.onOffLib, line 163
runInMillis(DIGITAL_TIMER, clearIsDigital, [overwrite: true]) // library marker kkossev.onOffLib, line 164
sendZigbeeCommands(cmds) // library marker kkossev.onOffLib, line 165
} // library marker kkossev.onOffLib, line 166
void sendSwitchEvent(int switchValuePar) { // library marker kkossev.onOffLib, line 168
int switchValue = safeToInt(switchValuePar) // library marker kkossev.onOffLib, line 169
if (settings?.inverceSwitch != null && settings?.inverceSwitch == true) { // library marker kkossev.onOffLib, line 170
switchValue = (switchValue == 0x00) ? 0x01 : 0x00 // library marker kkossev.onOffLib, line 171
} // library marker kkossev.onOffLib, line 172
String value = (switchValue == null) ? 'unknown' : (switchValue == 0x00) ? 'off' : (switchValue == 0x01) ? 'on' : 'unknown' // library marker kkossev.onOffLib, line 173
Map map = [:] // library marker kkossev.onOffLib, line 174
boolean isRefresh = state.states['isRefresh'] ?: false // library marker kkossev.onOffLib, line 175
boolean debounce = state.states['debounce'] ?: false // library marker kkossev.onOffLib, line 176
String lastSwitch = state.states['lastSwitch'] ?: 'unknown' // library marker kkossev.onOffLib, line 177
if (value == lastSwitch && (debounce || (settings.ignoreDuplicated ?: false)) && !isRefresh) { // library marker kkossev.onOffLib, line 178
logDebug "Ignored duplicated switch event ${value}" // library marker kkossev.onOffLib, line 179
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 180
return // library marker kkossev.onOffLib, line 181
} // library marker kkossev.onOffLib, line 182
logTrace "value=${value} lastSwitch=${state.states['lastSwitch']}" // library marker kkossev.onOffLib, line 183
boolean isDigital = state.states['isDigital'] ?: false // library marker kkossev.onOffLib, line 184
map.type = isDigital ? 'digital' : 'physical' // library marker kkossev.onOffLib, line 185
if (lastSwitch != value) { // library marker kkossev.onOffLib, line 186
logDebug "switch state changed from ${lastSwitch} to ${value}" // library marker kkossev.onOffLib, line 187
state.states['debounce'] = true // library marker kkossev.onOffLib, line 188
state.states['lastSwitch'] = value // library marker kkossev.onOffLib, line 189
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 190
} else { // library marker kkossev.onOffLib, line 191
state.states['debounce'] = true // library marker kkossev.onOffLib, line 192
runInMillis(DEBOUNCING_TIMER, switchDebouncingClear, [overwrite: true]) // library marker kkossev.onOffLib, line 193
} // library marker kkossev.onOffLib, line 194
map.name = 'switch' // library marker kkossev.onOffLib, line 195
map.value = value // library marker kkossev.onOffLib, line 196
if (isRefresh) { // library marker kkossev.onOffLib, line 197
map.descriptionText = "${device.displayName} is ${value} [Refresh]" // library marker kkossev.onOffLib, line 198
map.isStateChange = true // library marker kkossev.onOffLib, line 199
} else { // library marker kkossev.onOffLib, line 200
map.descriptionText = "${device.displayName} is ${value} [${map.type}]" // library marker kkossev.onOffLib, line 201
} // library marker kkossev.onOffLib, line 202
logInfo "${map.descriptionText}" // library marker kkossev.onOffLib, line 203
sendEvent(map) // library marker kkossev.onOffLib, line 204
clearIsDigital() // 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/development/libraries/batteryLib.groovy', documentationLink: '', // library marker kkossev.batteryLib, line 4
version: '3.2.1' // library marker kkossev.batteryLib, line 5
) // library marker kkossev.batteryLib, line 6
/* // library marker kkossev.batteryLib, line 7
* Zigbee Level 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 - (dev. branch) added tuyaToBatteryLevel and handleTuyaBatteryLevel; added batteryInitializeVars // library marker kkossev.batteryLib, line 16
* // library marker kkossev.batteryLib, line 17
* TODO: batteryVoltage in the deviceProfile capabilities // library marker kkossev.batteryLib, line 18
* TODO: battery voltage low/high limits configuration // library marker kkossev.batteryLib, line 19
*/ // library marker kkossev.batteryLib, line 20
static String batteryLibVersion() { '3.2.1' } // library marker kkossev.batteryLib, line 22
static String batteryLibStamp() { '2024/07/06 10:27 PM' } // library marker kkossev.batteryLib, line 23
metadata { // library marker kkossev.batteryLib, line 25
capability 'Battery' // library marker kkossev.batteryLib, line 26
attribute 'batteryVoltage', 'number' // library marker kkossev.batteryLib, line 27
attribute 'lastBattery', 'date' // last battery event time - added in 3.2.0 05/21/2024 // library marker kkossev.batteryLib, line 28
// no commands // library marker kkossev.batteryLib, line 29
preferences { // library marker kkossev.batteryLib, line 30
if (device && advancedOptions == true) { // library marker kkossev.batteryLib, line 31
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 32
if ('Battery' in DEVICE?.capabilities) { // library marker kkossev.batteryLib, line 33
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 34
} // library marker kkossev.batteryLib, line 35
} // library marker kkossev.batteryLib, line 36
} // library marker kkossev.batteryLib, line 37
} // library marker kkossev.batteryLib, line 38
@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 40
public void standardParsePowerCluster(final Map descMap) { // library marker kkossev.batteryLib, line 42
if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value // library marker kkossev.batteryLib, line 43
final int rawValue = hexStrToUnsignedInt(descMap.value) // library marker kkossev.batteryLib, line 44
if (descMap.attrId == '0020') { // battery voltage // library marker kkossev.batteryLib, line 45
state.lastRx['batteryTime'] = new Date().getTime() // library marker kkossev.batteryLib, line 46
state.stats['bVoltCtr'] = (state.stats['bVoltCtr'] ?: 0) + 1 // library marker kkossev.batteryLib, line 47
sendBatteryVoltageEvent(rawValue) // library marker kkossev.batteryLib, line 48
if ((settings.voltageToPercent ?: false) == true) { // library marker kkossev.batteryLib, line 49
sendBatteryVoltageEvent(rawValue, convertToPercent = true) // library marker kkossev.batteryLib, line 50
} // library marker kkossev.batteryLib, line 51
} // library marker kkossev.batteryLib, line 52
else if (descMap.attrId == '0021') { // battery percentage // library marker kkossev.batteryLib, line 53
state.lastRx['batteryTime'] = new Date().getTime() // library marker kkossev.batteryLib, line 54
state.stats['battCtr'] = (state.stats['battCtr'] ?: 0) + 1 // library marker kkossev.batteryLib, line 55
if (isTuya()) { // library marker kkossev.batteryLib, line 56
sendBatteryPercentageEvent(rawValue) // library marker kkossev.batteryLib, line 57
} // library marker kkossev.batteryLib, line 58
else { // library marker kkossev.batteryLib, line 59
sendBatteryPercentageEvent((rawValue / 2) as int) // library marker kkossev.batteryLib, line 60
} // library marker kkossev.batteryLib, line 61
} // library marker kkossev.batteryLib, line 62
else { // library marker kkossev.batteryLib, line 63
logWarn "customParsePowerCluster: zigbee received unknown Power cluster attribute 0x${descMap.attrId} (value ${descMap.value})" // library marker kkossev.batteryLib, line 64
} // library marker kkossev.batteryLib, line 65
} // library marker kkossev.batteryLib, line 66
public void sendBatteryVoltageEvent(final int rawValue, boolean convertToPercent=false) { // library marker kkossev.batteryLib, line 68
logDebug "batteryVoltage = ${(double)rawValue / 10.0} V" // library marker kkossev.batteryLib, line 69
final Date lastBattery = new Date() // library marker kkossev.batteryLib, line 70
Map result = [:] // library marker kkossev.batteryLib, line 71
BigDecimal volts = safeToBigDecimal(rawValue) / 10G // library marker kkossev.batteryLib, line 72
if (rawValue != 0 && rawValue != 255) { // library marker kkossev.batteryLib, line 73
BigDecimal minVolts = 2.2 // library marker kkossev.batteryLib, line 74
BigDecimal maxVolts = 3.2 // library marker kkossev.batteryLib, line 75
BigDecimal pct = (volts - minVolts) / (maxVolts - minVolts) // library marker kkossev.batteryLib, line 76
int roundedPct = Math.round(pct * 100) // library marker kkossev.batteryLib, line 77
if (roundedPct <= 0) { roundedPct = 1 } // library marker kkossev.batteryLib, line 78
if (roundedPct > 100) { roundedPct = 100 } // library marker kkossev.batteryLib, line 79
if (convertToPercent == true) { // library marker kkossev.batteryLib, line 80
result.value = Math.min(100, roundedPct) // library marker kkossev.batteryLib, line 81
result.name = 'battery' // library marker kkossev.batteryLib, line 82
result.unit = '%' // library marker kkossev.batteryLib, line 83
result.descriptionText = "battery is ${roundedPct} %" // library marker kkossev.batteryLib, line 84
} // library marker kkossev.batteryLib, line 85
else { // library marker kkossev.batteryLib, line 86
result.value = volts // library marker kkossev.batteryLib, line 87
result.name = 'batteryVoltage' // library marker kkossev.batteryLib, line 88
result.unit = 'V' // library marker kkossev.batteryLib, line 89
result.descriptionText = "battery is ${volts} Volts" // library marker kkossev.batteryLib, line 90
} // library marker kkossev.batteryLib, line 91
result.type = 'physical' // library marker kkossev.batteryLib, line 92
result.isStateChange = true // library marker kkossev.batteryLib, line 93
logInfo "${result.descriptionText}" // library marker kkossev.batteryLib, line 94
sendEvent(result) // library marker kkossev.batteryLib, line 95
sendEvent(name: 'lastBattery', value: lastBattery) // library marker kkossev.batteryLib, line 96
} // library marker kkossev.batteryLib, line 97
else { // library marker kkossev.batteryLib, line 98
logWarn "ignoring BatteryResult(${rawValue})" // library marker kkossev.batteryLib, line 99
} // library marker kkossev.batteryLib, line 100
} // library marker kkossev.batteryLib, line 101
public void sendBatteryPercentageEvent(final int batteryPercent, boolean isDigital=false) { // library marker kkossev.batteryLib, line 103
if ((batteryPercent as int) == 255) { // library marker kkossev.batteryLib, line 104
logWarn "ignoring battery report raw=${batteryPercent}" // library marker kkossev.batteryLib, line 105
return // library marker kkossev.batteryLib, line 106
} // library marker kkossev.batteryLib, line 107
final Date lastBattery = new Date() // library marker kkossev.batteryLib, line 108
Map map = [:] // library marker kkossev.batteryLib, line 109
map.name = 'battery' // library marker kkossev.batteryLib, line 110
map.timeStamp = now() // library marker kkossev.batteryLib, line 111
map.value = batteryPercent < 0 ? 0 : batteryPercent > 100 ? 100 : (batteryPercent as int) // library marker kkossev.batteryLib, line 112
map.unit = '%' // library marker kkossev.batteryLib, line 113
map.type = isDigital ? 'digital' : 'physical' // library marker kkossev.batteryLib, line 114
map.descriptionText = "${map.name} is ${map.value} ${map.unit}" // library marker kkossev.batteryLib, line 115
map.isStateChange = true // library marker kkossev.batteryLib, line 116
// // library marker kkossev.batteryLib, line 117
Object latestBatteryEvent = device.currentState('battery') // library marker kkossev.batteryLib, line 118
Long latestBatteryEventTime = latestBatteryEvent != null ? latestBatteryEvent.getDate().getTime() : now() // library marker kkossev.batteryLib, line 119
//log.debug "battery latest state timeStamp is ${latestBatteryTime} now is ${now()}" // library marker kkossev.batteryLib, line 120
int timeDiff = ((now() - latestBatteryEventTime) / 1000) as int // library marker kkossev.batteryLib, line 121
if (settings?.batteryDelay == null || (settings?.batteryDelay as int) == 0 || timeDiff > (settings?.batteryDelay as int)) { // library marker kkossev.batteryLib, line 122
// send it now! // library marker kkossev.batteryLib, line 123
sendDelayedBatteryPercentageEvent(map) // library marker kkossev.batteryLib, line 124
sendEvent(name: 'lastBattery', value: lastBattery) // library marker kkossev.batteryLib, line 125
} // library marker kkossev.batteryLib, line 126
else { // library marker kkossev.batteryLib, line 127
int delayedTime = (settings?.batteryDelay as int) - timeDiff // library marker kkossev.batteryLib, line 128
map.delayed = delayedTime // library marker kkossev.batteryLib, line 129
map.descriptionText += " [delayed ${map.delayed} seconds]" // library marker kkossev.batteryLib, line 130
map.lastBattery = lastBattery // library marker kkossev.batteryLib, line 131
logDebug "this battery event (${map.value}%) will be delayed ${delayedTime} seconds" // library marker kkossev.batteryLib, line 132
runIn(delayedTime, 'sendDelayedBatteryEvent', [overwrite: true, data: map]) // library marker kkossev.batteryLib, line 133
} // library marker kkossev.batteryLib, line 134
} // library marker kkossev.batteryLib, line 135
private void sendDelayedBatteryPercentageEvent(Map map) { // library marker kkossev.batteryLib, line 137
logInfo "${map.descriptionText}" // library marker kkossev.batteryLib, line 138
//map.each {log.trace "$it"} // library marker kkossev.batteryLib, line 139
sendEvent(map) // library marker kkossev.batteryLib, line 140
sendEvent(name: 'lastBattery', value: map.lastBattery) // library marker kkossev.batteryLib, line 141
} // library marker kkossev.batteryLib, line 142
/* groovylint-disable-next-line UnusedPrivateMethod */ // library marker kkossev.batteryLib, line 144
private void sendDelayedBatteryVoltageEvent(Map map) { // library marker kkossev.batteryLib, line 145
logInfo "${map.descriptionText}" // library marker kkossev.batteryLib, line 146
//map.each {log.trace "$it"} // library marker kkossev.batteryLib, line 147
sendEvent(map) // library marker kkossev.batteryLib, line 148
sendEvent(name: 'lastBattery', value: map.lastBattery) // library marker kkossev.batteryLib, line 149
} // library marker kkossev.batteryLib, line 150
public int tuyaToBatteryLevel(int fncmd) { // library marker kkossev.batteryLib, line 152
int rawValue = fncmd // library marker kkossev.batteryLib, line 153
switch (fncmd) { // library marker kkossev.batteryLib, line 154
case 0: rawValue = 100; break // Battery Full // library marker kkossev.batteryLib, line 155
case 1: rawValue = 75; break // Battery High // library marker kkossev.batteryLib, line 156
case 2: rawValue = 50; break // Battery Medium // library marker kkossev.batteryLib, line 157
case 3: rawValue = 25; break // Battery Low // library marker kkossev.batteryLib, line 158
case 4: rawValue = 100; break // Tuya 3 in 1 -> USB powered // library marker kkossev.batteryLib, line 159
// 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 160
} // library marker kkossev.batteryLib, line 161
return rawValue // library marker kkossev.batteryLib, line 162
} // library marker kkossev.batteryLib, line 163
public void handleTuyaBatteryLevel(int fncmd) { // library marker kkossev.batteryLib, line 165
int rawValue = tuyaToBatteryLevel(fncmd) // library marker kkossev.batteryLib, line 166
sendBatteryPercentageEvent(rawValue) // library marker kkossev.batteryLib, line 167
} // library marker kkossev.batteryLib, line 168
public void batteryInitializeVars( boolean fullInit = false ) { // library marker kkossev.batteryLib, line 170
logDebug "batteryInitializeVars()... fullInit = ${fullInit}" // library marker kkossev.batteryLib, line 171
if (device.hasCapability('Battery')) { // library marker kkossev.batteryLib, line 172
if (fullInit || settings?.voltageToPercent == null) { device.updateSetting('voltageToPercent', false) } // library marker kkossev.batteryLib, line 173
if (fullInit || settings?.batteryDelay == null) { device.updateSetting('batteryDelay', [value: DelayBatteryOpts.defaultValue.toString(), type: 'enum']) } // library marker kkossev.batteryLib, line 174
} // library marker kkossev.batteryLib, line 175
} // library marker kkossev.batteryLib, line 176
public List batteryRefresh() { // library marker kkossev.batteryLib, line 178
List cmds = [] // library marker kkossev.batteryLib, line 179
cmds += zigbee.readAttribute(0x0001, 0x0020, [:], delay = 100) // battery voltage // library marker kkossev.batteryLib, line 180
cmds += zigbee.readAttribute(0x0001, 0x0021, [:], delay = 100) // battery percentage // library marker kkossev.batteryLib, line 181
return cmds // library marker kkossev.batteryLib, line 182
} // library marker kkossev.batteryLib, line 183
// ~~~~~ 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.2.2' // 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 - (dev.branch) fixed T/H clusters attribute different than 0 (temperature, humidity MeasuredValue) bug // library marker kkossev.temperatureLib, line 16
* // library marker kkossev.temperatureLib, line 17
* TODO: check why if (settings?.minReportingTime...) condition in the preferences ? // library marker kkossev.temperatureLib, line 18
* TODO: add temperatureOffset // library marker kkossev.temperatureLib, line 19
* TODO: unschedule('sendDelayedTempEvent') only if needed (add boolean flag to sendDelayedTempEvent()) // library marker kkossev.temperatureLib, line 20
* TODO: check for negative temperature values in standardParseTemperatureCluster() // library marker kkossev.temperatureLib, line 21
*/ // library marker kkossev.temperatureLib, line 22
static String temperatureLibVersion() { '3.2.2' } // library marker kkossev.temperatureLib, line 24
static String temperatureLibStamp() { '2024/07/06 9:28 PM' } // library marker kkossev.temperatureLib, line 25
metadata { // library marker kkossev.temperatureLib, line 27
capability 'TemperatureMeasurement' // library marker kkossev.temperatureLib, line 28
// no commands // library marker kkossev.temperatureLib, line 29
preferences { // library marker kkossev.temperatureLib, line 30
if (device && advancedOptions == true) { // library marker kkossev.temperatureLib, line 31
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 32
if (!(deviceType in ['mmWaveSensor', 'Thermostat'])) { // library marker kkossev.temperatureLib, line 33
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 34
} // library marker kkossev.temperatureLib, line 35
} // library marker kkossev.temperatureLib, line 36
} // library marker kkossev.temperatureLib, line 37
} // library marker kkossev.temperatureLib, line 38
void standardParseTemperatureCluster(final Map descMap) { // library marker kkossev.temperatureLib, line 40
if (descMap.value == null || descMap.value == 'FFFF') { return } // invalid or unknown value // library marker kkossev.temperatureLib, line 41
if (descMap.attrId == '0000') { // library marker kkossev.temperatureLib, line 42
int value = hexStrToSignedInt(descMap.value) // library marker kkossev.temperatureLib, line 43
handleTemperatureEvent(value / 100.0F as BigDecimal) // library marker kkossev.temperatureLib, line 44
} // library marker kkossev.temperatureLib, line 45
else { // library marker kkossev.temperatureLib, line 46
logWarn "standardParseTemperatureCluster() - unknown attribute ${descMap.attrId} value=${descMap.value}" // library marker kkossev.temperatureLib, line 47
} // library marker kkossev.temperatureLib, line 48
} // library marker kkossev.temperatureLib, line 49
void handleTemperatureEvent(BigDecimal temperaturePar, boolean isDigital=false) { // library marker kkossev.temperatureLib, line 51
Map eventMap = [:] // library marker kkossev.temperatureLib, line 52
BigDecimal temperature = safeToBigDecimal(temperaturePar).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 53
if (state.stats != null) { state.stats['tempCtr'] = (state.stats['tempCtr'] ?: 0) + 1 } else { state.stats = [:] } // library marker kkossev.temperatureLib, line 54
eventMap.name = 'temperature' // library marker kkossev.temperatureLib, line 55
if (location.temperatureScale == 'F') { // library marker kkossev.temperatureLib, line 56
temperature = ((temperature * 1.8) + 32).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 57
eventMap.unit = '\u00B0F' // library marker kkossev.temperatureLib, line 58
} // library marker kkossev.temperatureLib, line 59
else { // library marker kkossev.temperatureLib, line 60
eventMap.unit = '\u00B0C' // library marker kkossev.temperatureLib, line 61
} // library marker kkossev.temperatureLib, line 62
BigDecimal tempCorrected = (temperature + safeToBigDecimal(settings?.temperatureOffset ?: 0)).setScale(2, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 63
eventMap.value = tempCorrected.setScale(1, BigDecimal.ROUND_HALF_UP) // library marker kkossev.temperatureLib, line 64
BigDecimal lastTemp = device.currentValue('temperature') ?: 0 // library marker kkossev.temperatureLib, line 65
logTrace "lastTemp=${lastTemp} tempCorrected=${tempCorrected} delta=${Math.abs(lastTemp - tempCorrected)}" // library marker kkossev.temperatureLib, line 66
if (Math.abs(lastTemp - tempCorrected) < 0.1) { // library marker kkossev.temperatureLib, line 67
logDebug "skipped temperature ${tempCorrected}, less than delta 0.1 (lastTemp=${lastTemp})" // library marker kkossev.temperatureLib, line 68
return // library marker kkossev.temperatureLib, line 69
} // library marker kkossev.temperatureLib, line 70
eventMap.type = isDigital == true ? 'digital' : 'physical' // library marker kkossev.temperatureLib, line 71
eventMap.descriptionText = "${eventMap.name} is ${eventMap.value} ${eventMap.unit}" // library marker kkossev.temperatureLib, line 72
if (state.states['isRefresh'] == true) { // library marker kkossev.temperatureLib, line 73
eventMap.descriptionText += ' [refresh]' // library marker kkossev.temperatureLib, line 74
eventMap.isStateChange = true // library marker kkossev.temperatureLib, line 75
} // library marker kkossev.temperatureLib, line 76
Integer timeElapsed = Math.round((now() - (state.lastRx['tempTime'] ?: now())) / 1000) // library marker kkossev.temperatureLib, line 77
Integer minTime = settings?.minReportingTime ?: DEFAULT_MIN_REPORTING_TIME // library marker kkossev.temperatureLib, line 78
Integer timeRamaining = (minTime - timeElapsed) as Integer // library marker kkossev.temperatureLib, line 79
if (timeElapsed >= minTime) { // library marker kkossev.temperatureLib, line 80
logInfo "${eventMap.descriptionText}" // library marker kkossev.temperatureLib, line 81
unschedule('sendDelayedTempEvent') //get rid of stale queued reports // library marker kkossev.temperatureLib, line 82
state.lastRx['tempTime'] = now() // library marker kkossev.temperatureLib, line 83
sendEvent(eventMap) // library marker kkossev.temperatureLib, line 84
} // library marker kkossev.temperatureLib, line 85
else { // queue the event // library marker kkossev.temperatureLib, line 86
eventMap.type = 'delayed' // library marker kkossev.temperatureLib, line 87
logDebug "${device.displayName} DELAYING ${timeRamaining} seconds event : ${eventMap}" // library marker kkossev.temperatureLib, line 88
runIn(timeRamaining, 'sendDelayedTempEvent', [overwrite: true, data: eventMap]) // library marker kkossev.temperatureLib, line 89
} // library marker kkossev.temperatureLib, line 90
} // library marker kkossev.temperatureLib, line 91
void sendDelayedTempEvent(Map eventMap) { // library marker kkossev.temperatureLib, line 93
logInfo "${eventMap.descriptionText} (${eventMap.type})" // library marker kkossev.temperatureLib, line 94
state.lastRx['tempTime'] = now() // TODO - -(minReportingTimeHumidity * 2000) // library marker kkossev.temperatureLib, line 95
sendEvent(eventMap) // library marker kkossev.temperatureLib, line 96
} // library marker kkossev.temperatureLib, line 97
List temperatureLibInitializeDevice() { // library marker kkossev.temperatureLib, line 99
List cmds = [] // library marker kkossev.temperatureLib, line 100
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 101
logDebug "temperatureLibInitializeDevice() cmds=${cmds}" // library marker kkossev.temperatureLib, line 102
return cmds // library marker kkossev.temperatureLib, line 103
} // library marker kkossev.temperatureLib, line 104
List temperatureRefresh() { // library marker kkossev.temperatureLib, line 106
List cmds = [] // library marker kkossev.temperatureLib, line 107
cmds += zigbee.readAttribute(0x0402, 0x0000, [:], delay = 200) // library marker kkossev.temperatureLib, line 108
return cmds // library marker kkossev.temperatureLib, line 109
} // library marker kkossev.temperatureLib, line 110
// ~~~~~ end include (172) kkossev.temperatureLib ~~~~~
// ~~~~~ start include (142) kkossev.deviceProfileLib ~~~~~
/* groovylint-disable CompileStatic, CouldBeSwitchStatement, DuplicateListLiteral, DuplicateNumberLiteral, DuplicateStringLiteral, ImplicitClosureParameter, ImplicitReturnStatement, Instanceof, LineLength, MethodCount, MethodSize, NestedBlockDepth, NoDouble, NoFloat, NoWildcardImports, ParameterName, UnnecessaryElseStatement, UnnecessaryGetter, UnnecessaryPublicModifier, UnnecessarySetter, UnusedImport */ // library marker kkossev.deviceProfileLib, line 1
library( // library marker kkossev.deviceProfileLib, line 2
base: 'driver', author: 'Krassimir Kossev', category: 'zigbee', description: 'Device Profile Library', name: 'deviceProfileLib', namespace: 'kkossev', // library marker kkossev.deviceProfileLib, line 3
importUrl: 'https://raw.githubusercontent.com/kkossev/hubitat/development/libraries/deviceProfileLib.groovy', documentationLink: '', // library marker kkossev.deviceProfileLib, line 4
version: '3.3.1' // library marker kkossev.deviceProfileLib, line 5
) // library marker kkossev.deviceProfileLib, line 6
/* // library marker kkossev.deviceProfileLib, line 7
* Device Profile Library // library marker kkossev.deviceProfileLib, line 8
* // library marker kkossev.deviceProfileLib, line 9
* Licensed Virtual the Apache License, Version 2.0 (the "License"); you may not use this file except // library marker kkossev.deviceProfileLib, line 10
* in compliance with the License. You may obtain a copy of the License at: // library marker kkossev.deviceProfileLib, line 11
* // library marker kkossev.deviceProfileLib, line 12
* http://www.apache.org/licenses/LICENSE-2.0 // library marker kkossev.deviceProfileLib, line 13
* // library marker kkossev.deviceProfileLib, line 14
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed // library marker kkossev.deviceProfileLib, line 15
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License // library marker kkossev.deviceProfileLib, line 16
* for the specific language governing permissions and limitations under the License. // library marker kkossev.deviceProfileLib, line 17
* // library marker kkossev.deviceProfileLib, line 18
* ver. 1.0.0 2023-11-04 kkossev - added deviceProfileLib (based on Tuya 4 In 1 driver) // library marker kkossev.deviceProfileLib, line 19
* 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 20
* ver. 3.0.1 2023-12-02 kkossev - release candidate // library marker kkossev.deviceProfileLib, line 21
* 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 22
* ver. 3.0.4 2024-03-30 kkossev - more Groovy Linting; processClusterAttributeFromDeviceProfile exception fix; // library marker kkossev.deviceProfileLib, line 23
* ver. 3.1.0 2024-04-03 kkossev - more Groovy Linting; deviceProfilesV3, enum pars bug fix; // library marker kkossev.deviceProfileLib, line 24
* 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 25
* ver. 3.1.2 2024-05-05 kkossev - added isSpammyDeviceProfile() // library marker kkossev.deviceProfileLib, line 26
* ver. 3.1.3 2024-05-21 kkossev - skip processClusterAttributeFromDeviceProfile if cluster or attribute or value is missing // library marker kkossev.deviceProfileLib, line 27
* ver. 3.2.0 2024-05-25 kkossev - commonLib 3.2.0 allignment; // library marker kkossev.deviceProfileLib, line 28
* 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 29
* 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 30
* ver. 3.3.1 2024-07-06 kkossev - (dev. branch) added powerSource event in the initEventsDeviceProfile // library marker kkossev.deviceProfileLib, line 31
* // library marker kkossev.deviceProfileLib, line 32
* TODO - remove the 2-in-1 patch ! // library marker kkossev.deviceProfileLib, line 33
* TODO - add defaults for profileId:'0104', endpointId:'01', inClusters, outClusters, in the deviceProfilesV3 map // library marker kkossev.deviceProfileLib, line 34
* TODO - add updateStateUnknownDPs (from the 4-in-1 driver) // library marker kkossev.deviceProfileLib, line 35
* TODO - when [refresh], send Info logs for parameters that are not events or preferences // library marker kkossev.deviceProfileLib, line 36
* 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 37
* TODO: add _DEBUG command (for temporary switching the debug logs on/off) // library marker kkossev.deviceProfileLib, line 38
* TODO: allow NULL parameters default values in the device profiles // library marker kkossev.deviceProfileLib, line 39
* TODO: handle preferences of a type TEXT // library marker kkossev.deviceProfileLib, line 40
* // library marker kkossev.deviceProfileLib, line 41
*/ // library marker kkossev.deviceProfileLib, line 42
static String deviceProfileLibVersion() { '3.3.1' } // library marker kkossev.deviceProfileLib, line 44
static String deviceProfileLibStamp() { '2024/07/06 10:02 PM' } // library marker kkossev.deviceProfileLib, line 45
import groovy.json.* // library marker kkossev.deviceProfileLib, line 46
import groovy.transform.Field // library marker kkossev.deviceProfileLib, line 47
import hubitat.zigbee.clusters.iaszone.ZoneStatus // library marker kkossev.deviceProfileLib, line 48
import hubitat.zigbee.zcl.DataType // library marker kkossev.deviceProfileLib, line 49
import java.util.concurrent.ConcurrentHashMap // library marker kkossev.deviceProfileLib, line 50
import groovy.transform.CompileStatic // library marker kkossev.deviceProfileLib, line 52
metadata { // library marker kkossev.deviceProfileLib, line 54
// no capabilities // library marker kkossev.deviceProfileLib, line 55
// no attributes // library marker kkossev.deviceProfileLib, line 56
command 'sendCommand', [ // library marker kkossev.deviceProfileLib, line 57
[name:'command', type: 'STRING', description: 'command name', constraints: ['STRING']], // library marker kkossev.deviceProfileLib, line 58
[name:'val', type: 'STRING', description: 'command parameter value', constraints: ['STRING']] // library marker kkossev.deviceProfileLib, line 59
] // library marker kkossev.deviceProfileLib, line 60
command 'setPar', [ // library marker kkossev.deviceProfileLib, line 61
[name:'par', type: 'STRING', description: 'preference parameter name', constraints: ['STRING']], // library marker kkossev.deviceProfileLib, line 62
[name:'val', type: 'STRING', description: 'preference parameter value', constraints: ['STRING']] // library marker kkossev.deviceProfileLib, line 63
] // library marker kkossev.deviceProfileLib, line 64
preferences { // library marker kkossev.deviceProfileLib, line 66
if (device) { // library marker kkossev.deviceProfileLib, line 67
// itterate over DEVICE.preferences map and inputIt all // library marker kkossev.deviceProfileLib, line 68
if (DEVICE != null && DEVICE?.preferences != null && DEVICE?.preferences != [:] && DEVICE?.device?.isDepricated != true) { // library marker kkossev.deviceProfileLib, line 69
(DEVICE?.preferences).each { key, value -> // library marker kkossev.deviceProfileLib, line 70
Map inputMap = inputIt(key) // library marker kkossev.deviceProfileLib, line 71
if (inputMap != null && inputMap != [:]) { // library marker kkossev.deviceProfileLib, line 72
input inputMap // library marker kkossev.deviceProfileLib, line 73
} // library marker kkossev.deviceProfileLib, line 74
} // library marker kkossev.deviceProfileLib, line 75
} // library marker kkossev.deviceProfileLib, line 76
//if (advancedOptions == true) { // library marker kkossev.deviceProfileLib, line 77
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 78
//} // library marker kkossev.deviceProfileLib, line 79
} // library marker kkossev.deviceProfileLib, line 80
} // library marker kkossev.deviceProfileLib, line 81
} // library marker kkossev.deviceProfileLib, line 82
private boolean is2in1() { return getDeviceProfile().contains('TS0601_2IN1') } // patch removed 05/29/2024 // library marker kkossev.deviceProfileLib, line 84
public String getDeviceProfile() { state?.deviceProfile ?: 'UNKNOWN' } // library marker kkossev.deviceProfileLib, line 86
public Map getDEVICE() { deviceProfilesV3 != null ? deviceProfilesV3[getDeviceProfile()] : deviceProfilesV2 != null ? deviceProfilesV2[getDeviceProfile()] : [:] } // library marker kkossev.deviceProfileLib, line 87
public Set getDeviceProfiles() { deviceProfilesV3 != null ? deviceProfilesV3?.keySet() : deviceProfilesV2 != null ? deviceProfilesV2?.keySet() : [] } // library marker kkossev.deviceProfileLib, line 88
//List getDeviceProfilesMap() { deviceProfilesV3 != null ? deviceProfilesV3.values().description as List : deviceProfilesV2.values().description as List } // library marker kkossev.deviceProfileLib, line 89
public List getDeviceProfilesMap() { // library marker kkossev.deviceProfileLib, line 91
if (deviceProfilesV3 == null) { // library marker kkossev.deviceProfileLib, line 92
if (deviceProfilesV2 == null) { return [] } // library marker kkossev.deviceProfileLib, line 93
return deviceProfilesV2.values().description as List // library marker kkossev.deviceProfileLib, line 94
} // library marker kkossev.deviceProfileLib, line 95
List activeProfiles = [] // library marker kkossev.deviceProfileLib, line 96
deviceProfilesV3.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 97
if ((profileMap.device?.isDepricated ?: false) != true) { // library marker kkossev.deviceProfileLib, line 98
activeProfiles.add(profileMap.description ?: '---') // library marker kkossev.deviceProfileLib, line 99
} // library marker kkossev.deviceProfileLib, line 100
} // library marker kkossev.deviceProfileLib, line 101
return activeProfiles // library marker kkossev.deviceProfileLib, line 102
} // library marker kkossev.deviceProfileLib, line 103
// ---------------------------------- deviceProfilesV3 helper functions -------------------------------------------- // library marker kkossev.deviceProfileLib, line 106
/** // library marker kkossev.deviceProfileLib, line 108
* Returns the profile key for a given profile description. // library marker kkossev.deviceProfileLib, line 109
* @param valueStr The profile description to search for. // library marker kkossev.deviceProfileLib, line 110
* @return The profile key if found, otherwise null. // library marker kkossev.deviceProfileLib, line 111
*/ // library marker kkossev.deviceProfileLib, line 112
String getProfileKey(final String valueStr) { // library marker kkossev.deviceProfileLib, line 113
if (deviceProfilesV3 != null) { return deviceProfilesV3.find { _, profileMap -> profileMap.description == valueStr }?.key } // library marker kkossev.deviceProfileLib, line 114
else if (deviceProfilesV2 != null) { return deviceProfilesV2.find { _, profileMap -> profileMap.description == valueStr }?.key } // library marker kkossev.deviceProfileLib, line 115
else { return null } // library marker kkossev.deviceProfileLib, line 116
} // library marker kkossev.deviceProfileLib, line 117
/** // library marker kkossev.deviceProfileLib, line 119
* Finds the preferences map for the given parameter. // library marker kkossev.deviceProfileLib, line 120
* @param param The parameter to find the preferences map for. // library marker kkossev.deviceProfileLib, line 121
* @param debug Whether or not to output debug logs. // library marker kkossev.deviceProfileLib, line 122
* @return returns either tuyaDPs or attributes map, depending on where the preference (param) is found // library marker kkossev.deviceProfileLib, line 123
* @return empty map [:] if param is not defined for this device. // library marker kkossev.deviceProfileLib, line 124
*/ // library marker kkossev.deviceProfileLib, line 125
Map getPreferencesMapByName(final String param, boolean debug=false) { // library marker kkossev.deviceProfileLib, line 126
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 127
if (!(param in DEVICE?.preferences)) { if (debug) { log.warn "getPreferencesMapByName: preference ${param} not defined for this device!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 128
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 129
def preference // library marker kkossev.deviceProfileLib, line 130
try { // library marker kkossev.deviceProfileLib, line 131
preference = DEVICE?.preferences["$param"] // library marker kkossev.deviceProfileLib, line 132
if (debug) { log.debug "getPreferencesMapByName: preference ${param} found. value is ${preference}" } // library marker kkossev.deviceProfileLib, line 133
if (preference in [true, false]) { // library marker kkossev.deviceProfileLib, line 134
// find the preference in the tuyaDPs map // library marker kkossev.deviceProfileLib, line 135
logDebug "getPreferencesMapByName: preference ${param} is boolean" // library marker kkossev.deviceProfileLib, line 136
return [:] // no maps for predefined preferences ! // library marker kkossev.deviceProfileLib, line 137
} // library marker kkossev.deviceProfileLib, line 138
if (safeToInt(preference, -1) > 0) { //if (preference instanceof Number) { // library marker kkossev.deviceProfileLib, line 139
int dp = safeToInt(preference) // library marker kkossev.deviceProfileLib, line 140
//if (debug) log.trace "getPreferencesMapByName: param ${param} preference ${preference} is number (${dp})" // library marker kkossev.deviceProfileLib, line 141
foundMap = DEVICE?.tuyaDPs.find { it.dp == dp } // library marker kkossev.deviceProfileLib, line 142
} // library marker kkossev.deviceProfileLib, line 143
else { // cluster:attribute // library marker kkossev.deviceProfileLib, line 144
//if (debug) { log.trace "${DEVICE?.attributes}" } // library marker kkossev.deviceProfileLib, line 145
foundMap = DEVICE?.attributes.find { it.at == preference } // library marker kkossev.deviceProfileLib, line 146
} // library marker kkossev.deviceProfileLib, line 147
// TODO - could be also 'true' or 'false' ... // library marker kkossev.deviceProfileLib, line 148
} catch (e) { // library marker kkossev.deviceProfileLib, line 149
if (debug) { log.warn "getPreferencesMapByName: exception ${e} caught when getting preference ${param} !" } // library marker kkossev.deviceProfileLib, line 150
return [:] // library marker kkossev.deviceProfileLib, line 151
} // library marker kkossev.deviceProfileLib, line 152
if (debug) { log.debug "getPreferencesMapByName: foundMap = ${foundMap}" } // library marker kkossev.deviceProfileLib, line 153
return foundMap // library marker kkossev.deviceProfileLib, line 154
} // library marker kkossev.deviceProfileLib, line 155
Map getAttributesMap(String attribName, boolean debug=false) { // library marker kkossev.deviceProfileLib, line 157
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 158
List'], // library marker kkossev.deviceProfileLib, line 199
if (parMap?.defVal == null) { logDebug "no default value for preference ${parName} !" ; return } // continue // library marker kkossev.deviceProfileLib, line 200
if (debug) { log.info "setting par ${parMap.name} defVal = ${parMap.defVal} (type:${parMap.type})" } // library marker kkossev.deviceProfileLib, line 201
String str = parMap.name // library marker kkossev.deviceProfileLib, line 202
device.updateSetting("$str", [value:parMap.defVal as String, type:parMap.type]) // library marker kkossev.deviceProfileLib, line 203
} // library marker kkossev.deviceProfileLib, line 204
logInfo 'Preferences reset to default values' // library marker kkossev.deviceProfileLib, line 205
} // library marker kkossev.deviceProfileLib, line 206
/** // library marker kkossev.deviceProfileLib, line 208
* Returns a list of valid parameters per model based on the device preferences. // library marker kkossev.deviceProfileLib, line 209
* // library marker kkossev.deviceProfileLib, line 210
* @return List of valid parameters. // library marker kkossev.deviceProfileLib, line 211
*/ // library marker kkossev.deviceProfileLib, line 212
List getValidParsPerModel() { // library marker kkossev.deviceProfileLib, line 213
List validPars = [] // library marker kkossev.deviceProfileLib, line 214
if (DEVICE?.preferences != null && DEVICE?.preferences != [:]) { // library marker kkossev.deviceProfileLib, line 215
// use the preferences to validate the parameters // library marker kkossev.deviceProfileLib, line 216
validPars = DEVICE?.preferences.keySet().toList() // library marker kkossev.deviceProfileLib, line 217
} // library marker kkossev.deviceProfileLib, line 218
return validPars // library marker kkossev.deviceProfileLib, line 219
} // library marker kkossev.deviceProfileLib, line 220
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 222
def getScaledPreferenceValue(String preference, Map dpMap) { // library marker kkossev.deviceProfileLib, line 223
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 224
def value = settings."${preference}" // library marker kkossev.deviceProfileLib, line 225
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 226
def scaledValue // library marker kkossev.deviceProfileLib, line 227
if (value == null) { // library marker kkossev.deviceProfileLib, line 228
logDebug "getScaledPreferenceValue: preference ${preference} not found!" // library marker kkossev.deviceProfileLib, line 229
return null // library marker kkossev.deviceProfileLib, line 230
} // library marker kkossev.deviceProfileLib, line 231
switch (dpMap.type) { // library marker kkossev.deviceProfileLib, line 232
case 'number' : // library marker kkossev.deviceProfileLib, line 233
scaledValue = safeToInt(value) // library marker kkossev.deviceProfileLib, line 234
break // library marker kkossev.deviceProfileLib, line 235
case 'decimal' : // library marker kkossev.deviceProfileLib, line 236
scaledValue = safeToDouble(value) // library marker kkossev.deviceProfileLib, line 237
if (dpMap.scale != null && dpMap.scale != 1) { // library marker kkossev.deviceProfileLib, line 238
scaledValue = Math.round(scaledValue * dpMap.scale) // library marker kkossev.deviceProfileLib, line 239
} // library marker kkossev.deviceProfileLib, line 240
break // library marker kkossev.deviceProfileLib, line 241
case 'bool' : // library marker kkossev.deviceProfileLib, line 242
scaledValue = value == 'true' ? 1 : 0 // library marker kkossev.deviceProfileLib, line 243
break // library marker kkossev.deviceProfileLib, line 244
case 'enum' : // library marker kkossev.deviceProfileLib, line 245
//logWarn "getScaledPreferenceValue: ENUM preference ${preference} type:${dpMap.type} value = ${value} dpMap.scale=${dpMap.scale}" // library marker kkossev.deviceProfileLib, line 246
if (dpMap.map == null) { // library marker kkossev.deviceProfileLib, line 247
logDebug "getScaledPreferenceValue: preference ${preference} has no map defined!" // library marker kkossev.deviceProfileLib, line 248
return null // library marker kkossev.deviceProfileLib, line 249
} // library marker kkossev.deviceProfileLib, line 250
scaledValue = value // library marker kkossev.deviceProfileLib, line 251
if (dpMap.scale != null && safeToInt(dpMap.scale) != 1) { // library marker kkossev.deviceProfileLib, line 252
scaledValue = Math.round(safeToDouble(scaledValue ) * safeToInt(dpMap.scale)) // library marker kkossev.deviceProfileLib, line 253
} // library marker kkossev.deviceProfileLib, line 254
break // library marker kkossev.deviceProfileLib, line 255
default : // library marker kkossev.deviceProfileLib, line 256
logDebug "getScaledPreferenceValue: preference ${preference} has unsupported type ${dpMap.type}!" // library marker kkossev.deviceProfileLib, line 257
return null // library marker kkossev.deviceProfileLib, line 258
} // library marker kkossev.deviceProfileLib, line 259
//logDebug "getScaledPreferenceValue: preference ${preference} value = ${value} scaledValue = ${scaledValue} (scale=${dpMap.scale})" // library marker kkossev.deviceProfileLib, line 260
return scaledValue // library marker kkossev.deviceProfileLib, line 261
} // library marker kkossev.deviceProfileLib, line 262
// called from customUpdated() method in the custom driver // library marker kkossev.deviceProfileLib, line 264
// TODO !!!!!!!!!! - refactor it !!! IAS settings do not use Tuya DPs !!! // library marker kkossev.deviceProfileLib, line 265
public void updateAllPreferences() { // library marker kkossev.deviceProfileLib, line 266
logDebug "updateAllPreferences: preferences=${DEVICE?.preferences}" // library marker kkossev.deviceProfileLib, line 267
if (DEVICE?.preferences == null || DEVICE?.preferences == [:]) { // library marker kkossev.deviceProfileLib, line 268
logDebug "updateAllPreferences: no preferences defined for device profile ${getDeviceProfile()}" // library marker kkossev.deviceProfileLib, line 269
return // library marker kkossev.deviceProfileLib, line 270
} // library marker kkossev.deviceProfileLib, line 271
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 272
def preferenceValue // int or String for enums // library marker kkossev.deviceProfileLib, line 273
// itterate over the preferences map and update the device settings // library marker kkossev.deviceProfileLib, line 274
(DEVICE?.preferences).each { name, dp -> // library marker kkossev.deviceProfileLib, line 275
Map foundMap = getPreferencesMapByName(name, false) // library marker kkossev.deviceProfileLib, line 276
logDebug "updateAllPreferences: foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 277
if (foundMap != null && foundMap != [:]) { // library marker kkossev.deviceProfileLib, line 278
// preferenceValue = getScaledPreferenceValue(name, foundMap) // library marker kkossev.deviceProfileLib, line 279
preferenceValue = settings."${name}" // library marker kkossev.deviceProfileLib, line 280
logTrace"preferenceValue = ${preferenceValue}" // library marker kkossev.deviceProfileLib, line 281
if (foundMap.type == 'enum' && foundMap.scale != null && foundMap.scale != 1 && foundMap.scale != 0) { // library marker kkossev.deviceProfileLib, line 282
// scale the value // library marker kkossev.deviceProfileLib, line 283
preferenceValue = (safeToDouble(preferenceValue) / safeToInt(foundMap.scale)) as double // library marker kkossev.deviceProfileLib, line 284
} // library marker kkossev.deviceProfileLib, line 285
if (preferenceValue != null) { // library marker kkossev.deviceProfileLib, line 286
setPar(name, preferenceValue.toString()) // library marker kkossev.deviceProfileLib, line 287
} // library marker kkossev.deviceProfileLib, line 288
else { logDebug "updateAllPreferences: preference ${name} is not set (preferenceValue was null)" ; return } // library marker kkossev.deviceProfileLib, line 289
} // library marker kkossev.deviceProfileLib, line 290
else { logDebug "warning: couldn't find map for preference ${name}" ; return } // library marker kkossev.deviceProfileLib, line 291
} // library marker kkossev.deviceProfileLib, line 292
return // library marker kkossev.deviceProfileLib, line 293
} // library marker kkossev.deviceProfileLib, line 294
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 296
def divideBy100(int val) { return (val as int) / 100 } // library marker kkossev.deviceProfileLib, line 297
int multiplyBy100(int val) { return (val as int) * 100 } // library marker kkossev.deviceProfileLib, line 298
int divideBy10(int val) { // library marker kkossev.deviceProfileLib, line 299
if (val > 10) { return (val as int) / 10 } // library marker kkossev.deviceProfileLib, line 300
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 301
} // library marker kkossev.deviceProfileLib, line 302
int multiplyBy10(int val) { return (val as int) * 10 } // library marker kkossev.deviceProfileLib, line 303
int divideBy1(int val) { return (val as int) / 1 } //tests // library marker kkossev.deviceProfileLib, line 304
int signedInt(int val) { // library marker kkossev.deviceProfileLib, line 305
if (val > 127) { return (val as int) - 256 } // library marker kkossev.deviceProfileLib, line 306
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 307
} // library marker kkossev.deviceProfileLib, line 308
int invert(int val) { // library marker kkossev.deviceProfileLib, line 309
if (settings.invertMotion == true) { return val == 0 ? 1 : 0 } // library marker kkossev.deviceProfileLib, line 310
else { return val } // library marker kkossev.deviceProfileLib, line 311
} // library marker kkossev.deviceProfileLib, line 312
// called from setPar and sendAttribite methods for non-Tuya DPs // library marker kkossev.deviceProfileLib, line 314
List zclWriteAttribute(Map attributesMap, int scaledValue) { // library marker kkossev.deviceProfileLib, line 315
if (attributesMap == null || attributesMap == [:]) { logWarn "attributesMap=${attributesMap}" ; return [] } // library marker kkossev.deviceProfileLib, line 316
List cmds = [] // library marker kkossev.deviceProfileLib, line 317
Map map = [:] // library marker kkossev.deviceProfileLib, line 318
// cluster:attribute // library marker kkossev.deviceProfileLib, line 319
try { // library marker kkossev.deviceProfileLib, line 320
map['cluster'] = hubitat.helper.HexUtils.hexStringToInt((attributesMap.at).split(':')[0]) as Integer // library marker kkossev.deviceProfileLib, line 321
map['attribute'] = hubitat.helper.HexUtils.hexStringToInt((attributesMap.at).split(':')[1]) as Integer // library marker kkossev.deviceProfileLib, line 322
map['dt'] = (attributesMap.dt != null && attributesMap.dt != '') ? hubitat.helper.HexUtils.hexStringToInt(attributesMap.dt) as Integer : null // library marker kkossev.deviceProfileLib, line 323
map['mfgCode'] = attributesMap.mfgCode ? attributesMap.mfgCode as String : null // library marker kkossev.deviceProfileLib, line 324
} // library marker kkossev.deviceProfileLib, line 325
catch (e) { logWarn "setPar: Exception caught while splitting cluser and attribute $customSetFunction($scaledValue) (val=${val})) : '${e}' " ; return [] } // library marker kkossev.deviceProfileLib, line 326
// dt (data type) is obligatory when writing to a cluster... // library marker kkossev.deviceProfileLib, line 327
if (attributesMap.rw != null && attributesMap.rw == 'rw' && map.dt == null) { // library marker kkossev.deviceProfileLib, line 328
map.dt = attributesMap.type in ['number', 'decimal'] ? DataType.INT16 : DataType.ENUM8 // library marker kkossev.deviceProfileLib, line 329
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 330
} // library marker kkossev.deviceProfileLib, line 331
if (map.mfgCode != null && map.mfgCode != '') { // library marker kkossev.deviceProfileLib, line 332
Map mfgCode = map.mfgCode != null ? ['mfgCode':map.mfgCode] : [:] // library marker kkossev.deviceProfileLib, line 333
cmds = zigbee.writeAttribute(map.cluster as int, map.attribute as int, map.dt as int, scaledValue, mfgCode, delay = 50) // library marker kkossev.deviceProfileLib, line 334
} // library marker kkossev.deviceProfileLib, line 335
else { // library marker kkossev.deviceProfileLib, line 336
cmds = zigbee.writeAttribute(map.cluster as int, map.attribute as int, map.dt as int, scaledValue, [:], delay = 50) // library marker kkossev.deviceProfileLib, line 337
} // library marker kkossev.deviceProfileLib, line 338
return cmds // library marker kkossev.deviceProfileLib, line 339
} // library marker kkossev.deviceProfileLib, line 340
/** // library marker kkossev.deviceProfileLib, line 342
* Called from setPar() method only! // library marker kkossev.deviceProfileLib, line 343
* Validates the parameter value based on the given dpMap type and scales it if needed. // library marker kkossev.deviceProfileLib, line 344
* // library marker kkossev.deviceProfileLib, line 345
* @param dpMap The map containing the parameter type, minimum and maximum values. // library marker kkossev.deviceProfileLib, line 346
* @param val The value to be validated and scaled. // library marker kkossev.deviceProfileLib, line 347
* @return The validated and scaled value if it is within the specified range, null otherwise. // library marker kkossev.deviceProfileLib, line 348
*/ // library marker kkossev.deviceProfileLib, line 349
/* groovylint-disable-next-line MethodReturnTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 350
def validateAndScaleParameterValue(Map dpMap, String val) { // library marker kkossev.deviceProfileLib, line 351
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 352
def value // validated value - integer, floar // library marker kkossev.deviceProfileLib, line 353
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 354
def scaledValue // // library marker kkossev.deviceProfileLib, line 355
//logDebug "validateAndScaleParameterValue: dpMap=${dpMap} val=${val}" // library marker kkossev.deviceProfileLib, line 356
switch (dpMap.type) { // library marker kkossev.deviceProfileLib, line 357
case 'number' : // library marker kkossev.deviceProfileLib, line 358
// TODO - negative values ! // library marker kkossev.deviceProfileLib, line 359
// TODO - better conversion to integer! // library marker kkossev.deviceProfileLib, line 360
value = safeToInt(val, 0) // library marker kkossev.deviceProfileLib, line 361
//scaledValue = value // library marker kkossev.deviceProfileLib, line 362
// scale the value - added 10/26/2023 also for integer values ! // library marker kkossev.deviceProfileLib, line 363
if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 364
scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 365
} // library marker kkossev.deviceProfileLib, line 366
else { // library marker kkossev.deviceProfileLib, line 367
scaledValue = value // library marker kkossev.deviceProfileLib, line 368
} // library marker kkossev.deviceProfileLib, line 369
break // library marker kkossev.deviceProfileLib, line 370
case 'decimal' : // library marker kkossev.deviceProfileLib, line 372
value = safeToDouble(val, 0.0) // library marker kkossev.deviceProfileLib, line 373
// scale the value // library marker kkossev.deviceProfileLib, line 374
if (dpMap.scale != null) { // library marker kkossev.deviceProfileLib, line 375
scaledValue = (value * dpMap.scale) as Integer // library marker kkossev.deviceProfileLib, line 376
} // library marker kkossev.deviceProfileLib, line 377
else { // library marker kkossev.deviceProfileLib, line 378
scaledValue = value // library marker kkossev.deviceProfileLib, line 379
} // library marker kkossev.deviceProfileLib, line 380
break // library marker kkossev.deviceProfileLib, line 381
case 'bool' : // library marker kkossev.deviceProfileLib, line 383
if (val == '0' || val == 'false') { value = scaledValue = 0 } // library marker kkossev.deviceProfileLib, line 384
else if (val == '1' || val == 'true') { value = scaledValue = 1 } // library marker kkossev.deviceProfileLib, line 385
else { // library marker kkossev.deviceProfileLib, line 386
logInfo "bool parameter ${val}. value must be one of 0 1 false true" // library marker kkossev.deviceProfileLib, line 387
return null // library marker kkossev.deviceProfileLib, line 388
} // library marker kkossev.deviceProfileLib, line 389
break // library marker kkossev.deviceProfileLib, line 390
case 'enum' : // library marker kkossev.deviceProfileLib, line 391
// enums are always integer values // library marker kkossev.deviceProfileLib, line 392
// check if the scaling is different than 1 in dpMap // library marker kkossev.deviceProfileLib, line 393
logTrace "validateAndScaleParameterValue: enum parameter ${val}. dpMap=${dpMap}" // library marker kkossev.deviceProfileLib, line 394
Integer scale = safeToInt(dpMap.scale) // library marker kkossev.deviceProfileLib, line 395
if (scale != null && scale != 0 && scale != 1) { // library marker kkossev.deviceProfileLib, line 396
// we have a float parameter input - convert it to int // library marker kkossev.deviceProfileLib, line 397
value = safeToDouble(val, -1.0) // library marker kkossev.deviceProfileLib, line 398
scaledValue = (value * safeToInt(dpMap.scale)) as Integer // library marker kkossev.deviceProfileLib, line 399
} // library marker kkossev.deviceProfileLib, line 400
else { // library marker kkossev.deviceProfileLib, line 401
value = scaledValue = safeToInt(val, -1) // library marker kkossev.deviceProfileLib, line 402
} // library marker kkossev.deviceProfileLib, line 403
if (scaledValue == null || scaledValue < 0) { // library marker kkossev.deviceProfileLib, line 404
// get the keys of dpMap.map as a List // library marker kkossev.deviceProfileLib, line 405
//List keys = dpMap.map.keySet().toList() // library marker kkossev.deviceProfileLib, line 406
//logDebug "${device.displayName} validateAndScaleParameterValue: enum parameter ${val}. value must be one of ${keys}" // library marker kkossev.deviceProfileLib, line 407
// find the key for the value // library marker kkossev.deviceProfileLib, line 408
String key = dpMap.map.find { it.value == val }?.key // library marker kkossev.deviceProfileLib, line 409
logTrace "validateAndScaleParameterValue: enum parameter ${val}. key=${key}" // library marker kkossev.deviceProfileLib, line 410
if (key == null) { // library marker kkossev.deviceProfileLib, line 411
logInfo "invalid enum parameter ${val}. value must be one of ${dpMap.map}" // library marker kkossev.deviceProfileLib, line 412
return null // library marker kkossev.deviceProfileLib, line 413
} // library marker kkossev.deviceProfileLib, line 414
value = scaledValue = key as Integer // library marker kkossev.deviceProfileLib, line 415
//return null // library marker kkossev.deviceProfileLib, line 416
} // library marker kkossev.deviceProfileLib, line 417
break // library marker kkossev.deviceProfileLib, line 418
default : // library marker kkossev.deviceProfileLib, line 419
logWarn "validateAndScaleParameterValue: unsupported dpMap type ${parType}" // library marker kkossev.deviceProfileLib, line 420
return null // library marker kkossev.deviceProfileLib, line 421
} // library marker kkossev.deviceProfileLib, line 422
//logTrace "validateAndScaleParameterValue before checking scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 423
// check if the value is within the specified range // library marker kkossev.deviceProfileLib, line 424
if ((dpMap.min != null && value < dpMap.min) || (dpMap.max != null && value > dpMap.max)) { // library marker kkossev.deviceProfileLib, line 425
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 426
return null // library marker kkossev.deviceProfileLib, line 427
} // library marker kkossev.deviceProfileLib, line 428
//logTrace "validateAndScaleParameterValue returning scaledValue=${scaledValue}" // library marker kkossev.deviceProfileLib, line 429
return scaledValue // library marker kkossev.deviceProfileLib, line 430
} // library marker kkossev.deviceProfileLib, line 431
/** // library marker kkossev.deviceProfileLib, line 433
* Sets the value of a parameter for a device. // library marker kkossev.deviceProfileLib, line 434
* // library marker kkossev.deviceProfileLib, line 435
* @param par The parameter name. // library marker kkossev.deviceProfileLib, line 436
* @param val The parameter value. // library marker kkossev.deviceProfileLib, line 437
* @return true if the parameter was successfully set, false otherwise. // library marker kkossev.deviceProfileLib, line 438
*/ // library marker kkossev.deviceProfileLib, line 439
public boolean setPar(final String parPar=null, final String val=null ) { // library marker kkossev.deviceProfileLib, line 440
List cmds = [] // library marker kkossev.deviceProfileLib, line 441
//Boolean validated = false // library marker kkossev.deviceProfileLib, line 442
logDebug "setPar(${parPar}, ${val})" // library marker kkossev.deviceProfileLib, line 443
if (DEVICE?.preferences == null || DEVICE?.preferences == [:]) { return false } // library marker kkossev.deviceProfileLib, line 444
if (parPar == null /*|| !(par in getValidParsPerModel())*/) { logInfo "setPar: 'parameter' must be one of these : ${getValidParsPerModel()}"; return false } // library marker kkossev.deviceProfileLib, line 445
String par = parPar.trim() // library marker kkossev.deviceProfileLib, line 446
Map dpMap = getPreferencesMapByName(par, false) // get the map for the parameter // library marker kkossev.deviceProfileLib, line 447
if ( dpMap == null || dpMap == [:]) { logInfo "setPar: tuyaDPs map not found for parameter ${par}"; return false } // library marker kkossev.deviceProfileLib, line 448
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 449
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 450
def scaledValue = validateAndScaleParameterValue(dpMap, val as String) // convert the val to the correct type and scale it if needed // library marker kkossev.deviceProfileLib, line 451
if (scaledValue == null) { logInfo "setPar: invalid parameter ${par} value ${val}. Must be in the range ${dpMap.min} to ${dpMap.max}"; return false } // library marker kkossev.deviceProfileLib, line 452
// if there is a dedicated set function, use it // library marker kkossev.deviceProfileLib, line 454
String capitalizedFirstChar = par[0].toUpperCase() + par[1..-1] // library marker kkossev.deviceProfileLib, line 455
String customSetFunction = "customSet${capitalizedFirstChar}" // library marker kkossev.deviceProfileLib, line 456
if (this.respondsTo(customSetFunction)) { // library marker kkossev.deviceProfileLib, line 457
logDebug "setPar: found customSetFunction=${setFunction}, scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 458
// execute the customSetFunction // library marker kkossev.deviceProfileLib, line 459
try { cmds = "$customSetFunction"(scaledValue) } // library marker kkossev.deviceProfileLib, line 460
catch (e) { logWarn "setPar: Exception caught while processing $customSetFunction($scaledValue) (val=${val})) : '${e}'" ; return false } // library marker kkossev.deviceProfileLib, line 461
logDebug "customSetFunction result is ${cmds}" // library marker kkossev.deviceProfileLib, line 462
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 463
logInfo "setPar: (1) successfluly executed setPar $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 464
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 465
return true // library marker kkossev.deviceProfileLib, line 466
} // library marker kkossev.deviceProfileLib, line 467
else { // library marker kkossev.deviceProfileLib, line 468
logWarn "setPar: customSetFunction $customSetFunction($scaledValue) returned null or empty list" // library marker kkossev.deviceProfileLib, line 469
// continue with the default processing // library marker kkossev.deviceProfileLib, line 470
} // library marker kkossev.deviceProfileLib, line 471
} // library marker kkossev.deviceProfileLib, line 472
if (isVirtual()) { // library marker kkossev.deviceProfileLib, line 473
// set a virtual attribute // library marker kkossev.deviceProfileLib, line 474
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 475
def valMiscType // library marker kkossev.deviceProfileLib, line 476
logDebug "setPar: found virtual attribute ${par} value ${val}" // library marker kkossev.deviceProfileLib, line 477
if (dpMap.type == 'enum') { // library marker kkossev.deviceProfileLib, line 478
// find the key for the value // library marker kkossev.deviceProfileLib, line 479
String key = dpMap.map.find { it.value == val }?.key // library marker kkossev.deviceProfileLib, line 480
logTrace "setPar: enum parameter ${val}. key=${key}" // library marker kkossev.deviceProfileLib, line 481
if (key == null) { // library marker kkossev.deviceProfileLib, line 482
logInfo "setPar: invalid virtual enum parameter ${val}. value must be one of ${dpMap.map}" // library marker kkossev.deviceProfileLib, line 483
return false // library marker kkossev.deviceProfileLib, line 484
} // library marker kkossev.deviceProfileLib, line 485
valMiscType = dpMap.map[key as int] // library marker kkossev.deviceProfileLib, line 486
logTrace "setPar: enum parameter ${val}. key=${key} valMiscType=${valMiscType} dpMap.map=${dpMap.map}" // library marker kkossev.deviceProfileLib, line 487
device.updateSetting("$par", [value:key as String, type:dpMap.type]) // library marker kkossev.deviceProfileLib, line 488
} // library marker kkossev.deviceProfileLib, line 489
else { // library marker kkossev.deviceProfileLib, line 490
valMiscType = val // library marker kkossev.deviceProfileLib, line 491
device.updateSetting("$par", [value:valMiscType, type:dpMap.type]) // library marker kkossev.deviceProfileLib, line 492
} // library marker kkossev.deviceProfileLib, line 493
String descriptionText = "${par} set to ${valMiscType}${dpMap.unit ?: ''} [virtual]" // library marker kkossev.deviceProfileLib, line 494
sendEvent(name:par, value:valMiscType, unit:dpMap.unit ?: '', isDigital: true) // library marker kkossev.deviceProfileLib, line 495
logInfo descriptionText // library marker kkossev.deviceProfileLib, line 496
return true // library marker kkossev.deviceProfileLib, line 497
} // library marker kkossev.deviceProfileLib, line 498
// check whether this is a tuya DP or a cluster:attribute parameter // library marker kkossev.deviceProfileLib, line 500
boolean isTuyaDP // library marker kkossev.deviceProfileLib, line 501
/* groovylint-disable-next-line Instanceof */ // library marker kkossev.deviceProfileLib, line 503
try { isTuyaDP = dpMap.dp instanceof Number } // library marker kkossev.deviceProfileLib, line 504
catch (e) { logWarn"setPar: (1) exception ${e} caught while checking isNumber() preference ${preference}" ; isTuyaDP = false } // library marker kkossev.deviceProfileLib, line 505
if (dpMap.dp != null && isTuyaDP) { // library marker kkossev.deviceProfileLib, line 506
// Tuya DP // library marker kkossev.deviceProfileLib, line 507
cmds = sendTuyaParameter(dpMap, par, scaledValue) // library marker kkossev.deviceProfileLib, line 508
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 509
logWarn "setPar: sendTuyaParameter par ${par} scaledValue ${scaledValue} returned null or empty list" // library marker kkossev.deviceProfileLib, line 510
return false // library marker kkossev.deviceProfileLib, line 511
} // library marker kkossev.deviceProfileLib, line 512
else { // library marker kkossev.deviceProfileLib, line 513
logInfo "setPar: (2) sending parameter $par ($val (scaledValue=${scaledValue}))" // library marker kkossev.deviceProfileLib, line 514
sendZigbeeCommands(cmds) // library marker kkossev.deviceProfileLib, line 515
return false // library marker kkossev.deviceProfileLib, line 516
} // library marker kkossev.deviceProfileLib, line 517
} // library marker kkossev.deviceProfileLib, line 518
else if (dpMap.at != null) { // library marker kkossev.deviceProfileLib, line 519
// cluster:attribute // library marker kkossev.deviceProfileLib, line 520
logDebug "setPar: found at=${dpMap.at} dt=${dpMap.dt} mfgCode=${dpMap.mfgCode} scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 521
int signedIntScaled = convertSignedInts(scaledValue, dpMap) // library marker kkossev.deviceProfileLib, line 522
cmds = zclWriteAttribute(dpMap, signedIntScaled) // library marker kkossev.deviceProfileLib, line 523
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 524
logWarn "setPar: failed to write cluster:attribute ${dpMap.at} value ${scaledValue}" // library marker kkossev.deviceProfileLib, line 525
return false // library marker kkossev.deviceProfileLib, line 526
} // library marker kkossev.deviceProfileLib, line 527
} // library marker kkossev.deviceProfileLib, line 528
else { logWarn "setPar: invalid dp or at value ${dpMap.dp} for parameter ${par}" ; return false } // library marker kkossev.deviceProfileLib, line 529
logInfo "setPar: (3) successfluly executed setPar $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 530
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 531
return true // library marker kkossev.deviceProfileLib, line 532
} // library marker kkossev.deviceProfileLib, line 533
// 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 535
// TODO - reuse it !!! // library marker kkossev.deviceProfileLib, line 536
/* groovylint-disable-next-line MethodParameterTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 537
public List sendTuyaParameter( Map dpMap, String par, tuyaValue) { // library marker kkossev.deviceProfileLib, line 538
//logDebug "sendTuyaParameter: trying to send parameter ${par} value ${tuyaValue}" // library marker kkossev.deviceProfileLib, line 539
List cmds = [] // library marker kkossev.deviceProfileLib, line 540
if (dpMap == null) { logWarn "sendTuyaParameter: tuyaDPs map not found for parameter ${par}" ; return [] } // library marker kkossev.deviceProfileLib, line 541
String dp = zigbee.convertToHexString(dpMap.dp, 2) // library marker kkossev.deviceProfileLib, line 542
if (dpMap.dp <= 0 || dpMap.dp >= 256) { // library marker kkossev.deviceProfileLib, line 543
logWarn "sendTuyaParameter: invalid dp ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 544
return [] // library marker kkossev.deviceProfileLib, line 545
} // library marker kkossev.deviceProfileLib, line 546
String dpType // library marker kkossev.deviceProfileLib, line 547
if (dpMap.dt == null) { // library marker kkossev.deviceProfileLib, line 548
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 549
} // library marker kkossev.deviceProfileLib, line 550
else { // library marker kkossev.deviceProfileLib, line 551
dpType = dpMap.dt // "01" - bool, "02" - enum, "03" - value // library marker kkossev.deviceProfileLib, line 552
} // library marker kkossev.deviceProfileLib, line 553
if (dpType == null) { // library marker kkossev.deviceProfileLib, line 554
logWarn "sendTuyaParameter: invalid dpType ${dpMap.type} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 555
return [] // library marker kkossev.deviceProfileLib, line 556
} // library marker kkossev.deviceProfileLib, line 557
// sendTuyaCommand // library marker kkossev.deviceProfileLib, line 558
String dpValHex = dpType == DP_TYPE_VALUE ? zigbee.convertToHexString(tuyaValue as int, 8) : zigbee.convertToHexString(tuyaValue as int, 2) // library marker kkossev.deviceProfileLib, line 559
logDebug "sendTuyaParameter: sending parameter ${par} dpValHex ${dpValHex} (raw=${tuyaValue}) Tuya dp=${dp} dpType=${dpType} " // library marker kkossev.deviceProfileLib, line 560
if (dpMap.tuyaCmd != null ) { // library marker kkossev.deviceProfileLib, line 561
cmds = sendTuyaCommand( dp, dpType, dpValHex, dpMap.tuyaCmd as int) // library marker kkossev.deviceProfileLib, line 562
} // library marker kkossev.deviceProfileLib, line 563
else { // library marker kkossev.deviceProfileLib, line 564
cmds = sendTuyaCommand( dp, dpType, dpValHex) // library marker kkossev.deviceProfileLib, line 565
} // library marker kkossev.deviceProfileLib, line 566
return cmds // library marker kkossev.deviceProfileLib, line 567
} // library marker kkossev.deviceProfileLib, line 568
int convertSignedInts(int val, Map dpMap) { // library marker kkossev.deviceProfileLib, line 570
if (dpMap.dt == '0x28') { // library marker kkossev.deviceProfileLib, line 571
if (val > 127) { return (val as int) - 256 } // library marker kkossev.deviceProfileLib, line 572
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 573
} // library marker kkossev.deviceProfileLib, line 574
else if (dpMap.dt == '0x29') { // library marker kkossev.deviceProfileLib, line 575
if (val > 32767) { return (val as int) - 65536 } // library marker kkossev.deviceProfileLib, line 576
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 577
} // library marker kkossev.deviceProfileLib, line 578
else { return (val as int) } // library marker kkossev.deviceProfileLib, line 579
} // library marker kkossev.deviceProfileLib, line 580
/* groovylint-disable-next-line MethodParameterTypeRequired, NoDef */ // library marker kkossev.deviceProfileLib, line 582
public boolean sendAttribute(String par=null, val=null ) { // library marker kkossev.deviceProfileLib, line 583
List cmds = [] // library marker kkossev.deviceProfileLib, line 584
//Boolean validated = false // library marker kkossev.deviceProfileLib, line 585
logDebug "sendAttribute(${par}, ${val})" // library marker kkossev.deviceProfileLib, line 586
if (par == null || DEVICE?.preferences == null || DEVICE?.preferences == [:]) { logDebug "DEVICE.preferences is empty!" ; return false } // library marker kkossev.deviceProfileLib, line 587
Map dpMap = getAttributesMap(par, false) // get the map for the attribute // library marker kkossev.deviceProfileLib, line 589
l//log.trace "sendAttribute: dpMap=${dpMap}" // library marker kkossev.deviceProfileLib, line 590
if (dpMap == null || dpMap?.isEmpty()) { logWarn "sendAttribute: map not found for parameter ${par}"; return false } // library marker kkossev.deviceProfileLib, line 591
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 592
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 593
def scaledValue = validateAndScaleParameterValue(dpMap, val as String) // convert the val to the correct type and scale it if needed // library marker kkossev.deviceProfileLib, line 594
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 595
logDebug "sendAttribute: parameter ${par} value ${val}, type ${dpMap.type} validated and scaled to ${scaledValue} type=${dpMap.type}" // library marker kkossev.deviceProfileLib, line 596
// if there is a dedicated set function, use it // library marker kkossev.deviceProfileLib, line 597
String capitalizedFirstChar = par[0].toUpperCase() + par[1..-1] // library marker kkossev.deviceProfileLib, line 598
String customSetFunction = "customSet${capitalizedFirstChar}" // library marker kkossev.deviceProfileLib, line 599
if (this.respondsTo(customSetFunction) /*&& !(customSetFunction in ["setHeatingSetpoint", "setCoolingSetpoint", "setThermostatMode"])*/) { // library marker kkossev.deviceProfileLib, line 600
logDebug "sendAttribute: found customSetFunction=${customSetFunction}, scaledValue=${scaledValue} (val=${val})" // library marker kkossev.deviceProfileLib, line 601
// execute the customSetFunction // library marker kkossev.deviceProfileLib, line 602
try { // library marker kkossev.deviceProfileLib, line 603
cmds = "$customSetFunction"(scaledValue) // library marker kkossev.deviceProfileLib, line 604
} // library marker kkossev.deviceProfileLib, line 605
catch (e) { // library marker kkossev.deviceProfileLib, line 606
logWarn "sendAttribute: Exception '${e}'caught while processing $customSetFunction($scaledValue) (val=${val}))" // library marker kkossev.deviceProfileLib, line 607
return false // library marker kkossev.deviceProfileLib, line 608
} // library marker kkossev.deviceProfileLib, line 609
logDebug "customSetFunction result is ${cmds}" // library marker kkossev.deviceProfileLib, line 610
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 611
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 612
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 613
return true // library marker kkossev.deviceProfileLib, line 614
} // library marker kkossev.deviceProfileLib, line 615
else { // library marker kkossev.deviceProfileLib, line 616
logWarn "sendAttribute: customSetFunction $customSetFunction($scaledValue) returned null or empty list, continue with the default processing" // library marker kkossev.deviceProfileLib, line 617
// continue with the default processing // library marker kkossev.deviceProfileLib, line 618
} // library marker kkossev.deviceProfileLib, line 619
} // library marker kkossev.deviceProfileLib, line 620
else { // library marker kkossev.deviceProfileLib, line 621
logDebug "sendAttribute: SKIPPED customSetFunction ${customSetFunction}, continue with the default processing" // library marker kkossev.deviceProfileLib, line 622
} // library marker kkossev.deviceProfileLib, line 623
// check whether this is a tuya DP or a cluster:attribute parameter or a virtual device // library marker kkossev.deviceProfileLib, line 624
if (isVirtual()) { // library marker kkossev.deviceProfileLib, line 625
// send a virtual attribute // library marker kkossev.deviceProfileLib, line 626
logDebug "sendAttribute: found virtual attribute ${par} value ${val}" // library marker kkossev.deviceProfileLib, line 627
// patch !! // library marker kkossev.deviceProfileLib, line 628
if (par == 'heatingSetpoint') { // library marker kkossev.deviceProfileLib, line 629
sendHeatingSetpointEvent(val) // library marker kkossev.deviceProfileLib, line 630
} // library marker kkossev.deviceProfileLib, line 631
else { // library marker kkossev.deviceProfileLib, line 632
String descriptionText = "${par} is ${val} [virtual]" // library marker kkossev.deviceProfileLib, line 633
sendEvent(name:par, value:val, isDigital: true) // library marker kkossev.deviceProfileLib, line 634
logInfo descriptionText // library marker kkossev.deviceProfileLib, line 635
} // library marker kkossev.deviceProfileLib, line 636
return true // library marker kkossev.deviceProfileLib, line 637
} // library marker kkossev.deviceProfileLib, line 638
else { // library marker kkossev.deviceProfileLib, line 639
logDebug "sendAttribute: not a virtual device (device.controllerType = ${device.controllerType}), continue " // library marker kkossev.deviceProfileLib, line 640
} // library marker kkossev.deviceProfileLib, line 641
boolean isTuyaDP // library marker kkossev.deviceProfileLib, line 642
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 643
def preference = dpMap.dp // TODO - remove it? // library marker kkossev.deviceProfileLib, line 644
try { // library marker kkossev.deviceProfileLib, line 645
isTuyaDP = dpMap.dp instanceof Number // check if dpMap.dp is a number // library marker kkossev.deviceProfileLib, line 646
} // library marker kkossev.deviceProfileLib, line 647
catch (e) { // library marker kkossev.deviceProfileLib, line 648
if (debug) { log.warn "sendAttribute: exception ${e} caught while checking isNumber() preference ${preference}" } // library marker kkossev.deviceProfileLib, line 649
return false // library marker kkossev.deviceProfileLib, line 650
} // library marker kkossev.deviceProfileLib, line 651
if (dpMap.dp != null && isTuyaDP) { // library marker kkossev.deviceProfileLib, line 652
// Tuya DP // library marker kkossev.deviceProfileLib, line 653
cmds = sendTuyaParameter(dpMap, par, scaledValue) // library marker kkossev.deviceProfileLib, line 654
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 655
logWarn "sendAttribute: sendTuyaParameter par ${par} scaledValue ${scaledValue} returned null or empty list" // library marker kkossev.deviceProfileLib, line 656
return false // library marker kkossev.deviceProfileLib, line 657
} // library marker kkossev.deviceProfileLib, line 658
else { // library marker kkossev.deviceProfileLib, line 659
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($val (scaledValue=${scaledValue}))" // library marker kkossev.deviceProfileLib, line 660
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 661
return true // library marker kkossev.deviceProfileLib, line 662
} // library marker kkossev.deviceProfileLib, line 663
} // library marker kkossev.deviceProfileLib, line 664
/* groovylint-disable-next-line EmptyIfStatement */ // library marker kkossev.deviceProfileLib, line 665
else if (dpMap.at != null && dpMap.at == 'virtual') { // library marker kkossev.deviceProfileLib, line 666
// send a virtual attribute // library marker kkossev.deviceProfileLib, line 667
} // library marker kkossev.deviceProfileLib, line 668
else if (dpMap.at != null) { // library marker kkossev.deviceProfileLib, line 669
// cluster:attribute // library marker kkossev.deviceProfileLib, line 670
cmds = zclWriteAttribute(dpMap, scaledValue) // library marker kkossev.deviceProfileLib, line 671
if (cmds == null || cmds == []) { // library marker kkossev.deviceProfileLib, line 672
logWarn "sendAttribute: failed to write cluster:attribute ${dpMap.at} value ${scaledValue}" // library marker kkossev.deviceProfileLib, line 673
return false // library marker kkossev.deviceProfileLib, line 674
} // library marker kkossev.deviceProfileLib, line 675
} // library marker kkossev.deviceProfileLib, line 676
else { // library marker kkossev.deviceProfileLib, line 677
logWarn "sendAttribute: invalid dp or at value ${dpMap.dp} for parameter ${par}" // library marker kkossev.deviceProfileLib, line 678
return false // library marker kkossev.deviceProfileLib, line 679
} // library marker kkossev.deviceProfileLib, line 680
logDebug "sendAttribute: successfluly executed sendAttribute $customSetFunction($scaledValue)" // library marker kkossev.deviceProfileLib, line 681
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 682
return true // library marker kkossev.deviceProfileLib, line 683
} // library marker kkossev.deviceProfileLib, line 684
/** // library marker kkossev.deviceProfileLib, line 686
* SENDS a list of Zigbee commands to be sent to the device. // library marker kkossev.deviceProfileLib, line 687
* @param command - The command to send. Must be one of the commands defined in the DEVICE.commands map. // library marker kkossev.deviceProfileLib, line 688
* @param val - The value to send with the command, can be null. // library marker kkossev.deviceProfileLib, line 689
* @return true on success, false otherwise. // library marker kkossev.deviceProfileLib, line 690
*/ // library marker kkossev.deviceProfileLib, line 691
public boolean sendCommand(final String command_orig=null, final String val_orig=null) { // library marker kkossev.deviceProfileLib, line 692
//logDebug "sending command ${command}(${val}))" // library marker kkossev.deviceProfileLib, line 693
final String command = command_orig?.trim() // library marker kkossev.deviceProfileLib, line 694
final String val = val_orig?.trim() // library marker kkossev.deviceProfileLib, line 695
List cmds = [] // library marker kkossev.deviceProfileLib, line 696
Map supportedCommandsMap = DEVICE?.commands as Map // library marker kkossev.deviceProfileLib, line 697
if (supportedCommandsMap == null || supportedCommandsMap?.isEmpty()) { // library marker kkossev.deviceProfileLib, line 698
logInfo "sendCommand: no commands defined for device profile ${getDeviceProfile()} !" // library marker kkossev.deviceProfileLib, line 699
return false // library marker kkossev.deviceProfileLib, line 700
} // library marker kkossev.deviceProfileLib, line 701
// TODO: compare ignoring the upper/lower case of the command. // library marker kkossev.deviceProfileLib, line 702
List supportedCommandsList = DEVICE?.commands?.keySet() as List // library marker kkossev.deviceProfileLib, line 703
// check if the command is defined in the DEVICE commands map // library marker kkossev.deviceProfileLib, line 704
if (command == null || !(command in supportedCommandsList)) { // library marker kkossev.deviceProfileLib, line 705
logInfo "sendCommand: the command ${(command ?: '')} for device profile '${DEVICE?.description}' must be one of these : ${supportedCommandsList}" // library marker kkossev.deviceProfileLib, line 706
return false // library marker kkossev.deviceProfileLib, line 707
} // library marker kkossev.deviceProfileLib, line 708
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 709
def func, funcResult // library marker kkossev.deviceProfileLib, line 710
try { // library marker kkossev.deviceProfileLib, line 711
func = DEVICE?.commands.find { it.key == command }.value // library marker kkossev.deviceProfileLib, line 712
if (val != null && val != '') { // library marker kkossev.deviceProfileLib, line 713
logInfo "executed $func($val)" // library marker kkossev.deviceProfileLib, line 714
funcResult = "${func}"(val) // library marker kkossev.deviceProfileLib, line 715
} // library marker kkossev.deviceProfileLib, line 716
else { // library marker kkossev.deviceProfileLib, line 717
logInfo "executed $func()" // library marker kkossev.deviceProfileLib, line 718
funcResult = "${func}"() // library marker kkossev.deviceProfileLib, line 719
} // library marker kkossev.deviceProfileLib, line 720
} // library marker kkossev.deviceProfileLib, line 721
catch (e) { // library marker kkossev.deviceProfileLib, line 722
logWarn "sendCommand: Exception '${e}' caught while processing $func(${val})" // library marker kkossev.deviceProfileLib, line 723
return false // library marker kkossev.deviceProfileLib, line 724
} // library marker kkossev.deviceProfileLib, line 725
// 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 726
// check if the result is a list of commands // library marker kkossev.deviceProfileLib, line 727
/* groovylint-disable-next-line Instanceof */ // library marker kkossev.deviceProfileLib, line 728
if (funcResult instanceof List) { // library marker kkossev.deviceProfileLib, line 729
cmds = funcResult // library marker kkossev.deviceProfileLib, line 730
if (cmds != null && cmds != []) { // library marker kkossev.deviceProfileLib, line 731
sendZigbeeCommands( cmds ) // library marker kkossev.deviceProfileLib, line 732
} // library marker kkossev.deviceProfileLib, line 733
} // library marker kkossev.deviceProfileLib, line 734
else if (funcResult == null) { // library marker kkossev.deviceProfileLib, line 735
return false // library marker kkossev.deviceProfileLib, line 736
} // library marker kkossev.deviceProfileLib, line 737
else { // library marker kkossev.deviceProfileLib, line 738
logDebug "sendCommand: $func(${val}) returned ${funcResult} instead of a list of commands!" // library marker kkossev.deviceProfileLib, line 739
return false // library marker kkossev.deviceProfileLib, line 740
} // library marker kkossev.deviceProfileLib, line 741
return true // library marker kkossev.deviceProfileLib, line 742
} // library marker kkossev.deviceProfileLib, line 743
/** // library marker kkossev.deviceProfileLib, line 745
* 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 746
* 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 747
* It then checks if the input parameter is a boolean value and skips it if it is. // library marker kkossev.deviceProfileLib, line 748
* The method also checks if the input parameter is a number and sets the isTuyaDP flag accordingly. // library marker kkossev.deviceProfileLib, line 749
* If the input parameter is read-only, the method returns null. // library marker kkossev.deviceProfileLib, line 750
* 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 751
* If the input parameter type is not supported, the method returns null. // library marker kkossev.deviceProfileLib, line 752
* @param param The input parameter to be checked. // library marker kkossev.deviceProfileLib, line 753
* @param debug A boolean flag indicating whether to log debug messages or not. // library marker kkossev.deviceProfileLib, line 754
* @return A map containing the input details. // library marker kkossev.deviceProfileLib, line 755
*/ // library marker kkossev.deviceProfileLib, line 756
Map inputIt(String paramPar, boolean debug = false) { // library marker kkossev.deviceProfileLib, line 757
String param = paramPar.trim() // library marker kkossev.deviceProfileLib, line 758
Map input = [:] // library marker kkossev.deviceProfileLib, line 759
Map foundMap = [:] // library marker kkossev.deviceProfileLib, line 760
if (!(param in DEVICE?.preferences)) { if (debug) { log.warn "inputIt: preference ${param} not defined for this device!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 761
/* groovylint-disable-next-line NoDef, VariableTypeRequired */ // library marker kkossev.deviceProfileLib, line 762
def preference // library marker kkossev.deviceProfileLib, line 763
try { preference = DEVICE?.preferences["$param"] } // library marker kkossev.deviceProfileLib, line 764
catch (e) { if (debug) { log.warn "inputIt: exception ${e} caught while parsing preference ${param} value ${preference}" } ; return [:] } // library marker kkossev.deviceProfileLib, line 765
// check for boolean values // library marker kkossev.deviceProfileLib, line 766
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 767
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 768
// TODO - check if this is neccessary? isTuyaDP is not defined! // library marker kkossev.deviceProfileLib, line 769
try { isTuyaDP = preference.isNumber() } // library marker kkossev.deviceProfileLib, line 770
catch (e) { if (debug) { log.warn "inputIt: exception ${e} caught while checking isNumber() preference ${param} value ${preference}" } ; return [:] } // library marker kkossev.deviceProfileLib, line 771
//if (debug) log.debug "inputIt: preference ${param} found. value is ${preference} isTuyaDP=${isTuyaDP}" // library marker kkossev.deviceProfileLib, line 772
foundMap = getPreferencesMapByName(param) // library marker kkossev.deviceProfileLib, line 773
//if (debug) log.debug "foundMap = ${foundMap}" // library marker kkossev.deviceProfileLib, line 774
if (foundMap == null || foundMap?.isEmpty()) { if (debug) { log.warn "inputIt: map not found for param '${param}'!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 775
if (foundMap.rw != 'rw') { if (debug) { log.warn "inputIt: param '${param}' is read only!" } ; return [:] } // library marker kkossev.deviceProfileLib, line 776
if (foundMap.advanced != null && foundMap.advanced == true && settings.advancedOptions != true) { // library marker kkossev.deviceProfileLib, line 777
if (debug) { log.debug "inputIt: param '${param}' is advanced!" } // library marker kkossev.deviceProfileLib, line 778
return [:] // library marker kkossev.deviceProfileLib, line 779
} // library marker kkossev.deviceProfileLib, line 780
input.name = foundMap.name // library marker kkossev.deviceProfileLib, line 781
input.type = foundMap.type // bool, enum, number, decimal // library marker kkossev.deviceProfileLib, line 782
input.title = foundMap.title // library marker kkossev.deviceProfileLib, line 783
input.description = foundMap.description // library marker kkossev.deviceProfileLib, line 784
if (input.type in ['number', 'decimal']) { // library marker kkossev.deviceProfileLib, line 785
if (foundMap.min != null && foundMap.max != null) { // library marker kkossev.deviceProfileLib, line 786
input.range = "${foundMap.min}..${foundMap.max}" // library marker kkossev.deviceProfileLib, line 787
} // library marker kkossev.deviceProfileLib, line 788
if (input.range != null && input.description != null) { // library marker kkossev.deviceProfileLib, line 789
input.description += "
Range: ${input.range}" // library marker kkossev.deviceProfileLib, line 790
if (foundMap.unit != null && foundMap.unit != '') { // library marker kkossev.deviceProfileLib, line 791
input.description += " (${foundMap.unit})" // library marker kkossev.deviceProfileLib, line 792
} // library marker kkossev.deviceProfileLib, line 793
} // library marker kkossev.deviceProfileLib, line 794
} // library marker kkossev.deviceProfileLib, line 795
/* groovylint-disable-next-line SpaceAfterClosingBrace */ // library marker kkossev.deviceProfileLib, line 796
else if (input.type == 'enum') { // library marker kkossev.deviceProfileLib, line 797
input.options = foundMap.map // library marker kkossev.deviceProfileLib, line 798
}/* // library marker kkossev.deviceProfileLib, line 799
else if (input.type == "bool") { // library marker kkossev.deviceProfileLib, line 800
input.options = ["true", "false"] // library marker kkossev.deviceProfileLib, line 801
}*/ // library marker kkossev.deviceProfileLib, line 802
else { // library marker kkossev.deviceProfileLib, line 803
if (debug) { log.warn "inputIt: unsupported type ${input.type} for param '${param}'!" } // library marker kkossev.deviceProfileLib, line 804
return [:] // library marker kkossev.deviceProfileLib, line 805
} // library marker kkossev.deviceProfileLib, line 806
if (input.defVal != null) { // library marker kkossev.deviceProfileLib, line 807
input.defVal = foundMap.defVal // library marker kkossev.deviceProfileLib, line 808
} // library marker kkossev.deviceProfileLib, line 809
return input // library marker kkossev.deviceProfileLib, line 810
} // library marker kkossev.deviceProfileLib, line 811
/** // library marker kkossev.deviceProfileLib, line 813
* Returns the device name and profile based on the device model and manufacturer. // library marker kkossev.deviceProfileLib, line 814
* @param model The device model (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 815
* @param manufacturer The device manufacturer (optional). If not provided, it will be retrieved from the device data value. // library marker kkossev.deviceProfileLib, line 816
* @return A list containing the device name and profile. // library marker kkossev.deviceProfileLib, line 817
*/ // library marker kkossev.deviceProfileLib, line 818
List getDeviceNameAndProfile(String model=null, String manufacturer=null) { // library marker kkossev.deviceProfileLib, line 819
String deviceName = UNKNOWN, deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 820
String deviceModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 821
String deviceManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 822
deviceProfilesV3.each { profileName, profileMap -> // library marker kkossev.deviceProfileLib, line 823
profileMap.fingerprints.each { fingerprint -> // library marker kkossev.deviceProfileLib, line 824
if (fingerprint.model == deviceModel && fingerprint.manufacturer == deviceManufacturer) { // library marker kkossev.deviceProfileLib, line 825
deviceProfile = profileName // library marker kkossev.deviceProfileLib, line 826
deviceName = fingerprint.deviceJoinName ?: deviceProfilesV3[deviceProfile].deviceJoinName ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 827
logDebug "found exact match for model ${deviceModel} manufacturer ${deviceManufacturer} : profileName=${deviceProfile} deviceName =${deviceName}" // library marker kkossev.deviceProfileLib, line 828
return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 829
} // library marker kkossev.deviceProfileLib, line 830
} // library marker kkossev.deviceProfileLib, line 831
} // library marker kkossev.deviceProfileLib, line 832
if (deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 833
logWarn "getDeviceNameAndProfile: NOT FOUND! deviceName =${deviceName} profileName=${deviceProfile} for model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 834
} // library marker kkossev.deviceProfileLib, line 835
return [deviceName, deviceProfile] // library marker kkossev.deviceProfileLib, line 836
} // library marker kkossev.deviceProfileLib, line 837
// called from initializeVars( fullInit = true) // library marker kkossev.deviceProfileLib, line 839
void setDeviceNameAndProfile(String model=null, String manufacturer=null) { // library marker kkossev.deviceProfileLib, line 840
def (String deviceName, String deviceProfile) = getDeviceNameAndProfile(model, manufacturer) // library marker kkossev.deviceProfileLib, line 841
if (deviceProfile == null || deviceProfile == UNKNOWN) { // library marker kkossev.deviceProfileLib, line 842
logInfo "unknown model ${deviceModel} manufacturer ${deviceManufacturer}" // library marker kkossev.deviceProfileLib, line 843
// don't change the device name when unknown // library marker kkossev.deviceProfileLib, line 844
state.deviceProfile = UNKNOWN // library marker kkossev.deviceProfileLib, line 845
} // library marker kkossev.deviceProfileLib, line 846
String dataValueModel = model != null ? model : device.getDataValue('model') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 847
String dataValueManufacturer = manufacturer != null ? manufacturer : device.getDataValue('manufacturer') ?: UNKNOWN // library marker kkossev.deviceProfileLib, line 848
if (deviceName != NULL && deviceName != UNKNOWN) { // library marker kkossev.deviceProfileLib, line 849
device.setName(deviceName) // library marker kkossev.deviceProfileLib, line 850
state.deviceProfile = deviceProfile // library marker kkossev.deviceProfileLib, line 851
device.updateSetting('forcedProfile', [value:deviceProfilesV3[deviceProfile]?.description, type:'enum']) // library marker kkossev.deviceProfileLib, line 852
logInfo "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was set to : deviceProfile=${deviceProfile} : deviceName=${deviceName}" // library marker kkossev.deviceProfileLib, line 853
} else { // library marker kkossev.deviceProfileLib, line 854
logInfo "device model ${dataValueModel} manufacturer ${dataValueManufacturer} was not found!" // library marker kkossev.deviceProfileLib, line 855
} // library marker kkossev.deviceProfileLib, line 856
} // library marker kkossev.deviceProfileLib, line 857
// called from customRefresh() in the device drivers // library marker kkossev.deviceProfileLib, line 859
List refreshFromDeviceProfileList() { // library marker kkossev.deviceProfileLib, line 860
logDebug 'refreshFromDeviceProfileList()' // library marker kkossev.deviceProfileLib, line 861
List cmds = [] // library marker kkossev.deviceProfileLib, line 862
if (DEVICE?.refresh != null) { // library marker kkossev.deviceProfileLib, line 863
List refreshList = DEVICE.refresh // library marker kkossev.deviceProfileLib, line 864
for (String k : refreshList) { // library marker kkossev.deviceProfileLib, line 865
k = k.replaceAll('\\[|\\]', '') // library marker kkossev.deviceProfileLib, line 866
if (k != null) { // library marker kkossev.deviceProfileLib, line 867
// check whether the string in the refreshList matches an attribute name in the DEVICE.attributes list // library marker kkossev.deviceProfileLib, line 868
Map map = DEVICE.attributes.find { it.name == k } // library marker kkossev.deviceProfileLib, line 869
if (map != null) { // library marker kkossev.deviceProfileLib, line 870
Map mfgCode = map.mfgCode != null ? ['mfgCode':map.mfgCode] : [:] // library marker kkossev.deviceProfileLib, line 871
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 872
} // library marker kkossev.deviceProfileLib, line 873
// check whether the string in the refreshList matches a method defined somewhere in the code // library marker kkossev.deviceProfileLib, line 874
if (this.respondsTo(k)) { // library marker kkossev.deviceProfileLib, line 875
cmds += this."${k}"() // library marker kkossev.deviceProfileLib, line 876
} // library marker kkossev.deviceProfileLib, line 877
} // library marker kkossev.deviceProfileLib, line 878
} // library marker kkossev.deviceProfileLib, line 879
} // library marker kkossev.deviceProfileLib, line 880
return cmds // library marker kkossev.deviceProfileLib, line 881
} // library marker kkossev.deviceProfileLib, line 882
// TODO! - remove? // library marker kkossev.deviceProfileLib, line 884
List refreshDeviceProfile() { // library marker kkossev.deviceProfileLib, line 885
List cmds = [] // library marker kkossev.deviceProfileLib, line 886
if (cmds == []) { cmds = ['delay 299'] } // library marker kkossev.deviceProfileLib, line 887
logDebug "refreshDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 888
return cmds // library marker kkossev.deviceProfileLib, line 889
} // library marker kkossev.deviceProfileLib, line 890
// TODO ! // library marker kkossev.deviceProfileLib, line 892
List configureDeviceProfile() { // library marker kkossev.deviceProfileLib, line 893
List cmds = [] // library marker kkossev.deviceProfileLib, line 894
logDebug "configureDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 895
if (cmds == []) { cmds = ['delay 299'] } // library marker kkossev.deviceProfileLib, line 896
return cmds // library marker kkossev.deviceProfileLib, line 897
} // library marker kkossev.deviceProfileLib, line 898
// TODO // library marker kkossev.deviceProfileLib, line 900
List initializeDeviceProfile() { // library marker kkossev.deviceProfileLib, line 901
List cmds = [] // library marker kkossev.deviceProfileLib, line 902
logDebug "initializeDeviceProfile() : ${cmds}" // library marker kkossev.deviceProfileLib, line 903
if (cmds == []) { cmds = ['delay 299',] } // library marker kkossev.deviceProfileLib, line 904
return cmds // library marker kkossev.deviceProfileLib, line 905
} // library marker kkossev.deviceProfileLib, line 906
public void deviceProfileInitializeVars(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 908
logDebug "deviceProfileInitializeVars(${fullInit})" // library marker kkossev.deviceProfileLib, line 909
if (state.deviceProfile == null) { // library marker kkossev.deviceProfileLib, line 910
setDeviceNameAndProfile() // library marker kkossev.deviceProfileLib, line 911
} // library marker kkossev.deviceProfileLib, line 912
} // library marker kkossev.deviceProfileLib, line 913
void initEventsDeviceProfile(boolean fullInit=false) { // library marker kkossev.deviceProfileLib, line 915
String ps = DEVICE?.device?.powerSource // library marker kkossev.deviceProfileLib, line 916
logDebug "initEventsDeviceProfile(${fullInit}) for deviceProfile=${state.deviceProfile} DEVICE?.device?.powerSource=${ps} ps.isEmpty()=${ps.isEmpty()}" // library marker kkossev.deviceProfileLib, line 917
if (ps != null && ps.isEmpty() == false) { // library marker kkossev.deviceProfileLib, line 918
sendEvent(name: 'powerSource', value: ps, descriptionText: "Power Source set to '${ps}'", type: 'digital') // library marker kkossev.deviceProfileLib, line 919
} // library marker kkossev.deviceProfileLib, line 920
} // library marker kkossev.deviceProfileLib, line 921
///////////////////////////// Tuya DPs ///////////////////////////////// // library marker kkossev.deviceProfileLib, line 923
// // library marker kkossev.deviceProfileLib, line 925
// called from parse() // library marker kkossev.deviceProfileLib, line 926
// returns: true - do not process this message if the spammy DP is defined in the spammyDPsToIgnore element of the active Device Profule // library marker kkossev.deviceProfileLib, line 927
// false - the processing can continue // library marker kkossev.deviceProfileLib, line 928
// // library marker kkossev.deviceProfileLib, line 929
public boolean isSpammyDPsToIgnore(Map descMap) { // library marker kkossev.deviceProfileLib, line 930
//log.trace "isSpammyDPsToIgnore: ${state.deviceProfile == 'TS0225_LINPTECH_RADAR'} ${descMap.cluster == 'E002'} ${descMap.attrId == 'E00A'} ${settings?.ignoreDistance == true}" // library marker kkossev.deviceProfileLib, line 931
if (state.deviceProfile == 'TS0225_LINPTECH_RADAR' && descMap.cluster == 'E002' && descMap.attrId == 'E00A' && settings?.ignoreDistance == true) { return true } // library marker kkossev.deviceProfileLib, line 932
if (!(descMap?.clusterId == 'EF00' && (descMap?.command in ['01', '02']))) { return false } // library marker kkossev.deviceProfileLib, line 933
if (descMap?.data?.size <= 2) { return false } // library marker kkossev.deviceProfileLib, line 934
int dp = zigbee.convertHexToInt(descMap.data[2]) // library marker kkossev.deviceProfileLib, line 935
List spammyList = deviceProfilesV3[getDeviceProfile()]?.spammyDPsToIgnore as List // library marker kkossev.deviceProfileLib, line 936
return (spammyList != null && (dp in spammyList) && ((settings?.ignoreDistance ?: false) == true)) // library marker kkossev.deviceProfileLib, line 937
} // library marker kkossev.deviceProfileLib, line 938
// // library marker kkossev.deviceProfileLib, line 940
// called from processTuyaDP(), processTuyaDPfromDeviceProfile(), isChattyDeviceReport() // library marker kkossev.deviceProfileLib, line 941
// returns: true - do not generate Debug log messages if the chatty DP is defined in the spammyDPsToNotTrace element of the active Device Profule // library marker kkossev.deviceProfileLib, line 942
// false - debug logs can be generated // library marker kkossev.deviceProfileLib, line 943
// // library marker kkossev.deviceProfileLib, line 944
public boolean isSpammyDPsToNotTrace(Map descMap) { // library marker kkossev.deviceProfileLib, line 945
//log.trace "isSpammyDPsToNotTrace: ${state.deviceProfile == 'TS0225_LINPTECH_RADAR'} ${descMap.cluster == 'E002'} ${descMap.attrId == 'E00A'} ${settings?.ignoreDistance == true}" // library marker kkossev.deviceProfileLib, line 946
if (state.deviceProfile == 'TS0225_LINPTECH_RADAR' && descMap.cluster == 'E002' && descMap.attrId == 'E00A' && settings?.ignoreDistance == true) { return true } // library marker kkossev.deviceProfileLib, line 947
if (!(descMap?.clusterId == 'EF00' && (descMap?.command in ['01', '02']))) { return false } // library marker kkossev.deviceProfileLib, line 948
if (descMap?.data?.size <= 2) { return false } // library marker kkossev.deviceProfileLib, line 949
int dp = zigbee.convertHexToInt(descMap.data[2]) // library marker kkossev.deviceProfileLib, line 950
List spammyList = deviceProfilesV3[getDeviceProfile()]?.spammyDPsToNotTrace as List // library marker kkossev.deviceProfileLib, line 951
return (spammyList != null && (dp in spammyList)) // library marker kkossev.deviceProfileLib, line 952
} // library marker kkossev.deviceProfileLib, line 953
// all DPs are spammy - sent periodically! // library marker kkossev.deviceProfileLib, line 955
public boolean isSpammyDeviceProfile() { // library marker kkossev.deviceProfileLib, line 956
if (deviceProfilesV3 == null || deviceProfilesV3[getDeviceProfile()] == null) { return false } // library marker kkossev.deviceProfileLib, line 957
Boolean isSpammy = deviceProfilesV3[getDeviceProfile()]?.device?.isSpammy ?: false // library marker kkossev.deviceProfileLib, line 958
return isSpammy // library marker kkossev.deviceProfileLib, line 959
} // library marker kkossev.deviceProfileLib, line 960
/* groovylint-disable-next-line UnusedMethodParameter */ // library marker kkossev.deviceProfileLib, line 962
List