feat: Set-Twinkly -Off ( Fixes #131 )

StartAutomating · Jul 14, 2024 · 73572bd · 73572bd
1 parent 0a110e4
commit 73572bd
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/docs/Set-Twinkly.md b/docs/Set-Twinkly.md
@@ -115,6 +115,13 @@ Valid Values:
 |----------|--------|--------|---------------------|
 |`[String]`|false   |9       |true (ByPropertyName)|
 
+#### **Off**
+If set, will turn off the lights.
+
+|Type      |Required|Position|PipelineInput        |
+|----------|--------|--------|---------------------|
+|`[Switch]`|false   |named   |true (ByPropertyName)|
+
 #### **DeviceName**
 If provided, will set the device name.
 
@@ -183,5 +190,5 @@ The size of each block within a movie.  By default, 3.
 
 ### Syntax
 ```PowerShell
-Set-Twinkly [[-IPAddress] <IPAddress[]>] [[-Hue] <Double>] [[-Saturation] <Double>] [[-Brightness] <Double>] [[-Red] <Byte>] [[-Green] <Byte>] [[-Blue] <Byte>] [[-RGBColor] <String[]>] [[-Mode] <String>] [[-DeviceName] <String>] [-RestartPlaylist] [[-MovieName] <String>] [[-MovieFramerate] <Int32>] [[-MovieLEDCount] <Int32>] [[-MovieFrameCount] <Int32>] [[-MovieData] <Byte[]>] [[-MovieBlockSize] <Byte>] [<CommonParameters>]
+Set-Twinkly [[-IPAddress] <IPAddress[]>] [[-Hue] <Double>] [[-Saturation] <Double>] [[-Brightness] <Double>] [[-Red] <Byte>] [[-Green] <Byte>] [[-Blue] <Byte>] [[-RGBColor] <String[]>] [[-Mode] <String>] [-Off] [[-DeviceName] <String>] [-RestartPlaylist] [[-MovieName] <String>] [[-MovieFramerate] <Int32>] [[-MovieLEDCount] <Int32>] [[-MovieFrameCount] <Int32>] [[-MovieData] <Byte[]>] [[-MovieBlockSize] <Byte>] [<CommonParameters>]
 ```