PHAL plugin - Network Manager

Provides the network manager interface for NetworkManager based plugins. This plugin utilizes nmcli for all communications with network manager. The dbus interface for this plugin is a work in progress. #15

Requires

This plugin has the following requirements:

nmcli

Install

pip install ovos-PHAL-plugin-network-manager

Config

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

{
"PHAL": {
    "admin": {
        "ovos-PHAL-plugin-network-manager": {"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 nmcli without sudo

Event Details:

Scanning

This plugin provides scanning operations for Network Manager to scan for available nearby networks, the following event can be used to initialize the scan.

# Scanning: 
# ovos.phal.nm.scan
# - type: Request
# - description: Allows client to request for a network scan
#
# ovos.phal.nm.scan.complete
# - type: Response
# - description: Emited when the requested scan is completed
# with a network list

Connecting

This plugin provides handling of connection operations for Network Manager, the following events can be used to connect a network, disconnect a network using the network manager interface.

# Connecting:
# ovos.phal.nm.connect
# - type: Request
# - description: Allows clients to connect to a given network
#
# ovos.phal.nm.connection.successful
# - type: Response
# - description: Emitted when a connection is successfully established
#
# ovos.phal.nm.connection.failure
# - type: Response
# - description: Emitted when a connection fails to establish
#
# Disconnecting:
# ovos.phal.nm.disconnect
# - type: Request
# - description: Allows clients to disconnect from a network
#
# ovos.phal.nm.disconnection.successful
# - type: Response
# - description: Emitted when a connection successfully disconnects
#
# ovos.phal.nm.disconnection.failure
# - type: Response
# - description: Emitted when a connection fails to disconnect

Forget Networks

The plugin also provides a interface to forget already connected networks, The following events can be used to forget a network

# Forgetting:
# ovos.phal.nm.forget
# - type: Request
# - description: Allows a client to forget a network
#
# ovos.phal.nm.forget.successful
# - type: Response
# - description: Emitted when a connection successfully is forgetten
#
# ovos.phal.nm.forget.failure
# - type: Response
# - description: Emitted when a connection fails to forget

Metadata

Release files for ovos-PHAL-plugin-network-manager 1.3.5

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-plugin-network-manager 1.3.5
File	Size	Uploaded
ovos_phal_plugin_network_manager-1.3.5.tar.gz	9.4 kB	Mar 1, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-PHAL-plugin-network-manager 1.3.5
File	Interpreter	ABI	Platform	Reset
ovos_phal_plugin_network_manager-1.3.5-py3-none-any.whl 10.1 kB Mar 1, 2026	Python 3	none	any	Details

Total release size: 19.5 kB

Release files / ovos_phal_plugin_network_manager-1.3.5.tar.gz

Download URL	ovos_phal_plugin_network_manager-1.3.5.tar.gz
Size	9.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`ffa210a065d4899c9af77c3512eb753698b6235fc7ab45e17ec03252c85247c3`
BLAKE2b-256 checksum How to use checksums	`d9234a73229ebdbbc14a089caa34996b0bb95e92fd63298e8382d4e94ce1fd8b`
Upload date	Mar 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.9.25`

Release files / ovos_phal_plugin_network_manager-1.3.5-py3-none-any.whl

Download URL	ovos_phal_plugin_network_manager-1.3.5-py3-none-any.whl
Size	10.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`31d4a7763261856a0db36faa69fa7bcfde5cbd26dcab436a50533b18a6a04953`
BLAKE2b-256 checksum How to use checksums	`6c6e74530d91fc75afe763f8177e0fddcd22f080184a4d6c86492a1394f7f221`
Upload date	Mar 1, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.9.25`