You've already forked fm-dx-webserver
mirror of
https://github.com/KubaPro010/fm-dx-webserver.git
synced 2026-02-27 06:23:53 +01:00
68 lines
2.1 KiB
Markdown
68 lines
2.1 KiB
Markdown
# FM-DX Webserver 📻🌐
|
|
|
|
FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their TEF6686 / F1HD receiver through a web interface.
|
|
|
|
## Features
|
|
|
|
- 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser.
|
|
- 📻 **FM DXing:** Enhance your FM DXing experience with a user-friendly web interface.
|
|
|
|
## Features to be added
|
|
- **Tuner control:** Currently the tuner info is read only, however in the near future you will also be able to control via password authentication.
|
|
- **Cross-Platform:** Our main priority, as we use librdsparser, we are patiently waiting for a Windows version.
|
|
- **Low-latency streaming**: Currently planned as a feature similar to WebSDRs to provide a zero-delay audio using your browser.
|
|
- **Pre-compiled app version**: Currently planned right after finishing the low-latency streaming feature.
|
|
|
|
## Getting Started
|
|
|
|
1. Clone the repository:
|
|
|
|
```bash
|
|
git clone https://github.com/NoobishSVK/FM-DX-Webserver.git
|
|
```
|
|
|
|
2. Install dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
|
|
3. Update your config in index.js:
|
|
|
|
```js
|
|
const webServerHost = '192.168.1.39'; // IP of the web server
|
|
const webServerPort = 8080; // web server port
|
|
|
|
const xdrdServerHost = '192.168.1.15'; // xdrd server iP
|
|
const xdrdServerPort = 7373; // xdrd server port
|
|
|
|
```
|
|
|
|
|
|
4. Start the server:
|
|
|
|
```bash
|
|
node .
|
|
```
|
|
|
|
4. Open your web browser and navigate to `http://web-server-ip:web-server-port` to access the web interface.
|
|
|
|
## Dependencies
|
|
|
|
This project utilizes the [librdsparser](https://github.com/kkonradpl/librdsparser) library for RDS parsing. Make sure to check out the library for more information.
|
|
|
|
## Contributing
|
|
|
|
Feel free to contribute to the project by opening issues or submitting pull requests. Your input is valuable!
|
|
|
|
## License
|
|
|
|
This project is licensed under the [GNU-GPL v3 License](LICENSE.md).
|
|
|
|
## Acknowledgments
|
|
|
|
- Thanks to [librdsparser](https://github.com/kkonradpl/librdsparser) for providing the RDS parsing functionality.
|
|
|
|
Happy DXing! 🎶📡
|