Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nervetattoo/simple-thermostat

A different take on the thermostat card for Home Assistant ♨️
https://github.com/nervetattoo/simple-thermostat

hassio home-assistant home-assistant-custom lovelace lovelace-ui polymer-3

Last synced: 26 days ago
JSON representation

A different take on the thermostat card for Home Assistant ♨️

Host: GitHub
URL: https://github.com/nervetattoo/simple-thermostat
Owner: nervetattoo
License: mit
Created: 2018-11-22T06:51:16.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2024-08-19T15:33:03.000Z (3 months ago)
Last Synced: 2024-10-09T16:22:23.602Z (30 days ago)
Topics: hassio, home-assistant, home-assistant-custom, lovelace, lovelace-ui, polymer-3
Language: TypeScript
Homepage:
Size: 1.35 MB
Stars: 743
Watchers: 22
Forks: 112
Open Issues: 153
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-home-assistant - Simple Thermostat - A simpler and more flexible thermostat card. (Dashboards / Custom Cards)

README

# Lovelace simple thermostat card

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

A different take on the thermostat card for Home Assistant Lovelace UI.
The aim is to provide a card with simpler interactions that are easier to use and take up less space, as well as provide more modularity to tweak the card. For example the abiltity to embed sensor values that are relevant to your thermostat (like humidity, energy usage, hours on +++).

![Example thermostat](https://github.com/nervetattoo/simple-thermostat/raw/master/thermostat-card.png)

## Compact mode

![Compact configuration](https://github.com/nervetattoo/simple-thermostat/raw/master/simple-thermostat-compact.png)

Hide everything but sensors and temperature control:

```yaml
type: custom:simple-thermostat
entity: climate.hvac
layout:
step: row
header: false
control: false
```

## Note about 2.0 release

The 2.0 release is most likely a breaking change for the majority of users.
Make sure you read the release notes and inspect the new configuration format.
It offers more flexibility and features as well as a number of bug fixes.

## Requirements

Home Assistant 0.84 or higher

## Installation

1. Install via [HACS](https://hacs.xyz/).
2. Add to resources:
```yaml
url: /hacsfiles/simple-thermostat/simple-thermostat.js
type: module
```

Manual install
1. Download the `simple-thermostat.js` from the [latest release](https://github.com/nervetattoo/simple-thermostat/releases/latest) and store it in your `configuration/www` folder.
_Previously you could download the source file from Github but starting from the 0.14 release that is no longer possible. If you try to do so it will crash_
2. Configure Lovelace to load the card:

```yaml
resources:
- url: /local/simple-thermostat.js?v=1
type: module
```

## Available configuration options:

- `entity` _string_: The thermostat entity id **required**
- `header` _false|Header object_: See [section](#header-config) about header config
- `setpoints` _false|Setpoints object_: See [section](#setpoints-config) about setpoints config
- `layout` _Layout object_:
- `step` _row|column_: Where to render the setpoint up/down buttons
- `mode` _object_: Disable elements for all modes
- `names` _boolean_
- `icons` _boolean_
- `headings` _boolean_
- `sensors`: _object_
- `type`: _list|table_: How to render the sensors
- `labels`: _boolean_: Whether to show labels/headings or not. Hiding here overrides hiding under root level `sensors` config
- `service` _object_: Must specify both domain+service if overriding
- `domain` _string_: Override the service call domain
- `service` _string_: Override the service call name
- `data` _object_: Send extra data with the service call
- `unit` _string|bool_: Override the unit to display. Set to false to hide unit
- `decimals` _number_: Specify number of decimals to use: 1 or 0
- `fallback` _string_: Specify a text to display if a valid set point can't be determined. Defaults to `N/A`
- `step_size` _number_: Override the default 0.5 step size for increasing/decreasing the temperature
- `label` _object_: Override untranslated labels
- `temperature`: _string_ Override Temperature label
- `state`: _string_ Override State label
- `hide` _object_: Control specifically information fields to show. Defaults to showing everything
- `temperature`: _bool_ (Default to `false`)
- `state`: _bool_ (Default to `false`)
- `control` _object|array_ (From 0.27)
- `hvac|fan|preset|swing` _object|bool_: The key of the mode type (hvac, preset, fan, swing)
- `_name` _string_: Override the name of the mode type
- `_hide_when_off` _bool_: Hides the mode type selection row when the entity is off. Defaults to false shown
- `{mode}` _string_: Name of mode type to control
- `name` _string|bool_: Specify a custom name or set to `false` to show only the icon
- `icon` _string|bool_: Specify a custom icon or set to `false` to not show icon
- `sensors` _array|false_
- `entity` _string_: A sensor value entity id
- `name` _string_: Specify a sensor name to use instead of the default friendly_name
- `icon` _string_: Specify an icon to use instead of a name
- `attribute` _string_: The key for an attribute to use instead of state. If this sensor has no entity it will use the main entity's attributes
- `unit` _string_: When specifying an attribute you can manually set the unit to display
- `decimals` _number_: If you know your sensors has a numeric value you can round it to a number of decimals.
- `type` _relativetime_: Special data types that result in special handling.

## Header config

> New in 2.0. Old ways of defining toggle_entity, faults, name and icon are no longer supported

Hiding the entire header is done with `header: false`
If you pass an object you can pass any of the following keys.
Example:

```yaml
header:
name: Overriden name
icon: mdi:sofa
toggle:
entity: switch.light
name: Light
faults:
- entity: switch.light
```

Full header config spec:

- `name` _string_: Override the card name. Default is to use the friendly_name of the thermostat provided
- `toggle` _object_: An entity id to create a toggle in the header for. This gives the option to control a separate entity which can be related to the thermostat entity (like a switch, or input_boolean)
- `entity` _string_: The entity id to create the header for
- `name` _string|bool_: Set the label to be shown to the left of the toggle. Set to true to show the friendly name of the toggle_entity
- `faults` _array|false_: Show fault conditions as active/inactive icons in the header
- `entity` _string_: A binary sensor entity id
- `icon` _string_: Override the entity icon
- `hide_inactive` _bool_: Hide the fault icon when inactive (Default to `false`)
- `icon` _string|object_: Show an icon next to the card name. You can also pass an object to specify specific icons. Current value is taken from attributes.hvac_action when available, or state as fallback.
- `auto`: _string_ Use this icon for hvac_action auto. Default mdi:radiator
- `cooling`: _string_ Use this icon for hvac_action cooling. Default mdi:snowflake
- `fan`: _string_ Use this icon for hvac_action fan. Default mdi:fan
- `heating`: _string_ Use this icon for hvac_action heating. Default mdi:radiator
- `idle`: _string_: Use this icon for hvac_action idle. Default mdi:radiator-disabled
- `"off"`: _string_ Use this icon for hvac_action off. Default mdi:radiator-off
- `auto`: _string_ Use this icon for state auto. Default hass:autorenew
- `cool`: _string_ Use this icon for state cooling. Default hass:snowflake
- `dry`: _string_: Use this icon for state dry. Default hass:water-percent
- `fan_only`: _string_ Use this icon for state fan. Default hass:fan
- `heat`: _string_ Use this icon for state heat. Default hass:autorenew
- `heat_cool`: _string_: Use this icon for state heat_cool. Default hass:fire
- `"off"`: _string_ Use this icon for state off. Default hass:power

## Setpoints config

> New in 2.0. Old ways of hiding setpoints is deprecated

If you specify setpoints manually you must include all setpoints you want included.
Normally there are only two possibilities here; `temperature` or `target_temp_high` + `target_temp_low`. Single or dual thermostats. But, theoretically there could be multiple setpoints and this aims to support any permutation.
The new feature in 2.0 is the ability to hide one of the two setpoints for dual thermostats.

To manually specify to use the `temperature` attribute as a setpoint you do:

```yaml
setpoints:
temperature:
```

For dual thermostats:

```yaml
setpoints:
target_temp_low:
target_temp_high:
```

To hide one of the dual setpoints:

```yaml
setpoints:
target_temp_low:
hide: true
target_temp_high:
```

For climate devices supporting more setpoints you can include as many as you like.
Automatic detection of set points only work for the single/dual cases.

## Usage of the control config

In 0.27, in order to both support changes in the climate domain and to support controlling all modes like hvac, preset, fan and swing modes the old `modes` configuration have been removed and replaced with a `control` config.

The `control` config is most easily explained using a few examples as it supports both a simplified definition using just an array to list the types of modes to control. By default, with no config, it will show `hvac` and `preset` (if the entity supports it). You can replicate the default manually like this:

```yaml
control:
- hvac
- preset
```

This will list all modes for both types. You can get more fine grained control by switching to an object format and taking control of specific modes:

```yaml
control:
preset:
away: true
none:
name: Not set
```

What is worth noticing is that there is no merging of the default any more, so with this config you will not get `hvac_mode` displayed. If you still want it to display like default you need to set:

```yaml
control:
preset:
away: true
none:
name: Not set
hvac: true
```

Please note that you need to quote off/on mode keys to not have them interprented as true/false.

```yaml
control:
hvac:
off: will not work
"off": works
```

## Example usage:

```yaml
cards:
- type: 'custom:simple-thermostat'
entity: climate.my_room
step_size: 1
sensors:
- entity: sensor.fibaro_system_fgwpef_wall_plug_gen5_energy
- entity: sensor.fibaro_system_fgwpef_wall_plug_gen5_power
name: Energy today
- attribute: min_temp
name: Min temp
header:
faults:
- entity: binary_sensor.my_room_communications_fault
- entity: binary_sensor.my_room_low_battery_fault
icon: mdi:battery-low
toggle:
entity: switch.pump_relay
control:
hvac:
some_mode: false
another_mode: false
'off':
name: Make it cold
icon: false
'on':
name: false
icon: mdi:whitewalker
```

```yaml
cards:
- type: 'custom:simple-thermostat'
entity: climate.my_room
step_size: 1
sensors:
- entity: sensor.fibaro_system_fgwpef_wall_plug_gen5_energy
header:
toggle:
entity: switch.pump_relay
name: Control the pump
```

## CSS vars for theming

The card uses the following CSS variables:

| Var name | Default value | Usage |
| --------------------------- | --------------------------------------- | ---------------------------------------------------- |
| --st-font-size-xl | var(--paper-font-display3\_-_font-size) | Used for target temperature |
| --st-font-size-l | var(--paper-font-display2\_-_font-size) | Unused at the moment |
| --st-font-size-m | var(--paper-font-title\_-_font-size) | Used for target temperature unit |
| --st-font-size-title | var(--ha-card-header-font-size, 24 | Font size for card heading |
| --st-font-size-sensors | var(--paper-font-subhead\_-_font-size) | Font size for sensors |
| --st-spacing | 4px | Base unit for spacing. Used in multiples many places |
| --st-mode-active-background | var(--primary-color) | Background color for active mode button |
| --st-mode-active-color | var(--text-primary-color, #fff) | Text color for active mode button |
| --st-mode-background | #dff4fd | Background color for inactive mode button |
| --st-toggle-label-color | var(--text-primary-color) | Text color for toggle label |
| --st-font-size-toggle-label | var(--paper-font-subhead\_-_font-size) | Font size for toggle label |
| --st-fault-inactive-color | var(--secondary-background-color) | Icon color for inactive faults |
| --st-fault-active-color | var(--accent-color) | Icon color for active faults |

These variables can be changed globally in the current theme or on each card via card-mod.

### Example using custom theme

Example that makes everything smaller and more compact except sensors that gets blown up completely.

```yaml
example-theme:
st-font-size-xl: 24px
st-font-size-m: 20px
st-font-size-title: 20px
st-font-size-sensors: 30px
st-spacing: 2px
```

### Example using card-mod

Same example as above, but will only apply to a single card.

```yaml
type: 'custom:simple-thermostat'
style: |
ha-card {
--st-font-size-xl: 24px;
--st-font-size-m: 20px;
--st-font-size-title: 20px;
--st-font-size-sensors: 30px;
--st-spacing: 2px;
}
...
```