jmcollin78 / versatile_thermostat

A full featured Thermostat for Home Assistant: presets, window, motion, presence and overpowering management
MIT License
320 stars 34 forks source link

missing documentation: "follow underlying temp change" #650

Open maia opened 1 day ago

maia commented 1 day ago

In a recent version the switch "follow underlying temp change" was added. With this name I do not understand what it does, it isn't self-explanatory, so I searched the repository for "follow underlying" and all I can find are two comments in the code base that aren't proper english and understandable:

"Set the flaf follow the underlying temperature changes" "The that enables the ManagedDevice optimisation with"

There search doesn't return a result in the documentation. So I suggest:

  1. give the switch a better name that is more self-explanatory
  2. fix the two comments in the code
  3. explain the feature in the documentation

Also, I suggest to place the switch differently in the UI, currently it's sitting between "eco" and "frost" temperature:

Bildschirmfoto 2024-11-17 um 10 20 48
jmcollin78 commented 15 hours ago

Hello, controls are in alphabetical order. I can't anything for this but you can always rename the "Follow..."

You are right the feature is not described in the documentation but here: https://github.com/jmcollin78/versatile_thermostat/issues/628. All is written in issues or PR or discussions, so this kind of search you should rather search in the github than in code when it is not described in the documentation.

Documentation improvement is a target I have but that is never the most urgent thing. I know you are very involved in the documentation. What do you think about proposing directly PR on the README ? I could really help me and improve the documentation, my English is so poor.

maia commented 14 hours ago

Thanks. I've read #628 but I'm still not exactly sure what it does. If e.g. I have 21°C target temperature but with the self-regulation 23° on the device and I change the temperature from 23° to 22° on the device, will that change the target temperature by -1 °C, so from 21° to 20°? That would be great, as I have multiple people in my extended family that don't have HA installed and expect to be able to change the room temperature on the TRV itself.

You don't need to explain this to me specifically, but that's something I think is important to explain in the documentation.

Regarding PRs: I am still a complete novice with git commands, as I never use them. I'm fine with making specific proposals as issues, but it's overwhelming to create a PR myself due to the lack of git knowledge. Besides that, I'm not a native speaker myself.

Regarding the documentation: I mentioned this before but I think it got lost: have you considered using ChatGPT for translations? This would greatly enhance the quality over Google translate, as ChatGPT would know the context of the entire integration and even the vocabulary used by Home Assistant. And ideally the integration itself is so self-explanatory that one doesn't need to check the documentation itself.

jmcollin78 commented 13 hours ago

If e.g. I have 21°C target temperature but with the self-regulation 23° on the device and I change the temperature from 23° to 22° on the device, will that change the target temperature by -1 °C, so from 21° to 20°?

If you set the target to 22° in the device, the VTherm will "follow" and set its target to 22°. Due to regulation, the Vtherm will maybe send 23° to the device which will then display 23°. This could be misleading but I don't have a better solution for now. But I'm working on it, I'm not sure you have seen it, but I'm trying to integrate a offset calibration. See here: #645. For now it is a POC for Sonoff TRVZB but this could easily extended if it's works.

This would greatly enhance the quality over Google translate, as ChatGPT

Yes i have seen that. One day, i will reorganize totally the documentation and it will be the time to translate with ChatGPT instead of Google Translate.

Git is not so hard. ChatGPT can help you to understand the concept. 😄