# Let's make a simple message class called StringMessage
# that will convey a string with a timestamp.
-class StringMessage(RNS.MessageBase):
+class StringMessage(RNS.MessageBase):
# The MSGTYPE class variable needs to be assigned a
# 2 byte integer value. This identifier allows the
# channel to look up your message's constructor when a
@@ -1962,7 +1962,7 @@ data between peers of a # This is needed so the channel can create an empty
# version of our message into which the incoming
# message can be unpacked.
- def __init__(self, data=None):
+ def __init__(self, data=None):
self.data = data
self.timestamp = datetime.now()
@@ -1982,12 +1982,12 @@ data between peers of a # The pack function encodes the message contents into
# a byte stream.
- def pack(self) -> bytes:
+ def pack(self) -> bytes:
return umsgpack.packb((self.data, self.timestamp))
# And the unpack function decodes a byte stream into
# the message contents.
- def unpack(self, raw):
+ def unpack(self, raw):
self.data, self.timestamp = umsgpack.unpackb(raw)
@@ -2000,7 +2000,7 @@ data between peers of a # This initialisation is executed when the users chooses
# to run as a server
-def server(configpath):
+def server(configpath):
# We must first initialise Reticulum
reticulum = RNS.Reticulum(configpath)
@@ -2026,7 +2026,7 @@ data between peers of a # Let's Wait for client requests or user input
server_loop(server_destination)
-def server_loop(destination):
+def server_loop(destination):
# Let the user know that everything is ready
RNS.log(
"Channel example "+
@@ -2048,7 +2048,7 @@ data between peers of a # When a client establishes a link to our server
# destination, this function will be called with
# a reference to the link.
-def client_connected(link):
+def client_connected(link):
global latest_client_link
latest_client_link = link
@@ -2060,10 +2060,10 @@ data between peers of a channel.register_message_type(StringMessage)
channel.add_message_handler(server_message_received)
-def client_disconnected(link):
+def client_disconnected(link):
RNS.log("Client disconnected")
-def server_message_received(message):
+def server_message_received(message):
"""
A message handler
@param message: An instance of a subclass of MessageBase
@@ -2104,7 +2104,7 @@ data between peers of a # This initialisation is executed when the users chooses
# to run as a client
-def client(destination_hexhash, configpath):
+def client(destination_hexhash, configpath):
# We need a binary representation of the destination
# hash that was entered on the command line
try:
@@ -2157,7 +2157,7 @@ data between peers of a # for the user to interact with the example
client_loop()
-def client_loop():
+def client_loop():
global server_link
# Wait for the link to become active
@@ -2201,7 +2201,7 @@ data between peers of a # This function is called when a link
# has been established with the server
-def link_established(link):
+def link_established(link):
# We store a reference to the link
# instance for later use
global server_link
@@ -2218,7 +2218,7 @@ data between peers of a # When a link is closed, we'll inform the
# user, and exit the program
-def link_closed(link):
+def link_closed(link):
if link.teardown_reason == RNS.Link.TIMEOUT:
RNS.log("The link timed out, exiting now")
elif link.teardown_reason == RNS.Link.DESTINATION_CLOSED:
@@ -2231,7 +2231,7 @@ data between peers of a # When a packet is received over the channel, we
# simply print out the data.
-def client_message_received(message):
+def client_message_received(message):
if isinstance(message, StringMessage):
RNS.log("Received data on the link: " + message.data + " (message created at " + str(message.timestamp) + ")")
print("> ", end=" ")
@@ -2305,15 +2305,15 @@ binary data between peers of a # a destination, and pass binary data over it using a #
# channel buffer. #
##########################################################
-from __future__ import annotations
-import os
-import sys
-import time
-import argparse
-from datetime import datetime
+from __future__ import annotations
+import os
+import sys
+import time
+import argparse
+from datetime import datetime
-import RNS
-from RNS.vendor import umsgpack
+import RNS
+from RNS.vendor import umsgpack
# Let's define an app name. We'll use this for all
# destinations we create. Since this echo example
@@ -2334,7 +2334,7 @@ binary data between peers of a # This initialisation is executed when the users chooses
# to run as a server
-def server(configpath):
+def server(configpath):
# We must first initialise Reticulum
reticulum = RNS.Reticulum(configpath)
@@ -2360,7 +2360,7 @@ binary data between peers of a # Let's Wait for client requests or user input
server_loop(server_destination)
-def server_loop(destination):
+def server_loop(destination):
# Let the user know that everything is ready
RNS.log(
"Link buffer example "+
@@ -2382,7 +2382,7 @@ binary data between peers of a # When a client establishes a link to our server
# destination, this function will be called with
# a reference to the link.
-def client_connected(link):
+def client_connected(link):
global latest_client_link, latest_buffer
latest_client_link = link
@@ -2408,10 +2408,10 @@ binary data between peers of a channel = link.get_channel()
latest_buffer = RNS.Buffer.create_bidirectional_buffer(0, 0, channel, server_buffer_ready)
-def client_disconnected(link):
+def client_disconnected(link):
RNS.log("Client disconnected")
-def server_buffer_ready(ready_bytes: int):
+def server_buffer_ready(ready_bytes: int):
"""
Callback from buffer when buffer has data available
@@ -2446,7 +2446,7 @@ binary data between peers of a # This initialisation is executed when the users chooses
# to run as a client
-def client(destination_hexhash, configpath):
+def client(destination_hexhash, configpath):
# We need a binary representation of the destination
# hash that was entered on the command line
try:
@@ -2499,7 +2499,7 @@ binary data between peers of a # for the user to interact with the example
client_loop()
-def client_loop():
+def client_loop():
global server_link
# Wait for the link to become active
@@ -2531,7 +2531,7 @@ binary data between peers of a # This function is called when a link
# has been established with the server
-def link_established(link):
+def link_established(link):
# We store a reference to the link
# instance for later use
global server_link, buffer
@@ -2548,7 +2548,7 @@ binary data between peers of a # When a link is closed, we'll inform the
# user, and exit the program
-def link_closed(link):
+def link_closed(link):
if link.teardown_reason == RNS.Link.TIMEOUT:
RNS.log("The link timed out, exiting now")
elif link.teardown_reason == RNS.Link.DESTINATION_CLOSED:
@@ -2560,7 +2560,7 @@ binary data between peers of a sys.exit(0)
# When the buffer has new data, read it and write it to the terminal.
-def client_buffer_ready(ready_bytes: int):
+def client_buffer_ready(ready_bytes: int):
global buffer
data = buffer.read(ready_bytes)
RNS.log("Received data over the link buffer: " + data.decode("utf-8"))
@@ -2649,13 +2649,13 @@ interface to efficiently pass files of any size over a Reticulum # into chunks suitable for packing as a Resource. #
##########################################################
-import os
-import sys
-import time
-import threading
-import argparse
-import RNS
-import RNS.vendor.umsgpack as umsgpack
+import os
+import sys
+import time
+import threading
+import argparse
+import RNS
+import RNS.vendor.umsgpack as umsgpack
# Let's define an app name. We'll use this for all
# destinations we create. Since this echo example
@@ -2674,7 +2674,7 @@ interface to efficiently pass files of any size over a Reticulum # This initialisation is executed when the users chooses
# to run as a server
-def server(configpath, path):
+def server(configpath, path):
# We must first initialise Reticulum
reticulum = RNS.Reticulum(configpath)
@@ -2704,7 +2704,7 @@ interface to efficiently pass files of any size over a Reticulum # Let's Wait for client requests or user input
announceLoop(server_destination)
-def announceLoop(destination):
+def announceLoop(destination):
# Let the user know that everything is ready
RNS.log("File server "+RNS.prettyhexrep(destination.hash)+" running")
RNS.log("Hit enter to manually send an announce (Ctrl-C to quit)")
@@ -2720,7 +2720,7 @@ interface to efficiently pass files of any size over a Reticulum # Here's a convenience function for listing all files
# in our served directory
-def list_files():
+def list_files():
# We add all entries from the directory that are
# actual files, and does not start with "."
global serve_path
@@ -2730,7 +2730,7 @@ interface to efficiently pass files of any size over a Reticulum # destination, this function will be called with
# a reference to the link. We then send the client
# a list of files hosted on the server.
-def client_connected(link):
+def client_connected(link):
# Check if the served directory still exists
if os.path.isdir(serve_path):
RNS.log("Client connected, sending file list...")
@@ -2763,10 +2763,10 @@ interface to efficiently pass files of any size over a Reticulum RNS.log("Client connected, but served path no longer exists!", RNS.LOG_ERROR)
link.teardown()
-def client_disconnected(link):
+def client_disconnected(link):
RNS.log("Client disconnected")
-def client_request(message, packet):
+def client_request(message, packet):
global serve_path
try:
@@ -2801,7 +2801,7 @@ interface to efficiently pass files of any size over a Reticulum # This function is called on the server when a
# resource transfer concludes.
-def resource_sending_concluded(resource):
+def resource_sending_concluded(resource):
if hasattr(resource, "filename"):
name = resource.filename
else:
@@ -2812,10 +2812,10 @@ interface to efficiently pass files of any size over a Reticulum elif resource.status == RNS.Resource.FAILED:
RNS.log("Sending \""+name+"\" to client failed")
-def list_delivered(receipt):
+def list_delivered(receipt):
RNS.log("The file list was received by the client")
-def list_timeout(receipt):
+def list_timeout(receipt):
RNS.log("Sending list to client timed out, closing this link")
link = receipt.destination
link.teardown()
@@ -2844,7 +2844,7 @@ interface to efficiently pass files of any size over a Reticulum # This initialisation is executed when the users chooses
# to run as a client
-def client(destination_hexhash, configpath):
+def client(destination_hexhash, configpath):
# We need a binary representation of the destination
# hash that was entered on the command line
try:
@@ -2912,7 +2912,7 @@ interface to efficiently pass files of any size over a Reticulum menu()
# Requests the specified file from the server
-def download(filename):
+def download(filename):
global server_link, menu_mode, current_filename, transfer_size, download_started
current_filename = filename
download_started = 0
@@ -2932,7 +2932,7 @@ interface to efficiently pass files of any size over a Reticulum # This function runs a simple menu for the user
# to select which files to download, or quit
menu_mode = None
-def menu():
+def menu():
global server_files, server_link
# Wait until we have a filelist
while len(server_files) == 0:
@@ -2972,7 +2972,7 @@ interface to efficiently pass files of any size over a Reticulum # It's simple and quite uninteresting.
# I won't go into detail here. Just
# strings basically.
-def print_menu():
+def print_menu():
global menu_mode, download_time, download_started, download_finished, transfer_size, file_size
if menu_mode == "main":
@@ -3041,13 +3041,13 @@ interface to efficiently pass files of any size over a Reticulum # This function prints out a list of files
# on the connected server.
-def print_filelist():
+def print_filelist():
global server_files
print("Files on server:")
for index,file in enumerate(server_files):
print("\t("+str(index)+")\t"+file)
-def filelist_received(filelist_data, packet):
+def filelist_received(filelist_data, packet):
global server_files, menu_mode
try:
# Unpack the list and extend our
@@ -3068,7 +3068,7 @@ interface to efficiently pass files of any size over a Reticulum # This function is called when a link
# has been established with the server
-def link_established(link):
+def link_established(link):
# We store a reference to the link
# instance for later use
global server_link
@@ -3089,7 +3089,7 @@ interface to efficiently pass files of any size over a Reticulum # time, and then checks if the file list
# was received. If not, the program will
# exit.
-def filelist_timeout_job():
+def filelist_timeout_job():
time.sleep(APP_TIMEOUT)
global server_files
@@ -3100,7 +3100,7 @@ interface to efficiently pass files of any size over a Reticulum # When a link is closed, we'll inform the
# user, and exit the program
-def link_closed(link):
+def link_closed(link):
if link.teardown_reason == RNS.Link.TIMEOUT:
RNS.log("The link timed out, exiting now")
elif link.teardown_reason == RNS.Link.DESTINATION_CLOSED:
@@ -3115,7 +3115,7 @@ interface to efficiently pass files of any size over a Reticulum # started, we'll update our menu state
# so the user can be shown a progress of
# the download.
-def download_began(resource):
+def download_began(resource):
global menu_mode, current_download, download_started, transfer_size, file_size
current_download = resource
@@ -3130,7 +3130,7 @@ interface to efficiently pass files of any size over a Reticulum # When the download concludes, successfully
# or not, we'll update our menu state and
# inform the user about how it all went.
-def download_concluded(resource):
+def download_concluded(resource):
global menu_mode, current_filename, download_started, download_finished, download_time
download_finished = time.time()
download_time = download_finished - download_started
@@ -3155,7 +3155,7 @@ interface to efficiently pass files of any size over a Reticulum # A convenience function for printing a human-
# readable file size
-def size_str(num, suffix='B'):
+def size_str(num, suffix='B'):
units = ['','Ki','Mi','Gi','Ti','Pi','Ei','Zi']
last_unit = 'Yi'
@@ -3171,7 +3171,7 @@ interface to efficiently pass files of any size over a Reticulum return "%.2f %s%s" % (num, last_unit, suffix)
# A convenience function for clearing the screen
-def clear_screen():
+def clear_screen():
os.system('cls' if os.name=='nt' else 'clear')
##########################################################
@@ -3263,15 +3263,15 @@ will be fully on-par with natively included interfaces, including all supported
# parity = none
# stopbits = 1
-from time import sleep
-import sys
-import threading
-import time
+from time import sleep
+import sys
+import threading
+import time
# This HDLC helper class is used by the interface
# to delimit and packetize data over the physical
# medium - in this case a serial connection.
-class HDLC():
+class HDLC():
# This example interface packetizes data using
# simplified HDLC framing, similar to PPP
FLAG = 0x7E
@@ -3279,14 +3279,14 @@ will be fully on-par with natively included interfaces, including all supported
ESC_MASK = 0x20
@staticmethod
- def escape(data):
+ def escape(data):
data = data.replace(bytes([HDLC.ESC]), bytes([HDLC.ESC, HDLC.ESC^HDLC.ESC_MASK]))
data = data.replace(bytes([HDLC.FLAG]), bytes([HDLC.ESC, HDLC.FLAG^HDLC.ESC_MASK]))
return data
# Let's define our custom interface class. It must
# be a sub-class of the RNS "Interface" class.
-class ExampleInterface(Interface):
+class ExampleInterface(Interface):
# All interface classes must define a default
# IFAC size, used in IFAC setup when the user
# has not specified a custom IFAC size. This
@@ -3307,14 +3307,14 @@ will be fully on-par with natively included interfaces, including all supported
# method that takes 2 positional arguments:
# The owner RNS Transport instance, and a dict
# of configuration values.
- def __init__(self, owner, configuration):
+ def __init__(self, owner, configuration):
# The following lines demonstrate handling
# potential dependencies required for the
# interface to function correctly.
- import importlib
+ import importlib
if importlib.util.find_spec('serial') != None:
- import serial
+ import serial
else:
RNS.log("Using this interface requires a serial communication module to be installed.", RNS.LOG_CRITICAL)
RNS.log("You can install one with the command: python3 -m pip install pyserial", RNS.LOG_CRITICAL)
@@ -3400,7 +3400,7 @@ will be fully on-par with natively included interfaces, including all supported
# Open the serial port with supplied configuration
# parameters and store a reference to the open port.
- def open_port(self):
+ def open_port(self):
RNS.log("Opening serial port "+self.port+"...", RNS.LOG_VERBOSE)
self.serial = self.pyserial.Serial(
port = self.port,
@@ -3420,7 +3420,7 @@ will be fully on-par with natively included interfaces, including all supported
# is to wait a small amount of time for the
# hardware to initialise and then start a thread
# that reads any incoming data from the device.
- def configure_device(self):
+ def configure_device(self):
sleep(0.5)
thread = threading.Thread(target=self.read_loop)
thread.daemon = True
@@ -3432,7 +3432,7 @@ will be fully on-par with natively included interfaces, including all supported
# This method will be called from our read-loop
# whenever a full packet has been received over
# the underlying medium.
- def process_incoming(self, data):
+ def process_incoming(self, data):
# Update our received bytes counter
self.rxb += len(data)
@@ -3443,7 +3443,7 @@ will be fully on-par with natively included interfaces, including all supported
# The running Reticulum Transport instance will
# call this method on the interface whenever the
# interface must transmit a packet.
- def process_outgoing(self,data):
+ def process_outgoing(self,data):
if self.online:
# First, escape and packetize the data
# according to HDLC framing.
@@ -3463,7 +3463,7 @@ will be fully on-par with natively included interfaces, including all supported
# When a full packet has been received, it will
# be sent to the process_incoming methed, which
# will in turn pass it to the Transport instance.
- def read_loop(self):
+ def read_loop(self):
try:
in_frame = False
escape = False
@@ -3516,7 +3516,7 @@ will be fully on-par with natively included interfaces, including all supported
self.reconnect_port()
# This method handles serial port disconnects.
- def reconnect_port(self):
+ def reconnect_port(self):
while not self.online:
try:
time.sleep(5)
@@ -3531,13 +3531,13 @@ will be fully on-par with natively included interfaces, including all supported
# Signal to Reticulum that this interface should
# not perform any ingress limiting.
- def should_ingress_limit(self):
+ def should_ingress_limit(self):
return False
# We must provide a string representation of this
# interface, that is used whenever the interface
# is printed in logs or external programs.
- def __str__(self):
+ def __str__(self):
return "ExampleInterface["+self.name+"]"
# Finally, register the defined interface class as the
diff --git a/docs/manual/forhumans.html b/docs/manual/forhumans.html
index 41ce930..f85cc16 100644
--- a/docs/manual/forhumans.html
+++ b/docs/manual/forhumans.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/gettingstartedfast.html b/docs/manual/gettingstartedfast.html
index 114fad9..19ac753 100644
--- a/docs/manual/gettingstartedfast.html
+++ b/docs/manual/gettingstartedfast.html
@@ -2,7 +2,7 @@
-
+
@@ -292,8 +292,7 @@ provides a complete encrypted communications suite built with Reticulum. It feat
encrypted messaging (both direct and delayed-delivery for offline users), file sharing,
and has a built-in text-browser and page server with support for dynamically rendered pages,
user authentication and more.
-
-
+
Nomad Network is a user-facing client
for the messaging and information-sharing protocol
LXMF, another project built with Reticulum.
@@ -319,8 +318,7 @@ manually add the pi
If you would rather use a program with a graphical user interface, you can take
a look at Sideband, which is available for Android,
Linux, macOS and Windows.
-
-
+
Sideband allows you to communicate with other people or LXMF-compatible
systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR
Paper Messages, or anything else Reticulum supports. It also interoperates with
@@ -331,8 +329,7 @@ the Nomad Network program.
The Reticulum MeshChat application
is a user-friendly LXMF client for macOS and Windows, that also includes voice call
functionality, and a range of other interesting functions.
-
-
+
Reticulum MeshChat is of course also compatible with Sideband and Nomad Network, or
any other LXMF client.
diff --git a/docs/manual/hardware.html b/docs/manual/hardware.html
index 6bd2dfa..9e727ef 100644
--- a/docs/manual/hardware.html
+++ b/docs/manual/hardware.html
@@ -2,7 +2,7 @@
-
+
@@ -292,8 +292,7 @@ to the configuration.
To create one or more RNodes, you will need to obtain supported development
boards. The following boards are supported by the auto-installer.
-
-
+
LilyGO T-Beam Supreme#
@@ -302,8 +301,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
LilyGO T-Beam#
@@ -313,8 +311,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
LilyGO T3S3#
@@ -324,8 +321,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
RAK4631-based Boards#
@@ -335,8 +331,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer RAK Wireless
-
-
+
Unsigned RNode v2.x#
@@ -346,8 +341,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer unsigned.io
-
-
+
LilyGO LoRa32 v2.1#
@@ -357,8 +351,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
LilyGO LoRa32 v2.0#
@@ -368,8 +361,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
LilyGO LoRa32 v1.0#
@@ -379,8 +371,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
LilyGO T-Deck#
@@ -390,8 +381,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer LilyGO
-
-
+
Heltec LoRa32 v3.0#
@@ -401,8 +391,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer Heltec Automation
-
-
+
Heltec LoRa32 v2.0#
@@ -412,8 +401,7 @@ boards. The following boards are supported by the auto-installer.
Manufacturer Heltec Automation
-
-
+
Unsigned RNode v1.x#
@@ -462,10 +450,8 @@ Most devices will behave like this by default, or allow it via configuration opt
and start communicating over them using Reticulum. It is not necessary to enable any IP
infrastructure such as DHCP servers, DNS or similar, as long as at least Ethernet is
available, and packets are passed transparently over the physical WiFi-based devices.
-
-
-
-
+
+
Below is a list of example WiFi (and similar) radios that work well for high capacity
Reticulum links over long distances:
diff --git a/docs/manual/index.html b/docs/manual/index.html
index 1a1c615..baa2677 100644
--- a/docs/manual/index.html
+++ b/docs/manual/index.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/interfaces.html b/docs/manual/interfaces.html
index 9dd75cd..1f682f6 100644
--- a/docs/manual/interfaces.html
+++ b/docs/manual/interfaces.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/networks.html b/docs/manual/networks.html
index 589b3db..b6f66a3 100644
--- a/docs/manual/networks.html
+++ b/docs/manual/networks.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/reference.html b/docs/manual/reference.html
index 47a4393..f966810 100644
--- a/docs/manual/reference.html
+++ b/docs/manual/reference.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/support.html b/docs/manual/support.html
index 409bb62..484e41c 100644
--- a/docs/manual/support.html
+++ b/docs/manual/support.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/understanding.html b/docs/manual/understanding.html
index d1271b6..3eb7dee 100644
--- a/docs/manual/understanding.html
+++ b/docs/manual/understanding.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/using.html b/docs/manual/using.html
index 9d948eb..9f820de 100644
--- a/docs/manual/using.html
+++ b/docs/manual/using.html
@@ -2,7 +2,7 @@
-
+
diff --git a/docs/manual/whatis.html b/docs/manual/whatis.html
index 0157827..150e3b8 100644
--- a/docs/manual/whatis.html
+++ b/docs/manual/whatis.html
@@ -2,7 +2,7 @@
-
+