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 0c90ec6 commit 18754dc
Showing 1 changed file with 119 additions and 34 deletions.
153 changes: 119 additions & 34 deletions docs/Get-NanoLeaf.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,13 @@ Can also get effects
---
### Related Links
* [Connect-NanoLeaf](Connect-NanoLeaf.md)



* [Set-NanoLeaf](Set-NanoLeaf.md)



---
### Examples
#### EXAMPLE 1
Expand All @@ -30,59 +36,101 @@ The IP Address of the NanoLeaf controller.



|Type |Requried|Postion|PipelineInput |
|-----------------|--------|-------|---------------------|
|```[IPAddress]```|true |named |true (ByPropertyName)|
> **Type**: ```[IPAddress]```
> **Required**: true
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **NanoLeafToken**

The nanoleaf authorization token.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |named |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Panel**

If set, will get information about NanoLeaf panels.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **Layout**

If set, will get information about NanoLeaf layout.



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[Switch]```|false |named |true (ByPropertyName)|
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **EffectName**

If provided, will get information about a particular NanoLeaf effect



|Type |Requried|Postion|PipelineInput |
|--------------|--------|-------|---------------------|
|```[String]```|false |named |true (ByPropertyName)|
> **Type**: ```[String]```
> **Required**: false
> **Position**: named
> **PipelineInput**:true (ByPropertyName)


---
#### **ListPlugin**

If provided, will get information about the plugins available to use in Nanoleaf effects.



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[Switch]```|false |named |false |
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false


---
#### **PluginType**

Expand All @@ -98,52 +146,89 @@ Valid Values:



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[String]```|false |named |false |
> **Type**: ```[String]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false


---
#### **ListEffectName**

If set, will return a string list of effect names.



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[Switch]```|false |named |false |
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false


---
#### **ListEffect**

If set, will return a string list of effect names.



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[Switch]```|false |named |false |
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false


---
#### **CurrentEffect**

If set, will display information about the current effect.



|Type |Requried|Postion|PipelineInput|
|--------------|--------|-------|-------------|
|```[Switch]```|false |named |false |
> **Type**: ```[Switch]```
> **Required**: false
> **Position**: named
> **PipelineInput**:false


---
#### **Force**

If set, will refresh connections to all nanoleafs



|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 18754dc

Please sign in to comment.