https://github.com/homeassistant-extras/zwave-card-set

Set of cards for different Zooz Z-Wave devices
https://github.com/homeassistant-extras/zwave-card-set

hacs hacs-integration home-assistant home-assistant-addons home-assistant-custom home-assistant-frontend home-assistant-integration zwave zwave-js

Last synced: 2 months ago
JSON representation

Set of cards for different Zooz Z-Wave devices

• Host: GitHub
• URL: https://github.com/homeassistant-extras/zwave-card-set
• Owner: homeassistant-extras
• License: mit
• Created: 2025-02-15T01:49:52.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2025-04-08T15:42:32.000Z (2 months ago)
• Last Synced: 2025-04-08T16:36:36.443Z (2 months ago)
• Topics: hacs, hacs-integration, home-assistant, home-assistant-addons, home-assistant-custom, home-assistant-frontend, home-assistant-integration, zwave, zwave-js
• Language: TypeScript
• Homepage:
• Size: 2.21 MB
• Stars: 11
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



Z-Wave Card Set



	Boosting your Z-Wave integration.



![Home Assistant](https://img.shields.io/badge/home%20assistant-%2341BDF5.svg?style=for-the-badge&logo=home-assistant&logoColor=white)

[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://github.com/hacs/integration)

![GitHub Release](https://img.shields.io/github/v/release/homeassistant-extras/zwave-card-set?style=for-the-badge&logo=github)

![GitHub Pre-Release](https://img.shields.io/github/v/release/homeassistant-extras/zwave-card-set?include_prereleases&style=for-the-badge&logo=github&label=PRERELEASE)

![GitHub Tag](https://img.shields.io/github/v/tag/homeassistant-extras/zwave-card-set?style=for-the-badge&color=yellow)

![GitHub branch status](https://img.shields.io/github/checks-status/homeassistant-extras/zwave-card-set/main?style=for-the-badge)

![stars](https://img.shields.io/github/stars/homeassistant-extras/zwave-card-set.svg?style=for-the-badge)

![home](https://img.shields.io/github/last-commit/homeassistant-extras/zwave-card-set.svg?style=for-the-badge)

![commits](https://img.shields.io/github/commit-activity/y/homeassistant-extras/zwave-card-set?style=for-the-badge)

![license](https://img.shields.io/github/license/homeassistant-extras/zwave-card-set?style=for-the-badge&logo=opensourceinitiative&logoColor=white&color=0080ff)

Built with the tools and technologies:



	

	

	

	

	






## Overview

This project brings a set of cards to display info about your Z-Wave devices. Many of these are great if you have a dedicated status view for your network or connected devices.

## Cards

### [Z-Wave Device Info](src/cards/node-info/README.md)

Universal card for all Z-Wave devices showing detailed device information and controls.

![card](assets/cards/node-info/card.png)

### [Device Center](src/cards/device-center/README.md)

See all your devices and their states and some controls if applicable in one place.

![card](assets/cards/device-center/card.png)

### [Z-Wave Nodes Status Card](src/cards/node-states/README.md)

Shows status and last seen time of all your nodes.

![card](assets/cards/node-status/card.png)

### [Hub Card](src/cards/controller-info/README.md)

Shows info about the Z-Wave Hub.

![card](assets/cards/controller-info/card.png)

## Installation

### HACS (Recommended)

[![HACS](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=homeassistant-extras&repository=zwave-card-sets&category=dashboard)

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/zwave-card-set`

4. Click "Install"

### Manual Installation

1. Download the `zwave-card-set.js` file from the latest release in the Releases tab.

2. Copy it to your `www/community/zwave-card-set/` folder

3. Add the following to your `configuration.yaml` (or add as a resource in dashboards menu)

```yaml

lovelace:

  resources:

    - url: /local/community/zwave-card-set/zwave-card-set.js

      type: module

```

Add the cards to your dashboard using the UI editor or YAML.

## Configuration Options

See the README files of the individual cards for configuration and detailed information.

- [Z-Wave Device Info](src/cards/node-info/README.md)

- [Device Center](src/cards/device-center/README.md)

- [Z-Wave Nodes Status Card](src/cards/node-states/README.md)

- [Z-Wave Hub Card](src/cards/controller-info/README.md)

Some cards may require the hub to be labeled with a "Hub" label:

![hub](assets/hub.png)

## Supported Devices

All Z-Wave devices are supported through the universal Device Info card. I have tested mainly Zooz devices as this is my Z-Wave devices of choice. Let me know if you have any issues and we'll get them fixed!

## Project Roadmap

- [x] **`Initial design`**: create initial room card based on button-card template in UI minimialist theme.

- [x] **`Editors`**: make sure stub configs and previews are solid.

- [x] **`Node cards`**: show info about different nodes.

- [x] **`Node status card sizing`**: make sizing dynamic, can't figure it out.

- [x] **`Device Center`**: add docs and pics towards end.

- [x] **`Themes`**: test default theme, etc.

- [ ] **`Tests`**: small refactors to simplify testing

## Contributing

- **💬 [Join the Discussions](https://github.com/homeassistant-extras/zwave-card-set/discussions)**: Share your insights, provide feedback, or ask questions.

- **🐛 [Report Issues](https://github.com/homeassistant-extras/zwave-card-set/issues)**: Submit bugs found or log feature requests for the `zwave-card-set` project.

- **💡 [Submit Pull Requests](https://github.com/homeassistant-extras/zwave-card-set/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.

- **📣 [Check out discord](https://discord.gg/F28wupKC)**: Need further help, have ideas, want to chat?

- **🃏 [Check out my other cards!](https://github.com/orgs/homeassistant-extras/repositories)** Maybe you have an integration that I made cards for.

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.

   ```sh

   git clone https://github.com/homeassistant-extras/zwave-card-set

   ```

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

   ```sh

   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.

   ```sh

   git commit -m 'Implemented new feature x.'

   ```

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

   ```sh

   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](LICENSE) file.

## Acknowledgments

- Built using [LitElement](https://lit.dev/)

- Inspired by Home Assistant's chip design

- Button-Card was a huge inspo

- Thanks to all contributors!

[![contributors](https://contrib.rocks/image?repo=homeassistant-extras/zwave-card-set)](https://github.com{/homeassistant-extras/zwave-card-set/}graphs/contributors)

[![ko-fi](https://img.shields.io/badge/buy%20me%20a%20coffee-72A5F2?style=for-the-badge&logo=kofi&logoColor=white)](https://ko-fi.com/N4N71AQZQG)

## Code Quality

Forgive me and my badges..

Stats

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=bugs)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=coverage)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

Ratings

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=homeassistant-extras_zwave-card-set&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=homeassistant-extras_zwave-card-set)

## Build Status

### Main

[![Bump & Tag](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/push.yml/badge.svg?branch=main)](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/push.yml)

[![Fast Forward Check](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/pull_request.yaml/badge.svg?branch=main)](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/pull_request.yaml)

### Release

[![Bump & Tag](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/push.yml/badge.svg?branch=release)](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/push.yml)

[![Merge](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/merge.yaml/badge.svg)](https://github.com/homeassistant-extras/zwave-card-set/actions/workflows/merge.yaml)