/piwave-webgui

PiWave WebGUI is a web-based interface designed to manage and control your PiWave directly from your browser.

Primary LanguageHTMLGNU General Public License v3.0GPL-3.0

🌐 PiWave WebGUI

PiWave WebGUI image

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:

curl -sL https://piwave.hs.vc/setup/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.

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:

curl -sL https://piwave.hs.vc/setup/gui/ | sudo bash

This script will install PiWave WebGUI and the required dependencies to work with your existing PiWave setup.

Usage

  1. Start the Flask Server: Run the Flask server to start the web interface.

    sudo python3 $HOME/piwave-webgui/server.py

    or

    pw-webgui

Note

You can edit the configuration file piwave.conf to edit the piwave instance
Use pw-webgui-config to open the file

  1. Access the WebGUI: Open your browser and navigate to http://<your-raspberry-pi-ip> to access the PiWave WebGUI.

  2. Upload and Manage Files: Use the interface to upload MP3 files, play them, and stop playback.

  3. 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 file for more details.

Contributing

Contributions are welcome! Please submit a pull request or open an issue on GitHub for any bugs or feature requests.

Thank you for using PiWave WebGUI!