PowerShell/Docs/check-wind.md

70 lines
2.0 KiB
Markdown
Raw Normal View History

2022-12-04 10:40:18 +01:00
## The *check-wind.ps1* Script
2022-02-10 09:01:07 +01:00
This PowerShell script determines the current wind conditions and replies by text-to-speech (TTS).
## Parameters
```powershell
2023-05-26 12:20:18 +02:00
/home/mf/Repos/PowerShell/Scripts/check-wind.ps1 [[-location] <String>] [<CommonParameters>]
2022-02-10 09:01:07 +01:00
-location <String>
Specifies the location to use (determined automatically per default)
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> ./check-wind
```
## Notes
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2022-02-10 09:01:07 +01:00
## Related Links
https://github.com/fleschutz/PowerShell
2022-11-17 20:02:26 +01:00
## Source Code
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Checks the wind conditions
.DESCRIPTION
This PowerShell script determines the current wind conditions and replies by text-to-speech (TTS).
.PARAMETER location
Specifies the location to use (determined automatically per default)
.EXAMPLE
PS> ./check-wind
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$location = "") # empty means determine automatically
try {
$Weather = (Invoke-WebRequest http://wttr.in/${location}?format=j1 -userAgent "curl" -useBasicParsing).Content | ConvertFrom-Json
$WindSpeed = $Weather.current_condition.windspeedKmph
$WindDir = $Weather.current_condition.winddir16Point
$Area = $Weather.nearest_area.areaName.value
$Region = $Weather.nearest_area.region.value
2022-11-18 17:02:20 +01:00
& "$PSScriptRoot/speak-english.ps1" "$($WindSpeed)km/h wind from $WindDir at $Area ($Region)."
2022-11-17 20:02:26 +01:00
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
2022-11-17 20:05:34 +01:00
```
2022-11-17 20:02:26 +01:00
2022-02-10 09:01:07 +01:00
*Generated by convert-ps2md.ps1 using the comment-based help of check-wind.ps1*