Skip to content

Commit

Permalink
Add-HueSensor: Adding -New (Fixes #25)
Browse files Browse the repository at this point in the history
  • Loading branch information
StartAutomating authored and StartAutomating committed Oct 3, 2022
1 parent 4033965 commit ab1d021
Showing 1 changed file with 152 additions and 43 deletions.
195 changes: 152 additions & 43 deletions docs/Get-HueScene.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,17 @@ 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
Expand All @@ -29,142 +38,242 @@ 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**

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**

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**

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**

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**

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**

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**

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**

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**

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**

If set, will treat the Name parameter as a regular expression pattern. By default, Name will be treated as a wildcard



|Type |Requried|Postion|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 |Requried|Postion|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 |Requried|Postion|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 |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)




---
Expand Down

0 comments on commit ab1d021

Please sign in to comment.