Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/douxxu/piwave-webgui
PiWave WebGUI is a web-based interface designed to manage and control your PiWave directly from your browser.
https://github.com/douxxu/piwave-webgui
fm gui hijacking pifmrds piwave radio raspberry rpi web webgui
Last synced: 14 days ago
JSON representation
PiWave WebGUI is a web-based interface designed to manage and control your PiWave directly from your browser.
- Host: GitHub
- URL: https://github.com/douxxu/piwave-webgui
- Owner: douxxu
- License: gpl-3.0
- Created: 2024-09-04T19:06:31.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-12-18T18:17:45.000Z (about 1 month ago)
- Last Synced: 2024-12-18T18:37:50.706Z (about 1 month ago)
- Topics: fm, gui, hijacking, pifmrds, piwave, radio, raspberry, rpi, web, webgui
- Language: HTML
- Homepage: https://piwave.xyz/webgui/test
- Size: 99.6 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🌐 PiWave WebGUI
**PiWave WebGUI** is a web-based interface designed to manage and control your PiWave directly from your browser. It allows you to upload audio files, play, stop them, and view the current PiWave configuration through an easy-to-use interface.
## Features
- **Intuitive Web Interface**: Control your PiWave from a browser with an easy-to-use interface.
- **File Management**: Upload, play, and stop MP3 audio files.
- **Configuration Display**: View the current PiWave settings directly from the interface.
- **Notifications**: Receive real-time notifications for actions like file uploads and audio playback.
## Installation
> [!WARNING]
> **Warning**: Using PiWave involves broadcasting signals which may be subject to local regulations and laws. It is your responsibility to ensure that your use of PiWave complies with all applicable legal requirements and regulations in your area. Unauthorized use of broadcasting equipment may result in legal consequences, including fines or penalties.
>
> **Liability**: The author of PiWave is not responsible for any damage, loss, or legal issues that may arise from the use of this software. By using PiWave, you agree to accept all risks and liabilities associated with its operation and broadcasting capabilities.
>
> Please exercise caution and ensure you have the proper permissions and knowledge of the regulations before using PiWave for broadcasting purposes.
### Method 1: Full Install (with PiWave included)
For a complete installation of PiWave WebGUI with PiWave included, use the auto-install script:
```bash
curl -sL https://setup.piwave.xyz/gui/full/ | sudo bash
```
This script will install both PiWave WebGUI and PiWave, setting up the necessary dependencies and preparing your environment for immediate use.
>[!NOTE]
>To uninstall full webgui, do the following command:
>```bash
>curl -sL https://setup.piwave.xyz/gui/full/uninstall | sudo bash
>```
### Method 2: WebGUI Install (PiWave must already be installed)
If you already have PiWave installed and configured, you can install only PiWave WebGUI using the dedicated installation script:
```bash
curl -sL https://setup.piwave.xyz/gui/ | sudo bash
```
This script will install PiWave WebGUI and the required dependencies to work with your existing PiWave setup.
>[!NOTE]
>To uninstall full webgui, do the following command:
>```bash
>curl -sL https://setup.piwave.xyz/gui/uninstall | sudo bash
>```
## Usage
1. **Start the Flask Server**: Run the Flask server to start the web interface.
>[!NOTE]
>You must be running this as root user.
```bash
sudo python3 $HOME/piwave-webgui/server.py
```
or
```bash
pw-webgui
```
> [!NOTE]
> You can edit the configuration file `piwave.conf` to edit the piwave instance
> Use `pw-webgui-config` as root user to open the file
2. **Access the WebGUI**: Open your browser and navigate to `http://` to access the PiWave WebGUI.
3. **Upload and Manage Files**: Use the interface to upload MP3 files, play them, and stop playback.
4. **View Configuration**: Check the current PiWave configuration directly from the web interface.
## Requirements
- **PiWave**: Ensure PiWave is installed and configured if you are using the WebGUI installation method.
- **Flask**: Python web framework for the web interface.
- **ffmpeg**: Required for audio file processing.
## Error Handling
- **Configuration Errors**: Ensure `piwave.conf` exists and is correctly formatted.
- **Playback Issues**: Verify that your PiWave hardware is properly set up and connected.
## License
PiWave WebGUI is licensed under the GNU General Public License (GPL) v3.0. See the [LICENSE](LICENSE) file for more details.
## Contributing
Contributions are welcome! Please submit a pull request or open an issue on [GitHub](https://github.com/douxxu/piwave-webgui/issues) for any bugs or feature requests.
---
Thank you for using PiWave WebGUI!