Django Micboard¶

Real-time wireless microphone monitoring for Django

Django Micboard is a Django application for real-time monitoring and management of Shure wireless microphone systems. It provides a modern web interface for tracking microphone status, battery levels, RF signals, and audio levels across your wireless systems.

Version: 25.10.17 (CalVer: YY.MM.DD) License: AGPL-3.0-or-later Python: 3.9+ Django: 4.2+/5.0+

Features¶

• 🎤 Real-time Monitoring - Live updates via WebSocket for battery, RF levels, and audio
• 🔌 Shure System API Integration - Full support for Shure wireless microphone systems
• 👥 User Assignments - Assign devices to users with location tracking
• 🚨 Smart Alerts - Configurable notifications for battery and RF issues
• 📊 Admin Dashboard - Visual oversight of devices and system health
• 🔒 Rate Limiting - Built-in API protection
• 🐳 Production Ready - Django 4.2+/5.0+ compatible

Quick Start¶

CRITICAL POLICY: All installation and environment management must use uv. Direct use of pip, venv, or poetry is strictly forbidden. If you encounter legacy instructions, escalate to maintainers. - Agents/developers: Use context7 for docs and gh_grep for code search. See README for escalation.

# Create and activate a uv virtual environment
uv venv .venv
source .venv/bin/activate

# Install django-micboard from PyPI
uv pip install django-micboard

# Add to Django settings
INSTALLED_APPS = [
    # ... other apps
    'channels',
    'micboard',
]

# Configure Shure API
MICBOARD_CONFIG = {
    'SHURE_API_BASE_URL': 'https://your-shure-system.local:10000',
    'SHURE_API_SHARED_KEY': 'your-shared-secret',
    'SHURE_API_VERIFY_SSL': True,
}

# Run migrations
python manage.py migrate

# Start monitoring
python manage.py poll_devices

Supported Systems¶

• Shure UHF-R, QLX-D, ULX-D, Axient Digital (AD), PSM1000 series
• Plugin architecture for additional manufacturers

Documentation¶

• Quick Start Guide - Get up and running quickly
• Configuration - All configuration options
• Multitenancy - Tenant-aware setup and behavior
• Shure Integration - Shure System API setup and usage
• API Reference - REST and WebSocket endpoints
• Architecture - System design overview
• Archive Index - Historical docs and delivery records

Requirements¶

• Python 3.9+
• Django 4.2+ or 5.0+
• Django Channels (for WebSocket support)
• Redis (recommended for production)

Support¶

• GitHub Issues: github.com/justprosound/django-micboard/issues

License¶

GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)

See LICENSE for full license text.