From ff938dabe2b633cde17e004ebc35124603bac7b9 Mon Sep 17 00:00:00 2001 From: geoffwhittington Date: Wed, 17 Aug 2022 21:39:44 -0400 Subject: [PATCH 1/4] Create README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..93ccb64 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Meshtastic Bridge + +Connect two distinct radio [Meshtastic](https://meshtastic.org) networks using TCP. + +## Requirements + +* Python3 +* `LOCAL_NODE_ADDR` The IP address or Serial devPath (micro USB cable needed for serial access) of a local Meshtastic device +* `REMOTE_NODE_ARR` The IP address of a remote Meshtastic device + +Refer to to configure a Meshtastic device to use wifi and expose a TCP address + +## Setup + +Run the following steps to download and install the software locally + +``` +$ git clone https://github.com/geoffwhittington/meshtastic-bridge.git +$ python3 -m venv meshtastic-bridge +$ cd meshtastic-bridge +$ source bin/activate +$ pip install -r requirements.txt +``` + +## Turn on the Bridge + +In the `meshtastic-bridge` directory run the following: + +``` +LOCAL_NODE_ADDR=/dev/ttyUSB0 REMOTE_NODE_ARR=182.168.86.123 python main.py +``` From 827e80486330685de598e1cf2026d471ccacd3ef Mon Sep 17 00:00:00 2001 From: geoffwhittington Date: Wed, 17 Aug 2022 21:45:22 -0400 Subject: [PATCH 2/4] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 93ccb64..c074684 100644 --- a/README.md +++ b/README.md @@ -27,5 +27,9 @@ $ pip install -r requirements.txt In the `meshtastic-bridge` directory run the following: ``` -LOCAL_NODE_ADDR=/dev/ttyUSB0 REMOTE_NODE_ARR=182.168.86.123 python main.py +BRIDGE_DISTANCE_KM=0 LOCAL_NODE_ADDR=/dev/ttyUSB0 REMOTE_NODE_ARR=182.168.86.123 python main.py ``` + +## Runtime Options + +* `BRIDGE_DISTANCE_KM` Maximum distance from local Meshtastic device to relay messages. Default `0` (no limit) From 125fe719f4bc3de599ea6e7fa294bf6b35c3fc54 Mon Sep 17 00:00:00 2001 From: geoffwhittington Date: Wed, 17 Aug 2022 21:51:21 -0400 Subject: [PATCH 3/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c074684..e3fa9bf 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,9 @@ $ pip install -r requirements.txt In the `meshtastic-bridge` directory run the following: ``` -BRIDGE_DISTANCE_KM=0 LOCAL_NODE_ADDR=/dev/ttyUSB0 REMOTE_NODE_ARR=182.168.86.123 python main.py +BRIDGE_DISTANCE_KM=0 LOCAL_NODE_ADDR=/dev/ttyUSB0 REMOTE_NODE_ADDR=182.168.86.123 python main.py ``` -## Runtime Options +## Bridge Options -* `BRIDGE_DISTANCE_KM` Maximum distance from local Meshtastic device to relay messages. Default `0` (no limit) +* `BRIDGE_DISTANCE_KM` Do not bridge messages from nodes that more than BRIDGE_DISTANCE_KM kilometers from the local Meshtastic device. Default `0` (no limit) From 0f304464781936cee597e25a78ddf2315fe96b35 Mon Sep 17 00:00:00 2001 From: geoffwhittington Date: Wed, 17 Aug 2022 21:55:03 -0400 Subject: [PATCH 4/4] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e3fa9bf..027a366 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,10 @@ Connect two distinct radio [Meshtastic](https://meshtastic.org) networks using T ## Requirements -* Python3 -* `LOCAL_NODE_ADDR` The IP address or Serial devPath (micro USB cable needed for serial access) of a local Meshtastic device -* `REMOTE_NODE_ARR` The IP address of a remote Meshtastic device +- Python3 +- Two Meshtastic devices: + - Local `LOCAL_NODE_ADDR` The IP address or Serial devPath (micro USB cable needed for serial access) of a local Meshtastic device + - Remote `REMOTE_NODE_ARR` The IP address of a remote Meshtastic device Refer to to configure a Meshtastic device to use wifi and expose a TCP address