HADBgenericComponentVacuum.groovy

/*

Copyright 2024

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.

-------------------------------------------

Change history:

2.10 - Yves Mercier - initial version

*/

metadata
    {
    definition(name: "HADB Generic Component Vacuum", namespace: "community", author: "community", importUrl: "https://raw.githubusercontent.com/ymerj/HE-HA-control/main/HADBgenericComponentVacuum.groovy")
        {
        capability "Actuator"
        capability "Refresh"
        capability "Health Check"

        command "cleanSpot"
        command "locate"
        command "pause"
        command "returnToBase"
        command "setFanSpeed", [[ name: "speed", type: "STRING", description: "Define new speed" ]]
        command "start"
        command "stop"
        }
    preferences
        {
        input name: "txtEnable", type: "bool", title: "Enable descriptionText logging", defaultValue: true
        }
    attribute "vacuum", "string"
    attribute "speed", "string"
    attribute "fanSpeedList", "enum"
    attribute "healthStatus", "enum", ["offline", "online"]
    }

void updated()
    {
    log.info "Updated..."
    log.warn "description logging is: ${txtEnable == true}"
    }

void installed()
    {
    log.info "Installed..."
    device.updateSetting("txtEnable",[type:"bool",value:true])
    refresh()
    }

void parse(String description) { log.warn "parse(String description) not implemented" }

void parse(List<Map> description)
    {
    description.each
        {
        if (it.name in ["vacuum", "speed", "fanSpeedList", "healthStatus"])
            {
            if (txtEnable) log.info it.descriptionText
            sendEvent(it)
            }
        }
    }

void cleanSpot()
    {
    // parent?.componentCleanSpot(this.device, newValue)
    }

void locate()
    {
    parent?.componentLocate(this.device)
    }

void pause()
    {
    parent?.componentPause(this.device)
    }

void returnToBase()
    {
    parent?.componentReturnToBase(this.device)
    }

void setFanSpeed()
    {
    parent?.componentSetFanSpeed(this.device, speed)
    }

void start()
    {
    parent?.componentStart(this.device)
    }

void stop()
    {
    parent?.componentStop(this.device)
    }

void refresh()
    {
    parent?.componentRefresh(this.device)
    }

void ping()
    {
    refresh()
    }