Room Summary Card

Room Data at Your Fingertips

Built with the tools and technologies:

Overview

A custom card for Home Assistant that provides a comprehensive room overview, including climate information, device states, and problem indicators. The card displays room temperature, humidity, connected devices, and entity states in an organized grid layout.

Features

Installation

HACS (Recommended)

1. Open HACS in your Home Assistant instance
2. Click the menu icon in the top right and select "Custom repositories"
3. Add this repository URL and select "Dashboard" as the category
   • https://github.com/homeassistant-extras/REPLACE-ME
4. Click "Install"

Manual Installation

1. Download the REPLACE-ME.js file from the latest release in the Releases tab.
2. Copy it to your www/community/REPLACE-ME/ folder
3. Add the following to your configuration.yaml (or add as a resource in dashboards menu)

lovelace:
  resources:
    - url: /local/community/REPLACE-ME/REPLACE-ME.js
      type: module

Usage

Add the card to your dashboard using the UI editor or YAML:

Card Editor

Slowly I'm enabling all the features in the card editor. Note that as things get converted to there some yaml settings may move / rename.

YAML

This is the most minimal configuarion needed to get started. See below for advanced usage.

type: custom:REPLACE-ME
area: living_room

The card will automatically:

Example Configurations

Basic Configuration

type: custom:REPLACE-ME
area: living_room

Full Configuration

type: custom:REPLACE-ME
area: living_room
...

For examples, see my HA configuration for my dashboard home page: 01-home.yaml

Project Roadmap

• Initial design: create initial card design

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the REPLACE-ME project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.
• 📣 Check out discord: Need further help, have ideas, want to chat?

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/homeassistant-extras/REPLACE-ME

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

Acknowledgments

• Built using LitElement
• Inspired by Home Assistant's chip design
• Button-Card was a huge inspo
• Thanks to all contributors!

Code Quality

Forgive me and my badges..

Stats

Ratings

Build Status

Main

Release