Glossary of Terms

[kneave]

I've been asked to clarify a bunch of terminology used so thought I'd start this discussion both to track what folks ask for and to keep as a source of info for others. Here is some of the terminology cleared up so far, if anyone has requests let me know and I'll add it to the list.

Scheduler (Front end):

• This allows the user to create and edit schedules to apply to the various climate entities considered "monitored" by the integration
• It also allows for choosing which entities to monitor and if they should be controlled individually or grouped together

Coordinator (Back End):

• This runs once per minute and compares the state of the monitored entities against the state requested by the user via the schedules
• If the current time has a node assigned to it the state in that node should be applied to all the entities assigned to the schedule
• If the state of an entity has been changed by a user manually in the interim, that change will be respected unless the user calls "Sync Thermostats"

Schedule:

• Contains the climate settings to apply at specified times, as defined by the user
• These settings are contained within a profile, each schedule can contain more than one profile to enable the user to create different control schemes
• Previously there were single entity schedules and group schedules, see below for an explanation

Profile:

• Profile examples include: Home, Away, Vacation, Winter, Summer, or whatever the user needs.
• Profiles are stored at the schedule level so if you have a Downstairs and Upstairs schedule you'd need to create separate profiles within each

A Note on Groups:
When the integration was first created it just controlled individual entities, grouping entities was added afterwards and for a while there were separate code paths for each which was causing a headache from a dev perspective. I changed things around so that a group could have a single member instead so that we only had one set of code paths regardless of number of members.

I need to make the terminology more consistent but essentially Group and Schedule should be considered interchangeable for the time being.