Fix inconsistency in Thermostat and Hygrostat card names

[j4n-e4t]

fixes: #22324

Breaking change

Proposed change

Rephrase the descriptions of the "Thermostat" and "Hygrostat" cards based on the suggestions of @NoRi2909. (see: #22324)

Type of change

• [ ] Dependency upgrade
• [x] Bugfix (non-breaking change which fixes an issue)
• [ ] New feature (thank you!)
• [ ] Breaking change (fix/feature causing existing functionality to break)
• [ ] Code quality improvements to existing code or addition of tests

Example configuration

Additional information

• This PR fixes or closes issue: fixes #22324
• This PR is related to issue or discussion:
• Link to documentation pull request:

Checklist

• [x] The code change is tested and works locally.
• [x] There is no commented out code in this PR.
• [ ] Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

• [ ] Documentation added/updated for www.home-assistant.io

[silamon]

There is documentation that needs to be updated if we are updating the names.

[NoRi2909]

@silamon OK, that's at https://www.home-assistant.io/dashboards/humidifier/ ?

Can the documentation update on https://github.com/home-assistant/home-assistant.io/blob/current/source/_dashboards/humidifier.markdown be included with the PR?

Looks like this isn't to complicated with just a three words to be changed from "Humidifier" to "Hygrostat" above and below the graphic.

[j4n-e4t]

@silamon OK, that's at https://www.home-assistant.io/dashboards/humidifier/ ?

Can the documentation update on https://github.com/home-assistant/home-assistant.io/blob/current/source/_dashboards/humidifier.markdown be included with the PR?

Looks like this isn't to complicated with just a three words to be changed from "Humidifier" to "Hygrostat" above and below the graphic.

No, it can't since the website lives in a separate repo. But I'm currently not sure if this isn't a bit much overhead for such a small change. What do you think?

Also, I've noticed that some internal components still refer to the entities as "humidifier".

[NoRi2909]

Also, I've noticed that some internal components still refer to the entities as "humidifier".

The entities are no problem. They remain humidifiers and dehumidifiers. Nothing to change there at all.

The entire PR is about making the Hygrostat agnostic about the type of device it controls as it can do both (as it already says in the documentation)

This is the main problem here, because in German you can't simply add "(de)" in front of "humidifier" to cover both: The two device classes "Luftentfeuchter" and "Luftbefeuchter" differ in the middle of the word.

[piitaya]

In the documentation we have this description:

The humidifier card lets you control and monitor humidifiers, dehumidifiers, and hygrostat devices.

I think we can update the description to explain that it supports humidifier and dehumidifier but I would not change the name for now as it will not be aligned with the yaml name humidifier.

[NoRi2909]

@piitaya So just as heating / cooling entities are summarized under climate this means that as the first step humidifier should be changed to humidity to better cover both humidifiers and dehumidifiers.

Climate vs. Humidifier

[piitaya]

If we want to follow HA domains, it should be humidifier and climate but that's already wrong because a dehumidifier is using humidifier domain and that's kind of stupid 😅 Changing that names should be part of an architecture discussion because it's not just a front-end issue but also a core issue.

[NoRi2909]

Well, we're already getting confused by the inconsistency. It's all correct on the first line here:

• A Thermostat card controls a climate entity, either heating or cooling
• A Hygrostat card controls a humidity entity, either a humidifier or dehumidifier

The second line is not consistent at the moment as this is currently:

• A "Humidifier" card controls a humidifier entity, either a humidifier or dehumidifier

So we need to fix these two "humidifier" items, starting with the entity.

[piitaya]

BTW, I checked for other card and we already have inconsistencies between type and name (iframe card is named Webpage). So I agree, we can rename it to Hygrostat. Also, you we need to do a PR in the documentation to update the documentation page (https://www.home-assistant.io/dashboards/humidifier/) to update the name to Hygrostat.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[bramkragten]

@googanhiem Can you help out here?

[googanhiem]

The thermostat text change works.

However, I have concerns with the rename of humidifier to hygrostat, as it's a bit of a niche word in English. Though it is more technically correct, it would be harder for general users to find and understand.

[NoRi2909]

@googanhiem That problem with "Hygrostat" is solved as we already have the "Generic Hygrostat" in Helpers. So that term is already established within HA:

We're not introducing something new here, but rather fixing a major consistency in the naming of the Dashboard card.

Users will still find the card using search as this also finds all matches in the descriptions where we still have "humidifier" and "dehumidifier".

Note that in translations "humidifier" is currently a big problem.: In German that's a "Luftbefeuchter" while a "dehumidifier" is a "Luftentfeuchter". So there is no way to sum them up as "(de)humidifiers" like in English.

[bramkragten]

While Hygrostat technically is the correct word, we feel people will not understand it or feel at home with the word.

Thats why we would like to name the card "(de)humidifier" which can also be translated as "Humidifier / Dehumidifier".

[NoRi2909]

Well, most people will make their humidifier or dehumidifiers smart by first creating a Generic Hygrostat helper to control some smart plug that will turn this on or off.

So those will all become familiarized with "Hygrostat" this way anyhow. Then why not make things consistent and use the same for the card that just integrates the Hygrostat into the dashboard?

Using "Luftbefeuchter-/Luftentfeuchter-Karte" in German will probably create some spacing issues, perhaps we will then prefer to test drive "Hygrostat" in the German UI … 😃

[piitaya]

@NoRi2909 It's up to the translator to use the right term in their language. In french, "climate" is translated "thermostat" and "thermostat" is translated "thermostat".

Even we call it "hygrostat", it will be translated by "Humidificateur" in french because we don't have a word for hygrostat.

Hygrostat is not commonly use in english but if you have a better word than "Luftbefeuchter-/Luftentfeuchter-Karte" in german, you should use it.

[NoRi2909]

OK, no problem. I just try to remain as close to English as long as we don't have a German online documentation.

So when I think that i would reword that in my language I try to figure out if it does make sense to apply the same change in English, too. Certainly half of my bug reports or PRs now have been triggered that way.

Then just add the 'dehumidifier' in English so both device types are covered and we'll see how we'll match that in German.

[piitaya]

@NoRi2909 Could you do the changes so we can merge it?

[NoRi2909]

@piitaya as I didn't write this PR I think I'm not sure if I can make any edits?

[piitaya]

Oh sorry, I thought it was your PR 🙈

[NoRi2909]

@piitaya It's my bug, but @j4n-e4t picked it up and wrote the PR. If I sum up the conversation correctly, the changes to the Thermostat card are approved and we just need to revert back to "Humidifier" where it currently says "Hygrostat" in the PR:

"name": "Humidifier",
"description": "The Humidifier card gives control of a humidifier entity for humidifying or dehumdifying, allowing you to set its mode and desired humidity.",

So if someone with write access can change the two words back we should be good to go.