Network Manager plugin for OpenVoiceOS hardware abstraction layer
Project description
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for ovos-PHAL-plugin-network-manager-1.1.1a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ff21f08ede976b660a7415748f9199a64ff50ffae0671d9fa141525f5c6cf77 |
|
MD5 | 567be86efecc4a6b5e9ecfa8bc6034ee |
|
BLAKE2b-256 | 9879242fc54ef0b7ff8d5e02ee6b7484b1e680f19756709d4c66a1f65a7497c1 |
Hashes for ovos_PHAL_plugin_network_manager-1.1.1a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77d0cd79af72b623d93c88c78044bab9941a1176b6b3abf79496f0bd9930ec9e |
|
MD5 | 1f93f1665e3cf14016476e63c0932a86 |
|
BLAKE2b-256 | db1c11d4ea1483ec420ac0f08cd9434bac38697bbb9db8bb3d07d29781bdd290 |