PowerShell/docs/check-moon-phase.md

80 lines
2.2 KiB
Markdown
Raw Normal View History

2023-07-29 10:34:04 +02:00
*check-moon-phase.ps1*
================
2021-12-09 16:19:09 +01:00
2022-02-10 09:01:07 +01:00
This PowerShell script determines the Moon phase and answers by text-to-speech (TTS).
2021-12-09 16:19:09 +01:00
2023-07-29 10:04:38 +02:00
Parameters
----------
2021-12-09 16:19:09 +01:00
```powershell
2023-07-29 10:15:44 +02:00
PS> ./check-moon-phase.ps1 [<CommonParameters>]
2021-12-09 16:19:09 +01:00
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
2023-07-29 10:04:38 +02:00
Example
-------
2021-12-09 16:19:09 +01:00
```powershell
PS> ./check-moon-phase
```
2023-07-29 10:04:38 +02:00
Notes
-----
2022-11-17 19:46:02 +01:00
Author: Markus Fleschutz | License: CC0
2021-12-09 16:19:09 +01:00
2023-07-29 10:04:38 +02:00
Related Links
-------------
2021-12-09 16:19:09 +01:00
https://github.com/fleschutz/PowerShell
2023-07-29 10:04:38 +02:00
Script Content
--------------
2022-11-17 20:05:34 +01:00
```powershell
2022-11-17 20:02:26 +01:00
<#
.SYNOPSIS
Checks the Moon phase
.DESCRIPTION
This PowerShell script determines the Moon phase and answers by text-to-speech (TTS).
.EXAMPLE
PS> ./check-moon-phase
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
try {
$LunarCycle = 29.53058868 # synodic period in days, time between successive new moons
$LunarHalfCycle = $LunarCycle / 2.0
$Phases = @("New moon", "Waxing crescent moon", "First quarter moon", "Waxing gibbous moon", "Full moon", "Waning gibbous moon", "Last quarter moon", "Waning crescent moon")
$PhaseLength = $LunarCycle / 8.0
$PhaseHalfLength = $PhaseLength / 2.0
$RefDate = get-date -Year 2021 -Month 12 -Day 4 -Hour 6 -Minute 43 # Dec 4, 2021 06:43 UTC [New Moon]
$Now = get-date
$TimeInterval = New-TimeSpan -Start $RefDate -End $Now
$Days = $TimeInterval.TotalDays
$MDays = $Days % $LunarCycle
$PhaseIndex = [int]($MDays * (8.0 / $LunarCycle))
$Visibility = [math]::Round((($Days % $LunarHalfCycle) * 100) / $LunarHalfCycle)
$Reply = "$($Phases[$PhaseIndex]) with $($Visibility)% visibility"
$MoonAge = [math]::Round($Days % $LunarCycle)
if ($MoonAge -eq "0") { $Reply += " today"
} elseif ($MoonAge -eq "1") { $Reply += " since yesterday"
} else { $Reply += ", last new moon was $MoonAge days ago"
}
2022-11-18 17:02:20 +01:00
& "$PSScriptRoot/speak-english.ps1" "$Reply"
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
2024-01-03 12:11:22 +01:00
*(generated by convert-ps2md.ps1 using the comment-based help of check-moon-phase.ps1 as of 01/03/2024 12:10:44)*