12 Commits
0.2 ... 0.5

Author SHA1 Message Date
Geoff Whittington
159b3b097d Added use case config, fixed bugs 2022-12-04 14:25:38 -05:00
Geoff Whittington
dd83f29806 Merge branch 'main' of github.com:geoffwhittington/meshtastic-bridge into main 2022-11-21 14:17:50 -05:00
Geoff Whittington
26d540fead fix type bug 2022-11-21 14:17:36 -05:00
geoffwhittington
b72102c402 Update Dockerfile 2022-11-20 18:53:35 -05:00
geoffwhittington
0930aa917e Update Dockerfile 2022-11-20 18:51:16 -05:00
geoffwhittington
7ad584830a Update Dockerfile 2022-11-20 18:47:10 -05:00
geoffwhittington
fe5e119059 Update Dockerfile 2022-11-20 18:41:47 -05:00
geoffwhittington
23c1250ccb Update Dockerfile 2022-11-20 18:26:30 -05:00
geoffwhittington
c5134fd5b4 Update README.md 2022-11-20 18:17:04 -05:00
geoffwhittington
c3ff3b3a4f Update main.yaml 2022-11-20 18:10:11 -05:00
geoffwhittington
0f1e5a908d Add multiple platform support 2022-11-20 18:08:14 -05:00
Geoff Whittington
74114f1acc Support for 1.3 (2.0) 2022-10-31 17:07:30 -04:00
7 changed files with 308 additions and 168 deletions

View File

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

View File

@@ -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

View File

@@ -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:
@@ -105,12 +105,12 @@ The following plugins can be used in the `pipelines` section of `config.yaml`:
| ----------------- | -------------------------------------------------------------------- |
| `debugger` | Log the packet to the system console |
| `message_filter` | Filters out packets from the bridge that match a specific criteria |
| `distance_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 |
| `mqtt_plugin` | Send packets to a MQTT server |
| `encrypt_filter` | Encrypt a packet for a desired MQTT recipient |
| `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
@@ -131,28 +131,37 @@ Useful for troubleshooting.
- **app** Name of meshtastic application to allow or disallow
- **from** The packet `fromId` values to allow or disallow
- **to** The packet `toId` values to allow or disallow
- **message** The packet `message` values to allow or disallow. Supports Regex.
For example:
```
message_filter:
app:
from:
allow:
- !bd5ba0ec
- !f85bc0bc
disallow:
- !c15ba2ec
message:
disallow:
- Good night
```
### distance_filter - Allow or block packets based on distance from origin to radio
### location_filter - Filter packets by location from current node (default) or specific location
- **log_level** `debug` or `info`. Default `info`
- **max_distance_km** Number of kilometers
- **max_distance_km** Filter packets more than a certain distance
- **comparison** `within` or `outside`. Default `within`
- **compare_latitude** latitude to compare against
- **compare_longitude** longitude to compare against
- **latitude** Set the latitude
- **longitude** Set the longitude
For example:
For example
```
distance_filter:
location_filter:
max_distance_km: 1000
```
@@ -225,7 +234,7 @@ decrypt_filter:
key: '/home/user/keys/key.pem'
```
### send_plugin - Send a packet to a radio
### radio_message_plugin - Send a packet to a radio
- **log_level** `debug` or `info`. Default `info`
- **active** Plugin is active. Values: `true` or `false`. Default `true`.
@@ -242,7 +251,7 @@ For example:
Broadcasts all packets to the "remote" radio network that are destined to the node `12354345`.
```
send_plugin:
radio_message_plugin:
device: remote
node_mapping:
12354345: ^all

171
main.py
View File

@@ -1,5 +1,6 @@
import json
import logging
from re import I
import meshtastic
import meshtastic.serial_interface
import meshtastic.tcp_interface
@@ -20,7 +21,15 @@ logger = logging.getLogger(name="meshtastic.bridge")
logger.setLevel(logging.DEBUG)
class CustomTCPInterface(meshtastic.tcp_interface.TCPInterface):
def __init__(self, hostname, device_name):
self.device_name = device_name
self.hostname = hostname
super(CustomTCPInterface, self).__init__(hostname)
def onReceive(packet, interface): # called when a packet arrives
nodeInfo = interface.getMyNodeInfo()
for pipeline, pipeline_plugins in bridge_config["pipelines"].items():
logger.debug(f"Pipeline {pipeline} initiated")
@@ -29,6 +38,9 @@ def onReceive(packet, interface): # called when a packet arrives
pipeline_packet = p.do_action(packet)
for plugin in pipeline_plugins:
if not pipeline_packet:
continue
for plugin_key, plugin_config in plugin.items():
logger.debug(f"Processing plugin: {pipeline}/{plugin_key}")
@@ -57,8 +69,17 @@ def onConnection(
)
def onLost(interface):
logger.debug(f"Connecting to {interface.hostname} ...")
devices[interface.device_name] = CustomTCPInterface(
hostname=interface.hostname, device_name=interface.device_name
)
logger.debug(f"Connected to {interface.hostname}")
pub.subscribe(onReceive, "meshtastic.receive")
pub.subscribe(onConnection, "meshtastic.connection.established")
pub.subscribe(onLost, "meshtastic.connection.lost")
with open("config.yaml") as f:
bridge_config = yaml.load(f, Loader=SafeLoader)
@@ -75,99 +96,121 @@ for device in bridge_config["devices"]:
devPath=device["serial"]
)
elif "tcp" in device:
devices[device["name"]] = meshtastic.tcp_interface.TCPInterface(
hostname=device["tcp"]
logger.debug(f"Connecting to {device['tcp']} ...")
devices[device["name"]] = CustomTCPInterface(
hostname=device["tcp"], device_name=device["name"]
)
logger.debug(f"Connected to {device['tcp']}")
else:
devices[device["name"]] = meshtastic.serial_interface.SerialInterface()
for config in bridge_config["mqtt_servers"]:
required_options = [
"name",
"server",
"port",
]
if "mqtt_servers" in bridge_config:
for config in bridge_config["mqtt_servers"]:
required_options = [
"name",
"server",
"port",
]
for option in required_options:
if option not in config:
logger.warning("Missing config: {option}")
for option in required_options:
if option not in config:
logger.warning("Missing config: {option}")
client_id = config["client_id"] if "client_id" in config else None
username = config["username"] if "username" in config else None
password = config["password"] if "password" in config else None
client_id = config["client_id"] if "client_id" in config else None
username = config["username"] if "username" in config else None
password = config["password"] if "password" in config else None
if client_id:
mqttc = mqtt.Client(client_id)
else:
mqttc = mqtt.Client()
logger.info(f"Connected to MQTT {config['name']}")
if username and password:
mqttc.username_pw_set(username, password)
if client_id:
mqttc = mqtt.Client(client_id)
else:
mqttc = mqtt.Client()
mqtt_servers[config["name"]] = mqttc
if username and password:
mqttc.username_pw_set(username, password)
def on_connect(mqttc, obj, flags, rc):
logger.debug(f"Connected to MQTT {config['name']}")
def on_connect(mqttc, obj, flags, rc):
logger.debug(f"Connected to MQTT {config['name']}")
def on_message(mqttc, obj, msg):
packet = msg.payload.decode()
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']}: on_message")
logger.debug(f"MQTT {config['name']}: {orig_packet}")
if "pipelines" not in config:
logger.warning(f"MQTT {config['name']}: no pipeline")
return
if "pipelines" not in config:
logger.warning(f"MQTT {config['name']}: no pipeline")
return
for pipeline, pipeline_plugins in config["pipelines"].items():
p = plugins["packet_filter"]
pipeline_packet = p.do_action(orig_packet)
logger.debug(f"MQTT {config['name']} pipeline {pipeline} started")
if not packet:
continue
for pipeline, pipeline_plugins in config["pipelines"].items():
for plugin in pipeline_plugins:
for plugin_key, plugin_config in plugin.items():
if plugin_key not in plugins:
logger.error(f"No such plugin: {plugin_key}. Skipping")
packet = pipeline_packet
logger.debug(f"MQTT {config['name']} pipeline {pipeline} initiated")
if not packet:
continue
for plugin in pipeline_plugins:
if not packet:
continue
p = plugins[plugin_key]
p.configure(devices, mqtt_servers, plugin_config)
for plugin_key, plugin_config in plugin.items():
if plugin_key not in plugins:
logger.error(f"No such plugin: {plugin_key}. Skipping")
continue
try:
packet = p.do_action(packet)
except Exception as e:
logger.error(f"Hit an error: {e}", exc_info=True)
logger.debug(f"MQTT {config['name']} pipeline {pipeline} finished")
p = plugins[plugin_key]
p.configure(devices, mqtt_servers, plugin_config)
def on_publish(mqttc, obj, mid):
logger.debug(f"MQTT {config['name']}: on_publish: {mid}")
try:
packet = p.do_action(packet)
except Exception as e:
logger.error(f"Hit an error: {e}", exc_info=True)
logger.debug(f"MQTT {config['name']} pipeline {pipeline} finished")
def on_subscribe(mqttc, obj, mid, granted_qos):
logger.debug(f"MQTT {config['name']}: on_subscribe: {mid}")
def on_publish(mqttc, obj, mid):
logger.debug(f"MQTT {config['name']}: on_publish: {mid}")
mqttc.on_message = on_message
mqttc.on_connect = on_connect
mqttc.on_publish = on_publish
mqttc.on_subscribe = on_subscribe
def on_subscribe(mqttc, obj, mid, granted_qos):
logger.debug(f"MQTT {config['name']}: on_subscribe: {mid}")
import ssl
mqttc.on_message = on_message
mqttc.on_connect = on_connect
mqttc.on_publish = on_publish
mqttc.on_subscribe = on_subscribe
if "insecure" in config and config["insecure"]:
mqttc.tls_set(cert_reqs=ssl.CERT_NONE)
mqttc.tls_insecure_set(True)
mqtt_servers[config["name"]] = mqttc
mqttc.connect(config["server"], config["port"], 60)
import ssl
if "topic" in config:
mqttc.subscribe(config["topic"], 0)
if "insecure" in config and config["insecure"]:
mqttc.tls_set(cert_reqs=ssl.CERT_NONE)
mqttc.tls_insecure_set(True)
mqttc.loop_start()
try:
logger.debug(f"Connecting to MQTT {config['server']}")
mqttc.connect(config["server"], config["port"], 60)
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)
for device, instance in devices.items():
instance.close()
if devices:
for device, instance in devices.items():
instance.close()
for server, instance in mqtt_servers.items():
instance.disconnect()
if mqtt_servers:
for server, instance in mqtt_servers.items():
instance.disconnect()

View File

@@ -1,16 +1,20 @@
from haversine import haversine
from meshtastic import mesh_pb2
from meshtastic.__init__ import BROADCAST_ADDR
from random import randrange
import base64
import json
import logging
import os
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
@@ -29,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:
del dict_obj["raw"]
for k, v in dict_obj.items():
dict_obj[k] = self.strip_raw(v)
return dict_obj
return self.strip_raw(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(
packet["decoded"]["payload"]
).decode("utf-8")
if type(packet["decoded"]["payload"]) is bytes:
text = packet["decoded"]["payload"]
packet["decoded"]["payload"] = base64.b64encode(
packet["decoded"]["payload"]
).decode("utf-8")
self.logger.debug(f"After normalization: {packet}")
return packet
@@ -74,6 +95,33 @@ class MessageFilter(Plugin):
self.logger.error("Missing packet")
return packet
text = packet["decoded"]["text"] if "text" in packet["decoded"] else None
if text and "message" in self.config:
if "allow" in self.config["message"]:
matches = False
for allow_regex in self.config["message"]["allow"]:
if not matches and re.search(allow_regex, text):
matches = True
if not matches:
self.logger.debug(
f"Dropped because it doesn't match message allow filter"
)
return None
if "disallow" in self.config["message"]:
matches = False
for disallow_regex in self.config["message"]["disallow"]:
if not matches and re.search(disallow_regex, text):
matches = True
if matches:
self.logger.debug(
f"Dropped because it matches message disallow filter"
)
return None
filters = {
"app": packet["decoded"]["portnum"],
"from": packet["fromId"],
@@ -83,12 +131,15 @@ class MessageFilter(Plugin):
for filter_key, value in filters.items():
if filter_key in self.config:
filter_val = self.config[filter_key]
if (
"allow" in filter_val
and filter_val["allow"]
and value not in filter_val["allow"]
):
self.logger.debug(f"Dropped because it doesn't match allow filter")
self.logger.debug(
f"Dropped because {value} doesn't match {filter_key} allow filter"
)
return None
if (
@@ -96,7 +147,9 @@ class MessageFilter(Plugin):
and filter_val["disallow"]
and value in filter_val["disallow"]
):
self.logger.debug(f"Dropped because it matches disallow filter")
self.logger.debug(
f"Dropped because {value} matches {filter_key} disallow filter"
)
return None
self.logger.debug(f"Accepted")
@@ -106,21 +159,24 @@ class MessageFilter(Plugin):
plugins["message_filter"] = MessageFilter()
class DistanceFilter(Plugin):
class LocationFilter(Plugin):
logger = logging.getLogger(name="meshtastic.bridge.filter.distance")
def do_action(self, packet):
if "device" not in self.config:
return packet
if "position" not in packet["decoded"]:
return packet
message_source_position = None
current_local_position = None
if "device" in self.config and self.config["device"] in self.devices:
nodeInfo = self.devices[self.config["device"]].getMyNodeInfo()
current_local_position = (
nodeInfo["position"]["latitude"],
nodeInfo["position"]["longitude"],
)
if (
"latitude" in packet["decoded"]["position"]
"decoded" in packet
and "position" in packet["decoded"]
and "latitude" in packet["decoded"]["position"]
and "longitude" in packet["decoded"]["position"]
):
message_source_position = (
@@ -128,44 +184,49 @@ class DistanceFilter(Plugin):
packet["decoded"]["position"]["longitude"],
)
nodeInfo = self.devices[self.config["device"]].getMyNodeInfo()
if "compare_latitude" in self.config and "compare_longitude" in self.config:
current_local_position = (
nodeInfo["position"]["latitude"],
nodeInfo["position"]["longitude"],
self.config["compare_latitude"],
self.config["compare_longitude"],
)
if message_source_position and current_local_position:
distance_km = haversine(message_source_position, current_local_position)
comparison = (
self.config["comparison"] if "comparison" in self.config else "within"
)
# message originates from too far a distance
if (
"max_distance_km" in self.config
and self.config["max_distance_km"] > 0
and distance_km > self.config["max_distance_km"]
):
logger.debug(
f"Packet from too far: {distance_km} > {SUPPORTED_BRIDGE_DISTANCE_KM}"
)
return None
if "max_distance_km" in self.config and self.config["max_distance_km"] > 0:
acceptable_distance = self.config["max_distance_km"]
if comparison == "within" and distance_km > acceptable_distance:
self.logger.debug(
f"Packet from too far: {distance_km} > {acceptable_distance}"
)
return None
elif comparison == "outside" and distance_km < acceptable_distance:
self.logger.debug(
f"Packet too close: {distance_km} < {acceptable_distance}"
)
return None
if "latitude" in self.config:
packet["decoded"]["position"]["latitude"] = self.config["latitude"]
if "longitude" in self.config:
packet["decoded"]["position"]["longitude"] = self.config["longitude"]
return packet
plugins["distance_filter"] = DistanceFilter()
plugins["location_filter"] = LocationFilter()
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
@@ -235,9 +296,16 @@ 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()
@@ -311,52 +379,40 @@ class DecryptFilter(Plugin):
plugins["decrypt_filter"] = DecryptFilter()
class SendPlugin(Plugin):
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:
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"]
destinationId = None
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
@@ -367,13 +423,19 @@ class SendPlugin(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"])
@@ -381,9 +443,11 @@ class SendPlugin(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
plugins["send_plugin"] = SendPlugin()
plugins["radio_message_plugin"] = RadioMessagePlugin()

View File

@@ -1,5 +1,5 @@
devices:
- name: local
- name: local
pipelines:
- debugger:
log_level: info
- debugger:
log_level: info

View File

@@ -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