diff --git a/API.md b/API.md index 4f32251..e510db3 100644 --- a/API.md +++ b/API.md @@ -1,55 +1,118 @@ Here are the API endpoints and the output: -## http://your-url/ip:8073/metrics +## Receiver metrics - -```{"openwebrx": -{"users": 2}, -"aprs": -{"decodes": {"unknown": {"aprs": {"count": 0}}, -"2m": {"aprs": {"count": 364}}, -.... -"wsjt": -{"decodes": -{"40m": {"FT8": {"count": 40484}, -"FT4": {"count": 1637}, -"WSPR": {"count": 170}}, -"2m": {"FT4": {"count": 16}, "FT8": {"count": 46}}, -"80m": {"FT4": {"count": 4}, "FT8": {"count": 320}}, -"20m": {"FT8": {"count": 385}, "FT4": {"count": 21}}}}} -``` - - - -## http://your-url/ip:8073/status.json +Endpoint: `/metrics` (Prometheus format) ``` -{"receiver": -{"name": "CALL", -"admin": "email", "gps": {"lat": 0.0, "lon": 0.0}, "asl": 200, "location": "City, Country"}, "max_clients": 20, "version": "v0.19.1", - -"sdrs": -[{"name": "RTL-SDR USB Stick", "type": "RtlSdrSoapySource", -"profiles": -[{"name": "2m komplett", "center_freq": 145000000, "sample_rate": 2400000}, -... -}] -{"name": "Hack RF", "type": "HackrfSource", "profiles": [{"name": "10m", "center_freq": 28800000, "sample_rate": 384000}, -{"name": "12m", "center_freq": 24950000, "sample_rate": 384000}, -{"name": "15m", "center_freq": 21250000, "sample_rate": 384000}, -{"name": "17m", "center_freq": 18090000, "sample_rate": 384000}, -{"name": "20m", "center_freq": 14150000, "sample_rate": 384000}, -{"name": "30m", "center_freq": 10125000, "sample_rate": 192000}, -{"name": "40m", "center_freq": 7100000, "sample_rate": 256000}, -{"name": "60m", "center_freq": 5350000, "sample_rate": 256000}, -{"name": "80m", "center_freq": 3650000, "sample_rate": 384000}, -{"name": "160m", "center_freq": 1900000, "sample_rate": 384000}]}]} +# https://prometheus.io/docs/instrumenting/exposition_formats/ +openwebrx_users 2 +wsjt_decodes_40m_FT8_total 40484 +wsjt_decodes_40m_FT4_total 1637 +wsjt_decodes_40m_WSPR_total 170 +wsjt_decodes_20m_FT8_total 385 +wsjt_decodes_20m_FT8_total 21 +aprs_decodes_2m_aprs_total_total 364 +aprs_decodes_2m_aprs_direct_total 123 ``` -## http://your-url/ip:8073/api/features +Endpoint: `/metrics.json` (Generic JSON format) -An overview over all features and their availability could be find at, it also include the necessary software components for that: +``` +{ + "openwebrx": { + "users": 2 + }, + "aprs": { + "decodes": { + "2m": { + "aprs": { + "total": { + "count": 364 + }, + "direct": { + "count": 123 + } + } + } + } + }, + "wsjt": { + "decodes": { + "40m": { + "FT8": { + "count": 40484 + }, + "FT4": { + "count": 1637 + }, + "WSPR": { + "count": 170 + } + }, + "20m": { + "FT8": { + "count": 385 + }, + "FT4": { + "count": 21 + } + } + } + } +} +``` -http://your-url/ip:8073/features
-http://your-url/ip:8073/api/features \ No newline at end of file +## Receiver status + +Endpoint: `/status.json` + +``` +{ + "receiver": { + "name": "CALL", + "admin": "email", + "gps": { + "lat": 0.0, + "lon": 0.0 + }, + "asl": 200, + "location": "City, Country" + }, + "max_clients": 20, + "version": "v0.20.3", + "sdrs": [ + { + "name": "RTL-SDR USB Stick", + "type": "RtlSdrSoapySource", + "profiles": [ + { + "name": "2m komplett", + "center_freq": 145000000, + "sample_rate": 2400000 + }, + [...] + ] + }, + { + "name": "Hack RF", + "type": "HackrfSource", + "profiles": [ + { + "name": "10m", + "center_freq": 28800000, + "sample_rate": 384000 + }, + [...] + ] + } + ] +} +``` + +## Feature detection API + +Endpoint: `api/features` + +An overview over all features and their availability, also including the necessary software components for them.