ovos-skill-boot-finished


Nameovos-skill-boot-finished JSON
Version 0.4.9 PyPI version JSON
download
home_pagehttps://github.com/OpenVoiceOS/skill-ovos-boot-finished
SummaryOVOS finished booting skill
upload_time2024-12-02 17:47:45
maintainerNone
docs_urlNone
authorOpenVoiceOS
requires_pythonNone
licenseApache-2.0
keywords ovos skill plugin
VCS
bugtrack_url
requirements ovos-workshop ovos-utils ovos-bus-client ovos-plugin-manager
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Finished Booting Skill

## Summary

The Finished Booting skill provides notifications when OpenVoiceOS (OVOS) has fully started and all core services are ready. Notifications can be spoken, played as a sound, or simply logged, based on the user’s preferences.

## Description

This skill ensures users are informed when OVOS has completed booting and all essential services (such as network, GUI, and others) are ready for use. Users can configure the type of ready notification, which can be spoken, triggered as a sound, or displayed visually on compatible devices. Notifications can also be enabled or disabled via voice commands, making it easy to control the readiness alerts.

### Key Features
- Monitors system readiness by checking core services like network, internet, and GUI.
- Notifies the user when OVOS is fully ready.
- Enables or disables ready notifications via voice commands.
- Offers configurable options for spoken readiness notifications and sound effects.


## Configuration

To customize the skill behavior, use the `settings.json` file.

```javascript
{
  "speak_ready": true,        // Enables or disables spoken notifications for readiness
  "ready_sound": true,         // Enables or disables sound notifications for readiness
  "ready_settings": [
    "skills",                  // Services to check before notifying readiness
    "voice",
    "audio",
    "gui",
    "internet"
  ]
}
```

The `ready_settings` option allows for flexible notifications based on the device’s role. For example, a server setup might only monitor core services, while a fully-featured OVOS device might wait for the GUI and audio stack. Specific skills can also be added to this list, ensuring the system only notifies readiness when those skills are loaded. 

> If `ready_settings` is omitted, the skill defaults to waiting for `ovos-core` and **all installed skills** to be ready before sending a notification. 

Valid ready settings options:
- `internet` -> device is connected to the internet
- `network` -> device is connected to local network, might not have internet
- `gui_connected` -> a gui client connected to the gui socket
- `skills` -> ovos-core reported ready
- `voice` -> ovos-dinkum-listener reported ready
- `audio` -> ovos-audio reported ready
- `gui` -> ovos-gui websocket reported ready
- `PHAL` -> PHAL reported ready
- specific skills can also be waited for via their `skill_id`

## Voice Commands

- **Enable Ready Notifications**: Activates the spoken notification when OVOS is ready.
  - Example: "Enable ready notifications."

- **Disable Ready Notifications**: Deactivates the spoken notification.
  - Example: "Disable ready notifications."

- **Check if System is Ready**: Inquires whether the system is fully ready.
  - Example: "Is the system ready?"

## Examples

- "Enable ready notifications."
- "Disable ready speech."
- "Is the system ready?"

## Credits

[NeonGeckoCom](https://github.com/NeonGeckoCom/skill-core_ready)

## Category

**Daily**



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/OpenVoiceOS/skill-ovos-boot-finished",
    "name": "ovos-skill-boot-finished",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "ovos skill plugin",
    "author": "OpenVoiceOS",
    "author_email": "jarbasai@mailfence.com",
    "download_url": "https://files.pythonhosted.org/packages/e7/d9/0b8a1176b983fa7d592238162a2f33d81b6d1c4c4ee79b65555c9d85f8d0/ovos-skill-boot-finished-0.4.9.tar.gz",
    "platform": null,
    "description": "# Finished Booting Skill\n\n## Summary\n\nThe Finished Booting skill provides notifications when OpenVoiceOS (OVOS) has fully started and all core services are ready. Notifications can be spoken, played as a sound, or simply logged, based on the user\u2019s preferences.\n\n## Description\n\nThis skill ensures users are informed when OVOS has completed booting and all essential services (such as network, GUI, and others) are ready for use. Users can configure the type of ready notification, which can be spoken, triggered as a sound, or displayed visually on compatible devices. Notifications can also be enabled or disabled via voice commands, making it easy to control the readiness alerts.\n\n### Key Features\n- Monitors system readiness by checking core services like network, internet, and GUI.\n- Notifies the user when OVOS is fully ready.\n- Enables or disables ready notifications via voice commands.\n- Offers configurable options for spoken readiness notifications and sound effects.\n\n\n## Configuration\n\nTo customize the skill behavior, use the `settings.json` file.\n\n```javascript\n{\n  \"speak_ready\": true,        // Enables or disables spoken notifications for readiness\n  \"ready_sound\": true,         // Enables or disables sound notifications for readiness\n  \"ready_settings\": [\n    \"skills\",                  // Services to check before notifying readiness\n    \"voice\",\n    \"audio\",\n    \"gui\",\n    \"internet\"\n  ]\n}\n```\n\nThe `ready_settings` option allows for flexible notifications based on the device\u2019s role. For example, a server setup might only monitor core services, while a fully-featured OVOS device might wait for the GUI and audio stack. Specific skills can also be added to this list, ensuring the system only notifies readiness when those skills are loaded. \n\n> If `ready_settings` is omitted, the skill defaults to waiting for `ovos-core` and **all installed skills** to be ready before sending a notification. \n\nValid ready settings options:\n- `internet` -> device is connected to the internet\n- `network` -> device is connected to local network, might not have internet\n- `gui_connected` -> a gui client connected to the gui socket\n- `skills` -> ovos-core reported ready\n- `voice` -> ovos-dinkum-listener reported ready\n- `audio` -> ovos-audio reported ready\n- `gui` -> ovos-gui websocket reported ready\n- `PHAL` -> PHAL reported ready\n- specific skills can also be waited for via their `skill_id`\n\n## Voice Commands\n\n- **Enable Ready Notifications**: Activates the spoken notification when OVOS is ready.\n  - Example: \"Enable ready notifications.\"\n\n- **Disable Ready Notifications**: Deactivates the spoken notification.\n  - Example: \"Disable ready notifications.\"\n\n- **Check if System is Ready**: Inquires whether the system is fully ready.\n  - Example: \"Is the system ready?\"\n\n## Examples\n\n- \"Enable ready notifications.\"\n- \"Disable ready speech.\"\n- \"Is the system ready?\"\n\n## Credits\n\n[NeonGeckoCom](https://github.com/NeonGeckoCom/skill-core_ready)\n\n## Category\n\n**Daily**\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "OVOS finished booting skill",
    "version": "0.4.9",
    "project_urls": {
        "Homepage": "https://github.com/OpenVoiceOS/skill-ovos-boot-finished"
    },
    "split_keywords": [
        "ovos",
        "skill",
        "plugin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c59c4ddc0bb5e76edca51f3348e7fbb73b1e15f494e1a10b04003012cea5c937",
                "md5": "216e6c6dc28131f9b29c60d0439996b8",
                "sha256": "bd0759858bf12d7db87cb07665a5e14186737c6ab80f5e9f59f526b9880e43a0"
            },
            "downloads": -1,
            "filename": "ovos_skill_boot_finished-0.4.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "216e6c6dc28131f9b29c60d0439996b8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 47661,
            "upload_time": "2024-12-02T17:47:44",
            "upload_time_iso_8601": "2024-12-02T17:47:44.994035Z",
            "url": "https://files.pythonhosted.org/packages/c5/9c/4ddc0bb5e76edca51f3348e7fbb73b1e15f494e1a10b04003012cea5c937/ovos_skill_boot_finished-0.4.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e7d90b8a1176b983fa7d592238162a2f33d81b6d1c4c4ee79b65555c9d85f8d0",
                "md5": "826481ec017ea180cbe5059932169f26",
                "sha256": "b0109b8c586fe3367a61d15f949ff7d7a90cfe293286ee05df73bb2cba2124b1"
            },
            "downloads": -1,
            "filename": "ovos-skill-boot-finished-0.4.9.tar.gz",
            "has_sig": false,
            "md5_digest": "826481ec017ea180cbe5059932169f26",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 20732,
            "upload_time": "2024-12-02T17:47:45",
            "upload_time_iso_8601": "2024-12-02T17:47:45.985845Z",
            "url": "https://files.pythonhosted.org/packages/e7/d9/0b8a1176b983fa7d592238162a2f33d81b6d1c4c4ee79b65555c9d85f8d0/ovos-skill-boot-finished-0.4.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-02 17:47:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OpenVoiceOS",
    "github_project": "skill-ovos-boot-finished",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "ovos-workshop",
            "specs": [
                [
                    "<",
                    "4.0.0"
                ],
                [
                    ">=",
                    "2.1.0"
                ]
            ]
        },
        {
            "name": "ovos-utils",
            "specs": [
                [
                    "<",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "ovos-bus-client",
            "specs": [
                [
                    "<",
                    "2.0.0"
                ]
            ]
        },
        {
            "name": "ovos-plugin-manager",
            "specs": []
        }
    ],
    "lcname": "ovos-skill-boot-finished"
}
        
Elapsed time: 0.37941s