diff --git a/Add-HueLight.ps1 b/Add-HueLight.ps1 index af5fe44..d68f18f 100644 --- a/Add-HueLight.ps1 +++ b/Add-HueLight.ps1 @@ -1,4 +1,21 @@ function Add-HueLight { + <# + .SYNOPSIS + Adds lights to Hue + .DESCRIPTION + Adds new lights to a Hue Bridge. + .EXAMPLE + Add-HueLight # Search for new lights + .EXAMPLE + Add-HueLight -DeviceID $serialNumber # Add a new light by serial number. + .EXAMPLE + Add-HueLight # Search for new lights + Get-HueLight -New # Get-HueLight -New will return the new lights + .LINK + Get-HueLight + .LINK + Set-HueLight + #> [CmdletBinding(SupportsShouldProcess)] diff --git a/Add-HueLight.ps1.ps1 b/Add-HueLight.ps1.ps1 index 063a3f0..b04487c 100644 --- a/Add-HueLight.ps1.ps1 +++ b/Add-HueLight.ps1.ps1 @@ -1,5 +1,22 @@ function Add-HueLight { + <# + .SYNOPSIS + Adds lights to Hue + .DESCRIPTION + Adds new lights to a Hue Bridge. + .EXAMPLE + Add-HueLight # Search for new lights + .EXAMPLE + Add-HueLight -DeviceID $serialNumber # Add a new light by serial number. + .EXAMPLE + Add-HueLight # Search for new lights + Get-HueLight -New # Get-HueLight -New will return the new lights + .LINK + Get-HueLight + .LINK + Set-HueLight + #> [Rest("lights", Invoker="Send-HueBridge", Method='POST', diff --git a/CHANGELOG.md b/CHANGELOG.md index 3685882..fe9e50e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.2.4.1 +* Adding help for Add-HueLight (#23) +* Fixing other markdown documentation layout issues +--- + + ## 0.2.4 * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) diff --git a/LightScript.HelpOut.ps1 b/LightScript.HelpOut.ps1 index 6709b19..dbf5e79 100644 --- a/LightScript.HelpOut.ps1 +++ b/LightScript.HelpOut.ps1 @@ -8,6 +8,5 @@ if ($LightScriptLoaded) { "::error:: LightScript not loaded" |Out-Host } if ($LightScriptLoaded) { - Save-MarkdownHelp -Module $LightScriptLoaded.Name -PassThru | - Add-Member ScriptProperty CommitMessage { "Updating $($this.Name)" } -Force -PassThru + Save-MarkdownHelp -Module $LightScriptLoaded.Name -PassThru } diff --git a/LightScript.psd1 b/LightScript.psd1 index 88175cf..ca1e4d7 100644 --- a/LightScript.psd1 +++ b/LightScript.psd1 @@ -1,5 +1,5 @@ @{ - ModuleVersion = '0.2.4' + ModuleVersion = '0.2.4.1' RootModule = 'LightScript.psm1' Description = 'Smarter Lighting with PowerShell' FormatsToProcess = 'LightScript.format.ps1xml' @@ -14,6 +14,11 @@ LicenseURI = 'https://github.com/StartAutomating/LightScript/blob/main/LICENSE' IconURI = 'https://github.com/StartAutomating/LightScript/blob/main/Assets/LightScript.png' ReleaseNotes = @' +## 0.2.4.1 +* Adding help for Add-HueLight (#23) +* Fixing other markdown documentation layout issues +--- + ## 0.2.4 * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) diff --git a/docs/Add-HueLight.md b/docs/Add-HueLight.md index 70717af..965528b 100644 --- a/docs/Add-HueLight.md +++ b/docs/Add-HueLight.md @@ -2,52 +2,64 @@ Add-HueLight ------------ ### Synopsis +Adds lights to Hue -Add-HueLight [[-DeviceID] ] [-WhatIf] [-Confirm] [] +--- +### Description +Adds new lights to a Hue Bridge. --- -### Description +### Related Links +* [Get-HueLight](Get-HueLight.md) +* [Set-HueLight](Set-HueLight.md) --- -### Parameters -#### **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. +### Examples +#### EXAMPLE 1 +```PowerShell +Add-HueLight # Search for new lights +``` + +#### EXAMPLE 2 +```PowerShell +Add-HueLight -DeviceID $serialNumber # Add a new light by serial number. +``` +#### EXAMPLE 3 +```PowerShell +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 ). +Use this parameter when adding lights that have already been assigned to another bridge. + + + |Type |Requried|Postion|PipelineInput| |----------------|--------|-------|-------------| -|```[string[]]```|false |0 |false | +|```[String[]]```|false |1 |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 ---- -### Inputs -None - - ---- -### Outputs -System.Object - +#### **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 -syntaxItem -``` -```PowerShell ----------- -``` -```PowerShell -{@{name=Add-HueLight; CommonParameters=True; parameter=System.Object[]}} +Add-HueLight [[-DeviceID] ] [-WhatIf] [-Confirm] [] ``` --- diff --git a/docs/Add-HueRoom.md b/docs/Add-HueRoom.md index a75b5ba..2d0fb75 100644 --- a/docs/Add-HueRoom.md +++ b/docs/Add-HueRoom.md @@ -89,6 +89,9 @@ Valid Values: * Recreation * Terrace * Toilet + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |named |true (ByPropertyName)| @@ -106,6 +109,9 @@ Valid Values: * LightGroup * Entertainment * Zone + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |named |true (ByPropertyName)| diff --git a/docs/Add-HueSensor.md b/docs/Add-HueSensor.md index 7c4a2cf..9f78774 100644 --- a/docs/Add-HueSensor.md +++ b/docs/Add-HueSensor.md @@ -59,6 +59,9 @@ Valid Values: * LightLevel * GenericFlag * GenericStatus + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|true |2 |true (ByPropertyName)| diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 3685882..fe9e50e 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,3 +1,9 @@ +## 0.2.4.1 +* Adding help for Add-HueLight (#23) +* Fixing other markdown documentation layout issues +--- + + ## 0.2.4 * Adding Add-HueLight (#18) * Adding Get-HueLight -New (#21) diff --git a/docs/Get-NanoLeaf.md b/docs/Get-NanoLeaf.md index d330dca..1c910e9 100644 --- a/docs/Get-NanoLeaf.md +++ b/docs/Get-NanoLeaf.md @@ -95,6 +95,9 @@ Valid Values: * Rhythm * Color + + + |Type |Requried|Postion|PipelineInput| |--------------|--------|-------|-------------| |```[String]```|false |named |false | diff --git a/docs/Set-HueLight.md b/docs/Set-HueLight.md index f85ae0e..fee544d 100644 --- a/docs/Set-HueLight.md +++ b/docs/Set-HueLight.md @@ -178,6 +178,9 @@ Valid Values: * colorloop * none + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |named |true (ByPropertyName)| @@ -193,6 +196,9 @@ Valid Values: * select * lselect * none + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |named |true (ByPropertyName)| diff --git a/docs/Set-NanoLeaf.md b/docs/Set-NanoLeaf.md index 6540362..e5c334c 100644 --- a/docs/Set-NanoLeaf.md +++ b/docs/Set-NanoLeaf.md @@ -230,6 +230,9 @@ Valid Values: * Highlight * Custom * Static + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |11 |true (ByPropertyName)| @@ -254,6 +257,9 @@ Valid Values: * Rhythm * Color + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |13 |true (ByPropertyName)| diff --git a/docs/Set-Pixoo.md b/docs/Set-Pixoo.md index 5f78b2a..5be173e 100644 --- a/docs/Set-Pixoo.md +++ b/docs/Set-Pixoo.md @@ -125,6 +125,9 @@ Valid Values: * Cloud * Visualizer * Custom + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |8 |true (ByPropertyName)| @@ -140,6 +143,9 @@ Valid Values: * Stop * Start * Reset + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |9 |true (ByPropertyName)| diff --git a/docs/Set-Twinkly.md b/docs/Set-Twinkly.md index ab96b51..470729c 100644 --- a/docs/Set-Twinkly.md +++ b/docs/Set-Twinkly.md @@ -134,6 +134,9 @@ Valid Values: * movie * playlist * rt + + + |Type |Requried|Postion|PipelineInput | |--------------|--------|-------|---------------------| |```[String]```|false |9 |true (ByPropertyName)|