mirror of
https://github.com/esphome/esphome.git
synced 2026-11-18 02:55:59 +00:00
Compare commits
289
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
07c5ef5c2c | ||
|
|
75ba3cbbae | ||
|
|
da6686fe83 | ||
|
|
e988dbd872 | ||
|
|
6d5d793986 | ||
|
|
1263a56c52 | ||
|
|
8f07b49fd9 | ||
|
|
75c3e8e00c | ||
|
|
7d697a8a62 | ||
|
|
b75b3e2bef | ||
|
|
144c799cf5 | ||
|
|
61cce92aaa | ||
|
|
38c1646870 | ||
|
|
b60c2864ef | ||
|
|
db0121bc21 | ||
|
|
be8f6c5e41 | ||
|
|
b621332de5 | ||
|
|
982cbba291 | ||
|
|
a2ac68faac | ||
|
|
731f6e2722 | ||
|
|
598d87836c | ||
|
|
e852e15ca3 | ||
|
|
6b82e127fe | ||
|
|
17baeae3ea | ||
|
|
bc57ad5c87 | ||
|
|
0c1606d3b8 | ||
|
|
a155401afc | ||
|
|
e3bfffc8ab | ||
|
|
9f5ca49e2f | ||
|
|
94cb20d9e1 | ||
|
|
82f2203cc3 | ||
|
|
23a83a9f3d | ||
|
|
59f6affb51 | ||
|
|
4a02a0d4ba | ||
|
|
85f0011e6b | ||
|
|
b617926576 | ||
|
|
34881c3e3c | ||
|
|
71f55f270e | ||
|
|
1a9cce8bb8 | ||
|
|
b6c5a6e7c2 | ||
|
|
149b9280eb | ||
|
|
7a09548cdc | ||
|
|
1a07f39062 | ||
|
|
4c99a0f1ed | ||
|
|
875b8faf43 | ||
|
|
47b27a93a6 | ||
|
|
3c8940bfef | ||
|
|
4886238892 | ||
|
|
d611d9a3ca | ||
|
|
aa2a31647d | ||
|
|
f18de29d20 | ||
|
|
4eb24d78b0 | ||
|
|
1658efa9e7 | ||
|
|
feebc28853 | ||
|
|
86385ea2fe | ||
|
|
9bee9629c6 | ||
|
|
422ba0662e | ||
|
|
4b4d787884 | ||
|
|
34d68a0fa0 | ||
|
|
7caa7de696 | ||
|
|
9b23184e10 | ||
|
|
2f9abefe3f | ||
|
|
84079c07e2 | ||
|
|
110f854246 | ||
|
|
b7dbf17469 | ||
|
|
b91750c325 | ||
|
|
6c5bdd9251 | ||
|
|
92d2a457fa | ||
|
|
be41bc41e4 | ||
|
|
c0cf8f6b19 | ||
|
|
49d1f61df7 | ||
|
|
95c67a5523 | ||
|
|
8045a11909 | ||
|
|
208d0021a9 | ||
|
|
1da90be339 | ||
|
|
4b48ff0255 | ||
|
|
fed2b2995e | ||
|
|
ae48c7ab4c | ||
|
|
6f6e34ca40 | ||
|
|
0561d90334 | ||
|
|
78ef1fd104 | ||
|
|
a6bca49020 | ||
|
|
2e68c56908 | ||
|
|
a1fecebb09 | ||
|
|
32b9d4cbe7 | ||
|
|
c53401a28d | ||
|
|
6b7d17c762 | ||
|
|
93a3306d82 | ||
|
|
54d3477240 | ||
|
|
5f9d83d293 | ||
|
|
43864283b4 | ||
|
|
4efbb38b86 | ||
|
|
045374965f | ||
|
|
39a939720f | ||
|
|
a79e51e784 | ||
|
|
517f0d6d48 | ||
|
|
1327d0ddc5 | ||
|
|
2adb544e7a | ||
|
|
48905beb96 | ||
|
|
ed401814bf | ||
|
|
0245db6285 | ||
|
|
07ee0f9f04 | ||
|
|
3d34ad572b | ||
|
|
5c9033e04d | ||
|
|
e91934e4bd | ||
|
|
602cbff184 | ||
|
|
da274f92d3 | ||
|
|
c6f330458a | ||
|
|
dbb4ba769a | ||
|
|
0eb4a09935 | ||
|
|
ed9e5cff58 | ||
|
|
7acd023079 | ||
|
|
5623a5d511 | ||
|
|
4f8c2239dd | ||
|
|
07bbad4061 | ||
|
|
1cd99ce6d6 | ||
|
|
91db9d86d0 | ||
|
|
2f900f23d7 | ||
|
|
373224c141 | ||
|
|
1dff22f578 | ||
|
|
c2eb540b37 | ||
|
|
fad21e3f14 | ||
|
|
904f0df920 | ||
|
|
7128d22f07 | ||
|
|
825e2c3dd0 | ||
|
|
eebe66da62 | ||
|
|
c032f58c6c | ||
|
|
ff3adb407e | ||
|
|
dcf3a6eb6e | ||
|
|
afbc7151d3 | ||
|
|
37b95ff544 | ||
|
|
6c556c178a | ||
|
|
9f197ca8d7 | ||
|
|
c2e8c872b1 | ||
|
|
9620899479 | ||
|
|
2a6a1a050e | ||
|
|
6a743eca57 | ||
|
|
46844d3631 | ||
|
|
8cad9c4035 | ||
|
|
76ff2d6c0f | ||
|
|
8b7d68b80f | ||
|
|
d40b7b12d5 | ||
|
|
32ac9f17f1 | ||
|
|
eee52fe419 | ||
|
|
915b75dcb8 | ||
|
|
df83d20fdc | ||
|
|
63decb1d68 | ||
|
|
5a04f4949a | ||
|
|
cc6db898e0 | ||
|
|
f6fa1d8e9e | ||
|
|
1442554df2 | ||
|
|
dceba4fa3b | ||
|
|
54f2f25f2d | ||
|
|
9245f20b31 | ||
|
|
483a4f6a73 | ||
|
|
2ef4e52637 | ||
|
|
122df49ef5 | ||
|
|
e96345f5dc | ||
|
|
4d758269a1 | ||
|
|
43d61df1fc | ||
|
|
9843763917 | ||
|
|
0b0b9033e5 | ||
|
|
deeb88a835 | ||
|
|
4d04cd6938 | ||
|
|
eef2ddca0d | ||
|
|
2bfa9d1524 | ||
|
|
610c9faca6 | ||
|
|
d09867c27e | ||
|
|
20d34660b8 | ||
|
|
c894b4514d | ||
|
|
e347dd957b | ||
|
|
2e60fa0f42 | ||
|
|
7684ccee06 | ||
|
|
dccb81b319 | ||
|
|
cdafeb5734 | ||
|
|
b09d62e6a3 | ||
|
|
c4a7b75596 | ||
|
|
2d0c1b07ec | ||
|
|
f216936fdd | ||
|
|
0240f57069 | ||
|
|
3248eeaf1f | ||
|
|
a2ccd64257 | ||
|
|
c22a7a4188 | ||
|
|
b03870b551 | ||
|
|
6e9b37ca0d | ||
|
|
f695f41a3d | ||
|
|
909ffd7313 | ||
|
|
4a965b8b32 | ||
|
|
d826a19eb1 | ||
|
|
fb54ec51c1 | ||
|
|
04b6c0d4ca | ||
|
|
abf282dd08 | ||
|
|
e097958ad9 | ||
|
|
8a8ad4d8da | ||
|
|
09b82388c9 | ||
|
|
ea5407925a | ||
|
|
97732df3a5 | ||
|
|
04482ae0d4 | ||
|
|
ca0dd8e292 | ||
|
|
e75ac64cc9 | ||
|
|
212c0c1ea4 | ||
|
|
3e2f9bf296 | ||
|
|
b997866e86 | ||
|
|
ae89db98e4 | ||
|
|
e9bb102c1f | ||
|
|
e95c1143af | ||
|
|
0d7a4bd87e | ||
|
|
bf6b0fd352 | ||
|
|
b273dfb829 | ||
|
|
0b6a78d206 | ||
|
|
0cf1bad9a7 | ||
|
|
9f74fcb820 | ||
|
|
666c60b158 | ||
|
|
408a24b6a5 | ||
|
|
047ff1aa15 | ||
|
|
e602b7aa53 | ||
|
|
4f1e2da537 | ||
|
|
e3c0ddb5df | ||
|
|
c8d038eada | ||
|
|
01d9547700 | ||
|
|
9c6fb6830d | ||
|
|
3919f4fcbc | ||
|
|
f544ac247b | ||
|
|
12f88f72bb | ||
|
|
f88f254ba0 | ||
|
|
10b503cb07 | ||
|
|
9aee2ea1ef | ||
|
|
434ba13986 | ||
|
|
f4c5d5f818 | ||
|
|
cfb76b1bc4 | ||
|
|
74dee7dd17 | ||
|
|
e0790a9063 | ||
|
|
9b26a15960 | ||
|
|
75b586fb57 | ||
|
|
6d95112b77 | ||
|
|
ff3075cb26 | ||
|
|
40a226f3fd | ||
|
|
182db18dd9 | ||
|
|
2a14d1375b | ||
|
|
8e0cb460ea | ||
|
|
ea5c8a2fbc | ||
|
|
4a6e43f9b3 | ||
|
|
8c2841d6f4 | ||
|
|
ac0dc6fe2e | ||
|
|
dc0cb537cc | ||
|
|
c3c4d70e0e | ||
|
|
f00fa15b54 | ||
|
|
34c4898771 | ||
|
|
19a332507d | ||
|
|
f71fcc1739 | ||
|
|
36fd800c83 | ||
|
|
3a3c390621 | ||
|
|
29875a9e03 | ||
|
|
9abc1812d9 | ||
|
|
a9c3c6d8d0 | ||
|
|
b03e03e465 | ||
|
|
6b2a9870d0 | ||
|
|
da06b29845 | ||
|
|
629dfe1c9a | ||
|
|
354f844843 | ||
|
|
c54b3b41d3 | ||
|
|
8412d6255a | ||
|
|
6b962b15d6 | ||
|
|
6d5400a80f | ||
|
|
f6a2241eb1 | ||
|
|
9d1071e2f8 | ||
|
|
74db3c0484 | ||
|
|
452b7017e6 | ||
|
|
b65cdb788c | ||
|
|
1558751b46 | ||
|
|
5b4d0069d2 | ||
|
|
44e39e6bca | ||
|
|
19e16144b6 | ||
|
|
029199b0ca | ||
|
|
e2b60adc2b | ||
|
|
71d9a995b6 | ||
|
|
9e69326b14 | ||
|
|
942faa87ef | ||
|
|
42cae195f8 | ||
|
|
f85ebd2e21 | ||
|
|
31af32a488 | ||
|
|
279e1dc48f | ||
|
|
dd641ff9d8 | ||
|
|
4d740dc1b4 | ||
|
|
292a646b03 | ||
|
|
429c3586bf | ||
|
|
0929b4d6be | ||
|
|
e24fe74baa | ||
|
|
1daba1b998 |
No files matched your search
@@ -40,6 +40,14 @@ Not shared code: the component's own platform files (`esphome/components/<c>/sen
|
||||
`text_sensor/__init__.py`, ...), its new `USE_*` lines in `esphome/core/defines.h`,
|
||||
and its `CODEOWNERS` entry.
|
||||
|
||||
## YAML language freeze
|
||||
|
||||
Until configurations move to yaml.rocks (esphome/backlog#201), flag any PR that adds to the YAML language: a new tag
|
||||
in `esphome/yaml_util.py`, new behaviour in the `packages` or `substitutions` components (a new entry in the Jinja
|
||||
`SAFE_GLOBALS` in `substitutions/jinja.py`, or a custom Jinja filter, counts), or new merge, override or remove
|
||||
semantics (`esphome/config_helpers.py`, `!extend`, `!remove`). Bug fixes to the existing features are fine. This
|
||||
covers how YAML files are read, included and combined, not a component's own configuration options.
|
||||
|
||||
## Memory and embedded constraints (highest value)
|
||||
|
||||
Heap allocation after `setup()` is treated as a reliability bug, not a
|
||||
|
||||
@@ -20,7 +20,9 @@ driven, what the logs show, and the same flow on a `dev` build when a quirk coul
|
||||
down. Never run `esphome logs` in a `while true` loop: the loop respawns it and holds the port.
|
||||
2. **Credentials stay local.** Put a `secrets.yaml` next to the scratch configs and reference it with
|
||||
`!secret`. A copy of a device's own config keeps using the secrets file next to that config: two
|
||||
checkouts can hold different networks, and the wrong one leaves the device unreachable after the OTA. Never paste a config with credentials into a PR, never commit scratch configs or logs.
|
||||
checkouts can hold different networks, and the wrong one leaves the device unreachable after the OTA.
|
||||
Generate an `api_key` with `openssl rand -base64 32` when you have none. Never paste a config with
|
||||
credentials into a PR, never commit scratch configs or logs.
|
||||
3. **Build from the tree under test.** `python -m esphome` puts the current directory first on
|
||||
`sys.path`, so run it with the checkout or worktree as the working directory and pass the yaml by
|
||||
its absolute path. A venv `esphome` entry point may import an installed snapshot instead of the
|
||||
@@ -47,6 +49,15 @@ driven, what the logs show, and the same flow on a `dev` build when a quirk coul
|
||||
piped, or lines land minutes late. Bound every long command with `timeout` (coreutils) or
|
||||
`perl -e 'alarm shift; exec @ARGV' <seconds> <command>` on macOS without it. Save an exit code with `rc=$?`
|
||||
right after the command: in `echo "$(date +%T) rc=$?"` the command substitution runs first and `$?` reads 0.
|
||||
8. **Give builds a private PlatformIO directory when sessions may use different Pythons.** ESPHome stamps the
|
||||
PlatformIO core directory with the Python version that last built, and a build from another version wipes and
|
||||
reinstalls the shared packages under every other build. Set `PLATFORMIO_CORE_DIR=<scratch>/pio` on every
|
||||
compile and upload (`scripts/pio_build.sh` does). Old releases and framework A/B builds need one too
|
||||
(see `reference/boards.md`).
|
||||
9. **One ESP-IDF or LibreTiny build at a time on a shared machine.** Concurrent builds race over tool caches. Wrap
|
||||
compiles in a lock (`BUILD_LOCK` for `scripts/pio_build.sh`, for example a script that holds a `mkdir` lock).
|
||||
10. **Check that the stimulus ran.** A load or soak run where most requests failed was not loaded, and a capture
|
||||
that stopped early covers nothing; check the driver's own counters before reading the device's verdict.
|
||||
|
||||
## Workflow
|
||||
|
||||
@@ -56,6 +67,9 @@ driven, what the logs show, and the same flow on a `dev` build when a quirk coul
|
||||
them apart with a 10 s capture using `serial_capture.py --reset` (ESP8266 prints its ROM banner at
|
||||
74880 baud, LibreTiny boards print `[LT]` and ESPHome lines, BK7238 prints its bootloader version).
|
||||
`ports.py --wait 2e8a` blocks until a Pico re-enumerates.
|
||||
A change in validation or platform independent code needs no board: a `host:` build serves the API on
|
||||
port 6053 on every interface (reach it at 127.0.0.1, and add `api: encryption:` on a shared network); see
|
||||
recipes/homeassistant.md for one against a throwaway Home Assistant.
|
||||
2. **Make a scratch directory** outside the checkout, with `secrets.yaml` and the templates you need.
|
||||
One yaml per board per variant, file name equal to `name:`.
|
||||
3. **Compile** in the right tree:
|
||||
@@ -78,7 +92,17 @@ driven, what the logs show, and the same flow on a `dev` build when a quirk coul
|
||||
> Automated testing results
|
||||
```
|
||||
|
||||
Then one short sentence saying what was tested (builds and SHAs, board, what was driven), a results table
|
||||
Then one short sentence saying what was tested (builds and SHAs, board, what was driven), and on the next line a
|
||||
bold result, one of **Test result: PASS**, **Test result: FAIL**, **Test result: PASS WITH CAVEATS** or
|
||||
**Test result: UNCLEAR**, followed by one sentence with the key numbers (for example "the device closed none of 32
|
||||
streams, dev closed 12 of 16"). FAIL means a regression or a fix that does not work. PASS WITH CAVEATS means it works
|
||||
but something about the change itself needs a look; name the caveat in that sentence. A limit of the test (the
|
||||
original crash did not reproduce) or a device or network quirk the tooling reported correctly is not a caveat on
|
||||
the change; say it as a separate note. UNCLEAR means the run could not decide; say what is
|
||||
missing. A reader must not have to dig through the table or guess. Side findings that do not change the result (a
|
||||
bug already on `dev`, a one-off oddity) go in the bullets, marked as separate from the result.
|
||||
|
||||
Then a results table
|
||||
(build SHA, board and framework, what was driven, counts, result, plus the `dev` control row), short bullets
|
||||
for the findings, and the setup and exact flow in a collapsed `<details>` block. Answer any question asked on
|
||||
the PR directly in the comment. No credentials, SSIDs, IP addresses, port names or other bench details.
|
||||
@@ -115,8 +139,13 @@ ESP-IDF OTA image: `.esphome/build/<name>/build/firmware.ota.bin`. LibreTiny OTA
|
||||
and then; retry up to three times.
|
||||
- `api_button.py HOST KEY list|press NAME [...]`: list a device's template buttons or press them over the API; the
|
||||
recipes drive their test configs with it.
|
||||
- `apiconn.py`: `connect(host, tries)` (API connect and login with retries, `API_KEY` from the env) and `log_text()`
|
||||
(an API log line without ANSI codes), imported by the newer API drivers.
|
||||
- `apiconn.py`: `connect(host, tries, port, on_stop)` (API connect and login with retries, `API_KEY` from the env),
|
||||
`log_text()` (an API log line without ANSI codes), `stop_event()` (an Event set when the connection ends),
|
||||
`ble_connect()` (wait for an advert, connect through a proxy without a cache like Home Assistant) and
|
||||
`enable_notify()` (start notify and write the CCCD), imported by the API drivers.
|
||||
- `pio_build.sh compile|upload NAME YAML [DEVICE] [esphome options]`: build or upload YAML as `-s name NAME` from
|
||||
`TREE` with a private PlatformIO directory, an import check and an optional `BUILD_LOCK`; logs to `NAME-*.log`.
|
||||
- `resolve.sh NAME [TRIES]`: the address of `NAME.local` once it resolves and answers a ping.
|
||||
- `wifisave_hammer.sh KIND DUT_PORT DUT_YAML DUT_TREE CLIENT_PORT CLIENT_YAML CLIENT_TREE [SETTLE]`:
|
||||
the fallback AP plus captive portal hammer end to end (compile, flash, capture, counts) with the
|
||||
templates below. KIND is `esp`, `pico`, `bw15` or `bk`. It ends with `RESULT PASS` (exit 0),
|
||||
@@ -125,12 +154,13 @@ ESP-IDF OTA image: `.esphome/build/<name>/build/firmware.ota.bin`. LibreTiny OTA
|
||||
(exit 2: a precondition was missed, the stimulus was insufficient, or a capture did not last the run)
|
||||
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/`
|
||||
Per-topic scripts, each described in the matching `reference/recipes/<component>.md`: `heap_alloc/` (operator new caller
|
||||
recorder, dump saver and decoder, cover cycle driver), `online_image/`
|
||||
(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,
|
||||
capture decoder, RTL8720C ROM dump versus report matcher), `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, frame stream harness with presence hold and link loss drivers, BT MAC driver), `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/` (`ha_discovery/`, `disable/`, `retained_burst/` and `reconnect/` runners; 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), `xiaomi_ble/` (frame and header generator with the expected counts, injecting, advertising and receiving configs, counter and runner), `ble_terminate/` (proxy and peer configs, connect and disconnect driver, peer disconnect matcher, runner), `i2c_slave/` (D1 mini slave and BK7238 master configs), `wpa3_ap/` (PMF AP with join and leave logging, BK7238 and CB3S DUTs, runner and summary), `wisp_ap/` (WISP upstream with AP buttons, WISP and ALWAYS_ON DUTs, client, runner and per phase summary), `wifi_restart/` (WPA3 mixed WISP upstream, static IP DUTs with syslog, runner and summary), `ota_timing/` (OTA upload timer with deflate, raw and TCP modes, API build check, A/B runner and median summary, `inflate_bench/` on-device inflate benchmark with stream generator, configs and syslog runner), `gpio_hold/` (ISR pin hold self test with ESP32 and S3 configs), `ble_event_inject/` (GAP and GATTC event injector header and proxy package), `light_sleep_wake/` (LEDC wave and edge timer for light sleep wakeup on a C3, external wave generator and per-call edge detail probe for peripheral power-down on the P4), `manual_ip/` (station and AP manual IP configs, DNS probe and runners), `web_handlers/` (late handler, web_server, captive_portal and prometheus variants, web OTA runner), `bk72xx_flash/` (flash readback with retries, per partition diff of two dumps), `ble_server_security/` (secure GATT server and pairing client configs, driver, summary and runner), `prometheus/` (datetime metrics configs and driver), `zephyr_ble_server/` (nRF52 server, looping ESP32 client and UF2 flash and count runner), `ble_adv_triggers/` (advertiser with six raw frames, ESP32 and BK72xx receivers with eleven triggers, runner and checker), `sun/` (longitude sweep package, runner and checker), `sensor_filters/` (every filter shape with a fixed input sequence, per-board packages and runner), `led_driver_sniff/` (SPI slave capture header with selftest, config generator, window comparer and runner), `hub_input_sim/` (keypad, wiegand and rdm6300 simulation on a D1 mini, API log runner), `value_range/` (on_value_range sequence with a restart, runner), `ezo_fake_bus/` (fake EZO I2C bus and step config, runner), `twai_self/` (TWAI self-reception header, on_frame config and counter runner), `ota_automations/` (OTA automation package for both OTA platforms, four case runner, repeated web upload runner and per case summary), `output_button/` (pad edge timer header, button package and runner), `homeassistant_button/` (raw plaintext API client for action calls and wizard inputs, package and runner), `uart_button/` (UART0 loopback package, API driver with TX and RX counts, runner), `interval/` (plain and delayed interval package, timing summary and runner), `smp_udp_ota/` (SMP reset fault injector, OTA runner, per mode result check, MCUboot swap limit, running image check and slot blanking UF2, Thread device config), `ld2420_sim/` (fake LD2420 answering the hub's commands on a UART0 loopback, API state recorder, two-build comparer and runner), `nrf52_tcp_probe/` (TCP and UDP socket probe config, build and log check, API check over Thread), `rs485_frame/` (simulated DLE/STX/ETX bus device, frame and gate cases, runner), `hx711/` (fake HXLine truncated
|
||||
capture decoder, RTL8720C ROM dump versus report matcher), `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, frame stream harness with presence hold and link loss drivers, BT MAC driver), `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, AT commands for the UART passthrough), `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, per-session `/events` listing check with its config, `/events` head, multi-client, stall, Wi-Fi drop and churn modes with their config, head comparer and runner), `mqtt/` (`ha_discovery/`, `disable/`, `retained_burst/` and `reconnect/` runners; 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), `xiaomi_ble/` (frame and header generator with the expected counts, injecting, advertising and receiving configs, counter and runner), `ble_terminate/` (proxy and peer configs, connect and disconnect driver, peer disconnect matcher, runner), `i2c_slave/` (D1 mini slave and BK7238 master configs), `wpa3_ap/` (PMF AP with join and leave logging, BK7238 and CB3S DUTs, runner and summary), `wisp_ap/` (WISP upstream with AP buttons, WISP and ALWAYS_ON DUTs, client, runner and per phase summary), `wifi_restart/` (WPA3 mixed WISP upstream, static IP DUTs with syslog, runner and summary), `ota_timing/` (OTA upload timer with deflate, raw and TCP modes, API build check, A/B runner and median summary, `inflate_bench/` on-device inflate benchmark with stream generator, configs and syslog runner), `gpio_hold/` (ISR pin hold self test with ESP32 and S3 configs), `ble_event_inject/` (GAP and GATTC event injector header and proxy package), `light_sleep_wake/` (LEDC wave and edge timer for light sleep wakeup on a C3, external wave generator and per-call edge detail probe for peripheral power-down on the P4), `manual_ip/` (station and AP manual IP configs, DNS probe and runners), `web_handlers/` (late handler, web_server, captive_portal and prometheus variants, web OTA runner), `bk72xx_flash/` (flash readback with retries, per partition diff of two dumps), `ble_server_security/` (secure GATT server and pairing client configs, driver, summary and runner), `prometheus/` (datetime metrics configs and driver), `zephyr_ble_server/` (nRF52 server, looping ESP32 client and UF2 flash and count runner), `ble_adv_triggers/` (advertiser with six raw frames, ESP32 and BK72xx receivers with eleven triggers, runner and checker), `sun/` (longitude sweep package, runner and checker), `sensor_filters/` (every filter shape with a fixed input sequence, per-board packages and runner), `led_driver_sniff/` (SPI slave capture header with selftest, config generator, window comparer and runner), `hub_input_sim/` (keypad, wiegand and rdm6300 simulation on a D1 mini, API log runner), `value_range/` (on_value_range sequence with a restart, runner), `ezo_fake_bus/` (fake EZO I2C bus and step config, runner), `twai_self/` (TWAI self-reception header, on_frame config and counter runner), `ota_automations/` (OTA automation package for both OTA platforms, four case runner, repeated web upload runner and per case summary), `output_button/` (pad edge timer header, button package and runner), `homeassistant_button/` (raw plaintext API client for action calls and wizard inputs, package and runner), `uart_button/` (UART0 loopback package, API driver with TX and RX counts, runner), `interval/` (plain and delayed interval package, timing summary and runner), `smp_udp_ota/` (SMP reset fault injector, OTA runner, per mode result check, MCUboot swap limit, running image check and slot blanking UF2, Thread device config), `ld2420_sim/` (fake LD2420 answering the hub's commands on a UART0 loopback, API state recorder, two-build comparer and runneLine truncated
|
||||
|
||||
## Templates in `$SKILL/templates`
|
||||
|
||||
@@ -139,6 +169,8 @@ capture decoder, RTL8720C ROM dump versus report matcher), `api_outgoing/` (wake
|
||||
- `client-wifisave.yaml` (package): joins that AP, posts N bogus `/wifisave` requests, then the real
|
||||
credentials from `!secret`. `example-client.yaml` is the per-run file. `bogus_saves: "1"` gives a
|
||||
plain provisioning check.
|
||||
- `diagnostics.yaml` (package): DEBUG logs, esphome OTA, uptime, free heap, reset reason and a 200 ms counter
|
||||
for soak and load tests.
|
||||
- Per-topic device configs, each described in `reference/recipes/<component>.md`: `online-image-dut.yaml`,
|
||||
`usb-cdc-acm-dongle-dut.yaml`, `nrf52-preferences-dut.yaml`, `rtsp-waveshare-s3-eth-dut.yaml`,
|
||||
`waveshare-s3-eth-camdiag.yaml`, `s31-cse7766-dut.yaml`, `nrf52-coredump-crash-dut.yaml`,
|
||||
@@ -192,6 +224,10 @@ comment quotes the exact commits. Fetch `origin dev` before computing a merge ba
|
||||
the shared `~/.platformio/platforms/libretiny`, so every later build on the machine uses the patched copy. Patch
|
||||
through the ESPHome side (a linker `-Wl,-wrap,<symbol>` or a define) instead, and if it happened, restore the
|
||||
directory from a clean copy of the same release.
|
||||
- Copying a .uf2 to a mounted bootloader drive (`RPI-RP2`, `ITSY840BOOT`) from a terminal on macOS can fail with
|
||||
"Operation not permitted" (the Removable Volumes privacy permission), and picotool then sees no device. Flash through
|
||||
the serial path instead (`esphome upload --device <port>`: the 1200 baud touch on RP2, serial DFU on Adafruit nRF52
|
||||
boards) or by OTA; a board that only shows the drive needs the file dragged in Finder.
|
||||
- `wc -l` pads its count on macOS, so `tail -n +$n0` needs `$((n0+0))` or an arithmetic expansion.
|
||||
- `api:` reboots a board after 15 min without a client: `reboot_timeout: 0s` on `api:` and `mqtt:` for
|
||||
soak tests.
|
||||
|
||||
@@ -25,7 +25,13 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- AsyncMqttClient drops inbound topics over 128 characters; topics of 255 or more wrap a counter and
|
||||
stall the link until the broker drops TCP.
|
||||
- `Arduino.h` already declares `_heap_start`; a lambda can use `&_heap_start` directly, and a second `extern` fails.
|
||||
- `Hardware Watchdog` with `wDev_ProcessFiq` in the stack means interrupts were held off too long for the Wi-Fi
|
||||
interrupt handler; `Software Watchdog` with `pm_send_nullfunc` means the loop was busy too long. Code that takes
|
||||
interrupt locks needs a load run to show either (`scripts/esp8266_lock_load/`, see recipes/one_wire.md).
|
||||
- `GPI` bits 16 to 31 are strapping bits (mask with 0xFFFF). GPIO16 has no interrupt; read `GP16O` for an output.
|
||||
- Cover positions and other restored entity state live in RTC memory by default, so they survive `erase_flash`
|
||||
and a dev build's state carries into the next build's first boot. Set `esp8266: restore_from_flash: true` on A/B
|
||||
configs that erase between builds.
|
||||
|
||||
## ESP32 classic devkit
|
||||
|
||||
@@ -47,6 +53,8 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- An ESP32 whose bootloader has no app rollback is protected only by `safe_mode` after a bad OTA. Before sending a
|
||||
change to such a device that nobody can reach by hand, boot the same code on a devkit first and keep a fallback
|
||||
image of the merge base built.
|
||||
- On modules where GPIO16 and GPIO17 are taken by the module itself (PSRAM on WROVER modules, for example), a
|
||||
`uart:` bus on those pins boot-loops with a watchdog reset during setup. Use GPIO21 and GPIO22.
|
||||
|
||||
## ESP32-S3, C3, C6, H2 with native USB
|
||||
|
||||
@@ -69,6 +77,25 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- 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.
|
||||
- On macOS a software reboot of an ESP32-C3 does not drop its USB JTAG serial port: pyserial keeps reading and gets
|
||||
no error, so a client that watches for a port reset misses it. Count ESPHome's `Running through setup()` line
|
||||
instead.
|
||||
- W5500 SPI Ethernet with IPv6 on (seen on an ESP32-S3, #22676): every `safe_reboot()` (OTA, restart button)
|
||||
aborts while an API client is subscribed to logs. `mdns_free()` leaves the IPv6 group inside `tcpip_api_call`, the
|
||||
W5500 driver logs "IPv6 multicast is always filtered in by W5500", the logger sends that line to the API inline,
|
||||
and the nested `LwIPLock` in `setsockopt(TCP_NODELAY)` releases the core lock it did not take, so `udp_recv`
|
||||
asserts. No crash with IPv6 off, with no log subscriber (a connected client that does not subscribe is fine), or
|
||||
on RMII Ethernet. Reading the crash record afterwards: `recipes/crash_report.md`.
|
||||
- `usb_serial_jtag` holds a `NO_LIGHT_SLEEP` power lock by itself, so a light sleep soak on a native USB board logs
|
||||
to UART0 instead (see `recipes/light_sleep_gpio_wake.md`).
|
||||
- The Waveshare ESP32-P4-WIFI6 needs `engineering_sample: true`. Its Wi-Fi is an ESP32-C6 over SDIO through
|
||||
`esp32_hosted`; a test with no network logs over UART0 to the CH343 console.
|
||||
|
||||
## ESP32-C2 (ESP8684, 26 MHz crystal)
|
||||
|
||||
- Boards with a 26 MHz crystal print the ROM banner (`ESP-ROM:esp8684`) at 74880 baud; at 115200 it is garbage.
|
||||
- ESP-IDF builds need `esp32: framework: sdkconfig_options: {CONFIG_XTAL_FREQ_26: y}`, or the app console runs at
|
||||
the wrong baud rate (the upload log warns `Crystal frequency mismatch`).
|
||||
|
||||
## RP2040 / RP2350 (Pico W, Pico 2 W)
|
||||
|
||||
@@ -96,6 +123,25 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
each RD_REQ with one byte from a 256-byte register file, so any read length works (used for BME280/BMP280 in
|
||||
esphome#22236). The ESP32-S3 I2C slave v2 driver is not usable for register emulation: answering from a task or
|
||||
straight from the interrupt both gave shifted multi-byte reads.
|
||||
- RP2350 PIO instruction memory survives a reflash (the 1200 baud touch and the UF2 reboot), so a program loaded by
|
||||
the previous firmware can hide a missing `pio_add_program`. Clear it from an `on_boot` priority 1000 lambda
|
||||
(`pio1->instr_mem[i] = 0` for i < 32) to start from power-on state; `scripts/pio_probe/pio-common.yaml` does.
|
||||
- `RP2Preferences::reset()` erases the flash sector but not the RAM copy the preferences load from, so the LibreTiny
|
||||
`on_boot` wipe-once pattern still boots with the old saved Wi-Fi credentials. Use a fallback AP config with
|
||||
`networks:` and a fresh `name:` per build instead.
|
||||
- WIZnet W5100S-EVB-Pico (RP2040, `rp2: board: wiznet_5100s_evb_pico`): W5100S on SPI with CLK 18, MOSI 19, MISO 16,
|
||||
CS 17, INT 21, RST 20 (`ethernet: type: W5100`). ESPHome firmware gives it no USB CDC port; reach it over Ethernet,
|
||||
OTA by address, and flash it over USB only through BOOTSEL and the UF2 drive. Keep `interrupt_pin` in every build:
|
||||
without it OTA starves and never completes (`recipes/arduino_pico.md`), which strands the board until a USB flash.
|
||||
The W5100S answers ICMP in hardware, so a ping reply says nothing about the RP2040; probe TCP instead (OTA port
|
||||
2040, API 6053, HTTP 80). In safe mode only 2040 answers.
|
||||
- Through a Pico W `bluetooth_proxy`, about 1 to 2 in 5 BLE connects fail with 0x3E (`connect err=62` in the
|
||||
client) on every build; retry.
|
||||
- arduino-pico framework bumps and the RPAsyncTCP SSE stall: see `recipes/arduino_pico.md`.
|
||||
- USB CDC sends nothing until the host asserts DTR; a client that opens with DTR low (`improvcli.py` without
|
||||
`--keep-dtr`) sees silence.
|
||||
- Powering a breakout from the Pico: use 3V3(OUT), pin 36. Pin 37 is 3V3_EN, which switches the Pico off when pulled
|
||||
low.
|
||||
|
||||
## BW15 kit (RTL8720CF, LibreTiny rtl87xx)
|
||||
|
||||
@@ -137,6 +183,12 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- Wrong-MD5 OTA test without changing firmware: monkeypatch `espota2.hashlib.md5` so only the image checksum (data
|
||||
over 64 KB) returns a wrong hexdigest. Give each build its own `name:` and read `device_info().name` after a
|
||||
restart to see which image booted.
|
||||
- Logger UART: `DEFAULT` is UART2 (the kit's USB serial). `hardware_uart: UART1` hangs after the boot banner and
|
||||
never joins Wi-Fi, on dev too. `UART0` moves both ESPHome and `lt_log` output off the kit's port. LibreTiny's own
|
||||
`LT_I` lines need `framework: loglevel: info` (the default is warn).
|
||||
- A config with no Wi-Fi network and no `ap:` resets about 10 s into setup when it has `web_server:` (dev too):
|
||||
`web_server` setup blocks with no interface up, and no crash record is left. VERBOSE logs show the last
|
||||
`Setup <component>` line.
|
||||
|
||||
## BK7238, WB3S, CB3S (BK7231N) (LibreTiny bk72xx, CH340, RTS on CEN)
|
||||
|
||||
@@ -262,6 +314,10 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
partition even when the upgrade state is still `UPG_STATE_DOWNLOAD_ING` (esphome#22111).
|
||||
- Without serial access to recover, never send a corrupted image; wrong-MD5 and cut-upload tests with valid
|
||||
images are safe.
|
||||
- On the WL2H-U `logger: hardware_uart: DEFAULT` resolves to UART1, LibreTiny's log port for that board.
|
||||
- Over a poor link (about 60 ms ping and 5 % loss) an ESPHome OTA takes anywhere from 50 to 445 s and a web `/update`
|
||||
of a UF2 can abort early while ESPHome OTA still works. Treat such a board's results as crash or no crash only, and
|
||||
settle questions about rates, heap after streams or OTA aborts on a BK7238 (same LibreTiny AsyncTCP).
|
||||
|
||||
## nRF52840
|
||||
|
||||
@@ -291,6 +347,10 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
the port open, and the logger warns `logger took a long time`. Print one line per `loop()` instead.
|
||||
- Zephyr settings survive a reflash: key a `restore_value` global by a `run` substitution when a test needs
|
||||
a never-saved value.
|
||||
- `2fe3:0100` is Zephyr's default USB VID:PID, so `ports.py` labels any board running a Zephyr ESPHome build as an
|
||||
nRF52840 Dongle. Tell an ItsyBitsy from a PCA10059 with a 1200 baud touch: the ItsyBitsy shows its `ITSY840BOOT`
|
||||
UF2 volume, the PCA10059 its Nordic DFU port.
|
||||
- nRF52 Zephyr builds use newlib; the nRF54LM20 builds use picolibc.
|
||||
- Thread: nRF52 `openthread:` accepts only `tlv:`; the individual keys (network_key, channel, ...) are rejected at
|
||||
validation. To list nearby networks with channel and PAN ID, call
|
||||
`otThreadDiscover(InstanceLock::acquire().get_instance(), 0, 0xFFFF, false, false, cb, nullptr)` from an
|
||||
@@ -344,6 +404,16 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- BDK headers such as `power_save_pub.h` have no `extern "C"`; wrap them when including them from the Arduino
|
||||
core's C++ files.
|
||||
|
||||
## Shared PlatformIO directory
|
||||
|
||||
- The stamp file is `.esphome.pio.stamp.json`; a mismatch deletes `packages`, `platforms` and `.cache`.
|
||||
- Building an old release (2025.7.0, Arduino ESP32) against the shared directory swapped `tool-scons` for an older
|
||||
version and broke it midway (`No module named 'SCons.SConf'`) for every PlatformIO build until a newer build
|
||||
reinstalled it. Build old releases with their own `PLATFORMIO_CORE_DIR`.
|
||||
- Two arduino-pico framework versions share the plain `framework-arduinopico` package directory, so an A/B swaps the
|
||||
framework on every build; give each side its own `PLATFORMIO_CORE_DIR`.
|
||||
- The general rule (a private directory whenever sessions may use different Pythons) is ground rule 8 in `SKILL.md`.
|
||||
|
||||
## LibreTiny crash and abort() facts (esphome#21596, #22288)
|
||||
|
||||
- `abort()` on dev: the BK7238 hangs for good (the main loop stops and the watchdog never fires once Wi-Fi is up;
|
||||
@@ -423,3 +493,33 @@ Ports are not listed on purpose: they follow the USB hub port and change on ever
|
||||
- LED0 P1.22, LED1 P1.25; BUTTON0 P1.26, BUTTON1 P1.09, BUTTON2 P1.08, BUTTON3 P0.05 (active low, pull-up). GPIO
|
||||
P1 registers at 0x500D8200 (IN +0x00C, PIN_CNF +0x080), P0 at 0x5010A200.
|
||||
- Binary sensor state changes are not logged at DEBUG; log the states or count `on_press` to see button presses.
|
||||
- FICR INFO.PART reads 0x054BC20B; the build target is `nrf54lm20dk`.
|
||||
- Zephyr `micros()` on nRF has 30.5 us resolution. Time short blocks with the DWT cycle counter instead; nRF54L idle
|
||||
clears `DWT_CTRL`, so enable it again before each timed block.
|
||||
- The nrf52 logger defaults to USB_CDC (the chip's own USB); set `logger: hardware_uart: UART0` to get the log on the
|
||||
J-Link VCOM port.
|
||||
- I2C (#22642): TWIM21 only takes pins on P1 or P3; P0 pins are rejected at config. BUTTON1 (P1.09) and BUTTON2
|
||||
(P1.08) pads work as SDA and SCL. A bus with no pull-ups times out (-116) on every scan address, so setup takes
|
||||
about 56 s. The JLinkExe `st` command reads VTref to check the I/O voltage.
|
||||
|
||||
## Seeed XIAO nRF54LM20A
|
||||
|
||||
- CMSIS-DAP probe (`2886:0068`) with one serial port that carries the console (uart20 on P1.11 and P1.10, #22599).
|
||||
It ships with a Seeed demo.
|
||||
- Flash with `esphome run` (pyOCD, MCUboot plus the signed app). A plain `esphome upload` flashed only the bare app
|
||||
on #22599, and the board stayed dark.
|
||||
- Reset: `<sdk-nrf python> -m pyocd reset -t nrf54lm20a -u <probe id>`.
|
||||
- nPM1300 PMIC at 0x6B on P1.18 (SDA) and P1.17 (SCL) (#22661; `i2c:` builds on i2c21 at 100 kHz). Per the upstream
|
||||
Zephyr board files, BUCK2 supplies VSYS_3V3, the nRF54 and the SAMD11 USB debugger: never switch it off (there is no
|
||||
way back without a power cycle, and the probe dies with it). LDO1 feeds the IMU and microphone (3.3 V, LDO mode) and
|
||||
is safe to toggle. BUCK1 and LDO2 are not described anywhere; leave them alone.
|
||||
- nPM1300 power-on state: BUCK2 on at 3.3 V, BUCK1 off, LDO1 and LDO2 off in load switch mode (enabling one as is
|
||||
passes VINLDO straight through), charger off, VBUS limit 100 mA, NTC select 10 k. Flows: `recipes/npm1300.md`.
|
||||
|
||||
## I2C and SPI breakouts
|
||||
|
||||
- GPIO switches on an I2C expander (XL9535 and others) write `value_or(false)` at setup even with
|
||||
`restore_mode: DISABLED`, so test pin retention on a pin no switch uses.
|
||||
- ADS1015: `sample_rate: 8` maps to 128 SPS at `12_BITS`.
|
||||
- A bus held low (`Performing bus recovery`, no devices found) on a new breakout can be a bad header joint; reflow
|
||||
it before blaming the driver.
|
||||
@@ -4,7 +4,7 @@ Each flow names the pull requests it was used on, so their result tables show wh
|
||||
|
||||
One file per component, named after it:
|
||||
|
||||
- [`api.md`](api.md): noise handshake and OTA encryption on the ESP8266, outgoing connection wake timing on deep sleep and after a Wi-Fi drop, user defined action listing and execution with a raw plaintext client, store_yaml recovery over Noise or plaintext
|
||||
- [`api.md`](api.md): noise handshake and OTA encryption on the ESP8266, outgoing connection wake timing on deep sleep and after a Wi-Fi drop, user defined action listing and execution with a raw plaintext client, store_yaml recovery over Noise or plaintext, rapid connect/disconnect stress (`connstress.py`)
|
||||
- [`ble_midi.md`](ble_midi.md): BLE MIDI client against a fake ESP32 instrument, every packet shape and the send actions
|
||||
- [`captive_portal.md`](captive_portal.md): fallback AP and /wifisave hammer
|
||||
- [`cse7766.md`](cse7766.md): Sonoff S31 parser check over the API
|
||||
@@ -15,27 +15,30 @@ One file per component, named after it:
|
||||
- [`ld2450.md`](ld2450.md): polygon zones, zone number round trip through the radar's readback, ESP8266 loopback harness without a radar, presence hold and link loss on a frame stream, BT MAC readback
|
||||
- [`ld2412.md`](ld2412.md): output pin level through the basic configuration command, held back writes
|
||||
- [`libretiny.md`](libretiny.md): rtc preference emulation, BK72xx and RTL8720C crash report on the next boot with a ROM dump matcher, BK7238 BLE bond store safety with a full flash backup and per partition diff, BK7238 OTA versus the board layout and bootloader, pulse counting, RTL8710B edge interrupts and millis timing
|
||||
- [`modem.md`](modem.md): PPPoS modem component boot check with no modem attached, loop blocking and disable timing
|
||||
- [`modem.md`](modem.md): PPPoS modem component boot check with no modem attached, loop blocking and disable timing, SIM7080G behaviour with no SIM and with no data plan through a raw UART passthrough
|
||||
- [`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, zephyr_ble_server connection slot under reordered callbacks, SMP over UDP OTA over Thread with reset faults, MCUboot swap limit and stuck slot recovery, TCP stack probe
|
||||
- [`nrf52.md`](nrf52.md): dongle board support, zephyr_ble_server connection slot under reordered callbacks, SMP over UDP OTA over Thread with reset faults, MCUboot swap limit and stuck slot recovery, TCP stack probe, sdk-nrf 3.4.1 build and USB notes
|
||||
- [`npm1300.md`](npm1300.md): nPM1300 PMIC on the XIAO nRF54LM20A: probe build, every entity with a register dump and regulator toggles, power-on state and no-battery readings
|
||||
- [`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): upload without a configuration and the refusal checks, overlap and lock, timeouts, deflate, upload timing A/B per build and board with deflate and raw, on-device inflate benchmark, OTA automations on two platforms
|
||||
- [`rtsp_server.md`](rtsp_server.md): camera streaming on the Waveshare ESP32-S3-ETH
|
||||
- [`scheduler.md`](scheduler.md): loop wake A/B, interval startup delay and control from lambdas
|
||||
- [`scheduler.md`](scheduler.md): loop wake A/B, interval startup delay and control from lambdas, RP2 scheduler lock under IRQ and lwIP load
|
||||
- [`udp.md`](udp.md): datagrams, multicast, sockets, `udp.write` payload shapes
|
||||
- [`usb_cdc_acm.md`](usb_cdc_acm.md): nRF52840 dongle host driver
|
||||
- [`wifi.md`](wifi.md): reboot_timeout with a fallback AP, DHCP lease cache, Easy Connect (DPP), WISP bridge with an ethernet upstream, reboots against a WPA2/WPA3 PMF access point, WISP and ALWAYS_ON AP switching, AP restarts with WPA3 mixed and LIGHT power save
|
||||
- [`wifi.md`](wifi.md): reboot_timeout with a fallback AP, DHCP lease cache, Easy Connect (DPP), WISP bridge with an ethernet upstream, reboots against a WPA2/WPA3 PMF access point, WISP and ALWAYS_ON AP switching, AP restarts with WPA3 mixed and LIGHT power save, soft AP clients with the BLE tracker scanning, ESP8266 power save after captive portal provisioning
|
||||
- [`zephyr.md`](zephyr.md): preferences on the nRF52840 dongle
|
||||
- [`zephyr_coredump.md`](zephyr_coredump.md): crash and decode on nRF52 boards
|
||||
- [`zwave_proxy.md`](zwave_proxy.md): frame checksums on a live proxy
|
||||
- [`one_wire.md`](one_wire.md): ESP8266 interrupt locks under Wi-Fi load with a DS18B20 search and a busy-wait control
|
||||
- [`cc1101.md`](cc1101.md): sleep and wake checks read directly from the chip (CHIP_RDYn, PATABLE loss, registers per setter)
|
||||
- [`globals.md`](globals.md): restoring globals with storage rtc and flash across every reset kind
|
||||
- [`homeassistant.md`](homeassistant.md): light platform mirrored from a local Home Assistant, held reports versus later calls, wizard-linked entities on every platform
|
||||
- [`homeassistant.md`](homeassistant.md): light platform mirrored from a local Home Assistant, held reports versus later calls, wizard-linked entities on every platform, homeassistant switch on a script with a host build
|
||||
- [`usb_audio.md`](usb_audio.md): USB audio speaker and microphone, the usb_host FIFO split, and Music Assistant playback through sendspin
|
||||
- [`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
|
||||
- [`web_server.md`](web_server.md): state SSE stress and the HTTPD task stack on web_server_idf, entity icon and device class readback, per-session `/events` listing, `/events` head, stall, Wi-Fi drop and churn checks
|
||||
- [`uart_sim.md`](uart_sim.md): UART sensors simulated on a classic ESP32 with loopback and cross-wired UARTs, a Duco ventilation box model on a second UART
|
||||
- [`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 per chip, loop cost per strip
|
||||
- [`remote_base.md`](remote_base.md): remote_receiver protocol decoding through a one-pin loopback on ESP32 and ESP8266, no IR hardware
|
||||
@@ -61,11 +64,11 @@ One file per component, named after it:
|
||||
- [`rs485_frame.md`](rs485_frame.md): DLE/STX/ETX bus on an ESP32-C3 with a cross-wired simulated bus device (frame cases, gate timing)
|
||||
- [`hx711.md`](hx711.md): fake HX711 driven from the other core, every published value matched to the served conversion
|
||||
- [`automation_trace.md`](automation_trace.md): automation codegen A/B, a marker trace of chains, conditions, loops and script modes over the API
|
||||
- [`bluetooth_proxy.md`](bluetooth_proxy.md): held GATT link after a half-open API session, frozen Home Assistant stand-in
|
||||
- [`bluetooth_proxy.md`](bluetooth_proxy.md): held GATT link after a half-open API session, frozen Home Assistant stand-in, out-of-order GATT discovery responses injected on the proxy, GATT UUID forms (16 bit, 32-bit base, 128 bit) compared against an ESP32 proxy
|
||||
- [`crash_report.md`](crash_report.md): crash buttons, fetching the previous boot's crash report over the API, per-chip abort facts
|
||||
- [`https_idf.md`](https_idf.md): web_server_idf HTTPS test component, listener switch, stalled TLS clients, bad key
|
||||
- [`mdns.md`](mdns.md): legacy unicast mDNS dump, hammer and latency straight to the device
|
||||
- [`sim_buses.md`](sim_buses.md): PCF8574/HD44780, MAX7219, SPI spy, packet_interface and SN74HC165 simulators, status LED probe, fake Home Assistant, cg.static_buffer probes
|
||||
- [`sim_buses.md`](sim_buses.md): PCF8574/HD44780, MAX7219, SPI spy, packet_interface and SN74HC165 simulators, status LED probe, fake Home Assistant, cg.static_buffer probes, a TRF7962A NFC reader chip behind a fake SPI bus
|
||||
- [`sigma_delta.md`](sigma_delta.md): pulse density of the sigma_delta speaker pin read inside the ESP32-P4, rtttl note onset and release
|
||||
- [`microphone_http_stream.md`](microphone_http_stream.md): raw PCM over HTTP with a counter fake mic or a USB mic, multi-reader client
|
||||
- [`i2s_audio.md`](i2s_audio.md): I2S microphone fed by an I2S TX channel on the same S3 through three jumpers
|
||||
@@ -78,3 +81,10 @@ One file per component, named after it:
|
||||
- [`mcp23017.md`](mcp23017.md): MCP23017 IOCON aliasing and INT line behavior (open drain, push-pull, polling) on an ESP8266 with PA to PB jumpers
|
||||
- [`pwm_capture.md`](pwm_capture.md): every LEDC PWM period captured on the same ESP32-C6 through RMT receive and PCNT, with and without power save
|
||||
- [`spi.md`](spi.md): SPI bus capture on the same board with no chips (ESP32 SPI3 slave, edge interrupt snapshots on C3, ESP8266 and Pico 2 W), checked and diffed between builds
|
||||
- [`heap_alloc.md`](heap_alloc.md): operator new counting, and a ring of allocation callers decoded with addr2line to tell the first run after boot from repeats
|
||||
- [`wled.md`](wled.md): WLED realtime sender on a board's own access point
|
||||
- [`combination.md`](combination.md): combination sensor NaN behaviour from the last source
|
||||
- [`improv.md`](improv.md): Improv serial with stray bytes, scan, bad and good passwords from a client that reads frames out of the log stream, Improv over BLE, per board notes
|
||||
- [`arduino_pico.md`](arduino_pico.md): arduino-pico framework bump A/B: W5100S Ethernet soak, Pico W fallback AP client count, Pico W bluetooth_proxy GATT hold, web_server SSE stalls, `/events` churn crashes and never completed connects, W5100S OTA without `interrupt_pin`
|
||||
- [`bluedroid_gattc_queue.md`](bluedroid_gattc_queue.md): queued MTU request and execute write recursion that overflows BTU_TASK, ble_client central against an ESP32-S3 peer
|
||||
- [`tuya.md`](tuya.md): Tuya MCU simulator on a cross-wired second UART (handshake, every datapoint type, command frames logged), hub vs entity order, dump A/B
|
||||
@@ -56,3 +56,25 @@ include of random base64 lines with `include_secrets: true` gives four chunks (1
|
||||
0bd3738430: `include_secrets: true` fails the build when a package in another directory uses `!secret` and has no
|
||||
`secrets.yaml` beside it; a copy next to the package works around it.
|
||||
Results: https://github.com/esphome/esphome/pull/16445#issuecomment-6335435397
|
||||
|
||||
## Allocations of a connecting client (ratgdo/esphome-ratgdo#705)
|
||||
|
||||
An API client that connects allocates about 15 times on ESP32: the connection object, then the list entities and
|
||||
initial state batches growing the `DeferredBatch` vector. A log subscription adds more per line. Connect before a
|
||||
heap measurement and subscribe to logs only afterwards (`heap_alloc.md`).
|
||||
|
||||
## Native API connect/disconnect stress (#14679, #14687, #14706)
|
||||
|
||||
`scripts/api/connstress.py HOST [ITERATIONS] [CONCURRENCY]` (aioesphomeapi; `API_KEY` env for a noise key) opens and
|
||||
closes native API connections as fast as it can, 500 attempts with 4 at a time by default, and ends with
|
||||
`RESULT PASS` or `RESULT FAIL`. It is the test that found the raw lwIP socket heap corruption, so run it for any change to
|
||||
the socket layer, the scheduler or locking on RP2040/RP2350 and ESP8266, with a bounded serial capture on the device:
|
||||
the client only sees resets, the crash is in the log.
|
||||
|
||||
- RP2040/RP2350 before #14687: crashed after 3 or 4 iterations (`malloc` from the lwIP accept IRQ while the main loop
|
||||
was in `malloc`: double free in `~APIFrameHelper`, `_malloc_r` in `APIConnection()`); after: 500/500. #14679 first
|
||||
added the lwIP locking between the lwIP callbacks and the main loop on RP2040.
|
||||
- ESP8266 before #14706: crashed within about 50 iterations (`umm_malloc_core` LoadStoreError, use after free of a
|
||||
closed PCB's callbacks); after: 490/500, the 10 failures are connection resets from overload, which is expected there.
|
||||
- ESP32 (BSD sockets) passes 500/500 on both and is the control.
|
||||
- Compare against dev on the same board; count reboots and decode crash addresses as well as the client's failures.
|
||||
@@ -0,0 +1,42 @@
|
||||
# arduino-pico framework bumps (RP2040/RP2350)
|
||||
|
||||
Scripts: `scripts/rp2_web_ble/` (README there). Used for #22671 (6.1.1 to 6.3.2).
|
||||
|
||||
- Build PR and dev with a private `PLATFORMIO_CORE_DIR` (`scripts/pio_build.sh` does; see `reference/boards.md`).
|
||||
Check the compile log line `framework-arduinopico @ 1.60302.0` per build.
|
||||
- Wired Ethernet (W5100S EVB): 6.3.2 defines `LWIP_ASSERT_CORE_LOCKED()` as `async_context_lock_check` on the
|
||||
Ethernet context (`cores/rp2040/lwip_wrap.cpp`), so unlocked lwIP calls panic there. Soak the API (200 ms template
|
||||
counter, 1 s uptime, logs subscribed), load pages, OTA and reboot; the rp2 crash handler shows a panic as
|
||||
`Crash (HardFault)` in the debug reset reason on the next boot.
|
||||
- Fallback AP client count: `ap_clients_` is protected and `WiFiComponent` is final; read it from an
|
||||
`esphome: includes:` header through an explicitly instantiated member pointer (`appeek.hpp`). Join raises it to 1.
|
||||
- bluetooth_proxy on the Pico W: `rp2_ble_tracker:` + `bluetooth_proxy: active: true`. Drive with `gatthold.py`
|
||||
against the ESP32-S3 server in `scripts/ble_notify/server.yaml`. UUID forms and the 0x3E connect failures are in
|
||||
`bluetooth_proxy.md`. A "Failed to send notify data response" warning at each disconnect is normal.
|
||||
- web_server SSE on the W5100S (dev 2a6a1a050e4, 6.1.1): every `/events` stream stops after 0.3 to 11 s (alone, with
|
||||
the API, or with page loads alike), then the EVB closes it with a FIN 5.8 to 6.3 s after its last data segment, so
|
||||
curl exits 0. The pcap shows every byte ACKed by the host, window 65535, no retransmits, nothing sent in the gap:
|
||||
the device simply stops writing. The 5 s gap matches RPAsyncTCP `ASYNC_MAX_ACK_TIME` (likely `_pcb_busy` not
|
||||
cleared, then `_onTimeout` closes). A new `/events`, GET / and the API keep working. Pico W: 60 s steady. On macOS
|
||||
`tcpdump` runs without sudo once your account is in the bpf group. Tools: `sserun.sh HOST TAG SECS alone|api|pages
|
||||
N` (pcap, netstat poll, API VERBOSE log, probes) and `pcapsum.py PCAP DEVICE_IP` (per connection last data, FIN/RST,
|
||||
retx). Confirmed with counters patched into the build's `.piolibdeps` copy of RPAsyncTCP: every stall is one
|
||||
`_sent()` underflow with `_tx_unacked_len` 0 and the pcb idle after `send()`; ESPAsyncWebServer 3.12.1 does not
|
||||
help. The esphome-libs RPAsyncTCP fork (`esphome-1.3.2`, 8efb83c) streams 16 x 30 s with no stall. `stallctr.py PCAP
|
||||
IP APILOG` lines the counters up with each stall.
|
||||
- `H=<device ip> churn.sh TAG SECS` (4 loops of 0.2 to 1.5 s `/events` connections) crashes the rp2 web_server: dev on
|
||||
the EVB, the fork build on the EVB and the Pico W. HardFault in `AsyncEventSource::send` from
|
||||
`deferrable_send_state`, about one reboot every 10 to 20 s. Ten quick reboots put the board in safe mode (ping and
|
||||
OTA port 2040 only); OTA a build to recover.
|
||||
- **Never flash the W5100S EVB a build without `interrupt_pin`** unless you can reach BOOTSEL: arduino-pico then polls
|
||||
the W5100 from an async_context timer that every lwIP call pushes back, so the esphome OTA read loop starves the
|
||||
poller and OTA never completes (the device ACKs the hello, then never the features byte). Web and API still work.
|
||||
The board has no USB CDC port with ESPHome firmware, so the only way back is BOOTSEL and the UF2 drive.
|
||||
- `churnflow.sh` (in `rp2_web_ble/`) repeats `churn.sh` with heap and main loop checks and reflashes by OTA when a
|
||||
round left the board in safe mode.
|
||||
- `leakflow.sh` with `neverconn.py HOST N rst|head`: ESPAsyncWebServer 3.9.6 leaks about 175 B per `/events` client
|
||||
that resets before the response head is ACKed (52 KB per 300); 3.12.1 stays flat.
|
||||
- `/events` churn also hangs the BK7238 main loop or drops it off the network on dev; recover with a serial reset.
|
||||
- The API has 3 sockets on these builds: connstress at concurrency 4 always shows some "dropped after hello" failures;
|
||||
use 2 for a clean 500/500.
|
||||
- IRQ context scheduler test for #22688: `scripts/rp2_sched_lock/`, described in `scheduler.md`.
|
||||
@@ -42,6 +42,7 @@ comparison accepted automatically) and a classic ESP32 devkit runs `esp32central
|
||||
phase B reads the MITM characteristic with no numeric comparison and no `Deleting unpaired device` line.
|
||||
- On ESP-IDF 5.5.6 every other reconnect pairs again (`Deleting unpaired device` on the disconnect after a bonded
|
||||
reconnect), the regression #22081 describes.
|
||||
#22559 fixes it: the bond survived 15 reconnects and a reset of both boards with no new pairing.
|
||||
|
||||
## Bluedroid hex parsing bench (#22081)
|
||||
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
# Bluedroid GATT client command queue
|
||||
|
||||
## Queued MTU request recursion overflows BTU_TASK (#17954, #22670)
|
||||
|
||||
Bluedroid's `bta_gattc_pop_command_to_send()` runs the head of `p_cmd_list` and removes it only after
|
||||
`bta_gattc_sm_execute()` returns. When that head is an MTU request (or an execute write) whose send fails at once,
|
||||
the failure path pops again with the same command still at the head, so it recurses until the BTU task stack
|
||||
overflows. Every ESP-IDF release so far; PR #22670 fixes it in ESPHome with linker wraps
|
||||
(`bluedroid_gattc_queue.c`).
|
||||
|
||||
Rig, `scripts/bluedroid_mtu_recursion/`:
|
||||
|
||||
- Peer: an ESP32-S3 with `btusrv.yaml` (`esp32_ble_server`, one readable and writable characteristic, advertising).
|
||||
- Central: a classic ESP32 devkit with `btu-common.yaml` plus a per-build file like `btucli-example.yaml` (set
|
||||
`peer_mac` to the peer's Bluetooth MAC, which is its Wi-Fi MAC + 2, and give each build its own name).
|
||||
`CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK: y` makes the overflow panic at the write:
|
||||
`Stack canary watchpoint triggered (BTU_TASK)`.
|
||||
- Each connection: `on_connect` looks up the characteristic handle right away (a `ble_client` with no child nodes
|
||||
releases services and cleans the GATT cache in the same SEARCH_CMPL event, so a lookup after a delay finds
|
||||
nothing), waits 1.5 s, then suspends `BTU_TASK`, calls `esp_ble_gap_disconnect`, queues 4 reads and one MTU
|
||||
request, waits 30 ms and resumes. The batch is the key: sent one at a time, the BTU task handles each request
|
||||
before the next arrives and nothing waits in the queue. The reads fail and keep the command slot busy so the MTU
|
||||
request is queued; when popped, `GATTC_ConfigureMTU` fails with "BT_GATT: connection not established".
|
||||
`ble_client` reconnects on its own and the next round starts.
|
||||
- `analyze.py CAPTURE` counts rounds, BTU canary crashes, boots, reconnects with and without a reboot and MTU 517.
|
||||
- Decode with the IDF `xtensa-esp32-elf-addr2line -pfiaC`; the overflow shows the repeating
|
||||
`pop_command_to_send (act.c:1739/1746) -> sm_execute -> cfg_mtu (act.c:1042)` frames.
|
||||
|
||||
Results on ESP-IDF 5.5.6: dev at 46844d3631 crashed 73 of 73 rounds in 5.5 min (every round, about 4.5 s per
|
||||
reboot cycle); the PR at ad787163fd ran with no crash and reconnected without a reboot each time. Check the wraps are
|
||||
linked with `nm firmware.elf | grep __wrap_GATTC_ConfigureMTU` (native ESP-IDF builds only; the define is
|
||||
`USE_ESP32_BLE_BLUEDROID_GATTC_QUEUE`).
|
||||
|
||||
### Execute write variant
|
||||
|
||||
`btuxw-example.yaml` sets `exec_write: "true"`, which sends `esp_ble_gattc_execute_write(gattc_if, conn_id, true)`
|
||||
in place of the MTU request. No prepare write is needed: Bluedroid does not check for prepared writes, and
|
||||
`GATTC_ExecuteWrite` fails synchronously with the same "connection not established" error. The variant also sets
|
||||
`CONFIG_BT_LOG_GATT_TRACE_LEVEL_API: y`, so each send logs `BT_GATT: GATTC_ExecuteWrite conn_id=... is_execute=1`,
|
||||
and those lines are counted per round with awk between the `ROUND n start` lines. In a few rounds (about 3 to 14%)
|
||||
the controller reports the disconnect before the command is popped. Those rounds log no execute send and never
|
||||
crash, so count "rounds that reached the send", not all rounds. Most dev backtraces in this variant are cut off in
|
||||
`vTaskSwitchContext` (the extra trace logging makes task switches more likely at the moment of overflow). Use the
|
||||
complete ones to decode the `bta_gattc_execute (act.c:1352)` cycle.
|
||||
|
||||
Results: dev 46844d3631 had 81 rounds, 70 reached the send, and all 70 crashed. PR e51f0b8321 had 151
|
||||
rounds, 147 reached the send with exactly one execute line each, and there were 0 crashes and 1 boot.
|
||||
@@ -26,3 +26,67 @@ swap fails when a round never connects. An owner that never got the link also fa
|
||||
- Before #22077, case H holds the link for good: 0 adverts, and the address stays in the slot report. With #22077 the
|
||||
link is released in the same millisecond as the `replaces` warning. In case 4 the first request logs `Connection
|
||||
request ignored, state: DISCONNECTING` (connected=false at 0.2 s) and the retry connects at 0.5 to 0.7 s.
|
||||
|
||||
## Out-of-order GATT discovery responses (#22518)
|
||||
|
||||
Some peripherals answer a characteristic discovery (Read By Type) with records out of handle order. ESP-IDF 5.5.6
|
||||
rejects that (`gatt_process_read_by_type_rsp invalid handle ...`) and ends the whole discovery; 5.5.5, Android and
|
||||
BlueZ accept it. `scripts/att_reorder/` reproduces it with no such device:
|
||||
|
||||
- `server.yaml` (ESP32-S3) serves `FFF0` with six characteristics, then `1826`.
|
||||
- `proxy.yaml` (classic ESP32, `idf` substitution; keep per-build files such as `example-proxy.yaml` in the same
|
||||
directory) links `components/attswap`, which wraps Bluedroid's
|
||||
`l2c_rcv_acl_data` (`-Wl,--wrap`); `attswap.hpp` swaps the first two records of the response whose first record
|
||||
declares `FFF1`, and logs a swap count.
|
||||
- `gattget.py PROXY PEER_MAC ROUNDS` reads the services through the proxy like Home Assistant (no cache);
|
||||
`run.sh PROXY_YAML [ROUNDS]` flashes both boards and prints the services per round and the discovery errors.
|
||||
|
||||
On 5.5.6 Home Assistant gets `fff0` with no characteristics and no `1826`, while the proxy still logs
|
||||
`Service discovery complete` (the proxy ignores the error status); on 5.5.5 every service arrives. To find the order a
|
||||
real device uses, decode an Android HCI snoop: a Read By Type response lists its records in the order sent.
|
||||
|
||||
- Handles, reads and notifies after a reordered response: flash `server-notify.yaml` (`SERVER_YAML` on `run.sh`) and run
|
||||
`gattcheck.py PROXY PEER_MAC`. It prints every service, characteristic and descriptor handle, reads FFF1, FFF2 and
|
||||
FFF3 by the received handles (each holds its own value), and enables notify on FFF1, FFF2 and 2ACD. Compare the table
|
||||
with a run of a proxy built without `attswap`. On ESP-IDF 5.5.5, which accepts the unsorted response, FFF1's
|
||||
descriptor range runs over FFF2's declaration, value and CCCD, so FFF2 has no CCCD (#22576).
|
||||
- `bluetooth_gatt_start_notify` only registers the notify on the proxy; the client writes the CCCD itself, as Home
|
||||
Assistant does. Without that write no notification arrives.
|
||||
- Give the proxy an `api` encryption key (`API_KEY` for the scripts). A Home Assistant on the same network connected to
|
||||
a plaintext test proxy and took over its Bluetooth subscription (`Subscription from Home Assistant ... replaces
|
||||
aioesphomeapi`), dropping the test client's connection mid-run.
|
||||
|
||||
## GATT UUID forms through a proxy (#22679)
|
||||
|
||||
`scripts/gatt_uuid/`: `server.yaml` (the `ble_notify` server plus a service with 128 bit, 32-bit base and 16 bit
|
||||
UUIDs on characteristics and descriptors, and 2901 and 2902; set the name with `-s name`), `gattlist.py PROXY PEER
|
||||
OUT.json` (lists every UUID, reads, notifies 10 s, retries 0x3E), `cmp.py REF.json OTHER.json` (entry by entry diff,
|
||||
exits 1 on a difference) and `run.sh NAME` (Pico W proxy from `rp2_web_ble/picow.yaml`, list, compare). Take the
|
||||
reference from an ESP32 proxy (unset `API_KEY` for a plaintext API).
|
||||
|
||||
- On rp2 before #22679, BTstack truncated 32-bit base UUIDs with a nonzero low half to 16 bits (`5ec10001-...` came
|
||||
out as `00000001-...`); a zero low half (5ec10000) came through intact.
|
||||
- Connects through the Pico W proxy fail with 0x3E now and then (see `reference/boards.md`); the scripts retry.
|
||||
|
||||
## Scan complete never arrives (#22770)
|
||||
|
||||
`scripts/ble_scan_complete/`: `scan.yaml` is a proxy config like the report's (ESP32-C6, interval = window = 1100 ms,
|
||||
debug sensors, `api: reboot_timeout: 0s`, a `duration` substitution, 5 s by default; the validator wants at least
|
||||
three intervals, so 2 s is refused). The tracker watchdog is `duration * 2`, so a short duration shortens it too.
|
||||
`scaninst.yaml` adds `scan_inst.hpp` and five `-Wl,--wrap` flags that count one scan's duration timer through
|
||||
Bluedroid: `BTM_BleScan` starts and stops, `btu_start_timer(BTU_TTYPE_BLE_SCAN)`, the timer's alarm firing (a shim on
|
||||
its `osi_alarm_new` callback, BTC task), `btm_ble_timeout` (BTU task) and the INQ_CMPL handed to `btc_transfer_context`
|
||||
(PID 5, act 3; the param is 108 bytes in libbt, so do not compare with the C++ `sizeof`). A 30 s interval logs them as
|
||||
`scaninst`; a lost completion shows where the chain stopped (timer > fire + 1, fire > timeout, timeout > cmpl_post, or
|
||||
cmpl_post above the ESPHome-side `ends / 2`). `ha.py HOST OUT SECONDS [--toggle S --jitter J]` is the Home Assistant
|
||||
stand-in (raw adverts, scanner state, set mode passive once, optional active/passive toggles). `soak.sh TAG HOST
|
||||
SECONDS [ha.py options]` (env PORT, API_KEY or else `apikey.txt`) runs a bounded serial capture plus ha.py.
|
||||
`wait.sh CAPTURE SECONDS [FROM_LINE]` blocks until a timeout, drop or unexpected-state line and prints the counters.
|
||||
- Bluedroid and IDF log lines reach the ESPHome log as tag `esp-idf` at VERBOSE (`[V][esp-idf:000][BTU_TASK]: E ...`),
|
||||
so a user capturing at INFO over the API never sees a Bluedroid error.
|
||||
- A stop from Home Assistant landing just after the timer fired (toggle period 5.03 s with 0.08 s jitter against 5 s
|
||||
scans hits it about once per 20 minutes) gives `Unexpected state: STOPPING on scan complete`, `stop complete -
|
||||
status 1`, `BTM_BleScan scan not active`; the tracker recovers. A stop while STARTING logs `Cannot stop scan:
|
||||
STARTING` and the mode change waits for the next restart.
|
||||
- With about 55 devices around (about 95 adverts/s), no lost completion in about 2800 natural 5 s cycles on 2026.10.2
|
||||
(VERBOSE and INFO builds) plus about 670 toggled stops, and none on dev.
|
||||
@@ -0,0 +1,17 @@
|
||||
# cc1101
|
||||
|
||||
## Sleep and wake checks read from the chip (#22519)
|
||||
|
||||
`scripts/cc1101_sleep/`: `cc1101-sleep.yaml` runs an ESP32-S3 (ESP-IDF) with an E07-M1101D module on SPI and runs
|
||||
tests T0 to T6 4 s after boot; `cctest.hpp` reads every config register and the PATABLE directly over SPI. The log
|
||||
ends with `DONE fails=N`, and T6 prints whether each setter woke a sleeping chip.
|
||||
|
||||
- Proof that the chip sleeps: with CSn low, SO (MISO) stays high until the crystal runs, so it is high after
|
||||
`power_down()` and low at once when awake. PATABLE entries 1 to 7 are also lost in SLEEP, so write marks to them
|
||||
before `power_down()` and check that they are gone.
|
||||
- Selecting the chip to check it wakes it, so after the check the chip is awake while the component still thinks it
|
||||
sleeps. Call `wake_up()` and `begin_rx()` before the next case.
|
||||
- Leave FSCAL3 to FSCAL1 (0x23 to 0x25), FSTEST (0x29) and AGCTEST (0x2B) out of register comparisons: calibration
|
||||
and the chip itself change them.
|
||||
- Results: on 7e6b90d08b, `set_frequency`, `set_channel` and `set_modulation_type` woke a sleeping chip and left it
|
||||
in RX. 9e65d0c327 fixed that; every other check passed on both, and 200 sleep and wake cycles took about 1 s.
|
||||
@@ -0,0 +1,7 @@
|
||||
# combination
|
||||
|
||||
## NaN from the last source (#22510)
|
||||
|
||||
A combination sensor defers each update and uses the value of the source that published last. A NaN from that
|
||||
source drops the whole update, so when testing NaN handling keep the last-publishing source finite, and compare
|
||||
rows one update late. Heap churn per update: see `heap_alloc.md`.
|
||||
@@ -24,3 +24,11 @@ put `scripts/` on `PYTHONPATH`):
|
||||
- Quick crash reboots count toward BK72xx safe mode, so space out back-to-back crash tests on those boards.
|
||||
- A device that keeps the previous crash replays it to every new log client until the next crash; that is one
|
||||
record, not two.
|
||||
|
||||
## Crash records and log subscribers
|
||||
|
||||
The record is replayed and cleared by the first log subscribe (`on_subscribe_logs_request`), so drain it on the
|
||||
first boot after an OTA, or a stale record from the previous build shows up. Moving `api: port:` keeps Home Assistant
|
||||
off the board while testing. `scripts/crash_report/quiet_then_subscribe.py HOST PORT OUT N` drains the record, stays
|
||||
connected without a log subscription for N reboots, then subscribes and records the replayed record; it tells a crash
|
||||
that needs a log subscriber (like the W5500 IPv6 reboot abort in `reference/boards.md`) from one that does not.
|
||||
@@ -0,0 +1,41 @@
|
||||
# Heap allocation counts and callers (#22509, #22510, ratgdo/esphome-ratgdo#705)
|
||||
|
||||
## Counting
|
||||
|
||||
Replace the global `operator new` in an `esphome: includes:` header on ESP32 (Arduino or ESP-IDF) and log the
|
||||
delta from an `interval`. Compare a PR build with its base on the same flow; the rate per second shows churn.
|
||||
- The ESP8266 core defines `operator new` non-weak. `-Wl,--wrap=_Znwj` worked in a sensor-only config but
|
||||
boot-looped a neopixelbus config (alignment fault in the wrapper), so report free heap only there.
|
||||
- `vec = {}` keeps a std::vector's capacity (it is an initializer_list assignment); only
|
||||
`std::vector<T>().swap(vec)` or `clear()` plus `shrink_to_fit()` frees it. Seen as heap that did not come back
|
||||
after a WLED effect stopped.
|
||||
|
||||
## Callers
|
||||
|
||||
`scripts/heap_alloc/`:
|
||||
- `allocring.hpp` counts every `operator new` and, once armed, keeps the first 1024 with their size, time and
|
||||
five caller PCs, about 28 KB of RAM. It disarms itself when full. The frame walker
|
||||
(`esp_backtrace_get_next_frame`) exists only on Xtensa (ESP32, S2, S3); on RISC-V chips entries keep size and
|
||||
time without callers. Aligned `operator new` (`std::align_val_t`) is not replaced, so it is not counted;
|
||||
nothrow `new` goes through the replaced one.
|
||||
- `allocring.yaml` (package, substitution `alloc_arm_s`) arms it that many seconds after boot and adds a
|
||||
"Dump allocations" button that logs what was kept. The press stops recording until the next reboot, so
|
||||
reboot (or reflash) before each run; a second press returns the same entries.
|
||||
- `alloc_marker(a, b)` from a lambda writes a marker entry, for example on each cover operation change, so the
|
||||
dump splits into phases.
|
||||
- `dump.py HOST OUT` presses the button and writes the dump to a fresh OUT, pressing again until the header
|
||||
and every entry arrived (a late log subscription or dropped log lines). `decode.py LOG ELF [ADDR2LINE]` prints each entry with its callers as function and file:line, and exits 2
|
||||
when the recorder never armed, an entry was still being written, entries are missing, repeated or out of
|
||||
range, no Xtensa entry has a caller, the ELF is from another build (the buffer address in the header differs), or the buffer
|
||||
filled. A PR build and its base can share that address, so copy each build's `firmware.elf` next to its dump. On RISC-V it prints sizes and times only. It reads only the newest dump in the file. The ESP-IDF ELF is `.esphome/build/<name>/build/firmware.elf`.
|
||||
- `cycles_cover.py HOST N OUT` waits for the "Allocation recorder armed" binary sensor, then moves the first
|
||||
cover to the far end and back N times (`cover_command(position=...)`, waiting for idle each way) with a states-only API client, then saves the dump the same way. It exits 2 when a move
|
||||
never reached its position.
|
||||
|
||||
Findings:
|
||||
- Arm well after boot: the scheduler regrows its storage once after the freelist trim (see `scheduler.md`).
|
||||
- Repeat the action several times in one session and count only what comes back. On a ratgdo cover (an external
|
||||
component, ESP32 ESP-IDF) the first door open after boot allocated 18 times: four 36 B SchedulerItems,
|
||||
`to_add_` and `items_` growth, and the API `DeferredBatch` vector. Cycles 2 and 3 allocated nothing.
|
||||
- Keep the API client out of the count (see `api.md`): connect before the run, subscribe to states only, and
|
||||
subscribe to logs only for the dump.
|
||||
@@ -66,3 +66,35 @@ only its current ID.
|
||||
`No entity ID set yet` check; nothing is sent either way.
|
||||
- Field 3 of LightStateResponse is brightness, not `missing_state`; SwitchStateResponse has no missing flag.
|
||||
- A light publishes only changes, so a report of the state it already has publishes nothing.
|
||||
|
||||
## homeassistant switch on a script, host build against a throwaway Home Assistant (#22548)
|
||||
|
||||
No board is needed when the change is in validation or platform independent code: an ESPHome `host:` build serves the
|
||||
API on 127.0.0.1:6053. `scripts/homeassistant_script_switch/`:
|
||||
|
||||
- `ha-configuration.yaml` is the Home Assistant config (port 8129, a 20 s `long_job` script that sets and clears
|
||||
`input_boolean.script_ran`, a `quick_job` toggle script). Onboard it with `scripts/mqtt/ha_discovery/onboard.py DIR`.
|
||||
- `hsw.yaml` mirrors both scripts and the flag with homeassistant switches, with template buttons that call
|
||||
`switch.turn_on` and `switch.turn_off`.
|
||||
- `haflow.py TOKENFILE` adds the device with the esphome config flow and turns on `allow_service_calls` in the options
|
||||
flow; without it the device's action calls are refused.
|
||||
- `drive.py TOKENFILE NAME` presses the buttons through the REST API and prints the script and flag states after each
|
||||
step.
|
||||
|
||||
Notes:
|
||||
- homeassistant import entities default to `internal: true`, so the mirrors are not Home Assistant entities; read
|
||||
them from the device's `Got state` log lines.
|
||||
- Turning a script off stops it mid run (the flag stays on). A script that finishes at once reports on, then off, in
|
||||
the same second.
|
||||
|
||||
## Subscription order and dump order (#22725)
|
||||
|
||||
- `hadrive.py` also prints `<phase> SUBORDER NNN <line>` in the order the device sent the subscriptions (the SUB lines
|
||||
are sorted). `grep -v SUBORDER drive.txt` diffs the sets, `grep SUBORDER` the order.
|
||||
- Dump block order per build: `python3 scripts/lognorm.py boot1.txt | grep -a "^\[C\]\[" |
|
||||
sed -E 's/^\[C\]\[([a-z_.0-9]+)\]: (.{0,40}).*/\1 | \2/' | awk -F' [|] ' '{ if ($1!=p) {print $1 " :: " $2; p=$1} }'`
|
||||
prints one line per component run; diff dump text between builds through `lognorm.py` too, which drops the
|
||||
`:NNN` line numbers.
|
||||
- Idle ESP8266 free heap in this config swings by 2 kB between readings; compare the steady reading (the fifth one
|
||||
after boot) per boot, which matched the heap_size change exactly (+168 B for 15 import entities on #22725).
|
||||
- The wizard light (`l_wiz`) needs #21908; a stack based before it needs it dropped on both builds (`NO_LIGHT=1`).
|
||||
@@ -0,0 +1,46 @@
|
||||
# Improv serial and BLE (#22597)
|
||||
|
||||
`scripts/improv/` drives Improv on a freshly erased board with no saved network:
|
||||
|
||||
- `improvcli.py PORT OUT --secrets FILE`: Improv serial client. It shares the console with the logs and parses
|
||||
frames out of the log stream. The flow: 300 stray bytes with no `I` in them, state, info, network state, scan, a
|
||||
bad password (expect `unable_to_connect` after about 30 s), the real password, then state and network state
|
||||
again. It ends with a count of frames, bad frames, port resets, reboots and log lines. Credentials come from the
|
||||
secrets file and are never printed, and the SSID is masked in scan results. It reopens a native USB port that
|
||||
re-enumerates. A reboot is counted from each new `Running through setup()` log line after the settle, so a board
|
||||
behind a USB-UART bridge that reboots without a port reset is caught too.
|
||||
Every request must get its reply; a missing reply, an unexpected error, a malformed frame, a port reset or a
|
||||
reboot fails the run. `--skip-bad` leaves out the bad password case, `--keep-dtr` leaves DTR asserted,
|
||||
`--allow-reset` accepts a reboot.
|
||||
- `improvble.py NAME SECRETS`: Improv BLE client (bleak). Finds the device by name, sends WIFI_SETTINGS and prints
|
||||
the state changes and the RPC result URLs. Needs `improv_ble` (formerly `esp32_improv`) with `authorizer: none`
|
||||
and a `next_url`; the result must carry a URL.
|
||||
- `common.yaml`: package with Wi-Fi and no network, `web_server`, `improv_serial` with a `next_url` (so the
|
||||
provisioned reply carries URLs) and an ALIVE line every 5 s. `example-esp32.yaml` uses it on a classic ESP32.
|
||||
- `run.sh NAME [improvcli args]` (env `TREE`, `PORT`, `SECRETS`, `PY`): compile, erase, flash and run the client.
|
||||
It erases with esptool, so ESP chips only; on LibreTiny or RP2040 erase and flash with that platform's tools and
|
||||
run `improvcli.py` directly. Both clients end with PASS or FAIL and exit non-zero on FAIL.
|
||||
|
||||
Per board:
|
||||
|
||||
- Improv serial uses the logger's UART, so the client must open the port the log is on. On LibreTiny check which
|
||||
UART `logger: hardware_uart: DEFAULT` resolves to (see the board notes).
|
||||
- BW15: drop `web_server:` or add an `ap:` (it resets during setup otherwise), and pass `--allow-reset` for the known
|
||||
reboot after `Disabling AP`; the provisioned reply usually goes out first, not always. See `reference/boards.md`.
|
||||
- ESP32-C3 on USB_SERIAL_JTAG: passes with and without `--keep-dtr`; its reboots only show in the
|
||||
`Running through setup()` count (see `reference/boards.md`). The scan returns only the last scan's results, which
|
||||
are empty in the first seconds after boot; use `--settle 10` or more when the target network should be listed.
|
||||
- Pico 2 W: run with `--keep-dtr` (see `reference/boards.md`). Its Improv scan lists no networks, on dev and PR alike.
|
||||
- Erase the flash between builds: a saved network skips the provisioning path entirely. Both clients fail at once
|
||||
when the board already reports `provisioned`; erase the flash first. A new config name does not help: the
|
||||
network is saved under a fixed key when the config has no `networks:`. A provisioned board also stops advertising
|
||||
Improv over BLE, so `improvble.py` reports the device as not found.
|
||||
- If the real password fails right after the bad password case, rerun once before blaming the change: on the C3 it
|
||||
failed once (`Auth Leave` while Wi-Fi was still retrying the bad network) and passed on every rerun.
|
||||
|
||||
When posting results:
|
||||
|
||||
- Scan results list the neighbours' SSIDs; filter `RPC cmd=4 len=[1-9]` lines out of anything you post.
|
||||
- Mask IP addresses in the result URLs.
|
||||
- Cover a long password too: provision once against a network whose password is 20 characters or more (the client
|
||||
prints the length).
|
||||
@@ -61,3 +61,10 @@ frame of two LEDs set to `Color(0xA5, 0x3C, 0x0F)` reads `3ca50f3ca50f`.
|
||||
- An RP2350 `panic()` escalates to a HardFault and the rp2 crash handler reboots within about a second, so a panic
|
||||
during component setup boot-loops before USB CDC enumerates and the board looks dead (no port, no BOOTSEL drive).
|
||||
Hold BOOTSEL while plugging it in and flash the UF2 drive. To see such a fault, trigger it after boot.
|
||||
|
||||
## Counting a PIO strip's edges on its own pin (#16243)
|
||||
|
||||
A GPIO interrupt on the strip's own data pin (`gpio_set_irq_enabled_with_callback(pin, GPIO_IRQ_EDGE_RISE, ...)`)
|
||||
counts every bit the PIO program sends, with no wires or LEDs; a strip that sends nothing shows 0 edges per report.
|
||||
Log the PIO block's state machine enable mask and program counters next to the count. `pio_probe/pio-common.yaml`
|
||||
clears PIO1 instruction memory at boot because it survives a reflash (see `reference/boards.md`).
|
||||
@@ -34,3 +34,11 @@ wave on the same pad no longer reaches the input (the pad reads 0).
|
||||
- Result on #21074 at 2ef417bd81 with peripherals powered down: the PR caught all 644 real edges (dev 66) but added
|
||||
4642 calls while the line was high, one per sleep cycle (about 16 ms), with the level read correctly. Peripherals
|
||||
on: both builds caught every edge. https://github.com/esphome/esphome/pull/21074#issuecomment-6503939850
|
||||
|
||||
## Power lock check
|
||||
|
||||
`power_management: esp32_power_management` with `profiling: true` and an `interval` lambda that calls
|
||||
`esp_pm_dump_locks(stdout);` prints the lock and mode tables on the USB console (not through the ESPHome logger).
|
||||
Compare lock lists between builds: `usb_serial_jtag` holds `NO_LIGHT_SLEEP` by itself. For a soak that the USB console
|
||||
must not keep awake, set `logger: hardware_uart: UART0`, dump the locks into `open_memstream()` and log the SLEEP,
|
||||
CPU_MAX and light sleep count lines, read over the API.
|
||||
@@ -16,3 +16,18 @@ states, saves the device log). Before 8cc8df4a1f a modem only config with `api:`
|
||||
config dependent `AUTO_LOAD` added `network` after the dependency check; an explicit `network:` block was the
|
||||
workaround. Results: https://github.com/esphome/esphome/pull/6721#issuecomment-6347395159 and
|
||||
https://github.com/esphome/esphome/pull/6721#issuecomment-6348520416
|
||||
|
||||
## SIM7080G on an M5Stack Atom Lite (#6721)
|
||||
|
||||
The M5 Unit CatM (SIM7080G) on the Atom Lite's Grove port: RX GPIO32, TX GPIO26, `model: SIM7080`.
|
||||
`templates/modem/modem-passthrough.yaml` is a raw UART passthrough with both directions logged, and
|
||||
`scripts/modem/mdrive.py HOST LOGFILE text:AT+CPIN? wait:5 ...` sends AT commands through it and saves the
|
||||
replies, to check what the module does with no component in the way.
|
||||
|
||||
- With no SIM, the component sets the `SIM not ready` warning and polls `AT+CPIN?` once a second.
|
||||
- With a SIM that has no data plan, `AT+CGATT=1` blocks the AT channel for about 141 s and then answers `ERROR`.
|
||||
The module answers nothing meanwhile, so the component logs `Network attachment request refused` and then `Modem not
|
||||
responding`, and loops every 2 minutes 22 seconds.
|
||||
- `AT+CFUN=1,1` leaves the module silent for about 2.5 minutes. It comes back without a power cycle.
|
||||
- A module left in CMUX (`AT+CMUX=0`, then an ESP restart) recovered 10 of 10 times (`Autodetect mode: 5`).
|
||||
- PPP and a warm reboot during PPP need a SIM with a working data plan.
|
||||
@@ -0,0 +1,29 @@
|
||||
# nPM1300 PMIC on the Seeed XIAO nRF54LM20A (#22661)
|
||||
|
||||
Scripts: `scripts/npm1300/`. The board's nPM1300 sits at 0x6B on P1.18 (SDA) and P1.17 (SCL); board facts, including
|
||||
which rails must never be switched off, are in `reference/boards.md`.
|
||||
|
||||
- Probe first: `npmprobe.yaml` has the hub with no regulator or charger settings, scans the bus and dumps the
|
||||
registers every 20 s, so you see what is on before any setting is written.
|
||||
- `npm-all.yaml` (with `npmcommon.yaml`) has every sensor, binary sensor, text sensor and switch, logs each value from
|
||||
`on_value` and `on_state` lambdas (entity state lines are VERBOSE on dev, so DEBUG shows nothing without them), dumps
|
||||
the registers and switch states, and toggles the charger and LDO1. Put a setting under test (the VBUS limit, the
|
||||
charger values) in `npmcommon.yaml`, not in the per-run file.
|
||||
- `regdump.yaml` reads a fixed register list with `id(pmic).read_register16()` and logs `REGS 0201=.. ...`; compare two
|
||||
builds' dumps after stripping timestamps and source line numbers.
|
||||
- `runone.sh NAME CONFIG PORT [SECS]` flashes with `esphome run --no-logs` (pyOCD) while a serial capture stays open on
|
||||
the same port. Builds without `ota:` have no MCUboot.
|
||||
|
||||
Findings:
|
||||
|
||||
- With no battery and the charger on, VBAT reads about 4.23 V, IBAT about 0.2 mA, battery detected is ON and the status
|
||||
flips between Trickle Charge and Constant Current; with the charger off it says No Battery, and it can drop to Not
|
||||
Charging for one update on its own. The battery temperature stays at 24.6 C (a fixed 10 k on the NTC pin). Charge
|
||||
current scale and sign need a real cell.
|
||||
- ADCIBATMEASSTATUS (0x0510) reads 0x0C (charge) most of the time with no cell and the charger on, sometimes 0x08 or
|
||||
0x0F.
|
||||
- `vbus_current_limit: 300mA` writes ILIM0 and ILIMSTARTUP as 0x03 and the board stays up on USB.
|
||||
- BUCKSWCTRLSEL (0x040F) keeps its value across reflashes until a power cycle, so a setup write to it shows no change on
|
||||
a warm board.
|
||||
- To prove a setup priority change, add `on_boot` hooks at 1001, 950 and 900 that log markers and see where the
|
||||
component's first publishes land between them.
|
||||
@@ -101,3 +101,14 @@ once on a build without TCP, or `tcp ok udp ok` twice and no error with it. Add
|
||||
come back, and connect with `apicheck.py ADDR` over Thread. Measured on the ItsyBitsy: 12.9 KB less flash and 17.1 KB
|
||||
less RAM without TCP (Zephyr's default pools, 16/16 instead of 24/48), and SMP over UDP OTA still works with them.
|
||||
Results: https://github.com/esphome/esphome/pull/21910#issuecomment-6518287139
|
||||
|
||||
## sdk-nrf 3.4.1 on the ItsyBitsy (#22233, #22558)
|
||||
|
||||
- Set `framework: version: 3.4.1` and `board: adafruit_itsybitsy`.
|
||||
- Trees before #22233 include `<nrf.h>` in `logger_zephyr.cpp`, which 3.4.1 no longer has on the include path, so
|
||||
Adafruit bootloader boards fail to build (`nrf.h: No such file or directory`). To test such a tree on 3.4.1, change
|
||||
that include to `<nrfx.h>` locally.
|
||||
- On the new USB stack, `usb_cdc_acm` bulk echo ran at about half the legacy rate (67 against 121 KiB/s for 64 KiB),
|
||||
and `flush()` returned `3`. The logger, DTR, line coding and the 1200 baud touch worked.
|
||||
- The zephyr_ble_server flow above, on 3.4.1: before #22558 advertising failed to restart after the first disconnect
|
||||
(`Advertising failed to start (rc -12)`); with it the server took 39 connections in 120 s.
|
||||
@@ -0,0 +1,32 @@
|
||||
# one_wire
|
||||
|
||||
## ESP8266 interrupt locks under Wi-Fi load (#22452, #22453)
|
||||
|
||||
Code that holds interrupts off for long on the ESP8266 starves the Wi-Fi interrupt handler (reset signatures in
|
||||
`reference/boards.md`). `scripts/esp8266_lock_load/` is the shared harness for any component that takes such locks:
|
||||
|
||||
- `base.yaml` is the shared DUT base: reset reason and info logged at boot, `power_save_mode: none`, `web_server` for
|
||||
the HTTP load, `api: reboot_timeout: 0s`.
|
||||
- `one-wire.yaml` reads a DS18B20 on GPIO4 every 2 s and runs a bus search every `search_interval`; `busy_control:
|
||||
"true"` replaces the search with the same busy time (13 ms) and no 1-Wire traffic.
|
||||
- `ir-one-pin.yaml` is the remote_transmitter case (see [remote_base.md](remote_base.md)).
|
||||
- `wifi_load.py HOST SECONDS PPS` sends 512 byte UDP datagrams to port 9 at a fixed rate plus back to back GETs of
|
||||
the web_server page.
|
||||
- `run.sh` builds and flashes a DUT, captures the serial log, runs the load and prints every reset reason (usage in its
|
||||
header). A clean run has one BOOT line.
|
||||
|
||||
Make one file per build with `substitutions: {name: ...}` and `packages: {t: !include one-wire.yaml}`, with
|
||||
`secrets.yaml` next to it, and give dev and the PR different names.
|
||||
|
||||
Notes:
|
||||
- Run each build for 45 minutes at 500 packets per second. Shorter or lighter runs often show no reset on either
|
||||
build: one search every 5 s survived on both.
|
||||
- The busy-wait control separates the lock from the CPU time. On #22452 it had no Hardware Watchdog in 45 minutes,
|
||||
while the PR still had 2 (dev had 6), so the remaining resets came from the slot locks. All three builds had one
|
||||
Software Watchdog, which is the busy time plus the load.
|
||||
- A search with no sensor answering is much shorter than one with a sensor (about 190 slot locks per search with
|
||||
one DS18B20), so test with a real sensor on the bus.
|
||||
- A stale `secrets.yaml` gives `No networks found` and the run has no IP to load.
|
||||
- The 1-Wire bus code is shared by every platform, so check a lock change on an ESP32 too: the same DS18B20 search
|
||||
config on ESP-IDF with `bluetooth_proxy` scanning and the same load gave 0 resets and no missed searches on dev and
|
||||
on #22452.
|
||||
@@ -12,7 +12,8 @@ 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`
|
||||
- ESP8266 before #22453: the transmitter sends the whole frame with interrupts off, so a receiver on the same pin
|
||||
sees nothing (from #22453 on it decodes, see below). For older trees, `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.
|
||||
@@ -28,3 +29,131 @@ 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.
|
||||
|
||||
## ESP8266 transmitter to receiver on the same board (#22453)
|
||||
|
||||
- Wire the `remote_transmitter` pin to a `remote_receiver` pin (GPIO12 to GPIO14 on a D1 mini), `inverted: false`.
|
||||
- Keep the receiver's default `idle`. `idle: 4ms` is shorter than the NEC leader space (4.5 ms), so every frame is
|
||||
split and nothing decodes.
|
||||
- Dev before #22453 sends the whole frame inside one `InterruptLock`, so a receiver on the same chip decodes 0
|
||||
frames. That is expected on old builds, not a wiring fault. With locks per edge, 3,692 of 3,695 frames decoded
|
||||
under Wi-Fi load.
|
||||
- Count with `on_nec` matching a counter in the command, and log the counts on an `interval`.
|
||||
- Without a jumper, put both on GPIO12 with `allow_other_uses: true` and call `pinMode(12, OUTPUT)` before each frame
|
||||
(the receiver's setup leaves the shared pin as an input); the receiver's edge interrupt sees the transmitter's own
|
||||
output. `scripts/esp8266_lock_load/ir-one-pin.yaml` does this, and its `run.sh` adds Wi-Fi load (see
|
||||
[one_wire.md](one_wire.md)). Under load, the build that sends the whole frame in one lock hit a Hardware Watchdog in
|
||||
`wDev_ProcessFiq` after 11 minutes.
|
||||
|
||||
## Climate IR loopback over the API (#22704 whirlpool, #22709 climate_ir)
|
||||
|
||||
- Pattern: one image with a sending climate and a receiving climate (`receiver_id`) per platform on one shared pin, an
|
||||
aioesphomeapi script that sends climate calls and reads every climate's state after each step. Several platforms can
|
||||
share one receiver; each rejects the others' frames. Scripts in `scripts/climate_ir_loop/`: `drive.py`
|
||||
(steps `Name:mode=cool,t=24,fan=low,swing=vertical,preset=eco` or `svc:action?flag=1`), `run.sh NAME PORT [STEPS]`
|
||||
with `steps.sh` (prelude and steps), `frames.py NAME` (splits the `dump: raw` lines per step), `compare.py A B
|
||||
[TOL] [--flat]` (per step, or with `--flat` the whole sequence timing by timing), `base.yaml` (network, API and
|
||||
logger), `c-common.yaml` (Samsung, Friedrich, Siemens IRA211 and Mistral senders and receivers), `esp32-ir.yaml`
|
||||
(GPIO27) and `esp8266-ir.yaml` (GPIO12) as one-pin loopback board packages (`pin`, and on the ESP32 `rmt_symbols`
|
||||
and `receive_symbols`, are substitutions; the Pronto configs include them too), `c32pr.yaml` (an example run file)
|
||||
and `whirlpool-inject-common.yaml` (injected frame actions).
|
||||
- ESP32-PICO-D4 kit: GPIO4 does not loop back cleanly (every mark reads 162 µs short, a -162 space leads the frame, so
|
||||
nothing decodes). GPIO27 gives exact timings (572/553/1659 µs). Try another pin before suspecting the code.
|
||||
- RMT ends a frame on any level longer than `idle`, mark or space. A whirlpool 14 byte frame ends after a 7,960 µs gap,
|
||||
so its decoder needs the trailing idle to be within 25% of that, but the 9 ms header mark must stay below idle:
|
||||
`idle: 9500us` works, 8500 cuts the header off.
|
||||
- Restored climate state changes the first frames (power toggles, Samsung power section): start every run with a
|
||||
prelude that puts each sender in a fixed state (every field each sender supports, such as humidity for daikin_arc
|
||||
or a fan mode daikin_brc supports), and compare only the frames after it. ESP8266 restore lives in RTC memory, so a
|
||||
receiver's state can carry over from the previous image.
|
||||
- Inject frames a sender cannot produce (an out of range temperature code, a short frame) from an API action lambda with
|
||||
`item_bytes<BitTimings>` and `call.perform()`.
|
||||
- Assigning frames to steps by host timestamps is fragile on the D1 mini (a log line can land after the next step
|
||||
starts); compare the whole frame sequence in order instead. Two frames sent back to back (siemens_ira211 power plus
|
||||
sync) come out as one dump, and the gap between them varies by up to 1 ms on ESP8266.
|
||||
- Samsung power frames are 347 timings: an ESP32 receiver needs `rmt_symbols: 384` and `receive_symbols: 384`.
|
||||
|
||||
## Protocol A/B with `dump: all` (#22711)
|
||||
|
||||
- One button per `transmit_<protocol>` action, one binary sensor and one `on_<protocol>` trigger per protocol, each
|
||||
logging a marker; count markers and compare the dumper lines of the dev and PR runs in order. All of nec, dooya,
|
||||
nexus, aok and cardin_s438 decode in the ESP32 GPIO27 loopback with the default idle.
|
||||
- Cardin S438 picks a random seed per frame (`random_uint32()`), so its pronto and cardin lines differ between any two
|
||||
runs; compare code and channel only. Each press sends 3 repeats, so its trigger and binary sensor fire 3 times.
|
||||
- Start the dump extraction at the first `MARK tx` of any protocol: the API lists buttons by name, not config order.
|
||||
- A Python-only change can still move generated code: diff `src/main.cpp` of the two builds (field order in action
|
||||
setters, defaults now written explicitly).
|
||||
|
||||
## Large climate frames in the loopback (#22710)
|
||||
|
||||
- At 115200 baud the serial log cannot keep up with long `dump: raw` frames (hitachi_ac344 is 691 timings, daikin
|
||||
sends 3 frames per command). Lines get lost or merged, frames show up under the wrong step, and the script reads the
|
||||
receiver state before it has decoded the frame. Use `logger: baud_rate: 921600`, capture with `--baud 921600`, and
|
||||
wait 4 s per step (`BAUD=921600 STEP_S=4 run.sh ...`). A CH340 D1 mini can garble 921600; 460800 carries the long
|
||||
frames cleanly there.
|
||||
- On the classic ESP32 the receiver has no RX ping-pong, so a whole frame has to fit `rmt_symbols`. With a 64 symbol
|
||||
transmitter, `rmt_symbols: 448` and `receive_symbols: 448` hold hitachi_ac344.
|
||||
- Receivers that keep state the frame does not carry (climate_ir_lg swing is a toggle, zhlt01 keeps its preset on
|
||||
"none") start each run from restored state, so compare them without those fields or erase the preferences first.
|
||||
|
||||
## Whirlpool A/B by hex lines (#22710 retest)
|
||||
|
||||
- whirlpool logs every frame at VERBOSE (`Sending:` and `Received:` hex), so on the D1 mini compare those bytes line by
|
||||
line instead of raw timings. One image per model (DG11J1-3A, HITACHI_HCRA31NEWH, HISENSE_ARG; "Hisense ARG" is a
|
||||
whirlpool model, not its own component). `scripts/climate_ir_loop/whirlpool/`: `cl.yaml` (the model
|
||||
as a substitution, combined with `../base.yaml` and `../esp8266-ir.yaml`), `steps.sh`, and `all.sh PORT BASE_TREE PR_TREE`, which builds and runs base then PR per model so the
|
||||
board ends on a PR build.
|
||||
- The HISENSE_ARG receiver reports fan medium for fan_only while the sender says auto (dev too).
|
||||
|
||||
## Pronto dump A/B with `dump: all` (#22752)
|
||||
|
||||
- Scripts in `scripts/remote_base/pronto/`: `gen.py` writes `gen-common.yaml` (buttons for NEC and raw frames of
|
||||
21/41/43/121/245 timings, a soak button with heap logs, a `pronto:` binary sensor), `esp32-ir.yaml` (GPIO27) and
|
||||
`d1-ir.yaml` (GPIO12) include it with the board packages from `climate_ir_loop/`, `run.sh NAME TREE YAML PORT BAUD
|
||||
ROUNDS` flashes, captures, presses every tx button ROUNDS times and then the soak button with `../press.py`, and
|
||||
counts the markers, triggers and `on_press` lines on serial; `extract.py` keeps the dump lines without timestamps
|
||||
and source line numbers, `consist.py` checks every dump against the `on_pronto` text, `jit.py` counts frames that
|
||||
differ between two runs.
|
||||
- The received frame ends with the idle gap as an extra timing (`0181` for the 10 ms idle), so a `pronto:` binary sensor
|
||||
built from the sent timings needs one more number at the end, or the length check rejects every frame. A 41 timing
|
||||
frame is then exactly 230 characters, one full log chunk: a good boundary case.
|
||||
- ESP32 RMT loopback gives byte-identical Pronto text across builds. The D1 mini edge interrupt moves timings by one
|
||||
Pronto unit between any two runs (about half the frames), so compare D1 runs by dump against trigger consistency.
|
||||
- `dump: all` prints NEC lines between the `on_pronto` trigger output and the Pronto dump; the API binary sensor
|
||||
ON/OFF pair can arrive collapsed, so count `on_press` log lines on serial instead.
|
||||
|
||||
## Protocol decode A/B on the host, climate fuzz, AEHA/Haier/Mirage loopback (#22773)
|
||||
|
||||
- `scripts/remote_base/hostharness/`: a `host:` config (`rbhost.yaml`) with the local `rbtest` component in
|
||||
`scripts/remote_base/ext/` (AUTO_LOAD remote_base, `request_protocol()` for every protocol source) and `rbh.hpp` called from `on_boot`; it encodes, mutates, decodes
|
||||
and dumps, then `exit(0)`. Run the `program` binary and compare stdout through `scripts/lognorm.py`. The Haier
|
||||
and Mirage decoders want one more item after the last mark (the receiver's idle gap): append `-20000` to transmitter
|
||||
timings or every clean frame fails.
|
||||
- AEHA frames longer than 35 bytes decode as their first 35 bytes (the trailer mark equals a bit mark).
|
||||
- `scripts/climate_ir_fuzz/`: copy `climate_fuzz.hpp` plus the matching `*_fuzz.cpp.example` (as `.cpp`) into
|
||||
`tests/components/<climate>/` of each tree (haier_tundra also needs `haier_init.py` as `__init__.py`), run
|
||||
`script/cpp_unit_test.py`, diff the `FUZZ` lines. `run()` appends the receiver's idle gap to every frame, and
|
||||
`aeha_random()` builds the random frames for the AEHA climates. All tests of one run share one main.cpp: use a macro include guard,
|
||||
not `#pragma once`, for a header copied to several test dirs.
|
||||
- Lambda idiom checks: compile `void f(AEHAData x) { ... }` snippets with `-fsyntax-only -I<host build>/src` and
|
||||
`#include "esphome.h"` (format_hex lives in alloc_helpers.h).
|
||||
- Loopback config `ir-common.yaml` (AEHA 2 to 35 bytes, Haier, Mirage from an API button, `../press.py HOST tx_all:14 ...`;
|
||||
the trigger lambdas call `rbh_on_frame()` from `rbh.hpp`, so keep the run file next to it). An ESP32-PICO-D4
|
||||
on GPIO27 never decodes 34 or 35 byte AEHA, even with `rmt_symbols: 384`, `buffer_size: 8kb` (dev too); a D1 mini on
|
||||
GPIO12 decodes all of them.
|
||||
|
||||
## Every dumper over a saved corpus, on the host (#22814)
|
||||
|
||||
`scripts/remote_base/dumpall/`: the same `rbtest` component requests every `_PROTOCOL_STEMS` source; `rbh.hpp` needs a
|
||||
`dumpers.h` that `gen_dumpers.py TREE` writes from the `DECLARE_REMOTE_PROTOCOL(...)` lines of the tree (plus Pronto,
|
||||
RCSwitch, ABBWelcome; Raw only when nothing matched). Encoders that randomise (Cardin S438 picks a random seed) make two builds see
|
||||
different inputs: run once with `RBH_CORPUS=<file>` to write the corpus, then replay that file on both builds.
|
||||
Merge back-to-back marks or spaces before decoding (Drayton never decodes otherwise). Nudging a quarter of all
|
||||
timings to the tolerance edges proves nothing (the frame fails elsewhere): put only the sync mark at lo-1, lo, hi,
|
||||
hi+1 and keep the rest exact; that variant caught a planted `< max` in 1,000 decodes per protocol.
|
||||
`cmp.sh` compares the DEBUG and VERBOSE outputs (`rbhost.yaml` built with `-s level DEBUG` and `-s level VERBOSE`)
|
||||
through `scripts/lognorm.py`.
|
||||
- Loopback with `dump: all` (`ir-common.yaml`, `../press.py HOST tx_all:9 tx_all:9 verbose tx_all:9 debug`): Beo4 never decodes on one pin (needs its carrier) and
|
||||
Drayton's channel/command form has no checksum; compare decoded lines, raw and Pronto timings jitter between runs.
|
||||
- `cc-common.yaml`: an ESP32-C3 with a CC1101 in async OOK at 433.92 MHz, GDO0 into remote_receiver, for the RF
|
||||
dumpers on real air (a quiet band gives only a few Pronto dumps a minute and no protocol hits).
|
||||
@@ -21,3 +21,19 @@ captures 40 s from boot and runs `ivsum.py`, which prints the run count, first r
|
||||
runs), so do not compare those offsets between builds.
|
||||
- `main.cpp` shows the class each interval gets (`IntervalTrigger` or `DelayedIntervalTrigger` on #21799).
|
||||
- Results: https://github.com/esphome/esphome/pull/21799#issuecomment-6516798398
|
||||
|
||||
## Freelist trim after boot (ratgdo/esphome-ratgdo#705)
|
||||
|
||||
10 s after setup the scheduler frees its item pool and shrinks its `to_add_` and `items_` vectors
|
||||
(`SCHEDULER_FREELIST_TRIM_DELAY_MS` in `application.cpp`). The first burst of timers after that allocates new
|
||||
items and regrows the vectors once, so heap or timing measurements should skip the first run after boot.
|
||||
|
||||
## RP2 scheduler lock under IRQ and lwIP load (#22688)
|
||||
|
||||
`scripts/rp2_sched_lock/` (README there). The `irq_sched_stress` external component calls `defer()` and `set_timeout()`
|
||||
from a 300 us pico-sdk repeating timer while the main loop does the same; the removed item race integration fixture
|
||||
runs on the board as an API action. `flow.sh` runs the actions, API connect churn (`../api/connstress.py`), REST POST
|
||||
churn and both together, then the actions again, and fails on a failed action, a failed connstress 500x2 or a reboot.
|
||||
Judge by counts, not order: RP2 is `ESPHOME_THREAD_SINGLE`, so `defer()` order is not FIFO on any build. Keep
|
||||
`debug_scheduler` off, it logs from the IRQ. Dev before #22688 failed the defer count on the Pico W; the PR passed.
|
||||
`looptime.sh` compares the 16 ms interval gaps with the API and page loads running between two builds.
|
||||
@@ -73,3 +73,16 @@ address they do not simulate.
|
||||
- An `addressable_light` display writes nothing until its light is turned on.
|
||||
- Before calling a rebased PR's change trivial, diff the PR's own diff (head against its parent) old against new: a
|
||||
move that looks like a merge only can carry real commits from below.
|
||||
|
||||
## TRF7962A fake chip (#22188)
|
||||
|
||||
`scripts/trf7962a_sim/`: `trfsim.hpp` replaces the SPI component's bus (`SPIComponent` is final, so `spi_bus_` is
|
||||
reached through the explicit-instantiation member pointer trick) with a `FakeBus` from `on_boot` priority 800, between
|
||||
the bus (1000) and the reader's setup (600). The bus hands both of the reader's clients (MODE0 write, MODE1 read)
|
||||
delegates on one register, FIFO and IRQ model; the IRQ pad is switched to input/output after setup and driven by the
|
||||
model. `trfpr.yaml` runs the tag scenarios (none, present, slow, flaky, swap, collision, CRC, error flag, bad MSB,
|
||||
TX only, stuck IRQ) and prints per-phase counters (CS, field timing, TX payload, reads without an address). The
|
||||
same FakeBus approach works for any SPI chip whose reply depends on the address byte inside one CS window, which the
|
||||
ESP32 SPI slave cannot fake.
|
||||
The header targets the SPI API of the #22188 branch (`SPIBus` and `SPIComponent::spi_bus_`); dev has since dropped
|
||||
`SPIBus`, so on a newer tree the bus hook has to move to the new delegate creation before it builds.
|
||||
@@ -0,0 +1,30 @@
|
||||
# Tuya MCU simulator (#22724)
|
||||
|
||||
No Tuya device needed. `scripts/tuya_sim/`: `tuyasim.hpp` is a Tuya MCU on a second UART of the same ESP32, cross-wired
|
||||
through the GPIO matrix to the hub's UART (hub tx 9 rx 10, MCU tx 10 rx 9 on an ESP32-PICO-D4, `board: pico32`,
|
||||
`allow_other_uses: true` on all four pins, 9600 baud). It answers heartbeat (0x00 first, then 0x01), product query,
|
||||
conf query with an empty payload (so the hub takes the WIFI_STATE path), wifi state and datapoint query (one report with
|
||||
all 14 datapoints), echoes each DATAPOINT_DELIVER back as a report like a real MCU, and logs every hub frame as
|
||||
`SIM RX #n cmd XX: <hex>`. `tuyasim::start()` (the "Sim start" button) plays 18 scripted steps 1.5 s apart: every
|
||||
datapoint type (bool, value incl. negative, string, enum, 1/2/4 byte bitmask, raw), a four datapoint frame, one
|
||||
DATAPOINT_REPORT_SYNC (the hub must ack with 0x23), a repeated value.
|
||||
|
||||
- `tuya.yaml`: hub plus binary_sensor, switch, three sensors (int, enum, bitmask), three text sensors (string, enum,
|
||||
raw), three selects (enum, string, int), water heater (switch/target/current/mode), number and fan. Hub
|
||||
`on_datapoint_update` lambdas log `HUB dpN x=.. <entity>=..` with the entity's state, and entity triggers log
|
||||
`ENT <id> <value>`, so the hub-before-entity order and the old state the hub sees are visible per datapoint.
|
||||
`name: ${name}`, built with `pio_build.sh compile <name>` per tree.
|
||||
- `tuyadrive.py HOST OUT.json` (API_KEY env): subscribes states, presses Sim start, then sends switch, select,
|
||||
water heater (on, target, mode eco/electric, off), number and fan commands 2 s apart; prints per phase counts.
|
||||
- `run.sh NAME TREE` (env PORT, API_KEY): upload, serial capture with a reset (stopped after the drive), drive.
|
||||
- `compare.sh A B`: normalises both logs with `../lognorm.py` and diffs API states, the entity dump block, the 1 s re-dump, the HUB/ENT order and the non-heartbeat
|
||||
frames the simulator received. Heartbeats move with timing, so they are left out.
|
||||
|
||||
Facts from the run:
|
||||
- At init the fan delivers its own state (`1f01000100`) before DP31 is known and the hub logs `Setting unknown
|
||||
datapoint 31`; same on dev.
|
||||
- The API coalesces states published in one loop pass: the four datapoint water heater frame gives one state.
|
||||
- A switch or select command for the value it already has sends no frame.
|
||||
- Water heater target 55 with multiplier 0.5 is sent as 110 (`15 02 0004 0000006e`); eco/electric as enum 0/2 on DP23.
|
||||
- #22724 changed only the dump order (children now print right after the hub's own lines); `setup_priority:` on a
|
||||
tuya sensor is rejected on the PR and accepted on dev.
|
||||
@@ -72,3 +72,23 @@ case, and `T1 X` shows which frames got through.
|
||||
about 49 s after reset. Only the second boot logs `CASE done`, so a skipped reboot fails the run.
|
||||
|
||||
See `rs485_frame.md` for the same cross-wired UART trick on an ESP32-C3.
|
||||
|
||||
## Duco ventilation box (#22560)
|
||||
|
||||
`scripts/uart_sim/duco/`: `ducosim.hpp` is the box model from `tests/integration/fixtures/uart_mock_duco.yaml` (ack
|
||||
plus answer, AA 01 stuffing, CRC16) on a second UART of the same board; on an ESP32-C6 the hub used tx 18 rx 19 and
|
||||
the box tx 19 rx 18 at 57600, wired across. `gen.py NAME pr|dev` writes the config (every text sensor, sensors, mode,
|
||||
comfort, sntp clock) with an `on_value` log per entity (`STATE id = '...'`, newlines as `\n`); `DUCO_VERBOSE=1` shows
|
||||
`Found node`, `DUCO_SERIAL_SIZE=18` gives the dev fixture's short serial answer. `run.sh NAME KIND SECONDS` (env
|
||||
`TREE`, `DUCO_PORT`, `PY`, optional `BUILD_LOCK`), run from a scratch directory with a copy of `ducosim.hpp`,
|
||||
generates, builds through `scripts/pio_build.sh`, flashes and captures with `scripts/serial_capture.py`; a pr build
|
||||
ends with `check.py` against `expected.txt` (exit 1 on a mismatch), and the model logs requests it has no answer for.
|
||||
- Answer one request per poll call. Answering a 26 request burst in one pass blocks about 100 ms and overflows the
|
||||
hub's 256 byte UART RX buffer, which silently drops the serial and version answers every round.
|
||||
- Dev's hub frame is 32 bytes: the PR model's 34 byte serial answer is dropped there and duco sets "No answer".
|
||||
- Error cases 7 (three long, 210 B) and 8 (four short, 148 B) check that the code-only fallback goes by length.
|
||||
|
||||
## ESP8266 software serial byte checks
|
||||
|
||||
The worst case for an unlock after a trailing run of high bits is a frame of bytes all below 0x80; a mixed frame
|
||||
hides it.
|
||||
@@ -24,3 +24,8 @@ identical payloads share one table, a lambda is sent from its vector. An empty c
|
||||
(`sendto() error 22` in the log, no datagram) until it accepted `nullptr` with a zero length; the old
|
||||
`TemplatableBytes::visit` had passed a zero length stack buffer instead. Compare sizes against the stacked PR's own
|
||||
head when the PR is stacked, not against dev. Results: https://github.com/esphome/esphome/pull/21263
|
||||
|
||||
## Two sockets on one port (#22509)
|
||||
|
||||
lwIP lets two sockets bind one UDP port when `SO_REUSEADDR` is set, and unicast then goes to the socket opened
|
||||
last; without it the second bind fails with errno 112.
|
||||
@@ -59,3 +59,46 @@ valve, update, alarm_control_panel or water_heater entity reboots with `Exceptio
|
||||
`json::linked(const char *)` (the ROM `strlen` on a flash address), fixed by #21316. The cover in the template keeps
|
||||
that path covered; before #21316 is merged, apply its one line change to both trees or the web_server comparison
|
||||
cannot run.
|
||||
|
||||
## Basic auth on the async web servers (ESP8266, RP2040, LibreTiny)
|
||||
|
||||
`scripts/web_auth/` (see its README) fuzzes Basic auth over raw sockets: functional routes with and without
|
||||
credentials, wrong credentials, other schemes, a tampered hash, spacing and case, then large headers, many failed
|
||||
attempts next to an authenticated `/events` stream, and a timing comparison of wrong first and last bytes. It also
|
||||
has a captive portal client package that probes `/`, `/config.json`, POST with and without credentials and
|
||||
`/wifisave`. `compare.py` lines a dev run up with a PR run. These scripts were still being extended when copied here.
|
||||
The README also covers the newer flows: the heap under paced connection churn (`heap_churn.py`, the LibreTiny TIME_WAIT
|
||||
check for #22696) and the main task stack high-water mark with the JSON arena (`arena/`, #22699).
|
||||
|
||||
## Per-session /events listing on ESP32 (#22691)
|
||||
|
||||
Checks that a new `/events` client's entity listing goes only to that client. Config
|
||||
`scripts/web_server/sse-listing.yaml` (ESP32 ESP-IDF, web_server version 3, 19 entities, 3 sorting groups, heap logged
|
||||
every 5 s); build each head with a different `-s name` through `pio_build.sh`. Driver:
|
||||
`python -I scripts/web_server/sse_listing.py DEVICE_IP --rounds 4 --out events.jsonl`. Each round opens streams 1 and
|
||||
2, waits for their listing, connects stream 3 and counts for 10 s per stream. A `state` event that carries `domain`
|
||||
is a full detail (detail_all) entry; a `ping` with only `uptime` is the 10 s keepalive, any other `ping` the greeting
|
||||
(config JSON). The greeting and `sorting_group` events always go only to the new session, so only the detail_all
|
||||
count tells the builds apart. Ends `RESULT PASS` or `RESULT FAIL` (exit 0 or 1).
|
||||
|
||||
On an ESP32-PICO-D4 the control sent all 19 detail_all entries to streams 1 and 2 on every round, the PR none; stream 3
|
||||
was ordered on both.
|
||||
|
||||
## /events stream rework checks (#21973)
|
||||
|
||||
Config `scripts/web_server/stream-dut.yaml` (ESP32 ESP-IDF, 20 ms template sensor, a "Wifi Drop" button that runs
|
||||
`wifi.disable`, 8 s, `wifi.enable`, heap every 5 s). `scripts/web_server/stream_retest.py HOST MODE` has five modes:
|
||||
`head` (raw bytes of the first 3 s; compare two builds with `head_compare.py A B NAME_A NAME_B`, which masks numbers
|
||||
and the device name), `multi` (4 clients 20 s, events and longest gap), `stall` (a client with a 2 KB receive buffer
|
||||
stops reading for 35 s; read the close time from `Closing stuck stream`, or `Closing stuck EventSource connection` on
|
||||
older builds), `wifidrop` (REST press, the client reconnects after 5 s idle like a browser `EventSource`) and `churn`
|
||||
(40 connects, 20 of them reset, then a fresh client). `stream_runall.sh NAME PORT` uploads, captures and runs every
|
||||
mode. Both builds should close the stalled stream at about 20 s and close the stream at the Wi-Fi drop.
|
||||
|
||||
- `sse_listing.py` prints stream 3's TCP connect and first event times. A late greeting (3 to 4 s) was TCP connect
|
||||
time on the network (SYN retransmits), seen on the control too, not the device.
|
||||
- On a noisy Wi-Fi network multi-client runs fell to 110 to 900 events per client with every client pausing together,
|
||||
and a stalled client sometimes missed the EOF although the device logged `Closing stuck stream`. Alternate the
|
||||
builds (flash A, 4 multi runs, flash B, repeat) before calling a rate difference.
|
||||
- Log text check for refactors: collect every `[web_server*]` line from all captures, mask timestamps, source line
|
||||
numbers and digits, `sort -u`, and diff the two builds' sets.
|
||||
@@ -93,3 +93,27 @@ connected channel starts and ends on the bench channel with another channel in b
|
||||
- Dropping the AP under a connected device gives a `Beacon Timeout` link loss.
|
||||
- The 90 s interval fires once right after boot.
|
||||
- A `Disconnected ... Association Leave` right after `Connecting to` is the aborted attempt, not a missed connect.
|
||||
|
||||
## Soft AP with the BLE tracker scanning (#22534, #22566)
|
||||
|
||||
`scripts/ble_scan_soft_ap/`: `dut.yaml` runs only `wifi: ap:` with `captive_portal:` and `bluetooth_proxy:`, and
|
||||
`client.yaml` (on a second ESP32) joins that AP and fetches the portal page every 5 s, logging `JOIN` and `STAT`
|
||||
lines. `run.sh` erases and flashes the DUT, resets the client and prints the generated scan window, the first join, the
|
||||
page counts and the client's disconnect reasons (usage in its header).
|
||||
|
||||
- A scan window equal to the scan interval (320 ms of 320 ms) leaves the radio no time for the soft AP: on dev no
|
||||
client joined on the classic ESP32, S3, C3 or C6. With #22566 the tracker uses its 30 ms connection window while
|
||||
the AP runs, and every chip took a client in about 4 s.
|
||||
- Only one AP with the test SSID may be up at a time; list the other AP boards in `PARK` so they wait in their ROM
|
||||
bootloader.
|
||||
- To check that the full window comes back after provisioning, log `esp32_ble_tracker` at VERBOSE and provision
|
||||
with `templates/client-wifisave.yaml` (set `ap_ssid` to the DUT's and `ap_password: ""`, the DUT's AP is open): `Connection or AP active, using 48 unit scan window` must stop once the AP stops.
|
||||
- Some clients do not join an ESP8266 AP at all (the C6 failed on dev too with `Too Many Associations`); use a C3.
|
||||
|
||||
## ESP8266 power save after captive portal provisioning (#22542, #22564)
|
||||
|
||||
The DUT runs `ap:` plus `captive_portal:` with no station network and logs `wifi_get_sleep_type()` every 5 s (0 is
|
||||
`NONE_SLEEP_T`, 2 is `MODEM_SLEEP_T`); an ESP32-C3 with `templates/client-wifisave.yaml` posts the real credentials.
|
||||
Erase the flash before each run so no saved credentials skip the portal. On dev the sleep type stayed 2 after
|
||||
provisioning although the config asked for none; with #22564 it read 0 from the moment the AP started, and the
|
||||
`networks:` path still read 0.
|
||||
@@ -0,0 +1,9 @@
|
||||
# wled
|
||||
|
||||
## Realtime sender on the bench (#22509)
|
||||
|
||||
When the access point stops passing traffic between clients (lwIP `sendto` on the sender fails with errno 12
|
||||
because ARP never resolves), run the sender on a board instead of the host: an ESP32-S3 runs `wifi: ap:` and a
|
||||
25 ms interval lambda sends WARLS, DRGB or DNRGB frames with lwIP `sendto` to the devices under test, which join
|
||||
that AP with `manual_ip`. Two lights on the same port: see `udp.md`. Heap after an effect stops: see
|
||||
`heap_alloc.md`.
|
||||
@@ -36,3 +36,22 @@ tracker as scan results: everything after the radio runs as normal.
|
||||
first one it hears.
|
||||
- Each frame arrives about 4 times; the counts matched the injection run exactly apart from one radio loss, so the
|
||||
over the air comparison allows two missing publishes per tag.
|
||||
|
||||
## Every Xiaomi platform at once (#22727)
|
||||
|
||||
- `gen_all.py` writes `frames_all.hpp`, `xball_entities.yaml` and `expected_all.json`: one device per platform
|
||||
(the 20 listener-only platforms, `xiaomi_mue4094rt`, `xiaomi_rtcgq02lm` hub, `xiaomi_body_scale`, ATC, PVVX),
|
||||
10 cycles, every frame sent twice. `mibeacon.py` holds the frame builders and the C++ injector that `gen.py`
|
||||
and `gen_all.py` share. Each entity logs `PUB <dev>.<key> <value>` on publish (binary sensors with
|
||||
`trigger_on_initial_state: true`). Frame shapes that parse: long encrypted (fc 0x58) only up to 24 bytes, so
|
||||
a 7 byte `th` object needs the short 19 byte frame, which only lywsd02mmc, xmwsdj04mmc, mjyd02yla, cgpr1 and
|
||||
rtcgq02lm accept; hhccjcy10 is FD50 9 bytes and miscale v1 181D 10 bytes (no counter, the repeat publishes
|
||||
again); mue4094rt is a plain fc 0x40 frame; body_scale an S200 0x4E16 object in a 24 byte short frame.
|
||||
`xiaomi_mccgq02hl` publishes 9 of 10: the first frame is "closed", which equals its initial off state.
|
||||
- `xball.yaml` is an ESP32-S3 (ESP-IDF, no network, USB_SERIAL_JTAG log) that injects one cycle per second from
|
||||
20 s and logs free heap before and after (`IDLE` lines). `run_all.sh TREE NAME PORT` builds, flashes, captures
|
||||
and counts; `count_all.py cap1 cap2 ...` also says whether the values are identical across builds.
|
||||
- `xbsetup_priority.yaml`: `esphome config` with `setup_priority:` on a moved sensor, a moved binary sensor and
|
||||
mue4094rt (still a component); remove one at a time, since validation stops at the first platform error.
|
||||
- On #22727: 441 publishes on the PR, its stacked base and dev, identical values; dump text identical, the PR prints
|
||||
the 20 listener dumps after `BLE Tracker:`.
|
||||
@@ -21,3 +21,39 @@ uart_button/uartbtn*.yaml
|
||||
value_range/rng*.yaml
|
||||
ld2420_sim/ldenergy*.yaml
|
||||
ld2420_sim/ldsimple*.yaml
|
||||
apikey.txt
|
||||
pio/
|
||||
rp2_web_ble/*.log
|
||||
rp2_web_ble/*.txt
|
||||
rp2_web_ble/*.pcap
|
||||
gatt_uuid/*.json
|
||||
gatt_uuid/*.txt
|
||||
web_auth/configs/*.log
|
||||
web_auth/configs/*.txt
|
||||
web_auth/configs/*.json
|
||||
improv/*.log
|
||||
npm1300/*-cap.txt
|
||||
npm1300/*-cap.err
|
||||
npm1300/*-run.log
|
||||
rp2_sched_lock/*.txt
|
||||
rp2_sched_lock/*.log
|
||||
climate_ir_loop/*-*.txt
|
||||
climate_ir_loop/*-frames.json
|
||||
climate_ir_loop/whirlpool/w??base.yaml
|
||||
climate_ir_loop/whirlpool/w??pr.yaml
|
||||
tuya_sim/*.txt
|
||||
tuya_sim/*.json
|
||||
remote_base/pronto/*.txt
|
||||
remote_base/pronto/gen-common.yaml
|
||||
remote_base/dumpall/dumpers.h
|
||||
remote_base/dumpall/db.txt
|
||||
remote_base/dumpall/dp.txt
|
||||
remote_base/dumpall/vb.txt
|
||||
remote_base/dumpall/vp.txt
|
||||
xiaomi_ble/*-cap.txt
|
||||
xiaomi_ble/frames_all.hpp
|
||||
xiaomi_ble/xball_entities.yaml
|
||||
xiaomi_ble/expected_all.json
|
||||
xiaomi_ble/run_*.yaml
|
||||
ble_scan_complete/*.txt
|
||||
ble_scan_complete/*.err
|
||||
@@ -0,0 +1,88 @@
|
||||
"""
|
||||
Rapid native API connect/disconnect stress test (from esphome#14687 and esphome#14706).
|
||||
|
||||
usage: connstress.py HOST [ITERATIONS] [CONCURRENCY] (default 500 iterations, 4 at a time)
|
||||
env: API_KEY (base64 noise key; unset, empty or - for plaintext), API_PORT (default 6053), API_PASSWORD
|
||||
Each attempt connects with login, disconnects and counts a failure on any error or a 10 s timeout on either step.
|
||||
Exits 1 when any attempt failed. Watch the serial log for crashes: the client only sees resets.
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import contextlib
|
||||
import os
|
||||
import sys
|
||||
import time
|
||||
|
||||
from aioesphomeapi import APIClient
|
||||
|
||||
HOST = sys.argv[1] if len(sys.argv) > 1 else sys.exit(__doc__)
|
||||
PORT = int(os.environ.get("API_PORT", "6053"))
|
||||
PASSWORD = os.environ.get("API_PASSWORD", "")
|
||||
NOISE_PSK = (
|
||||
None if os.environ.get("API_KEY") in (None, "", "-") else os.environ["API_KEY"]
|
||||
)
|
||||
|
||||
|
||||
async def connect_disconnect(client_id: int, iteration: int) -> tuple[int, bool, str]:
|
||||
cli = APIClient(HOST, PORT, PASSWORD, noise_psk=NOISE_PSK)
|
||||
try:
|
||||
await asyncio.wait_for(cli.connect(login=True), timeout=10)
|
||||
# a disconnect that hangs on a wedged device is a failure too, not a stuck slot
|
||||
await asyncio.wait_for(cli.disconnect(), timeout=10)
|
||||
return iteration, True, ""
|
||||
except Exception as e: # noqa: BLE001 every failure is a counted result
|
||||
return (
|
||||
iteration,
|
||||
False,
|
||||
f"client{client_id} iter{iteration}: {type(e).__name__}: {e}",
|
||||
)
|
||||
finally:
|
||||
with contextlib.suppress(Exception):
|
||||
await asyncio.wait_for(cli.disconnect(force=True), timeout=10)
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
iterations = int(sys.argv[2]) if len(sys.argv) > 2 else 500
|
||||
concurrency = int(sys.argv[3]) if len(sys.argv) > 3 else 4
|
||||
print(f"Iterations: {iterations}, Concurrency: {concurrency}", flush=True)
|
||||
|
||||
success = fail = 0
|
||||
errors: list[str] = []
|
||||
start = time.monotonic()
|
||||
sem = asyncio.Semaphore(concurrency)
|
||||
|
||||
async def run(client_id: int, iteration: int) -> tuple[int, bool, str]:
|
||||
async with sem:
|
||||
return await connect_disconnect(client_id, iteration)
|
||||
|
||||
tasks = [asyncio.create_task(run(i % concurrency, i)) for i in range(iterations)]
|
||||
for coro in asyncio.as_completed(tasks):
|
||||
_, ok, err = await coro
|
||||
if ok:
|
||||
success += 1
|
||||
else:
|
||||
fail += 1
|
||||
errors.append(err)
|
||||
total = success + fail
|
||||
if total % 10 == 0 or not ok:
|
||||
rate = total / max(time.monotonic() - start, 1e-6)
|
||||
print(
|
||||
f"[{total}/{iterations}] ok={success} fail={fail} ({rate:.1f}/s)",
|
||||
flush=True,
|
||||
)
|
||||
if err:
|
||||
print(f" ERROR: {err}", flush=True)
|
||||
|
||||
elapsed = time.monotonic() - start
|
||||
print(f"\nDone in {elapsed:.1f}s")
|
||||
print(f"Success: {success}, Failed: {fail}, Rate: {iterations / elapsed:.1f}/s")
|
||||
if errors:
|
||||
print("\nLast 10 errors:")
|
||||
for e in errors[-10:]:
|
||||
print(f" {e}")
|
||||
print("RESULT", "PASS" if fail == 0 else "FAIL")
|
||||
sys.exit(1 if fail else 0)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -4,6 +4,7 @@ Import it with this directory on sys.path (the drivers add their parent director
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Awaitable, Callable
|
||||
import contextlib
|
||||
import os
|
||||
import re
|
||||
@@ -27,19 +28,32 @@ FATAL = (
|
||||
)
|
||||
|
||||
|
||||
async def connect(host: str, tries: int = 30, timeout: float = 10) -> APIClient:
|
||||
async def connect(
|
||||
host: str,
|
||||
tries: int = 30,
|
||||
timeout: float = 10,
|
||||
port: int = 6053,
|
||||
on_stop: Callable[[bool], Awaitable[None]] | None = None,
|
||||
) -> APIClient:
|
||||
"""Connect and log in, retrying once a second; exits after TRIES failures with the last error.
|
||||
|
||||
API_KEY in the env selects Noise; unset, empty or - is plaintext.
|
||||
API_KEY in the env selects Noise; unset, empty or - is plaintext. ON_STOP is called when the connection ends.
|
||||
"""
|
||||
key = os.environ.get("API_KEY")
|
||||
last: BaseException | None = None
|
||||
for _ in range(tries):
|
||||
c = APIClient(
|
||||
host, 6053, None, noise_psk=None if key in (None, "", "-") else key
|
||||
host, port, None, noise_psk=None if key in (None, "", "-") else key
|
||||
)
|
||||
live = [False]
|
||||
|
||||
# a failed attempt's cleanup may call on_stop too; pass on only stops of the returned client
|
||||
async def stop(expected: bool, live: list[bool] = live) -> None:
|
||||
if live[0] and on_stop is not None:
|
||||
await on_stop(expected)
|
||||
|
||||
try:
|
||||
await asyncio.wait_for(c.connect(login=True), timeout)
|
||||
await asyncio.wait_for(c.connect(on_stop=stop, login=True), timeout)
|
||||
except FATAL as e:
|
||||
sys.exit(f"no API connection to {host}: {type(e).__name__}: {e}")
|
||||
except Exception as e: # noqa: BLE001
|
||||
@@ -49,6 +63,7 @@ async def connect(host: str, tries: int = 30, timeout: float = 10) -> APIClient:
|
||||
await c.disconnect(force=True)
|
||||
await asyncio.sleep(1)
|
||||
else:
|
||||
live[0] = True
|
||||
return c
|
||||
sys.exit(
|
||||
f"no API connection to {host} after {tries} tries: {type(last).__name__}: {last}"
|
||||
@@ -58,3 +73,80 @@ async def connect(host: str, tries: int = 30, timeout: float = 10) -> APIClient:
|
||||
def log_text(msg) -> str:
|
||||
"""The message of a subscribe_logs callback as text, without ANSI colour codes."""
|
||||
return ANSI.sub("", msg.message.decode(errors="replace"))
|
||||
|
||||
|
||||
def stop_event() -> tuple[asyncio.Event, Callable[[bool], Awaitable[None]]]:
|
||||
"""An Event and an on_stop callback for connect() that sets it when the connection ends."""
|
||||
ev = asyncio.Event()
|
||||
|
||||
async def on_stop(expected: bool) -> None:
|
||||
ev.set()
|
||||
|
||||
return ev, on_stop
|
||||
|
||||
|
||||
async def ble_connect(
|
||||
cli: APIClient,
|
||||
addr: int,
|
||||
on_lost: Callable[[int], None] | None = None,
|
||||
advert_timeout: float = 60,
|
||||
timeout: float = 30,
|
||||
) -> tuple[bool, int, int, Callable[[], None]]:
|
||||
"""Wait for an advert from ADDR, then connect through the proxy without a cache (like Home Assistant).
|
||||
|
||||
Returns (connected, mtu, error, cancel); a missing advert or a connect timeout gives (False, 0, -1, cancel), so
|
||||
callers can retry. ON_LOST(error) is called when the link drops later.
|
||||
"""
|
||||
seen = asyncio.Event()
|
||||
unsub = cli.subscribe_bluetooth_le_raw_advertisements(
|
||||
lambda m: (
|
||||
seen.set() if any(a.address == addr for a in m.advertisements) else None
|
||||
)
|
||||
)
|
||||
try:
|
||||
await asyncio.wait_for(seen.wait(), advert_timeout)
|
||||
except TimeoutError:
|
||||
return False, 0, -1, lambda: None
|
||||
finally:
|
||||
unsub()
|
||||
first: asyncio.Queue = asyncio.Queue()
|
||||
pending = True
|
||||
|
||||
def on_state(connected: bool, mtu: int, err: int) -> None:
|
||||
nonlocal pending
|
||||
if pending:
|
||||
pending = False
|
||||
first.put_nowait((connected, mtu, err))
|
||||
elif not connected and on_lost is not None:
|
||||
on_lost(err)
|
||||
|
||||
cancel = await cli.bluetooth_device_connect(
|
||||
addr,
|
||||
on_state,
|
||||
timeout=timeout,
|
||||
address_type=0,
|
||||
feature_flags=0xFF,
|
||||
has_cache=False,
|
||||
)
|
||||
try:
|
||||
connected, mtu, err = await asyncio.wait_for(first.get(), timeout + 5)
|
||||
except TimeoutError:
|
||||
return False, 0, -1, cancel
|
||||
return connected, mtu, err, cancel
|
||||
|
||||
|
||||
async def enable_notify(
|
||||
cli: APIClient, addr: int, ch, on_notify: Callable[[int, bytearray], None]
|
||||
) -> bool:
|
||||
"""Start notify on characteristic CH and write its first CCCD (2902) like Home Assistant.
|
||||
|
||||
Returns False when the characteristic lists no CCCD.
|
||||
"""
|
||||
await cli.bluetooth_gatt_start_notify(addr, ch.handle, on_notify)
|
||||
cccd = next(
|
||||
(d for d in ch.descriptors if d.uuid.lower().startswith("00002902")), None
|
||||
)
|
||||
if cccd is None:
|
||||
return False
|
||||
await cli.bluetooth_gatt_write_descriptor(addr, cccd.handle, b"\x01\x00")
|
||||
return True
|
||||
@@ -0,0 +1,31 @@
|
||||
#pragma once
|
||||
// Test only: swaps the first two records of an ATT Read By Type Response whose first record declares characteristic
|
||||
// 0xFFF1, the way some peripherals answer out of handle order (esphome#22518). Count of swaps in attswap_count.
|
||||
#include <cstdint>
|
||||
#include <cstring>
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
struct AttSwapHdr {
|
||||
uint16_t event, len, offset, layer_specific;
|
||||
};
|
||||
extern "C" void __real_l2c_rcv_acl_data(void *p_msg);
|
||||
static volatile uint32_t attswap_count = 0;
|
||||
|
||||
extern "C" void __wrap_l2c_rcv_acl_data(void *p_msg) {
|
||||
auto *h = static_cast<AttSwapHdr *>(p_msg);
|
||||
uint8_t *p = reinterpret_cast<uint8_t *>(h + 1) + h->offset;
|
||||
// HCI ACL header (4), L2CAP header (4), then ATT: opcode, record length, records
|
||||
if (h->len >= 4 + 4 + 2 + 14) {
|
||||
uint16_t cid = p[6] | (p[7] << 8);
|
||||
uint8_t *att = p + 8;
|
||||
// record: handle(2) properties(1) value handle(2) uuid16(2)
|
||||
if (cid == 0x0004 && att[0] == 0x09 && att[1] == 7 && att[2 + 5] == 0xF1 && att[2 + 6] == 0xFF) {
|
||||
uint8_t tmp[7];
|
||||
memcpy(tmp, att + 2, 7);
|
||||
memcpy(att + 2, att + 9, 7);
|
||||
memcpy(att + 9, tmp, 7);
|
||||
attswap_count = attswap_count + 1;
|
||||
}
|
||||
}
|
||||
__real_l2c_rcv_acl_data(p_msg);
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
"""Test only: wrap Bluedroid's l2c_rcv_acl_data so attswap.h can reorder a Read By Type response."""
|
||||
|
||||
import esphome.codegen as cg
|
||||
import esphome.config_validation as cv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
CONFIG_SCHEMA = cv.Schema({})
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
cg.add_build_flag("-Wl,--wrap=l2c_rcv_acl_data")
|
||||
@@ -0,0 +1,5 @@
|
||||
substitutions:
|
||||
name: attprx6
|
||||
idf: 5.5.6
|
||||
packages:
|
||||
c: !include proxy.yaml
|
||||
@@ -0,0 +1,125 @@
|
||||
"""Through the proxy (no cache): print the full GATT table, read FFF1/FFF2/FFF3 by handle, and enable notify on
|
||||
FFF1, FFF2 and 2ACD (writing the CCCD the way Home Assistant does), counting what arrives per handle for 6 s.
|
||||
usage: gattcheck.py PROXY PEER_MAC env: API_KEY (the proxy's api encryption key)
|
||||
Exits 1 when a characteristic or CCCD is missing, a read or notification carries another characteristic's value,
|
||||
a notify fails, or a notifying characteristic sends nothing."""
|
||||
|
||||
import asyncio
|
||||
import os
|
||||
import sys
|
||||
|
||||
from aioesphomeapi import APIClient
|
||||
|
||||
SFX = "-0000-1000-8000-00805f9b34fb"
|
||||
|
||||
|
||||
def short(u: str) -> str:
|
||||
return u[4:8] if u.endswith(SFX) else u
|
||||
|
||||
|
||||
async def main(host: str, peer: str) -> None:
|
||||
addr = int(peer.replace(":", ""), 16)
|
||||
cli = APIClient(host, 6053, None, noise_psk=os.environ["API_KEY"])
|
||||
await cli.connect(login=True)
|
||||
seen = asyncio.Event()
|
||||
cli.subscribe_bluetooth_le_raw_advertisements(
|
||||
lambda m: (
|
||||
seen.set() if any(a.address == addr for a in m.advertisements) else None
|
||||
)
|
||||
)
|
||||
await asyncio.wait_for(seen.wait(), 30)
|
||||
state: asyncio.Queue = asyncio.Queue()
|
||||
cancel = await cli.bluetooth_device_connect(
|
||||
addr,
|
||||
lambda c, mtu, err: state.put_nowait((c, mtu, err)),
|
||||
timeout=20,
|
||||
address_type=0,
|
||||
feature_flags=0xFF,
|
||||
has_cache=False,
|
||||
)
|
||||
c, mtu, err = await asyncio.wait_for(state.get(), 25)
|
||||
if not c:
|
||||
sys.exit(f"connect failed err={err}")
|
||||
svcs = await cli.bluetooth_gatt_get_services(addr)
|
||||
chars = {}
|
||||
for s in svcs.services:
|
||||
print(f"SVC {short(s.uuid)} 0x{s.handle:04X}", flush=True)
|
||||
for ch in s.characteristics:
|
||||
chars[short(ch.uuid)] = ch
|
||||
print(
|
||||
f" CHR {short(ch.uuid)} 0x{ch.handle:04X} props=0x{ch.properties:02X}",
|
||||
flush=True,
|
||||
)
|
||||
for d in ch.descriptors:
|
||||
print(f" DSC {short(d.uuid)} 0x{d.handle:04X}", flush=True)
|
||||
wanted = ("fff1", "fff2", "fff3", "2acc", "2acd")
|
||||
problems = [f"{u} missing" for u in wanted if u not in chars]
|
||||
for u in ("fff1", "fff2", "fff3", "2acc"):
|
||||
if u in chars:
|
||||
v = bytes(await cli.bluetooth_gatt_read(addr, chars[u].handle))
|
||||
text = v.decode(errors="replace")
|
||||
print(f"READ {u} 0x{chars[u].handle:04X} -> {text}", flush=True)
|
||||
# every server value starts with its own UUID, so a mixed-up handle shows here
|
||||
if not text.startswith(f"{u}-"):
|
||||
problems.append(f"{u} read returned {text!r}")
|
||||
got: dict[int, list[str]] = {}
|
||||
|
||||
def on_notify(handle: int, data: bytearray) -> None:
|
||||
got.setdefault(handle, []).append(bytes(data).decode(errors="replace"))
|
||||
|
||||
for u in ("fff1", "fff2", "2acd"):
|
||||
if u in chars:
|
||||
try:
|
||||
await cli.bluetooth_gatt_start_notify(addr, chars[u].handle, on_notify)
|
||||
# like Home Assistant's client: write the first CCCD listed under the characteristic
|
||||
cccd = next(
|
||||
(d for d in chars[u].descriptors if short(d.uuid) == "2902"), None
|
||||
)
|
||||
if cccd is None:
|
||||
print(
|
||||
f"NOTIFY {u} 0x{chars[u].handle:04X} NO CCCD in its descriptor list",
|
||||
flush=True,
|
||||
)
|
||||
problems.append(f"{u} has no CCCD")
|
||||
continue
|
||||
await cli.bluetooth_gatt_write_descriptor(
|
||||
addr, cccd.handle, b"\x01\x00"
|
||||
)
|
||||
print(
|
||||
f"NOTIFY {u} 0x{chars[u].handle:04X} enabled, CCCD 0x{cccd.handle:04X} written",
|
||||
flush=True,
|
||||
)
|
||||
except Exception as exc: # noqa: BLE001
|
||||
print(
|
||||
f"NOTIFY {u} 0x{chars[u].handle:04X} FAILED {type(exc).__name__}: {exc}",
|
||||
flush=True,
|
||||
)
|
||||
problems.append(f"{u} notify failed")
|
||||
await asyncio.sleep(6)
|
||||
if not got:
|
||||
print("GOT nothing", flush=True)
|
||||
for h, vals in sorted(got.items()):
|
||||
name = next((u for u, ch in chars.items() if ch.handle == h), "?")
|
||||
print(
|
||||
f"GOT 0x{h:04X} ({name}) x{len(vals)}: {vals[0]} .. {vals[-1]}", flush=True
|
||||
)
|
||||
problems.extend(
|
||||
f"0x{h:04X} ({name}) notified {v!r}"
|
||||
for v in vals
|
||||
if name == "?" or not v.startswith(f"{name}-")
|
||||
)
|
||||
# the server notifies FFF1 and 2ACD every second
|
||||
problems.extend(
|
||||
f"{u} sent nothing"
|
||||
for u in ("fff1", "2acd")
|
||||
if u in chars and chars[u].handle not in got
|
||||
)
|
||||
await cli.bluetooth_device_disconnect(addr)
|
||||
cancel()
|
||||
await cli.disconnect()
|
||||
if problems:
|
||||
sys.exit("FAIL: " + ", ".join(problems))
|
||||
print("PASS", flush=True)
|
||||
|
||||
|
||||
asyncio.run(main(sys.argv[1], sys.argv[2]))
|
||||
@@ -0,0 +1,56 @@
|
||||
"""Connect to PEER_MAC through the proxy like Home Assistant (v3 without cache) and print the services it returns.
|
||||
usage: gattget.py PROXY PEER_MAC ROUNDS env: API_KEY (the proxy's api encryption key)"""
|
||||
|
||||
import asyncio
|
||||
import os
|
||||
import sys
|
||||
|
||||
from aioesphomeapi import APIClient
|
||||
|
||||
|
||||
async def main(host: str, peer: str, rounds: int) -> None:
|
||||
addr = int(peer.replace(":", ""), 16)
|
||||
cli = APIClient(host, 6053, None, noise_psk=os.environ["API_KEY"])
|
||||
await cli.connect(login=True)
|
||||
seen = asyncio.Event()
|
||||
|
||||
def adv(msg) -> None:
|
||||
if any(a.address == addr for a in msg.advertisements):
|
||||
seen.set()
|
||||
|
||||
cli.subscribe_bluetooth_le_raw_advertisements(adv)
|
||||
await asyncio.wait_for(seen.wait(), 30)
|
||||
failed = 0
|
||||
for r in range(1, rounds + 1):
|
||||
state: asyncio.Queue = asyncio.Queue()
|
||||
cancel = await cli.bluetooth_device_connect(
|
||||
addr,
|
||||
lambda c, mtu, err, q=state: q.put_nowait((c, mtu, err)),
|
||||
timeout=20,
|
||||
address_type=0,
|
||||
feature_flags=0xFF,
|
||||
has_cache=False,
|
||||
)
|
||||
c, mtu, err = await asyncio.wait_for(state.get(), 25)
|
||||
if not c:
|
||||
print(f"R{r} connect failed err={err}", flush=True)
|
||||
failed += 1
|
||||
cancel()
|
||||
await asyncio.sleep(5)
|
||||
continue
|
||||
svcs = await cli.bluetooth_gatt_get_services(addr)
|
||||
sfx = "-0000-1000-8000-00805f9b34fb"
|
||||
out = [
|
||||
f"{s.uuid[4:8] if s.uuid.endswith(sfx) else s.uuid}({len(s.characteristics)})"
|
||||
for s in svcs.services
|
||||
]
|
||||
print(f"R{r} mtu={mtu} services: {' '.join(out)}", flush=True)
|
||||
await cli.bluetooth_device_disconnect(addr)
|
||||
cancel()
|
||||
await asyncio.sleep(5)
|
||||
await cli.disconnect()
|
||||
if failed:
|
||||
sys.exit(f"{failed} of {rounds} rounds did not connect")
|
||||
|
||||
|
||||
asyncio.run(main(sys.argv[1], sys.argv[2], int(sys.argv[3])))
|
||||
@@ -0,0 +1,37 @@
|
||||
# Proxy (classic ESP32): bluetooth_proxy without service cache, encrypted API, the reorder wrapper.
|
||||
# Substitutions: name, idf.
|
||||
# Keep the per-build file in this directory: attswap.hpp and components/ are found relative to it.
|
||||
esphome:
|
||||
name: ${name}
|
||||
includes: [attswap.hpp]
|
||||
esp32:
|
||||
board: esp32dev
|
||||
framework:
|
||||
type: esp-idf
|
||||
version: ${idf}
|
||||
logger:
|
||||
level: DEBUG
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
# a plaintext proxy can be taken over by any Home Assistant on the network mid-test
|
||||
encryption:
|
||||
key: !secret api_key
|
||||
ota:
|
||||
- platform: esphome
|
||||
external_components:
|
||||
- source: {type: local, path: components}
|
||||
components: [attswap]
|
||||
attswap:
|
||||
esp32_ble_tracker:
|
||||
scan_parameters:
|
||||
active: true
|
||||
bluetooth_proxy:
|
||||
active: true
|
||||
cache_services: false
|
||||
interval:
|
||||
- interval: 5s
|
||||
then:
|
||||
- lambda: 'ESP_LOGI("swap", "attswap swaps=%u", (unsigned) attswap_count);'
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
#!/bin/bash
|
||||
# run.sh PROXY_YAML [ROUNDS]: build server.yaml and PROXY_YAML from TREE, flash both, capture the proxy and read the
|
||||
# server's services through it ROUNDS times (default 3). Prints the services per round and the Bluedroid discovery
|
||||
# errors. Exit 0: every round got all services; 1: a round got a partial table (the bug); 2: setup failed, a round
|
||||
# did not connect, or the swap never fired (the result would be meaningless). PROXY_YAML must sit in this
|
||||
# directory, next to attswap.hpp and components/.
|
||||
# env: TREE, SERVER_YAML (default server.yaml), API_KEY (proxy api key), SERVER_PORT, PROXY_PORT, SERVER_BLE_MAC
|
||||
# (the server's BLE address), SC (path to serial_capture.py), PY
|
||||
D=$(cd "$(dirname "$0")" && pwd); Y=$(cd "$(dirname "${1:?proxy yaml}")" && pwd)/$(basename "$1"); R=${2:-3}
|
||||
W=${TREE:?set TREE}; SP=${SERVER_PORT:?set SERVER_PORT}; PP=${PROXY_PORT:?set PROXY_PORT}; MAC=${SERVER_BLE_MAC:?set SERVER_BLE_MAC}
|
||||
API_KEY=${API_KEY:?set API_KEY}; SC=${SC:?set SC}; PY=${PY:-$W/venv/bin/python}; N=$(basename "$Y" .yaml); O=$D/out-$N; mkdir -p "$O"
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome -s name attsrv run --no-logs "$D/${SERVER_YAML:-server.yaml}" --device "$SP") > "$O/server.log" 2>&1 ||
|
||||
{ echo "server build or upload failed"; exit 2; }
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome run --no-logs "$Y" --device "$PP") > "$O/proxy-upload.log" 2>&1 ||
|
||||
{ echo "$N build or upload failed"; exit 2; }
|
||||
rm -f "$O/proxy.txt"
|
||||
$PY "$SC" "$PP" $((R * 30 + 160)) "$O/proxy.txt" --reset > "$O/capture.log" 2>&1 &
|
||||
CAP=$!
|
||||
IP=""
|
||||
for _ in $(seq 40); do
|
||||
IP=$(LC_ALL=C grep -a -o -E "IP Address: [0-9.]+" "$O/proxy.txt" | tail -1 | cut -d' ' -f3)
|
||||
[ -n "$IP" ] && break; sleep 2
|
||||
done
|
||||
[ -n "$IP" ] || { kill "$CAP"; echo "$N no IP"; exit 2; }
|
||||
sleep 5
|
||||
timeout $((R * 30 + 60)) $PY "$D/gattget.py" "$IP" "$MAC" "$R" | tee "$O/client.txt"
|
||||
[ "${PIPESTATUS[0]}" = 0 ] || { kill "$CAP"; echo "$N client failed"; exit 2; }
|
||||
wait "$CAP" || { echo "$N capture failed (see $O/capture.log)"; exit 2; }
|
||||
echo "== $N"
|
||||
LC_ALL=C grep -a -E "invalid handle|Service discovery complete|attswap swaps=[1-9]" "$O/proxy.txt" | sed 's/^\[[0-9:]*\]//' |
|
||||
sort | uniq -c
|
||||
grep -a -q -E "attswap swaps=[1-9]" "$O/proxy.txt" || { echo "$N INVALID: the reorder never fired"; exit 2; }
|
||||
# every round must list the reordered service (fff0) and the one after it (1826) with all their characteristics
|
||||
grep -a -q "^R[0-9]* mtu=" "$O/client.txt" || { echo "$N no client output"; exit 2; }
|
||||
grep -a "^R[0-9]* mtu=" "$O/client.txt" | grep -v -q "fff0(6) 1826(2)" && exit 1
|
||||
exit 0
|
||||
@@ -0,0 +1,45 @@
|
||||
# Peripheral (ESP32-S3) for gattcheck.py: FFF1 to FFF6 each hold their own value, FFF1, FFF2 and 2ACD can notify,
|
||||
# and FFF1 and 2ACD send a changing value every second. Substitution: name.
|
||||
esphome:
|
||||
name: ${name}
|
||||
esp32:
|
||||
variant: esp32s3
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
hardware_uart: USB_SERIAL_JTAG
|
||||
esp32_ble:
|
||||
name: ${name}
|
||||
esp32_ble_server:
|
||||
manufacturer: ESPHome
|
||||
model: attcheck
|
||||
services:
|
||||
- uuid: FFF0
|
||||
advertise: true
|
||||
characteristics:
|
||||
- {id: c1, uuid: FFF1, read: true, notify: true, value: "fff1-v"}
|
||||
- {uuid: FFF2, read: true, notify: true, value: "fff2-v"}
|
||||
- {uuid: FFF3, read: true, value: "fff3-v"}
|
||||
- {uuid: FFF4, read: true, value: "fff4-v"}
|
||||
- {uuid: FFF5, read: true, value: "fff5-v"}
|
||||
- {uuid: FFF6, read: true, value: "fff6-v"}
|
||||
- uuid: "1826"
|
||||
characteristics:
|
||||
- {uuid: 2ACC, read: true, value: "2acc-v"}
|
||||
- {id: cd, uuid: 2ACD, read: true, notify: true, value: "2acd-0"}
|
||||
on_connect:
|
||||
- logger.log: {format: "SRV connected", level: INFO}
|
||||
globals:
|
||||
- {id: n, type: int, initial_value: "0"}
|
||||
interval:
|
||||
- interval: 1s
|
||||
then:
|
||||
- lambda: id(n)++;
|
||||
- ble_server.characteristic.set_value:
|
||||
id: cd
|
||||
value: !lambda 'std::string v = "2acd-" + to_string(id(n)); return std::vector<uint8_t>(v.begin(), v.end());'
|
||||
- ble_server.characteristic.notify: {id: cd}
|
||||
- ble_server.characteristic.set_value:
|
||||
id: c1
|
||||
value: !lambda 'std::string v = "fff1-n" + to_string(id(n)); return std::vector<uint8_t>(v.begin(), v.end());'
|
||||
- ble_server.characteristic.notify: {id: c1}
|
||||
@@ -0,0 +1,32 @@
|
||||
# Peripheral (ESP32-S3): a 6-characteristic service 0xFFF0, then an FTMS-like 0x1826 service. Substitution: name.
|
||||
esphome:
|
||||
name: ${name}
|
||||
esp32:
|
||||
variant: esp32s3
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
hardware_uart: USB_SERIAL_JTAG
|
||||
esp32_ble:
|
||||
name: ${name}
|
||||
esp32_ble_server:
|
||||
manufacturer: ESPHome
|
||||
model: g22518
|
||||
services:
|
||||
- uuid: FFF0
|
||||
advertise: true
|
||||
characteristics:
|
||||
- {uuid: FFF1, read: true, value: [1]}
|
||||
- {uuid: FFF2, read: true, value: [2]}
|
||||
- {uuid: FFF3, read: true, value: [3]}
|
||||
- {uuid: FFF4, read: true, value: [4]}
|
||||
- {uuid: FFF5, read: true, value: [5]}
|
||||
- {uuid: FFF6, read: true, value: [6]}
|
||||
- uuid: "1826"
|
||||
characteristics:
|
||||
- {uuid: 2ACC, read: true, value: [0, 0, 0, 0]}
|
||||
- {uuid: 2ACD, read: true, notify: true, value: [0, 0]}
|
||||
on_connect:
|
||||
- logger.log: {format: "SRV connected", level: INFO}
|
||||
on_disconnect:
|
||||
- logger.log: {format: "SRV disconnected", level: INFO}
|
||||
@@ -0,0 +1,129 @@
|
||||
"""Home Assistant stand-in for a bluetooth_proxy scan soak (esphome#22770).
|
||||
|
||||
usage: ha.py HOST OUT SECONDS [--toggle SECS [--jitter SECS]] [--mode passive|active|none]
|
||||
|
||||
Subscribes to raw advertisements and the scanner state like Home Assistant, sets the scanner mode once after connect
|
||||
(passive by default, as HA does for its proxies) and with --toggle flips active/passive every SECS seconds to stress
|
||||
the stop/restart path. Writes one line per event to OUT: scanner state changes, a per-second advert count, mode
|
||||
requests, connection drops. Reconnects after a drop (device reboot) and keeps going until SECONDS have passed.
|
||||
API_KEY in the env selects Noise.
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import asyncio
|
||||
import pathlib
|
||||
import random
|
||||
import sys
|
||||
import time
|
||||
|
||||
_here = pathlib.Path(__file__).resolve().parent
|
||||
# apiconn.py: copied next to it, or the skill scripts dir
|
||||
sys.path[:0] = [str(_here), str(_here.parent)]
|
||||
|
||||
from apiconn import FATAL, connect, stop_event # noqa: E402
|
||||
|
||||
|
||||
def main() -> None:
|
||||
ap = argparse.ArgumentParser()
|
||||
ap.add_argument("host")
|
||||
ap.add_argument("out")
|
||||
ap.add_argument("seconds", type=float)
|
||||
ap.add_argument("--toggle", type=float, default=0)
|
||||
ap.add_argument(
|
||||
"--jitter",
|
||||
type=float,
|
||||
default=0,
|
||||
help="random +- seconds added to each toggle period",
|
||||
)
|
||||
ap.add_argument("--mode", default="passive", choices=["passive", "active", "none"])
|
||||
a = ap.parse_args()
|
||||
asyncio.run(run(a))
|
||||
|
||||
|
||||
async def run(a: argparse.Namespace) -> None:
|
||||
from aioesphomeapi import BluetoothScannerMode
|
||||
|
||||
end = time.monotonic() + a.seconds
|
||||
f = pathlib.Path(a.out).open("a", encoding="utf-8", buffering=1) # noqa: SIM115
|
||||
|
||||
def w(s: str) -> None:
|
||||
f.write(
|
||||
f"{time.strftime('%H:%M:%S')}.{int(time.time() * 1000) % 1000:03d} {s}\n"
|
||||
)
|
||||
|
||||
session = 0
|
||||
connected = False
|
||||
while time.monotonic() < end:
|
||||
session += 1
|
||||
stopped, on_stop = stop_event()
|
||||
# a try takes up to 11 s (10 s timeout, 1 s pause): bound the tries by the soak time left instead of
|
||||
# cancelling connect(), which could leave a half open client behind
|
||||
tries = max(1, int((end - time.monotonic()) // 11))
|
||||
try:
|
||||
c = await connect(a.host, tries=tries, on_stop=on_stop)
|
||||
except SystemExit as e:
|
||||
w(f"CONNECT FAILED {e}")
|
||||
# a wrong key or a plaintext/Noise mismatch never recovers: stop instead of soaking without a client
|
||||
if isinstance(e.__context__, FATAL):
|
||||
raise
|
||||
await asyncio.sleep(5)
|
||||
continue
|
||||
w(f"CONNECTED session={session}")
|
||||
connected = True
|
||||
adv = [0]
|
||||
macs: set[int] = set()
|
||||
|
||||
def on_raw(resp, adv=adv, macs=macs) -> None:
|
||||
for x in resp.advertisements:
|
||||
adv[0] += 1
|
||||
macs.add(x.address)
|
||||
|
||||
def on_state(st) -> None:
|
||||
w(f"SCANNER state={st.state.name} mode={st.mode.name}")
|
||||
|
||||
unsub_raw = c.subscribe_bluetooth_le_raw_advertisements(on_raw)
|
||||
unsub_state = c.subscribe_bluetooth_scanner_state(on_state)
|
||||
if a.mode != "none":
|
||||
m = (
|
||||
BluetoothScannerMode.PASSIVE
|
||||
if a.mode == "passive"
|
||||
else BluetoothScannerMode.ACTIVE
|
||||
)
|
||||
c.bluetooth_scanner_set_mode(m)
|
||||
w(f"SET_MODE {a.mode}")
|
||||
last_toggle = time.monotonic()
|
||||
period = a.toggle
|
||||
active = a.mode == "active"
|
||||
last_report = time.monotonic()
|
||||
while time.monotonic() < end and not stopped.is_set():
|
||||
await asyncio.sleep(0.05)
|
||||
now = time.monotonic()
|
||||
if a.toggle and now - last_toggle >= period:
|
||||
active = not active
|
||||
c.bluetooth_scanner_set_mode(
|
||||
BluetoothScannerMode.ACTIVE
|
||||
if active
|
||||
else BluetoothScannerMode.PASSIVE
|
||||
)
|
||||
w(f"SET_MODE {'active' if active else 'passive'}")
|
||||
last_toggle = now
|
||||
period = a.toggle + random.uniform(-a.jitter, a.jitter)
|
||||
if now - last_report >= 10:
|
||||
w(f"ADV {adv[0]} in {now - last_report:.1f}s devices={len(macs)}")
|
||||
adv[0] = 0
|
||||
macs.clear()
|
||||
last_report = now
|
||||
if stopped.is_set():
|
||||
w("DISCONNECTED")
|
||||
await asyncio.sleep(2)
|
||||
continue
|
||||
unsub_raw()
|
||||
unsub_state()
|
||||
await c.disconnect()
|
||||
w("DONE")
|
||||
if not connected:
|
||||
sys.exit("no API connection during the whole soak")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,78 @@
|
||||
substitutions:
|
||||
name: scan2610
|
||||
duration: 5s
|
||||
|
||||
esphome:
|
||||
name: ${name}
|
||||
|
||||
esp32:
|
||||
board: esp32-c6-devkitc-1
|
||||
variant: esp32c6
|
||||
flash_size: 4MB
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
logger:
|
||||
level: VERBOSE
|
||||
hardware_uart: USB_SERIAL_JTAG
|
||||
logs:
|
||||
esp32_ble_tracker: VERBOSE
|
||||
esp32_ble: DEBUG
|
||||
bluetooth_proxy: DEBUG
|
||||
api: DEBUG
|
||||
api.connection: DEBUG
|
||||
api.service: DEBUG
|
||||
sensor: INFO
|
||||
text_sensor: INFO
|
||||
debug: INFO
|
||||
wifi: DEBUG
|
||||
scheduler: DEBUG
|
||||
component: DEBUG
|
||||
|
||||
ota:
|
||||
- platform: esphome
|
||||
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
|
||||
esp32_ble_tracker:
|
||||
scan_parameters:
|
||||
interval: 1100ms
|
||||
window: 1100ms
|
||||
active: true
|
||||
duration: ${duration}
|
||||
|
||||
bluetooth_proxy:
|
||||
active: true
|
||||
|
||||
sensor:
|
||||
- platform: wifi_signal
|
||||
name: WiFi signal
|
||||
update_interval: 60s
|
||||
- platform: uptime
|
||||
name: Uptime
|
||||
- platform: debug
|
||||
free:
|
||||
name: Free memory
|
||||
block:
|
||||
name: Largest free block
|
||||
min_free:
|
||||
name: Lowest free memory
|
||||
loop_time:
|
||||
name: Loop time
|
||||
|
||||
debug:
|
||||
update_interval: 60s
|
||||
|
||||
text_sensor:
|
||||
- platform: version
|
||||
name: ESPHome version
|
||||
- platform: debug
|
||||
reset_reason:
|
||||
name: Reset reason
|
||||
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
encryption:
|
||||
key: !secret api_key
|
||||
@@ -0,0 +1,126 @@
|
||||
#pragma once
|
||||
// esphome#22770 instrumentation: follows one scan's duration timer through Bluedroid.
|
||||
// Link with -Wl,--wrap= for BTM_BleScan, btu_start_timer, btm_ble_timeout, osi_alarm_new, btc_transfer_context.
|
||||
#include <cstdint>
|
||||
#include <esp_gap_ble_api.h>
|
||||
#include <esp_timer.h>
|
||||
#include <freertos/FreeRTOS.h>
|
||||
|
||||
extern "C" {
|
||||
struct scan_inst_t {
|
||||
uint32_t ble_scan_start; // BTM_BleScan(TRUE) calls
|
||||
uint32_t ble_scan_start_bad; // ... that did not return BTM_CMD_STARTED
|
||||
uint32_t ble_scan_stop; // BTM_BleScan(FALSE) calls
|
||||
uint32_t timer_start; // btu_start_timer(BTU_TTYPE_BLE_SCAN)
|
||||
uint32_t alarm_fire; // esp_timer fired for the scan timer entry (btc thread)
|
||||
uint32_t ble_timeout; // btm_ble_timeout for the scan timer entry (btu thread)
|
||||
uint32_t inq_cmpl_post; // INQ_CMPL handed to btc_transfer_context
|
||||
uint32_t inq_cmpl_post_fail; // ... that failed
|
||||
uint8_t pid;
|
||||
void *scan_tle;
|
||||
int64_t last_timer_start_us;
|
||||
int64_t last_fire_us;
|
||||
int64_t last_timeout_us;
|
||||
int64_t last_inq_cmpl_us;
|
||||
};
|
||||
// Written from the Bluedroid and timer tasks, read on the main loop: every access holds the lock, since the 64 bit
|
||||
// timestamps can tear on the 32 bit chips. Read with scan_inst_snapshot() and log the copy.
|
||||
static scan_inst_t g_scan_inst{};
|
||||
static portMUX_TYPE g_scan_inst_mux = portMUX_INITIALIZER_UNLOCKED;
|
||||
|
||||
static scan_inst_t scan_inst_snapshot() {
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
scan_inst_t copy = g_scan_inst;
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
return copy;
|
||||
}
|
||||
|
||||
typedef void (*scan_inst_cb_t)(void *);
|
||||
// the scan timer entry's original alarm callback (btu_general_alarm_cb)
|
||||
static scan_inst_cb_t s_orig_cb = nullptr;
|
||||
|
||||
static void scan_inst_shim(void *data) {
|
||||
int64_t now = esp_timer_get_time();
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
g_scan_inst.alarm_fire++;
|
||||
g_scan_inst.last_fire_us = now;
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
s_orig_cb(data);
|
||||
}
|
||||
|
||||
uint8_t __real_BTM_BleScan(uint8_t start, uint32_t duration, void *a, void *b, void *c);
|
||||
uint8_t __wrap_BTM_BleScan(uint8_t start, uint32_t duration, void *a, void *b, void *c) {
|
||||
uint8_t r = __real_BTM_BleScan(start, duration, a, b, c);
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
if (start) {
|
||||
g_scan_inst.ble_scan_start++;
|
||||
if (r != 1 /* BTM_CMD_STARTED */)
|
||||
g_scan_inst.ble_scan_start_bad++;
|
||||
} else {
|
||||
g_scan_inst.ble_scan_stop++;
|
||||
}
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
return r;
|
||||
}
|
||||
|
||||
void __real_btu_start_timer(void *p_tle, uint16_t type, uint32_t timeout_sec);
|
||||
void __wrap_btu_start_timer(void *p_tle, uint16_t type, uint32_t timeout_sec) {
|
||||
if (type == 109 /* BTU_TTYPE_BLE_SCAN */) {
|
||||
int64_t now = esp_timer_get_time();
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
g_scan_inst.scan_tle = p_tle;
|
||||
g_scan_inst.timer_start++;
|
||||
g_scan_inst.last_timer_start_us = now;
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
}
|
||||
__real_btu_start_timer(p_tle, type, timeout_sec);
|
||||
}
|
||||
|
||||
void __real_btm_ble_timeout(void *p_tle);
|
||||
void __wrap_btm_ble_timeout(void *p_tle) {
|
||||
int64_t now = esp_timer_get_time();
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
if (p_tle == g_scan_inst.scan_tle) {
|
||||
g_scan_inst.ble_timeout++;
|
||||
g_scan_inst.last_timeout_us = now;
|
||||
}
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
__real_btm_ble_timeout(p_tle);
|
||||
}
|
||||
|
||||
void *__real_osi_alarm_new(const char *name, scan_inst_cb_t cb, void *data, uint64_t expire);
|
||||
void *__wrap_osi_alarm_new(const char *name, scan_inst_cb_t cb, void *data, uint64_t expire) {
|
||||
// btu_start_timer's wrap records the scan entry before the real one creates its alarm. Shim every alarm made for
|
||||
// it, since Bluedroid may free and recreate it; they all use the same callback (btu_general_alarm_cb).
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
void *scan_tle = g_scan_inst.scan_tle;
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
if (data != nullptr && data == scan_tle) {
|
||||
s_orig_cb = cb;
|
||||
return __real_osi_alarm_new(name, scan_inst_shim, data, expire);
|
||||
}
|
||||
return __real_osi_alarm_new(name, cb, data, expire);
|
||||
}
|
||||
|
||||
struct scan_inst_msg_t {
|
||||
uint8_t sig, aid, pid, act;
|
||||
};
|
||||
int __real_btc_transfer_context(scan_inst_msg_t *msg, void *arg, int arg_len, void *cp, void *fr);
|
||||
int __wrap_btc_transfer_context(scan_inst_msg_t *msg, void *arg, int arg_len, void *cp, void *fr) {
|
||||
bool cmpl = msg != nullptr && arg != nullptr && msg->sig == 1 && msg->act == ESP_GAP_BLE_SCAN_RESULT_EVT &&
|
||||
arg_len >= 4 && msg->pid == 5 /* BTC_PID_GAP_BLE */ &&
|
||||
static_cast<esp_ble_gap_cb_param_t *>(arg)->scan_rst.search_evt == ESP_GAP_SEARCH_INQ_CMPL_EVT;
|
||||
int r = __real_btc_transfer_context(msg, arg, arg_len, cp, fr);
|
||||
if (cmpl) {
|
||||
int64_t now = esp_timer_get_time();
|
||||
portENTER_CRITICAL(&g_scan_inst_mux);
|
||||
g_scan_inst.pid = msg->pid;
|
||||
g_scan_inst.inq_cmpl_post++;
|
||||
g_scan_inst.last_inq_cmpl_us = now;
|
||||
if (r != 0)
|
||||
g_scan_inst.inq_cmpl_post_fail++;
|
||||
portEXIT_CRITICAL(&g_scan_inst_mux);
|
||||
}
|
||||
return r;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
# scan.yaml plus the Bluedroid scan timer counters (scan_inst.hpp) logged every 30 s as `scaninst`
|
||||
substitutions:
|
||||
name: scaninst
|
||||
|
||||
packages:
|
||||
base: !include scan.yaml
|
||||
|
||||
esphome:
|
||||
includes:
|
||||
- scan_inst.hpp
|
||||
platformio_options:
|
||||
build_flags:
|
||||
- -Wl,--wrap=BTM_BleScan
|
||||
- -Wl,--wrap=btu_start_timer
|
||||
- -Wl,--wrap=btm_ble_timeout
|
||||
- -Wl,--wrap=osi_alarm_new
|
||||
- -Wl,--wrap=btc_transfer_context
|
||||
|
||||
esp32_ble_tracker:
|
||||
on_scan_end:
|
||||
- lambda: id(scan_ends)++;
|
||||
|
||||
globals:
|
||||
- id: scan_ends
|
||||
type: uint32_t
|
||||
initial_value: '0'
|
||||
|
||||
interval:
|
||||
- interval: 30s
|
||||
then:
|
||||
- lambda: |-
|
||||
const scan_inst_t g = scan_inst_snapshot();
|
||||
int64_t now = esp_timer_get_time();
|
||||
ESP_LOGI("scaninst", "start=%u bad=%u stop=%u timer=%u fire=%u timeout=%u cmpl_post=%u cmpl_fail=%u pid=%u ends=%u "
|
||||
"ago_ms timer=%lld fire=%lld timeout=%lld cmpl=%lld",
|
||||
(unsigned) g.ble_scan_start, (unsigned) g.ble_scan_start_bad, (unsigned) g.ble_scan_stop,
|
||||
(unsigned) g.timer_start, (unsigned) g.alarm_fire, (unsigned) g.ble_timeout,
|
||||
(unsigned) g.inq_cmpl_post, (unsigned) g.inq_cmpl_post_fail, (unsigned) g.pid, (unsigned) id(scan_ends),
|
||||
(now - g.last_timer_start_us) / 1000, (now - g.last_fire_us) / 1000,
|
||||
(now - g.last_timeout_us) / 1000, (now - g.last_inq_cmpl_us) / 1000);
|
||||
@@ -0,0 +1,15 @@
|
||||
#!/bin/bash
|
||||
# usage: soak.sh TAG HOST SECONDS [ha.py options] serial capture plus HA stand-in, both bounded
|
||||
# env: PORT (serial port), PY, API_KEY (falls back to apikey.txt next to the script; unset or - for plaintext)
|
||||
W=$(cd "$(dirname "$0")" && pwd); cd "$W" || exit 1; T=$1; H=$2; S=$3; shift 3
|
||||
PY=${PY:-python3}
|
||||
PORT=${PORT:?serial port}
|
||||
[ -z "${API_KEY+x}" ] && [ -f apikey.txt ] && API_KEY=$(cat apikey.txt)
|
||||
$PY "$(dirname "$W")/serial_capture.py" "$PORT" "$S" "$T.txt" > /dev/null 2>&1 &
|
||||
CAP=$!
|
||||
API_KEY=$API_KEY PYTHONUNBUFFERED=1 $PY ha.py "$H" "$T-ha.txt" "$S" "$@" > "$T-ha.err" 2>&1 &
|
||||
HA=$!
|
||||
wait $CAP; CRC=$?
|
||||
wait $HA; HRC=$?
|
||||
echo "$T done: capture rc=$CRC ha.py rc=$HRC (see $T-ha.err)"
|
||||
[ $CRC -eq 0 ] && [ $HRC -eq 0 ]
|
||||
@@ -0,0 +1,11 @@
|
||||
#!/bin/bash
|
||||
# usage: wait.sh CAPTURE SECONDS [FROM_LINE] block until an anomaly after FROM_LINE or SECONDS pass, then print status
|
||||
C=$1; L=${3:-1}
|
||||
P="Scan timeout exceeded|Scan never terminated|Dropped [0-9]+ BLE|Guru|Backtrace|Unexpected|cmpl_fail=[1-9]|bad=[1-9]"
|
||||
timeout "$2" tail -n +"$L" -F "$C" 2> /dev/null | grep -a -m1 -q -E "$P"
|
||||
tail -n +"$L" "$C" | awk -v p="$P" -v t="$(date +%T)" '
|
||||
$0 ~ p && shown < 5 { print; shown++ }
|
||||
/Starting scan/ { starts++ }
|
||||
/Scan complete, set/ { completes++ }
|
||||
END { printf "%s starts=%d completes=%d\n", t, starts, completes }'
|
||||
grep -a scaninst "$C" | tail -1 | cut -c1-260
|
||||
@@ -0,0 +1,48 @@
|
||||
# Joins the DUT's open AP, fetches the portal page every 5 s and logs JOIN and STAT lines. Substitutions: name, board,
|
||||
# logger_uart, ap_ssid (same as dut.yaml).
|
||||
substitutions:
|
||||
board: esp32-c3-devkitm-1
|
||||
logger_uart: USB_SERIAL_JTAG
|
||||
ap_ssid: bleaptest
|
||||
esphome:
|
||||
name: ${name}
|
||||
esp32:
|
||||
board: ${board}
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
hardware_uart: ${logger_uart}
|
||||
wifi:
|
||||
ssid: ${ap_ssid}
|
||||
reboot_timeout: 0s
|
||||
on_connect:
|
||||
- lambda: |-
|
||||
id(joins)++;
|
||||
ESP_LOGI("cli", "JOIN %d at %u ms", id(joins), (unsigned) millis());
|
||||
on_disconnect:
|
||||
- lambda: ESP_LOGI("cli", "LEFT at %u ms", (unsigned) millis());
|
||||
http_request:
|
||||
timeout: 5s
|
||||
globals:
|
||||
- {id: joins, type: int, initial_value: "0"}
|
||||
- {id: pages_ok, type: int, initial_value: "0"}
|
||||
- {id: pages_fail, type: int, initial_value: "0"}
|
||||
interval:
|
||||
- interval: 5s
|
||||
then:
|
||||
- if:
|
||||
condition: wifi.connected
|
||||
then:
|
||||
- http_request.get:
|
||||
url: http://192.168.4.1/
|
||||
on_response:
|
||||
then:
|
||||
- lambda: if (response->status_code == 200) id(pages_ok)++; else id(pages_fail)++;
|
||||
on_error:
|
||||
then:
|
||||
- lambda: id(pages_fail)++;
|
||||
- interval: 15s
|
||||
then:
|
||||
- lambda: |-
|
||||
ESP_LOGI("cli", "STAT up=%u joins=%d connected=%d pages_ok=%d pages_fail=%d", (unsigned) (millis() / 1000),
|
||||
id(joins), (int) wifi::global_wifi_component->is_connected(), id(pages_ok), id(pages_fail));
|
||||
@@ -0,0 +1,23 @@
|
||||
# Soft AP only (no station network) with captive_portal and bluetooth_proxy, as in #22534. Substitutions: name,
|
||||
# board, logger_uart (USB_SERIAL_JTAG on native USB chips, UART0 on a classic devkit), ap_ssid.
|
||||
substitutions:
|
||||
board: esp32dev
|
||||
logger_uart: UART0
|
||||
ap_ssid: bleaptest
|
||||
esphome:
|
||||
name: ${name}
|
||||
esp32:
|
||||
board: ${board}
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
hardware_uart: ${logger_uart}
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
ota:
|
||||
- platform: esphome
|
||||
wifi:
|
||||
ap:
|
||||
ssid: ${ap_ssid}
|
||||
captive_portal:
|
||||
bluetooth_proxy:
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/bin/bash
|
||||
# run.sh DUT_YAML SECONDS: erase and flash DUT_YAML from TREE, let it boot, then reset the client (already flashed with
|
||||
# client.yaml) and capture both for SECONDS. Prints the generated scan window, the client's first JOIN and last STAT
|
||||
# lines, its disconnect reasons and the DUT's resets. One AP with this SSID at a time: ports in PARK are held in their
|
||||
# ROM bootloader first. The yaml file name must equal its `name:` (the build directory is found by it).
|
||||
# Exit 0: pass; 1: the run finished and failed the checks; 2: setup or capture failed.
|
||||
# env: TREE, DUT_PORT, CLIENT_PORT, PARK (space separated ports, optional), SC (path to serial_capture.py), PY
|
||||
Y=$(cd "$(dirname "${1:?dut yaml}")" && pwd)/$(basename "$1"); T=${2:?seconds}; N=$(basename "$Y" .yaml)
|
||||
W=${TREE:?set TREE}; DUT=${DUT_PORT:?set DUT_PORT}; CLI=${CLIENT_PORT:?set CLIENT_PORT}; SC=${SC:?set SC}
|
||||
PY=${PY:-$W/venv/bin/python}; O=$(dirname "$Y")/out-$N; mkdir -p "$O"
|
||||
for p in $PARK; do $PY -m esptool --port "$p" --after no-reset chip-id > /dev/null 2>&1 || { echo "park $p failed"; exit 2; }; done
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome compile "$Y") > "$O/compile.log" 2>&1 || { echo "$N compile failed"; exit 2; }
|
||||
$PY -m esptool --port "$DUT" erase_flash > "$O/erase.log" 2>&1 || { echo "$N erase failed"; exit 2; }
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome upload "$Y" --device "$DUT") > "$O/upload.log" 2>&1 || { echo "$N upload failed"; exit 2; }
|
||||
$PY "$SC" "$DUT" $((T + 40)) "$O/dut.txt" --reset > "$O/dut-capture.log" 2>&1 &
|
||||
CAP=$!
|
||||
trap 'kill $CAP 2>/dev/null' EXIT
|
||||
sleep 30
|
||||
$PY "$SC" "$CLI" "$T" "$O/cli.txt" --reset > "$O/cli-capture.log" 2>&1 || { echo "$N client capture failed"; exit 2; }
|
||||
wait "$CAP" || { echo "$N DUT capture failed"; exit 2; }
|
||||
B=$(dirname "$Y")/.esphome/build/$N/src/main.cpp
|
||||
[ -f "$B" ] || { echo "$N: $B not found (file name differs from name:?)"; exit 2; }
|
||||
echo "== $N window=$(grep -o 'set_scan_window([0-9]*)' "$B" || echo none)"
|
||||
J=$(grep -a -m1 "JOIN 1" "$O/cli.txt" | cut -c1-100); echo "${J:-$N NO JOIN}"
|
||||
STAT=$(grep -a "STAT" "$O/cli.txt" | tail -1 | cut -c1-140); echo "$STAT"
|
||||
echo "client disconnect reasons: $(grep -a -o "reason='[^']*'" "$O/cli.txt" | sort | uniq -c | tr '\n' ' ')"
|
||||
echo "dut resets: $(grep -a -c 'rst:' "$O/dut.txt")"
|
||||
# pass: the client joined and fetched pages, and the DUT reset exactly once (the capture's own reset)
|
||||
[ -n "$J" ] && [ -n "$STAT" ] && [[ "$STAT" != *"pages_ok=0 "* ]] && [ "$(grep -a -c 'rst:' "$O/dut.txt")" = 1 ]
|
||||
@@ -0,0 +1,57 @@
|
||||
"""Count rounds, BTU_TASK crashes, reconnects without reboot and MTU 517 in a central capture.
|
||||
|
||||
analyze.py CAPTURE
|
||||
A round counts from its "start" line (a crashing round never logs "fired"); rounds that log "not queued" or
|
||||
"aborted" are taken back out and listed apart. Exits 1 when no round counts, since such a capture tested nothing.
|
||||
"""
|
||||
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
lines = (
|
||||
pathlib.Path(sys.argv[1]).read_text(encoding="utf-8", errors="replace").splitlines()
|
||||
)
|
||||
rounds = crashes = other_panics = boots = connects = mtu517 = mtu_other = 0
|
||||
not_queued = aborted = skipped = 0
|
||||
reconnect_ok = reconnect_reboot = 0
|
||||
pending = False # a round fired and we wait for the next connect
|
||||
for ln in lines:
|
||||
if "Stack canary watchpoint triggered (BTU_TASK)" in ln:
|
||||
crashes += 1
|
||||
elif "Guru Meditation" in ln or "abort() was called" in ln:
|
||||
other_panics += 1
|
||||
if "rst:0x" in ln:
|
||||
boots += 1
|
||||
if pending:
|
||||
reconnect_reboot += 1
|
||||
pending = False
|
||||
if "CLI connected" in ln:
|
||||
connects += 1
|
||||
if pending:
|
||||
reconnect_ok += 1
|
||||
pending = False
|
||||
if re.search(r"ROUND \d+ start", ln):
|
||||
rounds += 1
|
||||
pending = True
|
||||
if re.search(r"ROUND \d+ (not queued|aborted)", ln):
|
||||
rounds -= 1
|
||||
pending = False
|
||||
not_queued += "not queued" in ln
|
||||
aborted += "aborted" in ln
|
||||
skipped += "ROUND skipped" in ln
|
||||
if m := re.search(r"cfg_mtu status 0, mtu (\d+)", ln):
|
||||
if m.group(1) == "517":
|
||||
mtu517 += 1
|
||||
else:
|
||||
mtu_other += 1
|
||||
print(
|
||||
f"rounds={rounds} btu_canary_crashes={crashes} other_panics={other_panics} boots={boots}"
|
||||
)
|
||||
print(
|
||||
f"connects={connects} reconnect_without_reboot={reconnect_ok} reconnect_after_reboot={reconnect_reboot}"
|
||||
)
|
||||
print(f"mtu517={mtu517} mtu_other={mtu_other}")
|
||||
print(f"not_queued={not_queued} aborted={aborted} skipped={skipped}")
|
||||
if rounds <= 0:
|
||||
sys.exit("FAIL: no round reached the BTU queue")
|
||||
@@ -0,0 +1,75 @@
|
||||
# Central for the Bluedroid queued MTU recursion repro (esphome#17954). Every connection: wait 1.5 s, then
|
||||
# suspend BTU_TASK, local disconnect, 4 reads + 1 MTU request (or execute write with exec_write: "true") in one
|
||||
# batch, resume. ble_client reconnects.
|
||||
esp32:
|
||||
board: esp32dev
|
||||
framework:
|
||||
type: esp-idf
|
||||
sdkconfig_options:
|
||||
CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK: y
|
||||
|
||||
logger:
|
||||
level: DEBUG
|
||||
|
||||
esp32_ble_tracker:
|
||||
scan_parameters:
|
||||
active: false
|
||||
|
||||
globals:
|
||||
- {id: rounds, type: int, initial_value: "0"}
|
||||
- {id: chr_handle, type: uint16_t, initial_value: "0"}
|
||||
|
||||
ble_client:
|
||||
- mac_address: ${peer_mac}
|
||||
id: srv
|
||||
on_connect:
|
||||
- logger.log: {format: "CLI connected", level: INFO}
|
||||
# Runs inside SEARCH_CMPL, before ble_client releases the GATT cache (it has no other nodes)
|
||||
- lambda: |-
|
||||
esp_bt_uuid_t uuid = esp32_ble_tracker::ESPBTUUID::from_raw("5ec10001-0000-1000-8000-00805f9b34fb").get_uuid();
|
||||
esp_gattc_char_elem_t elem;
|
||||
uint16_t count = 1;
|
||||
id(chr_handle) = 0;
|
||||
if (esp_ble_gattc_get_char_by_uuid(id(srv)->get_gattc_if(), id(srv)->get_conn_id(), 1, 0xFFFF, uuid, &elem,
|
||||
&count) == ESP_GATT_OK && count > 0)
|
||||
id(chr_handle) = elem.char_handle;
|
||||
- delay: 1500ms
|
||||
- lambda: |-
|
||||
if (!id(srv)->connected()) return;
|
||||
esp_gatt_if_t gattc_if = id(srv)->get_gattc_if();
|
||||
uint16_t conn_id = id(srv)->get_conn_id();
|
||||
uint16_t handle = id(chr_handle);
|
||||
if (handle == 0) {
|
||||
ESP_LOGW("btu", "ROUND skipped, no characteristic");
|
||||
return;
|
||||
}
|
||||
int n = ++id(rounds);
|
||||
ESP_LOGI("btu", "ROUND %d start conn_id=%u handle=0x%04x", n, conn_id, handle);
|
||||
TaskHandle_t btu = xTaskGetHandle("BTU_TASK");
|
||||
if (btu == nullptr) {
|
||||
// vTaskSuspend(nullptr) would suspend this task forever
|
||||
ESP_LOGE("btu", "ROUND %d aborted, no BTU_TASK", n);
|
||||
return;
|
||||
}
|
||||
vTaskSuspend(btu);
|
||||
// a rejected disconnect leaves the link up, so the queued calls never take the failing send path
|
||||
esp_err_t err = esp_ble_gap_disconnect(id(srv)->get_remote_bda());
|
||||
for (int i = 0; i < 4; i++) {
|
||||
esp_err_t e = esp_ble_gattc_read_char(gattc_if, conn_id, handle, ESP_GATT_AUTH_REQ_NONE);
|
||||
if (e != ESP_OK)
|
||||
err = e;
|
||||
}
|
||||
esp_err_t e = ${exec_write} ? esp_ble_gattc_execute_write(gattc_if, conn_id, true)
|
||||
: esp_ble_gattc_send_mtu_req(gattc_if, conn_id);
|
||||
if (e != ESP_OK)
|
||||
err = e;
|
||||
delay(30);
|
||||
vTaskResume(btu);
|
||||
// a round whose calls were rejected never reached the BTU queue, so it tests nothing
|
||||
if (err != ESP_OK) {
|
||||
ESP_LOGW("btu", "ROUND %d not queued: %s", n, esp_err_to_name(err));
|
||||
} else {
|
||||
ESP_LOGI("btu", "ROUND %d fired", n);
|
||||
}
|
||||
on_disconnect:
|
||||
- logger.log: {format: "CLI disconnected", level: INFO}
|
||||
@@ -0,0 +1,9 @@
|
||||
esphome:
|
||||
name: btuclibase # one name per build (btuclibase, btuclipr)
|
||||
|
||||
substitutions:
|
||||
peer_mac: "AA:BB:CC:DD:EE:FF" # the peer S3 Bluetooth MAC (Wi-Fi MAC + 2)
|
||||
exec_write: "false"
|
||||
|
||||
packages:
|
||||
common: !include btu-common.yaml
|
||||
@@ -0,0 +1,31 @@
|
||||
# Peer for the Bluedroid queued MTU recursion repro: a GATT server with one readable and writable characteristic
|
||||
esphome:
|
||||
name: btusrv
|
||||
|
||||
esp32:
|
||||
variant: esp32s3
|
||||
board: esp32-s3-devkitc-1
|
||||
framework:
|
||||
type: esp-idf
|
||||
|
||||
logger:
|
||||
level: DEBUG
|
||||
hardware_uart: USB_SERIAL_JTAG
|
||||
|
||||
esp32_ble:
|
||||
name: btusrv
|
||||
|
||||
esp32_ble_server:
|
||||
on_connect:
|
||||
- logger.log: {format: "SRV connected", level: INFO}
|
||||
on_disconnect:
|
||||
- logger.log: {format: "SRV disconnected", level: INFO}
|
||||
services:
|
||||
- uuid: 5ec10000-0000-1000-8000-00805f9b34fb
|
||||
advertise: true
|
||||
characteristics:
|
||||
- id: numc
|
||||
uuid: 5ec10001-0000-1000-8000-00805f9b34fb
|
||||
read: true
|
||||
write: true
|
||||
value: [42]
|
||||
@@ -0,0 +1,15 @@
|
||||
esphome:
|
||||
name: btuxwbase # one name per build (btuxwbase, btuxwpr)
|
||||
|
||||
substitutions:
|
||||
peer_mac: "AA:BB:CC:DD:EE:FF" # the peer S3 Bluetooth MAC (Wi-Fi MAC + 2)
|
||||
exec_write: "true"
|
||||
|
||||
esp32:
|
||||
framework:
|
||||
sdkconfig_options:
|
||||
# GATT API trace prints one "GATTC_ExecuteWrite conn_id=" line per execute send
|
||||
CONFIG_BT_LOG_GATT_TRACE_LEVEL_API: y
|
||||
|
||||
packages:
|
||||
common: !include btu-common.yaml
|
||||
@@ -0,0 +1,170 @@
|
||||
# CC1101 sleep and wake checks T0 to T6 on an ESP32-S3 (SPI on GPIO12/11/13, CS GPIO10, GDO0 GPIO9), run 4 s after
|
||||
# boot; the result is the "DONE fails=N" line. Substitution: name.
|
||||
esphome:
|
||||
name: ${name}
|
||||
includes: [cctest.hpp]
|
||||
on_boot:
|
||||
- priority: -100
|
||||
then:
|
||||
- delay: 4s
|
||||
- script.execute: run_tests
|
||||
esp32:
|
||||
variant: esp32s3
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
level: DEBUG
|
||||
hardware_uart: USB_SERIAL_JTAG
|
||||
spi:
|
||||
clk_pin: GPIO12
|
||||
mosi_pin: GPIO11
|
||||
miso_pin: GPIO13
|
||||
cc1101:
|
||||
id: transceiver
|
||||
cs_pin: GPIO10
|
||||
gdo0_pin: GPIO9
|
||||
frequency: 433.92MHz
|
||||
modulation_type: GFSK
|
||||
symbol_rate: 4800
|
||||
packet_mode: true
|
||||
packet_length: 8
|
||||
crc_enable: true
|
||||
sync_mode: "16/16"
|
||||
output_power: 0
|
||||
on_packet:
|
||||
then:
|
||||
- lambda: ESP_LOGI("cct", "RX packet %s rssi %.1f", format_hex(x).c_str(), rssi);
|
||||
script:
|
||||
- id: run_tests
|
||||
then:
|
||||
- lambda: |-
|
||||
using namespace cct;
|
||||
auto *c = id(transceiver);
|
||||
Snap base, s;
|
||||
int fails = 0;
|
||||
snap(c, base);
|
||||
ESP_LOGI("cct", "T0 baseline MARCSTATE=%02X FREQ=%02X%02X%02X TEST2=%02X TEST1=%02X TEST0=%02X so_high_awake=%d",
|
||||
base.marc, base.reg[0x0D], base.reg[0x0E], base.reg[0x0F], base.reg[0x2C], base.reg[0x2D],
|
||||
base.reg[0x2E], cs_low_so_high(c));
|
||||
hexpa("T0 baseline", base.pa);
|
||||
// the sleep checks below need a probe that sees an awake chip as awake
|
||||
if (cs_low_so_high(c)) {
|
||||
ESP_LOGW("cct", "T0 FAIL: SO reads high on an awake chip, the sleep checks cannot be trusted");
|
||||
fails++;
|
||||
}
|
||||
|
||||
// T1: mark PATABLE 1-7, sleep, wake by hand: lost entries prove the chip slept
|
||||
const uint8_t marks[8] = {base.pa[0], 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77};
|
||||
write_pa(c, marks);
|
||||
snap(c, s); hexpa("T1 marked", s.pa);
|
||||
c->power_down();
|
||||
bool so = cs_low_so_high(c);
|
||||
snap(c, s);
|
||||
hexpa("T1 after raw wake", s.pa);
|
||||
bool lost = s.pa[1] != 0x11;
|
||||
ESP_LOGI("cct", "T1 sleep proof: so_high_on_cs=%d pa_lost=%d MARCSTATE=%02X TEST0=%02X -> %s", so, lost, s.marc,
|
||||
s.reg[0x2E], (so && lost) ? "PASS" : "FAIL");
|
||||
if (!(so && lost)) fails++;
|
||||
// the component still thinks it sleeps
|
||||
c->wake_up();
|
||||
snap(c, s);
|
||||
int d = diff(base, s, "T1 restore");
|
||||
ESP_LOGI("cct", "T1 restore after wake_up: %d differences, MARCSTATE=%02X -> %s", d, s.marc, d == 0 ? "PASS" : "FAIL");
|
||||
if (d) fails++;
|
||||
c->begin_rx();
|
||||
|
||||
// T2: change settings while asleep, compare with the same change made awake
|
||||
Snap awake;
|
||||
c->set_frequency(433.42e6); c->set_output_power(5); c->set_symbol_rate(9600);
|
||||
snap(c, awake);
|
||||
c->set_frequency(433.92e6); c->set_output_power(0); c->set_symbol_rate(4800);
|
||||
c->power_down();
|
||||
c->set_frequency(433.42e6); c->set_output_power(5); c->set_symbol_rate(9600);
|
||||
bool so2 = cs_low_so_high(c); // wakes the chip by hand; component still asleep
|
||||
c->wake_up();
|
||||
c->begin_rx();
|
||||
snap(c, s);
|
||||
awake.marc = s.marc;
|
||||
d = diff(awake, s, "T2 asleep vs awake");
|
||||
ESP_LOGI("cct", "T2 settings changed asleep: so_high=%d %d differences FREQ=%02X%02X%02X MARCSTATE=%02X -> %s", so2, d,
|
||||
s.reg[0x0D], s.reg[0x0E], s.reg[0x0F], s.marc, (so2 && d == 0) ? "PASS" : "FAIL");
|
||||
if (!(so2 && d == 0)) fails++;
|
||||
c->set_frequency(433.92e6); c->set_output_power(0); c->set_symbol_rate(4800);
|
||||
c->begin_rx();
|
||||
snap(c, base);
|
||||
|
||||
// T3: send while asleep wakes the radio by itself
|
||||
c->power_down();
|
||||
uint8_t pkt[8] = {1, 2, 3, 4, 5, 6, 7, 8};
|
||||
int err = (int) c->transmit_packet(pkt, sizeof(pkt));
|
||||
snap(c, s);
|
||||
d = diff(base, s, "T3 after send");
|
||||
ESP_LOGI("cct", "T3 send while asleep: err=%d MARCSTATE=%02X TXBYTES=%02X %d differences -> %s", err, s.marc,
|
||||
status(c, 0x3A), d, (err == 0 && d == 0) ? "PASS" : "FAIL");
|
||||
if (!(err == 0 && d == 0)) fails++;
|
||||
|
||||
// T4: begin_rx while asleep
|
||||
c->power_down();
|
||||
c->begin_rx();
|
||||
snap(c, s);
|
||||
d = diff(base, s, "T4 begin_rx");
|
||||
ESP_LOGI("cct", "T4 begin_rx while asleep: MARCSTATE=%02X %d differences -> %s", s.marc, d,
|
||||
(s.marc == 0x0D && d == 0) ? "PASS" : "FAIL");
|
||||
if (!(s.marc == 0x0D && d == 0)) fails++;
|
||||
|
||||
// T5: 200 cycles, each one proven asleep and restored
|
||||
int bad = 0, notslept = 0;
|
||||
uint32_t t0 = micros();
|
||||
for (int i = 0; i < 200; i++) {
|
||||
write_pa(c, marks);
|
||||
c->power_down();
|
||||
if (!cs_low_so_high(c)) notslept++;
|
||||
c->wake_up();
|
||||
c->begin_rx();
|
||||
snap(c, s);
|
||||
if (diff(base, s, "T5") != 0) bad++;
|
||||
if ((i & 31) == 0) App.feed_wdt();
|
||||
}
|
||||
ESP_LOGI("cct", "T5 200 cycles: not_slept=%d restore_fail=%d in %u ms heap=%u -> %s", notslept, bad,
|
||||
(unsigned) ((micros() - t0) / 1000), (unsigned) esp_get_free_heap_size(),
|
||||
(notslept == 0 && bad == 0) ? "PASS" : "FAIL");
|
||||
if (notslept || bad) fails++;
|
||||
// T6: each setter on its own while asleep: does it wake the chip, and in which state does it leave it
|
||||
struct Case { const char *name; int kind; };
|
||||
const Case cases[] = {{"set_frequency", 0}, {"set_channel", 1}, {"set_modulation_type", 2}, {"set_symbol_rate", 3},
|
||||
{"set_output_power", 4}, {"set_filter_bandwidth", 5}, {"set_fsk_deviation", 6}};
|
||||
for (auto &k : cases) {
|
||||
c->begin_rx();
|
||||
c->power_down();
|
||||
switch (k.kind) {
|
||||
case 0: c->set_frequency(433.92e6); break;
|
||||
case 1: c->set_channel(0); break;
|
||||
case 2: c->set_modulation_type(cc1101::Modulation::MODULATION_GFSK); break;
|
||||
case 3: c->set_symbol_rate(4800); break;
|
||||
case 4: c->set_output_power(0); break;
|
||||
case 5: c->set_filter_bandwidth(203e3); break;
|
||||
case 6: c->set_fsk_deviation(1.5e3); break;
|
||||
}
|
||||
bool asleep = cs_low_so_high(c);
|
||||
uint8_t marc = status(c, 0x35) & 0x1F;
|
||||
ESP_LOGI("cct", "T6 %-20s while asleep: chip %s, MARCSTATE=%02X", k.name, asleep ? "still asleep" : "AWAKE", marc);
|
||||
if (!asleep) fails++;
|
||||
c->wake_up();
|
||||
}
|
||||
c->begin_rx();
|
||||
uint8_t agc_rx = rd(c, 0x2B);
|
||||
c->set_idle();
|
||||
uint8_t agc_idle = rd(c, 0x2B);
|
||||
ESP_LOGI("cct", "AGCTEST in RX=%02X in IDLE=%02X", agc_rx, agc_idle);
|
||||
c->begin_rx();
|
||||
ESP_LOGI("cct", "DONE fails=%d", fails);
|
||||
button:
|
||||
- platform: template
|
||||
id: yaml_actions
|
||||
name: Yaml actions
|
||||
on_press:
|
||||
- cc1101.power_down: transceiver
|
||||
- cc1101.wake_up: transceiver
|
||||
- cc1101.power_down: transceiver
|
||||
- cc1101.send_packet: [0x12, 0x34, 0x56, 0x78, 0x90, 0xab, 0xcd, 0xef]
|
||||
- lambda: ESP_LOGI("cct", "YAML actions done MARCSTATE=%02X", cct::status(id(transceiver), 0x35) & 0x1F);
|
||||
@@ -0,0 +1,70 @@
|
||||
// Register and PATABLE snapshots plus the CHIP_RDYn sleep check for the cc1101 sleep tests in cc1101-sleep.yaml.
|
||||
#pragma once
|
||||
#include "esphome/components/cc1101/cc1101.h"
|
||||
#include "driver/gpio.h"
|
||||
#include <cstring>
|
||||
|
||||
namespace cct {
|
||||
using esphome::cc1101::CC1101Component;
|
||||
static constexpr gpio_num_t MISO = GPIO_NUM_13; // the SPI MISO pin in cc1101-sleep.yaml
|
||||
static constexpr uint8_t NREG = 0x2F; // IOCFG2..TEST0
|
||||
|
||||
struct Snap {
|
||||
uint8_t reg[NREG];
|
||||
uint8_t pa[8];
|
||||
uint8_t marc;
|
||||
};
|
||||
|
||||
// Chip ready flag: with CSn low, SO stays high until the crystal runs (SLEEP), low at once otherwise
|
||||
inline bool cs_low_so_high(CC1101Component *c) {
|
||||
c->enable();
|
||||
bool high = gpio_get_level(MISO);
|
||||
delayMicroseconds(300);
|
||||
c->disable();
|
||||
return high;
|
||||
}
|
||||
inline uint8_t rd(CC1101Component *c, uint8_t a) {
|
||||
c->enable();
|
||||
c->write_byte(a | 0x80);
|
||||
uint8_t v = c->read_byte();
|
||||
c->disable();
|
||||
return v;
|
||||
}
|
||||
inline uint8_t status(CC1101Component *c, uint8_t a) { return rd(c, a | 0x40); }
|
||||
inline void snap(CC1101Component *c, Snap &s) {
|
||||
for (uint8_t i = 0; i < NREG; i++)
|
||||
s.reg[i] = rd(c, i);
|
||||
c->enable();
|
||||
c->write_byte(0x3E | 0xC0);
|
||||
for (auto &b : s.pa)
|
||||
b = c->read_byte();
|
||||
c->disable();
|
||||
s.marc = status(c, 0x35) & 0x1F;
|
||||
}
|
||||
inline void write_pa(CC1101Component *c, const uint8_t *pa) {
|
||||
c->enable();
|
||||
c->write_byte(0x3E | 0x40);
|
||||
for (int i = 0; i < 8; i++)
|
||||
c->write_byte(pa[i]);
|
||||
c->disable();
|
||||
}
|
||||
inline int diff(const Snap &a, const Snap &b, const char *what) {
|
||||
int n = 0;
|
||||
for (uint8_t i = 0; i < NREG; i++)
|
||||
// FSCAL3..FSCAL1 hold calibration results, FSTEST and AGCTEST are chip owned test registers
|
||||
if (i != 0x23 && i != 0x24 && i != 0x25 && i != 0x29 && i != 0x2B && a.reg[i] != b.reg[i]) {
|
||||
ESP_LOGW("cct", "%s reg 0x%02X: %02X vs %02X", what, i, a.reg[i], b.reg[i]);
|
||||
n++;
|
||||
}
|
||||
for (int i = 0; i < 8; i++)
|
||||
if (a.pa[i] != b.pa[i]) {
|
||||
ESP_LOGW("cct", "%s pa[%d]: %02X vs %02X", what, i, a.pa[i], b.pa[i]);
|
||||
n++;
|
||||
}
|
||||
return n;
|
||||
}
|
||||
inline void hexpa(const char *tag, const uint8_t *pa) {
|
||||
ESP_LOGI("cct", "%s PA %02X %02X %02X %02X %02X %02X %02X %02X", tag, pa[0], pa[1], pa[2], pa[3], pa[4], pa[5], pa[6],
|
||||
pa[7]);
|
||||
}
|
||||
} // namespace cct
|
||||
@@ -0,0 +1,116 @@
|
||||
#ifndef FUZZ22773_CLIMATE_FUZZ_H
|
||||
#define FUZZ22773_CLIMATE_FUZZ_H
|
||||
// Test only (esphome#22773 A/B): feeds a climate's own frames, mutated copies and random frames to on_receive
|
||||
// and prints whether each was accepted and the state that followed.
|
||||
#include <cstdio>
|
||||
#include <random>
|
||||
#include <vector>
|
||||
#include "esphome/components/climate_ir/climate_ir.h"
|
||||
#include "esphome/components/remote_base/aeha_protocol.h"
|
||||
#include "esphome/components/remote_base/remote_base.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/preferences.h"
|
||||
|
||||
namespace esphome::fuzz22773 {
|
||||
|
||||
class Cap : public remote_base::RemoteTransmitterBase {
|
||||
public:
|
||||
Cap() : RemoteTransmitterBase(nullptr) {}
|
||||
std::vector<remote_base::RawTimings> frames;
|
||||
|
||||
protected:
|
||||
void send_internal(uint32_t, uint32_t) override { this->frames.push_back(this->temp_.get_data()); }
|
||||
};
|
||||
|
||||
template<typename C> void prep(C &c, Cap &tx) {
|
||||
if (global_preferences != nullptr)
|
||||
global_preferences->reset();
|
||||
static char name[] = "fuzz";
|
||||
static char fn[] = "";
|
||||
App.pre_setup(name, sizeof(name) - 1, fn, 0);
|
||||
c.set_transmitter(&tx);
|
||||
static_cast<Component &>(c).setup();
|
||||
}
|
||||
|
||||
template<typename C> void print_state(const char *tag, int i, bool ok, C &c) {
|
||||
printf("FUZZ %s %d ok=%d mode=%d t=%.2f fan=%d swing=%d\n", tag, i, ok ? 1 : 0, (int) c.mode,
|
||||
(double) c.target_temperature, c.fan_mode.has_value() ? (int) *c.fan_mode : -1, (int) c.swing_mode);
|
||||
}
|
||||
|
||||
// A random AEHA frame of len bytes; half start with the climate's header (set_header), 3 in 4 use its address
|
||||
template<typename Header>
|
||||
void aeha_random(std::mt19937 &rng, remote_base::RawTimings &raw, size_t len, uint16_t address, Header set_header) {
|
||||
uint8_t d[35];
|
||||
for (auto &b : d)
|
||||
b = rng();
|
||||
if (rng() % 2)
|
||||
set_header(d);
|
||||
remote_base::RemoteTransmitData tx;
|
||||
remote_base::AEHAProtocol().encode(&tx, (rng() % 4) ? address : uint16_t(rng()), d, len);
|
||||
raw = tx.get_data();
|
||||
}
|
||||
|
||||
// make() returns a fresh climate; random_frame(rng, raw) fills raw with a random frame of the protocol, without the
|
||||
// trailing idle gap
|
||||
template<typename Make, typename Rand> void run(const char *tag, Make make, Rand random_frame) {
|
||||
std::mt19937 rng(22773);
|
||||
// Valid frames: everything the climate itself sends
|
||||
std::vector<remote_base::RawTimings> valid;
|
||||
{
|
||||
Cap tx;
|
||||
auto c = make();
|
||||
prep(*c, tx);
|
||||
for (auto mode : {climate::CLIMATE_MODE_OFF, climate::CLIMATE_MODE_COOL, climate::CLIMATE_MODE_HEAT,
|
||||
climate::CLIMATE_MODE_DRY, climate::CLIMATE_MODE_FAN_ONLY, climate::CLIMATE_MODE_HEAT_COOL})
|
||||
for (float t : {16.0f, 18.0f, 21.0f, 24.0f, 27.0f, 30.0f, 60.0f, 66.0f, 72.0f, 80.0f, 88.0f})
|
||||
for (auto fan : {climate::CLIMATE_FAN_AUTO, climate::CLIMATE_FAN_LOW, climate::CLIMATE_FAN_MEDIUM,
|
||||
climate::CLIMATE_FAN_HIGH}) {
|
||||
auto call = c->make_call();
|
||||
call.set_mode(mode);
|
||||
call.set_target_temperature(t);
|
||||
call.set_fan_mode(fan);
|
||||
call.perform();
|
||||
}
|
||||
valid = tx.frames;
|
||||
for (auto &v : valid)
|
||||
v.push_back(-20000); // the idle gap a receiver records after the last mark
|
||||
}
|
||||
int i = 0;
|
||||
auto feed = [&](const remote_base::RawTimings &raw, const char *kind) {
|
||||
Cap tx;
|
||||
auto c = make();
|
||||
prep(*c, tx);
|
||||
remote_base::RemoteReceiveData data(raw, 25, remote_base::TOLERANCE_MODE_PERCENTAGE);
|
||||
bool ok = static_cast<remote_base::RemoteReceiverListener &>(*c).on_receive(data);
|
||||
printf("%s ", kind);
|
||||
print_state(tag, i++, ok, *c);
|
||||
};
|
||||
for (const auto &v : valid) {
|
||||
feed(v, "valid");
|
||||
for (int m = 0; m < 4; m++) {
|
||||
auto raw = v;
|
||||
if (raw.size() < 8)
|
||||
continue;
|
||||
// a space swapped with another space's length flips a bit (or does nothing when they are equal)
|
||||
size_t a = 3 + rng() % (raw.size() - 3), b = 3 + rng() % (raw.size() - 3);
|
||||
if (raw[a] < 0 && raw[b] < 0)
|
||||
std::swap(raw[a], raw[b]);
|
||||
else
|
||||
raw[a] = raw[a] < 0 ? -int32_t(100 + rng() % 3000) : int32_t(100 + rng() % 3000);
|
||||
feed(raw, "mut");
|
||||
}
|
||||
auto t = v;
|
||||
t.resize(rng() % t.size());
|
||||
feed(t, "trunc");
|
||||
}
|
||||
for (int r = 0; r < 3000; r++) {
|
||||
remote_base::RawTimings raw;
|
||||
random_frame(rng, raw);
|
||||
raw.push_back(-20000);
|
||||
feed(raw, "rand");
|
||||
}
|
||||
fflush(stdout);
|
||||
}
|
||||
|
||||
} // namespace esphome::fuzz22773
|
||||
#endif
|
||||
@@ -0,0 +1,17 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <memory>
|
||||
#include "climate_fuzz.hpp"
|
||||
#include "esphome/components/friedrich/friedrich.h"
|
||||
namespace esphome::fuzz22773 {
|
||||
TEST(Fuzz22773, Friedrich) {
|
||||
run("friedrich", [] { return std::make_unique<friedrich::FriedrichClimate>(); },
|
||||
[](std::mt19937 &rng, remote_base::RawTimings &raw) {
|
||||
size_t len = (rng() % 3 == 0) ? 2 + rng() % 34 : ((rng() & 1) ? 14 : 5);
|
||||
aeha_random(rng, raw, len, 0x28C6, [](uint8_t *d) {
|
||||
d[0] = 0x00;
|
||||
d[1] = 0x08;
|
||||
d[2] = 0x08;
|
||||
});
|
||||
});
|
||||
}
|
||||
} // namespace esphome::fuzz22773
|
||||
@@ -0,0 +1,19 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <memory>
|
||||
#include "climate_fuzz.hpp"
|
||||
#include "esphome/components/haier_tundra/haier_tundra.h"
|
||||
#include "esphome/components/remote_base/haier_protocol.h"
|
||||
namespace esphome::fuzz22773 {
|
||||
TEST(Fuzz22773, HaierTundra) {
|
||||
run("haier_tundra", [] { return std::make_unique<haier_tundra::HaierTundra>(haier_tundra::HAIER_HEADER_UNIT_A); },
|
||||
[](std::mt19937 &rng, remote_base::RawTimings &raw) {
|
||||
uint8_t d[16];
|
||||
size_t len = (rng() % 3 == 0) ? 1 + rng() % 16 : 13;
|
||||
for (auto &b : d) b = rng();
|
||||
if (rng() % 2) d[0] = haier_tundra::HAIER_HEADER_UNIT_A;
|
||||
remote_base::RemoteTransmitData tx;
|
||||
remote_base::HaierProtocol().encode(&tx, d, len);
|
||||
raw = tx.get_data();
|
||||
});
|
||||
}
|
||||
} // namespace esphome::fuzz22773
|
||||
@@ -0,0 +1,12 @@
|
||||
from esphome.components import remote_base
|
||||
from esphome.types import ConfigType
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
manifest.auto_load = ["climate_ir", "climate"]
|
||||
|
||||
async def to_code_testing(config: ConfigType) -> None:
|
||||
remote_base.request_protocol("haier")
|
||||
|
||||
manifest.to_code = to_code_testing
|
||||
@@ -0,0 +1,16 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <memory>
|
||||
#include "climate_fuzz.hpp"
|
||||
#include "esphome/components/mistral_ir/mistral_ir.h"
|
||||
namespace esphome::fuzz22773 {
|
||||
TEST(Fuzz22773, MistralIR) {
|
||||
run("mistral", [] { return std::make_unique<mistral_ir::MistralIR>(); },
|
||||
[](std::mt19937 &rng, remote_base::RawTimings &raw) {
|
||||
size_t len = (rng() % 3 == 0) ? 2 + rng() % 34 : 12;
|
||||
aeha_random(rng, raw, len, mistral_ir::MISTRAL_ADDRESS, [](uint8_t *d) {
|
||||
d[0] = 0x56;
|
||||
d[2] = 0x08;
|
||||
});
|
||||
});
|
||||
}
|
||||
} // namespace esphome::fuzz22773
|
||||
@@ -0,0 +1,28 @@
|
||||
# Network, API and the VERBOSE logger setup shared by the climate loopback configs.
|
||||
esphome:
|
||||
name: ${name}
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
power_save_mode: none
|
||||
logger:
|
||||
level: VERBOSE
|
||||
logs:
|
||||
wifi: DEBUG
|
||||
api: DEBUG
|
||||
api.service: DEBUG
|
||||
api.connection: DEBUG
|
||||
scheduler: DEBUG
|
||||
component: DEBUG
|
||||
esp32.preferences: DEBUG
|
||||
esp8266.preferences: DEBUG
|
||||
preferences: DEBUG
|
||||
mdns: DEBUG
|
||||
sensor: DEBUG
|
||||
remote_receiver: DEBUG
|
||||
remote_transmitter: DEBUG
|
||||
climate: DEBUG
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
ota:
|
||||
- platform: esphome
|
||||
@@ -0,0 +1,12 @@
|
||||
# Samsung, Friedrich, Siemens IRA211 and Mistral senders and receivers on one loopback pin.
|
||||
packages:
|
||||
base: !include base.yaml
|
||||
climate:
|
||||
- {platform: samsung, id: sam_tx, name: SAM TX, transmitter_id: irtx}
|
||||
- {platform: samsung, id: sam_rx, name: SAM RX, transmitter_id: irtx, receiver_id: irrx}
|
||||
- {platform: friedrich, id: fr_tx, name: FR TX, transmitter_id: irtx}
|
||||
- {platform: friedrich, id: fr_rx, name: FR RX, transmitter_id: irtx, receiver_id: irrx}
|
||||
- {platform: siemens_ira211, id: si_tx, name: SI TX, transmitter_id: irtx}
|
||||
- {platform: siemens_ira211, id: si_rx, name: SI RX, transmitter_id: irtx, receiver_id: irrx}
|
||||
- {platform: mistral_ir, id: mi_tx, name: MI TX, transmitter_id: irtx}
|
||||
- {platform: mistral_ir, id: mi_rx, name: MI RX, transmitter_id: irtx, receiver_id: irrx}
|
||||
@@ -0,0 +1,5 @@
|
||||
substitutions:
|
||||
name: c32pr
|
||||
packages:
|
||||
common: !include c-common.yaml
|
||||
board: !include esp32-ir.yaml
|
||||
@@ -0,0 +1,98 @@
|
||||
"""compare.py A B [TOL] [--flat]: compare two runs (A-frames.json, B-frames.json from frames.py).
|
||||
|
||||
Per step (default): frames equal within TOL us and RX states equal.
|
||||
--flat: the whole frame sequence in order, timing by timing, ignoring step boundaries (for the D1 mini, where a log
|
||||
line can land in the next step); reports every item over TOL and the largest deviation elsewhere.
|
||||
"""
|
||||
|
||||
import json
|
||||
import pathlib
|
||||
import sys
|
||||
|
||||
args = [a for a in sys.argv[1:] if a != "--flat"]
|
||||
FLAT = "--flat" in sys.argv[1:]
|
||||
TOL = int(args[2]) if len(args) > 2 else 0
|
||||
|
||||
|
||||
def load(name):
|
||||
steps = json.loads(pathlib.Path(f"{name}-frames.json").read_text(encoding="utf-8"))
|
||||
# an empty run must not compare as equal to another empty run
|
||||
if not steps or not any(s["frames"] for s in steps):
|
||||
sys.exit(f"{name}-frames.json has no steps or no frames")
|
||||
return steps
|
||||
|
||||
|
||||
def same_timing(u, v):
|
||||
return (u > 0) == (v > 0) and abs(u - v) <= TOL
|
||||
|
||||
|
||||
def frame_dev(p, q):
|
||||
"""Largest deviation of two frames, or None when they differ in length or a timing is over TOL."""
|
||||
if len(p) != len(q) or not all(
|
||||
same_timing(u, v) for u, v in zip(p, q, strict=False)
|
||||
):
|
||||
return None
|
||||
return max((abs(u - v) for u, v in zip(p, q, strict=False)), default=0)
|
||||
|
||||
|
||||
def flat(a, b):
|
||||
fa = [f for s in a for f in s["frames"]]
|
||||
fb = [f for s in b for f in s["frames"]]
|
||||
mx = bad = items = 0
|
||||
print("frames", len(fa), len(fb))
|
||||
if len(fa) != len(fb):
|
||||
print("DIFF frame counts differ (a lost or extra transmission)")
|
||||
bad += 1
|
||||
for i, (p, q) in enumerate(zip(fa, fb, strict=False)):
|
||||
if len(p) != len(q):
|
||||
print("frame", i, "length", len(p), len(q))
|
||||
bad += 1
|
||||
continue
|
||||
for j, (u, v) in enumerate(zip(p, q, strict=False)):
|
||||
items += 1
|
||||
if same_timing(u, v):
|
||||
mx = max(mx, abs(u - v))
|
||||
else:
|
||||
print("frame", i, "item", j, u, v)
|
||||
bad += 1
|
||||
print(f"items {items} over_tol {bad} max_dev_within_tol {mx}")
|
||||
return bad == 0
|
||||
|
||||
|
||||
def per_step(a, b):
|
||||
if len(a) != len(b):
|
||||
print(f"DIFF step counts {len(a)} vs {len(b)} (an interrupted run?)")
|
||||
sys.exit(1)
|
||||
same_f = same_s = maxdev = 0
|
||||
for x, y in zip(a, b, strict=False):
|
||||
assert x["step"] == y["step"]
|
||||
fa, fb = x["frames"], y["frames"]
|
||||
devs = [frame_dev(p, q) for p, q in zip(fa, fb, strict=False)]
|
||||
ok = len(fa) == len(fb) and None not in devs
|
||||
if ok:
|
||||
maxdev = max([maxdev, *devs])
|
||||
same_f += ok
|
||||
st = x["rx"] == y["rx"]
|
||||
same_s += st
|
||||
if not ok or not st:
|
||||
print(
|
||||
"DIFF",
|
||||
x["step"],
|
||||
"frames",
|
||||
len(fa),
|
||||
len(fb),
|
||||
[len(p) for p in fa],
|
||||
[len(q) for q in fb],
|
||||
)
|
||||
for k in x["rx"]:
|
||||
if x["rx"][k] != y["rx"].get(k):
|
||||
print(" ", k, x["rx"][k], "|", y["rx"].get(k))
|
||||
print(
|
||||
f"steps {len(a)}/{len(b)} frames_equal {same_f} rx_states_equal {same_s} "
|
||||
f"total_frames {sum(len(s['frames']) for s in a)}/{sum(len(s['frames']) for s in b)} max_dev_us {maxdev}"
|
||||
)
|
||||
return same_f == len(a) and same_s == len(a)
|
||||
|
||||
|
||||
if not (flat if FLAT else per_step)(load(args[0]), load(args[1])):
|
||||
sys.exit(1)
|
||||
@@ -0,0 +1,74 @@
|
||||
"""drive.py IP STEP...: STEP is 'Name:mode=cool,t=24,fan=low,swing=vertical' or 'svc:action'; prints climate states after each."""
|
||||
|
||||
import asyncio
|
||||
import os
|
||||
import pathlib
|
||||
import sys
|
||||
import time
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
|
||||
from aioesphomeapi import (
|
||||
ClimateFanMode,
|
||||
ClimateInfo,
|
||||
ClimateMode,
|
||||
ClimatePreset,
|
||||
ClimateSwingMode,
|
||||
)
|
||||
from apiconn import connect
|
||||
|
||||
MODES = {m.name.lower(): m for m in ClimateMode}
|
||||
FANS = {m.name.lower(): m for m in ClimateFanMode}
|
||||
SWINGS = {m.name.lower(): m for m in ClimateSwingMode}
|
||||
PRESETS = {m.name.lower(): m for m in ClimatePreset}
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
c = await connect(sys.argv[1])
|
||||
ents, svcs = await c.list_entities_services()
|
||||
clim = {e.name: e for e in ents if isinstance(e, ClimateInfo)}
|
||||
byk = {e.key: e.name for e in clim.values()}
|
||||
st = {}
|
||||
c.subscribe_states(
|
||||
lambda s: st.__setitem__(byk[s.key], s) if s.key in byk else None
|
||||
)
|
||||
await asyncio.sleep(2)
|
||||
|
||||
def show(tag):
|
||||
for n in sorted(st):
|
||||
s = st[n]
|
||||
print(
|
||||
f" {tag} {n:11s} mode={s.mode.name} target={s.target_temperature:g} fan={s.fan_mode.name} swing={s.swing_mode.name} preset={s.preset.name}"
|
||||
)
|
||||
|
||||
show("init")
|
||||
for step in sys.argv[2:]:
|
||||
name, _, args = step.partition(":")
|
||||
print(time.strftime("%H:%M:%S"), "STEP", step, flush=True)
|
||||
if name == "svc":
|
||||
sname, _, sargs = args.partition("?")
|
||||
data = {
|
||||
k: v == "1"
|
||||
for k, v in (a.split("=") for a in filter(None, sargs.split("&")))
|
||||
}
|
||||
await c.execute_service(next(s for s in svcs if s.name == sname), data)
|
||||
else:
|
||||
kw = {}
|
||||
for a in filter(None, args.split(",")):
|
||||
k, v = a.split("=")
|
||||
if k == "mode":
|
||||
kw["mode"] = MODES[v]
|
||||
elif k == "t":
|
||||
kw["target_temperature"] = float(v)
|
||||
elif k == "fan":
|
||||
kw["fan_mode"] = FANS[v]
|
||||
elif k == "swing":
|
||||
kw["swing_mode"] = SWINGS[v]
|
||||
elif k == "preset":
|
||||
kw["preset"] = PRESETS[v]
|
||||
c.climate_command(clim[name].key, **kw)
|
||||
await asyncio.sleep(float(os.environ.get("STEP_S", "2.5")))
|
||||
show("after")
|
||||
await c.disconnect()
|
||||
|
||||
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,24 @@
|
||||
# One-pin IR loopback on an ESP32 devkit: transmitter and receiver share GPIO27, RMT reads its own output.
|
||||
# Override the substitutions (or `dump:`) from the including config.
|
||||
substitutions:
|
||||
pin: GPIO27
|
||||
rmt_symbols: "384"
|
||||
receive_symbols: "384"
|
||||
esp32:
|
||||
board: esp32dev
|
||||
framework:
|
||||
type: esp-idf
|
||||
remote_transmitter:
|
||||
id: irtx
|
||||
pin:
|
||||
number: ${pin}
|
||||
allow_other_uses: true
|
||||
carrier_duty_percent: 100%
|
||||
remote_receiver:
|
||||
id: irrx
|
||||
pin:
|
||||
number: ${pin}
|
||||
allow_other_uses: true
|
||||
dump: raw
|
||||
rmt_symbols: ${rmt_symbols}
|
||||
receive_symbols: ${receive_symbols}
|
||||
@@ -0,0 +1,23 @@
|
||||
# One-pin IR loopback on a D1 mini: transmitter and receiver share GPIO12. The receiver's setup leaves the shared pin
|
||||
# an input, so an interval drives it as an output again. Override the substitutions (or `dump:`) from the including
|
||||
# config.
|
||||
substitutions:
|
||||
pin: "12"
|
||||
esp8266:
|
||||
board: d1_mini
|
||||
remote_transmitter:
|
||||
id: irtx
|
||||
pin:
|
||||
number: ${pin}
|
||||
allow_other_uses: true
|
||||
carrier_duty_percent: 100%
|
||||
remote_receiver:
|
||||
id: irrx
|
||||
pin:
|
||||
number: ${pin}
|
||||
allow_other_uses: true
|
||||
dump: raw
|
||||
interval:
|
||||
- interval: 250ms
|
||||
then:
|
||||
- lambda: pinMode(${pin}, OUTPUT);
|
||||
@@ -0,0 +1,53 @@
|
||||
"""frames.py NAME: per step, the raw frames and the RX states. Prints JSON to NAME-frames.json."""
|
||||
|
||||
import json
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
n = sys.argv[1]
|
||||
steps = []
|
||||
cur = None
|
||||
with pathlib.Path(f"{n}-drive.txt").open(encoding="utf-8") as fh:
|
||||
for text in fh:
|
||||
m = re.match(r"(\d\d:\d\d:\d\d) STEP (.*)", text)
|
||||
if m:
|
||||
cur = {"t": m[1], "step": m[2], "rx": {}, "tx": {}, "frames": []}
|
||||
steps.append(cur)
|
||||
m = re.match(r"\s+after (\S+ \S+)\s+(.*)", text)
|
||||
if m and cur:
|
||||
(cur["rx"] if m[1].endswith("RX") else cur["tx"])[m[1]] = m[2]
|
||||
frames = []
|
||||
buf = None
|
||||
with pathlib.Path(f"{n}-ser.txt").open(encoding="utf-8", errors="replace") as fh:
|
||||
for text in fh:
|
||||
m = re.match(r"\[(\d\d:\d\d:\d\d)\]\[I\]\[remote\.raw(?::\d+)?\]: ?(.*)", text)
|
||||
if not m:
|
||||
continue
|
||||
ts, body = m[1], m[2]
|
||||
if body.startswith("Received Raw:"):
|
||||
buf = [ts, body[len("Received Raw:") :]]
|
||||
elif buf is not None:
|
||||
buf[1] += body
|
||||
# the raw dumper splits long frames into lines that end with a comma; the last line does not
|
||||
if buf is not None and not body.rstrip().endswith(","):
|
||||
frames.append(
|
||||
(
|
||||
buf[0],
|
||||
[
|
||||
int(x)
|
||||
for x in buf[1].replace(" ", "").strip(",").split(",")
|
||||
if x
|
||||
],
|
||||
)
|
||||
)
|
||||
buf = None
|
||||
for ts, f in frames:
|
||||
owner = None
|
||||
for s in steps:
|
||||
if s["t"] <= ts:
|
||||
owner = s
|
||||
if owner:
|
||||
owner["frames"].append(f)
|
||||
pathlib.Path(f"{n}-frames.json").write_text(json.dumps(steps), encoding="utf-8")
|
||||
print(n, "steps", len(steps), "frames", sum(len(s["frames"]) for s in steps))
|
||||
@@ -0,0 +1,30 @@
|
||||
#!/bin/bash
|
||||
# run.sh NAME PORT [STEPS_FILE]: serial capture with a reset, then the prelude and steps of STEPS_FILE (default
|
||||
# steps.sh here, which sets the PRE and STEPS arrays) through drive.py; writes NAME-ser.txt, NAME-pre.txt and
|
||||
# NAME-drive.txt. env: PY, BAUD (default 115200; use 921600 for long climate frames), STEP_S (default 2.5, the wait
|
||||
# after each step; the prelude always uses 2.5 s since it is not compared)
|
||||
D=$(cd "$(dirname "$0")" && pwd); S=$(dirname "$D"); N=${1:?name}; P=${2:?port}; PY=${PY:-python3}
|
||||
# shellcheck source=/dev/null
|
||||
source "${3:-$D/steps.sh}"
|
||||
cd "$D" || exit 1
|
||||
pkill -f "[s]erial_capture.py $P "; sleep 1
|
||||
# a stale capture would feed the IP lookup below
|
||||
rm -f "$D/$N-ser.txt"
|
||||
nohup $PY "$S/serial_capture.py" "$P" 1000 "$D/$N-ser.txt" --reset --baud "${BAUD:-115200}" > /dev/null 2>&1 &
|
||||
IP=
|
||||
for _ in $(seq 1 60); do
|
||||
IP=$(LC_ALL=C grep -a -o -E "IP Address: [0-9.]+" "$N-ser.txt" 2>/dev/null | tail -1 | cut -d' ' -f3)
|
||||
[ -n "$IP" ] && break; sleep 2
|
||||
done
|
||||
[ -z "$IP" ] && { echo "no IP in $N-ser.txt"; pkill -f "[s]erial_capture.py $P "; exit 1; }
|
||||
sleep 3
|
||||
STEP_S=2.5 $PY drive.py "$IP" "${PRE[@]}" > "$N-pre.txt" 2>&1; PRC=$?
|
||||
STEP_S=${STEP_S:-2.5} $PY drive.py "$IP" "${STEPS[@]}" > "$N-drive.txt" 2>&1; DRC=$?
|
||||
sleep 2; pkill -f "[s]erial_capture.py $P "; sleep 1
|
||||
echo "$N steps=$(grep -c STEP "$N-drive.txt") raw=$(LC_ALL=C grep -a -c 'Received Raw' "$N-ser.txt")" \
|
||||
"boots=$(LC_ALL=C grep -a -c 'Running through setup\|rst cause' "$N-ser.txt")"
|
||||
# a failed drive leaves a partial run: fail so frames.py and compare.py are not run on it
|
||||
if [ $PRC -ne 0 ] || [ $DRC -ne 0 ]; then
|
||||
echo "$N drive failed: prelude rc=$PRC steps rc=$DRC (see $N-pre.txt, $N-drive.txt)"
|
||||
exit 1
|
||||
fi
|
||||
@@ -0,0 +1,14 @@
|
||||
# prelude puts every sender in the same state on both builds; frames before the first MARK step are not compared
|
||||
PRE=("SAM TX:mode=off,t=24,fan=auto,swing=off" "FR TX:mode=off,t=72,fan=auto,swing=off" "SI TX:mode=off,t=21,fan=auto,preset=comfort" "MI TX:mode=off,t=24,fan=auto")
|
||||
STEPS=()
|
||||
for p in "SAM TX" "FR TX" "MI TX"; do
|
||||
for m in heat_cool cool dry fan_only heat off; do STEPS+=("${p}:mode=$m"); done
|
||||
STEPS+=("${p}:mode=cool")
|
||||
if [ "$p" = "FR TX" ]; then fans=(high medium low quiet auto); else fans=(low medium high auto); fi
|
||||
for f in "${fans[@]}"; do STEPS+=("${p}:fan=$f"); done
|
||||
[ "$p" = "SAM TX" ] && for s in vertical horizontal both off; do STEPS+=("${p}:swing=$s"); done
|
||||
STEPS+=("${p}:mode=off")
|
||||
done
|
||||
STEPS+=("SI TX:mode=heat_cool" "SI TX:preset=eco" "SI TX:preset=comfort")
|
||||
for f in low medium high auto; do STEPS+=("SI TX:fan=$f"); done
|
||||
STEPS+=("SI TX:mode=off")
|
||||
@@ -0,0 +1,52 @@
|
||||
# API actions that send whirlpool frames the sender cannot produce; add a board package and whirlpool/cl.yaml.
|
||||
packages:
|
||||
base: !include base.yaml
|
||||
remote_receiver:
|
||||
# a short frame ends in the idle gap, which the decoder takes as the second divider only up to 9,950 us
|
||||
# (7,960 + 25%); the 9 ms header mark must stay below idle
|
||||
idle: 9500us
|
||||
api:
|
||||
actions:
|
||||
# A Hitachi frame the sender cannot produce: temperature nibble 15 (16 + 15 = 31 C, above the 30 C max), cool, fan low
|
||||
- action: inject_t15
|
||||
then:
|
||||
- lambda: |-
|
||||
static constexpr remote_base::BitTimings T{.bit_mark = 572, .one_space = 1659, .zero_space = 553};
|
||||
uint8_t s[21] = {0};
|
||||
s[0] = 0xA9; s[1] = 0x59; s[2] = 0x03; s[3] = 0xF2; s[6] = 0x80; s[10] = 0x20; s[15] = 0x02;
|
||||
s[18] = 0x38; s[19] = 0x08;
|
||||
s[13] = xor_bytes(&s[2], 11);
|
||||
s[20] = xor_bytes(&s[14], 6);
|
||||
ESP_LOGI("w22704", "inject t15");
|
||||
auto call = id(irtx).transmit();
|
||||
auto *d = call.get_data();
|
||||
d->set_carrier_frequency(38000);
|
||||
d->mark(9000); d->space(4494);
|
||||
for (int i = 0; i < 21; i++) {
|
||||
if (i == 6 || i == 14) { d->mark(572); d->space(7960); }
|
||||
d->item_bytes<T>(s + i, 1);
|
||||
}
|
||||
d->mark(572);
|
||||
call.perform();
|
||||
# A 14-byte frame (what some whirlpool remotes send): bytes 0 to 13, the second divider, then silence
|
||||
- action: inject_short
|
||||
variables:
|
||||
hitachi: bool
|
||||
then:
|
||||
- lambda: |-
|
||||
static constexpr remote_base::BitTimings T{.bit_mark = 572, .one_space = 1659, .zero_space = 553};
|
||||
uint8_t s[14] = {0};
|
||||
s[0] = hitachi ? 0xA9 : 0x83; s[1] = hitachi ? 0x59 : 0x06; s[2] = 0x03; s[3] = 0xE2; s[6] = 0x80;
|
||||
if (hitachi) s[10] = 0x20;
|
||||
s[13] = xor_bytes(&s[2], 11);
|
||||
ESP_LOGI("w22704", "inject short hitachi=%d", (int) hitachi);
|
||||
auto call = id(irtx).transmit();
|
||||
auto *d = call.get_data();
|
||||
d->set_carrier_frequency(38000);
|
||||
d->mark(9000); d->space(4494);
|
||||
for (int i = 0; i < 14; i++) {
|
||||
if (i == 6) { d->mark(572); d->space(7960); }
|
||||
d->item_bytes<T>(s + i, 1);
|
||||
}
|
||||
d->mark(572);
|
||||
call.perform();
|
||||
@@ -0,0 +1,29 @@
|
||||
#!/bin/bash
|
||||
# all.sh PORT BASE_TREE PR_TREE: per whirlpool model (DG11J1-3A, HITACHI_HCRA31NEWH, HISENSE_ARG), build ../base.yaml
|
||||
# plus cl.yaml plus the D1 mini one-pin loopback from the base tree, then the PR tree, flash, run the whirlpool steps and split the frames. Base
|
||||
# runs first per model, so the board ends on a PR build. Compare the hex lines with `grep -a "Sending:\|Received:"`.
|
||||
# env: PY, BUILD_LOCK (optional)
|
||||
W=$(cd "$(dirname "$0")" && pwd); L=$(dirname "$W"); S=$(dirname "$L"); P=${1:?port}
|
||||
export PIO_CORE=${PIO_CORE:-$W/pio}
|
||||
FAILED=()
|
||||
for mm in dg:DG11J1-3A hi:HITACHI_HCRA31NEWH hs:HISENSE_ARG; do
|
||||
m=${mm%%:*}
|
||||
for v in base pr; do
|
||||
if [ $v = base ]; then T=${2:?base tree}; else T=${3:?pr tree}; fi
|
||||
N=w$m$v
|
||||
printf 'substitutions:\n name: %s\n model: %s\npackages:\n common: !include ../base.yaml\n model: !include cl.yaml\n board: !include ../esp8266-ir.yaml\n' \
|
||||
"$N" "${mm#*:}" > "$W/$N.yaml"
|
||||
echo "== $N"
|
||||
# a skipped variant must not leave an older run's outputs behind for the comparison
|
||||
rm -f "$L/$N-ser.txt" "$L/$N-pre.txt" "$L/$N-drive.txt" "$L/$N-frames.json"
|
||||
TREE=$T bash "$S/pio_build.sh" compile "$N" "$W/$N.yaml" || { FAILED+=("$N:compile"); continue; }
|
||||
TREE=$T bash "$S/pio_build.sh" upload "$N" "$W/$N.yaml" "$P" || { FAILED+=("$N:upload"); continue; }
|
||||
RPY=${PY:-$T/venv/bin/python}
|
||||
(cd "$L" && STEP_S=4 PY=$RPY bash run.sh "$N" "$P" "$W/steps.sh" && $RPY frames.py "$N") || FAILED+=("$N:run")
|
||||
done
|
||||
done
|
||||
if [ ${#FAILED[@]} -gt 0 ]; then
|
||||
echo "DONE with ${#FAILED[@]} failed variant(s): ${FAILED[*]}"
|
||||
exit 1
|
||||
fi
|
||||
echo DONE
|
||||
@@ -0,0 +1,3 @@
|
||||
climate:
|
||||
- {platform: whirlpool, id: w_tx, name: W TX, model: "${model}", transmitter_id: irtx}
|
||||
- {platform: whirlpool, id: w_rx, name: W RX, model: "${model}", transmitter_id: irtx, receiver_id: irrx}
|
||||
@@ -0,0 +1,6 @@
|
||||
PRE=("W TX:mode=off,t=24,fan=auto,swing=off")
|
||||
STEPS=()
|
||||
for m in heat_cool heat cool dry fan_only off; do STEPS+=("W TX:mode=${m}"); done
|
||||
STEPS+=("W TX:mode=cool")
|
||||
for f in low medium high auto; do STEPS+=("W TX:fan=${f}"); done
|
||||
STEPS+=("W TX:mode=off")
|
||||
@@ -0,0 +1,102 @@
|
||||
"""quiet_then_subscribe.py HOST PORT OUT QUIET_BOOTS: on the first boot drain any crash record (the first log
|
||||
subscribe replays and clears it), then stay connected without a log subscription for QUIET_BOOTS reboots, then
|
||||
subscribe on the next boot and record the log (including a crash record replayed on subscribe) until a line with
|
||||
REBOOT. The drain connection is dropped and replaced by one without a subscription before boot 1 reboots, so a crash
|
||||
that needs a log subscriber is not recorded as a quiet one; a reboot during the drain, or a reconnect slow enough to
|
||||
hide one, fails the run instead of shifting the boot count. Exits 1 when that line never comes or a quiet boot does
|
||||
not reboot within QUIET_REBOOT_WAIT seconds (default 900). Every lost connection counts as a reboot, so run it on a
|
||||
stable link.
|
||||
env: API_KEY (unset for a plaintext API), QUIET_REBOOT_WAIT."""
|
||||
|
||||
import asyncio
|
||||
import contextlib
|
||||
import os
|
||||
import pathlib
|
||||
import sys
|
||||
import time
|
||||
|
||||
from aioesphomeapi import LogLevel
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
|
||||
from apiconn import connect, log_text, stop_event # noqa: E402
|
||||
|
||||
# how long a quiet boot may run before its reboot; QUIET_REBOOT_WAIT in the env overrides it
|
||||
REBOOT_WAIT = float(os.environ.get("QUIET_REBOOT_WAIT", "900"))
|
||||
# a reconnect slower than this may have waited out a reboot (connect() retries once a second)
|
||||
RECONNECT_MAX_S = 5.0
|
||||
|
||||
|
||||
async def main(host: str, port: int, outf: str, quiet: int) -> None:
|
||||
with pathlib.Path(outf).open("a", encoding="utf-8") as f:
|
||||
|
||||
def w(t: str) -> None:
|
||||
f.write(f"{time.strftime('%H:%M:%S')} {t}\n")
|
||||
f.flush()
|
||||
|
||||
boots = 0
|
||||
while True:
|
||||
lost, on_stop = stop_event()
|
||||
cli = await connect(host, tries=300, timeout=5, port=port, on_stop=on_stop)
|
||||
boots += 1
|
||||
info = await cli.device_info()
|
||||
w(
|
||||
f"=== CONNECTED boot {boots} name={info.name} quiet={1 < boots <= quiet + 1}"
|
||||
)
|
||||
if boots > quiet + 1:
|
||||
done = asyncio.Event()
|
||||
|
||||
def on_log(m, done: asyncio.Event = done) -> None:
|
||||
t = log_text(m)
|
||||
w(t)
|
||||
if "REBOOT" in t:
|
||||
done.set()
|
||||
|
||||
cli.subscribe_logs(
|
||||
on_log, log_level=LogLevel.LOG_LEVEL_DEBUG, dump_config=False
|
||||
)
|
||||
try:
|
||||
await asyncio.wait_for(done.wait(), 120)
|
||||
except TimeoutError:
|
||||
w("=== no REBOOT within 120 s")
|
||||
with contextlib.suppress(Exception):
|
||||
await cli.disconnect()
|
||||
if not done.is_set():
|
||||
sys.exit("FAIL: no REBOOT line within 120 s of subscribing")
|
||||
return
|
||||
if boots == 1:
|
||||
# drain any crash record left by the reboot that brought this build up
|
||||
cli.subscribe_logs(
|
||||
lambda m: w("drain " + log_text(m)),
|
||||
log_level=LogLevel.LOG_LEVEL_DEBUG,
|
||||
dump_config=False,
|
||||
)
|
||||
await asyncio.sleep(3)
|
||||
if lost.is_set():
|
||||
w("=== boot 1 rebooted during the drain")
|
||||
sys.exit("FAIL: boot 1 rebooted with the drain subscriber attached")
|
||||
with contextlib.suppress(Exception):
|
||||
await cli.disconnect()
|
||||
lost, on_stop = stop_event()
|
||||
t = time.monotonic()
|
||||
cli = await connect(
|
||||
host, tries=300, timeout=5, port=port, on_stop=on_stop
|
||||
)
|
||||
if (dt := time.monotonic() - t) > RECONNECT_MAX_S:
|
||||
w(f"=== boot 1 reconnect took {dt:.1f} s")
|
||||
sys.exit(
|
||||
f"FAIL: the reconnect after the drain took {dt:.1f} s, boot 1 may have rebooted"
|
||||
)
|
||||
w("=== boot 1 reconnected without a log subscription")
|
||||
# quiet: wait for the device to drop the connection (its reboot)
|
||||
try:
|
||||
await asyncio.wait_for(lost.wait(), REBOOT_WAIT)
|
||||
except TimeoutError:
|
||||
w(f"=== boot {boots}: no reboot within {REBOOT_WAIT:.0f} s")
|
||||
sys.exit(
|
||||
f"FAIL: boot {boots} did not reboot within {REBOOT_WAIT:.0f} s"
|
||||
)
|
||||
w("=== connection lost")
|
||||
await asyncio.sleep(2)
|
||||
|
||||
|
||||
asyncio.run(main(sys.argv[1], int(sys.argv[2]), sys.argv[3], int(sys.argv[4])))
|
||||
@@ -0,0 +1,20 @@
|
||||
# Shared ESP8266 base for the lock load DUTs: reset reason at boot, no Wi-Fi sleep, web_server for the HTTP load.
|
||||
esphome:
|
||||
name: ${name}
|
||||
on_boot:
|
||||
- priority: 800
|
||||
then:
|
||||
- lambda: ESP_LOGI("lock", "BOOT reason=%s info=%s", ESP.getResetReason().c_str(), ESP.getResetInfo().c_str());
|
||||
esp8266:
|
||||
board: ${board}
|
||||
logger:
|
||||
wifi:
|
||||
ssid: !secret wifi_ssid
|
||||
password: !secret wifi_password
|
||||
power_save_mode: none
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
ota:
|
||||
- platform: esphome
|
||||
web_server:
|
||||
port: 80
|
||||
@@ -0,0 +1,39 @@
|
||||
# remote_transmitter and remote_receiver on the same pin (GPIO12), no jumper: one NEC frame every 250 ms, each one
|
||||
# checked by the receiver's edge interrupt. Substitutions: name, board.
|
||||
substitutions:
|
||||
board: d1_mini
|
||||
packages:
|
||||
base: !include base.yaml
|
||||
globals:
|
||||
- {id: sent, type: uint32_t, initial_value: "0"}
|
||||
- {id: rx_ok, type: uint32_t, initial_value: "0"}
|
||||
- {id: rx_bad, type: uint32_t, initial_value: "0"}
|
||||
remote_transmitter:
|
||||
id: irtx
|
||||
pin:
|
||||
number: GPIO12
|
||||
allow_other_uses: true
|
||||
carrier_duty_percent: 100%
|
||||
remote_receiver:
|
||||
pin:
|
||||
number: GPIO12
|
||||
allow_other_uses: true
|
||||
on_nec:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (x.address == 0x1234 && x.command == (uint16_t) (0x7800 | (id(sent) & 0xFF))) id(rx_ok)++; else id(rx_bad)++;
|
||||
interval:
|
||||
- interval: 250ms
|
||||
then:
|
||||
# The receiver's setup leaves the shared pin as an input; drive it again before each frame
|
||||
- lambda: |-
|
||||
pinMode(12, OUTPUT);
|
||||
id(sent)++;
|
||||
- remote_transmitter.transmit_nec:
|
||||
address: 0x1234
|
||||
command: !lambda return (uint16_t) (0x7800 | (id(sent) & 0xFF));
|
||||
- interval: 10s
|
||||
then:
|
||||
- lambda: |-
|
||||
ESP_LOGI("lock", "ALIVE up=%u sent=%u rx_ok=%u rx_bad=%u heap=%u", (unsigned) (millis() / 1000),
|
||||
(unsigned) id(sent), (unsigned) id(rx_ok), (unsigned) id(rx_bad), (unsigned) ESP.getFreeHeap());
|
||||
@@ -0,0 +1,43 @@
|
||||
# DS18B20 on GPIO4 with a bus search every ${search_interval}. Set busy_control to "true" to replace the search with
|
||||
# the same busy time and no 1-Wire traffic (the control run). Substitutions: name, board, search_interval, busy_control.
|
||||
substitutions:
|
||||
board: d1_mini
|
||||
search_interval: 100ms
|
||||
busy_control: "false"
|
||||
packages:
|
||||
base: !include base.yaml
|
||||
one_wire:
|
||||
- platform: gpio
|
||||
pin: GPIO4
|
||||
id: owbus
|
||||
globals:
|
||||
- {id: searches, type: uint32_t, initial_value: "0"}
|
||||
- {id: search_bad, type: uint32_t, initial_value: "0"}
|
||||
- {id: reads_ok, type: uint32_t, initial_value: "0"}
|
||||
- {id: reads_nan, type: uint32_t, initial_value: "0"}
|
||||
sensor:
|
||||
- platform: dallas_temp
|
||||
one_wire_id: owbus
|
||||
id: t1
|
||||
name: Temp
|
||||
update_interval: 2s
|
||||
on_raw_value:
|
||||
- lambda: if (std::isnan(x)) id(reads_nan)++; else id(reads_ok)++;
|
||||
interval:
|
||||
- interval: ${search_interval}
|
||||
then:
|
||||
- lambda: |-
|
||||
if (${busy_control}) {
|
||||
delayMicroseconds(13000); // about one search with one sensor answering
|
||||
return;
|
||||
}
|
||||
id(owbus)->search();
|
||||
id(searches)++;
|
||||
if (id(owbus)->get_devices().size() != 1)
|
||||
id(search_bad)++;
|
||||
- interval: 10s
|
||||
then:
|
||||
- lambda: |-
|
||||
ESP_LOGI("lock", "ALIVE up=%u ok=%u nan=%u searches=%u search_bad=%u heap=%u t=%.2f",
|
||||
(unsigned) (millis() / 1000), (unsigned) id(reads_ok), (unsigned) id(reads_nan),
|
||||
(unsigned) id(searches), (unsigned) id(search_bad), (unsigned) ESP.getFreeHeap(), id(t1).state);
|
||||
@@ -0,0 +1,47 @@
|
||||
#!/bin/bash
|
||||
# run.sh NAME SECONDS PPS: build NAME.yaml (next to this script, or a path) from TREE, flash it over serial, capture
|
||||
# the log for SECONDS plus 160 (boot, up to 120 s for the IP, the load) and run wifi_load.py at PPS packets per second
|
||||
# (0: no load). Prints the boot count, every reset reason and the last ALIVE line. Exit 0: a clean run (exactly one
|
||||
# BOOT line); 1: the run finished and saw resets; 2: setup failed or the run is invalid (no load, capture cut short,
|
||||
# or the sensor or IR loopback never worked).
|
||||
# env: TREE (checkout under test), PORT, SC (path to serial_capture.py), PY (checkout python)
|
||||
D=$(cd "$(dirname "$0")" && pwd); N=${1:?name}; T=${2:?seconds}; P=${3:?pps}
|
||||
W=${TREE:?set TREE}; PORT=${PORT:?set PORT}; SC=${SC:?set SC}; PY=${PY:-$W/venv/bin/python}
|
||||
Y=$N; [ -f "$Y" ] || Y=$D/$N.yaml; Y=$(cd "$(dirname "$Y")" && pwd)/$(basename "$Y"); N=$(basename "$Y" .yaml)
|
||||
O=$D/out-$N; mkdir -p "$O"
|
||||
pkill -f "[s]erial_capture.py $PORT "
|
||||
rm -f "$O/serial.txt" "$O/load.txt"
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome compile "$Y") > "$O/compile.log" 2>&1 || { echo "$N compile failed"; exit 2; }
|
||||
(cd "$W" && PYTHONPATH=$W $PY -m esphome upload "$Y" --device "$PORT") > "$O/upload.log" 2>&1 || { echo "$N upload failed"; exit 2; }
|
||||
$PY "$SC" "$PORT" $((T + 160)) "$O/serial.txt" --reset > "$O/capture.log" 2>&1 &
|
||||
CAP=$!
|
||||
for _ in $(seq 60); do
|
||||
IP=$(LC_ALL=C grep -a -o -E "IP Address: [0-9.]+" "$O/serial.txt" | tail -1 | cut -d' ' -f3)
|
||||
[ -n "$IP" ] && break; sleep 2
|
||||
done
|
||||
if [ "$P" -gt 0 ]; then
|
||||
[ -n "$IP" ] || { kill "$CAP"; echo "$N no IP (check the secrets file)"; exit 2; }
|
||||
python3 "$D/wifi_load.py" "$IP" "$T" "$P" > "$O/load.txt" 2>&1 || { echo "$N INVALID: load failed (see $O/load.txt)"; BAD=1; }
|
||||
else
|
||||
sleep "$T"
|
||||
fi
|
||||
wait "$CAP" || { echo "$N INVALID: capture failed (see $O/capture.log)"; BAD=1; }
|
||||
BOOTS=$(LC_ALL=C grep -a -c 'BOOT reason' "$O/serial.txt")
|
||||
echo "== $N pps=$P boots=$BOOTS"
|
||||
LC_ALL=C grep -a "BOOT reason" "$O/serial.txt" | cut -c1-150
|
||||
LC_ALL=C grep -a "ALIVE" "$O/serial.txt" | tail -1 | cut -c1-200
|
||||
tail -1 "$O/load.txt" 2>/dev/null
|
||||
ALIVE=$(LC_ALL=C grep -a "ALIVE" "$O/serial.txt" | tail -1)
|
||||
# the workload must have run: a sensor answering searches, or decoded IR frames
|
||||
case "$ALIVE" in
|
||||
*" ok=0 "*|*" rx_ok=0 "*|"") echo "$N INVALID: no ALIVE line or the workload did not run"; BAD=1 ;;
|
||||
esac
|
||||
# one-wire: the searches must find the sensor (busy_control runs no searches)
|
||||
S=$(echo "$ALIVE" | sed -n 's/.* searches=\([0-9]*\) search_bad=\([0-9]*\).*/\1 \2/p')
|
||||
if [ -n "$S" ]; then
|
||||
set -- $S
|
||||
[ "$1" -gt 0 ] && [ "$2" -ge "$1" ] && { echo "$N INVALID: no search found the sensor"; BAD=1; }
|
||||
fi
|
||||
# resets are a failure even when they also broke the load or the workload
|
||||
[ "$BOOTS" -gt 1 ] && exit 1
|
||||
[ -z "$BAD" ] && [ "$BOOTS" = 1 ] || exit 2
|
||||
@@ -0,0 +1,60 @@
|
||||
"""Wi-Fi load on an ESP8266 under test: a fixed rate UDP flood to port 9 plus back to back web_server GETs.
|
||||
|
||||
usage: wifi_load.py HOST SECONDS PPS
|
||||
Prints the counts every minute and a final "done" line.
|
||||
"""
|
||||
|
||||
import socket
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
import urllib.request
|
||||
|
||||
host, secs, pps = sys.argv[1], float(sys.argv[2]), int(sys.argv[3])
|
||||
end = time.monotonic() + secs
|
||||
stats = {"udp": 0, "udp_err": 0, "http_ok": 0, "http_err": 0, "http_gap_s": 0}
|
||||
|
||||
|
||||
last_ok = [time.monotonic()]
|
||||
|
||||
|
||||
def http_load() -> None:
|
||||
while time.monotonic() < end:
|
||||
try:
|
||||
with urllib.request.urlopen(f"http://{host}/", timeout=5) as r:
|
||||
r.read()
|
||||
stats["http_ok"] += 1
|
||||
now = time.monotonic()
|
||||
stats["http_gap_s"] = max(stats["http_gap_s"], round(now - last_ok[0]))
|
||||
last_ok[0] = now
|
||||
except Exception: # noqa: BLE001 any failure counts; the thread must not die
|
||||
stats["http_err"] += 1
|
||||
time.sleep(1)
|
||||
|
||||
|
||||
threading.Thread(target=http_load, daemon=True).start()
|
||||
s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
|
||||
payload = b"x" * 512
|
||||
nxt = last = time.monotonic()
|
||||
while (now := time.monotonic()) < end:
|
||||
try:
|
||||
s.sendto(payload, (host, 9))
|
||||
stats["udp"] += 1
|
||||
except OSError: # mostly ENOBUFS when the host outruns the network
|
||||
stats["udp_err"] += 1
|
||||
time.sleep(0.01)
|
||||
nxt += 1 / pps
|
||||
if (d := nxt - time.monotonic()) > 0:
|
||||
time.sleep(d)
|
||||
if now - last > 60:
|
||||
last = now
|
||||
print(time.strftime("%H:%M:%S"), stats, flush=True)
|
||||
stats["http_gap_s"] = max(stats["http_gap_s"], round(time.monotonic() - last_ok[0]))
|
||||
print("done", stats, flush=True)
|
||||
if (
|
||||
stats["http_ok"] == 0
|
||||
or stats["http_gap_s"] > 60 # the device stopped answering for over a minute
|
||||
or stats["http_err"] > stats["http_ok"]
|
||||
or stats["udp"] < secs * pps / 2
|
||||
):
|
||||
sys.exit("the load did not reach the device; the run is invalid")
|
||||
@@ -0,0 +1,62 @@
|
||||
"""cmp.py REF.json OTHER.json : list each UUID (service / characteristic / descriptor, in order) where OTHER differs
|
||||
from REF, whether reads match (static characteristics), whether every notifying characteristic notified and
|
||||
whether OTHER lost its link before the final disconnect. Exits 1 on any difference."""
|
||||
|
||||
import json
|
||||
import pathlib
|
||||
import sys
|
||||
|
||||
|
||||
def flat(p):
|
||||
d = json.loads(pathlib.Path(p).read_text(encoding="utf-8"))
|
||||
rows = []
|
||||
for s in d["services"]:
|
||||
rows.append(("svc", s["uuid"].lower()))
|
||||
for c in s["characteristics"]:
|
||||
rows.append(("chr", c["uuid"].lower()))
|
||||
rows += [("dsc", x.lower()) for x in c["descriptors"]]
|
||||
return d, rows
|
||||
|
||||
|
||||
rd, ref = flat(sys.argv[1])
|
||||
od, oth = flat(sys.argv[2])
|
||||
diff = [(a, b) for a, b in zip(ref, oth, strict=False) if a != b]
|
||||
print(
|
||||
f"entries ref={len(ref)} other={len(oth)} differing={len(diff) + abs(len(ref) - len(oth))}"
|
||||
)
|
||||
for a, b in diff:
|
||||
print(f" {a[0]} ref {a[1]} other {b[1]}")
|
||||
|
||||
|
||||
def chars(d: dict) -> list[dict]:
|
||||
return [c for s in d["services"] for c in s["characteristics"]]
|
||||
|
||||
|
||||
# compare by position: a UUID form bug renames the keys, so values and notify counts are matched by table order
|
||||
problems = []
|
||||
rc, oc = chars(rd), chars(od)
|
||||
for i, (a, b) in enumerate(zip(rc, oc, strict=False)):
|
||||
if a["props"] != b["props"]:
|
||||
problems.append(
|
||||
f"props {i} {b['uuid']} 0x{b['props']:02X} != ref 0x{a['props']:02X}"
|
||||
)
|
||||
rv, ov = rd["reads"].get(a["uuid"]), od["reads"].get(b["uuid"])
|
||||
if str(ov).startswith("FAILED"):
|
||||
problems.append(f"read {i} {b['uuid']} {ov}")
|
||||
elif not a["props"] & 0x10 and rv is not None and ov != rv:
|
||||
problems.append(f"read {i} {b['uuid']} {ov!r} != ref {rv!r}")
|
||||
if a["props"] & 0x10:
|
||||
n = od["notify"].get(b["uuid"])
|
||||
if not isinstance(n, int) or n <= 0:
|
||||
problems.append(f"notify {i} {b['uuid']} {n}")
|
||||
# a link that dropped after the first notification still has counts, so the drop itself fails the run
|
||||
if od.get("lost"):
|
||||
problems.append(f"link lost before the disconnect: {od['lost']}")
|
||||
print(f"notify {od['notify']}")
|
||||
for x in problems:
|
||||
print(" ", x)
|
||||
if diff or len(ref) != len(oth) or problems:
|
||||
sys.exit(
|
||||
f"FAIL: {len(diff)} differing entries, {len(problems)} read or notify problems"
|
||||
)
|
||||
print("PASS")
|
||||
@@ -0,0 +1,100 @@
|
||||
"""List every service, characteristic and descriptor UUID a bluetooth_proxy reports for a peer, read each readable
|
||||
characteristic, enable notify (CCCD write) on each notifying one and count 10 s of notifications, then disconnect.
|
||||
A link lost before that disconnect is recorded as "lost" in the JSON, which cmp.py fails on.
|
||||
usage: gattlist.py PROXY PEER_MAC OUT_JSON env: API_KEY (unset for a plaintext API). Retries 0x3E connect failures."""
|
||||
|
||||
import asyncio
|
||||
import json
|
||||
import pathlib
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
|
||||
from apiconn import ble_connect, connect, enable_notify # noqa: E402
|
||||
|
||||
|
||||
async def once(host: str, addr: int) -> dict | None:
|
||||
cli = await connect(host)
|
||||
lost: list[int] = []
|
||||
closing = False
|
||||
|
||||
def on_lost(e: int) -> None:
|
||||
if not closing:
|
||||
lost.append(e)
|
||||
print(f"LINK LOST err={e}", flush=True)
|
||||
|
||||
c, _mtu, err, cancel = await ble_connect(cli, addr, on_lost)
|
||||
if not c:
|
||||
print(f"connect err={err}", flush=True)
|
||||
cancel()
|
||||
await cli.disconnect()
|
||||
return None
|
||||
svcs = await cli.bluetooth_gatt_get_services(addr)
|
||||
out = {"services": [], "reads": {}, "notify": {}}
|
||||
notif: dict[str, int] = {}
|
||||
for s in svcs.services:
|
||||
so = {"uuid": s.uuid, "characteristics": []}
|
||||
for ch in s.characteristics:
|
||||
so["characteristics"].append(
|
||||
{
|
||||
"uuid": ch.uuid,
|
||||
"props": ch.properties,
|
||||
"descriptors": [d.uuid for d in ch.descriptors],
|
||||
}
|
||||
)
|
||||
if ch.properties & 0x02:
|
||||
try:
|
||||
out["reads"][ch.uuid] = bytes(
|
||||
await cli.bluetooth_gatt_read(addr, ch.handle)
|
||||
).hex()
|
||||
except Exception as e: # noqa: BLE001
|
||||
out["reads"][ch.uuid] = f"FAILED {type(e).__name__}"
|
||||
if ch.properties & 0x10:
|
||||
notif[ch.uuid] = 0
|
||||
try:
|
||||
if not await enable_notify(
|
||||
cli,
|
||||
addr,
|
||||
ch,
|
||||
lambda h, d, u=ch.uuid: (
|
||||
notif.__setitem__(u, notif[u] + 1)
|
||||
if isinstance(notif[u], int)
|
||||
else None
|
||||
),
|
||||
):
|
||||
notif[ch.uuid] = "FAILED no CCCD"
|
||||
except Exception as e: # noqa: BLE001
|
||||
notif[ch.uuid] = f"FAILED {type(e).__name__}"
|
||||
out["services"].append(so)
|
||||
await asyncio.sleep(10)
|
||||
out["notify"] = notif
|
||||
out["lost"] = lost
|
||||
closing = True
|
||||
await cli.bluetooth_device_disconnect(addr)
|
||||
await asyncio.sleep(2)
|
||||
cancel()
|
||||
await cli.disconnect()
|
||||
return out
|
||||
|
||||
|
||||
async def main(host: str, peer: str, path: str) -> None:
|
||||
addr = int(peer.replace(":", ""), 16)
|
||||
for _attempt in range(6):
|
||||
res = await once(host, addr)
|
||||
if res:
|
||||
break
|
||||
await asyncio.sleep(10)
|
||||
else:
|
||||
sys.exit("FAIL: no connection")
|
||||
pathlib.Path(path).write_text(json.dumps(res, indent=1), encoding="utf-8")
|
||||
for s in res["services"]:
|
||||
print(f"SVC {s['uuid']}")
|
||||
for c in s["characteristics"]:
|
||||
print(
|
||||
f" CHR {c['uuid']} props=0x{c['props']:02X} read={res['reads'].get(c['uuid'], '-')}"
|
||||
f" notify={res['notify'].get(c['uuid'], '-')}"
|
||||
)
|
||||
for d in c["descriptors"]:
|
||||
print(f" DSC {d}")
|
||||
|
||||
|
||||
asyncio.run(main(sys.argv[1], sys.argv[2], sys.argv[3]))
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
#!/bin/zsh
|
||||
# run.sh NAME: build ../rp2_web_ble/picow.yaml as NAME, USB flash the Pico W proxy, list the GATT UUID server
|
||||
# (server.yaml here) through it and compare with the ESP32 reference. Exit 0 only when the lists match.
|
||||
# env: TREE, PY, PICO_SN, PEER_MAC (the server); esp32ref.json (gattlist.py through an ESP32 proxy) and apikey.txt here
|
||||
D=${0:A:h}; N=$1; S=$D/..; T=${TREE:?set TREE}; PY=${PY:-$T/venv/bin/python}; C=$S/rp2_web_ble/picow.yaml
|
||||
$S/pio_build.sh compile $N $C || exit 1
|
||||
PORT=$($PY $S/ports.py --wait 2e8a --serial ${PICO_SN:?set PICO_SN} --timeout 30) || { echo "no pico"; exit 1; }
|
||||
$S/pio_build.sh upload $N $C $PORT || exit 1
|
||||
H=$($S/resolve.sh $N) || exit 1; sleep 5
|
||||
rm -f $D/$N.json
|
||||
API_KEY=$(cat $D/apikey.txt) timeout 600 $PY -I $D/gattlist.py $H ${PEER_MAC:?set PEER_MAC} $D/$N.json > $D/$N-list.txt
|
||||
RC=$?; grep -v "^ *CHR 00002a\|DSC 00002902\|SVC 000018" $D/$N-list.txt
|
||||
[ $RC = 0 ] && [ -s $D/$N.json ] || { echo "FAIL: gattlist.py exited $RC"; exit 1; }
|
||||
$PY $D/cmp.py $D/esp32ref.json $D/$N.json
|
||||
@@ -0,0 +1,27 @@
|
||||
# GATT server (ESP32-S3) for the UUID form check: the ble_notify server (16 bit and 32-bit base UUIDs, notify) plus a
|
||||
# 128 bit service whose characteristics and descriptors use 128 bit, 32-bit base (zero and nonzero low half) and
|
||||
# 16 bit UUIDs, with a 2901 user description. Set the name with -s name.
|
||||
packages:
|
||||
notify: !include ../ble_notify/server.yaml
|
||||
esp32_ble_server:
|
||||
services:
|
||||
- uuid: 0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0
|
||||
characteristics:
|
||||
- uuid: 0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f1
|
||||
read: true
|
||||
value: "c128"
|
||||
description: "text value"
|
||||
descriptors:
|
||||
- uuid: 5ec1ab01-0000-1000-8000-00805f9b34fb
|
||||
value: "d32"
|
||||
- uuid: 7d3e0a51-9c1b-4f2e-8a6d-1c2b3a4d5e6f
|
||||
value: "d128"
|
||||
- uuid: 5ec20000-0000-1000-8000-00805f9b34fb
|
||||
read: true
|
||||
value: "c32zero"
|
||||
- uuid: 5ec2abcd-0000-1000-8000-00805f9b34fb
|
||||
read: true
|
||||
value: "c32"
|
||||
- uuid: 2a19
|
||||
read: true
|
||||
value: [77]
|
||||
@@ -0,0 +1,79 @@
|
||||
#pragma once
|
||||
#include <atomic>
|
||||
#include <cstdint>
|
||||
#include <cstdlib>
|
||||
#include <new>
|
||||
#ifdef __XTENSA__
|
||||
#include "esp_cpu_utils.h"
|
||||
#include "esp_debug_helpers.h"
|
||||
#endif
|
||||
#include "esp_timer.h"
|
||||
// Counts every global operator new and, once armed, keeps the first ALLOC_CAP of them with five caller PCs
|
||||
// (callers on Xtensa only; RISC-V entries keep size and time). Aligned operator new is not counted.
|
||||
// See reference/recipes/heap_alloc.md.
|
||||
struct AllocEntry {
|
||||
uint32_t ms;
|
||||
uint32_t size; // ALLOC_MARKER for a marker: pc[0] and pc[1] then hold its two values
|
||||
uint32_t pc[5];
|
||||
};
|
||||
static constexpr uint32_t ALLOC_CAP = 1024;
|
||||
static constexpr uint32_t ALLOC_MARKER = UINT32_MAX;
|
||||
AllocEntry g_allocs[ALLOC_CAP];
|
||||
std::atomic<uint32_t> g_alloc_n{0};
|
||||
std::atomic<uint32_t> g_new_count{0};
|
||||
// seq_cst with g_alloc_busy: the dump stores false then loads busy, a recorder adds busy then loads this
|
||||
std::atomic<bool> g_alloc_armed{false};
|
||||
uint32_t g_alloc_armed_ms = 0; // when recording started, 0 if it never did
|
||||
// Recorders between claiming a slot and filling it; the dump waits for 0 after disarming.
|
||||
std::atomic<uint32_t> g_alloc_busy{0};
|
||||
|
||||
// Claims the next slot, or returns nullptr and disarms once the buffer is full.
|
||||
static inline AllocEntry *alloc_claim(uint32_t size) {
|
||||
uint32_t i = g_alloc_n.fetch_add(1);
|
||||
if (i >= ALLOC_CAP) {
|
||||
g_alloc_armed = false;
|
||||
return nullptr;
|
||||
}
|
||||
AllocEntry &e = g_allocs[i];
|
||||
e.ms = (uint32_t) (esp_timer_get_time() / 1000);
|
||||
e.size = size;
|
||||
return &e;
|
||||
}
|
||||
|
||||
void *operator new(size_t size) {
|
||||
g_new_count.fetch_add(1, std::memory_order_relaxed);
|
||||
g_alloc_busy.fetch_add(1); // before the armed check, so a dump that disarmed first sees it
|
||||
AllocEntry *e = g_alloc_armed ? alloc_claim(size) : nullptr;
|
||||
if (e != nullptr) {
|
||||
e->pc[0] = e->pc[1] = e->pc[2] = e->pc[3] = e->pc[4] = 0;
|
||||
#ifdef __XTENSA__
|
||||
esp_backtrace_frame_t f;
|
||||
esp_backtrace_get_start(&f.pc, &f.sp, &f.next_pc);
|
||||
// The start frame is this function; record the five callers above it.
|
||||
// Stop at the first frame that does not unwind; the slots after it stay 0.
|
||||
for (int k = 0; k < 5 && f.next_pc != 0 && esp_backtrace_get_next_frame(&f); k++)
|
||||
e->pc[k] = esp_cpu_process_stack_pc(f.pc);
|
||||
#endif
|
||||
}
|
||||
g_alloc_busy.fetch_sub(1);
|
||||
void *p = malloc(size ? size : 1);
|
||||
if (p == nullptr)
|
||||
abort();
|
||||
return p;
|
||||
}
|
||||
void *operator new[](size_t size) { return operator new(size); }
|
||||
void operator delete(void *p) noexcept { free(p); }
|
||||
void operator delete[](void *p) noexcept { free(p); }
|
||||
void operator delete(void *p, size_t) noexcept { free(p); }
|
||||
void operator delete[](void *p, size_t) noexcept { free(p); }
|
||||
|
||||
// Splits the dump into phases, for example on each change of an entity's state.
|
||||
static inline void alloc_marker(uint32_t a, uint32_t b) {
|
||||
g_alloc_busy.fetch_add(1);
|
||||
if (AllocEntry *e = g_alloc_armed ? alloc_claim(ALLOC_MARKER) : nullptr) {
|
||||
e->pc[0] = a;
|
||||
e->pc[1] = b;
|
||||
e->pc[2] = e->pc[3] = e->pc[4] = 0;
|
||||
}
|
||||
g_alloc_busy.fetch_sub(1);
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
# Package for allocring.hpp: arms it ${alloc_arm_s} s after boot, reports that on a binary sensor and adds the
|
||||
# dump button. See heap_alloc.md.
|
||||
esphome:
|
||||
includes:
|
||||
- allocring.hpp
|
||||
on_boot:
|
||||
then:
|
||||
- delay: ${alloc_arm_s}s
|
||||
- lambda: |-
|
||||
g_alloc_armed_ms = millis();
|
||||
g_alloc_armed = true;
|
||||
ESP_LOGI("allocs", "ARMED total=%u", g_new_count.load());
|
||||
|
||||
binary_sensor:
|
||||
# Drivers wait for this before the first action, so no step runs before recording starts
|
||||
- platform: template
|
||||
name: Allocation recorder armed
|
||||
lambda: return g_alloc_armed.load();
|
||||
|
||||
interval:
|
||||
- interval: 30s
|
||||
then:
|
||||
- lambda: |-
|
||||
ESP_LOGI("allocs", "total=%u kept=%u heap=%u", g_new_count.load(), (unsigned) g_alloc_n.load(),
|
||||
(unsigned) heap_caps_get_free_size(MALLOC_CAP_INTERNAL));
|
||||
|
||||
button:
|
||||
- platform: template
|
||||
name: Dump allocations
|
||||
on_press:
|
||||
# Recording stops for good; reboot before the next run, or a second press returns the same entries.
|
||||
- lambda: |-
|
||||
g_alloc_armed = false;
|
||||
// let recorders on other tasks finish the entry they claimed
|
||||
for (int w = 0; w < 100 && g_alloc_busy.load() != 0; w++)
|
||||
delay(1);
|
||||
uint32_t claimed = g_alloc_n.load();
|
||||
uint32_t n = std::min<uint32_t>(claimed, ALLOC_CAP);
|
||||
// claimed > n means the buffer filled and recording stopped early
|
||||
// armed_ms=0: the recorder never ran; busy>0: an entry may still be half written;
|
||||
// buf is the buffer's address, which decode.py matches against the ELF
|
||||
ESP_LOGI("allocs", "DUMP n=%u claimed=%u total=%u armed_ms=%u busy=%u buf=%08x", n, claimed,
|
||||
g_new_count.load(), g_alloc_armed_ms, g_alloc_busy.load(), (unsigned) (uintptr_t) g_allocs);
|
||||
for (uint32_t i = 0; i < n; i++) {
|
||||
const AllocEntry &e = g_allocs[i];
|
||||
ESP_LOGI("allocs", "E %u %u %u %08x %08x %08x %08x %08x", i, e.ms, e.size, e.pc[0], e.pc[1], e.pc[2],
|
||||
e.pc[3], e.pc[4]);
|
||||
if ((i & 15) == 15) {
|
||||
delay(20); // let the log drain
|
||||
App.feed_wdt(); // a full dump over a 115200 baud UART log outlasts the task watchdog
|
||||
}
|
||||
}
|
||||
ESP_LOGI("allocs", "DUMP END");
|
||||
@@ -0,0 +1,108 @@
|
||||
"""Move the device's first cover to the far end and back N times with a states-only client, then save the dump.
|
||||
|
||||
usage: cycles_cover.py HOST CYCLES OUT env: API_KEY (unset for a plaintext API)
|
||||
Waits for the recorder's armed binary sensor first. Exits 2 when a move did not reach its position (the
|
||||
cover never moved, so the dump proves nothing).
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
import pathlib
|
||||
import sys
|
||||
import time
|
||||
|
||||
from aioesphomeapi import (
|
||||
BinarySensorInfo,
|
||||
BinarySensorState,
|
||||
CoverInfo,
|
||||
CoverOperation,
|
||||
CoverState,
|
||||
)
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
|
||||
from apiconn import connect # noqa: E402
|
||||
from heap_alloc.dump import dump # noqa: E402
|
||||
|
||||
# After each move, so allocations that come once the cover has stopped land in the same cycle
|
||||
SETTLE_S = 8
|
||||
ARM_WAIT_S = 600
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
host, cycles, out = sys.argv[1], int(sys.argv[2]), sys.argv[3]
|
||||
with pathlib.Path(out).open("w", encoding="utf-8") as f:
|
||||
|
||||
def w(s: str) -> None:
|
||||
f.write(time.strftime("%H:%M:%S ") + s + "\n")
|
||||
f.flush()
|
||||
|
||||
c = await connect(host)
|
||||
ents, _ = await c.list_entities_services()
|
||||
cover = next(e for e in ents if isinstance(e, CoverInfo))
|
||||
armed_info = next(
|
||||
e
|
||||
for e in ents
|
||||
if isinstance(e, BinarySensorInfo)
|
||||
and e.object_id == "allocation_recorder_armed"
|
||||
)
|
||||
states: asyncio.Queue = asyncio.Queue()
|
||||
armed = asyncio.Event()
|
||||
|
||||
def on_state(s) -> None:
|
||||
if isinstance(s, CoverState) and s.key == cover.key:
|
||||
states.put_nowait(s)
|
||||
elif (
|
||||
isinstance(s, BinarySensorState) and s.key == armed_info.key and s.state
|
||||
):
|
||||
armed.set()
|
||||
|
||||
c.subscribe_states(on_state)
|
||||
latest = await asyncio.wait_for(states.get(), 10)
|
||||
# moves made before recording starts would be missing from the dump
|
||||
await asyncio.wait_for(armed.wait(), ARM_WAIT_S)
|
||||
w("ARMED")
|
||||
|
||||
def drain() -> CoverState:
|
||||
"""The newest queued state, so no stale one is read as this command's result."""
|
||||
nonlocal latest
|
||||
while not states.empty():
|
||||
latest = states.get_nowait()
|
||||
return latest
|
||||
|
||||
async def move(pos: float) -> bool:
|
||||
drain()
|
||||
w(f"CMD {pos}")
|
||||
c.cover_command(cover.key, position=pos)
|
||||
moved = False
|
||||
deadline = time.monotonic() + 60
|
||||
while (left := deadline - time.monotonic()) > 0:
|
||||
try:
|
||||
s = await asyncio.wait_for(states.get(), left)
|
||||
except TimeoutError:
|
||||
break
|
||||
idle = s.current_operation == CoverOperation.IDLE
|
||||
moved |= not idle
|
||||
if moved and idle and abs(s.position - pos) < 0.01:
|
||||
w(f"IDLE pos={s.position:.3f}")
|
||||
return True
|
||||
w("TIMEOUT")
|
||||
return False
|
||||
|
||||
timeouts = 0
|
||||
# start toward the far end, so the first command always moves the cover
|
||||
order = (0.0, 1.0) if drain().position > 0.5 else (1.0, 0.0)
|
||||
for i in range(cycles):
|
||||
w(f"CYCLE {i + 1}")
|
||||
for pos in order:
|
||||
timeouts += not await move(pos)
|
||||
await asyncio.sleep(SETTLE_S)
|
||||
if timeouts:
|
||||
# before the dump, which exits on its own failure
|
||||
print(f"{timeouts} moves timed out", file=sys.stderr)
|
||||
await dump(c, w)
|
||||
await c.disconnect()
|
||||
if timeouts:
|
||||
sys.exit(2)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,159 @@
|
||||
"""Decode an allocring dump into callers: decode.py LOG ELF [ADDR2LINE]
|
||||
|
||||
Prints each entry with its caller frames as function and file:line, and markers (size 0xFFFFFFFF, ALLOC_MARKER) as phase
|
||||
separators.
|
||||
ADDR2LINE defaults to an Xtensa one found in ESPHome's ESP-IDF tools cache, ~/.platformio or ~/.espressif.
|
||||
Exits 2 when the dump is incomplete (missing header or entries, or the buffer filled during the run).
|
||||
"""
|
||||
|
||||
from pathlib import Path
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
ENTRY = re.compile(r"\bE (\d+) (\d+) (\d+) ((?:[0-9a-f]{8} ?){5})")
|
||||
HEADER = re.compile(
|
||||
r"\bDUMP n=(\d+) claimed=(\d+) total=\d+ armed_ms=(\d+) busy=(\d+) buf=([0-9a-f]{8})"
|
||||
)
|
||||
MARKER = 0xFFFFFFFF
|
||||
XTENSA = 94 # ELF e_machine; the recorder walks frames only on Xtensa
|
||||
|
||||
|
||||
def tool_roots() -> list[Path]:
|
||||
roots = [Path.home() / ".platformio", Path.home() / ".espressif"]
|
||||
try:
|
||||
from esphome.espidf.framework import get_idf_tools_path
|
||||
except ImportError:
|
||||
return roots
|
||||
return [get_idf_tools_path(), *roots]
|
||||
|
||||
|
||||
def is_xtensa(elf: str) -> bool:
|
||||
return int.from_bytes(Path(elf).read_bytes()[18:20], "little") == XTENSA
|
||||
|
||||
|
||||
def find_addr2line() -> str:
|
||||
for root in tool_roots():
|
||||
for path in root.glob("**/bin/xtensa-esp*-elf-addr2line"):
|
||||
if path.is_file():
|
||||
return str(path)
|
||||
sys.exit("no addr2line found; pass it as the third argument")
|
||||
|
||||
|
||||
def short(path: str) -> str:
|
||||
for marker in ("esphome/components/", "esphome/core/", "esp-idf/", "include/c++/"):
|
||||
if marker in path:
|
||||
return marker + path.split(marker, 1)[1]
|
||||
return path
|
||||
|
||||
|
||||
def decode(
|
||||
addr2line: str, elf: str, pcs: list[str]
|
||||
) -> dict[str, list[tuple[str, str]]]:
|
||||
"""Every PC's frames (inlined ones too); -a prints each address before its frames."""
|
||||
out = subprocess.run(
|
||||
[addr2line, "-afiC", "-e", elf, *(f"0x{pc}" for pc in pcs)],
|
||||
capture_output=True,
|
||||
text=True,
|
||||
check=True,
|
||||
).stdout.splitlines()
|
||||
names: dict[str, list[tuple[str, str]]] = {}
|
||||
frames: list[tuple[str, str]] = []
|
||||
i = 0
|
||||
while i < len(out):
|
||||
if out[i].startswith("0x"):
|
||||
frames = names.setdefault(f"{int(out[i], 16):08x}", [])
|
||||
i += 1
|
||||
else:
|
||||
frames.append((out[i], short(out[i + 1])))
|
||||
i += 2
|
||||
return names
|
||||
|
||||
|
||||
def last_dump(text: str) -> str:
|
||||
"""The newest dump in the file (a retried press or an appended file holds several); check() rejects it if cut off."""
|
||||
start = max((m.start() for m in HEADER.finditer(text)), default=len(text))
|
||||
return text[start:]
|
||||
|
||||
|
||||
def check(dump: str, entries: list, xtensa: bool) -> list[str]:
|
||||
"""Reasons the dump is incomplete, empty when it is whole."""
|
||||
if not (header := HEADER.search(dump)):
|
||||
return ["no DUMP header (log subscription started late?)"]
|
||||
n, claimed, armed_ms, busy = (int(header[i]) for i in range(1, 5))
|
||||
problems = []
|
||||
if not armed_ms:
|
||||
problems.append("the recorder was never armed (pressed before alloc_arm_s?)")
|
||||
if busy:
|
||||
problems.append(f"{busy} recorders were still writing an entry")
|
||||
indexes = [int(e[0]) for e in entries]
|
||||
if missing := sorted(set(range(n)) - set(indexes)):
|
||||
problems.append(f"{len(missing)} of {n} entries missing, first {missing[:10]}")
|
||||
if len(indexes) != len(set(indexes)):
|
||||
problems.append("duplicate entries")
|
||||
if stray := sorted(i for i in set(indexes) if i >= n):
|
||||
problems.append(f"entries past n={n}: {stray[:10]}")
|
||||
allocs = [pcs for _, _, size, pcs in entries if size != MARKER]
|
||||
if xtensa and allocs and all(pcs[0] == "00000000" for pcs in allocs):
|
||||
problems.append("no entry has a caller (frame walk failed?)")
|
||||
if claimed > n:
|
||||
problems.append(f"buffer filled: recording stopped after {n} entries")
|
||||
if "DUMP END" not in dump:
|
||||
problems.append("no DUMP END")
|
||||
return problems
|
||||
|
||||
|
||||
def main() -> None:
|
||||
log, elf = sys.argv[1], sys.argv[2]
|
||||
text = last_dump(Path(log).read_text(encoding="utf-8", errors="replace"))
|
||||
entries = [
|
||||
(idx, int(ms), int(size), pcs.split())
|
||||
for idx, ms, size, pcs in ENTRY.findall(text)
|
||||
]
|
||||
wanted = {
|
||||
pc
|
||||
for _, _, size, pcs in entries
|
||||
if size != MARKER
|
||||
for pc in pcs
|
||||
if pc != "00000000"
|
||||
}
|
||||
# Only Xtensa dumps carry callers; RISC-V ones still print sizes and times
|
||||
names = {}
|
||||
if wanted:
|
||||
addr2line = sys.argv[3] if len(sys.argv) > 3 else find_addr2line()
|
||||
names = decode(addr2line, elf, sorted(wanted))
|
||||
for idx, ms, size, pcs in entries:
|
||||
if size == MARKER:
|
||||
print(
|
||||
f"--- marker at {ms / 1000:.3f} s: {int(pcs[0], 16)} {int(pcs[1], 16)}"
|
||||
)
|
||||
continue
|
||||
print(f"#{idx} {ms / 1000:.3f} s {size} B")
|
||||
for pc in pcs:
|
||||
if pc == "00000000":
|
||||
break
|
||||
for func, loc in names[pc]:
|
||||
print(f" {func[:110]} {loc}")
|
||||
problems = check(text, entries, is_xtensa(elf))
|
||||
# addr2line names any address, so check the ELF is the build that made the dump
|
||||
if wanted and (header := HEADER.search(text)):
|
||||
nm = addr2line[: -len("addr2line")] + "nm"
|
||||
if not Path(nm).is_file():
|
||||
problems.append(f"cannot check the ELF: no {nm} next to addr2line")
|
||||
elif not re.search(
|
||||
rf"^0*{int(header[5], 16):x} [bBdD] g_allocs$",
|
||||
subprocess.run(
|
||||
[nm, elf], capture_output=True, text=True, check=True
|
||||
).stdout,
|
||||
re.MULTILINE,
|
||||
):
|
||||
problems.append(
|
||||
"the ELF is not the build that made this dump (g_allocs address differs)"
|
||||
)
|
||||
if problems:
|
||||
print("INCOMPLETE DUMP: " + "; ".join(problems), file=sys.stderr)
|
||||
sys.exit(2)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -0,0 +1,84 @@
|
||||
"""Press the "Dump allocations" button from allocring.yaml and save the dump.
|
||||
|
||||
usage: dump.py HOST OUT env: API_KEY (unset for a plaintext API)
|
||||
"""
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable
|
||||
import contextlib
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
from aioesphomeapi import APIClient, ButtonInfo
|
||||
from aioesphomeapi.model import LogLevel
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1]))
|
||||
from apiconn import connect, log_text # noqa: E402
|
||||
|
||||
HEADER = re.compile(r"\bDUMP n=(\d+) claimed=\d+ total=\d+ armed_ms=(\d+) busy=(\d+)")
|
||||
ENTRY = re.compile(r"\bE (\d+) \d+ \d+ ")
|
||||
|
||||
|
||||
async def dump(c: APIClient, write: Callable[[str], None], tries: int = 3) -> None:
|
||||
"""Subscribe to logs, press the dump button and pass every line to WRITE until DUMP END.
|
||||
|
||||
subscribe_logs does not confirm the subscription and the device drops log lines when busy, so the press is
|
||||
repeated (the dump is repeatable) until the header and all n entries arrived; exits 2 after TRIES presses.
|
||||
"""
|
||||
ents, _ = await c.list_entities_services()
|
||||
button = next(
|
||||
e
|
||||
for e in ents
|
||||
if isinstance(e, ButtonInfo) and e.object_id == "dump_allocations"
|
||||
)
|
||||
seen: dict = {"n": None, "idx": set()}
|
||||
done = asyncio.Event()
|
||||
|
||||
def on_log(msg) -> None:
|
||||
text = log_text(msg)
|
||||
write(text)
|
||||
if m := HEADER.search(text):
|
||||
seen["n"], seen["idx"] = int(m[1]), set()
|
||||
seen["armed"], seen["busy"] = int(m[2]) != 0, int(m[3])
|
||||
elif m := ENTRY.search(text):
|
||||
seen["idx"].add(int(m[1]))
|
||||
elif "DUMP END" in text and seen["n"] is not None:
|
||||
# without this press's header it is a late end from an earlier press
|
||||
done.set()
|
||||
|
||||
c.subscribe_logs(on_log, log_level=LogLevel.LOG_LEVEL_INFO)
|
||||
for _ in range(tries):
|
||||
await asyncio.sleep(2)
|
||||
seen["n"] = None
|
||||
done.clear()
|
||||
c.button_command(button.key)
|
||||
with contextlib.suppress(TimeoutError):
|
||||
await asyncio.wait_for(done.wait(), 120)
|
||||
# the device drops log lines when its send buffer is full, so require every entry
|
||||
if done.is_set() and seen["n"] is not None and not seen["armed"]:
|
||||
print(
|
||||
"the recorder was never armed (pressed before alloc_arm_s?)",
|
||||
file=sys.stderr,
|
||||
)
|
||||
sys.exit(2)
|
||||
if (
|
||||
done.is_set()
|
||||
and seen["n"] is not None
|
||||
and not seen["busy"]
|
||||
and seen["idx"] == set(range(seen["n"]))
|
||||
):
|
||||
return
|
||||
print(f"no whole dump after {tries} presses", file=sys.stderr)
|
||||
sys.exit(2)
|
||||
|
||||
|
||||
async def main() -> None:
|
||||
c = await connect(sys.argv[1])
|
||||
with pathlib.Path(sys.argv[2]).open("w", encoding="utf-8") as f:
|
||||
await dump(c, lambda s: f.write(s + "\n"))
|
||||
await c.disconnect()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
asyncio.run(main())
|
||||
@@ -0,0 +1,51 @@
|
||||
"""Press the device's buttons through Home Assistant and print the script and flag states after each step.
|
||||
|
||||
usage: drive.py TOKENFILE NAME env: HA_URL (default http://127.0.0.1:8129)
|
||||
NAME is the device name from hsw.yaml (button entity ids are button.<NAME>_long_on and so on).
|
||||
"""
|
||||
|
||||
import pathlib
|
||||
import sys
|
||||
import time
|
||||
|
||||
sys.path.insert(
|
||||
0, str(pathlib.Path(__file__).resolve().parent.parent / "mqtt" / "ha_discovery")
|
||||
)
|
||||
from ha_rest import req_or_exit # noqa: E402
|
||||
|
||||
tok = pathlib.Path(sys.argv[1]).read_text(encoding="utf-8").strip()
|
||||
name = sys.argv[2].replace("-", "_") # entity ids use underscores
|
||||
t0 = time.monotonic()
|
||||
|
||||
|
||||
def state(entity: str) -> str:
|
||||
return req_or_exit(f"/api/states/{entity}", token=tok)["state"]
|
||||
|
||||
|
||||
def show(tag: str) -> None:
|
||||
print(
|
||||
f"{time.monotonic() - t0:6.1f}s {tag:30s} long_job={state('script.long_job'):4s}"
|
||||
f" quick_job={state('script.quick_job'):4s} flag={state('input_boolean.script_ran')}",
|
||||
flush=True,
|
||||
)
|
||||
|
||||
|
||||
def call(domain: str, action: str, entity: str, wait: float = 3) -> None:
|
||||
req_or_exit(f"/api/services/{domain}/{action}", {"entity_id": entity}, token=tok)
|
||||
time.sleep(wait)
|
||||
|
||||
|
||||
show("start")
|
||||
call("button", "press", f"button.{name}_long_on")
|
||||
show("device Long on")
|
||||
call("button", "press", f"button.{name}_long_off")
|
||||
show("device Long off")
|
||||
call("input_boolean", "turn_off", "input_boolean.script_ran", 1)
|
||||
call("button", "press", f"button.{name}_long_on")
|
||||
show("device Long on again")
|
||||
time.sleep(20)
|
||||
show("script finished on its own")
|
||||
call("button", "press", f"button.{name}_quick_on")
|
||||
show("device Quick on")
|
||||
call("script", "turn_on", "script.long_job")
|
||||
show("HA starts the script")
|
||||
+33
@@ -0,0 +1,33 @@
|
||||
# Throwaway Home Assistant on port 8129: a 20 s script that sets and clears a flag, and a toggle script.
|
||||
http:
|
||||
server_port: 8129
|
||||
api:
|
||||
config:
|
||||
onboarding:
|
||||
frontend:
|
||||
input_boolean:
|
||||
script_ran:
|
||||
script:
|
||||
long_job:
|
||||
alias: Long job
|
||||
mode: single
|
||||
sequence:
|
||||
- action: input_boolean.turn_on
|
||||
target:
|
||||
entity_id: input_boolean.script_ran
|
||||
- delay: 20
|
||||
- action: input_boolean.turn_off
|
||||
target:
|
||||
entity_id: input_boolean.script_ran
|
||||
quick_job:
|
||||
alias: Quick job
|
||||
sequence:
|
||||
- action: input_boolean.toggle
|
||||
target:
|
||||
entity_id: input_boolean.script_ran
|
||||
logger:
|
||||
default: warning
|
||||
logs:
|
||||
homeassistant.components.esphome: debug
|
||||
homeassistant.components.script: debug
|
||||
homeassistant.helpers.script: info
|
||||
@@ -0,0 +1,36 @@
|
||||
"""Add a host build's API to a throwaway Home Assistant and allow it to call actions.
|
||||
|
||||
usage: haflow.py TOKENFILE env: HA_URL (default http://127.0.0.1:8129)
|
||||
Runs the esphome config flow against 127.0.0.1:6053, then turns on allow_service_calls in the options flow.
|
||||
"""
|
||||
|
||||
import pathlib
|
||||
import sys
|
||||
|
||||
sys.path.insert(
|
||||
0, str(pathlib.Path(__file__).resolve().parent.parent / "mqtt" / "ha_discovery")
|
||||
)
|
||||
from ha_rest import req_or_exit # noqa: E402
|
||||
|
||||
tok = pathlib.Path(sys.argv[1]).read_text(encoding="utf-8").strip()
|
||||
flow = "/api/config/config_entries/flow"
|
||||
f = req_or_exit(flow, {"handler": "esphome"}, token=tok)
|
||||
r = req_or_exit(
|
||||
f"{flow}/{f['flow_id']}", {"host": "127.0.0.1", "port": 6053}, token=tok
|
||||
)
|
||||
if r.get("type") == "form" and r.get("errors"):
|
||||
sys.exit(f"config flow step {r.get('step_id')} failed: {r['errors']}")
|
||||
if r.get("type") == "form": # confirmation step
|
||||
r = req_or_exit(f"{flow}/{r['flow_id']}", {}, token=tok)
|
||||
if r.get("type") != "create_entry":
|
||||
sys.exit(
|
||||
f"config flow ended with {r.get('type')} {r.get('errors') or r.get('reason')}"
|
||||
)
|
||||
opts = "/api/config/config_entries/options/flow"
|
||||
o = req_or_exit(opts, {"handler": r["result"]["entry_id"]}, token=tok)
|
||||
o = req_or_exit(f"{opts}/{o['flow_id']}", {"allow_service_calls": True}, token=tok)
|
||||
if o.get("type") != "create_entry":
|
||||
sys.exit(
|
||||
f"options flow ended with {o.get('type')} {o.get('errors') or o.get('reason')}"
|
||||
)
|
||||
print("added", r.get("title"), "with allow_service_calls")
|
||||
@@ -0,0 +1,39 @@
|
||||
# Host build mirroring two Home Assistant scripts and the flag they set. Substitution: name.
|
||||
esphome:
|
||||
name: ${name}
|
||||
host:
|
||||
logger:
|
||||
level: DEBUG
|
||||
api:
|
||||
reboot_timeout: 0s
|
||||
switch:
|
||||
- platform: homeassistant
|
||||
id: sw_long
|
||||
name: "Long job mirror"
|
||||
entity_id: script.long_job
|
||||
on_turn_on:
|
||||
- logger.log: "EV long ON"
|
||||
on_turn_off:
|
||||
- logger.log: "EV long OFF"
|
||||
- platform: homeassistant
|
||||
id: sw_quick
|
||||
name: "Quick job mirror"
|
||||
entity_id: script.quick_job
|
||||
- platform: homeassistant
|
||||
id: sw_bool
|
||||
name: "Ran flag mirror"
|
||||
entity_id: input_boolean.script_ran
|
||||
on_turn_on:
|
||||
- logger.log: "EV flag ON"
|
||||
on_turn_off:
|
||||
- logger.log: "EV flag OFF"
|
||||
button:
|
||||
- platform: template
|
||||
name: "Long on"
|
||||
on_press: [switch.turn_on: sw_long]
|
||||
- platform: template
|
||||
name: "Long off"
|
||||
on_press: [switch.turn_off: sw_long]
|
||||
- platform: template
|
||||
name: "Quick on"
|
||||
on_press: [switch.turn_on: sw_quick]
|
||||
@@ -99,6 +99,9 @@ class Client(BaseClient):
|
||||
for line in out["STATE"]:
|
||||
name, _, value = line.partition(" = ")
|
||||
self.last[name] = value
|
||||
# SUB lines are printed sorted below; SUBORDER keeps the order the device sent them
|
||||
for i, line in enumerate(out["SUB"]):
|
||||
print(f" {label} SUBORDER {i:03d} {line}")
|
||||
for kind in ("SUB", "STATE", "ACTION"):
|
||||
for line in sorted(out[kind]) if kind == "SUB" else out[kind]:
|
||||
print(f" {label} {kind} {line}")
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
# Package for Improv tests: Wi-Fi with no network saved, web_server and improv_serial with a next_url, and an ALIVE
|
||||
# line every 5 s. Substitution: name. Drop web_server on a LibreTiny board with no ap: (it boot-loops, see
|
||||
# reference/recipes/improv.md).
|
||||
esphome:
|
||||
name: ${name}
|
||||
|
||||
wifi:
|
||||
power_save_mode: none
|
||||
|
||||
web_server:
|
||||
|
||||
improv_serial:
|
||||
next_url: https://example.com/?device_name={{device_name}}&ip_address={{ip_address}}
|
||||
|
||||
interval:
|
||||
- interval: 5s
|
||||
then:
|
||||
- logger.log: "ALIVE"
|
||||
@@ -0,0 +1,15 @@
|
||||
# Classic ESP32 devkit with Improv over serial (UART0, shared with the log) and BLE. Copy it per build with its own
|
||||
# name; run.sh wants the file name to match name.
|
||||
substitutions:
|
||||
name: improv32
|
||||
packages:
|
||||
common: !include common.yaml
|
||||
esp32:
|
||||
board: esp32dev
|
||||
framework:
|
||||
type: esp-idf
|
||||
logger:
|
||||
hardware_uart: UART0
|
||||
improv_ble:
|
||||
authorizer: none
|
||||
next_url: https://example.com/?device_name={{device_name}}&ip_address={{ip_address}}
|
||||
Loaded 100 of 1308 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user