From c7168a987bded450ed54c62c422ae64d4b68cb10 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:09 +0000 Subject: [PATCH 01/58] feat: $LightScript ( Fixes #104 ) --- LightScript.format.ps1xml | 205 +++++++++++++++++++++++++++----------- 1 file changed, 146 insertions(+), 59 deletions(-) diff --git a/LightScript.format.ps1xml b/LightScript.format.ps1xml index 7e26b66..1fbefaf 100644 --- a/LightScript.format.ps1xml +++ b/LightScript.format.ps1xml @@ -1,5 +1,5 @@ - + @@ -289,24 +289,24 @@ $(@(foreach ($_ in $actionLines) { } while ($false) - - $__ = $_ - $ci = . { + + $CellColorValue = $($Script:_LastCellStyle = $($__ = $_;. { if ($_.Status -eq 'Enabled') { '#00ff00' } else { '#ff0000' } -} - $_ = $__ - if ($ci -is [string]) { - $ci = & ${LightScript_Format-RichText} -NoClear -ForegroundColor $ci - } else { - $ci = & ${LightScript_Format-RichText} -NoClear @ci - } - $output = . {$_.'Status'} - @($ci; $output; & ${LightScript_Format-RichText}) -join "" - +};$_ = $__);$Script:_LastCellStyle) + + if ($CellColorValue -and $CellColorValue -is [string]) { + $CellColorValue = & ${LightScript_Format-RichText} -NoClear -ForegroundColor $CellColorValue + } elseif (`$CellColorValue -is [Collections.IDictionary]) { + $CellColorValue = & ${LightScript_Format-RichText} -NoClear @CellColorValue + } + + $output = . {$_.'Status'} + @($CellColorValue; $output; & ${LightScript_Format-RichText}) -join '' + Time @@ -853,7 +853,7 @@ New-Object PSObject -Property ([Ordered]@{ .Notes Stylized Output works in two contexts at present: * Rich consoles (Windows Terminal, PowerShell.exe, Pwsh.exe) (when $host.UI.SupportsVirtualTerminal) - * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) + * Web pages (Based off the presence of a $Request variable, or when $host.UI.SupportsHTML (you must add this property to $host.UI)) #> [Management.Automation.Cmdlet("Format","Object")] [ValidateScript({ @@ -862,12 +862,13 @@ New-Object PSObject -Property ([Ordered]@{ if (-not ($canUseANSI -or $canUseHTML)) { return $false} return $true })] + [OutputType([string])] param( # The input object [Parameter(ValueFromPipeline)] [PSObject] $InputObject, - + # The foreground color [string]$ForegroundColor, @@ -902,8 +903,23 @@ New-Object PSObject -Property ([Ordered]@{ # If set, will invert text [switch]$Invert, + + # If provided, will create a hyperlink to a given uri + [Alias('Hyperlink', 'Href')] + [uri] + $Link, + # If set, will not clear formatting - [switch]$NoClear + [switch]$NoClear, + + # The alignment. Defaulting to Left. + # Setting an alignment will pad the remaining space on each line. + [ValidateSet('Left','Right','Center')] + [string] + $Alignment, + + # The length of a line. By default, the buffer width + [int]$LineLength = $($host.UI.RawUI.BufferSize.Width) ) begin { @@ -913,12 +929,27 @@ New-Object PSObject -Property ([Ordered]@{ Output='';Error='BrightRed';Warning='BrightYellow'; Verbose='BrightCyan';Debug='Yellow';Progress='Cyan'; Success='BrightGreen';Failure='Red';Default=''} + + $ansiCode = [Regex]::new(@' + (?<ANSI_Code> + (?-i)\e # An Escape + \[ # Followed by a bracket + (?<ParameterBytes>[\d\:\;\<\=\>\?]{0,}) # Followed by zero or more parameter + bytes + (?<IntermediateBytes>[\s\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/]{0,}) # Followed by zero or more + intermediate bytes + (?<FinalByte>[\@ABCDEFGHIJKLMNOPQRSTUVWXYZ\[\\\]\^_\`abcdefghijklmnopqrstuvwxyz\{\|\}\~]) # Followed by a final byte + + ) +'@) $esc = [char]0x1b $standardColors = 'Black', 'Red', 'Green', 'Yellow', 'Blue','Magenta', 'Cyan', 'White' $brightColors = 'BrightBlack', 'BrightRed', 'BrightGreen', 'BrightYellow', 'BrightBlue','BrightMagenta', 'BrightCyan', 'BrightWhite' + $allOutput = @() + $n =0 - $cssClasses = @() + $cssClasses = @() $colorAttributes = @(:nextColor foreach ($hc in $ForegroundColor,$BackgroundColor) { $n++ @@ -1095,6 +1126,21 @@ New-Object PSObject -Property ([Ordered]@{ if ($canUseHTML) { "border-bottom: 3px double;"} elseif ($canUseANSI) {'' +$esc + "[21m" } } + + if ($Alignment -and $canUseHTML) { + "display:block;text-align:$($Alignment.ToLower())" + } + + if ($Link) { + if ($canUseHTML) { + # Hyperlinks need to be a nested element + # so we will not add it to style attributes for HTML + } + elseif ($canUseANSI) { + # For ANSI, + '' + $esc + ']8;;' + $Link + $esc + '\' + } + } ) @@ -1104,61 +1150,102 @@ New-Object PSObject -Property ([Ordered]@{ if ($styleAttributes) { " style='$($styleAttributes -join ';')'"} )$( if ($cssClasses) { " class='$($cssClasses -join ' ')'"} - )>" + )>" + $( + if ($Link) { + "<a href='$link'>" + } + ) } elseif ($canUseANSI) { $styleAttributes -join '' } } process { - if ($header) { - "$header" + "$(if ($inputObject) { $inputObject | Out-String})".Trim() - } - elseif ($inputObject) { - ($inputObject | Out-String).Trim() - } + $inputObjectAsString = + "$(if ($inputObject) { $inputObject | Out-String})".Trim() + + $inputObjectAsString = + if ($Alignment -and -not $canUseHTML) { + (@(foreach ($inputObjectLine in ($inputObjectAsString -split '(?>\r\n|\n)')) { + $inputObjectLength = $ansiCode.Replace($inputObjectLine, '').Length + if ($inputObjectLength -lt $LineLength) { + if ($Alignment -eq 'Left') { + $inputObjectLine + } elseif ($Alignment -eq 'Right') { + (' ' * ($LineLength - $inputObjectLength)) + $inputObjectLine + } else { + $half = ($LineLength - $inputObjectLength)/2 + (' ' * [Math]::Floor($half)) + $inputObjectLine + + (' ' * [Math]::Ceiling($half)) + } + } + else { + $inputObjectLine + } + }) -join [Environment]::NewLine) + [Environment]::newline + } else { + $inputObjectAsString + } + + $allOutput += + if ($header) { + "$header" + $inputObjectAsString + } + elseif ($inputObject) { + $inputObjectAsString + } } end { if (-not $NoClear) { - if ($canUseHTML) { - "</span>" - } - elseif ($canUseANSI) { - if ($Bold -or $Faint -or $colorAttributes -match '\[1;') { - "$esc[22m" - } - if ($Italic) { - "$esc[23m" - } - if ($Underline -or $doubleUnderline) { - "$esc[24m" - } - if ($Blink) { - "$esc[25m" - } - if ($Invert) { - "$esc[27m" - } - if ($hide) { - "$esc[28m" - } - if ($Strikethru) { - "$esc[29m" - } - if ($ForegroundColor) { - "$esc[39m" - } - if ($BackgroundColor) { - "$esc[49m" + $allOutput += + if ($canUseHTML) { + if ($Link) { + "</a>" + } + "</span>" } - - if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { - '' + $esc + '[0m' + elseif ($canUseANSI) { + if ($Bold -or $Faint -or $colorAttributes -match '\[1;') { + "$esc[22m" + } + if ($Italic) { + "$esc[23m" + } + if ($Underline -or $doubleUnderline) { + "$esc[24m" + } + if ($Blink) { + "$esc[25m" + } + if ($Invert) { + "$esc[27m" + } + if ($hide) { + "$esc[28m" + } + if ($Strikethru) { + "$esc[29m" + } + if ($ForegroundColor) { + "$esc[39m" + } + if ($BackgroundColor) { + "$esc[49m" + } + + if ($Link) { + "$esc]8;;$esc\" + } + + if (-not ($Underline -or $Bold -or $Invert -or $ForegroundColor -or $BackgroundColor)) { + '' + $esc + '[0m' + } } - } } + + $allOutput -join '' } From f520c9d6834e230f1215f0f33424412e002c9ad3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:09 +0000 Subject: [PATCH 02/58] feat: $LightScript ( Fixes #104 ) --- LightScript.types.ps1xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LightScript.types.ps1xml b/LightScript.types.ps1xml index d456b87..99553c4 100644 --- a/LightScript.types.ps1xml +++ b/LightScript.types.ps1xml @@ -1,5 +1,5 @@ - + Hue.Sensor From 56fdd109651f38a74c3c0d58bd4d2dd29b4b75ce Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:15 +0000 Subject: [PATCH 03/58] feat: $LightScript ( Fixes #104 ) --- docs/Add-HueLight.md | 43 +++++++++++++++++-------------------------- 1 file changed, 17 insertions(+), 26 deletions(-) diff --git a/docs/Add-HueLight.md b/docs/Add-HueLight.md index b0b5847..2b418a2 100644 --- a/docs/Add-HueLight.md +++ b/docs/Add-HueLight.md @@ -1,76 +1,67 @@ Add-HueLight ------------ + ### Synopsis Adds lights to Hue --- + ### Description Adds new lights to a Hue Bridge. --- + ### Related Links * [Get-HueLight](Get-HueLight.md) - - * [Set-HueLight](Set-HueLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-HueLight # Search for new lights ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Add-HueLight -DeviceID $serialNumber # Add a new light by serial number. ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell -Add-HueLight # Search for new lights +Add-HueLight # Search for new lights Get-HueLight -New # Get-HueLight -New will return the new lights ``` --- + ### Parameters #### **DeviceID** - -One or more Device Identifiers (serial numbers ). +One or more Device Identifiers (serial numbers ). Use this parameter when adding lights that have already been assigned to another bridge. +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|------------| +|`[String[]]`|false |1 |false |SerialNumber| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **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. --- + ### Syntax ```PowerShell Add-HueLight [[-DeviceID] ] [-WhatIf] [-Confirm] [] ``` ---- From 8c04983d66180018dc751d3d11cead36e524bfc1 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:15 +0000 Subject: [PATCH 04/58] feat: $LightScript ( Fixes #104 ) --- docs/Add-HueRoom.md | 119 ++++++++++---------------------------------- 1 file changed, 27 insertions(+), 92 deletions(-) diff --git a/docs/Add-HueRoom.md b/docs/Add-HueRoom.md index fa451b6..9b79d7a 100644 --- a/docs/Add-HueRoom.md +++ b/docs/Add-HueRoom.md @@ -1,106 +1,64 @@ Add-HueRoom ----------- + ### Synopsis Adds rooms or groups to a Hue Bridge. --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Add-HueRoom -Name Office -Light "Office Lightstrip", "Office Desk Light 1", "Office Desk Light 2" -RoomType Office ``` --- + ### Parameters #### **Name** - The name of the Room or Light Group. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - The name of the lights that will be added to the room +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------| +|`[String[]]`|false |named |true (ByPropertyName)|LightName| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **LightID** - One or more identifiers for lights +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **AutoGroup** - If set, will automatically group lights with a similar name as the room. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RoomType** - The type of the room - - - Valid Values: * Bathroom @@ -123,26 +81,13 @@ Valid Values: * Terrace * Toilet +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **GroupType** - The type of the group, either Room of LightGroup (by default, Room). Rooms cannot share lights with other rooms, while light groups can contain lights already in a room. - - - Valid Values: * Room @@ -150,28 +95,18 @@ Valid Values: * Entertainment * Zone - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Add-HueRoom [-Name] [-Light ] [-LightID ] [-AutoGroup] [-RoomType ] [-GroupType ] [] ``` ---- From d46f131da14ae7e1097c611e7cee2ea465fd1765 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 05/58] feat: $LightScript ( Fixes #104 ) --- docs/Add-HueSchedule.md | 209 +++++++++------------------------------- 1 file changed, 45 insertions(+), 164 deletions(-) diff --git a/docs/Add-HueSchedule.md b/docs/Add-HueSchedule.md index bfef54a..440c42c 100644 --- a/docs/Add-HueSchedule.md +++ b/docs/Add-HueSchedule.md @@ -1,243 +1,125 @@ Add-HueSchedule --------------- + ### Synopsis Adds a schedule to a Hue Bridge --- + ### Description Adds a new schedule to a Hue Bridge --- + ### Related Links * [Get-HueSchedule](Get-HueSchedule.md) - - * [Get-HueBridge](Get-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-HueSchedule -Daily -Name "Shift to Sunset" -Description "Shift to warmer and brighter as the day draws to a close" -Command (Set-Light -ColorTemperature 400 -Luminance 1 -TransitionTime '01:30:00' -OutputInput) -LocalTime "3:00 PM" ``` --- + ### Parameters #### **Name** - The name of the schedule +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Description** - A description for the schedule +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Command** - The command that will be run +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|true |named |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **LocalTime** - The time of the command +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[DateTime]`|true |1 |true (ByPropertyName)|At | - -> **Type**: ```[DateTime]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Daily** - If set, will run daily +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DayOfWeek** - The days of the week the schedule will be executed (1 is Sunday, 7 is Saturday). +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Byte[]]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[Byte[]]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **For** - The time the schedule should last +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|----------------------------| +|`[TimeSpan]`|false |4 |true (ByPropertyName)|ForTimeframe
ForTimespan| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **In** - Sets a countdown timer. This timer will occur once, in a given timespan. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------------------| +|`[TimeSpan]`|true |1 |true (ByPropertyName)|InTime
InTimespan| - -> **Type**: ```[TimeSpan]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Every** - If set, will repeat every N timeframe +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------------------------| +|`[TimeSpan]`|true |1 |true (ByPropertyName)|EveryTime
EveryTimespan| - -> **Type**: ```[TimeSpan]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Within** - If provided, the schedule will execute at a random time within the provided timespan. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|-----------------| +|`[TimeSpan]`|false |5 |true (ByPropertyName)|Jitter
Around| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DeviceID** - If provided, the schedule will only run on the bridge with a particular device ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IPAddress** - If provided, the schedule will only run on the bridge found at the provided IP address - - -> **Type**: ```[IPAddress]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases| +|-------------|--------|--------|---------------------|-------| +|`[IPAddress]`|false |named |true (ByPropertyName)|IP | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Add-HueSchedule [-Name ] [-Description ] -Command [-LocalTime] [[-Daily]] [[-DayOfWeek] ] [[-For] ] [[-Within] ] [-DeviceID ] [-IPAddress ] [] @@ -248,4 +130,3 @@ Add-HueSchedule [-Name ] [-Description ] -Command [-I ```PowerShell Add-HueSchedule [-Name ] [-Description ] -Command [-Every] [-DeviceID ] [-IPAddress ] [] ``` ---- From 0f39cfa63682bb047a35620b1d3b472419aa5793 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 06/58] feat: $LightScript ( Fixes #104 ) --- docs/Add-HueSensor.md | 138 ++++++++++-------------------------------- 1 file changed, 32 insertions(+), 106 deletions(-) diff --git a/docs/Add-HueSensor.md b/docs/Add-HueSensor.md index 9a861ab..49e4a13 100644 --- a/docs/Add-HueSensor.md +++ b/docs/Add-HueSensor.md @@ -1,52 +1,43 @@ 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. --- + ### Related Links * [Get-HueSensor](Get-HueSensor.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Add-HueSensor -Name "ChaseStatus1" -SensorType GenericStatus ``` --- + ### Parameters #### **Name** - The name of the sensor. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **SensorType** - The sensor type. - Sensors can be: - * Switches * OpenClose * Presence (motion detectors) @@ -55,9 +46,6 @@ Sensors can be: * LightLevel * GenericFlag (used for virtual sensors) * GenericStatus (used for virtual sensors) - - - Valid Values: * Switch @@ -69,124 +57,63 @@ Valid Values: * GenericFlag * GenericStatus +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ModelID** - The sensor ModelID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Manufacturer** - The sensor manufacturer +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **UniqueID** - The sensor unique ID. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Version** - The sensor version. +|Type |Required|Position|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 |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------| +|`[Switch]`|true |named |false |Find
Discover| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Add-HueSensor [-Name] [-SensorType] [[-ModelID] ] [[-Manufacturer] ] [[-UniqueID] ] [[-Version] ] [-WhatIf] [-Confirm] [] @@ -194,4 +121,3 @@ Add-HueSensor [-Name] [-SensorType] [[-ModelID] ] [[-M ```PowerShell Add-HueSensor -New [-WhatIf] [-Confirm] [] ``` ---- From 2482cfc10c6a5db2576bef16b4919dd904e6e223 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 07/58] feat: $LightScript ( Fixes #104 ) --- docs/Clear-Twinkly.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/Clear-Twinkly.md b/docs/Clear-Twinkly.md index 6c208c1..f96d86e 100644 --- a/docs/Clear-Twinkly.md +++ b/docs/Clear-Twinkly.md @@ -1,9 +1,11 @@ Clear-Twinkly ------------- + ### Synopsis Clears Twinkly devices --- + ### Description The Twinkly API does not allow for the deletion of specific storage items, and is limited to 16 movies. @@ -11,62 +13,50 @@ The Twinkly API does not allow for the deletion of specific storage items, and i This clears the stored movies and playlists --- + ### Related Links * [Get-Twinkly](Get-Twinkly.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Clear-Twinkly ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of Twinkly devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|----------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|TwinklyIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [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) - - - --- + ### Syntax ```PowerShell Clear-Twinkly [[-IPAddress] ] [-WhatIf] [-Confirm] [] ``` ---- From 9e4b1d8648155dfcf1cff985f1503caf7cad2f8f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 08/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-HueBridge.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/docs/Connect-HueBridge.md b/docs/Connect-HueBridge.md index 4567498..6d13de1 100644 --- a/docs/Connect-HueBridge.md +++ b/docs/Connect-HueBridge.md @@ -1,9 +1,11 @@ Connect-HueBridge ----------------- + ### Synopsis Connects to a new Hue Bridge. --- + ### Description Connects to a new Hue Bridge and saves connection information for later use. @@ -16,51 +18,40 @@ hold the link button on the Hue bridge until the lights flash. Then run this command within the next 30 seconds. --- + ### Related Links * [Find-HueBridge](Find-HueBridge.md) - - * [Get-HueBridge](Get-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-HueBridge | Connect-HueBridge ``` --- + ### Parameters #### **HueBridgeIP** - The IP Address of the Hue Bridge - - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------| +|`[IPAddress]`|true |named |true (ByPropertyName)|IPAddress| --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-HueBridge [] @@ -68,4 +59,3 @@ Connect-HueBridge [] ```PowerShell Connect-HueBridge -HueBridgeIP [] ``` ---- From cb4ef29ba2d6d23473be32e613a9b6800c1fa02d Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 09/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-KeyLight.md | 48 +++++++++++++--------------------------- 1 file changed, 15 insertions(+), 33 deletions(-) diff --git a/docs/Connect-KeyLight.md b/docs/Connect-KeyLight.md index f630437..1fe9c02 100644 --- a/docs/Connect-KeyLight.md +++ b/docs/Connect-KeyLight.md @@ -1,74 +1,56 @@ Connect-KeyLight ---------------- + ### Synopsis Connects to a Elgato Key Lighting --- + ### Description Connects to a Elgato Key Lighting over Wifi --- + ### Related Links * [Get-KeyLight](Get-KeyLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Connect-KeyLight 1.2.3.4 -PassThru ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|-----------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|KeyLightIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the connection information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-KeyLight [-IPAddress] [-PassThru] [] ``` ---- From ed56ae55f19c923e49d007a6663f3b3f1dfa047f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 10/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-LaMetricTime.md | 68 +++++++++++------------------------- 1 file changed, 20 insertions(+), 48 deletions(-) diff --git a/docs/Connect-LaMetricTime.md b/docs/Connect-LaMetricTime.md index 400d183..4705b95 100644 --- a/docs/Connect-LaMetricTime.md +++ b/docs/Connect-LaMetricTime.md @@ -1,101 +1,73 @@ Connect-LaMetricTime -------------------- + ### Synopsis Connects to a LaMetric clock --- + ### Description Connects to a LaMetric clock. + LaMetric Time devices require a local ApiKey. Unfortunately, there is no way to get this key automatically. To Connect-LaMetricTime, you'll need to visit [developer.lametric.com](https://developer.lametric.com) and sign in. + You will find API Keys for your devices at [developer.lametric.com/user/devices](https://developer.lametric.com/user/devices). --- + ### Related Links * [Get-LaMetricTime](Get-LaMetricTime.md) - - * [Disconnect-LaMetricTime](Disconnect-LaMetricTime.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Connect-LaMetric -IPAddress $laMetricIP -ApiKey $myApiKey -PassThru ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|LaMetricTimeIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ApiKey** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------| +|`[String]`|true |2 |true (ByPropertyName)|LaMetricTimeApiKey| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the connection information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-LaMetricTime [-IPAddress] [-ApiKey] [-PassThru] [] ``` ---- From fe53fb207dd67b042e3b3ebfe4adf9eed2c4f634 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:16 +0000 Subject: [PATCH 11/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-Nanoleaf.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/docs/Connect-Nanoleaf.md b/docs/Connect-Nanoleaf.md index 8d5eda9..fba03e2 100644 --- a/docs/Connect-Nanoleaf.md +++ b/docs/Connect-Nanoleaf.md @@ -1,9 +1,11 @@ Connect-Nanoleaf ---------------- + ### Synopsis Connects to a new Nanoleaf controller. --- + ### Description Connects to a new Nanoleaf controller and saves connection information for later use. @@ -14,51 +16,40 @@ To demostrate your access, hold the power button down on the controller until th nanoleaf controller lights flash in sequence. Then run this command within the next 30 seconds. --- + ### Related Links * [Find-NanoLeaf](Find-NanoLeaf.md) - - * [Get-NanoLeaf](Get-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-NanoLeaf | Connect-NanoLeaf ``` --- + ### Parameters #### **NanoLeafIP** - The IP Address of the Nanoleaf - - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------| +|`[IPAddress]`|true |named |true (ByPropertyName)|IPAddress| --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-Nanoleaf [] @@ -66,4 +57,3 @@ Connect-Nanoleaf [] ```PowerShell Connect-Nanoleaf -NanoLeafIP [] ``` ---- From e48638e35fc74f13f32826572f0201fb1bfdf5f3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 12/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-Pixoo.md | 64 ++++++++++++------------------------------- 1 file changed, 18 insertions(+), 46 deletions(-) diff --git a/docs/Connect-Pixoo.md b/docs/Connect-Pixoo.md index 1a13aa7..e46c154 100644 --- a/docs/Connect-Pixoo.md +++ b/docs/Connect-Pixoo.md @@ -1,92 +1,64 @@ Connect-Pixoo ------------- + ### Synopsis Connects to a Pixoo --- + ### Description Connects to a Pixoo over Wifi --- + ### Related Links * [Get-Pixoo](Get-Pixoo.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-Pixoo | Connect-Pixoo ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Pixoo device. This can be discovered using Find-Pixoo. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|----------------------------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|PixooIPAddress
DevicePrivateIP| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the connection information. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **DeviceId** - The DeviceID. This can be provided by Find-Pixoo - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-Pixoo [-IPAddress] [-PassThru] [-DeviceId ] [] ``` ---- From e41b68b0276cf951dcb802d58855af6bff489a92 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 13/58] feat: $LightScript ( Fixes #104 ) --- docs/Connect-Twinkly.md | 48 +++++++++++++---------------------------- 1 file changed, 15 insertions(+), 33 deletions(-) diff --git a/docs/Connect-Twinkly.md b/docs/Connect-Twinkly.md index 4681ced..93d5c5b 100644 --- a/docs/Connect-Twinkly.md +++ b/docs/Connect-Twinkly.md @@ -1,74 +1,56 @@ Connect-Twinkly --------------- + ### Synopsis Connects to a Twinkly light controller. --- + ### Description Connects to a Twinkly light controller --- + ### Related Links * [Get-Twinkly](Get-Twinkly.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Connect-Twinkly 192.168.0.144 -PassThru ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|----------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|TwinklyIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the connection information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Connect-Twinkly [-IPAddress] [-PassThru] [] ``` ---- From 48f590e02c11a103bfe91418b5d1092dfc4d9ad0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 14/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-HueBridge.md | 32 ++++++++++++-------------------- 1 file changed, 12 insertions(+), 20 deletions(-) diff --git a/docs/Disconnect-HueBridge.md b/docs/Disconnect-HueBridge.md index 85d9d5a..1f29cb7 100644 --- a/docs/Disconnect-HueBridge.md +++ b/docs/Disconnect-HueBridge.md @@ -1,55 +1,48 @@ Disconnect-HueBridge -------------------- + ### Synopsis Disconnects a Hue Bridge. --- + ### Description Disconnects a new Hue Bridge and removes connection information. --- + ### Related Links * [Connect-HueBridge](Connect-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-HueBridge -HueBridgeIP 1.2.3.4 ``` --- + ### Parameters #### **HueBridgeIP** - The IP Address of the Hue Bridge - - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------| +|`[IPAddress]`|true |named |true (ByPropertyName)|IPAddress| --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Disconnect-HueBridge [] @@ -57,4 +50,3 @@ Disconnect-HueBridge [] ```PowerShell Disconnect-HueBridge -HueBridgeIP [] ``` ---- From ea0c8cca888971b5cd80a70fae053825e9ae273e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 15/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-KeyLight.md | 38 ++++++++++++++----------------------- 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/Disconnect-KeyLight.md b/docs/Disconnect-KeyLight.md index 178dc3e..49c7adc 100644 --- a/docs/Disconnect-KeyLight.md +++ b/docs/Disconnect-KeyLight.md @@ -1,70 +1,60 @@ Disconnect-KeyLight ------------------- + ### Synopsis Disconnects a Elgato Key Lighting --- + ### Description Disconnects a Elgato Key Lighting, removing stored device info --- + ### Related Links * [Connect-KeyLight](Connect-KeyLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-KeyLight 1.2.3.4 ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|-----------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|KeyLightIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [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) - - - --- + ### Syntax ```PowerShell Disconnect-KeyLight [-IPAddress] [-WhatIf] [-Confirm] [] ``` ---- From ea7917413600e40aacdd53425694df4ac85c0f60 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 16/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-LaMetricTime.md | 38 ++++++++++++--------------------- 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/Disconnect-LaMetricTime.md b/docs/Disconnect-LaMetricTime.md index 597ae33..3d99228 100644 --- a/docs/Disconnect-LaMetricTime.md +++ b/docs/Disconnect-LaMetricTime.md @@ -1,70 +1,60 @@ Disconnect-LaMetricTime ----------------------- + ### Synopsis Disconnects a LaMetricTime --- + ### Description Disconnects a LaMetricTime, removing stored device info --- + ### Related Links * [Connect-LaMetricTime](Connect-LaMetricTime.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-LaMetricTime 1.2.3.4 ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|LaMetricTimeIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [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) - - - --- + ### Syntax ```PowerShell Disconnect-LaMetricTime [-IPAddress] [-WhatIf] [-Confirm] [] ``` ---- From 427442c655d989942c030dc1dce1e4c0cf93918b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 17/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-Nanoleaf.md | 38 ++++++++++++++----------------------- 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/Disconnect-Nanoleaf.md b/docs/Disconnect-Nanoleaf.md index 52eea78..8912624 100644 --- a/docs/Disconnect-Nanoleaf.md +++ b/docs/Disconnect-Nanoleaf.md @@ -1,70 +1,60 @@ Disconnect-Nanoleaf ------------------- + ### Synopsis Disconnects a new Nanoleaf controller. --- + ### Description Disconnnects a new Nanoleaf controller and removes connection information. --- + ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-NanoLeaf -IPAddress 1.2.3.4 ``` --- + ### Parameters #### **NanoLeafIP** - The IP Address of the Nanoleaf +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|---------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|IPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [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) - - - --- + ### Syntax ```PowerShell Disconnect-Nanoleaf [-NanoLeafIP] [-WhatIf] [-Confirm] [] ``` ---- From 71bc0f279d6adc1bab7e7065360a5f17b6ec8063 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:17 +0000 Subject: [PATCH 18/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-Pixoo.md | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/docs/Disconnect-Pixoo.md b/docs/Disconnect-Pixoo.md index 85b81c0..46f2167 100644 --- a/docs/Disconnect-Pixoo.md +++ b/docs/Disconnect-Pixoo.md @@ -1,70 +1,60 @@ Disconnect-Pixoo ---------------- + ### Synopsis Disconnects a Pixoo --- + ### Description Disconnects a Pixoo, removing stored device info --- + ### Related Links * [Connect-Pixoo](Connect-Pixoo.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-Pixoo 1.2.3.4 ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|--------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|PixooIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [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) - - - --- + ### Syntax ```PowerShell Disconnect-Pixoo [-IPAddress] [-WhatIf] [-Confirm] [] ``` ---- From 49eba073c6bc84d85a8547da358f9aab998aa8b0 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 19/58] feat: $LightScript ( Fixes #104 ) --- docs/Disconnect-Twinkly.md | 48 ++++++++++++-------------------------- 1 file changed, 15 insertions(+), 33 deletions(-) diff --git a/docs/Disconnect-Twinkly.md b/docs/Disconnect-Twinkly.md index 71e5ab2..55231b2 100644 --- a/docs/Disconnect-Twinkly.md +++ b/docs/Disconnect-Twinkly.md @@ -1,74 +1,56 @@ Disconnect-Twinkly ------------------ + ### Synopsis Disconnects a Twinkly light controller. --- + ### Description Disconnects a Twinkly light controller --- + ### Related Links * [Connect-Twinkly](Connect-Twinkly.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Disconnect-Twinkly 192.168.0.144 ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|----------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)|TwinklyIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PassThru** - If set, will output the connection information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [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) - - - --- + ### Syntax ```PowerShell Disconnect-Twinkly [-IPAddress] [-PassThru] [] ``` ---- From b08a0b0eaf94f5eb3659c2f3402ffbf124f1d17b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 20/58] feat: $LightScript ( Fixes #104 ) --- docs/Find-HueBridge.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/Find-HueBridge.md b/docs/Find-HueBridge.md index ef9d1c5..0a0af5a 100644 --- a/docs/Find-HueBridge.md +++ b/docs/Find-HueBridge.md @@ -1,36 +1,37 @@ Find-HueBridge -------------- + ### Synopsis Finds Hue Bridges --- + ### Description Finds Hue Bridges on the local area network, using https://discovery.meethue.com/. --- + ### Related Links * [Connect-HueBridge](Connect-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-HueBridge ``` --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Find-HueBridge [] ``` ---- From 106c17cb3402ce59446b3086823a86b960bf6ca5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 21/58] feat: $LightScript ( Fixes #104 ) --- docs/Find-NanoLeaf.md | 63 +++++++++++++------------------------------ 1 file changed, 18 insertions(+), 45 deletions(-) diff --git a/docs/Find-NanoLeaf.md b/docs/Find-NanoLeaf.md index b252d28..29964e1 100644 --- a/docs/Find-NanoLeaf.md +++ b/docs/Find-NanoLeaf.md @@ -1,90 +1,63 @@ Find-NanoLeaf ------------- + ### Synopsis Finds NanoLeaf controllers --- + ### Description Finds NanoLeaf controllers on your local area network, using SSDP. --- + ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-NanoLeaf | Connect-NanoLeaf ``` --- + ### Parameters #### **SearchTimeout** - The search timeout, in seconds. Increase this number on slower networks. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Force** - If set, will force a rescan of the network. Otherwise, the most recent cached result will be returned. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DeviceType** - The type of the device to find. By default, ssdp:all. Changing this value is unlikely to find any NanoLeaf controllers, but you can see other devices with -Verbose. - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| --- + ### Outputs * Roku.BasicInfo - - - --- + ### Syntax ```PowerShell Find-NanoLeaf [[-SearchTimeout] ] [-Force] [[-DeviceType] ] [] ``` ---- From d1b2dbd8dca4f81fb24b49557c5b7d21fbec4168 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 22/58] feat: $LightScript ( Fixes #104 ) --- docs/Find-Pixoo.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/Find-Pixoo.md b/docs/Find-Pixoo.md index aa95fa4..e113c47 100644 --- a/docs/Find-Pixoo.md +++ b/docs/Find-Pixoo.md @@ -1,33 +1,34 @@ Find-Pixoo ---------- + ### Synopsis Finds Pixoo devices --- + ### Description Finds Pixoo devices on the local network. --- + ### Related Links * [https://lightscript.start-automating.com/Find-Pixoo/](https://lightscript.start-automating.com/Find-Pixoo/) - - * [https://app.divoom-gz.com/Device/ReturnSameLANDevice](https://app.divoom-gz.com/Device/ReturnSameLANDevice) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Find-Pixoo ``` --- + ### Syntax ```PowerShell Find-Pixoo [] ``` ---- From 30d4081ec6d02c33f3676e1b7f17b55a4ba93e92 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 23/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueBridge.md | 247 +++++++++--------------------------------- 1 file changed, 53 insertions(+), 194 deletions(-) diff --git a/docs/Get-HueBridge.md b/docs/Get-HueBridge.md index 683cd2a..192ac79 100644 --- a/docs/Get-HueBridge.md +++ b/docs/Get-HueBridge.md @@ -1,290 +1,150 @@ Get-HueBridge ------------- + ### Synopsis Gets Hue Bridges --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueBridge ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. +|Type |Required|Position|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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueBridge [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] @@ -316,4 +176,3 @@ Get-HueBridge -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] ```PowerShell Get-HueBridge -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [-WhatIf] [-Confirm] [] ``` ---- From a68a3d107bc7b34ce5596192595efadf89c86fe7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 24/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueLight.md | 111 +++++++++++-------------------------------- 1 file changed, 27 insertions(+), 84 deletions(-) diff --git a/docs/Get-HueLight.md b/docs/Get-HueLight.md index 4ec6b6f..fe1614a 100644 --- a/docs/Get-HueLight.md +++ b/docs/Get-HueLight.md @@ -1,137 +1,81 @@ Get-HueLight ------------ + ### Synopsis Gets Hue lights --- + ### Description Gets Hue lights from the Hue Bridge. --- + ### Related Links * [Get-HueBridge](Get-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-HueLight ``` --- + ### Parameters #### **Name** - The name of the light +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|---------| +|`[String[]]`|true |1 |false |LightName| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **RegularExpression** - If set, will match patterns as regular expressions +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ExactMatch** - If set, will only match exact text +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Room** - The name of the room. +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|--------| +|`[String[]]`|true |named |false |RoomName| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **LightID** - The light ID. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **New** - If set, will get recently added lights. - - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueLight [-RegularExpression] [-ExactMatch] [] @@ -148,4 +92,3 @@ Get-HueLight [-RegularExpression] [-ExactMatch] -LightID [] ``` ---- From 51f248f812c8ceebae0a0b269e6052e35b6d2753 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:18 +0000 Subject: [PATCH 25/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueResource.md | 243 +++++++++------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueResource.md b/docs/Get-HueResource.md index f3f25c6..fedf5bf 100644 --- a/docs/Get-HueResource.md +++ b/docs/Get-HueResource.md @@ -1,281 +1,141 @@ Get-HueResource --------------- + ### Synopsis Gets Hue ResourceLinks --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueResource ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueResource [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueResource -Resource [[-Name] ] [-RegularExpression] [-ExactMatch ```PowerShell Get-HueResource -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From 73c279b6c9253fbd7cacb7a5fe5a3b1af38b8cf5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 26/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueRoom.md | 243 ++++++++++---------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueRoom.md b/docs/Get-HueRoom.md index 4af4d43..6d74ac0 100644 --- a/docs/Get-HueRoom.md +++ b/docs/Get-HueRoom.md @@ -1,281 +1,141 @@ Get-HueRoom ----------- + ### Synopsis Gets Hue Groups --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueRoom ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueRoom [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueRoom -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] [- ```PowerShell Get-HueRoom -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From 6ebdf87196273732f8dc00456cf7457ff7c58ffc Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 27/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueRule.md | 243 ++++++++++---------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueRule.md b/docs/Get-HueRule.md index fd3b833..937551b 100644 --- a/docs/Get-HueRule.md +++ b/docs/Get-HueRule.md @@ -1,281 +1,141 @@ Get-HueRule ----------- + ### Synopsis Gets Hue Rules --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueRule ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueRule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueRule -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] [- ```PowerShell Get-HueRule -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From de2d8239ec8b8deee3d194656b02beab740e2836 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 28/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueScene.md | 243 +++++++++---------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueScene.md b/docs/Get-HueScene.md index 6efe738..1bbaf10 100644 --- a/docs/Get-HueScene.md +++ b/docs/Get-HueScene.md @@ -1,281 +1,141 @@ Get-HueScene ------------ + ### Synopsis Gets Hue Scenes --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueScene ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueScene [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueScene -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] [ ```PowerShell Get-HueScene -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From 0718c49d5abac0e892cf74f9948f14ae53767c62 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 29/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueSchedule.md | 243 +++++++++------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueSchedule.md b/docs/Get-HueSchedule.md index 9300f23..1bbfd74 100644 --- a/docs/Get-HueSchedule.md +++ b/docs/Get-HueSchedule.md @@ -1,281 +1,141 @@ Get-HueSchedule --------------- + ### Synopsis Gets Hue Schedules --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueSchedule ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueSchedule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueSchedule -Resource [[-Name] ] [-RegularExpression] [-ExactMatch ```PowerShell Get-HueSchedule -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From 97e3f202e8138eae98b9928b21dd608c29d92c38 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 30/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-HueSensor.md | 243 +++++++++--------------------------------- 1 file changed, 51 insertions(+), 192 deletions(-) diff --git a/docs/Get-HueSensor.md b/docs/Get-HueSensor.md index 158e79f..3754dd0 100644 --- a/docs/Get-HueSensor.md +++ b/docs/Get-HueSensor.md @@ -1,281 +1,141 @@ Get-HueSensor ------------- + ### Synopsis Gets Hue Sensors --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Get-HueSensor ``` --- + ### Parameters #### **Schedule** - If set, will get the schedules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Schedules
Timer
Timers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rule** - If set, will get the rules defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Rules
Trigger
Triggers| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Scene** - If set, will get the scenes defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Scenes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Sensor** - If set, will get the sensors defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Sensors| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Group** - If set, will get the groups (or rooms) defined on the Hue bridge +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Groups
Room
Rooms| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will get the device configuration +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Capability** - If set, will get the device capabilities +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------| +|`[Switch]`|true |named |true (ByPropertyName)|Capabilities| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Resource** - If set, will get resources defined on the device +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------------------------| +|`[Switch]`|true |named |true (ByPropertyName)|Resources
ResourceLink
ResourceLinks| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Light** - If set, will get the lights defined on the device +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Lights | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Detailed** - If set, will requery each returned resource to retreive additional information. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-HueSensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] @@ -307,4 +167,3 @@ Get-HueSensor -Resource [[-Name] ] [-RegularExpression] [-ExactMatch] ```PowerShell Get-HueSensor -Light [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Detailed] [] ``` ---- From 440557272af661cb74fb3a900cb8d5a164ae723a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:19 +0000 Subject: [PATCH 31/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-KeyLight.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/docs/Get-KeyLight.md b/docs/Get-KeyLight.md index 16ea2df..4afc131 100644 --- a/docs/Get-KeyLight.md +++ b/docs/Get-KeyLight.md @@ -1,51 +1,44 @@ Get-KeyLight ------------ + ### Synopsis Gets Elgato Key Lighting Devices --- + ### Description Gets saved Elgato Key Lighting Devices --- + ### Related Links * [Connect-KeyLight](Connect-KeyLight.md) - - * [Set-KeyLight](Set-KeyLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-KeyLight ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Twinkly device. This can be discovered thru the phone user interface. - - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-----------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|KeyLightIPAddress| --- + ### Syntax ```PowerShell Get-KeyLight [[-IPAddress] ] [] ``` ---- From 9cfc98b133d571b59b83e987b928c12b3492d9b1 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 32/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-LaMetricTime.md | 153 ++++++++++----------------------------- 1 file changed, 37 insertions(+), 116 deletions(-) diff --git a/docs/Get-LaMetricTime.md b/docs/Get-LaMetricTime.md index 546b5cf..0929904 100644 --- a/docs/Get-LaMetricTime.md +++ b/docs/Get-LaMetricTime.md @@ -1,195 +1,117 @@ Get-LaMetricTime ---------------- + ### Synopsis Gets LaMetricTime --- + ### Description Gets LaMetricTime devices. --- + ### Related Links * [Connect-LaMetricTime](Connect-LaMetricTime.md) - - * [Set-LaMetricTime](Set-LaMetricTime.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-LaMetricTime ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Get-LaMetricTime -Audio # Gets audio settings ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Get-LaMetricTime -Bluetooth # Gets bluetooth settings ``` +> EXAMPLE 4 -#### EXAMPLE 4 ```PowerShell Get-LaMetricTime -Notification # Gets notifications (there may be none) ``` +> EXAMPLE 5 -#### EXAMPLE 5 ```PowerShell Get-LaMetricTime -Audio # Gets audio settings ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of LaMetricTime devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------------| +|`[IPAddress[]]`|false |named |true (ByPropertyName)|LaMetricTimeIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Application** - If set, will get apps from an LaMetric device. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-----------------------------| +|`[Switch]`|true |named |false |App
Apps
Applications| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Audio** - If set, will get audio settings of an LaMetric Time device +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Bluetooth** - If set, will get bluetooth settings of an LaMetric Time device +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Display** - If set, will get display settings of an LaMetric Time device +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Notification** - If set, will get LaMetric Time notifications +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|-------------| +|`[Switch]`|true |named |false |Notifications| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Package** - If set, will get details about a particular package of an LaMetric Time device. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WiFi** - If set, will get wifi settings of an LaMetric Time device - - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-LaMetricTime [-IPAddress ] [] @@ -215,4 +137,3 @@ Get-LaMetricTime [-IPAddress ] -Package [] -WiFi [] ``` ---- From b4687a378c67edd1112d62d197ddc17dc159915e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 33/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-NanoLeaf.md | 196 ++++++++++--------------------------------- 1 file changed, 42 insertions(+), 154 deletions(-) diff --git a/docs/Get-NanoLeaf.md b/docs/Get-NanoLeaf.md index 1a256ef..e838f9d 100644 --- a/docs/Get-NanoLeaf.md +++ b/docs/Get-NanoLeaf.md @@ -1,9 +1,11 @@ Get-NanoLeaf ------------ + ### Synopsis Gets Nanoleaf controllers. --- + ### Description Gets connected Nanoleaf controllers on the local area network. @@ -11,226 +13,113 @@ Gets connected Nanoleaf controllers on the local area network. Can also get effects --- + ### Related Links * [Connect-NanoLeaf](Connect-NanoLeaf.md) - - * [Set-NanoLeaf](Set-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-NanoLeaf ``` --- + ### Parameters #### **IPAddress** - The IP Address of the NanoLeaf controller. +|Type |Required|Position|PipelineInput |Aliases | +|-------------|--------|--------|---------------------|--------------------------------| +|`[IPAddress]`|true |named |true (ByPropertyName)|NanoLeafIP
NanoLeafIPAddress| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NanoLeafToken** - The nanoleaf authorization token. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Panel** - If set, will get information about NanoLeaf panels. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Layout** - If set, will get information about NanoLeaf layout. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EffectName** - If provided, will get information about a particular NanoLeaf effect +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |named |true (ByPropertyName)|animName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ListPlugin** - If provided, will get information about the plugins available to use in Nanoleaf effects. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------| +|`[Switch]`|false |named |false |Plugin
Plugins| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **PluginType** - If provided, will filter out plugins of a particular type. Valid for plugins and effects. - - - Valid Values: * Rhythm * Color +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |named |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ListEffectName** - If set, will return a string list of effect names. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **ListEffect** - If set, will return a string list of effect names. +|Type |Required|Position|PipelineInput|Aliases | +|----------|--------|--------|-------------|------------------| +|`[Switch]`|false |named |false |Effect
Effects| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **CurrentEffect** - If set, will display information about the current effect. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Force** - If set, will refresh connections to all nanoleafs - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-NanoLeaf [-NanoLeafToken ] [-Panel] [-Layout] [-EffectName ] [-ListPlugin] [-PluginType ] [-ListEffectName] [-ListEffect] [-CurrentEffect] [-Force] [] @@ -238,4 +127,3 @@ Get-NanoLeaf [-NanoLeafToken ] [-Panel] [-Layout] [-EffectName ] ```PowerShell Get-NanoLeaf -IPAddress [-NanoLeafToken ] [-Panel] [-Layout] [-EffectName ] [-ListPlugin] [-PluginType ] [-ListEffectName] [-ListEffect] [-CurrentEffect] [-Force] [] ``` ---- From 2dc0334aa2f98878a52b12ff3232c0356ad39990 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 34/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-Pixoo.md | 109 +++++++++++----------------------------------- 1 file changed, 26 insertions(+), 83 deletions(-) diff --git a/docs/Get-Pixoo.md b/docs/Get-Pixoo.md index e2ebe48..5874066 100644 --- a/docs/Get-Pixoo.md +++ b/docs/Get-Pixoo.md @@ -1,135 +1,79 @@ Get-Pixoo --------- + ### Synopsis Gets Pixoo Devices --- + ### Description Gets saved Pixoo Devices --- + ### Related Links * [Connect-Pixoo](Connect-Pixoo.md) - - * [Set-Pixoo](Set-Pixoo.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-Pixoo ``` --- + ### Parameters #### **IPAddress** - The IP Address for the Pixoo device. This can be discovered thru the phone user interface or by using Find-Pixoo. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|--------------| +|`[IPAddress[]]`|false |named |true (ByPropertyName)|PixooIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Weather** - If set, will get the local weather. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|true |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Upload** - If set, will get uploads. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Uploads| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Liked** - If set, will get liked images. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Likes | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Font** - If set, will get fonts that can be used on the Pixoo. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Switch]`|true |named |false |Fonts | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Force** - If set, will clear any cached results. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Syntax ```PowerShell Get-Pixoo [-IPAddress ] [-Force] [] @@ -146,4 +90,3 @@ Get-Pixoo [-IPAddress ] -Liked [-Force] [] ```PowerShell Get-Pixoo [-IPAddress ] -Font [-Force] [] ``` ---- From 26773221f7e6ae6d5673facfac3e5077348f2eca Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 35/58] feat: $LightScript ( Fixes #104 ) --- docs/Get-Twinkly.md | 319 +++++++++----------------------------------- 1 file changed, 66 insertions(+), 253 deletions(-) diff --git a/docs/Get-Twinkly.md b/docs/Get-Twinkly.md index 4b3ca54..e08c3f1 100644 --- a/docs/Get-Twinkly.md +++ b/docs/Get-Twinkly.md @@ -1,358 +1,172 @@ Get-Twinkly ----------- + ### Synopsis Gets Twinkly --- + ### Description Gets Twinkly lights. --- + ### Related Links * [Connect-Twinkly](Connect-Twinkly.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-Twinkly ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of Twinkly devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|----------------| +|`[IPAddress[]]`|false |named |true (ByPropertyName)|TwinklyIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **OperationMode** - If set, will get the operation mode +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Layout** - If set, will get the layout of the Twinkly lights. This may take a bit. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CurrentColor** - If set, will get the color displayed when the Twinkly lights are in color mode. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-------------| +|`[Switch]`|true |named |true (ByPropertyName)|CurrentColour| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ListEffect** - If set, will list the available effects. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------| +|`[Switch]`|true |named |true (ByPropertyName)|ListEffects| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CurrentEffect** - If set, will show the current effect. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Configuration** - If set, will list the configuration of each LED. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|true |named |true (ByPropertyName)|Config | - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Brightness** - If set, will output the brightness levels. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Saturation** - If set, will output the saturation levels. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ListMovie** - If set, will output the list of movies. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CurrentMovie** - If set, will output the list of movies. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieConfiguration** - If set, will output movie configuration. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Playlist** - If set, will output the playlists. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|true |named |true (ByPropertyName)|Playlists| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CurrentPlaylistItem** - If set, will output the current playlist item. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MQTTConfiguration** - If set, will output the MQTT configuration. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------| +|`[Switch]`|true |named |true (ByPropertyName)|MQTTConfig| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Summary** - If set, will output the summary. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NetworkStatus** - If set, will output the network status. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FirmwareVersion** - If set, will output the network status. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Timer** - If set, will output timers associated with each device. - - -> **Type**: ```[Switch]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|true |named |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Get-Twinkly [-IPAddress ] [] @@ -411,4 +225,3 @@ Get-Twinkly [-IPAddress ] -FirmwareVersion [] ```PowerShell Get-Twinkly [-IPAddress ] -Timer [] ``` ---- From ca6a4420a18c9820d51a969e08c89894f19de84a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 36/58] feat: $LightScript ( Fixes #104 ) --- docs/Read-HueSensor.md | 103 ++++++++++------------------------------- 1 file changed, 24 insertions(+), 79 deletions(-) diff --git a/docs/Read-HueSensor.md b/docs/Read-HueSensor.md index 7be606f..7f185d5 100644 --- a/docs/Read-HueSensor.md +++ b/docs/Read-HueSensor.md @@ -1,138 +1,83 @@ Read-HueSensor -------------- + ### Synopsis Reads Hue Sensors --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Read-HueSensor -Name Daylight ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Config** - If set, will read values from the configuration. By default, values are read from the sensor state. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Read-HueSensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Config] [] ``` ---- From 884b1bd02ae3aad8d4ce997601ea2a7682e802ee Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 37/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueResource.md | 89 ++++++++++---------------------------- 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueResource.md b/docs/Remove-HueResource.md index 67fdd52..83b35e9 100644 --- a/docs/Remove-HueResource.md +++ b/docs/Remove-HueResource.md @@ -1,126 +1,83 @@ Remove-HueResource ------------------ + ### Synopsis Removes Hue ResourceLinks --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueResource -Name 'HueResourceName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueResource [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From 383c1b8e894ccce31d685ee1167e5e28e40b8fe7 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:20 +0000 Subject: [PATCH 38/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueRoom.md | 89 +++++++++++------------------------------- 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueRoom.md b/docs/Remove-HueRoom.md index 6a6c663..6671a91 100644 --- a/docs/Remove-HueRoom.md +++ b/docs/Remove-HueRoom.md @@ -1,126 +1,83 @@ Remove-HueRoom -------------- + ### Synopsis Removes Hue Groups --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueRoom -Name 'HueRoomName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueRoom [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From 3e91eb9c4af716ddd505afdca6465f735a8b3749 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 39/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueRule.md | 89 +++++++++++------------------------------- 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueRule.md b/docs/Remove-HueRule.md index 4471469..b3f61ae 100644 --- a/docs/Remove-HueRule.md +++ b/docs/Remove-HueRule.md @@ -1,126 +1,83 @@ Remove-HueRule -------------- + ### Synopsis Removes Hue Rules --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueRule -Name 'HueRuleName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueRule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From 1fa265b57ad42616e64aad972f286e34b41001c9 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 40/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueScene.md | 89 +++++++++++------------------------------ 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueScene.md b/docs/Remove-HueScene.md index f450173..f6e72b8 100644 --- a/docs/Remove-HueScene.md +++ b/docs/Remove-HueScene.md @@ -1,126 +1,83 @@ Remove-HueScene --------------- + ### Synopsis Removes Hue Scenes --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueScene -Name 'HueSceneName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueScene [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From 181d0d383e50f2574616a089671efe5989ecdd28 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 41/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueSchedule.md | 89 ++++++++++---------------------------- 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueSchedule.md b/docs/Remove-HueSchedule.md index 042294a..8d13dea 100644 --- a/docs/Remove-HueSchedule.md +++ b/docs/Remove-HueSchedule.md @@ -1,126 +1,83 @@ Remove-HueSchedule ------------------ + ### Synopsis Removes Hue Schedules --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueSchedule -Name 'HueScheduleName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueSchedule [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From a9da93c372693f4c8d4186d94ad1f7b42f678b6f Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 42/58] feat: $LightScript ( Fixes #104 ) --- docs/Remove-HueSensor.md | 89 +++++++++++----------------------------- 1 file changed, 23 insertions(+), 66 deletions(-) diff --git a/docs/Remove-HueSensor.md b/docs/Remove-HueSensor.md index f021b6d..9784547 100644 --- a/docs/Remove-HueSensor.md +++ b/docs/Remove-HueSensor.md @@ -1,126 +1,83 @@ Remove-HueSensor ---------------- + ### Synopsis Removes Hue Sensors --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Remove-HueSensor -Name 'HueSensorName' ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Remove-HueSensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-WhatIf] [-Confirm] [] ``` ---- From c34aa40b660cf00678cec793d26a6b8cbee09796 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 43/58] feat: $LightScript ( Fixes #104 ) --- docs/Rename-HueLight.md | 49 +++++++++++++---------------------------- 1 file changed, 15 insertions(+), 34 deletions(-) diff --git a/docs/Rename-HueLight.md b/docs/Rename-HueLight.md index c26ba2c..dad84e1 100644 --- a/docs/Rename-HueLight.md +++ b/docs/Rename-HueLight.md @@ -1,75 +1,56 @@ Rename-HueLight --------------- + ### Synopsis Renames Hue Lights --- + ### Description Renames one or more Hue lights. --- + ### Related Links * [Get-HueBridge](Get-HueBridge.md) - - * [Get-HueLight](Get-HueLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Rename-HueLight ``` --- + ### Parameters #### **OldName** - The old name of the light. This can be a wildcard or regular expression. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|ID | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NewName** - The new name of the light. A number sign will be replaced with the match number. - - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Rename-HueLight [-OldName] [-NewName] [] ``` ---- From 2423d0ec5a59c7e9c0552f1fc6667d1c52a789b1 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 44/58] feat: $LightScript ( Fixes #104 ) --- docs/Rename-HueSensor.md | 49 ++++++++++++---------------------------- 1 file changed, 15 insertions(+), 34 deletions(-) diff --git a/docs/Rename-HueSensor.md b/docs/Rename-HueSensor.md index c130b13..d8b0abc 100644 --- a/docs/Rename-HueSensor.md +++ b/docs/Rename-HueSensor.md @@ -1,75 +1,56 @@ 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 +> EXAMPLE 1 + ```PowerShell Rename-HueSensor ``` --- + ### Parameters #### **OldName** - The old name of the Sensor. This can be a wildcard or regular expression. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[String]`|true |1 |true (ByPropertyName)|ID | - -> **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) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |2 |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Rename-HueSensor [-OldName] [-NewName] [] ``` ---- From 738061b1c9aa6ebac67cfe868157129ad15b57d8 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 45/58] feat: $LightScript ( Fixes #104 ) --- docs/Search-LaMetricIcon.md | 59 +++++++++++-------------------------- 1 file changed, 17 insertions(+), 42 deletions(-) diff --git a/docs/Search-LaMetricIcon.md b/docs/Search-LaMetricIcon.md index 6d51efb..7e07487 100644 --- a/docs/Search-LaMetricIcon.md +++ b/docs/Search-LaMetricIcon.md @@ -1,81 +1,56 @@ Search-LaMetricIcon ------------------- + ### Synopsis Searchs for LaMetricIcons --- + ### Description Searches for icons for LaMetric Time and other LaMetric devices. --- + ### Related Links * [Get-LaMetricTime](Get-LaMetricTime.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Search-LaMetricIcon "PowerShell" ``` --- + ### Parameters #### **IconName** - The name of the icon we are searching for +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------| +|`[String]`|true |1 |true (ByPropertyName)|Title
Query
Name| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Page** - The page count. By default, zero. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PageSize** - The page size. By default, 100. - - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| --- + ### Syntax ```PowerShell Search-LaMetricIcon [-IconName] [-Page ] [-PageSize ] [] ``` ---- From c753f7d30113dc0d549812f110739c549ff2ef79 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:21 +0000 Subject: [PATCH 46/58] feat: $LightScript ( Fixes #104 ) --- docs/Send-HueBridge.md | 133 ++++++++++------------------------------- 1 file changed, 32 insertions(+), 101 deletions(-) diff --git a/docs/Send-HueBridge.md b/docs/Send-HueBridge.md index ad48a4d..1410fee 100644 --- a/docs/Send-HueBridge.md +++ b/docs/Send-HueBridge.md @@ -1,172 +1,103 @@ Send-HueBridge -------------- + ### Synopsis Sends messages to a HueBridge --- + ### Description Sends messages to a Hue Bridge --- + ### Related Links * [Get-HueBridge](Get-HueBridge.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Get-HueBridge | Send-HueBridge -Command lights ``` --- + ### Parameters #### **IPAddress** - The IP address of the hue bridge. +|Type |Required|Position|PipelineInput | +|-------------|--------|--------|---------------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **HueUserName** - The hue user name +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------------| +|`[String]`|true |2 |true (ByPropertyName)|UserName
AuthToken| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Command** - The command being sent to the bridge. This is a partial URI. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------| +|`[String]`|false |3 |true (ByPropertyName)|Uri
Url| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Body** - The data being sent to the Hue Bridge. If this data is not a string, it will be converted to JSON. +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[PSObject]`|false |4 |true (ByPropertyName)|Data | - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Method** - The HTTP method. By default, Get. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **OutputInput** - If set, will output the data that would be sent to the bridge. This is useful for creating scheudles, routines, and other macros. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputParameter
OutputParameters
OutputArgument
OutputArguments| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PSTypeName** - If provided, will set the .pstypenames on output objects. This enables the PowerShell types and formatting systems. +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------| +|`[String[]]`|false |6 |true (ByPropertyName)|Decorate| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Send-HueBridge [-IPAddress] [-HueUserName] [[-Command] ] [[-Body] ] [[-Method] ] [-OutputInput] [[-PSTypeName] ] [-WhatIf] [-Confirm] [] ``` ---- From 48f8a597da81105d9cb32f81a1a8906beb103448 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:22 +0000 Subject: [PATCH 47/58] feat: $LightScript ( Fixes #104 ) --- docs/Send-NanoLeaf.md | 165 ++++++++++-------------------------------- 1 file changed, 38 insertions(+), 127 deletions(-) diff --git a/docs/Send-NanoLeaf.md b/docs/Send-NanoLeaf.md index ef92895..ffb05a7 100644 --- a/docs/Send-NanoLeaf.md +++ b/docs/Send-NanoLeaf.md @@ -1,203 +1,114 @@ Send-NanoLeaf ------------- + ### Synopsis Sends messages to a NanoLeaf --- + ### Description Sends HTTP messages to a NanoLeaf --- + ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Send-NanoLeaf -Command effects/effectsList ``` --- + ### Parameters #### **IPAddress** - The IP Address of the NanoLeaf. +|Type |Required|Position|PipelineInput | +|-------------|--------|--------|---------------------| +|`[IPAddress]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[IPAddress]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Command** - The URI fragment to send to the nanoleaf. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |2 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **Method** - The HTTP method to send. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Data** - The data to send. This will be converted into JSON if it is not a string. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[PSObject]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Property** - A set of additional properties to add to an object +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RemoveProperty** - A list of property names to remove from an object +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[String[]]`|false |6 |false | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:false - - - ---- #### **ExpandProperty** - If provided, will expand a given property returned from the REST api. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|false |7 |false | - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:false - - - ---- #### **PSTypeName** - The typename of the results. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NanoLeafToken** - The nanoleaf token +|Type |Required|Position|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)]```. -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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Send-NanoLeaf [-IPAddress] [[-Command] ] [[-Method] ] [[-Data] ] [[-Property] ] [[-RemoveProperty] ] [[-ExpandProperty] ] [[-PSTypeName] ] [[-NanoLeafToken] ] [-WhatIf] [-Confirm] [] ``` ---- From b7da55da9a1510152d9bb85ab6f2168050d224f3 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:22 +0000 Subject: [PATCH 48/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-HueLight.md | 361 ++++++++++--------------------------------- 1 file changed, 78 insertions(+), 283 deletions(-) diff --git a/docs/Set-HueLight.md b/docs/Set-HueLight.md index 80598f4..d57a369 100644 --- a/docs/Set-HueLight.md +++ b/docs/Set-HueLight.md @@ -1,440 +1,236 @@ Set-HueLight ------------ + ### Synopsis Sets Hue light state --- + ### Description Changes the state of one or more Hue lights --- + ### Related Links * [Get-HueLight](Get-HueLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-HueLight -Name *Lightstrip* -Luminance 0.05 # Set any Hue lights named Hue lightstrip to be very dim ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell LivingRoom -On -ColorTemperature 500 -Brightness .1 # Room names and light names are automatically aliased to Set-HueLight. # This gives all lights in the living room a warm glow. ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Set-HueLight -Alert select # Make all of the lights blink once ``` +> EXAMPLE 4 -#### EXAMPLE 4 ```PowerShell Set-HueLight -Effect colorloop # Set all lights to color loop ``` +> EXAMPLE 5 -#### EXAMPLE 5 ```PowerShell Set-HueLight -Effect none # Make all of the lights stop looping color ``` +> EXAMPLE 6 -#### EXAMPLE 6 ```PowerShell Set-HueLight -RGBColor "#ff0000" # Make all lights red ``` +> EXAMPLE 7 -#### EXAMPLE 7 ```PowerShell Set-HueLight -Hue 120 -Saturation .8 -Brightness .6 # Make all lights green ``` +> EXAMPLE 8 -#### EXAMPLE 8 ```PowerShell Set-HueLight -HueIncrement 60 # Move the hue of all lights ``` --- + ### Parameters #### **Name** - The name of the Hue light +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|---------| +|`[String[]]`|true |1 |true (ByPropertyName)|LightName| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RoomName** - The name of the Hue room +|Type |Required|Position|PipelineInput|Aliases | +|------------|--------|--------|-------------|----------------------------| +|`[String[]]`|true |1 |false |Group
GroupName
Room| - -> **Type**: ```[String[]]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **LightID** - The identifier of the Hue light +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|true |1 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **GroupID** - The identifier of the Hue group +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[String]`|true |1 |false | - -> **Type**: ```[String]``` - -> **Required**: true - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **TransitionTime** - The transition time. This is how long it will take light to change from it's current state to the one you've set +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **On** - If set, will switch the light on +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Off** - If set, will switch the light off +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RGBColor** - Sets lights to an RGB color +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Hue** - The desired hue (ranged 0-360) +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Single]`|false |named |true (ByPropertyName)|H | - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Saturation** - The desired saturation (ranged 0-1) +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Single]`|false |named |true (ByPropertyName)|S | - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Brightness** - The desired brightness (ranged 0-1) +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Single]`|false |named |true (ByPropertyName)|B
L
Luminance
.bri| - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Effect** - The effect - - - Valid Values: * colorloop * none +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Alert** - The alert - - - Valid Values: * select * lselect * none +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ColorTemperature** - The color temperature as a Mired value. +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|-----------------------| +|`[Int32]`|false |named |true (ByPropertyName)|CT
TemperatureMired| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **XY** - The color, in XY coordinates. +|Type |Required|Position|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. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Single]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BrightnessIncrement** - An increment in luminance. This will adjust the brightness of the light. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------| +|`[Single]`|false |named |true (ByPropertyName)|LuminanceIncrement| - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **HueIncrement** - An increment in hue. This will adjust the hue +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ColorTemperatureIncrement** - A change in the color temperature. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **OutputInput** - If set, will output the data that would be sent to the bridge. This is useful for creating scheudles, routines, and other macros. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------------------------------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|OutputParameter
OutputParameters
OutputArgument
OutputArguments| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Set-HueLight [[-TransitionTime] ] [-On] [-Off] [-RGBColor ] [-Hue ] [-Saturation ] [-Brightness ] [-Effect ] [-Alert ] [-ColorTemperature ] [-XY ] [-SaturationIncrement ] [-BrightnessIncrement ] [-HueIncrement ] [-ColorTemperatureIncrement ] [-OutputInput] [-WhatIf] [-Confirm] [] @@ -451,4 +247,3 @@ Set-HueLight [-LightID] [[-TransitionTime] ] [-On] [-Off] [-R ```PowerShell Set-HueLight [-GroupID] [[-TransitionTime] ] [-On] [-Off] [-RGBColor ] [-Hue ] [-Saturation ] [-Brightness ] [-Effect ] [-Alert ] [-ColorTemperature ] [-XY ] [-SaturationIncrement ] [-BrightnessIncrement ] [-HueIncrement ] [-ColorTemperatureIncrement ] [-OutputInput] [-WhatIf] [-Confirm] [] ``` ---- From 510145d6d01c2687000c2281505cfd3ff3307753 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:22 +0000 Subject: [PATCH 49/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-HueRule.md | 136 ++++++++++++-------------------------------- 1 file changed, 37 insertions(+), 99 deletions(-) diff --git a/docs/Set-HueRule.md b/docs/Set-HueRule.md index 03018ff..140533e 100644 --- a/docs/Set-HueRule.md +++ b/docs/Set-HueRule.md @@ -1,26 +1,27 @@ Set-HueRule ----------- + ### Synopsis Sets a Hue Rule --- + ### Description Sets a Hue Rule. Hue Rules are used to automatically change your Hue Lights and devices when conditions occur. --- + ### Related Links * [Get-HueRule](Get-HueRule.md) - - * [Remove-HueRule](Remove-HueRule.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-HueRule -Condition { "/sensors/55/state/status" -eq "1" @@ -28,18 +29,17 @@ Set-HueRule -Condition { Set-HueLight -Name "Sunroom*" -ColorTemperature 420 } -Name BrightenRoom ``` +Set a rule that when -#### 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 -#### EXAMPLE 3 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "4003" @@ -47,8 +47,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -Off } -Name SunroomDimmerHoldDownToTurnOff ``` +> EXAMPLE 4 -#### EXAMPLE 4 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1003" @@ -56,8 +56,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -On } -Name SunroomDimmerHoldUpToTurnOn ``` +> EXAMPLE 5 -#### EXAMPLE 5 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "1002" @@ -65,8 +65,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -On -Brightness .8 } -Name SunroomDimmerTapOn ``` +> EXAMPLE 6 -#### EXAMPLE 6 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2003" @@ -74,8 +74,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .1 } -Name SunroomDimmerHoldBright ``` +> EXAMPLE 7 -#### EXAMPLE 7 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "2002" @@ -83,8 +83,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -BrightnessIncrement .05 } -Name SunroomDimmerTapBright ``` +> EXAMPLE 8 -#### EXAMPLE 8 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3002" @@ -92,8 +92,8 @@ Set-HueRule -Condition { Set-HueLight -RoomName "Sunroom" -BrightnessIncrement -.05 } -Name SunroomDimmerTapDarken ``` +> EXAMPLE 9 -#### EXAMPLE 9 ```PowerShell Set-HueRule -Condition { "/sensors/SunroomDimmerSwitch/state/buttonevent" -eq "3003" @@ -103,47 +103,27 @@ Set-HueRule -Condition { ``` --- + ### Parameters #### **Name** - The name of the rule. +|Type |Required|Position|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 |Required|Position|PipelineInput|Aliases | +|--------------|--------|--------|-------------|----------| +|`[PSObject[]]`|true |2 |false |Conditions| - -> **Type**: ```[PSObject[]]``` - -> **Required**: true - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **Action** - The action. If this value is a Script Block, only commands from this module that have the parameter -OutputInput may be called. If the input is a ScriptBlock @@ -154,92 +134,50 @@ comes from this module and has the -OutputInput parameter. Otherwise, check for the required properties. +|Type |Required|Position|PipelineInput|Aliases| +|--------------|--------|--------|-------------|-------| +|`[PSObject[]]`|true |3 |false |Actions| - -> **Type**: ```[PSObject[]]``` - -> **Required**: true - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **DeviceID** - If provided, the schedule will only run on the bridge with a particular device ID +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **IPAddress** - If provided, the schedule will only run on the bridge found at the provided IP address +|Type |Required|Position|PipelineInput |Aliases| +|-------------|--------|--------|---------------------|-------| +|`[IPAddress]`|false |named |true (ByPropertyName)|IP | - -> **Type**: ```[IPAddress]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Disable** - If set, will disable the rule. +|Type |Required|Position|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 * [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] [-WhatIf] [-Confirm] [] ``` ---- From 47173f2c051c7ffd3271bc9461ab819db6f3276b Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:22 +0000 Subject: [PATCH 50/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-KeyLight.md | 97 ++++++++++++-------------------------------- 1 file changed, 25 insertions(+), 72 deletions(-) diff --git a/docs/Set-KeyLight.md b/docs/Set-KeyLight.md index 4bdf2b3..4aa02c5 100644 --- a/docs/Set-KeyLight.md +++ b/docs/Set-KeyLight.md @@ -1,130 +1,83 @@ Set-KeyLight ------------ + ### Synopsis Sets Elgato Key Lighting --- + ### Description Changes Elgato Key Lighting --- + ### Related Links * [Get-KeyLight](Get-KeyLight.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-KeyLight -Brightness .5 ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of Elgato Key Lighting devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|-----------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|KeyLightIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Brightness** - Sets the brightness of all lights in a fixture When passed with -Hue and -Saturation, sets the color When passed with no other parameters, adjusts the absolute brightness +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Single]`|false |2 |true (ByPropertyName)|Luminance| - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **On** - If set, will turn the light on. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Off** - If set, will turn the light on. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ColorTemperature** - The color temperature as a Mired value. +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|-----------------------| +|`[Int32]`|false |3 |true (ByPropertyName)|CT
TemperatureMired| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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. --- + ### Syntax ```PowerShell Set-KeyLight [[-IPAddress] ] [[-Brightness] ] [-On] [-Off] [[-ColorTemperature] ] [-WhatIf] [-Confirm] [] ``` ---- From b8736f985d0c476d817f48feca669800fce1326e Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:22 +0000 Subject: [PATCH 51/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-LaMetricTime.md | 344 +++++++++------------------------------ 1 file changed, 75 insertions(+), 269 deletions(-) diff --git a/docs/Set-LaMetricTime.md b/docs/Set-LaMetricTime.md index 80d9327..cbe196a 100644 --- a/docs/Set-LaMetricTime.md +++ b/docs/Set-LaMetricTime.md @@ -1,126 +1,103 @@ Set-LaMetricTime ---------------- + ### Synopsis Sets a LaMetricTime device. --- + ### Description Configures or sends notifications to an LaMetricTime device. --- + ### Related Links * [Get-LaMetricTime](Get-LaMetricTime.md) - - * [Connect-LaMetrictime](Connect-LaMetrictime.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-LaMetricTime -Clock # Set LaMetricTime devices into clock mode ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Set-LaMetricTime -Weather # Set LaMetricTime devices into weather forecast mode ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Set-LaMetricTime -NotificationText "Hello World" # Send a notification to the LaMetric time device. ``` +> EXAMPLE 4 -#### EXAMPLE 4 ```PowerShell Set-LaMetricTime -NotificationText "$" -NotificationSound cash ``` +Find an icon -#### EXAMPLE 5 ```PowerShell -# Find an icon Search-LaMetricIcon "PowerShell" | Select-Object -First 1 | # pick the first one Set-LaMetricTime -NotificationText "Hello PowerShell" # and display the notification ``` +> EXAMPLE 6 -#### EXAMPLE 6 ```PowerShell Set-LaMetricTime -Stopwatch start # Starts a stopwatch ``` +> EXAMPLE 7 -#### EXAMPLE 7 ```PowerShell Set-LaMetricTime -Stopwatch stop # Stops a stopwatch ``` +> EXAMPLE 8 -#### EXAMPLE 8 ```PowerShell Set-LaMetricTime -Stopwatch reset # Resets a stopwatch ``` +> EXAMPLE 9 -#### EXAMPLE 9 ```PowerShell Set-LaMetricTime -Timer "00:01:00" # Sets a timer for a minute ``` +> EXAMPLE 10 -#### EXAMPLE 10 ```PowerShell Set-LaMetricTime -NextApplication # Switches to the next application ``` +> EXAMPLE 11 -#### EXAMPLE 11 ```PowerShell Set-LaMetricTime -PreviousApplication # Switches to the previous application ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of LaMetricTime devices. If no IP Addresses are provided, the change will apply to all devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|---------------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|LaMetricTimeIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Clock** - If set, will switch the LaMetric Time into clock mode. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Switch]`|false |named |true (ByPropertyName)|ShowClock| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Stopwatch** - If provided, will switch the LaMetric Time into Stopwatch mode, and Stop/Pause, Reset, or Start the StopWatch - - - Valid Values: * Stop @@ -128,146 +105,63 @@ Valid Values: * Start * Reset +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **LastApplication** - If set, will switch to the previous application on the LaMetric Time. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------------------------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|LastApp
Last
Prev
Previous
PreviousApp
PreviousApplication| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NextApplication** - If set, will switch to the next application on the LaMetric Time. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|----------------| +|`[Switch]`|false |named |true (ByPropertyName)|NextApp
Next| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NotificationText** - One or more messages of notification text +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NotificationIcon** - One or more notification icons. +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[String[]]`|false |4 |true (ByPropertyName)|IconID | - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NotificationDuration** - The duration of the notification. By default, 15 seconds. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NotificationLoopCount** - The number of times to display the notification. Zero or less will be considered an indefinite notification +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|---------| +|`[Int32]`|false |6 |true (ByPropertyName)|LoopCount| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **LoopNotification** - If set, will indefinitely loop the notification. +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|Loop | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NotificationSound** - If provided, will play a sound with the notification. - - - Valid Values: * alarm1 @@ -319,161 +213,73 @@ Valid Values: * wind * wind_short +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CancelNotification** - If provided, will cancel a given notification. If 0 or less is provided, will cancel all notifications. +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|--------------| +|`[Int32]`|false |8 |true (ByPropertyName)|NotificationID| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Timer** - Sets a Timer on the LaMetric device, using the built-in Countdown app. +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Weather** - If set, will switch the LaMetric Time into weather forecast mode. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|-----------------------------------------| +|`[Switch]`|false |named |true (ByPropertyName)|Forecast
ShowForecast
ShowWeather| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Volume** - Sets the volume of an LaMetric Time device. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |10 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Package** - If set, will switch to a given app. If -Widget is not provided, the first widget will be used. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |11 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WidgetID** - The widget of a given application that should be activated. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |12 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WidgetActionId** - The name of the widget action id. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |13 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **WidgetProperty** - A set of properties to pass to a given widget. Must be provided with -WidgetSetting If no properties are provided, the widget will be activated. - - -> **Type**: ```[PSObject]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput |Aliases | +|------------|--------|--------|---------------------|--------------------------------| +|`[PSObject]`|false |14 |true (ByPropertyName)|WidgetParameter
WidgetParams| --- + ### Syntax ```PowerShell Set-LaMetricTime [[-IPAddress] ] [-Clock] [[-Stopwatch] ] [-LastApplication] [-NextApplication] [[-NotificationText] ] [[-NotificationIcon] ] [[-NotificationDuration] ] [[-NotificationLoopCount] ] [-LoopNotification] [[-NotificationSound] ] [[-CancelNotification] ] [[-Timer] ] [-Weather] [[-Volume] ] [[-Package] ] [[-WidgetID] ] [[-WidgetActionId] ] [[-WidgetProperty] ] [] ``` ---- From e8e5ae6043fba09266222325271d3a8529258c7a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 52/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-NanoLeaf.md | 425 +++++++++---------------------------------- 1 file changed, 90 insertions(+), 335 deletions(-) diff --git a/docs/Set-NanoLeaf.md b/docs/Set-NanoLeaf.md index 77c2970..9648a12 100644 --- a/docs/Set-NanoLeaf.md +++ b/docs/Set-NanoLeaf.md @@ -1,339 +1,191 @@ Set-NanoLeaf ------------ + ### Synopsis Changes settings on a NanoLeaf. --- + ### Description Changes settings on one or more NanoLeaf controllers. --- + ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) - - * [Send-NanoLeaf](Send-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-NanoLeaf -ColorTemperature 1999 ``` +> EXAMPLE 2 -#### EXAMPLE 2 ```PowerShell Set-NanoLeaf -Hue (Get-Random -Min 0 -Max 360) -Saturation ((Get-Random -Min 0 -Max 1)/100) -Brightness ((Get-Random -Min 0 -Max 1)/100) ``` +> EXAMPLE 3 -#### EXAMPLE 3 ```PowerShell Set-NanoLeaf -EffectName Blaze ``` +> EXAMPLE 4 -#### EXAMPLE 4 ```PowerShell Set-NanoLeaf -Palette "#fedcba", "#abcdef" # Fade between two colors ``` +Flow between two colors -#### EXAMPLE 5 ```PowerShell -# Flow between two colors Set-NanoLeaf -Palette "#fedcba", "#abcdef" -PluginName Flow ``` +Flow downward between two colors -#### EXAMPLE 6 ```PowerShell -# Flow downward between two colors Set-NanoLeaf -Palette "#abcdef", "#890aef" -PluginName Flow -PluginOption @{linDirection="down"} ``` +Make a color wheel -#### EXAMPLE 7 ```PowerShell -# Make a color wheel Set-NanoLeaf -Palette "#012345", "#543210" -PluginName Wheel ``` +Make a color wheel that rotates as slowly as it can, counter clockwise -#### EXAMPLE 8 ```PowerShell -# Make a color wheel that rotates as slowly as it can, counter clockwise Set-NanoLeaf -Palette "#012345", "#543210" -PluginName Wheel -PluginOption @{rotDirection="ccw";delayTime=600;transTime=600} ``` +Set up a Rhythm based RGB Fireworks -#### EXAMPLE 9 ```PowerShell -# Set up a Rhythm based RGB Fireworks Set-NanoLeaf -Palette "#ff0000", "#000000", "#00ff00", "#000000", "#0000ff", "#000000" -PluginName Fireworks -PluginType Rhythm ``` +Set up a Rhythm based RGB Fireworks, with a very short flash -#### EXAMPLE 10 ```PowerShell -# Set up a Rhythm based RGB Fireworks, with a very short flash Set-NanoLeaf -Palette "#ff0000", "#00ff00", "#0000ff", "#000000" -PluginName Fireworks -PluginType Rhythm -PluginOption @{ delayTime = 1 transTime = 1 } ``` +> EXAMPLE 11 -#### EXAMPLE 11 ```PowerShell Set-NanoLeaf -Palette "#123456", "#654321", "#abcdef", "#fedcba" -PluginType Rhythm -PluginName 'Dancing Duo' ``` --- + ### Parameters #### **Off** - If set, will turn the nanoleaf off +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **On** - If set, will turn the nanoleaf on +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Hue** - The hue of the NanoLeaf light color. +|Type |Required|Position|PipelineInput|Aliases| +|---------|--------|--------|-------------|-------| +|`[Int32]`|false |1 |false |H | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:false - - - ---- #### **HueIncrement** - Increments the hue of the NanoLeaf light color. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |2 |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:false - - - ---- #### **Saturation** - The saturation of the NanoLeaf light color. +|Type |Required|Position|PipelineInput|Aliases| +|----------|--------|--------|-------------|-------| +|`[Double]`|false |3 |false |S | - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:false - - - ---- #### **SaturationIncrement** - Increments the saturation of the NanoLeaf light color. +|Type |Required|Position|PipelineInput| +|---------|--------|--------|-------------| +|`[Int32]`|false |4 |false | - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:false - - - ---- #### **Brightness** - The brightness. If no other parameters are provided, adjusts universal brightness. If provided with -Hue and -Saturation, sets the color of all panels. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------------------| +|`[Double]`|false |5 |true (ByPropertyName)|B
L
Luminance
.bri| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BrightnessIncrement** - The brightness increment. If no other parameters are provided, adjusts universal brightness. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|------------------| +|`[Double]`|false |6 |true (ByPropertyName)|LuminanceIncrement| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ColorTemperature** - If set, will change all panels on the nanoleaf to a given color temperature. +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|------------------------| +|`[Int32]`|false |7 |true (ByPropertyName)|CT
TemperatureKelvin| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EffectName** - The name of the effect. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------| +|`[String]`|false |8 |true (ByPropertyName)|animName| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Duration** - The duration to display. In most contexts, this will be rounded to the nearest second. +|Type |Required|Position|PipelineInput| +|------------|--------|--------|-------------| +|`[TimeSpan]`|false |9 |false | - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:false - - - ---- #### **ExternalControl** - If set, will set the NanoLeaf for external control via UDP. If provided with -Panel, will set panels via UDP. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PluginName** - The name of the effect plugin. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |10 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Palette** - The palette used for an effect. +|Type |Required|Position|PipelineInput |Aliases | +|--------------|--------|--------|---------------------|--------| +|`[PSObject[]]`|false |11 |true (ByPropertyName)|RGBColor| - -> **Type**: ```[PSObject[]]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EffectType** - The type of effect. - - - Valid Values: * Plugin @@ -345,86 +197,41 @@ Valid Values: * Custom * Static +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |12 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PluginUuid** - The plugin UUID. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |13 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **PluginType** - The plugin type. - - - Valid Values: * Rhythm * Color +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |14 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Panel** - Detailed colors for each panel. The key will be the panel ID. The value will be an RGB color for the panel, followed by an optional timespan. Timespans will be ignored when sending colors via UDP. +|Type |Required|Position|PipelineInput | +|---------------|--------|--------|---------------------| +|`[IDictionary]`|false |15 |true (ByPropertyName)| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 15 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **EffectOption** - The effect options. - Plugins can use any of the Nanoleaf-approved option types to further control how panels render light. - |Option | type | limits | description | |---------------|-------|----------------------|---------------------------------------------------------------------------| |transTime | int |1-600 |The time it takes to go from one palette colour to another (tenths/second).| @@ -436,109 +243,57 @@ Plugins can use any of the Nanoleaf-approved option types to further control how |nColorsPerFrame|int |1-50 | Modifier that indicates how much of a palette is shown on the layout. | |mainColorProb |double |0.0-100.0 | Probability of background colour being used | +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|------------------------------------------------| +|`[IDictionary]`|false |16 |true (ByPropertyName)|PluginOption
PluginOptions
EffectOptions| - -> **Type**: ```[IDictionary]``` - -> **Required**: false - -> **Position**: 16 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Loop** - If set, will mark the effect to loop. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **AsByteStream** - If set, will set panels using UDP. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **IPAddress** - The IP Address of the NanoLeaf. +|Type |Required|Position|PipelineInput | +|-------------|--------|--------|---------------------| +|`[IPAddress]`|false |17 |true (ByPropertyName)| - -> **Type**: ```[IPAddress]``` - -> **Required**: false - -> **Position**: 17 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NanoLeafToken** - The nanoleaf token +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |18 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 18 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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 * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Set-NanoLeaf [-Off] [-On] [[-Hue] ] [[-HueIncrement] ] [[-Saturation] ] [[-SaturationIncrement] ] [[-Brightness] ] [[-BrightnessIncrement] ] [[-ColorTemperature] ] [[-EffectName] ] [[-Duration] ] [-ExternalControl] [[-PluginName] ] [[-Palette] ] [[-EffectType] ] [[-PluginUuid] ] [[-PluginType] ] [[-Panel] ] [[-EffectOption] ] [-Loop] [-AsByteStream] [[-IPAddress] ] [[-NanoLeafToken] ] [-WhatIf] [-Confirm] [] ``` ---- From 77ad510ef88525ac0bf90575236788be7fbd410c Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 53/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-Pixoo.md | 432 ++++++++++------------------------------------ 1 file changed, 87 insertions(+), 345 deletions(-) diff --git a/docs/Set-Pixoo.md b/docs/Set-Pixoo.md index 8a76d74..b678ded 100644 --- a/docs/Set-Pixoo.md +++ b/docs/Set-Pixoo.md @@ -1,201 +1,109 @@ Set-Pixoo --------- + ### Synopsis Sets Pixoo Frames --- + ### Description Changes Pixoo Frames --- + ### Related Links * [Get-Pixoo](Get-Pixoo.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-Pixoo -Brightness 1 ``` +Set the pixoo to the 3rd visualizer (a nice frequency graph) -#### EXAMPLE 2 ```PowerShell -# Set the pixoo to the 3rd visualizer (a nice frequency graph) Set-Pixoo -Visualizer 3 ``` +The timer will elapse after 30 seconds. -#### EXAMPLE 3 ```PowerShell -# The timer will elapse after 30 seconds. Set-Pixoo -Timer "00:00:30" ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of Pixoo devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|--------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|PixooIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Brightness** - Sets the brightness of all lights in a fixture When passed with -Hue and -Saturation, sets the color When passed with no other parameters, adjusts the absolute brightness +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Single]`|false |2 |true (ByPropertyName)|Luminance| - -> **Type**: ```[Single]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Hue** - Sets the hue of all lights in a fixture +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Saturation** - Sets the saturation of all lights in a fixture +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |4 |true (ByPropertyName)| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **On** - If set, will turn a Pixoo screen on. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Off** - If set, will turn a Pixoo screen off. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Visualizer** - If provided, will switch the Pixoo to a given numbered visualizer +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CustomPlaylist** - If provided, will switch the Pixoo custom playlist +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **CloudChannel** - If provided, will switch the Pixoo's current Cloud Channel. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Channel** - If provided, will switch the Pixoo channel. - - - Valid Values: * Clock @@ -203,174 +111,78 @@ Valid Values: * Visualizer * Custom +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Stopwatch** - If provided, will switch the Pixoo into Stopwatch mode, and Stop, Reset, or Start the StopWatch - - - Valid Values: * Stop * Start * Reset +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Timer** - If provided, will switch the Pixoo into a Timer, with the given timespan. (hours and subseconds will be ignored) +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |10 |true (ByPropertyName)| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NoiseMeter** - If set, will display a noise meter. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RedScore** - If provided, will switch the Pixoo into a Scoreboard. -RedScore is the score for the Red Team -BlueScore is the score for the Blue Team +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |11 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BlueScore** - If provided, will switch the Pixoo into a Scoreboard. -RedScore is the score for the Red Team -BlueScore is the score for the Blue Team +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |12 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RGBColor** - If provided, will change the Pixoo into a single RGB color. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |13 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Latitude** - The latitude for the device. Must be provided with -Longitude +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Double]`|false |14 |true (ByPropertyName)|Lat | - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Longitude** - The longitude for the device. Must be provided with -Latitude +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Double]`|false |15 |true (ByPropertyName)|Long | - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 15 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Rotation** - Set the device rotation. - - - Valid Values: * 0 @@ -378,140 +190,70 @@ Valid Values: * 180 * 270 +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |16 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 16 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Mirror** - If set, will put the Pixoo device into mirroring mode. This can be nice if you have two Pixoos side by side. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Beep** - If set, the Pixoo will beep. -BeepTime controls how long a -Beep will last +|Type |Required|Position|PipelineInput |Aliases| +|----------|--------|--------|---------------------|-------| +|`[Switch]`|false |named |true (ByPropertyName)|Beeps | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BeepTime** - -BeepTime controls how long a -Beep will last +|Type |Required|Position|PipelineInput |Aliases| +|------------|--------|--------|---------------------|-------| +|`[TimeSpan]`|false |17 |true (ByPropertyName)|BeepFor| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 17 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BeepPause** - -BeepPause controls how long to wait between -Beeps +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |18 |true (ByPropertyName)| - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 18 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **BeepCount** - -BeepCount controls the number of -Beeps +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |19 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 19 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **FileID** - A file identifier of an upload or liked file. These can be retreived by using Get-Pixoo -Upload. Note: File IDs are unique to each Pixoo device +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |20 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 20 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **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. --- + ### Syntax ```PowerShell Set-Pixoo [[-IPAddress] ] [[-Brightness] ] [[-Hue] ] [[-Saturation] ] [-On] [-Off] [[-Visualizer] ] [[-CustomPlaylist] ] [[-CloudChannel] ] [[-Channel] ] [[-Stopwatch] ] [[-Timer] ] [-NoiseMeter] [[-RedScore] ] [[-BlueScore] ] [[-RGBColor] ] [[-Latitude] ] [[-Longitude] ] [[-Rotation] ] [-Mirror] [-Beep] [[-BeepTime] ] [[-BeepPause] ] [[-BeepCount] ] [[-FileID] ] [-WhatIf] [-Confirm] [] ``` ---- From 20c2a7b03fdc93e5d77739770a74ea9f4b60573a Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 54/58] feat: $LightScript ( Fixes #104 ) --- docs/Set-Twinkly.md | 295 +++++++++----------------------------------- 1 file changed, 60 insertions(+), 235 deletions(-) diff --git a/docs/Set-Twinkly.md b/docs/Set-Twinkly.md index e718af5..722b136 100644 --- a/docs/Set-Twinkly.md +++ b/docs/Set-Twinkly.md @@ -1,177 +1,97 @@ Set-Twinkly ----------- + ### Synopsis Sets Twinkly Lights --- + ### Description Sets Twinkly Lights. Changes colors, mode of operation --- + ### Related Links * [Get-Twinkly](Get-Twinkly.md) - - * [Connect-Twinkly](Connect-Twinkly.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Set-Twinkly -Hue 360 -Saturation 100 -Luminance 1 ``` --- + ### Parameters #### **IPAddress** - One or more IP Addresses of Twinkly devices. +|Type |Required|Position|PipelineInput |Aliases | +|---------------|--------|--------|---------------------|----------------| +|`[IPAddress[]]`|false |1 |true (ByPropertyName)|TwinklyIPAddress| - -> **Type**: ```[IPAddress[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Hue** - Sets the hue of all lights in a fixture +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Saturation** - Sets the saturation of all lights in a fixture +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Double]`|false |3 |true (ByPropertyName)| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Brightness** - Sets the brightness of all lights in a fixture When passed with -Hue and -Saturation, sets the color When passed with no other parameters, adjusts the absolute brightness +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|---------| +|`[Double]`|false |4 |true (ByPropertyName)|Luminance| - -> **Type**: ```[Double]``` - -> **Required**: false - -> **Position**: 4 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Red** - Sets the red part of a color +|Type |Required|Position|PipelineInput | +|--------|--------|--------|---------------------| +|`[Byte]`|false |5 |true (ByPropertyName)| - -> **Type**: ```[Byte]``` - -> **Required**: false - -> **Position**: 5 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Green** - Sets the green part of a color +|Type |Required|Position|PipelineInput | +|--------|--------|--------|---------------------| +|`[Byte]`|false |6 |true (ByPropertyName)| - -> **Type**: ```[Byte]``` - -> **Required**: false - -> **Position**: 6 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Blue** - Sets the blue part of a color +|Type |Required|Position|PipelineInput | +|--------|--------|--------|---------------------| +|`[Byte]`|false |7 |true (ByPropertyName)| - -> **Type**: ```[Byte]``` - -> **Required**: false - -> **Position**: 7 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RGBColor** - Sets lights to an RGB color. If one color is provided, this will set the Twinkly color mode If more than one RGB Color is provided, this will create a movie where each light alternates between each color If -MovieFrameRate and +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |8 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 8 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Mode** - Will change the mode. Can be: - * Off * Color * Demo @@ -179,13 +99,8 @@ Will change the mode. Can be: * Movie * Playlist * RT - Many operations require the mode to be set before they take effect. - For instance, if you use -RGBColor, you will not see the changes if the mode is not set to 'color'. - - - Valid Values: * off @@ -196,167 +111,77 @@ Valid Values: * playlist * rt +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |9 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 9 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **DeviceName** - If provided, will set the device name. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |10 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 10 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RestartPlaylist** - If provided, will restart the playlist +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieName** - The name of a movie. +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |11 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 11 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieFramerate** - The movie framerate +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|--------| +|`[Int32]`|false |12 |true (ByPropertyName)|MovieFPS| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 12 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieLEDCount** - The movie LED +|Type |Required|Position|PipelineInput |Aliases | +|---------|--------|--------|---------------------|-----------------| +|`[Int32]`|false |13 |true (ByPropertyName)|MovieLEDsPerFrame| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 13 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieFrameCount** - The number of frames in the movie. +|Type |Required|Position|PipelineInput | +|---------|--------|--------|---------------------| +|`[Int32]`|false |14 |true (ByPropertyName)| - -> **Type**: ```[Int32]``` - -> **Required**: false - -> **Position**: 14 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieData** - A byte array of movie data. Each sequence of 3-4 bytes represents a light color Each sequence of colors represents a frame Each sequence of frames represents a movie. +|Type |Required|Position|PipelineInput |Aliases | +|----------|--------|--------|---------------------|--------------------------| +|`[Byte[]]`|false |15 |true (ByPropertyName)|MovieFrame
MovieFrames| - -> **Type**: ```[Byte[]]``` - -> **Required**: false - -> **Position**: 15 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **MovieBlockSize** - The size of each block within a movie. By default, 3. - - -> **Type**: ```[Byte]``` - -> **Required**: false - -> **Position**: 16 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|--------|--------|--------|---------------------| +|`[Byte]`|false |16 |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Set-Twinkly [[-IPAddress] ] [[-Hue] ] [[-Saturation] ] [[-Brightness] ] [[-Red] ] [[-Green] ] [[-Blue] ] [[-RGBColor] ] [[-Mode] ] [[-DeviceName] ] [-RestartPlaylist] [[-MovieName] ] [[-MovieFramerate] ] [[-MovieLEDCount] ] [[-MovieFrameCount] ] [[-MovieData] ] [[-MovieBlockSize] ] [] ``` ---- From 1b40e0a90e1387304e73dd9ecf26d8b1ae00a8a5 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 55/58] feat: $LightScript ( Fixes #104 ) --- docs/Watch-HueSensor.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/docs/Watch-HueSensor.md b/docs/Watch-HueSensor.md index 078386b..83f266c 100644 --- a/docs/Watch-HueSensor.md +++ b/docs/Watch-HueSensor.md @@ -1,9 +1,11 @@ Watch-HueSensor --------------- + ### Synopsis Watches Hue Sensors for changes --- + ### Description Watches Hue Sensors for changes. @@ -11,18 +13,17 @@ Watches Hue Sensors for changes. An event will be generated whenever a sensor changes. --- + ### Related Links * [Get-HueSensor](Get-HueSensor.md) - - --- + ### Examples -#### EXAMPLE 1 +Watch for events every minute + ```PowerShell -# Watch for events every minute Watch-HueSensor -Interval "00:01:00" -``` # Whenever daylight changes Register-EngineEvent -SourceIdentifier Daylight.Changed -Action { if ($event.MessageData.state.Daylight) { @@ -33,34 +34,26 @@ Register-EngineEvent -SourceIdentifier Daylight.Changed -Action { Set-NanoLeaf -Brightness 1 } } +``` + --- + ### Parameters #### **Interval** - The interval hue sensors will be polled. By default, every 2.5 seconds. - - -> **Type**: ```[TimeSpan]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[TimeSpan]`|false |1 |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.Job](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.Job) - - - --- + ### Syntax ```PowerShell Watch-HueSensor [[-Interval] ] [] ``` ---- From 044e33b779cbceadd5e7f53469be01c591fd62d2 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 56/58] feat: $LightScript ( Fixes #104 ) --- docs/Watch-NanoLeaf.md | 64 ++++++++++++------------------------------ 1 file changed, 18 insertions(+), 46 deletions(-) diff --git a/docs/Watch-NanoLeaf.md b/docs/Watch-NanoLeaf.md index 4adcbb7..fd27421 100644 --- a/docs/Watch-NanoLeaf.md +++ b/docs/Watch-NanoLeaf.md @@ -1,14 +1,15 @@ Watch-NanoLeaf -------------- + ### Synopsis Watches a NanoLeaf for touch events --- + ### Description Watches a NanoLeaf for touch events. - A background job is launched to monitor for UDP messages from a given Nanoleaf. These messages are unpacked and translated into PowerShell events: @@ -20,80 +21,51 @@ These messages are unpacked and translated into PowerShell events: * NanoLeaf.Touch.Swipe --- + ### Related Links * [Get-NanoLeaf](Get-NanoLeaf.md) - - --- + ### Examples -#### EXAMPLE 1 +> EXAMPLE 1 + ```PowerShell Watch-NanoLeaf ``` --- + ### Parameters #### **IPAddress** - The IP Address of the NanoLeaf. +|Type |Required|Position|PipelineInput | +|-------------|--------|--------|---------------------| +|`[IPAddress]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[IPAddress]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **NanoLeafToken** - The nanoleaf token +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |2 |true (ByPropertyName)| - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 2 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **TouchEventsPort** - The UDP port used for TouchStreamData - - -> **Type**: ```[String]``` - -> **Required**: false - -> **Position**: 3 - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[String]`|false |3 |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.Job](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.Job) - - - --- + ### Syntax ```PowerShell Watch-NanoLeaf [[-IPAddress] ] [[-NanoLeafToken] ] [[-TouchEventsPort] ] [] ``` ---- From bb49a0df6dfd0f6cdf3e24c34ccf7e7cc8a205bb Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:23 +0000 Subject: [PATCH 57/58] feat: $LightScript ( Fixes #104 ) --- docs/Write-HueSensor.md | 135 +++++++++------------------------------- 1 file changed, 30 insertions(+), 105 deletions(-) diff --git a/docs/Write-HueSensor.md b/docs/Write-HueSensor.md index 7547f02..4103038 100644 --- a/docs/Write-HueSensor.md +++ b/docs/Write-HueSensor.md @@ -1,172 +1,97 @@ Write-HueSensor --------------- + ### Synopsis Write Hue Sensors --- + ### Description 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 +> EXAMPLE 1 + ```PowerShell Write-HueSensor -Name ChaseStatus1 -Data @{status=0} ``` --- + ### Parameters #### **Name** - If provided, will filter returned items by name +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |1 |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: 1 - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **RegularExpression** - If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ExactMatch** - If set, will treat the Name parameter as a specific match +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **ID** - If provided, will filter returned items by ID +|Type |Required|Position|PipelineInput | +|------------|--------|--------|---------------------| +|`[String[]]`|false |named |true (ByPropertyName)| - -> **Type**: ```[String[]]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - - ---- #### **Config** - If set, will write values from to configuration. By default, values are written to the sensor state. +|Type |Required|Position|PipelineInput| +|----------|--------|--------|-------------| +|`[Switch]`|false |named |false | - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:false - - - ---- #### **Data** - The data that will be written to the sensor +|Type |Required|Position|PipelineInput | +|------------|--------|--------|--------------| +|`[PSObject]`|true |named |true (ByValue)| - -> **Type**: ```[PSObject]``` - -> **Required**: true - -> **Position**: named - -> **PipelineInput**:true (ByValue) - - - ---- #### **OutputInput** - If set, will output the data that would be sent to the bridge. This is useful for creating scheudles, routines, and other macros. - - -> **Type**: ```[Switch]``` - -> **Required**: false - -> **Position**: named - -> **PipelineInput**:true (ByPropertyName) - - +|Type |Required|Position|PipelineInput | +|----------|--------|--------|---------------------| +|`[Switch]`|false |named |true (ByPropertyName)| --- + ### Outputs * [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) - - - --- + ### Syntax ```PowerShell Write-HueSensor [[-Name] ] [-RegularExpression] [-ExactMatch] [-ID ] [-Config] -Data [-OutputInput] [] ``` ---- From 2b22b90872f0dd72c885bcce98888e69a72e0169 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Sun, 14 Jan 2024 21:15:24 +0000 Subject: [PATCH 58/58] feat: $LightScript ( Fixes #104 ) --- docs/README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index b22b31b..637bb4a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -296,6 +296,3 @@ Set-KeyLight -ColorTemperature 270 -Brightness 0.25 # Turn on and change the brightness at the same time: Set-KeyLight -On -Brightness 0.25 ~~~ - - -