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

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

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.2.0
File	Size	Uploaded
ovos-PHAL-plugin-network-manager-1.2.0.tar.gz	9.1 kB	Sep 11, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for ovos-PHAL-plugin-network-manager 1.2.0
File	Interpreter	ABI	Platform	Reset
ovos_PHAL_plugin_network_manager-1.2.0-py3-none-any.whl 9.6 kB Sep 11, 2024	Python 3	none	any	Details

Total release size: 18.8 kB

Release files / ovos-PHAL-plugin-network-manager-1.2.0.tar.gz

Download URL	ovos-PHAL-plugin-network-manager-1.2.0.tar.gz
Size	9.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`16a206229c4ee76d009dc87ab3120d15d69d9c726801d76439220e5b8f155894`
BLAKE2b-256 checksum How to use checksums	`0d2db3ffc377debaf70a3560c15d042522a1d091be899930b172beb119d5a043`
Upload date	Sep 11, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.9.20`

Release files / ovos_PHAL_plugin_network_manager-1.2.0-py3-none-any.whl

Download URL	ovos_PHAL_plugin_network_manager-1.2.0-py3-none-any.whl
Size	9.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6c9640080d3308191cfd9e13db4513173ed8cbe451b7baab207049f676daa9a2`
BLAKE2b-256 checksum How to use checksums	`da806c6243b8d464deb36d9bc6f779da827f88d3cb72d859fa18c6d923887e88`
Upload date	Sep 11, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.1 CPython/3.9.20`