{"id":16993328,"url":"https://github.com/janloebel/mmm-touchalarm","last_synced_at":"2025-03-22T05:21:49.337Z","repository":{"id":94389768,"uuid":"168404470","full_name":"JanLoebel/MMM-TouchAlarm","owner":"JanLoebel","description":"Touchable Alarm Clock Module for MagicMirror2","archived":false,"fork":false,"pushed_at":"2019-02-01T09:16:02.000Z","size":445,"stargazers_count":1,"open_issues_count":2,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-27T06:12:44.292Z","etag":null,"topics":["alarm","alarm-clock","magicmirror2","touch","touchable","touchscreen"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JanLoebel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-30T19:46:12.000Z","updated_at":"2024-10-29T19:30:20.000Z","dependencies_parsed_at":"2023-04-16T05:35:04.185Z","dependency_job_id":null,"html_url":"https://github.com/JanLoebel/MMM-TouchAlarm","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanLoebel%2FMMM-TouchAlarm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanLoebel%2FMMM-TouchAlarm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanLoebel%2FMMM-TouchAlarm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JanLoebel%2FMMM-TouchAlarm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JanLoebel","download_url":"https://codeload.github.com/JanLoebel/MMM-TouchAlarm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244909410,"owners_count":20530230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alarm","alarm-clock","magicmirror2","touch","touchable","touchscreen"],"created_at":"2024-10-14T03:42:52.789Z","updated_at":"2025-03-22T05:21:49.315Z","avatar_url":"https://github.com/JanLoebel.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Touchable Alarm Clock Module for MagicMirror\u003csup\u003e2\u003c/sup\u003e\n\n## Dependencies\n\n* An installation of [MagicMirror\u003csup\u003e2\u003c/sup\u003e](https://github.com/MichMich/MagicMirror)\n\n## Installation\n\n1. Clone this repo into `~/MagicMirror/modules` directory.\n1. Configure your `~/MagicMirror/config/config.js`:\n\n    ```\n    {\n        module: 'MMM-TouchAlarm',\n        position: 'bottom_left',\n        config: {\n            snoozeMinutes: 10, // I want to snooze longer\n            alarmTimeoutMinutes: 5, // Stop the alarm automatically after 5 minutes\n            alarmSoundFile: 'blackforest.mp3', // Play some birds\n            alarmSoundFadeSeconds: 60 // Increase the volume slowly\n            // ...\n        }\n    }\n    ```\n\n## (Currently) Known limitations\n\n* If you snooze, the alarm time will be updated. So the next day you have to reset the alarm and reduce it by the snoozed time.\n\n* If you close an alarm it will not be automatically be reset for the next day, you've to click the bell again.\n\n\n## Config Options\n\n| **Option** | **Default** | **Description** |\n| ---                     | --- | --- |\n| `minutesStepSize`       | `5` | Increasing/Decreasing the minutes in the configuration screen with this step size. |\n| `snoozeMinutes`         | `5` | Alarm will be fired again in x minutes after snoozing. |\n| `alarmTimeoutMinutes`   | `5` | Stop the alarm automatically after this amount of minutes. |\n| ---                     | --- | --- |\n| `alarmSound`            | `true` | Should an alarm sound be played. |\n| `alarmSoundFile`        | `'alarm.mp3'` | Name and extension of your alarm sound. File needs to be placed in `~/MagicMirror/modules/MMM-TouchAlarm/sounds`. Standard files are `alarm.mp3` and `blackforest.mp3`.  Alternatively specify a web stream `http` or `https`. |\n| `alarmSoundMaxVolume`   | `1.0` | The maximum volume of alarm (between 0.0 and 1.0). |\n| `alarmSoundFade`        | `true` | Should the alarm sound file be faded. |\n| `alarmSoundFadeSeconds` | `30` | Within how many seconds should the alarm reach the configured `alarmSoundMaxVolume`. |\n|                         | | |\n| **Expert Options**      | | |\n| `debug`                 | `false` | If set to `true` it will show some debug information in the console. |\n| `alarmStoreFileName`    | `alarm.json` | File name to store information even if the Magic Mirror restarts. |\n\n## Alarm Sounds\n\nThere are already two alarm sounds:\n\n* [alarm.mp3](http://www.orangefreesounds.com/mp3-alarm-clock/) | From Alexander licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)\n* [blackforest.mp3](http://www.orangefreesounds.com/coo-coo-clock-sound/) | From Alexander licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)\n\n\n## Notifications\n\nMore notifications will be implemented as soon as wished.\n\n### Outgoing\n\n* `MMM-TouchAlarm-ALARM-CHANGED` -\u003e will be send `hour`: number, `minutes`: number, `active`: boolean, `nextAlarm`: moment-timestamp\n* `MMM-TouchAlarm-ALARM-FIRED`   -\u003e will be send `hour`: number, `minutes`: number\n* `MMM-TouchAlarm-ALARM-SNOOZE`  -\u003e will be send `hour`: number, `minutes`: number\n\n\n## Special Thanks\nSpecial thanks to [fewieden](https://github.com/fewieden/) for creating [MMM-AlarmClock](https://github.com/fewieden/MMM-AlarmClock) which helped a lot to create this project.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanloebel%2Fmmm-touchalarm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjanloebel%2Fmmm-touchalarm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjanloebel%2Fmmm-touchalarm/lists"}