diff --git a/Add-HueSensor.ps1 b/Add-HueSensor.ps1 deleted file mode 100644 index 65c8f84..0000000 Binary files a/Add-HueSensor.ps1 and /dev/null differ diff --git a/CHANGELOG.md b/CHANGELOG.md index fe9e50e..3a98e0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,18 @@ +## 0.2.5: +* Set-HueRule: Easier conditions (Fixes #28) and plural aliases (Fixes #31) +* Adding Rename-HueSensor (Fixes #26). +* Rename-HueLight: Adding [Alias('ID')] to -OldName (Fixes #27) +* Get-HueBridge: SupportShouldProcess (Fixes #30) +* Set-HueLight: Fixing -Brightness/SaturationIncrement (Fixes #29) +* Add-HueSensor: Adding -New (Fixes #25) +* Improved Repository Organization (Fixes #32) +--- + ## 0.2.4.1 * Adding help for Add-HueLight (#23) * Fixing other markdown documentation layout issues --- - ## 0.2.4 * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) diff --git a/Add-HueLight.ps1 b/Functions/Hue/Add-HueLight.ps1 similarity index 99% rename from Add-HueLight.ps1 rename to Functions/Hue/Add-HueLight.ps1 index d68f18f..e1cbd26 100644 --- a/Add-HueLight.ps1 +++ b/Functions/Hue/Add-HueLight.ps1 @@ -1,5 +1,5 @@ function Add-HueLight { - <# +<# .SYNOPSIS Adds lights to Hue .DESCRIPTION @@ -15,12 +15,10 @@ function Add-HueLight { Get-HueLight .LINK Set-HueLight - #> - - [CmdletBinding(SupportsShouldProcess)] - +#> + [CmdletBinding(SupportsShouldProcess)] param( # One or more Device Identifiers (serial numbers ). # Use this parameter when adding lights that have already been assigned to another bridge. diff --git a/Add-HueLight.ps1.ps1 b/Functions/Hue/Add-HueLight.ps1.ps1 similarity index 100% rename from Add-HueLight.ps1.ps1 rename to Functions/Hue/Add-HueLight.ps1.ps1 diff --git a/Add-HueRoom.ps1 b/Functions/Hue/Add-HueRoom.ps1 similarity index 100% rename from Add-HueRoom.ps1 rename to Functions/Hue/Add-HueRoom.ps1 diff --git a/Add-HueSchedule.ps1 b/Functions/Hue/Add-HueSchedule.ps1 similarity index 100% rename from Add-HueSchedule.ps1 rename to Functions/Hue/Add-HueSchedule.ps1 diff --git a/Functions/Hue/Add-HueSensor.ps1 b/Functions/Hue/Add-HueSensor.ps1 new file mode 100644 index 0000000..6699de6 --- /dev/null +++ b/Functions/Hue/Add-HueSensor.ps1 @@ -0,0 +1,110 @@ +function Add-HueSensor +{ + <# + .Synopsis + Adds a sensor to a Hue Bridge. + .Description + Adds sensors to a Hue Bridge. + Sensors can be physical sensors, such as a motion detector, or virtual sensors, such as GenericFlag. + .Link + Get-HueSensor + .Example + Add-HueSensor -Name "ChaseStatus1" -SensorType GenericStatus + #> + [OutputType([PSObject])] + [CmdletBinding(SupportsShouldProcess)] + param( + # The name of the sensor. + [Parameter(Mandatory,Position=0,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [string] + $Name, + + <# + + The sensor type. + + Sensors can be: + + * Switches + * OpenClose + * Presence (motion detectors) + * Temperature + * Humidity + * LightLevel + * GenericFlag (used for virtual sensors) + * GenericStatus (used for virtual sensors) + #> + [Parameter(Mandatory,Position=1,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [ValidateSet('Switch','OpenClose','Presence','Temperature','Humidity','LightLevel', 'GenericFlag', 'GenericStatus')] + [string] + $SensorType, + + # The sensor ModelID + [Parameter(Position=2,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [string] + $ModelID = "ABCD-12345", + + # The sensor manufacturer + [Parameter(Position=2,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [string] + $Manufacturer = "ACME LTD", + + # The sensor unique ID. + [Parameter(Position=3,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [string] + $UniqueID= [guid]::NewGuid().tostring('n'), + + # The sensor version. + [Parameter(Position=4,ValueFromPipelineByPropertyName,ParameterSetName='CustomSensor')] + [Version] + $Version = '0.1', + + # If set, will search for new sensors to add. + [Parameter(Mandatory,ParameterSetName='NewSensor')] + [Alias('Find','Discover')] + [switch] + $New + ) + + begin { + $myCmd = $MyInvocation.MyCommand + } + + process { + #region Prepare REST Input + $sensorRest = + if ($PSCmdlet.ParameterSetName -eq 'CustomSensor') { + if ($SensorType) { + $sensorType = + foreach ($_ in $myCmd.Parameters['SensorType'].Attributes) { + if (-not $_.ValidValues) { continue } + $_.ValidValues -eq $SensorType + break + } + } + + @{ + name = $Name + modelid = $ModelID + swversion = "$Version" + type = 'CLIP' + $SensorType + uniqueid = $UniqueID + manufacturername = $Manufacturer + recycle = $false + } + } elseif ($New) { + $name = "new" + } + #endregion Prepare REST Input + + + if ($WhatIfPreference) { + return $sensorRest + } + + if ($PSCmdlet.ShouldProcess("Add-HueSensor $name")) { + Get-HueBridge | + Send-HueBridge -Method POST -Data $sensorRest -Command "sensors" + } + } +} diff --git a/Connect-HueBridge.ps1 b/Functions/Hue/Connect-HueBridge.ps1 similarity index 100% rename from Connect-HueBridge.ps1 rename to Functions/Hue/Connect-HueBridge.ps1 diff --git a/Disconnect-HueBridge.ps1 b/Functions/Hue/Disconnect-HueBridge.ps1 similarity index 100% rename from Disconnect-HueBridge.ps1 rename to Functions/Hue/Disconnect-HueBridge.ps1 diff --git a/Find-HueBridge.ps1 b/Functions/Hue/Find-HueBridge.ps1 similarity index 100% rename from Find-HueBridge.ps1 rename to Functions/Hue/Find-HueBridge.ps1 diff --git a/Get-HueBridge.ps1 b/Functions/Hue/Get-HueBridge.ps1 similarity index 97% rename from Get-HueBridge.ps1 rename to Functions/Hue/Get-HueBridge.ps1 index f72593c..d8a5165 100644 --- a/Get-HueBridge.ps1 +++ b/Functions/Hue/Get-HueBridge.ps1 @@ -11,8 +11,8 @@ .Example Get-HueBridge #> - [CmdletBinding(DefaultParameterSetName='ConnectionInfo')] - [OutputType([PSObject])] + [CmdletBinding(DefaultParameterSetName='ConnectionInfo',SupportsShouldProcess)] + [OutputType([PSObject])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSReviewUnusedParameter", "", Justification="Parameters used as hints for Parameter Sets")] param( # If set, will get the schedules defined on the Hue bridge @@ -131,6 +131,7 @@ $bridges | # Get all bridges Send-HueBridge -Command $PSCmdlet.ParameterSetName.ToLower() | # get the set of data we want from the bridge. ForEach-Object { + if ($WhatIfPreference) { return $_ } if ('Config', 'Capabilities' -contains $psCmdlet.ParameterSetName) { return $_ # config and capabilities are directly returned. } diff --git a/Get-HueLight.ps1 b/Functions/Hue/Get-HueLight.ps1 similarity index 100% rename from Get-HueLight.ps1 rename to Functions/Hue/Get-HueLight.ps1 diff --git a/Get-HueResource.ps1 b/Functions/Hue/Get-HueResource.ps1 similarity index 100% rename from Get-HueResource.ps1 rename to Functions/Hue/Get-HueResource.ps1 diff --git a/Get-HueRoom.ps1 b/Functions/Hue/Get-HueRoom.ps1 similarity index 100% rename from Get-HueRoom.ps1 rename to Functions/Hue/Get-HueRoom.ps1 diff --git a/Get-HueRule.ps1 b/Functions/Hue/Get-HueRule.ps1 similarity index 100% rename from Get-HueRule.ps1 rename to Functions/Hue/Get-HueRule.ps1 diff --git a/Get-HueScene.ps1 b/Functions/Hue/Get-HueScene.ps1 similarity index 100% rename from Get-HueScene.ps1 rename to Functions/Hue/Get-HueScene.ps1 diff --git a/Get-HueSchedule.ps1 b/Functions/Hue/Get-HueSchedule.ps1 similarity index 100% rename from Get-HueSchedule.ps1 rename to Functions/Hue/Get-HueSchedule.ps1 diff --git a/Get-HueSensor.ps1 b/Functions/Hue/Get-HueSensor.ps1 similarity index 100% rename from Get-HueSensor.ps1 rename to Functions/Hue/Get-HueSensor.ps1 diff --git a/Functions/Hue/README.md b/Functions/Hue/README.md new file mode 100644 index 0000000..36eb491 --- /dev/null +++ b/Functions/Hue/README.md @@ -0,0 +1,35 @@ +This directory contains LightScript's functions for [Philips Hue Bridges](https://www.philips-hue.com/). + + +|Name |Verb |Noun |Source | +|--------------------|----------|-----------|----------------------------------------------------| +|Add-HueLight |Add |HueLight |[Add-HueLight.ps1](Add-HueLight.ps1) | +|Add-HueRoom |Add |HueRoom |[Add-HueRoom.ps1](Add-HueRoom.ps1) | +|Add-HueSchedule |Add |HueSchedule|[Add-HueSchedule.ps1](Add-HueSchedule.ps1) | +|Add-HueSensor |Add |HueSensor |[Add-HueSensor.ps1](Add-HueSensor.ps1) | +|Connect-HueBridge |Connect |HueBridge |[Connect-HueBridge.ps1](Connect-HueBridge.ps1) | +|Disconnect-HueBridge|Disconnect|HueBridge |[Disconnect-HueBridge.ps1](Disconnect-HueBridge.ps1)| +|Find-HueBridge |Find |HueBridge |[Find-HueBridge.ps1](Find-HueBridge.ps1) | +|Get-HueBridge |Get |HueBridge |[Get-HueBridge.ps1](Get-HueBridge.ps1) | +|Get-HueLight |Get |HueLight |[Get-HueLight.ps1](Get-HueLight.ps1) | +|Get-HueResource |Get |HueResource|[Get-HueResource.ps1](Get-HueResource.ps1) | +|Get-HueRoom |Get |HueRoom |[Get-HueRoom.ps1](Get-HueRoom.ps1) | +|Get-HueRule |Get |HueRule |[Get-HueRule.ps1](Get-HueRule.ps1) | +|Get-HueScene |Get |HueScene |[Get-HueScene.ps1](Get-HueScene.ps1) | +|Get-HueSchedule |Get |HueSchedule|[Get-HueSchedule.ps1](Get-HueSchedule.ps1) | +|Get-HueSensor |Get |HueSensor |[Get-HueSensor.ps1](Get-HueSensor.ps1) | +|Read-HueSensor |Read |HueSensor |[Read-HueSensor.ps1](Read-HueSensor.ps1) | +|Remove-HueResource |Remove |HueResource|[Remove-HueResource.ps1](Remove-HueResource.ps1) | +|Remove-HueRoom |Remove |HueRoom |[Remove-HueRoom.ps1](Remove-HueRoom.ps1) | +|Remove-HueRule |Remove |HueRule |[Remove-HueRule.ps1](Remove-HueRule.ps1) | +|Remove-HueScene |Remove |HueScene |[Remove-HueScene.ps1](Remove-HueScene.ps1) | +|Remove-HueSchedule |Remove |HueSchedule|[Remove-HueSchedule.ps1](Remove-HueSchedule.ps1) | +|Remove-HueSensor |Remove |HueSensor |[Remove-HueSensor.ps1](Remove-HueSensor.ps1) | +|Rename-HueLight |Rename |HueLight |[Rename-HueLight.ps1](Rename-HueLight.ps1) | +|Rename-HueSensor |Rename |HueSensor |[Rename-HueSensor.ps1](Rename-HueSensor.ps1) | +|Send-HueBridge |Send |HueBridge |[Send-HueBridge.ps1](Send-HueBridge.ps1) | +|Set-HueLight |Set |HueLight |[Set-HueLight.ps1](Set-HueLight.ps1) | +|Set-HueRule |Set |HueRule |[Set-HueRule.ps1](Set-HueRule.ps1) | +|Write-HueSensor |Write |HueSensor |[Write-HueSensor.ps1](Write-HueSensor.ps1) | + + diff --git a/Functions/Hue/README.ps1.md b/Functions/Hue/README.ps1.md new file mode 100644 index 0000000..a3c6bca --- /dev/null +++ b/Functions/Hue/README.ps1.md @@ -0,0 +1,15 @@ +This directory contains LightScript's functions for [Philips Hue Bridges](https://www.philips-hue.com/). + +~~~PipeScript { + Import-Module ../../LightScript.psd1 -Global + [PSCustomObject]@{ + Table = Get-Command -Module LightScript | + Where-Object { $_.ScriptBlock.File -like "$pwd*" } | + .Name .Verb .Noun .Source { + $relativePath = $_.ScriptBlock.File.Substring("$pwd".Length) -replace '^[\\/]' + "[$relativePath]($relativePath)" + } + } + +} +~~~ \ No newline at end of file diff --git a/Read-HueSensor.ps1 b/Functions/Hue/Read-HueSensor.ps1 similarity index 100% rename from Read-HueSensor.ps1 rename to Functions/Hue/Read-HueSensor.ps1 diff --git a/Remove-HueResource.ps1 b/Functions/Hue/Remove-HueResource.ps1 similarity index 100% rename from Remove-HueResource.ps1 rename to Functions/Hue/Remove-HueResource.ps1 diff --git a/Remove-HueRoom.ps1 b/Functions/Hue/Remove-HueRoom.ps1 similarity index 100% rename from Remove-HueRoom.ps1 rename to Functions/Hue/Remove-HueRoom.ps1 diff --git a/Remove-HueRule.ps1 b/Functions/Hue/Remove-HueRule.ps1 similarity index 100% rename from Remove-HueRule.ps1 rename to Functions/Hue/Remove-HueRule.ps1 diff --git a/Remove-HueScene.ps1 b/Functions/Hue/Remove-HueScene.ps1 similarity index 100% rename from Remove-HueScene.ps1 rename to Functions/Hue/Remove-HueScene.ps1 diff --git a/Remove-HueSchedule.ps1 b/Functions/Hue/Remove-HueSchedule.ps1 similarity index 100% rename from Remove-HueSchedule.ps1 rename to Functions/Hue/Remove-HueSchedule.ps1 diff --git a/Remove-HueSensor.ps1 b/Functions/Hue/Remove-HueSensor.ps1 similarity index 100% rename from Remove-HueSensor.ps1 rename to Functions/Hue/Remove-HueSensor.ps1 diff --git a/Rename-HueLight.ps1 b/Functions/Hue/Rename-HueLight.ps1 similarity index 90% rename from Rename-HueLight.ps1 rename to Functions/Hue/Rename-HueLight.ps1 index e0a90f1..45b5cc1 100644 --- a/Rename-HueLight.ps1 +++ b/Functions/Hue/Rename-HueLight.ps1 @@ -15,12 +15,13 @@ function Rename-HueLight [OutputType([PSObject])] param( # The old name of the light. This can be a wildcard or regular expression. - [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)] + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias('ID')] [string] $OldName, # The new name of the light. A number sign will be replaced with the match number. - [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true)] + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] [string] $NewName ) diff --git a/Functions/Hue/Rename-HueSensor.ps1 b/Functions/Hue/Rename-HueSensor.ps1 new file mode 100644 index 0000000..b654070 --- /dev/null +++ b/Functions/Hue/Rename-HueSensor.ps1 @@ -0,0 +1,55 @@ +function Rename-HueSensor +{ + <# + .Synopsis + Renames Hue Sensors + .Description + Renames one or more Hue Sensors. + .Example + Rename-HueSensor + .Link + Get-HueBridge + .Link + Get-HueSensor + #> + [OutputType([PSObject])] + param( + # The old name of the Sensor. This can be a wildcard or regular expression. + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [Alias('ID')] + [string] + $OldName, + + # The new name of the Sensor. A number sign will be replaced with the match number. + [Parameter(Mandatory,ValueFromPipelineByPropertyName)] + [string] + $NewName + ) + + begin { + $Sensors = Get-HueSensor + $bridges = Get-HueBridge + } + + process { + $Sensors | + Where-Object { + #region Find matching Sensors + ($_.Id -eq $oldName) -or + ($_.Name -like $OldName) -or + ($oldName -as [regex] -and $_.Name -match $oldName) + #endregion Find matching Sensors + } | + ForEach-Object -Begin { + $matchCount = 0 + } -Process { + #region Rename the Sensors + $MatchCount++ + $realNewName = $NewName -replace '#', $MatchCount + $SensorToRename = $_ + $bridges | Send-HueBridge -Command "sensors/$($SensorToRename.id)" -Method PUT -Data @{name=$realNewName} + #endregion Rename the Sensors + } + } +} + diff --git a/Send-HueBridge.ps1 b/Functions/Hue/Send-HueBridge.ps1 similarity index 100% rename from Send-HueBridge.ps1 rename to Functions/Hue/Send-HueBridge.ps1 diff --git a/Set-HueLight.ps1 b/Functions/Hue/Set-HueLight.ps1 similarity index 94% rename from Set-HueLight.ps1 rename to Functions/Hue/Set-HueLight.ps1 index 76c257b..5a0f2da 100644 --- a/Set-HueLight.ps1 +++ b/Functions/Hue/Set-HueLight.ps1 @@ -151,16 +151,42 @@ function Set-HueLight [float[]] $XY, - # The increment in saturation. This will adjust the intensity of the color + # The increment in saturation. This will adjust the intensity of the color. [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty('sat_inc')] [ValidateRange(-1,1)] + [ComponentModel.AmbientValue({ + if ($_ -lt 0) { + [Math]::max(-254, + ([int][Math]::Floor(([Math]::Abs($_) / 1) * [byte]::maxValue)) * -1 + ) + } elseif ($_ -gt 0) { + [Math]::min(254, + [int][Math]::Floor(($_ / 1) * [byte]::maxValue) + ) + } else { + 0 + } + })] [float] $SaturationIncrement, - # An increment in luminance. This will adjust the brightness of the light + # An increment in luminance. This will adjust the brightness of the light. [Parameter(ValueFromPipelineByPropertyName)] [ComponentModel.DefaultBindingProperty('bri_inc')] + [ComponentModel.AmbientValue({ + if ($_ -lt 0) { + [Math]::max(-254, + ([int][Math]::Floor(([Math]::Abs($_) / 1) * [byte]::maxValue)) * -1 + ) + } elseif ($_ -gt 0) { + [Math]::min(254, + [int][Math]::Floor(($_ / 1) * [byte]::maxValue) + ) + } else { + 0 + } + })] [Alias('LuminanceIncrement')] [ValidateRange(-1,1)] [float] diff --git a/Set-HueRule.ps1 b/Functions/Hue/Set-HueRule.ps1 similarity index 66% rename from Set-HueRule.ps1 rename to Functions/Hue/Set-HueRule.ps1 index 1692e15..137cd6b 100644 --- a/Set-HueRule.ps1 +++ b/Functions/Hue/Set-HueRule.ps1 @@ -15,8 +15,58 @@ } -Action { Set-HueLight -Name "Sunroom*" -ColorTemperature 420 } -Name BrightenRoom + .EXAMPLE + # Set a rule that when + Set-HueRule -Condition { + "/sensors/61/state/buttonevent" -eq "4002" + } -Action { + Set-HueLight -RoomName "Sunroom" -Brightness 0.01 + } -Name SunroomDimmerTap + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "4003" + } -Action { + Set-HueLight -RoomName "Sunroom" -Off + } -Name SunroomDimmerHoldDownToTurnOff + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1003" + } -Action { + Set-HueLight -RoomName "Sunroom" -On + } -Name SunroomDimmerHoldUpToTurnOn + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1002" + } -Action { + Set-HueLight -RoomName "Sunroom" -On -Brightness .8 + } -Name SunroomDimmerTapOn + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2003" + } -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .1 + } -Name SunroomDimmerHoldBright + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2002" + } -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .05 + } -Name SunroomDimmerTapBright + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3002" + } -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement -.05 + } -Name SunroomDimmerTapDarken + .EXAMPLE + Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3003" + } -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement -.1 + } -Name SunroomDimmerHoldDarken #> [OutputType([PSObject])] + [CmdletBinding(SupportsShouldProcess)] [Diagnostics.CodeAnalysis.SuppressMessageAttribute("Test-ForSlowScript", "", Justification="Impact Incidental")] param( # The name of the rule. @@ -26,7 +76,11 @@ # The condition. # If the value is a ScriptBlock, only operators and their surrounding conext will be accepted. - [Parameter(Mandatory=$true,Position=1)] + # Each condition should take the form: `"/resource/id/restOfAddress" -operator "value"`. + # Rules may have more than one condition. + # If the address is not a resource followed by a digit, the resource will be looked up by name. + [Parameter(Mandatory,Position=1)] + [Alias('Conditions')] [PSObject[]] $Condition, @@ -64,17 +118,18 @@ } return $true })] - [Parameter(Mandatory=$true,Position=2)] + [Parameter(Mandatory,Position=2)] + [Alias('Actions')] [PSObject[]] $Action, # If provided, the schedule will only run on the bridge with a particular device ID - [Parameter(ValueFromPipelineByPropertyName=$true)] + [Parameter(ValueFromPipelineByPropertyName)] [string] $DeviceID, # If provided, the schedule will only run on the bridge found at the provided IP address - [Parameter(ValueFromPipelineByPropertyName=$true)] + [Parameter(ValueFromPipelineByPropertyName)] [Alias('IP')] [IPAddress] $IPAddress, @@ -85,7 +140,8 @@ ) begin { - $myCmd = $MyInvocation.MyCommand + $myCmd = $MyInvocation.MyCommand + $camelCaseSpace = [Regex]::new("(?<=[a-z])(?=[A-Z])") } process { @@ -127,23 +183,39 @@ $value = $value.ToString().ToLower() } - [PSCustomObject][Ordered]@{ - address =$address - operator = $tokens[$i].Content.TrimStart('-') - value = $value + if ($address -match '^/(?[^/]+)/(?\D[^/]+)/(?.+)$') { + $matchInfo = @{} + $matches + $getResourceSplat = @{ + "$($matches.R)" = $true + Name = $matches.N, $camelCaseSpace.Replace($matches.N, '?') + } + Get-HueBridge @getResourceSplat -WhatIf:$false | + ForEach-Object { + [PSCustomObject][Ordered]@{ + address = "/$($matchInfo.R)/$($_.Id)/$($matchInfo.M)" + operator = $tokens[$i].Content.TrimStart('-') + value = $value + } + } + } else { + [PSCustomObject][Ordered]@{ + address =$address + operator = $tokens[$i].Content.TrimStart('-') + value = $value + } } } } } else { foreach ($_ in $c) { - $ht = @{ + $ht = [Ordered]@{ address = $_.Address operator = $_.operator } if ($_.Value) { $ht.value = $_.value } - $ht + [PSCustomObject]$ht } } }) @@ -165,6 +237,9 @@ if ($func.Parameters.OutputInput) { $global:PSDefaultParameterValues["${func}:OutputInput"] = $true } + if ($func.Parameters.WhatIf) { + $global:PSDefaultParameterValues["${func}:WhatIf"] = $false + } } & $a | Select-Object @{ Name='address';Expression={ @@ -177,6 +252,9 @@ if ($func.Parameters.OutputInput) { $global:PSDefaultParameterValues.Remove("${func}:OutputInput") } + if ($func.Parameters.WhatIf) { + $global:PSDefaultParameterValues.Remove("${func}:WhatIf") + } } } else { $a | Select-Object @{Name='address';Expression={$_.Address}}, @@ -206,7 +284,7 @@ $true } | Send-HueBridge -Command "rules/$($RuleExists.ID)" -Method PUT -Data $restIn - + Get-HueRule -ID $RuleExists.ID } #endregion Create or Update Rule } diff --git a/Write-HueSensor.ps1 b/Functions/Hue/Write-HueSensor.ps1 similarity index 100% rename from Write-HueSensor.ps1 rename to Functions/Hue/Write-HueSensor.ps1 diff --git a/Connect-KeyLight.ps1 b/Functions/KeyLight/Connect-KeyLight.ps1 similarity index 100% rename from Connect-KeyLight.ps1 rename to Functions/KeyLight/Connect-KeyLight.ps1 diff --git a/Disconnect-KeyLight.ps1 b/Functions/KeyLight/Disconnect-KeyLight.ps1 similarity index 100% rename from Disconnect-KeyLight.ps1 rename to Functions/KeyLight/Disconnect-KeyLight.ps1 diff --git a/Get-KeyLight.ps1 b/Functions/KeyLight/Get-KeyLight.ps1 similarity index 100% rename from Get-KeyLight.ps1 rename to Functions/KeyLight/Get-KeyLight.ps1 diff --git a/Set-KeyLight.ps1 b/Functions/KeyLight/Set-KeyLight.ps1 similarity index 100% rename from Set-KeyLight.ps1 rename to Functions/KeyLight/Set-KeyLight.ps1 diff --git a/Connect-NanoLeaf.ps1 b/Functions/NanoLeaf/Connect-NanoLeaf.ps1 similarity index 100% rename from Connect-NanoLeaf.ps1 rename to Functions/NanoLeaf/Connect-NanoLeaf.ps1 diff --git a/Disconnect-NanoLeaf.ps1 b/Functions/NanoLeaf/Disconnect-NanoLeaf.ps1 similarity index 100% rename from Disconnect-NanoLeaf.ps1 rename to Functions/NanoLeaf/Disconnect-NanoLeaf.ps1 diff --git a/Find-NanoLeaf.ps1 b/Functions/NanoLeaf/Find-NanoLeaf.ps1 similarity index 100% rename from Find-NanoLeaf.ps1 rename to Functions/NanoLeaf/Find-NanoLeaf.ps1 diff --git a/Get-Nanoleaf.ps1 b/Functions/NanoLeaf/Get-Nanoleaf.ps1 similarity index 100% rename from Get-Nanoleaf.ps1 rename to Functions/NanoLeaf/Get-Nanoleaf.ps1 diff --git a/Functions/NanoLeaf/README.md b/Functions/NanoLeaf/README.md new file mode 100644 index 0000000..1325ee6 --- /dev/null +++ b/Functions/NanoLeaf/README.md @@ -0,0 +1,14 @@ +This directory contains LightScript's functions for [NanoLeaf](https://nanoleaf.me/). + + +|Name |Verb |Noun |Source | +|-------------------|----------|--------|--------------------------------------------------| +|Connect-Nanoleaf |Connect |Nanoleaf|[Connect-NanoLeaf.ps1](Connect-NanoLeaf.ps1) | +|Disconnect-Nanoleaf|Disconnect|Nanoleaf|[Disconnect-NanoLeaf.ps1](Disconnect-NanoLeaf.ps1)| +|Find-NanoLeaf |Find |NanoLeaf|[Find-NanoLeaf.ps1](Find-NanoLeaf.ps1) | +|Get-NanoLeaf |Get |NanoLeaf|[Get-Nanoleaf.ps1](Get-Nanoleaf.ps1) | +|Send-NanoLeaf |Send |NanoLeaf|[Send-NanoLeaf.ps1](Send-NanoLeaf.ps1) | +|Set-NanoLeaf |Set |NanoLeaf|[Set-NanoLeaf.ps1](Set-NanoLeaf.ps1) | +|Watch-NanoLeaf |Watch |NanoLeaf|[Watch-NanoLeaf.ps1](Watch-NanoLeaf.ps1) | + + diff --git a/Functions/NanoLeaf/README.ps1.md b/Functions/NanoLeaf/README.ps1.md new file mode 100644 index 0000000..520b452 --- /dev/null +++ b/Functions/NanoLeaf/README.ps1.md @@ -0,0 +1,15 @@ +This directory contains LightScript's functions for [NanoLeaf](https://nanoleaf.me/). + +~~~PipeScript { + Import-Module ../../LightScript.psd1 -Global + [PSCustomObject]@{ + Table = Get-Command -Module LightScript | + Where-Object { $_.ScriptBlock.File -like "$pwd*" } | + .Name .Verb .Noun .Source { + $relativePath = $_.ScriptBlock.File.Substring("$pwd".Length) -replace '^[\\/]' + "[$relativePath]($relativePath)" + } + } + +} +~~~ \ No newline at end of file diff --git a/Send-NanoLeaf.ps1 b/Functions/NanoLeaf/Send-NanoLeaf.ps1 similarity index 100% rename from Send-NanoLeaf.ps1 rename to Functions/NanoLeaf/Send-NanoLeaf.ps1 diff --git a/Set-NanoLeaf.ps1 b/Functions/NanoLeaf/Set-NanoLeaf.ps1 similarity index 100% rename from Set-NanoLeaf.ps1 rename to Functions/NanoLeaf/Set-NanoLeaf.ps1 diff --git a/Watch-NanoLeaf.ps1 b/Functions/NanoLeaf/Watch-NanoLeaf.ps1 similarity index 100% rename from Watch-NanoLeaf.ps1 rename to Functions/NanoLeaf/Watch-NanoLeaf.ps1 diff --git a/Connect-Pixoo.ps1 b/Functions/Pixoo/Connect-Pixoo.ps1 similarity index 100% rename from Connect-Pixoo.ps1 rename to Functions/Pixoo/Connect-Pixoo.ps1 diff --git a/Disconnect-Pixoo.ps1 b/Functions/Pixoo/Disconnect-Pixoo.ps1 similarity index 100% rename from Disconnect-Pixoo.ps1 rename to Functions/Pixoo/Disconnect-Pixoo.ps1 diff --git a/Get-Pixoo.ps1 b/Functions/Pixoo/Get-Pixoo.ps1 similarity index 100% rename from Get-Pixoo.ps1 rename to Functions/Pixoo/Get-Pixoo.ps1 diff --git a/Functions/Pixoo/README.md b/Functions/Pixoo/README.md new file mode 100644 index 0000000..a7ee260 --- /dev/null +++ b/Functions/Pixoo/README.md @@ -0,0 +1,11 @@ +This directory contains LightScript's functions for Divoom's [Pixoo64](https://www.divoom.com/products/pixoo-64). + + +|Name |Verb |Noun |Source | +|----------------|----------|-----|--------------------------------------------| +|Connect-Pixoo |Connect |Pixoo|[Connect-Pixoo.ps1](Connect-Pixoo.ps1) | +|Disconnect-Pixoo|Disconnect|Pixoo|[Disconnect-Pixoo.ps1](Disconnect-Pixoo.ps1)| +|Get-Pixoo |Get |Pixoo|[Get-Pixoo.ps1](Get-Pixoo.ps1) | +|Set-Pixoo |Set |Pixoo|[Set-Pixoo.ps1](Set-Pixoo.ps1) | + + diff --git a/Functions/Pixoo/README.ps1.md b/Functions/Pixoo/README.ps1.md new file mode 100644 index 0000000..1a24f4a --- /dev/null +++ b/Functions/Pixoo/README.ps1.md @@ -0,0 +1,15 @@ +This directory contains LightScript's functions for Divoom's [Pixoo64](https://www.divoom.com/products/pixoo-64). + +~~~PipeScript { + Import-Module ../../LightScript.psd1 -Global + [PSCustomObject]@{ + Table = Get-Command -Module LightScript | + Where-Object { $_.ScriptBlock.File -like "$pwd*" } | + .Name .Verb .Noun .Source { + $relativePath = $_.ScriptBlock.File.Substring("$pwd".Length) -replace '^[\\/]' + "[$relativePath]($relativePath)" + } + } + +} +~~~ \ No newline at end of file diff --git a/Set-Pixoo.ps1 b/Functions/Pixoo/Set-Pixoo.ps1 similarity index 100% rename from Set-Pixoo.ps1 rename to Functions/Pixoo/Set-Pixoo.ps1 diff --git a/Functions/README.md b/Functions/README.md new file mode 100644 index 0000000..607608a --- /dev/null +++ b/Functions/README.md @@ -0,0 +1,55 @@ +This directory and it's subdirectories contain the functions defined in LightScript. + + +|Name |Verb |Noun |Source | +|--------------------|----------|-----------|--------------------------------------------------------------------| +|Add-HueLight |Add |HueLight |[Hue/Add-HueLight.ps1](Hue/Add-HueLight.ps1) | +|Add-HueRoom |Add |HueRoom |[Hue/Add-HueRoom.ps1](Hue/Add-HueRoom.ps1) | +|Add-HueSchedule |Add |HueSchedule|[Hue/Add-HueSchedule.ps1](Hue/Add-HueSchedule.ps1) | +|Add-HueSensor |Add |HueSensor |[Hue/Add-HueSensor.ps1](Hue/Add-HueSensor.ps1) | +|Clear-Twinkly |Clear |Twinkly |[Twinkly/Clear-Twinkly.ps1](Twinkly/Clear-Twinkly.ps1) | +|Connect-HueBridge |Connect |HueBridge |[Hue/Connect-HueBridge.ps1](Hue/Connect-HueBridge.ps1) | +|Connect-KeyLight |Connect |KeyLight |[KeyLight/Connect-KeyLight.ps1](KeyLight/Connect-KeyLight.ps1) | +|Connect-Nanoleaf |Connect |Nanoleaf |[NanoLeaf/Connect-NanoLeaf.ps1](NanoLeaf/Connect-NanoLeaf.ps1) | +|Connect-Pixoo |Connect |Pixoo |[Pixoo/Connect-Pixoo.ps1](Pixoo/Connect-Pixoo.ps1) | +|Connect-Twinkly |Connect |Twinkly |[Twinkly/Connect-Twinkly.ps1](Twinkly/Connect-Twinkly.ps1) | +|Disconnect-HueBridge|Disconnect|HueBridge |[Hue/Disconnect-HueBridge.ps1](Hue/Disconnect-HueBridge.ps1) | +|Disconnect-KeyLight |Disconnect|KeyLight |[KeyLight/Disconnect-KeyLight.ps1](KeyLight/Disconnect-KeyLight.ps1)| +|Disconnect-Nanoleaf |Disconnect|Nanoleaf |[NanoLeaf/Disconnect-NanoLeaf.ps1](NanoLeaf/Disconnect-NanoLeaf.ps1)| +|Disconnect-Pixoo |Disconnect|Pixoo |[Pixoo/Disconnect-Pixoo.ps1](Pixoo/Disconnect-Pixoo.ps1) | +|Disconnect-Twinkly |Disconnect|Twinkly |[Twinkly/Disconnect-Twinkly.ps1](Twinkly/Disconnect-Twinkly.ps1) | +|Find-HueBridge |Find |HueBridge |[Hue/Find-HueBridge.ps1](Hue/Find-HueBridge.ps1) | +|Find-NanoLeaf |Find |NanoLeaf |[NanoLeaf/Find-NanoLeaf.ps1](NanoLeaf/Find-NanoLeaf.ps1) | +|Get-HueBridge |Get |HueBridge |[Hue/Get-HueBridge.ps1](Hue/Get-HueBridge.ps1) | +|Get-HueLight |Get |HueLight |[Hue/Get-HueLight.ps1](Hue/Get-HueLight.ps1) | +|Get-HueResource |Get |HueResource|[Hue/Get-HueResource.ps1](Hue/Get-HueResource.ps1) | +|Get-HueRoom |Get |HueRoom |[Hue/Get-HueRoom.ps1](Hue/Get-HueRoom.ps1) | +|Get-HueRule |Get |HueRule |[Hue/Get-HueRule.ps1](Hue/Get-HueRule.ps1) | +|Get-HueScene |Get |HueScene |[Hue/Get-HueScene.ps1](Hue/Get-HueScene.ps1) | +|Get-HueSchedule |Get |HueSchedule|[Hue/Get-HueSchedule.ps1](Hue/Get-HueSchedule.ps1) | +|Get-HueSensor |Get |HueSensor |[Hue/Get-HueSensor.ps1](Hue/Get-HueSensor.ps1) | +|Get-KeyLight |Get |KeyLight |[KeyLight/Get-KeyLight.ps1](KeyLight/Get-KeyLight.ps1) | +|Get-NanoLeaf |Get |NanoLeaf |[NanoLeaf/Get-Nanoleaf.ps1](NanoLeaf/Get-Nanoleaf.ps1) | +|Get-Pixoo |Get |Pixoo |[Pixoo/Get-Pixoo.ps1](Pixoo/Get-Pixoo.ps1) | +|Get-Twinkly |Get |Twinkly |[Twinkly/Get-Twinkly.ps1](Twinkly/Get-Twinkly.ps1) | +|Read-HueSensor |Read |HueSensor |[Hue/Read-HueSensor.ps1](Hue/Read-HueSensor.ps1) | +|Remove-HueResource |Remove |HueResource|[Hue/Remove-HueResource.ps1](Hue/Remove-HueResource.ps1) | +|Remove-HueRoom |Remove |HueRoom |[Hue/Remove-HueRoom.ps1](Hue/Remove-HueRoom.ps1) | +|Remove-HueRule |Remove |HueRule |[Hue/Remove-HueRule.ps1](Hue/Remove-HueRule.ps1) | +|Remove-HueScene |Remove |HueScene |[Hue/Remove-HueScene.ps1](Hue/Remove-HueScene.ps1) | +|Remove-HueSchedule |Remove |HueSchedule|[Hue/Remove-HueSchedule.ps1](Hue/Remove-HueSchedule.ps1) | +|Remove-HueSensor |Remove |HueSensor |[Hue/Remove-HueSensor.ps1](Hue/Remove-HueSensor.ps1) | +|Rename-HueLight |Rename |HueLight |[Hue/Rename-HueLight.ps1](Hue/Rename-HueLight.ps1) | +|Rename-HueSensor |Rename |HueSensor |[Hue/Rename-HueSensor.ps1](Hue/Rename-HueSensor.ps1) | +|Send-HueBridge |Send |HueBridge |[Hue/Send-HueBridge.ps1](Hue/Send-HueBridge.ps1) | +|Send-NanoLeaf |Send |NanoLeaf |[NanoLeaf/Send-NanoLeaf.ps1](NanoLeaf/Send-NanoLeaf.ps1) | +|Set-HueLight |Set |HueLight |[Hue/Set-HueLight.ps1](Hue/Set-HueLight.ps1) | +|Set-HueRule |Set |HueRule |[Hue/Set-HueRule.ps1](Hue/Set-HueRule.ps1) | +|Set-KeyLight |Set |KeyLight |[KeyLight/Set-KeyLight.ps1](KeyLight/Set-KeyLight.ps1) | +|Set-NanoLeaf |Set |NanoLeaf |[NanoLeaf/Set-NanoLeaf.ps1](NanoLeaf/Set-NanoLeaf.ps1) | +|Set-Pixoo |Set |Pixoo |[Pixoo/Set-Pixoo.ps1](Pixoo/Set-Pixoo.ps1) | +|Set-Twinkly |Set |Twinkly |[Twinkly/Set-Twinkly.ps1](Twinkly/Set-Twinkly.ps1) | +|Watch-NanoLeaf |Watch |NanoLeaf |[NanoLeaf/Watch-NanoLeaf.ps1](NanoLeaf/Watch-NanoLeaf.ps1) | +|Write-HueSensor |Write |HueSensor |[Hue/Write-HueSensor.ps1](Hue/Write-HueSensor.ps1) | + + diff --git a/Functions/README.ps1.md b/Functions/README.ps1.md new file mode 100644 index 0000000..8ed09f5 --- /dev/null +++ b/Functions/README.ps1.md @@ -0,0 +1,15 @@ +This directory and it's subdirectories contain the functions defined in LightScript. + +~~~PipeScript { + Import-Module ../LightScript.psd1 -Global + [PSCustomObject]@{ + Table = Get-Command -Module LightScript | + Where-Object { $_.ScriptBlock.File -like "$pwd*" } | + .Name .Verb .Noun .Source { + $relativePath = $_.ScriptBlock.File.Substring("$pwd".Length) -replace '^[\\/]' + "[$relativePath]($relativePath)" + } + } + +} +~~~ \ No newline at end of file diff --git a/Clear-Twinkly.ps1 b/Functions/Twinkly/Clear-Twinkly.ps1 similarity index 100% rename from Clear-Twinkly.ps1 rename to Functions/Twinkly/Clear-Twinkly.ps1 diff --git a/Connect-Twinkly.ps1 b/Functions/Twinkly/Connect-Twinkly.ps1 similarity index 100% rename from Connect-Twinkly.ps1 rename to Functions/Twinkly/Connect-Twinkly.ps1 diff --git a/Disconnect-Twinkly.ps1 b/Functions/Twinkly/Disconnect-Twinkly.ps1 similarity index 100% rename from Disconnect-Twinkly.ps1 rename to Functions/Twinkly/Disconnect-Twinkly.ps1 diff --git a/Get-Twinkly.ps1 b/Functions/Twinkly/Get-Twinkly.ps1 similarity index 100% rename from Get-Twinkly.ps1 rename to Functions/Twinkly/Get-Twinkly.ps1 diff --git a/Functions/Twinkly/README.md b/Functions/Twinkly/README.md new file mode 100644 index 0000000..cd8465f --- /dev/null +++ b/Functions/Twinkly/README.md @@ -0,0 +1,12 @@ +This directory contains LightScript's functions for [Twinkly](https://www.twinkly.com/) lights. + + +|Name |Verb |Noun |Source | +|------------------|----------|-------|------------------------------------------------| +|Clear-Twinkly |Clear |Twinkly|[Clear-Twinkly.ps1](Clear-Twinkly.ps1) | +|Connect-Twinkly |Connect |Twinkly|[Connect-Twinkly.ps1](Connect-Twinkly.ps1) | +|Disconnect-Twinkly|Disconnect|Twinkly|[Disconnect-Twinkly.ps1](Disconnect-Twinkly.ps1)| +|Get-Twinkly |Get |Twinkly|[Get-Twinkly.ps1](Get-Twinkly.ps1) | +|Set-Twinkly |Set |Twinkly|[Set-Twinkly.ps1](Set-Twinkly.ps1) | + + diff --git a/Functions/Twinkly/README.ps1.md b/Functions/Twinkly/README.ps1.md new file mode 100644 index 0000000..b821338 --- /dev/null +++ b/Functions/Twinkly/README.ps1.md @@ -0,0 +1,15 @@ +This directory contains LightScript's functions for [Twinkly](https://www.twinkly.com/) lights. + +~~~PipeScript { + Import-Module ../../LightScript.psd1 -Global + [PSCustomObject]@{ + Table = Get-Command -Module LightScript | + Where-Object { $_.ScriptBlock.File -like "$pwd*" } | + .Name .Verb .Noun .Source { + $relativePath = $_.ScriptBlock.File.Substring("$pwd".Length) -replace '^[\\/]' + "[$relativePath]($relativePath)" + } + } + +} +~~~ \ No newline at end of file diff --git a/Set-Twinkly.ps1 b/Functions/Twinkly/Set-Twinkly.ps1 similarity index 100% rename from Set-Twinkly.ps1 rename to Functions/Twinkly/Set-Twinkly.ps1 diff --git a/LightScript.psd1 b/LightScript.psd1 index ca1e4d7..4c011cc 100644 --- a/LightScript.psd1 +++ b/LightScript.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.2.4.1' + ModuleVersion = '0.2.5' RootModule = 'LightScript.psm1' Description = 'Smarter Lighting with PowerShell' FormatsToProcess = 'LightScript.format.ps1xml' @@ -14,19 +14,29 @@ LicenseURI = 'https://github.com/StartAutomating/LightScript/blob/main/LICENSE' IconURI = 'https://github.com/StartAutomating/LightScript/blob/main/Assets/LightScript.png' ReleaseNotes = @' -## 0.2.4.1 +## 0.2.5: +* Set-HueRule: Easier conditions (Fixes #28) and plural aliases (Fixes #31) +* Adding Rename-HueSensor (Fixes #26). +* Rename-HueLight: Adding [Alias('ID')] to -OldName (Fixes #27) +* Get-HueBridge: SupportShouldProcess (Fixes #30) +* Set-HueLight: Fixing -Brightness/SaturationIncrement (Fixes #29) +* Add-HueSensor: Adding -New (Fixes #25) +* Improved Repository Organization (Fixes #32) +--- + +## 0.2.4.1: * Adding help for Add-HueLight (#23) * Fixing other markdown documentation layout issues --- -## 0.2.4 +## 0.2.4: * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) * Fixing Rename-HueLight (#19) * Building LightScript with PipeScript (#20) --- -## 0.2.3 +## 0.2.3: * Set-NanoLeaf: Fixing #17 * Send-HueBridge: Adding logging * Automatically documentating module (#13) @@ -36,10 +46,10 @@ * Fixing -Hue/-HueIncrement (#15) --- -## 0.2.2 +## 0.2.2: Adding KeyLight: Connect-KeyLight, Get-KeyLight, Set-KeyLight, Disconnect-KeyLight --- -## 0.2.1 +## 0.2.1: * Set-NanoLeaf: Adding -EffectOption parameter help (#9). Adding examples. * Set-NanoLeaf: Fixing Brightness (#7). Adding Tab Completion (#8). Adding Examples --- diff --git a/docs/Add-HueLight.md b/docs/Add-HueLight.md index 965528b..e016757 100644 --- a/docs/Add-HueLight.md +++ b/docs/Add-HueLight.md @@ -12,7 +12,13 @@ Adds new lights to a Hue Bridge. --- ### Related Links * [Get-HueLight](Get-HueLight.md) + + + * [Set-HueLight](Set-HueLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -40,9 +46,16 @@ Use this parameter when adding lights that have already been assigned to another -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |1 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. diff --git a/docs/Add-HueRoom.md b/docs/Add-HueRoom.md index 2d0fb75..6898866 100644 --- a/docs/Add-HueRoom.md +++ b/docs/Add-HueRoom.md @@ -12,7 +12,13 @@ Adds Hue rooms, groups, or entertainment areas to a Hue Bridge. --- ### Related Links * [Get-HueRoom](Get-HueRoom.md) + + + * [Remove-HueRoom](Remove-HueRoom.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ The name of the Room or Light Group. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -38,9 +51,16 @@ The name of the lights that will be added to the room -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **LightID** @@ -48,9 +68,16 @@ One or more identifiers for lights -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **AutoGroup** @@ -58,9 +85,16 @@ If set, will automatically group lights with a similar name as the room. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RoomType** @@ -92,9 +126,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GroupType** @@ -112,12 +153,21 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Add-HueSchedule.md b/docs/Add-HueSchedule.md index 17e7a0c..1fd89f8 100644 --- a/docs/Add-HueSchedule.md +++ b/docs/Add-HueSchedule.md @@ -12,7 +12,13 @@ Adds a new schedule to a Hue Bridge --- ### Related Links * [Get-HueSchedule](Get-HueSchedule.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ The name of the schedule -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Description** @@ -38,9 +51,16 @@ A description for the schedule -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Command** @@ -48,9 +68,16 @@ The command that will be run -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|true |named |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **LocalTime** @@ -58,9 +85,16 @@ The time of the command -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[DateTime]```|true |1 |true (ByPropertyName)| +> **Type**: ```[DateTime]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Daily** @@ -68,9 +102,16 @@ If set, will run daily -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |2 |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DayOfWeek** @@ -78,9 +119,16 @@ The days of the week the schedule will be executed (1 is Sunday, 7 is Saturday). -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Byte[]]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Byte[]]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **For** @@ -88,9 +136,16 @@ The time the schedule should last -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|false |4 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **In** @@ -98,9 +153,16 @@ Sets a countdown timer. This timer will occur once, in a given timespan. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|true |1 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Every** @@ -108,9 +170,16 @@ If set, will repeat every N timeframe -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|true |1 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Within** @@ -118,9 +187,16 @@ If provided, the schedule will execute at a random time within the provided time -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|false |5 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DeviceID** @@ -128,9 +204,16 @@ If provided, the schedule will only run on the bridge with a particular device I -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IPAddress** @@ -138,12 +221,21 @@ If provided, the schedule will only run on the bridge found at the provided IP a -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|false |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Add-HueSensor.md b/docs/Add-HueSensor.md index 9f78774..b75dacb 100644 --- a/docs/Add-HueSensor.md +++ b/docs/Add-HueSensor.md @@ -13,6 +13,9 @@ Sensors can be physical sensors, such as a motion detector, or virtual sensors, --- ### Related Links * [Get-HueSensor](Get-HueSensor.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +31,16 @@ The name of the sensor. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SensorType** @@ -62,9 +72,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ModelID** @@ -72,9 +89,16 @@ The sensor ModelID -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Manufacturer** @@ -82,9 +106,16 @@ The sensor manufacturer -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **UniqueID** @@ -92,9 +123,16 @@ The sensor unique ID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |4 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Version** @@ -102,9 +140,33 @@ The sensor version. -|Type |Requried|Postion|PipelineInput | -|---------------|--------|-------|---------------------| -|```[Version]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Version]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **New** + +If set, will search for new sensors to add. + + + +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -120,7 +182,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- @@ -128,6 +192,9 @@ System.Management.Automation.PSObject ```PowerShell Add-HueSensor [-Name] [-SensorType] [[-ModelID] ] [[-Manufacturer] ] [[-UniqueID] ] [[-Version] ] [-WhatIf] [-Confirm] [] ``` +```PowerShell +Add-HueSensor -New [-WhatIf] [-Confirm] [] +``` --- diff --git a/docs/Assets/LightScript.png b/docs/Assets/LightScript.png index eef09f3..aef1d44 100644 Binary files a/docs/Assets/LightScript.png and b/docs/Assets/LightScript.png differ diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index fe9e50e..ce5094f 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,9 +1,18 @@ +## 0.2.5: +* Set-HueRule: Easier conditions (Fixes #28) and plural aliases (Fixes #31) +* Adding Rename-HueSensor (Fixes #26). +* Rename-HueLight: Adding [Alias('ID')] to -OldName (Fixes #27) +* Get-HueBridge: SupportShouldProcess (Fixes #30) +* Set-HueLight: Fixing -Brightness/SaturationIncrement (Fixes #29) +* Add-HueSensor: Adding -New (Fixes #25) +* Improved Repository Organization (Fixes #32) +--- + ## 0.2.4.1 * Adding help for Add-HueLight (#23) * Fixing other markdown documentation layout issues --- - ## 0.2.4 * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) @@ -40,3 +49,4 @@ Adding Pixoo commands: Connect/Disconnect/Get/Set-Pixoo (#4) Initial Release of LightScript: Smarter Lighting with PowerShell Script your Hue Bridge, NanoLeaf, or Twinkly lights. + diff --git a/docs/Clear-Twinkly.md b/docs/Clear-Twinkly.md index 3aacba1..2482b90 100644 --- a/docs/Clear-Twinkly.md +++ b/docs/Clear-Twinkly.md @@ -14,6 +14,9 @@ This clears the stored movies and playlists --- ### Related Links * [Get-Twinkly](Get-Twinkly.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +32,16 @@ One or more IP Addresses of Twinkly devices. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -47,10 +57,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Connect-HueBridge.md b/docs/Connect-HueBridge.md index aa14cae..cc1bec7 100644 --- a/docs/Connect-HueBridge.md +++ b/docs/Connect-HueBridge.md @@ -19,7 +19,13 @@ Then run this command within the next 30 seconds. --- ### Related Links * [Find-HueBridge](Find-HueBridge.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -35,15 +41,24 @@ The IP Address of the Hue Bridge -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Connect-KeyLight.md b/docs/Connect-KeyLight.md index 8f5e05a..0ad2852 100644 --- a/docs/Connect-KeyLight.md +++ b/docs/Connect-KeyLight.md @@ -12,6 +12,9 @@ Connects to a Elgato Key Lighting over Wifi --- ### Related Links * [Get-KeyLight](Get-KeyLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -37,15 +47,24 @@ If set, will output the connection information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Connect-Nanoleaf.md b/docs/Connect-Nanoleaf.md index 6d09a75..6b1c86e 100644 --- a/docs/Connect-Nanoleaf.md +++ b/docs/Connect-Nanoleaf.md @@ -17,7 +17,13 @@ nanoleaf controller lights flash in sequence. Then run this command within the --- ### Related Links * [Find-NanoLeaf](Find-NanoLeaf.md) + + + * [Get-NanoLeaf](Get-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -33,15 +39,24 @@ The IP Address of the Nanoleaf -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Connect-Pixoo.md b/docs/Connect-Pixoo.md index 867059a..be72c77 100644 --- a/docs/Connect-Pixoo.md +++ b/docs/Connect-Pixoo.md @@ -12,6 +12,9 @@ Connects to a Pixoo over Wifi --- ### Related Links * [Get-Pixoo](Get-Pixoo.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -37,15 +47,24 @@ If set, will output the connection information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Connect-Twinkly.md b/docs/Connect-Twinkly.md index d64e664..1339159 100644 --- a/docs/Connect-Twinkly.md +++ b/docs/Connect-Twinkly.md @@ -12,6 +12,9 @@ Connects to a Twinkly light controller --- ### Related Links * [Get-Twinkly](Get-Twinkly.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -37,15 +47,24 @@ If set, will output the connection information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Disconnect-HueBridge.md b/docs/Disconnect-HueBridge.md index 7d0cac9..1e5cb33 100644 --- a/docs/Disconnect-HueBridge.md +++ b/docs/Disconnect-HueBridge.md @@ -12,6 +12,9 @@ Disconnects a new Hue Bridge and removes connection information. --- ### Related Links * [Connect-HueBridge](Connect-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,15 +30,24 @@ The IP Address of the Hue Bridge -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Disconnect-KeyLight.md b/docs/Disconnect-KeyLight.md index 349d2ef..fd9e01b 100644 --- a/docs/Disconnect-KeyLight.md +++ b/docs/Disconnect-KeyLight.md @@ -12,6 +12,9 @@ Disconnects a Elgato Key Lighting, removing stored device info --- ### Related Links * [Connect-KeyLight](Connect-KeyLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -45,10 +55,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Disconnect-Nanoleaf.md b/docs/Disconnect-Nanoleaf.md index 8f3f2b4..08ce4a1 100644 --- a/docs/Disconnect-Nanoleaf.md +++ b/docs/Disconnect-Nanoleaf.md @@ -12,6 +12,9 @@ Disconnnects a new Nanoleaf controller and removes connection information. --- ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address of the Nanoleaf -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -45,10 +55,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Disconnect-Pixoo.md b/docs/Disconnect-Pixoo.md index 0dd2a4a..4cbab7c 100644 --- a/docs/Disconnect-Pixoo.md +++ b/docs/Disconnect-Pixoo.md @@ -12,6 +12,9 @@ Disconnects a Pixoo, removing stored device info --- ### Related Links * [Connect-Pixoo](Connect-Pixoo.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -45,10 +55,12 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Disconnect-Twinkly.md b/docs/Disconnect-Twinkly.md index b41d234..f4809b9 100644 --- a/docs/Disconnect-Twinkly.md +++ b/docs/Disconnect-Twinkly.md @@ -12,6 +12,9 @@ Disconnects a Twinkly light controller --- ### Related Links * [Connect-Twinkly](Connect-Twinkly.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PassThru** @@ -37,15 +47,24 @@ If set, will output the connection information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Nullable +* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable) + + +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) -System.Management.Automation.PSObject --- diff --git a/docs/Find-HueBridge.md b/docs/Find-HueBridge.md index e4b783a..fec1b63 100644 --- a/docs/Find-HueBridge.md +++ b/docs/Find-HueBridge.md @@ -12,6 +12,9 @@ Finds Hue Bridges on the local area network, using https://discovery.meethue.com --- ### Related Links * [Connect-HueBridge](Connect-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -21,7 +24,9 @@ Find-HueBridge --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Find-NanoLeaf.md b/docs/Find-NanoLeaf.md index 3ffee26..7e44c17 100644 --- a/docs/Find-NanoLeaf.md +++ b/docs/Find-NanoLeaf.md @@ -12,6 +12,9 @@ Finds NanoLeaf controllers on your local area network, using SSDP. --- ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The search timeout, in seconds. Increase this number on slower networks. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |1 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Force** @@ -38,9 +48,16 @@ Otherwise, the most recent cached result will be returned. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DeviceType** @@ -49,12 +66,21 @@ Changing this value is unlikely to find any NanoLeaf controllers, but you can se -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -Roku.BasicInfo +* Roku.BasicInfo + + --- diff --git a/docs/Get-HueBridge.md b/docs/Get-HueBridge.md index 8ea6d1d..483c04d 100644 --- a/docs/Get-HueBridge.md +++ b/docs/Get-HueBridge.md @@ -12,7 +12,13 @@ Gets Hue Bridges registered on the system, and gets Hue bridge resources. --- ### Related Links * [Find-HueBridge](Find-HueBridge.md) + + + * [Join-HueBridge](Join-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -38,9 +51,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -48,9 +68,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -58,9 +85,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -68,9 +102,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -78,9 +119,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -88,9 +136,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -98,9 +153,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -108,9 +170,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -118,9 +187,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -128,9 +204,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -138,9 +221,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -148,9 +238,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -158,45 +255,67 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + +--- +#### **WhatIf** +-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-WhatIf is used to see what would happen, or return operations without executing them +#### **Confirm** +-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-Confirm is used to -Confirm each operation. + +If you pass ```-Confirm:$false``` you will not be prompted. + + +If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- ### Syntax ```PowerShell -Get-HueBridge [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Schedule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Schedule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Rule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Rule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Scene [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Scene [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Sensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Sensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Group [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Group [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Configuration [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Configuration [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Capability [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Capability [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ```PowerShell -Get-HueBridge -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] +Get-HueBridge -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` --- diff --git a/docs/Get-HueLight.md b/docs/Get-HueLight.md index eda58dc..8a70b9c 100644 --- a/docs/Get-HueLight.md +++ b/docs/Get-HueLight.md @@ -12,6 +12,9 @@ Gets Hue lights from the Hue Bridge. --- ### Related Links * [Get-HueBridge](Get-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The name of the light -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|true |1 |false | +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **RegularExpression** @@ -37,9 +47,16 @@ If set, will match patterns as regular expressions -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ExactMatch** @@ -47,9 +64,16 @@ If set, will only match exact text -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Room** @@ -57,9 +81,16 @@ The name of the room. -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|true |named |false | +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **LightID** @@ -67,9 +98,16 @@ The light ID. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|true |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **New** @@ -77,12 +115,21 @@ If set, will get recently added lights. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueResource.md b/docs/Get-HueResource.md index a91c400..a694bec 100644 --- a/docs/Get-HueResource.md +++ b/docs/Get-HueResource.md @@ -12,8 +12,17 @@ Gets ResourceLinks from one or more Hue Bridges --- ### Related Links * [Remove-HueResource](Remove-HueResource.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueRoom.md b/docs/Get-HueRoom.md index a4402de..21eb88f 100644 --- a/docs/Get-HueRoom.md +++ b/docs/Get-HueRoom.md @@ -12,8 +12,17 @@ Gets Groups from one or more Hue Bridges --- ### Related Links * [Remove-HueRoom](Remove-HueRoom.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueRule.md b/docs/Get-HueRule.md index b4ccf65..e2ba5c5 100644 --- a/docs/Get-HueRule.md +++ b/docs/Get-HueRule.md @@ -12,8 +12,17 @@ Gets Rules from one or more Hue Bridges --- ### Related Links * [Remove-HueRule](Remove-HueRule.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueScene.md b/docs/Get-HueScene.md index 73f8ffe..ac72507 100644 --- a/docs/Get-HueScene.md +++ b/docs/Get-HueScene.md @@ -12,8 +12,17 @@ Gets Scenes from one or more Hue Bridges --- ### Related Links * [Remove-HueScene](Remove-HueScene.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueSchedule.md b/docs/Get-HueSchedule.md index 0ac3cb3..e7b3973 100644 --- a/docs/Get-HueSchedule.md +++ b/docs/Get-HueSchedule.md @@ -12,8 +12,17 @@ Gets Schedules from one or more Hue Bridges --- ### Related Links * [Remove-HueSchedule](Remove-HueSchedule.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-HueSensor.md b/docs/Get-HueSensor.md index 6e6c137..5ccdd78 100644 --- a/docs/Get-HueSensor.md +++ b/docs/Get-HueSensor.md @@ -12,8 +12,17 @@ Gets Sensors from one or more Hue Bridges --- ### Related Links * [Remove-HueSensor](Remove-HueSensor.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-KeyLight.md b/docs/Get-KeyLight.md index a4e2fcd..7850491 100644 --- a/docs/Get-KeyLight.md +++ b/docs/Get-KeyLight.md @@ -12,7 +12,13 @@ Gets saved Elgato Key Lighting Devices --- ### Related Links * [Connect-KeyLight](Connect-KeyLight.md) + + + * [Set-KeyLight](Set-KeyLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Syntax ```PowerShell diff --git a/docs/Get-NanoLeaf.md b/docs/Get-NanoLeaf.md index 1c910e9..3ccf340 100644 --- a/docs/Get-NanoLeaf.md +++ b/docs/Get-NanoLeaf.md @@ -14,7 +14,13 @@ Can also get effects --- ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) + + + * [Set-NanoLeaf](Set-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -30,9 +36,16 @@ The IP Address of the NanoLeaf controller. -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NanoLeafToken** @@ -40,9 +53,16 @@ The nanoleaf authorization token. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Panel** @@ -50,9 +70,16 @@ If set, will get information about NanoLeaf panels. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Layout** @@ -60,9 +87,16 @@ If set, will get information about NanoLeaf layout. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EffectName** @@ -70,9 +104,16 @@ If provided, will get information about a particular NanoLeaf effect -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ListPlugin** @@ -80,9 +121,16 @@ If provided, will get information about the plugins available to use in Nanoleaf -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **PluginType** @@ -98,9 +146,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |named |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ListEffectName** @@ -108,9 +163,16 @@ If set, will return a string list of effect names. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **ListEffect** @@ -118,9 +180,16 @@ If set, will return a string list of effect names. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **CurrentEffect** @@ -128,9 +197,16 @@ If set, will display information about the current effect. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Force** @@ -138,12 +214,21 @@ If set, will refresh connections to all nanoleafs -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Get-Pixoo.md b/docs/Get-Pixoo.md index 75da66f..13c40e5 100644 --- a/docs/Get-Pixoo.md +++ b/docs/Get-Pixoo.md @@ -12,7 +12,13 @@ Gets saved Pixoo Devices --- ### Related Links * [Connect-Pixoo](Connect-Pixoo.md) + + + * [Set-Pixoo](Set-Pixoo.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ The IP Address for the Twinkly device. This can be discovered thru the phone us -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Syntax ```PowerShell diff --git a/docs/Get-Twinkly.md b/docs/Get-Twinkly.md index d760185..e90d66c 100644 --- a/docs/Get-Twinkly.md +++ b/docs/Get-Twinkly.md @@ -12,6 +12,9 @@ Gets Twinkly lights. --- ### Related Links * [Connect-Twinkly](Connect-Twinkly.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ One or more IP Addresses of Twinkly devices. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **OperationMode** @@ -37,9 +47,16 @@ If set, will get the operation mode -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Layout** @@ -47,9 +64,16 @@ If set, will get the layout of the Twinkly lights. This may take a bit. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CurrentColor** @@ -57,9 +81,16 @@ If set, will get the color displayed when the Twinkly lights are in color mode. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ListEffect** @@ -67,9 +98,16 @@ If set, will list the available effects. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CurrentEffect** @@ -77,9 +115,16 @@ If set, will show the current effect. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -87,9 +132,16 @@ If set, will list the configuration of each LED. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Brightness** @@ -97,9 +149,16 @@ If set, will output the brightness levels. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Saturation** @@ -107,9 +166,16 @@ If set, will output the saturation levels. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ListMovie** @@ -117,9 +183,16 @@ If set, will output the list of movies. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CurrentMovie** @@ -127,9 +200,16 @@ If set, will output the list of movies. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieConfiguration** @@ -137,9 +217,16 @@ If set, will output movie configuration. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Playlist** @@ -147,9 +234,16 @@ If set, will output the playlists. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CurrentPlaylistItem** @@ -157,9 +251,16 @@ If set, will output the current playlist item. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MQTTConfiguration** @@ -167,9 +268,16 @@ If set, will output the MQTT configuration. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Summary** @@ -177,9 +285,16 @@ If set, will output the summary. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NetworkStatus** @@ -187,9 +302,16 @@ If set, will output the network status. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **FirmwareVersion** @@ -197,9 +319,16 @@ If set, will output the network status. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Timer** @@ -207,12 +336,21 @@ If set, will output timers associated with each device. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/README.md b/docs/README.md index d49f36f..b22b31b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -
+

Smarter Lighting with PowerShell

@@ -296,3 +296,6 @@ Set-KeyLight -ColorTemperature 270 -Brightness 0.25 # Turn on and change the brightness at the same time: Set-KeyLight -On -Brightness 0.25 ~~~ + + + diff --git a/docs/Read-HueSensor.md b/docs/Read-HueSensor.md index 1a7c6c7..0a2557b 100644 --- a/docs/Read-HueSensor.md +++ b/docs/Read-HueSensor.md @@ -12,10 +12,25 @@ Reads Sensors values from the Hue Bridge --- ### Related Links * [Write-HueSensor](Write-HueSensor.md) + + + * [Get-HueSensor](Get-HueSensor.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Add-HueSensor](Add-HueSensor.md) + + + * [Remove-HueSensor](Remove-HueSensor.md) + + + --- ### Examples #### EXAMPLE 1 @@ -31,9 +46,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -41,9 +63,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -51,9 +80,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -61,9 +97,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Config** @@ -71,12 +114,21 @@ If set, will read values from the configuration. By default, values are read fr -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueResource.md b/docs/Remove-HueResource.md index e2a5cd0..ca1d96f 100644 --- a/docs/Remove-HueResource.md +++ b/docs/Remove-HueResource.md @@ -12,8 +12,17 @@ Removes ResourceLinks from one or more Hue Bridges --- ### Related Links * [Get-HueResource](Get-HueResource.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueRoom.md b/docs/Remove-HueRoom.md index 7151c3b..fd42966 100644 --- a/docs/Remove-HueRoom.md +++ b/docs/Remove-HueRoom.md @@ -12,8 +12,17 @@ Removes Groups from one or more Hue Bridges --- ### Related Links * [Get-HueRoom](Get-HueRoom.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueRule.md b/docs/Remove-HueRule.md index 86bde69..92a337b 100644 --- a/docs/Remove-HueRule.md +++ b/docs/Remove-HueRule.md @@ -12,8 +12,17 @@ Removes Rules from one or more Hue Bridges --- ### Related Links * [Get-HueRule](Get-HueRule.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueScene.md b/docs/Remove-HueScene.md index 5ef0d40..8fd2b12 100644 --- a/docs/Remove-HueScene.md +++ b/docs/Remove-HueScene.md @@ -12,8 +12,17 @@ Removes Scenes from one or more Hue Bridges --- ### Related Links * [Get-HueScene](Get-HueScene.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueSchedule.md b/docs/Remove-HueSchedule.md index d97633b..6e3f560 100644 --- a/docs/Remove-HueSchedule.md +++ b/docs/Remove-HueSchedule.md @@ -12,8 +12,17 @@ Removes Schedules from one or more Hue Bridges --- ### Related Links * [Get-HueSchedule](Get-HueSchedule.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Remove-HueSensor.md b/docs/Remove-HueSensor.md index 45e9785..385693c 100644 --- a/docs/Remove-HueSensor.md +++ b/docs/Remove-HueSensor.md @@ -12,8 +12,17 @@ Removes Sensors from one or more Hue Bridges --- ### Related Links * [Get-HueSensor](Get-HueSensor.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -39,9 +55,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -49,9 +72,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -59,9 +89,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -77,7 +114,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Rename-HueLight.md b/docs/Rename-HueLight.md index 331afa2..60f8fce 100644 --- a/docs/Rename-HueLight.md +++ b/docs/Rename-HueLight.md @@ -12,7 +12,13 @@ Renames one or more Hue lights. --- ### Related Links * [Get-HueBridge](Get-HueBridge.md) + + + * [Get-HueLight](Get-HueLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ The old name of the light. This can be a wildcard or regular expression. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NewName** @@ -38,12 +51,21 @@ The new name of the light. A number sign will be replaced with the match number -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Rename-HueSensor.md b/docs/Rename-HueSensor.md new file mode 100644 index 0000000..71efaf7 --- /dev/null +++ b/docs/Rename-HueSensor.md @@ -0,0 +1,78 @@ + +Rename-HueSensor +---------------- +### Synopsis +Renames Hue Sensors + +--- +### Description + +Renames one or more Hue Sensors. + +--- +### Related Links +* [Get-HueBridge](Get-HueBridge.md) + + + +* [Get-HueSensor](Get-HueSensor.md) + + + +--- +### Examples +#### EXAMPLE 1 +```PowerShell +Rename-HueSensor +``` + +--- +### Parameters +#### **OldName** + +The old name of the Sensor. This can be a wildcard or regular expression. + + + +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +#### **NewName** + +The new name of the Sensor. A number sign will be replaced with the match number. + + + +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + +--- +### Outputs +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + + + +--- +### Syntax +```PowerShell +Rename-HueSensor [-OldName] [-NewName] [] +``` +--- + + diff --git a/docs/Send-HueBridge.md b/docs/Send-HueBridge.md index 92f3ade..bb69b35 100644 --- a/docs/Send-HueBridge.md +++ b/docs/Send-HueBridge.md @@ -12,6 +12,9 @@ Sends messages to a Hue Bridge --- ### Related Links * [Get-HueBridge](Get-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP address of the hue bridge. -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **HueUserName** @@ -37,9 +47,16 @@ The hue user name -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Command** @@ -47,9 +64,16 @@ The command being sent to the bridge. This is a partial URI. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Body** @@ -58,9 +82,16 @@ If this data is not a string, it will be converted to JSON. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |4 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Method** @@ -68,9 +99,16 @@ The HTTP method. By default, Get. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |5 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **OutputInput** @@ -79,9 +117,16 @@ This is useful for creating scheudles, routines, and other macros. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PSTypeName** @@ -90,9 +135,16 @@ This enables the PowerShell types and formatting systems. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |6 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -108,7 +160,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Send-NanoLeaf.md b/docs/Send-NanoLeaf.md index 8ebddb0..b42f2fd 100644 --- a/docs/Send-NanoLeaf.md +++ b/docs/Send-NanoLeaf.md @@ -12,6 +12,9 @@ Sends HTTP messages to a NanoLeaf --- ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ The IP Address of the NanoLeaf. -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|true |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Command** @@ -37,9 +47,16 @@ The URI fragment to send to the nanoleaf. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |2 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Method** @@ -47,9 +64,16 @@ The HTTP method to send. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Data** @@ -57,9 +81,16 @@ The data to send. This will be converted into JSON if it is not a string. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[PSObject]```|false |4 |true (ByPropertyName)| +> **Type**: ```[PSObject]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Property** @@ -67,9 +98,16 @@ A set of additional properties to add to an object -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |5 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RemoveProperty** @@ -77,9 +115,16 @@ A list of property names to remove from an object -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|false |6 |false | +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:false + + + --- #### **ExpandProperty** @@ -87,9 +132,16 @@ If provided, will expand a given property returned from the REST api. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|false |7 |false | +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:false + + + --- #### **PSTypeName** @@ -97,9 +149,16 @@ The typename of the results. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NanoLeafToken** @@ -107,9 +166,16 @@ The nanoleaf token -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -125,7 +191,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Set-HueLight.md b/docs/Set-HueLight.md index fee544d..47023c2 100644 --- a/docs/Set-HueLight.md +++ b/docs/Set-HueLight.md @@ -12,6 +12,9 @@ Changes the state of one or more Hue lights --- ### Related Links * [Get-HueLight](Get-HueLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -64,9 +67,16 @@ The name of the Hue light -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RoomName** @@ -74,9 +84,16 @@ The name of the Hue room -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[String[]]```|true |1 |false | +> **Type**: ```[String[]]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **LightID** @@ -84,9 +101,16 @@ The identifier of the Hue light -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|true |1 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **GroupID** @@ -94,9 +118,16 @@ The identifier of the Hue group -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |1 |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **TransitionTime** @@ -104,9 +135,16 @@ The transition time. This is how long it will take light to change from it's cu -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|false |2 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **On** @@ -114,9 +152,16 @@ If set, will switch the light on -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Off** @@ -124,9 +169,16 @@ If set, will switch the light off -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RGBColor** @@ -134,9 +186,16 @@ Sets lights to an RGB color -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Hue** @@ -144,9 +203,16 @@ The desired hue (ranged 0-360) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |named |true (ByPropertyName)| +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Saturation** @@ -154,9 +220,16 @@ The desired saturation (ranged 0-1) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |named |true (ByPropertyName)| +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Brightness** @@ -164,9 +237,16 @@ The desired brightness (ranged 0-1) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |named |true (ByPropertyName)| +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Effect** @@ -181,9 +261,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Alert** @@ -199,9 +286,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColorTemperature** @@ -209,9 +303,16 @@ The color temperature as a Mired value. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **XY** @@ -219,29 +320,50 @@ The color, in XY coordinates. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[Single[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[Single[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **SaturationIncrement** -The increment in saturation. This will adjust the intensity of the color +The increment in saturation. This will adjust the intensity of the color. + + + +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |named |true (ByPropertyName)| --- #### **BrightnessIncrement** -An increment in luminance. This will adjust the brightness of the light +An increment in luminance. This will adjust the brightness of the light. + + + +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |named |true (ByPropertyName)| --- #### **HueIncrement** @@ -249,9 +371,16 @@ An increment in hue. This will adjust the hue -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColorTemperatureIncrement** @@ -259,9 +388,16 @@ A change in the color temperature. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |named |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **OutputInput** @@ -269,9 +405,16 @@ If set, will output the data that would be sent to the bridge. This is useful f -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -287,7 +430,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Set-HueRule.md b/docs/Set-HueRule.md index 53d16d6..9aa100c 100644 --- a/docs/Set-HueRule.md +++ b/docs/Set-HueRule.md @@ -12,7 +12,13 @@ Sets a Hue Rule. Hue Rules are used to automatically change your Hue Lights and --- ### Related Links * [Get-HueRule](Get-HueRule.md) + + + * [Remove-HueRule](Remove-HueRule.md) + + + --- ### Examples #### EXAMPLE 1 @@ -24,6 +30,79 @@ Set-HueRule -Condition { } -Name BrightenRoom ``` +#### EXAMPLE 2 +```PowerShell +# Set a rule that when +Set-HueRule -Condition { + "/sensors/61/state/buttonevent" -eq "4002" +} -Action { + Set-HueLight -RoomName "Sunroom" -Brightness 0.01 +} -Name SunroomDimmerTap +``` + +#### EXAMPLE 3 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "4003" +} -Action { + Set-HueLight -RoomName "Sunroom" -Off +} -Name SunroomDimmerHoldDownToTurnOff +``` + +#### EXAMPLE 4 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1003" +} -Action { + Set-HueLight -RoomName "Sunroom" -On +} -Name SunroomDimmerHoldUpToTurnOn +``` + +#### EXAMPLE 5 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1002" +} -Action { + Set-HueLight -RoomName "Sunroom" -On -Brightness .8 +} -Name SunroomDimmerTapOn +``` + +#### EXAMPLE 6 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2003" +} -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .1 +} -Name SunroomDimmerHoldBright +``` + +#### EXAMPLE 7 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2002" +} -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .05 +} -Name SunroomDimmerTapBright +``` + +#### EXAMPLE 8 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3002" +} -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement -.05 +} -Name SunroomDimmerTapDarken +``` + +#### EXAMPLE 9 +```PowerShell +Set-HueRule -Condition { + "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3003" +} -Action { + Set-HueLight -RoomName "Sunroom" -BrightnessIncrement -.1 +} -Name SunroomDimmerHoldDarken +``` + --- ### Parameters #### **Name** @@ -32,20 +111,37 @@ The name of the rule. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[String]```|true |1 |false | +> **Type**: ```[String]``` + +> **Required**: true + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **Condition** The condition. If the value is a ScriptBlock, only operators and their surrounding conext will be accepted. +Each condition should take the form: `"/resource/id/restOfAddress" -operator "value"`. +Rules may have more than one condition. +If the address is not a resource followed by a digit, the resource will be looked up by name. + + + +> **Type**: ```[PSObject[]]``` + +> **Required**: true + +> **Position**: 2 + +> **PipelineInput**:false -|Type |Requried|Postion|PipelineInput| -|------------------|--------|-------|-------------| -|```[PSObject[]]```|true |2 |false | --- #### **Action** @@ -61,9 +157,16 @@ Otherwise, check for the required properties. -|Type |Requried|Postion|PipelineInput| -|------------------|--------|-------|-------------| -|```[PSObject[]]```|true |3 |false | +> **Type**: ```[PSObject[]]``` + +> **Required**: true + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **DeviceID** @@ -71,9 +174,16 @@ If provided, the schedule will only run on the bridge with a particular device I -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |named |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **IPAddress** @@ -81,9 +191,16 @@ If provided, the schedule will only run on the bridge found at the provided IP a -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|false |named |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Disable** @@ -91,18 +208,40 @@ If set, will disable the rule. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + +--- +#### **WhatIf** +-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-WhatIf is used to see what would happen, or return operations without executing them +#### **Confirm** +-Confirm is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. +-Confirm is used to -Confirm each operation. + +If you pass ```-Confirm:$false``` you will not be prompted. + + +If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$confirmImpactPreference```, you will not be prompted unless -Confirm is passed. + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- ### Syntax ```PowerShell -Set-HueRule [-Name] [-Condition] [-Action] [-DeviceID ] [-IPAddress ] [-Disable] [] +Set-HueRule [-Name] [-Condition] [-Action] [-DeviceID ] [-IPAddress ] [-Disable] [-WhatIf] [-Confirm] [] ``` --- diff --git a/docs/Set-KeyLight.md b/docs/Set-KeyLight.md index af263cd..657d108 100644 --- a/docs/Set-KeyLight.md +++ b/docs/Set-KeyLight.md @@ -12,6 +12,9 @@ Changes Elgato Key Lighting --- ### Related Links * [Get-KeyLight](Get-KeyLight.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ One or more IP Addresses of Elgato Key Lighting devices. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Brightness** @@ -39,9 +49,16 @@ When passed with no other parameters, adjusts the absolute brightness -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |2 |true (ByPropertyName)| +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **On** @@ -49,9 +66,16 @@ If set, will turn the light on. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Off** @@ -59,9 +83,16 @@ If set, will turn the light on. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColorTemperature** @@ -69,9 +100,16 @@ The color temperature as a Mired value. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. diff --git a/docs/Set-NanoLeaf.md b/docs/Set-NanoLeaf.md index e5c334c..61fef18 100644 --- a/docs/Set-NanoLeaf.md +++ b/docs/Set-NanoLeaf.md @@ -12,7 +12,13 @@ Changes settings on one or more NanoLeaf controllers. --- ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) + + + * [Send-NanoLeaf](Send-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -87,9 +93,16 @@ If set, will turn the nanoleaf off -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **On** @@ -97,9 +110,16 @@ If set, will turn the nanoleaf on -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Hue** @@ -107,9 +127,16 @@ The hue of the NanoLeaf light color. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |1 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:false + + + --- #### **HueIncrement** @@ -117,9 +144,16 @@ Increments the hue of the NanoLeaf light color. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |2 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:false + + + --- #### **Saturation** @@ -127,9 +161,16 @@ The saturation of the NanoLeaf light color. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Double]```|false |3 |false | +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:false + + + --- #### **SaturationIncrement** @@ -137,9 +178,16 @@ Increments the saturation of the NanoLeaf light color. -|Type |Requried|Postion|PipelineInput| -|-------------|--------|-------|-------------| -|```[Int32]```|false |4 |false | +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:false + + + --- #### **Brightness** @@ -149,9 +197,16 @@ If provided with -Hue and -Saturation, sets the color of all panels. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ColorTemperature** @@ -159,9 +214,16 @@ If set, will change all panels on the nanoleaf to a given color temperature. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EffectName** @@ -169,9 +231,16 @@ The name of the effect. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |7 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Duration** @@ -179,9 +248,16 @@ The duration to display. In most contexts, this will be rounded to the nearest -|Type |Requried|Postion|PipelineInput| -|----------------|--------|-------|-------------| -|```[TimeSpan]```|false |8 |false | +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:false + + + --- #### **ExternalControl** @@ -190,9 +266,16 @@ If provided with -Panel, will set panels via UDP. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PluginName** @@ -200,9 +283,16 @@ The name of the effect plugin. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Palette** @@ -210,9 +300,16 @@ The palette used for an effect. -|Type |Requried|Postion|PipelineInput | -|------------------|--------|-------|---------------------| -|```[PSObject[]]```|false |10 |true (ByPropertyName)| +> **Type**: ```[PSObject[]]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EffectType** @@ -233,9 +330,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |11 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PluginUuid** @@ -243,9 +347,16 @@ The plugin UUID. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |12 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **PluginType** @@ -260,9 +371,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |13 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 13 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Panel** @@ -273,9 +391,16 @@ Timespans will be ignored when sending colors via UDP. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |14 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 14 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **EffectOption** @@ -296,9 +421,16 @@ Plugins can use any of the Nanoleaf-approved option types to further control how -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IDictionary]```|false |15 |true (ByPropertyName)| +> **Type**: ```[IDictionary]``` + +> **Required**: false + +> **Position**: 15 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Loop** @@ -306,9 +438,16 @@ If set, will mark the effect to loop. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **AsByteStream** @@ -316,9 +455,16 @@ If set, will set panels using UDP. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **IPAddress** @@ -326,9 +472,16 @@ The IP Address of the NanoLeaf. -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|false |16 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: false + +> **Position**: 16 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NanoLeafToken** @@ -336,9 +489,16 @@ The nanoleaf token -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |17 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 17 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. @@ -354,7 +514,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Set-Pixoo.md b/docs/Set-Pixoo.md index 5be173e..0c56ab7 100644 --- a/docs/Set-Pixoo.md +++ b/docs/Set-Pixoo.md @@ -12,6 +12,9 @@ Changes Pixoo Frames --- ### Related Links * [Get-Pixoo](Get-Pixoo.md) + + + --- ### Examples #### EXAMPLE 1 @@ -27,9 +30,16 @@ One or more IP Addresses of Twinkly devices. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Brightness** @@ -39,9 +49,16 @@ When passed with no other parameters, adjusts the absolute brightness -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Single]```|false |2 |true (ByPropertyName)| +> **Type**: ```[Single]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Hue** @@ -49,9 +66,16 @@ Sets the hue of all lights in a fixture -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Saturation** @@ -59,9 +83,16 @@ Sets the saturation of all lights in a fixture -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **On** @@ -69,9 +100,16 @@ If set, will turn a Pixoo screen on. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Off** @@ -79,9 +117,16 @@ If set, will turn a Pixoo screen off. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Visualizer** @@ -89,9 +134,16 @@ If provided, will switch the Pixoo to a given numbered visualizer -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CustomPlaylist** @@ -99,9 +151,16 @@ If provided, will switch the Pixoo custom playlist -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **CloudChannel** @@ -109,9 +168,16 @@ If provided, will switch the Pixoo's current Cloud Channel. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |7 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Channel** @@ -128,9 +194,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Stopwatch** @@ -146,9 +219,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Timer** @@ -157,9 +237,16 @@ If provided, will switch the Pixoo into a Timer, with the given timespan. -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[TimeSpan]```|false |10 |true (ByPropertyName)| +> **Type**: ```[TimeSpan]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NoiseMeter** @@ -167,9 +254,16 @@ If set, will display a noise meter. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RedScore** @@ -179,9 +273,16 @@ If provided, will switch the Pixoo into a Scoreboard. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |11 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **BlueScore** @@ -191,9 +292,16 @@ If provided, will switch the Pixoo into a Scoreboard. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |12 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RGBColor** @@ -201,9 +309,16 @@ If provided, will change the Pixoo into a single RGB color. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |13 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 13 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **WhatIf** -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```. diff --git a/docs/Set-Twinkly.md b/docs/Set-Twinkly.md index 470729c..cc73600 100644 --- a/docs/Set-Twinkly.md +++ b/docs/Set-Twinkly.md @@ -12,7 +12,13 @@ Sets Twinkly Lights. Changes colors, mode of operation --- ### Related Links * [Get-Twinkly](Get-Twinkly.md) + + + * [Connect-Twinkly](Connect-Twinkly.md) + + + --- ### Examples #### EXAMPLE 1 @@ -28,9 +34,16 @@ One or more IP Addresses of Twinkly devices. -|Type |Requried|Postion|PipelineInput | -|-------------------|--------|-------|---------------------| -|```[IPAddress[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Hue** @@ -38,9 +51,16 @@ Sets the hue of all lights in a fixture -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |2 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Saturation** @@ -48,9 +68,16 @@ Sets the saturation of all lights in a fixture -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |3 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Brightness** @@ -60,9 +87,16 @@ When passed with no other parameters, adjusts the absolute brightness -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Double]```|false |4 |true (ByPropertyName)| +> **Type**: ```[Double]``` + +> **Required**: false + +> **Position**: 4 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Red** @@ -70,9 +104,16 @@ Sets the red part of a color -|Type |Requried|Postion|PipelineInput | -|------------|--------|-------|---------------------| -|```[Byte]```|false |5 |true (ByPropertyName)| +> **Type**: ```[Byte]``` + +> **Required**: false + +> **Position**: 5 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Green** @@ -80,9 +121,16 @@ Sets the green part of a color -|Type |Requried|Postion|PipelineInput | -|------------|--------|-------|---------------------| -|```[Byte]```|false |6 |true (ByPropertyName)| +> **Type**: ```[Byte]``` + +> **Required**: false + +> **Position**: 6 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Blue** @@ -90,9 +138,16 @@ Sets the blue part of a color -|Type |Requried|Postion|PipelineInput | -|------------|--------|-------|---------------------| -|```[Byte]```|false |7 |true (ByPropertyName)| +> **Type**: ```[Byte]``` + +> **Required**: false + +> **Position**: 7 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RGBColor** @@ -103,9 +158,16 @@ If -MovieFrameRate and -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |8 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 8 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Mode** @@ -137,9 +199,16 @@ Valid Values: -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |9 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 9 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **DeviceName** @@ -147,9 +216,16 @@ If provided, will set the device name. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |10 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 10 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RestartPlaylist** @@ -157,9 +233,16 @@ If provided, will restart the playlist -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieName** @@ -167,9 +250,16 @@ The name of a movie. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |11 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 11 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieFramerate** @@ -177,9 +267,16 @@ The movie framerate -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |12 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 12 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieLEDCount** @@ -187,9 +284,16 @@ The movie LED -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |13 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 13 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieFrameCount** @@ -197,9 +301,16 @@ The number of frames in the movie. -|Type |Requried|Postion|PipelineInput | -|-------------|--------|-------|---------------------| -|```[Int32]```|false |14 |true (ByPropertyName)| +> **Type**: ```[Int32]``` + +> **Required**: false + +> **Position**: 14 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieData** @@ -210,9 +321,16 @@ Each sequence of frames represents a movie. -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Byte[]]```|false |15 |true (ByPropertyName)| +> **Type**: ```[Byte[]]``` + +> **Required**: false + +> **Position**: 15 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **MovieBlockSize** @@ -220,12 +338,21 @@ The size of each block within a movie. By default, 3. -|Type |Requried|Postion|PipelineInput | -|------------|--------|-------|---------------------| -|```[Byte]```|false |16 |true (ByPropertyName)| +> **Type**: ```[Byte]``` + +> **Required**: false + +> **Position**: 16 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + --- diff --git a/docs/Watch-NanoLeaf.md b/docs/Watch-NanoLeaf.md index fcfb6fa..178cd81 100644 --- a/docs/Watch-NanoLeaf.md +++ b/docs/Watch-NanoLeaf.md @@ -23,6 +23,9 @@ These messages are unpacked and translated into PowerShell events: --- ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) + + + --- ### Examples #### EXAMPLE 1 @@ -38,9 +41,16 @@ The IP Address of the NanoLeaf. -|Type |Requried|Postion|PipelineInput | -|-----------------|--------|-------|---------------------| -|```[IPAddress]```|false |1 |true (ByPropertyName)| +> **Type**: ```[IPAddress]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **NanoLeafToken** @@ -48,9 +58,16 @@ The nanoleaf token -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |2 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 2 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **TouchEventsPort** @@ -58,12 +75,21 @@ The UDP port used for TouchStreamData -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[String]```|false |3 |true (ByPropertyName)| +> **Type**: ```[String]``` + +> **Required**: false + +> **Position**: 3 + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.Job +* [Management.Automation.Job](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.Job) + + --- diff --git a/docs/Write-HueSensor.md b/docs/Write-HueSensor.md index 446c449..802392c 100644 --- a/docs/Write-HueSensor.md +++ b/docs/Write-HueSensor.md @@ -12,10 +12,25 @@ Writes data to sensors on the Hue Bridge --- ### Related Links * [Read-HueSensor](Read-HueSensor.md) + + + * [Get-HueSensor](Get-HueSensor.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Add-HueSensor](Add-HueSensor.md) + + + * [Remove-HueSensor](Remove-HueSensor.md) + + + --- ### Examples #### EXAMPLE 1 @@ -31,9 +46,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -41,9 +63,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -51,9 +80,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -61,9 +97,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Config** @@ -71,9 +114,16 @@ If set, will write values from to configuration. By default, values are written -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- #### **Data** @@ -81,9 +131,16 @@ The data that will be written to the sensor -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|--------------| -|```[PSObject]```|true |named |true (ByValue)| +> **Type**: ```[PSObject]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByValue) + + + --- #### **OutputInput** @@ -91,12 +148,21 @@ If set, will output the data that would be sent to the bridge. This is useful f -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + ---