Set-HiveActiveLight

NAME Set-HiveActiveLight



SYNOPSIS

Set properties on a specific Hive light.





SYNTAX

Set-HiveActiveLight [-ActiveLightId] <Guid> [[-PowerState] <String>] [[-ColourMode] <String>] [[-Hue] <UInt16>]

[[-Brightness] <UInt16>] [[-ColourTemperature] <UInt16>] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Update specified Hive light with new desired state that can include a combination of:

Brightness, Hue, PowerState, ColourMode and ColourTemperature





PARAMETERS

-ActiveLightId <Guid>

ID of Hive Active Light Bulb



Required? true

Position? 1

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PowerState <String>

Desired Power state of the bulb



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ColourMode <String>

Desired colour mode of the bulb



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Hue <UInt16>

Desired hue colour of the bulb



Required? false

Position? 4

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Brightness <UInt16>

Desired brightness of the bulb



Required? false

Position? 5

Default value 5

Accept pipeline input? false

Accept wildcard characters? false



-ColourTemperature <UInt16>

Desired colour temperature of the bulb



Required? false

Position? 6

Default value 2700

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Accepts Pipeline input from Get-HiveDevice



Accepts pipeline input from Get-HiveDevice





OUTPUTS











NOTES





Author: @pm091



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Set-HiveActiveLight -ActiveLightID $ID -PowerState OFF













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Set-HiveActiveLight -ActiveLightID $ID -ColourMode TUNABLE -ColourTemperature 1200













-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Set-HiveActiveLight -ActiveLightID $ID -ColourMode COLOUR -Hue 255













-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Turns on all hive active light bulbs



Get-HiveDevice | Where-Object name -Like "*light*" | Select-Object -ExpandProperty id | Set-HiveActiveLight

-PowerState ON











RELATED LINKS

https://github.com/pm091/PowerHive/blob ... veLight.md