{"id":2851,"date":"2014-07-28T12:11:02","date_gmt":"2014-07-28T12:11:02","guid":{"rendered":"http:\/\/dollarunderscore.azurewebsites.net\/?p=2851"},"modified":"2014-07-28T12:22:13","modified_gmt":"2014-07-28T12:22:13","slug":"checking-who-is-home-with-powershell","status":"publish","type":"post","link":"https:\/\/p0wershell.com\/?p=2851","title":{"rendered":"Checking who is home with PowerShell"},"content":{"rendered":"

The first thing that comes to mind when doing home automation is probably controlling lights and sockets depending on if someone is home or not. Most apps I’ve seen for this can’t handle multiple family members though, which is quite useless. You don’t want to turn on all the lights when you come home if someone else is sleeping or watching a movie with dimmed lights for example.<\/p>\n

So how to figure out who is currently at home?<\/p>\n

The method I chose was to check if our phones are connected to WiFi. There are a few obstacles to overcome before this works though, for example:<\/p>\n

  • Many smartphones turn off WiFi to save battery (for example the iPhone)<\/li>\n
  • They use dynamic IP-addresses and name resolution is not always available, so how to find them?<\/li>\n

    The script therefor checks for how long a phone has been offline before it does any changes, and it starts off by doing a pingsweep to populate the arp-table to find the different phones MAC-addresses.<\/p>\n

    This scripts updates the status of each phone in a file on disk and also changes a device in Telldus Live! to On\/Off. That makes it possible to filter events in Telldus Live! based on who’s home, or when the last person leaves.<\/p>\n

    The script-module used here can be found in this post<\/a>.<\/p>\n

    The script looks like this:<\/p>\n

    [PowerShell]
    \n# Import the telldus module
    \nImport-Module ‘C:\\TelldusScripts\\Telldusv2.psm1’<\/p>\n

    # Set telldus credentials
    \n$Username = “MyEmailForTelldusLive@contoso.com”<\/p>\n

    # Get the password from the file (a saved PowerShell credential)
    \n$Password = Get-Content ‘C:\\TelldusScripts\\TelldusPassword.txt’ | ConvertTo-SecureString<\/p>\n

    # Build the credential
    \n$TelldusCredential = New-Object System.Management.Automation.PsCredential($Username,$Password)<\/p>\n

    # Specify path to the “FamilyMember” file
    \n$FamilyMemberFile = “C:\\TelldusScripts\\FamilyMembers.csv”<\/p>\n

    # How many times should we wait for the network scan to finish?
    \n$MaxWaitRounds = 10<\/p>\n

    # How long should we sleep between each “network scan check”?
    \n$WaitBetweenNetworkScanSeconds = 10<\/p>\n

    # Load that file into an array
    \n$FamilyMembers = Import-Csv $FamilyMemberFile -Encoding utf8<\/p>\n

    # Get the subnets
    \n$DeviceSubnets = $FamilyMembers | select -ExpandProperty WiFiSubnet | Sort-Object -Unique<\/p>\n

    # Set the time limit for when a device should be considered offline
    \n$NotHomeTimeLimit = 120<\/p>\n

    # Do a ping sweep in those subnets to find any device MACs
    \nforeach ($DeviceSubnet in $DeviceSubnets) {<\/p>\n

    Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 1..25 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 26..50 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 51..75 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 76..100 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 101..125 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 126..150 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 151..175 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 176..200 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 201..225 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n Start-Job -ArgumentList $DeviceSubnet -ScriptBlock { $Subnet=$args[0] ; 225..255 | % { ping “$Subnet$_” -n 1 -w 1 } }
    \n}<\/p>\n

    $NumberOfRounds = 1<\/p>\n

    while ((Get-Job -State Running).count -gt 0 -AND $NumberOfRounds -le $MaxWaitRounds) {
    \n Write-Output “Scanning network for devices… (Round: $NumberOfRounds of max $MaxWaitRounds. Number of jobs running: $((Get-Job -State Running).count).)”
    \n sleep -Seconds $WaitBetweenNetworkScanSeconds
    \n $NumberOfRounds++
    \n}<\/p>\n

    # Loop through the family members
    \nforeach ($FamilyMember in $FamilyMembers) {<\/p>\n

    # Reset the variables
    \n $FamilyMemberLastStatus = $null
    \n $FamilyMemberCurrentStatus = $null<\/p>\n

    # Get last status
    \n $FamilyMemberLastStatus = Get-Content $($FamilyMember.StatusFile)<\/p>\n

    # Get current status by name
    \n $FamilyMemberCurrentStatus = Test-Connection $($FamilyMember.DeviceName) -Count 1 -Quiet<\/p>\n

    # Get it by MAC if that failed
    \n if ($FamilyMemberCurrentStatus -eq $false) {
    \n $CurrentFamilyMemberIP = $null
    \n $CurrentFamilyMemberIP = arp -a | select-string $FamilyMember.DeviceMAC | % { $_.ToString().Trim().Split(” “)[0] } | select -First 1<\/p>\n

    $FamilyMemberCurrentStatus = Test-Connection $CurrentFamilyMemberIP -Count 1 -Quiet
    \n }
    \n # Check if the current status is online
    \n if ($FamilyMemberCurrentStatus -eq $true) {<\/p>\n

    Write-Output “$($FamilyMember.Name)’s device is online!”<\/p>\n

    # Update status file
    \n Write-Output $true | Out-File $FamilyMember.StatusFile<\/p>\n

    # If it was offline last time, set the telldus device to on
    \n if ($FamilyMemberLastStatus -ne $true) {
    \n Write-Host “This is a change since last run, setting device to on.”
    \n Connect-TelldusLive -Credential $TelldusCredential
    \n Set-TDDevice -DeviceID $FamilyMember.DeviceID -Action turnOn
    \n }
    \n }
    \n # So the device was offline…
    \n else {
    \n Write-Output “$($FamilyMember.Name)’s device is offline!”<\/p>\n

    # Verify if this is temporary (iPhone sleep mode) or if it has been offline for a while
    \n $LastChangeTime=(gci $($FamilyMember.StatusFile)).LastWriteTime
    \n $Now=Get-Date
    \n $LastChangeTimeSpan = (New-TimeSpan -Start $LastChangeTime -End $Now).TotalMinutes<\/p>\n

    # Only change status if the device has been offline for $NotHomeTimeLimit minutes.
    \n if ($LastChangeTimeSpan -gt $NotHomeTimeLimit -AND $FamilyMemberLastStatus -eq $true) {
    \n # It was, update statusfile to offline
    \n Write-Output $false | Out-File $($FamilyMember.StatusFile)<\/p>\n

    Write-Output “This device has been offline for more than $NotHomeTimeLimit minutes. Turning Telldus device off…”
    \n Connect-TelldusLive -Credential $TelldusCredential
    \n Set-TDDevice -DeviceID $FamilyMember.DeviceID -Action turnOff
    \n }
    \n }
    \n}
    \n[\/PowerShell]<\/p>\n

    I’ve scheduled it to run quite often to always check if someone has arrived. Hopefully the comments in code will give you the help you need, if not, post a comment below and I’ll be glad to help you!<\/p>\n

    The csv file ($FamilyMemberFile, C:\\TelldusScripts\\FamilyMembers.csv) used in the script above should have the columns Name, DeviceName, DeviceMAC, WiFiSubnet, StatusFile, DeviceID.<\/p>\n

    Name = The name of the person who owns the device
    \nDeviceName = The DNS name of the device. iPhones use “DeviceName.local”
    \nDeviceMAC = MAC-address of the devices, use “-” as a separator.
    \nWiFiSubnet = The subnet where the phone gets its IP-address.
    \nStatusFile = The path to a file unique for this phone where the status can be written (if it’s home or not)
    \nDeviceID = The device id in Telldus Live! that is used to filter if this person is home.<\/p>\n

    Example:
    \nName,DeviceName,DeviceMAC,WiFiSubnet,StatusFile,DeviceID
    \nJohn,”JohnsiPhone.local”,”00-01-03-04-05-06″,”192.168.1.”,”C:\\TelldusScripts\\IsJohnHome.txt”,”123456″<\/p>\n

    The script will loop through all devices added and set the status in the status file (True\/False) aswell as the device in Telldus Live! (On\/Off) depending on if the phone was online or not.<\/p>\n

    Hope that made sense for you!<\/p>\n","protected":false},"excerpt":{"rendered":"

    The first thing that comes to mind when doing home automation is probably controlling lights and sockets depending on if someone is home or not. Most apps I’ve seen for this can’t handle multiple family members though, which is quite useless. You don’t want to turn on all the lights when you come home if […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","enabled":false}}},"categories":[231,21,241],"tags":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/p3Zj0A-JZ","_links":{"self":[{"href":"https:\/\/p0wershell.com\/index.php?rest_route=\/wp\/v2\/posts\/2851"}],"collection":[{"href":"https:\/\/p0wershell.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/p0wershell.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/p0wershell.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/p0wershell.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2851"}],"version-history":[{"count":0,"href":"https:\/\/p0wershell.com\/index.php?rest_route=\/wp\/v2\/posts\/2851\/revisions"}],"wp:attachment":[{"href":"https:\/\/p0wershell.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2851"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/p0wershell.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2851"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/p0wershell.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2851"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}