# OpenVoiceOS Home Screen
The home screen is the central place for all your tasks. It is the first thing you will see after completing the onboarding process. It supports a variety of pre-defined widgets which provide you with a quick overview of information you need to know like the current date, time and weather. The home screen contains various features and integrations which you can learn more about in the following sections.
## Features
### Night Mode Feature
The Night Mode feature lets you quickly switch your home screen into a dark standby clock, reducing the amount of light emitted by your device. This is especially useful if you are using your device in a dark room or at night. You can enable the night mode feature by tapping on the left edge pill button on the home screen.
### Quick Actions Dashboard
The Quick Actions Dashboard provides you with a card-based interface to quickly access and add your most used action. The Quick Actions dashboard comes with a variety of pre-defined actions like the ability to quickly add a new alarm, start a new timer or add a new note. You can also add your own custom actions to the dashboard by tapping on the plus button in the top right corner of the dashboard. The Quick Actions dashboard is accessible by tapping on the right edge pill button on the home screen.
### Application Launcher
OpenVoiceOS comes with support for dedicated voice applications. Voice Applications can be dedicated skills or PHAL plugins, providing their own dedicated user interface. The application launcher will show you a list of all available voice applications. You can access the application launcher by tapping on the center pill button on the bottom of the home screen.
### Wallpapers
The home screen supports custom wallpapers and comes with a bunch of wallpapers to choose from. You can easily change your custom wallpaper by swiping from right to left on the home screen.
## Widgets
### Notifications Widget
The notifications widget provides you with a quick overview of all your notifications. The notifications bell icon will be displayed in the top left corner of the home screen. You can access the notifications overview by tapping on the bell icon when it is displayed.
### Timer Widget
The timer widget is displayed in top left corner after the notifications bell icon. It will show up when you have an active timer running. Clicking on the timer widget will open the timers overview.
### Alarm Widget
The alarm widget is displayed in top left corner after the timer widget. It will show up when you have an active alarm set. Clicking on the alarm widget will open the alarms overview.
### Media Player Widget
The media player widget is displayed in the bottom of the home screen, It replaces the examples widget when a media player is active. The media player widget will show you the currently playing media and provide you with a quick way to pause, resume or skip the current media. You can also quickly access the media player by tapping the quick display media player button on the right side of the media player widget.
## Configuration
### Settings
The homescreen has several customizations available via the standard [skill settings mechanism](https://openvoiceos.github.io/community-docs/115-ht_config_homescreen/)
Sample `settings.json` file with all of the options explained
```
{
"weather_skill": "skill-weather.openvoiceos",
"datetime_skill": "skill-date-time.mycroftai",
"examples_skill": "ovos-skills-info.openvoiceos",
"wallpaper": "default.jpg",
"persistent_menu_hint": true,
"examples_enabled": false,
"randomize_examples": true,
"examples_prefix": false
}
```
* weather_skill: Allows you to use a custom skill to display the weather. Defaults to `skill-ovos-weather.openvoiceos`
* datetime_skill: Allows you to use a custom skill to display the date and time. Defaults to `skill-ovos-date-time.openvoiceos`
* examples_skill: Allows use of a custom skill for the displayed examples. Defaults to `ovos_skills_manager.utils.get_skills_example()` function
* wallpaper: Allows a custom wallpaper to be displayed. Use a complete url without any tilde `~`
* persistent_menu_hint: When true, displayes a hint of the pull-down menu at the top of the page
* examples_enabled: When false, the examples at the bottom of the screen will be hidden
* randomize_examples: When false, the rotation of the examples will follow the way they are loaded
* examples_prefix: When false, the prefix 'Ask Me' will NOT be displayed with the examples
`settings.json` will be located in the following places:
OVOS: `~/.config/mycroft/skills/skill-ovos-homescreen.openvoiceos/settings.json`
Neon: `~/.config/neon/skills/skill-ovos-homescreen.openvoiceos/settings.json`
For other OVOS-based installations, first try the OVOS location, which is the default.
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenVoiceOS/skill-ovos-homescreen",
"name": "ovos-skill-homescreen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ovos skill plugin",
"author": "Aix",
"author_email": "aix.m@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/c5/20/f159b99d7166296301a2cb6f2d5b8b35cbe3d49fbac2292738c27663fe59/ovos-skill-homescreen-3.0.2.tar.gz",
"platform": null,
"description": "# OpenVoiceOS Home Screen\n\nThe home screen is the central place for all your tasks. It is the first thing you will see after completing the onboarding process. It supports a variety of pre-defined widgets which provide you with a quick overview of information you need to know like the current date, time and weather. The home screen contains various features and integrations which you can learn more about in the following sections.\n\n\n\n## Features\n\n### Night Mode Feature\n\nThe Night Mode feature lets you quickly switch your home screen into a dark standby clock, reducing the amount of light emitted by your device. This is especially useful if you are using your device in a dark room or at night. You can enable the night mode feature by tapping on the left edge pill button on the home screen.\n\n\n\n### Quick Actions Dashboard\n\nThe Quick Actions Dashboard provides you with a card-based interface to quickly access and add your most used action. The Quick Actions dashboard comes with a variety of pre-defined actions like the ability to quickly add a new alarm, start a new timer or add a new note. You can also add your own custom actions to the dashboard by tapping on the plus button in the top right corner of the dashboard. The Quick Actions dashboard is accessible by tapping on the right edge pill button on the home screen.\n\n\n\n### Application Launcher\n\nOpenVoiceOS comes with support for dedicated voice applications. Voice Applications can be dedicated skills or PHAL plugins, providing their own dedicated user interface. The application launcher will show you a list of all available voice applications. You can access the application launcher by tapping on the center pill button on the bottom of the home screen.\n\n\n\n\n### Wallpapers\n\nThe home screen supports custom wallpapers and comes with a bunch of wallpapers to choose from. You can easily change your custom wallpaper by swiping from right to left on the home screen.\n\n\n\n## Widgets\n\n\n\n### Notifications Widget\n\nThe notifications widget provides you with a quick overview of all your notifications. The notifications bell icon will be displayed in the top left corner of the home screen. You can access the notifications overview by tapping on the bell icon when it is displayed.\n\n### Timer Widget\n\nThe timer widget is displayed in top left corner after the notifications bell icon. It will show up when you have an active timer running. Clicking on the timer widget will open the timers overview.\n\n### Alarm Widget\n\nThe alarm widget is displayed in top left corner after the timer widget. It will show up when you have an active alarm set. Clicking on the alarm widget will open the alarms overview.\n\n### Media Player Widget\n\nThe media player widget is displayed in the bottom of the home screen, It replaces the examples widget when a media player is active. The media player widget will show you the currently playing media and provide you with a quick way to pause, resume or skip the current media. You can also quickly access the media player by tapping the quick display media player button on the right side of the media player widget.\n\n\n\n## Configuration\n\n### Settings\n\nThe homescreen has several customizations available via the standard [skill settings mechanism](https://openvoiceos.github.io/community-docs/115-ht_config_homescreen/)\n\nSample `settings.json` file with all of the options explained\n\n```\n{\n \"weather_skill\": \"skill-weather.openvoiceos\",\n \"datetime_skill\": \"skill-date-time.mycroftai\",\n \"examples_skill\": \"ovos-skills-info.openvoiceos\",\n \"wallpaper\": \"default.jpg\",\n \"persistent_menu_hint\": true,\n \"examples_enabled\": false,\n \"randomize_examples\": true,\n \"examples_prefix\": false\n}\n```\n\n* weather_skill: Allows you to use a custom skill to display the weather. Defaults to `skill-ovos-weather.openvoiceos`\n* datetime_skill: Allows you to use a custom skill to display the date and time. Defaults to `skill-ovos-date-time.openvoiceos`\n* examples_skill: Allows use of a custom skill for the displayed examples. Defaults to `ovos_skills_manager.utils.get_skills_example()` function\n* wallpaper: Allows a custom wallpaper to be displayed. Use a complete url without any tilde `~`\n* persistent_menu_hint: When true, displayes a hint of the pull-down menu at the top of the page\n* examples_enabled: When false, the examples at the bottom of the screen will be hidden\n* randomize_examples: When false, the rotation of the examples will follow the way they are loaded\n* examples_prefix: When false, the prefix 'Ask Me' will NOT be displayed with the examples\n\n`settings.json` will be located in the following places:\n\nOVOS: `~/.config/mycroft/skills/skill-ovos-homescreen.openvoiceos/settings.json`\nNeon: `~/.config/neon/skills/skill-ovos-homescreen.openvoiceos/settings.json`\n\nFor other OVOS-based installations, first try the OVOS location, which is the default.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OVOS skill plugin",
"version": "3.0.2",
"project_urls": {
"Homepage": "https://github.com/OpenVoiceOS/skill-ovos-homescreen"
},
"split_keywords": [
"ovos",
"skill",
"plugin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "063a68c0a175f2314f35e0b30f1695f675554cf7654b478bdad207983255e30d",
"md5": "6bdc43513d2ee7a88e2f2fed6019502b",
"sha256": "5ef7d9293a742d5cdae97048adb127bdfc3181cf8812fcdc60b3db83f170bfad"
},
"downloads": -1,
"filename": "ovos_skill_homescreen-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bdc43513d2ee7a88e2f2fed6019502b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 158396,
"upload_time": "2024-11-19T21:08:33",
"upload_time_iso_8601": "2024-11-19T21:08:33.080563Z",
"url": "https://files.pythonhosted.org/packages/06/3a/68c0a175f2314f35e0b30f1695f675554cf7654b478bdad207983255e30d/ovos_skill_homescreen-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c520f159b99d7166296301a2cb6f2d5b8b35cbe3d49fbac2292738c27663fe59",
"md5": "d1c7313d2043ab19414069dd78120fb7",
"sha256": "1beedfc62a7eceec547afb2e54019620c5d26787d8792e153bb6bd7403602ef6"
},
"downloads": -1,
"filename": "ovos-skill-homescreen-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d1c7313d2043ab19414069dd78120fb7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 126359,
"upload_time": "2024-11-19T21:08:34",
"upload_time_iso_8601": "2024-11-19T21:08:34.363548Z",
"url": "https://files.pythonhosted.org/packages/c5/20/f159b99d7166296301a2cb6f2d5b8b35cbe3d49fbac2292738c27663fe59/ovos-skill-homescreen-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 21:08:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenVoiceOS",
"github_project": "skill-ovos-homescreen",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "ovos-utils",
"specs": [
[
">=",
"0.0.38"
],
[
"<",
"2.0.0"
]
]
},
{
"name": "ovos-workshop",
"specs": [
[
"<",
"4.0.0"
],
[
">=",
"2.4.0"
]
]
},
{
"name": "ovos-date-parser",
"specs": [
[
">=",
"0.0.3"
],
[
"<",
"1.0.0"
]
]
},
{
"name": "ovos-bus-client",
"specs": [
[
">=",
"1.0.0"
],
[
"<",
"2.0.0"
]
]
}
],
"lcname": "ovos-skill-homescreen"
}
JSON
