Skip to content

snootched/cb-lcars

Repository files navigation


Note:

This project is active development.

Functionality and configurations may change over time until stabilized. Things may break - so you may not want to use this on your primary dashboard just yet.


cb-lcars

A collection of custom cards for building LCARS styled dashboards in Home Assistant

release license last-commit


Overview

What is this?

This is a set of custom cards to build yourself an LCARS-inspired Home Assistant dashboard.

These cards are built upon custom-button-card with some enhancements to base function and internal template management.


  • Inspired by, and meant to be used side-by-side with the amazing ha-lcars-theme
  • Provides a (growing) library of elements found in LCARS interfaces like:
    • Buttons
    • Sliders/Guages
    • 'Elbows'
    • That d-pad thing
    • etc.
  • Designed with HA 'Sections' or other grid layouts in mind. YMMV with other layouts.
  • Collaborative - There are likely way better ways of doing some things - open to any and all suggestions, comments, etc.
  • WIP - learn, break, iterate (and probably break again.)

What it isn't...

  • This is not a standalone theme - it provides lovelace dashboard cards.
    The intention is to use ha-lcars-theme to provide the base theme styles, color variables, etc.
  • It is not a fully standalone set of components (at present.)
    For some controls you need to install other cards from HACS (all requirements listed below)
  • Professional work.
    As this is my first crack at an HA custom card - it's a WIP and as I learn, updates and optimaztions will be made. Hobbyist here, not a pro.
  • A complete set of bugless components to fit every use-case you can imagine. Maybe in the next-class starship :P

What can be done...

In no particular ordeer:

  • Customizable variables/settings for just about everything:
    • default colors / per-instance colors
    • colors based on entity state
    • font sizes/weights
    • text positions
    • full icon customization
    • gradients for sliders with automatice step and shade calculations
    • really too much to list - you can customize just about anything you like
  • Matching control colors to the light entity (buttons, sliders, gradients, etc.)
  • Additional 'flare' such as animating button presses, blinking buttons
  • Automatic 'random' button labels in LCARS style (hex numbers)
  • Optional: invocation of lovelace-hue-like-light-card popups for light and scene controls

Make it so!


πŸ’« tl;dr: Express Startup Sequence

  • Clear All Moorings and Open Starbase Doors
    • Install 'required' dependencies from HACS
  • Thrusters Ahead, Take Us Out
    • Setup HA-LCARS theme (notes below)
    • Add font (customized URL)
    • Add CB-LCARS custom style to HA-LCARS theme
  • Bring Warp Core Online, Engines to Full Power
    • Install CB-LCARS from HACS
    • Create CB-LCARS input helper(s)
  • Engage!

1. Dependencies and Extras

The following should be installed and working in your Home Assistant instance - these are available in HACS
Please follow the instructions in the respective project documentation for installation details.

Custom Card Required? Function
ha-lcars theme Required Provides base theme elements, styes, color variables, etc.
my-slider-v2 Required Provided slider function in Multimeter card.
lovelace-layout-card Required Used internally.

Also handy for the ultimate in dashboard layout customization!
lovelace-card-mod Required Not strictly needed for CB-LCARS, but is required by HA-LCARS theming at the time of writing.

Very useful for modifying the elements/styles of other cards to fit the theme (overriding fonts, colors, remove backgrounds etc.)
lovelace-hue-like-light-card Optional Provides ability to use a Hue-style light and scene control popup card over the native HA light controls.

2. HA-LCARS Theme - Setup and Customizations

Font

When setting up the font resource, we use a slightly updated Antonio font resouce string.
This includes weights 100-700 allowing for more fine-grained control of the text as seen in Picard (some displays use really thin font, 100 or 200)

Simply substitute the following resource string when setting up ha-lcars: https://fonts.googleapis.com/css2?family=Antonio:wght@100..700&display=swap

Customized CB-LCARS Color Scheme

Ideally, add this cb-lcars version theme into your HA-LCARS. If not, the color definitions will be made available to use anyway.

Copy the custom LCARS Picard [cb-lcars] definition from cb-lcars-lcars.yaml to your HA-LCARS lcars.yaml file in Home Assistant (per instructions for adding custom themes to HA-LCARS).

Set LCARS Picard [cb-lcars] as the active theme.

Picard [cb-lcars] Grays, Blues, and Oranges are the core colours. Greens and Yellows added for additional options.

Picard theme

These are the colors used for the ha-lcars defined variables.

Picard ha-lcars


3. Install CB-LCARS from HACS

  1. Add CB-LCARS git repository as a custom repo in HACS.
  2. Install CB-LCARS from HACS like any other project.

3a. Create Input Helpers

Create the following input helpers in your Home Asstant.
Names are configurable, but Entity ID is required to match.

Click on the Entity ID in the table to launch the add helper dialog in your Home Assistant.

Name Entity ID Type Values
ALERT CONDITION input_select.lcars_ui_alert_condition Dropdown (input select) GREEN
RED
YELLOW
BLUE
BLACK
GRAY

4. Engage!

Add CB-LCARS cards to your dashboard just like any other card.



CB-LCARS Cards

For referenct - these are the cards found in CB-LCARS. They are highly configurable - and some default styles are shown.

Additional style possibilities can be found in the screenshots section.

Settings are available in the UI editor.


LCARS Elbows

type: custom:cb-lcars-elbow-card

cblcars_card_type: Default Style
cb-lcars-header cb-lcars-header
cb-lcars-header-right cb-lcars-header-right
cb-lcars-header-contained cb-lcars-header-contained
cb-lcars-header-open cb-lcars-header-open
cblcars_card_type: Default Style
cb-lcars-footer cb-lcars-footer
cb-lcars-footer-right cb-lcars-footer-right
cb-lcars-footer-contained cb-lcars-footer-contained
cb-lcars-footer-open cb-lcars-footer-open
cblcars_card_type: Default Style
cb-lcars-header-callout cb-lcars-header-callout
cb-lcars-header-callout-right cb-lcars-header-callout-right
cb-lcars-footer-callout cb-lcars-footer-callout
cb-lcars-footer-callout-right cb-lcars-footer-callout-right

type: custom:cb-lcars-double-elbow-card

cblcars_card_type: Default Style
cb-lcars-header-picard cb-lcars-header-picard
cb-lcars-header-picard-right cb-lcars-header-picard-right
cb-lcars-footer-picard cb-lcars-footer-picard
cb-lcars-footer-picard-right cb-lcars-footer-picard-right

LCARS Buttons

type: custom:cb-lcars-button-card

cblcars_card_type: Default Style
cb-lcars-button-lozenge cb-lcars-button-lozenge
cb-lcars-button-bullet cb-lcars-button-bullet
cb-lcars-button-capped cb-lcars-button-capped
cb-lcars-button-picard cb-lcars-button-picard
cb-lcars-button-picard-dense cb-lcars-button-picard-dense
cb-lcars-button-picard-filled cb-lcars-button-picard-filled
cb-lcars-button-picard-filled-dense cb-lcars-button-picard-filled-dense
cb-lcars-button-picard-icon cb-lcars-button-picard-icon

LCARS Multimeter (Sliders/Gauges)

type:cb-lcars-multimeter-card

  • Run in Slider or Guage mode
  • Horizontal or Vertical orientation
  • Configurable multi-modal slider control:
    • Light: brightness, temperature, hue, saturation
    • Media Player: volume, seek
    • etc.
  • Fully configurable borders, label/text, slider
  • Color match [border|slider|gauge|gradient start/end etc.] to entity color
  • Configurable min, max, gauge increments, slider step size
  • Show/Hide Units, Override unit
  • Configurable Subticks
    • Show/Hide
    • Size
    • Count (number of subticks per segement)

cb-lcars-multimeter

TODOs:

  • update slider mode to new code (code that gauge uses - better performance)
  • expose customization parameters for slider (rounded/square, width/height, etc.)
  • add RTL (right-to-left) support (?)

LCARS Label (Stylized Text)

type:cb-lcars-label-card

cblcars_card_type: Styles
cb-lcars-label picard-callout-2
cb-lcars-label-picard cb-lcars-label
cb-lcars-label-2
cb-lcars-cascade cb-lcars-cascade

TODOs:

  • add presets/expose options for cascade animation settings
  • add alternative text sources (sensors?)

LCARS DPAD

type:cb-lcars-dpad-card

  • Card-wide active/inactive colors
  • Per-segment active/inactive colors
  • Assignable entity per segment
  • Assignable actions/controls per segment (deafult toggle)

cb-lcars-dpad

TODOs:

  • update/remove ripple effect
  • add 'match entity color' for active state


Screenshots

Below are screenshots and snippets of potential variations of the controls.

Button Samples

picard-button-1 picard-button-1-off picard-button-2 picard-button-2-off lozenge-button-1 lozenge-button-1-off cb-lcars-button-grid button-grid-1 button-grid-2 icon-gird-1

Sliders/Gauges

meter-1 meter-2 meter-3 meter-4

cb-lcars-multimeter

multimeter-1

Row of sliders (Transporter controls? 😁)

dashboard_light_sliders

Room Selector with Sliders for Lights

dashboard_light_grid

Some Dashboard possibilities...

dashboard_1


dashboard_2


dashboard_red_alert_1


dashboard_3


Acknowledgements & Thanks

A very sincere thanks to these projects and their authors, contributers and communities for doing what they do, and making it available. It really does make this a fun hobby to tinker with.

ha-lcars theme (the definitive LCARS theme for HA!)

custom-button-card

my-cards/my-slider-v2

lovelace-layout-card

lovelace-card-mod

lovelace-hue-like-light-card


As well, some shout-outs and attributions to these great projects:

lovelace-animated-background - Allows for animated/video backgrounds on the dashboard (stars look great.) Additionally, Home Assistant natively supports background images (can be configured in UI from 2024.6+)

lovelace-wallpanel - Great panel-mode features - including hiding side/top bars, screensaver function (with cards support)

LCARSlad London for excellent LCARS images and diagrams for reference.

meWho Titan.DS for such a cool interactive design demo and color reference.

TheLCARS.com a great LCARS design reference.

wfurphy creative-button-card-templates for debugging code template that dumps variables to the browswer console - super handy.

lcars for the SVG used inline in the dpad control.


License

This project uses the MIT License. For more details, refer to the LICENSE file.