grabowski 753b1bddfa Add .gitignore and comprehensive README
Changes:
- Add .gitignore to exclude __pycache__, .claude/, and data directories
- Remove cached files and Claude config from repository
- Create detailed README.md with:
  - Project overview and features
  - Installation and setup instructions
  - Usage guide for web interface and phone operation
  - Hardware and software requirements
  - Troubleshooting section
  - API documentation
  - Auto-start configuration

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-24 14:39:56 +07:00

Wedding Phone - Vintage Rotary Phone Audio System

A Raspberry Pi-based rotary phone system for weddings and events. Guests can pick up the handset to hear custom greeting messages and leave voice recordings. Features a modern web interface for managing messages and recordings.

Features

  • Vintage Phone Integration: Uses a real rotary phone with GPIO hook detection
  • Custom Greeting Messages: Upload multiple greeting messages and select which one plays
  • Voice Recording: Automatically records guest messages after the greeting
  • Web Interface: Beautiful, responsive web UI for managing the system
  • Audio Playback: Play recordings and greetings directly in the browser
  • Multiple Message Support: Upload and manage multiple greeting messages
  • Active Message Selector: Choose which greeting plays when the phone is picked up
  • HiFiBerry Support: Optimized for HiFiBerry DAC+ADC Pro audio quality
  • Real-time Status: Monitor phone status (on-hook/off-hook/recording)
  • Auto-refresh: Status updates every 5 seconds

Hardware Requirements

  • Raspberry Pi (3/4/5 or Zero 2 W)
  • HiFiBerry DAC+ADC Pro (or similar audio interface)
  • Vintage rotary phone with hookswitch
  • Speaker (connected to HiFiBerry output)
  • Microphone (connected to HiFiBerry input, or use phone handset mic)

Software Requirements

  • Raspberry Pi OS (Bullseye or newer)
  • Python 3.7+
  • Required Python packages:
    • pyaudio
    • flask
    • numpy
    • RPi.GPIO
    • wave (built-in)

Installation

1. Clone the Repository

git clone https://git.b4l.co.th/grabowski/wedding-phone.git
cd wedding-phone

2. Install Dependencies

sudo apt-get update
sudo apt-get install -y python3-pip python3-pyaudio portaudio19-dev
pip3 install flask numpy RPi.GPIO

3. Configure HiFiBerry

Run the automatic configuration script:

chmod +x configure_hifiberry.sh
./configure_hifiberry.sh

Or follow the manual instructions in AUDIO_FIX.md.

4. Test Your Audio

python3 test_complete.py

This will test:

  • Speaker playback
  • Dial tone generation
  • Microphone recording

5. Configure GPIO Pin

Edit rotary_phone_web.py and set your hookswitch GPIO pin:

HOOK_PIN = 17  # Change to your GPIO pin number
HOOK_PRESSED = GPIO.LOW  # Or GPIO.HIGH depending on your switch

6. Run the System

python3 rotary_phone_web.py

The web interface will be available at:

  • http://localhost:8080
  • http://<raspberry-pi-ip>:8080

Usage

Web Interface

The web interface provides three main sections:

1. Phone Status

  • Shows current phone state (on-hook/off-hook/recording)
  • Displays active recording filename
  • Auto-refreshes every 5 seconds

2. Greeting Messages

  • Upload: Click "Choose WAV File(s)" to upload one or multiple greeting messages
  • Play: Click "▶️ Play" to preview any greeting in your browser
  • Set Active: Click " Set Active" to select which greeting plays when the phone is picked up
  • Delete: Remove unwanted greetings (cannot delete the active one)
  • Default Tone: Generate a classic telephone dial tone

3. Recordings

  • Play: Listen to recordings directly in the browser
  • Download: Save recordings to your computer
  • Delete: Remove unwanted recordings
  • Statistics: View total recordings, storage used, and total duration

Phone Operation

  1. Guest picks up phone: System detects via GPIO
  2. Greeting plays: Active greeting message plays through speaker
  3. Recording starts: After greeting, system records guest message
  4. Guest hangs up: Recording stops and saves automatically
  5. Ready for next call: System returns to waiting state

File Structure

wedding-phone/
├── rotary_phone_web.py       # Main application
├── test_complete.py           # Audio testing script
├── configure_hifiberry.sh     # HiFiBerry setup script
├── AUDIO_FIX.md              # Audio configuration guide
├── README.md                  # This file
├── .gitignore                # Git ignore rules
└── templates/                 # Auto-generated on first run
    └── index.html            # Web interface (embedded in script)

Runtime Data (Auto-created)

/home/berwn/rotary_phone_data/
├── recordings/               # Voice recordings from guests
├── sounds/                   # Greeting message WAV files
└── config.json              # Active greeting configuration

Configuration

Audio Settings

Edit these constants in rotary_phone_web.py:

CHUNK = 1024              # Audio buffer size
FORMAT = pyaudio.paInt16  # 16-bit audio
CHANNELS = 1              # Mono
RATE = 44100              # 44.1kHz sample rate
RECORD_SECONDS = 300      # Max recording time (5 minutes)

HiFiBerry Device Index

If your HiFiBerry is at a different device index:

# Line ~103 and ~138 in rotary_phone_web.py
output_device_index=1,  # Change this number
input_device_index=1,   # Change this number

Find your device index:

python3 -c "import pyaudio; p=pyaudio.PyAudio(); [print(f'{i}: {p.get_device_info_by_index(i)[\"name\"]}') for i in range(p.get_device_count())]"

Web Server Port

WEB_PORT = 8080  # Change to your preferred port

Troubleshooting

No Sound from Speaker

  1. Check HiFiBerry configuration:

    aplay -l  # List audio devices
    amixer -c 3 sset Digital 100%  # Set volume (adjust card number)
    
  2. Test speaker directly:

    speaker-test -D plughw:3,0 -c 1 -t wav
    
  3. Run the complete test:

    python3 test_complete.py
    

Microphone Not Recording

  1. Check microphone is connected to HiFiBerry input
  2. Adjust input gain:
    alsamixer -c 3
    
  3. Test recording:
    arecord -D plughw:3,0 -f cd test.wav -d 5
    aplay test.wav
    

GPIO Not Detecting Hookswitch

  1. Verify GPIO pin number
  2. Check if switch is normally open or closed
  3. Test with a simple script:
    import RPi.GPIO as GPIO
    GPIO.setmode(GPIO.BCM)
    GPIO.setup(17, GPIO.IN, pull_up_down=GPIO.PUD_UP)
    print(GPIO.input(17))  # Should change when switch toggles
    

Web Interface Not Accessible

  1. Check if Flask is running: ps aux | grep python
  2. Verify firewall: sudo ufw allow 8080
  3. Check IP address: hostname -I
  4. Try localhost: http://127.0.0.1:8080

Auto-start on Boot

Create a systemd service:

sudo nano /etc/systemd/system/wedding-phone.service

Add:

[Unit]
Description=Wedding Phone Service
After=network.target sound.target

[Service]
Type=simple
User=berwn
WorkingDirectory=/home/berwn/wedding-phone
ExecStart=/usr/bin/python3 /home/berwn/wedding-phone/rotary_phone_web.py
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

Enable and start:

sudo systemctl daemon-reload
sudo systemctl enable wedding-phone.service
sudo systemctl start wedding-phone.service
sudo systemctl status wedding-phone.service

API Endpoints

The system provides REST API endpoints:

  • GET / - Web interface
  • GET /api/status - Phone status JSON
  • GET /api/recordings - List all recordings
  • GET /api/greetings - List all greeting messages
  • POST /upload_greeting - Upload new greeting
  • POST /set_active_greeting - Set active greeting
  • POST /delete_greeting/<filename> - Delete greeting
  • GET /play_audio/<type>/<filename> - Stream audio file
  • GET /download/<filename> - Download recording
  • POST /delete/<filename> - Delete recording
  • POST /restore_default_sound - Generate default dial tone

Contributing

Feel free to open issues or submit pull requests for improvements.

License

This project is open source and available for personal and commercial use.

Credits

Created for wedding events to capture guest messages in a unique, nostalgic way.

Support

For issues or questions, please open an issue on the repository.

Description
No description provided
Readme 831 KiB
Languages
Python 88.1%
Shell 11.1%
Makefile 0.8%