Home-IoT/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-12-22 21:44:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Improve climate mode code docs (#1995)

Browse source 
Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Otto Winter 2021-07-10 11:23:04 +02:00 committed by GitHub
parent b62c47fede
commit 7ae611256a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
esphome/components/climate/climate_mode.h
View file

@ -7,19 +7,22 @@ namespace climate {
/// Enum for all modes a climate device can be in. /// Enum for all modes a climate device can be in.
enum ClimateMode : uint8_t { enum ClimateMode : uint8_t {
/// The climate device is off (not in auto, heat or cool mode) /// The climate device is off
CLIMATE_MODE_OFF = 0, CLIMATE_MODE_OFF = 0,
/// The climate device is set to automatically change the heating/cooling cycle /// The climate device is set to heat/cool to reach the target temperature.
CLIMATE_MODE_HEAT_COOL = 1, CLIMATE_MODE_HEAT_COOL = 1,
/// The climate device is manually set to cool mode (not in auto mode!) /// The climate device is set to cool to reach the target temperature
CLIMATE_MODE_COOL = 2, CLIMATE_MODE_COOL = 2,
/// The climate device is manually set to heat mode (not in auto mode!) /// The climate device is set to heat to reach the target temperature
CLIMATE_MODE_HEAT = 3, CLIMATE_MODE_HEAT = 3,
/// The climate device is manually set to fan only mode /// The climate device only has the fan enabled, no heating or cooling is taking place
CLIMATE_MODE_FAN_ONLY = 4, CLIMATE_MODE_FAN_ONLY = 4,
/// The climate device is manually set to dry mode /// The climate device is set to dry/humidity mode
CLIMATE_MODE_DRY = 5, CLIMATE_MODE_DRY = 5,
/// The climate device is manually set to heat-cool mode /** The climate device is adjusting the temperatre dynamically.
* For example, the target temperature can be adjusted based on a schedule, or learned behavior.
* The target temperature can't be adjusted when in this mode.
*/
CLIMATE_MODE_AUTO = 6 CLIMATE_MODE_AUTO = 6
}; };
@ -27,15 +30,15 @@ enum ClimateMode : uint8_t {
enum ClimateAction : uint8_t { enum ClimateAction : uint8_t {
/// The climate device is off (inactive or no power) /// The climate device is off (inactive or no power)
CLIMATE_ACTION_OFF = 0, CLIMATE_ACTION_OFF = 0,
/// The climate device is actively cooling (usually in cool or auto mode) /// The climate device is actively cooling
CLIMATE_ACTION_COOLING = 2, CLIMATE_ACTION_COOLING = 2,
/// The climate device is actively heating (usually in heat or auto mode) /// The climate device is actively heating
CLIMATE_ACTION_HEATING = 3, CLIMATE_ACTION_HEATING = 3,
/// The climate device is idle (monitoring climate but no action needed) /// The climate device is idle (monitoring climate but no action needed)
CLIMATE_ACTION_IDLE = 4, CLIMATE_ACTION_IDLE = 4,
/// The climate device is drying (either mode DRY or AUTO) /// The climate device is drying
CLIMATE_ACTION_DRYING = 5, CLIMATE_ACTION_DRYING = 5,
/// The climate device is in fan only mode (either mode FAN_ONLY or AUTO) /// The climate device is in fan only mode
CLIMATE_ACTION_FAN = 6, CLIMATE_ACTION_FAN = 6,
}; };