/*
* UnifiNetworkChild-RPS
*
* Description:
* This Hubitat driver provides a spot to put data from Unifi RPS device(s)
*
* Instructions for using Tile method:
* 1) In "Preferences -> Tile Template" enter your template (example below) and click "Save Preferences"
*   Ex: "[b]Temperature:[/b] @temperature@°@location.getTemperatureScale()@[/br]"
* 2) In a Hubitat dashboard, add a new tile, and select the child/sensor, in the center select "Attribute", and on the right select the "Tile" attribute
* 3) Select the Add Tile button and the tile should appear
* NOTE1: Put a @ before and after variable names
* NOTE2: Should accept most HTML formatting commands with [] instead of <>
* 
* Features List:
* Ability to check a website (mine) to notify user if there is a newer version of the driver available
* Ability to start/stop device location signaling
* Ability to restart device
* Ability to set state of the RPS ports
* Holds a variety of data as attributes for use by other areas of Hubitat hub
* 
* Licensing:
* Copyright 2025 David Snell
* 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.
*
* Version Control:
* 0.1.9 - Updated state, event, & tile handling
* 0.1.8 - Removed "Driver Status", added RestartDevice command, and added LCM Preferences
* 0.1.7 - Correction to ProcessEvent function and removal of old driver-specific attributes when Preferences are saved
* 0.1.6 - Added Uptime as an attribute and updates to various functions
* 0.1.5 - Correction to Tile Template preference, change to new port status method
* 0.1.4 - Added refresh capability to get device specific information and revised HTML to Tile Template
* 0.1.3 - Updates to attributes and default settings
* 0.1.2 - Change to port command
* 0.1.1 - Update to data processing list
* 0.1.0 - Initial version
* 
* Thank you(s):
* @Cobra for inspiration of how I perform driver version checking
* @mircolino for original concept of HTML Template method
*/

// Returns the driver name
def DriverName(){
    return "UnifiNetworkChild-RPS"
}

// Returns the driver version
def DriverVersion(){
    return "0.1.9"
}

// Driver Metadata
metadata{
	definition( name: "UnifiNetworkChild-RPS", namespace: "Snell", author: "David Snell", importUrl: "https://www.drdsnell.com/projects/hubitat/drivers/UnifiNetworkChild-RPS.groovy" ) {
        capability "PresenceSensor" // Adds an attribute "presence" with possible values of "present" or "not present"
        capability "TemperatureMeasurement"
        capability "Actuator"
        capability "Refresh"
        
        // Commands
        command "StartLocateDevice"
        command "StopLocateDevice"
        command "SetRPSPortState", [
            [ name: "PortNumber*", type: "INTEGER", constraints: [ 1, 2, 3, 4, 5, 6 ], description: "Enter Port # (ex: 1, 2 ... 6)" ],
            [ name: "PortState*", type: "ENUM", defaultValue: "auto", constraints: [ "auto", "disabled" ], description: "State to set the port to" ]
        ]
        command "RestartDevice"
        
        // Attributes - Driver Related
        attribute "DriverName", "string" // Identifies the driver being used for update purposes
        attribute "DriverVersion", "string" // Handles version for driver
        attribute "DriverStatus", "string" // Handles version notices for driver
        // Attributes - Device Related
        attribute "LastSeen", "string" // Date/Time the device was last seen by the Unifi controller
        attribute "Memory Usage", "number"
        attribute "CPU Usage", "number"
        attribute "Overheating", "string"
        attribute "Satisfaction", "number"
        attribute "12v Power Delivering", "number"
        attribute "54v Power Delivering", "number"
        attribute "12v Power Usage", "number"
        attribute "54v Power Usage", "number"
        attribute "Model LTS", "string"
        attribute "Model EOL", "string"
        attribute "RPS Port 01 Status", "map"
        attribute "RPS Port 02 Status", "map"
        attribute "RPS Port 03 Status", "map"
        attribute "RPS Port 04 Status", "map"
        attribute "RPS Port 05 Status", "map"
        attribute "RPS Port 06 Status", "map"
        attribute "Uptime", "string"
        
        // Tile attribute
        attribute "Tile", "string"; // Ex: "[b]Temperature:[/b] @temperature@°@location.getTemperatureScale()@[/br]"
        
    }
	preferences{
		//section{
            if( ShowAllPreferences ){
                if( state.DeviceName != null ){
                    input( type: "string", name: "DeviceName", title: "<b>Device Name</b>", description: "<font size='2'>If set it will change the device's name on the controller.</font>", defaultValue: "${ state.DeviceName }" )
                } else {
                    input( type: "string", name: "DeviceName", title: "<b>Device Name</b>", description: "<font size='2'>If set it will change the device's name on the controller.</font>", defaultValue: "" )
                }
                if( state.LCMBrightness != null ){
                    input( type: "number", name: "LCMBrightness", title: "<b>LCD Brightness</b>", description: "<font size='2'>Sets the brightness of the LCD display.</font>", defaultValue: state.LCMBrightness, minValue: 10, maxValue: 100, required: false )
                } else {
                    input( type: "number", name: "LCMBrightness", title: "<b>LCD Brightness</b>", description: "<font size='2'>Sets the brightness of the LCD display.</font>", defaultValue: 75, minValue: 10, maxValue: 100, required: false )
                }
                if( state.LCMNightStart != null ){
                    input( type: "string", name: "LCMNightStart", title: "<b>LCD Night Mode Start</b>", description: "<font size='2'>When the LCD should start night mode. Formatted as 22:00 = 10pm</font>", defaultValue: "${ state.LCMNightStart }", required: false )
                } else {
                    input( type: "string", name: "LCMNightStart", title: "<b>LCD Night Mode Start</b>", description: "<font size='2'>When the LCD should start night mode. Formatted as 22:00 = 10pm</font>", defaultValue: "22:00", required: false )
                }
                if( state.LCMNightEnd != null ){
                    input( type: "string", name: "LCMNightEnd", title: "<b>LCD Night Mode End</b>", description: "<font size='2'>When the LCD should end night mode. Formatted as 08:00 = 8am</font>", defaultValue: "${ state.LCMNightEnd }", required: false )
                } else {
                    input( type: "string", name: "LCMNightEnd", title: "<b>LCD Night Mode End</b>", description: "<font size='2'>When the LCD should end night mode. Formatted as 08:00 = 8am</font>", defaultValue: "08:00", required: false )
                }
                input( name: "TileTemplate", type: "string", title: "<b>Tile Template</b>", description: "<font size='2'>Ex: [b]Temperature:[/b] @temperature@&deg;@location.getTemperatureScale()@[/br]</font>", defaultValue: "");
    			input( type: "enum", name: "LogType", title: "<b>Enable Logging?</b>", required: false, multiple: false, options: [ "None", "Info", "Debug", "Trace" ], defaultValue: "Info" )
                input( type: "bool", name: "ShowAllPreferences", title: "<b>Show All Preferences?</b>", defaultValue: true )
            } else {
                input( type: "bool", name: "ShowAllPreferences", title: "<b>Show All Preferences?</b>", defaultValue: true )
            }
        //}
	}
}

// SetDefaults sets "unknown" as initial value for some attributes of the device
def SetDefaults(){
    for( int x = 1; x <= 6; x++ ){
        ProcessState( "RPS Port 0${ x } Status", [ PortID: x, Mode: "unknown" ] )
    }
    ProcessEvent( "LastSeen", "Unknown" )
    ProcessEvent( "Overheating", "Unknown" )
    ProcessEvent( "Model LTS", "Unknown" )
    ProcessEvent( "Model EOL", "Unknown" )
    ProcessEvent( "LED Override", "Unknown" )
    ProcessEvent( "LED OnOff", "Unknown" )
}

// updated
def updated( boolean NewDevice = false ){
    if( state."Driver Status" != null ){
        state.remove( "Driver Name" )
        state.remove( "Driver Version" )
        state.remove( "Driver Status" )
        device.deleteCurrentState( "Driver Status" )
        device.deleteCurrentState( "Driver Name" )
        device.deleteCurrentState( "Driver Version" )
    }
    ProcessEvent( "DriverName", "${ DriverName() }" )
    ProcessEvent( "DriverVersion", "${ DriverVersion() }" )
    ProcessEvent( "DriverStatus", null )
    
    if( LogType == null ){
        LogType = "Info"
    }
    
    if( NewDevice != true ){
        if( ( DeviceName != state.DeviceName ) || ( LCMBrightness != state.LCMBrightness ) || ( LCMBrightnessOverride != state.LCMBrightnessOverride ) || ( LCMNightStart != state.LCMNightStart ) || ( LCMNightEnd != state.LCMNightEnd ) ){
            SendSettings()
        }
    }
    
    def Hour = ( new Date().format( "h" ) as int )
    def Minute = ( new Date().format( "m" ) as int )
    def Second = ( new Date().format( "s" ) as int )
    // Schedule checks that are only performed once a day
    schedule( "${ Second } ${ Minute } ${ Hour } ? * *", "CheckForUpdate" )
    
    Logging( "Updated", 2 )
}

// RestartDevice attempts to restart device
def RestartDevice(){
    if( state.MAC != null  ){
        parent.RestartDevice( state.MAC )
    } else {
        Logging( "No MAC known for ${ device.getDeviceNetworkId() }, cannot restart.", 5 )
    }
}

// Refresh the specific device's information
def refresh(){
    if( state.MAC != null  ){
        parent.RefreshSpecificUnifiDevice( state.MAC )
    } else {
        Logging( "No MAC for ${ device.getDeviceNetworkId() }, cannot refresh.", 5 )
    }
}

// Set the port for the RPS
def SetRPSPortState( int PortNumber, String PortState ){
    if( state.ID != null ){
        parent.SetRPSPortState( device.getDeviceNetworkId(), state.ID, PortNumber as int, PortState )
    } else {
        Logging( "No ID for ${ device.getDeviceNetworkId() }, cannot configure ports.", 5 )
    }
}

// Starts the device location method
def StartLocateDevice(){
    if( state.MAC != null ){
        parent.LocateDevice( state.MAC, "On" )
    } else {
        Logging( "No MAC for ${ device.getDeviceNetworkId() }, cannot locate/identify.", 5 )
    }
}

// Stops the device location method
def StopLocateDevice(){
    if( state.MAC != null ){
        parent.LocateDevice( state.MAC, "Off" )
    } else {
        Logging( "No MAC for ${ device.getDeviceNetworkId() }, cannot locate/identify.", 5 )
    }
}

// Configure device settings based on Preferences
def SendSettings(){
    if( state.ID != null ){
        def Settings = ""
        if( ( LCMBrightness != state.LCMBrightness ) || ( LCMNightStart != state.LCMNightStart ) || ( LCMNightEnd != state.LCMNightEnd ) ){
            if( LCMBrightness != null ){
                Settings = Settings + ",\"lcm_brightness\":${ LCMBrightness }"
            } else if( state.LCMBrightness != null ){
                Settings = Settings + ",\"lcm_brightness\":${ state.LCMBrightness }"
            }
            Settings = Settings + ",\"lcm_brightness_override\":true"
            if( LCMNightStart != null ){
                Settings = Settings + ",\"lcm_night_mode_begins\":\"${ LCMNightStart }\""
            } else if( state.LCMNightStart != null ){
                Settings = Settings + ",\"lcm_night_mode_begins\":\"${ state.LCMNightStart }\""
            }
            if( LCMNightEnd != null ){
                Settings = Settings + ",\"lcm_night_mode_ends\":\"${ LCMNightEnd }\""
            } else if( state.LCMNightEnd != null ){
                Settings = Settings + ",\"lcm_night_mode_ends\":\"${ state.LCMNightEnd }\""
            }
        }
        if( DeviceName != null && DeviceName != device.label ){
            if( DeviceName != "null" ){
                parent.SendChildSettings( device.getDeviceNetworkId(), state.ID, "{\"name\":\"${ DeviceName }\"${ Settings } }" )
            } else {
                parent.SendChildSettings( device.getDeviceNetworkId(), state.ID, "${ Settings } }" )
            }
        } else {
            parent.SendChildSettings( device.getDeviceNetworkId(), state.ID, "{\"name\":\"${ device.label }\"${ Settings } }" )
        }
    } else {
        Logging( "No ID for ${ device.getDeviceNetworkId() }, cannot send settings", 5 )
    }
}

// installed is called when the device is installed, all it really does is run updated
def installed(){
	Logging( "Installed", 2 )
    SetDefaults()
	updated( true )
}

// initialize is called when the device is initialized, all it really does is run updated
def initialize(){
	Logging( "Initialized", 2 )
	updated( true )
}

// Return a state value
def ReturnState( Variable ){
    return state."${ Variable }"
}

// Tile method to produce HTML formatted string for dashboard use
private void UpdateTile( String val ){
    if( TileTemplate != null ){
        def TempString = ""
        Parsing = TileTemplate
        Parsing = Parsing.replaceAll( "\\[", "<" )
        Parsing = Parsing.replaceAll( "\\]", ">" )
        Count = Parsing.count( "@" )
        if( Count >= 1 ){
            def x = 1
            while( x <= Count ){
                TempName = Parsing.split( "@" )[ x ]
                switch( TempName ){
                    case "location.latitude":
                        Value = location.latitude
                        break
                    case "location.longitude":
                        Value = location.longitude
                        break
                    case "location.getTemperatureScale()":
                        Value = location.getTemperatureScale()
                        break
                    default:
                        Value = ReturnState( "${ TempName }" )
                        break
                }
                TempString = TempString + Parsing.split( "@" )[ ( x - 1 ) ] + Value
                x = ( x + 2 )
            }
            if( Parsing.split( "@" ).last() != Parsing.split( "@" )[ Count - 1 ] ){
                TempString = TempString + Parsing.split( "@" ).last()
            }
        } else if( Count == 1 ){
            TempName = Parsing.split( "@" )[ 1 ]
            switch( TempName ){
                case "location.latitude":
                    Value = location.latitude
                    break
                case "location.longitude":
                    Value = location.longitude
                    break
                case "location.getTemperatureScale()":
                    Value = location.getTemperatureScale()
                    break
                default:
                    Value = ReturnState( "${ TempName }" )
                    break
            }
            TempString = TempString + Parsing.split( "@" )[ 0 ] + Value
        } else {
            TempString = TileTemplate    
        }
        Logging( "Tile = ${ TempString }", 4 )
        sendEvent( name: "Tile", value: TempString )
    }
}

// Process data to check against current state value and then send an event if it has changed
def ProcessEvent( Variable, Value, Unit = null, ForceEvent = false, Description = null ){
    if( ForceEvent ){
        sendEvent( name: Variable, value: Value, unit: Unit, isStateChange: true, descriptionText: Description )
    } else {
        sendEvent( name: Variable, value: Value, unit: Unit, descriptionText: Description )
    }
    Logging( "Event: ${ Variable } = ${ Value } Unit = ${ Unit } Forced = ${ ForceEvent }", 4 )
    ProcessState( Variable, Value )
    UpdateTile( "${ Value }" )
}

// Set a state variable to a value
def ProcessState( Variable, Value ){
    Logging( "State: ${ Variable } = ${ Value }", 4 )
    state."${ Variable }" = Value
    UpdateTile( "${ Value }" )
}

// Handles whether logging is enabled and thus what to put there.
def Logging( LogMessage, LogLevel ){
	// Add all messages as info logging
    if( ( LogLevel == 2 ) && ( LogType != "None" ) ){
        log.info( "${ device.displayName } - ${ LogMessage }" )
    } else if( ( LogLevel == 3 ) && ( ( LogType == "Debug" ) || ( LogType == "Trace" ) ) ){
        log.debug( "${ device.displayName } - ${ LogMessage }" )
    } else if( ( LogLevel == 4 ) && ( LogType == "Trace" ) ){
        log.trace( "${ device.displayName } - ${ LogMessage }" )
    } else if( LogLevel == 5 ){
        log.error( "${ device.displayName } - ${ LogMessage }" )
    }
}

// Checks drdsnell.com for the latest version of the driver
// Original inspiration from @cobra's version checking
def CheckForUpdate(){
    ProcessEvent( "DriverName", DriverName() )
    ProcessEvent( "DriverVersion", DriverVersion() )
	httpGet( uri: "https://www.drdsnell.com/projects/hubitat/drivers/versions.json", contentType: "application/json" ){ resp ->
        switch( resp.status ){
            case 200:
                if( resp.data."${ DriverName() }" ){
                    CurrentVersion = DriverVersion().split( /\./ )
                    if( resp.data."${ DriverName() }".version == "REPLACED" ){
                       ProcessEvent( "DriverStatus", "Driver replaced, please use ${ resp.data."${ state.DriverName }".file }" )
                    } else if( resp.data."${ DriverName() }".version == "REMOVED" ){
                       ProcessEvent( "DriverStatus", "Driver removed and no longer supported." )
                    } else {
                        SiteVersion = resp.data."${ DriverName() }".version.split( /\./ )
                        if( CurrentVersion == SiteVersion ){
                            Logging( "Driver version up to date", 3 )
				            ProcessEvent( "DriverStatus", "Up to date" )
                        } else if( ( CurrentVersion[ 0 ] as int ) > ( SiteVersion [ 0 ] as int ) ){
                            Logging( "Major development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version", 3 )
				            ProcessEvent( "DriverStatus", "Major development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version" )
                        } else if( ( CurrentVersion[ 1 ] as int ) > ( SiteVersion [ 1 ] as int ) ){
                            Logging( "Minor development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version", 3 )
				            ProcessEvent( "DriverStatus", "Minor development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version" )
                        } else if( ( CurrentVersion[ 2 ] as int ) > ( SiteVersion [ 2 ] as int ) ){
                            Logging( "Patch development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version", 3 )
				            ProcessEvent( "DriverStatus", "Patch development ${ CurrentVersion[ 0 ] }.${ CurrentVersion[ 1 ] }.${ CurrentVersion[ 2 ] } version" )
                        } else if( ( SiteVersion[ 0 ] as int ) > ( CurrentVersion[ 0 ] as int ) ){
                            Logging( "New major release ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available", 2 )
				            ProcessEvent( "DriverStatus", "New major release ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available" )
                        } else if( ( SiteVersion[ 1 ] as int ) > ( CurrentVersion[ 1 ] as int ) ){
                            Logging( "New minor release ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available", 2 )
				            ProcessEvent( "DriverStatus", "New minor release ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available" )
                        } else if( ( SiteVersion[ 2 ] as int ) > ( CurrentVersion[ 2 ] as int ) ){
                            Logging( "New patch ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available", 2 )
				            ProcessEvent( "DriverStatus", "New patch ${ SiteVersion[ 0 ] }.${ SiteVersion[ 1 ] }.${ SiteVersion[ 2 ] } available" )
                        }
                    }
                } else {
                    Logging( "${ DriverName() } is not published on drdsnell.com", 2 )
                    ProcessEvent( "DriverStatus", "${ DriverName() } is not published on drdsnell.com" )
                }
                break
            default:
                Logging( "Unable to check drdsnell.com for ${ DriverName() } driver updates.", 2 )
                break
        }
    }
}