diff --git a/.github/workflows/automatic-custom-card-docs.yml b/.github/workflows/automatic-custom-card-docs.yml index a92327fbe..5f4c5ab23 100644 --- a/.github/workflows/automatic-custom-card-docs.yml +++ b/.github/workflows/automatic-custom-card-docs.yml @@ -11,7 +11,7 @@ jobs: docit: runs-on: "ubuntu-latest" steps: - - uses: "actions/checkout@v3" + - uses: "actions/checkout@v4" with: fetch-depth: 0 - name: "Copy and rename README.md files" diff --git a/.github/workflows/check-code-quality.yml b/.github/workflows/check-code-quality.yml index 2583600cb..e1b5b5ca6 100644 --- a/.github/workflows/check-code-quality.yml +++ b/.github/workflows/check-code-quality.yml @@ -11,11 +11,11 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "⤵️ Check out code from GitHub" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" - name: "⚙️ Set up Python" uses: "actions/setup-python@v4" with: - python-version: 3.8 + python-version: 3.11 - name: "⚙️ Set up Ruby" uses: "ruby/setup-ruby@v1" with: diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index f54dfd08b..1fbd12737 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -34,7 +34,7 @@ jobs: steps: - name: "Checkout repository" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" # Initializes the CodeQL tools for scanning. - name: "Initialize CodeQL" diff --git a/.github/workflows/hacs-validate.yml b/.github/workflows/hacs-validate.yml index d9a19e621..d2986cfa9 100644 --- a/.github/workflows/hacs-validate.yml +++ b/.github/workflows/hacs-validate.yml @@ -13,7 +13,7 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "checkout" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" - name: "validation" uses: "home-assistant/actions/hassfest@master" @@ -22,7 +22,7 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "checkout" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" - name: "validation" uses: "hacs/action@main" with: diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml index a782ee3b6..2ed8a8677 100644 --- a/.github/workflows/labeler.yml +++ b/.github/workflows/labeler.yml @@ -12,7 +12,7 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "⤵️ Check out code from GitHub" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" - name: "\U0001F680 Run Labeler" uses: "crazy-max/ghaction-github-labeler@v4" with: diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index d03239b40..335876e14 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -10,9 +10,9 @@ jobs: deploy: runs-on: "ubuntu-latest" steps: - - uses: "actions/checkout@v3" + - uses: "actions/checkout@v4" with: - node-version: "16.x" + node-version: "20.x" - uses: "actions/setup-python@v4" with: python-version: "3.11" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3196cc7e6..12d6ee6ee 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -11,7 +11,7 @@ jobs: runs-on: "ubuntu-latest" steps: - name: "Check out repository" - uses: "actions/checkout@v3" + uses: "actions/checkout@v4" - name: "Get version" id: "version" diff --git a/.markdownlint.yml b/.markdownlint.yml index ed383dae4..e6fda1a29 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -6,7 +6,7 @@ default: true MD001: false MD024: - allow_different_nesting: true + siblings_only: true MD025: false @@ -48,7 +48,7 @@ no-emphasis-as-heading: false first-line-h1: false code-block-style: - style: ["fenced"] + style: "fenced" proper-names: names: [] diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d9b4023f0..1a05c35c7 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -12,7 +12,7 @@ ci: repos: - repo: "https://github.com/pre-commit/pre-commit-hooks" - rev: "v4.2.0" + rev: "v5.0.0" hooks: - id: "check-executables-have-shebangs" - id: "check-json" @@ -30,7 +30,7 @@ repos: - id: "mixed-line-ending" - repo: "https://github.com/adrienverge/yamllint.git" - rev: "v1.26.3" + rev: "v1.35.1" hooks: - id: "yamllint" args: ["--format", "parsable", "--strict"] @@ -41,13 +41,13 @@ repos: )$ - repo: https://github.com/igorshubovych/markdownlint-cli - rev: v0.31.1 + rev: v0.43.0 hooks: - id: markdownlint args: ["--fix"] - repo: "https://github.com/jumanjihouse/pre-commit-hook-yamlfmt" - rev: "0.1.1" + rev: "0.2.3" hooks: - id: "yamlfmt" args: @@ -63,23 +63,23 @@ repos: exclude: ".*" - repo: "https://github.com/mattlqx/pre-commit-search-and-replace" - rev: "v1.0.5" + rev: "v1.1.8" hooks: - id: "search-and-replace" - repo: "https://github.com/asottile/pyupgrade" - rev: "v2.31.1" + rev: "v3.19.1" hooks: - id: "pyupgrade" args: ["--py39-plus"] - repo: https://github.com/pycqa/isort - rev: 5.12.0 + rev: 5.13.2 hooks: - id: isort - repo: "https://github.com/psf/black" - rev: "22.3.0" + rev: "24.10.0" hooks: - id: "black" args: @@ -89,7 +89,7 @@ repos: files: '^((custom_components|tests)/.+)?[^/]+\.py$' - repo: "https://github.com/PyCQA/flake8" - rev: "4.0.1" + rev: "7.1.1" hooks: - id: "flake8" additional_dependencies: @@ -99,7 +99,7 @@ repos: files: '^(custom_components/.+)?[^/]+\.py$' - repo: "https://github.com/PyCQA/bandit" - rev: "1.7.4" + rev: "1.8.0" hooks: - id: "bandit" args: @@ -108,7 +108,7 @@ repos: # - "--configfile=bandit.yaml" <<: *python-files-with-tests - repo: https://github.com/codespell-project/codespell.git - rev: "v2.1.0" + rev: "v2.3.0" hooks: - id: codespell files: "(.*.md|translations/en.json)" diff --git a/README.md b/README.md index 9cfc8928f..56c8e7fd2 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ It's kind of hard to explain what this is, so let's call it a "theme" (in quotation marks). But one thing is for sure, it is very nice! Taking the exceptional work of tben as a basis, this repository is aimed to ease installation and maintenance of his wonderful work. You can use this interpretation of a SmartHomeUI more or less like a theme in HomeAssistant. - +example-image1 example-image2 example-image3 example-image4 ## Wiki for documentation @@ -28,6 +28,7 @@ Take a look here: [https://ui-lovelace-minimalist.github.io/UI/](https://ui-love Table of content from the WIKI
+ @@ -103,5 +104,5 @@ The same goes for our `custom_cards`. As the number grows, the list would be to ### Contributions ->This is a living project and all input is very welcome! If you configured and designed a card, that you would like to share, please feel free to do so! We are happy to include your contribution so others can use it as well! -This project uses pre-commit for consistent and clean code. If possible, please make sure that you also use pre-commit for local development before creating a pull request. +> This is a living project and all input is very welcome! If you configured and designed a card, that you would like to share, please feel free to do so! We are happy to include your contribution so others can use it as well! +> This project uses pre-commit for consistent and clean code. If possible, please make sure that you also use pre-commit for local development before creating a pull request. diff --git a/custom_cards/custom_card_camera/README.md b/custom_cards/custom_card_camera/README.md index d3ebfbabc..90cef23db 100644 --- a/custom_cards/custom_card_camera/README.md +++ b/custom_cards/custom_card_camera/README.md @@ -3,6 +3,7 @@ title: Custom Camera Card hide: - toc --- + # Custom-card "Camera" @@ -21,7 +22,7 @@ Version: 1.0.0
1.0.1 -Added variable to passthough aspect ratio to the picture entity card. Fix minor issues with title. +Added variable to passthrough aspect ratio to the picture entity card. Fix minor issues with title.
1.0.0 @@ -39,7 +40,7 @@ Initial release. ulm_custom_card_camera_title: true ulm_custom_card_camera_name: "name" ulm_custom_card_camera_label: "label" - ulm_custom_card_camera_aspect_ratio: '16:9' + ulm_custom_card_camera_aspect_ratio: "16:9" ``` ## Variables diff --git a/custom_cards/custom_card_httpedo13_sun/README.md b/custom_cards/custom_card_httpedo13_sun/README.md index cbf240478..36ae30916 100644 --- a/custom_cards/custom_card_httpedo13_sun/README.md +++ b/custom_cards/custom_card_httpedo13_sun/README.md @@ -3,6 +3,7 @@ title: Sun Card Custom-card hide: - toc --- + # Custom-card "Sun" @@ -24,6 +25,7 @@ Initial release ## Requirements This card uses: +
Setup
@@ -49,10 +51,10 @@ This card uses: ## Usage ```yaml - - type: custom:button-card - template: custom_card_httpedo13_sun - variables: - language: 'it' +- type: custom:button-card + template: custom_card_httpedo13_sun + variables: + language: "it" ``` ## Variables @@ -60,12 +62,12 @@ This card uses: The same sun card config. | Name | Accepted values | Description | Default | -|---------------|----------------------|--------------------------------------|-----------------------------------------------------| +| ------------- | -------------------- | ------------------------------------ | --------------------------------------------------- | | darkMode | `boolean` | Changes card colors to dark or light | Home assistant dark mode state | | language | `string`1 | Changes card language | Home assistant language or english if not supported | | showAzimuth | `boolean` | Displays azimuth in the footer | `false` | | showElevation | `boolean` | Displays elevation in the footer | `false` | | timeFormat | `'12h'`/`'24h'` | Displayed time format | Locale based on Home assistant language | -| title | `string` | Card title | Doesn't display a title by default | | +| title | `string` | Card title | Doesn't display a title by default | (1) Supported languages: `da`, `de`, `en`, `es`, `et`, `fi`, `fr`, `hu`, `it`, `nl`, `pl`, `pt-BR`, `ru`, `sl`, `sv` diff --git a/custom_cards/custom_card_imswel_medias/README.md b/custom_cards/custom_card_imswel_medias/README.md index 6e137338b..28b49f162 100644 --- a/custom_cards/custom_card_imswel_medias/README.md +++ b/custom_cards/custom_card_imswel_medias/README.md @@ -29,6 +29,7 @@ Initial release ## Requirements This card needs the following to function correctly: + | Component | Required | | ----------------------------------------------------------------------------------------- | ---------------------------------- | |[Plex Recently Added](https://github.com/NemesisRE/sensor.plex_recently_added) | Yes for **`Media Library Card`** | @@ -40,6 +41,7 @@ This card needs the following to function correctly: **Media Library Card** for [Plex Recently Added](https://github.com/NemesisRE/sensor.plex_recently_added) : ![example-image-plex](../../docs/assets/img/custom_card_imswel_medias/medias_library_plex.png)
+ | Variable | Default | Required | Notes | | ----------------------------- | ------- | -------- | ----------------------------------------------------------------------- | | ulm_custom_card_imswel_medias_index | 1 | Yes | The index of the item in your **Plex library** to show. | @@ -58,6 +60,7 @@ This card needs the following to function correctly: ![example-image-radarr](../../docs/assets/img/custom_card_imswel_medias/medias_upcoming_radarr.png) ![example-image-sonarr](../../docs/assets/img/custom_card_imswel_medias/medias_upcoming_sonarr.png)
+ | Variable | Default | Required | Notes | | ----------------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------- | | ulm_custom_card_imswel_medias_index | 1 | Yes | The index of the item in your **Radarr/Sonarr library** to show. | diff --git a/custom_cards/custom_card_nik_clock/README.md b/custom_cards/custom_card_nik_clock/README.md index 5f3712a59..44b48dd34 100644 --- a/custom_cards/custom_card_nik_clock/README.md +++ b/custom_cards/custom_card_nik_clock/README.md @@ -3,11 +3,12 @@ title: Tablet Clock Card hide: - toc --- + # Custom-card "Tablet clock Card" -This is a `custom-card` that shows the currenct time and Date. This is designed for a tablet or big monitor. +This is a `custom-card` that shows the current time and Date. This is designed for a tablet or big monitor. ![Screenshot](../../docs/assets/img/custom_card_nik_clock.png) diff --git a/custom_cards/custom_card_nik_door/README.md b/custom_cards/custom_card_nik_door/README.md index 8e8220318..8237abebf 100644 --- a/custom_cards/custom_card_nik_door/README.md +++ b/custom_cards/custom_card_nik_door/README.md @@ -8,7 +8,7 @@ hide: # Custom-card "Minimal Door Lock" -This is a `custom-card` that shows the currenct state of your Lock and allows you to open and close it showing the state with a Minimal Design. +This is a `custom-card` that shows the current state of your Lock and allows you to open and close it showing the state with a Minimal Design. ![Screenshot](../../docs/assets/img/custom_card_nik_door.png) @@ -36,7 +36,6 @@ To have the Minimalist cards and custom cards installed ## Usage ```yaml - - type: "custom:button-card" template: "custom_card_nik_door" entity: "sensor.nuki_blindato_door_security_state" diff --git a/custom_cards/custom_card_person_info_small/README.md b/custom_cards/custom_card_person_info_small/README.md index ef9c16bcd..6a2ae52fc 100644 --- a/custom_cards/custom_card_person_info_small/README.md +++ b/custom_cards/custom_card_person_info_small/README.md @@ -29,11 +29,11 @@ The `custom_card_person_info_small` is based on `card_person_info`. | ulm_card_person_driving_entity | | :material-close: | Set a binary sensor that depicts when this person is driving | | ulm_card_person_battery_entity | | :material-close: | Set a battery level sensor | | ulm_card_person_battery_state_entity | | :material-close: | Set a battery state sensor (eg the battery state sensor from the home assistant companion app will have the states "charging" or "discharging") | -| ulm_card_battery_battery_level_danger | 15 | :material-close: | Changes the color of the Icon, if the battery level falls below the provided value. Must be higher than ulm_card_battery_battery_level_waring -| ulm_card_battery_battery_level_waring | 30 | :material-close: | Changes the color of the Icon, if the battery level falls below the provided value. -| ulm_card_battery_color_battery_level_danger | var(--google-red) | :material-close: | Color of icon if battery level is within the 'danger' zone. -| ulm_card_battery_color_battery_level_warning | var(--google-yellow) | :material-close: | Color of icon if battery level is within the 'warning' zone. -| ulm_card_battery_color_battery_level_ok | var(--google-green) | :material-close: | Color of icon if battery level is not within the 'danger' or 'warning' zone. +| ulm_card_battery_battery_level_danger | 15 | :material-close: | Changes the color of the Icon, if the battery level falls below the provided value. Must be higher than ulm_card_battery_battery_level_waring | +| ulm_card_battery_battery_level_waring | 30 | :material-close: | Changes the color of the Icon, if the battery level falls below the provided value. | +| ulm_card_battery_color_battery_level_danger | var(--google-red) | :material-close: | Color of icon if battery level is within the 'danger' zone. | +| ulm_card_battery_color_battery_level_warning | var(--google-yellow) | :material-close: | Color of icon if battery level is within the 'warning' zone. | +| ulm_card_battery_color_battery_level_ok | var(--google-green) | :material-close: | Color of icon if battery level is not within the 'danger' or 'warning' zone. | ## Usage diff --git a/custom_cards/custom_template_shogun160_battery_info/README.md b/custom_cards/custom_template_shogun160_battery_info/README.md index 3400942cb..dbdc51781 100644 --- a/custom_cards/custom_template_shogun160_battery_info/README.md +++ b/custom_cards/custom_template_shogun160_battery_info/README.md @@ -27,9 +27,9 @@ This is an template to add the battery level to every ui minimalist card ## Variables -| Variable | Default | Required | Notes | -| -------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------ | -| ulm_battery_entity | | No | The entity to represent the battery_level +| Variable | Default | Required | Notes | +| ------------------ | ------- | -------- | ----------------------------------------- | +| ulm_battery_entity | | No | The entity to represent the battery_level | ## Usage with battery or battery_level attribute from entity diff --git a/custom_components/ui_lovelace_minimalist/__init__.py b/custom_components/ui_lovelace_minimalist/__init__.py index be8369bbc..8498321b2 100644 --- a/custom_components/ui_lovelace_minimalist/__init__.py +++ b/custom_components/ui_lovelace_minimalist/__init__.py @@ -11,6 +11,7 @@ from homeassistant.core import HomeAssistant from homeassistant.helpers.aiohttp_client import async_get_clientsession from homeassistant.loader import async_get_integration +import voluptuous as vol from .base import UlmBase from .const import DOMAIN, NAME @@ -18,6 +19,8 @@ _LOGGER: logging.Logger = logging.getLogger(__package__) +CONFIG_SCHEMA = vol.Schema({DOMAIN: vol.Schema({})}, extra=vol.ALLOW_EXTRA) + async def async_initialize_integration( hass: HomeAssistant, diff --git a/custom_components/ui_lovelace_minimalist/base.py b/custom_components/ui_lovelace_minimalist/base.py index dc2e0dcae..417f24a3d 100644 --- a/custom_components/ui_lovelace_minimalist/base.py +++ b/custom_components/ui_lovelace_minimalist/base.py @@ -2,13 +2,14 @@ from __future__ import annotations +from collections.abc import Awaitable from dataclasses import asdict, dataclass, field from functools import partial import logging import os import pathlib import shutil -from typing import Any, Awaitable, Callable +from typing import Any, Callable from aiogithubapi import ( GitHubAPI, @@ -419,9 +420,9 @@ async def configure_dashboard(self) -> bool: async_remove_panel(self.hass, "ui-lovelace-minimalist") if self.configuration.adaptive_ui_enabled: - self.hass.data["lovelace"]["dashboards"][ - adv_dashboard_url - ] = LovelaceYAML(self.hass, adv_dashboard_url, adv_dashboard_config) + self.hass.data["lovelace"]["dashboards"][adv_dashboard_url] = ( + LovelaceYAML(self.hass, adv_dashboard_url, adv_dashboard_config) + ) _register_panel( self.hass, adv_dashboard_url, "yaml", adv_dashboard_config, True diff --git a/custom_components/ui_lovelace_minimalist/config_flow.py b/custom_components/ui_lovelace_minimalist/config_flow.py index 6b8d2245f..9ad4f2892 100644 --- a/custom_components/ui_lovelace_minimalist/config_flow.py +++ b/custom_components/ui_lovelace_minimalist/config_flow.py @@ -7,7 +7,9 @@ from aiogithubapi import GitHubDeviceAPI, GitHubException from aiogithubapi.common.const import OAUTH_USER_LOGIN +from awesomeversion import AwesomeVersion from homeassistant import config_entries +from homeassistant.const import __version__ as HAVERSION from homeassistant.core import callback from homeassistant.helpers import aiohttp_client import homeassistant.helpers.config_validation as cv @@ -51,6 +53,10 @@ _LOGGER: logging.Logger = logging.getLogger(__name__) +# Version threshold for config_entry setting in options flow +# See: https://github.com/home-assistant/core/pull/129562 +HA_OPTIONS_FLOW_VERSION_THRESHOLD = "2024.11.99" + async def ulm_config_option_schema(options: dict = {}) -> dict: """Return a schema for ULM configuration options.""" @@ -242,7 +248,10 @@ class UlmOptionFlowHandler(config_entries.OptionsFlow): def __init__(self, config_entry: config_entries.ConfigEntry) -> None: """Initialize.""" - self.config_entry = config_entry + self.options = dict(config_entry.options) + # See: https://github.com/home-assistant/core/pull/129562 + if AwesomeVersion(HAVERSION) < HA_OPTIONS_FLOW_VERSION_THRESHOLD: + self.config_entry = config_entry async def async_step_init(self, _user_input=None): """Manage the options.""" diff --git a/custom_components/ui_lovelace_minimalist/const.py b/custom_components/ui_lovelace_minimalist/const.py index 92c6056f6..e75a2c2e9 100644 --- a/custom_components/ui_lovelace_minimalist/const.py +++ b/custom_components/ui_lovelace_minimalist/const.py @@ -1,4 +1,5 @@ """Constants for UI Lovelace Minimalist.""" + from typing import TypeVar # Base component constants @@ -19,50 +20,49 @@ COMMUNITY_CARDS_FOLDER = "custom_cards" LANGUAGES = { - "Català": "ca", "Czech": "cs", "Danish": "da", - "Dutch": "nl", + "German": "de", "English (GB)": "en", + "Spanish": "es", + "Català": "ca", "French": "fr", - "German": "de", - "Hebrew": "he", "Italian": "it", + "Dutch": "nl", + "Hebrew": "he", "Norwegian": "no", "Polish": "pl", - "Portuguese (Brazil)": "pt-BR", "Portuguese": "pt", - "Russian": "ru", - "Slovak": "sk", + "Portuguese (Brazil)": "pt-BR", "Slovenian": "sl", - "Spanish": "es", + "Slovak": "sk", "Swedish": "sv", "Turkish": "tr", - "Ukrainian": "uk", + "Russian": "ru", "中文（简体）": "zh-CN", } CONF_LANGUAGE = "language" CONF_LANGUAGES = [ - "Català", "Czech", "Danish", - "Dutch", + "German", "English (GB)", + "Spanish", + "Català", "French", - "German", - "Hebrew", "Italian", + "Dutch", + "Hebrew", "Norwegian", "Polish", - "Portuguese (Brazil)", "Portuguese", - "Russian", + "Portuguese (Brazil)", "Slovenian", - "Spanish", + "Slovak", "Swedish", "Turkish", - "Ukrainian", + "Russian", "中文（简体）", ] CONF_SIDEPANEL_ENABLED = "sidepanel_enabled" diff --git a/custom_components/ui_lovelace_minimalist/enums.py b/custom_components/ui_lovelace_minimalist/enums.py index fa4d36405..48b3b15ca 100644 --- a/custom_components/ui_lovelace_minimalist/enums.py +++ b/custom_components/ui_lovelace_minimalist/enums.py @@ -1,4 +1,5 @@ """Helper constants.""" + # pylint: disable=missing-class-docstring from enum import Enum diff --git a/custom_components/ui_lovelace_minimalist/translations/ca.json b/custom_components/ui_lovelace_minimalist/translations/ca.json index 95a9b0f89..dcdb12205 100644 --- a/custom_components/ui_lovelace_minimalist/translations/ca.json +++ b/custom_components/ui_lovelace_minimalist/translations/ca.json @@ -24,7 +24,7 @@ "reauth_successful": "Reautenticació amb èxit." }, "progress": { - "wait_for_device": "1. Obrir {url} \n2.Enganxa la clau següent per autoritzar ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Obrir {url}\n2.Enganxa la clau següent per autoritzar ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Has de reconeixer tots els estaments.", "gh_token": "No s'ha establert el token de Github. Si et plau, reinstal·la aquesta integració per seguir amb el procés de configuració. (No es perdrà cap configuració personalitzada)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/cs.json b/custom_components/ui_lovelace_minimalist/translations/cs.json index 099bc659a..266384f9c 100644 --- a/custom_components/ui_lovelace_minimalist/translations/cs.json +++ b/custom_components/ui_lovelace_minimalist/translations/cs.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "You need to acknowledge all statements.", "gh_token": "Github Token not set. Please re-install this integration to go throught the setup procedure. (No custom configuration will be lost)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/da.json b/custom_components/ui_lovelace_minimalist/translations/da.json index 00f5475b2..16c147352 100644 --- a/custom_components/ui_lovelace_minimalist/translations/da.json +++ b/custom_components/ui_lovelace_minimalist/translations/da.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Genindlæs dashboard-konfiguration til UI Lovelace Minimalist." }, "installed": { + "name": "Installed", "description": "Skift den installerede nøgle i global konfiguration for UI Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/de.json b/custom_components/ui_lovelace_minimalist/translations/de.json index ff4d33b93..d5ee86a00 100644 --- a/custom_components/ui_lovelace_minimalist/translations/de.json +++ b/custom_components/ui_lovelace_minimalist/translations/de.json @@ -24,7 +24,7 @@ "reauth_successful": "Die erneute Authentifizierung war erfolgreich." }, "progress": { - "wait_for_device": "1. Öffne {url} \n2.Fügen Sie den folgenden Schlüssel ein, um ULM zu autorisieren: \n```\n{code}\n```\n" + "wait_for_device": "1. Öffne {url}\n2.Fügen Sie den folgenden Schlüssel ein, um ULM zu autorisieren:\n\n```{code}```" } }, "options": { @@ -60,9 +60,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Neuladen der Dashboardkonfiguration für UI Lovelace Minimalist" }, "installed": { + "name": "Installed", "description": "Änderung des installierten Schlüssels in der globalen Konfiguration für UI Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/en.json b/custom_components/ui_lovelace_minimalist/translations/en.json index 6a4a96133..212384c53 100644 --- a/custom_components/ui_lovelace_minimalist/translations/en.json +++ b/custom_components/ui_lovelace_minimalist/translations/en.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Reload dashboard configuration for UI Lovelace Minimalist." }, "installed": { + "name": "Installed", "description": "Change the installed key in global config for UI Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/es.json b/custom_components/ui_lovelace_minimalist/translations/es.json index 78fef41b7..5287d349d 100644 --- a/custom_components/ui_lovelace_minimalist/translations/es.json +++ b/custom_components/ui_lovelace_minimalist/translations/es.json @@ -24,7 +24,7 @@ "reauth_successful": "La reautenticación se ha realizado con éxito." }, "progress": { - "wait_for_device": "1. Abre {url} \n2.Pega la siguiente clave para autorizar a ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Abre {url}\n2.Pega la siguiente clave para autorizar a ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Debes aceptar todas las declaraciones.", "gh_token": "El token de Github no está configurado. Por favor, vuelve a instalar esta integración para pasar por el procedimiento de configuración. (No se perderá ninguna configuración personalizada)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/fi.json b/custom_components/ui_lovelace_minimalist/translations/fi.json index 8412f653e..fd2e9655e 100644 --- a/custom_components/ui_lovelace_minimalist/translations/fi.json +++ b/custom_components/ui_lovelace_minimalist/translations/fi.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "You need to acknowledge all statements.", "gh_token": "Github Token not set. Please re-install this integration to go throught the setup procedure. (No custom configuration will be lost)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/fr.json b/custom_components/ui_lovelace_minimalist/translations/fr.json index cb1869a68..21bd0a9d2 100644 --- a/custom_components/ui_lovelace_minimalist/translations/fr.json +++ b/custom_components/ui_lovelace_minimalist/translations/fr.json @@ -24,7 +24,7 @@ "reauth_successful": "La réauthentification a réussi." }, "progress": { - "wait_for_device": "1. Ouvrir {url} \n2.Collez la clé suivante pour autoriser ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Ouvrir {url}\n2.Collez la clé suivante pour autoriser ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Vous devez confirmer toutes les déclarations.", "gh_token": "Jeton Github non défini. Veuillez réinstaller cette intégration pour recommencer la procédure d'installation. (Aucune configuration personnalisée ne sera perdue)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/he.json b/custom_components/ui_lovelace_minimalist/translations/he.json index ed53867a3..9470895fa 100644 --- a/custom_components/ui_lovelace_minimalist/translations/he.json +++ b/custom_components/ui_lovelace_minimalist/translations/he.json @@ -24,7 +24,7 @@ "reauth_successful": "אימות מחדש הצליח" }, "progress": { - "wait_for_device": "1. פתח {url} \n2.הדבק המפתח על מנת לאשרר את ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. פתח {url}\n2.הדבק המפתח על מנת לאשרר את ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "טען קנפוג הדאשבורד מחדש עבור יו.איי. לאבלייס מינימליסט" }, "installed": { + "name": "Installed", "description": "החלף את המפתח המותקן בקנפוג הגלובלי עבור יו.איי. לאבלייס מינימליסט" } } diff --git a/custom_components/ui_lovelace_minimalist/translations/it.json b/custom_components/ui_lovelace_minimalist/translations/it.json index 7525f455d..b679b99c7 100644 --- a/custom_components/ui_lovelace_minimalist/translations/it.json +++ b/custom_components/ui_lovelace_minimalist/translations/it.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "You need to acknowledge all statements.", "gh_token": "Github Token not set. Please re-install this integration to go throught the setup procedure. (No custom configuration will be lost)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/nl.json b/custom_components/ui_lovelace_minimalist/translations/nl.json index dbc1372ef..740322270 100644 --- a/custom_components/ui_lovelace_minimalist/translations/nl.json +++ b/custom_components/ui_lovelace_minimalist/translations/nl.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Herlaad dashboardconfiguratie voor UI Lovelace Minimalist." }, "installed": { + "name": "Installed", "description": "Wijzig de geïnstalleerde sleutel in globale configuratie voor UI Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/pl.json b/custom_components/ui_lovelace_minimalist/translations/pl.json index fd6883ca6..a2bbe2e65 100644 --- a/custom_components/ui_lovelace_minimalist/translations/pl.json +++ b/custom_components/ui_lovelace_minimalist/translations/pl.json @@ -24,7 +24,7 @@ "reauth_successful": "Ponowne uwierzytelnienie zakończyło się sukcesem" }, "progress": { - "wait_for_device": "1. Otwórz {url} \n2.Wklej poniższy klucz, aby autoryzować ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Otwórz {url}\n2.Wklej poniższy klucz, aby autoryzować ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Należy zaznaczyć wszystkie oświadczenia.", "gh_token": "Token GitHub nie został ustawiony. Zainstaluj ponownie integrację, aby przejść przez proces konfiguracji. Żadna niestandardowa konfiguracja nie zostanie utracona." } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/pt-BR.json b/custom_components/ui_lovelace_minimalist/translations/pt-BR.json index 26049dab2..06dd94712 100644 --- a/custom_components/ui_lovelace_minimalist/translations/pt-BR.json +++ b/custom_components/ui_lovelace_minimalist/translations/pt-BR.json @@ -24,7 +24,7 @@ "reauth_successful": "Reauthentication was successful." }, "progress": { - "wait_for_device": "1. Open {url} \n2.Paste the following key to authorize ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Open {url}\n2.Paste the following key to authorize ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "You need to acknowledge all statements.", "gh_token": "Github Token not set. Please re-install this integration to go throught the setup procedure. (No custom configuration will be lost)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/ru.json b/custom_components/ui_lovelace_minimalist/translations/ru.json index 9f1c9967a..17ac50287 100644 --- a/custom_components/ui_lovelace_minimalist/translations/ru.json +++ b/custom_components/ui_lovelace_minimalist/translations/ru.json @@ -24,7 +24,7 @@ "reauth_successful": "Повторная аутентификация прошла успешно." }, "progress": { - "wait_for_device": "1. Откройте ссылку {url} \n2.Вставьте следующий ключ для авторизации ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Откройте ссылку {url}\n2.Вставьте следующий ключ для авторизации ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Вы должны подтвердить все пункты.", "gh_token": "Токен Github не установлен. Пожалуйста, переустановите эту интеграцию, чтобы пройти процедуру установки. (Никакая пользовательская конфигурация не будет потеряна)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/sk.json b/custom_components/ui_lovelace_minimalist/translations/sk.json index 5345f1824..07afd0548 100644 --- a/custom_components/ui_lovelace_minimalist/translations/sk.json +++ b/custom_components/ui_lovelace_minimalist/translations/sk.json @@ -24,7 +24,7 @@ "reauth_successful": "Opätovná autentifikácia bola úspešná." }, "progress": { - "wait_for_device": "1. Otvoriť {url} \n2.Vložte nasledujúci kľúč na autorizáciu ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Otvoriť {url}\n2.Vložte nasledujúci kľúč na autorizáciu ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Znovu načítajte konfiguráciu dashboardu pre používateľské rozhranie Lovelace Minimalist." }, "installed": { + "name": "Installed", "description": "Zmeňte nainštalovaný kľúč v globálnej konfigurácii pre používateľské rozhranie Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/sl.json b/custom_components/ui_lovelace_minimalist/translations/sl.json index 56a6e4fbd..04f6fcb3c 100644 --- a/custom_components/ui_lovelace_minimalist/translations/sl.json +++ b/custom_components/ui_lovelace_minimalist/translations/sl.json @@ -24,7 +24,7 @@ "reauth_successful": "Ponovna avtentikacija je bila uspešna." }, "progress": { - "wait_for_device": "1. Odpri {url} \n2.Za avtorizacijo prilepite naslednji ključ ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Odpri {url}\n2.Za avtorizacijo prilepite naslednji ključ ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Vse izjave morate potrditi.", "gh_token": "Žeton Github ni nastavljen. Znova namestite to integracijo, da opravite postopek namestitve. (Nobena konfiguracija po meri ne bo izgubljena)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/sv.json b/custom_components/ui_lovelace_minimalist/translations/sv.json index 08a85316f..188853c60 100644 --- a/custom_components/ui_lovelace_minimalist/translations/sv.json +++ b/custom_components/ui_lovelace_minimalist/translations/sv.json @@ -24,7 +24,7 @@ "reauth_successful": "Återautentiseringen lyckades." }, "progress": { - "wait_for_device": "1. Öppna {url} \n2.Klistra in följande nyckel för att auktorisera ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Öppna {url}\n2.Klistra in följande nyckel för att auktorisera ULM:\n\n```{code}```" } }, "options": { @@ -56,5 +56,15 @@ "ack": "Du måste bekräfta alla uttalande.", "gh_token": "Github Token inte inställt. Installera om denna integration för att gå igenom installationsproceduren. (Ingen anpassad konfiguration kommer att gå förlorad)" } + }, + "services": { + "reload": { + "name": "Reload", + "description": "Reload dashboard configuration for UI Lovelace Minimalist." + }, + "installed": { + "name": "Installed", + "description": "Change the installed key in global config for UI Lovelace Minimalist." + } } } diff --git a/custom_components/ui_lovelace_minimalist/translations/uk.json b/custom_components/ui_lovelace_minimalist/translations/uk.json index eeeeda065..ebd5c3d15 100644 --- a/custom_components/ui_lovelace_minimalist/translations/uk.json +++ b/custom_components/ui_lovelace_minimalist/translations/uk.json @@ -24,7 +24,7 @@ "reauth_successful": "Повторна автентифікація пройшла успішно." }, "progress": { - "wait_for_device": "1. Відкрите {url} \n2.Вставте цей ключ для авторизації ULM: \n```\n{code}\n```\n" + "wait_for_device": "1. Відкрите {url}\n2.Вставте цей ключ для авторизації ULM:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "Перезавантажте конфігурацію Інформаційної панелі для UI Lovelace Minimalist." }, "installed": { + "name": "Installed", "description": "Змініть встановлений ключ у глобальних налаштуваннях для UI Lovelace Minimalist." } } diff --git a/custom_components/ui_lovelace_minimalist/translations/zh-CN.json b/custom_components/ui_lovelace_minimalist/translations/zh-CN.json index 25fdc9f08..347e4ac3f 100644 --- a/custom_components/ui_lovelace_minimalist/translations/zh-CN.json +++ b/custom_components/ui_lovelace_minimalist/translations/zh-CN.json @@ -24,7 +24,7 @@ "reauth_successful": "重新验证成功。" }, "progress": { - "wait_for_device": "1. 访问 {url} \n2. 粘贴以下密钥以授权本集成: \n```\n{code}\n```\n" + "wait_for_device": "1. 访问 {url}\n2. 粘贴以下密钥以授权本集成:\n\n```{code}```" } }, "options": { @@ -59,9 +59,11 @@ }, "services": { "reload": { + "name": "Reload", "description": "为 UI Lovelace Minimalist 重载仪表盘配置。" }, "installed": { + "name": "Installed", "description": "为 UI Lovelace Minimalist 更改全局配置中的已安装密钥." } } diff --git a/custom_components/ui_lovelace_minimalist/utils/decode.py b/custom_components/ui_lovelace_minimalist/utils/decode.py index 9d42516c0..708f22f1a 100644 --- a/custom_components/ui_lovelace_minimalist/utils/decode.py +++ b/custom_components/ui_lovelace_minimalist/utils/decode.py @@ -1,4 +1,5 @@ """Util to decode content from the github API.""" + from base64 import b64decode diff --git a/custom_components/ui_lovelace_minimalist/utils/logger.py b/custom_components/ui_lovelace_minimalist/utils/logger.py index 699d7f1fe..47a77c07e 100644 --- a/custom_components/ui_lovelace_minimalist/utils/logger.py +++ b/custom_components/ui_lovelace_minimalist/utils/logger.py @@ -1,4 +1,5 @@ """Custom logger for HACS.""" + import logging from ..const import PACKAGE_NAME diff --git a/docs/setup/adaptive_dash.md b/docs/setup/adaptive_dash.md index 5c49f650c..767cd371c 100644 --- a/docs/setup/adaptive_dash.md +++ b/docs/setup/adaptive_dash.md @@ -3,7 +3,9 @@ title: Adaptive Dashboard hide: - toc --- + + ![Minimalist_adaptive_dashboard](../assets/img/setup/minimalist_adaptive_dash.gif) ## Add Adaptive Dashboard @@ -16,11 +18,11 @@ This dashboard automatically changes based on the device/screen size your are us This dashboard make extensive use of `state-switch` and `layout-card`. These are available through HACS or as manual install from Github. !!! warning "Warning" - For now the `state-switch` works only with version `v1.9.3` or below! +For now the `state-switch` works only with version `v1.9.3` or below! -| Additional lovelace resources | -| ----------------------------------------------------------------------- | -| [`layout-card`](https://github.com/thomasloven/lovelace-layout-card) | +| Additional lovelace resources | +| ---------------------------------------------------------------------- | +| [`layout-card`](https://github.com/thomasloven/lovelace-layout-card) | | [`state-switch`](https://github.com/thomasloven/lovelace-state-switch) | You need also configure an `input_select` with options for each popup_card and view you have configured. This `input_select` controls the cards showing on the right-side of the screen when in fullscreen mode. @@ -62,16 +64,16 @@ We have also added a folder with all the needed files to customizing your new da ```yaml config └── ui_lovelace_minimalist - ├── custom_cards - └── dashboard - └── ui-lovelace.yaml - └── adaptive-dash - └── adaptive-ui.yaml - └── popup - └── popup.yaml - └── views - └── livingroom.yaml - └── main.yaml +├── custom_cards +└── dashboard +└── ui-lovelace.yaml +└── adaptive-dash +└── adaptive-ui.yaml +└── popup +└── popup.yaml +└── views +└── livingroom.yaml +└── main.yaml ``` ## Customizing @@ -140,11 +142,11 @@ First you need to add the `input_select` you have created to the file. entity: input_select.minimalist_ui # put your input_select here ``` -We preconfigured multiple popups for different types of devices. In `popup.yaml` you only have to complete the information in the variables part. The `light 1`, `mediaplayer 1`, `livingroom` parts in the code refer to the options you have configuered in your `input_select`. Make sure they are spelled the same. ([see documentation on `state-switch`](https://github.com/thomasloven/lovelace-state-switch)) +We preconfigured multiple popups for different types of devices. In `popup.yaml` you only have to complete the information in the variables part. The `light 1`, `mediaplayer 1`, `livingroom` parts in the code refer to the options you have configured in your `input_select`. Make sure they are spelled the same. ([see documentation on `state-switch`](https://github.com/thomasloven/lovelace-state-switch)) !!! warning "Warning" - Only uncomment the options you have configured! - Else it could result in multiple errors in the dev-console of your browser. +Only uncomment the options you have configured! +Else it could result in multiple errors in the dev-console of your browser. Follow this part to add a card to an option of your `input_select`: To add a light popup to your first light card you just have to add the corresponding entity: diff --git a/docs/setup/custom_actions.md b/docs/setup/custom_actions.md index 33b34270b..da2a97053 100644 --- a/docs/setup/custom_actions.md +++ b/docs/setup/custom_actions.md @@ -3,7 +3,9 @@ title: Custom actions hide: - toc --- + + ## Customize tap, double-tap and hold actions This 'theme' do offer support for customizing actions. Tap, double-tap and hold on different parts (card, icon and name) of the cards could be changed. To achieve this customization follow the instructions on this page. @@ -25,19 +27,18 @@ ulm_custom_actions: ulm_name_tap_action: "more-info" ulm_name_hold_action: "toggle" ulm_name_double_tap_action: "popup" - ``` Possible values for each variables are : -| Value | Description | -|------------|---------------------------------------------------------------------------------------------------------------------------------| -| none | No action | -| toggle | Toggle an entity if available (for binary_sensor and sensor entity, `none` action is used) | -| more-info | Display more-info window | -| popup | Display UI LOVELACE MINIMALIST popup if available and enabled on card (if not `more-info` action is used) | -| adaptive | Switch UI LOVELACE MINIMALIST popup on adaptive dashboard
if current dashboard is adaptive (if not `popup` action is used) | -| navigate | Navigate to an other UI LOVELACE MINIMALIST view. Need additional variable (see below) | +| Value | Description | +| --------- | ------------------------------------------------------------------------------------------------------------------------------ | +| none | No action | +| toggle | Toggle an entity if available (for binary_sensor and sensor entity, `none` action is used) | +| more-info | Display more-info window | +| popup | Display UI LOVELACE MINIMALIST popup if available and enabled on card (if not `more-info` action is used) | +| adaptive | Switch UI LOVELACE MINIMALIST popup on adaptive dashboard
if current dashboard is adaptive (if not `popup` action is used) | +| navigate | Navigate to an other UI LOVELACE MINIMALIST view. Need additional variable (see below) | ## Haptic feedback @@ -60,8 +61,7 @@ ulm_custom_actions: ulm_name_double_tap_haptic: "none" ``` -Possible values for each variables (according to the underlying [button card]( -https://github.com/custom-cards/button-card)) are : +Possible values for each variables (according to the underlying [button card](https://github.com/custom-cards/button-card)) are : - `none` - `success` @@ -98,7 +98,6 @@ To define the path of `navigate` action, add one of the following depending on y variables: ulm_name_hold_action: "navigate" ulm_name_hold_navigate_path: "/adaptive-dash/Livingroom" - ``` ## Call service action @@ -130,7 +129,6 @@ tap action. ulm_name_tap_service: "light.toggle" ulm_name_tap_service_data: entity_id: light.light_livingroom_2 - ``` ## Overwrite custom actions @@ -145,7 +143,6 @@ For example, this code will overwrite the tap action on card with `more-info` ac variables: ulm_card_tap_action: "more-info" ulm_card_tap_haptic: "success" - ``` ## Custom Popups @@ -164,7 +161,7 @@ within the `ulm_custom_popup`. This `entity` variable is optional. It is also po custom popup it the `entity` variable within the `ulm_custom_popup is set to`none`. ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_power_outlet entity: switch.power_outlet_livingroom variables: @@ -178,7 +175,6 @@ custom popup it the `entity` variable within the `ulm_custom_popup is set to`non ulm_popup_power_outlet_sensor2: sensor.power_outlet_livingroom_consumption ulm_popup_power_outlet_graph_sensor: sensor.power_outlet_livingroom ulm_popup_power_outlet_entity: switch.power_outlet_livingroom - ``` The available popup templates `popup_media_player_infos`, `popup_light_brightness`, `popup_thermostat_temperature` @@ -318,7 +314,6 @@ custom_card: ulm_name_double_tap_service: "[[[ return variables.ulm_name_double_tap_service; ]]]" ulm_name_double_tap_service_data: "[[[ return variables.ulm_name_double_tap_service_data]]]" ulm_custom_popup: "[[[ return variables.ulm_custom_popup; ]]]" - ``` !!! tip "For developes who have already implemented the custom actions on their card" @@ -354,10 +349,9 @@ The following code won't work on custom popup cards: ```yaml popup_weather_forecast: -... - variables: - ulm_weather_popup_surpress_first_forecast: false -... +--- +variables: + ulm_weather_popup_surpress_first_forecast: false ``` Instead of using the variables section of the card the variables must be checked within a JavaScript template. The following @@ -376,4 +370,4 @@ element: > ]]] ``` -The code checks if the variable is available before reading from the variabl and if the variable isn't available it will set a default value. +The code checks if the variable is available before reading from the variable and if the variable isn't available it will set a default value. diff --git a/docs/usage/cards/card_battery.md b/docs/usage/cards/card_battery.md index 662aa3444..3d4043d56 100644 --- a/docs/usage/cards/card_battery.md +++ b/docs/usage/cards/card_battery.md @@ -3,6 +3,7 @@ title: Battery Card hide: - toc --- + ## Description @@ -11,37 +12,37 @@ hide: Charging animation if `ulm_card_battery_charging_animation` is true: - +example-image The `battery-card` is a slightly enhanced `generic-card`, that can indicate whether and how a device is being charged and colors the icon based on the battery level. ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | This is your battery entity | -| ulm_card_battery_name | `friendly_name` | :material-close: | Customize name | -| ulm_card_battery_attribute | | :material-close: | If your entity provides the battery percent in an attribute (= not as an own sensor), fill in the attribute's name here. E.g. if you have `sensor.livingroom_thermometer` and the attribute for your battery power is `sensor.livingroom_thermometer.attributes.battery_percent`, you fill in battery_percent here. | -| ulm_card_battery_battery_state_entity_id | | :material-close: | Entity that holds the battery state (charging/discharging). If provided, the Icon will display the current status. | -| ulm_card_battery_charger_type_entity_id | | :material-close: | Entity that holds the charger type (ac/wireless/none). This Entity replaces the need for the `ulm_card_battery_battery_state_entity_id` entity. If provided, the Icon will display the current charger type. This is only useful if you charge your devices Wireless and with cable. | -| ulm_card_battery_charging_animation | `false` | :material-close: | Weather to show charging animation or not. If set to `true`, `ulm_card_battery_battery_state_entity_id` needs to be defined and `ulm_card_battery_charger_type_entity_id` will be ignored. | -| ulm_card_battery_battery_level_danger | | :material-check: | Changes the color of the Icon, if the battery level falls below the provided value. Must be higher than `ulm_card_battery_battery_level_waring` | -| ulm_card_battery_battery_level_waring | | :material-check: | Changes the color of the Icon, if the battery level falls below the provided value. | -| ulm_card_battery_color_battery_level_danger | var(--google-red) | :material-close: | Color of icon if battery level is within the 'danger' zone. | -| ulm_card_battery_color_battery_level_warning | var(--google-yellow) | :material-close: | Color of icon if battery level is within the 'warning' zone. | -| ulm_card_battery_color_battery_level_ok | var(--google-green) | :material-close: | Color of icon if battery level is not within the 'danger' or 'warning' zone. | +| Variable | Default | Required | Notes | +| -------------------------------------------- | -------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| entity | | :material-check: | This is your battery entity | +| ulm_card_battery_name | `friendly_name` | :material-close: | Customize name | +| ulm_card_battery_attribute | | :material-close: | If your entity provides the battery percent in an attribute (= not as an own sensor), fill in the attribute's name here. E.g. if you have `sensor.livingroom_thermometer` and the attribute for your battery power is `sensor.livingroom_thermometer.attributes.battery_percent`, you fill in battery_percent here. | +| ulm_card_battery_battery_state_entity_id | | :material-close: | Entity that holds the battery state (charging/discharging). If provided, the Icon will display the current status. | +| ulm_card_battery_charger_type_entity_id | | :material-close: | Entity that holds the charger type (ac/wireless/none). This Entity replaces the need for the `ulm_card_battery_battery_state_entity_id` entity. If provided, the Icon will display the current charger type. This is only useful if you charge your devices Wireless and with cable. | +| ulm_card_battery_charging_animation | `false` | :material-close: | Weather to show charging animation or not. If set to `true`, `ulm_card_battery_battery_state_entity_id` needs to be defined and `ulm_card_battery_charger_type_entity_id` will be ignored. | +| ulm_card_battery_battery_level_danger | | :material-check: | Changes the color of the Icon, if the battery level falls below the provided value. Must be higher than `ulm_card_battery_battery_level_waring` | +| ulm_card_battery_battery_level_waring | | :material-check: | Changes the color of the Icon, if the battery level falls below the provided value. | +| ulm_card_battery_color_battery_level_danger | var(--google-red) | :material-close: | Color of icon if battery level is within the 'danger' zone. | +| ulm_card_battery_color_battery_level_warning | var(--google-yellow) | :material-close: | Color of icon if battery level is within the 'warning' zone. | +| ulm_card_battery_color_battery_level_ok | var(--google-green) | :material-close: | Color of icon if battery level is not within the 'danger' or 'warning' zone. | ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_battery entity: sensor.battery_level variables: - ulm_card_battery_charger_type_entity_id: sensor.battery_level - ulm_card_battery_battery_level_danger: 30 - ulm_card_battery_battery_level_warning: 80 - ulm_card_battery_name: Smartphone + ulm_card_battery_charger_type_entity_id: sensor.battery_level + ulm_card_battery_battery_level_danger: 30 + ulm_card_battery_battery_level_warning: 80 + ulm_card_battery_name: Smartphone ``` ??? note "Template Code" diff --git a/docs/usage/cards/card_binary_sensor.md b/docs/usage/cards/card_binary_sensor.md index 4079ee9be..3073d33c5 100644 --- a/docs/usage/cards/card_binary_sensor.md +++ b/docs/usage/cards/card_binary_sensor.md @@ -3,6 +3,7 @@ title: Binary Sensor Card hide: - toc --- + ## Description @@ -13,14 +14,14 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_binary_sensor_show_last_changed | | :material-close: | `true` or `false` | -| ulm_card_binary_sensor_name | | :material-close: | Set custom Name | -| ulm_card_binary_sensor_icon | | :material-close: | Set custom Icon | -| ulm_card_binary_sensor_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_binary_sensor_force_background_color | `false` | :material-close: | Set `ulm_card_binary_sensor_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| --------------------------------------------- | ------- | ---------------- | ------------------------------------------------------------------------ | +| entity | | :material-check: | | +| ulm_card_binary_sensor_show_last_changed | | :material-close: | `true` or `false` | +| ulm_card_binary_sensor_name | | :material-close: | Set custom Name | +| ulm_card_binary_sensor_icon | | :material-close: | Set custom Icon | +| ulm_card_binary_sensor_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_binary_sensor_force_background_color | `false` | :material-close: | Set `ulm_card_binary_sensor_color` as background color in active state ` | !!! Warning "⚠️ Breaking Change `v1.0.1`" @@ -41,7 +42,7 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_binary_sensor variables: ulm_card_binary_sensor_alert: true diff --git a/docs/usage/cards/card_binary_sensor_alert.md b/docs/usage/cards/card_binary_sensor_alert.md index 302c5b39c..bac375d97 100644 --- a/docs/usage/cards/card_binary_sensor_alert.md +++ b/docs/usage/cards/card_binary_sensor_alert.md @@ -3,6 +3,7 @@ title: Binary Sensor Alert Card hide: - toc --- + ## Description @@ -13,15 +14,15 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_binary_sensor_alert_show_last_changed | | :material-close: | `true` or `false` | -| ulm_card_binary_sensor_alert_name | | :material-close: | Set custom Name | -| ulm_card_binary_sensor_alert_icon | | :material-close: | Set custom Icon | -| ulm_icon_alert_invert_state | false | :material-close: | Invert the alert state logic so an alert is shown when the sensor is "off" | -| ulm_card_binary_sensor_alert_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_binary_sensor_alert_force_background_color | `false` | :material-close: | Set `ulm_card_binary_sensor_alert_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| --------------------------------------------------- | ------- | ---------------- | ------------------------------------------------------------------------------ | +| entity | | :material-check: | | +| ulm_card_binary_sensor_alert_show_last_changed | | :material-close: | `true` or `false` | +| ulm_card_binary_sensor_alert_name | | :material-close: | Set custom Name | +| ulm_card_binary_sensor_alert_icon | | :material-close: | Set custom Icon | +| ulm_icon_alert_invert_state | false | :material-close: | Invert the alert state logic so an alert is shown when the sensor is "off" | +| ulm_card_binary_sensor_alert_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_binary_sensor_alert_force_background_color | `false` | :material-close: | Set `ulm_card_binary_sensor_alert_color` as background color in active state ` | !!! Warning "⚠️ Breaking Change `v1.0.1`" @@ -30,6 +31,7 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi variables: ulm_show_last_changed: true ``` + !!! Warning "⚠️ Breaking Change `v1.3.8`" `ulm_show_last_changed` is renamed to `ulm_card_binary_sensor_show_last_changed`: @@ -41,7 +43,7 @@ The `binary-sensor-card` is to show the state (on/off, open/close, etc.) of a bi ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_binary_sensor_alert variables: ulm_card_binary_sensor_alert: true diff --git a/docs/usage/cards/card_generic.md b/docs/usage/cards/card_generic.md index 9b187acb4..b057bcc80 100644 --- a/docs/usage/cards/card_generic.md +++ b/docs/usage/cards/card_generic.md @@ -3,6 +3,7 @@ title: Generic Card hide: - toc --- + ## Description @@ -13,18 +14,18 @@ This is the `generic-card` to display values from a sensor, eg. to show humidity ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_generic_name | | :material-close: | Set custom Name | -| ulm_card_generic_icon | | :material-close: | Set custom Icon | -| ulm_card_generic_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_generic_force_background_color | `false` | :material-close: | Set `ulm_card_generic_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| --------------------------------------- | ------- | ---------------- | ------------------------------------------------------------------ | +| entity | | :material-check: | | +| ulm_card_generic_name | | :material-close: | Set custom Name | +| ulm_card_generic_icon | | :material-close: | Set custom Icon | +| ulm_card_generic_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_generic_force_background_color | `false` | :material-close: | Set `ulm_card_generic_color` as background color in active state ` | ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_generic entity: sensor.next_waste_collection ``` diff --git a/docs/usage/cards/card_generic_swap.md b/docs/usage/cards/card_generic_swap.md index 6aa1ff132..879809fba 100644 --- a/docs/usage/cards/card_generic_swap.md +++ b/docs/usage/cards/card_generic_swap.md @@ -3,6 +3,7 @@ title: Generic Swap Card hide: - toc --- + ## Description @@ -13,18 +14,18 @@ This is a `generic-card` with swapped label and name. ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_generic_swap_name | | :material-close: | Set custom Name | -| ulm_card_generic_swap_icon | | :material-close: | Set custom Icon | -| ulm_card_generic_swap_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_generic_swap_force_background_color | `false` | :material-close: | Set `ulm_card_generic_swap_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| -------------------------------------------- | ------- | ---------------- | ----------------------------------------------------------------------- | +| entity | | :material-check: | | +| ulm_card_generic_swap_name | | :material-close: | Set custom Name | +| ulm_card_generic_swap_icon | | :material-close: | Set custom Icon | +| ulm_card_generic_swap_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_generic_swap_force_background_color | `false` | :material-close: | Set `ulm_card_generic_swap_color` as background color in active state ` | ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_generic_swap entity: sensor.next_waste_collection ``` diff --git a/docs/usage/cards/card_graph.md b/docs/usage/cards/card_graph.md index c213e8f53..8c7673a9a 100644 --- a/docs/usage/cards/card_graph.md +++ b/docs/usage/cards/card_graph.md @@ -3,47 +3,48 @@ title: Graph Card hide: - toc --- + ## Description ![example-image](../../assets/img/ulm_cards/card_graph.png){ width="500" } -The `card_graph` shows an entity with the actual state and a *min-graph-card* integrated. This can be used for a thermostat to show the actual temperature and the history. It now supports dual graphs as well as bar style graphs. +The `card_graph` shows an entity with the actual state and a _min-graph-card_ integrated. This can be used for a thermostat to show the actual temperature and the history. It now supports dual graphs as well as bar style graphs. ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | Your entity_id for the temperature sensor | -| ulm_card_graph_color | | :material-close: | This is to adjust your color value. Use a CSS variable from HA or set a color value (eg. #FFFFFF) | -| ulm_card_graph_name | | :material-close: | Set graph name | -| ulm_card_graph_icon | | :material-close: | Set custom icon | -| ulm_card_graph_entity | | :material-check: | Your entity_id for the temperature sensor | -| ulm_card_graph_entity2 | | :material-close: | Your entity_id for the second temperature sensor | -| ulm_card_graph_color2 | | :material-close: | This is to adjust your color value of the second graph. Use a CSS variable from HA or set a color value (eg. #FFFFFF) | -| ulm_card_graph_type | fill | :material-close: | This is to change the appearance of the graph. Default is fill, but line, bar are valid options. | -| ulm_card_graph_hours | 24 | :material-close: | How much time should the graph cover, default is 24 hours. | -| ulm_card_graph_points | 0.5 | :material-close: | Specify amount of data points the graph should display for each hour. A larger number results in a more detailed graph. | -| ulm_card_graph_group_by | interval | :material-close: | Specify type of grouping of data, dynamic interval, date or hour. | -| ulm_card_graph_line_width | 5 | :material-close: | Set the thickness of the line. | +| Variable | Default | Required | Notes | +| ------------------------- | -------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------- | +| entity | | :material-check: | Your entity_id for the temperature sensor | +| ulm_card_graph_color | | :material-close: | This is to adjust your color value. Use a CSS variable from HA or set a color value (eg. #FFFFFF) | +| ulm_card_graph_name | | :material-close: | Set graph name | +| ulm_card_graph_icon | | :material-close: | Set custom icon | +| ulm_card_graph_entity | | :material-check: | Your entity_id for the temperature sensor | +| ulm_card_graph_entity2 | | :material-close: | Your entity_id for the second temperature sensor | +| ulm_card_graph_color2 | | :material-close: | This is to adjust your color value of the second graph. Use a CSS variable from HA or set a color value (eg. #FFFFFF) | +| ulm_card_graph_type | fill | :material-close: | This is to change the appearance of the graph. Default is fill, but line, bar are valid options. | +| ulm_card_graph_hours | 24 | :material-close: | How much time should the graph cover, default is 24 hours. | +| ulm_card_graph_points | 0.5 | :material-close: | Specify amount of data points the graph should display for each hour. A larger number results in a more detailed graph. | +| ulm_card_graph_group_by | interval | :material-close: | Specify type of grouping of data, dynamic interval, date or hour. | +| ulm_card_graph_line_width | 5 | :material-close: | Set the thickness of the line. | ## Usage ```yaml - - type: 'custom:button-card' - template: card_graph - entity: sensor.livingroom_temperature - variables: - ulm_card_graph_color: "var(--google-blue)" - ulm_card_graph_name: Temperature Livingroom - ulm_card_graph_entity: sensor.livingroom_temperature - ulm_card_graph_color2: "var(--google-green)" - ulm_card_graph_entity2: sensor.bedgroom_temperature - ulm_card_graph_type: fill - ulm_card_graph_hours: 24 - ulm_card_graph_group_by: interval - ulm_card_graph_line_width: 5 +- type: "custom:button-card" + template: card_graph + entity: sensor.livingroom_temperature + variables: + ulm_card_graph_color: "var(--google-blue)" + ulm_card_graph_name: Temperature Livingroom + ulm_card_graph_entity: sensor.livingroom_temperature + ulm_card_graph_color2: "var(--google-green)" + ulm_card_graph_entity2: sensor.bedroom_temperature + ulm_card_graph_type: fill + ulm_card_graph_hours: 24 + ulm_card_graph_group_by: interval + ulm_card_graph_line_width: 5 ``` ??? note "Template Code" diff --git a/docs/usage/cards/card_input_boolean.md b/docs/usage/cards/card_input_boolean.md index 2f9d51565..16110d903 100644 --- a/docs/usage/cards/card_input_boolean.md +++ b/docs/usage/cards/card_input_boolean.md @@ -3,6 +3,7 @@ title: Input_boolean Card hide: - toc --- + ## Description @@ -13,18 +14,18 @@ The `input-boolean-card` is to switch an `input_boolean` on or off. ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_input_boolean_name | | :material-close: | Set custom Name | -| ulm_card_input_boolean_icon | | :material-close: | Set custom Icon | -| ulm_card_input_boolean_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_input_boolean_force_background_color | `false` | :material-close: | Set `ulm_card_input_boolean_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| --------------------------------------------- | ------- | ---------------- | ------------------------------------------------------------------------ | +| entity | | :material-check: | | +| ulm_card_input_boolean_name | | :material-close: | Set custom Name | +| ulm_card_input_boolean_icon | | :material-close: | Set custom Icon | +| ulm_card_input_boolean_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_input_boolean_force_background_color | `false` | :material-close: | Set `ulm_card_input_boolean_color` as background color in active state ` | ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_input_boolean entity: input_boolean.guest_mode variables: diff --git a/docs/usage/cards/card_light.md b/docs/usage/cards/card_light.md index 54d4b80fa..8a965c746 100644 --- a/docs/usage/cards/card_light.md +++ b/docs/usage/cards/card_light.md @@ -33,25 +33,25 @@ To use `popup_light` you need to set the variable `ulm_card_light_enable_popup` ## Variables -| Variable/Entity | Default | Required | Notes | Requirement | -| ------------------------------------- | --------------- | ---------------- | ------------------------------------------------------ | --------------------------------------------- | -| entity | | :material-check: | Your HA entity | | -| ulm_card_light_name | `friendly_name` | :material-close: | Customize name | | -| ulm_card_light_icon | `mdi:lightbulb` | :material-close: | Customize icon | | -| ulm_card_light_enable_slider | `false` | :material-close: | Enable slider | | -| ulm_card_light_enable_slider_minSet | `0` | :material-close: | Minimum brightness value user can select in the slider | Need `ulm_card_light_enable_slider: true` | -| ulm_card_light_enable_slider_maxSet | `100` | :material-close: | Maximum brightness value user can select in the slider | Need `ulm_card_light_enable_slider: true` | -| ulm_card_light_enable_collapse | `false` | :material-close: | Collapse slider when off | Need `ulm_card_light_enable_slider: true` | -| ulm_card_light_enable_horizontal | `false` | :material-close: | Enable horizontal card | | -| ulm_card_light_enable_horizontal_wide | `false` | :material-close: | Wider slider | Need `ulm_card_light_enable_horizontal: true` | -| ulm_card_light_color | `yellow` | :material-close: | Set a manual color from the theme for icon, slider and background | | -| ulm_card_light_enable_color | `false` | :material-close: | Enable icon and label light color from the light itself. | Overrides `ulm_card_light_color` | -| ulm_card_light_force_background_color | `false` | :material-close: | Force background light color even in light theme | | -| ulm_card_light_enable_popup | `false` | :material-close: | Enable `popup_light` | | -| ulm_card_light_enable_popup_tap | `false` | :material-close: | Enable `popup_light` on simple icon tap | | -| ulm_card_light_color_palette | | :material-close: | Add `select` entity to control color palette | | -| ulm_card_light_enable_buttons | `false` | :material-close: | Enable Preset Brightness Buttons | -| ulm_card_light_brightness_low/medium/high | | :material-close: | Override the Brightness defaults for Buttons - Percentages | +| Variable/Entity | Default | Required | Notes | Requirement | +| ----------------------------------------- | --------------- | ---------------- | ----------------------------------------------------------------- | --------------------------------------------- | +| entity | | :material-check: | Your HA entity | | +| ulm_card_light_name | `friendly_name` | :material-close: | Customize name | | +| ulm_card_light_icon | `mdi:lightbulb` | :material-close: | Customize icon | | +| ulm_card_light_enable_slider | `false` | :material-close: | Enable slider | | +| ulm_card_light_enable_slider_minSet | `0` | :material-close: | Minimum brightness value user can select in the slider | Need `ulm_card_light_enable_slider: true` | +| ulm_card_light_enable_slider_maxSet | `100` | :material-close: | Maximum brightness value user can select in the slider | Need `ulm_card_light_enable_slider: true` | +| ulm_card_light_enable_collapse | `false` | :material-close: | Collapse slider when off | Need `ulm_card_light_enable_slider: true` | +| ulm_card_light_enable_horizontal | `false` | :material-close: | Enable horizontal card | | +| ulm_card_light_enable_horizontal_wide | `false` | :material-close: | Wider slider | Need `ulm_card_light_enable_horizontal: true` | +| ulm_card_light_color | `yellow` | :material-close: | Set a manual color from the theme for icon, slider and background | | +| ulm_card_light_enable_color | `false` | :material-close: | Enable icon and label light color from the light itself. | Overrides `ulm_card_light_color` | +| ulm_card_light_force_background_color | `false` | :material-close: | Force background light color even in light theme | | +| ulm_card_light_enable_popup | `false` | :material-close: | Enable `popup_light` | | +| ulm_card_light_enable_popup_tap | `false` | :material-close: | Enable `popup_light` on simple icon tap | | +| ulm_card_light_color_palette | | :material-close: | Add `select` entity to control color palette | | +| ulm_card_light_enable_buttons | `false` | :material-close: | Enable Preset Brightness Buttons | | +| ulm_card_light_brightness_low/medium/high | | :material-close: | Override the Brightness defaults for Buttons - Percentages | | ## Usage diff --git a/docs/usage/cards/card_media_player.md b/docs/usage/cards/card_media_player.md index e8366d651..6a152fdc5 100644 --- a/docs/usage/cards/card_media_player.md +++ b/docs/usage/cards/card_media_player.md @@ -15,31 +15,30 @@ hide: ![example-image](../../assets/img/ulm_cards/card_media_player_art_controls.png){ width="500" } ![example-image](../../assets/img/ulm_cards/card_media_player_volume_slider.png){ width="500" } - The `card_media_player` shows you the _app_, the _title_ and the _album name_ playing, if the data is available through HA. The _app_ is shown via a different icon. +The `card_media_player` shows you the _app_, the _title_ and the _album name_ playing, if the data is available through HA. The _app_ is shown via a different icon. ## Variables -| Variable | Default | Required | Notes | -| -------------------------------------------- | ------- | ---------------- | ----------------------------------------------- | -| entity | | :material-check: | The media-player entity | -| ulm_card_media_player_name | | | Name to display for your media-player | -| ulm_card_media_player_icon | | | Change the icon displayed | -| ulm_card_media_player_enable_art | false | | Enable album picture on background | -| ulm_card_media_player_enable_controls | false | | Enable controls below the title | -| ulm_card_media_player_enable_volume_slider | false | | Enable volume slider below controls | -| ulm_card_media_player_enable_volume_buttons | false | | Enable volume buttons below controls | -| ulm_card_media_player_enable_volume_adjust | 5 | | Volume Adjust Amount - if not set then 1 for TV and 5 for Speaker | -| ulm_card_media_player_collapsible | false | | Controls are collapsible when state is off | -| ulm_card_media_player_idle_off | false | | If true "idle" states will count as "off" for collapse | -| ulm_card_media_player_player_controls_entity | entity | | Change the controlled entity | -| ulm_card_media_player_enable_popup | false | | Enable pop-up | -| ulm_card_media_player_more_info | false | | Displays artist and album info in the sub-label | -| ulm_card_media_player_power_button | false | | Show power button | -| ulm_card_media_player_color | `blue` | :material-close: | Set Custom Color | | -| ulm_card_media_player_force_background_color | `false` | :material-close: | Set `ulm_card_media_player_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| -------------------------------------------- | ------- | ---------------- | ----------------------------------------------------------------------- | +| entity | | :material-check: | The media-player entity | +| ulm_card_media_player_name | | | Name to display for your media-player | +| ulm_card_media_player_icon | | | Change the icon displayed | +| ulm_card_media_player_enable_art | false | | Enable album picture on background | +| ulm_card_media_player_enable_controls | false | | Enable controls below the title | +| ulm_card_media_player_enable_volume_slider | false | | Enable volume slider below controls | +| ulm_card_media_player_enable_volume_buttons | false | | Enable volume buttons below controls | +| ulm_card_media_player_enable_volume_adjust | 5 | | Volume Adjust Amount - if not set then 1 for TV and 5 for Speaker | +| ulm_card_media_player_collapsible | false | | Controls are collapsible when state is off | +| ulm_card_media_player_player_controls_entity | entity | | Change the controlled entity | +| ulm_card_media_player_enable_popup | false | | Enable pop-up | +| ulm_card_media_player_more_info | false | | Displays artist and album info in the sub-label | +| ulm_card_media_player_power_button | false | | Show power button | +| ulm_card_media_player_color | `blue` | :material-close: | Set Custom Color | +| ulm_card_media_player_force_background_color | `false` | :material-close: | Set `ulm_card_media_player_color` as background color in active state ` | !!! note - To use `popup_media_player` you need to set the variable `ulm_card_media_player_enable_popup` to `true`. This is a different approach as the other `popup_cards` use. +To use `popup_media_player` you need to set the variable `ulm_card_media_player_enable_popup` to `true`. This is a different approach as the other `popup_cards` use. ## Usage @@ -48,7 +47,7 @@ hide: template: card_media_player entity: media_player.livingroom_shield variables: - ulm_card_media_player_name : Livingroom Nvidia Shield + ulm_card_media_player_name: Livingroom Nvidia Shield ``` ??? note "Template Code" diff --git a/docs/usage/cards/card_power_outlet.md b/docs/usage/cards/card_power_outlet.md index da3a8c795..3cab9af2f 100644 --- a/docs/usage/cards/card_power_outlet.md +++ b/docs/usage/cards/card_power_outlet.md @@ -3,6 +3,7 @@ title: Power Outlet Card hide: - toc --- + ## Description @@ -13,19 +14,19 @@ This is the `power-outlet-card`. It shows you the state of a power outlet, and i ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | | :material-check: | | -| ulm_card_power_outlet_name | | :material-close: | Set custom Name | -| ulm_card_power_outlet_icon | | :material-close: | Set custom Icon | -|ulm_card_power_outlet_consumption_sensor| | :material-close: | If you set this sensor, the `power-outlet-card` shows the energy consumption next to the state. | -| ulm_card_power_outlet_color | `yellow` | :material-close: | Set Custom Color | | -| ulm_card_power_outlet_force_background_color | `false` | :material-close: | Set `ulm_card_power_outlet_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| -------------------------------------------- | -------- | ---------------- | ----------------------------------------------------------------------------------------------- | +| entity | | :material-check: | | +| ulm_card_power_outlet_name | | :material-close: | Set custom Name | +| ulm_card_power_outlet_icon | | :material-close: | Set custom Icon | +| ulm_card_power_outlet_consumption_sensor | | :material-close: | If you set this sensor, the `power-outlet-card` shows the energy consumption next to the state. | +| ulm_card_power_outlet_color | `yellow` | :material-close: | Set Custom Color | +| ulm_card_power_outlet_force_background_color | `false` | :material-close: | Set `ulm_card_power_outlet_color` as background color in active state ` | ## Usage ```yaml -- type: 'custom:button-card' +- type: "custom:button-card" template: card_power_outlet variables: ulm_card_power_outlet_consumption_sensor: sensor.power_outlet_livingroom_consumption diff --git a/docs/usage/cards/card_room.md b/docs/usage/cards/card_room.md index b6eea51a8..97b494a8f 100644 --- a/docs/usage/cards/card_room.md +++ b/docs/usage/cards/card_room.md @@ -3,6 +3,7 @@ title: Room Card hide: - toc --- + ## Description @@ -14,79 +15,79 @@ The card has support for up to 4 subicons at the right side of the card. These c ## Variables -| Variable | Default | Required | Notes | Requirement | -|----------------------------------------|-----------------|------------------|----------------|-------------| -| label_use_temperature | `true` | :material-close: | Define whether the label should show the current room temperature
The temperature should be provide by either a `temperature` or `current_temperature` attribute or by the entity state | -| label_use_brightness | `false` | :material-close: | Define whether the label should show the current room brightness of the lights
Requires `label_use_temperature` to be false | -| entity_1 | | :material-close: | a `room_entity` object (see below) | | -| entity_2 | | :material-close: | a `room_entity` object (see below) | | -| entity_3 | | :material-close: | a `room_entity` object (see below) | | -| entity_4 | | :material-close: | a `room_entity` object (see below) | | +| Variable | Default | Required | Notes | Requirement | +| --------------------- | ------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| label_use_temperature | `true` | :material-close: | Define whether the label should show the current room temperature
The temperature should be provide by either a `temperature` or `current_temperature` attribute or by the entity state | | +| label_use_brightness | `false` | :material-close: | Define whether the label should show the current room brightness of the lights
Requires `label_use_temperature` to be false | | +| entity_1 | | :material-close: | a `room_entity` object (see below) | | +| entity_2 | | :material-close: | a `room_entity` object (see below) | | +| entity_3 | | :material-close: | a `room_entity` object (see below) | | +| entity_4 | | :material-close: | a `room_entity` object (see below) | | ## Room entity -| Variable | Default | Required | Notes | Requirement | -|----------------------------------------|-----------------|------------------|----------------|-------------| -| entity_id | | :material-close: | The entity_id of the status icon | | -| templates | | :material-close: | List of the additional button card templates to apply to this icon | | -| tap_action | | :material-close: | tap_action for the icon (see button card documentation for options) | | -| hold_action | | :material-close: | tap_action for the icon (see button card documentation for options) | | +| Variable | Default | Required | Notes | Requirement | +| ----------- | ------- | ---------------- | ------------------------------------------------------------------- | ----------- | +| entity_id | | :material-close: | The entity_id of the status icon | | +| templates | | :material-close: | List of the additional button card templates to apply to this icon | | +| tap_action | | :material-close: | tap_action for the icon (see button card documentation for options) | | +| hold_action | | :material-close: | tap_action for the icon (see button card documentation for options) | | ## Default card options All the options from the button card are still available for the large room card. If you want to tweak this card a little bit more, below are some examples. The full list can be found here: [link](https://github.com/custom-cards/button-card#main-options) -| Options | Default | Required | Notes | Requirement | -|----------------------------------------|-----------------|------------------|----------------|-------------| -| entity | | :material-close: | The entity_id for the large card | | -| icon | | :material-close: | Icon to display. Defaults to the entity icon | | -| tap_action | | :material-close: | Define the type of action on click, if undefined, toggle will be used.
See [Action](https://github.com/custom-cards/button-card#Action)| | -| hold_action | | :material-close: | Define the type of action on hold, if undefined, nothing happens
See [Action](https://github.com/custom-cards/button-card#Action)| | -| label | | :material-close: | Change the label text | | -| title | | :material-close: | Change the title text | | +| Options | Default | Required | Notes | Requirement | +| ----------- | ------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| entity | | :material-close: | The entity_id for the large card | | +| icon | | :material-close: | Icon to display. Defaults to the entity icon | | +| tap_action | | :material-close: | Define the type of action on click, if undefined, toggle will be used.
See [Action](https://github.com/custom-cards/button-card#Action) | | +| hold_action | | :material-close: | Define the type of action on hold, if undefined, nothing happens
See [Action](https://github.com/custom-cards/button-card#Action) | | +| label | | :material-close: | Change the label text | | +| title | | :material-close: | Change the title text | | ## Usage ```yaml - - type: 'custom:button-card' - template: - - card_room - - red_no_state - name: Bathroom - entity: light.bathroom - icon: mdi:shower-head - tap_action: - action: navigate - navigation_path: '/ui-lovelace-minimalist/bathroom' - variables: - label_use_temperature: false - label_use_brightness: true - entity_1: - entity_id: light.bathroom - templates: - - yellow_on - tap_action: - action: toggle - entity_2: - entity_id: binary_sensor.badkamer_motion_sensor - templates: - - blue_on - tap_action: - action: none - entity_3: - entity_id: input_boolean.badkamer_motionsensor_enabled - templates: - - green_on - - red_off - tap_action: - action: toggle - entity_4: - entity_id: input_boolean.bath_mode - templates: - - pink_on - tap_action: - action: toggle +- type: "custom:button-card" + template: + - card_room + - red_no_state + name: Bathroom + entity: light.bathroom + icon: mdi:shower-head + tap_action: + action: navigate + navigation_path: "/ui-lovelace-minimalist/bathroom" + variables: + label_use_temperature: false + label_use_brightness: true + entity_1: + entity_id: light.bathroom + templates: + - yellow_on + tap_action: + action: toggle + entity_2: + entity_id: binary_sensor.badkamer_motion_sensor + templates: + - blue_on + tap_action: + action: none + entity_3: + entity_id: input_boolean.badkamer_motionsensor_enabled + templates: + - green_on + - red_off + tap_action: + action: toggle + entity_4: + entity_id: input_boolean.bath_mode + templates: + - pink_on + tap_action: + action: toggle ``` ??? note "Template Code" diff --git a/docs/usage/cards/card_scenes.md b/docs/usage/cards/card_scenes.md index 2eff76083..c428a481e 100644 --- a/docs/usage/cards/card_scenes.md +++ b/docs/usage/cards/card_scenes.md @@ -3,6 +3,7 @@ title: Scenes Card hide: - toc --- + ## Description @@ -13,32 +14,32 @@ This card is part of the Welcome Scenes card and can be used separately to only ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity_1 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | -| entity_2 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_3 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_4 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_5 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_6 | none | :material-close: | Can be any common type of entity | -| entity_7 | none | :material-close: | Can be any common type of entity | +| Variable | Default | Required | Notes | +| -------- | ------------- | ---------------- | ----------------------------------------------------------------------------------------- | +| entity_1 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_2 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_3 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_4 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_5 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_6 | none | :material-close: | Can be any common type of entity | +| entity_7 | none | :material-close: | Can be any common type of entity | ## Entity Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| _entity_id | | :material-close: | Support almost all types of entities
Scenes do always show as off | -| _icon | | :material-close: | The icon to show | -| _name | | :material-close: | The name to show| -| _color | Random | :material-close: | Color of the icon
Can choose between: `blue`, `red`, `green`, `yellow`, `pink`, `purple`
If not specified, it will take a random color | -| _state | `on` or `playing` | :material-close: | Define `input_select` state or give manual state for pill to be full | -| _nav_path | | :material-close: | Navigate to another view
*Overrides other types of actions* +| Variable | Default | Required | Notes | +| ----------- | ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| \_entity_id | | :material-close: | Support almost all types of entities
Scenes do always show as off | +| \_icon | | :material-close: | The icon to show | +| \_name | | :material-close: | The name to show | +| \_color | Random | :material-close: | Color of the icon
Can choose between: `blue`, `red`, `green`, `yellow`, `pink`, `purple`
If not specified, it will take a random color | +| \_state | `on` or `playing` | :material-close: | Define `input_select` state or give manual state for pill to be full | +| \_nav_path | | :material-close: | Navigate to another view
_Overrides other types of actions_ | ## Usage !!! note "" - You can set 1 to 7 entities to show 1 to 7 pills dynamically
- If set none it uses `auto-entities` with max 5 pills +You can set 1 to 7 entities to show 1 to 7 pills dynamically
+If set none it uses `auto-entities` with max 5 pills ```yaml - type: "custom:button-card" diff --git a/docs/usage/cards/card_vacuum.md b/docs/usage/cards/card_vacuum.md index 415f24e8e..738e7e8d8 100644 --- a/docs/usage/cards/card_vacuum.md +++ b/docs/usage/cards/card_vacuum.md @@ -3,6 +3,7 @@ title: Vacuum Card hide: - toc --- + ## Description @@ -15,18 +16,18 @@ This is a card to control your Robot-vacuum. It has support for all vacuums whic ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| entity | `vacuum.*` | :material-check: | | -|`ulm_card_vacuum_name`| | :material-close: | Add a custom name | -|`ulm_card_vacuum_icon`| | :material-close: | Add a custom MDI icon | -|`ulm_card_vacuum_label`| | :material-close: | Add a custom label | -|`ulm_card_vacuum_room`| | :material-close: | Add a script to clean a specific room | -|`ulm_card_vacuum_room_icon`| | :material-close: | Add custom icon to the room script | -|`ulm_card_vacuum_camera`| | :material-close: | Add a camera entity to the card to show the vacuum map | -|`ulm_card_vacuum_camera_toggle`| | :material-close: | Only show the camera entity while cleaning | -| ulm_card_vacuum_color | state based | :material-close: | Set Custom Color | | -| ulm_card_vacuum_force_background_color | `false` | :material-close: | Set `ulm_card_vacuum_color` as background color in active state ` | | +| Variable | Default | Required | Notes | +| -------------------------------------- | ----------- | ---------------- | ----------------------------------------------------------------- | +| entity | `vacuum.*` | :material-check: | | +| `ulm_card_vacuum_name` | | :material-close: | Add a custom name | +| `ulm_card_vacuum_icon` | | :material-close: | Add a custom MDI icon | +| `ulm_card_vacuum_label` | | :material-close: | Add a custom label | +| `ulm_card_vacuum_room` | | :material-close: | Add a script to clean a specific room | +| `ulm_card_vacuum_room_icon` | | :material-close: | Add custom icon to the room script | +| `ulm_card_vacuum_camera` | | :material-close: | Add a camera entity to the card to show the vacuum map | +| `ulm_card_vacuum_camera_toggle` | | :material-close: | Only show the camera entity while cleaning | +| ulm_card_vacuum_color | state based | :material-close: | Set Custom Color | +| ulm_card_vacuum_force_background_color | `false` | :material-close: | Set `ulm_card_vacuum_color` as background color in active state ` | ## Usage diff --git a/docs/usage/cards/card_welcome_scenes.md b/docs/usage/cards/card_welcome_scenes.md index 196683236..c1fe9d143 100644 --- a/docs/usage/cards/card_welcome_scenes.md +++ b/docs/usage/cards/card_welcome_scenes.md @@ -3,6 +3,7 @@ title: Welcome Scenes Card hide: - toc --- + ## Description @@ -13,45 +14,45 @@ This is a card which shows the basic needs for your dashboard. This card can gen ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| ulm_card_welcome_scenes_collapse | | :material-close: | Enables the collapse function.
requires an `input_boolean` to track the state| -| ulm_weather | | :material-check: | This is your weather provider.
Example: `weather.your_provider`| -| ulm_language | Language of your system | :material-close: | You can set a different format with the [BCP-47 language tags](https://www.techonthenet.com/js/language_tags.php)
Example: `"en-US"` or just `"en"`| -| entity_1 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | -| entity_2 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_3 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_4 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_5 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities| -| entity_6 | none | :material-close: | Can be any common type of entity | -| entity_7 | none | :material-close: | Can be any common type of entity | +| Variable | Default | Required | Notes | +| -------------------------------- | ----------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ulm_card_welcome_scenes_collapse | | :material-close: | Enables the collapse function.
requires an `input_boolean` to track the state | +| ulm_weather | | :material-check: | This is your weather provider.
Example: `weather.your_provider` | +| ulm_language | Language of your system | :material-close: | You can set a different format with the [BCP-47 language tags](https://www.techonthenet.com/js/language_tags.php)
Example: `"en-US"` or just `"en"` | +| entity_1 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_2 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_3 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_4 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_5 | auto-entities | :material-close: | Can be any common type of entity
if no entity is specified defaults to auto-entities | +| entity_6 | none | :material-close: | Can be any common type of entity | +| entity_7 | none | :material-close: | Can be any common type of entity | ## Entity Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -| _entity_id | | :material-close: | Support almost all types of entities
Scenes do always show as off | -| _icon | | :material-close: | The icon to show | -| _name | | :material-close: | The name to show| -| _color | Random | :material-close: | Color of the icon
Can choose between: `blue`, `red`, `green`, `yellow`, `pink`, `purple`
If not specified, it will take a random color | -| _state | `on` or `playing` | :material-close: | Define `input_select` state or give manual state for pill to be full | -| _nav_path | | :material-close: | Navigate to another view
*Overrides other types of actions* -| _service_data | | :material-close: | Data to be passed through to data_service. Useful for running scripts with custom fields/parameters +| Variable | Default | Required | Notes | +| -------------- | ----------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| \_entity_id | | :material-close: | Support almost all types of entities
Scenes do always show as off | +| \_icon | | :material-close: | The icon to show | +| \_name | | :material-close: | The name to show | +| \_color | Random | :material-close: | Color of the icon
Can choose between: `blue`, `red`, `green`, `yellow`, `pink`, `purple`
If not specified, it will take a random color | +| \_state | `on` or `playing` | :material-close: | Define `input_select` state or give manual state for pill to be full | +| \_nav_path | | :material-close: | Navigate to another view
_Overrides other types of actions_ | +| \_service_data | | :material-close: | Data to be passed through to data_service. Useful for running scripts with custom fields/parameters | ## Requirement Collapse Function !!! note "" - This feature is fully optional. It requires some more manual configuration! +This feature is fully optional. It requires some more manual configuration! You need to create a `input_boolean` in HA to track the state. See [Docs](https://www.home-assistant.io/integrations/input_boolean/). Furthermore, you need to add the `input_boolean` to the variable `ulm_card_welcome_scenes_collapse` **and** to either the `entity` or `triggers_update` to make sure it directly refreshes the state. !!! warning - Do not use `triggers_update: "all"`! This will lead to unwanted behavior with the random colors generator. +Do not use `triggers_update: "all"`! This will lead to unwanted behavior with the random colors generator. ## Usage !!! note "" - You can set 1 to 7 entities to show 1 to 7 pills dynamically
- If set none it uses `auto-entities` with max 5 pills +You can set 1 to 7 entities to show 1 to 7 pills dynamically
+If set none it uses `auto-entities` with max 5 pills ```yaml - type: "custom:button-card" diff --git a/docs/usage/chips/chip_mdi_icon_state.md b/docs/usage/chips/chip_mdi_icon_state.md index 0aae91388..662f23478 100644 --- a/docs/usage/chips/chip_mdi_icon_state.md +++ b/docs/usage/chips/chip_mdi_icon_state.md @@ -3,6 +3,7 @@ title: Mdi:icon State Chip hide: - toc --- + ## Description @@ -13,12 +14,12 @@ This `chip` displays an icon using [mdi](https://materialdesignicons.com/) and ` ## Variables -| Variable | Default | Required | Notes | -|----------|---------|------------------|-------------------| -|ulm_chip_mdi_icon_state_entity | | :material-check: | `entity` to link | | -|ulm_chip_mdi_icon_state_icon | | :material-close: | mdi:icon to display | -|ulm_chip_mdi_icon_state_icon_color | `primary-text-color` | :material-close: | Allow to change `icon` color | -|ulm_chip_mdi_icon_state_label_color | `primary-text-color` | :material-close: | Allow to change `label` color | +| Variable | Default | Required | Notes | +| ----------------------------------- | -------------------- | ---------------- | ----------------------------- | +| ulm_chip_mdi_icon_state_entity | | :material-check: | `entity` to link | +| ulm_chip_mdi_icon_state_icon | | :material-close: | mdi:icon to display | +| ulm_chip_mdi_icon_state_icon_color | `primary-text-color` | :material-close: | Allow to change `icon` color | +| ulm_chip_mdi_icon_state_label_color | `primary-text-color` | :material-close: | Allow to change `label` color | ## Usage diff --git a/docs/usage/custom_cards/custom_card_camera.md b/docs/usage/custom_cards/custom_card_camera.md index f8d304bf5..d06e8dbf9 100644 --- a/docs/usage/custom_cards/custom_card_camera.md +++ b/docs/usage/custom_cards/custom_card_camera.md @@ -3,6 +3,7 @@ title: Custom Camera Card hide: - toc --- + # Custom-card "Camera" @@ -21,7 +22,7 @@ Version: 1.0.0
1.0.1 -Added variable to passthough aspect ratio to the picture entity card. Fix minor issues with title. +Added variable to passthrough aspect ratio to the picture entity card. Fix minor issues with title.
1.0.0 @@ -39,7 +40,7 @@ Initial release. ulm_custom_card_camera_title: true ulm_custom_card_camera_name: "name" ulm_custom_card_camera_label: "label" - ulm_custom_card_camera_aspect_ratio: '16:9' + ulm_custom_card_camera_aspect_ratio: "16:9" ``` ## Variables diff --git a/docs/usage/custom_cards/custom_card_httpedo13_sun.md b/docs/usage/custom_cards/custom_card_httpedo13_sun.md index c7684decb..78ab73887 100644 --- a/docs/usage/custom_cards/custom_card_httpedo13_sun.md +++ b/docs/usage/custom_cards/custom_card_httpedo13_sun.md @@ -3,6 +3,7 @@ title: Sun Card Custom-card hide: - toc --- + # Custom-card "Sun" @@ -24,6 +25,7 @@ Initial release ## Requirements This card uses: +
Component / card
@@ -49,10 +51,10 @@ This card uses: ## Usage ```yaml - - type: custom:button-card - template: custom_card_httpedo13_sun - variables: - language: 'it' +- type: custom:button-card + template: custom_card_httpedo13_sun + variables: + language: "it" ``` ## Variables @@ -60,12 +62,12 @@ This card uses: The same sun card config. | Name | Accepted values | Description | Default | -|---------------|----------------------|--------------------------------------|-----------------------------------------------------| +| ------------- | -------------------- | ------------------------------------ | --------------------------------------------------- | | darkMode | `boolean` | Changes card colors to dark or light | Home assistant dark mode state | | language | `string`1 | Changes card language | Home assistant language or english if not supported | | showAzimuth | `boolean` | Displays azimuth in the footer | `false` | | showElevation | `boolean` | Displays elevation in the footer | `false` | | timeFormat | `'12h'`/`'24h'` | Displayed time format | Locale based on Home assistant language | -| title | `string` | Card title | Doesn't display a title by default | | +| title | `string` | Card title | Doesn't display a title by default | (1) Supported languages: `da`, `de`, `en`, `es`, `et`, `fi`, `fr`, `hu`, `it`, `nl`, `pl`, `pt-BR`, `ru`, `sl`, `sv` diff --git a/docs/usage/custom_cards/custom_card_imswel_medias.md b/docs/usage/custom_cards/custom_card_imswel_medias.md index e1994dc63..69c2405aa 100644 --- a/docs/usage/custom_cards/custom_card_imswel_medias.md +++ b/docs/usage/custom_cards/custom_card_imswel_medias.md @@ -29,6 +29,7 @@ Initial release ## Requirements This card needs the following to function correctly: + | Component | Required | | ----------------------------------------------------------------------------------------- | ---------------------------------- | |[Plex Recently Added](https://github.com/NemesisRE/sensor.plex_recently_added) | Yes for **`Media Library Card`** | @@ -40,6 +41,7 @@ This card needs the following to function correctly: **Media Library Card** for [Plex Recently Added](https://github.com/NemesisRE/sensor.plex_recently_added) : ![example-image-plex](../../assets/img/custom_card_imswel_medias/medias_library_plex.png)
+ | Variable | Default | Required | Notes | | ----------------------------- | ------- | -------- | ----------------------------------------------------------------------- | | ulm_custom_card_imswel_medias_index | 1 | Yes | The index of the item in your **Plex library** to show. | @@ -58,6 +60,7 @@ This card needs the following to function correctly: ![example-image-radarr](../../assets/img/custom_card_imswel_medias/medias_upcoming_radarr.png) ![example-image-sonarr](../../assets/img/custom_card_imswel_medias/medias_upcoming_sonarr.png)
+ | Variable | Default | Required | Notes | | ----------------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------- | | ulm_custom_card_imswel_medias_index | 1 | Yes | The index of the item in your **Radarr/Sonarr library** to show. | diff --git a/docs/usage/custom_cards/custom_card_nik_clock.md b/docs/usage/custom_cards/custom_card_nik_clock.md index 735bfa8a4..795f109fe 100644 --- a/docs/usage/custom_cards/custom_card_nik_clock.md +++ b/docs/usage/custom_cards/custom_card_nik_clock.md @@ -3,11 +3,12 @@ title: Tablet Clock Card hide: - toc --- + # Custom-card "Tablet clock Card" -This is a `custom-card` that shows the currenct time and Date. This is designed for a tablet or big monitor. +This is a `custom-card` that shows the current time and Date. This is designed for a tablet or big monitor. ![Screenshot](../../assets/img/custom_card_nik_clock.png) diff --git a/docs/usage/custom_cards/custom_card_nik_door.md b/docs/usage/custom_cards/custom_card_nik_door.md index 01b1f8941..282fba66f 100644 --- a/docs/usage/custom_cards/custom_card_nik_door.md +++ b/docs/usage/custom_cards/custom_card_nik_door.md @@ -8,7 +8,7 @@ hide: # Custom-card "Minimal Door Lock" -This is a `custom-card` that shows the currenct state of your Lock and allows you to open and close it showing the state with a Minimal Design. +This is a `custom-card` that shows the current state of your Lock and allows you to open and close it showing the state with a Minimal Design. ![Screenshot](../../assets/img/custom_card_nik_door.png) @@ -36,7 +36,6 @@ To have the Minimalist cards and custom cards installed ## Usage ```yaml - - type: "custom:button-card" template: "custom_card_nik_door" entity: "sensor.nuki_blindato_door_security_state" diff --git a/docs/usage/custom_cards/custom_template_shogun160_battery_info.md b/docs/usage/custom_cards/custom_template_shogun160_battery_info.md index 3400942cb..dbdc51781 100644 --- a/docs/usage/custom_cards/custom_template_shogun160_battery_info.md +++ b/docs/usage/custom_cards/custom_template_shogun160_battery_info.md @@ -27,9 +27,9 @@ This is an template to add the battery level to every ui minimalist card ## Variables -| Variable | Default | Required | Notes | -| -------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------ | -| ulm_battery_entity | | No | The entity to represent the battery_level +| Variable | Default | Required | Notes | +| ------------------ | ------- | -------- | ----------------------------------------- | +| ulm_battery_entity | | No | The entity to represent the battery_level | ## Usage with battery or battery_level attribute from entity
Component / card