Updated manual

RNS/Utilities/rnstatus.py

@@ -46,7 +46,7 @@ def size_str(num, suffix='B'):
 
     return "%.2f%s%s" % (num, last_unit, suffix)
 
-def program_setup(configdir, dispall=False, verbosity=0, name_filter=None):
+def program_setup(configdir, dispall=False, verbosity=0, name_filter=None,json=False):
     reticulum = RNS.Reticulum(configdir = configdir, loglevel = 3+verbosity)
 
     stats = None
@@ -56,6 +56,11 @@ def program_setup(configdir, dispall=False, verbosity=0, name_filter=None):
         pass
 
     if stats != None:
+        if json:
+            import json
+            print(json.dumps(stats))
+            exit()
+            
         for ifstat in stats["interfaces"]:
             name = ifstat["name"]
 
@@ -176,6 +181,14 @@ def main():
             default=False
         )
         
+        parser.add_argument(
+            "-j",
+            "--json",
+            action="store_true",
+            help="output in JSON format",
+            default=False
+        )
+
         parser.add_argument('-v', '--verbose', action='count', default=0)
 
         parser.add_argument("filter", nargs="?", default=None, help="only display interfaces with names including filter", type=str)
@@ -187,7 +200,7 @@ def main():
         else:
             configarg = None
 
-        program_setup(configdir = configarg, dispall = args.all, verbosity=args.verbose, name_filter=args.filter)
+        program_setup(configdir = configarg, dispall = args.all, verbosity=args.verbose, name_filter=args.filter, json=args.json)
 
     except KeyboardInterrupt:
         print("")

Roadmap.md

@@ -20,8 +20,7 @@ For each release cycle of Reticulum, improvements and additions from the five [P
   - [x] Improved roaming support on Android
   - [x] Add bluetooth pairing code output to rnodeconf
   - [x] Add `rnid` utility with encryption, signing and Identity funcionality
-  - [ ] Transit traffic display in rnstatus
+  - [x] JSON output mode for rnstatus
-  - [ ] JSON output mode for rnstatus
   - [ ] Add automatic retries to all use cases of the `Request` API
   - [ ] Updating the documentation to reflect recent changes and improvements
 - Targets for related applications
@@ -31,7 +30,7 @@ For each release cycle of Reticulum, improvements and additions from the five [P
   - [x] Add spatial and multi-interface roaming support in Sideband
   - [x] Expand device support in Sideband to support older Android devices
   - [x] And input fields, data submission and dynamic request links to Nomad Network
-  - [ ] Add bandwidth-based weighting to LXMF propagation node sync peer prioritisation
+  - [x] Add bandwidth-based weighting to LXMF propagation node sync peer prioritisation
 
 ## Primary Efforts
 The development path for Reticulum is currently laid out in five distinct areas: *Comprehensibility*, *Universality*, *Functionality*, *Usability & Utility* and *Interfaceability*. Conceptualising the development of Reticulum into these areas serves to advance the implementation and work towards the Foundational Goals & Values of Reticulum.

docs/manual/examples.html

@@ -1065,10 +1065,6 @@ destination, and passing traffic back and forth over the link.</p>
     <span class="k">global</span> <span class="n">latest_client_link</span>
 
     <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Client connected&quot;</span><span class="p">)</span>
-    <span class="c1"># TODO: Remove</span>
-    <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Establishment rate: &quot;</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">link</span><span class="o">.</span><span class="n">get_establishment_rate</span><span class="p">()))</span>
-    <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Establishment rate: &quot;</span><span class="o">+</span><span class="n">RNS</span><span class="o">.</span><span class="n">prettysize</span><span class="p">(</span><span class="n">link</span><span class="o">.</span><span class="n">get_establishment_rate</span><span class="p">(),</span> <span class="s2">&quot;b&quot;</span><span class="p">))</span>
-    
     <span class="n">link</span><span class="o">.</span><span class="n">set_link_closed_callback</span><span class="p">(</span><span class="n">client_disconnected</span><span class="p">)</span>
     <span class="n">link</span><span class="o">.</span><span class="n">set_packet_callback</span><span class="p">(</span><span class="n">server_packet_received</span><span class="p">)</span>
     <span class="n">latest_client_link</span> <span class="o">=</span> <span class="n">link</span>
@@ -1201,10 +1197,6 @@ destination, and passing traffic back and forth over the link.</p>
     <span class="k">global</span> <span class="n">server_link</span>
     <span class="n">server_link</span> <span class="o">=</span> <span class="n">link</span>
 
-    <span class="c1"># TODO: Remove</span>
-    <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Establishment rate: &quot;</span><span class="o">+</span><span class="nb">str</span><span class="p">(</span><span class="n">link</span><span class="o">.</span><span class="n">get_establishment_rate</span><span class="p">()))</span>
-    <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Establishment rate: &quot;</span><span class="o">+</span><span class="n">RNS</span><span class="o">.</span><span class="n">prettysize</span><span class="p">(</span><span class="n">link</span><span class="o">.</span><span class="n">get_establishment_rate</span><span class="p">(),</span> <span class="s2">&quot;B&quot;</span><span class="p">))</span>
-
     <span class="c1"># Inform the user that the server is</span>
     <span class="c1"># connected</span>
     <span class="n">RNS</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="s2">&quot;Link established with server, enter some text to send, or </span><span class="se">\&quot;</span><span class="s2">quit</span><span class="se">\&quot;</span><span class="s2"> to quit&quot;</span><span class="p">)</span>