Skip to content

gevgeny/shutter-badge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Shutter Badge for Home Assistant

A custom Home Assistant badge to control shutter directly from the dashboard.

Screenshot of a comment on a GitHub issue showing an image, added in the Markdown, of an Octocat smiling and raising a tentacle.

Features

  • Display a badge with a customizable label, icon, and color.

  • Control the shutter's up and down movements by toggling associated switch entities.

  • Automatically stops the shutter after a configurable duration (in seconds) for full open or close.

Installation

To use this custom badge, you need to load the JavaScript file into your Home Assistant instance:

  1. Open the Dashboard Settings (three-dot menu in the top-right corner of your dashboard).

  2. Select Resources.

  3. Add the following resource:

    URL: https://cdn.jsdelivr.net/gh/gevgeny/shutter-badge@1.0.0/source/shutter-badge.js
    Type: JavaScript Module
  4. Save and refresh the page.


Configuration

To use the shutter-badge on your Home Assistant dashboard, follow these steps:

  1. Open Your Dashboard in Edit Mode

  2. Click the Add Badge [+] button.

  3. Scroll to the bottom and select Manual.

  4. Paste the following YAML into the card editor and customize it for your needs

- type: custom:shutter-badge
  label: Shutter               
  icon: mdi:window-shutter     
  color: var(--orange-color)   
  switch_up: switch.shellyplus2pm_2cbcaa388f54_switch_0   
  switch_down: switch.shellyplus2pm_2cbcaa388f54_switch_1 
  duration: 10                 

Configuration Options

Option Type Required Default Description
label string No Shutter Label to display on the badge.
icon string No mdi:window-shutter Material Design icon for the badge.
color string No var(--primary-color) Badge color (CSS color or variable).
switch_up string Yes - Entity ID of the switch controlling the UP direction.
switch_down string Yes - Entity ID of the switch controlling the DOWN direction.
duration number No 10 Time in seconds to keep the switch on for full open/close.

License

This project is open-source and available under the MIT License.


Enjoy seamless shutter control with your Home Assistant dashboard!

About

Shutter badge for Home Assistant

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors