Skip to content

PSHomebridge

PSHomebridge is a PowerShell 7 client module for the Homebridge UI API.

Requirements

  • PowerShell 7.0 or later
  • Homebridge with the Homebridge UI
  • A Homebridge user name and password when the server requires authentication

Install PSHomebridge

Install-Module -Name PSHomebridge -Repository PSGallery
Import-Module -Name PSHomebridge

Save a connection

This example saves a connection that uses Homebridge authentication.

$credential = Get-Credential
Set-PSHomebridgeConnection -InstanceName 'Home' -Url 'https://homebridge.example.com' -Credential $credential

Note

By default, Windows encrypts the password for the current user and host with DPAPI.

For portable encryption, set PSHOMEBRIDGE_AES_KEY to a Base64-encoded 32-byte key.

If the server does not require authentication, save a connection without credentials.

Set-PSHomebridgeConnection -InstanceName 'Home' -Url 'https://homebridge.example.com' -NoAuthentication

Test the connection

Get-HomebridgeStatus -InstanceName 'Home' -Type HomebridgeVersion

See the command reference for all supported commands.