arcs

Amateur Radio Chat Server with a modern interface
git clone git://squid-tech.com/arcs.git
Log | Files | Refs | README

commit b69ef39001503d6d6f5290d66fd55cf059adf4f0
parent 53060834b4d0b10a4a79e5696c9b3eb0c8621e74
Author: joshiemoore <jxm5210@g.rit.edu>
Date:   Fri, 20 Dec 2019 02:02:52 -0500

Merge branch 'master' of https://github.com/joshiemoore/arcs

Diffstat:
MREADME.md | 18++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md @@ -1,12 +1,14 @@ # arcs -The Amateur Radio Chat Server is a service that enables amateur radio operators to connect to a text chat room through a modern web browser interface without an internet connection. Users are able to send messages to the server, where they will be received by all other connected users. +The Amateur Radio Chat Server is a service that enables amateur radio operators to connect to a text chat room through a modern GUI without an internet connection. Users are able to send messages to the server, where they will be received by all other connected users. I will try to keep an ARCS server running 24/7 as KD2SIX-1 on frequency 144.39 - try connecting and leaving some messages! -Note that you do not necessarily need to use the browser interface to connect to ARCS - see section "Non-Browser Use" for more information. +Note that you do not necessarily need to use the GUI to connect to ARCS - see section "Non-GUI Use" for more information. ### Setup/Running -ARCS is based on "pure" python3, so no special setup is required. You also need a serial KISS TNC, and I highly recommend [Direwolf](https://github.com/wb2osz/direwolf). You also need a transceiver (and an amateur radio license!). +ARCS requires python3 and tkinter. tkinter comes with python3, but maybe you need to [install it if you don't have it.](https://www.wikihow.com/Install-Tkinter) + +You also need a serial KISS TNC, and I highly recommend [Direwolf](https://github.com/wb2osz/direwolf). You also need a transceiver (and an amateur radio license!). 1. Clone this repository. 2. Set MYCALL in `arcs.py` to your own callsign. @@ -14,8 +16,8 @@ ARCS is based on "pure" python3, so no special setup is required. You also need 4. If you are running your own server, modify the server config section of `arcs.py` to match your setup. 5. Connect your radio to your computer, and set it to frequency 144.39 (national APRS frequency). 6. Run `direwolf -p`, making note of the path to the serial KISS TNC. -7. Start ARCS with `python3 arcs.py <serial/tnc/path> 115200 [options ...]` (If you are running your own server, include the `-server` flag in the options field) -8. Open `index.html` in your web browser, and you're ready to go! +7. Start ARCS with `python3 arcs.py <serial/tnc/path> 9600 [options ...]` (If you are running your own server, include the `-server` flag in the options field) +8. Send some messages! ### Commands TODO @@ -29,10 +31,10 @@ Remember that while ARCS "looks like" a standard Internet chat application, the * Avoid needlessly running your own ARCS server. I think it would be a good idea to have regional servers for different areas of the country/world, but the network would get overwhelmed quickly if everyone tries to run their own server. * Please stick to normal text messaging if you are connecting to ARCS with anything other than the normal browser interface. Avoid including position, PHG, or other metadata in messages you send. This data is not really relevant to ARCS, it will just waste bandwidth and make your messages hard to read. Your APRS-enabled device may include this data in your messages by default, so be sure to check. -### Non-Browser Use -You do not need to use any of the included python3 code or a web browser to connect to an ARCS server. You can just send APRS messages directly to the callsign of the server (i.e. KD2SIX-1), and you will be connected just like through the browser interface. You will need to continue to send messages or manually send `/ping` commands periodically in order to keep your connection alive. +### Non-GUI Use +You do not need to use any of the included python3 code or the GUI to connect to an ARCS server. You can just send APRS messages directly to the callsign of the server (i.e. KD2SIX-1), and you will be connected just like through the GUI program. You will need to continue to send messages or manually send `/ping` commands periodically in order to keep your connection alive. -Note that this is not intended use, and this connection method is not actively supported. You should connect to ARCS servers through the browser interface. +Note that this is not intended use, and this connection method is not actively supported. You should connect to ARCS servers through the GUI program. ### Contributing Thank you for taking the time to look at ARCS. You can contribute by sending pull requests, opening issues with bug reports and feature suggestions, or just by using ARCS and letting me know how it goes.