Mirror/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2026-04-28 00:29:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

Updated documentation

Browse Source
This commit is contained in:
Mark Qvist
2022-04-17 20:12:23 +02:00
parent 124ec006b4
commit bac33d4e8b
6 changed files with 40 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/manual/_sources/interfaces.rst.txt
View File

@@ -519,23 +519,24 @@ beaconing functionality described above.
Common Interface Options
========================
A number of general options can be used to control various
aspects of interface behaviour.
A number of general options are available on most interfaces.
These can be used to control various aspects of interface behaviour.
The ``interface_enabled`` option tells Reticulum whether or not
The ``enabled`` option tells Reticulum whether or not
to bring up the interface. Defaults to ``False``. For any
interface to be brought up, the ``interface_enabled`` option
interface to be brought up, the ``enabled`` option
must be set to ``True`` or ``Yes``.
The ``outgoing`` option sets whether an interface is allowed
to transmit. Defaults to ``True``. If set to ``False`` the
interface will only receive data, and never transmit.
to transmit. Defaults to ``True``. If set to ``False`` or ``No``
the interface will only receive data, and never transmit.
The ``interface_mode`` option allows selecting the high-level
behaviour of the interface from a number of options.
The ``mode`` option allows selecting the high-level behaviour
of the interface from a number of options.
- The default value is ``full``. In this mode, all discovery,
meshing and transpor functionality is available.
meshing and transport functionality is available.
- In the ``access_point`` (or shorthand ``ap``) mode, the
interface will operate as a network access point. In this