Skip to content

A PowerShell module designed to remind you via Windows notification to drink some water every so often in order to stay hydrated!

License

Notifications You must be signed in to change notification settings

mmcmd/HydrationReminder

Repository files navigation

Project logo

Hydration Reminder

Status GitHub Issues GitHub Pull Requests License: GPL v3 CodeFactor


A PowerShell module designed to remind you via Windows notification to drink some water every so often in order to stay hydrated!

📝 Table of Contents

🧐 About

A fairly simple module to remind you (by default every hour) to drink some water in order to stay hydrated. Inspired by a Twitch Hydration bot

🏁 Getting Started

Prerequisites

  • Powershell 5.1 or higher
PS C:\> $PSVersionTable


Name                           Value
----                           -----
PSVersion                      5.1.19041.1237
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.19041.1237
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
PS C:\Windows\System32> Install-Module BurntToast
  • Windows 10/Windows Server 2019 or higher

Installing

PS C:\Windows\System32> Install-Module HydrationReminder

🎈 Usage

The commands from this module can be found by running Get-Command -Module HydrationReminder

Running Get-Help on any of the commands will provide additional examples and details on how to use the command

Parameter list and description for Start-HydrationReminder:

Parameters Type Functionality
ReminderInterval Integer Interval in minutes at which you will receive a notification to drink. Default is 60 minutes (1 hour)
DailyWaterInstake Integer Amount of daily water intake needed (in mL). Default is 2000mL (2L)
Duration Integer Amount in hours you want to be reminded for. Default is 16 hours (average amount of time a human is awake for before going to sleep)

Stop-HydrationReminder can be run if you'd like to stop any active hydration reminder jobs

🚀 Deployment

It is encouraged to create a task with Task Scheduler to run the command Start-HydrationReminder on logon. This can be done with the Register-HydrationReminderTask.

Start-HydrationReminder can be used to start the script Stop-HydrationReminder can be used to stop it Unregister-HydrationReminderTask removes the task created by Register-HydrationReminderTask

⛏️ Built Using

✍️ Authors

  • @mmcmd - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

About

A PowerShell module designed to remind you via Windows notification to drink some water every so often in order to stay hydrated!

Resources

License

Stars

Watchers

Forks

Packages

No packages published