diff --git a/.github/ISSUE_TEMPLATE/🐛-bug-report.md b/.github/ISSUE_TEMPLATE/🐛-bug-report.md
index 77ad6c2..82a4968 100644
--- a/.github/ISSUE_TEMPLATE/🐛-bug-report.md
+++ b/.github/ISSUE_TEMPLATE/🐛-bug-report.md
@@ -12,10 +12,14 @@ Before creating a bug report on this issue tracker, you **must** read the [Contr
- The issue tracker is used by developers of this project. **Do not use it to ask general questions, or for support requests**.
- Ideas and feature requests can be made on the [Discussions](https://github.com/markqvist/Reticulum/discussions). **Only** feature requests accepted by maintainers and developers are tracked and included on the issue tracker. **Do not post feature requests here**.
-- After reading the [Contribution Guidelines](https://github.com/markqvist/Reticulum/blob/master/Contributing.md), delete this section from your bug report.
+- After reading the [Contribution Guidelines](https://github.com/markqvist/Reticulum/blob/master/Contributing.md), **delete this section only** (*"Read the Contribution Guidelines"*) from your bug report, **and fill in all the other sections**.
**Describe the Bug**
-A clear and concise description of what the bug is.
+First of all: Is this really a bug? Is it reproducible?
+
+If this is a request for help because something is not working as you expected, stop right here, and go to the [discussions](https://github.com/markqvist/Reticulum/discussions) instead, where you can post your questions and get help from other users.
+
+If this really is a bug or issue with the software, remove this section of the template, and provide **a clear and concise description of what the bug is**.
**To Reproduce**
Describe in detail how to reproduce the bug.
@@ -24,7 +28,7 @@ Describe in detail how to reproduce the bug.
A clear and concise description of what you expected to happen.
**Logs & Screenshots**
-Please include any relevant log output. If applicable, also add screenshots to help explain your problem.
+Please include any relevant log output. If applicable, also add screenshots to help explain your problem. In most cases, without any relevant log output, we will not be able to determine the cause of the bug, or reproduce it.
**System Information**
- OS and version
diff --git a/.gitignore b/.gitignore
index d7d285d..efbd926 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,6 +6,7 @@ sbapp/bin
sbapp/app_storage
sbapp/RNS
sbapp/LXMF
+sbapp/LXST
sbapp/precompiled
sbapp/*.DS_Store
sbapp/*.pyc
@@ -32,3 +33,4 @@ dist
docs/build
sideband*.egg-info
sbapp*.egg-info
+LXST
diff --git a/FUNDING.yml b/FUNDING.yml
new file mode 100644
index 0000000..d125d55
--- /dev/null
+++ b/FUNDING.yml
@@ -0,0 +1,3 @@
+liberapay: Reticulum
+ko_fi: markqvist
+custom: "https://unsigned.io/donate"
diff --git a/Makefile b/Makefile
index 5b8cd31..6f5ed59 100644
--- a/Makefile
+++ b/Makefile
@@ -31,6 +31,9 @@ preparewheel:
build_wheel:
python3 setup.py sdist bdist_wheel
+build_win_exe:
+ python -m PyInstaller sideband.spec --noconfirm
+
release: build_wheel apk fetchapk
upload:
diff --git a/README.md b/README.md
index c1d8288..4bc11d3 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
Sideband Secure and private location and telemetry sharing
-- Including images in messages
-- Sending file attachments
-- Offline and online maps
-- Paper messages
-- Using Sideband as a Reticulum Transport Instance
-- Encryption keys export and import
-- Plugin support for commands, services and telemetry
-- Adding Linux .desktop file integration
-- Sending voice messages (using Codec2 and Opus)
-- Implementing the Local Broadcasts feature
-- LXMF sneakernet functionality
-- Network visualisation and test tools
-- A debug log viewer
-- Better message sorting mechanism
-- Fix I2P status not being displayed correctly when the I2P router disappears unexpectedly
-- Adding a Nomad Net page browser
-
# License
Unless otherwise noted, this work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].
diff --git a/docs/example_plugins/bme280_telemetry.py b/docs/example_plugins/bme280_telemetry.py
new file mode 100644
index 0000000..af29c70
--- /dev/null
+++ b/docs/example_plugins/bme280_telemetry.py
@@ -0,0 +1,67 @@
+# This plugin provides temperature, humidity
+# and pressure data via a BME280 sensor
+# connected over I2C. The plugin requires
+# the "smbus2" and "RPi.bme280" modules to
+# be available on your system. These can be
+# installed with:
+#
+# pip install smbus2 RPi.bme280
+
+import os
+import RNS
+from importlib.util import find_spec
+
+class BME280Plugin(SidebandTelemetryPlugin):
+ plugin_name = "telemetry_bme280"
+
+ I2C_ADDRESS = 0x76
+ I2C_BUS = 1
+
+ # If your BME280 has an offset from the true
+ # temperature, you can compensate for this
+ # by modifying this parameter.
+ TEMPERATURE_CORRECTION = 0.0
+
+ def start(self):
+ RNS.log("BME280 telemetry plugin starting...")
+
+ if find_spec("smbus2"): import smbus2
+ else: raise OSError(f"No smbus2 module available, cannot start BME280 telemetry plugin")
+
+ if find_spec("bme280"): import bme280
+ else: raise OSError(f"No bme280 module available, cannot start BME280 telemetry plugin")
+
+ self.sensor_connected = False
+
+ try:
+ self.bme280 = bme280
+ self.address = self.I2C_ADDRESS
+ self.bus = smbus2.SMBus(self.I2C_BUS)
+ self.calibration = self.bme280.load_calibration_params(self.bus, self.address)
+ self.sensor_connected = True
+ self.tc = self.TEMPERATURE_CORRECTION
+
+ except Exception as e:
+ RNS.log(f"Could not connect to I2C device while starting BME280 telemetry plugin", RNS.LOG_ERROR)
+ RNS.log(f"The contained exception was: {e}", RNS.LOG_ERROR)
+
+ super().start()
+
+ def stop(self):
+ self.bus.close()
+ super().stop()
+
+ def update_telemetry(self, telemeter):
+ if telemeter != None:
+ if self.sensor_connected:
+ try:
+ sample = self.bme280.sample(self.bus, self.address, self.calibration); ts = telemeter.sensors
+ telemeter.synthesize("temperature"); ts["temperature"].data = {"c": round(sample.temperature+self.tc,1)}
+ telemeter.synthesize("humidity"); ts["humidity"].data = {"percent_relative": round(sample.humidity,1)}
+ telemeter.synthesize("pressure"); ts["pressure"].data = {"mbar": round(sample.pressure,1)}
+
+ except Exception as e:
+ RNS.log("An error occurred while updating BME280 sensor data", RNS.LOG_ERROR)
+ RNS.log(f"The contained exception was: {e}", RNS.LOG_ERROR)
+
+plugin_class = BME280Plugin
\ No newline at end of file
diff --git a/docs/example_plugins/gpsd_location.py b/docs/example_plugins/gpsd_location.py
index 2c3e713..06d47cd 100644
--- a/docs/example_plugins/gpsd_location.py
+++ b/docs/example_plugins/gpsd_location.py
@@ -67,7 +67,7 @@ class GpsdLocationPlugin(SidebandTelemetryPlugin):
self.latitude = gpsd_latitude
self.longitude = gpsd_longitude
self.altitude = gpsd_altitude
- self.speed = gpsd_speed
+ self.speed = gpsd_speed*3.6 # Convert from m/s to km/h
self.bearing = gpsd_bearing
epx = result.get("epx", None); epy = result.get("epy", None)
diff --git a/docs/example_plugins/lxmd_telemetry.py b/docs/example_plugins/lxmd_telemetry.py
new file mode 100644
index 0000000..bef47b9
--- /dev/null
+++ b/docs/example_plugins/lxmd_telemetry.py
@@ -0,0 +1,41 @@
+# This is an LXMd telemetry plugin that
+# queries a running LXMF Propagation Node
+# for status and statistics.
+
+import RNS
+
+class LXMdTelemetryPlugin(SidebandTelemetryPlugin):
+ plugin_name = "lxmd_telemetry"
+
+ def start(self):
+ # Do any initialisation work here
+ RNS.log("LXMd telemetry plugin starting...")
+
+ # And finally call start on superclass
+ super().start()
+
+ def stop(self):
+ # Do any teardown work here
+ pass
+
+ # And finally call stop on superclass
+ super().stop()
+
+ def update_telemetry(self, telemeter):
+ if telemeter != None:
+ if not "lxmf_propagation" in telemeter.sensors:
+ # Create lxmd status sensor if it is not already
+ # enabled in the running telemeter instance
+ telemeter.enable("lxmf_propagation")
+
+ # Set the identity file used to communicate with
+ # the running LXMd instance.
+ telemeter.sensors["lxmf_propagation"].set_identity("~/.lxmd/identity")
+
+ # You can also get LXMF Propagation Node stats
+ # from an LXMd instance running inside nomadnet
+ # telemeter.sensors["lxmf_propagation"].set_identity("~/.nomadnetwork/storage/identity")
+
+# Finally, tell Sideband what class in this
+# file is the actual plugin class.
+plugin_class = LXMdTelemetryPlugin
diff --git a/docs/example_plugins/telemetry.py b/docs/example_plugins/telemetry.py
index c6993e9..fc4f618 100644
--- a/docs/example_plugins/telemetry.py
+++ b/docs/example_plugins/telemetry.py
@@ -59,7 +59,8 @@ class BasicTelemetryPlugin(SidebandTelemetryPlugin):
# Create fuel sensor
telemeter.synthesize("fuel")
- telemeter.sensors["fuel"].update_entry(capacity=75, level=61)
+ telemeter.sensors["fuel"].update_entry(capacity=75, level=61, type_label="Main")
+ telemeter.sensors["fuel"].update_entry(capacity=15, level=15, type_label="Reserve")
# Finally, tell Sideband what class in this
# file is the actual plugin class.
diff --git a/docs/example_plugins/view.py b/docs/example_plugins/view.py
index a30f9d1..5146ade 100644
--- a/docs/example_plugins/view.py
+++ b/docs/example_plugins/view.py
@@ -310,7 +310,8 @@ class ViewCommandPlugin(SidebandCommandPlugin):
else:
image_field = self.sources[source].get_image_field(quality_preset)
image_timestamp = self.timestamp_str(self.sources[source].last_update)
- message = f"Source [b]{source}[/b] at [b]{image_timestamp}[/b]"
+ message = "#!md\n" # Tell sideband to format this message
+ message += f"Source [b]{source}[/b] at [b]{image_timestamp}[/b]"
if image_field != None:
self.image_response(message, image_field, requestor)
diff --git a/docs/example_plugins/windows_location.py b/docs/example_plugins/windows_location.py
new file mode 100644
index 0000000..ff0aded
--- /dev/null
+++ b/docs/example_plugins/windows_location.py
@@ -0,0 +1,88 @@
+# Windows Location Provider plugin example, provided by @haplo-dev
+
+import RNS
+import time
+import threading
+import asyncio
+from winsdk.windows.devices import geolocation
+
+class WindowsLocationPlugin(SidebandTelemetryPlugin):
+ plugin_name = "windows_location"
+
+ def __init__(self, sideband_core):
+ self.update_interval = 5.0
+ self.should_run = False
+
+ self.latitude = None
+ self.longitude = None
+ self.altitude = None
+ self.speed = None
+ self.bearing = None
+ self.accuracy = None
+ self.last_update = None
+
+ super().__init__(sideband_core)
+
+ def start(self):
+ RNS.log("Starting Windows Location provider plugin...")
+
+ self.should_run = True
+ update_thread = threading.Thread(target=self.update_job, daemon=True)
+ update_thread.start()
+
+ super().start()
+
+ def stop(self):
+ self.should_run = False
+ super().stop()
+
+ def update_job(self):
+ while self.should_run:
+ RNS.log("Updating location from Windows Geolocation...", RNS.LOG_DEBUG)
+ try:
+ asyncio.run(self.get_location())
+ except Exception as e:
+ RNS.log(f"Error getting location: {str(e)}", RNS.LOG_ERROR)
+
+ time.sleep(self.update_interval)
+
+ async def get_location(self):
+ geolocator = geolocation.Geolocator()
+ position = await geolocator.get_geoposition_async()
+
+ self.last_update = time.time()
+ self.latitude = position.coordinate.latitude
+ self.longitude = position.coordinate.longitude
+ self.altitude = position.coordinate.altitude
+ self.accuracy = position.coordinate.accuracy
+
+ # Note: Windows Geolocation doesn't provide speed and bearing directly
+ # You might need to calculate these from successive position updates
+ self.speed = None
+ self.bearing = None
+
+ def has_location(self):
+ return all([self.latitude, self.longitude, self.altitude, self.accuracy]) is not None
+
+ def update_telemetry(self, telemeter):
+ if self.is_running() and telemeter is not None:
+ if self.has_location():
+ RNS.log("Updating location from Windows Geolocation", RNS.LOG_DEBUG)
+ if "location" not in telemeter.sensors:
+ telemeter.synthesize("location")
+
+ telemeter.sensors["location"].latitude = self.latitude
+ telemeter.sensors["location"].longitude = self.longitude
+ telemeter.sensors["location"].altitude = self.altitude
+ telemeter.sensors["location"].speed = self.speed
+ telemeter.sensors["location"].bearing = self.bearing
+ telemeter.sensors["location"].accuracy = self.accuracy
+ telemeter.sensors["location"].stale_time = 5
+ telemeter.sensors["location"].set_update_time(self.last_update)
+
+ else:
+ RNS.log("No location from Windows Geolocation yet", RNS.LOG_DEBUG)
+
+# Finally, tell Sideband what class in this
+# file is the actual plugin class.
+plugin_class = WindowsLocationPlugin
\ No newline at end of file
diff --git a/docs/utilities/rns_audio_call_calc.py b/docs/utilities/rns_audio_call_calc.py
deleted file mode 100644
index 61bbfff..0000000
--- a/docs/utilities/rns_audio_call_calc.py
+++ /dev/null
@@ -1,129 +0,0 @@
-import os
-import math
-import RNS
-import RNS.vendor.umsgpack as mp
-
-def simulate(link_speed=9600, audio_slot_ms=70, codec_rate=1200, method="msgpack"):
- # Simulated on-air link speed
- LINK_SPEED = link_speed
-
- # Packing method, can be "msgpack" or "protobuf"
- PACKING_METHOD = method
-
- # The target audio slot time
- TARGET_MS = audio_slot_ms
-
- # Packets needed per second for half-duplex audio
- PACKETS_PER_SECOND = 1000/TARGET_MS
-
- # Effective audio encoder bitrate
- CODEC_RATE = codec_rate
-
- # Maximum number of supported audio modes
- MAX_ENUM = 127
-
- # Per-packet overhead on a established link is 19
- # bytes, 3 for header and context, 16 for link ID
- RNS_OVERHEAD = 19
-
- # Physical-layer overhead. For RNode, this is 1
- # byte per RNS packet.
- PHY_OVERHEAD = 1
-
- # Total transport overhead
- TRANSPORT_OVERHEAD = PHY_OVERHEAD+RNS_OVERHEAD
-
- # Calculate parameters
- AUDIO_LEN = int(math.ceil(CODEC_RATE/(1000/TARGET_MS)/8))
- PER_BYTE_LATENCY_MS = 1000/(LINK_SPEED/8)
-
- # Pack the message with msgpack to get real-
- # world packed message size
-
- if PACKING_METHOD == "msgpack":
- # Calculate msgpack overhead
- PL_LEN = len(mp.packb([MAX_ENUM, os.urandom(AUDIO_LEN)]))
- PACKING_OVERHEAD = PL_LEN-AUDIO_LEN
- elif PACKING_METHOD == "protobuf":
- # For protobuf, assume the 8 bytes of stated overhead
- PACKING_OVERHEAD = 8
- PL_LEN = AUDIO_LEN+PACKING_OVERHEAD
- else:
- print("Unsupported packing method")
- exit(1)
-
- # Calculate required encrypted token blocks
- BLOCKSIZE = 16
- REQUIRED_BLOCKS = math.ceil((PL_LEN+1)/BLOCKSIZE)
- ENCRYPTED_PAYLOAD_LEN = REQUIRED_BLOCKS*BLOCKSIZE
- BLOCK_HEADROOM = (REQUIRED_BLOCKS*BLOCKSIZE) - PL_LEN - 1
-
- # The complete on-air packet length
- PACKET_LEN = PHY_OVERHEAD+RNS_OVERHEAD+ENCRYPTED_PAYLOAD_LEN
- PACKET_LATENCY = round(PACKET_LEN*PER_BYTE_LATENCY_MS, 1)
-
- # TODO: This should include any additional
- # airtime consumption such as preamble and TX-tail.
- PACKET_AIRTIME = PACKET_LEN*PER_BYTE_LATENCY_MS
- AIRTIME_PCT = (PACKET_AIRTIME/TARGET_MS) * 100
-
- # Maximum amount of concurrent full-duplex
- # calls that can coexist on the same channel
- CONCURRENT_CALLS = math.floor(100/AIRTIME_PCT)
-
- # Calculate latencies
- TRANSPORT_LATENCY = round((PHY_OVERHEAD+RNS_OVERHEAD)*PER_BYTE_LATENCY_MS, 1)
-
- PAYLOAD_LATENCY = round(ENCRYPTED_PAYLOAD_LEN*PER_BYTE_LATENCY_MS, 1)
- RAW_DATA_LATENCY = round(AUDIO_LEN*PER_BYTE_LATENCY_MS, 1)
- PACKING_LATENCY = round(PACKING_OVERHEAD*PER_BYTE_LATENCY_MS, 1)
-
- DATA_LATENCY = round(ENCRYPTED_PAYLOAD_LEN*PER_BYTE_LATENCY_MS, 1)
- ENCRYPTION_LATENCY = round((ENCRYPTED_PAYLOAD_LEN-PL_LEN)*PER_BYTE_LATENCY_MS, 1)
- if ENCRYPTED_PAYLOAD_LEN-PL_LEN == 1:
- E_OPT_STR = "(optimal)"
- else:
- E_OPT_STR = "(sub-optimal)"
-
- TOTAL_LATENCY = round(TARGET_MS+PACKET_LATENCY, 1)
-
- print( "\n===== Simulation Parameters ===\n")
- print(f" Packing method : {method}")
- print(f" Sampling delay : {TARGET_MS}ms")
- print(f" Codec bitrate : {CODEC_RATE} bps")
- print(f" Audio data : {AUDIO_LEN} bytes")
- print(f" Packing overhead : {PACKING_OVERHEAD} bytes")
- print(f" Payload length : {PL_LEN} bytes")
- print(f" AES blocks needed : {REQUIRED_BLOCKS}")
- print(f" Encrypted payload : {ENCRYPTED_PAYLOAD_LEN} bytes")
- print(f" Transport overhead : {TRANSPORT_OVERHEAD} bytes ({RNS_OVERHEAD} from RNS, {PHY_OVERHEAD} from PHY)")
- print(f" On-air length : {PACKET_LEN} bytes")
- print(f" Packet airtime : {PACKET_AIRTIME}ms")
-
- print( "\n===== Results for "+RNS.prettyspeed(LINK_SPEED)+" Link Speed ===\n")
- print(f" Final latency : {TOTAL_LATENCY}ms")
- print(f" Recording latency : contributes {TARGET_MS}ms")
- print(f" Packet transport : contributes {PACKET_LATENCY}ms")
- print(f" Payload : contributes {PAYLOAD_LATENCY}ms")
- print(f" Audio data : contributes {RAW_DATA_LATENCY}ms")
- print(f" Packing format : contributes {PACKING_LATENCY}ms")
- print(f" Encryption : contributes {ENCRYPTION_LATENCY}ms {E_OPT_STR}")
- print(f" RNS+PHY overhead : contributes {TRANSPORT_LATENCY}ms")
- print(f"")
- print(f" Half-duplex airtime : {round(AIRTIME_PCT, 2)}% of link capacity")
- print(f" Concurrent calls : {int(CONCURRENT_CALLS)}\n")
- print(f" Full-duplex airtime : {round(AIRTIME_PCT*2, 2)}% of link capacity")
- print(f" Concurrent calls : {int(CONCURRENT_CALLS/2)}")
-
- if BLOCK_HEADROOM != 0:
- print("")
- print(f" !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
- print(f" Unaligned AES block! Each packet could fit")
- print(f" {BLOCK_HEADROOM} bytes of additional audio data")
- print(f" !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!")
-
-print( "\n= With mspack =================")
-simulate(method="msgpack")
-
-#print("\n\n= With protobuf ===============")
-#simulate(method="protobuf")
diff --git a/main.py b/main.py
new file mode 100644
index 0000000..8518858
--- /dev/null
+++ b/main.py
@@ -0,0 +1 @@
+import sbapp.main
\ No newline at end of file
diff --git a/sbapp/Makefile b/sbapp/Makefile
index a8c75b5..11bdb19 100644
--- a/sbapp/Makefile
+++ b/sbapp/Makefile
@@ -7,7 +7,7 @@ clean:
-(rm ./__pycache__ -r)
-(rm ./app_storage -r)
-(rm ./share/pkg/* -r)
- -(rm ./share/mirrors/* -r)
+ -(rm ./share/mirrors/* -rf)
-(rm ./bin -r)
cleanlibs:
@@ -64,13 +64,14 @@ fetchshare:
cp ../../dist_archive/lxmf-*-py3-none-any.whl ./share/pkg/
cp ../../dist_archive/nomadnet-*-py3-none-any.whl ./share/pkg/
cp ../../dist_archive/rnsh-*-py3-none-any.whl ./share/pkg/
-# cp ../../dist_archive/sbapp-*-py3-none-any.whl ./share/pkg/
cp ../../dist_archive/RNode_Firmware_*_Source.zip ./share/pkg/
zip --junk-paths ./share/pkg/example_plugins.zip ../docs/example_plugins/*.py
cp -r ../../dist_archive/reticulum.network ./share/mirrors/
cp -r ../../dist_archive/unsigned.io ./share/mirrors/
cp ../../dist_archive/Reticulum\ Manual.pdf ./share/mirrors/Reticulum_Manual.pdf
cp ../../dist_archive/Reticulum\ Manual.epub ./share/mirrors/Reticulum_Manual.epub
+ cp -r ../../rnode-flasher ./share/mirrors/
+ -(rm ./share/mirrors/rnode-flasher/.git -rf)
release:
buildozer android release
@@ -96,7 +97,11 @@ getrns:
-(rm ./RNS/__pycache__ -r)
(cp -rv ../../LXMF/LXMF ./;rm ./LXMF/Utilities/LXMF)
-(rm ./LXMF/__pycache__ -r)
+ (cp -rv ../../LXST/LXST ./;rm ./LXST/Utilities/LXST)
+ -(rm ./LXST/__pycache__ -r)
+ -(rm ./LXST/Utilities/__pycache__ -r)
cleanrns:
-(rm ./RNS -r)
-(rm ./LXMF -r)
+ -(rm ./LXST -r)
diff --git a/sbapp/assets/audio/notifications/ringer.opus b/sbapp/assets/audio/notifications/ringer.opus
new file mode 100644
index 0000000..36d0094
Binary files /dev/null and b/sbapp/assets/audio/notifications/ringer.opus differ
diff --git a/sbapp/assets/audio/notifications/soft1.opus b/sbapp/assets/audio/notifications/soft1.opus
new file mode 100644
index 0000000..6e3d792
Binary files /dev/null and b/sbapp/assets/audio/notifications/soft1.opus differ
diff --git a/sbapp/assets/fonts/BigBlueTerm437NerdFont-Regular.ttf b/sbapp/assets/fonts/BigBlueTerm437NerdFont-Regular.ttf
new file mode 100644
index 0000000..256563d
Binary files /dev/null and b/sbapp/assets/fonts/BigBlueTerm437NerdFont-Regular.ttf differ
diff --git a/sbapp/assets/fonts/RobotoMonoNerdFont-Regular.ttf b/sbapp/assets/fonts/RobotoMonoNerdFont-Regular.ttf
new file mode 100644
index 0000000..11b95d3
Binary files /dev/null and b/sbapp/assets/fonts/RobotoMonoNerdFont-Regular.ttf differ
diff --git a/sbapp/assets/io.unsigned.sideband.desktop b/sbapp/assets/io.unsigned.sideband.desktop
index 6a7d437..c2d8223 100644
--- a/sbapp/assets/io.unsigned.sideband.desktop
+++ b/sbapp/assets/io.unsigned.sideband.desktop
@@ -1,4 +1,4 @@
-# Entry version 20240630
+# Entry version 20241128
[Desktop Entry]
Comment[en_US]=Messaging, telemetry and remote control over LXMF
Comment=Messaging, telemetry and remote control over LXMF
@@ -6,7 +6,7 @@ Encoding=UTF-8
Exec=sideband
GenericName[en_US]=LXMF client
GenericName=LXMF client
-Icon=io.unsigned.sideband.png
+Icon=io.unsigned.sideband
Categories=Utility
MimeType=
Name[en_US]=Sideband
diff --git a/sbapp/buildozer.spec b/sbapp/buildozer.spec
index 4c92699..f970683 100644
--- a/sbapp/buildozer.spec
+++ b/sbapp/buildozer.spec
@@ -10,9 +10,9 @@ source.exclude_patterns = app_storage/*,venv/*,Makefile,./Makefil*,requirements,
version.regex = __version__ = ['"](.*)['"]
version.filename = %(source.dir)s/main.py
-android.numeric_version = 20241013
+android.numeric_version = 20250327
-requirements = kivy==2.3.0,libbz2,pillow==10.2.0,qrcode==7.3.1,usb4a,usbserial4a,able_recipe,libwebp,libogg,libopus,opusfile,numpy,cryptography,ffpyplayer,codec2,pycodec2,sh,pynacl,typing-extensions
+requirements = kivy==2.3.0,libbz2,pillow==10.2.0,qrcode==7.3.1,usb4a,usbserial4a,able_recipe,libwebp,libogg,libopus,opusfile,numpy,cryptography,ffpyplayer,codec2,pycodec2,sh,pynacl,typing-extensions,mistune>=3.0.2,beautifulsoup4
android.gradle_dependencies = com.android.support:support-compat:28.0.0
#android.enable_androidx = True
diff --git a/sbapp/freeze.py b/sbapp/freeze.py
index 81f5ad8..8a7c498 100644
--- a/sbapp/freeze.py
+++ b/sbapp/freeze.py
@@ -30,10 +30,13 @@ def get_variant() -> str:
version = re.findall(version_regex, version_file_data, re.M)[0]
return version
except IndexError:
- raise ValueError(f"Unable to find version string in {version_file}.")
+ return None
__version__ = get_version()
__variant__ = get_variant()
+variant_str = ""
+if __variant__:
+ variant_str = " "+__variant__
def glob_paths(pattern):
out_files = []
@@ -60,14 +63,14 @@ package_data = {
]
}
-print("Freezing Sideband "+__version__+" "+__variant__)
+print("Freezing Sideband "+__version__+" "+variant_str)
if build_appimage:
global_excludes = [".buildozer", "build", "dist"]
# Dependencies are automatically detected, but they might need fine-tuning.
appimage_options = {
"target_name": "Sideband",
- "target_version": __version__+" "+__variant__,
+ "target_version": __version__+" "+variant_str,
"include_files": [],
"excludes": [],
"packages": ["kivy"],
diff --git a/sbapp/kivymd/images/folder.png b/sbapp/kivymd/images/folder.png
index fe0ed5b..0e50084 100644
Binary files a/sbapp/kivymd/images/folder.png and b/sbapp/kivymd/images/folder.png differ
diff --git a/sbapp/kivymd/images/folder_orange.png b/sbapp/kivymd/images/folder_orange.png
new file mode 100644
index 0000000..fe0ed5b
Binary files /dev/null and b/sbapp/kivymd/images/folder_orange.png differ
diff --git a/sbapp/main.py b/sbapp/main.py
index 3184b6a..46e7d0b 100644
--- a/sbapp/main.py
+++ b/sbapp/main.py
@@ -1,6 +1,6 @@
__debug_build__ = False
__disable_shaders__ = False
-__version__ = "1.1.3"
+__version__ = "1.7.0"
__variant__ = ""
import sys
@@ -8,7 +8,9 @@ import argparse
parser = argparse.ArgumentParser(description="Sideband LXMF Client")
parser.add_argument("-v", "--verbose", action='store_true', default=False, help="increase logging verbosity")
parser.add_argument("-c", "--config", action='store', default=None, help="specify path of config directory")
+parser.add_argument("-r", "--rnsconfig", action='store', default=None, help="specify path of RNS config directory")
parser.add_argument("-d", "--daemon", action='store_true', default=False, help="run as a daemon, without user interface")
+parser.add_argument("-i", "--interactive", action='store_true', default=False, help="connect interactive console after daemon init")
parser.add_argument("--export-settings", action='store', default=None, help="export application settings to file")
parser.add_argument("--import-settings", action='store', default=None, help="import application settings from file")
parser.add_argument("--version", action="version", version="sideband {version}".format(version=__version__))
@@ -19,11 +21,60 @@ import RNS
import LXMF
import time
import os
+import re
import pathlib
import base64
import threading
import RNS.vendor.umsgpack as msgpack
+WINDOW_DEFAULT_WIDTH = 494
+WINDOW_DEFAULT_HEIGHT = 800
+
+app_ui_scaling_path = None
+def apply_ui_scale():
+ global app_ui_scaling_path
+ default_scale = os.environ["KIVY_METRICS_DENSITY"] if "KIVY_METRICS_DENSITY" in os.environ else "unknown"
+ config_path = None
+ ui_scale_path = None
+
+ try:
+ if RNS.vendor.platformutils.is_android():
+ import plyer
+ ui_scale_path = plyer.storagepath.get_application_dir()+"/io.unsigned.sideband/files/app_storage/ui_scale"
+ else:
+ if config_path == None:
+ import sbapp.plyer as plyer
+ ui_scale_path = plyer.storagepath.get_home_dir()+"/.config/sideband/app_storage/ui_scale"
+ if ui_scale_path.startswith("file://"):
+ ui_scale_path = ui_scale_path.replace("file://", "")
+ else:
+ ui_scale_path = config_path+"/app_storage/ui_scale"
+
+ app_ui_scaling_path = ui_scale_path
+
+ except Exception as e:
+ RNS.log(f"Error while locating UI scale file: {e}", RNS.LOG_ERROR)
+
+ if ui_scale_path != None:
+ RNS.log("Default scaling factor on this platform is "+str(default_scale), RNS.LOG_NOTICE)
+ try:
+ RNS.log("Looking for scaling info in "+str(ui_scale_path))
+ if os.path.isfile(ui_scale_path):
+ scale_factor = None
+ with open(ui_scale_path, "r") as sf:
+ scale_factor = float(sf.readline())
+
+ if scale_factor != None:
+ if scale_factor >= 0.3 and scale_factor <= 5.0:
+ os.environ["KIVY_METRICS_DENSITY"] = str(scale_factor)
+ RNS.log("UI scaling factor set to "+str(os.environ["KIVY_METRICS_DENSITY"]), RNS.LOG_NOTICE)
+ elif scale_factor == 0.0:
+ RNS.log("Using default UI scaling factor", RNS.LOG_NOTICE)
+
+
+ except Exception as e:
+ RNS.log(f"Error while reading UI scaling factor: {e}", RNS.LOG_ERROR)
+
if args.export_settings:
from .sideband.core import SidebandCore
sideband = SidebandCore(
@@ -126,6 +177,27 @@ if not args.daemon:
local = os.path.dirname(__file__)
sys.path.append(local)
+ if not RNS.vendor.platformutils.is_android():
+ model = None
+ max_width = WINDOW_DEFAULT_WIDTH
+ max_height = WINDOW_DEFAULT_HEIGHT
+
+ try:
+ if os.path.isfile("/sys/firmware/devicetree/base/model"):
+ with open("/sys/firmware/devicetree/base/model", "r") as mf:
+ model = mf.read()
+ except: pass
+
+ if model:
+ if model.startswith("Raspberry Pi "): max_height = 625
+
+ window_width = min(WINDOW_DEFAULT_WIDTH, max_width)
+ window_height = min(WINDOW_DEFAULT_HEIGHT, max_height)
+
+ from kivy.config import Config
+ Config.set("graphics", "width", str(window_width))
+ Config.set("graphics", "height", str(window_height))
+
if args.daemon:
from .sideband.core import SidebandCore
class DaemonElement():
@@ -143,9 +215,11 @@ if args.daemon:
NewConv = DaemonElement; Telemetry = DaemonElement; ObjectDetails = DaemonElement; Announces = DaemonElement;
Messages = DaemonElement; ts_format = DaemonElement; messages_screen_kv = DaemonElement; plyer = DaemonElement; multilingual_markup = DaemonElement;
ContentNavigationDrawer = DaemonElement; DrawerList = DaemonElement; IconListItem = DaemonElement; escape_markup = DaemonElement;
- SoundLoader = DaemonElement;
+ SoundLoader = DaemonElement; BoxLayout = DaemonElement; mdconv = DaemonElement;
else:
+ apply_ui_scale()
+
from kivymd.app import MDApp
app_superclass = MDApp
from kivy.core.window import Window
@@ -157,6 +231,7 @@ else:
from kivy.effects.scroll import ScrollEffect
from kivy.uix.screenmanager import ScreenManager
from kivy.uix.screenmanager import FadeTransition, NoTransition, SlideTransition
+ from kivy.uix.boxlayout import BoxLayout
from kivymd.uix.list import OneLineIconListItem, IconLeftWidget
from kivy.properties import StringProperty
from kivymd.uix.button import BaseButton, MDIconButton
@@ -181,6 +256,8 @@ else:
from ui.layouts import *
from ui.conversations import Conversations, MsgSync, NewConv
from ui.telemetry import Telemetry
+ from ui.utilities import Utilities
+ from ui.voice import Voice
from ui.objectdetails import ObjectDetails
from ui.announces import Announces
from ui.messages import Messages, ts_format, messages_screen_kv
@@ -200,6 +277,9 @@ else:
from kivymd.utils.set_bars_colors import set_bars_colors
android_api_version = autoclass('android.os.Build$VERSION').SDK_INT
+ from android.broadcast import BroadcastReceiver
+ BluetoothAdapter = autoclass('android.bluetooth.BluetoothAdapter')
+
else:
from .sideband.core import SidebandCore
import sbapp.plyer as plyer
@@ -208,6 +288,8 @@ else:
from .ui.conversations import Conversations, MsgSync, NewConv
from .ui.announces import Announces
from .ui.telemetry import Telemetry
+ from .ui.utilities import Utilities
+ from .ui.voice import Voice
from .ui.objectdetails import ObjectDetails
from .ui.messages import Messages, ts_format, messages_screen_kv
from .ui.helpers import ContentNavigationDrawer, DrawerList, IconListItem
@@ -216,9 +298,7 @@ else:
import sbapp.pyogg as pyogg
from sbapp.pydub import AudioSegment
- class toast:
- def __init__(self, *kwargs):
- pass
+ from kivymd.toast import toast
from kivy.config import Config
Config.set('input', 'mouse', 'mouse,disable_multitouch')
@@ -270,7 +350,7 @@ class SidebandApp(MDApp):
if RNS.vendor.platformutils.get_platform() == "android":
self.sideband = SidebandCore(self, config_path=self.config_path, is_client=True, android_app_dir=self.app_dir, verbose=__debug_build__)
else:
- self.sideband = SidebandCore(self, config_path=self.config_path, is_client=False, verbose=(args.verbose or __debug_build__))
+ self.sideband = SidebandCore(self, config_path=self.config_path, is_client=False, verbose=(args.verbose or __debug_build__),rns_config_path=args.rnsconfig)
self.sideband.version_str = "v"+__version__+" "+__variant__
@@ -294,6 +374,8 @@ class SidebandApp(MDApp):
self.sync_dialog = None
self.settings_ready = False
self.telemetry_ready = False
+ self.utilities_ready = False
+ self.voice_ready = False
self.connectivity_ready = False
self.hardware_ready = False
self.repository_ready = False
@@ -306,9 +388,11 @@ class SidebandApp(MDApp):
self.service_last_available = 0
self.closing_app = False
+ self.file_manager = None
self.attach_path = None
self.attach_type = None
self.attach_dialog = None
+ self.shared_attach_dialog = None
self.rec_dialog = None
self.last_msg_audio = None
self.msg_sound = None
@@ -324,8 +408,12 @@ class SidebandApp(MDApp):
self.connectivity_updater = None
self.last_map_update = 0
self.last_telemetry_received = 0
- self.reposository_url = None
+ self.repository_url = None
+ self.rnode_flasher_url = None
+ self.bt_adapter = None
+ self.discovered_bt_devices = {}
+ self.bt_bonded_devices = []
#################################################
# Application Startup #
@@ -379,6 +467,67 @@ class SidebandApp(MDApp):
argument = self.app_dir
self.android_service.start(mActivity, argument)
+ def stop_service(self):
+ RNS.log("Stopping service...")
+ self.sideband.setstate("wants.service_stop", True)
+ while self.sideband.service_available(): time.sleep(0.2)
+ RNS.log("Service stopped")
+
+ def restart_service_action(self, sender):
+ if hasattr(self, "service_restarting") and self.service_restarting == True:
+ toast(f"Service restart already in progress")
+ else:
+ toast(f"Restarting RNS service...")
+ if hasattr(self, "connectivity_screen") and self.connectivity_screen != None:
+ self.connectivity_screen.ids.button_service_restart.disabled = True
+ def job():
+ if self.restart_service():
+ def tj(delta_time):
+ toast(f"Service restarted successfully!")
+ if hasattr(self, "connectivity_screen") and self.connectivity_screen != None:
+ self.connectivity_screen.ids.button_service_restart.disabled = False
+ Clock.schedule_once(tj, 0.1)
+ else:
+ def tj(delta_time):
+ toast(f"Service restart failed")
+ if hasattr(self, "connectivity_screen") and self.connectivity_screen != None:
+ self.connectivity_screen.ids.button_service_restart.disabled = False
+ Clock.schedule_once(tj, 0.1)
+
+ threading.Thread(target=job, daemon=True).start()
+
+ def restart_service(self):
+ if hasattr(self, "service_restarting") and self.service_restarting == True:
+ return False
+ else:
+ self.service_restarting = True
+ self.stop_service()
+ RNS.log("Waiting for service shutdown", RNS.LOG_DEBUG)
+ while self.sideband.service_rpc_request({"getstate": "service.heartbeat"}):
+ time.sleep(1)
+ time.sleep(4)
+
+ self.final_load_completed = False
+ self.sideband.service_stopped = True
+
+ RNS.log("Starting service...", RNS.LOG_DEBUG)
+ self.start_service()
+ RNS.log("Waiting for service restart...", RNS.LOG_DEBUG)
+ restart_timeout = time.time() + 45
+ while not self.sideband.service_rpc_request({"getstate": "service.heartbeat"}):
+ self.sideband.rpc_connection = None
+ time.sleep(1)
+ if time.time() > restart_timeout:
+ service_restarting = False
+ return False
+
+ RNS.log("Service restarted", RNS.LOG_DEBUG)
+ self.sideband.service_stopped = False
+ self.final_load_completed = True
+ self.service_restarting = False
+
+ return True
+
def start_final(self):
# Start local core instance
self.sideband.start()
@@ -505,6 +654,15 @@ class SidebandApp(MDApp):
fn_italic=fb_path+"NotoSans-Italic.ttf",
fn_bolditalic=fb_path+"NotoSans-BoldItalic.ttf")
+ LabelBase.register(name="mono",
+ fn_regular=fb_path+"RobotoMonoNerdFont-Regular.ttf")
+
+ LabelBase.register(name="term",
+ fn_regular=fb_path+"BigBlueTerm437NerdFont-Regular.ttf")
+
+ LabelBase.register(name="nf",
+ fn_regular=fb_path+"RobotoMonoNerdFont-Regular.ttf")
+
def update_input_language(self):
language = self.sideband.config["input_language"]
if language == None:
@@ -699,6 +857,13 @@ class SidebandApp(MDApp):
else:
RNS.log("Conversations view did not exist", RNS.LOG_DEBUG)
+ def ui_update_job():
+ time.sleep(0.05)
+ def cb(dt):
+ self.perform_wake_update()
+ Clock.schedule_once(cb, 0.1)
+ threading.Thread(target=ui_update_job, daemon=True).start()
+
RNS.log("App resumed", RNS.LOG_DEBUG)
def on_stop(self):
@@ -714,6 +879,21 @@ class SidebandApp(MDApp):
else:
return False
+ def perform_wake_update(self):
+ # This workaround mitigates a bug in Kivy on Android
+ # which causes the UI to turn black on app resume,
+ # probably due to an invalid GL draw context. By
+ # simply opening and immediately closing the nav
+ # drawer, we force the UI to do a frame redraw, which
+ # results in the UI actually being visible again.
+ if RNS.vendor.platformutils.is_android():
+ RNS.log("Performing app wake UI update", RNS.LOG_DEBUG)
+ self.root.ids.nav_drawer.set_state("open")
+ def cb(dt):
+ self.root.ids.nav_drawer.set_state("closed")
+ Clock.schedule_once(cb, 0)
+
+
def check_bluetooth_permissions(self):
if RNS.vendor.platformutils.get_platform() == "android":
mActivity = autoclass('org.kivy.android.PythonActivity').mActivity
@@ -834,6 +1014,66 @@ class SidebandApp(MDApp):
self.check_bluetooth_permissions()
+ def bluetooth_update_bonded_devices(self, sender=None):
+ if self.bt_adapter == None: self.bt_adapter = BluetoothAdapter.getDefaultAdapter()
+ self.bt_bonded_devices = []
+ for device in self.bt_adapter.getBondedDevices():
+ device_addr = device.getAddress()
+ self.bt_bonded_devices.append(device_addr)
+
+ RNS.log(f"Updated bonded devices: {self.bt_bonded_devices}", RNS.LOG_DEBUG)
+
+ def bluetooth_scan_action(self, sender=None):
+ toast("Starting Bluetooth scan...")
+ self.start_bluetooth_scan()
+
+ def start_bluetooth_scan(self):
+ self.check_bluetooth_permissions()
+ if not self.sideband.getpersistent("permissions.bluetooth"):
+ self.request_bluetooth_permissions()
+ else:
+ RNS.log("Starting bluetooth scan", RNS.LOG_DEBUG)
+ self.discovered_bt_devices = {}
+
+ BluetoothDevice = autoclass('android.bluetooth.BluetoothDevice')
+ self.bt_found_action = BluetoothDevice.ACTION_FOUND
+ self.broadcast_receiver = BroadcastReceiver(self.on_broadcast, actions=[self.bt_found_action])
+ self.broadcast_receiver.start()
+
+ self.bt_adapter = BluetoothAdapter.getDefaultAdapter()
+ self.bluetooth_update_bonded_devices()
+ self.bt_adapter.startDiscovery()
+
+ def stop_bluetooth_scan(self):
+ RNS.log("Stopping bluetooth scan", RNS.LOG_DEBUG)
+ self.check_bluetooth_permissions()
+ if not self.sideband.getpersistent("permissions.bluetooth"):
+ self.request_bluetooth_permissions()
+ else:
+ self.bt_adapter = BluetoothAdapter.getDefaultAdapter()
+ self.bt_adapter.cancelDiscovery()
+
+ def on_broadcast(self, context, intent):
+ BluetoothDevice = autoclass('android.bluetooth.BluetoothDevice')
+ action = intent.getAction()
+ extras = intent.getExtras()
+
+ if str(action) == "android.bluetooth.device.action.FOUND":
+ if extras:
+ try:
+ if android_api_version < 33: device = intent.getParcelableExtra("android.bluetooth.device.extra.DEVICE")
+ else: device = intent.getParcelableExtra("android.bluetooth.device.extra.DEVICE", BluetoothDevice)
+ dev_name = device.getName()
+ dev_addr = device.getAddress()
+ if dev_name.startswith("RNode "):
+ dev_rssi = extras.getShort("android.bluetooth.device.extra.RSSI", -9999)
+ discovered_device = {"name": dev_name, "address": dev_addr, "rssi": dev_rssi, "discovered": time.time()}
+ self.discovered_bt_devices[dev_addr] = discovered_device
+ RNS.log(f"Discovered RNode: {discovered_device}", RNS.LOG_DEBUG)
+
+ except Exception as e:
+ RNS.log(f"Error while mapping discovered device: {e}", RNS.LOG_ERROR)
+
def on_new_intent(self, intent):
intent_action = intent.getAction()
action = None
@@ -870,6 +1110,37 @@ class SidebandApp(MDApp):
if data.lower().startswith(LXMF.LXMessage.URI_SCHEMA):
action = "lxm_uri"
+ if intent_action == "android.intent.action.SEND":
+ try:
+ Intent = autoclass("android.content.Intent")
+ extras = intent.getExtras()
+ target = extras.get(Intent.EXTRA_STREAM)
+ mime_types = extras.get(Intent.EXTRA_MIME_TYPES)
+ target_uri = target.toString()
+ target_path = target.getPath()
+ target_filename = target.getLastPathSegment()
+
+ RNS.log(f"Received share intent: {target_uri} / {target_path} / {target_filename}", RNS.LOG_DEBUG)
+ for cf in os.listdir(self.sideband.share_cache):
+ rt = os.path.join(self.sideband.share_cache, cf)
+ os.unlink(rt)
+ RNS.log("Removed previously cached data: "+str(rt), RNS.LOG_DEBUG)
+
+ ContentResolver = autoclass("android.content.ContentResolver")
+ cr = mActivity.getContentResolver()
+ cache_path = os.path.join(self.sideband.share_cache, target_filename)
+ input_stream = cr.openInputStream(target)
+ with open(cache_path, "wb") as cache_file:
+ cache_file.write(bytes(input_stream.readAllBytes()))
+ RNS.log("Cached shared data from Android intent", RNS.LOG_DEBUG)
+
+ action = "shared_data"
+ data = {"filename": target_filename, "data_path": cache_path}
+
+ except Exception as e:
+ RNS.log(f"Error while getting intent action data: {e}", RNS.LOG_ERROR)
+ RNS.trace_exception(e)
+
if action != None:
self.handle_action(action, data)
@@ -877,6 +1148,16 @@ class SidebandApp(MDApp):
if action == "lxm_uri":
self.ingest_lxm_uri(data)
+ if action == "shared_data":
+ RNS.log("Got shared data: "+str(data))
+ def cb(dt):
+ try:
+ self.shared_attachment_action(data)
+ except Exception as e:
+ RNS.log("Error while handling external message attachment", RNS.LOG_ERROR)
+ RNS.trace_exception(e)
+ Clock.schedule_once(cb, 0.1)
+
def ingest_lxm_uri(self, lxm_uri):
RNS.log("Ingesting LXMF paper message from URI: "+str(lxm_uri), RNS.LOG_DEBUG)
self.sideband.lxm_ingest_uri(lxm_uri)
@@ -944,22 +1225,35 @@ class SidebandApp(MDApp):
description = rnode_errors["description"]
self.sideband.setpersistent("runtime.errors.rnode", None)
yes_button = MDRectangleFlatButton(
- text="OK",
+ text="Ignore",
+ font_size=dp(18),
+ )
+ restart_button = MDRectangleFlatButton(
+ text="Restart RNS",
font_size=dp(18),
)
self.hw_error_dialog = MDDialog(
title="Hardware Error",
text="While communicating with an RNode, Reticulum reported the following error:\n\n[i]"+str(description)+"[/i]",
- buttons=[ yes_button ],
+ buttons=[ yes_button, restart_button ],
# elevation=0,
)
def dl_yes(s):
self.hw_error_dialog.dismiss()
self.hw_error_dialog.is_open = False
+ def dl_restart(s):
+ self.hw_error_dialog.dismiss()
+ self.hw_error_dialog.is_open = False
+ self.restart_service_action(None)
yes_button.bind(on_release=dl_yes)
+ restart_button.bind(on_release=dl_restart)
self.hw_error_dialog.open()
self.hw_error_dialog.is_open = True
+ incoming_call = self.sideband.getstate("voice.incoming_call")
+ if incoming_call:
+ self.sideband.setstate("voice.incoming_call", None)
+ toast(f"Call from {incoming_call}", duration=7)
if self.root.ids.screen_manager.current == "messages_screen":
self.messages_view.update()
@@ -1064,6 +1358,9 @@ class SidebandApp(MDApp):
self.quit_action(None)
return True
+ def file_dropped(self, window, file_path, x, y, *args):
+ self.shared_attachment_action({"data_path": file_path.decode("utf-8")})
+
def on_start(self):
self.last_exit_event = time.time()
self.root.ids.screen_manager.transition = self.slide_transition
@@ -1074,6 +1371,7 @@ class SidebandApp(MDApp):
EventLoop.window.bind(on_key_down=self.keydown_event)
EventLoop.window.bind(on_key_up=self.keyup_event)
Window.bind(on_request_close=self.close_requested)
+ Window.bind(on_drop_file=self.file_dropped)
if __variant__ != "":
variant_str = " "+__variant__
@@ -1129,13 +1427,13 @@ class SidebandApp(MDApp):
self.messages_view.ids.message_text.write_tab = True
Clock.schedule_once(tab_job, 0.15)
- elif self.rec_dialog != None and self.rec_dialog_is_open:
+ elif len(modifiers) == 0 and self.rec_dialog != None and self.rec_dialog_is_open:
if text == " ":
self.msg_rec_a_rec(None)
elif keycode == 40:
self.msg_rec_a_save(None)
- elif not self.rec_dialog_is_open and not self.messages_view.ids.message_text.focus and self.messages_view.ptt_enabled and keycode == 44:
+ elif len(modifiers) == 0 and not self.rec_dialog_is_open and not self.messages_view.ids.message_text.focus and self.messages_view.ptt_enabled and keycode == 44:
if not self.key_ptt_down:
self.key_ptt_down = True
self.message_ptt_down_action()
@@ -1180,6 +1478,8 @@ class SidebandApp(MDApp):
self.close_sub_telemetry_action()
elif self.root.ids.screen_manager.current == "icons_screen":
self.close_sub_telemetry_action()
+ elif self.root.ids.screen_manager.current == "utilities_screen":
+ self.close_sub_utilities_action()
else:
self.open_conversations(direction="right")
@@ -1219,12 +1519,24 @@ class SidebandApp(MDApp):
else:
self.telemetry_action(self)
- if text == "u":
+ if text == "y":
self.map_display_own_telemetry()
+ if text == "u":
+ self.utilities_action()
+
if text == "o":
self.objects_action()
+ if text == "e":
+ self.voice_action()
+
+ if text == " ":
+ self.voice_answer_action()
+
+ if text == ".":
+ self.voice_reject_action()
+
if text == "r":
if self.root.ids.screen_manager.current == "conversations_screen":
if self.include_objects:
@@ -1233,6 +1545,8 @@ class SidebandApp(MDApp):
self.lxmf_sync_action(self)
elif self.root.ids.screen_manager.current == "telemetry_screen":
self.conversations_action(self, direction="right")
+ elif self.root.ids.screen_manager.current == "rnstatus_screen":
+ self.utilities_screen.update_rnstatus()
elif self.root.ids.screen_manager.current == "object_details_screen":
if not self.object_details_screen.object_hash == self.sideband.lxmf_destination.hash:
self.converse_from_telemetry(self)
@@ -1277,6 +1591,12 @@ class SidebandApp(MDApp):
self.close_sub_telemetry_action()
elif self.root.ids.screen_manager.current == "icons_screen":
self.close_sub_telemetry_action()
+ elif self.root.ids.screen_manager.current == "rnstatus_screen":
+ self.close_sub_utilities_action()
+ elif self.root.ids.screen_manager.current == "logviewer_screen":
+ self.close_sub_utilities_action()
+ elif self.root.ids.screen_manager.current == "voice_settings_screen":
+ self.close_sub_voice_action()
else:
self.open_conversations(direction="right")
@@ -1354,6 +1674,7 @@ class SidebandApp(MDApp):
def announce_now_action(self, sender=None):
self.sideband.lxmf_announce()
+ if self.sideband.telephone: self.sideband.telephone.announce()
yes_button = MDRectangleFlatButton(text="OK",font_size=dp(18))
@@ -1376,6 +1697,58 @@ class SidebandApp(MDApp):
### Messages (conversation) screen
######################################
+
+ def md_to_bbcode(self, text):
+ if not hasattr(self, "mdconv"):
+ if RNS.vendor.platformutils.is_android(): from md import mdconv
+ else: from .md import mdconv
+ self.mdconv = mdconv
+
+ converted = self.mdconv(text)
+ while converted.endswith("\n"):
+ converted = converted[:-1]
+
+ return converted
+
+ def process_bb_markup(self, text):
+ st = time.time()
+ ms = int(sp(14))
+ h1s = int(sp(20))
+ h2s = int(sp(18))
+ h3s = int(sp(16))
+
+ if not hasattr(self, "pres"):
+ self.presz = re.compile(r"\[(?:size=\d*?)\]", re.IGNORECASE | re.MULTILINE )
+ self.pres = []
+ res = [ [r"\[(?:code|icode).*?\]", f"[font=mono][size={ms}]"],
+ [r"\[\/(?:code|icode).*?\]", "[/size][/font]"],
+ [r"\[(?:heading)\]", f"[b][size={h1s}]"],
+ [r"\[(?:heading=1)*?\]", f"[b][size={h1s}]"],
+ [r"\[(?:heading=2)*?\]", f"[b][size={h2s}]"],
+ [r"\[(?:heading=3)*?\]", f"[b][size={h3s}]"],
+ [r"\[(?:heading=).*?\]", f"[b][size={h3s}]"], # Match all remaining lower-level headings
+ [r"\[\/(?:heading).*?\]", "[/size][/b]"],
+ [r"\[(?:list).*?\]", ""],
+ [r"\[\/(?:list).*?\]", ""],
+ [r"\n\[(?:\*).*?\]", "\n - "],
+ [r"\[(?:url).*?\]", ""], # Strip URLs for now
+ [r"\[\/(?:url).*?\]", ""],
+ [r"\[(?:img).*?\].*\[\/(?:img).*?\]", ""] # Strip images for now
+ ]
+
+ for r in res:
+ self.pres.append([re.compile(r[0], re.IGNORECASE | re.MULTILINE ), r[1]])
+
+
+ size_matches = self.presz.findall(text)
+ for sm in size_matches:
+ text = text.replace(sm, f"{sm[:-1]}sp]")
+
+ for pr in self.pres:
+ text = pr[0].sub(pr[1], text)
+
+ return text
+
def conversation_from_announce_action(self, context_dest):
if self.sideband.has_conversation(context_dest):
pass
@@ -1394,13 +1767,17 @@ class SidebandApp(MDApp):
self.conversation_action(item)
def conversation_action(self, sender):
- context_dest = sender.sb_uid
- def cb(dt):
- self.open_conversation(context_dest)
- def cbu(dt):
- self.conversations_view.update()
- Clock.schedule_once(cb, 0.15)
- Clock.schedule_once(cbu, 0.15+0.25)
+ if sender.conv_type == self.sideband.CONV_P2P:
+ context_dest = sender.sb_uid
+ def cb(dt): self.open_conversation(context_dest)
+ def cbu(dt): self.conversations_view.update()
+ Clock.schedule_once(cb, 0.15)
+ Clock.schedule_once(cbu, 0.15+0.25)
+
+ elif sender.conv_type == self.sideband.CONV_VOICE:
+ identity_hash = sender.sb_uid
+ def cb(dt): self.dial_action(identity_hash)
+ Clock.schedule_once(cb, 0.15)
def open_conversation(self, context_dest, direction="left"):
self.rec_dialog_is_open = False
@@ -1462,14 +1839,12 @@ class SidebandApp(MDApp):
if self.outbound_mode_command:
return
- def cb(dt):
- self.message_send_dispatch(sender)
+ def cb(dt): self.message_send_dispatch(sender)
Clock.schedule_once(cb, 0.20)
def message_send_dispatch(self, sender=None):
self.messages_view.ids.message_send_button.disabled = True
- def cb(dt):
- self.messages_view.ids.message_send_button.disabled = False
+ def cb(dt): self.messages_view.ids.message_send_button.disabled = False
Clock.schedule_once(cb, 0.5)
if self.root.ids.screen_manager.current == "messages_screen":
@@ -1618,6 +1993,11 @@ class SidebandApp(MDApp):
if self.root.ids.screen_manager.current == "messages_screen":
self.object_details_action(self.messages_view, from_conv=True)
+ def outbound_mode_reset(self, sender=None):
+ self.outbound_mode_paper = False
+ self.outbound_mode_propagation = False
+ self.outbound_mode_command = False
+
def message_propagation_action(self, sender):
if self.outbound_mode_command:
self.outbound_mode_paper = False
@@ -1647,18 +2027,10 @@ class SidebandApp(MDApp):
tf = open(path, "rb")
tf.close()
self.attach_path = path
+ if self.outbound_mode_command:
+ self.outbound_mode_reset()
- if RNS.vendor.platformutils.is_android():
- toast("Attached \""+str(fbn)+"\"")
- else:
- ok_button = MDRectangleFlatButton(text="OK",font_size=dp(18))
- ate_dialog = MDDialog(
- title="File Attached",
- text="The file \""+str(fbn)+"\" was attached, and will be included with the next message sent.",
- buttons=[ ok_button ],
- )
- ok_button.bind(on_release=ate_dialog.dismiss)
- ate_dialog.open()
+ toast("Attached \""+str(fbn)+"\"")
except Exception as e:
RNS.log(f"Error while attaching \"{fbn}\": "+str(e), RNS.LOG_ERROR)
@@ -1679,7 +2051,8 @@ class SidebandApp(MDApp):
def message_fm_exited(self, *args):
self.manager_open = False
- self.file_manager.close()
+ if self.file_manager != None:
+ self.file_manager.close()
def message_select_file_action(self, sender=None):
perm_ok = False
@@ -1694,11 +2067,20 @@ class SidebandApp(MDApp):
if perm_ok and path != None:
try:
- self.file_manager = MDFileManager(
- exit_manager=self.message_fm_exited,
- select_path=self.message_fm_got_path,
- )
- # self.file_manager.ext = ["*"]
+ if self.attach_type in ["lbimg", "defimg", "hqimg"]:
+ self.file_manager = MDFileManager(
+ exit_manager=self.message_fm_exited,
+ select_path=self.message_fm_got_path,
+ # Current KivyMD preview implementation is too slow to be reliable on Android
+ preview=False)
+ else:
+ self.file_manager = MDFileManager(
+ exit_manager=self.message_fm_exited,
+ select_path=self.message_fm_got_path,
+ preview=False)
+
+ # self.file_manager.ext = []
+ # self.file_manager.search = "all"
self.file_manager.show(path)
except Exception as e:
@@ -1889,6 +2271,8 @@ class SidebandApp(MDApp):
self.sideband.ui_stopped_recording()
if self.message_process_audio():
+ if self.outbound_mode_command:
+ self.outbound_mode_reset()
self.message_send_action()
Clock.schedule_once(cb_s, 0.35)
@@ -2036,6 +2420,8 @@ class SidebandApp(MDApp):
else:
self.message_process_audio()
+ if self.outbound_mode_command:
+ self.outbound_mode_reset()
self.update_message_widgets()
toast("Added recorded audio to message")
@@ -2162,18 +2548,66 @@ class SidebandApp(MDApp):
self.attach_type = None
self.update_message_widgets()
- if RNS.vendor.platformutils.get_platform() == "android":
- toast("Attachment removed")
+ toast("Attachment removed")
+
+ def shared_attachment_action(self, attachment_data):
+ if not self.root.ids.screen_manager.current == "messages_screen":
+ if RNS.vendor.platformutils.is_android():
+ toast("Please select a conversation first")
else:
ok_button = MDRectangleFlatButton(text="OK",font_size=dp(18))
ate_dialog = MDDialog(
- title="Attachment Removed",
- text="The attached resource was removed from the message",
+ title="No active conversation",
+ text="To drop files as attachments, please open a conversation first",
buttons=[ ok_button ],
)
ok_button.bind(on_release=ate_dialog.dismiss)
ate_dialog.open()
+ else:
+ self.rec_dialog_is_open = False
+ def a_img_lb(sender):
+ self.attach_type="lbimg"
+ self.shared_attach_dialog.dismiss()
+ self.shared_attach_dialog.att_exc()
+ def a_img_def(sender):
+ self.attach_type="defimg"
+ self.shared_attach_dialog.dismiss()
+ self.shared_attach_dialog.att_exc()
+ def a_img_hq(sender):
+ self.attach_type="hqimg"
+ self.shared_attach_dialog.dismiss()
+ self.shared_attach_dialog.att_exc()
+ def a_file(sender):
+ self.attach_type="file"
+ self.shared_attach_dialog.dismiss()
+ self.shared_attach_dialog.att_exc()
+
+ if self.shared_attach_dialog == None:
+ ss = int(dp(18))
+ cancel_button = MDRectangleFlatButton(text="Cancel", font_size=dp(18))
+ ad_items = [
+ DialogItem(IconLeftWidget(icon="message-image-outline", on_release=a_img_lb), text="[size="+str(ss)+"]Low-bandwidth Image[/size]", on_release=a_img_lb),
+ DialogItem(IconLeftWidget(icon="file-image", on_release=a_img_def), text="[size="+str(ss)+"]Medium Image[/size]", on_release=a_img_def),
+ DialogItem(IconLeftWidget(icon="image-outline", on_release=a_img_hq), text="[size="+str(ss)+"]High-res Image[/size]", on_release=a_img_hq),
+ DialogItem(IconLeftWidget(icon="file-outline", on_release=a_file), text="[size="+str(ss)+"]File Attachment[/size]", on_release=a_file)]
+
+ self.shared_attach_dialog = MDDialog(
+ title="Add Attachment",
+ type="simple",
+ text="Select how you want to attach this data to the next message sent\n",
+ items=ad_items,
+ buttons=[ cancel_button ],
+ width_offset=dp(32),
+ )
+
+ cancel_button.bind(on_release=self.shared_attach_dialog.dismiss)
+
+ def att_exc():
+ self.message_fm_got_path(attachment_data["data_path"])
+
+ self.shared_attach_dialog.att_exc = att_exc
+ self.shared_attach_dialog.open()
def update_message_widgets(self):
toolbar_items = self.messages_view.ids.messages_toolbar.ids.right_actions.children
@@ -2303,30 +2737,44 @@ class SidebandApp(MDApp):
return "Could not retrieve connectivity status"
def connectivity_status(self, sender):
- hs = dp(22)
+ if RNS.vendor.platformutils.is_android():
+ hs = dp(22)
+ yes_button = MDRectangleFlatButton(text="OK",font_size=dp(18))
+ full_button = MDRectangleFlatButton(text="Full RNS Status",font_size=dp(18), theme_text_color="Custom", line_color=self.color_accept, text_color=self.color_accept)
+ dialog = MDDialog(
+ title="Connectivity Status",
+ text=str(self.get_connectivity_text()),
+ buttons=[full_button, yes_button],
+ # elevation=0,
+ )
+ def cs_updater(dt):
+ dialog.text = str(self.get_connectivity_text())
+ def dl_yes(s):
+ dialog.dismiss()
+ if self.connectivity_updater != None:
+ self.connectivity_updater.cancel()
+ def cb_rns(sender):
+ dialog.dismiss()
+ if self.connectivity_updater != None:
+ self.connectivity_updater.cancel()
+ self.rnstatus_action()
+
+ yes_button.bind(on_release=dl_yes)
+ full_button.bind(on_release=cb_rns)
+ dialog.open()
- yes_button = MDRectangleFlatButton(text="OK",font_size=dp(18))
- dialog = MDDialog(
- title="Connectivity Status",
- text=str(self.get_connectivity_text()),
- buttons=[ yes_button ],
- # elevation=0,
- )
- def cs_updater(dt):
- dialog.text = str(self.get_connectivity_text())
- def dl_yes(s):
- self.connectivity_updater.cancel()
- dialog.dismiss()
if self.connectivity_updater != None:
self.connectivity_updater.cancel()
- yes_button.bind(on_release=dl_yes)
- dialog.open()
+ self.connectivity_updater = Clock.schedule_interval(cs_updater, 2.0)
- if self.connectivity_updater != None:
- self.connectivity_updater.cancel()
+ else:
+ self.rnstatus_action()
- self.connectivity_updater = Clock.schedule_interval(cs_updater, 2.0)
+ def rnstatus_action(self, sender=None):
+ if not self.utilities_ready:
+ self.utilities_init()
+ self.utilities_screen.rnstatus_action()
def ingest_lxm_action(self, sender):
def cb(dt):
@@ -2400,13 +2848,14 @@ class SidebandApp(MDApp):
else:
sl = None
+ sync_title = "LXMF Sync"
if not hasattr(self, "message_sync_dialog") or self.message_sync_dialog == None:
close_button = MDRectangleFlatButton(text="Close",font_size=dp(18))
stop_button = MDRectangleFlatButton(text="Stop",font_size=dp(18), theme_text_color="Custom", line_color=self.color_reject, text_color=self.color_reject)
dialog_content = MsgSync()
dialog = MDDialog(
- title="LXMF Sync via "+RNS.prettyhexrep(self.sideband.message_router.get_outbound_propagation_node()),
+ title=sync_title,
type="custom",
content_cls=dialog_content,
buttons=[ stop_button, close_button ],
@@ -2443,7 +2892,8 @@ class SidebandApp(MDApp):
dsp = 0
self.sideband.setstate("app.flags.lxmf_sync_dialog_open", True)
- self.message_sync_dialog.title = f"LXMF Sync via "+RNS.prettyhexrep(self.sideband.message_router.get_outbound_propagation_node())
+ self.message_sync_dialog.title = sync_title
+ self.message_sync_dialog.d_content.ids.node_info.text = f"Via {RNS.prettyhexrep(self.sideband.message_router.get_outbound_propagation_node())}\n"
self.message_sync_dialog.d_content.ids.sync_status.text = self.sideband.get_sync_status()
self.message_sync_dialog.d_content.ids.sync_progress.value = dsp
self.message_sync_dialog.d_content.ids.sync_progress.start()
@@ -2481,17 +2931,22 @@ class SidebandApp(MDApp):
n_address = dialog.d_content.ids["n_address_field"].text
n_name = dialog.d_content.ids["n_name_field"].text
n_trusted = dialog.d_content.ids["n_trusted"].active
- new_result = self.sideband.new_conversation(n_address, n_name, n_trusted)
+ n_voice_only = dialog.d_content.ids["n_voice_only"].active
+ new_result = self.sideband.new_conversation(n_address, n_name, n_trusted, n_voice_only)
except Exception as e:
RNS.log("Error while creating conversation: "+str(e), RNS.LOG_ERROR)
if new_result:
+ dialog.d_content.ids["n_address_field"].helper_text = ""
+ dialog.d_content.ids["n_address_field"].helper_text_mode = "on_focus"
dialog.d_content.ids["n_address_field"].error = False
dialog.dismiss()
if self.conversations_view != None:
self.conversations_view.update()
else:
+ dialog.d_content.ids["n_address_field"].helper_text = "Invalid address, check your input"
+ dialog.d_content.ids["n_address_field"].helper_text_mode = "persistent"
dialog.d_content.ids["n_address_field"].error = True
# dialog.d_content.ids["n_error_field"].text = "Could not create conversation. Check your input."
@@ -2539,11 +2994,11 @@ class SidebandApp(MDApp):
self.information_screen.ids.information_scrollview.effect_cls = ScrollEffect
self.information_screen.ids.information_logo.icon = self.sideband.asset_dir+"/rns_256.png"
- str_comps = " - [b]Reticulum[/b] (MIT License)\n - [b]LXMF[/b] (MIT License)\n - [b]KivyMD[/b] (MIT License)"
+ str_comps = " - [b]Reticulum[/b] (Reticulum License)\n - [b]LXMF[/b] (Reticulum License)\n - [b]KivyMD[/b] (MIT License)"
str_comps += "\n - [b]Kivy[/b] (MIT License)\n - [b]Codec2[/b] (LGPL License)\n - [b]PyCodec2[/b] (BSD-3 License)"
- str_comps += "\n - [b]PyDub[/b] (MIT License)\n - [b]PyOgg[/b] (Public Domain)"
- str_comps += "\n - [b]GeoidHeight[/b] (LGPL License)\n - [b]Python[/b] (PSF License)"
- str_comps += "\n\nGo to [u][ref=link]https://unsigned.io/donate[/ref][/u] to support the project.\n\nThe Sideband app is Copyright (c) 2024 Mark Qvist / unsigned.io\n\nPermission is granted to freely share and distribute binary copies of "+self.root.ids.app_version_info.text+", so long as no payment or compensation is charged for said distribution or sharing.\n\nIf you were charged or paid anything for this copy of Sideband, please report it to [b]license@unsigned.io[/b].\n\nTHIS IS EXPERIMENTAL SOFTWARE - SIDEBAND COMES WITH ABSOLUTELY NO WARRANTY - USE AT YOUR OWN RISK AND RESPONSIBILITY"
+ str_comps += "\n - [b]PyDub[/b] (MIT License)\n - [b]PyOgg[/b] (Public Domain)\n - [b]FFmpeg[/b] (GPL3 License)"
+ str_comps += "\n - [b]GeoidHeight[/b] (LGPL License)\n - [b]Paho MQTT[/b] (EPL2 License)\n - [b]Python[/b] (PSF License)"
+ str_comps += "\n\nGo to [u][ref=link]https://unsigned.io/donate[/ref][/u] to support the project.\n\nThe Sideband app is Copyright © 2025 Mark Qvist / unsigned.io\n\nPermission is granted to freely share and distribute binary copies of "+self.root.ids.app_version_info.text+", so long as no payment or compensation is charged for said distribution or sharing.\n\nIf you were charged or paid anything for this copy of Sideband, please report it to [b]license@unsigned.io[/b].\n\nTHIS IS EXPERIMENTAL SOFTWARE - SIDEBAND COMES WITH ABSOLUTELY NO WARRANTY - USE AT YOUR OWN RISK AND RESPONSIBILITY"
info = "This is "+self.root.ids.app_version_info.text+", on RNS v"+RNS.__version__+" and LXMF v"+LXMF.__version__+".\n\nHumbly build using the following open components:\n\n"+str_comps
self.information_screen.ids.information_info.text = info
self.information_screen.ids.information_info.bind(on_ref_press=link_exec)
@@ -2585,6 +3040,72 @@ class SidebandApp(MDApp):
if no_transition:
self.root.ids.screen_manager.transition = self.slide_transition
+ def configure_ui_scaling_action(self, sender=None):
+ global app_ui_scaling_path
+ try:
+ cancel_button = MDRectangleFlatButton(text="Cancel",font_size=dp(18))
+ set_button = MDRectangleFlatButton(text="Set",font_size=dp(18), theme_text_color="Custom", line_color=self.color_accept, text_color=self.color_accept)
+
+ dialog_content = UIScaling()
+ dialog = MDDialog(
+ title="UI Scaling",
+ type="custom",
+ content_cls=dialog_content,
+ buttons=[ set_button, cancel_button ],
+ # elevation=0,
+ )
+ dialog.d_content = dialog_content
+ dialog.d_content.ids["scaling_factor"].text = os.environ["KIVY_METRICS_DENSITY"] if "KIVY_METRICS_DENSITY" in os.environ else "0.0"
+ def dl_yes(s):
+ new_sf = 1.0
+ scaling_ok = False
+ try:
+ si = dialog.d_content.ids["scaling_factor"].text
+ sf = float(si)
+ if (sf >= 0.3 and sf <= 5.0) or sf == 0.0:
+ new_sf = sf
+ scaling_ok = True
+
+ except Exception as e:
+ RNS.log("Error while getting scaling factor from user: "+str(e), RNS.LOG_ERROR)
+
+ if scaling_ok:
+ dialog.d_content.ids["scaling_factor"].helper_text = ""
+ dialog.d_content.ids["scaling_factor"].helper_text_mode = "on_focus"
+ dialog.d_content.ids["scaling_factor"].error = False
+ dialog.dismiss()
+ if app_ui_scaling_path == None:
+ RNS.log("No path to UI scaling factor file could be found, cannot save scaling factor", RNS.LOG_ERROR)
+ else:
+ try:
+ with open(app_ui_scaling_path, "w") as sfile:
+ sfile.write(str(new_sf))
+ RNS.log(f"Saved configured scaling factor {new_sf} to {app_ui_scaling_path}", RNS.LOG_DEBUG)
+ except Exception as e:
+ RNS.log(f"Error while saving scaling factor {new_sf} to {app_ui_scaling_path}: {e}", RNS.LOG_ERROR)
+
+ else:
+ dialog.d_content.ids["scaling_factor"].helper_text = "Invalid scale factor, check your input"
+ dialog.d_content.ids["scaling_factor"].helper_text_mode = "persistent"
+ dialog.d_content.ids["scaling_factor"].error = True
+
+ def dl_no(s):
+ dialog.dismiss()
+
+ def dl_ds(s):
+ self.dialog_open = False
+
+ set_button.bind(on_release=dl_yes)
+ cancel_button.bind(on_release=dl_no)
+
+ dialog.bind(on_dismiss=dl_ds)
+ dialog.open()
+ self.dialog_open = True
+
+ except Exception as e:
+ RNS.log("Error while creating UI scaling dialog: "+str(e), RNS.LOG_ERROR)
+
+
def settings_action(self, sender=None, direction="left"):
if self.settings_ready:
self.settings_open(direction=direction)
@@ -2739,6 +3260,11 @@ class SidebandApp(MDApp):
self.sideband.save_configuration()
self.update_ui_theme()
+ def save_classic_message_colors(sender=None, event=None):
+ self.sideband.config["classic_message_colors"] = self.settings_screen.ids.settings_classic_message_colors.active
+ self.sideband.save_configuration()
+ self.update_ui_theme()
+
def save_display_style_in_contact_list(sender=None, event=None):
self.sideband.config["display_style_in_contact_list"] = self.settings_screen.ids.display_style_in_contact_list.active
self.sideband.save_configuration()
@@ -2749,6 +3275,14 @@ class SidebandApp(MDApp):
self.sideband.save_configuration()
self.sideband.setstate("wants.viewupdate.conversations", True)
+ def save_trusted_markup_only(sender=None, event=None):
+ self.sideband.config["trusted_markup_only"] = self.settings_screen.ids.settings_trusted_markup_only.active
+ self.sideband.save_configuration()
+
+ def save_compose_in_markdown(sender=None, event=None):
+ self.sideband.config["compose_in_markdown"] = self.settings_screen.ids.settings_compose_in_markdown.active
+ self.sideband.save_configuration()
+
def save_advanced_stats(sender=None, event=None):
self.sideband.config["advanced_stats"] = self.settings_screen.ids.settings_advanced_statistics.active
self.sideband.save_configuration()
@@ -2799,6 +3333,15 @@ class SidebandApp(MDApp):
self.sideband.config["hq_ptt"] = self.settings_screen.ids.settings_hq_ptt.active
self.sideband.save_configuration()
+ def save_voice_enabled(sender=None, event=None):
+ self.sideband.config["voice_enabled"] = self.settings_screen.ids.settings_voice_enabled.active
+ self.sideband.save_configuration()
+
+ if self.sideband.config["voice_enabled"] == True:
+ self.sideband.start_voice()
+ else:
+ self.sideband.stop_voice()
+
def save_print_command(sender=None, event=None):
if not sender.focus:
in_cmd = self.settings_screen.ids.settings_print_command.text
@@ -2900,6 +3443,9 @@ class SidebandApp(MDApp):
self.settings_screen.ids.settings_eink_mode.active = self.sideband.config["eink_mode"]
self.settings_screen.ids.settings_eink_mode.bind(active=save_eink_mode)
+ self.settings_screen.ids.settings_classic_message_colors.active = self.sideband.config["classic_message_colors"]
+ self.settings_screen.ids.settings_classic_message_colors.bind(active=save_classic_message_colors)
+
self.settings_screen.ids.display_style_in_contact_list.active = self.sideband.config["display_style_in_contact_list"]
self.settings_screen.ids.display_style_in_contact_list.bind(active=save_display_style_in_contact_list)
@@ -2921,6 +3467,12 @@ class SidebandApp(MDApp):
self.settings_screen.ids.settings_lxmf_ignore_unknown.active = self.sideband.config["lxmf_ignore_unknown"]
self.settings_screen.ids.settings_lxmf_ignore_unknown.bind(active=save_lxmf_ignore_unknown)
+ self.settings_screen.ids.settings_trusted_markup_only.active = self.sideband.config["trusted_markup_only"]
+ self.settings_screen.ids.settings_trusted_markup_only.bind(active=save_trusted_markup_only)
+
+ self.settings_screen.ids.settings_compose_in_markdown.active = self.sideband.config["compose_in_markdown"]
+ self.settings_screen.ids.settings_compose_in_markdown.bind(active=save_compose_in_markdown)
+
self.settings_screen.ids.settings_ignore_invalid_stamps.active = self.sideband.config["lxmf_ignore_invalid_stamps"]
self.settings_screen.ids.settings_ignore_invalid_stamps.bind(active=save_lxmf_ignore_invalid_stamps)
@@ -2965,6 +3517,10 @@ class SidebandApp(MDApp):
self.settings_screen.ids.settings_hq_ptt.active = self.sideband.config["hq_ptt"]
self.settings_screen.ids.settings_hq_ptt.bind(active=save_hq_ptt)
+ self.settings_screen.ids.settings_voice_enabled.active = self.sideband.config["voice_enabled"]
+ self.settings_screen.ids.settings_voice_enabled.bind(active=save_voice_enabled)
+ if RNS.vendor.platformutils.is_android(): self.settings_screen.ids.settings_voice_enabled.disabled = True
+
self.settings_screen.ids.settings_debug.active = self.sideband.config["debug"]
self.settings_screen.ids.settings_debug.bind(active=save_debug)
@@ -3078,6 +3634,7 @@ class SidebandApp(MDApp):
self.widget_hide(self.connectivity_screen.ids.connectivity_serial_label)
self.widget_hide(self.connectivity_screen.ids.connectivity_use_serial)
self.widget_hide(self.connectivity_screen.ids.connectivity_serial_fields)
+ self.widget_hide(self.connectivity_screen.ids.connectivity_share_instance)
self.widget_hide(self.connectivity_screen.ids.connectivity_shared_access)
self.widget_hide(self.connectivity_screen.ids.connectivity_shared_access_label)
self.widget_hide(self.connectivity_screen.ids.connectivity_shared_access_fields)
@@ -3085,6 +3642,7 @@ class SidebandApp(MDApp):
self.widget_hide(self.connectivity_screen.ids.connectivity_enable_transport)
self.widget_hide(self.connectivity_screen.ids.connectivity_transport_info)
self.widget_hide(self.connectivity_screen.ids.connectivity_transport_fields)
+ self.widget_hide(self.connectivity_screen.ids.connectivity_service_restart_fields)
def con_collapse_local(collapse=True):
# self.widget_hide(self.connectivity_screen.ids.connectivity_local_fields, collapse)
@@ -3120,6 +3678,7 @@ class SidebandApp(MDApp):
def save_connectivity(sender=None, event=None):
self.sideband.config["connect_transport"] = self.connectivity_screen.ids.connectivity_enable_transport.active
+ self.sideband.config["connect_share_instance"] = self.connectivity_screen.ids.connectivity_share_instance.active
self.sideband.config["connect_local"] = self.connectivity_screen.ids.connectivity_use_local.active
self.sideband.config["connect_local_groupid"] = self.connectivity_screen.ids.connectivity_local_groupid.text
self.sideband.config["connect_local_ifac_netname"] = self.connectivity_screen.ids.connectivity_local_ifac_netname.text
@@ -3237,7 +3796,7 @@ class SidebandApp(MDApp):
else:
info = "By default, Sideband will try to discover and connect to any available Reticulum networks via active WiFi and/or Ethernet interfaces. If any Reticulum Transport Instances are found, Sideband will use these to connect to wider Reticulum networks. You can disable this behaviour if you don't want it.\n\n"
info += "You can also connect to a network via a remote or local Reticulum instance using TCP or I2P. [b]Please Note![/b] Connecting via I2P requires that you already have I2P running on your device, and that the SAM API is enabled.\n\n"
- info += "For changes to connectivity to take effect, you must shut down and restart Sideband.\n"
+ info += "For changes to connectivity to take effect, you must either restart the RNS service, or completely shut down and restart Sideband.\n"
self.connectivity_screen.ids.connectivity_info.text = info
self.connectivity_screen.ids.connectivity_use_local.active = self.sideband.config["connect_local"]
@@ -3277,6 +3836,10 @@ class SidebandApp(MDApp):
self.connectivity_screen.ids.connectivity_enable_transport.active = self.sideband.config["connect_transport"]
con_collapse_transport(collapse=not self.sideband.config["connect_transport"])
self.connectivity_screen.ids.connectivity_enable_transport.bind(active=save_connectivity)
+
+ self.connectivity_screen.ids.connectivity_share_instance.active = self.sideband.config["connect_share_instance"]
+ self.connectivity_screen.ids.connectivity_share_instance.bind(active=save_connectivity)
+
self.connectivity_screen.ids.connectivity_local_ifmode.text = self.sideband.config["connect_ifmode_local"].capitalize()
self.connectivity_screen.ids.connectivity_tcp_ifmode.text = self.sideband.config["connect_ifmode_tcp"].capitalize()
self.connectivity_screen.ids.connectivity_i2p_ifmode.text = self.sideband.config["connect_ifmode_i2p"].capitalize()
@@ -3356,7 +3919,8 @@ class SidebandApp(MDApp):
dialog.dismiss()
yes_button.bind(on_release=dl_yes)
- rpc_string = "rpc_key = "+RNS.hexrep(self.sideband.reticulum.rpc_key, delimit=False)
+ rpc_string = "shared_instance_type = tcp\n"
+ rpc_string += "rpc_key = "+RNS.hexrep(self.sideband.reticulum.rpc_key, delimit=False)
Clipboard.copy(rpc_string)
dialog.open()
@@ -3369,6 +3933,7 @@ class SidebandApp(MDApp):
######################################
def repository_action(self, sender=None, direction="left"):
if self.repository_ready:
+ self.repository_update_info()
self.repository_open(direction=direction)
else:
self.loader_action(direction=direction)
@@ -3395,9 +3960,9 @@ class SidebandApp(MDApp):
self.root.ids.screen_manager.transition = self.slide_transition
def repository_link_action(self, sender=None, event=None):
- if self.reposository_url != None:
+ if self.repository_url != None:
def lj():
- webbrowser.open(self.reposository_url)
+ webbrowser.open(self.repository_url)
threading.Thread(target=lj, daemon=True).start()
def repository_update_info(self, sender=None):
@@ -3405,9 +3970,9 @@ class SidebandApp(MDApp):
info += "If you want to share the Sideband application itself via the repository server, you must first download it into the local repository, using the \"Update Content\" button below.\n\n"
info += "To make the repository available on your local network, simply start it below, and it will become browsable on a local IP address for anyone connected to the same WiFi or wired network.\n\n"
if self.sideband.webshare_server != None:
- if RNS.vendor.platformutils.is_android():
- def getIP():
- adrs = []
+ def getIP():
+ adrs = []
+ if RNS.vendor.platformutils.is_android():
try:
from jnius import autoclass
import ipaddress
@@ -3430,30 +3995,47 @@ class SidebandApp(MDApp):
RNS.log("Error while getting repository IP address: "+str(e), RNS.LOG_ERROR)
return None
- return adrs
-
- ips = getIP()
- if ips == None or len(ips) == 0:
- info += "The repository server is running, but the local device IP address could not be determined.\n\nYou can access the repository by pointing a browser to: http://DEVICE_IP:4444/"
- self.reposository_url = None
else:
- ipstr = ""
- for ip in ips:
- ipstr += "http://"+str(ip)+":4444/\n"
- self.reposository_url = ipstr
+ import socket
+ adrs.append(socket.gethostbyname(socket.gethostname()))
- ms = "" if len(ips) == 1 else "es"
- info += "The repository server is running at the following address"+ms+":\n [u][ref=link]"+ipstr+"[/ref][u]"
- self.repository_screen.ids.repository_info.bind(on_ref_press=self.repository_link_action)
+ return adrs
- self.repository_screen.ids.repository_enable_button.disabled = True
- self.repository_screen.ids.repository_disable_button.disabled = False
+ ips = getIP()
+ if ips == None or len(ips) == 0:
+ info += "The repository server is running, but the local device IP address could not be determined.\n\nYou can access the repository by pointing a browser to: https://DEVICE_IP:4444/"
+ self.repository_url = None
+ else:
+ ipstr = ""
+ self.repository_url = None
+ for ip in ips:
+ ipurl = "https://" + str(ip) + ":4444/"
+ ipstr += "[u][ref=link]"+ipurl+"[/ref][u]\n"
+ if self.repository_url == None:
+ self.repository_url = ipurl
+ self.rnode_flasher_url = ipurl+"mirrors/rnode-flasher/index.html"
+
+ ms = "" if len(ips) == 1 else "es"
+ info += "The repository server is running at the following address" + ms +":\n\n"+ipstr
+ self.repository_screen.ids.repository_info.bind(on_ref_press=self.repository_link_action)
+
+ def cb(dt):
+ self.repository_screen.ids.repository_enable_button.disabled = True
+ self.repository_screen.ids.repository_disable_button.disabled = False
+ if hasattr(self, "wants_flasher_launch") and self.wants_flasher_launch == True:
+ self.wants_flasher_launch = False
+ if self.rnode_flasher_url != None:
+ def lj():
+ webbrowser.open(self.rnode_flasher_url)
+ threading.Thread(target=lj, daemon=True).start()
+
+ Clock.schedule_once(cb, 0.1)
else:
self.repository_screen.ids.repository_enable_button.disabled = False
self.repository_screen.ids.repository_disable_button.disabled = True
- info += "\n"
+ info += ""
self.repository_screen.ids.repository_info.text = info
def repository_start_action(self, sender=None):
@@ -3461,7 +4043,7 @@ class SidebandApp(MDApp):
Clock.schedule_once(self.repository_update_info, 1.0)
def repository_stop_action(self, sender=None):
- self.reposository_url = None
+ self.repository_url = None
self.sideband.stop_webshare()
Clock.schedule_once(self.repository_update_info, 0.75)
@@ -3469,39 +4051,85 @@ class SidebandApp(MDApp):
def update_job(sender=None):
try:
import requests
+ ### RNode Firmwares ###########
+ if True:
+ downloads = []
+ try:
+ release_url = "https://api.github.com/repos/markqvist/rnode_firmware/releases"
+ with requests.get(release_url) as response:
+ releases = response.json()
+ release = releases[0]
+ assets = release["assets"]
+ for asset in assets:
+ if asset["name"].lower().startswith("rnode_firmware"):
+ fw_url = asset["browser_download_url"]
+ pkgname = asset["name"]
+ fw_version = release["tag_name"]
+ RNS.log(f"Found version {fw_version} artefact {pkgname} at {fw_url}", RNS.LOG_DEBUG)
+ downloads.append([fw_url, pkgname, fw_version])
- # Get release info
- apk_version = None
- apk_url = None
- pkgname = None
- try:
- release_url = "https://api.github.com/repos/markqvist/sideband/releases"
- with requests.get(release_url) as response:
- releases = response.json()
- release = releases[0]
- assets = release["assets"]
- for asset in assets:
- if asset["name"].lower().endswith(".apk"):
- apk_url = asset["browser_download_url"]
- pkgname = asset["name"]
- apk_version = release["tag_name"]
- RNS.log(f"Found version {apk_version} artefact {pkgname} at {apk_url}")
- except Exception as e:
- self.repository_screen.ids.repository_update.text = f"Downloading release info failed with the error:\n"+str(e)
- return
+ except Exception as e:
+ self.repository_screen.ids.repository_update.text = f"Downloading RNode firmware release info failed with the error:\n"+str(e)
+ return
- self.repository_screen.ids.repository_update.text = "Downloading: "+str(apk_url)
- with requests.get(apk_url, stream=True) as response:
- with open("./dl_tmp", "wb") as tmp_file:
- cs = 32*1024
- tds = 0
- for chunk in response.iter_content(chunk_size=cs):
- tmp_file.write(chunk)
- tds += cs
- self.repository_screen.ids.repository_update.text = "Downloaded "+RNS.prettysize(tds)+" of "+str(pkgname)
+ try:
+ for download in downloads:
+ fw_url = download[0]
+ pkgname = download[1]
+ self.repository_screen.ids.repository_update.text = "Downloading: "+str(pkgname)
+ with requests.get(fw_url, stream=True) as response:
+ with open("./dl_tmp", "wb") as tmp_file:
+ cs = 32*1024
+ tds = 0
+ for chunk in response.iter_content(chunk_size=cs):
+ tmp_file.write(chunk)
+ tds += cs
+ self.repository_screen.ids.repository_update.text = "Downloaded "+RNS.prettysize(tds)+" of "+str(pkgname)
+
+ os.rename("./dl_tmp", f"{self.sideband.webshare_dir}/pkg/{pkgname}")
+ self.repository_screen.ids.repository_update.text = f"Added {pkgname} to the repository!"
+
+ except Exception as e:
+ self.repository_screen.ids.repository_update.text = f"Downloading RNode firmware failed with the error:\n"+str(e)
+ return
+
+ ### Sideband APK File #########
+ if True:
+ # Get release info
+ apk_version = None
+ apk_url = None
+ pkgname = None
+ try:
+ release_url = "https://api.github.com/repos/markqvist/sideband/releases"
+ with requests.get(release_url) as response:
+ releases = response.json()
+ release = releases[0]
+ assets = release["assets"]
+ for asset in assets:
+ if asset["name"].lower().endswith(".apk"):
+ apk_url = asset["browser_download_url"]
+ pkgname = asset["name"]
+ apk_version = release["tag_name"]
+ RNS.log(f"Found version {apk_version} artefact {pkgname} at {apk_url}", RNS.LOG_DEBUG)
+ except Exception as e:
+ self.repository_screen.ids.repository_update.text = f"Downloading Sideband APK release info failed with the error:\n"+str(e)
+ return
+
+ self.repository_screen.ids.repository_update.text = "Downloading: "+str(pkgname)
+ with requests.get(apk_url, stream=True) as response:
+ with open("./dl_tmp", "wb") as tmp_file:
+ cs = 32*1024
+ tds = 0
+ for chunk in response.iter_content(chunk_size=cs):
+ tmp_file.write(chunk)
+ tds += cs
+ self.repository_screen.ids.repository_update.text = "Downloaded "+RNS.prettysize(tds)+" of "+str(pkgname)
+
+ os.rename("./dl_tmp", f"{self.sideband.webshare_dir}/pkg/{pkgname}")
+ self.repository_screen.ids.repository_update.text = f"Added {pkgname} to the repository!"
+
+ self.repository_screen.ids.repository_update.text = f"Repository contents updated successfully!"
- os.rename("./dl_tmp", f"./share/pkg/{pkgname}")
- self.repository_screen.ids.repository_update.text = f"Added {pkgname} to the repository!"
except Exception as e:
self.repository_screen.ids.repository_update.text = f"Downloading contents failed with the error:\n"+str(e)
@@ -3518,15 +4146,7 @@ class SidebandApp(MDApp):
self.root.ids.screen_manager.add_widget(self.repository_screen)
self.repository_screen.ids.repository_scrollview.effect_cls = ScrollEffect
-
self.repository_update_info()
-
- if not RNS.vendor.platformutils.is_android():
- self.widget_hide(self.repository_screen.ids.repository_enable_button)
- self.widget_hide(self.repository_screen.ids.repository_disable_button)
- self.widget_hide(self.repository_screen.ids.repository_download_button)
- self.repository_screen.ids.repository_info.text = "\nThe [b]Repository Webserver[/b] feature is currently only available on mobile devices."
-
self.repository_ready = True
def close_repository_action(self, sender=None):
@@ -3697,6 +4317,63 @@ class SidebandApp(MDApp):
self.sideband.save_configuration()
+ def hardware_rnode_scan_job(self):
+ time.sleep(1.25)
+ added_devices = []
+ scan_timeout = time.time()+16
+ while time.time() < scan_timeout:
+ RNS.log("Scanning...", RNS.LOG_DEBUG)
+ for device_addr in self.discovered_bt_devices:
+ if device_addr not in added_devices and not device_addr in self.bt_bonded_devices:
+ new_device = self.discovered_bt_devices[device_addr]
+ added_devices.append(device_addr)
+ RNS.log(f"Adding device: {new_device}")
+ def add_factory(add_device):
+ def add_job(dt):
+ pair_addr = add_device["address"]
+ btn_text = "Pair "+add_device["name"]
+ def run_pair(sender): self.hardware_rnode_pair_device_action(pair_addr)
+ # device_button = MDRectangleFlatButton(text=btn_text,font_size=dp(16))
+ device_button = MDRectangleFlatButton(text=btn_text, font_size=dp(16), padding=[dp(0), dp(14), dp(0), dp(14)], size_hint=[1.0, None])
+ device_button.bind(on_release=run_pair)
+ self.hardware_rnode_screen.ids.rnode_scan_results.add_widget(device_button)
+ return add_job
+
+ Clock.schedule_once(add_factory(new_device), 0.1)
+
+ time.sleep(2)
+
+ def job(dt):
+ self.hardware_rnode_screen.ids.hardware_rnode_bt_scan_button.disabled = False
+ self.hardware_rnode_screen.ids.hardware_rnode_bt_scan_button.text = "Pair New Device"
+ Clock.schedule_once(job, 0.2)
+
+ if len(added_devices) == 0:
+ def job(dt): toast("No unpaired RNodes discovered")
+ Clock.schedule_once(job, 0.2)
+
+ def hardware_rnode_pair_device_action(self, pair_addr):
+ RNS.log(f"Pair action for {pair_addr}", RNS.LOG_DEBUG)
+ self.stop_bluetooth_scan()
+ BluetoothSocket = autoclass('android.bluetooth.BluetoothSocket')
+ if self.bt_adapter == None: self.bt_adapter = BluetoothAdapter.getDefaultAdapter()
+ addr_bytes = bytes.fromhex(pair_addr.replace(":", ""))
+ remote_device = self.bt_adapter.getRemoteDevice(addr_bytes)
+ RNS.log(f"Remote device: {remote_device}", RNS.LOG_DEBUG)
+ remote_device.createBond()
+ RNS.log("Create bond call returned", RNS.LOG_DEBUG)
+
+ def hardware_rnode_bt_scan_action(self, sender=None):
+ self.discovered_bt_devices = {}
+ self.hardware_rnode_screen.ids.hardware_rnode_bt_scan_button.disabled = True
+ self.hardware_rnode_screen.ids.hardware_rnode_bt_scan_button.text = "Scanning..."
+ rw = []
+ for child in self.hardware_rnode_screen.ids.rnode_scan_results.children: rw.append(child)
+ for w in rw: self.hardware_rnode_screen.ids.rnode_scan_results.remove_widget(w)
+
+ Clock.schedule_once(self.bluetooth_scan_action, 0.5)
+ threading.Thread(target=self.hardware_rnode_scan_job, daemon=True).start()
+
def hardware_rnode_bt_on_action(self, sender=None):
self.hardware_rnode_screen.ids.hardware_rnode_bt_pair_button.disabled = True
self.hardware_rnode_screen.ids.hardware_rnode_bt_on_button.disabled = True
@@ -3872,7 +4549,7 @@ class SidebandApp(MDApp):
valid = False
try:
- valid_vals = [7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125, 250, 500]
+ valid_vals = [7.8, 10.4, 15.6, 20.8, 31.25, 41.7, 62.5, 125, 250, 500, 203.125, 406.25, 812.5, 1625]
val = float(self.hardware_rnode_screen.ids.hardware_rnode_bandwidth.text)
if not val in valid_vals:
raise ValueError("Invalid bandwidth")
@@ -4521,7 +5198,7 @@ class SidebandApp(MDApp):
self.bind_clipboard_actions(self.keys_screen.ids)
self.keys_screen.ids.keys_scrollview.effect_cls = ScrollEffect
- info = "Your primary encryption keys are stored in a Reticulum Identity within the Sideband app. If you want to backup this Identity for later use on this or another device, you can export it as a plain text blob, with the key data encoded in Base32 format. This will allow you to restore your address in Sideband or other LXMF clients at a later point.\n\n[b]Warning![/b] Anyone that gets access to the key data will be able to control your LXMF address, impersonate you, and read your messages. In is [b]extremely important[/b] that you keep the Identity data secure if you export it.\n\nBefore displaying or exporting your Identity data, make sure that no machine or person in your vicinity is able to see, copy or record your device screen or similar."
+ info = "Your primary encryption keys are stored in a Reticulum Identity within the Sideband app. If you want to backup this Identity for later use on this or another device, you can export it as a plain text blob, with the key data encoded in Base32 format. This will allow you to restore your address in Sideband or other LXMF clients at a later point.\n\n[b]Warning![/b] Anyone that gets access to the key data will be able to control your LXMF address, impersonate you, and read your messages. It is [b]extremely important[/b] that you keep the Identity data secure if you export it.\n\nBefore displaying or exporting your Identity data, make sure that no machine or person in your vicinity is able to see, copy or record your device screen or similar."
if not RNS.vendor.platformutils.get_platform() == "android":
self.widget_hide(self.keys_screen.ids.keys_share)
@@ -4782,6 +5459,100 @@ class SidebandApp(MDApp):
ate_dialog.open()
+ ### Utilities Screen
+ ######################################
+
+ def utilities_init(self):
+ if not self.utilities_ready:
+ self.utilities_screen = Utilities(self)
+ self.utilities_ready = True
+
+ def utilities_open(self, sender=None, direction="left", no_transition=False):
+ if no_transition:
+ self.root.ids.screen_manager.transition = self.no_transition
+ else:
+ self.root.ids.screen_manager.transition = self.slide_transition
+ self.root.ids.screen_manager.transition.direction = direction
+
+ self.root.ids.screen_manager.current = "utilities_screen"
+ self.root.ids.nav_drawer.set_state("closed")
+ self.sideband.setstate("app.displaying", self.root.ids.screen_manager.current)
+
+ if no_transition:
+ self.root.ids.screen_manager.transition = self.slide_transition
+
+ def utilities_action(self, sender=None, direction="left"):
+ if self.utilities_ready:
+ self.utilities_open(direction=direction)
+ else:
+ self.loader_action(direction=direction)
+ def final(dt):
+ self.utilities_init()
+ def o(dt):
+ self.utilities_open(no_transition=True)
+ Clock.schedule_once(o, ll_ot)
+ Clock.schedule_once(final, ll_ft)
+
+ def close_sub_utilities_action(self, sender=None):
+ self.utilities_action(direction="right")
+
+
+ ### voice Screen
+ ######################################
+
+ def voice_init(self):
+ if not self.voice_ready:
+ self.voice_screen = Voice(self)
+ self.voice_ready = True
+
+ def voice_open(self, sender=None, direction="left", no_transition=False, dial_on_complete=None):
+ if no_transition:
+ self.root.ids.screen_manager.transition = self.no_transition
+ else:
+ self.root.ids.screen_manager.transition = self.slide_transition
+ self.root.ids.screen_manager.transition.direction = direction
+
+ self.root.ids.screen_manager.current = "voice_screen"
+ self.root.ids.nav_drawer.set_state("closed")
+ self.sideband.setstate("app.displaying", self.root.ids.screen_manager.current)
+
+ if no_transition:
+ self.root.ids.screen_manager.transition = self.slide_transition
+
+ self.voice_screen.update_call_status()
+ if dial_on_complete:
+ self.voice_screen.dial_target = dial_on_complete
+ self.voice_screen.screen.ids.identity_hash.text = RNS.hexrep(dial_on_complete, delimit=False)
+ Clock.schedule_once(self.voice_screen.dial_action, 0.25)
+
+ def voice_action(self, sender=None, direction="left", dial_on_complete=None):
+ if self.voice_ready:
+ self.voice_open(direction=direction, dial_on_complete=dial_on_complete)
+ else:
+ self.loader_action(direction=direction)
+ def final(dt):
+ self.voice_init()
+ def o(dt):
+ self.voice_open(no_transition=True, dial_on_complete=dial_on_complete)
+ Clock.schedule_once(o, ll_ot)
+ Clock.schedule_once(final, ll_ft)
+
+ def close_sub_voice_action(self, sender=None):
+ self.voice_action(direction="right")
+
+ def dial_action(self, identity_hash):
+ self.voice_action(dial_on_complete=identity_hash)
+
+ def voice_answer_action(self, sender=None):
+ if self.sideband.voice_running:
+ if self.sideband.telephone.is_ringing: self.sideband.telephone.answer()
+
+ def voice_reject_action(self, sender=None):
+ if self.sideband.voice_running:
+ if self.sideband.telephone.is_ringing or self.sideband.telephone.is_in_call:
+ self.sideband.telephone.hangup()
+ toast("Call ended")
+
### Telemetry Screen
######################################
@@ -4894,7 +5665,7 @@ class SidebandApp(MDApp):
self.telemetry_info_dialog.dismiss()
ok_button.bind(on_release=dl_ok)
- result = self.sideband.request_latest_telemetry(from_addr=self.sideband.config["telemetry_collector"])
+ result = self.sideband.request_latest_telemetry(from_addr=self.sideband.config["telemetry_collector"], is_collector_request=True)
if result == "no_address":
title_str = "Invalid Address"
@@ -4904,10 +5675,10 @@ class SidebandApp(MDApp):
info_str = "No keys known for the destination. Connected reticules have been queried for the keys. Try again when an announce for the destination has arrived."
elif result == "in_progress":
title_str = "Transfer In Progress"
- info_str = "There is already a telemetry request transfer in progress for this peer."
+ info_str = "There is already a telemetry request transfer in progress to the collector."
elif result == "sent":
title_str = "Request Sent"
- info_str = "A telemetry request was sent to the peer. The peer should send any available telemetry shortly."
+ info_str = "A telemetry request was sent to the collector. The collector should send any available telemetry shortly."
elif result == "not_sent":
title_str = "Not Sent"
info_str = "A telemetry request could not be sent."
@@ -5386,8 +6157,23 @@ class SidebandApp(MDApp):
self.map_action()
self.map_show(location)
- def map_display_telemetry(self, sender=None):
- self.object_details_action(sender)
+ def map_display_telemetry(self, sender=None, event=None):
+ alt_event = False
+ if sender != None:
+ if hasattr(sender, "last_touch"):
+ if hasattr(sender.last_touch, "button"):
+ if sender.last_touch.button == "right":
+ alt_event = True
+
+ if alt_event:
+ try:
+ if hasattr(sender, "source_dest"):
+ self.sideband.request_latest_telemetry(from_addr=sender.source_dest)
+ toast("Telemetry request sent")
+ except Exception as e:
+ RNS.log(f"Could not request telemetry update: {e}", RNS.LOG_ERROR)
+ else:
+ self.object_details_action(sender)
def map_display_own_telemetry(self, sender=None):
self.sideband.update_telemetry()
@@ -5571,7 +6357,7 @@ class SidebandApp(MDApp):
latest_viewable = None
if not skip:
- for telemetry_entry in telemetry_entries[telemetry_source]:
+ for telemetry_entry in sorted(telemetry_entries[telemetry_source], key=lambda t: t[0], reverse=True):
telemetry_timestamp = telemetry_entry[0]
telemetry_data = telemetry_entry[1]
t = Telemeter.from_packed(telemetry_data)
@@ -5580,6 +6366,10 @@ class SidebandApp(MDApp):
if "location" in telemetry and telemetry["location"] != None and telemetry["location"]["latitude"] != None and telemetry["location"]["longitude"] != None:
latest_viewable = telemetry
break
+ elif "connection_map" in telemetry:
+ # TODO: Telemetry entries with connection map sensor types are skipped for now,
+ # until a proper rendering mechanism is implemented
+ break
if latest_viewable != None:
l = latest_viewable["location"]
@@ -5687,7 +6477,7 @@ If you use Reticulum and LXMF on hardware that does not carry any identifiers ti
[b]Quick Actions[/b]
- [b]Ctrl-W[/b] Go back
- - [b]Ctrl+Q[/b] Shut down Sideband
+ - [b]Ctrl-Q[/b] Shut down Sideband
- [b]Ctrl-R[/b] Start LXMF sync (from Conversations screen)
- [b]Ctrl-N[/b] Create new conversation
@@ -5699,20 +6489,27 @@ If you use Reticulum and LXMF on hardware that does not carry any identifiers ti
- [b]Ctrl-Shift-F[/b] add file
- [b]Ctrl-D[/b] or [b]Ctrl-S[/b] Send message
- [b]Voice & PTT[/b]
+ [b]Voice & PTT Messages[/b]
- [b]Space[/b] Start/stop recording
- [b]Enter[/b] Save recording to message
- With PTT enabled, hold [b]Space[/b] to talk
+ [b]Voice Calls[/b]
+ - [b]Ctrl-Space[/b] Answer incoming call
+ - [b]Ctrl-.[/b] Reject incoming call
+ - [b]Ctrl-.[/b] Hang up active call
+
[b]Navigation[/b]
- [b]Ctrl-[i]n[/i][/b] Go to conversation number [i]n[/i]
- [b]Ctrl-R[/b] Go to Conversations
- [b]Ctrl-O[/b] Go to Objects & Devices
+ - [b]Ctrl-E[/b] Go to Voice
- [b]Ctrl-L[/b] Go to Announce Stream
- [b]Ctrl-M[/b] Go to Situation Map
+ - [b]Ctrl-U[/b] Go to Utilities
- [b]Ctrl-T[/b] Go to Telemetry configuration
- [b]Ctrl-G[/b] Go to Guide
- - [b]Ctrl-U[/b] Display own telemetry
+ - [b]Ctrl-Y[/b] Display own telemetry
[b]Map Controls[/b]
- [b]Up[/b], [b]down[/b], [b]left[/b], [b]right[/b] Navigate
@@ -5822,6 +6619,9 @@ class DialogItem(OneLineIconListItem):
class MDMapIconButton(MDIconButton):
pass
+class UIScaling(BoxLayout):
+ pass
+
if not args.daemon:
from kivy.base import ExceptionManager, ExceptionHandler
class SidebandExceptionHandler(ExceptionHandler):
@@ -5844,16 +6644,27 @@ def run():
config_path=args.config,
is_client=False,
verbose=(args.verbose or __debug_build__),
- is_daemon=True
+ quiet=(args.interactive and not args.verbose),
+ is_daemon=True,
+ rns_config_path=args.rnsconfig,
)
sideband.version_str = "v"+__version__+" "+__variant__
sideband.start()
- while True:
- time.sleep(5)
+
+ if args.interactive:
+ while not sideband.getstate("core.started") == True: time.sleep(0.1)
+ from .sideband import console
+ console.attach(sideband)
+
+ else:
+ while True: time.sleep(5)
else:
ExceptionManager.add_handler(SidebandExceptionHandler())
SidebandApp().run()
if __name__ == "__main__":
run()
+
+if __name__ == "sbapp.main":
+ run()
\ No newline at end of file
diff --git a/sbapp/md/__init__.py b/sbapp/md/__init__.py
new file mode 100644
index 0000000..42253a8
--- /dev/null
+++ b/sbapp/md/__init__.py
@@ -0,0 +1 @@
+from .md import mdconv
\ No newline at end of file
diff --git a/sbapp/md/md.py b/sbapp/md/md.py
new file mode 100644
index 0000000..f2c3f6b
--- /dev/null
+++ b/sbapp/md/md.py
@@ -0,0 +1,110 @@
+import mistune
+from mistune.core import BaseRenderer
+from mistune.plugins.formatting import strikethrough, mark, superscript, subscript, insert
+from mistune.plugins.table import table, table_in_list
+from mistune.plugins.footnotes import footnotes
+from mistune.plugins.task_lists import task_lists
+from mistune.plugins.spoiler import spoiler
+from mistune.util import escape as escape_text, safe_entity
+
+def mdconv(markdown_text, domain=None, debug=False):
+ parser = mistune.create_markdown(renderer=BBRenderer(), plugins=[strikethrough, mark, superscript, subscript, insert, footnotes, task_lists, spoiler])
+ return parser(markdown_text)
+
+class BBRenderer(BaseRenderer):
+ NAME = "bbcode"
+
+ def __init__(self, escape=False):
+ super(BBRenderer, self).__init__()
+ self._escape = escape
+
+ def render_token(self, token, state):
+ func = self._get_method(token["type"])
+ attrs = token.get("attrs")
+
+ if "raw" in token: text = token["raw"]
+ elif "children" in token: text = self.render_tokens(token["children"], state)
+ else:
+ if attrs: return func(**attrs)
+ else: return func()
+
+ if attrs: return func(text, **attrs)
+ else: return func(text)
+
+ # Simple renderers
+ def emphasis(self, text): return f"[i]{text}[/i]"
+ def strong(self, text): return f"[b]{text}[/b]"
+ def codespan(self, text): return f"[icode]{text}[/icode]"
+ def linebreak(self): return "\n"
+ def softbreak(self): return "\n"
+ def list_item(self, text): return f"• {text}\n"
+ def task_list_item(self, text, checked=False): e = "" if checked else ""; return f"{e} {text}\n"
+ def strikethrough(self, text): return f"[s]{text}[/s]"
+ def insert(self, text): return f"[u]{text}[/u]"
+ def inline_spoiler(self, text): return f"[ISPOILER]{text}[/ISPOILER]"
+ def block_spoiler(self, text): return f"[SPOILER]\n{text}\n[/SPOILER]"
+ def block_error(self, text): return f"[color=red][icode]{text}[/icode][/color]\n"
+ def block_html(self, html): return ""
+ def link(self, text, url, title=None): return f"[u]{text}[/u] ({url})"
+ def footnote_ref(self, key, index): return f"[sup][u]{index}[/u][/sup]"
+ def footnotes(self, text): return f"[b]Footnotes[/b]\n{text}"
+ def footnote_item(self, text, key, index): return f"[ANAME=footnote-{index}]{index}[/ANAME]. {text}"
+ def superscript(self, text: str) -> str: return f"[sup]{text}[/sup]"
+ def subscript(self, text): return f"[sub]{text}[/sub]"
+ def block_quote(self, text: str) -> str: return f"| [i]{text}[/i]"
+ def paragraph(self, text): return f"{text}\n\n"
+ def blank_line(self): return ""
+ def block_text(self, text): return text
+
+ # Renderers needing some logic
+ def text(self, text):
+ if self._escape: return escape_text(text)
+ else: return text
+
+ def inline_html(self, html: str) -> str:
+ if self._escape: return escape_text(html)
+ else: return html
+
+ def heading(self, text, level, **attrs):
+ if 1 <= level <= 3: return f"[HEADING={level}]{text}[/HEADING]\n"
+ else: return f"[HEADING=3]{text}[/HEADING]\n"
+
+ def block_code(self, code: str, **attrs) -> str:
+ special_cases = {"plaintext": None, "text": None, "txt": None}
+ if "info" in attrs:
+ lang_info = safe_entity(attrs["info"].strip())
+ lang = lang_info.split(None, 1)[0].lower()
+ bbcode_lang = special_cases.get(lang, lang)
+ if bbcode_lang: return f"[CODE={bbcode_lang}]{escape_text(code)}[/CODE]\n"
+ else: return f"[CODE]{escape_text(code)}[/CODE]\n"
+
+ else: return f"[CODE]{escape_text(code)}[/CODE]\n"
+
+ def list(self, text, ordered, **attrs):
+ depth = 0; sln = ""; tli = ""
+ if "depth" in attrs: depth = attrs["depth"]
+ if depth != 0: sln = "\n"
+ if depth == 0: tli = "\n"
+ def remove_empty_lines(text):
+ lines = text.split("\n")
+ non_empty_lines = [line for line in lines if line.strip() != ""]
+ nli = ""; dlm = "\n"+" "*depth
+ if depth != 0: nli = dlm
+ return nli+dlm.join(non_empty_lines)
+
+ text = remove_empty_lines(text)
+ return sln+text+"\n"+tli
+
+ # TODO: Implement various table types and other special formatting
+ def table(self, children, **attrs): return children
+ def table_head(self, children, **attrs): return children
+ def table_body(self, children, **attrs): return children
+ def table_row(self, children, **attrs): return children
+ def table_cell(self, text, align=None, head=False, **attrs): return f"{text}\n"
+ def def_list(self, text): return f"{text}\n"
+ def def_list_head(self, text): return f"{text}\n"
+ def def_list_item(self, text): return f"{text}\n"
+ def abbr(self, text, title): return text
+ def mark(self, text): return text
+ def image(self, text, url, title=None): return ""
+ def thematic_break(self): return "-------------\n"
\ No newline at end of file
diff --git a/sbapp/patches/intent-filter.xml b/sbapp/patches/intent-filter.xml
index 48850af..37c4df6 100644
--- a/sbapp/patches/intent-filter.xml
+++ b/sbapp/patches/intent-filter.xml
@@ -13,11 +13,26 @@
-
+
+
+
+
+
` and :py:attr:`info.rc `.
+
+ For backwards compatibility, the `MQTTMessageInfo` class is iterable so
+ the old construct of ``(rc, mid) = client.publish(...)`` is still valid.
+
+ rc is MQTT_ERR_SUCCESS to indicate success or MQTT_ERR_NO_CONN if the
+ client is not currently connected. mid is the message ID for the
+ publish request. The mid value can be used to track the publish request
+ by checking against the mid argument in the on_publish() callback if it
+ is defined.
+
+ :raises ValueError: if topic is None, has zero length or is
+ invalid (contains a wildcard), except if the MQTT version used is v5.0.
+ For v5.0, a zero length topic can be used when a Topic Alias has been set.
+ :raises ValueError: if qos is not one of 0, 1 or 2
+ :raises ValueError: if the length of the payload is greater than 268435455 bytes.
+ """
+ if self._protocol != MQTTv5:
+ if topic is None or len(topic) == 0:
+ raise ValueError('Invalid topic.')
+
+ topic_bytes = topic.encode('utf-8')
+
+ self._raise_for_invalid_topic(topic_bytes)
+
+ if qos < 0 or qos > 2:
+ raise ValueError('Invalid QoS level.')
+
+ local_payload = _encode_payload(payload)
+
+ if len(local_payload) > 268435455:
+ raise ValueError('Payload too large.')
+
+ local_mid = self._mid_generate()
+
+ if qos == 0:
+ info = MQTTMessageInfo(local_mid)
+ rc = self._send_publish(
+ local_mid, topic_bytes, local_payload, qos, retain, False, info, properties)
+ info.rc = rc
+ return info
+ else:
+ message = MQTTMessage(local_mid, topic_bytes)
+ message.timestamp = time_func()
+ message.payload = local_payload
+ message.qos = qos
+ message.retain = retain
+ message.dup = False
+ message.properties = properties
+
+ with self._out_message_mutex:
+ if self._max_queued_messages > 0 and len(self._out_messages) >= self._max_queued_messages:
+ message.info.rc = MQTTErrorCode.MQTT_ERR_QUEUE_SIZE
+ return message.info
+
+ if local_mid in self._out_messages:
+ message.info.rc = MQTTErrorCode.MQTT_ERR_QUEUE_SIZE
+ return message.info
+
+ self._out_messages[message.mid] = message
+ if self._max_inflight_messages == 0 or self._inflight_messages < self._max_inflight_messages:
+ self._inflight_messages += 1
+ if qos == 1:
+ message.state = mqtt_ms_wait_for_puback
+ elif qos == 2:
+ message.state = mqtt_ms_wait_for_pubrec
+
+ rc = self._send_publish(message.mid, topic_bytes, message.payload, message.qos, message.retain,
+ message.dup, message.info, message.properties)
+
+ # remove from inflight messages so it will be send after a connection is made
+ if rc == MQTTErrorCode.MQTT_ERR_NO_CONN:
+ self._inflight_messages -= 1
+ message.state = mqtt_ms_publish
+
+ message.info.rc = rc
+ return message.info
+ else:
+ message.state = mqtt_ms_queued
+ message.info.rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+ return message.info
+
+ def username_pw_set(
+ self, username: str | None, password: str | None = None
+ ) -> None:
+ """Set a username and optionally a password for broker authentication.
+
+ Must be called before connect() to have any effect.
+ Requires a broker that supports MQTT v3.1 or more.
+
+ :param str username: The username to authenticate with. Need have no relationship to the client id. Must be str
+ [MQTT-3.1.3-11].
+ Set to None to reset client back to not using username/password for broker authentication.
+ :param str password: The password to authenticate with. Optional, set to None if not required. If it is str, then it
+ will be encoded as UTF-8.
+ """
+
+ # [MQTT-3.1.3-11] User name must be UTF-8 encoded string
+ self._username = None if username is None else username.encode('utf-8')
+ if isinstance(password, str):
+ self._password = password.encode('utf-8')
+ else:
+ self._password = password
+
+ def enable_bridge_mode(self) -> None:
+ """Sets the client in a bridge mode instead of client mode.
+
+ Must be called before `connect()` to have any effect.
+ Requires brokers that support bridge mode.
+
+ Under bridge mode, the broker will identify the client as a bridge and
+ not send it's own messages back to it. Hence a subsciption of # is
+ possible without message loops. This feature also correctly propagates
+ the retain flag on the messages.
+
+ Currently Mosquitto and RSMB support this feature. This feature can
+ be used to create a bridge between multiple broker.
+ """
+ self._client_mode = MQTT_BRIDGE
+
+ def _connection_closed(self) -> bool:
+ """
+ Return true if the connection is closed (and not trying to be opened).
+ """
+ return (
+ self._state == _ConnectionState.MQTT_CS_NEW
+ or (self._state in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED) and self._sock is None))
+
+ def is_connected(self) -> bool:
+ """Returns the current status of the connection
+
+ True if connection exists
+ False if connection is closed
+ """
+ return self._state == _ConnectionState.MQTT_CS_CONNECTED
+
+ def disconnect(
+ self,
+ reasoncode: ReasonCode | None = None,
+ properties: Properties | None = None,
+ ) -> MQTTErrorCode:
+ """Disconnect a connected client from the broker.
+
+ :param ReasonCode reasoncode: (MQTT v5.0 only) a ReasonCode instance setting the MQTT v5.0
+ reasoncode to be sent with the disconnect packet. It is optional, the receiver
+ then assuming that 0 (success) is the value.
+ :param Properties properties: (MQTT v5.0 only) a Properties instance setting the MQTT v5.0 properties
+ to be included. Optional - if not set, no properties are sent.
+ """
+ if self._sock is None:
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTED
+ return MQTT_ERR_NO_CONN
+ else:
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTING
+
+ return self._send_disconnect(reasoncode, properties)
+
+ def subscribe(
+ self,
+ topic: str | tuple[str, int] | tuple[str, SubscribeOptions] | list[tuple[str, int]] | list[tuple[str, SubscribeOptions]],
+ qos: int = 0,
+ options: SubscribeOptions | None = None,
+ properties: Properties | None = None,
+ ) -> tuple[MQTTErrorCode, int | None]:
+ """Subscribe the client to one or more topics.
+
+ This function may be called in three different ways (and a further three for MQTT v5.0):
+
+ Simple string and integer
+ -------------------------
+ e.g. subscribe("my/topic", 2)
+
+ :topic: A string specifying the subscription topic to subscribe to.
+ :qos: The desired quality of service level for the subscription.
+ Defaults to 0.
+ :options and properties: Not used.
+
+ Simple string and subscribe options (MQTT v5.0 only)
+ ----------------------------------------------------
+ e.g. subscribe("my/topic", options=SubscribeOptions(qos=2))
+
+ :topic: A string specifying the subscription topic to subscribe to.
+ :qos: Not used.
+ :options: The MQTT v5.0 subscribe options.
+ :properties: a Properties instance setting the MQTT v5.0 properties
+ to be included. Optional - if not set, no properties are sent.
+
+ String and integer tuple
+ ------------------------
+ e.g. subscribe(("my/topic", 1))
+
+ :topic: A tuple of (topic, qos). Both topic and qos must be present in
+ the tuple.
+ :qos and options: Not used.
+ :properties: Only used for MQTT v5.0. A Properties instance setting the
+ MQTT v5.0 properties. Optional - if not set, no properties are sent.
+
+ String and subscribe options tuple (MQTT v5.0 only)
+ ---------------------------------------------------
+ e.g. subscribe(("my/topic", SubscribeOptions(qos=1)))
+
+ :topic: A tuple of (topic, SubscribeOptions). Both topic and subscribe
+ options must be present in the tuple.
+ :qos and options: Not used.
+ :properties: a Properties instance setting the MQTT v5.0 properties
+ to be included. Optional - if not set, no properties are sent.
+
+ List of string and integer tuples
+ ---------------------------------
+ e.g. subscribe([("my/topic", 0), ("another/topic", 2)])
+
+ This allows multiple topic subscriptions in a single SUBSCRIPTION
+ command, which is more efficient than using multiple calls to
+ subscribe().
+
+ :topic: A list of tuple of format (topic, qos). Both topic and qos must
+ be present in all of the tuples.
+ :qos, options and properties: Not used.
+
+ List of string and subscribe option tuples (MQTT v5.0 only)
+ -----------------------------------------------------------
+ e.g. subscribe([("my/topic", SubscribeOptions(qos=0), ("another/topic", SubscribeOptions(qos=2)])
+
+ This allows multiple topic subscriptions in a single SUBSCRIPTION
+ command, which is more efficient than using multiple calls to
+ subscribe().
+
+ :topic: A list of tuple of format (topic, SubscribeOptions). Both topic and subscribe
+ options must be present in all of the tuples.
+ :qos and options: Not used.
+ :properties: a Properties instance setting the MQTT v5.0 properties
+ to be included. Optional - if not set, no properties are sent.
+
+ The function returns a tuple (result, mid), where result is
+ MQTT_ERR_SUCCESS to indicate success or (MQTT_ERR_NO_CONN, None) if the
+ client is not currently connected. mid is the message ID for the
+ subscribe request. The mid value can be used to track the subscribe
+ request by checking against the mid argument in the on_subscribe()
+ callback if it is defined.
+
+ Raises a ValueError if qos is not 0, 1 or 2, or if topic is None or has
+ zero string length, or if topic is not a string, tuple or list.
+ """
+ topic_qos_list = None
+
+ if isinstance(topic, tuple):
+ if self._protocol == MQTTv5:
+ topic, options = topic # type: ignore
+ if not isinstance(options, SubscribeOptions):
+ raise ValueError(
+ 'Subscribe options must be instance of SubscribeOptions class.')
+ else:
+ topic, qos = topic # type: ignore
+
+ if isinstance(topic, (bytes, str)):
+ if qos < 0 or qos > 2:
+ raise ValueError('Invalid QoS level.')
+ if self._protocol == MQTTv5:
+ if options is None:
+ # if no options are provided, use the QoS passed instead
+ options = SubscribeOptions(qos=qos)
+ elif qos != 0:
+ raise ValueError(
+ 'Subscribe options and qos parameters cannot be combined.')
+ if not isinstance(options, SubscribeOptions):
+ raise ValueError(
+ 'Subscribe options must be instance of SubscribeOptions class.')
+ topic_qos_list = [(topic.encode('utf-8'), options)]
+ else:
+ if topic is None or len(topic) == 0:
+ raise ValueError('Invalid topic.')
+ topic_qos_list = [(topic.encode('utf-8'), qos)] # type: ignore
+ elif isinstance(topic, list):
+ if len(topic) == 0:
+ raise ValueError('Empty topic list')
+ topic_qos_list = []
+ if self._protocol == MQTTv5:
+ for t, o in topic:
+ if not isinstance(o, SubscribeOptions):
+ # then the second value should be QoS
+ if o < 0 or o > 2:
+ raise ValueError('Invalid QoS level.')
+ o = SubscribeOptions(qos=o)
+ topic_qos_list.append((t.encode('utf-8'), o))
+ else:
+ for t, q in topic:
+ if isinstance(q, SubscribeOptions) or q < 0 or q > 2:
+ raise ValueError('Invalid QoS level.')
+ if t is None or len(t) == 0 or not isinstance(t, (bytes, str)):
+ raise ValueError('Invalid topic.')
+ topic_qos_list.append((t.encode('utf-8'), q)) # type: ignore
+
+ if topic_qos_list is None:
+ raise ValueError("No topic specified, or incorrect topic type.")
+
+ if any(self._filter_wildcard_len_check(topic) != MQTT_ERR_SUCCESS for topic, _ in topic_qos_list):
+ raise ValueError('Invalid subscription filter.')
+
+ if self._sock is None:
+ return (MQTT_ERR_NO_CONN, None)
+
+ return self._send_subscribe(False, topic_qos_list, properties)
+
+ def unsubscribe(
+ self, topic: str | list[str], properties: Properties | None = None
+ ) -> tuple[MQTTErrorCode, int | None]:
+ """Unsubscribe the client from one or more topics.
+
+ :param topic: A single string, or list of strings that are the subscription
+ topics to unsubscribe from.
+ :param properties: (MQTT v5.0 only) a Properties instance setting the MQTT v5.0 properties
+ to be included. Optional - if not set, no properties are sent.
+
+ Returns a tuple (result, mid), where result is MQTT_ERR_SUCCESS
+ to indicate success or (MQTT_ERR_NO_CONN, None) if the client is not
+ currently connected.
+ mid is the message ID for the unsubscribe request. The mid value can be
+ used to track the unsubscribe request by checking against the mid
+ argument in the on_unsubscribe() callback if it is defined.
+
+ :raises ValueError: if topic is None or has zero string length, or is
+ not a string or list.
+ """
+ topic_list = None
+ if topic is None:
+ raise ValueError('Invalid topic.')
+ if isinstance(topic, (bytes, str)):
+ if len(topic) == 0:
+ raise ValueError('Invalid topic.')
+ topic_list = [topic.encode('utf-8')]
+ elif isinstance(topic, list):
+ topic_list = []
+ for t in topic:
+ if len(t) == 0 or not isinstance(t, (bytes, str)):
+ raise ValueError('Invalid topic.')
+ topic_list.append(t.encode('utf-8'))
+
+ if topic_list is None:
+ raise ValueError("No topic specified, or incorrect topic type.")
+
+ if self._sock is None:
+ return (MQTTErrorCode.MQTT_ERR_NO_CONN, None)
+
+ return self._send_unsubscribe(False, topic_list, properties)
+
+ def loop_read(self, max_packets: int = 1) -> MQTTErrorCode:
+ """Process read network events. Use in place of calling `loop()` if you
+ wish to handle your client reads as part of your own application.
+
+ Use `socket()` to obtain the client socket to call select() or equivalent
+ on.
+
+ Do not use if you are using `loop_start()` or `loop_forever()`."""
+ if self._sock is None:
+ return MQTTErrorCode.MQTT_ERR_NO_CONN
+
+ max_packets = len(self._out_messages) + len(self._in_messages)
+ if max_packets < 1:
+ max_packets = 1
+
+ for _ in range(0, max_packets):
+ if self._sock is None:
+ return MQTTErrorCode.MQTT_ERR_NO_CONN
+ rc = self._packet_read()
+ if rc > 0:
+ return self._loop_rc_handle(rc)
+ elif rc == MQTTErrorCode.MQTT_ERR_AGAIN:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def loop_write(self) -> MQTTErrorCode:
+ """Process write network events. Use in place of calling `loop()` if you
+ wish to handle your client writes as part of your own application.
+
+ Use `socket()` to obtain the client socket to call select() or equivalent
+ on.
+
+ Use `want_write()` to determine if there is data waiting to be written.
+
+ Do not use if you are using `loop_start()` or `loop_forever()`."""
+ if self._sock is None:
+ return MQTTErrorCode.MQTT_ERR_NO_CONN
+
+ try:
+ rc = self._packet_write()
+ if rc == MQTTErrorCode.MQTT_ERR_AGAIN:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ elif rc > 0:
+ return self._loop_rc_handle(rc)
+ else:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ finally:
+ if self.want_write():
+ self._call_socket_register_write()
+ else:
+ self._call_socket_unregister_write()
+
+ def want_write(self) -> bool:
+ """Call to determine if there is network data waiting to be written.
+ Useful if you are calling select() yourself rather than using `loop()`, `loop_start()` or `loop_forever()`.
+ """
+ return len(self._out_packet) > 0
+
+ def loop_misc(self) -> MQTTErrorCode:
+ """Process miscellaneous network events. Use in place of calling `loop()` if you
+ wish to call select() or equivalent on.
+
+ Do not use if you are using `loop_start()` or `loop_forever()`."""
+ if self._sock is None:
+ return MQTTErrorCode.MQTT_ERR_NO_CONN
+
+ now = time_func()
+ self._check_keepalive()
+
+ if self._ping_t > 0 and now - self._ping_t >= self._keepalive:
+ # client->ping_t != 0 means we are waiting for a pingresp.
+ # This hasn't happened in the keepalive time so we should disconnect.
+ self._sock_close()
+
+ if self._state in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED):
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTED
+ rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+ else:
+ self._state = _ConnectionState.MQTT_CS_CONNECTION_LOST
+ rc = MQTTErrorCode.MQTT_ERR_KEEPALIVE
+
+ self._do_on_disconnect(
+ packet_from_broker=False,
+ v1_rc=rc,
+ )
+
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def max_inflight_messages_set(self, inflight: int) -> None:
+ """Set the maximum number of messages with QoS>0 that can be part way
+ through their network flow at once. Defaults to 20."""
+ self.max_inflight_messages = inflight
+
+ def max_queued_messages_set(self, queue_size: int) -> Client:
+ """Set the maximum number of messages in the outgoing message queue.
+ 0 means unlimited."""
+ if not isinstance(queue_size, int):
+ raise ValueError('Invalid type of queue size.')
+ self.max_queued_messages = queue_size
+ return self
+
+ def user_data_set(self, userdata: Any) -> None:
+ """Set the user data variable passed to callbacks. May be any data type."""
+ self._userdata = userdata
+
+ def user_data_get(self) -> Any:
+ """Get the user data variable passed to callbacks. May be any data type."""
+ return self._userdata
+
+ def will_set(
+ self,
+ topic: str,
+ payload: PayloadType = None,
+ qos: int = 0,
+ retain: bool = False,
+ properties: Properties | None = None,
+ ) -> None:
+ """Set a Will to be sent by the broker in case the client disconnects unexpectedly.
+
+ This must be called before connect() to have any effect.
+
+ :param str topic: The topic that the will message should be published on.
+ :param payload: The message to send as a will. If not given, or set to None a
+ zero length message will be used as the will. Passing an int or float
+ will result in the payload being converted to a string representing
+ that number. If you wish to send a true int/float, use struct.pack() to
+ create the payload you require.
+ :param int qos: The quality of service level to use for the will.
+ :param bool retain: If set to true, the will message will be set as the "last known
+ good"/retained message for the topic.
+ :param Properties properties: (MQTT v5.0 only) the MQTT v5.0 properties
+ to be included with the will message. Optional - if not set, no properties are sent.
+
+ :raises ValueError: if qos is not 0, 1 or 2, or if topic is None or has
+ zero string length.
+
+ See `will_clear` to clear will. Note that will are NOT send if the client disconnect cleanly
+ for example by calling `disconnect()`.
+ """
+ if topic is None or len(topic) == 0:
+ raise ValueError('Invalid topic.')
+
+ if qos < 0 or qos > 2:
+ raise ValueError('Invalid QoS level.')
+
+ if properties and not isinstance(properties, Properties):
+ raise ValueError(
+ "The properties argument must be an instance of the Properties class.")
+
+ self._will_payload = _encode_payload(payload)
+ self._will = True
+ self._will_topic = topic.encode('utf-8')
+ self._will_qos = qos
+ self._will_retain = retain
+ self._will_properties = properties
+
+ def will_clear(self) -> None:
+ """ Removes a will that was previously configured with `will_set()`.
+
+ Must be called before connect() to have any effect."""
+ self._will = False
+ self._will_topic = b""
+ self._will_payload = b""
+ self._will_qos = 0
+ self._will_retain = False
+
+ def socket(self) -> SocketLike | None:
+ """Return the socket or ssl object for this client."""
+ return self._sock
+
+ def loop_forever(
+ self,
+ timeout: float = 1.0,
+ retry_first_connection: bool = False,
+ ) -> MQTTErrorCode:
+ """This function calls the network loop functions for you in an
+ infinite blocking loop. It is useful for the case where you only want
+ to run the MQTT client loop in your program.
+
+ loop_forever() will handle reconnecting for you if reconnect_on_failure is
+ true (this is the default behavior). If you call `disconnect()` in a callback
+ it will return.
+
+ :param int timeout: The time in seconds to wait for incoming/outgoing network
+ traffic before timing out and returning.
+ :param bool retry_first_connection: Should the first connection attempt be retried on failure.
+ This is independent of the reconnect_on_failure setting.
+
+ :raises OSError: if the first connection fail unless retry_first_connection=True
+ """
+
+ run = True
+
+ while run:
+ if self._thread_terminate is True:
+ break
+
+ if self._state == _ConnectionState.MQTT_CS_CONNECT_ASYNC:
+ try:
+ self.reconnect()
+ except OSError:
+ self._handle_on_connect_fail()
+ if not retry_first_connection:
+ raise
+ self._easy_log(
+ MQTT_LOG_DEBUG, "Connection failed, retrying")
+ self._reconnect_wait()
+ else:
+ break
+
+ while run:
+ rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+ while rc == MQTTErrorCode.MQTT_ERR_SUCCESS:
+ rc = self._loop(timeout)
+ # We don't need to worry about locking here, because we've
+ # either called loop_forever() when in single threaded mode, or
+ # in multi threaded mode when loop_stop() has been called and
+ # so no other threads can access _out_packet or _messages.
+ if (self._thread_terminate is True
+ and len(self._out_packet) == 0
+ and len(self._out_messages) == 0):
+ rc = MQTTErrorCode.MQTT_ERR_NOMEM
+ run = False
+
+ def should_exit() -> bool:
+ return (
+ self._state in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED) or
+ run is False or # noqa: B023 (uses the run variable from the outer scope on purpose)
+ self._thread_terminate is True
+ )
+
+ if should_exit() or not self._reconnect_on_failure:
+ run = False
+ else:
+ self._reconnect_wait()
+
+ if should_exit():
+ run = False
+ else:
+ try:
+ self.reconnect()
+ except OSError:
+ self._handle_on_connect_fail()
+ self._easy_log(
+ MQTT_LOG_DEBUG, "Connection failed, retrying")
+
+ return rc
+
+ def loop_start(self) -> MQTTErrorCode:
+ """This is part of the threaded client interface. Call this once to
+ start a new thread to process network traffic. This provides an
+ alternative to repeatedly calling `loop()` yourself.
+
+ Under the hood, this will call `loop_forever` in a thread, which means that
+ the thread will terminate if you call `disconnect()`
+ """
+ if self._thread is not None:
+ return MQTTErrorCode.MQTT_ERR_INVAL
+
+ self._sockpairR, self._sockpairW = _socketpair_compat()
+ self._thread_terminate = False
+ self._thread = threading.Thread(target=self._thread_main, name=f"paho-mqtt-client-{self._client_id.decode()}")
+ self._thread.daemon = True
+ self._thread.start()
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def loop_stop(self) -> MQTTErrorCode:
+ """This is part of the threaded client interface. Call this once to
+ stop the network thread previously created with `loop_start()`. This call
+ will block until the network thread finishes.
+
+ This don't guarantee that publish packet are sent, use `wait_for_publish` or
+ `on_publish` to ensure `publish` are sent.
+ """
+ if self._thread is None:
+ return MQTTErrorCode.MQTT_ERR_INVAL
+
+ self._thread_terminate = True
+ if threading.current_thread() != self._thread:
+ self._thread.join()
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ @property
+ def callback_api_version(self) -> CallbackAPIVersion:
+ """
+ Return the callback API version used for user-callback. See docstring for
+ each user-callback (`on_connect`, `on_publish`, ...) for details.
+
+ This property is read-only.
+ """
+ return self._callback_api_version
+
+ @property
+ def on_log(self) -> CallbackOnLog | None:
+ """The callback called when the client has log information.
+ Defined to allow debugging.
+
+ Expected signature is::
+
+ log_callback(client, userdata, level, buf)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param int level: gives the severity of the message and will be one of
+ MQTT_LOG_INFO, MQTT_LOG_NOTICE, MQTT_LOG_WARNING,
+ MQTT_LOG_ERR, and MQTT_LOG_DEBUG.
+ :param str buf: the message itself
+
+ Decorator: @client.log_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_log
+
+ @on_log.setter
+ def on_log(self, func: CallbackOnLog | None) -> None:
+ self._on_log = func
+
+ def log_callback(self) -> Callable[[CallbackOnLog], CallbackOnLog]:
+ def decorator(func: CallbackOnLog) -> CallbackOnLog:
+ self.on_log = func
+ return func
+ return decorator
+
+ @property
+ def on_pre_connect(self) -> CallbackOnPreConnect | None:
+ """The callback called immediately prior to the connection is made
+ request.
+
+ Expected signature (for all callback API version)::
+
+ connect_callback(client, userdata)
+
+ :parama Client client: the client instance for this callback
+ :parama userdata: the private user data as set in Client() or user_data_set()
+
+ Decorator: @client.pre_connect_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+
+ """
+ return self._on_pre_connect
+
+ @on_pre_connect.setter
+ def on_pre_connect(self, func: CallbackOnPreConnect | None) -> None:
+ with self._callback_mutex:
+ self._on_pre_connect = func
+
+ def pre_connect_callback(
+ self,
+ ) -> Callable[[CallbackOnPreConnect], CallbackOnPreConnect]:
+ def decorator(func: CallbackOnPreConnect) -> CallbackOnPreConnect:
+ self.on_pre_connect = func
+ return func
+ return decorator
+
+ @property
+ def on_connect(self) -> CallbackOnConnect | None:
+ """The callback called when the broker reponds to our connection request.
+
+ Expected signature for callback API version 2::
+
+ connect_callback(client, userdata, connect_flags, reason_code, properties)
+
+ Expected signature for callback API version 1 change with MQTT protocol version:
+ * For MQTT v3.1 and v3.1.1 it's::
+
+ connect_callback(client, userdata, flags, rc)
+
+ * For MQTT v5.0 it's::
+
+ connect_callback(client, userdata, flags, reason_code, properties)
+
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param ConnectFlags connect_flags: the flags for this connection
+ :param ReasonCode reason_code: the connection reason code received from the broken.
+ In MQTT v5.0 it's the reason code defined by the standard.
+ In MQTT v3, we convert return code to a reason code, see
+ `convert_connack_rc_to_reason_code()`.
+ `ReasonCode` may be compared to integer.
+ :param Properties properties: the MQTT v5.0 properties received from the broker.
+ For MQTT v3.1 and v3.1.1 properties is not provided and an empty Properties
+ object is always used.
+ :param dict flags: response flags sent by the broker
+ :param int rc: the connection result, should have a value of `ConnackCode`
+
+ flags is a dict that contains response flags from the broker:
+ flags['session present'] - this flag is useful for clients that are
+ using clean session set to 0 only. If a client with clean
+ session=0, that reconnects to a broker that it has previously
+ connected to, this flag indicates whether the broker still has the
+ session information for the client. If 1, the session still exists.
+
+ The value of rc indicates success or not:
+ - 0: Connection successful
+ - 1: Connection refused - incorrect protocol version
+ - 2: Connection refused - invalid client identifier
+ - 3: Connection refused - server unavailable
+ - 4: Connection refused - bad username or password
+ - 5: Connection refused - not authorised
+ - 6-255: Currently unused.
+
+ Decorator: @client.connect_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_connect
+
+ @on_connect.setter
+ def on_connect(self, func: CallbackOnConnect | None) -> None:
+ with self._callback_mutex:
+ self._on_connect = func
+
+ def connect_callback(
+ self,
+ ) -> Callable[[CallbackOnConnect], CallbackOnConnect]:
+ def decorator(func: CallbackOnConnect) -> CallbackOnConnect:
+ self.on_connect = func
+ return func
+ return decorator
+
+ @property
+ def on_connect_fail(self) -> CallbackOnConnectFail | None:
+ """The callback called when the client failed to connect
+ to the broker.
+
+ Expected signature is (for all callback_api_version)::
+
+ connect_fail_callback(client, userdata)
+
+ :param Client client: the client instance for this callback
+ :parama userdata: the private user data as set in Client() or user_data_set()
+
+ Decorator: @client.connect_fail_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_connect_fail
+
+ @on_connect_fail.setter
+ def on_connect_fail(self, func: CallbackOnConnectFail | None) -> None:
+ with self._callback_mutex:
+ self._on_connect_fail = func
+
+ def connect_fail_callback(
+ self,
+ ) -> Callable[[CallbackOnConnectFail], CallbackOnConnectFail]:
+ def decorator(func: CallbackOnConnectFail) -> CallbackOnConnectFail:
+ self.on_connect_fail = func
+ return func
+ return decorator
+
+ @property
+ def on_subscribe(self) -> CallbackOnSubscribe | None:
+ """The callback called when the broker responds to a subscribe
+ request.
+
+ Expected signature for callback API version 2::
+
+ subscribe_callback(client, userdata, mid, reason_code_list, properties)
+
+ Expected signature for callback API version 1 change with MQTT protocol version:
+ * For MQTT v3.1 and v3.1.1 it's::
+
+ subscribe_callback(client, userdata, mid, granted_qos)
+
+ * For MQTT v5.0 it's::
+
+ subscribe_callback(client, userdata, mid, reason_code_list, properties)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param int mid: matches the mid variable returned from the corresponding
+ subscribe() call.
+ :param list[ReasonCode] reason_code_list: reason codes received from the broker for each subscription.
+ In MQTT v5.0 it's the reason code defined by the standard.
+ In MQTT v3, we convert granted QoS to a reason code.
+ It's a list of ReasonCode instances.
+ :param Properties properties: the MQTT v5.0 properties received from the broker.
+ For MQTT v3.1 and v3.1.1 properties is not provided and an empty Properties
+ object is always used.
+ :param list[int] granted_qos: list of integers that give the QoS level the broker has
+ granted for each of the different subscription requests.
+
+ Decorator: @client.subscribe_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_subscribe
+
+ @on_subscribe.setter
+ def on_subscribe(self, func: CallbackOnSubscribe | None) -> None:
+ with self._callback_mutex:
+ self._on_subscribe = func
+
+ def subscribe_callback(
+ self,
+ ) -> Callable[[CallbackOnSubscribe], CallbackOnSubscribe]:
+ def decorator(func: CallbackOnSubscribe) -> CallbackOnSubscribe:
+ self.on_subscribe = func
+ return func
+ return decorator
+
+ @property
+ def on_message(self) -> CallbackOnMessage | None:
+ """The callback called when a message has been received on a topic
+ that the client subscribes to.
+
+ This callback will be called for every message received unless a
+ `message_callback_add()` matched the message.
+
+ Expected signature is (for all callback API version):
+ message_callback(client, userdata, message)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param MQTTMessage message: the received message.
+ This is a class with members topic, payload, qos, retain.
+
+ Decorator: @client.message_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_message
+
+ @on_message.setter
+ def on_message(self, func: CallbackOnMessage | None) -> None:
+ with self._callback_mutex:
+ self._on_message = func
+
+ def message_callback(
+ self,
+ ) -> Callable[[CallbackOnMessage], CallbackOnMessage]:
+ def decorator(func: CallbackOnMessage) -> CallbackOnMessage:
+ self.on_message = func
+ return func
+ return decorator
+
+ @property
+ def on_publish(self) -> CallbackOnPublish | None:
+ """The callback called when a message that was to be sent using the
+ `publish()` call has completed transmission to the broker.
+
+ For messages with QoS levels 1 and 2, this means that the appropriate
+ handshakes have completed. For QoS 0, this simply means that the message
+ has left the client.
+ This callback is important because even if the `publish()` call returns
+ success, it does not always mean that the message has been sent.
+
+ See also `wait_for_publish` which could be simpler to use.
+
+ Expected signature for callback API version 2::
+
+ publish_callback(client, userdata, mid, reason_code, properties)
+
+ Expected signature for callback API version 1::
+
+ publish_callback(client, userdata, mid)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param int mid: matches the mid variable returned from the corresponding
+ `publish()` call, to allow outgoing messages to be tracked.
+ :param ReasonCode reason_code: the connection reason code received from the broken.
+ In MQTT v5.0 it's the reason code defined by the standard.
+ In MQTT v3 it's always the reason code Success
+ :parama Properties properties: the MQTT v5.0 properties received from the broker.
+ For MQTT v3.1 and v3.1.1 properties is not provided and an empty Properties
+ object is always used.
+
+ Note: for QoS = 0, the reason_code and the properties don't really exist, it's the client
+ library that generate them. It's always an empty properties and a success reason code.
+ Because the (MQTTv5) standard don't have reason code for PUBLISH packet, the library create them
+ at PUBACK packet, as if the message was sent with QoS = 1.
+
+ Decorator: @client.publish_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+
+ """
+ return self._on_publish
+
+ @on_publish.setter
+ def on_publish(self, func: CallbackOnPublish | None) -> None:
+ with self._callback_mutex:
+ self._on_publish = func
+
+ def publish_callback(
+ self,
+ ) -> Callable[[CallbackOnPublish], CallbackOnPublish]:
+ def decorator(func: CallbackOnPublish) -> CallbackOnPublish:
+ self.on_publish = func
+ return func
+ return decorator
+
+ @property
+ def on_unsubscribe(self) -> CallbackOnUnsubscribe | None:
+ """The callback called when the broker responds to an unsubscribe
+ request.
+
+ Expected signature for callback API version 2::
+
+ unsubscribe_callback(client, userdata, mid, reason_code_list, properties)
+
+ Expected signature for callback API version 1 change with MQTT protocol version:
+ * For MQTT v3.1 and v3.1.1 it's::
+
+ unsubscribe_callback(client, userdata, mid)
+
+ * For MQTT v5.0 it's::
+
+ unsubscribe_callback(client, userdata, mid, properties, v1_reason_codes)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param mid: matches the mid variable returned from the corresponding
+ unsubscribe() call.
+ :param list[ReasonCode] reason_code_list: reason codes received from the broker for each unsubscription.
+ In MQTT v5.0 it's the reason code defined by the standard.
+ In MQTT v3, there is not equivalent from broken and empty list
+ is always used.
+ :param Properties properties: the MQTT v5.0 properties received from the broker.
+ For MQTT v3.1 and v3.1.1 properties is not provided and an empty Properties
+ object is always used.
+ :param v1_reason_codes: the MQTT v5.0 reason codes received from the broker for each
+ unsubscribe topic. A list of ReasonCode instances OR a single
+ ReasonCode when we unsubscribe from a single topic.
+
+ Decorator: @client.unsubscribe_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_unsubscribe
+
+ @on_unsubscribe.setter
+ def on_unsubscribe(self, func: CallbackOnUnsubscribe | None) -> None:
+ with self._callback_mutex:
+ self._on_unsubscribe = func
+
+ def unsubscribe_callback(
+ self,
+ ) -> Callable[[CallbackOnUnsubscribe], CallbackOnUnsubscribe]:
+ def decorator(func: CallbackOnUnsubscribe) -> CallbackOnUnsubscribe:
+ self.on_unsubscribe = func
+ return func
+ return decorator
+
+ @property
+ def on_disconnect(self) -> CallbackOnDisconnect | None:
+ """The callback called when the client disconnects from the broker.
+
+ Expected signature for callback API version 2::
+
+ disconnect_callback(client, userdata, disconnect_flags, reason_code, properties)
+
+ Expected signature for callback API version 1 change with MQTT protocol version:
+ * For MQTT v3.1 and v3.1.1 it's::
+
+ disconnect_callback(client, userdata, rc)
+
+ * For MQTT v5.0 it's::
+
+ disconnect_callback(client, userdata, reason_code, properties)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param DisconnectFlag disconnect_flags: the flags for this disconnection.
+ :param ReasonCode reason_code: the disconnection reason code possibly received from the broker (see disconnect_flags).
+ In MQTT v5.0 it's the reason code defined by the standard.
+ In MQTT v3 it's never received from the broker, we convert an MQTTErrorCode,
+ see `convert_disconnect_error_code_to_reason_code()`.
+ `ReasonCode` may be compared to integer.
+ :param Properties properties: the MQTT v5.0 properties received from the broker.
+ For MQTT v3.1 and v3.1.1 properties is not provided and an empty Properties
+ object is always used.
+ :param int rc: the disconnection result
+ The rc parameter indicates the disconnection state. If
+ MQTT_ERR_SUCCESS (0), the callback was called in response to
+ a disconnect() call. If any other value the disconnection
+ was unexpected, such as might be caused by a network error.
+
+ Decorator: @client.disconnect_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+
+ """
+ return self._on_disconnect
+
+ @on_disconnect.setter
+ def on_disconnect(self, func: CallbackOnDisconnect | None) -> None:
+ with self._callback_mutex:
+ self._on_disconnect = func
+
+ def disconnect_callback(
+ self,
+ ) -> Callable[[CallbackOnDisconnect], CallbackOnDisconnect]:
+ def decorator(func: CallbackOnDisconnect) -> CallbackOnDisconnect:
+ self.on_disconnect = func
+ return func
+ return decorator
+
+ @property
+ def on_socket_open(self) -> CallbackOnSocket | None:
+ """The callback called just after the socket was opend.
+
+ This should be used to register the socket to an external event loop for reading.
+
+ Expected signature is (for all callback API version)::
+
+ socket_open_callback(client, userdata, socket)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param SocketLike sock: the socket which was just opened.
+
+ Decorator: @client.socket_open_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_socket_open
+
+ @on_socket_open.setter
+ def on_socket_open(self, func: CallbackOnSocket | None) -> None:
+ with self._callback_mutex:
+ self._on_socket_open = func
+
+ def socket_open_callback(
+ self,
+ ) -> Callable[[CallbackOnSocket], CallbackOnSocket]:
+ def decorator(func: CallbackOnSocket) -> CallbackOnSocket:
+ self.on_socket_open = func
+ return func
+ return decorator
+
+ def _call_socket_open(self, sock: SocketLike) -> None:
+ """Call the socket_open callback with the just-opened socket"""
+ with self._callback_mutex:
+ on_socket_open = self.on_socket_open
+
+ if on_socket_open:
+ with self._in_callback_mutex:
+ try:
+ on_socket_open(self, self._userdata, sock)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_socket_open: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ @property
+ def on_socket_close(self) -> CallbackOnSocket | None:
+ """The callback called just before the socket is closed.
+
+ This should be used to unregister the socket from an external event loop for reading.
+
+ Expected signature is (for all callback API version)::
+
+ socket_close_callback(client, userdata, socket)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param SocketLike sock: the socket which is about to be closed.
+
+ Decorator: @client.socket_close_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_socket_close
+
+ @on_socket_close.setter
+ def on_socket_close(self, func: CallbackOnSocket | None) -> None:
+ with self._callback_mutex:
+ self._on_socket_close = func
+
+ def socket_close_callback(
+ self,
+ ) -> Callable[[CallbackOnSocket], CallbackOnSocket]:
+ def decorator(func: CallbackOnSocket) -> CallbackOnSocket:
+ self.on_socket_close = func
+ return func
+ return decorator
+
+ def _call_socket_close(self, sock: SocketLike) -> None:
+ """Call the socket_close callback with the about-to-be-closed socket"""
+ with self._callback_mutex:
+ on_socket_close = self.on_socket_close
+
+ if on_socket_close:
+ with self._in_callback_mutex:
+ try:
+ on_socket_close(self, self._userdata, sock)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_socket_close: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ @property
+ def on_socket_register_write(self) -> CallbackOnSocket | None:
+ """The callback called when the socket needs writing but can't.
+
+ This should be used to register the socket with an external event loop for writing.
+
+ Expected signature is (for all callback API version)::
+
+ socket_register_write_callback(client, userdata, socket)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param SocketLike sock: the socket which should be registered for writing
+
+ Decorator: @client.socket_register_write_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_socket_register_write
+
+ @on_socket_register_write.setter
+ def on_socket_register_write(self, func: CallbackOnSocket | None) -> None:
+ with self._callback_mutex:
+ self._on_socket_register_write = func
+
+ def socket_register_write_callback(
+ self,
+ ) -> Callable[[CallbackOnSocket], CallbackOnSocket]:
+ def decorator(func: CallbackOnSocket) -> CallbackOnSocket:
+ self._on_socket_register_write = func
+ return func
+ return decorator
+
+ def _call_socket_register_write(self) -> None:
+ """Call the socket_register_write callback with the unwritable socket"""
+ if not self._sock or self._registered_write:
+ return
+ self._registered_write = True
+ with self._callback_mutex:
+ on_socket_register_write = self.on_socket_register_write
+
+ if on_socket_register_write:
+ try:
+ on_socket_register_write(
+ self, self._userdata, self._sock)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_socket_register_write: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ @property
+ def on_socket_unregister_write(
+ self,
+ ) -> CallbackOnSocket | None:
+ """The callback called when the socket doesn't need writing anymore.
+
+ This should be used to unregister the socket from an external event loop for writing.
+
+ Expected signature is (for all callback API version)::
+
+ socket_unregister_write_callback(client, userdata, socket)
+
+ :param Client client: the client instance for this callback
+ :param userdata: the private user data as set in Client() or user_data_set()
+ :param SocketLike sock: the socket which should be unregistered for writing
+
+ Decorator: @client.socket_unregister_write_callback() (``client`` is the name of the
+ instance which this callback is being attached to)
+ """
+ return self._on_socket_unregister_write
+
+ @on_socket_unregister_write.setter
+ def on_socket_unregister_write(
+ self, func: CallbackOnSocket | None
+ ) -> None:
+ with self._callback_mutex:
+ self._on_socket_unregister_write = func
+
+ def socket_unregister_write_callback(
+ self,
+ ) -> Callable[[CallbackOnSocket], CallbackOnSocket]:
+ def decorator(
+ func: CallbackOnSocket,
+ ) -> CallbackOnSocket:
+ self._on_socket_unregister_write = func
+ return func
+ return decorator
+
+ def _call_socket_unregister_write(
+ self, sock: SocketLike | None = None
+ ) -> None:
+ """Call the socket_unregister_write callback with the writable socket"""
+ sock = sock or self._sock
+ if not sock or not self._registered_write:
+ return
+ self._registered_write = False
+
+ with self._callback_mutex:
+ on_socket_unregister_write = self.on_socket_unregister_write
+
+ if on_socket_unregister_write:
+ try:
+ on_socket_unregister_write(self, self._userdata, sock)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_socket_unregister_write: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ def message_callback_add(self, sub: str, callback: CallbackOnMessage) -> None:
+ """Register a message callback for a specific topic.
+ Messages that match 'sub' will be passed to 'callback'. Any
+ non-matching messages will be passed to the default `on_message`
+ callback.
+
+ Call multiple times with different 'sub' to define multiple topic
+ specific callbacks.
+
+ Topic specific callbacks may be removed with
+ `message_callback_remove()`.
+
+ See `on_message` for the expected signature of the callback.
+
+ Decorator: @client.topic_callback(sub) (``client`` is the name of the
+ instance which this callback is being attached to)
+
+ Example::
+
+ @client.topic_callback("mytopic/#")
+ def handle_mytopic(client, userdata, message):
+ ...
+ """
+ if callback is None or sub is None:
+ raise ValueError("sub and callback must both be defined.")
+
+ with self._callback_mutex:
+ self._on_message_filtered[sub] = callback
+
+ def topic_callback(
+ self, sub: str
+ ) -> Callable[[CallbackOnMessage], CallbackOnMessage]:
+ def decorator(func: CallbackOnMessage) -> CallbackOnMessage:
+ self.message_callback_add(sub, func)
+ return func
+ return decorator
+
+ def message_callback_remove(self, sub: str) -> None:
+ """Remove a message callback previously registered with
+ `message_callback_add()`."""
+ if sub is None:
+ raise ValueError("sub must defined.")
+
+ with self._callback_mutex:
+ try:
+ del self._on_message_filtered[sub]
+ except KeyError: # no such subscription
+ pass
+
+ # ============================================================
+ # Private functions
+ # ============================================================
+
+ def _loop_rc_handle(
+ self,
+ rc: MQTTErrorCode,
+ ) -> MQTTErrorCode:
+ if rc:
+ self._sock_close()
+
+ if self._state in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED):
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTED
+ rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ self._do_on_disconnect(packet_from_broker=False, v1_rc=rc)
+
+ if rc == MQTT_ERR_CONN_LOST:
+ self._state = _ConnectionState.MQTT_CS_CONNECTION_LOST
+
+ return rc
+
+ def _packet_read(self) -> MQTTErrorCode:
+ # This gets called if pselect() indicates that there is network data
+ # available - ie. at least one byte. What we do depends on what data we
+ # already have.
+ # If we've not got a command, attempt to read one and save it. This should
+ # always work because it's only a single byte.
+ # Then try to read the remaining length. This may fail because it is may
+ # be more than one byte - will need to save data pending next read if it
+ # does fail.
+ # Then try to read the remaining payload, where 'payload' here means the
+ # combined variable header and actual payload. This is the most likely to
+ # fail due to longer length, so save current data and current position.
+ # After all data is read, send to _mqtt_handle_packet() to deal with.
+ # Finally, free the memory and reset everything to starting conditions.
+ if self._in_packet['command'] == 0:
+ try:
+ command = self._sock_recv(1)
+ except BlockingIOError:
+ return MQTTErrorCode.MQTT_ERR_AGAIN
+ except TimeoutError as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'timeout on socket: %s', err)
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ except OSError as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'failed to receive on socket: %s', err)
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ else:
+ if len(command) == 0:
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ self._in_packet['command'] = command[0]
+
+ if self._in_packet['have_remaining'] == 0:
+ # Read remaining
+ # Algorithm for decoding taken from pseudo code at
+ # http://publib.boulder.ibm.com/infocenter/wmbhelp/v6r0m0/topic/com.ibm.etools.mft.doc/ac10870_.htm
+ while True:
+ try:
+ byte = self._sock_recv(1)
+ except BlockingIOError:
+ return MQTTErrorCode.MQTT_ERR_AGAIN
+ except OSError as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'failed to receive on socket: %s', err)
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ else:
+ if len(byte) == 0:
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ byte_value = byte[0]
+ self._in_packet['remaining_count'].append(byte_value)
+ # Max 4 bytes length for remaining length as defined by protocol.
+ # Anything more likely means a broken/malicious client.
+ if len(self._in_packet['remaining_count']) > 4:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ self._in_packet['remaining_length'] += (
+ byte_value & 127) * self._in_packet['remaining_mult']
+ self._in_packet['remaining_mult'] = self._in_packet['remaining_mult'] * 128
+
+ if (byte_value & 128) == 0:
+ break
+
+ self._in_packet['have_remaining'] = 1
+ self._in_packet['to_process'] = self._in_packet['remaining_length']
+
+ count = 100 # Don't get stuck in this loop if we have a huge message.
+ while self._in_packet['to_process'] > 0:
+ try:
+ data = self._sock_recv(self._in_packet['to_process'])
+ except BlockingIOError:
+ return MQTTErrorCode.MQTT_ERR_AGAIN
+ except OSError as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'failed to receive on socket: %s', err)
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ else:
+ if len(data) == 0:
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+ self._in_packet['to_process'] -= len(data)
+ self._in_packet['packet'] += data
+ count -= 1
+ if count == 0:
+ with self._msgtime_mutex:
+ self._last_msg_in = time_func()
+ return MQTTErrorCode.MQTT_ERR_AGAIN
+
+ # All data for this packet is read.
+ self._in_packet['pos'] = 0
+ rc = self._packet_handle()
+
+ # Free data and reset values
+ self._in_packet = {
+ "command": 0,
+ "have_remaining": 0,
+ "remaining_count": [],
+ "remaining_mult": 1,
+ "remaining_length": 0,
+ "packet": bytearray(b""),
+ "to_process": 0,
+ "pos": 0,
+ }
+
+ with self._msgtime_mutex:
+ self._last_msg_in = time_func()
+ return rc
+
+ def _packet_write(self) -> MQTTErrorCode:
+ while True:
+ try:
+ packet = self._out_packet.popleft()
+ except IndexError:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ try:
+ write_length = self._sock_send(
+ packet['packet'][packet['pos']:])
+ except (AttributeError, ValueError):
+ self._out_packet.appendleft(packet)
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ except BlockingIOError:
+ self._out_packet.appendleft(packet)
+ return MQTTErrorCode.MQTT_ERR_AGAIN
+ except OSError as err:
+ self._out_packet.appendleft(packet)
+ self._easy_log(
+ MQTT_LOG_ERR, 'failed to receive on socket: %s', err)
+ return MQTTErrorCode.MQTT_ERR_CONN_LOST
+
+ if write_length > 0:
+ packet['to_process'] -= write_length
+ packet['pos'] += write_length
+
+ if packet['to_process'] == 0:
+ if (packet['command'] & 0xF0) == PUBLISH and packet['qos'] == 0:
+ with self._callback_mutex:
+ on_publish = self.on_publish
+
+ if on_publish:
+ with self._in_callback_mutex:
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ on_publish = cast(CallbackOnPublish_v1, on_publish)
+
+ on_publish(self, self._userdata, packet["mid"])
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_publish = cast(CallbackOnPublish_v2, on_publish)
+
+ on_publish(
+ self,
+ self._userdata,
+ packet["mid"],
+ ReasonCode(PacketTypes.PUBACK),
+ Properties(PacketTypes.PUBACK),
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_publish: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ # TODO: Something is odd here. I don't see why packet["info"] can't be None.
+ # A packet could be produced by _handle_connack with qos=0 and no info
+ # (around line 3645). Ignore the mypy check for now but I feel there is a bug
+ # somewhere.
+ packet['info']._set_as_published() # type: ignore
+
+ if (packet['command'] & 0xF0) == DISCONNECT:
+ with self._msgtime_mutex:
+ self._last_msg_out = time_func()
+
+ self._do_on_disconnect(
+ packet_from_broker=False,
+ v1_rc=MQTTErrorCode.MQTT_ERR_SUCCESS,
+ )
+ self._sock_close()
+ # Only change to disconnected if the disconnection was wanted
+ # by the client (== state was disconnecting). If the broker disconnected
+ # use unilaterally don't change the state and client may reconnect.
+ if self._state == _ConnectionState.MQTT_CS_DISCONNECTING:
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTED
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ else:
+ # We haven't finished with this packet
+ self._out_packet.appendleft(packet)
+ else:
+ break
+
+ with self._msgtime_mutex:
+ self._last_msg_out = time_func()
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _easy_log(self, level: LogLevel, fmt: str, *args: Any) -> None:
+ if self.on_log is not None:
+ buf = fmt % args
+ try:
+ self.on_log(self, self._userdata, level, buf)
+ except Exception: # noqa: S110
+ # Can't _easy_log this, as we'll recurse until we break
+ pass # self._logger will pick this up, so we're fine
+ if self._logger is not None:
+ level_std = LOGGING_LEVEL[level]
+ self._logger.log(level_std, fmt, *args)
+
+ def _check_keepalive(self) -> None:
+ if self._keepalive == 0:
+ return
+
+ now = time_func()
+
+ with self._msgtime_mutex:
+ last_msg_out = self._last_msg_out
+ last_msg_in = self._last_msg_in
+
+ if self._sock is not None and (now - last_msg_out >= self._keepalive or now - last_msg_in >= self._keepalive):
+ if self._state == _ConnectionState.MQTT_CS_CONNECTED and self._ping_t == 0:
+ try:
+ self._send_pingreq()
+ except Exception:
+ self._sock_close()
+ self._do_on_disconnect(
+ packet_from_broker=False,
+ v1_rc=MQTTErrorCode.MQTT_ERR_CONN_LOST,
+ )
+ else:
+ with self._msgtime_mutex:
+ self._last_msg_out = now
+ self._last_msg_in = now
+ else:
+ self._sock_close()
+
+ if self._state in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED):
+ self._state = _ConnectionState.MQTT_CS_DISCONNECTED
+ rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+ else:
+ rc = MQTTErrorCode.MQTT_ERR_KEEPALIVE
+
+ self._do_on_disconnect(
+ packet_from_broker=False,
+ v1_rc=rc,
+ )
+
+ def _mid_generate(self) -> int:
+ with self._mid_generate_mutex:
+ self._last_mid += 1
+ if self._last_mid == 65536:
+ self._last_mid = 1
+ return self._last_mid
+
+ @staticmethod
+ def _raise_for_invalid_topic(topic: bytes) -> None:
+ """ Check if the topic is a topic without wildcard and valid length.
+
+ Raise ValueError if the topic isn't valid.
+ """
+ if b'+' in topic or b'#' in topic:
+ raise ValueError('Publish topic cannot contain wildcards.')
+ if len(topic) > 65535:
+ raise ValueError('Publish topic is too long.')
+
+ @staticmethod
+ def _filter_wildcard_len_check(sub: bytes) -> MQTTErrorCode:
+ if (len(sub) == 0 or len(sub) > 65535
+ or any(b'+' in p or b'#' in p for p in sub.split(b'/') if len(p) > 1)
+ or b'#/' in sub):
+ return MQTTErrorCode.MQTT_ERR_INVAL
+ else:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _send_pingreq(self) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PINGREQ")
+ rc = self._send_simple_command(PINGREQ)
+ if rc == MQTTErrorCode.MQTT_ERR_SUCCESS:
+ self._ping_t = time_func()
+ return rc
+
+ def _send_pingresp(self) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PINGRESP")
+ return self._send_simple_command(PINGRESP)
+
+ def _send_puback(self, mid: int) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PUBACK (Mid: %d)", mid)
+ return self._send_command_with_mid(PUBACK, mid, False)
+
+ def _send_pubcomp(self, mid: int) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PUBCOMP (Mid: %d)", mid)
+ return self._send_command_with_mid(PUBCOMP, mid, False)
+
+ def _pack_remaining_length(
+ self, packet: bytearray, remaining_length: int
+ ) -> bytearray:
+ remaining_bytes = []
+ while True:
+ byte = remaining_length % 128
+ remaining_length = remaining_length // 128
+ # If there are more digits to encode, set the top bit of this digit
+ if remaining_length > 0:
+ byte |= 0x80
+
+ remaining_bytes.append(byte)
+ packet.append(byte)
+ if remaining_length == 0:
+ # FIXME - this doesn't deal with incorrectly large payloads
+ return packet
+
+ def _pack_str16(self, packet: bytearray, data: bytes | str) -> None:
+ data = _force_bytes(data)
+ packet.extend(struct.pack("!H", len(data)))
+ packet.extend(data)
+
+ def _send_publish(
+ self,
+ mid: int,
+ topic: bytes,
+ payload: bytes|bytearray = b"",
+ qos: int = 0,
+ retain: bool = False,
+ dup: bool = False,
+ info: MQTTMessageInfo | None = None,
+ properties: Properties | None = None,
+ ) -> MQTTErrorCode:
+ # we assume that topic and payload are already properly encoded
+ if not isinstance(topic, bytes):
+ raise TypeError('topic must be bytes, not str')
+ if payload and not isinstance(payload, (bytes, bytearray)):
+ raise TypeError('payload must be bytes if set')
+
+ if self._sock is None:
+ return MQTTErrorCode.MQTT_ERR_NO_CONN
+
+ command = PUBLISH | ((dup & 0x1) << 3) | (qos << 1) | retain
+ packet = bytearray()
+ packet.append(command)
+
+ payloadlen = len(payload)
+ remaining_length = 2 + len(topic) + payloadlen
+
+ if payloadlen == 0:
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s (NULL payload)",
+ dup, qos, retain, mid, topic, properties
+ )
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s' (NULL payload)",
+ dup, qos, retain, mid, topic
+ )
+ else:
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s, ... (%d bytes)",
+ dup, qos, retain, mid, topic, properties, payloadlen
+ )
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending PUBLISH (d%d, q%d, r%d, m%d), '%s', ... (%d bytes)",
+ dup, qos, retain, mid, topic, payloadlen
+ )
+
+ if qos > 0:
+ # For message id
+ remaining_length += 2
+
+ if self._protocol == MQTTv5:
+ if properties is None:
+ packed_properties = b'\x00'
+ else:
+ packed_properties = properties.pack()
+ remaining_length += len(packed_properties)
+
+ self._pack_remaining_length(packet, remaining_length)
+ self._pack_str16(packet, topic)
+
+ if qos > 0:
+ # For message id
+ packet.extend(struct.pack("!H", mid))
+
+ if self._protocol == MQTTv5:
+ packet.extend(packed_properties)
+
+ packet.extend(payload)
+
+ return self._packet_queue(PUBLISH, packet, mid, qos, info)
+
+ def _send_pubrec(self, mid: int) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PUBREC (Mid: %d)", mid)
+ return self._send_command_with_mid(PUBREC, mid, False)
+
+ def _send_pubrel(self, mid: int) -> MQTTErrorCode:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending PUBREL (Mid: %d)", mid)
+ return self._send_command_with_mid(PUBREL | 2, mid, False)
+
+ def _send_command_with_mid(self, command: int, mid: int, dup: int) -> MQTTErrorCode:
+ # For PUBACK, PUBCOMP, PUBREC, and PUBREL
+ if dup:
+ command |= 0x8
+
+ remaining_length = 2
+ packet = struct.pack('!BBH', command, remaining_length, mid)
+ return self._packet_queue(command, packet, mid, 1)
+
+ def _send_simple_command(self, command: int) -> MQTTErrorCode:
+ # For DISCONNECT, PINGREQ and PINGRESP
+ remaining_length = 0
+ packet = struct.pack('!BB', command, remaining_length)
+ return self._packet_queue(command, packet, 0, 0)
+
+ def _send_connect(self, keepalive: int) -> MQTTErrorCode:
+ proto_ver = int(self._protocol)
+ # hard-coded UTF-8 encoded string
+ protocol = b"MQTT" if proto_ver >= MQTTv311 else b"MQIsdp"
+
+ remaining_length = 2 + len(protocol) + 1 + \
+ 1 + 2 + 2 + len(self._client_id)
+
+ connect_flags = 0
+ if self._protocol == MQTTv5:
+ if self._clean_start is True:
+ connect_flags |= 0x02
+ elif self._clean_start == MQTT_CLEAN_START_FIRST_ONLY and self._mqttv5_first_connect:
+ connect_flags |= 0x02
+ elif self._clean_session:
+ connect_flags |= 0x02
+
+ if self._will:
+ remaining_length += 2 + \
+ len(self._will_topic) + 2 + len(self._will_payload)
+ connect_flags |= 0x04 | ((self._will_qos & 0x03) << 3) | (
+ (self._will_retain & 0x01) << 5)
+
+ if self._username is not None:
+ remaining_length += 2 + len(self._username)
+ connect_flags |= 0x80
+ if self._password is not None:
+ connect_flags |= 0x40
+ remaining_length += 2 + len(self._password)
+
+ if self._protocol == MQTTv5:
+ if self._connect_properties is None:
+ packed_connect_properties = b'\x00'
+ else:
+ packed_connect_properties = self._connect_properties.pack()
+ remaining_length += len(packed_connect_properties)
+ if self._will:
+ if self._will_properties is None:
+ packed_will_properties = b'\x00'
+ else:
+ packed_will_properties = self._will_properties.pack()
+ remaining_length += len(packed_will_properties)
+
+ command = CONNECT
+ packet = bytearray()
+ packet.append(command)
+
+ # as per the mosquitto broker, if the MSB of this version is set
+ # to 1, then it treats the connection as a bridge
+ if self._client_mode == MQTT_BRIDGE:
+ proto_ver |= 0x80
+
+ self._pack_remaining_length(packet, remaining_length)
+ packet.extend(struct.pack(
+ f"!H{len(protocol)}sBBH",
+ len(protocol), protocol, proto_ver, connect_flags, keepalive,
+ ))
+
+ if self._protocol == MQTTv5:
+ packet += packed_connect_properties
+
+ self._pack_str16(packet, self._client_id)
+
+ if self._will:
+ if self._protocol == MQTTv5:
+ packet += packed_will_properties
+ self._pack_str16(packet, self._will_topic)
+ self._pack_str16(packet, self._will_payload)
+
+ if self._username is not None:
+ self._pack_str16(packet, self._username)
+
+ if self._password is not None:
+ self._pack_str16(packet, self._password)
+
+ self._keepalive = keepalive
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending CONNECT (u%d, p%d, wr%d, wq%d, wf%d, c%d, k%d) client_id=%s properties=%s",
+ (connect_flags & 0x80) >> 7,
+ (connect_flags & 0x40) >> 6,
+ (connect_flags & 0x20) >> 5,
+ (connect_flags & 0x18) >> 3,
+ (connect_flags & 0x4) >> 2,
+ (connect_flags & 0x2) >> 1,
+ keepalive,
+ self._client_id,
+ self._connect_properties
+ )
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending CONNECT (u%d, p%d, wr%d, wq%d, wf%d, c%d, k%d) client_id=%s",
+ (connect_flags & 0x80) >> 7,
+ (connect_flags & 0x40) >> 6,
+ (connect_flags & 0x20) >> 5,
+ (connect_flags & 0x18) >> 3,
+ (connect_flags & 0x4) >> 2,
+ (connect_flags & 0x2) >> 1,
+ keepalive,
+ self._client_id
+ )
+ return self._packet_queue(command, packet, 0, 0)
+
+ def _send_disconnect(
+ self,
+ reasoncode: ReasonCode | None = None,
+ properties: Properties | None = None,
+ ) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending DISCONNECT reasonCode=%s properties=%s",
+ reasoncode,
+ properties
+ )
+ else:
+ self._easy_log(MQTT_LOG_DEBUG, "Sending DISCONNECT")
+
+ remaining_length = 0
+
+ command = DISCONNECT
+ packet = bytearray()
+ packet.append(command)
+
+ if self._protocol == MQTTv5:
+ if properties is not None or reasoncode is not None:
+ if reasoncode is None:
+ reasoncode = ReasonCode(DISCONNECT >> 4, identifier=0)
+ remaining_length += 1
+ if properties is not None:
+ packed_props = properties.pack()
+ remaining_length += len(packed_props)
+
+ self._pack_remaining_length(packet, remaining_length)
+
+ if self._protocol == MQTTv5:
+ if reasoncode is not None:
+ packet += reasoncode.pack()
+ if properties is not None:
+ packet += packed_props
+
+ return self._packet_queue(command, packet, 0, 0)
+
+ def _send_subscribe(
+ self,
+ dup: int,
+ topics: Sequence[tuple[bytes, SubscribeOptions | int]],
+ properties: Properties | None = None,
+ ) -> tuple[MQTTErrorCode, int]:
+ remaining_length = 2
+ if self._protocol == MQTTv5:
+ if properties is None:
+ packed_subscribe_properties = b'\x00'
+ else:
+ packed_subscribe_properties = properties.pack()
+ remaining_length += len(packed_subscribe_properties)
+ for t, _ in topics:
+ remaining_length += 2 + len(t) + 1
+
+ command = SUBSCRIBE | (dup << 3) | 0x2
+ packet = bytearray()
+ packet.append(command)
+ self._pack_remaining_length(packet, remaining_length)
+ local_mid = self._mid_generate()
+ packet.extend(struct.pack("!H", local_mid))
+
+ if self._protocol == MQTTv5:
+ packet += packed_subscribe_properties
+
+ for t, q in topics:
+ self._pack_str16(packet, t)
+ if self._protocol == MQTTv5:
+ packet += q.pack() # type: ignore
+ else:
+ packet.append(q) # type: ignore
+
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending SUBSCRIBE (d%d, m%d) %s",
+ dup,
+ local_mid,
+ topics,
+ )
+ return (self._packet_queue(command, packet, local_mid, 1), local_mid)
+
+ def _send_unsubscribe(
+ self,
+ dup: int,
+ topics: list[bytes],
+ properties: Properties | None = None,
+ ) -> tuple[MQTTErrorCode, int]:
+ remaining_length = 2
+ if self._protocol == MQTTv5:
+ if properties is None:
+ packed_unsubscribe_properties = b'\x00'
+ else:
+ packed_unsubscribe_properties = properties.pack()
+ remaining_length += len(packed_unsubscribe_properties)
+ for t in topics:
+ remaining_length += 2 + len(t)
+
+ command = UNSUBSCRIBE | (dup << 3) | 0x2
+ packet = bytearray()
+ packet.append(command)
+ self._pack_remaining_length(packet, remaining_length)
+ local_mid = self._mid_generate()
+ packet.extend(struct.pack("!H", local_mid))
+
+ if self._protocol == MQTTv5:
+ packet += packed_unsubscribe_properties
+
+ for t in topics:
+ self._pack_str16(packet, t)
+
+ # topics_repr = ", ".join("'"+topic.decode('utf8')+"'" for topic in topics)
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending UNSUBSCRIBE (d%d, m%d) %s %s",
+ dup,
+ local_mid,
+ properties,
+ topics,
+ )
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Sending UNSUBSCRIBE (d%d, m%d) %s",
+ dup,
+ local_mid,
+ topics,
+ )
+ return (self._packet_queue(command, packet, local_mid, 1), local_mid)
+
+ def _check_clean_session(self) -> bool:
+ if self._protocol == MQTTv5:
+ if self._clean_start == MQTT_CLEAN_START_FIRST_ONLY:
+ return self._mqttv5_first_connect
+ else:
+ return self._clean_start # type: ignore
+ else:
+ return self._clean_session
+
+ def _messages_reconnect_reset_out(self) -> None:
+ with self._out_message_mutex:
+ self._inflight_messages = 0
+ for m in self._out_messages.values():
+ m.timestamp = 0
+ if self._max_inflight_messages == 0 or self._inflight_messages < self._max_inflight_messages:
+ if m.qos == 0:
+ m.state = mqtt_ms_publish
+ elif m.qos == 1:
+ # self._inflight_messages = self._inflight_messages + 1
+ if m.state == mqtt_ms_wait_for_puback:
+ m.dup = True
+ m.state = mqtt_ms_publish
+ elif m.qos == 2:
+ # self._inflight_messages = self._inflight_messages + 1
+ if self._check_clean_session():
+ if m.state != mqtt_ms_publish:
+ m.dup = True
+ m.state = mqtt_ms_publish
+ else:
+ if m.state == mqtt_ms_wait_for_pubcomp:
+ m.state = mqtt_ms_resend_pubrel
+ else:
+ if m.state == mqtt_ms_wait_for_pubrec:
+ m.dup = True
+ m.state = mqtt_ms_publish
+ else:
+ m.state = mqtt_ms_queued
+
+ def _messages_reconnect_reset_in(self) -> None:
+ with self._in_message_mutex:
+ if self._check_clean_session():
+ self._in_messages = collections.OrderedDict()
+ return
+ for m in self._in_messages.values():
+ m.timestamp = 0
+ if m.qos != 2:
+ self._in_messages.pop(m.mid)
+ else:
+ # Preserve current state
+ pass
+
+ def _messages_reconnect_reset(self) -> None:
+ self._messages_reconnect_reset_out()
+ self._messages_reconnect_reset_in()
+
+ def _packet_queue(
+ self,
+ command: int,
+ packet: bytes,
+ mid: int,
+ qos: int,
+ info: MQTTMessageInfo | None = None,
+ ) -> MQTTErrorCode:
+ mpkt: _OutPacket = {
+ "command": command,
+ "mid": mid,
+ "qos": qos,
+ "pos": 0,
+ "to_process": len(packet),
+ "packet": packet,
+ "info": info,
+ }
+
+ self._out_packet.append(mpkt)
+
+ # Write a single byte to sockpairW (connected to sockpairR) to break
+ # out of select() if in threaded mode.
+ if self._sockpairW is not None:
+ try:
+ self._sockpairW.send(sockpair_data)
+ except BlockingIOError:
+ pass
+
+ # If we have an external event loop registered, use that instead
+ # of calling loop_write() directly.
+ if self._thread is None and self._on_socket_register_write is None:
+ if self._in_callback_mutex.acquire(False):
+ self._in_callback_mutex.release()
+ return self.loop_write()
+
+ self._call_socket_register_write()
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _packet_handle(self) -> MQTTErrorCode:
+ cmd = self._in_packet['command'] & 0xF0
+ if cmd == PINGREQ:
+ return self._handle_pingreq()
+ elif cmd == PINGRESP:
+ return self._handle_pingresp()
+ elif cmd == PUBACK:
+ return self._handle_pubackcomp("PUBACK")
+ elif cmd == PUBCOMP:
+ return self._handle_pubackcomp("PUBCOMP")
+ elif cmd == PUBLISH:
+ return self._handle_publish()
+ elif cmd == PUBREC:
+ return self._handle_pubrec()
+ elif cmd == PUBREL:
+ return self._handle_pubrel()
+ elif cmd == CONNACK:
+ return self._handle_connack()
+ elif cmd == SUBACK:
+ self._handle_suback()
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ elif cmd == UNSUBACK:
+ return self._handle_unsuback()
+ elif cmd == DISCONNECT and self._protocol == MQTTv5: # only allowed in MQTT 5.0
+ self._handle_disconnect()
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ else:
+ # If we don't recognise the command, return an error straight away.
+ self._easy_log(MQTT_LOG_ERR, "Error: Unrecognised command %s", cmd)
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ def _handle_pingreq(self) -> MQTTErrorCode:
+ if self._in_packet['remaining_length'] != 0:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ self._easy_log(MQTT_LOG_DEBUG, "Received PINGREQ")
+ return self._send_pingresp()
+
+ def _handle_pingresp(self) -> MQTTErrorCode:
+ if self._in_packet['remaining_length'] != 0:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ # No longer waiting for a PINGRESP.
+ self._ping_t = 0
+ self._easy_log(MQTT_LOG_DEBUG, "Received PINGRESP")
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _handle_connack(self) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] < 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+ elif self._in_packet['remaining_length'] != 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ if self._protocol == MQTTv5:
+ (flags, result) = struct.unpack(
+ "!BB", self._in_packet['packet'][:2])
+ if result == 1:
+ # This is probably a failure from a broker that doesn't support
+ # MQTT v5.
+ reason = ReasonCode(CONNACK >> 4, aName="Unsupported protocol version")
+ properties = None
+ else:
+ reason = ReasonCode(CONNACK >> 4, identifier=result)
+ properties = Properties(CONNACK >> 4)
+ properties.unpack(self._in_packet['packet'][2:])
+ else:
+ (flags, result) = struct.unpack("!BB", self._in_packet['packet'])
+ reason = convert_connack_rc_to_reason_code(result)
+ properties = None
+ if self._protocol == MQTTv311:
+ if result == CONNACK_REFUSED_PROTOCOL_VERSION:
+ if not self._reconnect_on_failure:
+ return MQTT_ERR_PROTOCOL
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Received CONNACK (%s, %s), attempting downgrade to MQTT v3.1.",
+ flags, result
+ )
+ # Downgrade to MQTT v3.1
+ self._protocol = MQTTv31
+ return self.reconnect()
+ elif (result == CONNACK_REFUSED_IDENTIFIER_REJECTED
+ and self._client_id == b''):
+ if not self._reconnect_on_failure:
+ return MQTT_ERR_PROTOCOL
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Received CONNACK (%s, %s), attempting to use non-empty CID",
+ flags, result,
+ )
+ self._client_id = _base62(uuid.uuid4().int, padding=22).encode("utf8")
+ return self.reconnect()
+
+ if result == 0:
+ self._state = _ConnectionState.MQTT_CS_CONNECTED
+ self._reconnect_delay = None
+
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG, "Received CONNACK (%s, %s) properties=%s", flags, reason, properties)
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG, "Received CONNACK (%s, %s)", flags, result)
+
+ # it won't be the first successful connect any more
+ self._mqttv5_first_connect = False
+
+ with self._callback_mutex:
+ on_connect = self.on_connect
+
+ if on_connect:
+ flags_dict = {}
+ flags_dict['session present'] = flags & 0x01
+ with self._in_callback_mutex:
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ if self._protocol == MQTTv5:
+ on_connect = cast(CallbackOnConnect_v1_mqtt5, on_connect)
+
+ on_connect(self, self._userdata,
+ flags_dict, reason, properties)
+ else:
+ on_connect = cast(CallbackOnConnect_v1_mqtt3, on_connect)
+
+ on_connect(
+ self, self._userdata, flags_dict, result)
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_connect = cast(CallbackOnConnect_v2, on_connect)
+
+ connect_flags = ConnectFlags(
+ session_present=flags_dict['session present'] > 0
+ )
+
+ if properties is None:
+ properties = Properties(PacketTypes.CONNACK)
+
+ on_connect(
+ self,
+ self._userdata,
+ connect_flags,
+ reason,
+ properties,
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_connect: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ if result == 0:
+ rc = MQTTErrorCode.MQTT_ERR_SUCCESS
+ with self._out_message_mutex:
+ for m in self._out_messages.values():
+ m.timestamp = time_func()
+ if m.state == mqtt_ms_queued:
+ self.loop_write() # Process outgoing messages that have just been queued up
+ return MQTT_ERR_SUCCESS
+
+ if m.qos == 0:
+ with self._in_callback_mutex: # Don't call loop_write after _send_publish()
+ rc = self._send_publish(
+ m.mid,
+ m.topic.encode('utf-8'),
+ m.payload,
+ m.qos,
+ m.retain,
+ m.dup,
+ properties=m.properties
+ )
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ elif m.qos == 1:
+ if m.state == mqtt_ms_publish:
+ self._inflight_messages += 1
+ m.state = mqtt_ms_wait_for_puback
+ with self._in_callback_mutex: # Don't call loop_write after _send_publish()
+ rc = self._send_publish(
+ m.mid,
+ m.topic.encode('utf-8'),
+ m.payload,
+ m.qos,
+ m.retain,
+ m.dup,
+ properties=m.properties
+ )
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ elif m.qos == 2:
+ if m.state == mqtt_ms_publish:
+ self._inflight_messages += 1
+ m.state = mqtt_ms_wait_for_pubrec
+ with self._in_callback_mutex: # Don't call loop_write after _send_publish()
+ rc = self._send_publish(
+ m.mid,
+ m.topic.encode('utf-8'),
+ m.payload,
+ m.qos,
+ m.retain,
+ m.dup,
+ properties=m.properties
+ )
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ elif m.state == mqtt_ms_resend_pubrel:
+ self._inflight_messages += 1
+ m.state = mqtt_ms_wait_for_pubcomp
+ with self._in_callback_mutex: # Don't call loop_write after _send_publish()
+ rc = self._send_pubrel(m.mid)
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ self.loop_write() # Process outgoing messages that have just been queued up
+
+ return rc
+ elif result > 0 and result < 6:
+ return MQTTErrorCode.MQTT_ERR_CONN_REFUSED
+ else:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ def _handle_disconnect(self) -> None:
+ packet_type = DISCONNECT >> 4
+ reasonCode = properties = None
+ if self._in_packet['remaining_length'] > 2:
+ reasonCode = ReasonCode(packet_type)
+ reasonCode.unpack(self._in_packet['packet'])
+ if self._in_packet['remaining_length'] > 3:
+ properties = Properties(packet_type)
+ props, props_len = properties.unpack(
+ self._in_packet['packet'][1:])
+ self._easy_log(MQTT_LOG_DEBUG, "Received DISCONNECT %s %s",
+ reasonCode,
+ properties
+ )
+
+ self._sock_close()
+ self._do_on_disconnect(
+ packet_from_broker=True,
+ v1_rc=MQTTErrorCode.MQTT_ERR_SUCCESS, # If reason is absent (remaining length < 1), it means normal disconnection
+ reason=reasonCode,
+ properties=properties,
+ )
+
+ def _handle_suback(self) -> None:
+ self._easy_log(MQTT_LOG_DEBUG, "Received SUBACK")
+ pack_format = f"!H{len(self._in_packet['packet']) - 2}s"
+ (mid, packet) = struct.unpack(pack_format, self._in_packet['packet'])
+
+ if self._protocol == MQTTv5:
+ properties = Properties(SUBACK >> 4)
+ props, props_len = properties.unpack(packet)
+ reasoncodes = [ReasonCode(SUBACK >> 4, identifier=c) for c in packet[props_len:]]
+ else:
+ pack_format = f"!{'B' * len(packet)}"
+ granted_qos = struct.unpack(pack_format, packet)
+ reasoncodes = [ReasonCode(SUBACK >> 4, identifier=c) for c in granted_qos]
+ properties = Properties(SUBACK >> 4)
+
+ with self._callback_mutex:
+ on_subscribe = self.on_subscribe
+
+ if on_subscribe:
+ with self._in_callback_mutex: # Don't call loop_write after _send_publish()
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ if self._protocol == MQTTv5:
+ on_subscribe = cast(CallbackOnSubscribe_v1_mqtt5, on_subscribe)
+
+ on_subscribe(
+ self, self._userdata, mid, reasoncodes, properties)
+ else:
+ on_subscribe = cast(CallbackOnSubscribe_v1_mqtt3, on_subscribe)
+
+ on_subscribe(
+ self, self._userdata, mid, granted_qos)
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_subscribe = cast(CallbackOnSubscribe_v2, on_subscribe)
+
+ on_subscribe(
+ self,
+ self._userdata,
+ mid,
+ reasoncodes,
+ properties,
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_subscribe: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ def _handle_publish(self) -> MQTTErrorCode:
+ header = self._in_packet['command']
+ message = MQTTMessage()
+ message.dup = ((header & 0x08) >> 3) != 0
+ message.qos = (header & 0x06) >> 1
+ message.retain = (header & 0x01) != 0
+
+ pack_format = f"!H{len(self._in_packet['packet']) - 2}s"
+ (slen, packet) = struct.unpack(pack_format, self._in_packet['packet'])
+ pack_format = f"!{slen}s{len(packet) - slen}s"
+ (topic, packet) = struct.unpack(pack_format, packet)
+
+ if self._protocol != MQTTv5 and len(topic) == 0:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ # Handle topics with invalid UTF-8
+ # This replaces an invalid topic with a message and the hex
+ # representation of the topic for logging. When the user attempts to
+ # access message.topic in the callback, an exception will be raised.
+ try:
+ print_topic = topic.decode('utf-8')
+ except UnicodeDecodeError:
+ print_topic = f"TOPIC WITH INVALID UTF-8: {topic!r}"
+
+ message.topic = topic
+
+ if message.qos > 0:
+ pack_format = f"!H{len(packet) - 2}s"
+ (message.mid, packet) = struct.unpack(pack_format, packet)
+
+ if self._protocol == MQTTv5:
+ message.properties = Properties(PUBLISH >> 4)
+ props, props_len = message.properties.unpack(packet)
+ packet = packet[props_len:]
+
+ message.payload = packet
+
+ if self._protocol == MQTTv5:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Received PUBLISH (d%d, q%d, r%d, m%d), '%s', properties=%s, ... (%d bytes)",
+ message.dup, message.qos, message.retain, message.mid,
+ print_topic, message.properties, len(message.payload)
+ )
+ else:
+ self._easy_log(
+ MQTT_LOG_DEBUG,
+ "Received PUBLISH (d%d, q%d, r%d, m%d), '%s', ... (%d bytes)",
+ message.dup, message.qos, message.retain, message.mid,
+ print_topic, len(message.payload)
+ )
+
+ message.timestamp = time_func()
+ if message.qos == 0:
+ self._handle_on_message(message)
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ elif message.qos == 1:
+ self._handle_on_message(message)
+ if self._manual_ack:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ else:
+ return self._send_puback(message.mid)
+ elif message.qos == 2:
+
+ rc = self._send_pubrec(message.mid)
+
+ message.state = mqtt_ms_wait_for_pubrel
+ with self._in_message_mutex:
+ self._in_messages[message.mid] = message
+
+ return rc
+ else:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ def ack(self, mid: int, qos: int) -> MQTTErrorCode:
+ """
+ send an acknowledgement for a given message id (stored in :py:attr:`message.mid `).
+ only useful in QoS>=1 and ``manual_ack=True`` (option of `Client`)
+ """
+ if self._manual_ack :
+ if qos == 1:
+ return self._send_puback(mid)
+ elif qos == 2:
+ return self._send_pubcomp(mid)
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def manual_ack_set(self, on: bool) -> None:
+ """
+ The paho library normally acknowledges messages as soon as they are delivered to the caller.
+ If manual_ack is turned on, then the caller MUST manually acknowledge every message once
+ application processing is complete using `ack()`
+ """
+ self._manual_ack = on
+
+
+ def _handle_pubrel(self) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] < 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+ elif self._in_packet['remaining_length'] != 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ mid, = struct.unpack("!H", self._in_packet['packet'][:2])
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] > 2:
+ reasonCode = ReasonCode(PUBREL >> 4)
+ reasonCode.unpack(self._in_packet['packet'][2:])
+ if self._in_packet['remaining_length'] > 3:
+ properties = Properties(PUBREL >> 4)
+ props, props_len = properties.unpack(
+ self._in_packet['packet'][3:])
+ self._easy_log(MQTT_LOG_DEBUG, "Received PUBREL (Mid: %d)", mid)
+
+ with self._in_message_mutex:
+ if mid in self._in_messages:
+ # Only pass the message on if we have removed it from the queue - this
+ # prevents multiple callbacks for the same message.
+ message = self._in_messages.pop(mid)
+ self._handle_on_message(message)
+ self._inflight_messages -= 1
+ if self._max_inflight_messages > 0:
+ with self._out_message_mutex:
+ rc = self._update_inflight()
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+
+ # FIXME: this should only be done if the message is known
+ # If unknown it's a protocol error and we should close the connection.
+ # But since we don't have (on disk) persistence for the session, it
+ # is possible that we must known about this message.
+ # Choose to acknowledge this message (thus losing a message) but
+ # avoid hanging. See #284.
+ if self._manual_ack:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ else:
+ return self._send_pubcomp(mid)
+
+ def _update_inflight(self) -> MQTTErrorCode:
+ # Dont lock message_mutex here
+ for m in self._out_messages.values():
+ if self._inflight_messages < self._max_inflight_messages:
+ if m.qos > 0 and m.state == mqtt_ms_queued:
+ self._inflight_messages += 1
+ if m.qos == 1:
+ m.state = mqtt_ms_wait_for_puback
+ elif m.qos == 2:
+ m.state = mqtt_ms_wait_for_pubrec
+ rc = self._send_publish(
+ m.mid,
+ m.topic.encode('utf-8'),
+ m.payload,
+ m.qos,
+ m.retain,
+ m.dup,
+ properties=m.properties,
+ )
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ else:
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _handle_pubrec(self) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] < 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+ elif self._in_packet['remaining_length'] != 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ mid, = struct.unpack("!H", self._in_packet['packet'][:2])
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] > 2:
+ reasonCode = ReasonCode(PUBREC >> 4)
+ reasonCode.unpack(self._in_packet['packet'][2:])
+ if self._in_packet['remaining_length'] > 3:
+ properties = Properties(PUBREC >> 4)
+ props, props_len = properties.unpack(
+ self._in_packet['packet'][3:])
+ self._easy_log(MQTT_LOG_DEBUG, "Received PUBREC (Mid: %d)", mid)
+
+ with self._out_message_mutex:
+ if mid in self._out_messages:
+ msg = self._out_messages[mid]
+ msg.state = mqtt_ms_wait_for_pubcomp
+ msg.timestamp = time_func()
+ return self._send_pubrel(mid)
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _handle_unsuback(self) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] < 4:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+ elif self._in_packet['remaining_length'] != 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ mid, = struct.unpack("!H", self._in_packet['packet'][:2])
+ if self._protocol == MQTTv5:
+ packet = self._in_packet['packet'][2:]
+ properties = Properties(UNSUBACK >> 4)
+ props, props_len = properties.unpack(packet)
+ reasoncodes_list = [
+ ReasonCode(UNSUBACK >> 4, identifier=c)
+ for c in packet[props_len:]
+ ]
+ else:
+ reasoncodes_list = []
+ properties = Properties(UNSUBACK >> 4)
+
+ self._easy_log(MQTT_LOG_DEBUG, "Received UNSUBACK (Mid: %d)", mid)
+ with self._callback_mutex:
+ on_unsubscribe = self.on_unsubscribe
+
+ if on_unsubscribe:
+ with self._in_callback_mutex:
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ if self._protocol == MQTTv5:
+ on_unsubscribe = cast(CallbackOnUnsubscribe_v1_mqtt5, on_unsubscribe)
+
+ reasoncodes: ReasonCode | list[ReasonCode] = reasoncodes_list
+ if len(reasoncodes_list) == 1:
+ reasoncodes = reasoncodes_list[0]
+
+ on_unsubscribe(
+ self, self._userdata, mid, properties, reasoncodes)
+ else:
+ on_unsubscribe = cast(CallbackOnUnsubscribe_v1_mqtt3, on_unsubscribe)
+
+ on_unsubscribe(self, self._userdata, mid)
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_unsubscribe = cast(CallbackOnUnsubscribe_v2, on_unsubscribe)
+
+ if properties is None:
+ properties = Properties(PacketTypes.CONNACK)
+
+ on_unsubscribe(
+ self,
+ self._userdata,
+ mid,
+ reasoncodes_list,
+ properties,
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_unsubscribe: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _do_on_disconnect(
+ self,
+ packet_from_broker: bool,
+ v1_rc: MQTTErrorCode,
+ reason: ReasonCode | None = None,
+ properties: Properties | None = None,
+ ) -> None:
+ with self._callback_mutex:
+ on_disconnect = self.on_disconnect
+
+ if on_disconnect:
+ with self._in_callback_mutex:
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ if self._protocol == MQTTv5:
+ on_disconnect = cast(CallbackOnDisconnect_v1_mqtt5, on_disconnect)
+
+ if packet_from_broker:
+ on_disconnect(self, self._userdata, reason, properties)
+ else:
+ on_disconnect(self, self._userdata, v1_rc, None)
+ else:
+ on_disconnect = cast(CallbackOnDisconnect_v1_mqtt3, on_disconnect)
+
+ on_disconnect(self, self._userdata, v1_rc)
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_disconnect = cast(CallbackOnDisconnect_v2, on_disconnect)
+
+ disconnect_flags = DisconnectFlags(
+ is_disconnect_packet_from_server=packet_from_broker
+ )
+
+ if reason is None:
+ reason = convert_disconnect_error_code_to_reason_code(v1_rc)
+
+ if properties is None:
+ properties = Properties(PacketTypes.DISCONNECT)
+
+ on_disconnect(
+ self,
+ self._userdata,
+ disconnect_flags,
+ reason,
+ properties,
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_disconnect: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ def _do_on_publish(self, mid: int, reason_code: ReasonCode, properties: Properties) -> MQTTErrorCode:
+ with self._callback_mutex:
+ on_publish = self.on_publish
+
+ if on_publish:
+ with self._in_callback_mutex:
+ try:
+ if self._callback_api_version == CallbackAPIVersion.VERSION1:
+ on_publish = cast(CallbackOnPublish_v1, on_publish)
+
+ on_publish(self, self._userdata, mid)
+ elif self._callback_api_version == CallbackAPIVersion.VERSION2:
+ on_publish = cast(CallbackOnPublish_v2, on_publish)
+
+ on_publish(
+ self,
+ self._userdata,
+ mid,
+ reason_code,
+ properties,
+ )
+ else:
+ raise RuntimeError("Unsupported callback API version")
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_publish: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+ msg = self._out_messages.pop(mid)
+ msg.info._set_as_published()
+ if msg.qos > 0:
+ self._inflight_messages -= 1
+ if self._max_inflight_messages > 0:
+ rc = self._update_inflight()
+ if rc != MQTTErrorCode.MQTT_ERR_SUCCESS:
+ return rc
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _handle_pubackcomp(
+ self, cmd: Literal['PUBACK'] | Literal['PUBCOMP']
+ ) -> MQTTErrorCode:
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] < 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+ elif self._in_packet['remaining_length'] != 2:
+ return MQTTErrorCode.MQTT_ERR_PROTOCOL
+
+ packet_type_enum = PUBACK if cmd == "PUBACK" else PUBCOMP
+ packet_type = packet_type_enum.value >> 4
+ mid, = struct.unpack("!H", self._in_packet['packet'][:2])
+ reasonCode = ReasonCode(packet_type)
+ properties = Properties(packet_type)
+ if self._protocol == MQTTv5:
+ if self._in_packet['remaining_length'] > 2:
+ reasonCode.unpack(self._in_packet['packet'][2:])
+ if self._in_packet['remaining_length'] > 3:
+ props, props_len = properties.unpack(
+ self._in_packet['packet'][3:])
+ self._easy_log(MQTT_LOG_DEBUG, "Received %s (Mid: %d)", cmd, mid)
+
+ with self._out_message_mutex:
+ if mid in self._out_messages:
+ # Only inform the client the message has been sent once.
+ rc = self._do_on_publish(mid, reasonCode, properties)
+ return rc
+
+ return MQTTErrorCode.MQTT_ERR_SUCCESS
+
+ def _handle_on_message(self, message: MQTTMessage) -> None:
+
+ try:
+ topic = message.topic
+ except UnicodeDecodeError:
+ topic = None
+
+ on_message_callbacks = []
+ with self._callback_mutex:
+ if topic is not None:
+ on_message_callbacks = list(self._on_message_filtered.iter_match(message.topic))
+
+ if len(on_message_callbacks) == 0:
+ on_message = self.on_message
+ else:
+ on_message = None
+
+ for callback in on_message_callbacks:
+ with self._in_callback_mutex:
+ try:
+ callback(self, self._userdata, message)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR,
+ 'Caught exception in user defined callback function %s: %s',
+ callback.__name__,
+ err
+ )
+ if not self.suppress_exceptions:
+ raise
+
+ if on_message:
+ with self._in_callback_mutex:
+ try:
+ on_message(self, self._userdata, message)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_message: %s', err)
+ if not self.suppress_exceptions:
+ raise
+
+
+ def _handle_on_connect_fail(self) -> None:
+ with self._callback_mutex:
+ on_connect_fail = self.on_connect_fail
+
+ if on_connect_fail:
+ with self._in_callback_mutex:
+ try:
+ on_connect_fail(self, self._userdata)
+ except Exception as err:
+ self._easy_log(
+ MQTT_LOG_ERR, 'Caught exception in on_connect_fail: %s', err)
+
+ def _thread_main(self) -> None:
+ try:
+ self.loop_forever(retry_first_connection=True)
+ finally:
+ self._thread = None
+
+ def _reconnect_wait(self) -> None:
+ # See reconnect_delay_set for details
+ now = time_func()
+ with self._reconnect_delay_mutex:
+ if self._reconnect_delay is None:
+ self._reconnect_delay = self._reconnect_min_delay
+ else:
+ self._reconnect_delay = min(
+ self._reconnect_delay * 2,
+ self._reconnect_max_delay,
+ )
+
+ target_time = now + self._reconnect_delay
+
+ remaining = target_time - now
+ while (self._state not in (_ConnectionState.MQTT_CS_DISCONNECTING, _ConnectionState.MQTT_CS_DISCONNECTED)
+ and not self._thread_terminate
+ and remaining > 0):
+
+ time.sleep(min(remaining, 1))
+ remaining = target_time - time_func()
+
+ @staticmethod
+ def _proxy_is_valid(p) -> bool: # type: ignore[no-untyped-def]
+ def check(t, a) -> bool: # type: ignore[no-untyped-def]
+ return (socks is not None and
+ t in {socks.HTTP, socks.SOCKS4, socks.SOCKS5} and a)
+
+ if isinstance(p, dict):
+ return check(p.get("proxy_type"), p.get("proxy_addr"))
+ elif isinstance(p, (list, tuple)):
+ return len(p) == 6 and check(p[0], p[1])
+ else:
+ return False
+
+ def _get_proxy(self) -> dict[str, Any] | None:
+ if socks is None:
+ return None
+
+ # First, check if the user explicitly passed us a proxy to use
+ if self._proxy_is_valid(self._proxy):
+ return self._proxy
+
+ # Next, check for an mqtt_proxy environment variable as long as the host
+ # we're trying to connect to isn't listed under the no_proxy environment
+ # variable (matches built-in module urllib's behavior)
+ if not (hasattr(urllib.request, "proxy_bypass") and
+ urllib.request.proxy_bypass(self._host)):
+ env_proxies = urllib.request.getproxies()
+ if "mqtt" in env_proxies:
+ parts = urllib.parse.urlparse(env_proxies["mqtt"])
+ if parts.scheme == "http":
+ proxy = {
+ "proxy_type": socks.HTTP,
+ "proxy_addr": parts.hostname,
+ "proxy_port": parts.port
+ }
+ return proxy
+ elif parts.scheme == "socks":
+ proxy = {
+ "proxy_type": socks.SOCKS5,
+ "proxy_addr": parts.hostname,
+ "proxy_port": parts.port
+ }
+ return proxy
+
+ # Finally, check if the user has monkeypatched the PySocks library with
+ # a default proxy
+ socks_default = socks.get_default_proxy()
+ if self._proxy_is_valid(socks_default):
+ proxy_keys = ("proxy_type", "proxy_addr", "proxy_port",
+ "proxy_rdns", "proxy_username", "proxy_password")
+ return dict(zip(proxy_keys, socks_default))
+
+ # If we didn't find a proxy through any of the above methods, return
+ # None to indicate that the connection should be handled normally
+ return None
+
+ def _create_socket(self) -> SocketLike:
+ if self._transport == "unix":
+ sock = self._create_unix_socket_connection()
+ else:
+ sock = self._create_socket_connection()
+
+ if self._ssl:
+ sock = self._ssl_wrap_socket(sock)
+
+ if self._transport == "websockets":
+ sock.settimeout(self._keepalive)
+ return _WebsocketWrapper(
+ socket=sock,
+ host=self._host,
+ port=self._port,
+ is_ssl=self._ssl,
+ path=self._websocket_path,
+ extra_headers=self._websocket_extra_headers,
+ )
+
+ return sock
+
+ def _create_unix_socket_connection(self) -> _socket.socket:
+ unix_socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+ unix_socket.connect(self._host)
+ return unix_socket
+
+ def _create_socket_connection(self) -> _socket.socket:
+ proxy = self._get_proxy()
+ addr = (self._host, self._port)
+ source = (self._bind_address, self._bind_port)
+
+ if proxy:
+ return socks.create_connection(addr, timeout=self._connect_timeout, source_address=source, **proxy)
+ else:
+ return socket.create_connection(addr, timeout=self._connect_timeout, source_address=source)
+
+ def _ssl_wrap_socket(self, tcp_sock: _socket.socket) -> ssl.SSLSocket:
+ if self._ssl_context is None:
+ raise ValueError(
+ "Impossible condition. _ssl_context should never be None if _ssl is True"
+ )
+
+ verify_host = not self._tls_insecure
+ try:
+ # Try with server_hostname, even it's not supported in certain scenarios
+ ssl_sock = self._ssl_context.wrap_socket(
+ tcp_sock,
+ server_hostname=self._host,
+ do_handshake_on_connect=False,
+ )
+ except ssl.CertificateError:
+ # CertificateError is derived from ValueError
+ raise
+ except ValueError:
+ # Python version requires SNI in order to handle server_hostname, but SNI is not available
+ ssl_sock = self._ssl_context.wrap_socket(
+ tcp_sock,
+ do_handshake_on_connect=False,
+ )
+ else:
+ # If SSL context has already checked hostname, then don't need to do it again
+ if getattr(self._ssl_context, 'check_hostname', False): # type: ignore
+ verify_host = False
+
+ ssl_sock.settimeout(self._keepalive)
+ ssl_sock.do_handshake()
+
+ if verify_host:
+ # TODO: this type error is a true error:
+ # error: Module has no attribute "match_hostname" [attr-defined]
+ # Python 3.12 no longer have this method.
+ ssl.match_hostname(ssl_sock.getpeercert(), self._host) # type: ignore
+
+ return ssl_sock
+
+class _WebsocketWrapper:
+ OPCODE_CONTINUATION = 0x0
+ OPCODE_TEXT = 0x1
+ OPCODE_BINARY = 0x2
+ OPCODE_CONNCLOSE = 0x8
+ OPCODE_PING = 0x9
+ OPCODE_PONG = 0xa
+
+ def __init__(
+ self,
+ socket: socket.socket | ssl.SSLSocket,
+ host: str,
+ port: int,
+ is_ssl: bool,
+ path: str,
+ extra_headers: WebSocketHeaders | None,
+ ):
+ self.connected = False
+
+ self._ssl = is_ssl
+ self._host = host
+ self._port = port
+ self._socket = socket
+ self._path = path
+
+ self._sendbuffer = bytearray()
+ self._readbuffer = bytearray()
+
+ self._requested_size = 0
+ self._payload_head = 0
+ self._readbuffer_head = 0
+
+ self._do_handshake(extra_headers)
+
+ def __del__(self) -> None:
+ self._sendbuffer = bytearray()
+ self._readbuffer = bytearray()
+
+ def _do_handshake(self, extra_headers: WebSocketHeaders | None) -> None:
+
+ sec_websocket_key = uuid.uuid4().bytes
+ sec_websocket_key = base64.b64encode(sec_websocket_key)
+
+ if self._ssl:
+ default_port = 443
+ http_schema = "https"
+ else:
+ default_port = 80
+ http_schema = "http"
+
+ if default_port == self._port:
+ host_port = f"{self._host}"
+ else:
+ host_port = f"{self._host}:{self._port}"
+
+ websocket_headers = {
+ "Host": host_port,
+ "Upgrade": "websocket",
+ "Connection": "Upgrade",
+ "Origin": f"{http_schema}://{host_port}",
+ "Sec-WebSocket-Key": sec_websocket_key.decode("utf8"),
+ "Sec-Websocket-Version": "13",
+ "Sec-Websocket-Protocol": "mqtt",
+ }
+
+ # This is checked in ws_set_options so it will either be None, a
+ # dictionary, or a callable
+ if isinstance(extra_headers, dict):
+ websocket_headers.update(extra_headers)
+ elif callable(extra_headers):
+ websocket_headers = extra_headers(websocket_headers)
+
+ header = "\r\n".join([
+ f"GET {self._path} HTTP/1.1",
+ "\r\n".join(f"{i}: {j}" for i, j in websocket_headers.items()),
+ "\r\n",
+ ]).encode("utf8")
+
+ self._socket.send(header)
+
+ has_secret = False
+ has_upgrade = False
+
+ while True:
+ # read HTTP response header as lines
+ try:
+ byte = self._socket.recv(1)
+ except ConnectionResetError:
+ byte = b""
+
+ self._readbuffer.extend(byte)
+
+ # line end
+ if byte == b"\n":
+ if len(self._readbuffer) > 2:
+ # check upgrade
+ if b"connection" in str(self._readbuffer).lower().encode('utf-8'):
+ if b"upgrade" not in str(self._readbuffer).lower().encode('utf-8'):
+ raise WebsocketConnectionError(
+ "WebSocket handshake error, connection not upgraded")
+ else:
+ has_upgrade = True
+
+ # check key hash
+ if b"sec-websocket-accept" in str(self._readbuffer).lower().encode('utf-8'):
+ GUID = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
+
+ server_hash_str = self._readbuffer.decode(
+ 'utf-8').split(": ", 1)[1]
+ server_hash = server_hash_str.strip().encode('utf-8')
+
+ client_hash_key = sec_websocket_key.decode('utf-8') + GUID
+ # Use of SHA-1 is OK here; it's according to the Websocket spec.
+ client_hash_digest = hashlib.sha1(client_hash_key.encode('utf-8')) # noqa: S324
+ client_hash = base64.b64encode(client_hash_digest.digest())
+
+ if server_hash != client_hash:
+ raise WebsocketConnectionError(
+ "WebSocket handshake error, invalid secret key")
+ else:
+ has_secret = True
+ else:
+ # ending linebreak
+ break
+
+ # reset linebuffer
+ self._readbuffer = bytearray()
+
+ # connection reset
+ elif not byte:
+ raise WebsocketConnectionError("WebSocket handshake error")
+
+ if not has_upgrade or not has_secret:
+ raise WebsocketConnectionError("WebSocket handshake error")
+
+ self._readbuffer = bytearray()
+ self.connected = True
+
+ def _create_frame(
+ self, opcode: int, data: bytearray, do_masking: int = 1
+ ) -> bytearray:
+ header = bytearray()
+ length = len(data)
+
+ mask_key = bytearray(os.urandom(4))
+ mask_flag = do_masking
+
+ # 1 << 7 is the final flag, we don't send continuated data
+ header.append(1 << 7 | opcode)
+
+ if length < 126:
+ header.append(mask_flag << 7 | length)
+
+ elif length < 65536:
+ header.append(mask_flag << 7 | 126)
+ header += struct.pack("!H", length)
+
+ elif length < 0x8000000000000001:
+ header.append(mask_flag << 7 | 127)
+ header += struct.pack("!Q", length)
+
+ else:
+ raise ValueError("Maximum payload size is 2^63")
+
+ if mask_flag == 1:
+ for index in range(length):
+ data[index] ^= mask_key[index % 4]
+ data = mask_key + data
+
+ return header + data
+
+ def _buffered_read(self, length: int) -> bytearray:
+
+ # try to recv and store needed bytes
+ wanted_bytes = length - (len(self._readbuffer) - self._readbuffer_head)
+ if wanted_bytes > 0:
+
+ data = self._socket.recv(wanted_bytes)
+
+ if not data:
+ raise ConnectionAbortedError
+ else:
+ self._readbuffer.extend(data)
+
+ if len(data) < wanted_bytes:
+ raise BlockingIOError
+
+ self._readbuffer_head += length
+ return self._readbuffer[self._readbuffer_head - length:self._readbuffer_head]
+
+ def _recv_impl(self, length: int) -> bytes:
+
+ # try to decode websocket payload part from data
+ try:
+
+ self._readbuffer_head = 0
+
+ result = b""
+
+ chunk_startindex = self._payload_head
+ chunk_endindex = self._payload_head + length
+
+ header1 = self._buffered_read(1)
+ header2 = self._buffered_read(1)
+
+ opcode = (header1[0] & 0x0f)
+ maskbit = (header2[0] & 0x80) == 0x80
+ lengthbits = (header2[0] & 0x7f)
+ payload_length = lengthbits
+ mask_key = None
+
+ # read length
+ if lengthbits == 0x7e:
+
+ value = self._buffered_read(2)
+ payload_length, = struct.unpack("!H", value)
+
+ elif lengthbits == 0x7f:
+
+ value = self._buffered_read(8)
+ payload_length, = struct.unpack("!Q", value)
+
+ # read mask
+ if maskbit:
+ mask_key = self._buffered_read(4)
+
+ # if frame payload is shorter than the requested data, read only the possible part
+ readindex = chunk_endindex
+ if payload_length < readindex:
+ readindex = payload_length
+
+ if readindex > 0:
+ # get payload chunk
+ payload = self._buffered_read(readindex)
+
+ # unmask only the needed part
+ if mask_key is not None:
+ for index in range(chunk_startindex, readindex):
+ payload[index] ^= mask_key[index % 4]
+
+ result = payload[chunk_startindex:readindex]
+ self._payload_head = readindex
+ else:
+ payload = bytearray()
+
+ # check if full frame arrived and reset readbuffer and payloadhead if needed
+ if readindex == payload_length:
+ self._readbuffer = bytearray()
+ self._payload_head = 0
+
+ # respond to non-binary opcodes, their arrival is not guaranteed because of non-blocking sockets
+ if opcode == _WebsocketWrapper.OPCODE_CONNCLOSE:
+ frame = self._create_frame(
+ _WebsocketWrapper.OPCODE_CONNCLOSE, payload, 0)
+ self._socket.send(frame)
+
+ if opcode == _WebsocketWrapper.OPCODE_PING:
+ frame = self._create_frame(
+ _WebsocketWrapper.OPCODE_PONG, payload, 0)
+ self._socket.send(frame)
+
+ # This isn't *proper* handling of continuation frames, but given
+ # that we only support binary frames, it is *probably* good enough.
+ if (opcode == _WebsocketWrapper.OPCODE_BINARY or opcode == _WebsocketWrapper.OPCODE_CONTINUATION) \
+ and payload_length > 0:
+ return result
+ else:
+ raise BlockingIOError
+
+ except ConnectionError:
+ self.connected = False
+ return b''
+
+ def _send_impl(self, data: bytes) -> int:
+
+ # if previous frame was sent successfully
+ if len(self._sendbuffer) == 0:
+ # create websocket frame
+ frame = self._create_frame(
+ _WebsocketWrapper.OPCODE_BINARY, bytearray(data))
+ self._sendbuffer.extend(frame)
+ self._requested_size = len(data)
+
+ # try to write out as much as possible
+ length = self._socket.send(self._sendbuffer)
+
+ self._sendbuffer = self._sendbuffer[length:]
+
+ if len(self._sendbuffer) == 0:
+ # buffer sent out completely, return with payload's size
+ return self._requested_size
+ else:
+ # couldn't send whole data, request the same data again with 0 as sent length
+ return 0
+
+ def recv(self, length: int) -> bytes:
+ return self._recv_impl(length)
+
+ def read(self, length: int) -> bytes:
+ return self._recv_impl(length)
+
+ def send(self, data: bytes) -> int:
+ return self._send_impl(data)
+
+ def write(self, data: bytes) -> int:
+ return self._send_impl(data)
+
+ def close(self) -> None:
+ self._socket.close()
+
+ def fileno(self) -> int:
+ return self._socket.fileno()
+
+ def pending(self) -> int:
+ # Fix for bug #131: a SSL socket may still have data available
+ # for reading without select() being aware of it.
+ if self._ssl:
+ return self._socket.pending() # type: ignore[union-attr]
+ else:
+ # normal socket rely only on select()
+ return 0
+
+ def setblocking(self, flag: bool) -> None:
+ self._socket.setblocking(flag)
diff --git a/sbapp/pmqtt/enums.py b/sbapp/pmqtt/enums.py
new file mode 100644
index 0000000..5428769
--- /dev/null
+++ b/sbapp/pmqtt/enums.py
@@ -0,0 +1,113 @@
+import enum
+
+
+class MQTTErrorCode(enum.IntEnum):
+ MQTT_ERR_AGAIN = -1
+ MQTT_ERR_SUCCESS = 0
+ MQTT_ERR_NOMEM = 1
+ MQTT_ERR_PROTOCOL = 2
+ MQTT_ERR_INVAL = 3
+ MQTT_ERR_NO_CONN = 4
+ MQTT_ERR_CONN_REFUSED = 5
+ MQTT_ERR_NOT_FOUND = 6
+ MQTT_ERR_CONN_LOST = 7
+ MQTT_ERR_TLS = 8
+ MQTT_ERR_PAYLOAD_SIZE = 9
+ MQTT_ERR_NOT_SUPPORTED = 10
+ MQTT_ERR_AUTH = 11
+ MQTT_ERR_ACL_DENIED = 12
+ MQTT_ERR_UNKNOWN = 13
+ MQTT_ERR_ERRNO = 14
+ MQTT_ERR_QUEUE_SIZE = 15
+ MQTT_ERR_KEEPALIVE = 16
+
+
+class MQTTProtocolVersion(enum.IntEnum):
+ MQTTv31 = 3
+ MQTTv311 = 4
+ MQTTv5 = 5
+
+
+class CallbackAPIVersion(enum.Enum):
+ """Defined the arguments passed to all user-callback.
+
+ See each callbacks for details: `on_connect`, `on_connect_fail`, `on_disconnect`, `on_message`, `on_publish`,
+ `on_subscribe`, `on_unsubscribe`, `on_log`, `on_socket_open`, `on_socket_close`,
+ `on_socket_register_write`, `on_socket_unregister_write`
+ """
+ VERSION1 = 1
+ """The version used with paho-mqtt 1.x before introducing CallbackAPIVersion.
+
+ This version had different arguments depending if MQTTv5 or MQTTv3 was used. `Properties` & `ReasonCode` were missing
+ on some callback (apply only to MQTTv5).
+
+ This version is deprecated and will be removed in version 3.0.
+ """
+ VERSION2 = 2
+ """ This version fix some of the shortcoming of previous version.
+
+ Callback have the same signature if using MQTTv5 or MQTTv3. `ReasonCode` are used in MQTTv3.
+ """
+
+
+class MessageType(enum.IntEnum):
+ CONNECT = 0x10
+ CONNACK = 0x20
+ PUBLISH = 0x30
+ PUBACK = 0x40
+ PUBREC = 0x50
+ PUBREL = 0x60
+ PUBCOMP = 0x70
+ SUBSCRIBE = 0x80
+ SUBACK = 0x90
+ UNSUBSCRIBE = 0xA0
+ UNSUBACK = 0xB0
+ PINGREQ = 0xC0
+ PINGRESP = 0xD0
+ DISCONNECT = 0xE0
+ AUTH = 0xF0
+
+
+class LogLevel(enum.IntEnum):
+ MQTT_LOG_INFO = 0x01
+ MQTT_LOG_NOTICE = 0x02
+ MQTT_LOG_WARNING = 0x04
+ MQTT_LOG_ERR = 0x08
+ MQTT_LOG_DEBUG = 0x10
+
+
+class ConnackCode(enum.IntEnum):
+ CONNACK_ACCEPTED = 0
+ CONNACK_REFUSED_PROTOCOL_VERSION = 1
+ CONNACK_REFUSED_IDENTIFIER_REJECTED = 2
+ CONNACK_REFUSED_SERVER_UNAVAILABLE = 3
+ CONNACK_REFUSED_BAD_USERNAME_PASSWORD = 4
+ CONNACK_REFUSED_NOT_AUTHORIZED = 5
+
+
+class _ConnectionState(enum.Enum):
+ MQTT_CS_NEW = enum.auto()
+ MQTT_CS_CONNECT_ASYNC = enum.auto()
+ MQTT_CS_CONNECTING = enum.auto()
+ MQTT_CS_CONNECTED = enum.auto()
+ MQTT_CS_CONNECTION_LOST = enum.auto()
+ MQTT_CS_DISCONNECTING = enum.auto()
+ MQTT_CS_DISCONNECTED = enum.auto()
+
+
+class MessageState(enum.IntEnum):
+ MQTT_MS_INVALID = 0
+ MQTT_MS_PUBLISH = 1
+ MQTT_MS_WAIT_FOR_PUBACK = 2
+ MQTT_MS_WAIT_FOR_PUBREC = 3
+ MQTT_MS_RESEND_PUBREL = 4
+ MQTT_MS_WAIT_FOR_PUBREL = 5
+ MQTT_MS_RESEND_PUBCOMP = 6
+ MQTT_MS_WAIT_FOR_PUBCOMP = 7
+ MQTT_MS_SEND_PUBREC = 8
+ MQTT_MS_QUEUED = 9
+
+
+class PahoClientMode(enum.IntEnum):
+ MQTT_CLIENT = 0
+ MQTT_BRIDGE = 1
diff --git a/sbapp/pmqtt/matcher.py b/sbapp/pmqtt/matcher.py
new file mode 100644
index 0000000..b73c13a
--- /dev/null
+++ b/sbapp/pmqtt/matcher.py
@@ -0,0 +1,78 @@
+class MQTTMatcher:
+ """Intended to manage topic filters including wildcards.
+
+ Internally, MQTTMatcher use a prefix tree (trie) to store
+ values associated with filters, and has an iter_match()
+ method to iterate efficiently over all filters that match
+ some topic name."""
+
+ class Node:
+ __slots__ = '_children', '_content'
+
+ def __init__(self):
+ self._children = {}
+ self._content = None
+
+ def __init__(self):
+ self._root = self.Node()
+
+ def __setitem__(self, key, value):
+ """Add a topic filter :key to the prefix tree
+ and associate it to :value"""
+ node = self._root
+ for sym in key.split('/'):
+ node = node._children.setdefault(sym, self.Node())
+ node._content = value
+
+ def __getitem__(self, key):
+ """Retrieve the value associated with some topic filter :key"""
+ try:
+ node = self._root
+ for sym in key.split('/'):
+ node = node._children[sym]
+ if node._content is None:
+ raise KeyError(key)
+ return node._content
+ except KeyError as ke:
+ raise KeyError(key) from ke
+
+ def __delitem__(self, key):
+ """Delete the value associated with some topic filter :key"""
+ lst = []
+ try:
+ parent, node = None, self._root
+ for k in key.split('/'):
+ parent, node = node, node._children[k]
+ lst.append((parent, k, node))
+ # TODO
+ node._content = None
+ except KeyError as ke:
+ raise KeyError(key) from ke
+ else: # cleanup
+ for parent, k, node in reversed(lst):
+ if node._children or node._content is not None:
+ break
+ del parent._children[k]
+
+ def iter_match(self, topic):
+ """Return an iterator on all values associated with filters
+ that match the :topic"""
+ lst = topic.split('/')
+ normal = not topic.startswith('$')
+ def rec(node, i=0):
+ if i == len(lst):
+ if node._content is not None:
+ yield node._content
+ else:
+ part = lst[i]
+ if part in node._children:
+ for content in rec(node._children[part], i + 1):
+ yield content
+ if '+' in node._children and (normal or i > 0):
+ for content in rec(node._children['+'], i + 1):
+ yield content
+ if '#' in node._children and (normal or i > 0):
+ content = node._children['#']._content
+ if content is not None:
+ yield content
+ return rec(self._root)
diff --git a/sbapp/pmqtt/packettypes.py b/sbapp/pmqtt/packettypes.py
new file mode 100644
index 0000000..d205149
--- /dev/null
+++ b/sbapp/pmqtt/packettypes.py
@@ -0,0 +1,43 @@
+"""
+*******************************************************************
+ Copyright (c) 2017, 2019 IBM Corp.
+
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v2.0
+ and Eclipse Distribution License v1.0 which accompany this distribution.
+
+ The Eclipse Public License is available at
+ http://www.eclipse.org/legal/epl-v20.html
+ and the Eclipse Distribution License is available at
+ http://www.eclipse.org/org/documents/edl-v10.php.
+
+ Contributors:
+ Ian Craggs - initial implementation and/or documentation
+*******************************************************************
+"""
+
+
+class PacketTypes:
+
+ """
+ Packet types class. Includes the AUTH packet for MQTT v5.0.
+
+ Holds constants for each packet type such as PacketTypes.PUBLISH
+ and packet name strings: PacketTypes.Names[PacketTypes.PUBLISH].
+
+ """
+
+ indexes = range(1, 16)
+
+ # Packet types
+ CONNECT, CONNACK, PUBLISH, PUBACK, PUBREC, PUBREL, \
+ PUBCOMP, SUBSCRIBE, SUBACK, UNSUBSCRIBE, UNSUBACK, \
+ PINGREQ, PINGRESP, DISCONNECT, AUTH = indexes
+
+ # Dummy packet type for properties use - will delay only applies to will
+ WILLMESSAGE = 99
+
+ Names = ( "reserved", \
+ "Connect", "Connack", "Publish", "Puback", "Pubrec", "Pubrel", \
+ "Pubcomp", "Subscribe", "Suback", "Unsubscribe", "Unsuback", \
+ "Pingreq", "Pingresp", "Disconnect", "Auth")
diff --git a/sbapp/pmqtt/properties.py b/sbapp/pmqtt/properties.py
new file mode 100644
index 0000000..f307b86
--- /dev/null
+++ b/sbapp/pmqtt/properties.py
@@ -0,0 +1,421 @@
+# *******************************************************************
+# Copyright (c) 2017, 2019 IBM Corp.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v2.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+# http://www.eclipse.org/legal/epl-v20.html
+# and the Eclipse Distribution License is available at
+# http://www.eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+# Ian Craggs - initial implementation and/or documentation
+# *******************************************************************
+
+import struct
+
+from .packettypes import PacketTypes
+
+
+class MQTTException(Exception):
+ pass
+
+
+class MalformedPacket(MQTTException):
+ pass
+
+
+def writeInt16(length):
+ # serialize a 16 bit integer to network format
+ return bytearray(struct.pack("!H", length))
+
+
+def readInt16(buf):
+ # deserialize a 16 bit integer from network format
+ return struct.unpack("!H", buf[:2])[0]
+
+
+def writeInt32(length):
+ # serialize a 32 bit integer to network format
+ return bytearray(struct.pack("!L", length))
+
+
+def readInt32(buf):
+ # deserialize a 32 bit integer from network format
+ return struct.unpack("!L", buf[:4])[0]
+
+
+def writeUTF(data):
+ # data could be a string, or bytes. If string, encode into bytes with utf-8
+ if not isinstance(data, bytes):
+ data = bytes(data, "utf-8")
+ return writeInt16(len(data)) + data
+
+
+def readUTF(buffer, maxlen):
+ if maxlen >= 2:
+ length = readInt16(buffer)
+ else:
+ raise MalformedPacket("Not enough data to read string length")
+ maxlen -= 2
+ if length > maxlen:
+ raise MalformedPacket("Length delimited string too long")
+ buf = buffer[2:2+length].decode("utf-8")
+ # look for chars which are invalid for MQTT
+ for c in buf: # look for D800-DFFF in the UTF string
+ ord_c = ord(c)
+ if ord_c >= 0xD800 and ord_c <= 0xDFFF:
+ raise MalformedPacket("[MQTT-1.5.4-1] D800-DFFF found in UTF-8 data")
+ if ord_c == 0x00: # look for null in the UTF string
+ raise MalformedPacket("[MQTT-1.5.4-2] Null found in UTF-8 data")
+ if ord_c == 0xFEFF:
+ raise MalformedPacket("[MQTT-1.5.4-3] U+FEFF in UTF-8 data")
+ return buf, length+2
+
+
+def writeBytes(buffer):
+ return writeInt16(len(buffer)) + buffer
+
+
+def readBytes(buffer):
+ length = readInt16(buffer)
+ return buffer[2:2+length], length+2
+
+
+class VariableByteIntegers: # Variable Byte Integer
+ """
+ MQTT variable byte integer helper class. Used
+ in several places in MQTT v5.0 properties.
+
+ """
+
+ @staticmethod
+ def encode(x):
+ """
+ Convert an integer 0 <= x <= 268435455 into multi-byte format.
+ Returns the buffer converted from the integer.
+ """
+ if not 0 <= x <= 268435455:
+ raise ValueError(f"Value {x!r} must be in range 0-268435455")
+ buffer = b''
+ while 1:
+ digit = x % 128
+ x //= 128
+ if x > 0:
+ digit |= 0x80
+ buffer += bytes([digit])
+ if x == 0:
+ break
+ return buffer
+
+ @staticmethod
+ def decode(buffer):
+ """
+ Get the value of a multi-byte integer from a buffer
+ Return the value, and the number of bytes used.
+
+ [MQTT-1.5.5-1] the encoded value MUST use the minimum number of bytes necessary to represent the value
+ """
+ multiplier = 1
+ value = 0
+ bytes = 0
+ while 1:
+ bytes += 1
+ digit = buffer[0]
+ buffer = buffer[1:]
+ value += (digit & 127) * multiplier
+ if digit & 128 == 0:
+ break
+ multiplier *= 128
+ return (value, bytes)
+
+
+class Properties:
+ """MQTT v5.0 properties class.
+
+ See Properties.names for a list of accepted property names along with their numeric values.
+
+ See Properties.properties for the data type of each property.
+
+ Example of use::
+
+ publish_properties = Properties(PacketTypes.PUBLISH)
+ publish_properties.UserProperty = ("a", "2")
+ publish_properties.UserProperty = ("c", "3")
+
+ First the object is created with packet type as argument, no properties will be present at
+ this point. Then properties are added as attributes, the name of which is the string property
+ name without the spaces.
+
+ """
+
+ def __init__(self, packetType):
+ self.packetType = packetType
+ self.types = ["Byte", "Two Byte Integer", "Four Byte Integer", "Variable Byte Integer",
+ "Binary Data", "UTF-8 Encoded String", "UTF-8 String Pair"]
+
+ self.names = {
+ "Payload Format Indicator": 1,
+ "Message Expiry Interval": 2,
+ "Content Type": 3,
+ "Response Topic": 8,
+ "Correlation Data": 9,
+ "Subscription Identifier": 11,
+ "Session Expiry Interval": 17,
+ "Assigned Client Identifier": 18,
+ "Server Keep Alive": 19,
+ "Authentication Method": 21,
+ "Authentication Data": 22,
+ "Request Problem Information": 23,
+ "Will Delay Interval": 24,
+ "Request Response Information": 25,
+ "Response Information": 26,
+ "Server Reference": 28,
+ "Reason String": 31,
+ "Receive Maximum": 33,
+ "Topic Alias Maximum": 34,
+ "Topic Alias": 35,
+ "Maximum QoS": 36,
+ "Retain Available": 37,
+ "User Property": 38,
+ "Maximum Packet Size": 39,
+ "Wildcard Subscription Available": 40,
+ "Subscription Identifier Available": 41,
+ "Shared Subscription Available": 42
+ }
+
+ self.properties = {
+ # id: type, packets
+ # payload format indicator
+ 1: (self.types.index("Byte"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]),
+ 2: (self.types.index("Four Byte Integer"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]),
+ 3: (self.types.index("UTF-8 Encoded String"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]),
+ 8: (self.types.index("UTF-8 Encoded String"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]),
+ 9: (self.types.index("Binary Data"), [PacketTypes.PUBLISH, PacketTypes.WILLMESSAGE]),
+ 11: (self.types.index("Variable Byte Integer"),
+ [PacketTypes.PUBLISH, PacketTypes.SUBSCRIBE]),
+ 17: (self.types.index("Four Byte Integer"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.DISCONNECT]),
+ 18: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK]),
+ 19: (self.types.index("Two Byte Integer"), [PacketTypes.CONNACK]),
+ 21: (self.types.index("UTF-8 Encoded String"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.AUTH]),
+ 22: (self.types.index("Binary Data"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK, PacketTypes.AUTH]),
+ 23: (self.types.index("Byte"),
+ [PacketTypes.CONNECT]),
+ 24: (self.types.index("Four Byte Integer"), [PacketTypes.WILLMESSAGE]),
+ 25: (self.types.index("Byte"), [PacketTypes.CONNECT]),
+ 26: (self.types.index("UTF-8 Encoded String"), [PacketTypes.CONNACK]),
+ 28: (self.types.index("UTF-8 Encoded String"),
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]),
+ 31: (self.types.index("UTF-8 Encoded String"),
+ [PacketTypes.CONNACK, PacketTypes.PUBACK, PacketTypes.PUBREC,
+ PacketTypes.PUBREL, PacketTypes.PUBCOMP, PacketTypes.SUBACK,
+ PacketTypes.UNSUBACK, PacketTypes.DISCONNECT, PacketTypes.AUTH]),
+ 33: (self.types.index("Two Byte Integer"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK]),
+ 34: (self.types.index("Two Byte Integer"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK]),
+ 35: (self.types.index("Two Byte Integer"), [PacketTypes.PUBLISH]),
+ 36: (self.types.index("Byte"), [PacketTypes.CONNACK]),
+ 37: (self.types.index("Byte"), [PacketTypes.CONNACK]),
+ 38: (self.types.index("UTF-8 String Pair"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK,
+ PacketTypes.PUBLISH, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.PUBREL, PacketTypes.PUBCOMP,
+ PacketTypes.SUBSCRIBE, PacketTypes.SUBACK,
+ PacketTypes.UNSUBSCRIBE, PacketTypes.UNSUBACK,
+ PacketTypes.DISCONNECT, PacketTypes.AUTH, PacketTypes.WILLMESSAGE]),
+ 39: (self.types.index("Four Byte Integer"),
+ [PacketTypes.CONNECT, PacketTypes.CONNACK]),
+ 40: (self.types.index("Byte"), [PacketTypes.CONNACK]),
+ 41: (self.types.index("Byte"), [PacketTypes.CONNACK]),
+ 42: (self.types.index("Byte"), [PacketTypes.CONNACK]),
+ }
+
+ def allowsMultiple(self, compressedName):
+ return self.getIdentFromName(compressedName) in [11, 38]
+
+ def getIdentFromName(self, compressedName):
+ # return the identifier corresponding to the property name
+ result = -1
+ for name in self.names.keys():
+ if compressedName == name.replace(' ', ''):
+ result = self.names[name]
+ break
+ return result
+
+ def __setattr__(self, name, value):
+ name = name.replace(' ', '')
+ privateVars = ["packetType", "types", "names", "properties"]
+ if name in privateVars:
+ object.__setattr__(self, name, value)
+ else:
+ # the name could have spaces in, or not. Remove spaces before assignment
+ if name not in [aname.replace(' ', '') for aname in self.names.keys()]:
+ raise MQTTException(
+ f"Property name must be one of {self.names.keys()}")
+ # check that this attribute applies to the packet type
+ if self.packetType not in self.properties[self.getIdentFromName(name)][1]:
+ raise MQTTException(f"Property {name} does not apply to packet type {PacketTypes.Names[self.packetType]}")
+
+ # Check for forbidden values
+ if not isinstance(value, list):
+ if name in ["ReceiveMaximum", "TopicAlias"] \
+ and (value < 1 or value > 65535):
+
+ raise MQTTException(f"{name} property value must be in the range 1-65535")
+ elif name in ["TopicAliasMaximum"] \
+ and (value < 0 or value > 65535):
+
+ raise MQTTException(f"{name} property value must be in the range 0-65535")
+ elif name in ["MaximumPacketSize", "SubscriptionIdentifier"] \
+ and (value < 1 or value > 268435455):
+
+ raise MQTTException(f"{name} property value must be in the range 1-268435455")
+ elif name in ["RequestResponseInformation", "RequestProblemInformation", "PayloadFormatIndicator"] \
+ and (value != 0 and value != 1):
+
+ raise MQTTException(
+ f"{name} property value must be 0 or 1")
+
+ if self.allowsMultiple(name):
+ if not isinstance(value, list):
+ value = [value]
+ if hasattr(self, name):
+ value = object.__getattribute__(self, name) + value
+ object.__setattr__(self, name, value)
+
+ def __str__(self):
+ buffer = "["
+ first = True
+ for name in self.names.keys():
+ compressedName = name.replace(' ', '')
+ if hasattr(self, compressedName):
+ if not first:
+ buffer += ", "
+ buffer += f"{compressedName} : {getattr(self, compressedName)}"
+ first = False
+ buffer += "]"
+ return buffer
+
+ def json(self):
+ data = {}
+ for name in self.names.keys():
+ compressedName = name.replace(' ', '')
+ if hasattr(self, compressedName):
+ val = getattr(self, compressedName)
+ if compressedName == 'CorrelationData' and isinstance(val, bytes):
+ data[compressedName] = val.hex()
+ else:
+ data[compressedName] = val
+ return data
+
+ def isEmpty(self):
+ rc = True
+ for name in self.names.keys():
+ compressedName = name.replace(' ', '')
+ if hasattr(self, compressedName):
+ rc = False
+ break
+ return rc
+
+ def clear(self):
+ for name in self.names.keys():
+ compressedName = name.replace(' ', '')
+ if hasattr(self, compressedName):
+ delattr(self, compressedName)
+
+ def writeProperty(self, identifier, type, value):
+ buffer = b""
+ buffer += VariableByteIntegers.encode(identifier) # identifier
+ if type == self.types.index("Byte"): # value
+ buffer += bytes([value])
+ elif type == self.types.index("Two Byte Integer"):
+ buffer += writeInt16(value)
+ elif type == self.types.index("Four Byte Integer"):
+ buffer += writeInt32(value)
+ elif type == self.types.index("Variable Byte Integer"):
+ buffer += VariableByteIntegers.encode(value)
+ elif type == self.types.index("Binary Data"):
+ buffer += writeBytes(value)
+ elif type == self.types.index("UTF-8 Encoded String"):
+ buffer += writeUTF(value)
+ elif type == self.types.index("UTF-8 String Pair"):
+ buffer += writeUTF(value[0]) + writeUTF(value[1])
+ return buffer
+
+ def pack(self):
+ # serialize properties into buffer for sending over network
+ buffer = b""
+ for name in self.names.keys():
+ compressedName = name.replace(' ', '')
+ if hasattr(self, compressedName):
+ identifier = self.getIdentFromName(compressedName)
+ attr_type = self.properties[identifier][0]
+ if self.allowsMultiple(compressedName):
+ for prop in getattr(self, compressedName):
+ buffer += self.writeProperty(identifier,
+ attr_type, prop)
+ else:
+ buffer += self.writeProperty(identifier, attr_type,
+ getattr(self, compressedName))
+ return VariableByteIntegers.encode(len(buffer)) + buffer
+
+ def readProperty(self, buffer, type, propslen):
+ if type == self.types.index("Byte"):
+ value = buffer[0]
+ valuelen = 1
+ elif type == self.types.index("Two Byte Integer"):
+ value = readInt16(buffer)
+ valuelen = 2
+ elif type == self.types.index("Four Byte Integer"):
+ value = readInt32(buffer)
+ valuelen = 4
+ elif type == self.types.index("Variable Byte Integer"):
+ value, valuelen = VariableByteIntegers.decode(buffer)
+ elif type == self.types.index("Binary Data"):
+ value, valuelen = readBytes(buffer)
+ elif type == self.types.index("UTF-8 Encoded String"):
+ value, valuelen = readUTF(buffer, propslen)
+ elif type == self.types.index("UTF-8 String Pair"):
+ value, valuelen = readUTF(buffer, propslen)
+ buffer = buffer[valuelen:] # strip the bytes used by the value
+ value1, valuelen1 = readUTF(buffer, propslen - valuelen)
+ value = (value, value1)
+ valuelen += valuelen1
+ return value, valuelen
+
+ def getNameFromIdent(self, identifier):
+ rc = None
+ for name in self.names:
+ if self.names[name] == identifier:
+ rc = name
+ return rc
+
+ def unpack(self, buffer):
+ self.clear()
+ # deserialize properties into attributes from buffer received from network
+ propslen, VBIlen = VariableByteIntegers.decode(buffer)
+ buffer = buffer[VBIlen:] # strip the bytes used by the VBI
+ propslenleft = propslen
+ while propslenleft > 0: # properties length is 0 if there are none
+ identifier, VBIlen2 = VariableByteIntegers.decode(
+ buffer) # property identifier
+ buffer = buffer[VBIlen2:] # strip the bytes used by the VBI
+ propslenleft -= VBIlen2
+ attr_type = self.properties[identifier][0]
+ value, valuelen = self.readProperty(
+ buffer, attr_type, propslenleft)
+ buffer = buffer[valuelen:] # strip the bytes used by the value
+ propslenleft -= valuelen
+ propname = self.getNameFromIdent(identifier)
+ compressedName = propname.replace(' ', '')
+ if not self.allowsMultiple(compressedName) and hasattr(self, compressedName):
+ raise MQTTException(
+ f"Property '{property}' must not exist more than once")
+ setattr(self, propname, value)
+ return self, propslen + VBIlen
diff --git a/sbapp/pmqtt/publish.py b/sbapp/pmqtt/publish.py
new file mode 100644
index 0000000..b8b9476
--- /dev/null
+++ b/sbapp/pmqtt/publish.py
@@ -0,0 +1,306 @@
+# Copyright (c) 2014 Roger Light
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v2.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+# http://www.eclipse.org/legal/epl-v20.html
+# and the Eclipse Distribution License is available at
+# http://www.eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+# Roger Light - initial API and implementation
+
+"""
+This module provides some helper functions to allow straightforward publishing
+of messages in a one-shot manner. In other words, they are useful for the
+situation where you have a single/multiple messages you want to publish to a
+broker, then disconnect and nothing else is required.
+"""
+from __future__ import annotations
+
+import collections
+from collections.abc import Iterable
+from typing import TYPE_CHECKING, Any, List, Tuple, Union
+
+from .enums import CallbackAPIVersion, MQTTProtocolVersion
+from .properties import Properties
+from .reasoncodes import ReasonCode
+
+from .. import mqtt
+from . import client as paho
+
+if TYPE_CHECKING:
+ try:
+ from typing import NotRequired, Required, TypedDict # type: ignore
+ except ImportError:
+ from typing_extensions import NotRequired, Required, TypedDict
+
+ try:
+ from typing import Literal
+ except ImportError:
+ from typing_extensions import Literal # type: ignore
+
+
+
+ class AuthParameter(TypedDict, total=False):
+ username: Required[str]
+ password: NotRequired[str]
+
+
+ class TLSParameter(TypedDict, total=False):
+ ca_certs: Required[str]
+ certfile: NotRequired[str]
+ keyfile: NotRequired[str]
+ tls_version: NotRequired[int]
+ ciphers: NotRequired[str]
+ insecure: NotRequired[bool]
+
+
+ class MessageDict(TypedDict, total=False):
+ topic: Required[str]
+ payload: NotRequired[paho.PayloadType]
+ qos: NotRequired[int]
+ retain: NotRequired[bool]
+
+ MessageTuple = Tuple[str, paho.PayloadType, int, bool]
+
+ MessagesList = List[Union[MessageDict, MessageTuple]]
+
+
+def _do_publish(client: paho.Client):
+ """Internal function"""
+
+ message = client._userdata.popleft()
+
+ if isinstance(message, dict):
+ client.publish(**message)
+ elif isinstance(message, (tuple, list)):
+ client.publish(*message)
+ else:
+ raise TypeError('message must be a dict, tuple, or list')
+
+
+def _on_connect(client: paho.Client, userdata: MessagesList, flags, reason_code, properties):
+ """Internal v5 callback"""
+ if reason_code == 0:
+ if len(userdata) > 0:
+ _do_publish(client)
+ else:
+ raise mqtt.MQTTException(paho.connack_string(reason_code))
+
+
+def _on_publish(
+ client: paho.Client, userdata: collections.deque[MessagesList], mid: int, reason_codes: ReasonCode, properties: Properties,
+) -> None:
+ """Internal callback"""
+ #pylint: disable=unused-argument
+
+ if len(userdata) == 0:
+ client.disconnect()
+ else:
+ _do_publish(client)
+
+
+def multiple(
+ msgs: MessagesList,
+ hostname: str = "localhost",
+ port: int = 1883,
+ client_id: str = "",
+ keepalive: int = 60,
+ will: MessageDict | None = None,
+ auth: AuthParameter | None = None,
+ tls: TLSParameter | None = None,
+ protocol: MQTTProtocolVersion = paho.MQTTv311,
+ transport: Literal["tcp", "websockets"] = "tcp",
+ proxy_args: Any | None = None,
+) -> None:
+ """Publish multiple messages to a broker, then disconnect cleanly.
+
+ This function creates an MQTT client, connects to a broker and publishes a
+ list of messages. Once the messages have been delivered, it disconnects
+ cleanly from the broker.
+
+ :param msgs: a list of messages to publish. Each message is either a dict or a
+ tuple.
+
+ If a dict, only the topic must be present. Default values will be
+ used for any missing arguments. The dict must be of the form:
+
+ msg = {'topic':"", 'payload':"", 'qos':,
+ 'retain':}
+ topic must be present and may not be empty.
+ If payload is "", None or not present then a zero length payload
+ will be published.
+ If qos is not present, the default of 0 is used.
+ If retain is not present, the default of False is used.
+
+ If a tuple, then it must be of the form:
+ ("", "", qos, retain)
+
+ :param str hostname: the address of the broker to connect to.
+ Defaults to localhost.
+
+ :param int port: the port to connect to the broker on. Defaults to 1883.
+
+ :param str client_id: the MQTT client id to use. If "" or None, the Paho library will
+ generate a client id automatically.
+
+ :param int keepalive: the keepalive timeout value for the client. Defaults to 60
+ seconds.
+
+ :param will: a dict containing will parameters for the client: will = {'topic':
+ "", 'payload':", 'qos':, 'retain':}.
+ Topic is required, all other parameters are optional and will
+ default to None, 0 and False respectively.
+ Defaults to None, which indicates no will should be used.
+
+ :param auth: a dict containing authentication parameters for the client:
+ auth = {'username':"", 'password':""}
+ Username is required, password is optional and will default to None
+ if not provided.
+ Defaults to None, which indicates no authentication is to be used.
+
+ :param tls: a dict containing TLS configuration parameters for the client:
+ dict = {'ca_certs':"", 'certfile':"",
+ 'keyfile':"", 'tls_version':"",
+ 'ciphers':", 'insecure':""}
+ ca_certs is required, all other parameters are optional and will
+ default to None if not provided, which results in the client using
+ the default behaviour - see the paho.mqtt.client documentation.
+ Alternatively, tls input can be an SSLContext object, which will be
+ processed using the tls_set_context method.
+ Defaults to None, which indicates that TLS should not be used.
+
+ :param str transport: set to "tcp" to use the default setting of transport which is
+ raw TCP. Set to "websockets" to use WebSockets as the transport.
+
+ :param proxy_args: a dictionary that will be given to the client.
+ """
+
+ if not isinstance(msgs, Iterable):
+ raise TypeError('msgs must be an iterable')
+ if len(msgs) == 0:
+ raise ValueError('msgs is empty')
+
+ client = paho.Client(
+ CallbackAPIVersion.VERSION2,
+ client_id=client_id,
+ userdata=collections.deque(msgs),
+ protocol=protocol,
+ transport=transport,
+ )
+
+ client.enable_logger()
+ client.on_publish = _on_publish
+ client.on_connect = _on_connect # type: ignore
+
+ if proxy_args is not None:
+ client.proxy_set(**proxy_args)
+
+ if auth:
+ username = auth.get('username')
+ if username:
+ password = auth.get('password')
+ client.username_pw_set(username, password)
+ else:
+ raise KeyError("The 'username' key was not found, this is "
+ "required for auth")
+
+ if will is not None:
+ client.will_set(**will)
+
+ if tls is not None:
+ if isinstance(tls, dict):
+ insecure = tls.pop('insecure', False)
+ # mypy don't get that tls no longer contains the key insecure
+ client.tls_set(**tls) # type: ignore[misc]
+ if insecure:
+ # Must be set *after* the `client.tls_set()` call since it sets
+ # up the SSL context that `client.tls_insecure_set` alters.
+ client.tls_insecure_set(insecure)
+ else:
+ # Assume input is SSLContext object
+ client.tls_set_context(tls)
+
+ client.connect(hostname, port, keepalive)
+ client.loop_forever()
+
+
+def single(
+ topic: str,
+ payload: paho.PayloadType = None,
+ qos: int = 0,
+ retain: bool = False,
+ hostname: str = "localhost",
+ port: int = 1883,
+ client_id: str = "",
+ keepalive: int = 60,
+ will: MessageDict | None = None,
+ auth: AuthParameter | None = None,
+ tls: TLSParameter | None = None,
+ protocol: MQTTProtocolVersion = paho.MQTTv311,
+ transport: Literal["tcp", "websockets"] = "tcp",
+ proxy_args: Any | None = None,
+) -> None:
+ """Publish a single message to a broker, then disconnect cleanly.
+
+ This function creates an MQTT client, connects to a broker and publishes a
+ single message. Once the message has been delivered, it disconnects cleanly
+ from the broker.
+
+ :param str topic: the only required argument must be the topic string to which the
+ payload will be published.
+
+ :param payload: the payload to be published. If "" or None, a zero length payload
+ will be published.
+
+ :param int qos: the qos to use when publishing, default to 0.
+
+ :param bool retain: set the message to be retained (True) or not (False).
+
+ :param str hostname: the address of the broker to connect to.
+ Defaults to localhost.
+
+ :param int port: the port to connect to the broker on. Defaults to 1883.
+
+ :param str client_id: the MQTT client id to use. If "" or None, the Paho library will
+ generate a client id automatically.
+
+ :param int keepalive: the keepalive timeout value for the client. Defaults to 60
+ seconds.
+
+ :param will: a dict containing will parameters for the client: will = {'topic':
+ "", 'payload':", 'qos':, 'retain':}.
+ Topic is required, all other parameters are optional and will
+ default to None, 0 and False respectively.
+ Defaults to None, which indicates no will should be used.
+
+ :param auth: a dict containing authentication parameters for the client:
+ Username is required, password is optional and will default to None
+ auth = {'username':"", 'password':""}
+ if not provided.
+ Defaults to None, which indicates no authentication is to be used.
+
+ :param tls: a dict containing TLS configuration parameters for the client:
+ dict = {'ca_certs':"", 'certfile':"",
+ 'keyfile':"", 'tls_version':"",
+ 'ciphers':", 'insecure':""}
+ ca_certs is required, all other parameters are optional and will
+ default to None if not provided, which results in the client using
+ the default behaviour - see the paho.mqtt.client documentation.
+ Defaults to None, which indicates that TLS should not be used.
+ Alternatively, tls input can be an SSLContext object, which will be
+ processed using the tls_set_context method.
+
+ :param transport: set to "tcp" to use the default setting of transport which is
+ raw TCP. Set to "websockets" to use WebSockets as the transport.
+
+ :param proxy_args: a dictionary that will be given to the client.
+ """
+
+ msg: MessageDict = {'topic':topic, 'payload':payload, 'qos':qos, 'retain':retain}
+
+ multiple([msg], hostname, port, client_id, keepalive, will, auth, tls,
+ protocol, transport, proxy_args)
diff --git a/sbapp/pmqtt/py.typed b/sbapp/pmqtt/py.typed
new file mode 100644
index 0000000..e69de29
diff --git a/sbapp/pmqtt/reasoncodes.py b/sbapp/pmqtt/reasoncodes.py
new file mode 100644
index 0000000..243ac96
--- /dev/null
+++ b/sbapp/pmqtt/reasoncodes.py
@@ -0,0 +1,223 @@
+# *******************************************************************
+# Copyright (c) 2017, 2019 IBM Corp.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v2.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+# http://www.eclipse.org/legal/epl-v20.html
+# and the Eclipse Distribution License is available at
+# http://www.eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+# Ian Craggs - initial implementation and/or documentation
+# *******************************************************************
+
+import functools
+import warnings
+from typing import Any
+
+from .packettypes import PacketTypes
+
+
+@functools.total_ordering
+class ReasonCode:
+ """MQTT version 5.0 reason codes class.
+
+ See ReasonCode.names for a list of possible numeric values along with their
+ names and the packets to which they apply.
+
+ """
+
+ def __init__(self, packetType: int, aName: str ="Success", identifier: int =-1):
+ """
+ packetType: the type of the packet, such as PacketTypes.CONNECT that
+ this reason code will be used with. Some reason codes have different
+ names for the same identifier when used a different packet type.
+
+ aName: the String name of the reason code to be created. Ignored
+ if the identifier is set.
+
+ identifier: an integer value of the reason code to be created.
+
+ """
+
+ self.packetType = packetType
+ self.names = {
+ 0: {"Success": [PacketTypes.CONNACK, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.PUBREL, PacketTypes.PUBCOMP,
+ PacketTypes.UNSUBACK, PacketTypes.AUTH],
+ "Normal disconnection": [PacketTypes.DISCONNECT],
+ "Granted QoS 0": [PacketTypes.SUBACK]},
+ 1: {"Granted QoS 1": [PacketTypes.SUBACK]},
+ 2: {"Granted QoS 2": [PacketTypes.SUBACK]},
+ 4: {"Disconnect with will message": [PacketTypes.DISCONNECT]},
+ 16: {"No matching subscribers":
+ [PacketTypes.PUBACK, PacketTypes.PUBREC]},
+ 17: {"No subscription found": [PacketTypes.UNSUBACK]},
+ 24: {"Continue authentication": [PacketTypes.AUTH]},
+ 25: {"Re-authenticate": [PacketTypes.AUTH]},
+ 128: {"Unspecified error": [PacketTypes.CONNACK, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK,
+ PacketTypes.DISCONNECT], },
+ 129: {"Malformed packet":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 130: {"Protocol error":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 131: {"Implementation specific error": [PacketTypes.CONNACK,
+ PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.SUBACK,
+ PacketTypes.UNSUBACK, PacketTypes.DISCONNECT], },
+ 132: {"Unsupported protocol version": [PacketTypes.CONNACK]},
+ 133: {"Client identifier not valid": [PacketTypes.CONNACK]},
+ 134: {"Bad user name or password": [PacketTypes.CONNACK]},
+ 135: {"Not authorized": [PacketTypes.CONNACK, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.UNSUBACK,
+ PacketTypes.DISCONNECT], },
+ 136: {"Server unavailable": [PacketTypes.CONNACK]},
+ 137: {"Server busy": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 138: {"Banned": [PacketTypes.CONNACK]},
+ 139: {"Server shutting down": [PacketTypes.DISCONNECT]},
+ 140: {"Bad authentication method":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 141: {"Keep alive timeout": [PacketTypes.DISCONNECT]},
+ 142: {"Session taken over": [PacketTypes.DISCONNECT]},
+ 143: {"Topic filter invalid":
+ [PacketTypes.SUBACK, PacketTypes.UNSUBACK, PacketTypes.DISCONNECT]},
+ 144: {"Topic name invalid":
+ [PacketTypes.CONNACK, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.DISCONNECT]},
+ 145: {"Packet identifier in use":
+ [PacketTypes.PUBACK, PacketTypes.PUBREC,
+ PacketTypes.SUBACK, PacketTypes.UNSUBACK]},
+ 146: {"Packet identifier not found":
+ [PacketTypes.PUBREL, PacketTypes.PUBCOMP]},
+ 147: {"Receive maximum exceeded": [PacketTypes.DISCONNECT]},
+ 148: {"Topic alias invalid": [PacketTypes.DISCONNECT]},
+ 149: {"Packet too large": [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 150: {"Message rate too high": [PacketTypes.DISCONNECT]},
+ 151: {"Quota exceeded": [PacketTypes.CONNACK, PacketTypes.PUBACK,
+ PacketTypes.PUBREC, PacketTypes.SUBACK, PacketTypes.DISCONNECT], },
+ 152: {"Administrative action": [PacketTypes.DISCONNECT]},
+ 153: {"Payload format invalid":
+ [PacketTypes.PUBACK, PacketTypes.PUBREC, PacketTypes.DISCONNECT]},
+ 154: {"Retain not supported":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 155: {"QoS not supported":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 156: {"Use another server":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 157: {"Server moved":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 158: {"Shared subscription not supported":
+ [PacketTypes.SUBACK, PacketTypes.DISCONNECT]},
+ 159: {"Connection rate exceeded":
+ [PacketTypes.CONNACK, PacketTypes.DISCONNECT]},
+ 160: {"Maximum connect time":
+ [PacketTypes.DISCONNECT]},
+ 161: {"Subscription identifiers not supported":
+ [PacketTypes.SUBACK, PacketTypes.DISCONNECT]},
+ 162: {"Wildcard subscription not supported":
+ [PacketTypes.SUBACK, PacketTypes.DISCONNECT]},
+ }
+ if identifier == -1:
+ if packetType == PacketTypes.DISCONNECT and aName == "Success":
+ aName = "Normal disconnection"
+ self.set(aName)
+ else:
+ self.value = identifier
+ self.getName() # check it's good
+
+ def __getName__(self, packetType, identifier):
+ """
+ Get the reason code string name for a specific identifier.
+ The name can vary by packet type for the same identifier, which
+ is why the packet type is also required.
+
+ Used when displaying the reason code.
+ """
+ if identifier not in self.names:
+ raise KeyError(identifier)
+ names = self.names[identifier]
+ namelist = [name for name in names.keys() if packetType in names[name]]
+ if len(namelist) != 1:
+ raise ValueError(f"Expected exactly one name, found {namelist!r}")
+ return namelist[0]
+
+ def getId(self, name):
+ """
+ Get the numeric id corresponding to a reason code name.
+
+ Used when setting the reason code for a packetType
+ check that only valid codes for the packet are set.
+ """
+ for code in self.names.keys():
+ if name in self.names[code].keys():
+ if self.packetType in self.names[code][name]:
+ return code
+ raise KeyError(f"Reason code name not found: {name}")
+
+ def set(self, name):
+ self.value = self.getId(name)
+
+ def unpack(self, buffer):
+ c = buffer[0]
+ name = self.__getName__(self.packetType, c)
+ self.value = self.getId(name)
+ return 1
+
+ def getName(self):
+ """Returns the reason code name corresponding to the numeric value which is set.
+ """
+ return self.__getName__(self.packetType, self.value)
+
+ def __eq__(self, other):
+ if isinstance(other, int):
+ return self.value == other
+ if isinstance(other, str):
+ return other == str(self)
+ if isinstance(other, ReasonCode):
+ return self.value == other.value
+ return False
+
+ def __lt__(self, other):
+ if isinstance(other, int):
+ return self.value < other
+ if isinstance(other, ReasonCode):
+ return self.value < other.value
+ return NotImplemented
+
+ def __repr__(self):
+ try:
+ packet_name = PacketTypes.Names[self.packetType]
+ except IndexError:
+ packet_name = "Unknown"
+
+ return f"ReasonCode({packet_name}, {self.getName()!r})"
+
+ def __str__(self):
+ return self.getName()
+
+ def json(self):
+ return self.getName()
+
+ def pack(self):
+ return bytearray([self.value])
+
+ @property
+ def is_failure(self) -> bool:
+ return self.value >= 0x80
+
+
+class _CompatibilityIsInstance(type):
+ def __instancecheck__(self, other: Any) -> bool:
+ return isinstance(other, ReasonCode)
+
+
+class ReasonCodes(ReasonCode, metaclass=_CompatibilityIsInstance):
+ def __init__(self, *args, **kwargs):
+ warnings.warn("ReasonCodes is deprecated, use ReasonCode (singular) instead",
+ category=DeprecationWarning,
+ stacklevel=2,
+ )
+ super().__init__(*args, **kwargs)
diff --git a/sbapp/pmqtt/subscribe.py b/sbapp/pmqtt/subscribe.py
new file mode 100644
index 0000000..b6c80f4
--- /dev/null
+++ b/sbapp/pmqtt/subscribe.py
@@ -0,0 +1,281 @@
+# Copyright (c) 2016 Roger Light
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Eclipse Public License v2.0
+# and Eclipse Distribution License v1.0 which accompany this distribution.
+#
+# The Eclipse Public License is available at
+# http://www.eclipse.org/legal/epl-v20.html
+# and the Eclipse Distribution License is available at
+# http://www.eclipse.org/org/documents/edl-v10.php.
+#
+# Contributors:
+# Roger Light - initial API and implementation
+
+"""
+This module provides some helper functions to allow straightforward subscribing
+to topics and retrieving messages. The two functions are simple(), which
+returns one or messages matching a set of topics, and callback() which allows
+you to pass a callback for processing of messages.
+"""
+
+from .. import mqtt
+from . import client as paho
+
+
+def _on_connect(client, userdata, flags, reason_code, properties):
+ """Internal callback"""
+ if reason_code != 0:
+ raise mqtt.MQTTException(paho.connack_string(reason_code))
+
+ if isinstance(userdata['topics'], list):
+ for topic in userdata['topics']:
+ client.subscribe(topic, userdata['qos'])
+ else:
+ client.subscribe(userdata['topics'], userdata['qos'])
+
+
+def _on_message_callback(client, userdata, message):
+ """Internal callback"""
+ userdata['callback'](client, userdata['userdata'], message)
+
+
+def _on_message_simple(client, userdata, message):
+ """Internal callback"""
+
+ if userdata['msg_count'] == 0:
+ return
+
+ # Don't process stale retained messages if 'retained' was false
+ if message.retain and not userdata['retained']:
+ return
+
+ userdata['msg_count'] = userdata['msg_count'] - 1
+
+ if userdata['messages'] is None and userdata['msg_count'] == 0:
+ userdata['messages'] = message
+ client.disconnect()
+ return
+
+ userdata['messages'].append(message)
+ if userdata['msg_count'] == 0:
+ client.disconnect()
+
+
+def callback(callback, topics, qos=0, userdata=None, hostname="localhost",
+ port=1883, client_id="", keepalive=60, will=None, auth=None,
+ tls=None, protocol=paho.MQTTv311, transport="tcp",
+ clean_session=True, proxy_args=None):
+ """Subscribe to a list of topics and process them in a callback function.
+
+ This function creates an MQTT client, connects to a broker and subscribes
+ to a list of topics. Incoming messages are processed by the user provided
+ callback. This is a blocking function and will never return.
+
+ :param callback: function with the same signature as `on_message` for
+ processing the messages received.
+
+ :param topics: either a string containing a single topic to subscribe to, or a
+ list of topics to subscribe to.
+
+ :param int qos: the qos to use when subscribing. This is applied to all topics.
+
+ :param userdata: passed to the callback
+
+ :param str hostname: the address of the broker to connect to.
+ Defaults to localhost.
+
+ :param int port: the port to connect to the broker on. Defaults to 1883.
+
+ :param str client_id: the MQTT client id to use. If "" or None, the Paho library will
+ generate a client id automatically.
+
+ :param int keepalive: the keepalive timeout value for the client. Defaults to 60
+ seconds.
+
+ :param will: a dict containing will parameters for the client: will = {'topic':
+ "", 'payload':", 'qos':, 'retain':}.
+ Topic is required, all other parameters are optional and will
+ default to None, 0 and False respectively.
+
+ Defaults to None, which indicates no will should be used.
+
+ :param auth: a dict containing authentication parameters for the client:
+ auth = {'username':"", 'password':""}
+ Username is required, password is optional and will default to None
+ if not provided.
+ Defaults to None, which indicates no authentication is to be used.
+
+ :param tls: a dict containing TLS configuration parameters for the client:
+ dict = {'ca_certs':"", 'certfile':"",
+ 'keyfile':"", 'tls_version':"",
+ 'ciphers':", 'insecure':""}
+ ca_certs is required, all other parameters are optional and will
+ default to None if not provided, which results in the client using
+ the default behaviour - see the paho.mqtt.client documentation.
+ Alternatively, tls input can be an SSLContext object, which will be
+ processed using the tls_set_context method.
+ Defaults to None, which indicates that TLS should not be used.
+
+ :param str transport: set to "tcp" to use the default setting of transport which is
+ raw TCP. Set to "websockets" to use WebSockets as the transport.
+
+ :param clean_session: a boolean that determines the client type. If True,
+ the broker will remove all information about this client
+ when it disconnects. If False, the client is a persistent
+ client and subscription information and queued messages
+ will be retained when the client disconnects.
+ Defaults to True.
+
+ :param proxy_args: a dictionary that will be given to the client.
+ """
+
+ if qos < 0 or qos > 2:
+ raise ValueError('qos must be in the range 0-2')
+
+ callback_userdata = {
+ 'callback':callback,
+ 'topics':topics,
+ 'qos':qos,
+ 'userdata':userdata}
+
+ client = paho.Client(
+ paho.CallbackAPIVersion.VERSION2,
+ client_id=client_id,
+ userdata=callback_userdata,
+ protocol=protocol,
+ transport=transport,
+ clean_session=clean_session,
+ )
+ client.enable_logger()
+
+ client.on_message = _on_message_callback
+ client.on_connect = _on_connect
+
+ if proxy_args is not None:
+ client.proxy_set(**proxy_args)
+
+ if auth:
+ username = auth.get('username')
+ if username:
+ password = auth.get('password')
+ client.username_pw_set(username, password)
+ else:
+ raise KeyError("The 'username' key was not found, this is "
+ "required for auth")
+
+ if will is not None:
+ client.will_set(**will)
+
+ if tls is not None:
+ if isinstance(tls, dict):
+ insecure = tls.pop('insecure', False)
+ client.tls_set(**tls)
+ if insecure:
+ # Must be set *after* the `client.tls_set()` call since it sets
+ # up the SSL context that `client.tls_insecure_set` alters.
+ client.tls_insecure_set(insecure)
+ else:
+ # Assume input is SSLContext object
+ client.tls_set_context(tls)
+
+ client.connect(hostname, port, keepalive)
+ client.loop_forever()
+
+
+def simple(topics, qos=0, msg_count=1, retained=True, hostname="localhost",
+ port=1883, client_id="", keepalive=60, will=None, auth=None,
+ tls=None, protocol=paho.MQTTv311, transport="tcp",
+ clean_session=True, proxy_args=None):
+ """Subscribe to a list of topics and return msg_count messages.
+
+ This function creates an MQTT client, connects to a broker and subscribes
+ to a list of topics. Once "msg_count" messages have been received, it
+ disconnects cleanly from the broker and returns the messages.
+
+ :param topics: either a string containing a single topic to subscribe to, or a
+ list of topics to subscribe to.
+
+ :param int qos: the qos to use when subscribing. This is applied to all topics.
+
+ :param int msg_count: the number of messages to retrieve from the broker.
+ if msg_count == 1 then a single MQTTMessage will be returned.
+ if msg_count > 1 then a list of MQTTMessages will be returned.
+
+ :param bool retained: If set to True, retained messages will be processed the same as
+ non-retained messages. If set to False, retained messages will
+ be ignored. This means that with retained=False and msg_count=1,
+ the function will return the first message received that does
+ not have the retained flag set.
+
+ :param str hostname: the address of the broker to connect to.
+ Defaults to localhost.
+
+ :param int port: the port to connect to the broker on. Defaults to 1883.
+
+ :param str client_id: the MQTT client id to use. If "" or None, the Paho library will
+ generate a client id automatically.
+
+ :param int keepalive: the keepalive timeout value for the client. Defaults to 60
+ seconds.
+
+ :param will: a dict containing will parameters for the client: will = {'topic':
+ "", 'payload':", 'qos':, 'retain':}.
+ Topic is required, all other parameters are optional and will
+ default to None, 0 and False respectively.
+ Defaults to None, which indicates no will should be used.
+
+ :param auth: a dict containing authentication parameters for the client:
+ auth = {'username':"", 'password':""}
+ Username is required, password is optional and will default to None
+ if not provided.
+ Defaults to None, which indicates no authentication is to be used.
+
+ :param tls: a dict containing TLS configuration parameters for the client:
+ dict = {'ca_certs':"", 'certfile':"",
+ 'keyfile':"", 'tls_version':"",
+ 'ciphers':", 'insecure':""}
+ ca_certs is required, all other parameters are optional and will
+ default to None if not provided, which results in the client using
+ the default behaviour - see the paho.mqtt.client documentation.
+ Alternatively, tls input can be an SSLContext object, which will be
+ processed using the tls_set_context method.
+ Defaults to None, which indicates that TLS should not be used.
+
+ :param protocol: the MQTT protocol version to use. Defaults to MQTTv311.
+
+ :param transport: set to "tcp" to use the default setting of transport which is
+ raw TCP. Set to "websockets" to use WebSockets as the transport.
+
+ :param clean_session: a boolean that determines the client type. If True,
+ the broker will remove all information about this client
+ when it disconnects. If False, the client is a persistent
+ client and subscription information and queued messages
+ will be retained when the client disconnects.
+ Defaults to True. If protocol is MQTTv50, clean_session
+ is ignored.
+
+ :param proxy_args: a dictionary that will be given to the client.
+ """
+
+ if msg_count < 1:
+ raise ValueError('msg_count must be > 0')
+
+ # Set ourselves up to return a single message if msg_count == 1, or a list
+ # if > 1.
+ if msg_count == 1:
+ messages = None
+ else:
+ messages = []
+
+ # Ignore clean_session if protocol is MQTTv50, otherwise Client will raise
+ if protocol == paho.MQTTv5:
+ clean_session = None
+
+ userdata = {'retained':retained, 'msg_count':msg_count, 'messages':messages}
+
+ callback(_on_message_simple, topics, qos, userdata, hostname, port,
+ client_id, keepalive, will, auth, tls, protocol, transport,
+ clean_session, proxy_args)
+
+ return userdata['messages']
diff --git a/sbapp/pmqtt/subscribeoptions.py b/sbapp/pmqtt/subscribeoptions.py
new file mode 100644
index 0000000..7e0605d
--- /dev/null
+++ b/sbapp/pmqtt/subscribeoptions.py
@@ -0,0 +1,113 @@
+"""
+*******************************************************************
+ Copyright (c) 2017, 2019 IBM Corp.
+
+ All rights reserved. This program and the accompanying materials
+ are made available under the terms of the Eclipse Public License v2.0
+ and Eclipse Distribution License v1.0 which accompany this distribution.
+
+ The Eclipse Public License is available at
+ http://www.eclipse.org/legal/epl-v20.html
+ and the Eclipse Distribution License is available at
+ http://www.eclipse.org/org/documents/edl-v10.php.
+
+ Contributors:
+ Ian Craggs - initial implementation and/or documentation
+*******************************************************************
+"""
+
+
+
+class MQTTException(Exception):
+ pass
+
+
+class SubscribeOptions:
+ """The MQTT v5.0 subscribe options class.
+
+ The options are:
+ qos: As in MQTT v3.1.1.
+ noLocal: True or False. If set to True, the subscriber will not receive its own publications.
+ retainAsPublished: True or False. If set to True, the retain flag on received publications will be as set
+ by the publisher.
+ retainHandling: RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB or RETAIN_DO_NOT_SEND
+ Controls when the broker should send retained messages:
+ - RETAIN_SEND_ON_SUBSCRIBE: on any successful subscribe request
+ - RETAIN_SEND_IF_NEW_SUB: only if the subscribe request is new
+ - RETAIN_DO_NOT_SEND: never send retained messages
+ """
+
+ # retain handling options
+ RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB, RETAIN_DO_NOT_SEND = range(
+ 0, 3)
+
+ def __init__(
+ self,
+ qos: int = 0,
+ noLocal: bool = False,
+ retainAsPublished: bool = False,
+ retainHandling: int = RETAIN_SEND_ON_SUBSCRIBE,
+ ):
+ """
+ qos: 0, 1 or 2. 0 is the default.
+ noLocal: True or False. False is the default and corresponds to MQTT v3.1.1 behavior.
+ retainAsPublished: True or False. False is the default and corresponds to MQTT v3.1.1 behavior.
+ retainHandling: RETAIN_SEND_ON_SUBSCRIBE, RETAIN_SEND_IF_NEW_SUB or RETAIN_DO_NOT_SEND
+ RETAIN_SEND_ON_SUBSCRIBE is the default and corresponds to MQTT v3.1.1 behavior.
+ """
+ object.__setattr__(self, "names",
+ ["QoS", "noLocal", "retainAsPublished", "retainHandling"])
+ self.QoS = qos # bits 0,1
+ self.noLocal = noLocal # bit 2
+ self.retainAsPublished = retainAsPublished # bit 3
+ self.retainHandling = retainHandling # bits 4 and 5: 0, 1 or 2
+ if self.retainHandling not in (0, 1, 2):
+ raise AssertionError(f"Retain handling should be 0, 1 or 2, not {self.retainHandling}")
+ if self.QoS not in (0, 1, 2):
+ raise AssertionError(f"QoS should be 0, 1 or 2, not {self.QoS}")
+
+ def __setattr__(self, name, value):
+ if name not in self.names:
+ raise MQTTException(
+ f"{name} Attribute name must be one of {self.names}")
+ object.__setattr__(self, name, value)
+
+ def pack(self):
+ if self.retainHandling not in (0, 1, 2):
+ raise AssertionError(f"Retain handling should be 0, 1 or 2, not {self.retainHandling}")
+ if self.QoS not in (0, 1, 2):
+ raise AssertionError(f"QoS should be 0, 1 or 2, not {self.QoS}")
+ noLocal = 1 if self.noLocal else 0
+ retainAsPublished = 1 if self.retainAsPublished else 0
+ data = [(self.retainHandling << 4) | (retainAsPublished << 3) |
+ (noLocal << 2) | self.QoS]
+ return bytes(data)
+
+ def unpack(self, buffer):
+ b0 = buffer[0]
+ self.retainHandling = ((b0 >> 4) & 0x03)
+ self.retainAsPublished = True if ((b0 >> 3) & 0x01) == 1 else False
+ self.noLocal = True if ((b0 >> 2) & 0x01) == 1 else False
+ self.QoS = (b0 & 0x03)
+ if self.retainHandling not in (0, 1, 2):
+ raise AssertionError(f"Retain handling should be 0, 1 or 2, not {self.retainHandling}")
+ if self.QoS not in (0, 1, 2):
+ raise AssertionError(f"QoS should be 0, 1 or 2, not {self.QoS}")
+ return 1
+
+ def __repr__(self):
+ return str(self)
+
+ def __str__(self):
+ return "{QoS="+str(self.QoS)+", noLocal="+str(self.noLocal) +\
+ ", retainAsPublished="+str(self.retainAsPublished) +\
+ ", retainHandling="+str(self.retainHandling)+"}"
+
+ def json(self):
+ data = {
+ "QoS": self.QoS,
+ "noLocal": self.noLocal,
+ "retainAsPublished": self.retainAsPublished,
+ "retainHandling": self.retainHandling,
+ }
+ return data
diff --git a/sbapp/services/sidebandservice.py b/sbapp/services/sidebandservice.py
index e718a6f..814c2b6 100644
--- a/sbapp/services/sidebandservice.py
+++ b/sbapp/services/sidebandservice.py
@@ -481,6 +481,9 @@ class SidebandService():
self.sideband.cleanup()
self.release_locks()
+ # TODO: Check if this works in all cases
+ self.android_service.stopSelf()
+
def handle_exception(exc_type, exc_value, exc_traceback):
if issubclass(exc_type, KeyboardInterrupt):
sys.__excepthook__(exc_type, exc_value, exc_traceback)
diff --git a/sbapp/share/flasher.html b/sbapp/share/flasher.html
new file mode 100644
index 0000000..9033cc9
--- /dev/null
+++ b/sbapp/share/flasher.html
@@ -0,0 +1,33 @@
+
+
+
+Sideband Repository
+RNode Flasher
+
Liam Cottle . You can use this flasher to install and provision the RNode firmware on any compatible boards.Please note! Your browser must support Web-USB for this to work.
+ Sideband can automatically download the latest release of these, and include them directly in this repository.
+
+ To do so, go to the Repository menu item, and select Update Contents .
+ After that, they will be available on the Software page of this repository.
+
+
+ You can download them manually from the latest release page on GitHub .
+ You can compile them yourself from the RNode Firmware source code package included in this repository .
+
+Launch Web Flasher
+
diff --git a/sbapp/share/guides.html b/sbapp/share/guides.html
index 143b70c..d4cf17a 100644
--- a/sbapp/share/guides.html
+++ b/sbapp/share/guides.html
@@ -9,7 +9,7 @@
Guides
-
Guide Section !
=========
-Sideband is an extensible LXMF messaging client, situational awareness tracker and remote control and monitoring system for Android, Linux, macOS and Windows. It 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.
+Sideband is an extensible LXMF messaging and LXST telephony client, situational awareness tracker and remote control and monitoring system for Android, Linux, macOS and Windows. It 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.
@@ -13,10 +13,11 @@ This also means that Sideband operates differently than what you might be used t
Sideband provides many useful and interesting functions, such as:
-- **Secure** and **self-sovereign** messaging using the LXMF protocol over Reticulum.
+- **Secure** and **self-sovereign** messaging and voice calls using the LXMF and LXST protocols over Reticulum.
- **Image** and **file transfers** over all supported mediums.
- **Audio messages** that work even over **LoRa** and **radio links**, thanks to [Codec2](https://github.com/drowe67/codec2/) and [Opus](https://github.com/xiph/opus) encoding.
- Secure and direct P2P **telemetry and location sharing**. No third parties or servers ever have your data.
+- The telemetry system is **completely extensible** via [simple plugins](#creating-plugins).
- Situation display on both online and **locally stored offline maps**.
- Geospatial awareness calculations.
- Exchanging messages through **encrypted QR-codes on paper**, or through messages embedded directly in **lxm://** links.
@@ -39,7 +40,7 @@ Sideband can run on most computing devices, but installation methods vary by dev
## On Android
-For your Android devices, you can install Sideband through F-Droid, by adding the [Between the Borders Repo](https://reticulum.betweentheborders.com/fdroid/repo/), or you can download an [APK on the latest release](https://github.com/markqvist/Sideband/releases/latest) page. Both sources are signed with the same release keys, and can be used interchangably.
+For your Android devices, you can download an [APK on the latest release page](https://github.com/markqvist/Sideband/releases/latest).
After the application is installed on your Android device, it is also possible to pull updates directly through the **Repository** section of the application.
@@ -47,7 +48,8 @@ After the application is installed on your Android device, it is also possible t
On all Linux-based operating systems, Sideband is available as a `pipx`/`pip` package. This installation method **includes desktop integration**, so that Sideband will show up in your applications menu and launchers. Below are install steps for the most common recent Linux distros. For Debian 11, see the end of this section.
-You will first need to install a few dependencies for audio messaging and Codec2 support to work:
+#### Basic Installation
+You will first need to install a few dependencies for voice calls, audio messaging and Codec2 support to work:
```bash
# For Debian (12+), Ubuntu (22.04+) and derivatives
@@ -78,7 +80,10 @@ After installation, you can now run Sideband in a number of different ways:
pipx ensurepath
# The first time you run Sideband, you will need to do it
-# from the terminal:
+# from the terminal, for the application launcher item to
+# show up. On some distros you may also need to log out
+# and back in again, or simply reboot the machine for the
+# application entry to show up in your menu.
sideband
# At the first launch, it will add an application icon
@@ -95,6 +100,9 @@ sideband --daemon
sideband -v
```
+If you do not already have Reticulum connectivity set up on your computer or local network, you will probably want to edit the Reticulum configuration file at `~/.reticulum/config` and [add any interfaces](https://reticulum.network/manual/interfaces.html) you need for connectivity.
+
+#### Advanced Installation
You can also install Sideband in various alternative ways:
```bash
@@ -109,8 +117,9 @@ pip install sbapp --break-system-packages
# any of the normal UI dependencies:
pip install sbapp --no-dependencies
-# In the above case, you will still need to
-# manually install the RNS and LXMF dependencies:
+# In the case of using --no-dependencies, you
+# will still need to manually install the RNS
+# and LXMF dependencies:
pip install rns lxmf
# Install Sideband on Debian 11 and derivatives:
@@ -128,17 +137,17 @@ You can install Sideband on all Raspberry Pi models that support 64-bit operatin
Aditionally, the `pycodec2` package needs to be installed manually. I have provided a pre-built version, that you can download and install with a single command, or if you don't want to trust my pre-built version, you can [build and install it from source yourself](https://github.com/gregorias/pycodec2/blob/main/DEV.md).
-The install instructions below assume that you are installing Sideband on 64-bit Raspberry Pi OS (based on Debian Bookworm). If you're running something else on your Pi, you might need to modify some commands slightly. To install Sideband on Raspberry Pi, follow these steps:
+The install instructions below assume that you are installing Sideband on 64-bit Raspberry Pi OS (based on Debian Bookworm or later). If you're running something else on your Pi, you might need to modify some commands slightly. To install Sideband on Raspberry Pi with full support for voice calls, audio messages and Codec2, follow these steps:
```bash
# First of all, install the required dependencies:
sudo apt install python3-pip python3-pyaudio python3-dev python3-cryptography build-essential libopusfile0 libsdl2-dev libavcodec-dev libavdevice-dev libavfilter-dev portaudio19-dev codec2 libcodec2-1.0 xclip xsel
# If you don't want to compile pycodec2 yourself,
-# download the pre-compiled package provided here
+# download the pre-compiled package provided here:
wget https://raw.githubusercontent.com/markqvist/Sideband/main/docs/utilities/pycodec2-3.0.1-cp311-cp311-linux_aarch64.whl
-# Install it:
+# And install it:
pip install ./pycodec2-3.0.1-cp311-cp311-linux_aarch64.whl --break-system-packages
# You can now install Sideband
@@ -152,46 +161,106 @@ sudo reboot
sideband
```
+If you do not already have Reticulum connectivity set up on your computer or local network, you will probably want to edit the Reticulum configuration file at `~/.reticulum/config` and [add any interfaces](https://reticulum.network/manual/interfaces.html) you need for connectivity.
+
## On macOS
-On macOS, you can install Sideband with `pip3` or `pipx`. Due to the many different potential Python versions and install paths across macOS versions, the easiest install method is to use `pipx`.
+To install Sideband on macOS, you have two options available:
-If you don't already have the `pipx` package manager installed, it can be installed via [Homebrew](https://brew.sh/) with `brew install pipx`.
+1. An easy to install pre-built disk image package
+2. A source package install for more advanced setups
+
+#### Prebuilt Executable
+
+You can download a disk image with Sideband for macOS (ARM and Intel) from the [latest release page](https://github.com/markqvist/Sideband/releases/latest). Simply mount the downloaded disk image, drag `Sideband` to your applications folder, and run it.
+
+**Please note!** If you have application install restrictions enabled on your macOS install, or have restricted your system to only allow installation of application from the Apple App Store, you will need to create an exception for Sideband. The Sideband application will *never* be distributed with an Apple-controlled digital signature, as this will allow Apple to simply disable Sideband from running on your system if they decide to do so, or are forced to by authorities or other circumstances.
+
+If you install Sideband from the DMG file, it is still recommended to install the `rns` package via the `pip` or `pipx` package manager, so you can use the RNS utility programs, like `rnstatus` to see interface and connectivity status from the terminal. If you already have Python and `pip` installed on your system, simply open a terminal window and use one of the following commands:
```bash
-# Install Sideband and dependencies on macOS using pipx:
-pipx install sbapp
-pipx ensurepath
+# Install Reticulum and utilities with pip:
+pip3 install rns
-# Run it
-sideband
+# On some versions, you may need to use the
+# flag --break-system-packages to install:
+pip3 install rns --break-system-packages
```
-Or, if you prefer to use `pip` directly, follow the instructions below. In this case, if you have not already installed Python and `pip3` on your macOS system, [download and install](https://www.python.org/downloads/) the latest version first.
+If you do not have Python and `pip` available, [download and install it](https://www.python.org/downloads/) first.
+
+If you do not already have Reticulum connectivity set up on your computer or local network, you will probably want to edit the Reticulum configuration file at `~/.reticulum/config` and [add any interfaces](https://reticulum.network/manual/interfaces.html) you need for connectivity.
+
+#### Source Package Install
+
+For more advanced setups, including the ability to run Sideband in headless daemon mode, enable debug logging output, configuration import and export and more, you may want to install it from the source package via `pip` instead.
+
+**Please note!** The very latest Python release, Python 3.13 is currently **not** compatible with the Kivy framework, that Sideband uses to render its user interface. If your version of macOS uses Python 3.13 as its default Python installation, you will need to install an earlier version as well. Using [the latest release of Python 3.12](https://www.python.org/downloads/release/python-3127/) is recommended.
+
+To install Sideband via `pip`, follow these instructions:
```bash
# Install Sideband and dependencies on macOS using pip:
-pip3 install sbapp --user --break-system-packages
+pip3 install sbapp
-# Run it:
+# Run Sideband from the terminal:
+#################################
+sideband
+# or
python3 -m sbapp.main
-# If you add your pip install location to
-# the PATH environment variable, you can
-# also run Sideband simply using:
-sideband
+# Enable debug logging:
+#################################
+sideband -v
+# or
+python3 -m sbapp.main -v
+
+# Start Sideband in daemon mode:
+#################################
+sideband -d
+# or
+python3 -m sbapp.main -d
+
+# If Python and pip was installed correctly,
+# you can simply use the "sideband" command
+# directly. Otherwise, you will manually
+# need to add the pip binaries directory to
+# your PATH environment variable, or start
+# Sideband via the "python3 -m sbapp.main"
+# syntax.
```
## On Windows
-Even though there is currently not an automated installer, or packaged `.exe` file for Sideband on Windows, you can still install it through `pip`. If you don't already have Python installed, [download and install](https://www.python.org/downloads/) the latest version of Python.
+To install Sideband on Windows, you have two options available:
-Please note that audio messaging functionality isn't supported on Windows yet. Please support the development if you'd like to see this feature added faster.
+1. An easy to install pre-built executable package
+2. A source package install for more advanced setups
-**Important!** When asked by the installer, make sure to add the Python program to your PATH environment variables. If you don't do this, you will not be able to use the `pip` installer, or run the `sideband` command.
+#### Prebuilt Executable
-When Python has been installed, you can open a command prompt and install sideband via `pip`:
+Simply download the packaged Windows ZIP file from the [latest release page](https://github.com/markqvist/Sideband/releases/latest), unzip the file, and run `Sideband.exe` from the unzipped directory. You can create desktop or start menu shortcuts from this executable if needed.
+
+When running Sideband for the first time, a default Reticulum configuration file will be created, if you don't already have one. If you don't have any existing Reticulum connectivity available locally, you may want to edit the file, located at `C:\Users\USERNAME\.reticulum\config` and manually add an interface that provides connectivity to a wider network. If you just want to connect over the Internet, you can add one of the public hubs on the [Reticulum Testnet](https://reticulum.network/connect.html).
+
+#### Installing Reticulum Utilities
+
+Though the ZIP file contains everything necessary to run Sideband, it is also recommended to install the Reticulum command line utilities separately, so that you can use commands like `rnstatus` and `rnsd` from the command line. This will make it easier to manage Reticulum connectivity on your system. If you do not already have Python installed on your system, [download and install it](https://www.python.org/downloads/) first.
+
+**Important!** When asked by the installer, make sure to add the Python program to your `PATH` environment variables. If you don't do this, you will not be able to use the `pip` installer, or run any of the installed commands. When Python has been installed, you can open a command prompt and install the Reticulum package via `pip`:
+
+```bash
+pip install rns
+```
+
+#### Source Package Install
+
+For more advanced setups, including the ability to run Sideband in headless daemon mode, enable debug logging output, configuration import and export and more, you may want to install it from the source package via `pip` instead.
+
+In this case, you will need to [download and install the latest supported version of Python](https://www.python.org/downloads/release/python-3127/) (currently Python 3.12.7), since very latest Python release, Python 3.13 is currently **not** compatible with the Kivy framework, that Sideband uses to render its user interface. The binary package already includes a compatible Python version, so if you are running Sideband from that, there is no need to install a specific version of Python.
+
+When Python has been installed, you can open a command prompt and install Sideband via `pip`:
```bash
pip install sbapp
@@ -199,7 +268,29 @@ pip install sbapp
The Sideband application can now be launched by running the command `sideband` in the command prompt. If needed, you can create a shortcut for Sideband on your desktop or in the start menu.
-When running Sideband for the first time, a default Reticulum configuration file will be created, if you don't already have one. If you don't have any existing Reticulum connectivity available locally, you may want to edit the file, located at `C:\Users\USERNAME\.reticulum\config` and manually add an interface that provides connectivity to a wider network. If you just want to connect over the Internet, you can add one of the public hubs on the [Reticulum Testnet](https://reticulum.network/connect.html).
+Since this installation method automatically installs the `rns` and `lxmf` packages as well, you will also have access to using all the included RNS and LXMF utilities like `rnstatus`, `rnsd` and `lxmd` on your system.
+
+# Creating Plugins
+
+Sideband features a flexible and extensible plugin system, that allows you to hook all kinds of control, status reporting, command execution and telemetry collection into the LXMF messaging system. Plugins can be created as either *Telemetry*, *Command* or *Service* plugins, for different use-cases.
+
+To create plugins for Sideband, you can find a variety of [code examples](https://github.com/markqvist/Sideband/tree/main/docs/example_plugins) in this repository, that you can use as a basis for writing your own plugins. The example plugins include:
+
+- [Custom telemetry](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/telemetry.py)
+- [Getting BME280 temperature, humidity and pressure](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/bme280_telemetry.py)
+- [Basic commands](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/basic.py)
+- [Location telemetry from GPSd on Linux](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/gpsd_location.py)
+- [Location telemetry from Windows Location Provider](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/windows_location.py)
+- [Getting statistics from your LXMF propagation node](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/lxmd_telemetry.py)
+- [Viewing cameras and streams](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/view.py)
+- [Fetching an XKCD comic](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/comic.py)
+- [Creating a service plugin](https://github.com/markqvist/Sideband/blob/main/docs/example_plugins/service.py)
+
+For creating telemetry plugins, Sideband includes 20+ built-in sensor types to chose from, for representing all kinds telemetry data. If none of those fit your needs, there is a `Custom` sensor type, that can include any kind of data.
+
+Command plugins allow you to define any kind of action or command to be run when receiving command messages from other LXMF clients. In the example directory, you will find various command plugin templates, for example for viewing security cameras or webcams through Sideband.
+
+Service plugins allow you to integrate any kind of service, bridge or other system into Sideband, and have that react to events or state changes in Sideband itself.
# Paper Messaging Example
@@ -224,38 +315,21 @@ You can help support the continued development of open, free and private communi
```
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
```
-- Ethereum
- ```
- 0xFDabC71AC4c0C78C95aDDDe3B4FA19d6273c5E73
- ```
- Bitcoin
```
- 35G9uWVzrpJJibzUwpNUQGQNFzLirhrYAH
+ bc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
```
+- Ethereum
+ ```
+ 0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+ ```
+- Liberapay: https://liberapay.com/Reticulum/
+
- Ko-Fi: https://ko-fi.com/markqvist
+