merbanan / rtl_433

Program to decode radio transmissions from devices on the ISM bands (and other frequencies)
GNU General Public License v2.0
6.08k stars 1.31k forks source link

Add documentation for `-F http` rxui web user-interface on port `localhost:8443` #3022

Open norpol opened 2 months ago

norpol commented 2 months ago

I knew it's possible to start rtl_433 with a web-ui. Neither README.md, man rtl_433, rtl_433 -h or rtl_433 -F help will tell me about how to start with a web-server, which is rtl_433 -F http.

Is there any particular reason why I can't find documentation on that feature?

zuckschwerdt commented 2 months ago

There wasn't too much interest in the HTTP API or the web UI so far. It's experimental, not well tested and features are missing. Happy to change that though! Did it work well for you?

norpol commented 2 months ago

Hi. To me it was a very valuable addition, it makes navigating results much easier than just on the console.

Some parts are a bit confusing, like

Besides all of this, I think it is quite useful already - gives me a good idea of what signals are in my area and whether there would be a benefit for setting up a Prometheus exporter for example.

Thank you

zuckschwerdt commented 2 months ago

Thanks for the detailed report! Good pointers for a cleanup.