Skip to content

v1.4.0

Latest
Latest

Choose a tag to compare

View all tags
@jkandasa jkandasa released this 18 Jul 03:29
v1.4.0
64fb66c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Proto baseline jumped from ESPHome 2024.5.0 (library snapshot 2024-06-15) to
2026.7.0.
Full migration notes: docs/API_PROTO_UPDATE_2024.5.0_to_2026.7.0.md.

Contains BREAKING CHANGES (see below and the doc above).

Protocol and generated API

  • Sync api.proto / api_options.proto with ESPHome 2026.7.0
  • Regenerate pkg/api protobuf bindings; expand helper.go to all 148 message type IDs
    (was 111; highest ID 114 → 148)
  • New entities/features on the wire: siren, update, water heater, infrared, serial proxy,
    radio frequency, Z-Wave proxy, noise key provisioning, HA action / service responses,
    Bluetooth scanner mode and connection params, voice assistant extensions

Client (pkg/client, pkg/types)

  • Advertise Hello API version 1.14
  • Session setup: use Hello() on modern devices (ESPHome 2026.1+)
  • Login(password) kept for older firmware only; password auth was removed in
    ESPHome 2026.1.0. Prefer Noise encryption via encryptionKey on GetClient
  • Login treats auth-response timeout as success after Hello (modern devices ignore password)
  • Answer device-originated GetTimeRequest (timezone-aware epoch seconds)
  • Record DisconnectReason from device DisconnectRequest
  • Safer shutdown (close-once + deadline) and register waiters before send
  • DeviceInfo gains friendly name, manufacturer, project, BT MAC, encryption flags,
    areas/devices, Z-Wave, serial proxies, and related fields
  • GetLogEntry: decode log message from bytes; SendFailed always false (field removed)

CLI (esphomectl) and examples

  • Always complete session setup: Hello(), or legacy Login(password) when a password is set
  • Warn on stderr when API password is used (deprecated; removed in ESPHome 2026.1.0)
  • --password help/examples mark password auth as removed; prefer --encryption-key
  • Persist expanded device info after login; entity list UI no longer uses removed unique_id
  • Examples follow the same Hello / Login session pattern

Build and docs

  • Release builds use -trimpath and slim ldflags (-s -w); README documents the same for local CLI builds
  • Migration guide: docs/API_PROTO_UPDATE_2024.5.0_to_2026.7.0.md
  • README / proto/README.md updated for 2026.7.0 and encryption-first setup

Breaking changes

  • api.ConnectRequest / api.ConnectResponse → api.AuthenticationRequest / api.AuthenticationResponse
    (IDs 3/4; not processed by ESPHome 2026.1.0+)
  • api.HomeassistantServiceResponse → api.HomeassistantActionRequest
  • Entity list messages: unique_id removed (use object_id + key, optional device_id)
  • SubscribeLogsResponse.message: string → bytes; send_failed removed
  • BluetoothLEAdvertisementResponse.name: string → bytes
  • Bluetooth helper constants use *TypeID suffix (aligned with other message IDs)
  • Callers must run Hello() (or deprecated Login) after GetClient for a full session
Assets 10
Loading