Skip to content
Dijker edited this page Jan 1, 2017 · 9 revisions

PowerShell CLI for Homey

Get your Bearer token from the Browser and your CloudID from: Homey Settings System

Initialize the PowerShell CLI for Homey

Open your PowerShell or PowerShell ISE, and load the module:

C:\Homey> Import-Module HomeyPSCLI

Connect to Homey:

PS> Connect-Homey -Bearer "Deaf001000bad1000effe000hace000215c001" -CloudID "Deaf010bad10effe0hace021" -ExportPath "C:\Homey\Backup" -WriteConfig or PS> Connect-Homey -Bearer "Deaf001000bad1000effe000hace000215c001" -IP "192.168.12.34" -ExportPath "C:\Homey\Backup" -WriteConfig

PS> Get-HomeyPendingUpdate -Verbose -InstallPendingUpdate

No Updates available...

Version : 0.10.3

To export as much info from Homey I could find to the Export path defined with Connect-Homey use the following:

PS> Export-HomeyConfig

Look at the files and folder structure after running this command. Each Flow is exported to a JSON file in it's folder. If you can read JSON, you can document all flows in seconds and review older or lost flows and configurations.

Some Examples:

PS> Get-HomeyFlows | Where-Object { $_.title -eq "StopMic" }

PS> Get-HomeyFlows | Where-Object { $_.broken -eq $true } | ConvertTo-Json | ConvertFrom-Json | FT -Property id, title, broken

PS C:\Homey> Get-HomeyFlows | Where-Object { $_.title -eq "New Flow" }

Key Value

--- -----

id a13f6703-a770-4620-8c93-4ea7e824b6b5

title New Flow

enabled True

folder False

order 11

broken False

trigger False

conditions {}

actions {}

PS> Remove-HomeyFlow -ID "a13f6703-a770-4620-8c93-4ea7e824b6b5"

Warning:

This scripts make it possible to import some of the exported information, fe flows and BetterLogic variables. Possibly you break something in Homey when you import across different Homeys, different firmware versions or after importing edited information.

Using the import functions incorrectly can cause serious, system-wide problems that may require you to factory reset your Homey, restore firmware or even buy a new Homey to correct them. The Creator of the App and Athom cannot guarantee that any problems resulting from the use of these scripts can be solved. Use this tool at your own risk.

The Creator of the App and Athom are not responsible!!

FAQ:

  1. Q: What does this App do? A: Nothing (yet)! It shows this Page to tel you How to user HomeyPSCLI / PowerShell end provides the downloads of the two files.
  2. Q: So I download the psm1/psd1 files from Github and follow this instructions, will that work? A: Yes that should work!
  3. Q: Why should I install this app? A: I like to inform you in the notification center to update you scripts next time I update the app. Maybe the next version will support auto updating so you only have to update the scripts yourself once...
  4. Q: I have an other question..... 😃 A: See you on the forum: https://forum.athom.com/discussion/2086
  5. Q: I have found a bug / a feature request! A: See you on GitHub https://github.com/Dijker/nu.dijker.HomeyPSCLI/issues

Version History:

0.0.1 First version created local (20161005)

Full Release notes here: https://github.com/Dijker/nu.dijker.HomeyPSCLI/wiki/Release-Notes

Download

Download using the App Store or go to the Github repository for the most recent version.