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

Minor Documentation improvements #192

Closed travisp closed 1 month ago

travisp commented 1 month ago

Description

Contains some changes to the documentation:

1) some minor fixes for grammar and typos 2) update documentation for climate mode to make clear what happens when no presence entity is set 3) updates the documentation to reflect that the default set of weather conditions that used in climate mode to activate adaptive cover includes "cloudy" 4) updates the flow chart by a) breaking into climate and non-climate subgraphs, and b) adding more details about the Climate->Presence condition as it doesn't always flow to the "normal mode"

If some, but not all, of these are wanted I am happy to pull out the commits.

Motivation and Context

It helps to make the project more accessible and easier to understand.

I'm not currently using presence sensors, but am using climate mode, so spent a bit of time trying to understand why adaptive cover was reacting the way it was. The key was that (1) when no presence sensor is present it acts as if someone is always present and (2) when in climate mode and presence is detected, the algorithm checks weather and temperature before deciding what to do.

How has this been tested?

I reviewed the changes in preview mode, and read the code to try to make sure I understood the code flow during climate mode.

Screenshots (if appropriate):

Types of changes

Checklist

PS - thank you for this project, it's great!

basbruss commented 1 month ago

Thank you!