do6uk/meshcore_multitcp
1
0
Fork 0
mirror of https://github.com/do6uk/meshcore_multitcp.git synced 2026-04-21 03:53:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
multiplexing a mescore tcp-connected companion to multiple clients as cli-chat, observer or bots
13 commits 1 branch 0 tags 59 KiB
Find a file
luk-ada e96052f35e move sqlite db for persistance storage
2026-04-12 18:50:31 +02:00
.gitignore docker support 2026-04-12 18:50:08 +02:00
docker-compose.yml docker support 2026-04-12 18:50:08 +02:00
Dockerfile docker support 2026-04-12 18:50:08 +02:00
example_meshcore-multitcp.service Add files via upload 2025-11-17 12:05:49 +01:00
meshcore_multitcp.py move sqlite db for persistance storage 2026-04-12 18:50:31 +02:00
meshcore_multitcp_packets.py Add files via upload 2025-11-17 12:04:17 +01:00
README.md docker support 2026-04-12 18:50:08 +02:00

README.md

meshcore_multitcp

multiplexing a mescore tcp-connected companion to multiple clients as cli-chat, observer or bots

what you can do with this software

  • use one companion with multiple client-apps simultaneously

what you will need

  • companion radio with wifi-firmware to allow tcp-connections
  • linux device (tested under debian trixie)
  • python3
  • python meshcore package (pip install meshcore)

alternatively: docker

usage

python3 meshcore_multitcp.py -d Device-IP:PORT -s Server-IP:PORT [-q|-v]

-d sets IP & port of your companion radio

-s sets IP & port of the machine this script listens to clients

-q minimizes CLI-output

-v maximizes CLI-output

-f sets secondary IP & port for listening to clients using message-storage (see S&F)

-sql activates message-storage for clients which connect at second ip/port given by -f (see S&F)

After meshcore_multitcp is running you can connect your clients to IP/port set with -s

docker

# build
docker build -t meshcore-multitcp .

# run
docker run -p 5000:5000 meshcore-multitcp -d Device-IP:PORT -s 0.0.0.0:5000 [-q|-v]

docker compose

Copy and edit docker-compose.yml to match your setup:

  • -d - IP and port of your companion radio
  • -s 0.0.0.0:PORT - port the proxy listens on for clients (always use 0.0.0.0 inside the container)
  • -f 0.0.0.0:PORT - port for store & forward clients (requires -sql)
  • ports - use host-ip:port:port to bind to a specific host interface, or port:port for all interfaces
  • volumes - mount a host path to /data to persist the SQLite database across restarts
docker compose up -d

S&F - store & forward messages

Using option -sql meshcore-multitcp will store all incomming private & channel messages in local sqlite3-database. If client connects at secondary ip/port given by -f meshcore-multitcp will forward all stored messages since last message exchange. Dumping large number of messages can cause hung up clients and messages could be lost.

WARNING: Actually theres no database-clean-up - so if you connect a new client first time, meshcore-multitcp will try to forward all known messages.

what you should know before you start

This software comes as it is without any guarantee to work stable and secure. It contains modified parts of the original meshcore_py-scripts. There are several things untested und a lot of bugs in it. Some client-app functions doesn't work as expected and could throw timeout-errors or crash the whole app.

TEST