ESPHome  2024.6.6
Enumerations
esphome::api::enums Namespace Reference

Enumerations

enum  EntityCategory : uint32_t { ENTITY_CATEGORY_NONE = 0, ENTITY_CATEGORY_CONFIG = 1, ENTITY_CATEGORY_DIAGNOSTIC = 2 }
 
enum  LegacyCoverState : uint32_t { LEGACY_COVER_STATE_OPEN = 0, LEGACY_COVER_STATE_CLOSED = 1 }
 
enum  CoverOperation : uint32_t { COVER_OPERATION_IDLE = 0, COVER_OPERATION_IS_OPENING = 1, COVER_OPERATION_IS_CLOSING = 2 }
 
enum  LegacyCoverCommand : uint32_t { LEGACY_COVER_COMMAND_OPEN = 0, LEGACY_COVER_COMMAND_CLOSE = 1, LEGACY_COVER_COMMAND_STOP = 2 }
 
enum  FanSpeed : uint32_t { FAN_SPEED_LOW = 0, FAN_SPEED_MEDIUM = 1, FAN_SPEED_HIGH = 2 }
 
enum  FanDirection : uint32_t { FAN_DIRECTION_FORWARD = 0, FAN_DIRECTION_REVERSE = 1 }
 
enum  ColorMode : uint32_t {
  COLOR_MODE_UNKNOWN = 0, COLOR_MODE_ON_OFF = 1, COLOR_MODE_BRIGHTNESS = 2, COLOR_MODE_WHITE = 7,
  COLOR_MODE_COLOR_TEMPERATURE = 11, COLOR_MODE_COLD_WARM_WHITE = 19, COLOR_MODE_RGB = 35, COLOR_MODE_RGB_WHITE = 39,
  COLOR_MODE_RGB_COLOR_TEMPERATURE = 47, COLOR_MODE_RGB_COLD_WARM_WHITE = 51
}
 
enum  SensorStateClass : uint32_t { STATE_CLASS_NONE = 0, STATE_CLASS_MEASUREMENT = 1, STATE_CLASS_TOTAL_INCREASING = 2, STATE_CLASS_TOTAL = 3 }
 
enum  SensorLastResetType : uint32_t { LAST_RESET_NONE = 0, LAST_RESET_NEVER = 1, LAST_RESET_AUTO = 2 }
 
enum  LogLevel : uint32_t {
  LOG_LEVEL_NONE = 0, LOG_LEVEL_ERROR = 1, LOG_LEVEL_WARN = 2, LOG_LEVEL_INFO = 3,
  LOG_LEVEL_CONFIG = 4, LOG_LEVEL_DEBUG = 5, LOG_LEVEL_VERBOSE = 6, LOG_LEVEL_VERY_VERBOSE = 7
}
 
enum  ServiceArgType : uint32_t {
  SERVICE_ARG_TYPE_BOOL = 0, SERVICE_ARG_TYPE_INT = 1, SERVICE_ARG_TYPE_FLOAT = 2, SERVICE_ARG_TYPE_STRING = 3,
  SERVICE_ARG_TYPE_BOOL_ARRAY = 4, SERVICE_ARG_TYPE_INT_ARRAY = 5, SERVICE_ARG_TYPE_FLOAT_ARRAY = 6, SERVICE_ARG_TYPE_STRING_ARRAY = 7
}
 
enum  ClimateMode : uint32_t {
  CLIMATE_MODE_OFF = 0, CLIMATE_MODE_HEAT_COOL = 1, CLIMATE_MODE_COOL = 2, CLIMATE_MODE_HEAT = 3,
  CLIMATE_MODE_FAN_ONLY = 4, CLIMATE_MODE_DRY = 5, CLIMATE_MODE_AUTO = 6
}
 
enum  ClimateFanMode : uint32_t {
  CLIMATE_FAN_ON = 0, CLIMATE_FAN_OFF = 1, CLIMATE_FAN_AUTO = 2, CLIMATE_FAN_LOW = 3,
  CLIMATE_FAN_MEDIUM = 4, CLIMATE_FAN_HIGH = 5, CLIMATE_FAN_MIDDLE = 6, CLIMATE_FAN_FOCUS = 7,
  CLIMATE_FAN_DIFFUSE = 8, CLIMATE_FAN_QUIET = 9
}
 
enum  ClimateSwingMode : uint32_t { CLIMATE_SWING_OFF = 0, CLIMATE_SWING_BOTH = 1, CLIMATE_SWING_VERTICAL = 2, CLIMATE_SWING_HORIZONTAL = 3 }
 
enum  ClimateAction : uint32_t {
  CLIMATE_ACTION_OFF = 0, CLIMATE_ACTION_COOLING = 2, CLIMATE_ACTION_HEATING = 3, CLIMATE_ACTION_IDLE = 4,
  CLIMATE_ACTION_DRYING = 5, CLIMATE_ACTION_FAN = 6
}
 
enum  ClimatePreset : uint32_t {
  CLIMATE_PRESET_NONE = 0, CLIMATE_PRESET_HOME = 1, CLIMATE_PRESET_AWAY = 2, CLIMATE_PRESET_BOOST = 3,
  CLIMATE_PRESET_COMFORT = 4, CLIMATE_PRESET_ECO = 5, CLIMATE_PRESET_SLEEP = 6, CLIMATE_PRESET_ACTIVITY = 7
}
 
enum  NumberMode : uint32_t { NUMBER_MODE_AUTO = 0, NUMBER_MODE_BOX = 1, NUMBER_MODE_SLIDER = 2 }
 
enum  LockState : uint32_t {
  LOCK_STATE_NONE = 0, LOCK_STATE_LOCKED = 1, LOCK_STATE_UNLOCKED = 2, LOCK_STATE_JAMMED = 3,
  LOCK_STATE_LOCKING = 4, LOCK_STATE_UNLOCKING = 5
}
 
enum  LockCommand : uint32_t { LOCK_UNLOCK = 0, LOCK_LOCK = 1, LOCK_OPEN = 2 }
 
enum  MediaPlayerState : uint32_t { MEDIA_PLAYER_STATE_NONE = 0, MEDIA_PLAYER_STATE_IDLE = 1, MEDIA_PLAYER_STATE_PLAYING = 2, MEDIA_PLAYER_STATE_PAUSED = 3 }
 
enum  MediaPlayerCommand : uint32_t {
  MEDIA_PLAYER_COMMAND_PLAY = 0, MEDIA_PLAYER_COMMAND_PAUSE = 1, MEDIA_PLAYER_COMMAND_STOP = 2, MEDIA_PLAYER_COMMAND_MUTE = 3,
  MEDIA_PLAYER_COMMAND_UNMUTE = 4
}
 
enum  BluetoothDeviceRequestType : uint32_t {
  BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT = 0, BLUETOOTH_DEVICE_REQUEST_TYPE_DISCONNECT = 1, BLUETOOTH_DEVICE_REQUEST_TYPE_PAIR = 2, BLUETOOTH_DEVICE_REQUEST_TYPE_UNPAIR = 3,
  BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT_V3_WITH_CACHE = 4, BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT_V3_WITHOUT_CACHE = 5, BLUETOOTH_DEVICE_REQUEST_TYPE_CLEAR_CACHE = 6
}
 
enum  VoiceAssistantSubscribeFlag : uint32_t { VOICE_ASSISTANT_SUBSCRIBE_NONE = 0, VOICE_ASSISTANT_SUBSCRIBE_API_AUDIO = 1 }
 
enum  VoiceAssistantRequestFlag : uint32_t { VOICE_ASSISTANT_REQUEST_NONE = 0, VOICE_ASSISTANT_REQUEST_USE_VAD = 1, VOICE_ASSISTANT_REQUEST_USE_WAKE_WORD = 2 }
 
enum  VoiceAssistantEvent : uint32_t {
  VOICE_ASSISTANT_ERROR = 0, VOICE_ASSISTANT_RUN_START = 1, VOICE_ASSISTANT_RUN_END = 2, VOICE_ASSISTANT_STT_START = 3,
  VOICE_ASSISTANT_STT_END = 4, VOICE_ASSISTANT_INTENT_START = 5, VOICE_ASSISTANT_INTENT_END = 6, VOICE_ASSISTANT_TTS_START = 7,
  VOICE_ASSISTANT_TTS_END = 8, VOICE_ASSISTANT_WAKE_WORD_START = 9, VOICE_ASSISTANT_WAKE_WORD_END = 10, VOICE_ASSISTANT_STT_VAD_START = 11,
  VOICE_ASSISTANT_STT_VAD_END = 12, VOICE_ASSISTANT_TTS_STREAM_START = 98, VOICE_ASSISTANT_TTS_STREAM_END = 99
}
 
enum  VoiceAssistantTimerEvent : uint32_t { VOICE_ASSISTANT_TIMER_STARTED = 0, VOICE_ASSISTANT_TIMER_UPDATED = 1, VOICE_ASSISTANT_TIMER_CANCELLED = 2, VOICE_ASSISTANT_TIMER_FINISHED = 3 }
 
enum  AlarmControlPanelState : uint32_t {
  ALARM_STATE_DISARMED = 0, ALARM_STATE_ARMED_HOME = 1, ALARM_STATE_ARMED_AWAY = 2, ALARM_STATE_ARMED_NIGHT = 3,
  ALARM_STATE_ARMED_VACATION = 4, ALARM_STATE_ARMED_CUSTOM_BYPASS = 5, ALARM_STATE_PENDING = 6, ALARM_STATE_ARMING = 7,
  ALARM_STATE_DISARMING = 8, ALARM_STATE_TRIGGERED = 9
}
 
enum  AlarmControlPanelStateCommand : uint32_t {
  ALARM_CONTROL_PANEL_DISARM = 0, ALARM_CONTROL_PANEL_ARM_AWAY = 1, ALARM_CONTROL_PANEL_ARM_HOME = 2, ALARM_CONTROL_PANEL_ARM_NIGHT = 3,
  ALARM_CONTROL_PANEL_ARM_VACATION = 4, ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS = 5, ALARM_CONTROL_PANEL_TRIGGER = 6
}
 
enum  TextMode : uint32_t { TEXT_MODE_TEXT = 0, TEXT_MODE_PASSWORD = 1 }
 
enum  ValveOperation : uint32_t { VALVE_OPERATION_IDLE = 0, VALVE_OPERATION_IS_OPENING = 1, VALVE_OPERATION_IS_CLOSING = 2 }
 

Enumeration Type Documentation

◆ AlarmControlPanelState

Enumerator
ALARM_STATE_DISARMED 
ALARM_STATE_ARMED_HOME 
ALARM_STATE_ARMED_AWAY 
ALARM_STATE_ARMED_NIGHT 
ALARM_STATE_ARMED_VACATION 
ALARM_STATE_ARMED_CUSTOM_BYPASS 
ALARM_STATE_PENDING 
ALARM_STATE_ARMING 
ALARM_STATE_DISARMING 
ALARM_STATE_TRIGGERED 

Definition at line 200 of file api_pb2.h.

◆ AlarmControlPanelStateCommand

Enumerator
ALARM_CONTROL_PANEL_DISARM 
ALARM_CONTROL_PANEL_ARM_AWAY 
ALARM_CONTROL_PANEL_ARM_HOME 
ALARM_CONTROL_PANEL_ARM_NIGHT 
ALARM_CONTROL_PANEL_ARM_VACATION 
ALARM_CONTROL_PANEL_ARM_CUSTOM_BYPASS 
ALARM_CONTROL_PANEL_TRIGGER 

Definition at line 212 of file api_pb2.h.

◆ BluetoothDeviceRequestType

Enumerator
BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT 
BLUETOOTH_DEVICE_REQUEST_TYPE_DISCONNECT 
BLUETOOTH_DEVICE_REQUEST_TYPE_PAIR 
BLUETOOTH_DEVICE_REQUEST_TYPE_UNPAIR 
BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT_V3_WITH_CACHE 
BLUETOOTH_DEVICE_REQUEST_TYPE_CONNECT_V3_WITHOUT_CACHE 
BLUETOOTH_DEVICE_REQUEST_TYPE_CLEAR_CACHE 

Definition at line 159 of file api_pb2.h.

◆ ClimateAction

Enumerator
CLIMATE_ACTION_OFF 
CLIMATE_ACTION_COOLING 
CLIMATE_ACTION_HEATING 
CLIMATE_ACTION_IDLE 
CLIMATE_ACTION_DRYING 
CLIMATE_ACTION_FAN 

Definition at line 110 of file api_pb2.h.

◆ ClimateFanMode

Enumerator
CLIMATE_FAN_ON 
CLIMATE_FAN_OFF 
CLIMATE_FAN_AUTO 
CLIMATE_FAN_LOW 
CLIMATE_FAN_MEDIUM 
CLIMATE_FAN_HIGH 
CLIMATE_FAN_MIDDLE 
CLIMATE_FAN_FOCUS 
CLIMATE_FAN_DIFFUSE 
CLIMATE_FAN_QUIET 

Definition at line 92 of file api_pb2.h.

◆ ClimateMode

Enumerator
CLIMATE_MODE_OFF 
CLIMATE_MODE_HEAT_COOL 
CLIMATE_MODE_COOL 
CLIMATE_MODE_HEAT 
CLIMATE_MODE_FAN_ONLY 
CLIMATE_MODE_DRY 
CLIMATE_MODE_AUTO 

Definition at line 83 of file api_pb2.h.

◆ ClimatePreset

Enumerator
CLIMATE_PRESET_NONE 
CLIMATE_PRESET_HOME 
CLIMATE_PRESET_AWAY 
CLIMATE_PRESET_BOOST 
CLIMATE_PRESET_COMFORT 
CLIMATE_PRESET_ECO 
CLIMATE_PRESET_SLEEP 
CLIMATE_PRESET_ACTIVITY 

Definition at line 118 of file api_pb2.h.

◆ ClimateSwingMode

Enumerator
CLIMATE_SWING_OFF 
CLIMATE_SWING_BOTH 
CLIMATE_SWING_VERTICAL 
CLIMATE_SWING_HORIZONTAL 

Definition at line 104 of file api_pb2.h.

◆ ColorMode

Enumerator
COLOR_MODE_UNKNOWN 
COLOR_MODE_ON_OFF 
COLOR_MODE_BRIGHTNESS 
COLOR_MODE_WHITE 
COLOR_MODE_COLOR_TEMPERATURE 
COLOR_MODE_COLD_WARM_WHITE 
COLOR_MODE_RGB 
COLOR_MODE_RGB_WHITE 
COLOR_MODE_RGB_COLOR_TEMPERATURE 
COLOR_MODE_RGB_COLD_WARM_WHITE 

Definition at line 40 of file api_pb2.h.

◆ CoverOperation

Enumerator
COVER_OPERATION_IDLE 
COVER_OPERATION_IS_OPENING 
COVER_OPERATION_IS_CLOSING 

Definition at line 21 of file api_pb2.h.

◆ EntityCategory

Enumerator
ENTITY_CATEGORY_NONE 
ENTITY_CATEGORY_CONFIG 
ENTITY_CATEGORY_DIAGNOSTIC 

Definition at line 12 of file api_pb2.h.

◆ FanDirection

Enumerator
FAN_DIRECTION_FORWARD 
FAN_DIRECTION_REVERSE 

Definition at line 36 of file api_pb2.h.

◆ FanSpeed

Enumerator
FAN_SPEED_LOW 
FAN_SPEED_MEDIUM 
FAN_SPEED_HIGH 

Definition at line 31 of file api_pb2.h.

◆ LegacyCoverCommand

Enumerator
LEGACY_COVER_COMMAND_OPEN 
LEGACY_COVER_COMMAND_CLOSE 
LEGACY_COVER_COMMAND_STOP 

Definition at line 26 of file api_pb2.h.

◆ LegacyCoverState

Enumerator
LEGACY_COVER_STATE_OPEN 
LEGACY_COVER_STATE_CLOSED 

Definition at line 17 of file api_pb2.h.

◆ LockCommand

Enumerator
LOCK_UNLOCK 
LOCK_LOCK 
LOCK_OPEN 

Definition at line 141 of file api_pb2.h.

◆ LockState

Enumerator
LOCK_STATE_NONE 
LOCK_STATE_LOCKED 
LOCK_STATE_UNLOCKED 
LOCK_STATE_JAMMED 
LOCK_STATE_LOCKING 
LOCK_STATE_UNLOCKING 

Definition at line 133 of file api_pb2.h.

◆ LogLevel

Enumerator
LOG_LEVEL_NONE 
LOG_LEVEL_ERROR 
LOG_LEVEL_WARN 
LOG_LEVEL_INFO 
LOG_LEVEL_CONFIG 
LOG_LEVEL_DEBUG 
LOG_LEVEL_VERBOSE 
LOG_LEVEL_VERY_VERBOSE 

Definition at line 63 of file api_pb2.h.

◆ MediaPlayerCommand

Enumerator
MEDIA_PLAYER_COMMAND_PLAY 
MEDIA_PLAYER_COMMAND_PAUSE 
MEDIA_PLAYER_COMMAND_STOP 
MEDIA_PLAYER_COMMAND_MUTE 
MEDIA_PLAYER_COMMAND_UNMUTE 

Definition at line 152 of file api_pb2.h.

◆ MediaPlayerState

Enumerator
MEDIA_PLAYER_STATE_NONE 
MEDIA_PLAYER_STATE_IDLE 
MEDIA_PLAYER_STATE_PLAYING 
MEDIA_PLAYER_STATE_PAUSED 

Definition at line 146 of file api_pb2.h.

◆ NumberMode

Enumerator
NUMBER_MODE_AUTO 
NUMBER_MODE_BOX 
NUMBER_MODE_SLIDER 

Definition at line 128 of file api_pb2.h.

◆ SensorLastResetType

Enumerator
LAST_RESET_NONE 
LAST_RESET_NEVER 
LAST_RESET_AUTO 

Definition at line 58 of file api_pb2.h.

◆ SensorStateClass

Enumerator
STATE_CLASS_NONE 
STATE_CLASS_MEASUREMENT 
STATE_CLASS_TOTAL_INCREASING 
STATE_CLASS_TOTAL 

Definition at line 52 of file api_pb2.h.

◆ ServiceArgType

Enumerator
SERVICE_ARG_TYPE_BOOL 
SERVICE_ARG_TYPE_INT 
SERVICE_ARG_TYPE_FLOAT 
SERVICE_ARG_TYPE_STRING 
SERVICE_ARG_TYPE_BOOL_ARRAY 
SERVICE_ARG_TYPE_INT_ARRAY 
SERVICE_ARG_TYPE_FLOAT_ARRAY 
SERVICE_ARG_TYPE_STRING_ARRAY 

Definition at line 73 of file api_pb2.h.

◆ TextMode

Enumerator
TEXT_MODE_TEXT 
TEXT_MODE_PASSWORD 

Definition at line 221 of file api_pb2.h.

◆ ValveOperation

Enumerator
VALVE_OPERATION_IDLE 
VALVE_OPERATION_IS_OPENING 
VALVE_OPERATION_IS_CLOSING 

Definition at line 225 of file api_pb2.h.

◆ VoiceAssistantEvent

Enumerator
VOICE_ASSISTANT_ERROR 
VOICE_ASSISTANT_RUN_START 
VOICE_ASSISTANT_RUN_END 
VOICE_ASSISTANT_STT_START 
VOICE_ASSISTANT_STT_END 
VOICE_ASSISTANT_INTENT_START 
VOICE_ASSISTANT_INTENT_END 
VOICE_ASSISTANT_TTS_START 
VOICE_ASSISTANT_TTS_END 
VOICE_ASSISTANT_WAKE_WORD_START 
VOICE_ASSISTANT_WAKE_WORD_END 
VOICE_ASSISTANT_STT_VAD_START 
VOICE_ASSISTANT_STT_VAD_END 
VOICE_ASSISTANT_TTS_STREAM_START 
VOICE_ASSISTANT_TTS_STREAM_END 

Definition at line 177 of file api_pb2.h.

◆ VoiceAssistantRequestFlag

Enumerator
VOICE_ASSISTANT_REQUEST_NONE 
VOICE_ASSISTANT_REQUEST_USE_VAD 
VOICE_ASSISTANT_REQUEST_USE_WAKE_WORD 

Definition at line 172 of file api_pb2.h.

◆ VoiceAssistantSubscribeFlag

Enumerator
VOICE_ASSISTANT_SUBSCRIBE_NONE 
VOICE_ASSISTANT_SUBSCRIBE_API_AUDIO 

Definition at line 168 of file api_pb2.h.

◆ VoiceAssistantTimerEvent

Enumerator
VOICE_ASSISTANT_TIMER_STARTED 
VOICE_ASSISTANT_TIMER_UPDATED 
VOICE_ASSISTANT_TIMER_CANCELLED 
VOICE_ASSISTANT_TIMER_FINISHED 

Definition at line 194 of file api_pb2.h.