jks-prv / Beagle_SDR_GPS

KiwiSDR: BeagleBone web-accessible shortwave receiver and software-defined GPS (archived)
http://kiwisdr.com
484 stars 161 forks source link

Status JSON endpoint for Telegraph plugin #132

Open hb9fxq opened 7 years ago

hb9fxq commented 7 years ago

This is an enhancement / extension idea, not a bug.

I've setup a small dashboard for our remote QTH: https://dashboard.superlogical.ch/dashboard/db/technikraum-dashboard?orgId=1&from=now-24h&to=now&refresh=30s

Currently parsing the http://kiwiurl/status page to query the number of connected users

dashboard_fxq

Now I'd like to have a compact json endpoint summary of the Kiwi status to write a custom telegraph plugin like described e.g. here: https://nessy.info/?p=903

Requirements:

Basically enything in that box: kiwi_stat

jks-prv commented 7 years ago

Good idea. The current format of /status is because that's what's needed by sdr.hu Then other projects like http://rx.linkfanel.net/ and http://ve3sun.com/KiwiSDR/index.php began using it. And I use it for maintaining the sdr.hu backup site http://kiwisdr.com/public No reason not to add a separate JSON interface which will be easier to use for a lot of frameworks.

GeoNomad commented 7 years ago

A JSON interface would be useful.

Related, it would be nice if all the Kiwis could have a callsign type ID. Non-hams could make up a short identifier. The current "name" becomes more like a comment field and it would be good to identify receivers on saved waterfall images with a short ID like a callsign or anything 10 characters max. I know there is a hex ID now, but that is not very memorable :)

jks-prv commented 7 years ago

Non-hams who want to register on sdr.hu (which asks for a call when registering for some reason) or want to allow WSPR uploads have been using the convention of SWL. E.g. SWLRF82CI.

I could add a callsign field to the sdr.hu tab on the admin page instead of it only appearing in the WSPR reporter callsign field.

OH1KK commented 5 years ago

json interface should also be able to communicate with extensions. Like

my.kiwisdr.example/json?ext=ant_switch

Json would return status on currently selected antennas.

{
  "extension":"ant_switch",
  "backendfailed": false,
  "denymixing": false,
  "denyswitching": false,
  "currently_selected": [ 1,4 ],
  "available": [
    { "antenna": 1, "description": "Wimo GPM-1500 vertical" },
    { "antenna": 2, "description": "100m wire 10m agl" },
    { "antenna": 3, "description": "RA0SMS mini-whip" },
    { "antenna": 4, "description": "50 ohm dummy load" },
    { "antenna": 5, "description": "Sheet metal rooftop" }
  ]
 }

If json would be birectional, it would be possible to also select antennas using json. This would make possible to build hardware antenna switch controller that shows current antenna status and allows selecting antennas. It could be even some physical arduino box with buttons, leds and lcd.

doccodyblue commented 2 years ago

This one is from 2019 so I may ask ;) Is there already a way to get the frequency and the user of RX0 to RXn?

I'd like to track my users to find out which frequency range is used the most and where I could maybe improve reception. I could parse the log on a regular base but picking up the data from a (already implemented) JSON would be much more efficient.

Maybe this info could be added to /status?

jks-prv commented 2 years ago

Use /status (local network access only for security reasons). Discussed here.

doccodyblue commented 2 years ago

Exactly what I was looking for.

Thanks for the quick answer.