Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

ovos-PHAL

ovos-PHAL is the Plugin-based Hardware Abstraction Layer for OpenVoiceOS. It runs as a service that loads PHAL plugins based on the environment, either from known configuration or from device fingerprinting. Each plugin connects a specific piece of hardware or a specific system feature to the OVOS messagebus.

A PHAL plugin can provide a hardware integration, such as a respeaker, mk1, or mk2 device. It can also provide a system integration, such as a network manager or the OVOS shell.

Install

pip install ovos_PHAL

Extra plugin sets install with the package:

pip install ovos_PHAL[linux]   # alsa, system, network-manager, wallpaper-manager
pip install ovos_PHAL[mac]     # ovos-phal-plugin-mac
pip install ovos_PHAL[mk1]     # ovos-PHAL-plugin-mk1
pip install ovos_PHAL[mk2]     # ovos-PHAL-plugin-hotkeys
pip install ovos_PHAL[mk2dev]  # ovos-PHAL-plugin-mk2-fan-control
pip install ovos_PHAL[extras]  # ipgeo, connectivity-events, oauth

Usage

Start the PHAL service from the command line:

ovos_PHAL

This reads the PHAL section of mycroft.conf and starts the plugins listed there:

{
  "PHAL": {
    "ovos-PHAL-plugin-display-manager-ipc": {"enabled": true},
    "ovos-PHAL-plugin-mk1": {"enabled": true}
  }
}

To run PHAL from Python, use ovos_PHAL.service.PHAL:

from ovos_PHAL.service import PHAL
from ovos_utils import wait_for_exit_signal

phal = PHAL()
phal.start()
wait_for_exit_signal()
phal.shutdown()

An admin variant that loads root-only plugins runs with the ovos_PHAL_admin command.

License

Apache-2.0

Metadata

Release files for ovos-PHAL 0.3.2a1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ovos-PHAL 0.3.2a1
File Size Uploaded Provenance
ovos_phal-0.3.2a1.tar.gz 9.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-PHAL 0.3.2a1
File Interpreter ABI Platform
ovos_phal-0.3.2a1-py3-none-any.whl Python 3 none any Details

Total release size: 21.0 kB

Release files / ovos_phal-0.3.2a1.tar.gz

Download URL ovos_phal-0.3.2a1.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
46742b7b627df45d39add9791ddc98052a98805f3fae6509c3d7dc9b2508f5b1
BLAKE2b-256 checksum
How to use checksums
4a105458f27eb7f104080f26e2b3fe2c6264b64c46ad768426d80318b9b0eeb8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ovos_phal-0.3.2a1-py3-none-any.whl

Download URL ovos_phal-0.3.2a1-py3-none-any.whl
Size 11.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
172aff20bdd8e152ac16a67f26dd05f98b1b2fa804638b99adfe88db44486d19
BLAKE2b-256 checksum
How to use checksums
b40777ed68f2f933d10a95b97bb7dd910ffb2eb00f6c00033a51dae110968d71
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for ovos-PHAL 0.3.2a1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page