✨ Blackcap Feature Catalog
Audience: User, Org Admin, System Admin, Deployment Administrator, Developer, Support
Related: Blackcap Overview · Documentation Index · Platform Stacks and Raspberry Pi Hardware
This catalog is the maintained, categorized list of currently implemented Blackcap capabilities. It replaces the historical practice of keeping a very long feature list inside the root README.md. The README remains a high-level introduction and links here for full coverage.
A feature is listed as available only when the current repository contains the routes, services, persistence, templates, or deployment support needed to use it. Experimental behavior and future ideas are labeled explicitly in their owning feature documents rather than presented here as generally available.
🍽️ Recipe management
- Recipe Library with organization-scoped recipes, search, filtering, sorting, status, ratings, archive, restore, dependency-aware deletion, and mass actions.
- Normal URL recipe import using deterministic structured data and page parsing first, with browser rendering for supported slow or JavaScript-heavy sites.
- Social recipe import for supported YouTube, TikTok, Instagram, Facebook Reel, and Pinterest URL forms, including normal URL submission and extension-assisted evidence capture.
- Manual recipe entry from Admin and Mobile.
- Photo and screenshot capture with OCR-assisted extraction.
- QR-code URL capture on supported Mobile/browser environments.
- Chrome Extension Capture Page for reviewing page evidence before recipe submission, plus Quick Add URL import.
- AI-assisted social recipe review when an appropriate provider, use case, profile, and Seed balance are configured.
- AI recipe image generation with configured OpenAI or Gemini provider families and quality profiles.
- Recipe editing for title, description, ingredients, directions, metadata, notes, layout, and supported recipe fields.
- Preferred Recipe Units presentation without destructively replacing the source recipe text.
- Recipe cache generation for PDFs, preview PNGs, display-ready renders, thumbnails, editable-content artifacts, and provider/display-specific outputs.
- Safe source refresh that distinguishes fresh-source capture from rebuilding from existing edited content.
- Recipe metadata including time, difficulty, people served, cleanup, nutrition where available, source, and configurable display pills.
- Recipe ratings and Made It feedback, including managed Made It photos and notes.
- Recipe sharing through email-ready PDFs and tokenized Blackcap-to-Blackcap share links.
- Recipe Discovery and ingredient-oriented search using normalized ingredient data and configured search behavior.
- Ingredient canonical management and duplicate canonical merging through Database Admin.
📅 Meal planning
- Meal Planner in Admin and Mobile.
- Configurable week-start day, meal slots, optional slot times, and organization time zone.
- Multiple recipes and manual meal items in a slot.
- Recipe multipliers and people-served planning.
- Week and month views, drag/drop or move actions, and Review Plan.
- Today, Tomorrow, selected-day, week, and month shopping-list source selection.
- Meal-plan PDF and email output.
- Day, Week, Today & Tomorrow, Current Meal Plan, and Monthly display rendering where supported.
- Scheduled display refresh behavior for current meal-plan content.
🛒 Shopping Lists
- Recipe Cart for collecting recipes before list generation.
- Shopping-list generation from recipes, the Recipe Cart, Meal Planner ranges, selected meal items, or manual items.
- Ingredient scaling, consolidation, normalization, department assignment, and provenance back to recipes or manual sources.
- Active, completed, archived/deleted, printable, and restorable list states according to retention policy.
- Edit Shopping List with recipe multipliers, manual-item editing, ingredient preview, and controlled rebuild behavior.
- Shop a List in Admin and Mobile with department, recipe, or flat grouping; collapsible groups; quick manual items; undo; and completion handling.
- Rapid checkoff persistence designed to survive refreshes and multiple browser actions.
- Household List, a persistent organization list that is not completed or archived like an event shopping list.
- Household item pinning, ignore behavior for imported external items, and optional inclusion in Admin or Mobile Shop a List.
- External Shopping List browser bridge for configured Google Keep and Amazon/Alexa web-list connections.
- External-list import, source attribution, last-sync status, failure visibility, and controlled provider check-off.
- Shop With assisted shopping through the Chrome Extension for configured retailer/provider sites.
- Provider-aware shopping performance and job visibility.
🧺 Kitchen Inventory
- Kitchen Inventory as a primary organization-scoped feature, separate from Shopping Lists and Meal Planner.
- On-hand and not-on-hand tracking through Have It behavior.
- Canonical item identity, grocery department, storage location, quantity/details, and organization uniqueness rules.
- Filtering shopping workflows against items already on hand.
- Default and organization-managed storage locations.
- Recently Deleted/archived inventory items, restore, and retention-based permanent cleanup.
- Database Admin reconciliation for duplicate identity, departments, locations, and inactive records.
🖥️ Displays and content delivery
- Display types: Local E-Ink, Hosted Web Receiver, Kiosk, Remote Pi Client, and Mock.
- Organization-scoped display records, capabilities, render profiles, resolution, orientation, status, preview, and default display.
- Immediate and scheduled Assign Content workflows.
- Content modes including Menu, Recipe, meal-plan views, Today & Tomorrow, Monthly Meal Plan, Let’s Cook, Return to Default, and Client where supported.
- Durable current/default assignments, scheduled start/end windows, activation state, and Return to Default.
- Hosted receiver and kiosk token/authenticated access modes.
- Display status, last poll, last preview, physical update, and country/IP access breadth.
- Menu source capture, lightweight source probing, grouped render fan-out, and change-aware updates.
- Noun Project footer rules, organization placement, icon caching, and use on Menu and Meal Plan output.
- Display-aware recipe, meal-plan, Menu, and Let’s Cook rendering.
- Shared scheduler and physical-panel locking to prevent overlapping e-ink work.
🥧 Raspberry Pi and e-ink
- Raspberry Pi full-server deployment with SQLite by default.
- Raspberry Pi server with an attached Waveshare 13.3-inch Type K panel.
- Raspberry Pi acting as a Remote Pi Client for another Blackcap server.
- Combined Pi server/client behavior where the local server remains available while the panel is in Client mode.
- Exact 960×680 four-level grayscale rendering for the supported Type K profile.
- Server-prepared controller-plane transport, PNG compatibility path, validation, atomic last-known-good installation, and physical acknowledgements.
- Let’s Cook local and remote-client refresh watchers with deployment-controlled cadence.
- Monthly e-ink deep-clean scheduling where an attached panel is enabled.
- Conservative e-ink visual rules, including black 1 px lines and light gray only for sufficiently large filled regions.
🧑🍳 Let’s Cook
- Guided cooking sessions from recipe content.
- Preparation/mise-en-place, ingredients, directions, and progress tracking.
- Previous/next step, ingredient completion, current-step focus, and one-step display options where supported.
- Timers with start, pause, resume, stop, cancel, and bounded minute adjustments.
- Admin, Mobile, Hosted/Kiosk, Local E-Ink, and Remote Pi Client delivery according to display capability.
- Voice assistant commands for supported session, step, and timer actions.
- Session history and detailed operational state with separate retention periods.
- Completion/cancellation and restoration of display default content.
🧩 Chrome Extension
- User-owned API Token authentication and Active Organization selection.
- Capture Page recipe review/edit flow.
- Quick Add URL import.
- Supported social evidence capture and source submission.
- Shop With provider/site detection, list selection, assisted item queue, skip/Got It/Already Have It behavior, and completion handoff.
- Household/External Shopping List browser bridge for attended import and provider check-off.
- Extension release, privacy, permission, packaging, and Chrome Web Store documentation.
🤖 AI
- OpenAI and Gemini provider families through provider adapters.
- Platform provider connections and capability declarations.
- Registered AI use cases and quality/intelligence profiles.
- AI Seeds as the Blackcap product currency, distinct from API Tokens.
- Platform and organization allotments, reservations, usage events, provider-reported tokens, and reporting.
- Organization AI Seeds and global personal AI Seeds according to current entitlement rules.
- Social recipe enhancement and recipe image generation use cases.
- Generated candidate assets, saved assets, cleanup, and retention policy.
- AI diagnostics, usage views, provider tests, and regression coverage.
🔐 Users, organizations, and security
- Internal/password login, invitations, password reset, and account management.
- External authentication-provider foundation and organization enablement.
- TOTP MFA, recovery codes, trusted-browser tokens, and organization MFA policy.
- System Admin, Org Admin, Data Admin, contributor/operator, and ordinary-user permission behavior.
- Active Organization context, Default Organization, organization switching, and cross-organization restrictions.
- User-owned named API Tokens with show-once secret, revocation, access attribution, and retention.
- Organization lifecycle, ownership transfer, closeout status, and controlled purge foundation.
- Diagnostic clones for isolated support/regression reproduction without changing the source organization.
- CSRF protection, safe external fetch behavior, request validation, secret encryption/masking, and activity auditing.
⚙️ Configuration and integrations
- Unified Configuration workspace with Platform and Organization scopes, search, lazy-loaded groups, permission-aware visibility, and audit history.
- Platform configuration for security, runtime, database diagnostics, email, providers, authentication providers, AI, social imports, recipe discovery, GeoIP, country flags, purge, Performance, Support Requests, voice assistants, and Shop With providers.
- Organization configuration for Menu, general rendering, Noun Project footer, recipe rendering, recipe information, sharing, Meal Planner, Household List, backups, Let’s Cook, and login providers.
- Display-specific configuration on Display Details rather than in the general Configuration workspace.
- SMTP branded email with plain-text alternatives.
- Dropbox and Google Drive backup integrations.
- Alexa Custom Skill, Alexa Smart Home, and Google Home integrations.
- Shop With provider configuration and external household-list browser connections.
🛠️ Administration and operations
- Home dashboard and Stats for Geeks.
- Users, Organization, Organizations, Security, Activity, and Configuration pages.
- Database Admin with provider-aware resource exploration, data problems, maintenance, schema export, saved queries, SQL Console safeguards, and parity diagnostics.
- Data Cleanup with manual dry-run/real-run workflow and scheduled domain-aware retention.
- Job Status for queued, running, stale, failed, retryable, reviewed, ignored, and stoppable background work.
- Performance for metrics, trends, graphs, slow requests, resource snapshots, display/render phases, backup/email/purge/external-list timing, and regression comparison.
- Regression Tests with immediate, scheduled, resumable, leave-open, cleanup, diagnostic-clone, role, integration-smoke, and code/schema verification options.
- API Tester and Postman export using the registered API inventory.
- Support Request submission with generated case numbers, safe diagnostic context, email delivery, and audit history when configured.
- Instance reporting with privacy-conscious deployment and lifecycle metadata.
- Activity/audit logging, login history, display access breadth, API Token activity, and voice access tracking.
- GeoIP local-country lookup and optional public flag indicators for login and display troubleshooting.
☁️ Backup, maintenance, and scheduled operations
- Local, Dropbox, and Google Drive backup destinations.
- SQLite database backup on Pi; PostgreSQL/Cloud SQL backup boundary on GCP.
- Organization/full/platform backup scopes according to current permissions and provider behavior.
- Restore staging, validation, rollback safety, and cache reconstruction.
- Automatic backup schedules and retention.
- Database migrations before Gunicorn startup.
- Managed
/etc/cron.d/blackcaptasks for display refresh, regression continuation, data purge, backup scheduling, Menu refresh, and enabled panel maintenance. - systemd services for Gunicorn, Cloud SQL Auth Proxy, remote client polling, Let’s Cook watchers, and GeoIP updates where applicable.
- Documentation, migration, direct-SQL, schema, and regression validation tools.
🎮 Games
- Organization-aware berry trivia.
- Cooking-terms trivia.
- Admin configuration and user play surfaces where enabled.
🧱 Platform support summary
Blackcap supports two primary server deployment paths:
- Raspberry Pi: local server, SQLite by default, optional attached e-ink, stunnel TLS, Pi hardware packages, and optional Remote Pi Client behavior.
- GCP: Compute Engine application host, Cloud SQL PostgreSQL, Cloud SQL Auth Proxy, Nginx, managed HTTPS certificates, cloud/server Python requirements, and remote/browser display delivery.
See Platform Stacks and Raspberry Pi Hardware for the maintained stack and hardware breakdown.