From dc04ad403ee9476ba079a0a0bbe6e4f37cd0ee02 Mon Sep 17 00:00:00 2001 From: StartAutomating Date: Mon, 3 Oct 2022 03:05:25 +0000 Subject: [PATCH] Add-HueSensor: Adding -New (Fixes #25) --- docs/Get-HueSensor.md | 195 ++++++++++++++++++++++++++++++++---------- 1 file changed, 152 insertions(+), 43 deletions(-) diff --git a/docs/Get-HueSensor.md b/docs/Get-HueSensor.md index 6e6c137..5ccdd78 100644 --- a/docs/Get-HueSensor.md +++ b/docs/Get-HueSensor.md @@ -12,8 +12,17 @@ Gets Sensors from one or more Hue Bridges --- ### Related Links * [Remove-HueSensor](Remove-HueSensor.md) + + + * [Get-HueBridge](Get-HueBridge.md) + + + * [Send-HueBridge](Send-HueBridge.md) + + + --- ### Examples #### EXAMPLE 1 @@ -29,9 +38,16 @@ If set, will get the schedules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Rule** @@ -39,9 +55,16 @@ If set, will get the rules defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Scene** @@ -49,9 +72,16 @@ If set, will get the scenes defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Sensor** @@ -59,9 +89,16 @@ If set, will get the sensors defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Group** @@ -69,9 +106,16 @@ If set, will get the groups (or rooms) defined on the Hue bridge -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Configuration** @@ -79,9 +123,16 @@ If set, will get the device configuration -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Capability** @@ -89,9 +140,16 @@ If set, will get the device capabilities -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Resource** @@ -99,9 +157,16 @@ If set, will get resources defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Light** @@ -109,9 +174,16 @@ If set, will get the lights defined on the device -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|true |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: true + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Name** @@ -119,9 +191,16 @@ If provided, will filter returned items by name -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |1 |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: 1 + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **RegularExpression** @@ -129,9 +208,16 @@ If set, will treat the Name parameter as a regular expression pattern. By defau -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ExactMatch** @@ -139,9 +225,16 @@ If set, will treat the Name parameter as a specific match -|Type |Requried|Postion|PipelineInput | -|--------------|--------|-------|---------------------| -|```[Switch]```|false |named |true (ByPropertyName)| +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **ID** @@ -149,9 +242,16 @@ If provided, will filter returned items by ID -|Type |Requried|Postion|PipelineInput | -|----------------|--------|-------|---------------------| -|```[String[]]```|false |named |true (ByPropertyName)| +> **Type**: ```[String[]]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:true (ByPropertyName) + + + --- #### **Detailed** @@ -159,12 +259,21 @@ If set, will requery each returned resource to retreive additional information. -|Type |Requried|Postion|PipelineInput| -|--------------|--------|-------|-------------| -|```[Switch]```|false |named |false | +> **Type**: ```[Switch]``` + +> **Required**: false + +> **Position**: named + +> **PipelineInput**:false + + + --- ### Outputs -System.Management.Automation.PSObject +* [Management.Automation.PSObject](https://learn.microsoft.com/en-us/dotnet/api/System.Management.Automation.PSObject) + + ---