PowerHive PowerShell Module

PowerShell module for Hive British Gas API, control the hive home system from PowerShell

Get Started With PowerHive

# Get The Module
Install-Module -Name PowerHive

Using The PowerHive Functions

# Connect To Hive API , Connect Hive will prompt for credentials, or use get-help connect-hive for details
Connect-Hive
# Get Hive Devices
Get-HiveDevice
# Get Hive Devices and return all properties
Get-HiveDevice -Detailed
# Send hive boost signal
$Id = "8a6b5d85-9ba2-4adb-9ceb-157c59f9b2ac"
Set-HiveBoost -ReceiverId $Id -Time 120 -Temperature 22

Exploring PowerHive Functions

# Get Commands
Get-Command -Module PowerHive
# Recurse help files
Get-Command -Module PowerHive | ForEach-Object {Get-Help $_.name}

List Of Functions

CommandType	Name	Version	Source
Function	Connect-Hive	1.0	PowerHive
Function	Disconnect-Hive	1.0	PowerHive
Function	Get-HiveActiveLight	1.0	PowerHive
Function	Get-HiveActivePlug	1.0	PowerHive
Function	Get-HiveAsscociatedDevice	1.0	PowerHive
Function	Get-HiveChannels	1.0	PowerHive
Function	Get-HiveContacts	1.0	PowerHive
Function	Get-HiveDevice	1.0	PowerHive
Function	Get-HiveEvents	1.0	PowerHive
Function	Get-HiveReceiver	1.0	PowerHive
Function	Get-HiveTemperature	1.0	PowerHive
Function	Get-HiveThermometer	1.0	PowerHive
Function	Get-HiveTopology	1.0	PowerHive
Function	Get-HiveUser	1.0	PowerHive
Function	Get-HiveWeather	1.0	PowerHive
Function	Remove-HiveContact	1.0	PowerHive
Function	Set-HiveActiveLight	1.0	PowerHive
Function	Set-HiveActivePlug	1.0	PowerHive
Function	Set-HiveBoost	1.0	PowerHive
Function	Set-HiveContact	1.0	PowerHive
Function	Set-HiveTemperature	1.0	PowerHive

Future Expansions

Formatting output on some of the functions to provide a better experiance and maybe some added functions around the hive channels etc.

Credits

smartofthehome

lwsrbrts/PoSHive

ukbendavies/PoshHive