Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc camera_image (CameraImageRequest, void)

  api.proto:39

  message CameraImageRequest

  api.proto:715

  • bool single = 1

  • bool stream = 2

• rpc climate_command (ClimateCommandRequest, void)

  api.proto:40

  message ClimateCommandRequest

  api.proto:820

  • 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

• rpc connect (ConnectRequest, ConnectResponse)

  api.proto:10

  message ConnectRequest

  api.proto:101

  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:112

  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 cover_command (CoverCommandRequest, void)

  api.proto:35

  message CoverCommandRequest

  api.proto:282

  • 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 device_info (DeviceInfoRequest, DeviceInfoResponse)

  api.proto:22

  message DeviceInfoRequest

  api.proto:151

  (message has no fields)

  message DeviceInfoResponse

  api.proto:157

  • 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

• rpc disconnect (DisconnectRequest, DisconnectResponse)

  api.proto:14

  message DisconnectRequest

  api.proto:122

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

  (message has no fields)

  message DisconnectResponse

  api.proto:130

  (message has no fields)

• rpc execute_service (ExecuteServiceRequest, void)

  api.proto:33

  message ExecuteServiceRequest

  api.proto:684

  • fixed32 key = 1

  • repeated ExecuteServiceArgument args = 2

• rpc fan_command (FanCommandRequest, void)

  api.proto:36

  message FanCommandRequest

  api.proto:342

  • 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

• rpc get_time (GetTimeRequest, GetTimeResponse)

  api.proto:30

  message GetTimeRequest

  api.proto:636

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

  (message has no fields)

  message GetTimeResponse

  api.proto:641

  • fixed32 epoch_seconds = 1

• rpc hello (HelloRequest, HelloResponse)

  api.proto:6

  message HelloRequest

  api.proto:67

  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.

  message HelloResponse

  api.proto:81

  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"

• rpc light_command (LightCommandRequest, void)

  api.proto:37

  message LightCommandRequest

  api.proto:416

  • fixed32 key = 1

  • bool has_state = 2

  • bool state = 3

  • bool has_brightness = 4

  • float brightness = 5

  • bool has_color_mode = 22

  • ColorMode 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 list_entities (ListEntitiesRequest, void)

  api.proto:25

  message ListEntitiesRequest

  api.proto:187

  (message has no fields)

• rpc number_command (NumberCommandRequest, void)

  api.proto:41

  message NumberCommandRequest

  api.proto:879

  • fixed32 key = 1

  • float state = 2

• rpc ping (PingRequest, PingResponse)

  api.proto:18

  message PingRequest

  api.proto:139

  (message has no fields)

  message PingResponse

  api.proto:145

  (message has no fields)

• rpc select_command (SelectCommandRequest, void)

  api.proto:42

  message SelectCommandRequest

  api.proto:916

  • fixed32 key = 1

  • string state = 2

• rpc subscribe_home_assistant_states (SubscribeHomeAssistantStatesRequest, void)

  api.proto:29

  message SubscribeHomeAssistantStatesRequest

  api.proto:613

  ==================== 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 subscribe_homeassistant_services (SubscribeHomeassistantServicesRequest, void)

  api.proto:28

  message SubscribeHomeassistantServicesRequest

  api.proto:587

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

  (message has no fields)

• rpc subscribe_logs (SubscribeLogsRequest, void)

  api.proto:27

  message SubscribeLogsRequest

  api.proto:569

  • LogLevel level = 1

  • bool dump_config = 2

• rpc subscribe_states (SubscribeStatesRequest, void)

  api.proto:26

  message SubscribeStatesRequest

  api.proto:198

  (message has no fields)

• rpc switch_command (SwitchCommandRequest, void)

  api.proto:38

  message SwitchCommandRequest

  api.proto:521

  • fixed32 key = 1

  • bool state = 2

• SOURCE_BOTH = 0

• SOURCE_SERVER = 1

• SOURCE_CLIENT = 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

• 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 ====================

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

Used in: ClimateCommandRequest, ClimateStateResponse, ListEntitiesClimateResponse

• CLIMATE_SWING_OFF = 0

• CLIMATE_SWING_BOTH = 1

• CLIMATE_SWING_VERTICAL = 2

• CLIMATE_SWING_HORIZONTAL = 3

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

Used in: LightCommandRequest, LightStateResponse, ListEntitiesLightResponse

• 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

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

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 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

• ColorMode 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

==================== 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

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

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• bool disabled_by_default = 5

• 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_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

==================== 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

(message has no fields)

==================== 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_count = 8

• bool disabled_by_default = 9

• string icon = 10

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• repeated ColorMode 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

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

• 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

==================== 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

• 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 legacy_last_reset_type = 11

  Last reset type removed in 2021.9.0

• bool disabled_by_default = 12

Used in: ListEntitiesServicesResponse

• string name = 1

• ServiceArgType type = 2

• string name = 1

• fixed32 key = 2

• repeated ListEntitiesServicesArgument args = 3

==================== 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

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

• string object_id = 1

• fixed32 key = 2

• string name = 3

• string unique_id = 4

• string icon = 5

• bool disabled_by_default = 6

==================== 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

• 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

• 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

• string entity_id = 1

• string attribute = 2

• LogLevel level = 1

• string message = 3

• bool send_failed = 4

• fixed32 key = 1

• bool state = 2

• 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

Used as response type in: APIConnection.camera_image, APIConnection.climate_command, APIConnection.cover_command, APIConnection.execute_service, APIConnection.fan_command, APIConnection.light_command, APIConnection.list_entities, APIConnection.number_command, APIConnection.select_command, APIConnection.subscribe_home_assistant_states, APIConnection.subscribe_homeassistant_services, APIConnection.subscribe_logs, APIConnection.subscribe_states, APIConnection.switch_command

(message has no fields)