ovos-PHAL-plugin-system


Nameovos-PHAL-plugin-system JSON
Version 1.2.0 PyPI version JSON
download
home_pagehttps://github.com/OpenVoiceOS/ovos-PHAL-plugin-system
SummaryA plugin for OpenVoiceOS hardware abstraction layer
upload_time2024-12-03 22:13:07
maintainerNone
docs_urlNone
authorJarbasAi
requires_pythonNone
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements ovos-plugin-manager ovos-utils ovos_config ovos-bus-client
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ovos-PHAL-plugin - system

Provides system specific commands to OVOS.
The dbus interface for this plugin is not yet established.

# Install

`pip install ovos-PHAL-plugin-system`

# Config

This plugin is a Admin plugin, it needs to run as root and to be explicitly enabled in mycroft.conf

```javascript
{
"PHAL": {
    "admin": {
        "ovos-PHAL-plugin-system": {"enabled": true}
    }
}
}
```
if not enabled (omit config above) it will be run as the regular user, you need to ensure [polkit policy](#) is set to allow usage of systemctl without sudo.  Not yet implemented


handle bus events to interact with the OS

```python
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.factory.reset", self.handle_factory_reset_request)
self.bus.on("system.factory.reset.register", self.handle_reset_register)
self.bus.on("system.configure.language", self.handle_configure_language_request)
self.bus.on("system.mycroft.service.restart", self.handle_mycroft_restart_request)
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/OpenVoiceOS/ovos-PHAL-plugin-system",
    "name": "ovos-PHAL-plugin-system",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "JarbasAi",
    "author_email": "jarbasai@mailfence.com",
    "download_url": "https://files.pythonhosted.org/packages/c1/4a/6178f870a4c6e3973f9947286c4000c7821dee0bd7d6caf3516ae72288e1/ovos-PHAL-plugin-system-1.2.0.tar.gz",
    "platform": null,
    "description": "# ovos-PHAL-plugin - system\n\nProvides system specific commands to OVOS.\nThe dbus interface for this plugin is not yet established.\n\n# Install\n\n`pip install ovos-PHAL-plugin-system`\n\n# Config\n\nThis plugin is a Admin plugin, it needs to run as root and to be explicitly enabled in mycroft.conf\n\n```javascript\n{\n\"PHAL\": {\n    \"admin\": {\n        \"ovos-PHAL-plugin-system\": {\"enabled\": true}\n    }\n}\n}\n```\nif not enabled (omit config above) it will be run as the regular user, you need to ensure [polkit policy](#) is set to allow usage of systemctl without sudo.  Not yet implemented\n\n\nhandle bus events to interact with the OS\n\n```python\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.factory.reset\", self.handle_factory_reset_request)\nself.bus.on(\"system.factory.reset.register\", self.handle_reset_register)\nself.bus.on(\"system.configure.language\", self.handle_configure_language_request)\nself.bus.on(\"system.mycroft.service.restart\", self.handle_mycroft_restart_request)\n```\n\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A plugin for OpenVoiceOS hardware abstraction layer",
    "version": "1.2.0",
    "project_urls": {
        "Homepage": "https://github.com/OpenVoiceOS/ovos-PHAL-plugin-system"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "abd0fae3d1671d84fd5d858f88873926964564016c5e60b39c6ff169355eef62",
                "md5": "fbeff7b7f61d3819e563cd26ce67e3eb",
                "sha256": "7be1b1e180f0f02a51e8d56b86ba564d93fff07052b3c635ca3cc99dffe9e2b9"
            },
            "downloads": -1,
            "filename": "ovos_PHAL_plugin_system-1.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fbeff7b7f61d3819e563cd26ce67e3eb",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 17675,
            "upload_time": "2024-12-03T22:13:05",
            "upload_time_iso_8601": "2024-12-03T22:13:05.488553Z",
            "url": "https://files.pythonhosted.org/packages/ab/d0/fae3d1671d84fd5d858f88873926964564016c5e60b39c6ff169355eef62/ovos_PHAL_plugin_system-1.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c14a6178f870a4c6e3973f9947286c4000c7821dee0bd7d6caf3516ae72288e1",
                "md5": "e18de6f1f2f713346c80cef9904be2dd",
                "sha256": "21b3f5646700d8eb7a00094751de45809bb515ff1760ec87064baa3016eaf5eb"
            },
            "downloads": -1,
            "filename": "ovos-PHAL-plugin-system-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e18de6f1f2f713346c80cef9904be2dd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14328,
            "upload_time": "2024-12-03T22:13:07",
            "upload_time_iso_8601": "2024-12-03T22:13:07.049520Z",
            "url": "https://files.pythonhosted.org/packages/c1/4a/6178f870a4c6e3973f9947286c4000c7821dee0bd7d6caf3516ae72288e1/ovos-PHAL-plugin-system-1.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-03 22:13:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "OpenVoiceOS",
    "github_project": "ovos-PHAL-plugin-system",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "ovos-plugin-manager",
            "specs": [
                [
                    ">=",
                    "0.0.26"
                ],
                [
                    "<",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "ovos-utils",
            "specs": [
                [
                    ">=",
                    "0.1.0"
                ],
                [
                    "<",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "ovos_config",
            "specs": [
                [
                    "<",
                    "1.0.0"
                ],
                [
                    ">=",
                    "0.0.5"
                ]
            ]
        },
        {
            "name": "ovos-bus-client",
            "specs": [
                [
                    ">=",
                    "0.0.8"
                ],
                [
                    "<",
                    "2.0.0"
                ]
            ]
        }
    ],
    "lcname": "ovos-phal-plugin-system"
}
        
Elapsed time: 1.00682s