Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates

This integration adds possibility to use new functions in Home Assistant Jinja2 templating engine.
https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates

home-assistant jinja2 jinja2-templates template templates

Last synced: about 2 months ago
JSON representation

This integration adds possibility to use new functions in Home Assistant Jinja2 templating engine.

Awesome Lists containing this project

README 

        
[![HACS Default][hacs_shield]][hacs]

[![GitHub Latest Release][releases_shield]][latest_release]

[![GitHub All Releases][downloads_total_shield]][releases]

[![Installations][installations_shield]][releases]

[![Community Forum][community_forum_shield]][community_forum]

[![Ko-Fi][ko_fi_shield]][ko_fi]

[![buycoffee.to][buycoffee_to_shield]][buycoffee_to]

[![PayPal.Me][paypal_me_shield]][paypal_me]

[![Revolut.Me][revolut_me_shield]][revolut_me]



[hacs_shield]: https://img.shields.io/static/v1.svg?label=HACS&message=Default&style=popout&color=green&labelColor=41bdf5&logo=HomeAssistantCommunityStore&logoColor=white

[hacs]: https://hacs.xyz/docs/default_repositories



[latest_release]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates/releases/latest

[releases_shield]: https://img.shields.io/github/release/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates.svg?style=popout



[releases]: https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates/releases

[downloads_total_shield]: https://img.shields.io/github/downloads/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates/total



[installations_shield]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fanalytics.home-assistant.io%2Fcustom_integrations.json&query=%24.custom_templates.total&style=popout&color=41bdf5&label=analytics



[community_forum_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Forum&style=popout&color=41bdf5&logo=HomeAssistant&logoColor=white

[community_forum]: https://community.home-assistant.io/t/custom-templates/528378



# Custom Templates



> [!CAUTION]

> This custom integration tampers with internal code of Home Assistant which _might_ cause some unforeseen issues (especially after HA updates).

> 

> If you encounter any problems related to templating engine or translations try uninstalling this integration before raising an issue in Home Assistant repository.



This integration adds possibility to use new functions in Home Assistant Jinja2 templating engine:

- `ct_state_translated` - returns translated state of an entity

- `ct_state_attr_translated` - returns translated value of an attribute of an entity

- `ct_translated` - returns translation for a given key

- `ct_all_translations` - returns all available translations (that can be used with `ct_translated`)

- `ct_eval` - evaluates text as a template

- `ct_is_available` - checks if given entity is available

- `ct_dict_merge` - Merges two or more dictionaries together. 



## Usage



### `ct_state_translated`



This function returns translated state of an entity.

Second parameter (language) is optional - it defaults to the language configured in Home Assistant.



Input



Output



```

State: {{ states("sun.sun") }}

Translated en: {{ ct_state_translated("sun.sun", "en") }}

Translated en: {{ "sun.sun" | ct_state_translated("en") }}

Translated nl: {{ ct_state_translated("sun.sun", "nl") }}

Translated nl: {{ "sun.sun" | ct_state_translated("nl") }}

```



```

State: below_horizon

Translated en: Below horizon

Translated en: Below horizon

Translated nl: Onder de horizon

Translated nl: Onder de horizon

```



### `ct_state_attr_translated`



This function returns translated value of an attribute of an entity.

Third parameter (language) is optional - it defaults to the language configured in Home Assistant.



Input



Output



```

Attribute: {{ state_attr("automation.example", "mode") }}

Translated en: {{ ct_state_attr_translated("automation.example", "mode", "en") }}

Translated en: {{ "automation.example" | ct_state_attr_translated("mode", "en") }}

Translated nl: {{ ct_state_attr_translated("automation.example", "mode", "nl") }}

Translated nl: {{ "automation.example" | ct_state_attr_translated("mode", "nl") }}

```



```

Attribute: single

Translated en: Single

Translated en: Single

Translated nl: Enkelvoudig

Translated nl: Enkelvoudig

```



### `ct_translated`



This function returns translation for a given key. You can use `ct_all_translations` to check available keys.

Second parameter (language) is optional - it defaults to the language configured in Home Assistant.



Input



Output



```yaml

Translated en: {{ ct_translated("component.sun.entity_component._.state.below_horizon", "en") }}

Translated en: {{ "component.sun.entity_component._.state.below_horizon" | ct_translated("en") }}

Translated nl: {{ ct_translated("component.sun.entity_component._.state.below_horizon", "nl") }}

Translated nl: {{ "component.sun.entity_component._.state.below_horizon" | ct_translated("nl") }}

```



```

Translated en: Below horizon

Translated en: Below horizon

Translated nl: Onder de horizon

Translated nl: Onder de horizon

```



### `ct_all_translations`



This function returns all available translations.

Parameter (language) is optional - it defaults to the language configured in Home Assistant.



Input



Output



```

{{ ct_all_translations("en") }}

```



```json

{

  "component.sun.entity_component._.state.above_horizon": "Above horizon",

  "component.sun.entity_component._.state.below_horizon": "Below horizon"

}

```



### `ct_eval`



This function evaluates text as a template.



Input



Output



```yaml

{% set template_text = "{{ states('sun.sun') }}" %}

{{ ct_eval(template_text) }}

{{ template_text | ct_eval }}

```



 



```

below_horizon

below_horizon

```



### `ct_is_available`



This function checks if given entity has an available state.

By default, the following states are treated as not available: `unknown`, `unavailable`, ``, `None`.

It is possible to override this list by providing a second argument.



Input



Output



```yaml

{{ states('sensor.invalid') }}

{{ ct_is_available('sensor.invalid') }}

{{ ct_is_available('sensor.invalid', ['', 'unknown']) }}

```



 



```

unavailable

true

false

```



### `ct_dict_merge`



This function will merge one or more dictionaries (mappings) together into a single dictionary.

If any key is shared between two or more dictionaries, the value of the key will be the last value passed.



Input



Output



```yaml

{% set dict_1 = {'a':1,'b':2,'c':3} %}

{% set dict_2 = {'d':4,'e':5,'f':6} %}

{% set dict_3 = {'b':7,'d':8,'g':9} %}

{{ ct_dict_merge(dict_1, dict_1) }}

{{ ct_dict_merge(dict_1, dict_2) }}

{{ ct_dict_merge(dict_2, dict_3) }}

{{ ct_dict_merge(dict_1, dict_2, dict_3) }}

```



 



```django



{'a': 1, 'b': 2, 'c': 3}

{'a': 1, 'b': 2, 'c': 3, 'd': 4, 'e': 5, 'f': 6}

{'d': 8, 'e': 5, 'f': 6, 'b': 7, 'g': 9}

{'a': 1, 'b': 7, 'c': 3, 'd': 8, 'e': 5, 'f': 6, 'g': 9}

```



## Configuration



To use this integration you have to add following config in `configuration.yaml`:



* Without additional languages:

  ```yaml

  custom_templates:

  ```



* With additional languages:

  ```yaml

  custom_templates:

    preload_translations:

      - en

      - nl

  ```



A list of available language tags is available [here](https://github.com/home-assistant/core/blob/master/homeassistant/generated/languages.py), a list of descriptions of language tags is available [here](https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry).



Section `preload_translations` should contain a list of languages you want to use with translations-related functions.

If it is not provided only a language provided in HA config will be loaded.



## Installation



Since version v1.4.0 the minimal supported version of Home Assistant is 2024.5.0.



### Using [HACS](https://hacs.xyz/) (recommended)



This integration can be installed using HACS.

To do it search for `Custom Templates` in *Integrations* section.

 

### Manual



Download [*custom_templates.zip*](https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates/releases/latest/download/custom_templates.zip) and extract its contents to `config/custom_components/custom_templates` directory:

```bash

mkdir -p custom_components/custom_templates

cd custom_components/custom_templates

wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Custom-Templates/releases/latest/download/custom_templates.zip

unzip custom_templates.zip

rm custom_templates.zip

```



Finally, restart Home Assistant and configure the integration.



## Support



If you want to support my work with a donation you can use one of the following platforms:



  

    Platform

    Payment methods

    Link

    Comment

  

  

    Ko-fi

    

      
  • PayPal
    • 

          
  • Credit card
    • 

        

        

          Buy Me a Coffee at ko-fi.com

        

        

          
  • No fees
    • 

          
  • Single or monthly payment
    • 

        

      

      

        buycoffee.to

        

          
  • BLIK
    • 

          
  • Bank transfer
    • 

        

        

          Postaw mi kawę na buycoffee.to

        

        

      

      

        PayPal

        

          
  • PayPal
    • 

        

        

          PayPal Logo

        

        

          
  • No fees
    • 

        

      

      

        Revolut

        

          
  • Revolut
    • 

          
  • Credit Card
    • 

        

        

          Revolut

        

        

          
  • No fees
    • 

        

      
    


    [ko_fi_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Ko-Fi&color=F16061&logo=ko-fi&logoColor=white
    


    [ko_fi]: https://ko-fi.com/piotrmachowski
    


    [buycoffee_to_shield]: https://shields.io/badge/buycoffee.to-white?style=flat&labelColor=white&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAABhmlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw1AUhU9TpaIVh1YQcchQnayIijhKFYtgobQVWnUweemP0KQhSXFxFFwLDv4sVh1cnHV1cBUEwR8QVxcnRRcp8b6k0CLGC4/3cd49h/fuA4R6malmxzigapaRisfEbG5FDLzChxB6MIZ+iZl6Ir2QgWd93VM31V2UZ3n3/Vm9St5kgE8knmW6YRGvE09vWjrnfeIwK0kK8TnxqEEXJH7kuuzyG+eiwwLPDBuZ1BxxmFgstrHcxqxkqMRTxBFF1ShfyLqscN7irJarrHlP/sJgXltOc53WEOJYRAJJiJBRxQbKsBClXSPFRIrOYx7+QcefJJdMrg0wcsyjAhWS4wf/g9+zNQuTE25SMAZ0vtj2xzAQ2AUaNdv+PrbtxgngfwautJa/UgdmPkmvtbTIEdC3DVxctzR5D7jcAQaedMmQHMlPSygUgPcz+qYcELoFulfduTXPcfoAZGhWSzfAwSEwUqTsNY93d7XP7d+e5vx+AIahcq//o+yoAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH5wETCy4vFNqLzwAAAVpJREFUOMvd0rFLVXEYxvHPOedKJnKJhrDLuUFREULE7YDCMYj+AydpsCWiaKu29hZxiP4Al4aWwC1EdFI4Q3hqEmkIBI8ZChWXKNLLvS0/Qcza84V3enm/7/s878t/HxGkeTaIGziP+EB918nawu7Dq1d0e1+2J2bepnk2jFEUVVF+qKV51o9neBCaugfge70keoxxUbSWjrQ+4SUyzKZ5NlnDZdzGG7w4DIh+dtZEFntDA98l8S0MYwctNGrYz9WqKJePFLq80g5Sr+EHlnATp+NA+4qLaZ7FfzMrzbMBjGEdq8GrJMZnvAvFC/8wfAwjWMQ8XmMzaW9sdevNRgd3MFhvNpbaG1u/Dk2/hOc4gadVUa7Um425qii/7Z+xH9O4jwW8Cqv24Tru4hyeVEU588cfBMgpPMI9nMFe0BkFzVOYrYqycyQgQJLwTC2cDZCPeF8V5Y7jGb8BUpRicy7OU5MAAAAASUVORK5CYII=
    


    [buycoffee_to]: https://buycoffee.to/piotrmachowski
    


    [buy_me_a_coffee_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Buy%20me%20a%20coffee&color=6f4e37&logo=buy%20me%20a%20coffee&logoColor=white
    


    [buy_me_a_coffee]: https://www.buymeacoffee.com/PiotrMachowski
    


    [paypal_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=PayPal.Me&logo=paypal
    


    [paypal_me]: https://paypal.me/PiMachowski
    


    [revolut_me_shield]: https://img.shields.io/static/v1.svg?label=%20&message=Revolut&logo=revolut
    


    [revolut_me]: https://revolut.me/314ma