Compare commits

...
Author SHA1 Message Date
J. Nick Koston 852676e47e Merge branch 'dev' into info-ip-sensor-count 2026-10-24 15:15:08 -10:00
21fb25a45f [rx8111] Add backup, FOUT, and EVIN events (#21490)
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: J. Nick Koston <nick@home-assistant.io>
2026-10-24 15:10:44 -10:00
J. Nick Koston a208cf2264 [remote_base] Give each receiver an exact dumper table (#21562) 2026-10-25 01:00:17 +00:00
J. Nick Koston a57dff1ea1 [am43] Build and decode packets on the stack instead of heap objects (#21571) 2026-10-24 14:57:26 -10:00
J. Nick Koston 1f8c762f83 [core] Add ConstVector::append_copy and prepend_copy that read flash tables safely (#21561) 2026-10-24 14:48:30 -10:00
J. Nick Koston a339f2cec6 [remote_base] Test dumper dispatch and registration (#21560) 2026-10-24 14:48:30 -10:00
J. Nick Koston bbb978f8a0 [http_request] Test the OTA component's setters and getters from a lambda (#21555) 2026-10-24 14:47:50 -10:00
J. Nick Koston e6b4b80ff8 [tests] Run the integration test TCP servers through a tcp_server context manager (#21541) 2026-10-24 14:47:29 -10:00
J. Nick Koston e17c205863 [tests] Let SensorTracker wait for text sensor values (#21540) 2026-10-24 14:47:14 -10:00
J. Nick Koston 485ce83703 [bq25186] Apply inverted to the PG/GPO pin level (#21547) 2026-10-24 14:45:41 -10:00
J. Nick Koston 0bb4097de4 [libretiny] Flag a BK72xx board layout that misses the RF calibration (#21550) 2026-10-24 14:45:26 -10:00
J. Nick Koston 90a90455ed [ci] Add UART simulation, remote_base loopback, online_image decode, http_request and MQTT flows to the hardware-test skill (#21549) 2026-10-24 14:44:48 -10:00
J. Nick Koston 2a6feb0448 [wifi_info][ethernet_info] Size the array for the largest of several entries 2026-10-24 14:44:35 -10:00
J. Nick Koston 16b25e81aa [wifi_info][ethernet_info] Size the IP address child sensor array from the configured addresses 2026-10-24 14:44:35 -10:00
J. Nick Koston 893b60e7a0 [wifi_info][ethernet_info] Test the IP address child sensors (#21558) 2026-10-24 14:44:31 -10:00
J. Nick Koston 978dbf9b41 [am43] Test the packet encoder and decoder (#21570) 2026-10-24 14:37:38 -10:00
J. Nick Koston b8df87350f [web_server_base] Answer captive portal DNS queries with a 60 s TTL (#21597) 2026-10-24 14:37:15 -10:00
J. Nick Koston 146107c93f [as7341] Deprecate in favour of as734x, removal in 2027.5.0 (#21569) 2026-10-24 14:37:02 -10:00
J. Nick Koston fe6f19a6f5 [wifi] Leave the AP before a BK72xx reboots (#21590) 2026-10-24 14:36:47 -10:00
J. Nick Koston 6d989d60aa [mqtt][core] Wait for the broker to confirm the shutdown message before disconnecting (#21566) 2026-10-24 14:36:29 -10:00
MarvintheboredandJ. Nick Koston 263256b548 [gree] Add yaw1f model for YAW1F remotes (#19722)
Co-authored-by: J. Nick Koston <nick@home-assistant.io>
2026-10-24 22:51:36 +00:00
chorty 97fb058d60 [es7243] Add ES7243 audio ADC driver (#19335) 2026-10-24 11:12:52 -10:00
ebb170e3e2 [gree] Fix YX1FF and YAC IR transmit frames (#20881)
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: J. Nick Koston <nick@home-assistant.io>
2026-10-24 11:02:28 -10:00
c307754c62 [pcf8563] Don't trust the time after a power loss (#20735)
Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: J. Nick Koston <nick@home-assistant.io>
2026-10-24 21:00:11 +00:00
b60fc37cbc [modem] Add signal sensors and a network type text sensor (#14683)
Co-authored-by: J. Nick Koston <nick@home-assistant.io>
Co-authored-by: J. Nick Koston <nick@koston.org>
2026-10-24 09:32:34 -10:00
J. Nick Koston 55940fac30 [const] Move CONF_DEVICE_TYPE to the shared component constants (#21592) 2026-10-24 09:32:22 -10:00
Olivier ARCHERandJ. Nick Koston 6dbd140922 [modem] [wifi] allow wifi AP for modem (WISP) (#21584)
Co-authored-by: J. Nick Koston <nick@koston.org>
2026-10-24 18:40:06 +00:00
Jonathan Swoboda 4da3706c55 [remote_base] Reject delta on the pronto transmit action (#21578) 2026-10-24 08:27:40 -10:00
J. Nick Koston 4a1b837ddb [const] Add CONF_MODEM (#21589) 2026-10-24 08:27:26 -10:00
Jonathan Swoboda 1488ca32b4 [esp32_hosted] Keep hosted task stacks in internal RAM with use_psram (#21583) 2026-10-24 12:58:12 -04:00
5e0e32552b [packet_interface] Add session and XXTEA encryption layers (#21088)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
2026-10-24 22:09:59 +11:00
Clyde StubbsandClaude Opus 5.5 809bc71649 [packet_interface] Add layer registry and HDLC reliability layer (#21044)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 22:09:58 +11:00
Clyde StubbsandClaude Opus 5.5 7bec8aeb3d [udp] Add UDP packet interface link (#21042)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 22:09:58 +11:00
Clyde StubbsandClaude Opus 5.5 2897963905 [runtime_image] Draw BMP pixels opaque (#21424)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 10:52:04 +00:00
Christopher Pruijsen ace4651476 [as7341] Read channel data as little-endian (#21494) 2026-10-23 22:13:17 -10:00
Clyde StubbsandClaude Opus 5.5 b8d35764e7 [runtime_image] Write opaque RGB565 image directly (#21393)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 19:07:29 +11:00
Clyde StubbsandClaude Opus 5.5 afcf345264 [runtime_image] Limit how long one BMP or QOI decode call runs (#21392)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 07:48:01 +00:00
Clyde StubbsandClaude Opus 5.5 19ce03f4bf [runtime_image] Limit how long one PNG decode call runs (#21391)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 07:32:39 +00:00
Clyde StubbsandClaude Opus 5.5 83f460e964 [runtime_image] Work out grayscale pixels with integer maths (#21390)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 18:15:06 +11:00
Clyde StubbsandClaude Opus 5.5 e964a4d11a [runtime_image] Draw each target pixel once, with integer maths (#21387)
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-24 18:00:14 +11:00
Peter Valkov 29a928ed5a [mqtt] mqtt_client does not honor name_add_mac_suffix for default log_topic, birth_message, will_message, shutdown_message (#9315) 2026-10-23 20:58:39 -10:00
Clyde Stubbs 2cbc1bc02d [http_request] Run requests without blocking the loop (#21486) 2026-10-24 06:14:45 +00:00
Petar Petrov 701e5746b0 [demo][lvgl][const] Move CONF_BUTTONS to the shared component constants (#21551) 2026-10-23 20:14:36 -10:00
Keith BurzinskiandClaude Opus 5.5 9d30bcc721 [core] Do not warn that ESPHome's own core is an unmatched SBOM component (#21546)
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-24 00:52:50 -05:00
252 changed files with 11915 additions and 964 deletions

No files matched your search

+14 -3
View File
@@ -111,11 +111,11 @@ ESP-IDF OTA image: `.esphome/build/<name>/build/firmware.ota.bin`. LibreTiny OTA
or exits 1 when a build, flash or port step failed.
Per-topic scripts, each described in the matching `reference/recipes/<component>.md`: `online_image/`
(server, image generator, API driver), `zwave_proxy/` (checksum verifier, device info), `usb_cdc_acm/`
(server with prefixed misbehaviour cases, PNG, JPEG, BMP and QOI generators, API drivers, first pass timer), `zwave_proxy/` (checksum verifier, device info), `usb_cdc_acm/`
(host driver, Zephyr driver probe), `rtsp_server/` (protocol client, raw rate reader, measurement set,
API image grab), `cse7766/` (API observer with ping), `zephyr_coredump/` (reader flow, decode with the
Zephyr tools), `libretiny_prefs/` (rtc preference harness header), `libretiny_crash/` (BK72xx crash probe header and
capture decoder), `api_outgoing/` (wake cycle and Wi-Fi drop timing readers), `ld2450/` (zone number driver, loopback harness driver with number and binary sensor states and TX frame summarizer), `api/` (raw plaintext native API client for user defined actions, store_yaml recovery client over Noise or plaintext), `http_request/` (update manifest server, update state driver), `modem/` (button and sensor driver over the plaintext API, also used for the BLE MIDI boards), `dfrobot_sen0395/` (API driver and case runner), `homeassistant_light/` (direct bulb driver, held-report case driver), `usb_audio/` (URL player), `speaker_media_player/` (API player driver, pipeline task case runner), `web_server/` (SSE client, request mix, SSE and HTTPD case runners), `mqtt/` (broker config with TLS, client-certificate and WebSocket listeners, test CA with server and client certificates, transport case runner, flash-and-drive runner, CLI TLS check without a board), `udp/` (datagram recorder, `udp.write` payload checker and case driver), `entity_icons/` (icon and device class readback over the API, MQTT discovery, web_server and dump_config, with a comparer).
capture decoder), `api_outgoing/` (wake cycle and Wi-Fi drop timing readers), `ld2450/` (zone number driver, loopback harness driver with number and binary sensor states and TX frame summarizer), `api/` (raw plaintext native API client for user defined actions, store_yaml recovery client over Noise or plaintext), `http_request/` (update manifest server, update state driver, request test server, action case driver, concurrency, reboot, update check and OTA drivers, `ota_auth/` OTA request cases with basic auth), `modem/` (button and sensor driver over the plaintext API, also used for the BLE MIDI boards), `dfrobot_sen0395/` (API driver and case runner), `homeassistant_light/` (direct bulb driver, held-report case driver), `usb_audio/` (URL player), `speaker_media_player/` (API player driver, pipeline task case runner), `web_server/` (SSE client, request mix, SSE and HTTPD case runners), `mqtt/` (broker config with TLS, client-certificate and WebSocket listeners, test CA with server and client certificates, transport case runner, flash-and-drive runner, CLI TLS check without a board, MAC suffix runner with per-variant configs for two boards, `shutdown/` shutdown message runner and matcher), `udp/` (datagram recorder, `udp.write` payload checker and case driver), `entity_icons/` (icon and device class readback over the API, MQTT discovery, web_server and dump_config, with a comparer), `uart_sim/` (API driver and flash, capture and drive runner for the simulated UART sensors), `remote_base/` (loopback runner and API log decoder per sent frame).
## Templates in `$SKILL/templates`
@@ -133,9 +133,20 @@ capture decoder), `api_outgoing/` (wake cycle and Wi-Fi drop timing readers), `l
`cast-pro-1-sendspin-control.yaml`, `aux-2-preprod-stock-dut.yaml`, `aux-2-preprod-usb-audio-dut.yaml`,
`dfrobot-sen0395-dut.yaml`, `aux-2-preprod-speaker-player-dut.yaml`, `web-server-sse-dut.yaml`,
`mqtt-transport-dut.yaml`, `mqtt-tls-dut.yaml`, `udp-write-dut.yaml`, `entity-icon-dut.yaml`,
`online-image-s3-eth-dut.yaml`,
and the directories `store_yaml/` (package with secrets one directory up, per-board files),
`http_request_update/` (manifest URL setter shapes, per-board files), `modem/` (modem only and modem plus
Wi-Fi boot checks) and `ble_midi/` (fake BLE MIDI instrument and the client).
Wi-Fi boot checks), `ble_midi/` (fake BLE MIDI instrument and the client), `http_request_action/` (request
action package with per-board files and an OTA flash variant) `uart_sim/` (simulator header, common package, per-build parts and run files) and `remote_base/` (common
package, transmit script, per-board templates and the ESP8266 software sender).
## When the PR keeps moving
Record every head in the stack (`gh pr view N --json headRefOid`), build, and recheck before flashing; if anything
moved, wait five minutes and check again so the test runs on a settled head. When a head moved only by merging dev,
compare the PR's own diff (`git diff $(git merge-base OLD origin/dev) OLD` against the same for NEW); if it is
identical and the dev commits do not touch the code under test, earlier results still describe it, but rebuild so the
comment quotes the exact commits. Fetch `origin dev` before computing a merge base.
## When something looks wrong
@@ -50,6 +50,9 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
USB replug fixes it. Fallback: `esphome logs --device <name>.local` (API log stream, which drops lines
while Wi-Fi is off).
- The ESP32-P4 before silicon revision 3 is bricked by rev3-only firmware (boot loop at bootloader entry).
- A board left in the ROM bootloader after an upload (BOOT held, or the USB JTAG reset landing in download mode
again) starts its app without a replug through `esptool --port <port> --after watchdog-reset chip-id`; flash a
minimal Wi-Fi plus API image first when recovering from a crash-looping one.
## RP2040 / RP2350 (Pico W, Pico 2 W)
@@ -83,6 +86,8 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
from `~/.platformio/packages/toolchain-gccarmnoneeabi/bin/` (`raw_firmware.elf`, not `firmware.elf`).
Fault dumps print PC, LR and R0 to R3.
- The AmebaZ2 SDK sets `LWIP_TCPIP_CORE_LOCKING 0`.
- The `rtw_is_adapter_up` bus fault after `Disabling AP` happens on LibreTiny 1.13.0 and 1.14.0 alike
(2 of 4 and 3 of 3 runs in #21531); run at least four rounds per build before blaming a PR for it.
## BK7238, WB3S, CB3S (BK7231N) (LibreTiny bk72xx, CH340, RTS on CEN)
@@ -113,6 +118,13 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
SDK's saved register banks are usable. Code is compiled Thumb, the SDK assembly is ARM; in an exception
handler only r0 to r3 are shared by all modes. BK7231N ITCM is `0x3FEE00..0x400000` (4.5 KB); a `.noinit`
placed there after `.itcm.code` works for a crash record.
- Pick the board that matches the module's flash layout. A NiceMCU XH-WB3S (BK7238) needs `board: xh-wb3s` (plain
Beken layout, RF calibration at 0x1E0000). Built as `generic-bk7238-tuya` (calibration at 0x1E3000, download
partition over 0x1E0000) the firmware boots and may even join a known network, but scans come back empty and its
AP is invisible to clients, with no warning in the log. If scans are empty, check the layout first.
- The BK7238 bootloader prints `App verify failed! Need to recovery factory firmware.` on every boot with any
build; it is harmless. Even with the right layout an ESP32 client did not see the BK7238 fallback AP on
LibreTiny 1.13.0 or 1.14.0, so the wifisave hammer cannot run on it.
- Callbacks run on the `async_tcp` task and log lines can lose a byte. Wi-Fi connect takes tens of ms;
radio enable 160 to 278 ms, disable about 200 ms.
@@ -10,14 +10,14 @@ One file per component, named after it:
- [`cse7766.md`](cse7766.md): Sonoff S31 parser check over the API
- [`espnow.md`](espnow.md): ESP8266 broadcast receive
- [`hdmi_cec.md`](hdmi_cec.md): two-board wire
- [`http_request.md`](http_request.md): update manifest URL changed at run time, every setter shape, a swap under a running check
- [`http_request.md`](http_request.md): update manifest URL changed at run time, every setter shape, a swap under a running check, non-blocking request actions with loop gap, queue, cancel and reboot checks, OTA request cases with basic auth and MD5 sources
- [`ld2450.md`](ld2450.md): polygon zones, zone number round trip through the radar's readback, ESP8266 loopback harness without a radar
- [`ld2412.md`](ld2412.md): output pin level through the basic configuration command, held back writes
- [`libretiny.md`](libretiny.md): rtc preference emulation, BK72xx crash report on the next boot
- [`modem.md`](modem.md): PPPoS modem component boot check with no modem attached, loop blocking and disable timing
- [`mqtt.md`](mqtt.md): broker bench, QoS, reconnect, crash log over MQTT, WebSocket transports with a local and a public broker, TLS trust sources (own CA, client certificate, certificate bundle, no verification) with the CLI check
- [`mqtt.md`](mqtt.md): broker bench, QoS, reconnect, crash log over MQTT, WebSocket transports with a local and a public broker, TLS trust sources (own CA, client certificate, certificate bundle, no verification) with the CLI check, MAC suffix topics and will messages on two boards, shutdown message delivery on restart, disable and deep sleep
- [`nrf52.md`](nrf52.md): dongle board support
- [`online_image.md`](online_image.md): stalled and malformed downloads
- [`online_image.md`](online_image.md): stalled and malformed downloads, PNG, JPEG, BMP and QOI decode time per loop pass with large images and small buffers
- [`openthread.md`](openthread.md): border router on the S3 host plus H2 RCP
- [`ota.md`](ota.md): overlap and lock, timeouts, deflate
- [`rtsp_server.md`](rtsp_server.md): camera streaming on the Waveshare ESP32-S3-ETH
@@ -34,3 +34,7 @@ One file per component, named after it:
- [`dfrobot_sen0395.md`](dfrobot_sen0395.md): SEN0395 mmWave command flow, module quirks and overlong lines through its error reply
- [`speaker.md`](speaker.md): media player pipeline tasks on the Connect AUX-2 with the `speaker` platform player
- [`web_server.md`](web_server.md): state SSE stress and the HTTPD task stack on web_server_idf, entity icon and device class readback
- [`uart_sim.md`](uart_sim.md): UART sensors simulated on a classic ESP32 with loopback and cross-wired UARTs
- [`gpio_expander.md`](gpio_expander.md): interrupt driven expander inputs, loop idle checks, testing a device out of reach
- [`led_strip.md`](led_strip.md): forcing a failed strip allocation, RMT symbols on the S3
- [`remote_base.md`](remote_base.md): remote_receiver protocol decoding through a one-pin loopback on ESP32 and ESP8266, no IR hardware
@@ -0,0 +1,13 @@
# GPIO expanders
## Interrupt driven base class (#21469, #21468)
Any device with a PCF8574 input expander whose INT line goes to an ESP32 GPIO works; the inputs should change
during the test (end switches on a gate or cover are ideal). Before flashing, check with `nm` that
`gpio_expander::interrupt_pin_isr` lands in IRAM (0x4008xxxx on a classic ESP32). Then confirm `dump_config` lists
the interrupt pin and the input states match reality, and that the `pcf8574` entry is absent from the runtime stats
while idle (its loop is disabled). Drive the inputs (for a cover, `cover_command(position=1.0)` and then `0.0` over
the API, waiting for each end state): every input edge should log, `pcf8574` should show a small count in that
minute's stats and vanish in the next. For a device that cannot be reached physically, boot the same code on a
bench board first and keep a merge base image built as the fallback; an ESP32 bootloader without rollback support
leaves only `safe_mode` to recover a bad image.
@@ -16,3 +16,33 @@ update state (latest version, summary). The ESP8266 Arduino client gets `Error r
quarter of the fetches from this Python server on every build, so count checks against the base before blaming a
PR. `http_request` on the ESP8266 needs `verify_ssl: false` even for plain http URLs.
Results: https://github.com/esphome/esphome/pull/21373#issuecomment-6337544933
## Non-blocking request actions (#21486)
`scripts/http_request/hsrv.py PORT` serves `/fast`, `/slow?d=S`, `/big` and `/chunked` (`n` bytes at `rate` B/s,
deterministic bytes `(i*7+3)&0xFF`), `/post` (echoes length and byte sum), `/redirect` and `/hang`.
`templates/http_request_action/hr-common.yaml` (substitutions `name`, `bufsize`; per-board files `hr32.yaml` and
`hr66.yaml`, `-s name hr32base` on the command line for the base build; `hrota32.yaml` adds the `otaflash` action
for `otadrive.py`) has API actions `req_get`, `req_post`, `burst` (N runs of a `mode: parallel` script on one action),
`cancel` (`mode: single` script run twice, then `script.stop`) and `reboot_during`, and logs
`RESULT n status len sum took maxgap`, where maxgap is the longest main loop gap during the request (an
`interval: 1ms` lambda plus the time since its last pass, so a fully blocking request counts too). Drive with
`scripts/http_request/hrdrive.py IP http://HOST:PORT LABEL [https]` (`ONLY=case,case` and `ROUNDS=n` env; the
`cross` case runs two actions on one component). `burstonly.py IP URL N` checks concurrency against the server's
completion times, `reboottest.py IP URL` times `App.safe_reboot()` with requests in flight, `updcheck.py IP LABEL N`
runs N update checks over the API (for real device configs that use `update: platform: http_request`) and
`otadrive.py` triggers `ota.http_request.flash` (the API variable is `sum`; `md5` is a reserved variable name).
`execute_service` must be awaited on current aioesphomeapi or nothing is sent. Keep the ESP32 `bufsize` at 32 KB or
less: the action copies the body into a `std::string` while the buffer is still held, and 80 KB aborts with out of
memory on dev and on the PR alike. `http_request` refuses BK72xx and RTL87xx at validation.
## OTA request cases with basic auth (#21556)
`scripts/http_request/ota_auth/`: `ho-common.yaml` (API actions for `ota.http_request.flash` with `md5_url`, `md5`
and basic auth, `flash()` with no URL, an invalid URL, the `md5_computed()`/`md5_expected()` getters), `fwsrv.py`
(serves a www dir, `/auth/` needs `otauser:otapass`), `hodrive.py` (11 cases, reconnects after each good flash) and
`run.sh BUILD BOARD` (compiles from `TREE`, serial flash, serves that exact image; `TREE`, `P32` or `P66`, `SC` and `HOST_IP` in
the environment). On the D1 mini the authenticated MD5 read fails
with `Error reading MD5: -1` on dev too, and stored credentials carry over to the next flash on both builds.
Results: https://github.com/esphome/esphome/pull/21556#issuecomment-6381067561
@@ -0,0 +1,10 @@
# Addressable LED strips (#21447, #21445)
- To exercise a failed strip allocation, use a classic ESP32 without PSRAM with `num_leds: 65535` and
`channel_colors: GRBW` (262 kB, bigger than any internal block). `num_leds` is uint16 in the drivers, larger
values wrap. On dev such a strip boot-loops the board.
- Never force allocation failures by hogging RAM instead: Wi-Fi then aborts in `operator new` or the loop task
trips the task watchdog.
- On the ESP32-S3 give each RMT strip `rmt_symbols: 48`, or the first channel takes all 192 symbols.
- A board with a few WS2812 on a pin already defined as a light can be extended with `id: !extend <light id>` to
add effects; restore its own config afterwards.
@@ -51,3 +51,31 @@ context rejects a CA that lacks a `keyUsage` extension (`CA cert does not includ
on the device accepts it, which is why the test CA carries `basicConstraints` and `keyUsage`. A broker kill shows as one
`Last esp-tls error: 0x8008` on every build, TLS or not. Results:
https://github.com/esphome/esphome/pull/14318#issuecomment-6311863827
## MAC suffix topics (#9315)
`scripts/mqtt/mac_suffix/run.sh X BUILD` compiles (from `TREE`) and flashes variant X (a defaults, b custom `topic_prefix`, c explicit topics,
d no suffix) of BUILD (`pr` or `base`) on an ESP32 and a D1 mini, records the broker with
`mosquitto_sub -F '@H:@M:@S r=%r %t %p'`, presses Restart through the `cmd_t` found in the discovery payloads, then
holds both chips in the bootloader for 40 s (`esptool --after no-reset chip-id`) so the broker sends the will; a
plain reset only gives "session taken over" and no will. The two boards' configs live in separate folders because
variants a to c share a `name` (the MAC suffix tells them apart), and the same name in one folder shares a build
directory. A D1 mini CH340 can garble the serial capture after an RTS reset, so read its topics from the broker.
`esphome logs --device MQTT` on a current tree needs paho-mqtt 2.x; an older venv with 1.6.1 fails, so use a venv
made from the tree's requirements.txt. A Restart press never delivered the shutdown message on any build tested.
## Shutdown message delivery (#21566)
`scripts/mqtt/shutdown/`: `sd-common.yaml` sets birth/will/shutdown payloads `hello`/`dead`/`bye` so the shutdown
message and the will cannot be confused, and takes `restart`, `disable` and `sleep` on `<name>/cmd`.
`sdrun.sh V N` (`TREE`, `P32` and `P66` in the environment) compiles and flashes the ESP32 and D1 mini, restarts each N times, disables MQTT once and deep sleeps the ESP32 three
times (never the D1 mini: without the GPIO16 to RST wire it never wakes); `match.py OUT` counts a `bye` within 5 s of
each command. Dev: ESP32 0/10 restarts, D1 mini 1 to 3/10. Put the broker address (`broker_ip`) in the secrets.yaml next to
the included package, and quote `"${name}/status"` inside flow mappings.
Results: https://github.com/esphome/esphome/pull/21566#issuecomment-6381448061
Retest at c9cf3c2813 (shutdown message sent at QoS 1, teardown waits for the broker's ack): 10/10 restarts on both
boards and 3/3 deep sleeps, against 1/10, 3/10 and 0/3 on base. An earlier 100 ms hold gave 3/10, 6/10 and 2/3, so
judge a delivery fix by counts over 10 or more restarts, never one or two presses.
Results: https://github.com/esphome/esphome/pull/21566#issuecomment-6382076613
@@ -18,3 +18,47 @@ ends with `Error downloading image: -28679` (EAGAIN) after the transport timeout
and cut chunked cases and every later update logs `Image already being updated.`, so a baseline run needs
a reboot per group, the driver's 45 s cap per case, and an outer `timeout` that covers the whole list.
A case expected as `any` passes on `finished` or `error`, never on no outcome.
## PNG decode time limit (#21364, #21391)
The same server also serves any plain file in its www directory by name (404 for a missing file or a path
outside it). `scripts/online_image/make_big_pngs.py <www>` (after `make_images.py`) writes a 320x240 gradient (618 B, also as `ok.png` so the misbehaviour cases carry a
real multi-row PNG), a flat 640x480 PNG (1.6 KB for 307200 pixels), 231 KB of noise and a JPEG. The device is
`templates/online-image-dut.yaml` with `type: BINARY` on the main image (a 640x480 RGB565 does not fit a classic
ESP32 without PSRAM) and `debug` loop time and heap sensors at 2 s; the 256 byte buffer image stays RGB565, so do
not point big images at it (out of memory on every build). `scripts/online_image/pngdrive.py HOST KEY LOGFILE
BASEURL LABEL` (default case set `png`; `CASES=short` for the six case list) calls the actions, waits for the
finished or error line and reports the case time, the highest loop time and the lowest free heap. The per pass `online_image.image took a long time` values come from
the serial capture and only print on a new maximum, so read the first fetch of each image. The pass that decodes a
whole buffer is the decoder cost (before the change 510 ms gradient and 1980 ms flat, after it 77 and 140 ms); for
the noisy PNG the longest pass is the blocking 64 KB read on both builds (0.7 to 3.7 s). Alternate PR, base, PR
for a timing claim.
For a replacement PR, compare against the parent PR head, not dev. `CASES=noise` fetches the noisy PNG three times
(run it right after a boot, alternating builds); `CASES=end` runs flat and gradient as plain, `noclen_`, `chunked_`,
`half_` and `stall_` through the prefixed server cases below.
## JPEG decoded as it downloads (#21342)
`oi_server.py` serves prefixed cases on any file: `half_<file>` (first half, matching Content-Length),
`noclen_<file>` (close delimited), `chunked_<file>` (1 KB chunks), `stall_<file>` (a third, then the socket held
40 s). `scripts/online_image/make_jpegs.py <www>` writes noise, gradient, 12 KB EXIF and progressive JPEGs. Device:
`templates/online-image-dut.yaml` with `type: BINARY` on both entities and `buffer_size: 4096` on the second;
`CASES=jpeg scripts/online_image/pngdrive.py HOST KEY LOGFILE BASEURL LABEL` runs the JPEG list; every case set
prints case time, highest loop time and lowest free heap. Before the change a JPEG needs a contiguous block of its file size (233 KB never
allocates on a classic ESP32, and after a few failures 69 KB does not either until a reboot); after it the 64 KB
buffer stays 64 KB and 4 KB is enough for a baseline JPEG. The first pass still reads up to `buffer_size` in one
blocking read, so the 64 KB entity blocks 1.7 to 4 s and the 4 KB one 272 ms at most; judge the decode budget on
the small buffer entity. Already on dev: a JPEG without Content-Length (plain or chunked) ends with `Could not open
image for decoding: 4` then `Invalid type`.
## BMP and QOI decode time limit (#21392)
Use a wired board (`templates/online-image-s3-eth-dut.yaml`: Waveshare ESP32-S3-ETH, W5500, PSRAM, `type: RGB565`)
rather than a classic ESP32 on Wi-Fi: with a weak link the reads block up to the 4.5 s timeout and the per case loop
numbers are noise. `scripts/online_image/make_bmp_qoi.py <www>` writes 1 bit BMP 640x480, 8 and 24 bit BMP 320x240,
QOI 640x480 one colour (all runs) and checkerboard, QOI 320x240 gradient and noise. `pngdrive.py` with
`CASES=bmpqoi` runs each as plain, `noclen_`, `chunked_`, `half_` plus stalls. The `loop_time` sensor sits at 75
to 160 ms even for a 16x16 image, so for decode passes use `scripts/online_image/firstpass.py HOST KEY BASEURL
LABEL IMAGE...`: it reboots the device before each fetch and reports that fetch's `took a long time` maximum. A
`half_` file with matching Content-Length reports `download finished` with "not caching it" on dev too.
@@ -0,0 +1,30 @@
# remote_base / remote_receiver
## Loopback on one pin, no IR hardware (#21560 to #21563)
`templates/remote_base/`: `rb-common.yaml` (API action `tx_all`, a dumper registered from `on_boot` through
`register_dumper()` standing in for an external component), `rb-txscript.yaml` (14 `remote_transmitter.transmit_*`
frames with `tx <proto>` log markers), `rb32.tmpl` and `rb66.tmpl` (`@V@` is the build label).
`scripts/remote_base/run.sh LABEL B N` (`TREE`, `P32` or `P66`, `SC` in the environment) writes the run file from the
template, builds and flashes it from `TREE` (`esphome run --no-logs`), finds the IP and runs `rbdrive.py IP N`, which segments the API log by the
markers and prints what each sent frame decoded as.
- ESP32: `remote_transmitter` and two `remote_receiver`s on the same GPIO (`allow_other_uses`), carrier 100%, no
inversion. RMT reads its own output, every frame decodes. Second receiver `dump: [nec, raw]` shows raw runs only
where no primary matched.
- ESP8266: the transmitter sends with interrupts off, so a receiver on the same pin sees nothing. `softtx.hpp`
bit-bangs frames built with each protocol's `encode()` with interrupts on, and an `interval` sets the pin back to
OUTPUT after the receiver's setup. Bit-banged NEC decodes as NEC about 2 of 3 times (timing), on every build.
- Dish never decodes in loopback on dev either. Pronto matches every frame, so raw on `dump: all` never prints.
- API log lines can drop under bursts; rerun with more rounds before calling a shortfall.
- `register_dumper()` returns nothing, so the config logs `ext dumper register called`, not whether it stuck. On dev
the list has a fixed size and a dumper beyond it is dropped with `No dumper slot` (ERROR); judge by that line and by
`ext dumper saw` counts in the `rbdrive.py` table, which only appear when the dumper is really registered.
`rbdrive.py` exits 1 when the external dumper saw no frame, so a build that rejects the registration fails the
drive; set `EXPECT_REGISTER=1` on `run.sh` to also fail the run on any `No dumper slot` line.
Results: https://github.com/esphome/esphome/pull/21563#issuecomment-6381304387
Retest of the moved stack with 5 rounds per build: https://github.com/esphome/esphome/pull/21563#issuecomment-6382075726.
A D1 mini CH340 sometimes fails the 460800 baud upload; esphome retries at 115200 by itself, but a runner that reads
only the last line sees "Failed to upload" first, so rerun before blaming the build.
@@ -0,0 +1,19 @@
# Simulated UART sensors on a classic ESP32 (#21449, #21446)
No sensor needed. `templates/uart_sim/sim.hpp` (included with `esphome: includes:`) has frame builders for wts01,
ds1603l, sm300d2 and ufm01, `sim::loopback(id(uart))` (ESP-IDF `uart_set_loop_back` on the component's own UART),
`sim::send()` that logs the bytes, and `sim::probe`, a SEN0465 responder polled from a 10 ms interval. The run files
`fra.yaml`, `frb.yaml` and `frc.yaml` set the name and include `fr-common.yaml` plus their `fr*-parts.yaml` as
packages; copy them with a different name (`frabase` and so on) for the base build.
- Push-style sensors: put the component on a UART, switch it to loopback in `on_boot`, and inject frames from
template buttons (`fra-parts.yaml`, `frb-parts.yaml`). ufm01 enters its active stream by itself when a 1 s
interval streams frames during its 2 s startup wait.
- Request/response sensors: cross-wire two UARTs through the GPIO matrix (UART1 tx 25 rx 26, UART2 tx 26 rx 25,
`allow_other_uses: true` on all four pins); the second UART runs the simulated device (`frc-parts.yaml`).
A select sets the probe's misbehaviour (tail, FF tail, silent, split, wrong gas).
- Polled readers: run `update()` from a script and log `micros()` around it to measure blocking
(sm300d2 on dev blocks about 104 ms on an empty buffer).
- The logger stays on UART0, so three builds cover five components. Drive with `scripts/uart_sim/frdrive.py HOST
LOG press:NAME sel:NAME=OPT num:NAME=V wait:S`, or `scripts/uart_sim/run.sh NAME TREE SECONDS OPS...` (build
and flash from TREE with `esphome run --no-logs`, capture, drive; `PORT` and `SC` in the environment).
@@ -0,0 +1,44 @@
"""Run the burst action once and print each queued request as it completes.
Usage: burstonly.py IP URL N"""
import asyncio
import re
import sys
import time
import aioesphomeapi
IP, URL, N = sys.argv[1], sys.argv[2], int(sys.argv[3])
async def main():
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
_, svcs = await c.list_entities_services()
s = {x.name: x for x in svcs}
t0 = time.monotonic()
done = []
errors = []
def on_log(m):
t = re.sub(r"\x1b\[[0-9;]*m", "", m.message.decode(errors="replace"))
if "BURSTRESP status=200 " in t:
done.append(t)
elif "BURSTRESP" in t or "BURSTERR" in t:
errors.append(t)
if "hrt" in t or "Too many" in t:
print(f"{time.monotonic() - t0:6.2f} {t[:120]}", flush=True)
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_INFO)
await asyncio.sleep(1)
t0 = time.monotonic()
await c.execute_service(s["burst"], {"url": URL, "count": N})
await asyncio.sleep(14)
await c.disconnect()
print(
f"{len(done)} of {N} burst requests answered, {len(errors)} failed", flush=True
)
return 0 if len(done) >= N else 1
sys.exit(asyncio.run(main()))
@@ -0,0 +1,159 @@
"""Drive the http_request action test device over the API and collect its hrt log lines.
Usage: hrdrive.py DEVICE_IP SERVER_BASE LABEL [https]"""
import asyncio
import os
import re
import sys
import time
import aioesphomeapi
IP, BASE, LABEL = sys.argv[1], sys.argv[2], sys.argv[3]
HTTPS = len(sys.argv) > 4
CASES = [
("get", "fast", BASE + "/fast"),
("get", "slow2s", BASE + "/slow?d=2"),
("get", "big70k", BASE + "/big?n=70000&rate=20000"),
("get", "chunked70k", BASE + "/chunked?n=70000&rate=20000"),
("post", "post500", BASE + "/post"),
("get", "redirect", BASE + "/redirect"),
("get", "hang", BASE + "/hang?d=20"),
("get", "unreachable", "http://192.0.2.1:81/"),
]
if HTTPS:
CASES += [
("get", "https_get", "https://www.howsmyssl.com/a/check"),
("post", "https_post", "https://httpbin.org/post"),
]
ONLY = os.environ.get("ONLY")
if ONLY:
CASES = [c for c in CASES if c[1] in ONLY.split(",")]
ROUNDS = int(os.environ.get("ROUNDS", "2"))
# cases whose request must fail (past the 8 s timeout, or an address that never answers)
EXPECT_ERROR = {"hang", "unreachable"}
EXTRAS = not ONLY
timeouts: list[str] = []
mismatches: list[str] = []
async def main() -> int:
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
_, services = await c.list_entities_services()
svc = {s.name: s for s in services}
lines = []
def on_log(m):
t = (
m.message.decode(errors="replace")
if isinstance(m.message, bytes)
else m.message
)
t = re.sub(r"\x1b\[[0-9;]*m", "", t)
if (
"[hrt" in t
or "http_request" in t
or "Script" in t
or "already running" in t
):
lines.append(t)
print(f"{LABEL} {t}", flush=True)
def bad_burst(ln: str) -> bool:
return "BURSTERR" in ln or ("BURSTRESP" in ln and "status=200 " not in ln)
def mismatch(what: str, why: str) -> None:
print(f"{LABEL} {what} MISMATCH: {why}", flush=True)
mismatches.append(what)
async def wait_until(done, secs: float, what: str) -> None:
"""Poll done() until it holds; print a TIMEOUT marker when the deadline passes first."""
end = time.monotonic() + secs
while not done():
if time.monotonic() >= end:
print(f"{LABEL} {what} TIMEOUT", flush=True)
timeouts.append(what)
return
await asyncio.sleep(0.2)
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(1)
for rnd in range(1, ROUNDS + 1):
for kind, name, url in CASES:
n0 = len(lines)
print(f"{LABEL} == {name} round {rnd}", flush=True)
if kind == "get":
await c.execute_service(svc["req_get"], {"url": url})
else:
await c.execute_service(
svc["req_post"], {"url": url, "payload": "x" * 500}
)
await wait_until(
lambda n0=n0: any("RESULT" in ln for ln in lines[n0:]),
40,
f"{name} round {rnd}",
)
result = next((ln for ln in lines[n0:] if "RESULT" in ln), None)
if result is not None and (
("status=200 " not in result)
if name not in EXPECT_ERROR
else (" error " not in result)
):
mismatch(f"{name} round {rnd}", result)
await asyncio.sleep(1.5)
if not EXTRAS:
continue
print(f"{LABEL} == burst round {rnd}", flush=True)
n0 = len(lines)
await c.execute_service(svc["burst"], {"url": BASE + "/slow?d=1", "count": 6})
await wait_until(
lambda n0=n0: (
sum("BURSTRESP" in ln or "BURSTERR" in ln for ln in lines[n0:]) >= 6
),
30,
f"burst round {rnd}",
)
if any(bad_burst(ln) for ln in lines[n0:]):
mismatch(f"burst round {rnd}", "a burst request failed or was not 200")
await asyncio.sleep(2)
print(f"{LABEL} == cancel round {rnd}", flush=True)
n0 = len(lines)
await c.execute_service(svc["cancel"], {"url": BASE + "/slow?d=2"})
await asyncio.sleep(9)
if not any("CANCEL stopped running=0" in ln for ln in lines[n0:]):
mismatch(
f"cancel round {rnd}", "script.stop did not leave the script stopped"
)
print(f"{LABEL} == cross round {rnd}", flush=True)
n0 = len(lines)
await c.execute_service(svc["req_get"], {"url": BASE + "/slow?d=2&tag=cross"})
await c.execute_service(
svc["burst"], {"url": BASE + "/slow?d=1&tag=crossburst", "count": 3}
)
await wait_until(
lambda n0=n0: (
sum("BURSTRESP" in ln or "BURSTERR" in ln for ln in lines[n0:]) >= 3
and any("RESULT" in ln for ln in lines[n0:])
),
30,
f"cross round {rnd}",
)
if any(
bad_burst(ln) or ("RESULT" in ln and "status=200 " not in ln)
for ln in lines[n0:]
):
mismatch(f"cross round {rnd}", "a request failed")
await asyncio.sleep(2)
await c.disconnect()
if timeouts:
print(f"{LABEL} TIMEOUTS: {', '.join(timeouts)}", flush=True)
if mismatches:
print(f"{LABEL} MISMATCHES: {', '.join(mismatches)}", flush=True)
return 1 if timeouts or mismatches else 0
sys.exit(asyncio.run(main()))
@@ -0,0 +1,78 @@
"""Test server for http_request actions: deterministic bodies, slow and chunked responses."""
from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
import sys
import time
from urllib.parse import parse_qs, urlparse
def body_bytes(n):
return bytes((i * 7 + 3) & 0xFF for i in range(n))
class H(BaseHTTPRequestHandler):
protocol_version = "HTTP/1.1"
def log_message(self, fmt, *a):
sys.stdout.write(f"{time.time():.3f} {self.client_address[0]} {fmt % a}\n")
sys.stdout.flush()
def _q(self):
u = urlparse(self.path)
return u.path, {k: v[0] for k, v in parse_qs(u.query).items()}
def _send(self, data, code=200, ctype="application/octet-stream"):
self.send_response(code)
self.send_header("Content-Type", ctype)
self.send_header("Content-Length", str(len(data)))
self.end_headers()
self.wfile.write(data)
def do_POST(self):
n = int(self.headers.get("Content-Length", 0))
got = self.rfile.read(n)
self._send(
b"posted %d %d" % (len(got), sum(got) & 0xFFFFFFFF), ctype="text/plain"
)
def do_GET(self):
path, q = self._q()
if path == "/fast":
self._send(b"hello", ctype="text/plain")
elif path == "/slow":
time.sleep(float(q.get("d", "2")))
self._send(b"slow ok", ctype="text/plain")
elif path == "/redirect":
self.send_response(302)
self.send_header("Location", "/fast")
self.send_header("Content-Length", "0")
self.end_headers()
elif path == "/hang":
time.sleep(float(q.get("d", "30")))
elif path in ("/big", "/chunked"):
n = int(q.get("n", "70000"))
rate = float(q.get("rate", "20000"))
data = body_bytes(n)
self.send_response(200)
self.send_header("Content-Type", "application/octet-stream")
if path == "/big":
self.send_header("Content-Length", str(n))
else:
self.send_header("Transfer-Encoding", "chunked")
self.end_headers()
step = 1000
for i in range(0, n, step):
part = data[i : i + step]
if path == "/big":
self.wfile.write(part)
else:
self.wfile.write(b"%x\r\n" % len(part) + part + b"\r\n")
self.wfile.flush()
time.sleep(len(part) / rate)
if path == "/chunked":
self.wfile.write(b"0\r\n\r\n")
else:
self._send(b"nope", 404)
ThreadingHTTPServer(("0.0.0.0", int(sys.argv[1])), H).serve_forever()
@@ -0,0 +1,10 @@
esphome:
name: ho32base
esp32:
board: esp32dev
framework:
type: esp-idf
packages:
common: !include ../../ho-common.yaml
@@ -0,0 +1,11 @@
esphome:
name: ho66base
esp8266:
board: d1_mini
packages:
common: !include ../../ho-common.yaml
http_request:
verify_ssl: false
@@ -0,0 +1,32 @@
"""Serve a www dir for ota.http_request tests; /auth/ needs basic auth otauser:otapass.
Usage: fwsrv.py WWW PORT"""
import base64
import functools
import http.server
import sys
WWW, PORT = sys.argv[1], int(sys.argv[2])
GOOD = "Basic " + base64.b64encode(b"otauser:otapass").decode()
class H(http.server.SimpleHTTPRequestHandler):
def do_GET(self):
if self.path.startswith("/auth/") and self.headers.get("Authorization") != GOOD:
self.send_response(401)
self.send_header("WWW-Authenticate", 'Basic realm="ota"')
self.send_header("Content-Length", "0")
self.end_headers()
return
super().do_GET()
def log_message(self, fmt, *args):
print(
f"{self.address_string()} auth={'Authorization' in self.headers} {fmt % args}",
flush=True,
)
http.server.ThreadingHTTPServer(
("0.0.0.0", PORT), functools.partial(H, directory=WWW)
).serve_forever()
@@ -0,0 +1,60 @@
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
logger:
level: DEBUG
api:
reboot_timeout: 0s
actions:
- action: fl_md5url
variables: {url: string, md5url: string}
then:
- ota.http_request.flash:
url: !lambda return url;
md5_url: !lambda return md5url;
- action: fl_md5
variables: {url: string, sum: string}
then:
- ota.http_request.flash:
url: !lambda return url;
md5: !lambda return sum;
- action: fl_auth
variables: {url: string, md5url: string, user: string, pw: string}
then:
- ota.http_request.flash:
url: !lambda return url;
md5_url: !lambda return md5url;
username: !lambda return user;
password: !lambda return pw;
- action: fl_nourl
then:
- lambda: id(hota).flash();
- action: fl_badurl
then:
- lambda: |-
id(hota).set_url("not a url");
id(hota).flash();
- action: getters
then:
- lambda: |-
ESP_LOGI("hot", "getters computed='%s' expected='%s'", id(hota).md5_computed().c_str(),
id(hota).md5_expected().c_str());
esphome:
on_boot:
priority: -100
then:
- lambda: |-
ESP_LOGI("hot", "boot getters computed='%s' expected='%s'", id(hota).md5_computed().c_str(),
id(hota).md5_expected().c_str());
http_request:
timeout: 10s
ota:
- platform: esphome
- platform: http_request
id: hota
@@ -0,0 +1,142 @@
"""Drive the ota.http_request cases over the API.
Usage: hodrive.py IP BASEURL MD5FILE (BASEURL serves fw.bin, fw.md5, bad.md5, auth/fw.bin, auth/fw.md5)"""
import asyncio
import pathlib
import re
import sys
import time
import aioesphomeapi
if len(sys.argv) != 4:
sys.exit(__doc__)
IP, BASE = sys.argv[1:3]
SUM = pathlib.Path(sys.argv[3]).read_text(encoding="utf-8").strip()
T0 = time.monotonic()
lines: list[str] = []
failed: list[str] = []
def out(s: str) -> None:
print(f"{time.monotonic() - T0:7.2f} {s}", flush=True)
async def connect() -> tuple[aioesphomeapi.APIClient, dict]:
last: Exception | None = None
for _ in range(90):
c = aioesphomeapi.APIClient(IP, 6053, None)
try:
await c.connect(login=True)
except (
aioesphomeapi.InvalidAuthAPIError,
aioesphomeapi.InvalidEncryptionKeyAPIError,
aioesphomeapi.RequiresEncryptionAPIError,
):
raise # a key or password problem never fixes itself
except Exception as exc: # noqa: BLE001
last = exc
await asyncio.sleep(2)
continue
i = await c.device_info()
out(f"connected {i.name} {i.compilation_time}")
_, svcs = await c.list_entities_services()
def on_log(m):
t = re.sub(r"\x1b\[[0-9;]*m", "", m.message.decode(errors="replace"))
if re.search(r"\[hot|http_request|ota|OTA|MD5|md5", t):
lines.append(t)
out(t[:170])
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_DEBUG)
return c, {x.name: x for x in svcs}
raise SystemExit(f"device never came back (last error {last!r})")
async def case(c, s, name, args, want, timeout=60.0):
out(f"=== {name} {args} (want {want})")
start = len(lines)
await c.execute_service(s[name], args)
end = time.monotonic() + timeout
while time.monotonic() < end:
if any(re.search(want, x) for x in lines[start:]):
out(f"RESULT {name} PASS")
return True
await asyncio.sleep(0.2)
out(f"RESULT {name} FAIL (no '{want}')")
failed.append(name)
return False
async def flash_ok(c, s, name, args):
"""A good flash: wait for the device to drop and come back."""
out(f"=== {name} {args} (want reboot)")
start = len(lines)
await c.execute_service(s[name], args)
end = time.monotonic() + 120
while (
time.monotonic() < end
and c._connection is not None
and c._connection.is_connected
): # noqa: SLF001
await asyncio.sleep(0.5)
# a good flash needs both the device's own success line and the connection dropping for the reboot
dropped = c._connection is None or not c._connection.is_connected # noqa: SLF001
logged = any(
re.search(r"(?i)update complete|rebooting|successful", x) for x in lines[start:]
)
if not dropped:
out(f"{name}: the device never dropped the connection within 120 s")
ok = logged and dropped
await c.disconnect()
await asyncio.sleep(5)
c, s = await connect()
out(f"RESULT {name} {'PASS' if ok else 'FAIL'}")
if not ok:
failed.append(name)
return c, s
async def main():
c, s = await connect()
u, m = f"{BASE}/fw.bin", f"{BASE}/fw.md5"
await case(c, s, "getters", {}, r"computed='' expected=''")
await case(c, s, "fl_nourl", {}, r"URL not set")
await case(c, s, "fl_badurl", {}, r"URL not set")
await case(c, s, "getters", {}, r"computed='' expected=''")
await case(c, s, "fl_md5", {"url": u, "sum": "0" * 32}, r"MD5 mismatch")
await case(c, s, "getters", {}, r"getters computed=")
await case(
c,
s,
"fl_auth",
{
"url": f"{BASE}/auth/fw.bin",
"md5url": f"{BASE}/auth/fw.md5",
"user": "otauser",
"pw": "wrong",
},
r"HTTP Request failed; URL: \S*/auth/fw\.md5; Code: 401",
)
c, s = await flash_ok(
c,
s,
"fl_auth",
{
"url": f"{BASE}/auth/fw.bin",
"md5url": f"{BASE}/auth/fw.md5",
"user": "otauser",
"pw": "otapass",
},
)
c, s = await flash_ok(c, s, "fl_md5url", {"url": u, "md5url": m})
c, s = await flash_ok(c, s, "fl_md5", {"url": u, "sum": SUM})
await case(c, s, "getters", {}, r"computed='' expected=''")
await c.disconnect()
out(
f"SUMMARY {'all cases passed' if not failed else 'FAILED: ' + ', '.join(failed)}"
)
return 1 if failed else 0
sys.exit(asyncio.run(main()))
@@ -0,0 +1,10 @@
esphome:
name: ho32pr
esp32:
board: esp32dev
framework:
type: esp-idf
packages:
common: !include ../../ho-common.yaml
@@ -0,0 +1,11 @@
esphome:
name: ho66pr
esp8266:
board: d1_mini
packages:
common: !include ../../ho-common.yaml
http_request:
verify_ssl: false
@@ -0,0 +1,30 @@
#!/bin/bash
# run.sh BUILD(pr|base) BOARD(32|66) : serial flash ho<BOARD><BUILD>, serve its own image, drive the cases
# Copy this directory to a scratch directory (secrets.yaml next to ho-common.yaml) and run it there.
# env: TREE (esphome checkout for BUILD), P32 or P66 (serial port of the board), SC (path to serial_capture.py),
# HOST_IP (this host's address as the device reaches it), PY (checkout python)
D=$(cd "$(dirname "$0")" && pwd); V=$1; B=$2; N=ho$B$V; T=${TREE:?set TREE}; PY=${PY:-$T/venv/bin/python}
SC=${SC:?set SC}; HOST=${HOST_IP:?set HOST_IP}
if [ "$B" = 32 ]; then P=${P32:?set P32}; else P=${P66:?set P66}; fi
OUT=$D/out-$V-$B; rm -rf "$OUT"; mkdir -p "$OUT"
pkill -f "[s]erial_capture.py $P"
(cd "$T" && $PY -m esphome compile "$D/$V/$B/$N.yaml" > "$OUT/compile.log" 2>&1) || { echo "compile failed"; exit 1; }
(cd "$T" && $PY -m esphome upload "$D/$V/$B/$N.yaml" --device "$P" > "$OUT/upload.log" 2>&1) || { echo "upload failed"; exit 1; }
# the exact image of this config, just compiled, never one found elsewhere
if [ "$B" = 32 ]; then IMG=$D/$V/$B/.esphome/build/$N/build/firmware.ota.bin
else IMG=$D/$V/$B/.esphome/build/$N/.pioenvs/$N/firmware.bin; fi
[ -f "$IMG" ] || { echo "no image for $N at $IMG"; exit 1; }
echo "image $IMG"
W=$OUT/www; mkdir -p "$W/auth"; cp "$IMG" "$W/fw.bin"; cp "$IMG" "$W/auth/fw.bin"
$PY -c "import hashlib,sys;print(hashlib.md5(open(sys.argv[1],'rb').read()).hexdigest())" "$IMG" > "$W/fw.md5"
cp "$W/fw.md5" "$W/auth/fw.md5"; echo 00000000000000000000000000000000 > "$W/bad.md5"
$PY "$SC" "$P" 400 "$OUT/serial.txt" --reset > /dev/null 2>&1 & CAP=$!
trap 'kill $CAP $SRV 2>/dev/null' EXIT
pkill -f "[f]wsrv.py"; $PY "$D/fwsrv.py" "$W" 8093 > "$OUT/server.txt" 2>&1 & SRV=$!
for i in $(seq 60); do IP=$(grep -a -o 'IP Address: [0-9.]*' "$OUT/serial.txt" | tail -1 | cut -d' ' -f3); [ -z "$IP" ] && IP=$(python3 -c "import socket;print(socket.gethostbyname('$N.local'))" 2>/dev/null); [ -n "$IP" ] && break; sleep 2; done
[ -n "$IP" ] || { echo "device not found"; exit 1; }
echo "device up"
$PY "$D/hodrive.py" "$IP" "http://$HOST:8093" "$W/fw.md5" > "$OUT/drive.txt" 2>&1; RC=$?
kill $SRV; pkill -f "[s]erial_capture.py $P"
grep -E 'RESULT|SUMMARY|never came back' "$OUT/drive.txt"; echo "server requests: $(grep -c . "$OUT/server.txt")"
exit $RC
@@ -0,0 +1,74 @@
"""Trigger ota.http_request.flash over the API, optionally during a burst of action requests.
Usage: otadrive.py IP FWURL MD5 BASE [burst]"""
import asyncio
import contextlib
import re
import sys
import time
import aioesphomeapi
IP, FW, SUM, BASE = sys.argv[1:5]
BURST = len(sys.argv) > 5
async def main():
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
i = await c.device_info()
print("before:", i.name, i.compilation_time, flush=True)
_, svcs = await c.list_entities_services()
s = {x.name: x for x in svcs}
t0 = time.monotonic()
seen: list[str] = []
def on_log(m):
t = re.sub(r"\x1b\[[0-9;]*m", "", m.message.decode(errors="replace"))
seen.append(t)
if re.search(r"hrt|http_request|ota|OTA|Too many", t):
print(f"{time.monotonic() - t0:7.2f} {t[:170]}", flush=True)
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_INFO)
await asyncio.sleep(1)
if BURST:
await c.execute_service(s["burst"], {"url": BASE + "/slow?d=1", "count": 6})
await asyncio.sleep(0.5)
await c.execute_service(s["otaflash"], {"url": FW, "sum": SUM})
end = time.monotonic() + 45
while (
time.monotonic() < end
and c._connection is not None # noqa: SLF001
and c._connection.is_connected # noqa: SLF001
):
await asyncio.sleep(0.5)
dropped = c._connection is None or not c._connection.is_connected # noqa: SLF001
with contextlib.suppress(Exception):
await c.disconnect()
for _ in range(30):
try:
c2 = aioesphomeapi.APIClient(IP, 6053, None)
await c2.connect(login=True)
i = await c2.device_info()
print("after:", i.name, i.compilation_time, flush=True)
await c2.disconnect()
break
except Exception: # noqa: BLE001
await asyncio.sleep(2)
else:
print("RESULT FAIL: not reachable after the flash", flush=True)
return 1
if not dropped:
print("RESULT FAIL: the device never rebooted", flush=True)
return 1
if any("OTAFLASH returned" in t for t in seen):
print("RESULT FAIL: the flash action returned, the update failed", flush=True)
return 1
if not any(re.search(r"(?i)update complete|rebooting|successful", t) for t in seen):
print("RESULT FAIL: no update complete line before the reboot", flush=True)
return 1
print("RESULT PASS", flush=True)
return 0
sys.exit(asyncio.run(main()))
@@ -0,0 +1,68 @@
"""Call reboot_during (a slow request in flight, another waiting, then App.safe_reboot) and time the reboot.
Usage: reboottest.py IP URL"""
import asyncio
import contextlib
import re
import sys
import time
import aioesphomeapi
IP, URL = sys.argv[1], sys.argv[2]
async def main():
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
_, svcs = await c.list_entities_services()
s = {x.name: x for x in svcs}
t0 = time.monotonic()
def on_log(m):
t = re.sub(r"\x1b\[[0-9;]*m", "", m.message.decode(errors="replace"))
if re.search(
r"hrt|http_request|safe_mode|shutdown|Rebooting|reboot", t, re.IGNORECASE
):
print(f"{time.monotonic() - t0:7.2f} {t[:150]}", flush=True)
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(1)
t0 = time.monotonic()
await c.execute_service(s["reboot_during"], {"url": URL})
dropped = False
while time.monotonic() - t0 < 30:
try:
await asyncio.wait_for(c.device_info(), 1.0)
await asyncio.sleep(0.2)
except TimeoutError:
continue # a slow reply is not a reboot; only a closed connection counts
except Exception: # noqa: BLE001
dropped = True
print(f"{time.monotonic() - t0:7.2f} API connection gone", flush=True)
break
with contextlib.suppress(Exception):
await c.disconnect()
if not dropped:
print(f"{time.monotonic() - t0:7.2f} NO REBOOT within 30 s", flush=True)
return 1
last: Exception | None = None
for _ in range(60):
try:
c2 = aioesphomeapi.APIClient(IP, 6053, None)
await asyncio.wait_for(c2.connect(login=True), 3)
i = await c2.device_info()
print(f"{time.monotonic() - t0:7.2f} back: {i.name}", flush=True)
await c2.disconnect()
return 0
except Exception as exc: # noqa: BLE001
last = exc
await asyncio.sleep(1)
print(
f"{time.monotonic() - t0:7.2f} NOT BACK after reboot (last error {last!r})",
flush=True,
)
return 1
sys.exit(asyncio.run(main()))
@@ -0,0 +1,66 @@
"""Run N update checks over the API and print the update state plus http_request/update/long-operation log lines.
Usage: updcheck.py IP LABEL N"""
import asyncio
import re
import sys
import time
import aioesphomeapi
IP, LABEL, N = sys.argv[1], sys.argv[2], int(sys.argv[3])
async def main():
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
info = await c.device_info()
print(
f"{LABEL} device {info.name} {info.esphome_version} {info.compilation_time}",
flush=True,
)
ents, _ = await c.list_entities_services()
upd = next(e for e in ents if isinstance(e, aioesphomeapi.UpdateInfo))
states = []
def on_state(s):
if s.key == upd.key:
states.append(s)
print(
f"{LABEL} {time.monotonic() - t0:7.2f} UPDATE in_progress={s.in_progress} current={s.current_version} latest={s.latest_version} title={s.title!r}",
flush=True,
)
def on_log(m):
t = (
m.message.decode(errors="replace")
if isinstance(m.message, bytes)
else m.message
)
t = re.sub(r"\x1b\[[0-9;]*m", "", t)
if re.search(
r"http_request|update|took a long time|Guru|abort|heap|Free",
t,
re.IGNORECASE,
):
print(f"{LABEL} {time.monotonic() - t0:7.2f} {t[:200]}", flush=True)
t0 = time.monotonic()
c.subscribe_states(on_state)
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(3)
missing = []
for i in range(N):
print(f"{LABEL} {time.monotonic() - t0:7.2f} CHECK {i + 1}", flush=True)
before = len(states)
c.update_command(upd.key, aioesphomeapi.UpdateCommand.CHECK)
await asyncio.sleep(25)
if not any(not st.in_progress for st in states[before:]):
print(f"{LABEL} CHECK {i + 1} got no finished update state", flush=True)
missing.append(i + 1)
await c.disconnect()
print(f"{LABEL} {N - len(missing)} of {N} checks reported a state", flush=True)
return 1 if missing else 0
sys.exit(asyncio.run(main()))
@@ -0,0 +1,8 @@
substitutions: {name: mqabase, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,9 @@
substitutions: {name: mqbbase, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
topic_prefix: custpre32
@@ -0,0 +1,18 @@
substitutions: {name: mqcbase, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
log_topic: explicit32/log
birth_message:
topic: explicit32/avail
payload: up
will_message:
topic: explicit32/avail
payload: down
shutdown_message:
topic: explicit32/avail
payload: bye
@@ -0,0 +1,8 @@
substitutions: {name: mqd32base, suffix: "false"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,7 @@
substitutions: {name: mqabase, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,8 @@
substitutions: {name: mqbbase, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
topic_prefix: custpre66
@@ -0,0 +1,17 @@
substitutions: {name: mqcbase, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
log_topic: explicit66/log
birth_message:
topic: explicit66/avail
payload: up
will_message:
topic: explicit66/avail
payload: down
shutdown_message:
topic: explicit66/avail
payload: bye
@@ -0,0 +1,7 @@
substitutions: {name: mqd66base, suffix: "false"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,24 @@
# Package for esphome#9315, included by the per-variant files under pr/ and base/ (substitutions name, suffix).
esphome:
name: ${name}
name_add_mac_suffix: ${suffix}
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
logger:
level: DEBUG
ota:
- platform: esphome
button:
- platform: restart
name: Restart
interval:
- interval: 10s
then:
- logger.log: "alive"
@@ -0,0 +1,8 @@
substitutions: {name: mqapr, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,9 @@
substitutions: {name: mqbpr, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
topic_prefix: custpre32
@@ -0,0 +1,18 @@
substitutions: {name: mqcpr, suffix: "true"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
log_topic: explicit32/log
birth_message:
topic: explicit32/avail
payload: up
will_message:
topic: explicit32/avail
payload: down
shutdown_message:
topic: explicit32/avail
payload: bye
@@ -0,0 +1,8 @@
substitutions: {name: mqd32pr, suffix: "false"}
esp32:
board: esp32dev
framework: {type: esp-idf}
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,7 @@
substitutions: {name: mqapr, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,8 @@
substitutions: {name: mqbpr, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
topic_prefix: custpre66
@@ -0,0 +1,17 @@
substitutions: {name: mqcpr, suffix: "true"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
log_topic: explicit66/log
birth_message:
topic: explicit66/avail
payload: up
will_message:
topic: explicit66/avail
payload: down
shutdown_message:
topic: explicit66/avail
payload: bye
@@ -0,0 +1,7 @@
substitutions: {name: mqd66pr, suffix: "false"}
esp8266:
board: d1_mini
packages: {mq: !include ../../mq-common.yaml}
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
@@ -0,0 +1,51 @@
#!/bin/bash
# run.sh X BUILD : flash variant X (a..d) of BUILD (pr|base) on both boards, record broker traffic, restart, hard reset
# Copy this directory to a scratch directory and run it there; secrets.yaml (wifi_ssid, wifi_password, broker_ip)
# goes next to mq-common.yaml and in every board folder.
# env: TREE (esphome checkout for BUILD), P32 and P66 (ESP32 and ESP8266 serial ports), SC (path to
# serial_capture.py), PY (checkout python)
M=$(cd "$(dirname "$0")" && pwd); X=$1; V=$2; T=${TREE:?set TREE to the checkout under test}
P32=${P32:?set P32}; P66=${P66:?set P66}; SC=${SC:?set SC}
PY=${PY:-$T/venv/bin/python}; OUT=$M/out-$X-$V; mkdir -p $OUT
pkill -f "[s]erial_capture.py $P32"; pkill -f "[s]erial_capture.py $P66"; pkill -f "[m]osquitto_sub -h 127.0.0.1"
# compile one at a time (shared tool caches), then flash both boards at once; upload alone never builds
for b in 32 66; do
(cd $T && $PY -m esphome compile $M/$V/$b/mq${X}$b$V.yaml > $OUT/c$b.log 2>&1) || { echo "compile$b failed, see $OUT/c$b.log"; exit 1; }
done
(cd $T && $PY -m esphome upload $M/$V/32/mq${X}32$V.yaml --device $P32 > $OUT/u32.log 2>&1) & U32=$!
(cd $T && $PY -m esphome upload $M/$V/66/mq${X}66$V.yaml --device $P66 > $OUT/u66.log 2>&1) & U66=$!
wait $U32 || { echo "upload32 failed, see $OUT/u32.log"; exit 1; }
wait $U66 || { echo "upload66 failed, see $OUT/u66.log"; exit 1; }
mosquitto_sub -h 127.0.0.1 -v -t '#' -F '@H:@M:@S r=%r %t %p' > $OUT/broker.txt 2>&1 &
SUB=$!
$PY $SC $P32 170 $OUT/s32.txt --reset > /dev/null 2>&1 &
$PY $SC $P66 170 $OUT/s66.txt > /dev/null 2>&1 &
sleep 60
TOPICS=$(grep "homeassistant/button/" $OUT/broker.txt | grep "\"name\":\"mq${X}" | grep -o '"cmd_t":"[^"]*"' | cut -d'"' -f4 | sort -u)
ERR=0
[ "$(echo "$TOPICS" | grep -c .)" -ge 2 ] || { echo "ERROR: expected a Restart command topic per board, found: ${TOPICS:-none}"; ERR=1; }
for t in $TOPICS; do
mosquitto_pub -h 127.0.0.1 -t "$t" -m PRESS && echo "$(date +%T) press $t" || { echo "$(date +%T) ERROR: publish to $t failed"; ERR=1; }
done
sleep 45
pkill -f "[s]erial_capture.py $P32"; pkill -f "[s]erial_capture.py $P66"; sleep 1
echo "$(date +%T) hold both in the bootloader for 40 s (will test)"
$PY -m esptool --port $P32 --after no-reset chip-id > $OUT/hold32.log 2>&1 & H32=$!
$PY -m esptool --port $P66 --after no-reset chip-id > $OUT/hold66.log 2>&1 & H66=$!
wait $H32 || { echo "ERROR: ESP32 not held in the bootloader, no will expected (see $OUT/hold32.log)"; ERR=1; }
wait $H66 || { echo "ERROR: ESP8266 not held in the bootloader, no will expected (see $OUT/hold66.log)"; ERR=1; }
sleep 40
REL=$(date +%T); echo "$REL release both"
$PY $SC $P32 40 $OUT/s32b.txt --reset > /dev/null 2>&1 &
$PY $SC $P66 40 $OUT/s66b.txt --reset > /dev/null 2>&1 &
sleep 42
kill $SUB
for f in s32 s66; do echo "== $f"; grep -a -E "Topic Prefix|Log Topic|Availability|Client ID" $OUT/$f.txt | head -4 | sed 's/^\[[0-9:]*\]//'; done
echo "== broker (excluding discovery and entity state)"
grep -v -E " homeassistant/| [^ ]*/(sensor|button|binary_sensor)/| esphome/discover/" $OUT/broker.txt | awk '$3 ~ /(debug|log)$/ { if (seen[$3]++) next; print $1, $2, $3, "(log lines:", "see file)"; next } { print }' | head -40
echo "== log line counts per topic"; awk '$3 ~ /(debug|log)$/ {c[$3]++} END {for (t in c) print t, c[t]}' $OUT/broker.txt
# each board must publish its birth message (default "online", explicit variant "up") after the release;
# a missing will is the measured result and does not fail the run
BIRTHS=$(awk -v t="$REL" '$1 >= t && ($4 == "online" || $4 == "up") {print $3}' $OUT/broker.txt | sort -u | grep -c .)
[ "$BIRTHS" -ge 2 ] || { echo "ERROR: $BIRTHS of 2 boards published a birth message after the release"; ERR=1; }
exit $ERR
@@ -0,0 +1,9 @@
substitutions: {name: sd32base}
esphome:
name: sd32base
esp32:
board: esp32dev
framework: {type: esp-idf}
deep_sleep:
id: ds
packages: {c: !include ../sd-common.yaml}
@@ -0,0 +1,8 @@
substitutions: {name: sd66base}
esphome:
name: sd66base
esp8266:
board: d1_mini
deep_sleep:
id: ds
packages: {c: !include ../sd-common.yaml}
@@ -0,0 +1,33 @@
"""match.py OUTDIR: for each event, say whether a bye/dead for that board arrived within 5 s."""
import pathlib
import sys
d = pathlib.Path(sys.argv[1])
def secs(stamp: str) -> int:
h, m, s = (int(x) for x in stamp.split(":"))
return h * 3600 + m * 60 + s
ev = [ln.split() for ln in (d / "events.txt").read_text(encoding="utf-8").splitlines()]
br = [
f
for f in (
ln.split() for ln in (d / "broker.txt").read_text(encoding="utf-8").splitlines()
)
if len(f) >= 3 and f[2] in ("bye", "dead")
]
rows = {}
for ts, kind, b in ev:
hit = [
p
for s, top, p in br
if top.startswith(f"sd{b}") and 0 <= secs(s) - secs(ts) <= 5
]
rows.setdefault((b, kind), []).append(
"bye" if "bye" in hit else (hit[0] if hit else "-")
)
for (b, kind), r in sorted(rows.items()):
print(f"{b} {kind:8s} {r.count('bye')}/{len(r)} bye {' '.join(r)}")
@@ -0,0 +1,9 @@
substitutions: {name: sd32pr}
esphome:
name: sd32pr
esp32:
board: esp32dev
framework: {type: esp-idf}
deep_sleep:
id: ds
packages: {c: !include ../sd-common.yaml}
@@ -0,0 +1,8 @@
substitutions: {name: sd66pr}
esphome:
name: sd66pr
esp8266:
board: d1_mini
deep_sleep:
id: ds
packages: {c: !include ../sd-common.yaml}
@@ -0,0 +1,40 @@
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
logger:
level: DEBUG
mqtt:
broker: !secret broker_ip
reboot_timeout: 0s
discovery: false
birth_message: {topic: "${name}/status", payload: hello}
will_message: {topic: "${name}/status", payload: dead}
shutdown_message: {topic: "${name}/status", payload: bye}
on_message:
- topic: ${name}/cmd
payload: restart
then:
- button.press: restart_btn
- topic: ${name}/cmd
payload: disable
then:
- mqtt.disable:
- delay: 5s
- mqtt.enable:
- topic: ${name}/cmd
payload: sleep
then:
- deep_sleep.enter:
id: ds
sleep_duration: 5s
ota:
- platform: esphome
button:
- platform: restart
id: restart_btn
name: Restart
@@ -0,0 +1,44 @@
#!/bin/bash
# sdrun.sh V(pr|base) [N] : flash both boards, restart each N times over MQTT, then disable, then deep sleep (ESP32)
# Copy this directory to a scratch directory (secrets.yaml with wifi_ssid, wifi_password and broker_ip next to
# sd-common.yaml) and run it there with a local mosquitto on this host.
# env: TREE (esphome checkout for V), P32 and P66 (ESP32 and ESP8266 serial ports), PY (checkout python)
S=$(cd "$(dirname "$0")" && pwd); V=$1; N=${2:-10}; T=${TREE:?set TREE}; PY=${PY:-$T/venv/bin/python}
P32=${P32:?set P32}; P66=${P66:?set P66}; OUT=$S/out-$V; rm -rf "$OUT"; mkdir -p "$OUT"
pkill -f "[s]erial_capture.py $P32"; pkill -f "[s]erial_capture.py $P66"
# compile one at a time (shared tool caches), then flash both boards at once; upload alone never builds
for b in 32 66; do
(cd "$T" && $PY -m esphome compile "$S/$V/sd$b$V.yaml" > "$OUT/c$b.log" 2>&1) || { echo "compile$b failed, see $OUT/c$b.log"; exit 1; }
done
(cd "$T" && $PY -m esphome upload "$S/$V/sd32$V.yaml" --device "$P32" > "$OUT/u32.log" 2>&1) & U32=$!
(cd "$T" && $PY -m esphome upload "$S/$V/sd66$V.yaml" --device "$P66" > "$OUT/u66.log" 2>&1) & U66=$!
wait $U32 || { echo "upload32 failed"; exit 1; }; wait $U66 || { echo "upload66 failed"; exit 1; }
mosquitto_sub -h 127.0.0.1 -R -v -t "sd32$V/status" -t "sd66$V/status" -F '@H:@M:@S %t %p' > "$OUT/broker.txt" 2>&1 & SUB=$!
# cmd KIND BOARD: publish the command and record the event only when the publish worked
ERR=0
cmd() {
local ts; ts=$(date +%T)
if mosquitto_pub -h 127.0.0.1 -t "sd$2$V/cmd" -m "$1"; then echo "$ts $1 $2" >> "$OUT/events.txt"
else echo "$ts ERROR: publish $1 to board $2 failed"; ERR=1; fi
}
sleep 40
for b in 32 66; do
grep -q "sd$b$V/status hello" "$OUT/broker.txt" || { echo "ERROR: sd$b$V never sent its birth message"; kill $SUB; exit 1; }
done
for i in $(seq "$N"); do
for b in 32 66; do cmd restart $b; done
sleep 25
done
for b in 32 66; do cmd disable $b; done
sleep 30
for i in 1 2 3; do cmd sleep 32; sleep 30; done
kill -0 $SUB 2>/dev/null || { echo "ERROR: the broker subscriber died, counts are incomplete"; ERR=1; }
kill $SUB 2>/dev/null
for b in 32 66; do echo "sd$b$V: $(grep -c "sd$b$V/status hello" "$OUT/broker.txt") hello, $(grep -c "sd$b$V/status bye" "$OUT/broker.txt") bye, $(grep -c "sd$b$V/status dead" "$OUT/broker.txt") dead"; done
# each restart, the disable (a reconnect) and each ESP32 deep sleep is followed by a new birth message
for b in 32 66; do
want=$((N + 2)); [ $b = 32 ] && want=$((want + 3))
got=$(grep -c "sd$b$V/status hello" "$OUT/broker.txt")
[ "$got" -ge "$want" ] || { echo "ERROR: sd$b$V sent $got birth messages, expected $want (a board did not come back)"; ERR=1; }
done
exit $ERR
@@ -0,0 +1,115 @@
"""Reboot the DUT before each fetch and report the longest online_image loop pass of that one fetch.
usage: firstpass.py HOST KEY BASEURL LABEL IMAGE...
The component warning prints only on a new maximum, so a fresh boot per image gives that image's own maximum.
"""
import asyncio
import contextlib
import re
import sys
import time
from aioesphomeapi import (
APIClient,
ButtonInfo,
InvalidAuthAPIError,
InvalidEncryptionKeyAPIError,
LogLevel,
RequiresEncryptionAPIError,
UserService,
)
HOST, KEY, BASE, LABEL = sys.argv[1:5]
IMAGES = sys.argv[5:]
TOOK = re.compile(r"online_image\.image took a long time for an operation \((\d+) ms\)")
OUTCOME = re.compile(r"download (finished|error): img\b")
async def connect() -> tuple[APIClient, dict, int]:
last: Exception | None = None
for _ in range(30):
c = APIClient(HOST, 6053, None, noise_psk=KEY)
try:
await c.connect(login=True)
break
except (
InvalidAuthAPIError,
InvalidEncryptionKeyAPIError,
RequiresEncryptionAPIError,
):
raise # a wrong key never fixes itself
except Exception as exc: # noqa: BLE001
last = exc
await asyncio.sleep(2)
else:
raise RuntimeError(f"device did not come back (last error {last!r})")
ents, services = await c.list_entities_services()
reboot = next(
(e.key for e in ents if isinstance(e, ButtonInfo) and e.name == "Reboot"), None
)
if reboot is None:
raise RuntimeError("the device has no button named Reboot")
return c, {s.name: s for s in services if isinstance(s, UserService)}, reboot
async def rebooted(c: APIClient, reboot: int) -> bool:
"""Press Reboot and wait up to 15 s for the API connection to drop."""
c.button_command(reboot)
end = time.monotonic() + 15
while time.monotonic() < end:
try:
await asyncio.wait_for(c.device_info(), 1.0)
except TimeoutError:
continue # a slow reply is not a reboot; only a closed connection counts
except Exception: # noqa: BLE001
return True
await asyncio.sleep(0.2)
return False
async def main() -> int:
failed = []
for img in IMAGES:
c, actions, reboot = await connect()
ok = await rebooted(c, reboot)
with contextlib.suppress(Exception):
await c.disconnect()
if not ok:
print(f"{LABEL} {img:22} SKIPPED: no reboot within 15 s", flush=True)
failed.append(img)
continue
await asyncio.sleep(8)
c, actions, reboot = await connect()
lines: list[str] = []
c.subscribe_logs(
lambda m, lines=lines: lines.append(m.message.decode(errors="replace")),
log_level=LogLevel.LOG_LEVEL_DEBUG,
)
await asyncio.sleep(3)
lines.clear()
t0 = time.monotonic()
await c.execute_service(actions["fetch"], {"url": f"{BASE}/{img}"})
outcome = None
while time.monotonic() - t0 < 60 and outcome is None:
await asyncio.sleep(0.2)
outcome = next(
(m.group(1) for ln in lines if (m := OUTCOME.search(ln))), None
)
took = time.monotonic() - t0
await asyncio.sleep(1)
passes = [int(m.group(1)) for ln in lines if (m := TOOK.search(ln))]
print(
f"{LABEL} {img:22} {outcome or 'none':9} {took:5.1f}s longest pass {max(passes) if passes else '<50'} ms {passes}",
flush=True,
)
if (
outcome != "finished"
): # a decode timing is only meaningful for a complete image
failed.append(img)
await c.disconnect()
if failed:
print(f"{LABEL} not finished: {', '.join(failed)}", flush=True)
return 1 if failed else 0
sys.exit(asyncio.run(main()))
@@ -0,0 +1,32 @@
"""Build the large PNGs for the decode time test: a compressible gradient (also saved as ok.png so every server case
carries a multi-row PNG), a flat 640x480 image whose few KB hold 307200 pixels, incompressible noise, and a JPEG."""
from pathlib import Path
import random
import sys
from PIL import Image
www = Path(sys.argv[1])
im = Image.new("RGB", (320, 240))
px = im.load()
for y in range(240):
for x in range(320):
px[x, y] = (x * 255 // 319, y * 255 // 239, 128)
im.save(www / "ok.png", "PNG", optimize=True)
im.save(www / "gradient.png", "PNG", optimize=True)
im.save(www / "gradient.jpg", "JPEG", quality=85)
Image.new("RGB", (640, 480), (40, 90, 200)).save(www / "flat.png", "PNG", optimize=True)
random.seed(1)
noise = Image.new("RGB", (320, 240))
npx = noise.load()
for y in range(240):
for x in range(320):
npx[x, y] = (
random.randrange(256),
random.randrange(256),
random.randrange(256),
)
noise.save(www / "noise.png", "PNG")
for p in sorted(www.iterdir()):
print(p.name, p.stat().st_size)
@@ -0,0 +1,93 @@
"""Write big BMP (1, 8, 24 bit) and QOI test images into a www directory."""
from pathlib import Path
import random
import struct
import sys
from PIL import Image
www = Path(sys.argv[1])
def gradient(w, h):
im = Image.new("RGB", (w, h))
im.putdata(
[
((x * 255) // w, (y * 255) // h, ((x + y) * 255) // (w + h))
for y in range(h)
for x in range(w)
]
)
return im
def checker(w, h):
im = Image.new("1", (w, h))
im.putdata(
[255 if ((x // 16) + (y // 16)) % 2 else 0 for y in range(h) for x in range(w)]
)
return im
checker(640, 480).save(www / "bmp1_640.bmp")
gradient(320, 240).convert("P", palette=Image.ADAPTIVE).save(www / "bmp8_320.bmp")
gradient(320, 240).save(www / "bmp24_320.bmp")
def qoi(im, path):
im = im.convert("RGBA")
w, h = im.size
out = bytearray(b"qoif" + struct.pack(">IIBB", w, h, 4, 0))
idx = [(0, 0, 0, 0)] * 64
prev = (0, 0, 0, 255)
run = 0
px = list(im.getdata())
for i, p in enumerate(px):
if p == prev:
run += 1
if run == 62 or i == len(px) - 1:
out.append(0xC0 | (run - 1))
run = 0
continue
if run:
out.append(0xC0 | (run - 1))
run = 0
h_ = (p[0] * 3 + p[1] * 5 + p[2] * 7 + p[3] * 11) % 64
if idx[h_] == p:
out.append(h_)
else:
idx[h_] = p
if p[3] == prev[3]:
dr, dg, db = (
((p[0] - prev[0] + 128) % 256) - 128,
((p[1] - prev[1] + 128) % 256) - 128,
((p[2] - prev[2] + 128) % 256) - 128,
)
drg, dbg = dr - dg, db - dg
if -2 <= dr <= 1 and -2 <= dg <= 1 and -2 <= db <= 1:
out.append(0x40 | (dr + 2) << 4 | (dg + 2) << 2 | (db + 2))
elif -32 <= dg <= 31 and -8 <= drg <= 7 and -8 <= dbg <= 7:
out += bytes([0x80 | (dg + 32), (drg + 8) << 4 | (dbg + 8)])
else:
out += bytes([0xFE, p[0], p[1], p[2]])
else:
out += bytes([0xFF, *p])
prev = p
out += b"\x00" * 7 + b"\x01"
path.write_bytes(out)
qoi(
Image.new("RGB", (640, 480), (0, 0, 0)).copy(), www / "qoi_flat.qoi"
) # all runs, 62 pixels a byte
qoi(checker(640, 480).convert("RGB"), www / "qoi_check.qoi")
qoi(gradient(320, 240), www / "qoi_grad.qoi")
random.seed(1)
noise = Image.frombytes(
"RGB", (320, 240), bytes(random.getrandbits(8) for _ in range(320 * 240 * 3))
)
qoi(noise, www / "qoi_noise.qoi")
for f in sorted(www.glob("*_*.*")):
print(f.name, f.stat().st_size)
@@ -0,0 +1,42 @@
"""Build the JPEGs for the streaming decode test: noise 320x240 (also ok.jpg) and 640x480, a 640x480 gradient, the
320x240 noise with a 12 KB EXIF segment in front of the frame header, and a progressive one."""
from pathlib import Path
import random
import sys
from PIL import Image
www = Path(sys.argv[1])
random.seed(2)
def noise(w: int, h: int) -> Image.Image:
im = Image.new("RGB", (w, h))
px = im.load()
for y in range(h):
for x in range(w):
px[x, y] = (
random.randrange(256),
random.randrange(256),
random.randrange(256),
)
return im
n320 = noise(320, 240)
n320.save(www / "noise320.jpg", "JPEG", quality=90)
n320.save(www / "ok.jpg", "JPEG", quality=90)
noise(640, 480).save(www / "noise640.jpg", "JPEG", quality=85)
g = Image.new("RGB", (640, 480))
px = g.load()
for y in range(480):
for x in range(640):
px[x, y] = (x * 255 // 639, y * 255 // 479, 128)
g.save(www / "gradient640.jpg", "JPEG", quality=85)
n320.save(
www / "bigexif320.jpg", "JPEG", quality=90, exif=b"Exif\x00\x00" + bytes(12000)
)
n320.save(www / "progressive320.jpg", "JPEG", quality=90, progressive=True)
for p in sorted(www.iterdir()):
print(p.name, p.stat().st_size)
@@ -5,7 +5,16 @@ from pathlib import Path
import sys
import time
WWW = Path(sys.argv[1])
WWW = Path(sys.argv[1]).resolve()
NOT_FOUND = b"HTTP/1.1 404 Not Found\r\nContent-Length: 0\r\nConnection: close\r\n\r\n"
def www_file(rel: str) -> Path | None:
"""The file under WWW named by a request path, or None if missing or outside WWW."""
file = (WWW / rel).resolve()
return file if file.is_relative_to(WWW) and file.is_file() else None
PORT = int(sys.argv[2])
LOG = Path(sys.argv[3]).open("a", encoding="utf-8", buffering=1) # noqa: SIM115
@@ -108,8 +117,34 @@ async def respond(path: str, req: bytes, w: asyncio.StreamWriter) -> str:
if name == "huge": # claims 20 MB so the JPEG buffer resize fails
w.write(headers(ctype, [b"Content-Length: 20000000"]) + body)
return f"claims 20000000, sent {len(body)} bytes"
w.write(b"HTTP/1.1 404 Not Found\r\nContent-Length: 0\r\nConnection: close\r\n\r\n")
return "404"
prefix, _, rest = name.partition("_")
if prefix in ("half", "noclen", "chunked", "stall") and rest:
# 404 when the base file is missing, so a typo never passes as the misbehaviour under test
file = www_file(rest + "." + ext)
else:
prefix, file = "", www_file(path.lstrip("/"))
if file is None:
w.write(NOT_FOUND)
return "404"
data = file.read_bytes()
if prefix == "half": # the first half of a file, Content-Length matching
cut = data[: len(data) // 2]
w.write(headers(ctype, [b"Content-Length: %d" % len(cut)]) + cut)
return f"half {len(cut)} of {len(data)} bytes"
if prefix == "noclen": # a file without Content-Length, delimited by close
w.write(headers(ctype, []) + data)
return f"no content-length, full {len(data)} bytes"
if prefix == "chunked": # a file in 1 KB chunks
w.write(headers(ctype, [b"Transfer-Encoding: chunked"]) + chunked(data, 1024))
return f"chunked full {len(data)} bytes"
if prefix == "stall": # claims the full length, sends a third, holds the socket
part = data[: len(data) // 3]
w.write(headers(ctype, [b"Content-Length: %d" % len(data)]) + part)
await w.drain()
await asyncio.sleep(40)
return f"stalled after {len(part)} of {len(data)} bytes"
w.write(headers(ctype, [b"Content-Length: %d" % len(data), *tag]) + data)
return f"file {file.name} {len(data)} bytes"
async def handle(r: asyncio.StreamReader, w: asyncio.StreamWriter) -> None:
@@ -0,0 +1,261 @@
"""Fetch images through the online_image API actions and report outcome, time, loop time maximum and heap minimum per case.
usage: [CASES=png|noise|end|bmpqoi|short|jpeg] pngdrive.py HOST KEY LOGFILE BASEURL LABEL
"""
import asyncio
import contextlib
import os
import pathlib
import re
import sys
import time
import urllib.error
import urllib.request
from aioesphomeapi import APIClient, LogLevel, SensorInfo, SensorState, UserService
HOST, KEY, LOGFILE, BASE, LABEL = sys.argv[1:6]
CAP_S = 60
OUTCOME = re.compile(r"download (finished|error): (\w+)")
INTEREST = re.compile(
r"took a long time|Error|error|Download ended|No data received|Waiting for more|Decoded|cut off|already being|headers do not fit|buffer_size|Downloading image|fully downloaded|allocat|not caching"
)
PNG = [
("gradient 320x240 png", "fetch", "gradient.png", "finished"),
("gradient again", "fetch", "gradient.png", "finished"),
("gradient again", "fetch", "gradient.png", "finished"),
("flat 640x480 png", "fetch", "flat.png", "finished"),
("flat again", "fetch", "flat.png", "finished"),
("flat again", "fetch", "flat.png", "finished"),
("gradient jpeg", "fetch", "gradient.jpg", "finished"),
("ok bmp 16x16", "fetch", "ok.bmp", "finished"),
("ok png 16x16 body = gradient", "fetch", "ok.png", "finished"),
("chunked png", "fetch", "chunked.png", "finished"),
("chunked png cut in half", "fetch", "chunked_cut.png", "any"),
("closed early png", "fetch", "closed_early.png", "error"),
("stalled png", "fetch", "stall.png", "error"),
("slow png", "fetch", "slow.png", "finished"),
("empty png", "fetch", "empty.png", "error"),
("no content-length png", "fetch", "noclen.png", "any"),
("truncated bmp", "fetch", "truncated.bmp", "error"),
("gradient after errors", "fetch", "gradient.png", "finished"),
("gradient refetch 304", "refetch", "", "finished"),
("noise 320x240 png", "fetch", "noise.png", "finished"),
("noise again", "fetch", "noise.png", "finished"),
]
NOISE = [("noise 320x240 png", "fetch", "noise.png", "finished")] * 3
END = [
(f"{pre}{img}", "fetch", f"{pre}{img}", exp)
for img in ("flat.png", "gradient.png")
for pre, exp in (
("", "finished"),
("noclen_", "finished"),
("chunked_", "finished"),
("half_", "any"),
("stall_", "error"),
)
] + [("gradient after", "fetch", "gradient.png", "finished")]
BMPQOI = [
(f"{pre}{img}", "fetch", f"{pre}{img}", exp)
for img in (
"bmp1_640.bmp",
"bmp8_320.bmp",
"bmp24_320.bmp",
"qoi_flat.qoi",
"qoi_check.qoi",
"qoi_grad.qoi",
"qoi_noise.qoi",
)
for pre, exp in (
("", "finished"),
("", "finished"),
("noclen_", "any"),
("chunked_", "any"),
("half_", "error"),
)
] + [
("ok bmp 16x16", "fetch", "ok.bmp", "finished"),
("ok qoi 16x16", "fetch", "ok.qoi", "finished"),
("truncated bmp", "fetch", "truncated.bmp", "error"),
("stall_bmp1_640.bmp", "fetch", "stall_bmp1_640.bmp", "error"),
("stall_qoi_flat.qoi", "fetch", "stall_qoi_flat.qoi", "error"),
("qoi_flat after", "fetch", "qoi_flat.qoi", "finished"),
]
SHORT = [
("gradient 320x240 png", "fetch", "gradient.png", "finished"),
("gradient again", "fetch", "gradient.png", "finished"),
("noise 320x240 png", "fetch", "noise.png", "finished"),
("noise again", "fetch", "noise.png", "finished"),
("noise again", "fetch", "noise.png", "finished"),
("gradient after noise", "fetch", "gradient.png", "finished"),
]
JPEG = [
("noise 320x240 jpeg 69 KB", "fetch", "noise320.jpg", "finished"),
("noise 320x240 again", "fetch", "noise320.jpg", "finished"),
("noise 320x240 again", "fetch", "noise320.jpg", "finished"),
("noise 640x480 jpeg 233 KB", "fetch", "noise640.jpg", "finished"),
("noise 640x480 again", "fetch", "noise640.jpg", "finished"),
("gradient 640x480 jpeg 14 KB", "fetch", "gradient640.jpg", "finished"),
("4 KB buffer: noise 320x240", "fetch_small", "noise320.jpg", "finished"),
("4 KB buffer: noise 640x480", "fetch_small", "noise640.jpg", "finished"),
("4 KB buffer: 12 KB exif", "fetch_small", "bigexif320.jpg", "any"),
("64 KB buffer: 12 KB exif", "fetch", "bigexif320.jpg", "finished"),
("progressive jpeg", "fetch", "progressive320.jpg", "any"),
("no content-length", "fetch", "noclen_noise320.jpg", "finished"),
("chunked", "fetch", "chunked_noise320.jpg", "finished"),
("half with matching length", "fetch", "half_noise320.jpg", "error"),
("closed early", "fetch", "closed_early.jpg", "error"),
("stalled after a third", "fetch", "stall_noise320.jpg", "error"),
("empty", "fetch", "empty.jpg", "error"),
("noise 320x240 after errors", "fetch", "noise320.jpg", "finished"),
("refetch 304", "refetch", "", "finished"),
("ok png 16x16", "fetch", "ok.png", "finished"),
("ok bmp 16x16", "fetch", "ok.bmp", "finished"),
("4 KB buffer: noise 640x480 again", "fetch_small", "noise640.jpg", "finished"),
("4 KB buffer: half", "fetch_small", "half_noise320.jpg", "error"),
("4 KB buffer: stalled", "fetch_small", "stall_noise320.jpg", "error"),
(
"4 KB buffer: noise 320x240 after errors",
"fetch_small",
"noise320.jpg",
"finished",
),
]
CASE_SETS = {
"png": PNG,
"noise": NOISE,
"end": END,
"bmpqoi": BMPQOI,
"short": SHORT,
"jpeg": JPEG,
}
CASES = CASE_SETS[os.environ.get("CASES", "png")]
def missing_base_files() -> list[str]:
"""Base files behind prefixed cases that the server does not serve (any HTTP error, or no server).
A failed fetch ends as a download error on the device, which would pass the half_ and stall_ cases untested.
"""
builtin = {"chunked_cut", "closed_early", "large_header"}
missing = []
for _, _, path, _ in CASES:
stem = path.rsplit(".", 1)[0]
prefix, _, rest = path.partition("_")
if (
stem in builtin
or prefix not in ("half", "noclen", "chunked", "stall")
or not rest
):
continue
try:
with urllib.request.urlopen(f"{BASE}/{rest}", timeout=10):
pass
except (urllib.error.URLError, OSError) as exc: # HTTPError is a URLError
missing.append(f"{rest} ({exc})")
return sorted(set(missing))
async def main() -> int:
if missing := missing_base_files():
print(
f"server has no {', '.join(missing)}; run the image generators first",
flush=True,
)
return 2
c = APIClient(HOST, 6053, None, noise_psk=KEY)
await c.connect(login=True)
ents, services = await c.list_entities_services()
actions = {s.name: s for s in services if isinstance(s, UserService)}
loop_key = next(
e.key for e in ents if isinstance(e, SensorInfo) and e.name == "Loop Time"
)
heap_key = next(
e.key for e in ents if isinstance(e, SensorInfo) and e.name == "Heap Free"
)
state = {"loop": [], "heap": None, "heap_min": None, "lines": []}
def on_state(s) -> None:
if isinstance(s, SensorState) and s.key == loop_key:
state["loop"].append(s.state)
elif isinstance(s, SensorState) and s.key == heap_key:
state["heap"] = s.state
if state["heap_min"] is None or s.state < state["heap_min"]:
state["heap_min"] = s.state
def on_log(msg) -> None:
line = msg.message.decode(errors="replace")
log.write(f"{time.strftime('%H:%M:%S')} {line}\n")
state["lines"].append(line)
with pathlib.Path(LOGFILE).open("w", encoding="utf-8") as log:
c.subscribe_states(on_state)
c.subscribe_logs(on_log, log_level=LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(3)
print(f"{LABEL}: heap at start {state['heap']}")
rows = []
for label, action, path, expect in CASES:
img = "img_small" if action.endswith("_small") else "img"
state["loop"].clear()
state["lines"].clear()
state["heap_min"] = None
args = {} if action.startswith("refetch") else {"url": f"{BASE}/{path}"}
t0 = time.monotonic()
log.write(f">>> {label} {path}\n")
try:
await c.execute_service(actions[action], args)
except Exception as exc: # noqa: BLE001
print(f" api call failed ({exc!r}); reconnecting", flush=True)
with contextlib.suppress(Exception):
await c.disconnect()
await asyncio.sleep(10)
await c.connect(login=True)
ents, services = await c.list_entities_services()
actions = {s.name: s for s in services if isinstance(s, UserService)}
c.subscribe_states(on_state)
c.subscribe_logs(on_log, log_level=LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(2)
state["lines"].clear()
t0 = time.monotonic()
await c.execute_service(actions[action], args)
outcome = "no outcome"
while time.monotonic() - t0 < CAP_S:
await asyncio.sleep(0.25)
for line in state["lines"]:
m = OUTCOME.search(line)
if m and m.group(2) == img:
outcome = m.group(1)
if outcome != "no outcome":
break
took = time.monotonic() - t0
await asyncio.sleep(4.5) # two loop time reports after the case
notes = [
ln for ln in state["lines"] if INTEREST.search(ln) and "Loop" not in ln
]
loop_max = max(state["loop"]) if state["loop"] else float("nan")
ok = outcome == expect or (expect == "any" and outcome != "no outcome")
rows.append((label, path, expect, outcome, took, loop_max, ok))
print(
f"{'PASS' if ok else 'FAIL'} {label:30s} {path:18s} expected {expect:9s} got {outcome:10s} {took:5.1f}s loop max {loop_max:7.0f} ms heap min {state['heap_min']}",
flush=True,
)
for n in notes[:8]:
print(f" {n.strip()}", flush=True)
await c.disconnect()
print(
"\nSUMMARY",
"all expectations met"
if all(r[6] for r in rows)
else "MISMATCHES: " + ", ".join(r[0] for r in rows if not r[6]),
)
return 0 if all(r[6] for r in rows) else 1
sys.exit(asyncio.run(main()))
@@ -0,0 +1,75 @@
"""Run the tx_all script N times over the API and count what each sent frame decoded as.
Usage: rbdrive.py IP N"""
import asyncio
import collections
import re
import sys
import aioesphomeapi
IP, N = sys.argv[1], int(sys.argv[2])
lines: list[str] = []
async def main() -> None:
c = aioesphomeapi.APIClient(IP, 6053, None)
await c.connect(login=True)
i = await c.device_info()
print("device", i.name, i.compilation_time, flush=True)
_, svcs = await c.list_entities_services()
s = {x.name: x for x in svcs}
def on_log(m):
lines.append(re.sub(r"\x1b\[[0-9;]*m", "", m.message.decode(errors="replace")))
c.subscribe_logs(on_log, log_level=aioesphomeapi.LogLevel.LOG_LEVEL_DEBUG)
await asyncio.sleep(1)
complete = 0
for rnd in range(1, N + 1):
start = len(lines)
await c.execute_service(s["tx_all"], {})
for _ in range(200):
if any("tx done" in x for x in lines[start:]):
complete += 1
break
await asyncio.sleep(0.1)
else:
print(f"round {rnd}: no tx done within 20 s", flush=True)
await asyncio.sleep(1)
await c.disconnect()
# per sent protocol: what was decoded
table: dict[str, collections.Counter] = collections.defaultdict(collections.Counter)
cur = None
for x in lines:
if m := re.search(r"\]: tx (\w+)$", x):
cur = m[1]
continue
if cur is None or cur == "done":
continue
if m := re.search(r"Received ([A-Za-z0-9_ ]+?):", x):
table[cur][m[1]] += 1
elif "ext dumper saw" in x:
table[cur]["ext"] += 1
print(f"{complete} of {N} rounds complete", flush=True)
for proto, cnt in table.items():
print(
f"{proto:11s} " + ", ".join(f"{k}={v}" for k, v in sorted(cnt.items())),
flush=True,
)
for x in lines:
if "ext dumper saw" not in x and re.search(
r"rbt|error|Error|overflow|Guru|panic", x
):
print(" ", x[:160])
if not any(k != "ext" for cnt in table.values() for k in cnt):
print("nothing decoded", flush=True)
return 1
if not any(cnt["ext"] for cnt in table.values()):
print("the external dumper saw no frame", flush=True)
return 1
return 0 if complete == N else 1
sys.exit(asyncio.run(main()))
+24
View File
@@ -0,0 +1,24 @@
#!/bin/bash
# run.sh LABEL B(32|66) [N] : write rb<B><LABEL> from templates/remote_base on every run, flash it, run rbdrive.py for N rounds
# Copy this directory and templates/remote_base into one scratch directory (secrets.yaml next to rb-common.yaml).
# env: TREE (esphome checkout to build from), P32 or P66 (serial port of the board), SC (path to
# serial_capture.py), PY (checkout python), EXPECT_REGISTER=1 (fail when the dumper registration was rejected)
R=$(cd "$(dirname "$0")" && pwd); V=$1; B=$2; N=${3:-3}; NAME=rb$B$V; T=${TREE:?set TREE}
PY=${PY:-$T/venv/bin/python}; SC=${SC:?set SC}
if [ "$B" = 32 ]; then P=${P32:?set P32}; else P=${P66:?set P66}; fi
mkdir -p "$R/$V"; sed "s/@V@/$V/g" "$R/rb$B.tmpl" > "$R/$V/$NAME.yaml" # always from the current template
OUT=$R/out-$V-$B; rm -rf "$OUT"; mkdir -p "$OUT"
pkill -f "[s]erial_capture.py $P"
(cd "$T" && $PY -m esphome run --no-logs "$R/$V/$NAME.yaml" --device "$P" > "$OUT/upload.log" 2>&1) || { echo "build or upload failed"; exit 1; }
$PY "$SC" "$P" 150 "$OUT/serial.txt" --reset > /dev/null 2>&1 & CAP=$!
trap 'kill $CAP 2>/dev/null' EXIT
for i in $(seq 60); do IP=$(grep -a -o 'IP Address: [0-9.]*' "$OUT/serial.txt" 2>/dev/null | tail -1 | cut -d' ' -f3); [ -z "$IP" ] && IP=$(python3 -c "import socket;print(socket.gethostbyname('$NAME.local'))" 2>/dev/null); [ -n "$IP" ] && break; sleep 2; done
[ -n "$IP" ] || { echo "device not found"; exit 1; }
$PY "$R/rbdrive.py" "$IP" "$N" > "$OUT/drive.txt" 2>&1; RC=$?
pkill -f "[s]erial_capture.py $P"
[ -s "$OUT/serial.txt" ] || { echo "serial capture got nothing, crash check invalid"; exit 1; }
CRASH=$(grep -a -c -i 'guru\|panic\|exception\|rst cause' "$OUT/serial.txt")
REJECTED=$(grep -a -c 'No dumper slot' "$OUT/serial.txt")
cat "$OUT/drive.txt"; echo "serial: $(grep -a -c 'ext dumper register called' "$OUT/serial.txt") register calls, $REJECTED rejected, $CRASH crash lines"
if [ "${EXPECT_REGISTER:-0}" = 1 ] && [ "$REJECTED" != 0 ]; then echo "the dumper registration was rejected"; exit 1; fi
[ "$RC" = 0 ] && [ "$CRASH" = 0 ]
@@ -0,0 +1,103 @@
"""Drive the FrameReader simulation builds over the API: press buttons, set selects/numbers, print states.
usage: frdrive.py HOST LOGFILE OP [OP ...]
OP: list | press:NAME | sel:NAME=OPTION | num:NAME=VALUE | wait:SECONDS
"""
import asyncio
import math
import pathlib
import sys
import time
from aioesphomeapi import (
APIClient,
BinarySensorState,
ButtonInfo,
LogLevel,
NumberInfo,
SelectInfo,
SensorInfo,
SensorState,
)
HOST, LOGFILE = sys.argv[1], sys.argv[2]
OPS = sys.argv[3:]
T0 = time.time()
SKIP = {"Heap Free", "Loop Time"}
def stamp() -> str:
return f"{time.time() - T0:7.3f}"
async def main() -> int:
with pathlib.Path(LOGFILE).open("w", encoding="utf-8") as log:
c = APIClient(HOST, 6053, None)
await c.connect(login=True)
info = await c.device_info()
print(f"device {info.name} compiled {info.compilation_time}", flush=True)
ents, _ = await c.list_entities_services()
by_key = {e.key: e for e in ents}
def find(kind: type, name: str):
for e in ents:
if isinstance(e, kind) and e.name == name:
return e
sys.exit(f"no {kind.__name__} named {name!r}")
def on_state(s) -> None:
e = by_key.get(s.key)
if e is None or e.name in SKIP:
return
if isinstance(s, SensorState) and isinstance(e, SensorInfo):
v = "nan" if math.isnan(s.state) else f"{s.state:.2f}"
line = f"{stamp()} SEN {e.name} = {v}"
elif isinstance(s, BinarySensorState):
line = f"{stamp()} BIN {e.name} = {s.state}"
else:
return
print(line, flush=True)
log.write(line + "\n")
states.append(line)
def on_log(msg) -> None:
log.write(f"{stamp()} {msg.message.decode(errors='replace')}\n")
log.flush()
states: list[str] = []
c.subscribe_states(on_state)
c.subscribe_logs(on_log, log_level=LogLevel.LOG_LEVEL_VERBOSE)
await asyncio.sleep(2)
states.clear() # count only states published while the ops ran
for op in OPS:
kind, _, rest = op.partition(":")
if kind == "list":
for e in ents:
print(type(e).__name__, e.name)
continue
if kind == "wait":
await asyncio.sleep(float(rest))
continue
line = f"{stamp()} >>> {op}"
print(line, flush=True)
log.write(line + "\n")
if kind == "press":
c.button_command(find(ButtonInfo, rest).key)
elif kind == "sel":
name, _, value = rest.partition("=")
c.select_command(find(SelectInfo, name).key, value)
elif kind == "num":
name, _, value = rest.partition("=")
c.number_command(find(NumberInfo, name).key, float(value))
else:
sys.exit(f"unknown op {op!r}")
await asyncio.sleep(2.5)
await asyncio.sleep(1)
await c.disconnect()
if any(not op.startswith(("list", "wait")) for op in OPS) and not states:
print("no sensor state was published while the ops ran", flush=True)
return 1
return 0
sys.exit(asyncio.run(main()))
+19
View File
@@ -0,0 +1,19 @@
#!/bin/bash
# usage: run.sh NAME TREE SECONDS OP... flash over serial, capture serial, drive over the API
# Copy this, frdrive.py and the templates/uart_sim files into one scratch directory and run it there.
# env: PORT (the devkit serial port), SC (path to serial_capture.py), PY (checkout python); TREE is the esphome
# checkout to build from
D=$(cd "$(dirname "$0")" && pwd); N=$1; T=$2; S=$3; shift 3; P=${PORT:?set PORT}; PY=${PY:-$T/venv/bin/python}
(cd $T && PYTHONUNBUFFERED=1 timeout 1500 $PY -m esphome run --no-logs $D/$N.yaml --device $P > $D/$N-upload.log 2>&1) || { echo "build or upload failed"; exit 1; }
$PY ${SC:?set SC} $P $S $D/$N-cap.txt > $D/$N-cap.err 2>&1 &
CAP=$!
trap 'kill $CAP 2>/dev/null' EXIT
UP=0
for i in $(seq 1 40); do $PY -c "import socket;socket.create_connection(('$N.local',6053),2)" 2>/dev/null && { UP=1; break; }; sleep 2; done
[ $UP = 1 ] || { echo "device $N.local not reachable on port 6053"; exit 1; }
cd $D && PYTHONUNBUFFERED=1 timeout $((S - 5)) $PY frdrive.py $N.local $N-api.log "$@" > $N-drive.txt 2>&1; RC=$?; echo "drive rc=$RC"
wait $CAP; CAPRC=$?; trap - EXIT
[ "$CAPRC" = 0 ] || { echo "serial capture failed (rc $CAPRC), crash check invalid"; exit 1; }
CRASH=$(grep -acE 'Guru|abort\(\)|rst:0x' $D/$N-cap.txt)
echo "crash lines: $CRASH"
[ "$RC" = 0 ] && [ "$CRASH" = 0 ]
@@ -0,0 +1,162 @@
# Package for the http_request action test (esphome#21486). Needs substitutions: name, bufsize.
esphome:
name: ${name}
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
api:
reboot_timeout: 0s
actions:
- action: req_get
variables:
url: string
then:
- lambda: 'id(max_gap) = 0; id(t_start) = millis(); id(tag)++; ESP_LOGI("hrt", "START %d %s %s", id(tag), "GET", url.c_str());'
- http_request.get:
url: !lambda return url;
capture_response: true
max_response_buffer_size: ${bufsize}
on_response:
then:
- lambda: |-
uint32_t sum = 0;
for (char c : body) sum += (uint8_t) c;
ESP_LOGI("hrt", "RESULT %d status=%d len=%u sum=%u took=%u maxgap=%u head=%.20s", id(tag),
response->status_code, (unsigned) body.size(), (unsigned) sum,
(unsigned) (millis() - id(t_start)), (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)), body.c_str());
on_error:
then:
- lambda: 'ESP_LOGI("hrt", "RESULT %d error took=%u maxgap=%u", id(tag), (unsigned) (millis() - id(t_start)), (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)));'
- lambda: 'ESP_LOGI("hrt", "CHAIN %d after send", id(tag));'
- action: req_post
variables:
url: string
payload: string
then:
- lambda: 'id(max_gap) = 0; id(t_start) = millis(); id(tag)++; ESP_LOGI("hrt", "START %d %s %s", id(tag), "POST", url.c_str());'
- http_request.post:
url: !lambda return url;
body: !lambda return payload;
capture_response: true
max_response_buffer_size: ${bufsize}
on_response:
then:
- lambda: |-
uint32_t sum = 0;
for (char c : body) sum += (uint8_t) c;
ESP_LOGI("hrt", "RESULT %d status=%d len=%u sum=%u took=%u maxgap=%u head=%.20s", id(tag),
response->status_code, (unsigned) body.size(), (unsigned) sum,
(unsigned) (millis() - id(t_start)), (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)), body.c_str());
on_error:
then:
- lambda: 'ESP_LOGI("hrt", "RESULT %d error took=%u maxgap=%u", id(tag), (unsigned) (millis() - id(t_start)), (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)));'
- lambda: 'ESP_LOGI("hrt", "CHAIN %d after send", id(tag));'
- action: burst
variables:
url: string
count: int
then:
- lambda: 'id(max_gap) = 0; id(t_start) = millis(); ESP_LOGI("hrt", "BURST %d", count);'
- repeat:
count: !lambda return count;
then:
- script.execute:
id: burst_script
url: !lambda return url;
- action: cancel
variables:
url: string
then:
- lambda: 'id(max_gap) = 0; id(t_start) = millis(); ESP_LOGI("hrt", "CANCEL start");'
- script.execute:
id: single_script
url: !lambda return url;
- delay: 300ms
- script.execute:
id: single_script
url: !lambda return url;
- delay: 300ms
- script.stop: single_script
- lambda: 'ESP_LOGI("hrt", "CANCEL stopped running=%d", id(single_script).is_running());'
- delay: 4s
- lambda: 'ESP_LOGI("hrt", "CANCEL done maxgap=%u", (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)));'
- action: reboot_during
variables:
url: string
then:
- lambda: 'ESP_LOGI("hrt", "REBOOT_DURING start");'
- script.execute:
id: single_script
url: !lambda return url;
- script.execute:
id: burst_script
url: !lambda return url;
- delay: 500ms
- lambda: 'ESP_LOGI("hrt", "REBOOT_DURING rebooting"); App.safe_reboot();'
script:
- id: burst_script
mode: parallel
max_runs: 10
parameters:
url: string
then:
- http_request.get:
url: !lambda return url;
capture_response: true
max_response_buffer_size: 256
on_response:
then:
- lambda: 'ESP_LOGI("hrt", "BURSTRESP status=%d len=%u took=%u maxgap=%u", response->status_code, (unsigned) body.size(), (unsigned) (millis() - id(t_start)), (unsigned) std::max<uint32_t>(id(max_gap), millis() - id(last_tick)));'
on_error:
then:
- lambda: 'ESP_LOGI("hrt", "BURSTERR took=%u", (unsigned) (millis() - id(t_start)));'
- id: single_script
parameters:
url: string
then:
- lambda: 'ESP_LOGI("hrt", "SINGLE begin");'
- http_request.get:
url: !lambda return url;
capture_response: true
max_response_buffer_size: 256
on_response:
then:
- lambda: 'ESP_LOGI("hrt", "SINGLERESP status=%d took=%u", response->status_code, (unsigned) (millis() - id(t_start)));'
on_error:
then:
- lambda: 'ESP_LOGI("hrt", "SINGLEERR took=%u", (unsigned) (millis() - id(t_start)));'
- lambda: 'ESP_LOGI("hrt", "SINGLE end");'
http_request:
timeout: 8s
globals:
- id: max_gap
type: uint32_t
initial_value: "0"
- id: last_tick
type: uint32_t
initial_value: "0"
- id: t_start
type: uint32_t
initial_value: "0"
- id: tag
type: int
initial_value: "0"
interval:
- interval: 1ms
then:
- lambda: |-
const uint32_t now = millis();
if (id(last_tick) != 0 && now - id(last_tick) > id(max_gap))
id(max_gap) = now - id(last_tick);
id(last_tick) = now;
ota:
- platform: esphome
@@ -0,0 +1,7 @@
# Run file for the PR build; for the base build pass `-s name hr32base` to esphome (or copy it with that name).
substitutions: {name: hr32pr, bufsize: "32768"}
esp32:
board: esp32dev
framework: {type: esp-idf}
logger:
packages: {hr: !include hr-common.yaml}
@@ -0,0 +1,8 @@
# Run file for the PR build; for the base build pass `-s name hr66base` to esphome (or copy it with that name).
substitutions: {name: hr66pr, bufsize: "8192"}
esp8266:
board: d1_mini
logger:
packages: {hr: !include hr-common.yaml}
http_request:
verify_ssl: false
@@ -0,0 +1,22 @@
# Same as hr32.yaml plus the otaflash action otadrive.py calls; pass -s name hrota32base for the base build.
substitutions: {name: hrota32, bufsize: "32768"}
esp32:
board: esp32dev
framework: {type: esp-idf}
logger:
packages: {hr: !include hr-common.yaml}
ota:
- platform: http_request
id: ota_http
api:
actions:
- action: otaflash
variables:
url: string
sum: string
then:
- lambda: 'ESP_LOGI("hrt", "OTAFLASH start %s", url.c_str());'
- ota.http_request.flash:
url: !lambda return url;
md5: !lambda return sum;
- lambda: 'ESP_LOGI("hrt", "OTAFLASH returned (failed)");'
@@ -0,0 +1,105 @@
esphome:
name: oi-s3eth
friendly_name: oi-s3eth
esp32:
board: esp32-s3-devkitc-1
variant: esp32s3
flash_size: 16MB
framework:
type: esp-idf
psram:
mode: octal
speed: 80MHz
logger:
level: DEBUG
hardware_uart: USB_SERIAL_JTAG
ethernet:
type: W5500
clk_pin: GPIO13
mosi_pin: GPIO11
miso_pin: GPIO12
cs_pin: GPIO14
interrupt_pin: GPIO10
reset_pin: GPIO9
api:
encryption:
key: !secret api_key
reboot_timeout: 0s
actions:
- action: fetch
variables:
url: string
then:
- online_image.set_url:
id: img
url: !lambda 'return url;'
update: false
- component.update: img
- action: refetch
then:
- component.update: img
- action: fetch_small
variables:
url: string
then:
- online_image.set_url:
id: img_small
url: !lambda 'return url;'
update: false
- component.update: img_small
- action: refetch_small
then:
- component.update: img_small
http_request:
timeout: 4.5s
verify_ssl: false
display:
image:
- platform: online_image
id: img
url: http://127.0.0.1/none.bmp
format: AUTO
type: RGB565
update_interval: never
on_download_finished:
logger.log:
format: "download finished: img cached=%d"
args: [cached]
on_error:
logger.log: "download error: img"
- platform: online_image
id: img_small
url: http://127.0.0.1/none.bmp
format: AUTO
type: RGB565
buffer_size: 256
update_interval: never
on_download_finished:
logger.log:
format: "download finished: img_small cached=%d"
args: [cached]
on_error:
logger.log: "download error: img_small"
button:
- platform: restart
id: reboot_btn
name: Reboot
debug:
update_interval: 2s
sensor:
- platform: debug
loop_time:
name: Loop Time
free:
name: Heap Free
@@ -0,0 +1,33 @@
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
logger:
level: DEBUG
api:
reboot_timeout: 0s
actions:
- action: tx_all
then:
- script.execute: tx_all
ota:
- platform: esphome
esphome:
on_boot:
priority: -100
then:
- lambda: |-
// A dumper registered at runtime, the way external components do it from setup()
struct ExtDumper : remote_base::RemoteReceiverDumperBase {
bool dump(remote_base::RemoteReceiveData src) override {
ESP_LOGI("rbt", "ext dumper saw %d", (int) src.size());
return false;
}
};
static ExtDumper ext;
id(rx_all).register_dumper(&ext);
ESP_LOGI("rbt", "ext dumper register called");
@@ -0,0 +1,46 @@
script:
- id: tx_all
then:
- logger.log: "tx nec"
- remote_transmitter.transmit_nec: {address: 0x1234, command: 0x78}
- delay: 400ms
- logger.log: "tx samsung"
- remote_transmitter.transmit_samsung: {data: 0xE0E040BF}
- delay: 400ms
- logger.log: "tx sony"
- remote_transmitter.transmit_sony: {data: 0xA90, nbits: 12}
- delay: 400ms
- logger.log: "tx lg"
- remote_transmitter.transmit_lg: {data: 0x20DF10EF, nbits: 32}
- delay: 400ms
- logger.log: "tx jvc"
- remote_transmitter.transmit_jvc: {data: 0xC5E8}
- delay: 400ms
- logger.log: "tx panasonic"
- remote_transmitter.transmit_panasonic: {address: 0x4004, command: 0x0100BCBD}
- delay: 400ms
- logger.log: "tx rc5"
- remote_transmitter.transmit_rc5: {address: 0x1C, command: 0x05}
- delay: 400ms
- logger.log: "tx rc6"
- remote_transmitter.transmit_rc6: {address: 0x00, command: 0x0C}
- delay: 400ms
- logger.log: "tx dish"
- remote_transmitter.transmit_dish: {address: 1, command: 16}
- delay: 400ms
- logger.log: "tx coolix"
- remote_transmitter.transmit_coolix: {first: 0xB23FE4}
- delay: 400ms
- logger.log: "tx pioneer"
- remote_transmitter.transmit_pioneer: {rc_code_1: 0xA556}
- delay: 400ms
- logger.log: "tx samsung36"
- remote_transmitter.transmit_samsung36: {address: 0x0400, command: 0x000E00FF}
- delay: 400ms
- logger.log: "tx magiquest"
- remote_transmitter.transmit_magiquest: {wand_id: 0x01234567}
- delay: 400ms
- logger.log: "tx raw"
- remote_transmitter.transmit_raw: {code: [3000, -1000, 700, -2900, 1500, -400, 2200, -1700]}
- delay: 400ms
- logger.log: "tx done"
@@ -0,0 +1,32 @@
esphome:
name: rb32@V@
esp32:
board: esp32dev
framework:
type: esp-idf
packages:
common: !include ../rb-common.yaml
txscript: !include ../rb-txscript.yaml
remote_transmitter:
pin:
number: GPIO4
allow_other_uses: true
carrier_duty_percent: 100%
rmt_symbols: 64
remote_receiver:
- id: rx_all
pin:
number: GPIO4
allow_other_uses: true
dump: all
rmt_symbols: 192
- id: rx_nec_raw
pin:
number: GPIO4
allow_other_uses: true
dump: [nec, raw]
rmt_symbols: 192
@@ -0,0 +1,69 @@
esphome:
name: rb66@V@
includes:
- ../softtx.hpp
esp8266:
board: d1_mini
packages:
common: !include ../rb-common.yaml
remote_receiver:
- id: rx_all
pin: GPIO5
dump: all
# the receiver leaves its pin an input; drive it so the software sender reaches the pad
interval:
- interval: 1h
startup_delay: 0s
then:
- lambda: pinMode(5, OUTPUT);
script:
- id: tx_all
then:
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
NECProtocol().encode(&d, {0x1234, 0x78, 1});
softtx::send(d, "nec");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
SamsungProtocol().encode(&d, {0xE0E040BF, 32});
softtx::send(d, "samsung");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
SonyProtocol().encode(&d, {0xA90, 12});
softtx::send(d, "sony");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
LGProtocol().encode(&d, {0x20DF10EF, 32});
softtx::send(d, "lg");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
JVCProtocol().encode(&d, {0xC5E8});
softtx::send(d, "jvc");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
RC5Protocol().encode(&d, {0x1C, 0x05});
softtx::send(d, "rc5");
- delay: 400ms
- lambda: |-
remote_base::RemoteTransmitData d;
using namespace remote_base;
d.item(3000, 1000); d.item(700, 2900); d.item(1500, 400); d.mark(2200);
softtx::send(d, "raw");
- delay: 400ms
- logger.log: "tx done"
@@ -0,0 +1,15 @@
#pragma once
// Bit-bang a frame with interrupts left on, so a receiver on the same pin sees every edge.
// The ESP8266 remote_transmitter disables interrupts while it sends, which hides the edges.
#include "esphome/components/remote_base/remote_base.h"
namespace softtx {
inline void send(const esphome::remote_base::RemoteTransmitData &d, const char *name) {
ESP_LOGI("rbt", "tx %s", name);
for (int32_t v : d.get_data()) {
digitalWrite(5, v > 0 ? HIGH : LOW);
delayMicroseconds(v > 0 ? v : -v);
}
digitalWrite(5, LOW);
}
} // namespace softtx
@@ -0,0 +1,35 @@
esp32:
board: esp32dev
framework:
type: esp-idf
esphome:
includes:
- sim.hpp
logger:
level: VERBOSE
logs:
component: DEBUG
api.service: DEBUG
api.connection: DEBUG
scheduler: DEBUG
sensor: DEBUG
wifi:
ssid: !secret wifi_ssid
password: !secret wifi_password
power_save_mode: none
api:
reboot_timeout: 0s
debug:
update_interval: 10s
sensor:
- platform: debug
free:
name: Heap Free
loop_time:
name: Loop Time
@@ -0,0 +1,86 @@
esphome:
on_boot:
priority: -100
then:
- lambda: |-
sim::loopback(id(u_w));
sim::loopback(id(u_d));
uart:
- id: u_w
tx_pin: GPIO25
rx_pin: GPIO26
baud_rate: 9600
- id: u_d
tx_pin: GPIO32
rx_pin: GPIO33
baud_rate: 9600
sensor:
- platform: wts01
id: wts
name: WTS01 Temperature
uart_id: u_w
accuracy_decimals: 2
filters: []
- platform: ds1603l
name: DS1603L Distance
uart_id: u_d
button:
- platform: template
name: W Good
on_press:
- lambda: sim::send(id(u_w), "W Good 22.18", sim::wts01(22, 18));
- platform: template
name: W Negative
on_press:
- lambda: sim::send(id(u_w), "W Negative -5.50", sim::wts01(0x85, 50));
- platform: template
name: W Extra 55
on_press:
- lambda: sim::send(id(u_w), "W Extra 55 then 23.25", sim::cat({0x55}, sim::wts01(23, 25)));
- platform: template
name: W 55 Breaks Header
on_press:
- lambda: sim::send(id(u_w), "W 55 01 01 then 26.00", sim::cat({0x55, 0x01, 0x01}, sim::wts01(26, 0)));
- platform: template
name: W Bad Checksum
on_press:
- lambda: sim::send(id(u_w), "W bad checksum 30.00", sim::wts01(30, 0, true));
- platform: template
name: W Garbage Then Frame
on_press:
- lambda: sim::send(id(u_w), "W garbage then 24.50", sim::cat({0x01, 0x02, 0x55, 0x01, 0x99}, sim::wts01(24, 50)));
- platform: template
name: W Split
on_press:
- lambda: sim::send(id(u_w), "W split head 27.75", sim::part(sim::wts01(27, 75), 0, 5));
- delay: 300ms
- lambda: sim::send(id(u_w), "W split rest", sim::part(sim::wts01(27, 75), 5, 9));
- platform: template
name: W Two Frames
on_press:
- lambda: sim::send(id(u_w), "W 20.01 then 20.02", sim::cat(sim::wts01(20, 1), sim::wts01(20, 2)));
- platform: template
name: D Good
on_press:
- lambda: sim::send(id(u_d), "D Good 1000", sim::ds1603l(1000));
- platform: template
name: D Misaligned
on_press:
- lambda: sim::send(id(u_d), "D FF 01 then 1234", sim::cat({0xFF, 0x01}, sim::ds1603l(1234)));
- platform: template
name: D Bad Checksum
on_press:
- lambda: sim::send(id(u_d), "D bad checksum 2000", sim::ds1603l(2000, true));
- platform: template
name: D Garbage Then Frame
on_press:
- lambda: sim::send(id(u_d), "D garbage then 500", sim::cat({0x12, 0x34}, sim::ds1603l(500)));
- platform: template
name: D Split
on_press:
- lambda: sim::send(id(u_d), "D split head 777", sim::part(sim::ds1603l(777), 0, 2));
- delay: 300ms
- lambda: sim::send(id(u_d), "D split rest", sim::part(sim::ds1603l(777), 2, 4));
@@ -0,0 +1,6 @@
# Run file for build a; copy it as frabase.yaml with name frabase for the base build.
esphome:
name: fra
packages:
common: !include fr-common.yaml
parts: !include fra-parts.yaml
@@ -0,0 +1,104 @@
esphome:
on_boot:
priority: 200
then:
- lambda: |-
sim::loopback(id(u_s));
sim::loopback(id(u_f));
uart:
- id: u_s
tx_pin: GPIO25
rx_pin: GPIO26
baud_rate: 9600
- id: u_f
tx_pin: GPIO32
rx_pin: GPIO33
baud_rate: 2400
parity: EVEN
sensor:
- platform: sm300d2
id: sm
uart_id: u_s
update_interval: never
co2:
name: SM CO2
temperature:
name: SM Temperature
- platform: ufm01
temperature:
name: UFM Temperature
accumulated_flow:
name: UFM Accumulated Flow
ufm01:
id: ufm
uart_id: u_f
interval:
- interval: 1s
then:
- lambda: id(u_f).write_array(sim::ufm01(0x21, 0x50).data(), 32);
script:
- id: sm_update
then:
- delay: 100ms
- lambda: |-
uint32_t t0 = micros();
id(sm).update();
ESP_LOGI("sim", "sm300d2 update() took %u us", (unsigned) (micros() - t0));
button:
- platform: template
name: S Good
on_press:
- lambda: sim::send(id(u_s), "S Good co2 600 23.4", sim::sm300d2(600, 23, 4));
- script.execute: sm_update
- platform: template
name: S Empty Update
on_press:
- script.execute: sm_update
- platform: template
name: S Wrong Second Header
on_press:
- lambda: sim::send(id(u_s), "S 3C 05 then co2 700", sim::cat({0x3C, 0x05}, sim::sm300d2(700, 24, 0)));
- script.execute: sm_update
- platform: template
name: S Garbage Then Frame
on_press:
- lambda: sim::send(id(u_s), "S garbage then co2 800", sim::cat({0x01, 0x3C, 0x99}, sim::sm300d2(800, 25, 0)));
- script.execute: sm_update
- platform: template
name: S Cut Frame
on_press:
- lambda: sim::send(id(u_s), "S first 10 bytes of co2 900", sim::part(sim::sm300d2(900, 26, 0), 0, 10));
- script.execute: sm_update
- platform: template
name: S Two Frames
on_press:
- lambda: sim::send(id(u_s), "S co2 1001 then 1002", sim::cat(sim::sm300d2(1001, 27, 0), sim::sm300d2(1002, 28, 0)));
- script.execute: sm_update
- delay: 1s
- script.execute: sm_update
- platform: template
name: S Bad Checksum
on_press:
- lambda: |-
auto f = sim::sm300d2(1100, 29, 0);
f[16] += 0x11;
sim::send(id(u_s), "S bad checksum co2 1100", f);
- script.execute: sm_update
- platform: template
name: F Cut Then Frame
on_press:
- lambda: sim::send(id(u_f), "F 3C 32 00 00 then 33.33", sim::cat({0x3C, 0x32, 0x00, 0x00}, sim::ufm01(0x33, 0x33)));
- platform: template
name: F Bad Checksum Then Frame
on_press:
- lambda: sim::send(id(u_f), "F bad checksum 66.66 then 44.44", sim::cat(sim::ufm01(0x66, 0x66, true), sim::ufm01(0x44, 0x44)));
- platform: template
name: F Garbage Then Frame
on_press:
- lambda: sim::send(id(u_f), "F garbage then 55.55", sim::cat({0x16, 0x3C, 0x00}, sim::ufm01(0x55, 0x55)));
@@ -0,0 +1,6 @@
# Run file for build b; copy it as frbbase.yaml with name frbbase for the base build.
esphome:
name: frb
packages:
common: !include fr-common.yaml
parts: !include frb-parts.yaml
@@ -0,0 +1,64 @@
uart:
- id: u_a
tx_pin:
number: GPIO25
allow_other_uses: true
rx_pin:
number: GPIO26
allow_other_uses: true
baud_rate: 9600
- id: u_b
tx_pin:
number: GPIO26
allow_other_uses: true
rx_pin:
number: GPIO25
allow_other_uses: true
baud_rate: 9600
esphome:
on_boot:
priority: 1000
then:
- lambda: sim::probe.u = id(u_b);
interval:
- interval: 10ms
then:
- lambda: sim::probe.poll();
sensor:
- platform: dfrobot_sen0465_uart
id: gas
uart_id: u_a
model: SEN0466
alarm:
threshold: 35
type: high
update_interval: 5s
concentration:
name: CO Concentration
temperature:
name: CO Temperature
select:
- platform: template
name: Probe Mode
optimistic: true
options: ["0 normal", "1 tail", "2 FF tail", "3 silent", "4 split", "5 wrong gas"]
initial_option: "0 normal"
set_action:
- lambda: |-
sim::probe.mode = x.c_str()[0] - '0';
ESP_LOGI("sim", "probe mode %d", sim::probe.mode);
number:
- platform: template
name: Probe Conc
optimistic: true
min_value: 0
max_value: 1000
step: 1
initial_value: 25
set_action:
- lambda: sim::probe.conc = (uint16_t) x;
@@ -0,0 +1,6 @@
# Run file for build c; copy it as frcbase.yaml with name frcbase for the base build.
esphome:
name: frc
packages:
common: !include fr-common.yaml
parts: !include frc-parts.yaml
@@ -0,0 +1,158 @@
#pragma once
// Simulated UART sensors for the FrameReader hardware test: frame builders, UART loopback and a SEN0465 responder.
#include <driver/uart.h>
#include <cstring>
#include <vector>
#include "esphome/components/uart/uart_component_esp_idf.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
namespace sim {
using esphome::uart::IDFUARTComponent;
static const char *const TAG = "sim";
inline void loopback(IDFUARTComponent *u) {
esp_err_t err = uart_set_loop_back((uart_port_t) u->get_hw_serial_number(), true);
if (err != ESP_OK) {
ESP_LOGE(TAG, "UART%u loopback FAILED: %s", u->get_hw_serial_number(), esp_err_to_name(err));
} else {
ESP_LOGI(TAG, "UART%u loopback on", u->get_hw_serial_number());
}
}
inline void send(IDFUARTComponent *u, const char *name, std::vector<uint8_t> bytes) {
char hex[200] = {0};
size_t n = 0;
for (uint8_t b : bytes) {
if (n + 4 > sizeof(hex))
break;
n += snprintf(hex + n, sizeof(hex) - n, "%02X ", b);
}
ESP_LOGI(TAG, ">>> %s: %s", name, hex);
u->write_array(bytes.data(), bytes.size());
}
inline uint8_t sum(const std::vector<uint8_t> &v, size_t from, size_t to) {
uint8_t s = 0;
for (size_t i = from; i < to; i++)
s += v[i];
return s;
}
// wts01: 55 01 01 04 01 11 T Td Ck
inline std::vector<uint8_t> wts01(uint8_t t, uint8_t td, bool bad_ck = false) {
std::vector<uint8_t> f = {0x55, 0x01, 0x01, 0x04, 0x01, 0x11, t, td, 0};
f[8] = sum(f, 0, 8) + (bad_ck ? 1 : 0);
return f;
}
// ds1603l: FF H L Ck
inline std::vector<uint8_t> ds1603l(uint16_t mm, bool bad_ck = false) {
std::vector<uint8_t> f = {0xFF, (uint8_t) (mm >> 8), (uint8_t) mm, 0};
f[3] = sum(f, 0, 3) + (bad_ck ? 1 : 0);
return f;
}
// sm300d2: 3C 02 co2 hcho tvoc pm25 pm10 (16 bit each) temp temp.dec hum hum.dec Ck
inline std::vector<uint8_t> sm300d2(uint16_t co2, uint8_t temp, uint8_t temp_dec) {
std::vector<uint8_t> f = {
0x3C, 0x02, (uint8_t) (co2 >> 8), (uint8_t) co2, 0, 10, 0, 20, 0, 5, 0, 8, temp, temp_dec, 45, 6, 0};
f[16] = sum(f, 0, 16);
return f;
}
// ufm01 active frame, temperature t.tt as BCD (t_int, t_frac)
inline std::vector<uint8_t> ufm01(uint8_t t_int_bcd, uint8_t t_frac_bcd, bool bad_ck = false) {
std::vector<uint8_t> f(32, 0);
f[0] = 0x3C;
f[1] = 0x32;
f[2] = 0x01;
f[4] = 0x14;
f[5] = 0x07;
f[6] = 0x23;
f[7] = 0x01;
f[9] = 0x56; // accumulated flow 0.056
f[15] = 0x0B;
f[16] = 0x50; // flow
f[21] = 0x0C;
f[24] = 0x0D;
f[25] = t_frac_bcd;
f[26] = t_int_bcd;
f[31] = 0x16;
f[30] = sum(f, 0, 30) + (bad_ck ? 1 : 0);
return f;
}
inline std::vector<uint8_t> cat(std::vector<uint8_t> a, const std::vector<uint8_t> &b) {
a.insert(a.end(), b.begin(), b.end());
return a;
}
inline std::vector<uint8_t> part(const std::vector<uint8_t> &v, size_t from, size_t to) {
return std::vector<uint8_t>(v.begin() + from, v.begin() + to);
}
// SEN0465 probe on the other end of a cross-wired UART pair. Modes: 0 normal, 1 tail before the answer,
// 2 tail with an FF before the answer, 3 silent, 4 answer split in two 300 ms apart, 5 wrong gas type.
struct Probe {
IDFUARTComponent *u{nullptr};
int mode{0};
uint8_t req[9];
uint8_t n{0};
std::vector<uint8_t> rest;
uint32_t rest_at{0};
uint16_t conc{25};
static uint8_t ck(const std::vector<uint8_t> &f) { return (uint8_t) (~sum(f, 1, 7) + 1); }
void poll() {
if (!this->rest.empty() && millis() - this->rest_at >= 300) {
send(this->u, "probe answer rest", this->rest);
this->rest.clear();
}
uint8_t c;
while (this->u->available() && this->u->read_byte(&c)) {
if (this->n == 0 && c != 0xFF)
continue;
this->req[this->n++] = c;
if (this->n < 9)
continue;
this->n = 0;
this->answer_(this->req[2]);
}
}
void answer_(uint8_t cmd) {
ESP_LOGI(TAG, "probe got request 0x%02X (mode %d)", cmd, this->mode);
std::vector<uint8_t> f;
if (cmd == 0x88) {
f = {0xFF,
0x88,
(uint8_t) (this->conc >> 8),
(uint8_t) this->conc,
(uint8_t) (this->mode == 5 ? 0x05 : 0x04),
0x00,
0x02,
0x00,
0};
} else {
f = {0xFF, cmd, 0x01, 0, 0, 0, 0, 0, 0};
}
f[8] = ck(f);
switch (this->mode) {
case 1:
send(this->u, "probe tail+answer", cat({0x12, 0x34, 0x56}, f));
break;
case 2:
send(this->u, "probe FF tail+answer", cat({0x12, 0xFF, 0x34}, f));
break;
case 3:
ESP_LOGI(TAG, "probe silent");
break;
case 4:
send(this->u, "probe answer head", part(f, 0, 5));
this->rest = part(f, 5, 9);
this->rest_at = millis();
break;
default:
send(this->u, "probe answer", f);
}
}
};
inline Probe probe;
} // namespace sim
+2
View File
@@ -195,6 +195,7 @@ esphome/components/ens160_spi/* @latonita
esphome/components/ens210/* @itn3rd77
esphome/components/epaper_spi/* @esphome/core
esphome/components/es7210/* @kahrendt
esphome/components/es7243/* @Chorty
esphome/components/es7243e/* @kbx81
esphome/components/es8156/* @kbx81
esphome/components/es8311/* @kahrendt @kroimon
@@ -697,6 +698,7 @@ esphome/components/uart/packet_transport/* @clydebarrow
esphome/components/uart_mux/* @kbx81
esphome/components/uart_tcp/* @Bascht74
esphome/components/udp/* @clydebarrow
esphome/components/udp/packet_interface/* @clydebarrow
esphome/components/ufire_ec/* @pvizeli
esphome/components/ufire_ise/* @pvizeli
esphome/components/ufm01/* @ljungqvist
@@ -1,5 +1,6 @@
import esphome.codegen as cg
from esphome.components import airthings_wave_base, sensor
from esphome.components.const import CONF_DEVICE_TYPE
import esphome.config_validation as cv
from esphome.const import (
CONF_CO2,
@@ -27,7 +28,6 @@ AirthingsWavePlus = airthings_wave_plus_ns.class_(
"AirthingsWavePlus", airthings_wave_base.AirthingsWaveBase
)
CONF_DEVICE_TYPE = "device_type"
WaveDeviceType = airthings_wave_plus_ns.enum("WaveDeviceType")
DEVICE_TYPES = WaveDeviceType.options("WAVE_PLUS", "WAVE_GEN2")
+50 -52
View File
@@ -1,129 +1,127 @@
#include "am43_base.h"
#include "esphome/core/helpers.h"
#include "esphome/core/log.h"
#include <cstring>
namespace esphome::am43 {
const uint8_t START_PACKET[5] = {0x00, 0xff, 0x00, 0x00, 0x9a};
ESPHOME_LOG_TAG(TAG, "am43");
Am43Packet *Am43Encoder::get_battery_level_request() {
static constexpr uint8_t START_PACKET[5] = {0x00, 0xff, 0x00, 0x00, 0x9a};
Am43Packet Am43Encoder::get_battery_level_request() {
uint8_t data = 0x1;
return this->encode_(0xA2, &data, 1);
return encode(CMD_GET_BATTERY_LEVEL, &data, 1);
}
Am43Packet *Am43Encoder::get_light_level_request() {
Am43Packet Am43Encoder::get_light_level_request() {
uint8_t data = 0x1;
return this->encode_(0xAA, &data, 1);
return encode(CMD_GET_LIGHT_LEVEL, &data, 1);
}
Am43Packet *Am43Encoder::get_position_request() {
Am43Packet Am43Encoder::get_position_request() {
uint8_t data = 0x1;
return this->encode_(CMD_GET_POSITION, &data, 1);
return encode(CMD_GET_POSITION, &data, 1);
}
Am43Packet *Am43Encoder::get_send_pin_request(uint16_t pin) {
Am43Packet Am43Encoder::get_send_pin_request(uint16_t pin) {
uint8_t data[2];
data[0] = (pin & 0xFF00) >> 8;
data[1] = pin & 0xFF;
return this->encode_(CMD_SEND_PIN, data, 2);
return encode(CMD_SEND_PIN, data, 2);
}
Am43Packet *Am43Encoder::get_open_request() {
Am43Packet Am43Encoder::get_open_request() {
uint8_t data = 0xDD;
return this->encode_(CMD_SET_STATE, &data, 1);
return encode(CMD_SET_STATE, &data, 1);
}
Am43Packet *Am43Encoder::get_close_request() {
Am43Packet Am43Encoder::get_close_request() {
uint8_t data = 0xEE;
return this->encode_(CMD_SET_STATE, &data, 1);
return encode(CMD_SET_STATE, &data, 1);
}
Am43Packet *Am43Encoder::get_stop_request() {
Am43Packet Am43Encoder::get_stop_request() {
uint8_t data = 0xCC;
return this->encode_(CMD_SET_STATE, &data, 1);
return encode(CMD_SET_STATE, &data, 1);
}
Am43Packet *Am43Encoder::get_set_position_request(uint8_t position) {
return this->encode_(CMD_SET_POSITION, &position, 1);
}
Am43Packet Am43Encoder::get_set_position_request(uint8_t position) { return encode(CMD_SET_POSITION, &position, 1); }
void Am43Encoder::checksum_() {
uint8_t checksum = 0;
int i = 0;
for (i = 0; i < this->packet_.length; i++)
checksum = checksum ^ this->packet_.data[i];
this->packet_.data[i] = checksum ^ 0xff;
this->packet_.length++;
Am43Packet Am43Encoder::encode(uint8_t command, const uint8_t *data, uint8_t length) {
Am43Packet packet;
memcpy(packet.data, START_PACKET, sizeof(START_PACKET));
packet.data[5] = command;
packet.data[6] = length;
memcpy(&packet.data[7], data, length);
packet.length = length + 7;
// The device checks the inverted XOR of everything before it
packet.data[packet.length] = xor_bytes(packet.data, packet.length, 0xff);
packet.length++;
char hex_buf[format_hex_size(sizeof(packet.data))];
ESP_LOGV(TAG, "ENC(%d): 0x%s", packet.length, format_hex_to(hex_buf, packet.data, packet.length));
return packet;
}
Am43Packet *Am43Encoder::encode_(uint8_t command, uint8_t *data, uint8_t length) {
memcpy(this->packet_.data, START_PACKET, 5);
this->packet_.data[5] = command;
this->packet_.data[6] = length;
memcpy(&this->packet_.data[7], data, length);
this->packet_.length = length + 7;
this->checksum_();
char hex_buf[format_hex_size(sizeof(this->packet_.data))];
ESP_LOGV("am43", "ENC(%d): 0x%s", this->packet_.length,
format_hex_to(hex_buf, this->packet_.data, this->packet_.length));
return &this->packet_;
}
#define VERIFY_MIN_LENGTH(x) \
if (length < (x)) \
return;
void Am43Decoder::decode(const uint8_t *data, uint16_t length) {
// Reset so a decoder reused across frames reports only the latest one
this->has_battery_level_ = false;
this->has_light_level_ = false;
this->has_set_position_response_ = false;
this->has_set_state_response_ = false;
this->has_position_ = false;
this->has_pin_response_ = false;
char hex_buf[format_hex_size(24)]; // Max expected packet size
ESP_LOGV("am43", "DEC(%d): 0x%s", length, format_hex_to(hex_buf, data, length));
char hex_buf[format_hex_size(sizeof(Am43Packet::data))]; // Max expected packet size
ESP_LOGV(TAG, "DEC(%d): 0x%s", length, format_hex_to(hex_buf, data, length));
if (length < 2 || data[0] != 0x9a)
return;
switch (data[1]) {
case CMD_GET_BATTERY_LEVEL: {
VERIFY_MIN_LENGTH(8);
if (length < 8)
return;
this->battery_level_ = data[7];
this->has_battery_level_ = true;
break;
}
case CMD_GET_LIGHT_LEVEL: {
VERIFY_MIN_LENGTH(5);
if (length < 5)
return;
this->light_level_ = 100 * ((float) data[4] / 9);
this->has_light_level_ = true;
break;
}
case CMD_GET_POSITION: {
VERIFY_MIN_LENGTH(6);
if (length < 6)
return;
this->position_ = data[5];
this->has_position_ = true;
break;
}
case CMD_NOTIFY_POSITION: {
VERIFY_MIN_LENGTH(5);
if (length < 5)
return;
this->position_ = data[4];
this->has_position_ = true;
break;
}
case CMD_SEND_PIN: {
VERIFY_MIN_LENGTH(4);
if (length < 4)
return;
this->pin_ok_ = data[3] == RESPONSE_ACK;
this->has_pin_response_ = true;
break;
}
case CMD_SET_POSITION: {
VERIFY_MIN_LENGTH(4);
if (length < 4)
return;
this->set_position_ok_ = data[3] == RESPONSE_ACK;
this->has_set_position_response_ = true;
break;
}
case CMD_SET_STATE: {
VERIFY_MIN_LENGTH(4);
if (length < 4)
return;
this->set_state_ok_ = data[3] == RESPONSE_ACK;
this->has_set_state_response_ = true;
break;
@@ -131,6 +129,6 @@ void Am43Decoder::decode(const uint8_t *data, uint16_t length) {
default:
break;
}
};
}
} // namespace esphome::am43
+37 -39
View File
@@ -1,59 +1,57 @@
#pragma once
#include "esphome/core/helpers.h"
#include "esphome/core/log.h"
#include <cstdint>
namespace esphome::am43 {
static const uint16_t AM43_SERVICE_UUID = 0xFE50;
static const uint16_t AM43_CHARACTERISTIC_UUID = 0xFE51;
//
static constexpr uint16_t AM43_SERVICE_UUID = 0xFE50;
static constexpr uint16_t AM43_CHARACTERISTIC_UUID = 0xFE51;
// Tuya identifiers, only to detect and warn users as they are incompatible.
static const uint16_t AM43_TUYA_SERVICE_UUID = 0x1910;
static const uint16_t AM43_TUYA_CHARACTERISTIC_UUID = 0x2b11;
static constexpr uint16_t AM43_TUYA_SERVICE_UUID = 0x1910;
static constexpr uint16_t AM43_TUYA_CHARACTERISTIC_UUID = 0x2b11;
struct Am43Packet {
uint8_t length;
uint8_t data[24];
};
static const uint8_t CMD_GET_BATTERY_LEVEL = 0xA2;
static const uint8_t CMD_GET_LIGHT_LEVEL = 0xAA;
static const uint8_t CMD_GET_POSITION = 0xA7;
static const uint8_t CMD_SEND_PIN = 0x17;
static const uint8_t CMD_SET_STATE = 0x0A;
static const uint8_t CMD_SET_POSITION = 0x0D;
static const uint8_t CMD_NOTIFY_POSITION = 0xA1;
static constexpr uint8_t CMD_GET_BATTERY_LEVEL = 0xA2;
static constexpr uint8_t CMD_GET_LIGHT_LEVEL = 0xAA;
static constexpr uint8_t CMD_GET_POSITION = 0xA7;
static constexpr uint8_t CMD_SEND_PIN = 0x17;
static constexpr uint8_t CMD_SET_STATE = 0x0A;
static constexpr uint8_t CMD_SET_POSITION = 0x0D;
static constexpr uint8_t CMD_NOTIFY_POSITION = 0xA1;
static const uint8_t RESPONSE_ACK = 0x5A;
static const uint8_t RESPONSE_NACK = 0xA5;
static constexpr uint8_t RESPONSE_ACK = 0x5A;
static constexpr uint8_t RESPONSE_NACK = 0xA5;
/// Builds request packets; each returns a packet the caller sends from its own stack.
class Am43Encoder {
public:
Am43Packet *get_battery_level_request();
Am43Packet *get_light_level_request();
Am43Packet *get_position_request();
Am43Packet *get_send_pin_request(uint16_t pin);
Am43Packet *get_open_request();
Am43Packet *get_close_request();
Am43Packet *get_stop_request();
Am43Packet *get_set_position_request(uint8_t position);
static Am43Packet get_battery_level_request();
static Am43Packet get_light_level_request();
static Am43Packet get_position_request();
static Am43Packet get_send_pin_request(uint16_t pin);
static Am43Packet get_open_request();
static Am43Packet get_close_request();
static Am43Packet get_stop_request();
static Am43Packet get_set_position_request(uint8_t position);
protected:
void checksum_();
Am43Packet *encode_(uint8_t command, uint8_t *data, uint8_t length);
Am43Packet packet_;
static Am43Packet encode(uint8_t command, const uint8_t *data, uint8_t length);
};
/// Decodes one notification; construct it on the stack for each frame.
class Am43Decoder {
public:
void decode(const uint8_t *data, uint16_t length);
bool has_battery_level() { return this->has_battery_level_; }
bool has_light_level() { return this->has_light_level_; }
bool has_set_position_response() { return this->has_set_position_response_; }
bool has_set_state_response() { return this->has_set_state_response_; }
bool has_position() { return this->has_position_; }
bool has_pin_response() { return this->has_pin_response_; }
bool has_battery_level() const { return this->has_battery_level_; }
bool has_light_level() const { return this->has_light_level_; }
bool has_set_position_response() const { return this->has_set_position_response_; }
bool has_set_state_response() const { return this->has_set_state_response_; }
bool has_position() const { return this->has_position_; }
bool has_pin_response() const { return this->has_pin_response_; }
union {
uint8_t position_;
@@ -65,12 +63,12 @@ class Am43Decoder {
};
protected:
bool has_battery_level_;
bool has_light_level_;
bool has_set_position_response_;
bool has_set_state_response_;
bool has_position_;
bool has_pin_response_;
bool has_battery_level_{false};
bool has_light_level_{false};
bool has_set_position_response_{false};
bool has_set_state_response_{false};
bool has_position_{false};
bool has_pin_response_{false};
};
} // namespace esphome::am43
+27 -47
View File
@@ -17,25 +17,12 @@ void Am43Component::dump_config() {
this->pin_, (int) this->invert_position_);
}
void Am43Component::setup() {
this->position = COVER_OPEN;
this->encoder_ = make_unique<Am43Encoder>();
this->decoder_ = make_unique<Am43Decoder>();
this->logged_in_ = false;
}
void Am43Component::setup() { this->position = COVER_OPEN; }
void Am43Component::loop() {
if (this->node_state == espbt::ClientState::ESTABLISHED && !this->logged_in_) {
auto *packet = this->encoder_->get_send_pin_request(this->pin_);
auto status =
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
packet->length, packet->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
ESP_LOGI(TAG, "[%s] Logging into AM43", LOG_STR_ARG(this->get_log_name()));
if (status) {
ESP_LOGW(TAG, "[%s] Error writing set_pin to device, error = %d", LOG_STR_ARG(this->get_log_name()), status);
} else {
this->logged_in_ = true;
}
this->logged_in_ = this->write_packet_(Am43Encoder::get_send_pin_request(this->pin_), LOG_STR("set_pin"));
}
}
@@ -53,29 +40,15 @@ void Am43Component::control(const CoverCall &call) {
ESP_LOGW(TAG, "[%s] Cannot send cover control, not connected", LOG_STR_ARG(this->get_log_name()));
return;
}
if (call.get_stop()) {
auto *packet = this->encoder_->get_stop_request();
auto status =
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
packet->length, packet->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] Error writing stop command to device, error = %d", LOG_STR_ARG(this->get_log_name()), status);
}
}
if (call.get_stop())
this->write_packet_(Am43Encoder::get_stop_request(), LOG_STR("stop"));
auto opt_pos = call.get_position();
if (opt_pos.has_value()) {
auto pos = *opt_pos;
if (this->invert_position_)
pos = 1 - pos;
auto *packet = this->encoder_->get_set_position_request(100 - (uint8_t) (pos * 100));
auto status =
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
packet->length, packet->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] Error writing set_position command to device, error = %d", LOG_STR_ARG(this->get_log_name()),
status);
}
this->write_packet_(Am43Encoder::get_set_position_request(100 - (uint8_t) (pos * 100)), LOG_STR("set_position"));
}
}
@@ -113,10 +86,11 @@ void Am43Component::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_
case ESP_GATTC_NOTIFY_EVT: {
if (param->notify.handle != this->char_handle_)
break;
this->decoder_->decode(param->notify.value, param->notify.value_len);
Am43Decoder decoder;
decoder.decode(param->notify.value, param->notify.value_len);
if (this->decoder_->has_position()) {
this->position = ((float) this->decoder_->position_ / 100.0f);
if (decoder.has_position()) {
this->position = ((float) decoder.position_ / 100.0f);
if (!this->invert_position_)
this->position = 1 - this->position;
if (this->position > 0.97f)
@@ -126,27 +100,20 @@ void Am43Component::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_
this->publish_state();
}
if (this->decoder_->has_pin_response()) {
if (this->decoder_->pin_ok_) {
if (decoder.has_pin_response()) {
if (decoder.pin_ok_) {
ESP_LOGI(TAG, "[%s] AM43 pin accepted.", LOG_STR_ARG(this->get_log_name()));
auto *packet = this->encoder_->get_position_request();
auto status = esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(),
this->char_handle_, packet->length, packet->data,
ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] Error writing set_position to device, error = %d", LOG_STR_ARG(this->get_log_name()),
status);
}
this->write_packet_(Am43Encoder::get_position_request(), LOG_STR("get_position"));
} else {
ESP_LOGW(TAG, "[%s] AM43 pin rejected!", LOG_STR_ARG(this->get_log_name()));
}
}
if (this->decoder_->has_set_position_response() && !this->decoder_->set_position_ok_) {
if (decoder.has_set_position_response() && !decoder.set_position_ok_) {
ESP_LOGW(TAG, "[%s] Got nack after sending set_position. Bad pin?", LOG_STR_ARG(this->get_log_name()));
}
if (this->decoder_->has_set_state_response() && !this->decoder_->set_state_ok_) {
if (decoder.has_set_state_response() && !decoder.set_state_ok_) {
ESP_LOGW(TAG, "[%s] Got nack after sending set_state. Bad pin?", LOG_STR_ARG(this->get_log_name()));
}
break;
@@ -156,6 +123,19 @@ void Am43Component::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_
}
}
bool Am43Component::write_packet_(const Am43Packet &packet, const LogString *what) {
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-const-cast) the IDF API takes a mutable buffer it only reads
auto status = esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(),
this->char_handle_, packet.length, const_cast<uint8_t *>(packet.data),
ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] Error writing %s to device, error = %d", LOG_STR_ARG(this->get_log_name()), LOG_STR_ARG(what),
status);
return false;
}
return true;
}
} // namespace esphome::am43
#endif
+6 -8
View File
@@ -27,14 +27,12 @@ class Am43Component final : public cover::Cover, public esphome::ble_client::BLE
protected:
void control(const cover::CoverCall &call) override;
uint16_t char_handle_;
uint16_t pin_;
bool invert_position_;
std::unique_ptr<Am43Encoder> encoder_;
std::unique_ptr<Am43Decoder> decoder_;
bool logged_in_;
float position_;
/// Writes a request to the control characteristic; logs and returns false on failure.
bool write_packet_(const Am43Packet &packet, const LogString *what);
uint16_t char_handle_{0};
uint16_t pin_{0};
bool invert_position_{false};
bool logged_in_{false};
};
} // namespace esphome::am43
+20 -39
View File
@@ -14,24 +14,9 @@ void Am43::dump_config() {
LOG_SENSOR(" ", "Illuminance", this->illuminance_);
}
void Am43::setup() {
this->encoder_ = make_unique<Am43Encoder>();
this->decoder_ = make_unique<Am43Decoder>();
this->logged_in_ = false;
this->last_battery_update_ = 0;
this->current_sensor_ = 0;
}
void Am43::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) {
switch (event) {
case ESP_GATTC_OPEN_EVT: {
if (param->open.status == ESP_GATT_OK) {
this->logged_in_ = false;
}
break;
}
case ESP_GATTC_DISCONNECT_EVT: {
this->logged_in_ = false;
this->node_state = espbt::ClientState::IDLE;
if (this->battery_ != nullptr)
this->battery_->publish_state(NAN);
@@ -60,28 +45,21 @@ void Am43::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_i
case ESP_GATTC_NOTIFY_EVT: {
if (param->notify.handle != this->char_handle_)
break;
this->decoder_->decode(param->notify.value, param->notify.value_len);
Am43Decoder decoder;
decoder.decode(param->notify.value, param->notify.value_len);
if (this->battery_ != nullptr && this->decoder_->has_battery_level() &&
millis() - this->last_battery_update_ > 10000) {
this->battery_->publish_state(this->decoder_->battery_level_);
if (this->battery_ != nullptr && decoder.has_battery_level() && millis() - this->last_battery_update_ > 10000) {
this->battery_->publish_state(decoder.battery_level_);
this->last_battery_update_ = millis();
}
if (this->illuminance_ != nullptr && this->decoder_->has_light_level()) {
this->illuminance_->publish_state(this->decoder_->light_level_);
if (this->illuminance_ != nullptr && decoder.has_light_level()) {
this->illuminance_->publish_state(decoder.light_level_);
}
if (this->current_sensor_ > 0) {
if (this->illuminance_ != nullptr) {
auto *packet = this->encoder_->get_light_level_request();
auto status = esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(),
this->char_handle_, packet->length, packet->data,
ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
}
}
if (this->illuminance_ != nullptr)
this->write_packet_(Am43Encoder::get_light_level_request());
this->current_sensor_ = 0;
}
break;
@@ -97,19 +75,22 @@ void Am43::update() {
return;
}
if (this->current_sensor_ == 0) {
if (this->battery_ != nullptr) {
auto *packet = this->encoder_->get_battery_level_request();
auto status =
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
packet->length, packet->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
}
}
if (this->battery_ != nullptr)
this->write_packet_(Am43Encoder::get_battery_level_request());
this->current_sensor_++;
}
}
void Am43::write_packet_(const Am43Packet &packet) {
// NOLINTNEXTLINE(cppcoreguidelines-pro-type-const-cast) the IDF API takes a mutable buffer it only reads
auto status = esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(),
this->char_handle_, packet.length, const_cast<uint8_t *>(packet.data),
ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
if (status) {
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
}
}
} // namespace esphome::am43
#endif
+5 -7
View File
@@ -16,7 +16,6 @@ namespace espbt = esphome::esp32_ble_tracker;
class Am43 final : public esphome::ble_client::BLEClientNode, public PollingComponent {
public:
void setup() override;
void update() override;
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
esp_ble_gattc_cb_param_t *param) override;
@@ -25,16 +24,15 @@ class Am43 final : public esphome::ble_client::BLEClientNode, public PollingComp
void set_illuminance(sensor::Sensor *illuminance) { illuminance_ = illuminance; }
protected:
uint16_t char_handle_;
std::unique_ptr<Am43Encoder> encoder_;
std::unique_ptr<Am43Decoder> decoder_;
bool logged_in_;
/// Writes a request to the control characteristic; logs on failure.
void write_packet_(const Am43Packet &packet);
sensor::Sensor *battery_{nullptr};
sensor::Sensor *illuminance_{nullptr};
uint8_t current_sensor_;
// The AM43 often gets into a state where it spams loads of battery update
// notifications. Here we will limit to no more than every 10s.
uint32_t last_battery_update_;
uint32_t last_battery_update_{0};
uint16_t char_handle_{0};
uint8_t current_sensor_{0};
};
} // namespace esphome::am43
+5
View File
@@ -1 +1,6 @@
DOMAIN = "as7341"
DEPRECATED_COMPONENT = """
The 'as7341' component is deprecated in favour of 'as734x', which covers the AS7341, AS7343 and TCS3448.
New features and fixes should target 'as734x'. It will be removed in ESPHome 2027.5.0.
"""
+2 -2
View File
@@ -110,12 +110,12 @@ bool AS7341Component::read_channels(uint16_t *data) {
this->set_smux_low_channels(true);
this->enable_spectral_measurement(true);
this->wait_for_data();
bool low_success = this->read_bytes_16(AS7341_CH0_DATA_L, data, 6);
bool low_success = this->read_bytes_16_le(AS7341_CH0_DATA_L, data, 6);
this->set_smux_low_channels(false);
this->enable_spectral_measurement(true);
this->wait_for_data();
bool high_sucess = this->read_bytes_16(AS7341_CH0_DATA_L, &data[6], 6);
bool high_sucess = this->read_bytes_16_le(AS7341_CH0_DATA_L, &data[6], 6);
return low_success && high_sucess;
}
+10
View File
@@ -1,3 +1,5 @@
import logging
import esphome.codegen as cg
from esphome.components import i2c, sensor
from esphome.components.const import UNIT_COUNTS
@@ -11,6 +13,8 @@ from esphome.const import (
)
from esphome.types import ConfigType
_LOGGER = logging.getLogger(__name__)
CODEOWNERS = ["@mrgnr"]
DEPENDENCIES = ["i2c"]
@@ -96,6 +100,12 @@ SENSORS = {
async def to_code(config: ConfigType) -> None:
# Remove before 2027.5.0
_LOGGER.warning(
"The 'as7341' component is deprecated and will be removed in ESPHome 2027.5.0, migrate to an "
"'as734x:' hub with 'type: AS7341' and a 'sensor:' entry with 'platform: as734x' and the bands "
"under 'counts:'."
)
var = await i2c.new_i2c_component(config)
cg.add(var.set_gain(config[CONF_GAIN]))
+6 -2
View File
@@ -92,7 +92,7 @@ void BQ25186Component::setup() {
// The poll below puts the pin in output mode; without a restore mode the switch takes its level from it
auto initial = this->pg_gpo_switch_->get_initial_state_with_restore_mode();
if (initial.has_value())
this->pg_gpo_switch_->publish_state(*initial); // the first poll writes it to the pin
this->pg_gpo_switch_->publish_state(*initial != this->pg_gpo_switch_->is_inverted()); // the first poll writes it
}
#endif
// The poller first runs after a random share of the interval; the entities get a state now
@@ -112,7 +112,11 @@ void BQ25186Component::check_pg_gpo_(const BQ25186StatusRegisters &status, bool
const bool level = (status[BQ25186_REG_SYS_REG] & BQ25186_SYS_REG_PG_GPO_LEVEL) != 0;
if (!this->pg_gpo_switch_->has_state()) {
this->pg_gpo_switch_->publish_state(level);
} else if (level != this->pg_gpo_switch_->state && !this->write_pg_gpo_level(this->pg_gpo_switch_->state)) {
return;
}
// state is what the switch shows; an inverted switch drives the opposite level
const bool wanted = this->pg_gpo_switch_->state != this->pg_gpo_switch_->is_inverted();
if (level != wanted && !this->write_pg_gpo_level(wanted)) {
this->status_set_warning(LOG_STR("PG/GPO level write failed"));
pending = true;
}
+3
View File
@@ -19,6 +19,7 @@ CONF_BITRATE = "bitrate"
CONF_BLUE_CHANNEL = "blue_channel"
CONF_BORDER_ROUTER = "border_router"
CONF_BREATH_VOC_EQUIVALENT = "breath_voc_equivalent"
CONF_BUTTONS = "buttons"
CONF_BYTE_ORDER = "byte_order"
CONF_CHANNEL_COLORS = "channel_colors"
CONF_CLEAR_CHANNEL = "clear_channel"
@@ -31,6 +32,7 @@ CONF_CONVERSION_RATE = "conversion_rate"
CONF_CRC_ENABLE = "crc_enable"
CONF_DATA_BITS = "data_bits"
CONF_DESCRIPTION = "description"
CONF_DEVICE_TYPE = "device_type"
CONF_DRAW_ROUNDING = "draw_rounding"
CONF_DRIVE_STRENGTH = "drive_strength"
CONF_DTR_PIN = "dtr_pin"
@@ -53,6 +55,7 @@ CONF_LIBRETINY = "libretiny"
CONF_LOOP = "loop"
CONF_MANUFACTURER = "manufacturer"
CONF_MAX_PACKET_SIZE = "max_packet_size"
CONF_MODEM = "modem"
CONF_MODULATION = "modulation"
CONF_NOX_INDEX = "nox_index"
CONF_ON_PACKET = "on_packet"
@@ -60,11 +60,9 @@ void DeepSleepComponent::begin_sleep(bool manual) {
}
if (this->should_teardown_()) {
App.run_safe_shutdown_hooks();
// It's critical to teardown components cleanly for deep sleep to ensure
// Home Assistant sees a clean disconnect instead of marking the device unavailable
App.teardown_components(TEARDOWN_TIMEOUT_DEEP_SLEEP_MS);
App.run_powerdown_hooks();
App.safe_shutdown(TEARDOWN_TIMEOUT_DEEP_SLEEP_MS);
}
this->deep_sleep_();
+1 -1
View File
@@ -18,6 +18,7 @@ from esphome.components import (
text_sensor,
valve,
)
from esphome.components.const import CONF_BUTTONS
import esphome.config_validation as cv
from esphome.const import (
CONF_ACCURACY_DECIMALS,
@@ -167,7 +168,6 @@ VALVE_TYPES = {
CONF_ALARM_CONTROL_PANELS = "alarm_control_panels"
CONF_BUTTONS = "buttons"
CONF_CLIMATES = "climates"
CONF_COVERS = "covers"
CONF_DATETIMES = "datetimes"
+1
View File
@@ -0,0 +1 @@
DOMAIN = "es7243"
+52
View File
@@ -0,0 +1,52 @@
import esphome.codegen as cg
from esphome.components import i2c
from esphome.components.audio_adc import AudioAdc
from esphome.components.i2s_audio import (
CONF_I2S_AUDIO_ID,
CONF_I2S_MCLK_PIN,
I2SAudioComponent,
)
import esphome.config_validation as cv
from esphome.const import CONF_MIC_GAIN
import esphome.final_validate as fv
from esphome.types import ConfigType
CODEOWNERS = ["@Chorty"]
DEPENDENCIES = ["i2c", "i2s_audio"]
es7243_ns = cg.esphome_ns.namespace("es7243")
ES7243 = es7243_ns.class_("ES7243", AudioAdc, cg.Component, i2c.I2CDevice)
# Gains the chip's register 0x08 can express, from the ESP-ADF es7243 driver
ES7243_MIC_GAINS = [1, 3.5, 18, 20.5, 22.5, 24.5, 25, 27]
CONFIG_SCHEMA = (
cv.Schema(
{
cv.GenerateID(): cv.declare_id(ES7243),
cv.GenerateID(CONF_I2S_AUDIO_ID): cv.use_id(I2SAudioComponent),
cv.Optional(CONF_MIC_GAIN, default="27db"): cv.All(
cv.decibel, cv.one_of(*ES7243_MIC_GAINS)
),
}
)
.extend(cv.COMPONENT_SCHEMA)
.extend(i2c.i2c_device_schema(0x13))
)
def _validate_mclk_pin(config: ConfigType) -> None:
"""The chip only answers on I2C after it has seen MCLK, so the bus must drive that pin."""
i2s_id = config[CONF_I2S_AUDIO_ID]
if CONF_I2S_MCLK_PIN not in fv.get_declaring_config(i2s_id):
raise cv.Invalid(f"es7243 needs {CONF_I2S_MCLK_PIN} on i2s_audio {i2s_id}")
FINAL_VALIDATE_SCHEMA = _validate_mclk_pin
async def to_code(config: ConfigType) -> None:
i2s = await cg.get_variable(config[CONF_I2S_AUDIO_ID])
var = await i2c.new_i2c_component(config, i2s)
cg.add(var.set_mic_gain(config[CONF_MIC_GAIN]))
+89
View File
@@ -0,0 +1,89 @@
#include "es7243.h"
#ifdef USE_ESP32
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
#include <driver/gpio.h>
#include <cmath>
namespace esphome::es7243 {
ESPHOME_LOG_TAG(TAG, "es7243");
// Register map from the ES7243 datasheet
static constexpr uint8_t REG_MODE_CONFIG = 0x00;
static constexpr uint8_t REG_SDP_FORMAT = 0x01;
static constexpr uint8_t REG_MUTE_CONTROL = 0x05;
static constexpr uint8_t REG_STATE_CONTROL = 0x06;
static constexpr uint8_t REG_GAIN = 0x08; // ANACTRL1
static constexpr uint8_t MCLK_PULSES = 20;
struct GainEntry {
float db;
uint8_t reg;
};
// Register 0x08 values for each gain, from the ESP-ADF es7243 driver
static constexpr GainEntry GAIN_TABLE[] = {
{1.0f, 0x11}, {3.5f, 0x13}, {18.0f, 0x21}, {20.5f, 0x23},
{22.5f, 0x06}, {24.5f, 0x41}, {25.0f, 0x07}, {27.0f, 0x43},
};
static constexpr uint8_t GAIN_COUNT = sizeof(GAIN_TABLE) / sizeof(GAIN_TABLE[0]);
// The table entry nearest the requested gain; values outside the table snap to its ends
static uint8_t nearest_gain_index(float gain_db) {
uint8_t best = 0;
for (uint8_t i = 1; i < GAIN_COUNT; i++) {
if (std::fabs(gain_db - GAIN_TABLE[i].db) < std::fabs(gain_db - GAIN_TABLE[best].db))
best = i;
}
return best;
}
void ES7243::setup() {
// The chip ignores I2C until it has seen MCLK, so pulse the pin before the I2S peripheral takes it over
const gpio_num_t mclk = this->i2s_->get_pin_config().mclk;
gpio_reset_pin(mclk);
gpio_set_direction(mclk, GPIO_MODE_OUTPUT);
for (uint8_t i = 0; i < MCLK_PULSES; i++) {
gpio_set_level(mclk, 0);
delay(1);
gpio_set_level(mclk, 1);
delay(1);
}
// The ESP-ADF sequence: mute while the format and gain are set, then unmute
const bool ok = this->write_byte(REG_MODE_CONFIG, 0x01) && this->write_byte(REG_STATE_CONTROL, 0x00) &&
this->write_byte(REG_MUTE_CONTROL, 0x1B) && this->write_byte(REG_SDP_FORMAT, 0x0C) &&
this->write_mic_gain_() && this->write_byte(REG_MUTE_CONTROL, 0x13);
if (!ok) {
this->mark_failed(LOG_STR(ESP_LOG_MSG_COMM_FAIL));
return;
}
this->setup_complete_ = true;
}
void ES7243::dump_config() {
ESP_LOGCONFIG(TAG,
"ES7243 audio ADC:\n"
" Mic gain: %.1f dB",
this->mic_gain());
LOG_I2C_DEVICE(this);
}
float ES7243::mic_gain() { return GAIN_TABLE[this->gain_index_].db; }
bool ES7243::set_mic_gain(float mic_gain) {
this->gain_index_ = nearest_gain_index(mic_gain);
if (!this->setup_complete_)
return true;
return this->status_comm_result(this->write_mic_gain_());
}
bool ES7243::write_mic_gain_() { return this->write_byte(REG_GAIN, GAIN_TABLE[this->gain_index_].reg); }
} // namespace esphome::es7243
#endif // USE_ESP32
+36
View File
@@ -0,0 +1,36 @@
#pragma once
#ifdef USE_ESP32
#include "esphome/components/audio_adc/audio_adc.h"
#include "esphome/components/i2c/i2c.h"
#include "esphome/components/i2s_audio/i2s_audio.h"
#include "esphome/core/component.h"
namespace esphome::es7243 {
/// ES7243 microphone ADC. Not the ES7243E, which has a different register map and its own platform.
/// Register sequence from the ESP-ADF es7243 driver.
class ES7243 final : public audio_adc::AudioAdc, public Component, public i2c::I2CDevice {
public:
explicit ES7243(const i2s_audio::I2SAudioComponent *i2s) : i2s_(i2s) {}
void setup() override;
void dump_config() override;
// Before i2s_audio (DATA) routes the MCLK pin to the I2S peripheral, after the I2C bus
float get_setup_priority() const override { return setup_priority::HARDWARE; }
bool set_mic_gain(float mic_gain) override;
float mic_gain() override;
protected:
bool write_mic_gain_();
const i2s_audio::I2SAudioComponent *i2s_;
uint8_t gain_index_{0}; // into GAIN_TABLE in the .cpp
bool setup_complete_{false};
};
} // namespace esphome::es7243
#endif // USE_ESP32
+3 -1
View File
@@ -289,7 +289,9 @@ async def to_code(config: ConfigType) -> None:
)
if config[CONF_USE_PSRAM]:
esp32.add_idf_sdkconfig_option("CONFIG_EH_HOST_PORT_DMA_PREFER_SPIRAM", True)
esp32.add_idf_sdkconfig_option("CONFIG_ESP_HOSTED_DFLT_TASK_FROM_SPIRAM", True)
# Task stacks in PSRAM corrupt the heap on esp_hosted 3.0.10
# (esp-hosted-mcu#254); revisit with the next esp_hosted release
esp32.add_idf_sdkconfig_option("CONFIG_ESP_HOSTED_DFLT_TASK_FROM_SPIRAM", False)
# ESP-NOW-over-hosted shim: only the radio-less ESP32-P4 host needs it (see
# the note by _MAX_CUSTOM_MSG_HANDLERS). Enabled for every P4 host, not
@@ -17,16 +17,20 @@ void IPAddressEthernetInfo::on_ip_state(const network::IPAddresses &ips, const n
char buf[network::IP_ADDRESS_BUFFER_SIZE];
ips[0].str_to(buf);
this->publish_state(buf);
#ifdef ETHERNET_INFO_IP_SENSOR_COUNT
uint8_t sensor = 0;
for (const auto &ip : ips) {
if (ip.is_set()) {
if (this->ip_sensors_[sensor] != nullptr) {
ip.str_to(buf);
this->ip_sensors_[sensor]->publish_state(buf);
}
sensor++;
if (!ip.is_set())
continue;
if (sensor == ETHERNET_INFO_IP_SENSOR_COUNT)
break;
if (this->ip_sensors_[sensor] != nullptr) {
ip.str_to(buf);
this->ip_sensors_[sensor]->publish_state(buf);
}
sensor++;
}
#endif
}
void DNSAddressEthernetInfo::setup() { ethernet::global_eth_component->add_ip_state_listener(this); }
@@ -18,14 +18,19 @@ class IPAddressEthernetInfo final : public Component,
void setup() override;
void dump_config() override;
#ifdef ETHERNET_INFO_IP_SENSOR_COUNT
void add_ip_sensors(uint8_t index, text_sensor::TextSensor *s) { this->ip_sensors_[index] = s; }
#endif
// EthernetIPStateListener interface
void on_ip_state(const network::IPAddresses &ips, const network::IPAddress &dns1,
const network::IPAddress &dns2) override;
protected:
std::array<text_sensor::TextSensor *, 5> ip_sensors_{};
#ifdef ETHERNET_INFO_IP_SENSOR_COUNT
// Sized to the highest configured address_N
std::array<text_sensor::TextSensor *, ETHERNET_INFO_IP_SENSOR_COUNT> ip_sensors_{};
#endif
};
class DNSAddressEthernetInfo final : public Component,
@@ -12,6 +12,7 @@ from esphome.types import ConfigType
DEPENDENCIES = ["ethernet"]
ethernet_info_ns = cg.esphome_ns.namespace("ethernet_info")
_request_ip_sensor_slot = cg.slot_counter("ETHERNET_INFO_IP_SENSOR_COUNT")
IPAddressEthernetInfo = ethernet_info_ns.class_(
"IPAddressEthernetInfo", text_sensor.TextSensor, cg.Component
@@ -57,10 +58,13 @@ async def to_code(config: ConfigType) -> None:
if conf := config.get(CONF_IP_ADDRESS):
ip_info = await text_sensor.new_text_sensor(config[CONF_IP_ADDRESS])
await cg.register_component(ip_info, config[CONF_IP_ADDRESS])
for x in range(5):
if sensor_conf := conf.get(f"address_{x}"):
sens = await text_sensor.new_text_sensor(sensor_conf)
cg.add(ip_info.add_ip_sensors(x, sens))
indexes = [x for x in range(5) if f"address_{x}" in conf]
# One shared array size: the largest highest index of any entry, so add_ip_sensors(x) stays in range
for _ in range(max(indexes, default=-1) + 1):
_request_ip_sensor_slot(str(ip_info))
for x in indexes:
sens = await text_sensor.new_text_sensor(conf[f"address_{x}"])
cg.add(ip_info.add_ip_sensors(x, sens))
if conf := config.get(CONF_DNS_ADDRESS):
dns_info = await text_sensor.new_text_sensor(conf)
await cg.register_component(dns_info, conf)
Loaded 100 of 252 files, more files were not shown because too many files have changed in this diff. Show more