finity69x2 / cover-position-preset-row

Plug-in for Home Assistant that provides an easy means to set 3 fixed positions for a programmable cover entity.
24 stars 4 forks source link
cover lovelace-custom-card plugin

cover-position-preset-row

Provides a means to program 3 preset position settings for programmable cover entities selectable from a Lovelace button row. This plugin will also accept a "cover group" as the entity_id.

This pluig-in was inspired by user @ktownsend-personal on the Home Assistant forum (community.home-assistant.io) as a thematically complementary plug-in for my other various control rows.

This element is completely theme-able to provide a match to the other control rows to provide a consistent look for the different elements in your Lovelace frontend

Installation:

The easiest way to install this is to use the Home Assistant Community Store (HACS) in Home Assistant.

Follow the instructions there for installation making sure you note the "url:" section for the resources addition.

Conversely, if you don't use HACS you can install it manually by performing the following:

Copy the cover-position-preset-row.js file to the appropriate folder in your Home Assistant Configuration directory (/config/www/).

Place the following in your "resources" section in your lovelace configuration (updating the localation to where you placed the above file):

    - url: /local/cover-position-preset-row.js
      type: module

Then to use this in a card place the following in your entity card:

Options:

Name Type Required Default Description
type String Yes none custom:cover-position-entity-row
entity String Yes none Any positional cover entity_id (including "cover group" entities)
name String No none A custom name for the entity in the row
customSetpoints Boolean No false Set to true to use custom position setpoints
customTheme Boolean No false Set to true to use a custom theme
customText Boolean No false Set to true to use custom button text
reverseButtons Boolean No false Set to true to reverse the button order
isTwoPositionCover Boolean No false Set to true to hide the two middle position preset buttons
allowDisablingButtons Boolean No true Set to false to prevent buttons being disabled
width String No 30px A custom width for the buttons
height String No 30px A custom height for the buttons
openPosition Integer No 99 Sets the position setpoint for the "open" button (max 100)
midOpenPosition Integer No 66 Sets the position setpoint for the "mid open" button
midClosePosition Integer No 33 Sets the position setpoint for the "mid close" button
closePosition Integer No 0 Sets the position setpoint for the "close" button (min 0)
isOpenedColor String No '#f44c09' Sets the color of the 'open' button if cover is fully open
isMidOpenedColor String No '#f44c09' Sets the color of the 'mid open' button if cover is partially open but closer to open
isMidClosedColor String No '#f44c09' Sets the color of the 'mid closed' button if cover is partially open but cloder to closed
isClosedColor String No '#43A047' Sets the color of the 'closed' button if cover is closed
buttonInactiveColor String No '#759aaa' Sets the color of the the buttons if that selection is not "active"
customOpenText String No '99%' Sets the text of the "open" position button
customMidOpenText String No '66%' Sets the text of the "mid open" position button
customMidClosedText String No '33%' Sets the text of the "mid close" position button
customClosedText String No '0%' Sets the text of the "close" position button
state_color Boolean No false Sets the icon color of the entity to reflect the current state

The values for the colors can be any valid color string in "HEX", "RGB" or by color name.

If no custom setting is provided it will use the 'default' value for that individual setting.

If the cover position is changed via any other means (slider, service call, etc) the buttons will indicate which range the cover position is in based on the setpoint settings in the config.

This plugin can also be used with a group of positionable covers by creating a "cover group". Then each cover in the group will be simultaneously controlled by the plugin.

Configuration Examples:

      type: entities
      title: cover theme test
      show_header_toggle: false
      state_color: true
      entities:
        - type: custom:cover-position-preset-row
          name: Blind Custom Position
          entity: cover.blinds_test
          reverseButtons: true
          ## used to select your own customizable theme
          customTheme: true
          isOpenedColor: 'rgb(255, 0, 0)'
          isMidOpenedColor: '#888888'
          isMidClosedColor: '#222222'
          isClosedColor: 'purple'
          buttonInactiveColor: 'black'
          ## used to set the custom setpoints for the cover (default is 0, 33, 66, and 99)
          customSetpoints: true
          openPosition: 85
          midOpenPosition: 40
          midClosePosition: 20
          closePosition: 8
          ## used to select custom text for the buttons (defaults to 0, 33, 66, 99. Or it defaults to the values of the setpoints if custom setpoints are used)
          customText: true
          customOpenText: open
          customMidOpenText: mop
          customMidClosedText: mcls
          customClosedText: cls
          width: '15px'
          height: '15px'

This is with the default Lovelace frontend theme set:

Default

This is with the "Slate" frontend theme set:

Slate

This is with custom setpoints and a custom theme:

Custom Setpoints and Theme

And here is the above with custom text:

Custom Setpoints and Theme