/* * BlinkChild-Network * * Description: * This Hubitat driver provides a spot to put Blink network data * * Instructions for using Tile Template method (originally based on @mircolino's HTML Templates): * 1) In "Hubitat -> Devices" select the child/sensor (not the parent) you would like to "templetize" * 2) In "Preferences -> Tile Template" enter your template (example below) and click "Save Preferences" * Ex: "[font size='2'][b]Temperature:[/b] ${ temperature }°${ location.getTemperatureScale() }[/br][/font]" * 3) 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 * 4) Select the Add Tile button and the tile should appear * NOTE: Should accept most HTML formatting commands with [] instead of <> * * Features List: * Ability to Arm/Disarm the device's network * Ability to display various device data * Ability to check a website (mine) to notify user if there is a newer version of the driver available * * KNOWN ISSUE(S): * Image and video data/thumbnails cannot be displayed in Hubitat * * Licensing: * Copyright 2024 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.3 - Correction to ProcessEvent function and removal of old driver-specific attributes when Preferences are saved * 0.1.2 - Altered the device specific driver attribute names * 0.1.1 - Update to driver version checking method and attributes * 0.1.0 - Initial version * * Thank you(s): * @Cobra for inspiration of how I perform driver version checking * @mircolino for Template method for dashboard use * https://github.com/MattTW/BlinkMonitorProtocol for providing the basis for much of what is possible with the API */ // Returns the driver name def DriverName(){ return "BlinkChild-Network" } // Returns the driver version def DriverVersion(){ return "0.1.3" } // Driver Metadata metadata{ definition( name: "BlinkChild-Network", namespace: "Snell", author: "David Snell", importUrl: "https://www.drdsnell.com/projects/hubitat/drivers/BlinkChild-Network.groovy" ) { capability "Sensor" capability "Actuator" capability "Switch" // Commands command "on", [ [ name: "This will Arm system represented by Network" ] ] // command "off", [ [ name: "This will Disarm system represented by Network" ] ] // command "SystemArm", [ [ name: "This will Arm system represented by Network" ] ] // command "SystemDisarm", [ [ name: "This will Disarm system represented by Network" ] ] // //command "DoSomething" // For testing and development purposes only, it should not be uncommented for normal use // Attributes - Common attribute "ID", "number" // attribute "Network ID", "number" // attribute "Created", "string" // attribute "Updated", "string" // attribute "Deleted", "string" // attribute "Status", "string" // attribute "Name", "string" // attribute "Serial", "string" // attribute "Firmware Version", "string" // attribute "WiFi Strength", "number" // attribute "Local Storage Compatible", "string" // attribute "Local Storage Enabled", "string" // attribute "Local Storage Status", "string" // attribute "Join State", "number" // attribute "Options", "map" // attribute "Continue Warning", "number" // attribute "Submit Logs", "string" // attribute "Join Available", "string" // attribute "New Command", "string" // attribute "Account ID", "number" // attribute "Last Command ID", "number" // attribute "Feature Plan ID", "string" // attribute "WiFi Signal", "number" // attribute "temperature", "number" // attribute "LFR Signal", "number" // attribute "Battery Signal", "number" // attribute "Armed", "string" // attribute "Arm String", "string" // // Attributes - Network Specific attribute "Network ID", "number" // attribute "Auto Arm By Geo", "string" // attribute "Auto Arm By Time", "string" // attribute "Camera Error", "string" // attribute "Sync Module Error", "string" // attribute "Daylight Savings Time", "string" // attribute "SM Backup Enabled", "string" // attribute "Storage Total", "number" // attribute "LiveView Mode", "string" // attribute "Video Description", "string" // attribute "Ping Interval", "number" // attribute "Network Key", "string" // attribute "Busy", "string" // attribute "Network Origin", "string" // attribute "Time Zone", "string" // attribute "LFR Channel", "number" // attribute "Encryption Key", "string" // attribute "Video History Count", "number" // attribute "Storage Used", "number" // attribute "LV Save", "string" // attribute "Location ID", "string" // // Tile Template attribute attribute "Tile", "string"; // Ex: "[font size='2'][b]Temperature:[/b] ${ temperature }°${ location.getTemperatureScale() }[/br][/font]" attribute "DriverName", "string" // Identifies the driver being used for update purposes attribute "DriverVersion", "string" // Version number of the driver itself attribute "DriverStatus", "string" // Attribute to provide notice to user of driver version changes } preferences{ //section{ if( ShowAllPreferences ){ input( name: "TileTemplate", type: "string", title: "Tile Template", description: "Ex: [b]Temperature:[/b] \${ state.temperature }°${ location.getTemperatureScale() }[/br]", defaultValue: ""); input( type: "enum", name: "LogType", title: "Enable Logging?", required: false, multiple: false, options: [ "None", "Info", "Debug", "Trace" ], defaultValue: "Info" ) input( type: "bool", name: "ShowAllPreferences", title: "Show All Preferences?", defaultValue: true ) } else { input( type: "bool", name: "ShowAllPreferences", title: "Show All Preferences?", defaultValue: true ) } //} } } // updated def updated(){ if( LogType == null ){ LogType = "Info" } // Set the driver name and version before update checking is scheduled if( state."Driver Name" != null ){ state.remove( "Driver Name" ) state.remove( "Driver Version" ) device.deleteCurrentState( "Driver Name" ) device.deleteCurrentState( "Driver Version" ) } ProcessEvent( "DriverName", DriverName() ) ProcessEvent( "DriverVersion", DriverVersion() ) // Schedule the daily driver version check schedule( new Date(), CheckForUpdate ) Logging( "Updated", 2 ) } // DoSomething is for testing and development purposes. It should not be uncommented for normal usage. def DoSomething(){ } // Call the ArmSystem def SystemArm(){ ArmSystem() } // Call the DisarmSystem def SystemDisarm(){ DisarmSystem() } // Call the parent device's ArmSystem with this device's ID def ArmSystem(){ parent.ArmSystem( state.ID ) } // Call the parent device's DisarmSystem with this device's ID def DisarmSystem(){ parent.DisarmSystem( state.ID ) } // on will trigger an ArmSystem command with this device def on(){ ArmSystem() } // off will trigger an DisarmSystem command with this device def off(){ DisarmSystem() } // installed is called when the device is installed, all it really does is run updated def installed(){ Logging( "Installed", 2 ) updated() } // initialize is called when the device is initialized, all it really does is run updated def initialize(){ Logging( "Initialized", 2 ) updated() } // Tile Template method based on @mircolino's HTML Template method private void UpdateTile( String val ){ if( settings.TileTemplate ){ // Create special compound/html tile val = settings.TileTemplate.toString().replaceAll( "\\[", "<" ) val = val.replaceAll( "\\]", ">" ) val = val.replaceAll( ~/\$\{\s*([A-Za-z][A-Za-z0-9_]*)\s*\}/ ) { java.util.ArrayList m -> device.currentValue("${ m [ 1 ] }").toString() } if( device.currentValue( "Tile" ).toString() != val ){ sendEvent( name: "Tile", value: val ) } } } // Process data to check against current state value and then send an event if it has changed def SetDeviceType( Type ){ DeviceType = Type Logging( "DeviceType = ${ DeviceType }", 4 ) } // Return a state value def ReturnState( Variable ){ return state."${ Variable }" } // Process data to check against current state value and then send an event if it has changed def ProcessEvent( Variable, Value, Unit = null ){ if( state."${ Variable }" != Value ){ state."${ Variable }" = Value if( Unit != null ){ Logging( "Event: ${ Variable } = ${ Value }${ Unit }", 4 ) sendEvent( name: "${ Variable }", value: Value, unit: Unit, isStateChange: true ) } else { Logging( "Event: ${ Variable } = ${ Value }", 4 ) sendEvent( name: "${ Variable }", value: Value, isStateChange: true ) } UpdateTile( "${ Value }" ) } } // Process data to check against current state value and update if it has changed def ProcessState( Variable, Value ){ if( state."${ 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 } } }