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.

Related projects

License

Apache-2.0

Metadata

Release files for ovos-PHAL 0.3.1a1

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.1a1
File Size Uploaded
ovos_phal-0.3.1a1.tar.gz 9.9 kB Details

Built distribution (wheel)

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

Total release size: 21.0 kB

Release files / ovos_phal-0.3.1a1.tar.gz

Download URL ovos_phal-0.3.1a1.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
cdb3ea3c95ede20f3e11318048d5ca6a9cc3273fefdd97dc646870e32d2e9571
BLAKE2b-256 checksum
How to use checksums
07f8081e9c67bf6346e9902496d1e2f4a11d8a2dcc207b1981d1dc2412ef3544
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

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

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

Release history Release notifications | RSS feed

This release

0.3.1a1 This release

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

2 release files

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