meshcore_multitcp/README.md

50 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2025-11-17 11:18:18 +01:00
# meshcore_multitcp
2025-11-17 11:33:35 +01:00
2025-11-17 11:18:18 +01:00
multiplexing a mescore tcp-connected companion to multiple clients as cli-chat, observer or bots
2025-11-17 11:33:35 +01:00
## 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)
## usage
python3 meshcore_multitcp.py -d Device-IP:PORT -s Server-IP:PORT [-q|-v]
2025-11-17 11:34:35 +01:00
-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
2025-11-17 11:33:35 +01:00
2025-12-20 15:56:27 +01:00
-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)
2025-11-17 11:33:35 +01:00
After meshcore_multitcp is running you can connect your clients to IP/port set with -s
2025-12-20 15:56:27 +01:00
## 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.
2025-11-17 11:33:35 +01:00
## 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.
2026-01-07 10:55:41 +01:00
TEST