kuba/fm-dx-webserver
1
0
Fork 0
mirror of https://github.com/KubaPro010/fm-dx-webserver.git synced 2026-02-26 22:13:53 +01:00
Code Issues Activity

readme update

Browse Source
This commit is contained in:
NoobishSVK
2024-03-21 22:50:46 +01:00
parent 8f4c96ce12
commit 39f0db35c2
1 changed files with 11 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,21 +1,24 @@
# FM-DX Webserver 📻🌐 # 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. FM-DX Webserver is a cross-platform web server designed for FM DXers who want to control their radio receiver through a web interface.
# Officially supported devices
- **TEF668x:** Supported with PE5PVB's and Konrad's FM-DX Tuner firmware, although Arduino versions with other firmwares will work too
- **XDR F1HD:** Officially supported, works best with Konrad's FM-DX Tuner firmware
- **SDR (AirSpy / RTL-SDR):** Supported unofficially via SDRSharp and XDR-GTK plugin
## Features ## Features
- **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser.
- 🌐 **Web-Based Control:** Access and control your TEF6686 / F1HD receiver from any device with a web browser. - **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface.
- 📻 **FM DXing:** Enhance your FM/AM DXing experience with a user-friendly web interface.
- **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd. - **Cross-Platform:** You can run this on both Windows and Linux servers along with xdrd.
- **Tuner control:** Control your FM tuner on the go. Phone? Tablet? No problem.
- **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users - **Low-latency streaming**: Built in directly into the webserver, no external apps needed for users
## Features to be added ## Features to be added
Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list Check [here](https://trello.com/b/OAKo7n0Q/fm-dx-webserver) for an up to date task list
## Community ## Community
Join our **Discord community** to get the latest development update info, share feedback and receive support. Join our **Discord community** to get the latest development update info, share feedback and receive support.
[<img alt="Join the TEF6686 Discord community!" src="https://i.imgur.com/lI9Tuxf.png" height="120">](https://discord.gg/ZAVNdS74mC) [<img alt="Join the OpenRadio Discord community!" src="https://i.imgur.com/lI9Tuxf.png" height="120">](https://discord.gg/ZAVNdS74mC)
## Getting Started ## Getting Started
@@ -24,23 +27,12 @@ Join our **Discord community** to get the latest development update info, share
https://nodejs.org/en https://nodejs.org/en
``` ```
1. Clone the repository (or alternatively download it manually): 2. Clone the repository (or alternatively download it manually):
```bash ```bash
git clone https://github.com/NoobishSVK/FM-DX-Webserver.git git clone https://github.com/NoobishSVK/FM-DX-Webserver.git
``` ```
2. Download or install ffmpeg (optional, but needed if you want the audio stream to work)
```bash
Linux (Ubuntu/Debian):
sudo apt install ffmpeg
Windows:
Download this file: https://www.gyan.dev/ffmpeg/builds/ffmpeg-git-essentials.7z
Extract the file bin/ffmpeg.exe into the fm-dx-webserver folder
```
3. Navigate to the fm-dx-webserver folder in your terminal/command prompt and run this command: 3. Navigate to the fm-dx-webserver folder in your terminal/command prompt and run this command:
```bash ```bash
npm install npm install