Commit ecea824b authored by David Boddie's avatar David Boddie
Browse files

Link the networking guide into other documents

parent 7fd37f8d
......@@ -58,7 +58,7 @@ method, the application can respond when the user clicks the button. The
.. literalinclude:: app/src/main.py
:language: python3
:start-at: def update_label
:end-at: set_text('Other')
:end-at: set_text("Not metered")
In this method we create an instance of the ``Gio.NetworkMonitor`` class and
call its ``get_connectivity`` method to obtain the current network state.
......
......@@ -17,23 +17,39 @@ The use of an Ethernet port, available only on the Librem 5 developer board, is
Wireless (Wi-Fi)
~~~~~~~~~~~~~~~~
When wireless networking is enabled, applications will be able to access it without any further configuration as long as they have requested permission to access the network in general. For applications distributed as flatpaks, this is achieved by specifying the ``--share=network`` permission in the manifest file.
When wireless networking is enabled, applications will be able to access it without any further configuration as long as they have requested permission to access the network in general. For applications distributed as flatpaks, this is achieved by specifying the ``--share=network`` permission in the manifest file. See the :ref:`flatpak_app_permissions_guide` guide for details.
.. Link to permissions guide.
Lower level information about configuring wireless networking is given in the :ref:`imx8_devkit_wifi` section of the :ref:`imx8_devkit` documentation.
USB
~~~
.. note:: It is expected that USB networking will be configured by a system component that exposes a general networking interface to applications. This section will be revised and updated with more details later.
Bluetooth
~~~~~~~~~
Lower level information about configuring USB networking is given in the :ref:`devkit_howto_ethernet_usb` section of the :ref:`imx8_devkit` documentation.
.. Bluetooth
.. Cellular
Common Tasks
------------
There are a number of common tasks that network-aware applications may need to perform.
Checking Network State
~~~~~~~~~~~~~~~~~~~~~~
Cellular
~~~~~~~~
Since the network interfaces are managed by a common framework, it is possible to obtain information about network availability and any limitations on network usage.
The :ref:`examples_Network_State` example shows how to access these kinds of information, showing the level of access to the network, availability of the network, and whether the connection is metered.
.. image:: /Apps/Examples/Networking/NetworkState/images/screenshot.png
:scale: 50%
:align: center
:alt: A screenshot of the Network State application running in the phone environment
This information is obtained using methods of the `Gio.NetworkMonitor`_ class.
Although the application may request full network access, the system may limit the connectivity in some way depending on the user's preferences.
.. include:: /links.txt
......@@ -17,6 +17,10 @@
.. _`Freedesktop quick reference`: http://docs.flatpak.org/en/latest/freedesktop-quick-reference.html
.. _`GdkPixbuf.Pixbuf`: https://lazka.github.io/pgi-docs/#GdkPixbuf-2.0/classes/Pixbuf.html
.. _`Gio.GApplication documentation`: https://developer.gnome.org/gio/stable/GApplication.html#g-application-id-is-valid
.. _`Gio.Menu`: https://lazka.github.io/pgi-docs/#Gio-2.0/classes/Menu.html
.. _`Git revision control system`: https://git-scm.com/
.. _`Gio.NetworkConnectivity`: https://lazka.github.io/pgi-docs/Gio-2.0/enums.html#Gio.NetworkConnectivity
.. _`Gio.NetworkMonitor`: https://lazka.github.io/pgi-docs/#Gio-2.0/classes/NetworkMonitor.html
.. _`git-buildpackage`: http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html
.. _`GKeyFile`: https://developer.gnome.org/glib/stable/glib-Key-value-file-parser.html
.. _`Glade`: https://glade.gnome.org/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment