Added custom interfaces to documentation and readme

README.md

@@ -53,7 +53,10 @@ For more info, see [reticulum.network](https://reticulum.network/) and [the FAQ
   - HMAC using SHA256 for authentication
   - IVs are generated through os.urandom()
 - Unforgeable packet delivery confirmations
-- A large variety of supported interface types
+- Flexible and extensible interface system
+  - Includes a large variety of built-in interface types
+  - Ability to load and utilise custom user- or community-supplied interface types
+  - Easily create your own custom interfaces for communicating over anything
 - An intuitive and easy-to-use API
 - Reliable and efficient transfer of arbitrary amounts of data
   - Reticulum can handle a few bytes of data or files of many gigabytes

docs/manual/_sources/examples.rst.txt

@@ -125,4 +125,18 @@ interface to efficiently pass files of any size over a Reticulum :ref:`Link<api-
 
 .. literalinclude:: ../../Examples/Filetransfer.py
 
-This example can also be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py>`_.
+This example can also be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py>`_.
+
+.. _example-custominterface:
+
+Custom Interfaces
+=================
+
+The *ExampleInterface* demonstrates creating custom interfaces for Reticulum.
+Any number of custom interfaces can be loaded and utilised by Reticulum, and
+will be fully on-par with natively included interfaces, including all supported
+:ref:`interface modes<interfaces-modes>` and :ref:`common configuration options<interfaces-options>`.
+
+.. literalinclude:: ../../Examples/ExampleInterface.py
+
+This example can also be found at `<https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py>`_.

docs/manual/_sources/interfaces.rst.txt

@@ -14,6 +14,11 @@ for Reticulum to use.
 The following sections describe the interfaces currently available in Reticulum,
 and gives example configurations for the respective interface types.
 
+In addition to the built-in interface types, Reticulum is fully extensible with
+custom, user- or community-supplied interfaces, and creating custom interface
+modules is straightforward. Please see the :ref:`custom interface<example-custominterface>`
+example for basic interface code to build upon.
+
 For a high-level overview of how networks can be formed over different interface
 types, have a look at the :ref:`Building Networks<networks-main>` chapter of this
 manual.
@@ -493,89 +498,89 @@ Multi interface can be used to configure sub-interfaces individually.
   # id_interval = 600
 
     # A subinterface
-    [[[HIGHDATARATE]]]
-    # Subinterfaces can be enabled and disabled in of themselves
-    interface_enabled = True
-
-    # Set frequency to 2.4GHz
-    frequency = 2400000000
-
-    # Set LoRa bandwidth to 1625 KHz
-    bandwidth = 1625000
-
-    # Set TX power to 0 dBm (0.12 mW)
-    txpower = 0
-
-    # The virtual port, only the manufacturer
-    # or the person who wrote the board config
-    # can tell you what it will be for which
-    # physical hardware interface
-    vport = 1
-
-    # Select spreading factor 5. Valid
-    # range is 5 through 12, with 5 
-    # being the fastest and 12 having
-    # the longest range.
-    spreadingfactor = 5
-
-    # Select coding rate 5. Valid range
-    # is 5 throough 8, with 5 being the
-    # fastest, and 8 the longest range.
-    codingrate = 5
-
-    # It is possible to limit the airtime
-    # utilisation of an RNode by using the
-    # following two configuration options.
-    # The short-term limit is applied in a
-    # window of approximately 15 seconds,
-    # and the long-term limit is enforced
-    # over a rolling 60 minute window. Both
-    # options are specified in percent.
-
-    # airtime_limit_long = 100
-    # airtime_limit_short = 100
-
-    [[[LOWDATARATE]]]
-    # Subinterfaces can be enabled and disabled in of themselves
-    interface_enabled = True
-
-    # Set frequency to 865.6 MHz
-    frequency = 865600000
-
-    # The virtual port, only the manufacturer
-    # or the person who wrote the board config
-    # can tell you what it will be for which
-    # physical hardware interface
-    vport = 0
-
-    # Set LoRa bandwidth to 125 KHz
-    bandwidth = 125000
-
-    # Set TX power to 0 dBm (0.12 mW)
-    txpower = 0
-
-    # Select spreading factor 7. Valid
-    # range is 5 through 12, with 5 
-    # being the fastest and 12 having
-    # the longest range.
-    spreadingfactor = 7
-
-    # Select coding rate 5. Valid range
-    # is 5 throough 8, with 5 being the
-    # fastest, and 8 the longest range.
-    codingrate = 5
-
-    # It is possible to limit the airtime
-    # utilisation of an RNode by using the
-    # following two configuration options.
-    # The short-term limit is applied in a
-    # window of approximately 15 seconds,
-    # and the long-term limit is enforced
-    # over a rolling 60 minute window. Both
-    # options are specified in percent.
-
-    # airtime_limit_long = 100
-    # airtime_limit_short = 100
+    [[[High Datarate]]]
+      # Subinterfaces can be enabled and disabled in of themselves
+      interface_enabled = True
+
+      # Set frequency to 2.4GHz
+      frequency = 2400000000
+
+      # Set LoRa bandwidth to 1625 KHz
+      bandwidth = 1625000
+
+      # Set TX power to 0 dBm (0.12 mW)
+      txpower = 0
+
+      # The virtual port, only the manufacturer
+      # or the person who wrote the board config
+      # can tell you what it will be for which
+      # physical hardware interface
+      vport = 1
+
+      # Select spreading factor 5. Valid
+      # range is 5 through 12, with 5 
+      # being the fastest and 12 having
+      # the longest range.
+      spreadingfactor = 5
+
+      # Select coding rate 5. Valid range
+      # is 5 throough 8, with 5 being the
+      # fastest, and 8 the longest range.
+      codingrate = 5
+
+      # It is possible to limit the airtime
+      # utilisation of an RNode by using the
+      # following two configuration options.
+      # The short-term limit is applied in a
+      # window of approximately 15 seconds,
+      # and the long-term limit is enforced
+      # over a rolling 60 minute window. Both
+      # options are specified in percent.
+
+      # airtime_limit_long = 100
+      # airtime_limit_short = 100
+
+    [[[Low Datarate]]]
+      # Subinterfaces can be enabled and disabled in of themselves
+      interface_enabled = True
+
+      # Set frequency to 865.6 MHz
+      frequency = 865600000
+
+      # The virtual port, only the manufacturer
+      # or the person who wrote the board config
+      # can tell you what it will be for which
+      # physical hardware interface
+      vport = 0
+
+      # Set LoRa bandwidth to 125 KHz
+      bandwidth = 125000
+
+      # Set TX power to 0 dBm (0.12 mW)
+      txpower = 0
+
+      # Select spreading factor 7. Valid
+      # range is 5 through 12, with 5 
+      # being the fastest and 12 having
+      # the longest range.
+      spreadingfactor = 7
+
+      # Select coding rate 5. Valid range
+      # is 5 throough 8, with 5 being the
+      # fastest, and 8 the longest range.
+      codingrate = 5
+
+      # It is possible to limit the airtime
+      # utilisation of an RNode by using the
+      # following two configuration options.
+      # The short-term limit is applied in a
+      # window of approximately 15 seconds,
+      # and the long-term limit is enforced
+      # over a rolling 60 minute window. Both
+      # options are specified in percent.
+
+      # airtime_limit_long = 100
+      # airtime_limit_short = 100
 
 .. _interfaces-serial: