Croom Documentation
Overview
Welcome to the Croom documentation. This documentation covers the enhanced version of Croom, designed to be an enterprise-grade video conferencing solution comparable to Cisco Webex Room Kit at a fraction of the cost.
Quick Links
For Users
- User Guide - How to use Croom in meeting rooms
For Administrators
- Administrator Guide - Managing Croom devices
- Deployment Guide - Setting up Croom
For Developers/Product
- Enterprise Roadmap - Product vision and phases
- Feature Index - All features with status
Product Requirements
- PRD-001: Management Dashboard
- PRD-002: Multi-Platform Support
- PRD-003: Device Provisioning
- PRD-004: Security & Compliance
- PRD-005: Touch Screen Room UI - Local management interface
- PRD-006: Edge AI Features - AI for Raspberry Pi hardware
- PRD-007: Modern Installation - Non-destructive install on existing OS
Document Structure
docs/
├── README.md # This file
├── roadmap/
│ ├── enterprise-roadmap.md # Vision and phases
│ ├── feature-index.md # Feature tracking
│ ├── upstream-contributions.md # Upstream PR/issue tracking
│ └── dashboard-implementation.md # Technical architecture
├── prd/
│ ├── 001-management-dashboard.md
│ ├── 002-multi-platform-support.md
│ ├── 003-device-provisioning.md
│ ├── 004-security-compliance.md
│ ├── 005-touch-screen-room-ui.md # Local touch interface
│ ├── 006-edge-ai-features.md # AI on Pi hardware
│ └── 007-modern-installation.md # Non-destructive install
└── guides/
├── user-guide.md # End user documentation
├── administrator-guide.md # IT admin documentation
└── deployment-guide.md # Setup and rollout guide
Project Vision
Goal
Transform Croom from a simple conference room automation tool into an enterprise-grade video conferencing solution that:
- Installs on existing Raspberry Pi OS without reformatting
- Supports modern OS versions (Bookworm, Trixie)
- Provides local touch screen management UI for room control
- Features edge AI processing for auto-framing and noise reduction
- Supports multiple meeting platforms (Google Meet, Teams, Zoom, Webex)
- Provides centralized fleet management
- Meets enterprise security requirements
- Scales to hundreds of devices
- Costs <$250 per room (with AI) vs $3,000-15,000 for Cisco
Target Users
- End Users: Meeting room participants
- Room Administrators: Local room management via touch UI
- IT Administrators: Device and fleet managers
- Facilities Managers: Room utilization tracking
Competitive Position
| Feature | Cisco Room Kit | Croom | |———|—————|——————-| | Hardware Cost | $3,000-15,000 | <$250 (with AI) | | Multi-Platform | Yes | Yes (Phase 1) | | Central Management | Control Hub | Dashboard (Phase 1) | | Local Touch UI | Yes | Yes (Phase 1) | | AI Features | Yes | Yes (Phase 2) | | Non-Destructive Install | N/A | Yes (Phase 1) | | Monthly Fee | $15/device | Free (open source) |
Roadmap Summary
Phase 1: Modern Foundation (Current)
- Modern Installation System - apt packages, non-destructive install
- Touch Screen Room UI - Local management interface
- Management Dashboard MVP
- Multi-platform support (Teams, Zoom)
- Zero-touch device provisioning
- Bookworm/Trixie OS support
Phase 2: Enterprise & AI
- Edge AI Features - Auto-framing, noise reduction, speaker detection
- Advanced monitoring & analytics
- Remote troubleshooting
- Security hardening
- Wireless content sharing
Phase 3: Advanced Features
- PTZ speaker tracking
- Voice control
- Room booking integration
- Digital signage mode
Phase 4: Scale & Polish
- High availability
- Multi-tenant support
- Mobile applications
Getting Started
New to Croom?
- Read the Project Overview
- Review the Enterprise Roadmap
- Check the Deployment Guide
Setting Up Development?
- Clone the repository
- Review the codebase structure
- Check Feature Index for current priorities
Contributing?
- Review Upstream Contributions
- Check open issues in GitHub
- Follow contribution guidelines
Version Information
| Document | Version | Last Updated |
|---|---|---|
| Documentation | 1.0.0 | 2025-12-15 |
Contact
- Issues: GitHub Issues
- Support: [email protected]