Troubleshooting
This plugin counts with an extensive suite of end-to-end tests. At the moment of writing, there are 466 tests covering every single option of the plugin and the coverage of the code is at 100%. On top of this, there are also regression tests through screenshots to check that that there are no visual changes when a modification of the code is done. There are also Nightly Beta Tests in place that run every night against the homeassistant/home-assistant:beta tag that allows us to detect if any option of the plugin will be broken in the next Home Assistant version before that version is released.
This means that if you detect that your configuration stopped working suddenly after an update, there are four possible reasons for that:
- The first one is caching
- The second one is caching
- The third one is caching
- The fourth one could be a bug in the code
Due to the amount of invalid issues in the repo (the majority related to caching issues), the Troubleshooting section has been created to help you detect from which place are coming your issues taking into account the most common causes. So first follow this section before assuming that there is a bug in the plugin code and reporting an issue.
Customisations are not applied
If the customisations are applied correctly in a browser but not in the Companion App, go to Issues with the Companion App.
Issues with the Companion App
Check first if the customisations are not applied also in a browser, if that is the case, go to Customisations are not applied.
Customisations are not applied in all devices
If the sidebar customisations work perfectly when you are connected through your local network but they don't work when you are connected remotely, or if you see that they work in some of your devices and not in others, you are suffering from caching issues. Caching is not something that is performed only in your device. Caching is performed at any level: in your local network, proxies, DNS providers (as Cloudflare), internet providers, Nabucasa, etc. You need to identify from which place the cache is performed and clean it there.
Warning about not matching sidebar items
This warning means that you have an item in your configuration that doesn't match any sidebar item.