https://github.com/andrey-git/home-assistant-customizer
Companion component for home-assistant CustomUI
https://github.com/andrey-git/home-assistant-customizer
Last synced: 11 months ago
JSON representation
Companion component for home-assistant CustomUI
- Host: GitHub
- URL: https://github.com/andrey-git/home-assistant-customizer
- Owner: andrey-git
- License: mit
- Created: 2017-07-23T10:59:42.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-05-28T18:25:28.000Z (about 8 years ago)
- Last Synced: 2024-08-10T14:14:40.518Z (almost 2 years ago)
- Language: Python
- Size: 13.7 KB
- Stars: 32
- Watchers: 9
- Forks: 32
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Home-assistant customizer comonent
Custom component for [home-assistant](https://home-assistant.io)
* Optionally loads CustomUI files. [HA 0.53+]
* Specify a list of attributes to hide from `more-info` window.
* Hide CustomUI - related attributes in `more-info` window. [HA 0.53+]
* Add services for dynamic customization.
* Set the width and number of UI columns (Requires CustomUI 20180112+)
## Installing
Put `customizer` dir in `/custom_components/`
## Using
`configuration.yaml` options (all optional):
attribute | type | description |
-- | -- | -- |
custom_ui [HA 0.53+]| local / hosted / debug
version_tag | Whether to fetch CustomUI files.
`local` loads it from `/www/custom_ui/state-card-custom-ui.html`.
`hosted` loads it from https://raw.githubusercontent.com/andrey-git/home-assistant-custom-ui/master/state-card-custom-ui.html
`debug` loads it from https://raw.githubusercontent.com/andrey-git/home-assistant-custom-ui/master/state-card-custom-ui-dbg.html
version_tag (for example 20170830) loads a tagged version from 'https://github.com/andrey-git/home-assistant-custom-ui/releases/download/20170830/state-card-custom-ui.html' |
hide_attributes | List of strings | List of attributes to hide from more-info popups. (Requires CustomUI) |
columns| List of integers | Pixel widths at which to add the next column. Default value is [300, 600, 900, 1200]
Example HA 0.53:
```yaml
customizer:
custom_ui: local
hide_attributes:
- node_id
- value_index
columns: [350, 700, 1050, 1400, 1850, 2100]
```
## Services
The component exposes a `set_attribute` service.
It sets (or clears) persistent attribute of an entity overriding any value set in code.
Like specifying it in `homeassistant -> customize` YAML section.
Note that calling `homeassistant.reload_core_config` service or changing customization via Config panel will reset overrides to their yaml state.
Service fields:
name | description | example
-- | -- | --
entity_id | Entity ID to set the attribute on | light.patio
attribute | Name of the attribute to set | friendly_name
value | (Optional) Value to set. Leave unspecified in order to clear set value. Note that when clearing attribute it will be empty (and not set-by-code) until next entity update | My light'
For example you can call:
```
customizer.set_attribute({"entity_id": "light.patio", "attribute": "friendly_name", "value": "My Light"}) to change the light name
```