mirror of
https://github.com/markqvist/Reticulum.git
synced 2026-06-11 07:23:29 -07:00
Updated documentation
This commit is contained in:
@@ -522,6 +522,31 @@ directly over a wire-pair, or for using devices such as data radios and lasers.
|
||||
parity = none
|
||||
stopbits = 1
|
||||
|
||||
.. _interfaces-pipe:
|
||||
|
||||
Pipe Interface
|
||||
==============
|
||||
|
||||
Using this interface, reticulum can use any program as an interface via `stdin` and
|
||||
`stdout`. This can be used to easily create virtual interfaces, or to interface with
|
||||
custom hardware or other systems.
|
||||
|
||||
.. code::
|
||||
|
||||
[[Pipe Interface]]
|
||||
type = PipeInterface
|
||||
interface_enabled = True
|
||||
|
||||
# External command to execute
|
||||
command = netcat -l 5757
|
||||
|
||||
# Optional respawn delay, in seconds
|
||||
respawn_delay = 5
|
||||
|
||||
Reticulum will write all packets to `stdin` of the ``command`` option, and will
|
||||
continously read and scan its `stdout` for Reticulum packets. If ``EOF`` is reached,
|
||||
Reticulum will try to respawn the program after waiting for ``respawn_interval`` seconds.
|
||||
|
||||
.. _interfaces-kiss:
|
||||
|
||||
KISS Interface
|
||||
|
||||
@@ -122,6 +122,14 @@ Reticulum implements a range of generalised interface types that covers the comm
|
||||
|
||||
* UDP over IP networks
|
||||
|
||||
* Anything you can connect via stdio
|
||||
|
||||
* Reticulum can use external programs and pipes as interfaces
|
||||
|
||||
* This can be used to easily hack in virtual interfaces
|
||||
|
||||
* Or to quickly create interfaces with custom hardware
|
||||
|
||||
For a full list and more details, see the :ref:`Supported Interfaces<interfaces-main>` chapter.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user