Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc hello (HelloRequest, HelloResponse)

  api.proto:6

  message HelloRequest

  api.proto:92

  Message sent at the beginning of each connection Can only be sent by the client and only at the beginning of the connection

  • string client_info = 1

    Description of client (like User Agent) For example "Home Assistant" Not strictly necessary to send but nice for debugging purposes.

  • uint32 api_version_major = 2

  • uint32 api_version_minor = 3

  message HelloResponse

  api.proto:108

  Confirmation of successful connection request. Can only be sent by the server and only at the beginning of the connection

  • uint32 api_version_major = 1

    The version of the API to use. The _client_ (for example Home Assistant) needs to check for compatibility and if necessary adopt to an older API. Major is for breaking changes in the base protocol - a mismatch will lead to immediate disconnect_client_ Minor is for breaking changes in individual messages - a mismatch will lead to a warning message

  • uint32 api_version_minor = 2

  • string server_info = 3

    A string identifying the server (ESP); like client info this may be empty and only exists for debugging/logging purposes. For example "ESPHome v1.10.0 on ESP8266"

  • string name = 4

    The name of the server (App.get_name())

• rpc connect (ConnectRequest, ConnectResponse)

  api.proto:10

  message ConnectRequest

  api.proto:131

  Message sent at the beginning of each connection to authenticate the client Can only be sent by the client and only at the beginning of the connection

  • string password = 1

    The password to log in with

  message ConnectResponse

  api.proto:142

  Confirmation of successful connection. After this the connection is available for all traffic. Can only be sent by the server and only at the beginning of the connection

  • bool invalid_password = 1

• rpc disconnect (DisconnectRequest, DisconnectResponse)

  api.proto:14

  message DisconnectRequest

  api.proto:152

  Request to close the connection. Can be sent by both the client and server

  (message has no fields)

  message DisconnectResponse

  api.proto:160

  (message has no fields)

• rpc ping (PingRequest, PingResponse)

  api.proto:18

  message PingRequest

  api.proto:169

  (message has no fields)

  message PingResponse

  api.proto:175

  (message has no fields)

• rpc device_info (DeviceInfoRequest, DeviceInfoResponse)

  api.proto:22

  message DeviceInfoRequest

  api.proto:181

  (message has no fields)

  message DeviceInfoResponse

  api.proto:187

  • bool uses_password = 1

  • string name = 2

    The name of the node, given by "App.set_name()"

  • string mac_address = 3

    The mac address of the device. For example "AC:BC:32:89:0E:A9"

  • string esphome_version = 4

    A string describing the ESPHome version. For example "1.10.0"

  • string compilation_time = 5

    A string describing the date of compilation, this is generated by the compiler and therefore may not be in the same format all the time. If the user isn't using ESPHome, this will also not be set.

  • string model = 6

    The model of the board. For example NodeMCU

  • bool has_deep_sleep = 7

  • string project_name = 8

    The esphome project details if set

  • string project_version = 9

  • uint32 webserver_port = 10

  • uint32 legacy_bluetooth_proxy_version = 11

  • uint32 bluetooth_proxy_feature_flags = 15

  • string manufacturer = 12

  • string friendly_name = 13

  • uint32 legacy_voice_assistant_version = 14

  • uint32 voice_assistant_feature_flags = 17

  • string suggested_area = 16

  • string bluetooth_mac_address = 18

    The Bluetooth mac address of the device. For example "AC:BC:32:89:0E:AA"

  • bool api_encryption_supported = 19

    Supports receiving and saving api encryption key

• rpc list_entities (ListEntitiesRequest, void)

  api.proto:25

  message ListEntitiesRequest

  api.proto:237

  (message has no fields)

• rpc subscribe_states (SubscribeStatesRequest, void)

  api.proto:26

  message SubscribeStatesRequest

  api.proto:248

  (message has no fields)

• rpc subscribe_logs (SubscribeLogsRequest, void)

  api.proto:27

  message SubscribeLogsRequest

  api.proto:629

  • LogLevel level = 1

  • bool dump_config = 2

• rpc subscribe_homeassistant_services (SubscribeHomeassistantServicesRequest, void)

  api.proto:28

  message SubscribeHomeassistantServicesRequest

  api.proto:664

  ==================== HOMEASSISTANT.SERVICE ====================

  (message has no fields)

• rpc subscribe_home_assistant_states (SubscribeHomeAssistantStatesRequest, void)

  api.proto:29

  message SubscribeHomeAssistantStatesRequest

  api.proto:690

  ==================== IMPORT HOME ASSISTANT STATES ==================== 1. Client sends SubscribeHomeAssistantStatesRequest 2. Server responds with zero or more SubscribeHomeAssistantStateResponse (async) 3. Client sends HomeAssistantStateResponse for state changes.

  (message has no fields)

• rpc get_time (GetTimeRequest, GetTimeResponse)

  api.proto:30

  message GetTimeRequest

  api.proto:714

  ==================== IMPORT TIME ====================

  (message has no fields)

  message GetTimeResponse

  api.proto:719

  • fixed32 epoch_seconds = 1

• rpc execute_service (ExecuteServiceRequest, void)

  api.proto:33

  message ExecuteServiceRequest

  api.proto:762

  • fixed32 key = 1

  • repeated ExecuteServiceArgument args = 2

• rpc noise_encryption_set_key (NoiseEncryptionSetKeyRequest, NoiseEncryptionSetKeyResponse)

  api.proto:34

  message NoiseEncryptionSetKeyRequest

  api.proto:647

  ==================== NOISE ENCRYPTION ====================

  • bytes key = 1

  message NoiseEncryptionSetKeyResponse

  api.proto:655

  • bool success = 1

• rpc cover_command (CoverCommandRequest, void)

  api.proto:36

  message CoverCommandRequest

  api.proto:343

  • fixed32 key = 1

  • bool has_legacy_command = 2

    legacy: command has been removed in 1.13 clients/servers must still send/accept it until the next protocol change

  • LegacyCoverCommand legacy_command = 3

  • bool has_position = 4

  • float position = 5

  • bool has_tilt = 6

  • float tilt = 7

  • bool stop = 8

• rpc fan_command (FanCommandRequest, void)

  api.proto:37

  message FanCommandRequest

  api.proto:406

  • fixed32 key = 1

  • bool has_state = 2

  • bool state = 3

  • bool has_speed = 4

  • FanSpeed speed = 5

  • bool has_oscillating = 6

  • bool oscillating = 7

  • bool has_direction = 8

  • FanDirection direction = 9

  • bool has_speed_level = 10

  • int32 speed_level = 11

  • bool has_preset_mode = 12

  • string preset_mode = 13

• rpc light_command (LightCommandRequest, void)

  api.proto:38

  message LightCommandRequest

  api.proto:471

  • fixed32 key = 1

  • bool has_state = 2

  • bool state = 3

  • bool has_brightness = 4

  • float brightness = 5

  • bool has_color_mode = 22

  • int32 color_mode = 23

  • bool has_color_brightness = 20

  • float color_brightness = 21

  • bool has_rgb = 6

  • float red = 7

  • float green = 8

  • float blue = 9

  • bool has_white = 10

  • float white = 11

  • bool has_color_temperature = 12

  • float color_temperature = 13

  • bool has_cold_white = 24

  • float cold_white = 25

  • bool has_warm_white = 26

  • float warm_white = 27

  • bool has_transition_length = 14

  • uint32 transition_length = 15

  • bool has_flash_length = 16

  • uint32 flash_length = 17

  • bool has_effect = 18

  • string effect = 19

• rpc switch_command (SwitchCommandRequest, void)

  api.proto:39

  message SwitchCommandRequest

  api.proto:579

  • fixed32 key = 1

  • bool state = 2

• rpc camera_image (CameraImageRequest, void)

  api.proto:40

  message CameraImageRequest

  api.proto:795

  • bool single = 1

  • bool stream = 2

• rpc climate_command (ClimateCommandRequest, void)

  api.proto:41

  message ClimateCommandRequest

  api.proto:909

  • fixed32 key = 1

  • bool has_mode = 2

  • ClimateMode mode = 3

  • bool has_target_temperature = 4

  • float target_temperature = 5

  • bool has_target_temperature_low = 6

  • float target_temperature_low = 7

  • bool has_target_temperature_high = 8

  • float target_temperature_high = 9

  • bool has_legacy_away = 10

    legacy, for older peers, newer ones should use CLIMATE_PRESET_AWAY in preset

  • bool legacy_away = 11

  • bool has_fan_mode = 12

  • ClimateFanMode fan_mode = 13

  • bool has_swing_mode = 14

  • ClimateSwingMode swing_mode = 15

  • bool has_custom_fan_mode = 16

  • string custom_fan_mode = 17

  • bool has_preset = 18

  • ClimatePreset preset = 19

  • bool has_custom_preset = 20

  • string custom_preset = 21

  • bool has_target_humidity = 22

  • float target_humidity = 23

• rpc number_command (NumberCommandRequest, void)

  api.proto:42

  message NumberCommandRequest

  api.proto:979

  • fixed32 key = 1

  • float state = 2

• rpc select_command (SelectCommandRequest, void)

  api.proto:43

  message SelectCommandRequest

  api.proto:1017

  • fixed32 key = 1

  • string state = 2

• rpc text_command (TextCommandRequest, void)

  api.proto:44

  message TextCommandRequest

  api.proto:1776

  • fixed32 key = 1

  • string state = 2

• rpc siren_command (SirenCommandRequest, void)

  api.proto:45

  message SirenCommandRequest

  api.proto:1054

  • fixed32 key = 1

  • bool has_state = 2

  • bool state = 3

  • bool has_tone = 4

  • string tone = 5

  • bool has_duration = 6

  • uint32 duration = 7

  • bool has_volume = 8

  • float volume = 9

• rpc button_command (ButtonCommandRequest, void)

  api.proto:46

  message ButtonCommandRequest

  api.proto:1139

  • fixed32 key = 1

• rpc lock_command (LockCommandRequest, void)

  api.proto:47

  message LockCommandRequest

  api.proto:1112

  • fixed32 key = 1

  • LockCommand command = 2

  • bool has_code = 3

  • string code = 4

• rpc valve_command (ValveCommandRequest, void)

  api.proto:48

  message ValveCommandRequest

  api.proto:1933

  • fixed32 key = 1

  • bool has_position = 2

  • float position = 3

  • bool stop = 4

• rpc media_player_command (MediaPlayerCommandRequest, void)

  api.proto:49

  message MediaPlayerCommandRequest

  api.proto:1203

  • fixed32 key = 1

  • bool has_command = 2

  • MediaPlayerCommand command = 3

  • bool has_volume = 4

  • float volume = 5

  • bool has_media_url = 6

  • string media_url = 7

  • bool has_announcement = 8

  • bool announcement = 9

• rpc date_command (DateCommandRequest, void)

  api.proto:50

  message DateCommandRequest

  api.proto:1816

  • fixed32 key = 1

  • uint32 year = 2

  • uint32 month = 3

  • uint32 day = 4

• rpc time_command (TimeCommandRequest, void)

  api.proto:51

  message TimeCommandRequest

  api.proto:1857

  • fixed32 key = 1

  • uint32 hour = 2

  • uint32 minute = 3

  • uint32 second = 4

• rpc datetime_command (DateTimeCommandRequest, void)

  api.proto:52

  message DateTimeCommandRequest

  api.proto:1972

  • fixed32 key = 1

  • fixed32 epoch_seconds = 2

• rpc subscribe_bluetooth_le_advertisements (SubscribeBluetoothLEAdvertisementsRequest, void)

  api.proto:54

  message SubscribeBluetoothLEAdvertisementsRequest

  api.proto:1225

  ==================== BLUETOOTH ====================

  • int32 flags = 1

• rpc bluetooth_device_request (BluetoothDeviceRequest, void)

  api.proto:55

  message BluetoothDeviceRequest

  api.proto:1280

  • uint64 address = 1

  • BluetoothDeviceRequestType request_type = 2

  • bool has_address_type = 3

  • uint32 address_type = 4

• rpc bluetooth_gatt_get_services (BluetoothGATTGetServicesRequest, void)

  api.proto:56

  message BluetoothGATTGetServicesRequest

  api.proto:1302

  • uint64 address = 1

• rpc bluetooth_gatt_read (BluetoothGATTReadRequest, void)

  api.proto:57

  message BluetoothGATTReadRequest

  api.proto:1345

  • uint64 address = 1

  • uint32 handle = 2

• rpc bluetooth_gatt_write (BluetoothGATTWriteRequest, void)

  api.proto:58

  message BluetoothGATTWriteRequest

  api.proto:1366

  • uint64 address = 1

  • uint32 handle = 2

  • bool response = 3

  • bytes data = 4

• rpc bluetooth_gatt_read_descriptor (BluetoothGATTReadDescriptorRequest, void)

  api.proto:59

  message BluetoothGATTReadDescriptorRequest

  api.proto:1378

  • uint64 address = 1

  • uint32 handle = 2

• rpc bluetooth_gatt_write_descriptor (BluetoothGATTWriteDescriptorRequest, void)

  api.proto:60

  message BluetoothGATTWriteDescriptorRequest

  api.proto:1387

  • uint64 address = 1

  • uint32 handle = 2

  • bytes data = 3

• rpc bluetooth_gatt_notify (BluetoothGATTNotifyRequest, void)

  api.proto:61

  message BluetoothGATTNotifyRequest

  api.proto:1398

  • uint64 address = 1

  • uint32 handle = 2

  • bool enable = 3

• rpc unsubscribe_bluetooth_le_advertisements (UnsubscribeBluetoothLEAdvertisementsRequest, void)

  api.proto:62

  message UnsubscribeBluetoothLEAdvertisementsRequest

  api.proto:1483

  (message has no fields)

• rpc bluetooth_scanner_set_mode (BluetoothScannerSetModeRequest, void)

  api.proto:63

  message BluetoothScannerSetModeRequest

  api.proto:1521

  • BluetoothScannerMode mode = 1

• rpc subscribe_voice_assistant (SubscribeVoiceAssistantRequest, void)

  api.proto:65

  message SubscribeVoiceAssistantRequest

  api.proto:1535

  • bool subscribe = 1

  • uint32 flags = 2

• rpc alarm_control_panel_command (AlarmControlPanelCommandRequest, void)

  api.proto:67

  message AlarmControlPanelCommandRequest

  api.proto:1731

  • fixed32 key = 1

  • AlarmControlPanelStateCommand command = 2

  • string code = 3

• SOURCE_BOTH = 0

• SOURCE_SERVER = 1

• SOURCE_CLIENT = 2

==================== ALARM CONTROL PANEL ====================

Used in: AlarmControlPanelStateResponse

• 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

Used in: AlarmControlPanelCommandRequest

• 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

• fixed32 key = 1

• AlarmControlPanelState state = 2

• fixed32 key = 1

• bool state = 2

• bool missing_state = 3

  If the binary sensor does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• uint32 free = 1

• uint32 limit = 2

• repeated uint64 allocated = 3

• uint64 address = 1

• bool success = 2

• int32 error = 3

• uint64 address = 1

• bool connected = 2

• uint32 mtu = 3

• int32 error = 4

• uint64 address = 1

• bool paired = 2

• int32 error = 3

Used in: BluetoothDeviceRequest

• 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

• uint64 address = 1

• bool success = 2

• int32 error = 3

Used in: BluetoothGATTService

• repeated uint64 uuid = 1

• uint32 handle = 2

• uint32 properties = 3

• repeated BluetoothGATTDescriptor descriptors = 4

Used in: BluetoothGATTCharacteristic

• repeated uint64 uuid = 1

• uint32 handle = 2

• uint64 address = 1

• uint32 handle = 2

• int32 error = 3

• uint64 address = 1

• uint64 address = 1

• repeated BluetoothGATTService services = 2

• uint64 address = 1

• uint32 handle = 2

• bytes data = 3

• uint64 address = 1

• uint32 handle = 2

• uint64 address = 1

• uint32 handle = 2

• bytes data = 3

Used in: BluetoothGATTGetServicesResponse

• repeated uint64 uuid = 1

• uint32 handle = 2

• repeated BluetoothGATTCharacteristic characteristics = 3

• uint64 address = 1

• uint32 handle = 2

• uint64 address = 1

• bytes name = 2

• sint32 rssi = 3

• repeated string service_uuids = 4

• repeated BluetoothServiceData service_data = 5

• repeated BluetoothServiceData manufacturer_data = 6

• uint32 address_type = 7

Used in: BluetoothLERawAdvertisementsResponse

• uint64 address = 1

• sint32 rssi = 2

• uint32 address_type = 3

• bytes data = 4

• repeated BluetoothLERawAdvertisement advertisements = 1

Used in: BluetoothScannerSetModeRequest, BluetoothScannerStateResponse

• BLUETOOTH_SCANNER_MODE_PASSIVE = 0

• BLUETOOTH_SCANNER_MODE_ACTIVE = 1

Used in: BluetoothScannerStateResponse

• BLUETOOTH_SCANNER_STATE_IDLE = 0

• BLUETOOTH_SCANNER_STATE_STARTING = 1

• BLUETOOTH_SCANNER_STATE_RUNNING = 2

• BLUETOOTH_SCANNER_STATE_FAILED = 3

• BLUETOOTH_SCANNER_STATE_STOPPING = 4

• BLUETOOTH_SCANNER_STATE_STOPPED = 5

• BluetoothScannerState state = 1

• BluetoothScannerMode mode = 2

Used in: BluetoothLEAdvertisementResponse

• string uuid = 1

• repeated uint32 legacy_data = 2

  Removed in api version 1.7

• bytes data = 3

  Added in api version 1.7

• fixed32 key = 1

• bytes data = 2

• bool done = 3

Used in: ClimateStateResponse

• CLIMATE_ACTION_OFF = 0

• CLIMATE_ACTION_COOLING = 2

  values same as mode for readability

• CLIMATE_ACTION_HEATING = 3

• CLIMATE_ACTION_IDLE = 4

• CLIMATE_ACTION_DRYING = 5

• CLIMATE_ACTION_FAN = 6

Used in: ClimateCommandRequest, ClimateStateResponse, ListEntitiesClimateResponse

• 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

==================== CLIMATE ====================

Used in: ClimateCommandRequest, ClimateStateResponse, ListEntitiesClimateResponse

• 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

Used in: ClimateCommandRequest, ClimateStateResponse, ListEntitiesClimateResponse

• 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

• fixed32 key = 1

• ClimateMode mode = 2

• float current_temperature = 3

• float target_temperature = 4

• float target_temperature_low = 5

• float target_temperature_high = 6

• bool legacy_away = 7

  For older peers, equal to preset == CLIMATE_PRESET_AWAY

• ClimateAction action = 8

• ClimateFanMode fan_mode = 9

• ClimateSwingMode swing_mode = 10

• string custom_fan_mode = 11

• ClimatePreset preset = 12

• string custom_preset = 13

• float current_humidity = 14

• float target_humidity = 15

Used in: ClimateCommandRequest, ClimateStateResponse, ListEntitiesClimateResponse

• CLIMATE_SWING_OFF = 0

• CLIMATE_SWING_BOTH = 1

• CLIMATE_SWING_VERTICAL = 2

• CLIMATE_SWING_HORIZONTAL = 3

Used in: CoverStateResponse

• COVER_OPERATION_IDLE = 0

• COVER_OPERATION_IS_OPENING = 1

• COVER_OPERATION_IS_CLOSING = 2

• fixed32 key = 1

• LegacyCoverState legacy_state = 2

  legacy: state has been removed in 1.13 clients/servers must still send/accept it until the next protocol change

• float position = 3

• float tilt = 4

• CoverOperation current_operation = 5

• fixed32 key = 1

• bool missing_state = 2

  If the date does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• uint32 year = 3

• uint32 month = 4

• uint32 day = 5

• fixed32 key = 1

• bool missing_state = 2

  If the datetime does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• fixed32 epoch_seconds = 3

Used in: ListEntitiesAlarmControlPanelResponse, ListEntitiesBinarySensorResponse, ListEntitiesButtonResponse, ListEntitiesCameraResponse, ListEntitiesClimateResponse, ListEntitiesCoverResponse, ListEntitiesDateResponse, ListEntitiesDateTimeResponse, ListEntitiesEventResponse, ListEntitiesFanResponse, ListEntitiesLightResponse, ListEntitiesLockResponse, ListEntitiesMediaPlayerResponse, ListEntitiesNumberResponse, ListEntitiesSelectResponse, ListEntitiesSensorResponse, ListEntitiesSirenResponse, ListEntitiesSwitchResponse, ListEntitiesTextResponse, ListEntitiesTextSensorResponse, ListEntitiesTimeResponse, ListEntitiesUpdateResponse, ListEntitiesValveResponse

• ENTITY_CATEGORY_NONE = 0

• ENTITY_CATEGORY_CONFIG = 1

• ENTITY_CATEGORY_DIAGNOSTIC = 2

• fixed32 key = 1

• string event_type = 2

Used in: ExecuteServiceRequest

• bool bool_ = 1

• int32 legacy_int = 2

• float float_ = 3

• string string_ = 4

• sint32 int_ = 5

  ESPHome 1.14 (api v1.3) make int a signed value

• repeated bool bool_array = 6

• repeated sint32 int_array = 7

• repeated float float_array = 8

• repeated string string_array = 9

Used in: FanCommandRequest, FanStateResponse

• FAN_DIRECTION_FORWARD = 0

• FAN_DIRECTION_REVERSE = 1

Used in: FanCommandRequest, FanStateResponse

• FAN_SPEED_LOW = 0

• FAN_SPEED_MEDIUM = 1

• FAN_SPEED_HIGH = 2

• fixed32 key = 1

• bool state = 2

• bool oscillating = 3

• FanSpeed speed = 4

• FanDirection direction = 5

• int32 speed_level = 6

• string preset_mode = 7

• string entity_id = 1

• string state = 2

• string attribute = 3

Used in: HomeassistantServiceResponse

• string key = 1

• string value = 2

• string service = 1

• repeated HomeassistantServiceMap data = 2

• repeated HomeassistantServiceMap data_template = 3

• repeated HomeassistantServiceMap variables = 4

• bool is_event = 5

Used in: CoverCommandRequest

• LEGACY_COVER_COMMAND_OPEN = 0

• LEGACY_COVER_COMMAND_CLOSE = 1

• LEGACY_COVER_COMMAND_STOP = 2

Used in: CoverStateResponse

• LEGACY_COVER_STATE_OPEN = 0

• LEGACY_COVER_STATE_CLOSED = 1

• fixed32 key = 1

• bool state = 2

• float brightness = 3

• int32 color_mode = 11

• float color_brightness = 10

• float red = 4

• float green = 5

• float blue = 6

• float white = 7

• float color_temperature = 8

• float cold_white = 12

• float warm_white = 13

• string effect = 9

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• uint32 supported_features = 8

• bool requires_code = 9

• bool requires_code_to_arm = 10

==================== BINARY SENSOR ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string device_class = 5

• bool is_status_binary_sensor = 6

• bool disabled_by_default = 7

• string icon = 8

• EntityCategory entity_category = 9

==================== BUTTON ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• string device_class = 8

==================== CAMERA ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• bool disabled_by_default = 5

• string icon = 6

• EntityCategory entity_category = 7

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• bool supports_current_temperature = 5

• bool supports_two_point_target_temperature = 6

• repeated ClimateMode supported_modes = 7

• float visual_min_temperature = 8

• float visual_max_temperature = 9

• float visual_target_temperature_step = 10

• bool legacy_supports_away = 11

  for older peer versions - in new system this is if CLIMATE_PRESET_AWAY exists is supported_presets

• bool supports_action = 12

• repeated ClimateFanMode supported_fan_modes = 13

• repeated ClimateSwingMode supported_swing_modes = 14

• repeated string supported_custom_fan_modes = 15

• repeated ClimatePreset supported_presets = 16

• repeated string supported_custom_presets = 17

• bool disabled_by_default = 18

• string icon = 19

• EntityCategory entity_category = 20

• float visual_current_temperature_step = 21

• bool supports_current_humidity = 22

• bool supports_target_humidity = 23

• float visual_min_humidity = 24

• float visual_max_humidity = 25

==================== COVER ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• bool assumed_state = 5

• bool supports_position = 6

• bool supports_tilt = 7

• string device_class = 8

• bool disabled_by_default = 9

• string icon = 10

• EntityCategory entity_category = 11

• bool supports_stop = 12

==================== DATETIME DATE ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

==================== DATETIME DATETIME ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

(message has no fields)

==================== EVENT ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• string device_class = 8

• repeated string event_types = 9

==================== FAN ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• bool supports_oscillation = 5

• bool supports_speed = 6

• bool supports_direction = 7

• int32 supported_speed_levels = 8

• bool disabled_by_default = 9

• string icon = 10

• EntityCategory entity_category = 11

• repeated string supported_preset_modes = 12

==================== LIGHT ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• repeated int32 supported_color_modes = 12

• bool legacy_supports_brightness = 5

  next four supports_* are for legacy clients, newer clients should use color modes

• bool legacy_supports_rgb = 6

• bool legacy_supports_white_value = 7

• bool legacy_supports_color_temperature = 8

• float min_mireds = 9

• float max_mireds = 10

• repeated string effects = 11

• bool disabled_by_default = 13

• string icon = 14

• EntityCategory entity_category = 15

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• bool assumed_state = 8

• bool supports_open = 9

• bool requires_code = 10

• string code_format = 11

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• bool supports_pause = 8

• repeated MediaPlayerSupportedFormat supported_formats = 9

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• float min_value = 6

• float max_value = 7

• float step = 8

• bool disabled_by_default = 9

• EntityCategory entity_category = 10

• string unit_of_measurement = 11

• NumberMode mode = 12

• string device_class = 13

==================== SELECT ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• repeated string options = 6

• bool disabled_by_default = 7

• EntityCategory entity_category = 8

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• string unit_of_measurement = 6

• int32 accuracy_decimals = 7

• bool force_update = 8

• string device_class = 9

• SensorStateClass state_class = 10

• SensorLastResetType last_reset_type = 11

• bool disabled_by_default = 12

• EntityCategory entity_category = 13

Used in: ListEntitiesServicesResponse

• string name = 1

• ServiceArgType type = 2

• string name = 1

• fixed32 key = 2

• repeated ListEntitiesServicesArgument args = 3

==================== SIREN ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• repeated string tones = 7

• bool supports_duration = 8

• bool supports_volume = 9

• EntityCategory entity_category = 10

==================== SWITCH ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool assumed_state = 6

• bool disabled_by_default = 7

• EntityCategory entity_category = 8

• string device_class = 9

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• uint32 min_length = 8

• uint32 max_length = 9

• string pattern = 10

• TextMode mode = 11

==================== TEXT SENSOR ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• string device_class = 8

==================== DATETIME TIME ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

==================== UPDATE ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• string device_class = 8

==================== VALVE ====================

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

• EntityCategory entity_category = 7

• string device_class = 8

• bool assumed_state = 9

• bool supports_position = 10

• bool supports_stop = 11

Used in: LockCommandRequest

• LOCK_UNLOCK = 0

• LOCK_LOCK = 1

• LOCK_OPEN = 2

==================== LOCK ====================

Used in: LockStateResponse

• LOCK_STATE_NONE = 0

• LOCK_STATE_LOCKED = 1

• LOCK_STATE_UNLOCKED = 2

• LOCK_STATE_JAMMED = 3

• LOCK_STATE_LOCKING = 4

• LOCK_STATE_UNLOCKING = 5

• fixed32 key = 1

• LockState state = 2

==================== SUBSCRIBE LOGS ====================

Used in: SubscribeLogsRequest, SubscribeLogsResponse

• 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

Used in: MediaPlayerCommandRequest

• 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

Used in: MediaPlayerSupportedFormat

• MEDIA_PLAYER_FORMAT_PURPOSE_DEFAULT = 0

• MEDIA_PLAYER_FORMAT_PURPOSE_ANNOUNCEMENT = 1

==================== MEDIA PLAYER ====================

Used in: MediaPlayerStateResponse

• MEDIA_PLAYER_STATE_NONE = 0

• MEDIA_PLAYER_STATE_IDLE = 1

• MEDIA_PLAYER_STATE_PLAYING = 2

• MEDIA_PLAYER_STATE_PAUSED = 3

• fixed32 key = 1

• MediaPlayerState state = 2

• float volume = 3

• bool muted = 4

Used in: ListEntitiesMediaPlayerResponse

• string format = 1

• uint32 sample_rate = 2

• uint32 num_channels = 3

• MediaPlayerFormatPurpose purpose = 4

• uint32 sample_bytes = 5

==================== NUMBER ====================

Used in: ListEntitiesNumberResponse

• NUMBER_MODE_AUTO = 0

• NUMBER_MODE_BOX = 1

• NUMBER_MODE_SLIDER = 2

• fixed32 key = 1

• float state = 2

• bool missing_state = 3

  If the number does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• fixed32 key = 1

• string state = 2

• bool missing_state = 3

  If the select does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

Used in: ListEntitiesSensorResponse

• LAST_RESET_NONE = 0

• LAST_RESET_NEVER = 1

• LAST_RESET_AUTO = 2

==================== SENSOR ====================

Used in: ListEntitiesSensorResponse

• STATE_CLASS_NONE = 0

• STATE_CLASS_MEASUREMENT = 1

• STATE_CLASS_TOTAL_INCREASING = 2

• STATE_CLASS_TOTAL = 3

• fixed32 key = 1

• float state = 2

• bool missing_state = 3

  If the sensor does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

==================== USER-DEFINES SERVICES ====================

Used in: ListEntitiesServicesArgument

• 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

• fixed32 key = 1

• bool state = 2

(message has no fields)

• string entity_id = 1

• string attribute = 2

• bool once = 3

• LogLevel level = 1

• bytes message = 3

• bool send_failed = 4

• fixed32 key = 1

• bool state = 2

===================== TEXT =====================

Used in: ListEntitiesTextResponse

• TEXT_MODE_TEXT = 0

• TEXT_MODE_PASSWORD = 1

• fixed32 key = 1

• string state = 2

• bool missing_state = 3

  If the text sensor does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• fixed32 key = 1

• string state = 2

• bool missing_state = 3

  If the Text does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• fixed32 key = 1

• bool missing_state = 2

  If the time does not have a valid state yet. Equivalent to `!obj->has_state()` - inverse logic to make state packets smaller

• uint32 hour = 3

• uint32 minute = 4

• uint32 second = 5

Used in: UpdateCommandRequest

• UPDATE_COMMAND_NONE = 0

• UPDATE_COMMAND_UPDATE = 1

• UPDATE_COMMAND_CHECK = 2

• fixed32 key = 1

• UpdateCommand command = 2

• fixed32 key = 1

• bool missing_state = 2

• bool in_progress = 3

• bool has_progress = 4

• float progress = 5

• string current_version = 6

• string latest_version = 7

• string title = 8

• string release_summary = 9

• string release_url = 10

Used in: ValveStateResponse

• VALVE_OPERATION_IDLE = 0

• VALVE_OPERATION_IS_OPENING = 1

• VALVE_OPERATION_IS_CLOSING = 2

• fixed32 key = 1

• float position = 2

• ValveOperation current_operation = 3

• bool success = 1

• string media_id = 1

• string text = 2

• string preannounce_media_id = 3

• bool start_conversation = 4

• bytes data = 1

• bool end = 2

Used in: VoiceAssistantRequest

• uint32 noise_suppression_level = 1

• uint32 auto_gain = 2

• float volume_multiplier = 3

(message has no fields)

• repeated VoiceAssistantWakeWord available_wake_words = 1

• repeated string active_wake_words = 2

• uint32 max_active_wake_words = 3

Used in: VoiceAssistantEventResponse

• 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

Used in: VoiceAssistantEventResponse

• string name = 1

• string value = 2

• VoiceAssistantEvent event_type = 1

• repeated VoiceAssistantEventData data = 2

• bool start = 1

• string conversation_id = 2

• uint32 flags = 3

• optional VoiceAssistantAudioSettings audio_settings = 4

• string wake_word_phrase = 5

• uint32 port = 1

• bool error = 2

• repeated string active_wake_words = 1

==================== VOICE ASSISTANT ====================

• VOICE_ASSISTANT_SUBSCRIBE_NONE = 0

• VOICE_ASSISTANT_SUBSCRIBE_API_AUDIO = 1

Used in: VoiceAssistantTimerEventResponse

• VOICE_ASSISTANT_TIMER_STARTED = 0

• VOICE_ASSISTANT_TIMER_UPDATED = 1

• VOICE_ASSISTANT_TIMER_CANCELLED = 2

• VOICE_ASSISTANT_TIMER_FINISHED = 3

• VoiceAssistantTimerEvent event_type = 1

• string timer_id = 2

• string name = 3

• uint32 total_seconds = 4

• uint32 seconds_left = 5

• bool is_active = 6

Used in: VoiceAssistantConfigurationResponse

• string id = 1

• string wake_word = 2

• repeated string trained_languages = 3

Used as response type in: APIConnection.alarm_control_panel_command, APIConnection.bluetooth_device_request, APIConnection.bluetooth_gatt_get_services, APIConnection.bluetooth_gatt_notify, APIConnection.bluetooth_gatt_read, APIConnection.bluetooth_gatt_read_descriptor, APIConnection.bluetooth_gatt_write, APIConnection.bluetooth_gatt_write_descriptor, APIConnection.bluetooth_scanner_set_mode, APIConnection.button_command, APIConnection.camera_image, APIConnection.climate_command, APIConnection.cover_command, APIConnection.date_command, APIConnection.datetime_command, APIConnection.execute_service, APIConnection.fan_command, APIConnection.light_command, APIConnection.list_entities, APIConnection.lock_command, APIConnection.media_player_command, APIConnection.number_command, APIConnection.select_command, APIConnection.siren_command, APIConnection.subscribe_bluetooth_le_advertisements, APIConnection.subscribe_home_assistant_states, APIConnection.subscribe_homeassistant_services, APIConnection.subscribe_logs, APIConnection.subscribe_states, APIConnection.subscribe_voice_assistant, APIConnection.switch_command, APIConnection.text_command, APIConnection.time_command, APIConnection.unsubscribe_bluetooth_le_advertisements, APIConnection.valve_command

(message has no fields)