Skip to content

Troubleshooting guide

Gerben ten Hove edited this page Aug 11, 2019 · 1 revision

You could have run into an issue with a custom card. Please be sure to have followed these steps before you submit an issue report. It can save you and me a lot of time.

TL;DR

Use the latest version. Don't be fooled by the cache. Use the debug info that the card can supply. Search the forum topic and in issue reports for similar issues.

Before submitting an issue report, please follow all the steps

Step 1: Check if you use the latest version of the card

Because the cards are improving version by version your issue may have been resolved already in a next version of the card. You can check the latest version here. You have some options to check which version you are using:

  • Look into the first few lines of the code in the .js file of the card. Or:
  • Use the custom_updater custom component (for advanced users). Click the Check button in the tracker-card and compare versions. Or:
  • Enable debug mode and look in the dev console of your browser. You can enable the debug mode by supplying an extra parameter to the config of the card: debug: true. (This option also helps for step 2 and 3 so why not choose it. ;-) )

Step 2: Check if you don't use a old cached version of the card

Nb. Refreshing your browser is not enough! Nb. Refreshing Lovelace (button in upper right corner) is not enough! After each change in the code of the card you have to perform an action to tell the browser to skip the cached version of the card. This is needed e.g. if you copy a new version of the code into the .js file. But it's also needed if you make custom changes in the code of the card. And don't forget to do it when you recover a previous version of your HA. In all cases you could end up using an old cached version of the card.

What to do to skip the cache?

  1. Update your ui-lovelace.yaml where it imports the card in the top of this file. Look for the ?v=<number> part. Increase the number by one. The number itself isn't relevant. But it should be unique for each time you want to skip the cached version. I.e. if you used ?v=8 yesterday, don't use it again next week!
  2. Refresh your browser (usually by pressing F5).
  3. Refresh Lovelace by clicking Refresh in the menu in the upper right corner of HA.

Step 3: Enable debug mode

When the card operates in debug mode you get extra information in the dev console of the browser. The dev console usually opens with F12. The extra information can help you solve the issue yourself. It is also handy when you want to report the issue, because all the version information of the card, of HA, of your browser is available in the logging in the dev console.

You can enable the debug mode by supplying an extra parameter to the config of the card: debug: true.

Step 4: Search if others ran into the same issue before you

Sometimes you're not the first one with the issue. You can search in this forum topic for power-wheel-card and search in the open and closed issues here.

Step 5: Report the issue

If nothing helped, then please submit an issue report. Please fill in the complete template, even if it sounds irrelevant to you. You can upload a screenshot if you think that's relevant. Submit the report here and please choose for Bug report.