yalehomeapp.groovy

/*
Hubitat App For Yale Home

Copyright 2020 - Taylor Brown

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


11-25-2020 :  Initial
11-28-2020 :  0.0.1 Alpha 
04-01-2024 :  1.0 Yale Home Rebrand
Considerable inspiration and examples thanks to: https://github.com/snjoetw/py-august
*/


import groovy.json.JsonSlurper
import groovy.json.JsonOutput
import groovy.transform.Field


@Field static String global_apiURL = "https://api.aaecosystem.com"
@Field static String global_HeaderApiKey = "d9984f29-07a6-816e-e1c9-44ec9d1be431"
@Field static String global_HeaderUserAgent = "August/Luna-22.17.0 (Android; SDK 31; gphone64_arm64)"
@Field static String global_HeaderAcceptVersion = "0.0.1"

definition(
        name: "Yale Home",
        namespace: "tmleafs",
        author: "Steven Dale (TMLeafs) Credit Taylor Brown (@thecloudtaylor)",
        description: "Yale Home App and Driver",
        category: "DoorLock",
        iconUrl: "",
        iconX2Url: "")

preferences 
{
    page(name: "mainPage")
    page(name: "loginPage", title: "Login Options", install: true)
    page(name: "debugPage", title: "Debug Options", install: true)


}

mappings {
    path("/handleAuth") {
        action: [
            GET: "handleAuthRedirect"
        ]
    }
}

def mainPage() {
    dynamicPage(name: "mainPage", title: "Setup connection to Yale Home and Discover devices", install: true, uninstall: true) {

        getLoginLink()
        
        getDiscoverButton()
        
        section {
            input name: "debugOutput", type: "bool", title: "Enable Debug Logging?", defaultValue: false, submitOnChange: true
        }
        
        listDiscoveredDevices()
        
        getDebugLink()
    }
}

def loginPage()
{
    dynamicPage(name:"loginPage", title: "Login Options", install: false, uninstall: false) {
    section {
        paragraph "Yale Home Login Options"
    }
    getLoginOptions()
    getTwoFA()
    }

}

def debugPage() {
    dynamicPage(name:"debugPage", title: "Debug", install: false, uninstall: false) {
        section {
            paragraph "Debug buttons"
        }
        section {
            input 'refreshToken', 'button', title: 'Force Token Refresh', submitOnChange: true
        }
        section {
            input 'deleteDevices', 'button', title: 'Delete all devices', submitOnChange: true
        }
        section {
            input 'refreshLocks', 'button', title: 'Refresh all locks', submitOnChange: true
        }
        section {
            input 'initialize', 'button', title: 'initialize', submitOnChange: true
        }
        section {
            input 'test', 'button', title: 'test', submitOnChange: true
        }
    }
}

def getLoginOptions() 
{
 section 
    {
        input name: "loginMethod", type: "enum", title: "Authentication Method", options: ["email", "phone"], required: true, defaultValue: "email", submitOnChange: true
        input name: "username", type: "text", title: "Username(email or phone i.e +44XXXXXXXXXX", description: "Yale Home Username", required: true
        input name: "password", type: "password", title: "Password", description: "Yale Home Password", required: true   
        input 'login', 'button', title: 'Login', submitOnChange: true
    }
}

def getTwoFA() 
{
 section 
    {
        if (state.twoFAneeded == false)
        {

        }
        else
        {
            input name: "twoFAcode", type: "text", title: "Two factor auth code", description: "AuthCode", required: true
            input 'verify', 'button', title: 'Verify', submitOnChange: true
        }
    }
}

def LogDebug(logMessage)
{
    if(settings?.debugOutput)
    {
        log.debug "${logMessage}";
    }
}

def LogInfo(logMessage)
{
    log.info "${logMessage}";
}

def LogWarn(logMessage)
{
    log.warn "${logMessage}";
}

def LogError(logMessage)
{
    log.error "${logMessage}";
}

def installed()
{
    LogInfo("Installing Yale Home.");
    state.twoFAneeded = false;
    
}

def initialize() 
{
    LogInfo("Initializing Yale Home.");
    unschedule()
    refreshToken()
    refreshLocks()
        
    if (refreshIntervals != "0" && refreshIntervals != null)
    {
        def cronString = ('0 */' + refreshIntervals + ' * ? * *')
        LogDebug("Scheduling Refresh cronstring: ${cronString}")
        schedule(cronString, refreshLocks)
    }
    else
    {
        LogInfo("Auto Refresh Disabled.")
    }
}

def updated() 
{
    LogDebug("Updated with config: ${settings}");
    if (refreshIntervals == null)
    {
        refreshIntervals = 10;
    }
    initialize();
}

def uninstalled() 
{
    LogInfo("Uninstalling August Home.");
    unschedule()
    for (device in getChildDevices())
    {
        deleteChildDevice(device.deviceNetworkId)
    }
}

def sessionRequest(loginMethod, userName, password) 
{
    LogDebug("sessionRequest()");


    //state.install_id
    //state.access_token
    //state.access_token_expires 

    def installID = getHubUID()
    def identifier = "${loginMethod}:${userName}"

    def uri = global_apiURL + '/session'
// "x-kease-api-key":global_HeaderApiKey,
    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent
    ]
    def body = [
        "installId": installID,
        "identifier": identifier,
        "password": password,
    ]

    def params = [ uri: uri, headers:headers, body: body]
    LogDebug("sessionRequest-params ${params}")

    //bugbug: should be validating resoponse
    //bugbug: should be setting expire
    try
    {
        httpPostJson(params) { response -> 
            
            def reCode = response.getStatus();
            def reJson = response.getData();
            def reHeaders = 
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            LogDebug("reHeaders: ${reHeaders}")

            state.access_token = response.getHeaders("x-august-access-token").value[0].toString()
            LogDebug("AccessToken: ${state.access_token}")
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
        
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("connectToYaleHome failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

}

def sendVerificationCodeRequest(loginMethod, userName) 
{
    LogDebug("sendVerificationCodeRequest()");

    def uri =""

    if (loginMethod == "email")
    {
        uri = global_apiURL + '/validation/email'
    }
    else if (loginMethod == "phone")
    {
        uri = global_apiURL + '/validation/phone'
    }
    else
    {
        LogError("Invalid verification type: ${loginMethod}")
        return false;
    }

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def body = [
        "value":userName
    ]

    def params = [ uri: uri, headers:headers, body: body]
    LogDebug("sendVerificationCodeRequest-params ${params}")

    try
    {
        httpPostJson(params) { response -> 
    
            def reCode = response.getStatus();
            def reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
            state.twoFAneeded = true;
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
        
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("sendVerificationCodeRequest failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

}

def sendVerificationCodeResponse(loginMethod, userName, verifcationCode) 
{
    LogDebug("sendVerificationCodeResponse()");

    def uri =""
    def body = []


    if (loginMethod == "email")
    {
        uri = global_apiURL + '/validate/email'
        body = [
            email:userName,
            "code":verifcationCode
        ]
    }
    else if (loginMethod == "phone")
    {
        uri = global_apiURL + '/validate/phone'
        body = [
            phone:userName,
            "code":verifcationCode
        ]
    }
    else
    {
        LogError("Invalid validate type: ${loginMethod}")
        return false;
    }

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers, body: body]
    LogDebug("sendVerificationCodeResponse-params ${params}")

    try
    {
        httpPostJson(params) { response -> 
    
            def reCode = response.getStatus();
            def reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
            state.access_token = response.getHeaders("x-august-access-token").value[0].toString()
            LogDebug("AccessToken: ${state.access_token}")
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
            state.twoFAneeded = false;
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("connectToYaleHome failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

}


def refreshToken() 
{
    LogDebug("refreshToken()");

    def uri = global_apiURL + '/users/houses/mine'
    def body = []

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers, body: body]
    LogDebug("refreshToken-params ${params}")

    try
    {
        httpGet(params) { response -> 
    
            def reCode = response.getStatus();
            def reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
            state.access_token = response.getHeaders("x-august-access-token").value[0].toString()
            LogDebug("AccessToken: ${state.access_token}")
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
        
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("refreshToken failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

    def runTime = new Date()
    runTime.setHours(24)
    runOnce(runTime, refreshToken)
    LogInfo("Token Refreshed, next refresh in 24 hours.")
}

def discoverLocks() 
{
    LogDebug("discoverLocks()");

    def uri = global_apiURL + '/users/locks/mine'

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers]
    LogDebug("getLocks-params ${params}")

    def reJson =''
    try
    {
        httpGet(params) { response -> 
    
            def reCode = response.getStatus();
            reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("connectToYaleHome failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }
    
    reJson.each 
    {
        LogDebug("LockID: ${it.key}")
        LogDebug("LockName: ${it.value['LockName']}")
        LogDebug("macAddress: ${it.value['macAddress']}")
        LogDebug("HouseID: ${it.value['HouseID']}")
        LogDebug("HouseName: ${it.value['HouseName']}")

        lockStatus = getLock(it.key)
        LogDebug("LockStatus: ${lockStatus.LockStatus.doorState}")

        try 
        {
            if (lockStatus.doorState != "init")
            {
                addChildDevice(
                    'tmleafs',
                    'Yale Home Lock with DoorSense',
                    "${it.key}",
                    [
                        name: "Yale Home Lock with DoorSense",
                        label: "${it.value['HouseName']} - ${it.value['LockName']}"
                    ])
            }
            else
            {
                addChildDevice(
                    'tmleafs',
                    'Yale Home Lock',
                    "${it.key}",
                    [
                        name: "Yale Home Lock",
                        label: "${it.value['HouseName']} - ${it.value['LockName']}"
                    ])   
            }
        } 
        catch (com.hubitat.app.exception.UnknownDeviceTypeException e) 
        {
            "${e.message} - you need to install the appropriate driver."
        } 
        catch (IllegalArgumentException ignored) 
        {
            //Intentionally ignored.  Expected if device id already exists in HE.
        }
    }

}

def refreshLocks()
{
    LogDebug("refreshLocks()");

    def children = getChildDevices()
    children.each 
    {
        if (it != null) 
        {
            updateLockDeviceStatus(it);
        }
    }

    if (refreshIntervals != "0" && refreshIntervals != null)
    {
        LogInfo("Updated Locks, Next Update in ${refreshIntervals} min.")
    }
    else
    {
        LogInfo("Auto Refresh Disabled.")
    }
}

def getLock(deviceID) 
{
    LogDebug("getLock(deviceID=${deviceID})");

    //def uri = global_apiURL + "/locks/${deviceID}/status"
    def uri = global_apiURL + "/locks/${deviceID}"


    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers]
    LogDebug("getLock-params ${params}")

    def reJson =''
    try
    {
        httpGet(params) { response -> 
    
            def reCode = response.getStatus();
            reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("getLock failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

    return reJson;
}

def updateLockDeviceStatus(com.hubitat.app.DeviceWrapper device) 
{
    LogDebug("updateLockDeviceStatus()");

    def deviceID = device.getDeviceNetworkId();
    def reJson = getLock(deviceID)


    def lockStatus = reJson.LockStatus.status
    LogDebug("updateLockDeviceStatus-status: ${lockStatus}")
    sendEvent(device, [name: 'lock', value: lockStatus])

    def doorState = reJson.LockStatus.doorState
    LogDebug("updateLockDeviceStatus-doorState: ${doorState}")
    if (doorState != "init")
    {
        sendEvent(device, [name: 'contact', value: doorState])
    }

    def batteryLevel = reJson.battery
    LogDebug("updateLockDeviceStatus-battery: ${batteryLevel}")
    if (batteryLevel > 0)
    {
        sendEvent(device, [name: 'battery', value: (batteryLevel*100).intValue()])
    }

    if (reJson.containsKey("keypad"))
    {
        LogDebug("Keypad Found with ID: ${reJson.keypad._id}")
        device.updateKeypad(reJson.keypad)
    }
}

def discoverKeypad(com.hubitat.app.DeviceWrapper device) 
{
    LogDebug("discoverKeypad()");

    def deviceID = device.getDeviceNetworkId();
    def reJson = getLock(deviceID)

    if (reJson.containsKey("keypad"))
    {
        LogInfo("Keypad Found")
        device.createChildKeypad(reJson.keypad._id, reJson.keypad.lockID)
    }
    updateLockDeviceStatus(device)
}

def lockDoor(com.hubitat.app.DeviceWrapper device) 
{
    LogDebug("lockDoor()");

    def deviceID = device.getDeviceNetworkId();

    def uri = global_apiURL + "/remoteoperate/${deviceID}/lock"

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers]
    LogDebug("lockDoor-params ${params}")

    try
    {
        httpPut(params) { response -> 
    
            def reCode = response.getStatus();
            def reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
        
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("lockDoor failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }
    updateLockDeviceStatus(device)
    LogInfo("Door Lock Request Compleated")
}

def unlockDoor(com.hubitat.app.DeviceWrapper device) 
{
    LogDebug("unlockDoor()");

    def deviceID = device.getDeviceNetworkId();

    def uri = global_apiURL + "/remoteoperate/${deviceID}/unlock"

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers]
    LogDebug("unlockDoor-params ${params}")

    try
    {
        httpPut(params) { response -> 
    
            def reCode = response.getStatus();
            def reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
            //[installId:66b5b48f-ec95-46f1-ac65-04e5a491cce8, applicationId:, userId:f9a97f3d-1516-4092-99dc-bd2956a8a34f, vInstallId:false, vPassword:true, vEmail:false, vPhone:false, hasInstallId:true, hasPassword:true, hasEmail:true, hasPhone:true, isLockedOut:false, captcha:, email:[], phone:[], expiresAt:2021-03-29T01:24:49.273Z, temporaryAccountCreationPasswordLink:, iat:1606613089, exp:1616981089, LastName:Brown, FirstName:Taylor]
        
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("unlockDoor failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }
    updateLockDeviceStatus(device)
    LogInfo("Door Unlock Request Compleated")
}


def getLockCodes(com.hubitat.app.DeviceWrapper lockDevice, com.hubitat.app.DeviceWrapper keypadDevice) 
{
    def lockDeviceID = lockDevice.getDeviceNetworkId();

    LogDebug("getLockCodes(deviceID=${lockDeviceID})");

    def uri = global_apiURL + "/locks/${lockDeviceID}/pins"

    def headers = [
        "Accept-Version":global_HeaderAcceptVersion,
        "x-august-api-key":global_HeaderApiKey,
        "Content-Type":"application/json",
        "x-august-country":"US",
        "x-august-branding":"yale",
        "User-Agent":global_HeaderUserAgent,
        "x-august-access-token":state.access_token
    ]

    def params = [ uri: uri, headers:headers]
    LogDebug("getLockCodes-params ${params}")

    def reJson =''
    try
    {
        httpGet(params) { response -> 
    
            def reCode = response.getStatus();
            reJson = response.getData();
            LogDebug("reCode: ${reCode}")
            LogDebug("reJson: ${reJson}")
            response.getHeaders().each {
                LogDebug("reHeader: ${it}")
            }
        }
    }
    catch (groovyx.net.http.HttpResponseException e) 
    {
        LogError("getLockCodes failed -- ${e.getLocalizedMessage()}: ${e.response.data}")
        return false;
    }

    def lockCodesJson = '{'
    reJson.loaded.each { code ->
        if (lockCodesJson.endsWith('}'))
        {
            lockCodesJson += ','
        }
        lockCodesJson += ('"' + code.slot + '":{"name":"' + code.firstName + ' ' + code.lastName + '","code":"' + code.pin + '"}')
    }
    lockCodesJson += '}'

    // Pins are in clear text so hiding
    //LogDebug("getLockCodes PinJson: ${lockCodesJson}")
    sendEvent(keypadDevice, [name: 'lockCodes', value: encrypt(lockCodesJson)])
}

def deleteCode(com.hubitat.app.DeviceWrapper lockDevice, com.hubitat.app.DeviceWrapper keypadDevice, Map params)
{
    def codePosition = params.codeposition;
    def lockDeviceID = lockDevice.getDeviceNetworkId();

    LogDebug("deleteCode() deviceID=${lockDeviceID}; codePosition=${codePosition}")

    LogError("deleteCode Not Yet Supported")
    // As the August API is not documented and I don't have a keypad I can't add this support.

    // There does seem to be a delete API (see the unexplored list at https://medium.com/@nolanbrown/august-lock-rest-apis-the-basics-7ec7f31e7874)
    // Without more exploration I am not sure if it' "DELETE /locks/{lockID}/pins" or more likly something 
    // something similar to PUT /locks/{lockID}/users/{userID}/pin
}

def setCode(com.hubitat.app.DeviceWrapper lockDevice, com.hubitat.app.DeviceWrapper keypadDevice, Map params)
{
    def pincode = params.pincode;  //might be encripted? if so run decript()
    def codePosition = params.codeposition;
    def name = params.name

    def lockDeviceID = lockDevice.getDeviceNetworkId();

    LogDebug("setCode() deviceID=${lockDeviceID}; codePosition=${codePosition}; pincode=${pincode}; name=${name}")

    LogError("deleteCode Not Yet Supported")
    // As the August API is not documented and I don't have a keypad I can't add this support.

    // I suspect you first need to match the user or create one and then the pin 
    // (see the unexplored list at https://medium.com/@nolanbrown/august-lock-rest-apis-the-basics-7ec7f31e7874)
    // PUT /locks/adduser/{lockID}/{otherUserId}/{type} AND THEN PUT /locks/{lockID}/users/{userID}/pin
}


def grandChildDeviceHandler(com.hubitat.app.DeviceWrapper lockDevice, com.hubitat.app.DeviceWrapper keypadDevice, method, Map params=null)
{    
    LogDebug("grandChildDeviceHandler(method=${method})");


    switch (method){
        case 'getLockCodes':
            getLockCodes(lockDevice, keypadDevice)
        break
        case 'deleteCode':
            deleteCode(lockDevice, keypadDevice, params)
        break
        case 'setCode':
            setCode(lockDevice, keypadDevice, params)
        break
        defaultValue:
        LogError("No method named: ${method}")
    }
}


def getDiscoverButton() 
{
    if (state.access_token == null) 
    {
        section 
        {
            paragraph "Device discovery button is hidden until authorization is completed."            
        }
    } 
    else 
    {
        section 
        {
            input 'discoverDevices', 'button', title: 'Discover', submitOnChange: true
        }
    }
}

def getLoginLink() {
    section{
        href(
            name       : 'loginHref',
            title      : 'Login Options',
            page       : 'loginPage',
            description: 'Access Login Options'
        )
    }
}

def getDebugLink() {
    section{
        href(
            name       : 'debugHref',
            title      : 'Debug buttons',
            page       : 'debugPage',
            description: 'Access debug buttons (force Token refresh, delete child devices , refresh devices)'
        )
    }
}

def listDiscoveredDevices() {
    def children = getChildDevices()
    def builder = new StringBuilder()
    builder << "<ul>"
    children.each {
        if (it != null) {
            builder << "<li><a href='/device/edit/${it.getId()}'>${it.getLabel()}</a></li>"
        }
    }
    builder << "</ul>"
    def links = builder.toString()
    section {
        paragraph "Discovered devices are listed below:"
        paragraph links
    }
    section {
        paragraph "Refresh interval (how often devices are automaticaly refreshed/polled):"

        input name: "refreshIntervals", type: "enum", title: "Set the refresh interval.", options: [0:"off", 1:"1 minute", 2:"2 minutes", 5:"5 minutes",10:"10 minutes",15:"15 minutes",30:"30 minutes",55:"55 minutes"], required: true, defaultValue: "10", submitOnChange: true
    }
}   
    

def appButtonHandler(btn) {
    switch (btn) {
    case 'login':
        sessionRequest(settings.loginMethod, settings.username, settings.password)
        sendVerificationCodeRequest(settings.loginMethod, settings.username)
        break
    case 'verify':
        sendVerificationCodeResponse(settings.loginMethod, settings.username, settings.twoFAcode)
        break
    case 'discoverDevices':
        discoverDevices()
        break
    case 'refreshToken':
        refreshToken()
        break
    case 'deleteDevices':
        deleteDevices()
        break
    case 'refreshLocks':
        refreshLocks()
        break
    case 'initialize':
        initialize()
        break
    /*case 'test':
        test()
        break */
    }
}

def deleteDevices()
{
    def children = getChildDevices()
    LogInfo("Deleting all child devices: ${children}")
    children.each {
        if (it != null) {
            deleteChildDevice(it.getDeviceNetworkId())
        }
    } 
}

def discoverDevices()
{
    LogDebug("discoverDevices()");

    discoverLocks()

    def children = getChildDevices()
    LogDebug("All child devices: ${children}")
    children.each { 
        discoverKeypad(it)
    }
    refreshLocks()
}

def test()
{

}