├── LICENSE.md ├── README.md └── docs ├── _config.yml ├── _layout └── default.html ├── about.md ├── addons.md ├── addons ├── air-visual.md ├── alarm.md ├── area-card.md ├── areas.md ├── battery.md ├── button.md ├── calendar.md ├── camera.md ├── custom-legacy.md ├── custom.md ├── device-counters.md ├── energy.md ├── entities.md ├── favorites.md ├── find-my.md ├── gauge.md ├── glance.md ├── google.md ├── header.md ├── history.md ├── humidifier.md ├── iframe.md ├── layout.md ├── logbook.md ├── logo.md ├── map.md ├── markdown.md ├── media-player.md ├── menu.md ├── meteoalarm.md ├── notifications.md ├── picture-elements.md ├── plant-status.md ├── plex.md ├── popups.md ├── profile.md ├── remote-control.md ├── sensor.md ├── shopping-list.md ├── statistics-card.md ├── statistics-graph.md ├── statistics.md ├── sun-card.md ├── themes.md ├── thermostat.md ├── tile.md ├── upcoming-media.md ├── view-selector.md ├── weather.md └── xbox.md ├── configuration.md ├── fixes └── readme.md ├── images ├── hki-1.png ├── hki-2.png ├── hki-3.png ├── hki-4.png ├── hki-air-visual.png ├── hki-alarm-1.png ├── hki-alarm-2.png ├── hki-area-card.png ├── hki-battery.png ├── hki-button-1.png ├── hki-button-2.png ├── hki-button-3.png ├── hki-button-4.png ├── hki-button-5.png ├── hki-button-6.png ├── hki-calendar.png ├── hki-camera.png ├── hki-energy-1.png ├── hki-energy-2.png ├── hki-energy-3.png ├── hki-entities.png ├── hki-favorites.png ├── hki-find-my.png ├── hki-gauge.png ├── hki-glance-1.png ├── hki-glance-2.png ├── hki-glance-3.png ├── hki-google.png ├── hki-header-logo.png ├── hki-header.png ├── hki-history-1.png ├── hki-history-2.png ├── hki-iframe.png ├── hki-logbook.png ├── hki-map.png ├── hki-markdown.png ├── hki-media-player.png ├── hki-menu.png ├── hki-meteoalarm.png ├── hki-notifications.png ├── hki-picture-elements-1.png ├── hki-picture-elements-2.png ├── hki-plant-status.png ├── hki-plex.png ├── hki-popup.png ├── hki-profile-1.png ├── hki-profile-2.png ├── hki-remote-control.png ├── hki-sensor.png ├── hki-shopping-list.png ├── hki-statistics-1.png ├── hki-statistics-2.png ├── hki-sun-card.png ├── hki-theme-midnight-black.jpg ├── hki-theme-orange-sunrise.jpg ├── hki-theme-orange-sunset.jpg ├── hki-theme-paper-white.jpg ├── hki-theme-purple-blur.jpg ├── hki-theme-sweet-pink.jpg ├── hki-themes.png ├── hki-thermostat-1.png ├── hki-thermostat-2.png ├── hki-tile.png ├── hki-upcoming.png ├── hki-view-selector-1.png ├── hki-view-selector-2.png ├── hki-weather-1.png ├── hki-weather-2.png └── hki-xbox.png ├── index.md ├── installation.md ├── issues.md ├── paypal-donate-button.png ├── splitting-the-config.md ├── thanks.md ├── updates.md ├── version.html └── version_compatible.html /README.md: -------------------------------------------------------------------------------- 1 | 2 | Buy Me A Coffee 3 | 4 | ![Maintenance](https://img.shields.io/maintenance/yes/2023.svg?style=plasticr) 5 | [![GitHub last commit](https://img.shields.io/github/last-commit/jimz011/homekit-infused.svg?style=plasticr)](https://github.com/jimz011/homekit-infused/commits/4.x.x) 6 | [![HA Version](https://img.shields.io/badge/Latest%20Compatible%20Home%20Assistant-2023.12.x%20-dodgerblue)](https://github.com/home-assistant/home-assistant/releases/latest) 7 | [![HKI Version](https://img.shields.io/badge/Latest%20Homekit%20Infused-2023.1.3%20-purple)](https://github.com/jimz011/homekit-infused/releases) 8 | 9 | ![GitHub stars](https://img.shields.io/github/stars/jimz011/homekit-infused?style=social) 10 | ![GitHub forks](https://img.shields.io/github/forks/jimz011/homekit-infused?style=social) 11 | ![GitHub watchers](https://img.shields.io/github/watchers/jimz011/homekit-infused?style=social) 12 | ![GitHub followers](https://img.shields.io/github/followers/jimz011?style=social) 13 | 14 | 15 | 16 | 17 | 18 | ## Homekit Infused 5 (Lovelace) by Jimz011 19 | 20 | This is Homekit Infused 5, a complete lovelace dashboard solution for Home Assistant. 21 | In a nutshell Homekit Infused will turn your Home Assistant dashboard into a Homekit styled variant with a beautiful header which gives a more tablet/phone app style to your dashboard. 22 | 23 | Note: Homekit Infused is a YAML style dashboard, this means that a basic understanding of YAML is advised. However if you follow the documentation/video tutorials you should be able to create a dashboard nonetheless. You should be able to create a beautiful dashboard without too much effort! 24 | 25 | Homekit Infused does NOT replace any of your existing dashboards so you can rest assured that installing HKI will not destroy any of your existing dashboards. You can use Homekit Infused in conjunction with other dashboards. 26 | 27 | In short Homekit Infused 5 is all of the below and much much more! 28 | - Having trouble convincing your partner to use HA? HKI has a really amazing WAF! 29 | - A beautiful header with notifications that is customizable per view and is added to each view for you automatically. 30 | - A customizable navigation bar which can also be set at the bottom of the screen. 31 | - An automatically created menu. 32 | - Create new views super fast by only defining a view name, title and icon. Just these lines will create a new view, a menu entry, a navigation bar button and icon and a header title, cool huh? 33 | - 2 Fully customizable themes where you can change the entire look and feel of Homekit Infused in REAL-TIME! 34 | - Share your own created themes with the HKI community by creating scripts, the best themes will be added to future HKI releases! 35 | - A LOT of preconfigured addons which you can add to any of your views, by default all addons are preconfigured for fast dashboard creation. 36 | - Custom addon which allows you to use ANY home assistant card available either core or community created cards. 37 | - A fully customizable per user profile menu. 38 | - A fully customizable Alarm panel. 39 | - Known to be one of the best documented dashboards around, HKI 5 is no different and even better! 40 | - Experienced users can go fully custom YAML on a per view basis (this is particularly useful for HKI 3 and 4 users that want to migrate) 41 | - Easy updates, copy/replace 2 folders on each update! 42 | - Blazing fast frontend, even with large setups (watch my video's to see it in action). 43 | - Over 200+ new settings compared to HKI 4! 44 | - And MUCH MUCH I mean MUCH more! 45 | 46 | *Note: None of the custom-cards used in this project are made by me and every custom-card used has a reference to their original creators as well as the original link to their repo's. All contributors/donators and people that gave me the inspiration are mentioned in the docs on the last page! 47 | 48 | ### Quick Links 49 | #### [Click here](https://jimz011.github.io/homekit-infused/) for the documentation 50 | #### [Click here](https://github.com/jimz011/homekit-infused/releases) to download the latest release 51 | #### [Click here](docs/addons.md) for addons 52 | #### [Click here](https://github.com/jimz011/homekit-infused/tree/5.x.x-personal/) to view how my personal Home Assistant is setup for HKI 5 53 | #### [Click here](https://github.com/jimz011/homekit-infused/tree/4.x.x-docs) if you were looking for Homekit Infused 4 54 | 55 | ### Support Links 56 | #### [Click here](https://www.youtube.com/jimz011) for my YouTube channel 57 | #### [Click here](https://www.youtube.com/playlist?list=PLezjWQmPsNpF9zNbWAXfm3mcnDwFYLdpT) for video guides on how to install and configure HKI 5! 58 | #### [Click here](https://discord.gg/WZvK4Cb) to join our Discord Community with over 4000+ members 59 | #### [Click here](https://community.home-assistant.io/t/homekit-infused-hki-v0-13-3/117086/1) for my HA Community Forum Thread 60 | 61 | ### Video and screenshots 62 | #### Screenshots 63 | 64 | ![Homekit Infused](docs/images/hki-1.png)![Homekit Infused](docs/images/hki-2.png) 65 | 66 | ![Homekit Infused](docs/images/hki-3.png)![Homekit Infused](docs/images/hki-4.png) 67 | 68 | ![Homekit Infused](docs/images/hki-find-my.png) 69 | 70 | #### Video 71 | [![Watch the video](https://img.youtube.com/vi/1ujzqV9c5Qk/maxresdefault.jpg)](https://youtu.be/1ujzqV9c5Qk) 72 | 73 | #### Included Themes (A powerful real-time theme editor included) 74 | 75 | ![Homekit Infused](docs/images/hki-theme-paper-white.jpg)![Homekit Infused](docs/images/hki-theme-midnight-black.jpg) 76 | 77 | ![Homekit Infused](docs/images/hki-theme-orange-sunrise.jpg)![Homekit Infused](docs/images/hki-theme-orange-sunset.jpg) 78 | 79 | ![Homekit Infused](docs/images/hki-theme-sweet-pink.jpg)![Homekit Infused](docs/images/hki-theme-purple-blur.jpg) 80 | 81 | 82 | #### Extra License Information 83 | Selling, reselling or redistribution of this dashboard is not permitted without my permission! 84 | 85 | -------------------------------------------------------------------------------- /docs/_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-slate 2 | show_downloads: false 3 | title: Homekit Infused 5 4 | google_analytics: UA-158593402-1 5 | # buttons: 6 | # zip_url: https://github.com/jimz011/homekit-infused/archive/refs/tags/2022.3.0.zip 7 | # zip_title: Download latest release 8 | # zip_hide: false 9 | # tar_hide: true 10 | -------------------------------------------------------------------------------- /docs/_layout/default.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | {% if site.google_analytics %} 7 | 8 | 14 | {% endif %} 15 | 16 | 17 | {% seo %} 18 | 19 | 20 | 21 | 22 | 23 | 24 | 39 | 40 |
41 | {% include anchor_headings.html html=content anchorClass='anchor-hash' anchorBody='#'%} 42 | 43 | 49 |
50 | 51 | 52 | -------------------------------------------------------------------------------- /docs/about.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | # About Me 14 | 15 | Hello everyone my name is Jimmy (jimz011) and I proudly present to you the latest version of Homekit Infused. 16 | I know there was a long 'silence' before I came with an update. I can certainly tell you why. Homekit Infused has been completely rewritten from the ground up. 17 | It took me months to rewrite all of it but it is finally done. (Take in account that I have a full-time job so time is a luxury product) 18 | 19 | So to start off, I must sadly announce that there is no upgrade path from previous versions of HKI, the reason for this is simple. The code has changed too much! 20 | It would be like trying to release the youtube app as an update to the facebook app. This is obviously not ideal and I had to choose to either continue the old project, or create a new one that should be better, especially considering the future. 21 | So I chose to rewrite everything and boy it was a lot of work, not only did I rewrite it, I also found ways for a lot of the config to be easier to set up. As a non-developer (I am a bartender) you can imagine all the headaches it caused me to figure out a way to do this. 22 | But I have found ways, they might not always seem very beautiful, because remember I'm not a programmer. But hey it works, which is all that counts. 23 | 24 | One of the major changes, which I might consider the biggest change of all is the removal of decluttering-cards. All templates are now handled through lovelace_gen as well as global configuration. Lovelace_gen was a requirement for a global config to happen. 25 | For all the users that made lots of customizations with this project not all hope is lost. All old decluttering-templates and cards can be cut/paste in the new config just like it was in the old one. So if you did make customizations you could still use them, but it might require you some extra work to put them on the right places. 26 | I will however advise you to switch over to lovelace_gen templates in the long term as this is the mod that we will see more and more in the future on other HA setups, mark my words. You can find tutorials on how to do this in the future in these docs. 27 | Why did I change to lovelace_gen? Well first and foremost it is a mod and not a card, it modifies the yaml parser and allows us to do templating stuff in lovelace. It also allows us to create decluttering style templates that can be used in a similar fashion that decluttering-card used. 28 | But it is more than that, it is currently also the only way I know of that is capable of building a global config. That is what this entire update is about, simplification. In the end only a few files will need to be edited to get you up and running fairly quickly. 29 | 30 | Anyways, lets not make this any longer than it should be and get into the project as I would love to tell you more about myself and why I use Home Assistant, but you can find a lengthy interview of me that I did a while back [here](https://gadget-freakz.com/interview-with-jimz011/). 31 | It isn't very recent anymore, but you will certainly get the idea. 32 | 33 | I hope you enjoy this release, 34 | 35 | Yours Sincerely, 36 | 37 | Jimz011 38 | -------------------------------------------------------------------------------- /docs/addons.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | ## Addons 14 | Addons are baked-in preconfigured cards that you can turn on/off on any view. You can add an addon by adding the key to your view configuration (which is done in /hki-user/config/views.yaml). ALL addons are preconfigured with a vertical-stack and a title, you MUST keep this in mind when defining addons. Each addon has some extra options for the stack, so the first section of each addons documentation shows you those extra options. 15 | 16 | You can control the placement of the addons by using the [layout](addons/layout.md) addon and/or by changing the order of defining your addons. The addons that are defined first will be rendered first. How to exactly configure an addon depends on the addon and you should read the addons specific documentation before adding them to your configuration. 17 | 18 | ```yaml 19 | # views.yaml (example how to add addons) 20 | my_view: 21 | subtitle: Overview 22 | icon: mdi:thermostat 23 | addons: 24 | thermostat: 25 | - title: My thermostats 26 | entities: 27 | - # Thermostat addon config here! 28 | 29 | my_second_view: 30 | subtitle: Overview 31 | icon: mdi:vacuum-cleaner 32 | addons: 33 | button: 34 | - title: My lights 35 | entities: 36 | - # Button addon config here! 37 | ``` 38 | # Addons 39 | 40 | | Name | Description | 41 | |--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 42 | | [air_visual](addons/air-visual.md) | A nice looking air quality card | 43 | | [area_card](addons/area-card.md) *new* | A HA core card that shows you area/room information | 44 | | [battery](addons/battery.md) | An addon to give your view a battery levels overview | 45 | | [button](addons/button.md) | The all powerful button-card, probably the only addon you'll ever need | 46 | | [calendar](addons/calendar.md) | The default Calendar card | 47 | | [camera](addons/camera.md) | An addon to add your camera's to a view | 48 | | [custom](addons/custom.md) | The ultimate addon that allows any card or multitude of cards! | 49 | | [energy](addons/energy.md) *updated* | Recreate the HA energy dashboard in lovelace | 50 | | [entities](addons/entities.md) | An easy to use entities card | 51 | | [favorites](addons/favorites.md) | Show a stack with shortcuts to your favorited views | 52 | | [gauge](addons/gauge.md) *updated* | Show simple gauges for your entities | 53 | | [glance](addons/glance.md) | An easy to use glance card | 54 | | [google](addons/google.md) | A Google Home TTS card | 55 | | [humidifier](addons/humidifier.md) *new* | Core humidifier card | 56 | | [history](addons/history.md) | This is the core HA graph card which you can use as an alternative to the graphs addon in HKI | 57 | | [iframe](addons/iframe.md) | A handy iFrame card that you can use on your views | 58 | | [logbook](addons/logbook.md) | Keep track of your entities with a logbook | 59 | | [markdown](addons/markdown.md) *new* | The core markdown card with all its features available | 60 | | [map](addons/map.md) | A map to track your entities | 61 | | [media_player](addons/media-player.md) | A Media Player addon | 62 | | [menu](addons/menu.md) | Show the menu on other views than.... menu! | 63 | | [meteoalarm](addons/meteoalarm.md) | A nice card to show you your weather alerts | 64 | | [picture_elements](addons/picture-elements.md) | The core picture elements card for HKI | 65 | | [plant_status](addons/plant-status.md) | Monitor your plants | 66 | | [plex](addons/plex.md) | A very beautiful Plex addon | 67 | | [remote_control](addons/remote-control.md) | A beautiful remote control for Nvidia Shield TV/Apple TV | 68 | | [sensor](addons/sensor.md) | A core sensor card | 69 | | [shopping_list](addons/shopping-list.md) *new* | A simple shopping list for use on your views | 70 | | [statistics_card](addons/statistics-card.md) *new* | The newly introduced core statistics card | 71 | | [statistics_graph](addons/statistics-graph.md) *renamed* | Create beautiful statistics graphs | 72 | | [sun_card](addons/sun-card.md) | A beautiful sun elevation card | 73 | | [tile](addons/tile.md) *new* | A handy tile card | 74 | | [upcoming_media](addons/upcoming-media.md) | Show your upcoming and recently added media from your sonarr/radarr | 75 | | [thermostat](addons/thermostat.md) *updated* | Thermostat buttons for your view | 76 | | [weather](addons/weather.md) | The weather addon for HKI, choose between core or simple-weather | 77 | | [xbox](addons/xbox.md) | An Xbox controller card | 78 | 79 | ### Advanced 80 | 81 | Addons can be defined multiple times, this is particularly useful when you want for example a view with a button stack at the top, a map in the middle and another button stack at the bottom. 82 | 83 | To define an extra addon of the same type in a single view you MUST add a suffix to the addon name, it doesn't matter what the name of the suffix is, as long as you use one. `addon_whatever:` 84 | 85 | ```yaml 86 | # views.yaml (example of defining multiple addons of the same type) 87 | my_view: 88 | title: Location 89 | addons: 90 | button: 91 | - title: My Quicktoggles 92 | entities: 93 | - switch.phone 94 | button_2: 95 | - title: My second quicktoggles 96 | entities: 97 | - switch.iphone 98 | button_whatever: 99 | - title: Another button addon 100 | entities: 101 | - switch.galaxy 102 | ``` 103 | 104 | Addons can also be conditional depending on a state of an entity! 105 | 106 | ```yaml 107 | # views.yaml (example of defining multiple addons of the same type) 108 | my_view: 109 | title: Location 110 | addons: 111 | button: 112 | - title: This will only show when Jimmy is home 113 | conditional: true 114 | conditions: 115 | - entity: person.jimmy 116 | state: "home" 117 | entities: 118 | - switch.phone 119 | button_2: 120 | - title: This will only show when Jimmy AND Stephanie are home 121 | conditional: true 122 | conditions: 123 | - entity: person.jimmy 124 | state: "home" 125 | - entity: person.stephanie 126 | state: "home" 127 | entities: 128 | - switch.iphone 129 | button_3: 130 | - title: This will only show when Jimmy is NOT home AND Stephanie IS home 131 | conditional: true 132 | conditions: 133 | - entity: person.jimmy 134 | state_not: "home" 135 | - entity: person.stephanie 136 | state: "home" 137 | entities: 138 | - switch.iphone 139 | ``` 140 | -------------------------------------------------------------------------------- /docs/addons/air-visual.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Air Visual 14 | 15 | A nice air quality card for your views. 16 | 17 | ### HACS Requirements 18 | 19 | | Name | Type | Description | 20 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | [Air Visual Card](https://github.com/dnguyen800/air-visual-card) | Frontend | A card that shows you air quality | 22 | 23 | You must have setup the Air Visual integration in Home Assistant (you can do this in the integrations section of Home Assistant) 24 | 25 | You can use any of the following options to modify your addon. 26 | 27 | ### Stack and Addon config 28 | 29 | | Name | Required | Default | Description | 30 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 31 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 32 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 33 | | weather | no | unknown | Setup a weather entity to show the weather in this card | 34 | | hide_header | no | true | Whether to show/hide the header title of this card (this is NOT the same as the title defined above) | 35 | | hide_face | no | false | Whether to show/hide the face icon in the card | 36 | | hide_weather | no | false | Whether to show/hide the weather information in the card, this might be useful if you already have another weather card on that view | 37 | | speed_unit | no | KM/h | Set your prefered speed unit e.g. `MP/s`, `KM/s` or `MP/h` | 38 | | air_pollution_level | yes | sensor.u_s_air_pollution_level | Set the air pollution sensor entity | 39 | | air_quality_index | yes | sensor.u_s_air_quality_index | Set the air quality index sensor entity | 40 | | main_pollutant | yes | sensor.u_s_main_pollutant | Set the main pollutant sensor entity | 41 | | city_name | no | unknown | Set your city name | 42 | | country | no | US | Set your country name | 43 | | conditional | no | false | Setting this to `true` will make the stack condtional | 44 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 45 | 46 | 47 | ```yaml 48 | # views.yaml (example) 49 | my_view: 50 | addons: 51 | air_visual: 52 | - air_pollution_level: sensor.u_s_air_pollution_level 53 | air_quality_index: sensor.u_s_air_quality_index 54 | main_pollutant: sensor.u_s_main_pollutant 55 | weather: weather.eindhoven 56 | city_name: Eindhoven 57 | ``` 58 | 59 | ### Images: 60 | 61 | ![Homekit Infused](../images/hki-air-visual.png) 62 | -------------------------------------------------------------------------------- /docs/addons/alarm.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Alarm 14 | 15 | You can setup your alarm in here including the header badge and/or popup. The settings on this page MUST be configured in `/hki-user/config/config.yaml`! 16 | 17 | | Name | Required | Default | Description | 18 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 19 | | entity | yes | alarm_control_panel.home_alarm | Sets the alarm entity used | 20 | | show_badge | no | true | Choose whether to show or hide the alarm badge in the header | 21 | | icon | no | predefined | Set your own alarm icon, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 22 | | icon_color | no | predefined | Set your own icon color, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 23 | | [tap_action](https://github.com/custom-cards/button-card#Action) | no | predefined | Set a custom tap_action, see [actions](https://github.com/custom-cards/button-card#Action) for more information, if you set a tap_action the default popup will no longer work and be replaced by this action instead | 24 | | [hold_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom hold_action, see [actions](https://github.com/custom-cards/button-card#Action) | 25 | | [double_tap_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom double_tap_action, see [actions](https://github.com/custom-cards/button-card#Action) | 26 | | popup | no | keypad | Design your own popup when clicking this badge (*Note: Will not work if tap_action is defined!*), this must be a list of cards! If ommitted it will show a keypad instead | 27 | 28 | ```yaml 29 | # config.yaml (default settings) 30 | alarm: 31 | entity: alarm_control_panel.home_alarm 32 | show_badge: true 33 | ``` 34 | ```yaml 35 | # config.yaml (example custom cards) 36 | alarm: 37 | entity: alarm_control_panel.home_alarm 38 | show_badge: true 39 | popup: 40 | - type: markdown 41 | content: My Alarm Panel 42 | - type: alarm-panel 43 | entity: alarm_control_panel.home_alarm 44 | ``` 45 | 46 | ### Images: 47 | 48 | ![Homekit Infused](../images/hki-alarm-2.png) 49 | ![Homekit Infused](../images/hki-alarm-1.png) 50 | -------------------------------------------------------------------------------- /docs/addons/area-card.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Area Card 14 | 15 | The Area card lets you control and monitor an individual area. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 3 | Define the number of columns this stack will use | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | | areas | yes | list of area ID's | List all your areas you want to show up here, you MUST use an Area ID | 29 | 30 | ### Areas Extra Options 31 | 32 | | Name | Required | Default | Description | 33 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 34 | | area | yes | undefined | Set the area used in this card, you must use the format `area: AREA_ID` | 35 | | show_camera | no | false | Changes the area picture to a live feed of the camera set for the area. | 36 | | navigation_path | no | undefined | link to another view e.g. `lights` | 37 | | name_size | no | 18px | Set the size of the name in the card | 38 | | name_color | no | var(--name-color) | Set the color of the name in the card | 39 | | sensor_label_size | no | 14px | Set the size of the label in the card | 40 | | sensor_color | no | var(--label-color) | Set the color of the label in the card | 41 | | sensor_opacity | no | 0.8 | Set the opacity of the label in the card | 42 | | sensor_icon_size | no | 18px | Set the size of the icon in the card | 43 | | sensor_margin | no | 0px | Set the margin-top of the label/icon in the card | 44 | 45 | 46 | ```yaml 47 | # views.yaml (example minimum) 48 | my_view: 49 | addons: 50 | area_card: 51 | - title: My Rooms 52 | areas: 53 | - livingroom 54 | - kitchen 55 | ``` 56 | ```yaml 57 | # views.yaml (example extra options) 58 | my_view: 59 | addons: 60 | area_card: 61 | - title: My Rooms 62 | areas: 63 | - area: livingroom 64 | name_color: Red 65 | sensor_icon_size: 20px 66 | - area: kitchen 67 | show_camera: true 68 | ``` 69 | 70 | ### Images: 71 | 72 | ![Homekit Infused](../images/hki-area-card.png) 73 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/area-card.png) -------------------------------------------------------------------------------- /docs/addons/areas.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Areas 14 | 15 | **Coming Soon!** 16 | -------------------------------------------------------------------------------- /docs/addons/battery.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Battery 14 | 15 | A nice looking HKI styled battery card 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 3 | Define the number of columns this stack will use | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | | entities | yes | list of entities | List all your entities you want to show up here | 29 | 30 | ```yaml 31 | # views.yaml (example) 32 | my_view: 33 | addons: 34 | battery: 35 | - title: Hue Dimmers 36 | columns: 3 37 | entities: 38 | - sensor.hallway_hue_dimmer 39 | - sensor.kitchen_hue_dimmer 40 | - sensor.office_hue_dimmer 41 | ``` 42 | ```yaml 43 | # views.yaml (example with multiple stacks) 44 | my_view: 45 | addons: 46 | battery: 47 | - title: Hue Dimmers 48 | columns: 3 49 | entities: 50 | - sensor.hallway_hue_dimmer 51 | - sensor.kitchen_hue_dimmer 52 | - sensor.office_hue_dimmer 53 | - title: IKEA Dimmers 54 | entities: 55 | - sensor.office_tradfri_dimmer 56 | - sensor.bedroom_tradri_dimmer 57 | - sensor.living_room_tradfri_dimmer 58 | ``` 59 | 60 | #### Battery Extra Options 61 | By default it will get the friendly_name from either the entity itself or when set from customize.yaml. You can however set your own friendly name here if you wanted to. 62 | 63 | | Name | Required | Default | Description | 64 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 65 | | entity | yes | undefined | Set the entity that should be used | 66 | | name | no | undefined | Sets the name of this entity | 67 | 68 | ```yaml 69 | # views.yaml (extra options) 70 | my_view: 71 | addons: 72 | battery: 73 | - title: Hue Dimmers 74 | entities: 75 | - entity: sensor.hallway_hue_dimmer 76 | name: Hallway 77 | - entity: sensor.kitchen_hue_dimmer 78 | name: Kitchen 79 | - entity: sensor.office_hue_dimmer 80 | name: Office 81 | ``` 82 | 83 | ### Images: 84 | 85 | ![Homekit Infused](../images/hki-battery.png) 86 | -------------------------------------------------------------------------------- /docs/addons/calendar.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Calendar 14 | 15 | The Home Assistant core calendar card 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | show_title | no | true | Show or hide the stack title | 25 | | initial_view | no | dayGridMonth | Choose between `dayGridMonth`, `dayGridDay`, and `listWeek` | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | | entities | yes | list of entities | Set your calendar entity/entities here, you can define more than one entity per stack | 30 | 31 | ```yaml 32 | # views.yaml (example) 33 | my_view: 34 | addons: 35 | calendar: 36 | - title: Birthdays 37 | initial_view: dayGridMonth 38 | entities: 39 | - calendar.contacts 40 | ``` 41 | ```yaml 42 | # views.yaml (example multiple stacks) 43 | my_view: 44 | addons: 45 | calendar: 46 | - title: Birthdays 47 | initial_view: dayGridMonth 48 | entities: 49 | - calendar.contacts 50 | - calendar.birthdays 51 | - title: Reminders 52 | initial_view: dayGridMonth 53 | entities: 54 | - calendar.reminders 55 | ``` 56 | 57 | ### Images: 58 | 59 | ![Homekit Infused](../images/hki-calendar.png) 60 | -------------------------------------------------------------------------------- /docs/addons/camera.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Camera 14 | 15 | Quickly show your camera's on any view! 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 3 | Define the number of columns this stack will use | 25 | | aspect_ratio | no | 16x10 | Set an aspect ratio for all the cameras in this stack | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | | entities | yes | list of entities | List all your entities you want to show up here | 30 | 31 | ### Cameras Extra Options 32 | By default you must enter an array of entities like in the examples below, this does not need extra options. 33 | You can define an entity as an object instead to make use of the options below. See examples. 34 | 35 | | Name | Required | Default | Description | 36 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 37 | | entity | yes | undefined | Set the entity used | 38 | | aspect_ratio | no | 16x10 | Set a custom aspect_ratio for this camera | 39 | | show_state | no | false | Choose to show the state of this camera | 40 | | camera_view | no | false | Choose between `auto` or `live`. Live will make the card show a live view, note that this might be heavy on your resources, it is recommended to keep this set to `auto` unless you really want this | 41 | 42 | Examples: 43 | 44 | ```yaml 45 | # views.yaml (example basic) 46 | my_view: 47 | addons: 48 | camera: 49 | - title: Unifi Camera's 50 | entities: 51 | - camera.living_room 52 | - camera.bedroom 53 | ``` 54 | ```yaml 55 | # views.yaml (example multiple stacks) 56 | my_view: 57 | addons: 58 | camera: 59 | - title: Unifi Camera's 60 | entities: 61 | - camera.living_room 62 | - camera.bedroom 63 | - title: Xiaomi Camera's 64 | entities: 65 | - camera.frontdoor 66 | - camera.kitchen 67 | ``` 68 | ```yaml 69 | # views.yaml (example with extra options) 70 | my_view: 71 | addons: 72 | camera: 73 | - title: Unifi Camera's 74 | entities: 75 | - entity: camera.living_room 76 | aspect_ratio: 4x3 77 | - entity: camera.bedroom 78 | camera_view: live 79 | ``` 80 | ```yaml 81 | # views.yaml (example mixed) 82 | my_view: 83 | addons: 84 | camera: 85 | - title: Unifi Camera's 86 | entities: 87 | - entity: camera.living_room 88 | aspect_ratio: 4x3 89 | - camera.bedroom 90 | ``` 91 | ```yaml 92 | # views.yaml (example global stack settings) 93 | my_view: 94 | addons: 95 | camera: 96 | - title: Unifi Camera's 97 | aspect_ratio: 16x9 98 | entities: 99 | - camera.living_room 100 | - camera.bedroom 101 | ``` 102 | 103 | #### Camera Tip 104 | Since camera's are rendered before most other addons we can make really cool views. Having multiple camera's in a row on the desktop. 105 | The example below will show all 4 camera's horizontally and below that a stack of buttons showing motion. 106 | ```yaml 107 | # views.yaml (example with the layout addon) 108 | my_view: 109 | layout: 110 | layout_type: custom:horizontal-layout 111 | layout: 112 | max_cols: 4 113 | addons: 114 | camera: 115 | - entities: 116 | - camera.living_room 117 | - entities: 118 | - camera.bedroom 119 | - entities: 120 | - camera.frontdoor 121 | - entities: 122 | - camera.backyard 123 | button: 124 | - title: Motion Sensors 125 | columns: 4 126 | entities: 127 | - binary_sensor.living_room 128 | - binary_sensor.bedroom 129 | - binary_sensor.frontdoor 130 | - binary_sensor.backyard 131 | ``` 132 | 133 | ### Images: 134 | 135 | ![Homekit Infused](../images/hki-camera.png) 136 | -------------------------------------------------------------------------------- /docs/addons/custom-legacy.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Custom Legacy 14 | *Warning: You can NOT use addons on a view that has `custom_legacy:` set!* 15 | 16 | Users of Homekit Infused v3 and v4 are already known to this concept. Homekit Infused allows you to disable all addons and create a view completely custom just like all previous versions of HKI could. This is useful if you don't want to use the addons and create the views with your own code. This setting is per view and can not be set globally. 17 | 18 | If you are looking for a way to add custom cards together with your addons you should take a look at the [custom:](custom.md) addon instead! 19 | 20 | To add your own cards to the view you must: 21 | - Create a folder in `/hki-user/custom_legacy` with the same name as the objectname of your view (in the example below this is `/hki-user/custom_legacy/living_room`) 22 | - If you added a custom path for your custom_cards then create a folder with that name instead! 23 | - Add the following line to your view config: 24 | 25 | ```yaml 26 | living_room: 27 | custom_legacy: 28 | ``` 29 | 30 | Tip: You can control the layout with the `layout` addon! 31 | 32 | ### Custom Legacy 33 | To use your custom cards on a view you must open the folder that we have just created and then create a new file. You can name the file anyway you want since the name of the file is not relevant for now. 34 | Lets say we have a file that is named `button-and-title.yaml` and add a piece of code to it. To make it easier to understand I chose a core lovelace card for this example 35 | 36 | ```yaml 37 | - type: entity-button 38 | entity: light.living_room 39 | ``` 40 | This will render an entity button on the chosen view. 41 | 42 | ### How to control the layout of the Custom Cards? 43 | Cards that are dropped into the views folder will be placed from top to bottom in alphabetical/numerical order (of the filename). 44 | E.g. 45 | 46 | ``` 47 | In the following folder /hki-user/custom_legacy/home/ you have 48 | buttons.yaml 49 | map-card.yaml 50 | weather-card.yaml 51 | ``` 52 | In this example the buttons will be at the top, below that there will be a map and below that there will be a weather card. 53 | 54 | Because the cards are always placed in alphabetical/numerical order of the FILENAME you can add a double digit in front of the name. 55 | This gives us the opportunity to sort the cards to our likings. 56 | 57 | E.g. 58 | ``` 59 | In the following folder /hki-user/custom_legacy/home/ you have 60 | 01.weather-card.yaml 61 | 02.buttons.yaml 62 | 03.map-card.yaml 63 | ``` 64 | In this example you can see that now there is a value and the names all start with the same letter/number. This means the second letter/number takes precedence. So in this example the top card will be a weather card, the second one will be buttons and the third is the map. 65 | You could also do this by naming them `a.weather-card.yaml` and `b.buttons.yaml`. HKI does NOT care about the filename and you can name it whatever you want it to be, it will simply ALWAYS render the cards in alphabetical/numerical order! 66 | 67 | You can also add your own files (since HKI doesn't care about the file names, it just cares about the order). 68 | 69 | ### What about styling? 70 | You can add the default HKI style to any card quickly by adding two lines to your cards. This will set the card up to use most of the HKI styles. Some of them aren't in there but can be added separately. You must add the following to your card: 71 | 72 | ```yaml 73 | card_mod: 74 | class: hki 75 | ``` 76 | ```yaml 77 | # (example giving HKI style to a card) 78 | - type: markdown 79 | card_mod: 80 | class: hki 81 | content: Hello 82 | ``` 83 | ```yaml 84 | # (example giving HKI style to a card with custom styles) 85 | - type: markdown 86 | card_mod: 87 | class: hki 88 | style: | 89 | ha-card { 90 | opacity: 0.4; 91 | } 92 | content: Hello 93 | ``` 94 | 95 | ### Advanced 96 | You can have multiple cards in a single file if you so desire, which might be the case if you want to organise your cards differently or you prefer to have the same type of cards in the same file for easier editing. 97 | When having multiple cards in a file it will still render everything in the same order, so imagine in our previous example that the `weather-card.yaml` file would have two cards (e.g. a simple weather card and a forecast card), it will render the FILES on alphabetical/numerical order, NOT the cards! Remember this! 98 | E.g. 99 | ``` 100 | In the following folder /hki-user/custom_legacy/home/ you have 101 | 01.weather-card.yaml (this one has two cards) 102 | 02.buttons.yaml 103 | 03.map-card.yaml 104 | ``` 105 | In this example the first card will be the simple weather card, the next one will be a forecast card (so the 2 cards in the first file go first). The third one will be the buttons and the fourth will be the map. 106 | So there are 3 files, but 4 cards (as in the first file there are two cards). 107 | 108 | If you wish to stick cards together you can use vertical or horizontal stacks within a file (https://www.home-assistant.io/lovelace/horizontal-stack/ and https://www.home-assistant.io/lovelace/vertical-stack/). 109 | 110 | -------------------------------------------------------------------------------- /docs/addons/device-counters.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Device Counters 14 | 15 | Settings for this can be found in `/hki-user/device-counters.yaml` and must be edited in that file. 16 | 17 | By default HKI has device counters to create sensors that will show you the amount of devices/lights etc that are on at this very moment. Currently you can only use the preconfigured items that are named in that file, this might change in the future. 18 | 19 | **NOTE:** It is advised to ALSO fill in the `all_entities:` sensor! 20 | 21 | ### Information 22 | When filling this file you get a few sensors that you can use in your setup. By default the header sensors should work out of the box (provided that you filled the device_counters.yaml file) 23 | You can use the sensors anywhere you like (for example inside of a navigation button), below is a list of all the available sensors you can use. You can find the documentation of how to setup a badge inside a button [here](https://github.com/jimz011/homekit-infused/blob/master/docs/addons/button-navigation.md) and find examples of my personal setup [here](https://github.com/jimz011/homekit-infused/blob/personal/homekit-infused/user/views/menu/menu-card.yaml). 24 | 25 | *Remember that this will NOT work without the device_counters.yaml file!!! 26 | 27 | List of available sensors to use: 28 | ```yaml 29 | - sensor.current_devices_on (to show all devices currently on) 30 | - sensor.current_lights_on (to show all lights currently on) 31 | - sensor.current_climate_entities_on (to show all climate devices currently on) 32 | - sensor.current_binary_sensors_on (to show all binary sensors currently on) 33 | - sensor.current_doors_open (to show all doors currently open) 34 | - sensor.current_windows_open (to show all windows currently open) 35 | - sensor.current_motion_sensors_on (to show all motion sensors currently active) 36 | - sensor.current_covers_open (to show all covers currently open) 37 | - sensor.current_garage_doors_open (to show all garage doors currently open) 38 | - sensor.current_fans_on (to show all fans currently on) 39 | - sensor.current_detectors_on (to show all detector entities, like gas/smoke/fire, currently on) 40 | ``` 41 | -------------------------------------------------------------------------------- /docs/addons/energy.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Energy 14 | 15 | This addon gives your view a wide range of different core energy cards. 16 | 17 | *NOTE: For more screenshots of what the options below look like, you can refer to the [official HA documentation](https://www.home-assistant.io/lovelace/energy/). This addon has quite a few different cards check them all out. 18 | 19 | You can use any of the following options to modify your addon. 20 | 21 | ### Stack and Addon Config 22 | 23 | | Name | Required | Default | Description | 24 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 25 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | | energy-date-selection | no | undefined | This card will allow you to pick what data to show. Changing it in this card will influence the data in all other cards. | 30 | | energy-usage-graph | no | undefined | The energy usage graph card shows the amount of energy your house has consumed, and from what source this energy came. It will also show the amount of energy your have returned to the grid. | 31 | | energy-solar-graph | no | undefined | The solar production graph card shows the amount of energy your solar panels have produced per source, and if setup and available the forecast of the solar production. | 32 | | energy-gas-graph | no | undefined | The gas consumption graph card shows the amount of gas consumed per source. | 33 | | energy-sources-table | no | undefined | The energy sources table card shows all your energy sources, and the corresponding amount of energy. If setup, it will also show the costs and compensation per source and the total | 34 | | energy-grid-neutrality-gauge | no | undefined | The grid neutrality gauge card represents your energy dependency. If the needle is in the purple, you returned more energy to the grid than you consumed from it. If it’s in the blue, you consumed more energy from the grid than you returned | 35 | | energy-solar-consumed-gauge | no | undefined | The solar consumed gauge represents how much of the solar energy was not used by your home and was returned to the grid. If you frequently return a lot, try to conserve this energy by installing a battery or buying an electric car to charge | 36 | | energy-carbon-consumed-gauge | no | undefined | The carbon consumed gauge card represents how much of the energy consumed by your home was generated using non-fossil fuels like solar, wind and nuclear. It includes the solar energy you generated your self | 37 | | energy-devices-graph | no | undefined | The devices energy graph show the energy usage per device, it is sorted by usage | 38 | | energy-distribution | no | undefined | The energy distribution card shows how the energy flowed, from the grid to your house, from your solar panels to your house and/or back to the grid. If setup, it will also tell you how many kWh of the energy you got from the grid was produced without using fossil fuels. If you set link_dashboard to true, the card will include a link to the energy dashboard | 39 | | energy-water-graph | no | undefined | The water consumption graph card shows the amount of water consumed per source. | 40 | | link_dashboard | no | false | Add this to your card to create a shortcut to your energy dashboard (this only works when using the `energy-distribution` type) 41 | 42 | ```yaml 43 | # views.yaml (example) 44 | my_view: 45 | addons: 46 | energy: 47 | - title: Energy Date Select 48 | type: energy-date-selection 49 | - title: Energy Usage 50 | type: energy-usage-graph 51 | ``` 52 | ```yaml 53 | # views.yaml (example of everything) 54 | my_view: 55 | addons: 56 | energy: 57 | - title: Energy Date Select 58 | type: energy-date-selection 59 | - title: Energy Usage 60 | type: energy-usage-graph 61 | - title: Energy Solar 62 | type: energy-solar-graph 63 | - title: Energy Gas 64 | type: energy-gas-graph 65 | - title: Energy Distribution with link 66 | type: energy-distribution 67 | link_dashboard: true 68 | - title: Energy Distribution without link 69 | type: energy-distribution 70 | - title: Energy Sources 71 | type: energy-sources-table 72 | - title: Grid Neutrality 73 | type: energy-grid-neutrality-gauge 74 | - title: Solar Consumed 75 | type: energy-solar-consumed-gauge 76 | - title: Carbon Consumed 77 | type: energy-carbon-consumed-gauge 78 | - title: Energy Devices 79 | type: energy-devices-graph 80 | ``` 81 | ```yaml 82 | # views.yaml (example no title) 83 | my_view: 84 | addons: 85 | energy: 86 | - type: energy-date-selection 87 | # or 88 | my_view: 89 | addons: 90 | energy: 91 | - title: hide 92 | type: energy-date-selection 93 | ``` 94 | 95 | ### Images: 96 | 97 | ![Homekit Infused](../images/hki-energy-1.png) 98 | 99 | ![Homekit Infused](../images/hki-energy-2.png) 100 | 101 | ![Homekit Infused](../images/hki-energy-3.png) 102 | -------------------------------------------------------------------------------- /docs/addons/entities.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Entities 14 | 15 | This addon gives your view a core entities card with ALL of the options available. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 25 | | conditional | no | false | Setting this to `true` will make the stack condtional | 26 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 27 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 28 | 29 | The documentation on this page is only a quick way to set it up, however you can use all the options available in the [OFFICIAL DOCUMENTATION](https://www.home-assistant.io/lovelace/entities/#options-for-entities). 30 | 31 | ```yaml 32 | # views.yaml (example) 33 | my_view: 34 | addons: 35 | entities: 36 | - title: Waste Collection 37 | entities: 38 | - sensor.mijnafvalwijzer_gft 39 | - sensor.mijnafvalwijzer_papier 40 | - sensor.mijnafvalwijzer_restafval 41 | ``` 42 | ```yaml 43 | # views.yaml (example with extra features) 44 | my_view: 45 | addons: 46 | entities: 47 | - title: My entities stack 48 | entities: 49 | - type: button 50 | icon: mdi:power 51 | name: Bed light transition 52 | action_name: Toggle light 53 | tap_action: 54 | action: call-service 55 | service: light.toggle 56 | service_data: 57 | entity_id: light.bed_light 58 | transition: 10 59 | - type: divider 60 | - type: attribute 61 | entity: sun.sun 62 | attribute: elevation 63 | name: Sun elevation 64 | prefix: "~" 65 | suffix: Units 66 | ``` 67 | ```yaml 68 | # views.yaml (example of a Unifi Dream Machine Pro card with header and footer) 69 | my_view: 70 | addons: 71 | entities: 72 | - title: Unifi Dream Machine Pro 73 | header: 74 | type: picture 75 | image: /local/images/udm-pro-transparant.png 76 | footer: 77 | type: graph 78 | entity: sensor.dream_machine_pro_cpu_temperature 79 | hours_to_show: 24 80 | detail: 2 81 | entities: 82 | - entity: sensor.dream_machine_pro_uptime 83 | name: Uptime 84 | - entity: sensor.dream_machine_pro_cpu_utilization 85 | name: CPU Utilization 86 | - entity: sensor.dream_machine_pro_memory_utilization 87 | name: Memory Utilization 88 | - entity: sensor.dream_machine_pro_storage_utilization 89 | name: Storage Utilization 90 | - entity: sensor.dream_machine_pro_recording_capacity 91 | name: Recording Capacity 92 | - entity: binary_sensor.dream_machine_pro_disk_0_health 93 | name: Disk Health 94 | ``` 95 | 96 | ### Images: 97 | 98 | ![Homekit Infused](../images/hki-entities.png) 99 | -------------------------------------------------------------------------------- /docs/addons/favorites.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Favorites 14 | 15 | This addon gives your view a set of buttons with shortcuts to your favorite/most used views. It will ONLY show shortcuts to views that have the following line set: 16 | 17 | ```yaml 18 | # views.yaml (example) 19 | my_view: 20 | show_in_favorites: true 21 | ``` 22 | 23 | You can use any of the following options to modify your addon. You MUST use at least one of the settings! 24 | 25 | ### Stack and Addon Config 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 30 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 31 | | conditional | no | false | Setting this to `true` will make the stack condtional | 32 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 33 | | columns | yes/no | 3 | Set how many buttons are shown horizontally | 34 | 35 | ```yaml 36 | # views.yaml (example) 37 | my_view: 38 | addons: 39 | favorites: 40 | - title: Favorites 41 | columns: 3 42 | ``` 43 | ```yaml 44 | # views.yaml (example no title) 45 | my_view: 46 | addons: 47 | favorites: 48 | - columns: 3 49 | # or 50 | my_view: 51 | addons: 52 | favorites: 53 | - title: hide 54 | columns: 3 55 | ``` 56 | 57 | ### Images: 58 | 59 | ![Homekit Infused](../images/hki-favorites.png) 60 | -------------------------------------------------------------------------------- /docs/addons/find-my.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Find My 14 | 15 | This addon is a complete and beautiful Find My addon inspired by Apple's own Find My application (and a little bit from @LRvdLinden). 16 | 17 | You can find the find_my shortcut in the profile menu. You MUST set up find_my in `/hki-user/config/config.yaml`! 18 | 19 | You can use any of the following options to modify your addon. Choose at least one of the categories for this to function properly! 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | persons | no | undefined | Set the persons you want to show in find_my | 24 | | devices | no | undefined | Set the devices you want to show in find_my | 25 | | vehicles | no | undefined | Set the vehicles you want to show in find_my | 26 | 27 | #### Find My Extra Options 28 | You can pass any of the options below to your entity to customize the look and feel. If you don't set icon or picture_entity it will try to get them from customize.yaml. 29 | 30 | | Name | Required | Default | Description | 31 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 32 | | name | no | global_name | Set a name for this entity | 33 | | entity | yes | undefined | Set the entity used, these work best with either `person` or `device_tracker` entities | 34 | | icon | no | global_icon | Specify a custom icon for your entity | 35 | | entity_picture | no | global_entity_picture | Specify a custom entity_picture for your entity | 36 | | battery_entity | no | undefined | If this entity has a separate battery entity you can enter it here, else no battery is shown | 37 | | geocoded_location_entity | no | undefined | If this entity has a separate geocoded location entity you can enter it here, else not geocoded location is shown | 38 | 39 | Examples: 40 | 41 | ```yaml 42 | # config.yaml (example persons) 43 | find_my: 44 | persons: 45 | - name: Jimmy 46 | entity: person.jimmy 47 | battery_entity: sensor.sm_n976b_battery_level 48 | geocoded_location_entity: sensor.sm_n976b_geocoded_location 49 | - name: Stephanie 50 | entity: person.stephanie 51 | battery_entity: sensor.sm_n986b_batterijniveau 52 | geocoded_location_entity: sensor.sm_n986b_gegeocodeerde_locatie 53 | ``` 54 | ```yaml 55 | # config.yaml (example persons and devices) 56 | find_my: 57 | persons: 58 | - name: Jimmy 59 | entity: person.jimmy 60 | battery_entity: sensor.sm_n976b_battery_level 61 | geocoded_location_entity: sensor.sm_n976b_geocoded_location 62 | - name: Stephanie 63 | entity: person.stephanie 64 | battery_entity: sensor.sm_n986b_batterijniveau 65 | geocoded_location_entity: sensor.sm_n986b_gegeocodeerde_locatie 66 | devices: 67 | - name: Tile Pro 68 | entity: device_tracker.dog 69 | - name: Note 10+ 5G 70 | entity: device_tracker.sm_n976b 71 | geocoded_location_entity: sensor.sm_n976b_geocoded_location 72 | battery_entity: sensor.sm_n976b_battery_level 73 | ``` 74 | 75 | #### Entity Picture Tips 76 | You can use entity pictures so that your view will look like the ones from the screenshots. It is recommended that you create the entity pictures yourself and not just enter pictures you find on the internet. 77 | 78 | The best settings will be to open paint/photoshop. Create a square of 130x130 pixels and put your entity picture in the middle of it (resize the photo at will). 79 | 80 | NOTE: The default theme uses a white button, if you want to use another color I recommend you to change the background color of the images you are going to use as well! 81 | 82 | #### Bonus Entity Picture Tips 83 | - If you have iCloud you can get beautiful ready to go images from the icloud website by logging in view icloud and then saving the images to your desktop. 84 | - If you use the Unifi Controller you can get some nice images as well by clicking any device and then click on report wrong icon (this will open up a search menu in which you can right-click to save, note that Apple users will want to try Chrome or Firefox since Safari doesn't support this). 85 | 86 | ### Images: 87 | 88 | ![Homekit Infused](../images/hki-find-my.png) 89 | -------------------------------------------------------------------------------- /docs/addons/gauge.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Gauge Card 14 | 15 | This addon gives your view a core gauge card that shows a simple gauge for an entity (or multiple entities). 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 1 | Set the number of gauges this stack will show horizontally | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | | entities | yes | undefined | Set your entity/entities here, you can define more than one entity per card | 29 | 30 | ### Gauge Extra Options 31 | The recommended method to change icons and/or friendly names is by the use of customize.yaml, however this is not always adequate enough for the customizations that we might want, you can pass any of the options below to your entity to customize the look and feel. 32 | 33 | By default you must enter an array of entities like in the examples below, this does not need extra options and will just get the global name/icon. 34 | You must define it as an object instead to make use of the options below. See examples. 35 | 36 | | Name | Required | Default | Description | 37 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 38 | | entity | yes | undefined | Set the entity used make sure to put `entity:` in the list and then the actual entity see example below | 39 | | name | no | global_name | Set a custom name for this entity | 40 | | unit | no | unit defined by entity | This will set the measurement unit this gauge | 41 | | min | no | unit defined by entity | This will set the minimum number to show this gauge | 42 | | max | no | unit defined by entity | This will set the maximum number to show this gauge | 43 | | severity | no | undefined | You can have colors shown on different severities for this gauge, you MUST use all three option `red`, `yellow` and `green` (see example below) | 44 | | needle | no | false | Show the gauge as a needle gauge. Required to be set to true, if using segments | 45 | | segments | no | undefined | List of colors and their corresponding start values. Segments will override the severity settings. Needle required to be true. | 46 | 47 | ### Segments 48 | 49 | | Name | Required | Default | Description | 50 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 51 | | from | yes | undefined | Value from which to start the color. | 52 | | color | yes | undefined | Color of the segment, may be any CSS color declaration like “red”, “#0000FF” or “rgb(255, 120, 0)”. | 53 | | label | no | undefined | Label of the segment. This will be shown instead of the value. | 54 | 55 | CSS variables can be used (instead of CSS ‘#rrggbb’) for default gauge segment colors: 56 | 57 | `var(--success-color)` for green color 58 | `var(--warning-color)` for yellow color 59 | `var(--error-color)` for red color 60 | `var(--info-color)` for blue color 61 | 62 | 63 | ```yaml 64 | # views.yaml (example) 65 | my_view: 66 | addons: 67 | gauge: 68 | - title: Gauges 69 | columns: 3 70 | entities: 71 | - sensor.unifi_gateway_mem 72 | - sensor.memory_use_percent 73 | ``` 74 | ```yaml 75 | # views.yaml (example with severity) 76 | my_view: 77 | addons: 78 | gauge: 79 | - title: Gauges 80 | columns: 2 81 | entities: 82 | - entity: sensor.unifi_gateway_mem 83 | name: UDM Memory 84 | severity: 85 | red: 90 86 | yellow: 60 87 | green: 10 88 | ``` 89 | ```yaml 90 | # views.yaml (example with segments) 91 | my_view: 92 | addons: 93 | gauge: 94 | - title: Gauges 95 | columns: 2 96 | entities: 97 | - entity: sensor.kitchen_humidity 98 | needle: true 99 | min: 20 100 | max: 80 101 | segments: 102 | - from: 0 103 | color: '#db4437' 104 | - from: 35 105 | color: '#ffa600' 106 | - from: 40 107 | color: '#43a047' 108 | - from: 60 109 | color: '#ffa600' 110 | - from: 65 111 | color: '#db4437' 112 | ``` 113 | 114 | ### Images: 115 | 116 | ![Homekit Infused](../images/hki-gauge.png) 117 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/gauge_card.gif) 118 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/gauge_segments.png) 119 | 120 | -------------------------------------------------------------------------------- /docs/addons/glance.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Glance Card 14 | 15 | This addon gives your view a core glance card. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | show_name | no | true | Choose whether to show the name of the entity | 25 | | show_icon | no | true | Choose whether to show the icon of the entity | 26 | | show_state | no | true | Choose whether to show the state of the entity | 27 | | columns | no | auto | Choose how many columns you want this card to have, if omitted than it will choose the column size automatically | 28 | | state_color | no | true | Choose whether to show a different color when the state is `on`, just like a light button would show | 29 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 30 | | conditional | no | false | Setting this to `true` will make the stack condtional | 31 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 32 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 33 | 34 | ```yaml 35 | # views.yaml (example) 36 | my_view: 37 | addons: 38 | glance: 39 | - title: Waste Collection 40 | columns: 3 41 | show_name: false 42 | entities: 43 | - sensor.mijnafvalwijzer_gft 44 | - sensor.mijnafvalwijzer_papier 45 | - sensor.mijnafvalwijzer_restafval 46 | ``` 47 | 48 | ### Images: 49 | 50 | ![Homekit Infused](../images/hki-glance-1.png) 51 | 52 | ![Homekit Infused](../images/hki-glance-2.png) 53 | 54 | ![Homekit Infused](../images/hki-glance-3.png) 55 | -------------------------------------------------------------------------------- /docs/addons/google.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Google 14 | 15 | This addon gives your view a simple Google TTS card. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### HACS Requirements 20 | 21 | | Name | Type | Description | 22 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | [Mini Media Player](https://github.com/kalkih/mini-media-player) | Frontend | This is a very feature rich media player card, it is only used in a simple form for this addon, but you can use the custom addon to go wild with this card | 24 | 25 | ### Stack and Addon Config 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 30 | | speaker_group | no | undefined | Set a group entity (useful if you want to control multiple entities at once) | 31 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 32 | | conditional | no | false | Setting this to `true` will make the stack condtional | 33 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 34 | | entities | yes | array | Add the entities you want in your stack, entities must be listed as an array and must be in the media_player domain | 35 | 36 | ```yaml 37 | # views.yaml (example) 38 | my_view: 39 | addons: 40 | google: 41 | - title: Google Home 42 | speaker_group: media_player.all_speakers 43 | entities: 44 | - media_player.badkamer_speaker 45 | - media_player.bijkeuken_speaker 46 | - media_player.woonkamer_speaker 47 | ``` 48 | 49 | ### Images: 50 | 51 | ![Homekit Infused](../images/hki-google.png) 52 | -------------------------------------------------------------------------------- /docs/addons/header.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Header 14 | 15 | **NOTE:** For any of the header badges to show an actual number you MUST setup [device counters](device-counters.md) FIRST! 16 | 17 | You can setup some parts of the header in here like which badges to show and whether or not to show the subtitle/notification bar. 18 | The settings on this page MUST be configured in `/hki-user/config/config.yaml`! 19 | 20 | | Name | Required | Default | Description | 21 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 22 | | show_subtitle | no | true | Choose whether to show the subtitle/notification bar | 23 | | badges | no | list | Set the badges to show in the header, you can have a maximum of 8, delete/comment out badges you don't want | 24 | 25 | #### Header Extra Options 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | name | yes | unknown | Set a name to show when opening the popup | 30 | | icon | yes | unknown | Choose an icon to show in the header, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 31 | | icon_color | no | set globally | Set a custom icon color for this badge, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 32 | | entity | yes | unknown | Choose the entity that holds the number of devices that are `on`, you must have created this sensor yourself or use the ones from HKI's [device counters](device-counters.md) | 33 | | group_entity | no | unknown | Choose an entity to show its state in the badge, this can be any entity however you will probably want to use a group that is created here [device counters](device-counters.md), note that entities with a long state might look bad, use this wisely | 34 | | grid_area | yes | see example below | Choose where the button will be placed horizontally. You can choose a number (written in words) between `one` and `eight` | 35 | | [tap_action](https://github.com/custom-cards/button-card#Action) | no | predefined | Set a custom tap_action, see [actions](https://github.com/custom-cards/button-card#Action) for more information, if you set a tap_action the default popup will no longer work and be replaced by this action instead | 36 | | [hold_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom hold_action, see [actions](https://github.com/custom-cards/button-card#Action) | 37 | | [double_tap_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom double_tap_action, see [actions](https://github.com/custom-cards/button-card#Action) | 38 | | popup | no | predefined | Design your own popup when clicking this badge (*Note: Will not work if tap_action is defined!*), this must be a list of cards! See example below | 39 | 40 | ```yaml 41 | # config.yaml (default and minimum header settings) 42 | header: 43 | show_subtitle: true 44 | badges: 45 | - name: Thermostats 46 | icon: mdi:thermometer 47 | entity: sensor.current_climate_entities_on 48 | group_entity: group.all_climate_entities 49 | grid_area: six 50 | - name: Doors 51 | icon: mdi:door 52 | entity: sensor.current_doors_open 53 | group_entity: group.all_door_sensor_entities 54 | grid_area: five 55 | - name: Windows 56 | icon: mdi:window-closed 57 | entity: sensor.current_windows_open 58 | group_entity: group.all_window_sensor_entities 59 | grid_area: four 60 | - name: Motion 61 | icon: mdi:motion-sensor 62 | entity: sensor.current_binary_sensors_on 63 | group_entity: group.all_binary_sensor_entities 64 | grid_area: three 65 | - name: Devices 66 | icon: mdi:power-plug 67 | entity: sensor.current_devices_on 68 | group_entity: group.all_device_switch_entities 69 | grid_area: two 70 | - name: Lights 71 | icon: mdi:lightbulb 72 | entity: sensor.current_lights_on 73 | group_entity: group.all_light_entities 74 | grid_area: one 75 | ``` 76 | ```yaml 77 | # config.yaml (example custom popup) 78 | header: 79 | show_subtitle: true 80 | badges: 81 | - name: Thermostats 82 | icon: mdi:thermometer 83 | entity: sensor.current_climate_entities_on 84 | group_entity: group.all_climate_entities 85 | grid_area: six 86 | popup: 87 | - type: markdown 88 | content: My thermostat 89 | - type: thermostat 90 | entity: climate.office 91 | ``` 92 | 93 | ### Images: 94 | 95 | ![Homekit Infused](../images/hki-header.png) 96 | -------------------------------------------------------------------------------- /docs/addons/history.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > History 14 | 15 | This addon gives your view a core history card that shows the history of a given entity (or multiple entities), this can be useful for example when you want to track how many times you have opened a specific door. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 25 | | hours_to_show | no | 24 | Set how many hours you want the history card to show | 26 | | refresh_interval | no | 0 | Set the refresh interval rate in `s` | 27 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 28 | | conditional | no | false | Setting this to `true` will make the stack condtional | 29 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 30 | 31 | 32 | ```yaml 33 | # views.yaml (example) 34 | my_view: 35 | addons: 36 | history: 37 | - title: History 38 | hours_to_show: 48 39 | refresh_interval: 60 40 | entities: 41 | - sensor.unifi_gateway_mem 42 | - sensor.memory_use_percent 43 | ``` 44 | 45 | ### Images: 46 | 47 | ![Homekit Infused](../images/hki-history-1.png) 48 | 49 | ![Homekit Infused](../images/hki-history-2.png) 50 | -------------------------------------------------------------------------------- /docs/addons/humidifier.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Humidifier 14 | 15 | The Humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 3 | Define the number of columns this stack will use | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | | entities | yes | list of tiles | List all your tiles you want to show up here | 29 | 30 | ### Humidifier Extra Options 31 | 32 | | Name | Required | Default | Description | 33 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 34 | | entity | yes | undefined | Set the entity of your humidifier | 35 | | name | no | default entity name | Set a custom name for your humidifier | 36 | 37 | ```yaml 38 | # views.yaml (example minimum) 39 | my_view: 40 | addons: 41 | humidifier: 42 | - title: My Humidifiers 43 | cards: 44 | - humidifier.living_room 45 | - humidifier.bedroom 46 | - humidifier.office 47 | ``` 48 | ```yaml 49 | # views.yaml (example extra options) 50 | my_view: 51 | addons: 52 | humidifier: 53 | - title: My Humidifiers 54 | cards: 55 | - entity: humidifier.living_room 56 | name: Living 57 | - entity: humidifier.bedroom 58 | name: The Room 59 | 60 | ``` 61 | 62 | ### Images: 63 | 64 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/humidifier_card.png) -------------------------------------------------------------------------------- /docs/addons/iframe.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > iFrame 14 | 15 | This addon gives your view an iFrame card . 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | url | yes | undefined | Set your iFrame address here, note that if you use `https` to access your Home Assistant, your iFrame address must be `https` as well! | 25 | | aspect_ratio | no | undefined | Set a custom aspect_ratio for this iFrame | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | 30 | 31 | ```yaml 32 | # views.yaml (example) 33 | my_view: 34 | addons: 35 | iframe: 36 | - title: Windy 37 | url: https://embed.windy.com/ 38 | ``` 39 | ```yaml 40 | # views.yaml (example multiple iframes) 41 | my_view: 42 | addons: 43 | iframe: 44 | - title: Windy 45 | url: https://embed.windy.com/ 46 | - title: Buienradar 47 | url: https://embed.buienradar.nl/ 48 | ``` 49 | 50 | ### Images: 51 | 52 | ![Homekit Infused](../images/hki-iframe.png) 53 | -------------------------------------------------------------------------------- /docs/addons/layout.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Layout 14 | 15 | You can use this addon to change the layout of your view. 16 | 17 | Below are some of the examples you can use, however this addon is REALLY AWESOME and you can use ALL options available to layout-card. 18 | You should check out the [OFFICIAL DOCUMENTATION](https://github.com/thomasloven/lovelace-layout-card#layout-card-1) 19 | 20 | The only difference in HKI is that you MUST define `layout:` in your view to use it. By default HKI uses `custom:masonry-layout` just like the default HA behaviour. 21 | 22 | 23 | ```yaml 24 | # views.yaml (example) 25 | my_view: 26 | layout: 27 | layout_type: custom:horizontal-layout 28 | layout: 29 | max_cols: 3 30 | ``` 31 | ```yaml 32 | # views.yaml (example) 33 | my_view: 34 | layout: 35 | layout_type: custom:grid-layout 36 | layout: 37 | grid-template-columns: auto 43px 38 | grid-template-rows: min-content 39 | grid-template-areas: | 40 | "left right" 41 | mediaquery: 42 | "(min-width: 650px)": 43 | grid-template-columns: auto repeat(2, 43px) 44 | grid-template-areas: | 45 | "left center right" 46 | ``` 47 | 48 | ## View layout 49 | 50 | You can control where addons are placed/shown by adding a view_layout to their configuration. You can find documentation [HERE](https://github.com/thomasloven/lovelace-layout-card#card-layout-options) 51 | 52 | You can also control whether or not to show an addon depending on screen size, you can find examples below: 53 | 54 | ```yaml 55 | # views.yaml (example addon for specific screen size) 56 | my_view: 57 | title: My Lights 58 | addons: 59 | button: 60 | - title: Bedroom 61 | view_layout: 62 | show: 63 | mediaquery: "(min-width: 500px)" 64 | entities: 65 | - light.nightstand_1 66 | - light.nightstand_2 67 | - light.ceiling 68 | ``` 69 | ```yaml 70 | # views.yaml (example with layout addon defined, horizontal layout type) 71 | my_view: 72 | title: My Lights 73 | layout: 74 | layout_type: custom:horizontal-layout 75 | layout: 76 | max_cols: 5 77 | addons: 78 | button: 79 | - title: Bedroom 80 | view_layout: 81 | column: 3 82 | entities: 83 | - light.nightstand_1 84 | - light.nightstand_2 85 | - light.ceiling 86 | ``` 87 | ```yaml 88 | # views.yaml (example with layout addon defined, grid type) 89 | my_view: 90 | title: My Lights 91 | layout: 92 | layout_type: custom:grid-layout 93 | layout: 94 | grid-template-columns: auto 1fr 95 | grid-template-rows: min-content 96 | grid-template-areas: | 97 | "left right" 98 | mediaquery: 99 | "(min-width: 650px)": 100 | grid-template-columns: repeat(6, 43px) 101 | grid-template-areas: | 102 | "left left2 center center2 right right2" 103 | addons: 104 | button: 105 | - title: Bedroom 106 | view_layout: 107 | grid-area: right2 108 | show: 109 | mediaquery: "(min-width: 650px)" 110 | entities: 111 | - light.nightstand_1 112 | - light.nightstand_2 113 | - light.ceiling 114 | ``` 115 | -------------------------------------------------------------------------------- /docs/addons/logbook.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Logbook 14 | 15 | This addon gives your view a core logbook card that shows the history of a given entity (or multiple entities), this can be useful for example when you want to track all the events of a given entity. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 25 | | hours_to_show | no | 24 | Set how many hours you want the logbook card to show | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | 30 | ```yaml 31 | # views.yaml (example) 32 | my_view: 33 | addons: 34 | logbook: 35 | - title: Logbook 36 | hours_to_show: 12 37 | entities: 38 | - light.livingroom 39 | - switch.oven 40 | ``` 41 | 42 | ### Images: 43 | 44 | ![Homekit Infused](../images/hki-logbook.png) 45 | -------------------------------------------------------------------------------- /docs/addons/logo.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Logo 14 | 15 | Instead of a title and subtitle in the header you can also opt to use a logo instead, there are a few options you can set when using a logo. 16 | Unfortunately images come in hundreds of different sizes and shapes. You can adjust the way the logo is placed with the options below. 17 | You will probably have to restart a lot to get this right, sorry! 18 | 19 | I will always advise you to use an image with a transparent background! 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | image | yes | local/images/logos/my_logo.png | Set the url to your image, this can be an external source as well. The default example shows how to use a local path | 24 | | width | yes | 200px | Set the width of this logo, you MUST adjust this to your own likings | 25 | | height | yes | 60px | Set the height of this logo, you MUST adjust this to your own likings, however you should not exceed `81px`, which is the headers max height. For best results you probably shouldn't go over `60px` | 26 | | margin_top | no | 0px | You can align the logo more to the top or bottom by using a value like `-15px` or `15px`, you should play around with this to get it right | 27 | | margin_left | no | 0px | You can align the logo more to the left or right by using a value like `-15px` or `15px`, you should play around with this to get it right | 28 | 29 | ### Images: 30 | 31 | ![Homekit Infused](../images/hki-header-logo.png) 32 | -------------------------------------------------------------------------------- /docs/addons/map.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Map 14 | 15 | This addon gives your view a map that you can use with your own defined entities. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | default_zoom | no | default | Sets the default zoom, around 15 is probably what you will want for your setup | 25 | | aspect_ratio | no | none | Sets an aspect ratio for your map | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | dark_mode | no | false | Whether to use a dark or light map | 28 | | conditional | no | false | Setting this to `true` will make the stack condtional | 29 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 30 | | entities | yes | array | Add the entities you want in your stack, entities must be listed as an array | 31 | 32 | ```yaml 33 | # views.yaml (example) 34 | my_view: 35 | addons: 36 | map: 37 | - title: Location Stephanie 38 | default_zoom: 15 39 | aspect_ratio: 16x10 40 | entities: 41 | - person.stephanie 42 | ``` 43 | ```yaml 44 | # views.yaml (example with multiple maps) 45 | my_view: 46 | addons: 47 | map: 48 | - title: Location Stephanie 49 | entities: 50 | - person.stephanie 51 | - title: Location Jimmy 52 | entities: 53 | - person.jimmy 54 | ``` 55 | ```yaml 56 | # views.yaml (example with multiple entities on single map) 57 | my_view: 58 | addons: 59 | map: 60 | - title: Location 61 | entities: 62 | - person.stephanie 63 | - person.jimmy 64 | - person.tala 65 | ``` 66 | 67 | ### Images: 68 | 69 | ![Homekit Infused](../images/hki-map.png) 70 | -------------------------------------------------------------------------------- /docs/addons/markdown.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Markdown 14 | 15 | The Markdown card is used to render Markdown. 16 | 17 | The renderer uses [Marked.js](https://marked.js.org/), which supports [several specifications of Markdown](https://marked.js.org/#specifications), including CommonMark, GitHub Flavored Markdown (GFM) and `markdown.pl`. 18 | 19 | You can use any of the following options to modify your addon, you can find more examples [here](https://www.home-assistant.io/dashboards/markdown/) 20 | 21 | ### Stack and Addon Config 22 | 23 | | Name | Required | Default | Description | 24 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 25 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 26 | | aspect_ratio | no | none | Sets an aspect ratio for your map | 27 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 28 | | conditional | no | false | Setting this to `true` will make the stack condtional | 29 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 30 | | card_size | The algorithm for placing cards aesthetically may have problems with the Markdown card if it contains templates. You can use this value to help it estimate the height of the card in units of 50 pixels (approximately 3 lines of text in default size). (e.g., `4`) | 31 | | entity_id | A list of entity IDs so a template in `content:` only reacts to the state changes of these entities. This can be used if the automatic analysis fails to find all relevant entities. | 32 | | content | yes | undefined | Your markdown text, if you want to use multiline use a `>` or `|` operator (see examples below) | 33 | 34 | ```yaml 35 | # views.yaml (example single line) 36 | my_view: 37 | addons: 38 | markdown: 39 | - title: My Markdown Card 40 | content: Hello World 41 | ``` 42 | ```yaml 43 | # views.yaml (example with multiple lines) 44 | my_view: 45 | addons: 46 | markdown: 47 | - title: hide 48 | content: > 49 | ## Dashboards 50 | 51 | Starting with Home Assistant 0.72, we're experimenting with a new way of defining your interface. 52 | ``` 53 | ```yaml 54 | # views.yaml (example with jinja) 55 | my_view: 56 | addons: 57 | markdown: 58 | - title: hide 59 | content: | 60 | The lights that are on are: 61 | {% for l in config.entities %} 62 | - {{ l.entity }} 63 | {%- endfor %} 64 | ``` 65 | 66 | ### Images: 67 | 68 | ![Homekit Infused](../images/hki-markdown.png) 69 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/markdown.png) 70 | -------------------------------------------------------------------------------- /docs/addons/media-player.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Media Player 14 | 15 | This addon lets you add some media player cards to your view 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 1 | Define the number of columns this stack will use | 25 | | square | no | false | Set if the media_players should be square or not | 26 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 27 | | conditional | no | false | Setting this to `true` will make the stack condtional | 28 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 29 | | entities | yes | list of entities | List all your entities you want to show up here | 30 | 31 | ### Media Players Extra Options 32 | You can pass any of the options below to your entity to customize the look and feel. 33 | 34 | By default you must enter an array of entities like in the examples above. 35 | You must define your entity as an object instead to make use of the options below. See examples. 36 | 37 | | Name | Required | Default | Description | 38 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 39 | | entity | yes | undefined | Set the entity used | 40 | | name | no | global_name | Set a name for this media-player | 41 | 42 | ```yaml 43 | # views.yaml (example) 44 | living_room: 45 | addons: 46 | media_player: 47 | - title: Spotify 48 | type: core 49 | entities: 50 | - media_player.spotify_stephanie 51 | - media_player.spotify_jimmy 52 | ``` 53 | ```yaml 54 | # views.yaml (example multiple stacks) 55 | living_room: 56 | addons: 57 | media_player: 58 | - title: Spotify 59 | type: core 60 | entities: 61 | - media_player.spotify_stephanie 62 | - media_player.spotify_jimmy 63 | - title: TV's 64 | type: core 65 | entities: 66 | - media_player.samsung_tv 67 | - media_player.philips_tv 68 | ``` 69 | 70 | ### Images: 71 | 72 | ![Homekit Infused](../images/hki-media-player.png) 73 | -------------------------------------------------------------------------------- /docs/addons/menu.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Menu 14 | 15 | This addon gives your view a button stack with shortcuts to all your views. This addon is installed on the menu view by default, but you can use it anywhere else if you really wanted to. 16 | 17 | *Note: this addon will show ALL defined views, if you wish to hide a view from the menu you can add the following to your view. 18 | 19 | ```yaml 20 | # views.yaml (example) 21 | my_view: 22 | show_in_menu: false 23 | ``` 24 | 25 | You can use any of the following options to modify your addon. You MUST use at least one of the settings! 26 | 27 | ### Stack and Addon Config 28 | 29 | | Name | Required | Default | Description | 30 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 31 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 32 | | columns | yes/no | 3 | Set how many buttons are shown horizontally | 33 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 34 | | conditional | no | false | Setting this to `true` will make the stack condtional | 35 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 36 | 37 | ```yaml 38 | # Example 39 | my_view: 40 | addons: 41 | menu: 42 | - title: Menu 43 | columns: 3 44 | ``` 45 | ```yaml 46 | # views.yaml (example no title) 47 | my_view: 48 | addons: 49 | menu: 50 | - columns: 3 51 | # or 52 | my_view: 53 | addons: 54 | menu: 55 | - title: hide 56 | columns: 3 57 | ``` 58 | 59 | ### Images: 60 | 61 | ![Homekit Infused](../images/hki-menu.png) 62 | -------------------------------------------------------------------------------- /docs/addons/meteoalarm.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > MeteoAlarm 14 | 15 | A nice weather alerts card for your views. 16 | 17 | ### HACS Requirements 18 | 19 | | Name | Type | Description | 20 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | [Meteo Alarm Card](https://github.com/MrBartusek/MeteoalarmCard) | Frontend | A card that shows you weather alerts | 22 | 23 | You must have setup the meteoalarm integration in Home Assistant (you can do this in the integrations section of Home Assistant) 24 | 25 | You can use any of the following options to modify your addon. 26 | 27 | ### Stack and Addon Config 28 | 29 | | Name | Required | Default | Description | 30 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 31 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 32 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 33 | | conditional | no | false | Setting this to `true` will make the stack condtional | 34 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 35 | | entity | yes | unknown | The entity to use, this MUST have weather alerts in its attributes! | 36 | | integration | yes | automatic | Name of the integration. Available options: | 37 | 38 | ```yaml 39 | # views.yaml (example) 40 | my_view: 41 | addons: 42 | meteoalarm: 43 | - title: My Weather Alerts 44 | entity: binary_sensor.meteoalarm 45 | integration: weatheralerts 46 | ``` 47 | 48 | ### Images: 49 | 50 | ![Homekit Infused](../images/hki-meteoalarm.png) 51 | -------------------------------------------------------------------------------- /docs/addons/notifications.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Notifications 14 | 15 | This card will show you live notifications in the subtitle part of the header. If you have multiple notifications, they will automatically slide and show you each notification for a few seconds. You could also swipe through them. 16 | 17 | - To create a notification you will have to open the following file `/homekit-infused/user/notifications.yaml` 18 | - You will first need to create a conditional card and then put the notification card inside of it. The state of the defined condition will decide to show the notification or not. See examples below. 19 | 20 | ```yaml 21 | # notifications.yaml (example) 22 | - type: conditional 23 | conditions: 24 | - entity: binary_sensor.smoke_sensor 25 | state: "on" 26 | card: 27 | !include 28 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 29 | - icon: mdi:smoke-detector 30 | name: There is smoke detected in the Kitchen!! 31 | spin: true 32 | ``` 33 | 34 | ### Notification Extra Options 35 | 36 | | Properties | Required | Default | Description | 37 | |----------------------------------|-------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| 38 | | icon | yes | none | Sets an icon to show with the notification, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 39 | | name | yes | none | Sets the notification, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 40 | | spin | no | false | Sets if the icon should spin when showing the notification | 41 | | [tap_action](https://github.com/custom-cards/button-card#Action) | no | undefined | Set a specific tap_action for this notification see [here](https://github.com/custom-cards/button-card#Action) for available options | 42 | | [hold_action](https://github.com/custom-cards/button-card#Action) | no | undefined | Set a specific hold_action for this notification see [here](https://github.com/custom-cards/button-card#Action) for available options | 43 | | [double_tap_action](https://github.com/custom-cards/button-card#Action) | no | undefined | Set a specific double_tap_action for this notification see [here](https://github.com/custom-cards/button-card#Action) for available options | 44 | 45 | ```yaml 46 | # notifications.yaml (example multiple notifications) 47 | 48 | # Smoke Detector 49 | - type: conditional 50 | conditions: 51 | - entity: binary_sensor.smoke_sensor 52 | state: "on" 53 | card: 54 | !include 55 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 56 | - icon: mdi:smoke-detector 57 | name: There is smoke detected in the Kitchen!! 58 | spin: true 59 | 60 | # Front Door 61 | - type: conditional 62 | conditions: 63 | - entity: binary_sensor.front_door 64 | state: "on" 65 | card: 66 | !include 67 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 68 | - icon: mdi:door 69 | name: The frontdoor is open!! 70 | ``` 71 | 72 | ```yaml 73 | # example multiple notifications with an all clear notification 74 | 75 | # All Clear 76 | - type: conditional 77 | conditions: 78 | - entity: binary_sensor.smoke_sensor 79 | state: "off" 80 | - entity: binary_sensor.smoke_sensor 81 | state: "off" 82 | card: 83 | !include 84 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 85 | - icon: mdi:check-box-outline 86 | name: All clear, no notifications. 87 | 88 | # Smoke Detector 89 | - type: conditional 90 | conditions: 91 | - entity: binary_sensor.smoke_sensor 92 | state: "on" 93 | card: 94 | !include 95 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 96 | - icon: mdi:smoke-detector 97 | name: There is smoke detected in the Kitchen!! 98 | spin: true 99 | 100 | # Front Door 101 | - type: conditional 102 | conditions: 103 | - entity: binary_sensor.front_door 104 | state: "on" 105 | card: 106 | !include 107 | - '../hki-base/templates/header/subtitle-notification-template.yaml' 108 | - icon: mdi:door 109 | name: The frontdoor is open!! 110 | ``` 111 | 112 | ### Extra Information 113 | For more examples you can check out my personal notifications.yaml file [here](https://github.com/jimz011/homekit-infused/blob/5.x.x-personal/hki-user/notifications.yaml) 114 | 115 | ### Images: 116 | 117 | ![Homekit Infused](../images/hki-notifications.png) 118 | -------------------------------------------------------------------------------- /docs/addons/plant-status.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Plant Status 14 | 15 | This addon gives your view a core plant status card that shows the different entities associated with your plant. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | entity | yes | undefined | Set your entity here, you can only define one entity per card | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | 29 | ```yaml 30 | # Example 31 | my_view: 32 | addons: 33 | plant_status: 34 | - title: Bonsai 35 | entity: plant.bonsai 36 | ``` 37 | 38 | ### Images: 39 | 40 | ![Homekit Infused](../images/hki-plant-status.png) 41 | -------------------------------------------------------------------------------- /docs/addons/plex.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Plex 14 | 15 | Plex for Home Assistant 16 | 17 | ### HACS Requirements 18 | 19 | | Name | Type | Description | 20 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | [Plex Meets Home Assistant](https://github.com/JurajNyiri/PlexMeetsHomeAssistant) | Frontend | A very nice card to search and start movies/series on your devices that support Plex | 22 | 23 | It is HIGHLY recommended that you setup the Plex integration before using this card, it is not required but it will make the experience a lot better. 24 | 25 | You can use any of the following options to modify your addon. 26 | 27 | ### Stack and Addon Config 28 | 29 | | Name | Required | Default | Description | 30 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 31 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 32 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 33 | | conditional | no | false | Setting this to `true` will make the stack condtional | 34 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 35 | | plex_token | yes | unknown | Your plex token, if you want to know how to get your plex token [click here](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) | 36 | | plex_ip | yes | unknown | The ip of your plex server | 37 | | plex_port | no | 32400 | The port of your plex server, by default it will use 32400 | 38 | | libraryName | yes | movies | The name of the library to show in this card, this must match the library name you have used on your Plex Server | 39 | | protocol | no | http | Set if you should connect over `http` or `https`, if you connect with Home Assistant through `https` you MUST have plex available over `https` as well! | 40 | | maxCount | no | 10 | How many items to show per page | 41 | | android_tv | no | optional | Set an Android TV entity, this will be used as media player | 42 | | kodi | no | optional | Set a Kodi entity, this will be used as media player | 43 | | plex_player | no | optional | Set an Plex PLayer entity, This can be any plex entity. This will be used as media player | 44 | 45 | ```yaml 46 | # views.yaml (example with extra options) 47 | my_view: 48 | addons: 49 | plex: 50 | - title: Movies 51 | plex_token: !secret plex_token 52 | plex_ip: !secret plex_url 53 | plex_port: 443 54 | protocol: https 55 | library_name: Movies 56 | android_tv: media_player.nvidia_s_h_i_e_l_d_tv_pro 57 | - title: Series 58 | plex_token: !secret plex_token 59 | plex_ip: !secret plex_url 60 | plex_port: 443 61 | protocol: https 62 | library_name: TV Series 63 | android_tv: media_player.nvidia_s_h_i_e_l_d_tv_pro 64 | ``` 65 | 66 | ### Images: 67 | 68 | ![Homekit Infused](../images/hki-plex.png) 69 | -------------------------------------------------------------------------------- /docs/addons/popups.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Popups 14 | 15 | HKI comes with preconfigured popups by default. You can set the popup size and set which colors/actions to show in a light popup. 16 | There are two different categories and must be defined separately (see last example below). 17 | 18 | The settings on this page MUST be configured in `/hki-user/config/config.yaml`! 19 | 20 | #### Popups 21 | 22 | | Name | Required | Default | Description | 23 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 24 | | popup_size | no | fullscreen | Set the popup size, choose between `normal`, `wide` and `fullscreen`. *Note: `normal` or `wide` might look bad on a mobile phone!* | 25 | | popup_border_radius | no | 12px | Set a border radius on popups. *Note: this does NOT work when `popup_size: fullscreen`!* | 26 | 27 | ```yaml 28 | # config.yaml (default popups settings) 29 | popup_size: fullscreen 30 | popup_border_radius: 25px 31 | ``` 32 | 33 | #### RGB and Covers Popups 34 | 35 | You must have set your [button](button.md) to `type: rgb` or `type: cover` for these changes to have any effect on them! 36 | 37 | ONLY height and width will apply to covers, all other settings will only be applied for rgb and color-temp popups. 38 | 39 | | Name | Required | Default | Description | 40 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 41 | | slider_colored_by_light | no | true | Set if the slider should be the same color as the light | 42 | | height | no | 410px | Set the height in `px` of the slider on the popup, it might be useful to lower this on smaller phones, this will set the height for all sliders on any popup type | 43 | | width | no | 110px | Set the width in `px` of the slider on the popup, this will set the width for all sliders on any popup type | 44 | | actions_per_row | no | 3 | Set the number of actions that should be shown horizontally | 45 | | action_size | no | 30px | Set the size of the action button in `px` | 46 | | rgb_popup | no | undefined | Set the action buttons, see options below | 47 | 48 | #### RGB Popups Extra Options 49 | 50 | You can have as many actions as you want, as long as you define both rgb and hex colors! 51 | 52 | | Name | Required | Default | Description | 53 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 54 | | rgb_color | yes | undefined | Set the RGB color of the action button, the format MUST be `[255, 136, 0]` | 55 | | hex_color | yes | undefined | Set the HEX color of the action button, the format MUST be `'#ff8800'` | 56 | 57 | ```yaml 58 | # config.yaml (default rgb popups settings) 59 | rgb_popups: 60 | slider_colored_by_light: true 61 | height: 410px 62 | width: 110px 63 | actions_per_row: 3 64 | action_size: 30px 65 | rgb_popup: 66 | - rgb_color: [255, 136, 0] 67 | hex_color: '#ff8800' 68 | - rgb_color: [255, 0, 95] 69 | hex_color: '#ff005f' 70 | - rgb_color: [40, 255, 0] 71 | hex_color: '#28ff00' 72 | - rgb_color: [0, 160, 255] 73 | hex_color: '#00a0ff' 74 | - rgb_color: [131, 0, 255] 75 | hex_color: '#8300ff' 76 | - rgb_color: [3, 0, 255] 77 | hex_color: '#0300ff' 78 | ``` 79 | ```yaml 80 | # config.yaml (example with both categories defined) 81 | popup_size: wide 82 | rgb_popups: 83 | slider_colored_by_light: true 84 | height: 410px 85 | width: 110px 86 | actions_per_row: 3 87 | action_size: 30px 88 | rgb_popup: 89 | - rgb_color: [255, 136, 0] 90 | hex_color: '#ff8800' 91 | - rgb_color: [255, 0, 95] 92 | hex_color: '#ff005f' 93 | - rgb_color: [40, 255, 0] 94 | hex_color: '#28ff00' 95 | - rgb_color: [0, 160, 255] 96 | hex_color: '#00a0ff' 97 | - rgb_color: [131, 0, 255] 98 | hex_color: '#8300ff' 99 | - rgb_color: [3, 0, 255] 100 | hex_color: '#0300ff' 101 | ``` 102 | 103 | ### Images: 104 | 105 | ![Homekit Infused](../images/hki-popup.png) 106 | -------------------------------------------------------------------------------- /docs/addons/remote-control.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Remote Control 14 | 15 | This addon gives your view a remote control that is suitable for Android TV, it also works for Apple TV's though not all features are working yet. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack and Addon Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | media_player | yes | undefined | Set your media_player entity here, usually this is something like `media_player.shield_tv` or `media_player.kitchen_apple_tv` | 25 | | sound_player | yes | undefined | If you have a separate sound player you can enter the entity here, else use the same entity as the media_player | 26 | | remote_entity | yes | undefined | Set your entity that is used as the remote control (for Android TV you must use the same entity as the media_player) | 27 | | type | no | undefined | Set to `atv` if you have an Apple TV, otherwise don't use this line | 28 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 29 | | conditional | no | false | Setting this to `true` will make the stack condtional | 30 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 31 | 32 | ```yaml 33 | # views.yaml (example shield tv) 34 | my_view: 35 | addons: 36 | remote_control: 37 | - title: Livingroom 38 | media_player: media_player.nvidia_shield 39 | sound_player: media_player.nvidia_shield 40 | remote_entity: media_player.nvidia_shield 41 | ``` 42 | ```yaml 43 | # views.yaml (example apple tv) 44 | my_view: 45 | addons: 46 | remote_control: 47 | - title: Bedroom 48 | media_player: media_player.apple_tv 49 | sound_player: media_player.apple_tv 50 | remote_entity: remote.apple_tv 51 | type: atv 52 | ``` 53 | ```yaml 54 | # views.yaml (example Android and ATV remote on the same view) 55 | my_view: 56 | addons: 57 | remote_control: 58 | - title: Livingroom 59 | media_player: media_player.nvidia_shield 60 | sound_player: media_player.nvidia_shield 61 | remote_entity: media_player.nvidia_shield 62 | - title: Bedroom 63 | media_player: media_player.apple_tv 64 | sound_player: media_player.apple_tv 65 | remote_entity: remote.apple_tv 66 | type: atv 67 | ``` 68 | 69 | ### Images: 70 | 71 | ![Homekit Infused](../images/hki-remote-control.png) 72 | -------------------------------------------------------------------------------- /docs/addons/sensor.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Sensor 14 | 15 | This addon allows you to quickly add core sensor cards to your views. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 2 | Define the number of columns this stack will use | 25 | | square | no | false | Set if the sensors should be square or not | 26 | | line_color | no | undefined | Set the line color of sensors with a graph for the entire stack | 27 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 28 | | conditional | no | false | Setting this to `true` will make the stack condtional | 29 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 30 | | entities | yes | list of entities | List all your entities you want to show up here | 31 | 32 | Note: The stack config of this addon also accepts almost any of the options below, this is so that you don't have to define these configurations over and over again for each entity, see examples below! 33 | 34 | ### Sensor Extra Options 35 | You can pass any of the options below to your entity to customize the look and feel. 36 | 37 | By default you must enter an array of entities like in the examples above. 38 | You must define the entity as an object instead to make use of the options below. See examples. 39 | 40 | | Name | Required | Default | Description | 41 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 42 | | entity | yes | undefined | Set the entity used, note that this addon only supports 1 single entity per graph, if you want to be able to use more, you must create this yourself as a custom_card! | 43 | | name | no | undefined | Set a custom name for this sensor card | 44 | | icon | no | undefined | Set a custom icon for this sensor card | 45 | | graph | no | line | Type of graph `none` or `line` | 46 | | unit | no | undefined | The unit of measurement | 47 | | detail | no | 1 | Detail of the graph 1 or 2 (1 = one point/hour, 2 = six points/hour) | 48 | | hours_to_show | no | 24 | Hours to show in graph. Minimum is 1 hour. Big values can result in delayed rendering, especially if the selected entities have a lot of state changes | 49 | | line_color | no | 1 | Set a line color for the graph on this sensor card | 50 | 51 | 52 | Examples: 53 | 54 | ```yaml 55 | # views.yaml (example) 56 | living_room: 57 | addons: 58 | sensor: 59 | - title: Temperature 60 | columns: 2 61 | entities: 62 | - sensor.living_room_temperature 63 | - sensor.kitchen_temperature 64 | ``` 65 | ```yaml 66 | # views.yaml (example extra options) 67 | living_room: 68 | addons: 69 | sensor: 70 | - title: Temperature 71 | line_color: red 72 | entities: 73 | - entity: sensor.living_room_temperature 74 | name: Living Room 75 | graph: none 76 | - entity: sensor.kitchen_temperature 77 | name: Kitchen 78 | line_color: green 79 | ``` 80 | 81 | ### Images: 82 | 83 | ![Homekit Infused](../images/hki-sensor.png) 84 | 85 | -------------------------------------------------------------------------------- /docs/addons/shopping-list.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Shopping List 14 | 15 | The Shopping List card allows you to add, edit, check-off, and clear items from your shopping list. 16 | 17 | Setup of the [Shopping List integration](https://www.home-assistant.io/integrations/shopping_list/) is required. 18 | 19 | ### Stack and Addon config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | yes | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title, you MUST set this for this addon! | 24 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 25 | | conditional | no | false | Setting this to `true` will make the stack condtional | 26 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 27 | 28 | 29 | ```yaml 30 | # views.yaml (example config) 31 | my_view: 32 | addons: 33 | shopping_list: 34 | - title: hide 35 | ``` 36 | ### Images: 37 | 38 | ![Homekit Infused](../images/hki-shopping-list.png) 39 | -------------------------------------------------------------------------------- /docs/addons/statistics-card.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Statistics Card 14 | 15 | The Statistics card allows you to display a statistical value for an entity. 16 | 17 | Statistics are gathered every 5 minutes for sensors that support it. It will either keep the min, max and mean of a sensors value for a specific period, or the sum for a metered entity. 18 | 19 | If your sensor doesn’t work with statistics, check [this](https://www.home-assistant.io/more-info/statistics/). 20 | 21 | ### Stack Config 22 | 23 | | Name | Required | Default | Description | 24 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 25 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 26 | | days_to_show | no | 30 | Set how many days you want the graph to show | 27 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 28 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 29 | 30 | ### Statistic Extra Options 31 | 32 | | Name | Required | Default | Description | 33 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 34 | | entity | yes | undefined | Set the entity used make sure to put `entity:` in the list and then the actual entity see example below | 35 | | name | no | global_name | Set a custom name for this entity | 36 | | unit | no | unit defined by entity | Unit of measurement given to data | 37 | | stat_type | no | change | The statistics types to render. `min`, `max`, `mean`, `change` | 38 | | period | no | month | The period to use for the calculation. See [here](https://www.home-assistant.io/dashboards/statistic/#options-for-period) how to use! | 39 | | footer | no | undefined | Footer widget to render. See [footer documentation](https://www.home-assistant.io/dashboards/header-footer/). | 40 | 41 | ```yaml 42 | # views.yaml (example) 43 | my_view: 44 | addons: 45 | statistics_card: 46 | - title: Stats 47 | entities: 48 | - sensor.unifi_gateway_mem 49 | - sensor.unraid_mem 50 | ``` 51 | ```yaml 52 | # views.yaml (example with stat types) 53 | my_view: 54 | addons: 55 | statistics_card: 56 | - title: Stats 57 | entities: 58 | - entity: sensor.unifi_gateway_mem 59 | stat_type: max 60 | period: 61 | calendar: 62 | period: day 63 | - entity: sensor.unraid_mem 64 | stat_type: min 65 | period: 66 | calendar: 67 | period: month 68 | ``` 69 | 70 | ### Images: 71 | 72 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/statistic.png) 73 | -------------------------------------------------------------------------------- /docs/addons/statistics-graph.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Statistics Graph 14 | 15 | This addon gives your view a core statistics graph that shows the statistics of a given entity (or multiple entities). 16 | 17 | *NOTE: You’re configuring a statistic but your card shows no data, but no errors? That’s caused by a bug in the integration providing the entity. Integrations need to configure their entities correctly so Home Assistant knows that we need to track statistics for it and how. Open an issue with the author of the integration and link them to https://developers.home-assistant.io/docs/core/entity/sensor#long-term-statistics. 18 | 19 | You can use any of the following options to modify your addon. 20 | 21 | ### Stack Config 22 | 23 | | Name | Required | Default | Description | 24 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 25 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 26 | | days_to_show | no | 30 | Set how many days you want the graph to show | 27 | | chart_type | no | line | Set the type of chart style, you can choose between `line` and `bar` | 28 | | stat_types | no | list of types | Set stat type(s) for this entity to show in your card, see example below. Choose between `min`, `max`, `mean`, and `sum` | 29 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 30 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 31 | 32 | ```yaml 33 | # views.yaml (example) 34 | my_view: 35 | addons: 36 | statistics_graph: 37 | - title: Statistics 38 | days_to_show: 7 39 | entities: 40 | - sensor.unifi_gateway_mem 41 | - sensor.memory_use_percent 42 | ``` 43 | ```yaml 44 | # views.yaml (example with stat types) 45 | my_view: 46 | addons: 47 | statistics_graph: 48 | - title: Statistics 49 | days_to_show: 7 50 | entities: 51 | - sensor.unifi_gateway_mem 52 | - sensor.memory_use_percent 53 | stat_types: 54 | - min 55 | - max 56 | - mean 57 | - sum 58 | ``` 59 | 60 | ### Images: 61 | 62 | ![Homekit Infused](../images/hki-statistics-1.png) 63 | 64 | ![Homekit Infused](../images/hki-statistics-2.png) 65 | -------------------------------------------------------------------------------- /docs/addons/statistics.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Statistics 14 | 15 | This addon gives your view a core statistics graph card that shows the statistics of a given entity (or multiple entities). 16 | 17 | *NOTE: You’re configuring a statistic but your card shows no data, but no errors? That’s caused by a bug in the integration providing the entity. Integrations need to configure their entities correctly so Home Assistant knows that we need to track statistics for it and how. Open an issue with the author of the integration and link them to https://developers.home-assistant.io/docs/core/entity/sensor#long-term-statistics. 18 | 19 | You can use any of the following options to modify your addon. 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | days_to_show | no | 30 | Set how many days you want the graph to show | 25 | | chart_type | no | line | Set the type of chart style, you can choose between `line` and `bar` | 26 | | stat_types | no | list of types | Set stat type(s) for this entity to show in your card, see example below. Choose between `min`, `max`, `mean`, and `sum` | 27 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 28 | | entities | yes | list of entities | Set your entity/entities here, you can define more than one entity per card | 29 | 30 | ```yaml 31 | # views.yaml (example) 32 | my_view: 33 | addons: 34 | statistics: 35 | - title: Statistics 36 | days_to_show: 7 37 | entities: 38 | - sensor.unifi_gateway_mem 39 | - sensor.memory_use_percent 40 | ``` 41 | ```yaml 42 | # views.yaml (example with stat types) 43 | my_view: 44 | addons: 45 | statistics: 46 | - title: Statistics 47 | days_to_show: 7 48 | entities: 49 | - sensor.unifi_gateway_mem 50 | - sensor.memory_use_percent 51 | stat_types: 52 | - min 53 | - max 54 | - mean 55 | - sum 56 | ``` 57 | 58 | ### Images: 59 | 60 | ![Homekit Infused](../images/hki-statistics-1.png) 61 | 62 | ![Homekit Infused](../images/hki-statistics-2.png) 63 | -------------------------------------------------------------------------------- /docs/addons/sun-card.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Sun Card 14 | 15 | A nice air quality card for your views. 16 | 17 | ### HACS Requirements 18 | 19 | | Name | Type | Description | 20 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | [Sun Card](https://github.com/AitorDB/home-assistant-sun-card) | Frontend | A beautiful looking card that shows you the sun's position | 22 | 23 | You can use any of the following options to modify your addon, 24 | WARNING! YOU MUST SET AT LEAST 1 OF THE FOLLOWING VALUES FOR THIS CARD TO WORK `time_format`, `darkmode`, `language`, `show_azimuth` or `show_elevation`. 25 | 26 | ### Stack and Addon config 27 | 28 | | Name | Required | Default | Description | 29 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 30 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 31 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 32 | | time_format | no | 24 | Set the time format, choose between `12` or `24` | 33 | | darkmode | no | undefined | Set this to force the card to dark or light mode | 34 | | language | no | undefined | Changes card language, e.g. `English` | 35 | | show_azimuth | no | false | Set to show azimuth in the footer | 36 | | show_elevation | no | false | Set to show the elevation in the footer | 37 | | conditional | no | false | Setting this to `true` will make the stack condtional | 38 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 39 | 40 | 41 | ```yaml 42 | # views.yaml (example minimum config) 43 | my_view: 44 | addons: 45 | sun_card: 46 | - title: hide 47 | time_format: 24 48 | ``` 49 | ```yaml 50 | # views.yaml (example) 51 | my_view: 52 | addons: 53 | sun_card: 54 | - title: hide 55 | show_azimuth: true 56 | show_elevation: true 57 | darkmode: true 58 | ``` 59 | ### Images: 60 | 61 | ![Homekit Infused](../images/hki-sun-card.png) 62 | -------------------------------------------------------------------------------- /docs/addons/themes.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Theming 14 | 15 | HKI has 2 fully customizable themes that you can use to change the look and feel of HKI. You can find the settings in your profile menu. 16 | 17 | **NOTE:** Only Administrators can see these options! 18 | 19 | Open the profile menu (the button at the top right of the header), a popup will open. Now scroll through the top shortcuts bar and find `HKI Settings`. 20 | 21 | Once there you can change the location of the navigation bar and setup the header greeting. 22 | 23 | If you want to be a real Jedi Master in theming you must enable the `HKI Custom` themes, I recommend to set them accordingly to the time of day, that way you can have 2 different themes depending on the time of day. 24 | Once you have enabled the Custom theme you can use all of the options in the list on this page! 95% of the settings will take effect in real-time, but some require a quick browser refresh. 25 | 26 | ### Tips & Tricks 27 | 28 | You can use different ways of defining the colors and other settings, below some examples: 29 | 30 | ```yaml 31 | # example with border-radius 32 | border-radius: 12px 33 | # or 34 | border-radius: 12px 10px 12px 10px 35 | ``` 36 | ```yaml 37 | # example with colors 38 | color: '#ABBABB' 39 | # or 40 | color: var(--paper-item-icon-color) 41 | # or 42 | color: LimeGreen 43 | ``` 44 | 45 | Box-shadow generator [here](https://html-css-js.com/css/generator/box-shadow/) 46 | 47 | Border-radius generator [here](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Backgrounds_and_Borders/Border-radius_generator) 48 | 49 | ### Sharing Themes 50 | 51 | HKI 5 allows for sharing your themes relatively easy, but unfortunately requires a bit of your time. Experienced users can do this in a few minutes, but when you do it for the first time you might be looking at 10 minutes. 52 | 53 | You will find a few scripts in `/packages/homekit-infused-theme/`, e.g. `hki-light-empty.yaml`. 54 | Copy any of the scripts (NOT the `config.yaml` file) to the same folder and rename it. Now open the file and rename the script at the top of the file, now fill in all the variables with your own variables. You can find the variables in the HKI Settings page, however you can also use the sidebar > developer tools and then put `input_text.` in the filter bar. You should see only text_inputs now. Now fill in the variables you see in the script you have just created. If you use the developer tools you will find that most of it is in the same order for faster copy/pasting. 55 | 56 | Once done you can save it and restart Home Assistant. You can now run that script to quickly set those variables (and thus changing your theme in real-time). You can create multiple scripts and call any given script in a service to change the theme quickly every time. You can share your script with other HKI users (they will only need to put the script in the `/packages/homekit-infused-theme/` folder and restart HA). They will have to create a button to launch the script (or use the developer tools to call the service) themselves. 57 | 58 | You can also send in your script as a PR on this repo, the best themes will be added to HKI and will be selectable through some quick toggles to quickly switch through these selected themes. 59 | 60 | ### Images: 61 | 62 | ![Homekit Infused](../images/hki-themes.png) 63 | -------------------------------------------------------------------------------- /docs/addons/thermostat.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Thermostat 14 | 15 | A gorgeous thermostat for your views! 16 | 17 | **NOTE:** This is an addon that will only display thermostats, it is useful if you want something quick or if you have a lot of thermostats. If you want to mix a thermostat inside of your button addon stack, you should use the button addon instead! 18 | 19 | ### HACS Requirements 20 | 21 | | Name | Type | Description | 22 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | [Thermostat Popup Card](https://github.com/jimz011/thermostat-popup-card) | Frontend | This is a popup that opens when holding/double climate buttons, you need to add this repository MANUALLY in HACS | 24 | 25 | You can use any of the following options to modify your addon. 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 30 | | columns | no | 3 | Sets the number of columns for this stack | 31 | | lock | no | undefined | Puts a lock on the entire stack | 32 | | action | no | undefined | You can reverse the default tap/hold action behaviour by setting `action: alternative` for this entire stack at once. If you want to be able to see the `more-info` window directly use `action: more-info` | 33 | | box_shadow | no | fancy | Choose how the box-shadow of your thermostats behave, choose between `none`, `default` or `fancy`, when setting `default` it will follow the default card active box-shadow that you set in the HKI Settings | 34 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 35 | | conditional | no | false | Setting this to `true` will make the stack condtional | 36 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 37 | | entities | yes | list of entities | List your thermostat entities | 38 | 39 | ```yaml 40 | # views.yaml (example) 41 | my_view: 42 | addons: 43 | thermostat: 44 | - title: Ground Floor Thermostats 45 | entities: 46 | - climate.thermostat_livingroom 47 | - climate.thermostat_kitchen 48 | - climate.thermostat_office 49 | - climate.thermostat_guest_room 50 | - title: First Floor Thermostats 51 | entities: 52 | - climate.thermostat_bedroom 53 | - climate.thermostat_bathroom 54 | - climate.thermostat_hallway 55 | - climate.thermostat_guest_bedroom 56 | ``` 57 | ```yaml 58 | # views.yaml (example with stack options) 59 | my_view: 60 | addons: 61 | thermostat: 62 | - title: Thermostats 63 | columns: 2 64 | lock: true 65 | box_shadow: fancy 66 | entities: 67 | - climate.thermostat_livingroom 68 | - climate.thermostat_kitchen 69 | - climate.thermostat_office 70 | - climate.thermostat_guest_room 71 | ``` 72 | 73 | #### Thermostat Extra Options 74 | If you define your entity as an object you can unlock more options. 75 | 76 | | Name | Required | Default | Description | 77 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 78 | | entity | yes | undefined | Sets the entity used | 79 | | name | no | default | Set a custom name for this entity, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 80 | | icon | no | mdi:thermostat | Set a custom icon for this button, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 81 | | lock | no | false | Puts a lock on the button, choose between `true` or `false` | 82 | | action | no | undefined | You can reverse the default tap/hold action behaviour by setting `action: alternative` | 83 | | ambient_temperature | no | undefined | Set this to show the current temperature from a different sensor in your thermostat buttons, this is only an aesthetic change and doesn't change the functionality of your thermostat! | 84 | | attribute | no | undefined | This only accepts `state`, only use this if your thermostats show `undefined` as its state | 85 | | box_shadow | no | fancy | Choose how the box-shadow of your thermostats behave, choose between `none`, `default` or `fancy`, when setting `default` it will follow the default card active box-shadow that you set in the HKI Settings | 86 | 87 | ```yaml 88 | # views.yaml (example with extra options) 89 | my_view: 90 | addons: 91 | thermostat: 92 | - title: Thermostats 93 | entities: 94 | - entity: climate.thermostat_livingroom 95 | lock: true 96 | - entity: climate.thermostat_kitchen 97 | ambient_temperature: sensor.kitchen_temperature 98 | box_shadow: none 99 | attribute: state 100 | ``` 101 | 102 | ### Images: 103 | 104 | ![Homekit Infused](../images/hki-thermostat-1.png) 105 | 106 | ![Homekit Infused](../images/hki-thermostat-2.png) 107 | -------------------------------------------------------------------------------- /docs/addons/tile.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Tile 14 | 15 | The tile card gives you a quick overview of your entity. The card allows you to toggle the entity and show the more info dialog. A badge is shown for some entities like the climate or person entities. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | ### Stack Config 20 | 21 | | Name | Required | Default | Description | 22 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 23 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 24 | | columns | no | 3 | Define the number of columns this stack will use | 25 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 26 | | conditional | no | false | Setting this to `true` will make the stack condtional | 27 | | conditions | no | undefined | Add entities and conditions, this will determine when this addon will be shown, e.g. if entity x is turned `on`, then show this addon (see [addons](../addons.md) for examples | 28 | | entities | yes | list of tiles | List all your tiles you want to show up here | 29 | 30 | ### Tile Extra Options 31 | 32 | | Name | Required | Default | Description | 33 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 34 | | entity | yes | undefined | Set the entity your tile should use | 35 | | name | no | default entity name | Set a custom name for your entity | 36 | | icon | no | default entity icon | Set a custom icon for your entity | 37 | | color | no | undefined | Set the color when the entity is active. By default, the color is based on `state`, `domain`, and `device_class` of your entity. It accept [color token](https://www.home-assistant.io/dashboards/tile/#available-color-tokens) or hex color code. | 38 | | show_entity_picture | no | false | If your entity has a picture, it will replace the icon. | 39 | | tap_action | no | undefined | Action taken on card tap. See [action documentation](https://www.home-assistant.io/dashboards/actions/#tap-action). By default, it will show the `more-info` dialog. | 40 | | icon_tap_action | no | undefined | Action taken on icon card tap. See [action documentation](https://www.home-assistant.io/dashboards/actions/#tap-action). By default, it will `toggle` the entity (if possible), otherwise, show the `more-info` dialog. 41 | 42 | ```yaml 43 | # views.yaml (example minimum) 44 | my_view: 45 | addons: 46 | tile: 47 | - title: My Tiles 48 | entities: 49 | - light.living_room 50 | - person.jimmy 51 | - person.stephanie 52 | ``` 53 | ```yaml 54 | # views.yaml (example extra options) 55 | my_view: 56 | addons: 57 | tile: 58 | - title: My Tiles 59 | entities: 60 | - entity: light.living_room 61 | name: Living 62 | - entity: person.jimmy 63 | show_entity_picture: false 64 | - entity: person.stephanie 65 | tap_action: 66 | action: navigate 67 | navigation_path: stephanie 68 | 69 | ``` 70 | 71 | ### Images: 72 | 73 | ![Homekit Infused](../images/hki-tile.png) 74 | ![Homekit Infused](https://www.home-assistant.io/images/dashboards/tile_card.png) 75 | -------------------------------------------------------------------------------- /docs/addons/upcoming-media.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | ## Content 3 | - [Introduction](../index.md) 4 | - [Installation](../installation.md) 5 | - [Configuration](../configuration.md) 6 | - [Addons](../addons.md) 7 | - [Updates](../updates.md) 8 | - [Issues & Questions](../issues.md) 9 | - [About Me](../about.md) 10 | - [Thanks](../thanks.md) 11 | 12 | ## Addons > Upcoming Media 13 | 14 | This addon gives your view an overview of upcoming movies/tv shows and recently added for your Plex/Sonarr/Radarr server. 15 | 16 | ### HACS Requirements 17 | 18 | | Name | Type | Description | 19 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 20 | | [Radarr Upcoming Media](https://github.com/custom-components/sensor.radarr_upcoming_media) | Integration | This integration fetches data from your Radarr webserver | 21 | | [Sonarr Upcoming Media](https://github.com/custom-components/sensor.sonarr_upcoming_media) | Integration | This integration fetches data from your Sonarr webserver | 22 | | [Plex Recently Added](https://github.com/custom-components/sensor.sonarr_upcoming_media) | Integration | This integration fetches data from your Plex server to show what has recently been added | 23 | | [Upcoming Media Card](https://github.com/custom-cards/upcoming-media-card) | Frontend | This is the card used to show the above integrations in a nice way | 24 | 25 | You can use any of the following options to modify your addon. 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 30 | | entity | yes | undefined | Add the entity that should be used for this stack, you can only define one entity per card! | 31 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 32 | 33 | ```yaml 34 | # views.yaml (example) 35 | my_view: 36 | addons: 37 | upcoming_media: 38 | - title: Recently Added TV 39 | entity: sensor.recently_added_tv 40 | - title: Recently Added Movies 41 | entity: sensor.recently_added_movies 42 | - title: Upcoming TV 43 | entity: sensor.sonarr_upcoming_media 44 | - title: Upcoming Movies 45 | entity: sensor.radarr_upcoming_media 46 | ``` 47 | 48 | ### Images: 49 | 50 | ![Homekit Infused](../images/hki-upcoming.png) 51 | -------------------------------------------------------------------------------- /docs/addons/view-selector.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > View Selector 14 | 15 | This addon gives your view a selector menu at the top of your view. 16 | 17 | **WARNING:** The view_selector is ported from HKI 4, this addon will undergo some major changes soon, the config variables may or may not change in the future. 18 | 19 | The view selector works by leveraging multiple views as pages. You must add the view_selector to every view that you want the view_selector to show on. 20 | 21 | **Note:** When adding view_selector to your view, that view will be removed from the main menu! You can re-add views to your menu by adding `show_in_menu: true`. It is advised to only use one of the views that belong to a view_selector group in the main menu (but this is completely up to you). 22 | 23 | **Tip:** It is suggested that you set a title with the same name for each view (since by default the view title is the object name unless you specify one manually). See example below. 24 | 25 | | Name | Required | Default | Description | 26 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 27 | | columns | no | 4 | Set the amount of columns the view_selector uses on this page | 28 | | aspect_ratio | no | 1/1 | Set a custom aspect_ratio, this is useful when using less buttons | 29 | | size | no | 25% | Set the size of icons for all elements at once | 30 | | elements | yes | a list of elements | Set the elements your view selector should use, see options below | 31 | 32 | #### Elements Extra Options 33 | 34 | | Name | Required | Default | Description | 35 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 36 | | name | no | undefined | Sets the name of this button, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 37 | | icon | no | undefined | Sets the icon of this button, this accepts [JS templates](https://github.com/custom-cards/button-card#javascript-templates) | 38 | | size | no | 25% | Set a custom icon size for this element | 39 | | path | yes | undefined | Sets the path this button should take you to | 40 | | this_view | no | undefined | You can add this to your selector to make HKI aware that you are currently on this page, this will give the button a nice `ON` appearance. The view selector works fine without it though | 41 | | button_badge | no | undefined | You can set a button badge just like in the menu. A useful case would be for example a lights view with multiple floors where the badge shows you the number of lights `on` on that specific floor | 42 | | [tap_action](https://github.com/custom-cards/button-card#Action) | no | predefined | Set a custom tap_action, see [actions](https://github.com/custom-cards/button-card#Action) for more information, if you set a tap_action the navigate to `path` setting will no longer work and be replaced by this action instead | 43 | | [hold_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom hold_action, see [actions](https://github.com/custom-cards/button-card#Action) | 44 | | [double_tap_action](https://github.com/custom-cards/button-card#Action) | no | none | Set a custom double_tap_action, see [actions](https://github.com/custom-cards/button-card#Action) | 45 | 46 | ```yaml 47 | # views.yaml (example with 2 views with a view_selector) 48 | stephanie_location: 49 | title: Stephanie 50 | view_selector: 51 | columns: 3 52 | aspect_ratio: 3/1 53 | elements: 54 | - name: Agenda 55 | icon: mdi:calendar-edit 56 | path: stephanie_calendar 57 | this_view: true 58 | - name: Location 59 | icon: mdi:map-marker 60 | path: stephanie_location 61 | 62 | stephanie_calendar: 63 | title: Stephanie 64 | view_selector: 65 | columns: 3 66 | aspect_ratio: 3/1 67 | elements: 68 | - name: Agenda 69 | icon: mdi:calendar-edit 70 | path: stephanie_calendar 71 | - name: Location 72 | icon: mdi:map-marker 73 | path: stephanie_location 74 | this_view: true 75 | ``` 76 | ```yaml 77 | # views.yaml (example with 2 views with a view_selector with one view shown in the main menu) 78 | stephanie_location: 79 | title: Stephanie 80 | show_in_menu: true 81 | view_selector: 82 | columns: 3 83 | aspect_ratio: 3/1 84 | elements: 85 | - name: Agenda 86 | icon: mdi:calendar-edit 87 | path: stephanie_calendar 88 | this_view: true 89 | - name: Location 90 | icon: mdi:map-marker 91 | path: stephanie_location 92 | 93 | stephanie_calendar: 94 | title: Stephanie 95 | view_selector: 96 | columns: 3 97 | aspect_ratio: 3/1 98 | elements: 99 | - name: Agenda 100 | icon: mdi:calendar-edit 101 | path: stephanie_calendar 102 | - name: Location 103 | icon: mdi:map-marker 104 | path: stephanie_location 105 | this_view: true 106 | ``` 107 | 108 | ### Images: 109 | 110 | ![Homekit Infused](../images/hki-view-selector-1.png) 111 | ![Homekit Infused](../images/hki-view-selector-2.png) 112 | -------------------------------------------------------------------------------- /docs/addons/weather.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Weather 14 | 15 | This addon gives your view a simple but elegant weather forecast card. 16 | 17 | ### HACS Requirements 18 | 19 | | Name | Type | Description | 20 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | [Simple Weather Card](https://github.com/kalkih/simple-weather-card) | Frontend | A simple weather card (only required if `type: simple_weather`) | 22 | 23 | You can use any of the following options to modify your addon. 24 | 25 | ### Stack Config 26 | 27 | | Name | Required | Default | Description | 28 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 29 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 30 | | type | yes | core | Set the card type, either `core` or `simple_weather`, you MUST define this | 31 | | entity | yes | undefined | Set your weather entity, this must be in the weather domain! | 32 | | path | no | weather | Change the path the UI will navigate to when clicked, remember that you must have created the view you want to refer to | 33 | ||||| 34 | | show_forecast | no | true | Show forecast (only works for `type: core`) | 35 | | city_name | yes | undefined | Set your city name (only works for `type: simple_weather`) | 36 | | backdrop | no | false | Sets a backdrop image (only works for `type: simple_weather`) | 37 | | primary_info | no | undefined | Primary card information, one or more weather attributes | 38 | | secondary_info | no | undefined | Secondary card information, one or more weather attributes | 39 | | custom | no | undefined | Override weather information with custom sensors, see examples below (only works for `type: simple_weather`) | 40 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 41 | 42 | ### Weather attributes (simple-weather only) 43 | | Name | Description | 44 | |------|--------------| 45 | | extrema | Forecast high and low temperature | 46 | | precipitation | Forecast precipitation | 47 | | precipitation_probability | Probability of precipitation | 48 | | humidity | Current humidity | 49 | | wind_speed | Current wind speed | 50 | | wind_bearing | Current wind direction | 51 | | pressure | Current air pressure | 52 | 53 | ### Backdrop object options (simple-weather only) 54 | See [Backdrop example](#backdrop-example) for example usage. 55 | 56 | | Name | Type | Default | Description | 57 | |------|------|---------|-------------| 58 | | fade | boolean | `false` | Faded background. 59 | | day | string | '#45aaf2' | Background color (Day). 60 | | night | string | '#a55eea' | Background color (Night). 61 | | text | string | 'var(--text-dark-color)' | Text color. 62 | 63 | #### Custom option array 64 | See [Custom example](#custom-sensors-example) for example usage. 65 | Possible entries are: `temp`, `high`, `low`, `state`, `precipitation`, `humidity`, `icon-state`, `wind_speed`, `wind_bearing`, `pressure` & `precipitation_probability`. 66 | 67 | ```yaml 68 | custom: 69 | - temp: sensor.home_temp 70 | - high: sensor.home_high_temp 71 | - low: sensor.home_low_temp 72 | ``` 73 | 74 | ```yaml 75 | # views.yaml (example core weather) 76 | my_view: 77 | addons: 78 | weather: 79 | - title: Core Weather 80 | type: core 81 | entity: weather.eindhoven 82 | show_forecast: false 83 | path: weather 84 | ``` 85 | ```yaml 86 | # views.yaml (example simple weather) 87 | my_view: 88 | addons: 89 | weather: 90 | - title: Simple Weather 91 | type: simple_weather 92 | entity: weather.eindhoven 93 | city_name: Eindhoven 94 | backdrop: true 95 | path: weather 96 | ``` 97 | ```yaml 98 | # views.yaml (example simple weather) 99 | my_view: 100 | addons: 101 | weather: 102 | - title: hide 103 | type: simple_weather 104 | entity: weather.eindhoven 105 | city_name: Eindhoven 106 | backdrop: true 107 | path: weather 108 | primary_info: 109 | - wind_bearing 110 | - humidity 111 | secondary_info: 112 | - precipitation 113 | - precipitation_probability 114 | custom: 115 | - temp: sensor.home_temp 116 | - high: sensor.home_high_temp 117 | - low: sensor.home_low_temp 118 | ``` 119 | 120 | ### Images: 121 | 122 | ![Homekit Infused](../images/hki-weather-1.png) 123 | 124 | ![Homekit Infused](../images/hki-weather-2.png) 125 | -------------------------------------------------------------------------------- /docs/addons/xbox.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](../index.md) 5 | - [Installation](../installation.md) 6 | - [Configuration](../configuration.md) 7 | - [Addons](../addons.md) 8 | - [Updates](../updates.md) 9 | - [Issues & Questions](../issues.md) 10 | - [About Me](../about.md) 11 | - [Thanks](../thanks.md) 12 | 13 | ## Addons > Xbox Controller 14 | 15 | This addon gives your view an Xbox Controller. 16 | 17 | You can use any of the following options to modify your addon. 18 | 19 | | Name | Required | Default | Description | 20 | |----------------------------------|-------------|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 21 | | title | no | undefined | Set the title of the stack, ommitting this line will or setting `title: hide` will hide the title | 22 | | xbox_entity | yes | media_player.xboxone | Set your Xbox entity here, this must be in the media_player domain | 23 | | remote_entity | yes | remote.xboxone_remote | Set your Xbox remote entity here, this must be in the remote domain | 24 | | [view_layout](layout.md#view-layout) | no | undefined | This is best used in conjunction with the [layout](layout.md#view-layout) addon, but can also be used to control whether to show this stack on different screen sizes. | 25 | 26 | ```yaml 27 | # views.yaml (example) 28 | my_view: 29 | addons: 30 | xbox: 31 | - title: Xbox One 32 | xbox_entity: media_player.xboxone 33 | remote_entity: remote.xboxone_remote 34 | ``` 35 | ```yaml 36 | # views.yaml (example multiple controllers) 37 | my_view: 38 | addons: 39 | xbox: 40 | - title: Xbox One 41 | xbox_entity: media_player.xboxone 42 | remote_entity: remote.xboxone_remote 43 | - title: Xbox One X 44 | xbox_entity: media_player.xboxone_x 45 | remote_entity: remote.xboxone_x_remote 46 | ``` 47 | 48 | ### Images: 49 | 50 | ![Homekit Infused](../images/hki-xbox.png) 51 | -------------------------------------------------------------------------------- /docs/fixes/readme.md: -------------------------------------------------------------------------------- 1 | This fix is no longer available, 2 | 3 | Please install the latest button-card for this fix. Make sure to tick `show beta versions` and install 3.5.0-dev.1 4 | -------------------------------------------------------------------------------- /docs/images/hki-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-1.png -------------------------------------------------------------------------------- /docs/images/hki-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-2.png -------------------------------------------------------------------------------- /docs/images/hki-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-3.png -------------------------------------------------------------------------------- /docs/images/hki-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-4.png -------------------------------------------------------------------------------- /docs/images/hki-air-visual.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-air-visual.png -------------------------------------------------------------------------------- /docs/images/hki-alarm-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-alarm-1.png -------------------------------------------------------------------------------- /docs/images/hki-alarm-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-alarm-2.png -------------------------------------------------------------------------------- /docs/images/hki-area-card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-area-card.png -------------------------------------------------------------------------------- /docs/images/hki-battery.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-battery.png -------------------------------------------------------------------------------- /docs/images/hki-button-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-1.png -------------------------------------------------------------------------------- /docs/images/hki-button-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-2.png -------------------------------------------------------------------------------- /docs/images/hki-button-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-3.png -------------------------------------------------------------------------------- /docs/images/hki-button-4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-4.png -------------------------------------------------------------------------------- /docs/images/hki-button-5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-5.png -------------------------------------------------------------------------------- /docs/images/hki-button-6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-button-6.png -------------------------------------------------------------------------------- /docs/images/hki-calendar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-calendar.png -------------------------------------------------------------------------------- /docs/images/hki-camera.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-camera.png -------------------------------------------------------------------------------- /docs/images/hki-energy-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-energy-1.png -------------------------------------------------------------------------------- /docs/images/hki-energy-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-energy-2.png -------------------------------------------------------------------------------- /docs/images/hki-energy-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-energy-3.png -------------------------------------------------------------------------------- /docs/images/hki-entities.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-entities.png -------------------------------------------------------------------------------- /docs/images/hki-favorites.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-favorites.png -------------------------------------------------------------------------------- /docs/images/hki-find-my.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-find-my.png -------------------------------------------------------------------------------- /docs/images/hki-gauge.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-gauge.png -------------------------------------------------------------------------------- /docs/images/hki-glance-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-glance-1.png -------------------------------------------------------------------------------- /docs/images/hki-glance-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-glance-2.png -------------------------------------------------------------------------------- /docs/images/hki-glance-3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-glance-3.png -------------------------------------------------------------------------------- /docs/images/hki-google.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-google.png -------------------------------------------------------------------------------- /docs/images/hki-header-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-header-logo.png -------------------------------------------------------------------------------- /docs/images/hki-header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-header.png -------------------------------------------------------------------------------- /docs/images/hki-history-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-history-1.png -------------------------------------------------------------------------------- /docs/images/hki-history-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-history-2.png -------------------------------------------------------------------------------- /docs/images/hki-iframe.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-iframe.png -------------------------------------------------------------------------------- /docs/images/hki-logbook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-logbook.png -------------------------------------------------------------------------------- /docs/images/hki-map.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-map.png -------------------------------------------------------------------------------- /docs/images/hki-markdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-markdown.png -------------------------------------------------------------------------------- /docs/images/hki-media-player.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-media-player.png -------------------------------------------------------------------------------- /docs/images/hki-menu.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-menu.png -------------------------------------------------------------------------------- /docs/images/hki-meteoalarm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-meteoalarm.png -------------------------------------------------------------------------------- /docs/images/hki-notifications.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-notifications.png -------------------------------------------------------------------------------- /docs/images/hki-picture-elements-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-picture-elements-1.png -------------------------------------------------------------------------------- /docs/images/hki-picture-elements-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-picture-elements-2.png -------------------------------------------------------------------------------- /docs/images/hki-plant-status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-plant-status.png -------------------------------------------------------------------------------- /docs/images/hki-plex.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-plex.png -------------------------------------------------------------------------------- /docs/images/hki-popup.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-popup.png -------------------------------------------------------------------------------- /docs/images/hki-profile-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-profile-1.png -------------------------------------------------------------------------------- /docs/images/hki-profile-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-profile-2.png -------------------------------------------------------------------------------- /docs/images/hki-remote-control.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-remote-control.png -------------------------------------------------------------------------------- /docs/images/hki-sensor.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-sensor.png -------------------------------------------------------------------------------- /docs/images/hki-shopping-list.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-shopping-list.png -------------------------------------------------------------------------------- /docs/images/hki-statistics-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-statistics-1.png -------------------------------------------------------------------------------- /docs/images/hki-statistics-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-statistics-2.png -------------------------------------------------------------------------------- /docs/images/hki-sun-card.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-sun-card.png -------------------------------------------------------------------------------- /docs/images/hki-theme-midnight-black.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-midnight-black.jpg -------------------------------------------------------------------------------- /docs/images/hki-theme-orange-sunrise.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-orange-sunrise.jpg -------------------------------------------------------------------------------- /docs/images/hki-theme-orange-sunset.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-orange-sunset.jpg -------------------------------------------------------------------------------- /docs/images/hki-theme-paper-white.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-paper-white.jpg -------------------------------------------------------------------------------- /docs/images/hki-theme-purple-blur.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-purple-blur.jpg -------------------------------------------------------------------------------- /docs/images/hki-theme-sweet-pink.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-theme-sweet-pink.jpg -------------------------------------------------------------------------------- /docs/images/hki-themes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-themes.png -------------------------------------------------------------------------------- /docs/images/hki-thermostat-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-thermostat-1.png -------------------------------------------------------------------------------- /docs/images/hki-thermostat-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-thermostat-2.png -------------------------------------------------------------------------------- /docs/images/hki-tile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-tile.png -------------------------------------------------------------------------------- /docs/images/hki-upcoming.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-upcoming.png -------------------------------------------------------------------------------- /docs/images/hki-view-selector-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-view-selector-1.png -------------------------------------------------------------------------------- /docs/images/hki-view-selector-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-view-selector-2.png -------------------------------------------------------------------------------- /docs/images/hki-weather-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-weather-1.png -------------------------------------------------------------------------------- /docs/images/hki-weather-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-weather-2.png -------------------------------------------------------------------------------- /docs/images/hki-xbox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/images/hki-xbox.png -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | # Introduction 14 | This is Homekit Infused 5, a complete lovelace dashboard solution for Home Assistant. 15 | In a nutshell Homekit Infused will turn your Home Assistant dashboard into a Homekit styled variant with a beautiful header which gives a more tablet/phone app style to your dashboard. 16 | 17 | Note: Homekit Infused is a YAML style dashboard, this means that a basic understanding of YAML is advised. However if you follow the documentation/video tutorials you should be able to create a dashboard nonetheless. You should be able to create a beautiful dashboard without too much effort! 18 | 19 | Homekit Infused does NOT replace any of your existing dashboards so you can rest assured that installing HKI will not destroy any of your existing dashboards. You can use Homekit Infused in conjunction with other dashboards. 20 | 21 | In short Homekit Infused 5 is all of the below and much much more! 22 | - Having trouble convincing your partner to use HA? HKI has a really amazing WAF! 23 | - A beautiful header with notifications that is customizable per view and is added to each view for you automatically. 24 | - A customizable navigation bar which can also be set at the bottom of the screen. 25 | - An automatically created menu. 26 | - Create new views super fast by only defining a view name, title and icon. Just these lines will create a new view, a menu entry, a navigation bar button and icon and a header title, cool huh? 27 | - 2 Fully customizable themes where you can change the entire look and feel of Homekit Infused in REAL-TIME! 28 | - Share your own created themes with the HKI community by creating scripts, the best themes will be added to future HKI releases! 29 | - A LOT of preconfigured addons which you can add to any of your views, by default all addons are preconfigured for fast dashboard creation. 30 | - Custom addon which allows you to use ANY home assistant card available either core or community created cards. 31 | - A fully customizable per user profile menu. 32 | - A fully customizable Alarm panel. 33 | - Known to be one of the best documented dashboards around, HKI 5 is no different and even better! 34 | - Experienced users can go fully custom YAML on a per view basis (this is particularly useful for HKI 3 and 4 users that want to migrate) 35 | - Easy updates, copy/replace 2 folders on each update! 36 | - Blazing fast frontend, even with large setups (watch my video's to see it in action). 37 | - Over 200+ new settings compared to HKI 4! 38 | - And MUCH MUCH I mean MUCH more! 39 | 40 | ### Follow me on YouTube 41 | [Click Here for all the latest updates/videos](https://www.youtube.com/jimz011) 42 | 43 | # Disclaimer 44 | Warning: 45 | - I am not responsible for any data loss or defects that are caused by user error. 46 | - Any custom card/component used in this project is not made by me and all credits should go to the original creator. 47 | - Any custom card/component used in this project has a link to it's original repo and creator. 48 | 49 | # Hardware I use personally for this setup 50 | #### Computer 51 | 52 | - Intel i7 4790K 53 | - 32GB DDR3 1600MHz RAM 54 | - 9x HDD (6x 3TB, 2x 2TB, 1x 1TB) 55 | - 2x SSD (1x 120GB, 1x 480GB) 56 | - Hypervisor used: Unraid 57 | - Docker: Yes 58 | - VM's: 1 (Ubuntu) 59 | - Docker Containers: 70+ 60 | - Home Assistant: Home Assistant Core running on docker in Unraid 61 | 62 | #### Phones and Wearables 63 | - Note 20 Ultra 64 | - Z Fold 3 5G 65 | - iPhone 5S 66 | - Galaxy Watch 4 Classic x2 67 | 68 | #### Other 69 | - Xbox One (2013) 70 | - Playstation 2 71 | 72 | #### Smart Devices 73 | - 6x Philips Hue dimmers (deCONZ controlled) 74 | - 3x IKEA Tradfri remotes (deCONZ controlled) 75 | - 1x Koogeek kh01cn hardware switch (connected through HA with Homekit Controller) 76 | - 11x LED strips (around 70 meters in total) with MagicHome controllers (Flashed with ESPHome, varying from RGB to RGBWC) 77 | - 14x Ikea Tradfri smart switches (deCONZ controlled) 78 | - 2x Ikea Tradfri bulbs (ranging from normals to color temperature ones) (deCONZ controlled) 79 | - 13x Philips Hue lights (ranging from filament to color temperature ones) (deCONZ controlled) 80 | - 3x Sonoff POW R2 (to monitor the washingmachine, dryer and dishwasher) 81 | - 7x Sonoff Basic used as light or device switches (Flashed with ESPHome) 82 | - 2x Sonoffs TH-16 (used to monitor temperature and humidity, but also doubles as a switch) (Flashed with ESPHome) 83 | - 1x TP-Link HS110 Energy Reading smart switch (to monitor the refrigerator) 84 | - 4x Blitwolf SHP13 Energy Reading smart switch (to monitor the freezer and unraid server) 85 | - 1x Honeywell smoke detector by Xiaomi (deCONZ controlled) 86 | - 6x Aqara door/window sensors by Xiaomi (3 used on doors, 3 on windows) (deCONZ controlled) 87 | - 3x Aqara temperature/humidity sensors by Xiaomi (deCONZ controlled) 88 | - 1x Xiaomi Roborock S55 (Rooted and flashed with Valetudo RE) 89 | - 1x Apple TV 4K 90 | - 1x Nvidia Shield TV Pro (2019) 91 | - 2x Samsung smart TV 92 | - 2x Google Nest mini's 93 | - 1x Google Home mini 94 | - 1x Google Home 95 | - 4x Google Nest Hub 96 | - 2x Aqara motion sensor by Xiaomi (deCONZ controlled) 97 | - 3x IKEA Tradfri Motion sensors (deCONZ controlled) 98 | - 1x Xiaofang Camera (rooted and flashed with Dafang Hacks) 99 | - 1x Simple webcam (via motioneye) 100 | - 1x deCONZ stick by Dresden Elektronic 101 | - 1x Xiaomi Mija Gateway (Lumigateway version 3) (I only ever use this as speaker/light, no other devices are attached to this and it is cut off from the internet) 102 | - 1x Xiaomi Aqara Airconditioning Companion (version 3) (I don't have a compatible airconditioner yet, though it does work as a switch and energy reader, not yet in my HA) 103 | - 1x Xiaomi Aqara Cube (this device is actually better than I thought it would be, but because of the way our house is programmed it is just a fun object) 104 | - 1x Unifi Dream Machine Pro 105 | - 2x Unifi AP AC-Lite WiFI Access Points 106 | - 2x Unifi Flex G3 Camera 107 | - 2x Unifi Flex-Mini Switches 108 | - 1x TP-Link Switch 109 | - 1x Raspberry Pi B (running a failover AdGuard Server) 110 | - A bunch of NFC stickers around the house 111 | 112 | There is probably more, but I can't think of it right now XD 113 | -------------------------------------------------------------------------------- /docs/installation.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | ### Installation 14 | ##### NOTE 15 | There is no direct upgrade path from HKI 4, the way HKI 5 is written is very similar, but deviates too much to make a decent upgrade possible. HKI 4 users should start fresh. If you are a new user, this doesn't apply to you and you can continue on to the next step of the documentation. 16 | 17 | There is also a video guide available [HERE](https://www.youtube.com/playlist?list=PLezjWQmPsNpF9zNbWAXfm3mcnDwFYLdpT), but it is always recommended to keep the documentation at hand since video's tend to age fast! 18 | 19 | ##### Advice 20 | - Install Home Assistant or create a backup of your current setup. I will advise you to install this on a clean Home Assistant install, though it is not a requirement. 21 | - Add all your known devices to Home Assistant (if integrations are available the prefered way would be to use that instead of putting it in manually. 22 | - Create person entities in the UI go to configuration>persons and create all the persons in your house. Add the device_trackers you have to the person entities via the dropdown menu. Also add an entity_picture to the entities so your entities will look better and you'll get a personalized profile button. 23 | 24 | ##### Requirements 25 | - Create a secrets.yaml file in the root of your HA installation if you do not have it already. Add the following line on any line within that file `alarm_code: 123456`. You can change the code to whatever number you want. DO NOT SKIP THIS PART or HKI will fail to start. 26 | - Install HACS https://hacs.xyz/docs/installation/manual 27 | - Install all of the cards/components below. 28 | 29 | ### HACS 30 | Below is a list of all the addons required to run Homekit Infused, you can install ALL of them through HACS. If this is your first time installing HA you want to click on your current dashboard and click on `take over control` if you haven't done so already. 31 | 32 | | Name | Type | Description | 33 | |----------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 34 | | [Auto Entities](https://github.com/thomasloven/lovelace-auto-entities) | Frontend | This card is handy to fill certain domains/entities very quickly | 35 | | [Card Mod](https://github.com/thomasloven/lovelace-card-mod) | Frontend | This mod allows for custom css on any card and even stacks | 36 | | [Button Card](https://github.com/custom-cards/button-card) | Frontend | This is the button used throughout the entire setup, **WARNING: MAKE SURE YOU SELECT, `Show Beta Versions` AND SELECT THE LATEST VERSION!** | 37 | | [State Switch](https://github.com/thomasloven/lovelace-state-switch) | Frontend | This is used to make cards appear based on certain conditions, like a conditional-card but better | 38 | | [Card Tools](https://github.com/thomasloven/lovelace-card-tools) | Frontend | This is needed for various custom cards to run | 39 | | [Search Card](https://github.com/postlund/search-card) | Frontend | An easy to use search card | 40 | | [Swipe Card](https://github.com/bramkragten/swipe-card) | Frontend | This card is mainly used for the scrolling notifications | 41 | | [Config Template Card](https://github.com/iantrich/config-template-card) | Frontend | Allows for some specific templating, it is required for the profile button | 42 | | [Fold Entity Row](https://github.com/thomasloven/lovelace-fold-entity-row) | Frontend | Allows entities cards to have a row that can be folded/collapsed | 43 | | [Text Input Row](https://github.com/gadgetchnnel/lovelace-text-input-row/) | Frontend | Allows text input rows to be much wider | 44 | | [Layout Card](https://github.com/thomasloven/lovelace-layout-card) | Frontend | This card is needed for the layout, IMPORTANT: Read the note below | 45 | | [Browser Mod](https://github.com/thomasloven/hass-browser_mod) | Integration | Browser-mod makes the browser more useful and gives us the opportunity to show/create custom popups and many more! | 46 | | [Lovelace Gen](https://github.com/thomasloven/hass-lovelace_gen) | Integration | This is the MOST important piece of the setup, without this HKI will not work! Don't add this to your `configuration.yaml` file as the included package already does so for you, if you already have `lovelace_gen:` in your `configuration.yaml` please remove or comment that line! | 47 | 48 | ### Adding Resources 49 | Resources are added automatically when the card gets installed within HACS AND if you have taken over control of the default dashboard as mentioned above, but to be sure check them through `Sidebar > Lovelace Dashboards > Resources`. If there are no resources listed, make sure you either add them manually or reinstall them through HACS (you can find the url to add if you click on `redownload`, you do not need to redownload them, but you can use the URL's to add the resources manually if needed). 50 | 51 | If you can't see the resources tab, set your profile to `advanced mode` in `Sidebar > Profile`! 52 | 53 | ### Installation 54 | Download the project, you can grab the latest release from [here](https://github.com/jimz011/homekit-infused/releases). 55 | Copy the following files/folders to the root of your Home Assistant installation 56 | 57 | - Copy the `/hki-base/` folder to the root of your setup 58 | - Copy the `/hki-user/` folder to the root of your setup 59 | - Copy the `/packages/` folder to the root of your setup 60 | - Add the following lines to your `configuration.yaml` file 61 | 62 | ```yaml 63 | homeassistant: 64 | packages: !include_dir_named packages/ 65 | ``` 66 | 67 | Optionally you can add the images folder to your setup (it has some useful images that you might want to use): 68 | - Copy the `/www/` folder to the root of your setup 69 | 70 | **NOTE:** The packages folder has 2 extra folders named `homekit-infused-theme` and `homekit-infused-extra`, these 2 packages are optional and can be removed safely if you do not wish to make use of the advanced theming options in HKI or the extra additional sensors HKI can create for you. 71 | 72 | ## That's it! You have succesfully installed the Homekit Infused! Now go on with configuring it :P 73 | 74 | ### Extra Information 75 | #### Dwains Dashboard! 76 | 77 | If you happen to have [Dwains Dashboard](https://github.com/dwainscheeren/dwains-lovelace-dashboard) you must comment out a line in the Homekit Infused configuration files. 78 | 79 | You must proceed with the following change, this must be repeated EVERY time HKI gets updated! You must comment (or remove) the following line. 80 | ```yaml 81 | # in /packages/homekit_infused/hki_configuration.yaml 82 | lovelace_gen: !include_dir_merge_named ../../hki-user/config/ 83 | ``` 84 | 85 | This is line 1 and should look like this after the change 86 | 87 | ```yaml 88 | # lovelace_gen: !include_dir_merge_named ../../hki-user/config/ 89 | ``` 90 | 91 | Restart Home Assistant after you have done this change! 92 | -------------------------------------------------------------------------------- /docs/issues.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | ## ISSUES 14 | 15 | #### Known Issues 16 | - If you get a `t.setConfig is not a function` error, please re-download `Swipe Card` from HACS! 17 | - If your popups do not work or get the `custom element doesn't exist: popup-card` error you can try the following solutions below: 18 | 19 | ``` 20 | # Solution by Jimz011 21 | 1. Update HKI to the 2022.5.1 22 | 2. Delete browser-mod entirely (make sure nothing remains) 23 | 3. Re-download browser-mod from HACS with the latest version available at this very moment 24 | 4. Restart HA 25 | 5. Check in your Devices & Integrations and see if browser-mod is listed and loaded, if not add a new integration and select browser-mod 26 | 6. Open up the sidebar to find the browser-mod tab, click on it and register your browser 27 | ``` 28 | ``` 29 | # Solution by Markeydoo 30 | 1. Install browser mod 31 | 2. Thoroughly clear your browser cache 17 32 | 3. Go to the Browser Mod panel in your sidebar 33 | 4. Make sure the “Register” toggle is checked. 34 | 5. This is required in order to enable backend services to target this browser.* 35 | 6. Refresh the page (F5) 36 | 7. Go to Developer Tools → Services [![Open your Home Assistant instance and show your service developer tools. 37 | 8. Select service “Browser Mod: popup (browser_mod.popup)” 38 | 9. Check the “Title” checkbar and write something as a title 39 | 10. Enter some text in the “Content” text box, not yaml or anything, just any text for now. 40 | 11. Click “CALL SERVICE”, The button is likely grayed out. That’s a Home Assistant visual bug. Click it anyway. 41 | 12. A popup dialog should now open on all your Registered Browsers. 42 | ``` 43 | 44 | #### QUESTIONS? 45 | For questions please visit any of the support links on the [main page](https://github.com/jimz011/homekit-infused) of this repo. 46 | -------------------------------------------------------------------------------- /docs/paypal-donate-button.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jimz011/homekit-infused/9cab1a308dbb87a280f87ba2807bc316e454ca25/docs/paypal-donate-button.png -------------------------------------------------------------------------------- /docs/splitting-the-config.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | ## Splitting the Configuration 14 | It is possible to split your configuration so you can organize your views better and make your code more readable. 15 | 16 | Since it is useless to rewrite an entire documentation about this, here is the [official documentation](https://www.home-assistant.io/docs/configuration/splitting_configuration/). 17 | 18 | I mention this, since I believe it is one of the few things that new users don't get to see until they have already invested a lot of time into their dashboards/configurations. You can do this for your configuration, lovelace, automations etc. etc. Basically anything in Home Assistant can be split using this method. And it will eventually make your code a lot better readable and most of all, you will probably have a better time finding code that you made a long time ago. 19 | 20 | This basically allows you to split up your configuration in multiple files. 21 | 22 | #### Splitting the views.yaml file 23 | If you have read the official documentation you will have found that you can split basically any file into any folder, as long as you refer to it from the main file. This is also possible for the views.yaml file, for this example we will use a simple example on how to split your views into multiple files. For this example you must create a folder named `views` in `/hki-user/` (the full path would look like this `/hki-user/views`). 24 | 25 | ```yaml 26 | # views.yaml (example) 27 | views: 28 | !include_dir_named ../views 29 | ``` 30 | 31 | The above file will not need to be touched again since all config will be taken from the folder we have just created. 32 | Create a file with the name of your object in `/hki-user/views` (the file name will be the object and title of the view) 33 | 34 | ```yaml 35 | # hki-user/views/livingroom.yaml 36 | subtitle: My livingroom 37 | addons: 38 | button: 39 | - title: My livingroom lights 40 | entities: 41 | - light.lava_lamp 42 | ``` 43 | 44 | When using this method you MUST define EVERY view in a separate file. You can NOT have multiple views in the same file! 45 | Basically you do the exact same thing as in the views.yaml file, you have just split them up into multiple files. 46 | 47 | There is also an alternative way users can split up the configuration. 48 | ```yaml 49 | # views.yaml (example) 50 | views: 51 | !include_dir_merge_named ../views 52 | ``` 53 | 54 | The above file will not need to be touched again since all config will be taken from the folder we have just created. 55 | Create a file with the name of your object in `/hki-user/views`, in this case the name doesn't really matter since we need to define the object. 56 | 57 | ```yaml 58 | # hki-user/views/livingroom.yaml 59 | living_room: 60 | title: livingroom 61 | subtitle: My livingroom 62 | addons: 63 | button: 64 | - title: My livingroom lights 65 | entities: 66 | - light.lava_lamp 67 | ``` 68 | 69 | Using this method allows you to add multiple views in the same file as well as having multiple files, but you MUST define the object for each view. 70 | 71 | Whatever method you choose doesn't really matter, it is really up to personal preference, they are just methods of organising your code. If you do not feel comfortable doing this just use the `views.yaml` file. 72 | -------------------------------------------------------------------------------- /docs/thanks.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | # THANKS TO ALL OF YOU 14 | I wanted to thank everyone for supporting me, watching and subscribing to my channels, donating, downloading etc, helping me out, having posted addons or other great stuff for the community, and obviously the community itself ofcourse. 15 | All of you really, thank you. Here are a few names I want to specially thank! 16 | - @ciotlosm 17 | - @thomasloven 18 | - @balloob 19 | - @gluwc 20 | - @maykar 21 | - @robbiet480 22 | - @philhawthorne 23 | - @ljmerza 24 | - @iantrich 25 | - @kalkih 26 | - @bramkragten 27 | - @peternijssen 28 | - @eelcohn 29 | - @hunterjm 30 | - @jc2k 31 | - @kuuji 32 | - @romrider 33 | - @roflcoopter 34 | - @Piotrmachowski 35 | - @xMrVizzy 36 | - @MarsWarrior 37 | - @Dwains 38 | - @Sander_Abbink 39 | - @FranckNijhof 40 | - @Dbuit 41 | - @martinvdm 42 | - @diondk 43 | - @stephan 44 | - @hassan 45 | - @burningstone 46 | - @evr 47 | - @zbuh 48 | - @HomeAssistantAddicts Discord Group 49 | - @HomeAssistantNL/BE Slack group 50 | - @everyone I forgot to mention 51 | 52 | # Thanks for Translating (Applies to HKI 2 and 3) 53 | - @jolly for Italian 54 | - @yaazze for French 55 | - @hassan for Spanish 56 | - @sergiu for Alternative Spanish 57 | - @marcelomaciel for Brazilian Portuguese 58 | - @wayller for Norwegian 59 | - @manzn for German 60 | - @sergiu for Romanian 61 | - @aviabeksis for Hebrew 62 | - @donhimol for Polish 63 | 64 | # Special Thanks to my Donators 65 | - @marco 66 | - @huntergresh 67 | - @dhartsmith 68 | - @edgardmello 69 | - @magicmountainman 70 | - @aviabeksis 71 | - @tobygoulden 72 | - @royfreriks 73 | - @chrissmit 74 | - @joerihaas 75 | - @michaeldobson 76 | - @rickverduin 77 | - @fabiopergola 78 | - @sergiusuciu 79 | - @dworkin 80 | - @erikvanroekel 81 | - @ryssk 82 | - @diondk 83 | - @wayller 84 | - @brmsouza 85 | - @Adrianus Kon 86 | - @suscitatio 87 | - @LaceNode 88 | - @jaxc 89 | - @ali.sh 90 | - @NiMa008 91 | - @Daniel B Turgel 92 | - @toprunbu 93 | - @henrikrox 94 | - @PhysK 95 | - @valdesan 96 | - @luckies 97 | - @steve 98 | - @mny01 99 | - @Alex C 100 | - @Jeffrey W 101 | - @Larry S 102 | - @Ben Vermeulen 103 | 104 | I am really sorry, I have tried to get you all. But also a very big thank you to all of the ones not mentioned here. And ofcourse the Home Assistant community which helped me out a lot. Translations are no longer used, however I still want to thank them for their great input! 105 | -------------------------------------------------------------------------------- /docs/updates.md: -------------------------------------------------------------------------------- 1 | # Homekit Infused 5 2 | 3 | ## Content 4 | - [Introduction](index.md) 5 | - [Installation](installation.md) 6 | - [Configuration](configuration.md) 7 | - [Addons](addons.md) 8 | - [Updates](updates.md) 9 | - [Issues & Questions](issues.md) 10 | - [About Me](about.md) 11 | - [Thanks](thanks.md) 12 | 13 | ## Updates 14 | ### How to update HKI 5 to a newer version? 15 | To update Homekit Infused to a newer version all you need to do is download the latest release and replace the following 2 folders: 16 | - /hki-base/ 17 | - /packages/ 18 | 19 | Be sure to read any breaking changes. 20 | 21 | ### Procedure upgrading from HKI 4 (last version v2022.02.0) 22 | To put it simply.... There is none! There has been too many integral changes that it would take as much time explaining how to convert your setup as writing the entire project. 23 | 24 | It is not all that bad though, HKI 4 users will find that many things are pretty much the same and only slightly different. In most cases you can simply re-use the config you already had with some adjustments. Nevertheless you should NOT copy over the entire setup that you had, go slowly and do it view by view. 25 | 26 | There are two very notable changes though that I will mention here: 27 | - notifications have had their template name changed. 28 | - `/hki-user/views` is no longer the default folder for custom_cards, the folder has been renamed to `custom_legacy`! Why this change has been made can be found [here](splitting-the-config.md). 29 | 30 | Luckily you don't have to redo all your notifications, just make sure you change all the lines that contain `'../hki-base/templates/header/notification-template.yaml'` to `'../hki-base/templates/header/subtitle-notification-template.yaml'`. 31 | 32 | ## Versions (these are always up to date and are used as sensors within Home Assistant) 33 | [Current HKI Version](version.html) 34 | 35 | [Latest Compatible HA Version](version_compatible.html) 36 | -------------------------------------------------------------------------------- /docs/version.html: -------------------------------------------------------------------------------- 1 | Current Version: 2023.1.3 2 | -------------------------------------------------------------------------------- /docs/version_compatible.html: -------------------------------------------------------------------------------- 1 | Latest Compatible Version: 2023.12.x 2 | --------------------------------------------------------------------------------