neon-skill-alerts


Nameneon-skill-alerts JSON
Version 3.0.0 PyPI version JSON
download
home_pagehttps://github.com/NeonGeckoCom/skill-alerts
SummaryNone
upload_time2024-04-02 18:20:58
maintainerNone
docs_urlNone
authorNeongecko
requires_pythonNone
licenseBSD-3-Clause
keywords
VCS
bugtrack_url
requirements json_database neon-utils combo_lock ovos-utils ovos-bus-client ovos-workshop
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # <img src='./logo.svg' card_color="#FF8600" width="50" style="vertical-align:bottom" style="vertical-align:bottom">Alerts  
  
## Summary  
  
A skill to schedule alarms, timers, and reminders.


## Description  
  
The skill provides functionality to create alarms, timers and reminders, remove them by name, time, or type, and ask for
what is active. You may also silence all alerts and ask for a summary of what was missed if you were away, your device
was off, or you had quiet hours enabled.

Alarms and reminders may be set to recur daily or weekly. An active alert may be snoozed for a specified amount of time
while it is active. Any alerts that are not acknowledged will be added to a list of missed alerts that may be read and
cleared when requested.

Other modules may integrate with the alerts skill by listening for `neon.alert_expired` events. This event will be
emitted when a scheduled alert expires and will include any context associated with the event creation. If the event
was created with `mq` context, the mq connector module will forward the expired alert for the client module to handle
and the alert will be marked `active` until the client module emits a `neon.acknowledge_alert` Message with the `alert_id`
and `missed` data, i.e.:
```
Message("neon.acknowledge_alert", {"alert_id": <alert_id>, "missed": False}, <context>)
```
    
  
## Examples  
  
If you are skipping wake words, say `Neon` followed by any of the following, otherwise say your `Wake Word`:

- "Set an alarm for 8 AM."
- "When is my next alarm?"
- "Cancel my 8 AM alarm."

- "Set a 5 minute timer."
- "How much time is left?"

- "Remind me to go home at 6."
- "Remind me to take out the trash every thursday at 7 PM."
- "What are my reminders?"

- "Cancel all alarms."
- "Cancel all timers."
- "Cancel all reminders."

- "Go to sleep."
- "Start quiet hours."

If there is an active alert (expired and currently speaking or playing), you may snooze or dismiss it:

- "Stop."

- "Snooze."
- "Snooze for 1 minute."
  
If you had quiet hours enabled, your device was off, or you were away and missed an alert, you may ask for a summary:

- "Wake up."
- "What did I miss?"
- "Did I miss anything?"

## Contact Support
Use [this link](https://neongecko.com/ContactUs) or
[submit an issue on GitHub](https://help.github.com/en/articles/creating-an-issue)

## Incompatible Skills
This skill has known intent collisions with the following skills:
- [skill-reminder.mycroftAI](https://github.com/mycroftai/skill-reminder)
- [skill-alarm.mycroftAI](https://github.com/mycroftai/skill-alarm)
- [mycroft-timer.mycroftAI](https://github.com/mycroftai/mycroft-timer)

## Credits
[NeonGeckoCom](https://github.com/NeonGeckoCom)
[NeonDaniel](https://github.com/NeonDaniel)

## Category
**Productivity**
Daily

## Tags
#NeonGecko Original
#NeonAI
#alert
#alarm
#timer
#reminder
#schedule

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NeonGeckoCom/skill-alerts",
    "name": "neon-skill-alerts",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Neongecko",
    "author_email": "developers@neon.ai",
    "download_url": "https://files.pythonhosted.org/packages/31/aa/d04a0c58c9f4a3a1e688f78a8df97eadcce8b5ef4bac7f100e7931861a58/neon-skill-alerts-3.0.0.tar.gz",
    "platform": null,
    "description": "# <img src='./logo.svg' card_color=\"#FF8600\" width=\"50\" style=\"vertical-align:bottom\" style=\"vertical-align:bottom\">Alerts  \n  \n## Summary  \n  \nA skill to schedule alarms, timers, and reminders.\n\n\n## Description  \n  \nThe skill provides functionality to create alarms, timers and reminders, remove them by name, time, or type, and ask for\nwhat is active. You may also silence all alerts and ask for a summary of what was missed if you were away, your device\nwas off, or you had quiet hours enabled.\n\nAlarms and reminders may be set to recur daily or weekly. An active alert may be snoozed for a specified amount of time\nwhile it is active. Any alerts that are not acknowledged will be added to a list of missed alerts that may be read and\ncleared when requested.\n\nOther modules may integrate with the alerts skill by listening for `neon.alert_expired` events. This event will be\nemitted when a scheduled alert expires and will include any context associated with the event creation. If the event\nwas created with `mq` context, the mq connector module will forward the expired alert for the client module to handle\nand the alert will be marked `active` until the client module emits a `neon.acknowledge_alert` Message with the `alert_id`\nand `missed` data, i.e.:\n```\nMessage(\"neon.acknowledge_alert\", {\"alert_id\": <alert_id>, \"missed\": False}, <context>)\n```\n    \n  \n## Examples  \n  \nIf you are skipping wake words, say `Neon` followed by any of the following, otherwise say your `Wake Word`:\n\n- \"Set an alarm for 8 AM.\"\n- \"When is my next alarm?\"\n- \"Cancel my 8 AM alarm.\"\n\n- \"Set a 5 minute timer.\"\n- \"How much time is left?\"\n\n- \"Remind me to go home at 6.\"\n- \"Remind me to take out the trash every thursday at 7 PM.\"\n- \"What are my reminders?\"\n\n- \"Cancel all alarms.\"\n- \"Cancel all timers.\"\n- \"Cancel all reminders.\"\n\n- \"Go to sleep.\"\n- \"Start quiet hours.\"\n\nIf there is an active alert (expired and currently speaking or playing), you may snooze or dismiss it:\n\n- \"Stop.\"\n\n- \"Snooze.\"\n- \"Snooze for 1 minute.\"\n  \nIf you had quiet hours enabled, your device was off, or you were away and missed an alert, you may ask for a summary:\n\n- \"Wake up.\"\n- \"What did I miss?\"\n- \"Did I miss anything?\"\n\n## Contact Support\nUse [this link](https://neongecko.com/ContactUs) or\n[submit an issue on GitHub](https://help.github.com/en/articles/creating-an-issue)\n\n## Incompatible Skills\nThis skill has known intent collisions with the following skills:\n- [skill-reminder.mycroftAI](https://github.com/mycroftai/skill-reminder)\n- [skill-alarm.mycroftAI](https://github.com/mycroftai/skill-alarm)\n- [mycroft-timer.mycroftAI](https://github.com/mycroftai/mycroft-timer)\n\n## Credits\n[NeonGeckoCom](https://github.com/NeonGeckoCom)\n[NeonDaniel](https://github.com/NeonDaniel)\n\n## Category\n**Productivity**\nDaily\n\n## Tags\n#NeonGecko Original\n#NeonAI\n#alert\n#alarm\n#timer\n#reminder\n#schedule\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": null,
    "version": "3.0.0",
    "project_urls": {
        "Homepage": "https://github.com/NeonGeckoCom/skill-alerts"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d6f27d3699a0be15b848c7871fde6efdef88538de12dd4861e2f3d47246fb30",
                "md5": "df9ff47c66fee4e8d3f55d3e83f5810e",
                "sha256": "22ecd978f43a2b10f841850f0628764f38eb8358b273586fa02371a8976f5e17"
            },
            "downloads": -1,
            "filename": "neon_skill_alerts-3.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "df9ff47c66fee4e8d3f55d3e83f5810e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 501057,
            "upload_time": "2024-04-02T18:20:56",
            "upload_time_iso_8601": "2024-04-02T18:20:56.027531Z",
            "url": "https://files.pythonhosted.org/packages/7d/6f/27d3699a0be15b848c7871fde6efdef88538de12dd4861e2f3d47246fb30/neon_skill_alerts-3.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "31aad04a0c58c9f4a3a1e688f78a8df97eadcce8b5ef4bac7f100e7931861a58",
                "md5": "972c01f36fdafec50f0e780d2904d467",
                "sha256": "e031a8dc54e2d30257583d6016db376740627b4c71085be8dd16d2f21133f927"
            },
            "downloads": -1,
            "filename": "neon-skill-alerts-3.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "972c01f36fdafec50f0e780d2904d467",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 469176,
            "upload_time": "2024-04-02T18:20:58",
            "upload_time_iso_8601": "2024-04-02T18:20:58.629354Z",
            "url": "https://files.pythonhosted.org/packages/31/aa/d04a0c58c9f4a3a1e688f78a8df97eadcce8b5ef4bac7f100e7931861a58/neon-skill-alerts-3.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-02 18:20:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NeonGeckoCom",
    "github_project": "skill-alerts",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "json_database",
            "specs": [
                [
                    "~=",
                    "0.5"
                ]
            ]
        },
        {
            "name": "neon-utils",
            "specs": [
                [
                    "~=",
                    "1.2"
                ],
                [
                    ">=",
                    "1.11.1a3"
                ]
            ]
        },
        {
            "name": "combo_lock",
            "specs": [
                [
                    "~=",
                    "0.2"
                ]
            ]
        },
        {
            "name": "ovos-utils",
            "specs": [
                [
                    "~=",
                    "0.0"
                ],
                [
                    ">=",
                    "0.0.32"
                ]
            ]
        },
        {
            "name": "ovos-bus-client",
            "specs": [
                [
                    "~=",
                    "0.0"
                ],
                [
                    ">=",
                    "0.0.3"
                ]
            ]
        },
        {
            "name": "ovos-workshop",
            "specs": [
                [
                    "~=",
                    "0.0"
                ],
                [
                    ">=",
                    "0.0.12"
                ]
            ]
        }
    ],
    "lcname": "neon-skill-alerts"
}
        
Elapsed time: 0.66612s