W1CDN/aprs_tool
0
0
Fork 0
Code Issues 45 Pull Requests Projects Releases Activity

Update readme.

Browse Source
This commit is contained in:
W1CDN 2023-04-16 16:49:25 -05:00
parent 467ec11522
commit 19b3a54d98
1 changed files with 47 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
README.md
View File

@ -7,6 +7,7 @@ direwolf logs into a REST API in JSON format.
## Setup ## Setup
1. Run direwolf with logging to CSV on by using `-l`. (`-L` not yet implemented). 1. Run direwolf with logging to CSV on by using `-l`. (`-L` not yet implemented).
1. Install requirements using `pip install -r requirements.txt`. 1. Install requirements using `pip install -r requirements.txt`.
1. Set up database file with `python init_db.py`.
2. Run `app.py` with either a Python call or a real WSGI server. 2. Run `app.py` with either a Python call or a real WSGI server.
You can use screen to detach the session. You can use screen to detach the session.
- Default URL is http://127.0.0.1:5000 - Default URL is http://127.0.0.1:5000
@ -22,29 +23,52 @@ User Guide.
Example of an object packet sent by W1CDN-1 and digipeated by K0UND-2: Example of an object packet sent by W1CDN-1 and digipeated by K0UND-2:
``` ```
{ {
"chan": 0, "id": 1,
"utime": 1680566406, "addresse": null,
"isotime": "2023-04-04T00:00:06Z", "alive": null,
"source": "W1CDN-1", "altitude": null,
"heard": "K0UND-2", "comment": "Leave a message to say hi!",
"level": "113(71/42)", "course": null,
"error": 0, "created": "2023-04-16 15:04:03",
"dti": ";", "format": "uncompressed",
"name": "147.390GF", "frame": null,
"symbol": "/r", "from": "W1CDN-2",
"latitude": 47.924167, "gpsfixstatus": null,
"longitude": -97.009667, "latitude": 47.94133333333333,
"speed": 0.0, "longitude": -97.02683333333333,
"course": 0.0, "mbits": null,
"altitude": 0.0, "messagecapable": 1,
"frequency": 147.39, "message_text": null,
"offset": 600.0, "mtype": null,
"tone": 0.0, "object_format": null,
"system": "DireWolf, WB2OSZ", "object_name": null,
"status": 0, "path": "['K0UND-2', 'WIDE2-2']",
"telemetry": 0.0, "phg": null,
"comment": " https://www.wa0jxt.org/" "phg_dir": null,
}, "phg_gain": null,
"phg_height": null,
"phg_power": null,
"phg_range": null,
"posambiguity": 0,
"raw": "W1CDN-2>APQTH1,K0UND-2,WIDE2-2:@150321h4756.48N/09701.61W-Leave a message to say hi!",
"raw_timestamp": "150321h",
"speed": null,
"station_call": "W1CDN-1",
"station_lat": 47.9415,
"station_lon": -97.027,
"status": null,
"symbol": "-",
"symbol_table": "/",
"telemetry": null,
"timestamp": 1681657401,
"to": "APQTH1",
"tEQNS": null,
"tPARM": null,
"tUNIT": null,
"via": "",
"weather": null,
"wx_raw_timestamp": null
}
``` ```
# Contributing # Contributing