Skip to content

Review before submitting a new issue or feature request

Jump to bottom
bruxy70 edited this page May 24, 2020 · 15 revisions

Before submitting an issue, please check these frequent questions and known limitations

  • Many of the submitted bugs are not really errors in the integration, but rather questions about the configuration of the Lovelace card, or issues with a custom card. I am happy to help (if I can), but please open these issues as questions, not bugs (I spend a lot of time trying to replicate it and check the code for possible clues). Below are some clues that can help to recognize an actual bug. Thanks for your help!

  • Translations: the way they work is, the state sensor is always in English, and it is translated by the front end to the language selected in the user profile (if translation for that language exists). There could be a number of users configured at the same time, each with a different language - so this way each will see the state in his language (the sensor obviously cannot have multiple states at the same time, so this is why the actual state stays in English, independently of the user language setting). The other reason is, that the state should not change when you change the language, otherwise the automations would stop working. The actual sensor state should be all in lower case. The translated state usually has the first letter capitalized (yes, there is translation even for English).

  • The custom cards can do the translations on their own (e.g. the custom:garbage-collection-card). In this case, please open the issue on the website of this custom card.

  • The easiest way to recognize a bug in this integration from a problem with your front end config is to

  1. go to Developer Tools and click on tab States
  2. under Current entities, type the name of your sensor in the filter
  3. You can see the actual sensor state (not translated) in the column State
  4. click to the (i) icon before the entity name to check the sensor state translated by this integration (top right corner) and attributes. If you refer to the sensor state, always include a screenshot from this card please. Thank you!

  • Translation of the configuration. The configuration of the integration can contain names of weeks or month names. These are always in English and can't be translated to local language (not even from the GUI config).

  • If you This is a Home Assistant limitation where the current Jinja 2 implementation does not support locales. Formatting of the sensor state including localization should really be done on the frontend (Lovelace), based on the language selected in the user profile. Because of frequent requests, I have added verbose output and added localization to the sensor itself. But I am not going to extend this any further, as it would never stop.

  • If you add/configure the sensors in Configuration/Integrations (not in YAML), each sensor will create a separate integration entry, there is no way to add multiple sensors under one integration. This is a current Home Assistant limitation (since the sensors are not linked to physical devices, there is no option to add additional devices under the integration). You can add as many entries you want, there is no limitation.

  • If you want to delete the integration, please first remove the configured sensors (if you have configured them from in Configuration/Integration) - not applicable to YAML

  • You have to restart HA after installing are removing the integration, or after changing the configuration in YAML mode.

  • If you configure an optional parameter via Configuration/Integration, it cannot be removed, only changed. This is Home Assistant limitation/bug.

  • Change of sensor entity_id, is only possible for sensors configured in Configuration/Integration. The sensors configured in YAML will be given entity_id automatically based on the friendly_name.

Please respect the following rules:

  1. Before creating a new issue, search the issues if a similar issue did not exist.
  2. If you are a developer, consider creating a pull request with your suggested change. This is especially the case for translations. There are 2 files for each language - one translates the sensor values, the other the web-based configuration.
  3. Use the provided templates - leave the headers and replace the instructions with your text.
Clone this wiki locally