*Note*: This plugin is [planned to be deprecated](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-gui-network-client/issues/2).
# PHAL plugin - GUI Network Client
GUI Network client is a graphical user frontend to network manager and allows configuring, modifying and deleting networks. This plugin is also utilizes Plasma Network Manager for additional model support.
# Requirements
This plugin requires the following:
- Network Manager PHAL Plugin: https://github.com/OpenVoiceOS/ovos-PHAL-plugin-network-manager
- Plasma Network Manager: https://invent.kde.org/plasma/plasma-nm
# Install
`pip install ovos-PHAL-plugin-gui-network-client`
# Event Details:
##### Plugin Registeration and Activation
The GUI network client registers itself as a networking plugin for the wifi client, The following events are used for managing registeration, deregisteration and activation status of the plugin.
```python
# WIFI Plugin Registeration and Activation Specific Events
self.bus.on("ovos.phal.wifi.plugin.stop.setup.event", self.handle_stop_setup)
self.bus.on("ovos.phal.wifi.plugin.client.registered", self.handle_registered)
self.bus.on("ovos.phal.wifi.plugin.client.deregistered", self.handle_deregistered)
self.bus.on("ovos.phal.wifi.plugin.client.registration.failure", self.handle_registration_failure)
self.bus.on("ovos.phal.wifi.plugin.alive", self.register_client)
```
##### Plugin Network Manager Interaction
The GUI network client utilizes the Network Manager for providing functionality such as activation of connections and deactivation of connections, the Plugin listens for the following events to display a success and failure passed from the network manager to display the status of connection activation and deactivation.
```python
# OVOS PHAL NM EVENTS
self.bus.on("ovos.phal.nm.connection.successful", self.display_success)
self.bus.on("ovos.phal.nm.connection.failure", self.display_failure)
```
##### Plugin GUI Events
The GUI network client utilizes the following button events that are emitted between the QML GUI and the python side of the plugin, they handle information flow and events flow between onscreen events and logicical operations of the plugin.
```python
# INTERNAL GUI EVENTS
self.bus.on("ovos.phal.gui.network.client.back",
self.display_path_exit)
self.bus.on("ovos.phal.gui.display.connected.network.settings",
self.display_connected_network_settings)
self.bus.on("ovos.phal.gui.display.disconnected.network.settings",
self.display_disconnected_network_settings)
self.bus.on("ovos.phal.gui.network.client.internal.back",
self.display_internal_back)
# Also listen for certain events that can forcefully deactivate the client
self.bus.on("system.display.homescreen", self.clean_shutdown)
self.bus.on("mycroft.device.settings", self.clean_shutdown)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/NeonGeckoCom/neon-phal-plugin-gui-network-client",
"name": "neon-phal-plugin-gui-network-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Neongecko",
"author_email": "defelopers@neon.ai",
"download_url": "https://files.pythonhosted.org/packages/68/ae/176c18958c00bb3da5212636f741b935f05c4f8d0dc2861442bceaeec081/neon-phal-plugin-gui-network-client-0.0.5.tar.gz",
"platform": null,
"description": "*Note*: This plugin is [planned to be deprecated](https://github.com/OpenVoiceOS/ovos-PHAL-plugin-gui-network-client/issues/2).\n\n# PHAL plugin - GUI Network Client\n\nGUI Network client is a graphical user frontend to network manager and allows configuring, modifying and deleting networks. This plugin is also utilizes Plasma Network Manager for additional model support.\n\n# Requirements\n\nThis plugin requires the following:\n- Network Manager PHAL Plugin: https://github.com/OpenVoiceOS/ovos-PHAL-plugin-network-manager\n- Plasma Network Manager: https://invent.kde.org/plasma/plasma-nm\n\n# Install\n\n`pip install ovos-PHAL-plugin-gui-network-client`\n\n# Event Details:\n\n##### Plugin Registeration and Activation\n\nThe GUI network client registers itself as a networking plugin for the wifi client, The following events are used for managing registeration, deregisteration and activation status of the plugin.\n\n```python\n # WIFI Plugin Registeration and Activation Specific Events \n self.bus.on(\"ovos.phal.wifi.plugin.stop.setup.event\", self.handle_stop_setup)\n self.bus.on(\"ovos.phal.wifi.plugin.client.registered\", self.handle_registered)\n self.bus.on(\"ovos.phal.wifi.plugin.client.deregistered\", self.handle_deregistered)\n self.bus.on(\"ovos.phal.wifi.plugin.client.registration.failure\", self.handle_registration_failure)\n self.bus.on(\"ovos.phal.wifi.plugin.alive\", self.register_client)\n```\n\n##### Plugin Network Manager Interaction\n\nThe GUI network client utilizes the Network Manager for providing functionality such as activation of connections and deactivation of connections, the Plugin listens for the following events to display a success and failure passed from the network manager to display the status of connection activation and deactivation.\n\n```python\n # OVOS PHAL NM EVENTS\n self.bus.on(\"ovos.phal.nm.connection.successful\", self.display_success)\n self.bus.on(\"ovos.phal.nm.connection.failure\", self.display_failure)\n```\n##### Plugin GUI Events\n\nThe GUI network client utilizes the following button events that are emitted between the QML GUI and the python side of the plugin, they handle information flow and events flow between onscreen events and logicical operations of the plugin.\n\n```python\n # INTERNAL GUI EVENTS\n self.bus.on(\"ovos.phal.gui.network.client.back\",\n self.display_path_exit)\n self.bus.on(\"ovos.phal.gui.display.connected.network.settings\",\n self.display_connected_network_settings)\n self.bus.on(\"ovos.phal.gui.display.disconnected.network.settings\",\n self.display_disconnected_network_settings)\n self.bus.on(\"ovos.phal.gui.network.client.internal.back\",\n self.display_internal_back)\n \n # Also listen for certain events that can forcefully deactivate the client\n self.bus.on(\"system.display.homescreen\", self.clean_shutdown)\n self.bus.on(\"mycroft.device.settings\", self.clean_shutdown)\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A PHAL plugin for Neon/OVOS",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/NeonGeckoCom/neon-phal-plugin-gui-network-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "310be73f7cafd246a90418831eb841a5047e093262233bfb54f71fb9d49014c8",
"md5": "d16303812bb3499c551b85749c13007c",
"sha256": "86e980b6e849ba90abf86077621b6c13fdded04364fc78077c8fcd26ea37d561"
},
"downloads": -1,
"filename": "neon_phal_plugin_gui_network_client-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d16303812bb3499c551b85749c13007c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 115790,
"upload_time": "2024-04-22T18:47:46",
"upload_time_iso_8601": "2024-04-22T18:47:46.448006Z",
"url": "https://files.pythonhosted.org/packages/31/0b/e73f7cafd246a90418831eb841a5047e093262233bfb54f71fb9d49014c8/neon_phal_plugin_gui_network_client-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "68ae176c18958c00bb3da5212636f741b935f05c4f8d0dc2861442bceaeec081",
"md5": "630b1aba28118350a092abcfbe530d34",
"sha256": "9b3171f0181aecc3f6a067410efcba1c1fc851923b8de8fe4a6b7a138ba2331d"
},
"downloads": -1,
"filename": "neon-phal-plugin-gui-network-client-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "630b1aba28118350a092abcfbe530d34",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 96292,
"upload_time": "2024-04-22T18:47:48",
"upload_time_iso_8601": "2024-04-22T18:47:48.664900Z",
"url": "https://files.pythonhosted.org/packages/68/ae/176c18958c00bb3da5212636f741b935f05c4f8d0dc2861442bceaeec081/neon-phal-plugin-gui-network-client-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 18:47:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeonGeckoCom",
"github_project": "neon-phal-plugin-gui-network-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "neon-phal-plugin-gui-network-client"
}
JSON
