Update readme.
This commit is contained in:
		
							
								
								
									
										70
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										70
									
								
								README.md
									
									
									
									
									
								
							@@ -7,6 +7,7 @@ direwolf logs into a REST API in JSON format.
 | 
			
		||||
## Setup
 | 
			
		||||
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. Set up database file with `python init_db.py`.
 | 
			
		||||
2. Run `app.py` with either a Python call or a real WSGI server.
 | 
			
		||||
You can use screen to detach the session.
 | 
			
		||||
    - 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:
 | 
			
		||||
```
 | 
			
		||||
{
 | 
			
		||||
            "chan": 0,
 | 
			
		||||
            "utime": 1680566406,
 | 
			
		||||
            "isotime": "2023-04-04T00:00:06Z",
 | 
			
		||||
            "source": "W1CDN-1",
 | 
			
		||||
            "heard": "K0UND-2",
 | 
			
		||||
            "level": "113(71/42)",
 | 
			
		||||
            "error": 0,
 | 
			
		||||
            "dti": ";",
 | 
			
		||||
            "name": "147.390GF",
 | 
			
		||||
            "symbol": "/r",
 | 
			
		||||
            "latitude": 47.924167,
 | 
			
		||||
            "longitude": -97.009667,
 | 
			
		||||
            "speed": 0.0,
 | 
			
		||||
            "course": 0.0,
 | 
			
		||||
            "altitude": 0.0,
 | 
			
		||||
            "frequency": 147.39,
 | 
			
		||||
            "offset": 600.0,
 | 
			
		||||
            "tone": 0.0,
 | 
			
		||||
            "system": "DireWolf, WB2OSZ",
 | 
			
		||||
            "status": 0,
 | 
			
		||||
            "telemetry": 0.0,
 | 
			
		||||
            "comment": " https://www.wa0jxt.org/"
 | 
			
		||||
        },
 | 
			
		||||
      "id": 1,
 | 
			
		||||
      "addresse": null,
 | 
			
		||||
      "alive": null,
 | 
			
		||||
      "altitude": null,
 | 
			
		||||
      "comment": "Leave a message to say hi!",
 | 
			
		||||
      "course": null,
 | 
			
		||||
      "created": "2023-04-16 15:04:03",
 | 
			
		||||
      "format": "uncompressed",
 | 
			
		||||
      "frame": null,
 | 
			
		||||
      "from": "W1CDN-2",
 | 
			
		||||
      "gpsfixstatus": null,
 | 
			
		||||
      "latitude": 47.94133333333333,
 | 
			
		||||
      "longitude": -97.02683333333333,
 | 
			
		||||
      "mbits": null,
 | 
			
		||||
      "messagecapable": 1,
 | 
			
		||||
      "message_text": null,
 | 
			
		||||
      "mtype": null,
 | 
			
		||||
      "object_format": null,
 | 
			
		||||
      "object_name": null,
 | 
			
		||||
      "path": "['K0UND-2', 'WIDE2-2']",
 | 
			
		||||
      "phg": null,
 | 
			
		||||
      "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
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user