# PHAL-plugin-mac
Provides system specific commands to OVOS for Mac OS. Creates fake ducking for OCP/ovos-media, barge-in volume adjustment, GUI button compatability, and allows for management of OVOS services.
Tested on Mac OS Sonoma 14.6.1, but should be valid for all currently supported Mac OS versions as of August 2024.
## Install
`pip install PHAL-plugin-mac`
Requires associated skill for volume-based voice commands:
- skill-ovos-volume
## Config
This plugin is not an Admin plugin, but in order for most of the system level commands to work, the user must be in the sudoers file. This can be done by running the following command in the terminal:
`sudo vim /private/etc/sudoers.d/<username>`
Replace <username> with the username of the user running the OVOS instance.
Then add the following lines to the file:
```sh
<username> ALL=(ALL) NOPASSWD: /usr/sbin/systemsetup
<username> ALL=(ALL) NOPASSWD: /usr/sbin/shutdown
<username> ALL=(ALL) NOPASSWD: /usr/bin/sntp
<username> ALL=(ALL) NOPASSWD: /usr/bin/defaults
```
Be sure to replace `<username>` with the username of the user running the OVOS instance.
**NOTE:** Do this at your own risk. This is a security risk and should only be done if you understand the implications.
## Handle bus events to interact with the OS
```python
# System
self.bus.on("system.ntp.sync", self.handle_ntp_sync_request)
self.bus.on("system.ssh.status", self.handle_ssh_status)
self.bus.on("system.ssh.enable", self.handle_ssh_enable_request)
self.bus.on("system.ssh.disable", self.handle_ssh_disable_request)
self.bus.on("system.reboot", self.handle_reboot_request)
self.bus.on("system.shutdown", self.handle_shutdown_request)
self.bus.on("system.configure.language", self.handle_configure_language_request)
self.bus.on("system.mycroft.service.restart", self.handle_mycroft_restart_request)
# Volume
self.bus.on("mycroft.volume.get", self.handle_volume_set)
self.bus.on("mycroft.volume.set", self.handle_volume_set)
self.bus.on("mycroft.volume.decrease", self.handle_volume_decrease)
self.bus.on("mycroft.volume.increase", self.handle_volume_increase)
self.bus.on("mycroft.volume.mute", self.handle_volume_mute)
self.bus.on("mycroft.volume.unmute", self.handle_volume_unmute)
self.bus.on("mycroft.volume.mute.toggle", self.handle_volume_mute_toggle)
```
## Credits
Oscillate Labs (@mikejgray)
Raw data
{
"_id": null,
"home_page": null,
"name": "ovos-phal-plugin-mac",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ovos, plugin, voice, assistant",
"author": null,
"author_email": "Mike Gray <mike@oscillatelabs.net>",
"download_url": "https://files.pythonhosted.org/packages/91/db/2bba9172f5969233a376ba8a1bcf7ca7a32c75e92488fa98577d8980b3c6/ovos_phal_plugin_mac-0.1.0.tar.gz",
"platform": null,
"description": "# PHAL-plugin-mac\n\nProvides system specific commands to OVOS for Mac OS. Creates fake ducking for OCP/ovos-media, barge-in volume adjustment, GUI button compatability, and allows for management of OVOS services.\n\nTested on Mac OS Sonoma 14.6.1, but should be valid for all currently supported Mac OS versions as of August 2024.\n\n## Install\n\n`pip install PHAL-plugin-mac`\n\nRequires associated skill for volume-based voice commands:\n\n- skill-ovos-volume\n\n## Config\n\nThis plugin is not an Admin plugin, but in order for most of the system level commands to work, the user must be in the sudoers file. This can be done by running the following command in the terminal:\n\n`sudo vim /private/etc/sudoers.d/<username>`\nReplace <username> with the username of the user running the OVOS instance.\n\nThen add the following lines to the file:\n\n```sh\n<username> ALL=(ALL) NOPASSWD: /usr/sbin/systemsetup\n<username> ALL=(ALL) NOPASSWD: /usr/sbin/shutdown\n<username> ALL=(ALL) NOPASSWD: /usr/bin/sntp\n<username> ALL=(ALL) NOPASSWD: /usr/bin/defaults\n```\n\nBe sure to replace `<username>` with the username of the user running the OVOS instance.\n\n**NOTE:** Do this at your own risk. This is a security risk and should only be done if you understand the implications.\n\n## Handle bus events to interact with the OS\n\n```python\n# System\nself.bus.on(\"system.ntp.sync\", self.handle_ntp_sync_request)\nself.bus.on(\"system.ssh.status\", self.handle_ssh_status)\nself.bus.on(\"system.ssh.enable\", self.handle_ssh_enable_request)\nself.bus.on(\"system.ssh.disable\", self.handle_ssh_disable_request)\nself.bus.on(\"system.reboot\", self.handle_reboot_request)\nself.bus.on(\"system.shutdown\", self.handle_shutdown_request)\nself.bus.on(\"system.configure.language\", self.handle_configure_language_request)\nself.bus.on(\"system.mycroft.service.restart\", self.handle_mycroft_restart_request)\n# Volume\nself.bus.on(\"mycroft.volume.get\", self.handle_volume_set)\nself.bus.on(\"mycroft.volume.set\", self.handle_volume_set)\nself.bus.on(\"mycroft.volume.decrease\", self.handle_volume_decrease)\nself.bus.on(\"mycroft.volume.increase\", self.handle_volume_increase)\nself.bus.on(\"mycroft.volume.mute\", self.handle_volume_mute)\nself.bus.on(\"mycroft.volume.unmute\", self.handle_volume_unmute)\nself.bus.on(\"mycroft.volume.mute.toggle\", self.handle_volume_mute_toggle)\n```\n\n## Credits\n\nOscillate Labs (@mikejgray)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "# PHAL-plugin-mac",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac",
"Repository": "https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac"
},
"split_keywords": [
"ovos",
" plugin",
" voice",
" assistant"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8c0570ee5c5882bacc0dab37804dd6254451b43794771263912073353d6c4c4e",
"md5": "a52a39ae675cdbc33355038587a36f50",
"sha256": "b995860d20dd3dc72ae9b22f7ebb4ee374269d65e5ed55869b3a1bacda02292f"
},
"downloads": -1,
"filename": "ovos_phal_plugin_mac-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a52a39ae675cdbc33355038587a36f50",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5128,
"upload_time": "2024-12-26T03:14:46",
"upload_time_iso_8601": "2024-12-26T03:14:46.887458Z",
"url": "https://files.pythonhosted.org/packages/8c/05/70ee5c5882bacc0dab37804dd6254451b43794771263912073353d6c4c4e/ovos_phal_plugin_mac-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91db2bba9172f5969233a376ba8a1bcf7ca7a32c75e92488fa98577d8980b3c6",
"md5": "e49154283113d095c71d12a7b2a51fd3",
"sha256": "a87b9b2ec55057c28098b823afdad5992a188a9b13f09fa7018391b32378fb77"
},
"downloads": -1,
"filename": "ovos_phal_plugin_mac-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e49154283113d095c71d12a7b2a51fd3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6332,
"upload_time": "2024-12-26T03:14:49",
"upload_time_iso_8601": "2024-12-26T03:14:49.402722Z",
"url": "https://files.pythonhosted.org/packages/91/db/2bba9172f5969233a376ba8a1bcf7ca7a32c75e92488fa98577d8980b3c6/ovos_phal_plugin_mac-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-26 03:14:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OscillateLabsLLC",
"github_project": "ovos-phal-plugin-mac",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "ovos-phal-plugin-mac"
}
JSON
