Skip to content

About

Star Trek-themed (LCARS) dashboard for Home Assistant

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

smartLCARS Icon

smartLCARS: 24th Century Smart Home Command

smartLCARS is a high-fidelity, Star Trek-inspired (LCARS) dashboard for Home Assistant. Built with Angular 21 and Electron 29, it transforms your smart home control into an authentic LCARS interface with a focus on tactile feedback, real-time data, and deep integration with the Home Assistant ecosystem.


🚀 Key Features

  • Modular "Main Operations" Dashboard: A customizable command center where you can pin critical devices and camera feeds for immediate access.
  • Dynamic Auto-Discovery: Automatically maps Home Assistant domains (Lights, Locks, Climate, Cameras) into interactive LCARS grids.
  • Tactical & Security: High-performance MJPEG camera monitoring with a "Main Viewer" modal for expanded live streams.
  • System Engineering: Real-time bridge for local hardware telemetry (CPU load, memory usage, uptime) when running in Electron.
  • Deck Sectors: Organize and filter devices by their Home Assistant Area (Room/Zone) for localized control.
  • Authentic LCARS UX: A strict flat-design aesthetic using the DS9/Cardassian hybrid palette, uppercase typography, and iconic sound effects.
  • Touch Optimized: Integrated virtual keyboard for credential entry and persistent storage for UI layout.

🎨 LCARS Design Philosophy

Following the strict guidelines of the 24th-century aesthetic:

  • Color Palette: Utilizes a specific SCSS-driven palette: Orange (#d17745), Purple (#8b728e), Tan (#cbb493), Red (#cc4444), and Gold (#c2a14e).
  • UI Structure: Pill-shaped buttons (border-radius: 50px), CSS Grid-based layouts, and a strict 8px gap protocol.
  • Typography: All text is uppercase, utilizing the Antonio or Swiss 911 Ultra Compressed typefaces.
  • Soundscape: Every interaction is accompanied by a library of LCARS-authentic chirps, pips, and an optional ambient ship hum.

🛠️ System Architecture

  • Frontend: Angular 21 with RxJS for reactive Home Assistant state management.
  • Desktop Layer: Electron 29 providing secure access to local system stats and environment configuration.
  • Security: Rigid use of preload.js and contextBridge for secure IPC communication. No nodeIntegration in the renderer.
  • Data Link: home-assistant-js-websocket for real-time entity updates and service calls.
  • Persistence: Local UI state and pinned entities are stored via localStorage.

🏁 Getting Started

Prerequisites

  • Node.js: v20+ (v20.20.0 recommended).
  • Home Assistant: Instance with a Long-Lived Access Token.

Installation

  1. Clone the Repository:
    git clone https://github.com/your-username/smartLCARS.git
    cd smartLCARS
  2. Install Dependencies:
    npm install
  3. Configure Environment: Create a .env file in the root directory for Desktop Mode:
    HA_URL=http://HAIPADDRESS:8123 
    HA_TOKEN=YOUR_LONG_LIVED_ACCESS_TOKEN

Running the App

  • Development Mode (Electron + Angular HMR):
    npm run start
  • Web Mode (Standard Browser):
    npx ng serve
    Note: In web mode, you will be prompted to enter HA credentials via the LCARS login terminal.

📦 Building & Deployment

Desktop Application

Packages the application into a native executable (Windows, macOS, or Linux) inside the release/ folder.

npm run build:desktop

Web Deployment

Generates optimized static files in dist/smartLCARS/.

npm run build:web

⚠️ Security Protocols

  • Sandbox Enabled: Electron windows run with full sandboxing enabled.
  • Context Isolation: Direct Node.js access is restricted; the frontend communicates with the OS via a secure electronAPI exposed in the preload script.
  • Credential Safety: Secrets are never hardcoded and are managed through .env (Desktop) or localStorage (Web).

📜 Credits & License

  • Author: Rob DuBoff
  • Inspiration: The iconic LCARS interface created by Michael Okuda for Star Trek.
  • License: This project is licensed under the PolyForm Noncommercial License 1.0.0. See the LICENSE file for details. This means you are free to use, modify, and share this code for personal or academic purposes, but commercial use is strictly prohibited.

About

Star Trek-themed (LCARS) dashboard for Home Assistant

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages