MMM-WaterReminder

KO | EN

gitlite — search

#react #typescript #llm #machine-learning #rust #linux #docker #macos #cli #kubernetes #vue #security #ios #openai

MMM-WaterReminder

(★ 8)

This is a simple and configurable Water Reminder Module for MagicMirror

MMM-WaterReminder Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MMM-WaterReminder ![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)

A simple and configurable Water Reminder Module for MagicMirror2. Also, you can use it as a reminder for any purpose by replacing the predefined phrases. Additionally, this module can help you to understand how to make your first MM module.
## Example

![Module design](https://raw.githubusercontent.com/thiagomides/MMM-WaterReminder/master/.github/screenshot.png)  
![Module working](https://raw.githubusercontent.com/thiagomides/MMM-WaterReminder/master/.github/working.gif)

## Dependencies

* An installation of [MagicMirror2](https://github.com/MichMich/MagicMirror)

## Installation

* Clone this repo into `~/MagicMirror/modules` directory.
* Configure your `~/MagicMirror/config/config.js`:

## Minimal configuration
```js
{
    module: 'MMM-WaterReminder',
    position: 'top_center',
    config: {
         ...
    }
}
```

## Personalized configuration
this is the default configuration defined if you don't define any value
```js
{
 module: 'MMM-WaterReminder',
 position: 'top_center',
 config: {
 foo: "Did you have enough water today?",
 phrases: ["Did you have enough water today?", "Hey buddy, you should have some water!","Drink water, bro.","'Better to have stones in the way than in the Kidneys: Drink water!'",
 "It's been such a long time since your last glass of water...","Water! Water! Water!","Are you anxious for the next glass of water?"],
 additionalPhrases: [],
 startTime: "00:00",
 endTime: "23:59",
 messageDuration: 1 * 60 * 1000, // 1 min showing on the screen
 animationSpeed: 4 * 1000, // 4 seconds for fading
 reminderFrequency: 60 * 60 * 1000, // hourly reminder
 classes: "bright medium light",
 color: "#fff",
 idleMessage: " ",
 logo: true,
 days: [0,1,2,3,4,5,6], // all week
 alarm: {
 status: false, 
 daysWithAudibleReminder: [1,2,3,4,5],
 src: "done-for-you.mp3",
 startTime: "09:00",
 endTime: "17:00",
 }
 }
}
```
## Config Options

| **Option** | **Default** | **Description** |
| --- | --- | --- |
| `foo` | `Did you have enough water today?` | This is the module initialization message
| `phrases` | `["Did you have enough water today?", ... , "Are you anxious for the next glass of water?"]` | An array of phrases that will be randomly displayed. 
| `additionalPhrases` | `[]` | An array of phrases to be used with the default array of phrases. 
| `days` | `[0,1,2,3,4,5,6]` From Sunday to Saturday | Days of the week that the reminder should work . ``0 => Sunday, 1 => Monday, 2 => Tuesday, 3 => Wednesday, 4 => Thursday, 5 => Friday, 6 => Saturday`` **Example (workdays) :** ``[1, 2, 3, 4, 5], // From Monday to Friday .`` |
| `startTime` | `00:00` | The time that the module will start to work. 
| `endTime` | `23:59` | The time that the module will stop to work. 
| `messageDuration` | `60000` (1 min) | How long does the reminder should remain on the screen? 
| `animationSpeed` | `4000` (4 sec) | Speed of the update animation. 
| `reminderFrequency` | `3600000` (1 hour) | How often does the reminder should appear?
| `classes` | `bright medium light` | Override the CSS classes of the div showing the reminder.
| `color` | `#fff` | Sets the color of the reminder.
| `idleMessage` | `` | Text displayed during the idle time, that is, before and after a reminder. 
| `logo` | `true` | If you are using a touch screen device you need to press a button to disable an alarm.. |

##  Audible Reminder Options

| **Option** | **Default** | **Description** |
| --- | --- | --- |
| `status` | `false` | Enable or disable audible reminder |
| `startTime` | `09:00` | Time at which the reminder should start being audible. e.g.,  reminder should sound only during working hours. |
| `endTime` | `17:00` | Time at which the reminder should stop being audible. e.g., time to get off from the work |
| `daysWithAudibleReminder` | `[]` | Days of the week that the reminder should display a sound. If  `status = true` and the sound option `daysWithAudibleReminder = []` is empty, the sound will be displayed following the value in `days` |
| `src` | `done-for-you.mp3` | Name or the url of the mp3 file. By default, the sound of the config will be use if this option is empty. |

## Default Sound

The alarm sound for this module is `done-for-you.mp3`. However, additional sounds can be placed on the `sounds/` folder:

* [done-for-you.mp3](https://notificationsounds.com/notification-sounds/done-for-you-612) | From Notification Sounds licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)

MMM-WaterReminder

MMM-WaterReminder Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MMM-WaterReminder

MMM-WaterReminder Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README