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 4d0cc6b commit fcb97e4
Showing 1 changed file with 96 additions and 28 deletions.
124 changes: 96 additions & 28 deletions docs/Send-NanoLeaf.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Sends HTTP messages to a NanoLeaf
---
### Related Links
* [Get-NanoLeaf](Get-NanoLeaf.md)



---
### Examples
#### EXAMPLE 1
Expand All @@ -27,89 +30,152 @@ The IP Address of the NanoLeaf.



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


---
#### **Command**

The URI fragment to send to the nanoleaf.



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


---
#### **Method**

The HTTP method to send.



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


---
#### **Data**

The data to send. This will be converted into JSON if it is not a string.



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


---
#### **Property**

A set of additional properties to add to an object



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


---
#### **RemoveProperty**

A list of property names to remove from an object



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


---
#### **ExpandProperty**

If provided, will expand a given property returned from the REST api.



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


---
#### **PSTypeName**

The typename of the results.



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


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

The nanoleaf token



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


---
#### **WhatIf**
-WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
Expand All @@ -125,7 +191,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co

---
### 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 fcb97e4

Please sign in to comment.