diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..8bac00ca9c197b4160e70db91d359661b8673229 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# APEX + +Right now the setup.py has a few bugs in it. So you can either try to fix it, wait for us to fix it, or simply install +the prerequsites manually. The following is a list of the preequsites that need to be installed. + + pynmea2 >= 1.4.2 + pyserial >= 2.7 + requests >= 2.7.0 + MySQLdb >= 1.2.5 + mysql >= 2.1.3 + +The application is written for python 3 specifically, it may not work with python 2. Once installed copy the +apex.cfg.example file over to apex.cfg in the same directory, then edit the file and replace it with your details. Next +just run the application with the following command. + + python ./comterminal.py + +There isnt much to the application right now, so thats all you should need to run it. Digipeating will occur +automatically and respond to the WIDEN-n paradigm as well as your own callsign. Cross-band repeating is enabled right +now but only by specifying the call sign directly. The application is still pre-release so more features and +configuration options should be added soon. \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index d303fe0cb02921f2fe049bb4e7e1df0c89b27bd8..0000000000000000000000000000000000000000 --- a/README.rst +++ /dev/null @@ -1,92 +0,0 @@ -APEX -************************* - -Includes Python module with bindings for APRS as well as ``aprs_tracker`` command-line APRS location tracking utility. - - -Examples -======== - -Example 1: APRS Tracker ------------------------ - -The following example uses the ``aprs_tracker`` command to connect to APRS-IS -as WI2ARD and send a single-shot location frame using location data from my -locally connected USB (or USB->Serial) GPS: - -Example 1 Code -^^^^^^^^^^^^^^ -:: - - $ aprs_tracker -c WI2ARD -p 12345 -s /dev/cu.usbmodem1a1211 -u 3 -d - -Example 1 Output -^^^^^^^^^^^^^^^^ -:: - - 2015-09-25 15:04:55,930 INFO aprs.classes.connect:63 - Connected to server=rotate.aprs.net port=14580 - 2015-09-25 15:04:55,931 DEBUG aprs.cmd.tracker:113 - frame=WI2ARD-3>APRS:!3745.78N/12225.14W>000/000/A=000175 APRS - - -See Also -^^^^^^^^ -See ``$ aprs_tracker -h`` for more information. - - -Example 2: Library Usage - Receive ----------------------------------- - -The following example connects to APRS-IS as WI2ARD and filters for APRS -frames coming from my prefix (WI2ARD, WI2ARD-n, etc). Any frames returned are -sent to my callback *my_callback* and printed. - -Example 2 Code -^^^^^^^^^^^^^^ -:: - - import aprs - - def my_callback(line): - print line - - a = aprs.APRS('WI2ARD', '12345') - a.connect() - a.receive(callback=my_callback) - -Example 2 Output -^^^^^^^^^^^^^^^^ -:: - - W2GMD-6>APRX28,TCPIP*,qAC,APRSFI-I1:T#471,7.5,34.7,37.0,1.0,137.0,00000000 - -Example 3: Library Usage - Send ----------------------------------- - -The following example connects to APRS-IS as WI2ARD and sends an APRS frame. - -Example 3 Code -^^^^^^^^^^^^^^ -:: - - import aprs - - a = aprs.APRS('WI2ARD', '12345') - a.connect() - a.send('WI2ARD>APRS:>Hello World!') - - -Source -====== -Github: https://github.com/syncleus/apex - -Author -====== -Jeffrey Phillips Freeman WI2ARD <freemo@syncleus.com> - -Copyright -========= -Copyright 2016, Syncleus, Inc. - -License -======= -Apache License, Version 2.0