basbruss / adaptive-cover

An Adaptive Cover component for HomeAsisstant to control covers based on the sun's position
MIT License
57 stars 7 forks source link

Unclear meaning of configuration parameters #165

Open mion00 opened 1 month ago

mion00 commented 1 month ago

Checklist

Is your feature request related to a problem? Please describe.

Thank you for this great integration! I am eager to try it out with my outdoor (horizontal) awning, but I have some doubts in what the various parameters mean. For instance windows height is described as:

Height of the window when fully extended

Is it a typo? What does it mean for the window to be fully extended?

Describe the solution you'd like

Does it perhaps mean the distance from the floor to the bottom part of the window?

Describe alternatives you've considered

Maybe adding a simple diagram to the README might help avoid clear any doubts.

Additional context

I have tried to draw a (very basic) sketch to explain my target setup. Are the labels indicated in the drawing correct?

adaptive_cover drawio

bradkoerner commented 1 week ago

I agree, a diagram would be immensely helpful. It would also be nice to have example use-cases for each of the parameters. It's hard to know why I'm setting parameters and what changing them will actually affect.

For example
Minimal Elevation None 1-90 Minimal elevation degree of the sun to be considered
Maximum Elevation None 1-90 Maximum elevation degree of the sun to be considered
Could instead read as
Minimal Elevation None 1-90 Minimal elevation degree of the sun to be considered. Ex. There is a neighboring building that blocks the sun when it is below 20 degrees
Maximum Elevation None 1-90 Maximum elevation degree of the sun to be considered Ex. There is fixed awning over the window that blocks the sun when it is higher than 80 degrees overhead

I'm not even sure if my example is accurate to what that parameter controls, which is why I think diagrams and examples would be helpful.