Rename folder Docs to docs

docs/simulate-presence.md

@@ -0,0 +1,77 @@
+*simulate-presence.ps1*
+================
+
+This PowerShell script simulates the human presence against burglars. It switches a Shelly1 device on and off.
+
+Parameters
+----------
+```powershell
+PS> ./simulate-presence.ps1 [[-IPaddress] <String>] [<CommonParameters>]
+
+-IPaddress <String>
+    Specifies the IP address of the Shelly1 device
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
+
+[<CommonParameters>]
+    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
+    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
+```
+
+Example
+-------
+```powershell
+PS> ./simulate-presence 192.168.100.100
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Simulate a human against burglars
+.DESCRIPTION
+	This PowerShell script simulates the human presence against burglars. It switches a Shelly1 device on and off.
+.PARAMETER IPaddress
+	Specifies the IP address of the Shelly1 device
+.EXAMPLE
+	PS> ./simulate-presence 192.168.100.100
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+param([string]$IPaddress = "")
+
+try {
+	if ($IPaddress -eq "" ) { $IPaddress = Read-Host "Enter IP address of the Shelly1 device" }
+
+	for ([int]$i = 0; $i -lt 1000; $i++) {
+		& "$PSScriptRoot/switch-shelly1.ps1" $IPaddress on 0
+		Start-Sleep -seconds 10 # on for 10 seconds
+		& "$PSScriptRoot/switch-shelly1.ps1" $IPaddress off 0
+		Start-Sleep -seconds 60 # off for 60 seconds
+	}
+	"✔️ Done."
+	exit 0 # success
+} catch {
+	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	exit 1
+}
+```
+
+*(generated by convert-ps2md.ps1 using the comment-based help of simulate-presence.ps1 as of 10/19/2023 08:11:42)*