-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
StartAutomating
authored and
StartAutomating
committed
Jan 14, 2024
1 parent
044e33b
commit bb49a0d
Showing
1 changed file
with
30 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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] <String[]>] [-RegularExpression] [-ExactMatch] [-ID <String[]>] [-Config] -Data <PSObject> [-OutputInput] [<CommonParameters>] | ||
| ``` | ||
| --- |