Updates

.github/workflows/main.yaml

@@ -4,21 +4,16 @@ on:
       - "*"
 
 jobs:
-  build:
+  docker-buildx:
-    name: Build, push
     runs-on: ubuntu-latest
     steps:
       - name: Checkout main
         uses: actions/checkout@main
 
-      - name: Build container
+      - name: Build and publish image
-        run: docker build --tag gwhittington/meshtastic-bridge:latest .
+        uses: zmingxie/docker_buildx@master
-
+        with:
-      - name: Log in to Container Registry with short-lived credentials
+          publish: true
-        run: docker login --username=gwhittington --password "${{secrets.DOCKER_HUB}}"
+          imageName: gwhittington/meshtastic-bridge
-
+          dockerHubUser: gwhittington
-      - name: Push image to Container Registry
+          dockerHubPassword: ${{secrets.DOCKER_HUB}}
-        run: docker push gwhittington/meshtastic-bridge:latest
-
-      - name: Logout from Container Registry
-        run: docker logout

Dockerfile

@@ -7,7 +7,11 @@ WORKDIR /code
 # copy the dependencies file to the working directory
 COPY requirements.txt .
 
+RUN apt-get update && apt-get install -y cargo
+
 # install dependencies
+RUN pip install -U pip
+RUN pip install setuptools_rust wheel
 RUN pip install -r requirements.txt
 
 # copy the content of the local src directory to the working directory

README.md

@@ -66,7 +66,7 @@ mqtt_servers:
        mqtt-to-radio:
          - decrypt_filter:
             key: '/home/user/keys/key.pem'
-         - send_plugin:
+         - radio_message_plugin:
             device: remote
 pipelines:
  radio-to-mqtt:
@@ -101,16 +101,16 @@ NOTE: If `tcp` or `serial` are not given the bridge will attempt to detect a rad
 
 The following plugins can be used in the `pipelines` section of `config.yaml`:
 
-| Plugin            | Description                                                          |
+| Plugin                 | Description                                                          |
-| ----------------- | -------------------------------------------------------------------- |
+| ---------------------- | -------------------------------------------------------------------- |
-| `debugger`        | Log the packet to the system console                                 |
+| `debugger`             | Log the packet to the system console                                 |
-| `message_filter`  | Filters out packets from the bridge that match a specific criteria   |
+| `message_filter`       | Filters out packets from the bridge that match a specific criteria   |
-| `location_filter` | Filters out packets that originate too far from a specified `device` |
+| `location_filter`      | Filters out packets that originate too far from a specified `device` |
-| `webhook`         | Send HTTP requests with custom payloads using packet information     |
+| `webhook`              | Send HTTP requests with custom payloads using packet information     |
-| `mqtt_plugin`     | Send packets to a MQTT server                                        |
+| `mqtt_plugin`          | Send packets to a MQTT server                                        |
-| `encrypt_filter`  | Encrypt a packet for a desired MQTT recipient                        |
+| `encrypt_filter`       | Encrypt a packet for a desired MQTT recipient                        |
-| `decrypt_filter`  | Decrypt a packet originating from MQTT                               |
+| `decrypt_filter`       | Decrypt a packet originating from MQTT                               |
-| `send_plugin`     | Send a packet to a specified `device`                                |
+| `radio_message_plugin` | Send a packet to a specified `device`                                |
 
 ### debugger - Output the contents of a packet
 
@@ -153,8 +153,8 @@ message_filter:
 - **log_level** `debug` or `info`. Default `info`
 - **max_distance_km** Filter packets more than a certain distance
 - **comparison** `within` or `outside`. Default `within`
-- **compare_latitude** Set the latitude to compare against
+- **compare_latitude** latitude to compare against
-- **compare_longitude** Set the longitude to compare against
+- **compare_longitude** longitude to compare against
 - **latitude** Set the latitude
 - **longitude** Set the longitude
 
@@ -199,7 +199,7 @@ webhook:
 - **log_level** `debug` or `info`. Default `info`
 - **active** Plugin is active. Values: `true` or `false`. Default = `true`.
 - **name** Reference of an existing MQTT server configured in the top-level `mqtt_servers` configuration
-- **message** Override the packet message with a custom value
+- **message** Override the packet message with a custom value.
 - **topic** The message topic
 
 For example:
@@ -210,6 +210,10 @@ mqtt_plugin:
   topic: meshtastic/topic
 ```
 
+Placeholders can be used with the **message** value:
+
+- `{MSG}` - Packet text
+
 ### encrypt_filter - Encrypt a packet before sending it to a MQTT server
 
 - **log_level** `debug` or `info`. Default `info`
@@ -277,10 +281,13 @@ python main.py
 
 Create a `config.yaml` with the desired settings and run the following Docker command:
 
+#### Linux
+
 ```
-docker run -v $(pwd)/config.yaml:/code/config.yaml gwhittington/meshtastic-bridge:latest
+docker run --rm --network host -v $(pwd)/config.yaml:/code/config.yaml gwhittington/meshtastic-bridge:latest
 ```
 
 ## Resources
 
 - Example guidance for creating [PEM](https://www.suse.com/support/kb/doc/?id=000018152) key files.
+- Test webhooks using [Webhooks.site](https://webhook.site/)

main.py

@@ -120,6 +120,8 @@ if "mqtt_servers" in bridge_config:
         username = config["username"] if "username" in config else None
         password = config["password"] if "password" in config else None
 
+        logger.info(f"Connected to MQTT {config['name']}")
+
         if client_id:
             mqttc = mqtt.Client(client_id)
         else:
@@ -128,25 +130,26 @@ if "mqtt_servers" in bridge_config:
         if username and password:
             mqttc.username_pw_set(username, password)
 
-        mqtt_servers[config["name"]] = mqttc
-
         def on_connect(mqttc, obj, flags, rc):
             logger.debug(f"Connected to MQTT {config['name']}")
 
         def on_message(mqttc, obj, msg):
             orig_packet = msg.payload.decode()
 
-            logger.debug(f"MQTT {config['name']}: on_message")
+            logger.debug(f"MQTT {config['name']}: {orig_packet}")
 
             if "pipelines" not in config:
                 logger.warning(f"MQTT {config['name']}: no pipeline")
                 return
 
+            p = plugins["packet_filter"]
+            pipeline_packet = p.do_action(orig_packet)
+
             for pipeline, pipeline_plugins in config["pipelines"].items():
 
-                packet = orig_packet
+                packet = pipeline_packet
 
-                logger.debug(f"MQTT {config['name']} pipeline {pipeline} started")
+                logger.debug(f"MQTT {config['name']} pipeline {pipeline} initiated")
                 if not packet:
                     continue
 
@@ -179,18 +182,26 @@ if "mqtt_servers" in bridge_config:
         mqttc.on_publish = on_publish
         mqttc.on_subscribe = on_subscribe
 
+        mqtt_servers[config["name"]] = mqttc
+
         import ssl
 
         if "insecure" in config and config["insecure"]:
             mqttc.tls_set(cert_reqs=ssl.CERT_NONE)
             mqttc.tls_insecure_set(True)
 
-        mqttc.connect(config["server"], config["port"], 60)
+        try:
+            logger.debug(f"Connecting to MQTT {config['server']}")
 
-        if "topic" in config:
+            mqttc.connect(config["server"], config["port"], 60)
-            mqttc.subscribe(config["topic"], 0)
 
-        mqttc.loop_start()
+            if "topic" in config:
+                mqttc.subscribe(config["topic"], 0)
+
+            mqttc.loop_start()
+        except Exception as e:
+            logger.error(f"MQTT {config['name']} could not start: {e}")
+            pass
 
 while True:
     time.sleep(1000)

plugins.py

@@ -11,7 +11,10 @@ import re
 plugins = {}
 
 
-class Plugin:
+class Plugin(object):
+    def __init__(self) -> None:
+        self.logger.setLevel(logging.INFO)
+
     def configure(self, devices, mqtt_servers, config):
         self.config = config
         self.devices = devices
@@ -30,25 +33,42 @@ class Plugin:
 class PacketFilter(Plugin):
     logger = logging.getLogger(name="meshtastic.bridge.filter.packet")
 
-    def strip_raw(self, dict_obj):
+    def strip_raw(self, data):
+        if type(data) is not dict:
+            return data
+
+        if "raw" in data:
+            del data["raw"]
+
+        for k, v in data.items():
+            data[k] = self.strip_raw(v)
+
+        return data
+
+    def normalize(self, dict_obj):
+        """
+        Packets are either a dict, string dict or string
+        """
         if type(dict_obj) is not dict:
-            return dict_obj
+            try:
+                dict_obj = json.loads(dict_obj)
+            except:
+                dict_obj = {"decoded": {"text": dict_obj}}
 
-        if "raw" in dict_obj:
+        return self.strip_raw(dict_obj)
-            del dict_obj["raw"]
-
-        for k, v in dict_obj.items():
-            dict_obj[k] = self.strip_raw(v)
-
-        return dict_obj
 
     def do_action(self, packet):
-        packet = self.strip_raw(packet)
+        self.logger.debug(f"Before normalization: {packet}")
+        packet = self.normalize(packet)
 
         if "decoded" in packet and "payload" in packet["decoded"]:
-            packet["decoded"]["payload"] = base64.b64encode(
+            if type(packet["decoded"]["payload"]) is bytes:
-                packet["decoded"]["payload"]
+                text = packet["decoded"]["payload"]
-            ).decode("utf-8")
+                packet["decoded"]["payload"] = base64.b64encode(
+                    packet["decoded"]["payload"]
+                ).decode("utf-8")
+
+        self.logger.debug(f"After normalization: {packet}")
 
         return packet
 
@@ -90,15 +110,17 @@ class MessageFilter(Plugin):
                     )
                     return None
 
-        if text and "disallow" in self.config["message"]:
+            if "disallow" in self.config["message"]:
-            matches = False
+                matches = False
-            for disallow_regex in self.config["message"]["disallow"]:
+                for disallow_regex in self.config["message"]["disallow"]:
-                if not matches and re.search(disallow_regex, text):
+                    if not matches and re.search(disallow_regex, text):
-                    matches = True
+                        matches = True
 
-            if matches:
+                if matches:
-                self.logger.debug(f"Dropped because it matches message disallow filter")
+                    self.logger.debug(
-                return None
+                        f"Dropped because it matches message disallow filter"
+                    )
+                    return None
 
         filters = {
             "app": packet["decoded"]["portnum"],
@@ -116,7 +138,7 @@ class MessageFilter(Plugin):
                     and value not in filter_val["allow"]
                 ):
                     self.logger.debug(
-                        f"Dropped because it doesn't match {filter_key} allow filter"
+                        f"Dropped because {value} doesn't match {filter_key} allow filter"
                     )
                     return None
 
@@ -126,7 +148,7 @@ class MessageFilter(Plugin):
                     and value in filter_val["disallow"]
                 ):
                     self.logger.debug(
-                        f"Dropped because it matches {filter_key} disallow filter"
+                        f"Dropped because {value} matches {filter_key} disallow filter"
                     )
                     return None
 
@@ -205,13 +227,6 @@ class WebhookPlugin(Plugin):
     logger = logging.getLogger(name="meshtastic.bridge.plugin.webhook")
 
     def do_action(self, packet):
-        if type(packet) is not dict:
-            try:
-                packet = json.loads(packet)
-            except:
-                self.logger.warning("Packet is not dict")
-                return packet
-
         if "active" in self.config and not self.config["active"]:
             return packet
 
@@ -227,8 +242,8 @@ class WebhookPlugin(Plugin):
         text = packet["decoded"]["text"] if "text" in packet["decoded"] else None
 
         macros = {
-            "{LAT}": position["latitude"] if position else None,
+            "{LAT}": position["latitude"] if position else "",
-            "{LNG}": position["longitude"] if position else None,
+            "{LNG}": position["longitude"] if position else "",
             "{MSG}": self.config["message"] if "message" in self.config else text,
             "{FID}": packet["fromId"],
             "{TID}": packet["toId"],
@@ -281,15 +296,24 @@ class MQTTPlugin(Plugin):
 
         mqtt_server = self.mqtt_servers[self.config["name"]]
 
-        packet_payload = packet if type(packet) is str else json.dumps(packet)
+        if not mqtt_server.is_connected():
+            self.logger.error("Not sent, not connected")
+            return
 
-        message = self.config["message"] if "message" in self.config else packet_payload
+        packet_message = json.dumps(packet)
+
+        if "message" in self.config:
+            message = self.config["message"].replace("{MSG}", packet["decoded"]["text"])
+        else:
+            message = packet_message
 
         info = mqtt_server.publish(self.config["topic"], message)
         info.wait_for_publish()
 
         self.logger.debug("Message sent")
 
+        return packet
+
 
 plugins["mqtt_plugin"] = MQTTPlugin()
 
@@ -361,48 +385,36 @@ class RadioMessagePlugin(Plugin):
     logger = logging.getLogger(name="meshtastic.bridge.plugin.send")
 
     def do_action(self, packet):
-
-        if type(packet) is not dict:
-            try:
-                packet = json.loads(packet)
-            except:
-                self.logger.error("Packet is not a dict")
-                return packet
-
         if self.config["device"] not in self.devices:
             self.logger.error(f"Missing interface for device {self.config['device']}")
             return packet
 
-        if "to" not in packet and "toId" not in packet:
+        destinationId = None
-            self.logger.debug("Not a message")
-            return packet
-
-        # Broadcast messages or specific
-        if (
-            "node_mapping" in self.config
-            and packet["to"] in self.config["node_mapping"]
-        ):
-            destinationId = self.config["node_mapping"][packet["to"]]
-        else:
-            destinationId = packet["to"] if "to" in packet else packet["toId"]
 
         if "to" in self.config:
             destinationId = self.config["to"]
         elif "toId" in self.config:
             destinationId = self.config["toId"]
+        elif "node_mapping" in self.config and "to" in packet:
+            destinationId = self.config["node_mapping"][packet["to"]]
+        elif "to" in packet:
+            destinationId = packet["to"]
+        elif "toId" in packet:
+            destinationId = packet["toId"]
+
+        if not destinationId:
+            self.logger.error("Missing 'to' property in config or packet")
+            return packet
 
         device_name = self.config["device"]
 
-        if device_name not in self.devices:
-            self.logger.warning(f"No such radio device: {device_name}")
-            return packet
-
         device = self.devices[device_name]
 
-        self.logger.debug(f"Sending packet to Radio {device_name}")
+        # Not a radio packet
+        if "decoded" in packet and "text" in packet["decoded"] and "from" not in packet:
+            self.logger.debug(f"Sending text to Radio {device_name}")
+            device.sendText(text=packet["decoded"]["text"], destinationId=destinationId)
 
-        if "message" in self.config and self.config["message"]:
-            device.sendText(text=self.config["message"], destinationId=destinationId)
         elif (
             "lat" in self.config
             and self.config["lat"] > 0
@@ -413,13 +425,19 @@ class RadioMessagePlugin(Plugin):
             lng = self.config["lng"]
             altitude = self.config["alt"] if "alt" in self.config else 0
 
+            self.logger.debug(f"Sending position to Radio {device_name}")
+
             device.sendPosition(
                 latitude=lat,
                 longitude=lng,
                 altitude=altitude,
                 destinationId=destinationId,
             )
-        else:
+        elif (
+            "decoded" in packet
+            and "payload" in packet["decoded"]
+            and "portnum" in packet["decoded"]
+        ):
             meshPacket = mesh_pb2.MeshPacket()
             meshPacket.channel = 0
             meshPacket.decoded.payload = base64.b64decode(packet["decoded"]["payload"])
@@ -427,6 +445,8 @@ class RadioMessagePlugin(Plugin):
             meshPacket.decoded.want_response = False
             meshPacket.id = device._generatePacketId()
 
+            self.logger.debug(f"Sending packet to Radio {device_name}")
+
             device._sendPacket(meshPacket=meshPacket, destinationId=destinationId)
 
         return packet

use-cases/mqtt_bridge/config.yaml

@@ -0,0 +1,25 @@
+devices:
+  - name: radio1
+    tcp: 192.168.86.27
+mqtt_servers:
+  - name: external
+    server: broker.hivemq.com
+    port: 1883
+    topic: meshtastic/radio-network1
+    pipelines:
+      mqtt-to-radio:
+        - radio_message_plugin:
+            device: radio1
+            to: "^all"
+pipelines:
+  pipeline1:
+    - debugger:
+        log_level: debug
+  radio-to-mqtt:
+    - message_filter:
+        app:
+          allow:
+            - "TEXT_MESSAGE_APP"
+    - mqtt_plugin:
+        name: external
+        topic: meshtastic/radio-network1

use-cases/webhook/config.yaml

@@ -0,0 +1,18 @@
+devices:
+  - name: radio1
+    tcp: meshtastic.local
+pipelines:
+  pipeline1:
+    - debugger:
+        log_level: debug
+  radio-to-webhook:
+    - message_filter:
+        app:
+          allow:
+            - "TEXT_MESSAGE_APP"
+    - webhook:
+        active: true
+        body: '{"lat": "{LAT}", "lng": "{LNG}", "text_message": "{MSG}"}'
+        url: "https://webhook.site/452ea027-f9f1-4a62-827b-c921715fcdfb"
+        headers:
+          Content-type: application/json