William
/
Reticulum
mirror of https://github.com/markqvist/Reticulum.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated interface documentation

This commit is contained in:
Mark Qvist 2022-04-16 16:43:41 +02:00
parent 39f1258d0e
commit ed20b27e9d
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/interfaces.rst
View File

@ -519,20 +519,21 @@ beaconing functionality described above.
Common Interface Options Common Interface Options
======================== ========================
A number of general options can be used to control various A number of general options are available on most interfaces.
aspects of interface behaviour. 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 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``. must be set to ``True`` or ``Yes``.
The ``outgoing`` option sets whether an interface is allowed The ``outgoing`` option sets whether an interface is allowed
to transmit. Defaults to ``True``. If set to ``False`` the to transmit. Defaults to ``True``. If set to ``False`` or ``No``
interface will only receive data, and never transmit. the interface will only receive data, and never transmit.
The ``interface_mode`` option allows selecting the high-level The ``mode`` option allows selecting the high-level behaviour
behaviour of the interface from a number of options. of the interface from a number of options.
- The default value is ``full``. In this mode, all discovery, - The default value is ``full``. In this mode, all discovery,
meshing and transport functionality is available. meshing and transport functionality is available.