Skip to content

General

Packet Format 1

Part Description Example
0 Preamble (always zero byte) 0x00
1 Message Length 0x00
2 Message Type (Internal number for identifying the proto message => Link to custom mapping) 0x01
3-X Content 
---
title: "Native API Packet"
---
packet-beta
  0-0: "Marker"
  1-1: "Length"
  2-2: "Type"
  3-31: "Protobuf Content"

Example Communication

sequenceDiagram
    Client->>Api: HelloRequest
    Api->>Client: HelloResponse
    Client->>Api: DisconnectRequest


    Client->>Api: ConnectRequest
    Api->>Client: ConnectResponse
    Client->>Api: DeviceInfoRequest
    Api->>Client: DeviceInfoResponse
    Client->>+Api: ListEntitiesRequest
    Api->>Client: ListEntitiesSensorResponse
    Api->>Client: ListEntitiesBinarySensorResponse
    Api->>-Client: ListEntitiesDoneResponse

    loop Keep Alive Messaging
        Client->>Api: PingRequest
        Api->>Client: PingResponse
    end

    Client->>Api: DisconnectRequest
    Api->>Client: DisconnectResponse

  1. From: https://github.com/esphome/aioesphomeapi/blob/main/aioesphomeapi/connection.py#L700 https://github.com/esphome/aioesphomeapi/blob/main/aioesphomeapi/_frame_helper/plain_text.py#L41 ↩