ovos-phal-plugin-mac 0.1.0__tar.gz

ovos_phal_plugin_mac-0.1.0/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.1
+Name: ovos-phal-plugin-mac
+Version: 0.1.0
+Summary: # PHAL-plugin-mac
+Author-email: Mike Gray <mike@oscillatelabs.net>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac
+Project-URL: Repository, https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac
+Keywords: ovos,plugin,voice,assistant
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ovos-utils
+Requires-Dist: ovos-bus-client
+Requires-Dist: ovos-workshop
+Requires-Dist: ovos-plugin-manager
+Requires-Dist: osascript==2020.12.3
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+# 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)

ovos_phal_plugin_mac-0.1.0/README.md

@@ -0,0 +1,59 @@
+# 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)

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/PKG-INFO

@@ -0,0 +1,79 @@
+Metadata-Version: 2.1
+Name: ovos-phal-plugin-mac
+Version: 0.1.0
+Summary: # PHAL-plugin-mac
+Author-email: Mike Gray <mike@oscillatelabs.net>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac
+Project-URL: Repository, https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac
+Keywords: ovos,plugin,voice,assistant
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: ovos-utils
+Requires-Dist: ovos-bus-client
+Requires-Dist: ovos-workshop
+Requires-Dist: ovos-plugin-manager
+Requires-Dist: osascript==2020.12.3
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+
+# 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)

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+README.md
+pyproject.toml
+ovos_phal_plugin_mac.egg-info/PKG-INFO
+ovos_phal_plugin_mac.egg-info/SOURCES.txt
+ovos_phal_plugin_mac.egg-info/dependency_links.txt
+ovos_phal_plugin_mac.egg-info/entry_points.txt
+ovos_phal_plugin_mac.egg-info/requires.txt
+ovos_phal_plugin_mac.egg-info/top_level.txt
+phal_plugin_mac/__init__.py
+phal_plugin_mac/version.py
+requirements/requirements-dev.txt
+requirements/requirements.txt
+test/test_plugin.py

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[ovos.plugin.phal]
+ovos-phal-plugin-mac = ovos_phal_plugin_mac:MacOSPlugin

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/requires.txt

@@ -0,0 +1,9 @@
+ovos-utils
+ovos-bus-client
+ovos-workshop
+ovos-plugin-manager
+osascript==2020.12.3
+
+[test]
+pytest
+pytest-cov

ovos_phal_plugin_mac-0.1.0/ovos_phal_plugin_mac.egg-info/top_level.txt

@@ -0,0 +1 @@
+ovos_phal_plugin_mac

ovos_phal_plugin_mac-0.1.0/phal_plugin_mac/__init__.py

@@ -0,0 +1,239 @@
+"""macOS PHAL plugin for OVOS."""
+
+import subprocess
+
+import osascript
+from ovos_bus_client import Message
+from ovos_plugin_manager.phal import PHALPlugin
+
+
+class MacOSPlugin(PHALPlugin):
+    """macOS PHAL plugin for OVOS."""
+
+    def __init__(self, bus=None, config=None, *args, **kwargs):
+        super().__init__(bus=bus, config=config, name="ovos-PHAL-plugin-mac", *args, **kwargs)
+        # System events
+        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 events
+        self.bus.on("mycroft.volume.get", self.handle_volume_get)
+        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)
+
+    @property
+    def allow_reboot(self):
+        """Check if reboot is allowed."""
+        return self.config.get("allow_reboot", True)
+
+    @property
+    def allow_shutdown(self):
+        """Check if shutdown is allowed."""
+        return self.config.get("allow_shutdown", True)
+
+    @property
+    def volume_change_interval(self):
+        """Get the volume change interval percentage. Defaults to 10."""
+        return self.config.get("volume_change_interval", 10)
+
+    def _run_command(self, command, check=True):
+        """Private method to run shell commands."""
+        try:
+            return subprocess.run(command, check=check, capture_output=True, text=True)
+        except Exception as err:
+            self.log.exception("Error running command: %s", err)
+
+    def _run_applescript(self, script):
+        """Private method to run AppleScript."""
+        return_code, out, err = osascript.run(script)
+        self.log.debug("Return code for %s was %s", script, return_code)
+        if return_code and return_code > 0:
+            self.log.error("Error code %s running AppleScript: %s", return_code, err)
+            return
+        return out
+
+    def _set_volume(self, volume):
+        """Set the system volume (0-100)."""
+        script = f"set volume output volume {volume}"
+        self._run_applescript(script)
+
+    def _get_volume(self):
+        """Get the current system volume (0-100)."""
+        script = "output volume of (get volume settings)"
+        result = self._run_applescript(script)
+        self.log.debug("Current volume: %s", result)
+        return int(result) if result else None
+
+    def _is_muted(self):
+        """Check if the system is muted."""
+        script = "output muted of (get volume settings)"
+        result = self._run_applescript(script)
+        if not result:
+            return False
+        return "true" in result.lower()
+
+    def _set_mute(self, mute):
+        """Set the system mute state."""
+        script = "set volume with output muted"
+        if not mute:
+            script = "set volume without output muted"
+        self._run_applescript(script)
+
+    def handle_volume_get(self, message: Message):
+        """Handle the volume get request."""
+        volume = self._get_volume()
+        if volume:
+            self.bus.emit(message.reply("mycroft.volume.get.response", {"percent": volume}))
+        else:
+            self.log.error("Error getting Mac volume")
+
+    def handle_volume_set(self, message: Message):
+        """Handle the volume set request."""
+        volume = message.data.get("percent", 50)
+        volume = max(0, min(100, volume))  # Ensure volume is between 0 and 100
+        self._set_volume(volume)
+        self.bus.emit(message.forward("mycroft.volume.set.confirm", {"percent": volume}))
+
+    def handle_volume_decrease(self, message: Message):
+        """Handle the volume decrease request."""
+        current_volume = self._get_volume()
+        new_volume = max(
+            0, current_volume - self.volume_change_interval
+        )  # Decrease by volume_change_interval, but not below 0
+        self._set_volume(new_volume)
+        self.bus.emit(message.forward("mycroft.volume.set.confirm", {"percent": new_volume}))
+
+    def handle_volume_increase(self, message: Message):
+        """Handle the volume increase request."""
+        current_volume = self._get_volume()
+        new_volume = min(
+            100, current_volume + self.volume_change_interval
+        )  # Increase by volume_change_interval, but not above 100
+        self._set_volume(new_volume)
+        self.bus.emit(message.forward("mycroft.volume.set.confirm", {"percent": new_volume}))
+
+    def handle_volume_mute(self, message: Message):
+        """Handle the volume mute request."""
+        self._set_mute(True)
+        self.bus.emit(message.forward("mycroft.volume.mute.confirm", {"muted": True}))
+
+    def handle_volume_unmute(self, message: Message):
+        """Handle the volume unmute request."""
+        self._set_mute(False)
+        self.bus.emit(message.forward("mycroft.volume.mute.confirm", {"muted": False}))
+
+    def handle_volume_mute_toggle(self, message: Message):
+        """Handle the volume mute toggle request."""
+        current_mute = self._is_muted()
+        self._set_mute(not current_mute)
+        self.bus.emit(message.forward("mycroft.volume.mute.confirm", {"muted": not current_mute}))
+
+    def _get_ntp_server(self):
+        """Private method to get the configured NTP server."""
+        try:
+            result = self._run_command(["systemsetup", "-getnetworktimeserver"])
+            return result.stdout.strip().split(": ")[-1]
+        except Exception as err:
+            self.log.exception("Error getting NTP server: %s", err)
+            return
+
+    def handle_ntp_sync_request(self, message: Message):
+        """Handle the NTP sync request."""
+        try:
+            ntp_server = self._get_ntp_server()
+            self._run_command(["sntp", "-sS", ntp_server])
+            self.bus.emit(message.forward("system.ntp.sync.complete"))
+        except subprocess.CalledProcessError:
+            self.bus.emit(message.forward("system.ntp.sync.failed"))
+
+    def handle_ssh_status(self, message: Message):
+        """Handle the SSH status request."""
+        status = self._run_command(["systemsetup", "-getremotelogin"])
+        is_enabled = "On" in status.stdout
+        self.bus.emit(message.forward("system.ssh.status.response", {"enabled": is_enabled}))
+
+    def handle_ssh_enable_request(self, message: Message):
+        """Handle the SSH enable request."""
+        try:
+            script = """
+            tell application "System Events"
+                activate
+                display dialog "OVOS needs Full Disk Access to enable Remote Login. Please grant permission in System Preferences." buttons {"OK"} default button "OK"
+            end tell
+            """
+            self._run_applescript(script)
+            self._run_command(["systemsetup", "-setremotelogin", "on"])
+            self.bus.emit(message.forward("system.ssh.enabled"))
+        except subprocess.CalledProcessError:
+            self.bus.emit(message.forward("system.ssh.enable.failed"))
+
+    def handle_ssh_disable_request(self, message: Message):
+        """Handle the SSH disable request."""
+        try:
+            script = """
+            tell application "System Events"
+                activate
+                display dialog "OVOS needs Full Disk Access to disable Remote Login. Please grant permission in System Preferences." buttons {"OK"} default button "OK"
+            end tell
+            """
+            self._run_applescript(script)
+            self._run_command(["systemsetup", "-setremotelogin", "off"])
+            self.bus.emit(message.forward("system.ssh.disabled"))
+        except subprocess.CalledProcessError:
+            self.bus.emit(message.forward("system.ssh.disable.failed"))
+
+    def handle_reboot_request(self, message: Message):
+        """Handle the reboot request."""
+        if self.allow_reboot is False:
+            self.bus.emit(message.forward("system.reboot.failed"))
+        try:
+            self._run_command(["shutdown", "-r", "now"])
+        except subprocess.CalledProcessError:
+            self.bus.emit(message.forward("system.reboot.failed"))
+
+    def handle_shutdown_request(self, message: Message):
+        """Handle the shutdown request."""
+        if self.allow_shutdown is False:
+            self.bus.emit(message.forward("system.shutdown.failed"))
+        try:
+            self._run_command(["shutdown", "-h", "now"])
+        except subprocess.CalledProcessError:
+            self.bus.emit(message.forward("system.shutdown.failed"))
+
+    def handle_configure_language_request(self, message: Message):
+        """Handle the configure language request."""
+        lang = message.data.get("lang")
+        if lang:
+            try:
+                self._run_command(["defaults", "write", "NSGlobalDomain", "AppleLanguages", f'("{lang}")'])
+                self.bus.emit(message.forward("system.language.configured", {"lang": lang}))
+            except subprocess.CalledProcessError:
+                self.bus.emit(message.forward("system.language.configure.failed"))
+        else:
+            self.bus.emit(message.forward("system.language.configure.failed", {"error": "Language not specified"}))
+
+    def handle_mycroft_restart_request(self, message: Message):
+        """Handle the Mycroft restart request."""
+        try:
+            self._run_command(["launchctl", "stop", "com.ovos.service"])
+            self._run_command(["launchctl", "start", "com.ovos.service"])
+            self.bus.emit(message.forward("system.mycroft.service.restarted"))
+        except subprocess.CalledProcessError as err:
+            self.log.exception("OVOS service request restart failed", err)
+            self.bus.emit(message.forward("system.mycroft.service.restart.failed"))
+
+
+if __name__ == "__main__":
+    from ovos_utils.fakebus import FakeBus
+
+    plugin = MacOSPlugin(bus=FakeBus())
+    print("BREAK")

ovos_phal_plugin_mac-0.1.0/phal_plugin_mac/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"  # This gets updated automatically by release-please

ovos_phal_plugin_mac-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ovos-phal-plugin-mac"
+readme = "README.md"
+authors = [{ name = "Mike Gray", email = "mike@oscillatelabs.net" }]
+license = { text = "Apache-2.0" }
+keywords = ["ovos", "plugin", "voice", "assistant"]
+requires-python = ">=3.9"
+dynamic = ["version", "dependencies", "optional-dependencies", "description"]
+
+[project.urls]
+Homepage = "https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac"
+Repository = "https://github.com/OscillateLabsLLC/ovos-phal-plugin-mac"
+
+[tool.setuptools]
+package-dir = { "ovos_phal_plugin_mac" = "phal_plugin_mac" }
+packages = ["ovos_phal_plugin_mac"]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+dependencies = { file = ["requirements/requirements.txt"] }
+optional-dependencies = { test = { file = [
+    "requirements/requirements-dev.txt",
+] } }
+description = { file = "README.md" }
+version = { attr = "phal_plugin_mac.version.__version__" }
+
+[tool.setuptools.package-data]
+ovos_phal_plugin_mac = [
+    "*.json",
+    "locale/*",
+    "intents/*",
+    "dialog/*",
+    "vocab/*",
+    "regex/*",
+    "ui/*",
+    "requirements/*",
+]
+
+[project.entry-points."ovos.plugin.phal"]
+ovos-phal-plugin-mac = "ovos_phal_plugin_mac:MacOSPlugin"
+
+[tool.uv]
+package = true

ovos_phal_plugin_mac-0.1.0/requirements/requirements-dev.txt

@@ -0,0 +1,2 @@
+pytest
+pytest-cov

ovos_phal_plugin_mac-0.1.0/requirements/requirements.txt

@@ -0,0 +1,5 @@
+ovos-utils
+ovos-bus-client
+ovos-workshop
+ovos-plugin-manager
+osascript==2020.12.3

ovos_phal_plugin_mac-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ovos_phal_plugin_mac-0.1.0/test/test_plugin.py

@@ -0,0 +1,330 @@
+# pylint: disable=missing-docstring,redefined-outer-name,protected-access,unnecessary-lambda
+import subprocess
+from unittest.mock import MagicMock, patch
+
+import pytest
+from ovos_bus_client import Message
+from ovos_plugin_manager.phal import find_phal_plugins
+from ovos_utils.fakebus import FakeBus
+
+from phal_plugin_mac import MacOSPlugin
+
+
+@pytest.fixture
+def bus():
+    return FakeBus()
+
+
+@pytest.fixture
+def plugin(bus):
+    config = {"allow_reboot": True, "allow_shutdown": True, "volume_change_interval": 10}
+    return MacOSPlugin(bus=bus, config=config)
+
+
+@pytest.fixture
+def message():
+    return Message("test.message")
+
+
+def test_find_phal_plugins():
+    plugins = find_phal_plugins()
+    assert "ovos-phal-plugin-mac" in plugins
+
+
+def test_init(plugin):
+    assert plugin.allow_reboot is True
+    assert plugin.allow_shutdown is True
+    assert plugin.volume_change_interval == 10
+
+
+def test_run_command_error(plugin):
+    cmd_results = plugin._run_command(["rm", "-r", "/ae5ih7srjo8g4ege5"])
+    assert not isinstance(cmd_results, subprocess.CompletedProcess)
+    assert cmd_results is None
+
+
+@patch("subprocess.run")
+def test_get_ntp_server(mock_run, plugin):
+    mock_run.return_value = MagicMock(stdout="Network Time Server: test.ntp.org\n")
+    assert plugin._get_ntp_server() == "test.ntp.org"
+
+
+@patch("subprocess.run")
+def test_get_ntp_server_error(mock_run, plugin):
+    mock_run.side_effect = subprocess.CalledProcessError(1, "test")
+    assert plugin._get_ntp_server() is None
+
+
+@patch("phal_plugin_mac.MacOSPlugin._run_applescript")
+def test_handle_ssh_enable_request(mock_run_applescript, plugin, message, bus):
+    received_messages = []
+    bus.on("system.ssh.enabled", lambda m: received_messages.append(m))
+
+    plugin.handle_ssh_enable_request(message)
+
+    mock_run_applescript.assert_called()
+    assert len(received_messages) == 1
+
+
+@patch("phal_plugin_mac.MacOSPlugin._run_applescript")
+def test_handle_ssh_disable_request(mock_run_applescript, plugin, message, bus):
+    received_messages = []
+    bus.on("system.ssh.disabled", lambda m: received_messages.append(m))
+
+    plugin.handle_ssh_disable_request(message)
+
+    mock_run_applescript.assert_called()
+    assert len(received_messages) == 1
+
+
+def test_handle_reboot_request_not_allowed(plugin, message, bus):
+    plugin.config["allow_reboot"] = False
+    received_messages = []
+    bus.on("system.reboot.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_reboot_request(message)
+
+    assert len(received_messages) == 1
+
+
+def test_handle_shutdown_request_not_allowed(plugin, message, bus):
+    plugin.config["allow_shutdown"] = False
+    received_messages = []
+    bus.on("system.shutdown.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_shutdown_request(message)
+
+    assert len(received_messages) == 1
+
+
+@patch.object(MacOSPlugin, "_run_command")
+def test_handle_configure_language_request_error(mock_run_command, plugin, message, bus):
+    mock_run_command.side_effect = subprocess.CalledProcessError(1, "language config failure")
+    received_messages = []
+    bus.on("system.language.configure.failed", lambda m: received_messages.append(m))
+
+    message.data["lang"] = "en-US"
+    plugin.handle_configure_language_request(message)
+
+    assert len(received_messages) == 1
+    # Optionally, check the content of the received message
+    # assert received_messages[0].data == {"error": "Command execution failed"}
+
+
+@patch.object(MacOSPlugin, "_run_command")
+def test_handle_mycroft_restart_request_error(mock_run_command, plugin, message, bus):
+    mock_run_command.side_effect = subprocess.CalledProcessError(1, "mycroft restart request error")
+    received_messages = []
+    bus.on("system.mycroft.service.restart.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_mycroft_restart_request(message)
+    assert len(received_messages) == 1
+
+
+@patch.object(MacOSPlugin, "_run_command")
+def test_handle_ntp_sync_request_error(mock_run_command, plugin, message, bus):
+    mock_run_command.side_effect = subprocess.CalledProcessError(1, "ntp sync request error")
+    received_messages = []
+    bus.on("system.ntp.sync.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_ntp_sync_request(message)
+
+    assert len(received_messages) == 1
+
+
+@patch.object(MacOSPlugin, "_run_command")
+def test_handle_ssh_enable_request_error(mock_run_command, plugin, message, bus):
+    mock_run_command.side_effect = subprocess.CalledProcessError(1, "ssh enable request error")
+    received_messages = []
+    bus.on("system.ssh.enable.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_ssh_enable_request(message)
+
+    assert len(received_messages) == 1
+
+
+@patch.object(MacOSPlugin, "_run_command")
+def test_handle_ssh_disable_request_error(mock_run_command, plugin, message, bus):
+    mock_run_command.side_effect = subprocess.CalledProcessError(1, "ssh disable request error")
+    received_messages = []
+    bus.on("system.ssh.disable.failed", lambda m: received_messages.append(m))
+
+    plugin.handle_ssh_disable_request(message)
+
+    assert len(received_messages) == 1
+
+
+@patch("subprocess.run")
+def test_run_command(mock_run, plugin):
+    mock_run.return_value = MagicMock(stdout="test output")
+    result = plugin._run_command(["test", "command"])
+    mock_run.assert_called_once_with(["test", "command"], check=True, capture_output=True, text=True)
+    assert result.stdout == "test output"
+
+
+@patch("phal_plugin_mac.MacOSPlugin._run_applescript")
+def test_get_volume(mock_run_applescript, plugin):
+    mock_run_applescript.return_value = 50
+    volume = plugin._get_volume()
+    mock_run_applescript.assert_called_once_with("output volume of (get volume settings)")
+    assert volume == 50
+
+
+@patch("phal_plugin_mac.MacOSPlugin._run_applescript")
+def test_set_volume(mock_run_applescript, plugin):
+    plugin._set_volume(75)
+    mock_run_applescript.assert_called_once_with("set volume output volume 75")
+
+
+@patch("phal_plugin_mac.MacOSPlugin._run_applescript")
+def test_is_muted(mock_run_applescript, plugin):
+    mock_run_applescript.return_value = "true"
+    assert plugin._is_muted() is True
+    mock_run_applescript.assert_called_once_with("output muted of (get volume settings)")
+
+
+@patch("phal_plugin_mac.MacOSPlugin._set_volume")
+def test_handle_volume_set(mock_set_volume, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.set.confirm", lambda m: received_messages.append(m))
+
+    message.data["percent"] = 60
+    plugin.handle_volume_set(message)
+
+    mock_set_volume.assert_called_once_with(60)
+    assert len(received_messages) == 1
+    assert received_messages[0].data["percent"] == 60
+
+
+@patch("phal_plugin_mac.MacOSPlugin._get_volume")
+@patch("phal_plugin_mac.MacOSPlugin._set_volume")
+def test_handle_volume_decrease(mock_set_volume, mock_get_volume, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.set.confirm", lambda m: received_messages.append(m))
+
+    mock_get_volume.return_value = 50
+    plugin.handle_volume_decrease(message)
+
+    mock_set_volume.assert_called_once_with(40)
+    assert len(received_messages) == 1
+    assert received_messages[0].data["percent"] == 40
+
+
+@patch("phal_plugin_mac.MacOSPlugin._get_volume")
+@patch("phal_plugin_mac.MacOSPlugin._set_volume")
+def test_handle_volume_increase(mock_set_volume, mock_get_volume, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.set.confirm", lambda m: received_messages.append(m))
+
+    mock_get_volume.return_value = 50
+    plugin.handle_volume_increase(message)
+
+    mock_set_volume.assert_called_once_with(60)
+    assert len(received_messages) == 1
+    assert received_messages[0].data["percent"] == 60
+
+
+@patch("phal_plugin_mac.MacOSPlugin._set_mute")
+def test_handle_volume_mute(mock_set_mute, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.mute.confirm", lambda m: received_messages.append(m))
+
+    plugin.handle_volume_mute(message)
+
+    mock_set_mute.assert_called_once_with(True)
+    assert len(received_messages) == 1
+    assert received_messages[0].data["muted"] is True
+
+
+@patch("phal_plugin_mac.MacOSPlugin._set_mute")
+def test_handle_volume_unmute(mock_set_mute, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.mute.confirm", lambda m: received_messages.append(m))
+
+    plugin.handle_volume_unmute(message)
+
+    mock_set_mute.assert_called_once_with(False)
+    assert len(received_messages) == 1
+    assert not received_messages[0].data["muted"]
+
+
+@patch("phal_plugin_mac.MacOSPlugin._is_muted")
+@patch("phal_plugin_mac.MacOSPlugin._set_mute")
+def test_handle_volume_mute_toggle(mock_set_mute, mock_is_muted, plugin, message, bus):
+    received_messages = []
+    bus.on("mycroft.volume.mute.confirm", lambda m: received_messages.append(m))
+
+    mock_is_muted.return_value = True
+    plugin.handle_volume_mute_toggle(message)
+
+    mock_set_mute.assert_called_once_with(False)
+    assert len(received_messages) == 1
+    assert not received_messages[0].data["muted"]
+
+
+@patch("subprocess.run")
+def test_handle_ntp_sync_request(mock_run, plugin, message, bus):
+    received_messages = []
+    bus.on("system.ntp.sync.complete", lambda m: received_messages.append(m))
+
+    mock_run.return_value = MagicMock(stdout="Network Time Server: time.apple.com\n")
+    plugin.handle_ntp_sync_request(message)
+
+    mock_run.assert_any_call(["systemsetup", "-getnetworktimeserver"], check=True, capture_output=True, text=True)
+    mock_run.assert_any_call(["sntp", "-sS", "time.apple.com"], check=True, capture_output=True, text=True)
+    assert len(received_messages) == 1
+
+
+@patch("subprocess.run")
+def test_handle_ssh_status(mock_run, plugin, message, bus):
+    received_messages = []
+    bus.on("system.ssh.status.response", lambda m: received_messages.append(m))
+
+    mock_run.return_value = MagicMock(stdout="Remote Login: On\n")
+    plugin.handle_ssh_status(message)
+
+    mock_run.assert_called_once_with(["systemsetup", "-getremotelogin"], check=True, capture_output=True, text=True)
+    assert len(received_messages) == 1
+    assert received_messages[0].data["enabled"] is True
+
+
+@patch("subprocess.run")
+def test_handle_reboot_request(mock_run, plugin, message):
+    plugin.handle_reboot_request(message)
+    mock_run.assert_called_once_with(["shutdown", "-r", "now"], check=True, capture_output=True, text=True)
+
+
+@patch("subprocess.run")
+def test_handle_shutdown_request(mock_run, plugin, message):
+    plugin.handle_shutdown_request(message)
+    mock_run.assert_called_once_with(["shutdown", "-h", "now"], check=True, capture_output=True, text=True)
+
+
+@patch("subprocess.run")
+def test_handle_configure_language_request(mock_run, plugin, message, bus):
+    received_messages = []
+    bus.on("system.language.configured", lambda m: received_messages.append(m))
+
+    message.data["lang"] = "en-US"
+    plugin.handle_configure_language_request(message)
+
+    mock_run.assert_called_once_with(
+        ["defaults", "write", "NSGlobalDomain", "AppleLanguages", '("en-US")'],
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+    assert len(received_messages) == 1
+    assert received_messages[0].data["lang"] == "en-US"
+
+
+@patch("subprocess.run")
+def test_handle_mycroft_restart_request(mock_run, plugin, message, bus):
+    received_messages = []
+    bus.on("system.mycroft.service.restarted", lambda m: received_messages.append(m))
+
+    plugin.handle_mycroft_restart_request(message)
+
+    mock_run.assert_any_call(["launchctl", "stop", "com.ovos.service"], check=True, capture_output=True, text=True)
+    mock_run.assert_any_call(["launchctl", "start", "com.ovos.service"], check=True, capture_output=True, text=True)
+    assert len(received_messages) == 1