mirror of
https://github.com/esphome/esphome.git
synced 2026-09-09 14:28:46 +00:00
Compare commits
45
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6250c6bbd0 | ||
|
|
1ce0bed3f6 | ||
|
|
f91486305f | ||
|
|
f191d5e0c3 | ||
|
|
227ca90aad | ||
|
|
1700a40b7c | ||
|
|
28588310e7 | ||
|
|
10a9baff74 | ||
|
|
a23f7bb569 | ||
|
|
53075e4139 | ||
|
|
5722ccba37 | ||
|
|
94e5c3839d | ||
|
|
574762f078 | ||
|
|
d34ffaf392 | ||
|
|
e6aa575f2e | ||
|
|
639ce609bf | ||
|
|
62eafc477d | ||
|
|
56c3361b9a | ||
|
|
50ca381198 | ||
|
|
89a56298c2 | ||
|
|
390742cf9b | ||
|
|
5e37872da2 | ||
|
|
8f280abdbd | ||
|
|
8a88a3f576 | ||
|
|
82431641cc | ||
|
|
f79e9f9cb1 | ||
|
|
f17fd9fcb3 | ||
|
|
07f091059c | ||
|
|
2807a6932b | ||
|
|
ec09ce636c | ||
|
|
7f437aa680 | ||
|
|
f8a60d0259 | ||
|
|
50f50aa7e0 | ||
|
|
676ecae469 | ||
|
|
78258dc554 | ||
|
|
55180938ca | ||
|
|
d88a95c3f6 | ||
|
|
4dad932cd8 | ||
|
|
3b8b90b2cd | ||
|
|
9df8505c8d | ||
|
|
427b83dc0a | ||
|
|
deb641d413 | ||
|
|
0b3e399588 | ||
|
|
33d9adbef1 | ||
|
|
88d6ded5f3 |
@@ -244,11 +244,20 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Check out code from GitHub
|
- name: Check out code from GitHub
|
||||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||||
|
- name: Read prek version from requirements_test.txt
|
||||||
|
id: prek
|
||||||
|
# requirements_test.txt is the only place the version is pinned, so a
|
||||||
|
# Dependabot bump there is picked up here without a second edit.
|
||||||
|
run: |
|
||||||
|
if ! version=$(sed -nE 's/^prek==([^[:space:]#]+).*/\1/p' requirements_test.txt) || [ -z "$version" ]; then
|
||||||
|
echo "::error::No prek== pin found in requirements_test.txt."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
echo "version=$version" >> "$GITHUB_OUTPUT"
|
||||||
- name: Run prek
|
- name: Run prek
|
||||||
uses: j178/prek-action@4e14d07f9231acabce116ccfca13b13dd9755ece # v3.0.0
|
uses: j178/prek-action@4e14d07f9231acabce116ccfca13b13dd9755ece # v3.0.0
|
||||||
with:
|
with:
|
||||||
# Keep in sync with requirements_test.txt.
|
prek-version: ${{ steps.prek.outputs.version }}
|
||||||
prek-version: "0.4.11"
|
|
||||||
# This job only runs on pull requests, so nothing ever populates
|
# This job only runs on pull requests, so nothing ever populates
|
||||||
# the cache on dev. Every run would miss and then write a per-pull
|
# the cache on dev. Every run would miss and then write a per-pull
|
||||||
# request copy, which is what the old seed-cache job existed to
|
# request copy, which is what the old seed-cache job existed to
|
||||||
|
|||||||
@@ -0,0 +1,94 @@
|
|||||||
|
# Keeps pre-commit hook revs in sync with the requirements files.
|
||||||
|
#
|
||||||
|
# Dependabot only bumps the pins in requirements*.txt. Some of those tools
|
||||||
|
# are pinned again as hook revs in .pre-commit-config.yaml. This workflow
|
||||||
|
# runs script/sync_dependency_versions.py against the pull request branch
|
||||||
|
# and pushes a commit with the revs updated.
|
||||||
|
|
||||||
|
name: Sync dependency versions
|
||||||
|
|
||||||
|
on:
|
||||||
|
# pull_request_target rather than pull_request so the App secret is
|
||||||
|
# available on Dependabot pull requests (pull_request runs opened by
|
||||||
|
# Dependabot only see Dependabot secrets). The job below only touches
|
||||||
|
# branches in this repository and only ever executes the script from the
|
||||||
|
# base branch checkout, so fork code never runs with the token.
|
||||||
|
pull_request_target:
|
||||||
|
types: [opened, synchronize, reopened]
|
||||||
|
paths:
|
||||||
|
- requirements_dev.txt
|
||||||
|
- requirements_test.txt
|
||||||
|
- .pre-commit-config.yaml
|
||||||
|
- script/sync_dependency_versions.py
|
||||||
|
|
||||||
|
# The push to the pull request branch uses the App token minted below, so
|
||||||
|
# the workflow's GITHUB_TOKEN does not need any scopes.
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
sync:
|
||||||
|
name: Sync pinned versions
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
# Same-repository branches only: a push to a fork is not possible with
|
||||||
|
# this token, and it keeps untrusted heads out of a privileged job.
|
||||||
|
if: >-
|
||||||
|
github.repository == 'esphome/esphome'
|
||||||
|
&& github.event.pull_request.head.repo.full_name == github.repository
|
||||||
|
steps:
|
||||||
|
- name: Generate a token
|
||||||
|
id: generate-token
|
||||||
|
uses: actions/create-github-app-token@bcd2ba49218906704ab6c1aa796996da409d3eb1 # v3.2.0
|
||||||
|
with:
|
||||||
|
client-id: ${{ vars.ESPHOME_GITHUB_APP_CLIENT_ID }}
|
||||||
|
private-key: ${{ secrets.ESPHOME_GITHUB_APP_PRIVATE_KEY }}
|
||||||
|
# A push made with the workflow's own GITHUB_TOKEN would not start
|
||||||
|
# CI on the new commit; a push with the App token does.
|
||||||
|
permission-contents: write # git push of the sync commit to the pull request branch
|
||||||
|
|
||||||
|
- name: Check out base branch
|
||||||
|
# Provides the script that runs below. Deliberately the base branch
|
||||||
|
# so the pull request cannot change what executes here.
|
||||||
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.base.sha }}
|
||||||
|
persist-credentials: false
|
||||||
|
|
||||||
|
- name: Check out pull request branch
|
||||||
|
# No allow-unsafe-pr-checkout here on purpose: checkout v7 only
|
||||||
|
# refuses heads that live in a different repository, and the job
|
||||||
|
# condition above already limits runs to same-repository branches.
|
||||||
|
# Leaving it off keeps that refusal as a backstop for fork heads.
|
||||||
|
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||||
|
with:
|
||||||
|
ref: ${{ github.event.pull_request.head.ref }}
|
||||||
|
path: pull-request
|
||||||
|
token: ${{ steps.generate-token.outputs.token }}
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
|
||||||
|
- name: Install yamlrocks
|
||||||
|
# The script edits YAML through yamlrocks. Take the pin from the
|
||||||
|
# base branch requirements so this workflow has no copy of its own.
|
||||||
|
run: pip install "$(grep -E '^yamlrocks==' requirements_test.txt | cut -d'#' -f1)"
|
||||||
|
|
||||||
|
- name: Sync pinned versions
|
||||||
|
run: python script/sync_dependency_versions.py --root pull-request
|
||||||
|
|
||||||
|
- name: Push changes
|
||||||
|
working-directory: pull-request
|
||||||
|
run: |
|
||||||
|
if git diff --quiet; then
|
||||||
|
echo "All pinned versions already match the requirements files."
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
git config user.name "esphome[bot]"
|
||||||
|
git config user.email "115708604+esphome[bot]@users.noreply.github.com"
|
||||||
|
git commit -am "Sync pinned tool versions with requirements files"
|
||||||
|
git push
|
||||||
@@ -1,7 +1,6 @@
|
|||||||
---
|
---
|
||||||
# See https://pre-commit.com for more information
|
# See https://pre-commit.com for more information
|
||||||
# See https://pre-commit.com/hooks.html for more hooks
|
# See https://pre-commit.com/hooks.html for more hooks
|
||||||
|
|
||||||
ci:
|
ci:
|
||||||
autoupdate_commit_msg: 'pre-commit: autoupdate'
|
autoupdate_commit_msg: 'pre-commit: autoupdate'
|
||||||
autoupdate_schedule: off # Disabled until ruff versions are synced between deps and pre-commit
|
autoupdate_schedule: off # Disabled until ruff versions are synced between deps and pre-commit
|
||||||
@@ -11,7 +10,7 @@ ci:
|
|||||||
repos:
|
repos:
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
# Ruff version.
|
# Ruff version.
|
||||||
rev: v0.16.3
|
rev: v0.16.6
|
||||||
hooks:
|
hooks:
|
||||||
# Run the linter.
|
# Run the linter.
|
||||||
- id: ruff
|
- id: ruff
|
||||||
@@ -42,7 +41,7 @@ repos:
|
|||||||
- id: pyupgrade
|
- id: pyupgrade
|
||||||
args: [--py312-plus]
|
args: [--py312-plus]
|
||||||
- repo: https://github.com/adrienverge/yamllint.git
|
- repo: https://github.com/adrienverge/yamllint.git
|
||||||
rev: v1.37.1
|
rev: v1.38.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: yamllint
|
- id: yamllint
|
||||||
exclude: ^(\.clang-format|\.clang-tidy)$
|
exclude: ^(\.clang-format|\.clang-tidy)$
|
||||||
|
|||||||
@@ -840,7 +840,7 @@ file does, and it is the authority when they disagree. The most useful starting
|
|||||||
cv.rename_key(
|
cv.rename_key(
|
||||||
CONF_OLD_KEY, CONF_NEW_KEY, removed_in="2026.6.0", component="my_component"
|
CONF_OLD_KEY, CONF_NEW_KEY, removed_in="2026.6.0", component="my_component"
|
||||||
),
|
),
|
||||||
cv.Schema({ ... }),
|
cv.Schema({...}),
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
For other deprecations, warn manually during validation:
|
For other deprecations, warn manually during validation:
|
||||||
|
|||||||
+1
-1
@@ -22,7 +22,7 @@ RUN \
|
|||||||
-r /requirements.txt
|
-r /requirements.txt
|
||||||
|
|
||||||
# Install the ESPHome Device Builder dashboard.
|
# Install the ESPHome Device Builder dashboard.
|
||||||
RUN uv pip install --no-cache-dir esphome-device-builder==1.14.4
|
RUN uv pip install --no-cache-dir esphome-device-builder==1.14.5
|
||||||
|
|
||||||
RUN \
|
RUN \
|
||||||
platformio settings set enable_telemetry No \
|
platformio settings set enable_telemetry No \
|
||||||
|
|||||||
@@ -23,9 +23,7 @@ from esphome.util import safe_print
|
|||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
|
|
||||||
from aioesphomeapi.api_pb2 import (
|
from aioesphomeapi.api_pb2 import SubscribeLogsResponse # pylint: disable=no-name-in-module
|
||||||
SubscribeLogsResponse, # pylint: disable=no-name-in-module
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ void Anova::dump_config() { LOG_CLIMATE("", "Anova BLE Cooker", this); }
|
|||||||
|
|
||||||
void Anova::setup() {
|
void Anova::setup() {
|
||||||
this->codec_ = make_unique<AnovaCodec>();
|
this->codec_ = make_unique<AnovaCodec>();
|
||||||
this->current_request_ = 0;
|
this->poll_step_ = PollStep::IDLE;
|
||||||
}
|
}
|
||||||
|
|
||||||
void Anova::loop() {
|
void Anova::loop() {
|
||||||
@@ -22,6 +22,15 @@ void Anova::loop() {
|
|||||||
this->disable_loop();
|
this->disable_loop();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void Anova::write_request_(AnovaPacket *pkt) {
|
||||||
|
auto status =
|
||||||
|
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
||||||
|
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
||||||
|
if (status) {
|
||||||
|
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
void Anova::control(const ClimateCall &call) {
|
void Anova::control(const ClimateCall &call) {
|
||||||
auto mode_val = call.get_mode();
|
auto mode_val = call.get_mode();
|
||||||
if (mode_val.has_value()) {
|
if (mode_val.has_value()) {
|
||||||
@@ -38,22 +47,11 @@ void Anova::control(const ClimateCall &call) {
|
|||||||
ESP_LOGW(TAG, "Unsupported mode: %d", mode);
|
ESP_LOGW(TAG, "Unsupported mode: %d", mode);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
auto status =
|
this->write_request_(pkt);
|
||||||
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
|
||||||
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
|
||||||
if (status) {
|
|
||||||
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
auto target_temp = call.get_target_temperature();
|
auto target_temp = call.get_target_temperature();
|
||||||
if (target_temp.has_value()) {
|
if (target_temp.has_value()) {
|
||||||
auto *pkt = this->codec_->get_set_target_temp_request(*target_temp);
|
this->write_request_(this->codec_->get_set_target_temp_request(*target_temp));
|
||||||
auto status =
|
|
||||||
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
|
||||||
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
|
||||||
if (status) {
|
|
||||||
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -62,6 +60,7 @@ void Anova::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_
|
|||||||
case ESP_GATTC_DISCONNECT_EVT: {
|
case ESP_GATTC_DISCONNECT_EVT: {
|
||||||
this->current_temperature = NAN;
|
this->current_temperature = NAN;
|
||||||
this->target_temperature = NAN;
|
this->target_temperature = NAN;
|
||||||
|
this->poll_step_ = PollStep::IDLE;
|
||||||
this->publish_state();
|
this->publish_state();
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -83,8 +82,8 @@ void Anova::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_
|
|||||||
}
|
}
|
||||||
case ESP_GATTC_REG_FOR_NOTIFY_EVT: {
|
case ESP_GATTC_REG_FOR_NOTIFY_EVT: {
|
||||||
this->node_state = espbt::ClientState::ESTABLISHED;
|
this->node_state = espbt::ClientState::ESTABLISHED;
|
||||||
this->current_request_ = 0;
|
this->poll_step_ = PollStep::IDLE;
|
||||||
this->update();
|
this->update(); // begin the first poll cycle immediately
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case ESP_GATTC_NOTIFY_EVT: {
|
case ESP_GATTC_NOTIFY_EVT: {
|
||||||
@@ -101,33 +100,30 @@ void Anova::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_
|
|||||||
this->mode = this->codec_->running_ ? climate::CLIMATE_MODE_HEAT : climate::CLIMATE_MODE_OFF;
|
this->mode = this->codec_->running_ ? climate::CLIMATE_MODE_HEAT : climate::CLIMATE_MODE_OFF;
|
||||||
}
|
}
|
||||||
if (this->codec_->has_unit()) {
|
if (this->codec_->has_unit()) {
|
||||||
this->fahrenheit_ = (this->codec_->unit_ == 'f');
|
ESP_LOGD(TAG, "Anova units is %s", (this->codec_->unit_ == 'f') ? "fahrenheit" : "celsius");
|
||||||
ESP_LOGD(TAG, "Anova units is %s", this->fahrenheit_ ? "fahrenheit" : "celsius");
|
|
||||||
this->current_request_++;
|
|
||||||
}
|
}
|
||||||
this->publish_state();
|
this->publish_state();
|
||||||
|
|
||||||
if (this->current_request_ > 1) {
|
// Advance the poll cycle to its next request based on the reply we got.
|
||||||
AnovaPacket *pkt = nullptr;
|
switch (this->poll_step_) {
|
||||||
switch (this->current_request_++) {
|
case PollStep::SET_UNIT:
|
||||||
case 2:
|
this->poll_step_ = PollStep::STATUS;
|
||||||
pkt = this->codec_->get_read_target_temp_request();
|
this->write_request_(this->codec_->get_read_device_status_request());
|
||||||
break;
|
break;
|
||||||
case 3:
|
case PollStep::STATUS:
|
||||||
pkt = this->codec_->get_read_current_temp_request();
|
this->poll_step_ = PollStep::TARGET;
|
||||||
break;
|
this->write_request_(this->codec_->get_read_target_temp_request());
|
||||||
default:
|
break;
|
||||||
this->current_request_ = 1;
|
case PollStep::TARGET:
|
||||||
break;
|
this->poll_step_ = PollStep::CURRENT;
|
||||||
}
|
this->write_request_(this->codec_->get_read_current_temp_request());
|
||||||
if (pkt != nullptr) {
|
break;
|
||||||
auto status =
|
case PollStep::CURRENT:
|
||||||
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
this->poll_step_ = PollStep::IDLE; // full cycle complete
|
||||||
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
break;
|
||||||
if (status) {
|
default:
|
||||||
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
// A reply to an ad-hoc control() write, outside a managed cycle.
|
||||||
}
|
break;
|
||||||
}
|
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -136,27 +132,26 @@ void Anova::gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void Anova::set_unit_of_measurement(const char *unit) { this->fahrenheit_ = !strncmp(unit, "f", 1); }
|
void Anova::set_unit_of_measurement(const char *unit) { this->want_fahrenheit_ = !strncmp(unit, "f", 1); }
|
||||||
|
|
||||||
void Anova::update() {
|
void Anova::update() {
|
||||||
if (this->node_state != espbt::ClientState::ESTABLISHED)
|
if (this->node_state != espbt::ClientState::ESTABLISHED)
|
||||||
return;
|
return;
|
||||||
|
if (this->poll_step_ != PollStep::IDLE) {
|
||||||
if (this->current_request_ < 2) {
|
// The previous cycle never finished within a full polling interval -- a
|
||||||
AnovaPacket *pkt;
|
// reply was missed or a write failed. Restart the cycle rather than stall;
|
||||||
if (this->current_request_ == 0) {
|
// the polling interval itself acts as the timeout. A late reply from the
|
||||||
pkt = this->codec_->get_set_unit_request(this->fahrenheit_ ? 'f' : 'c');
|
// abandoned cycle is harmless: state decoding happens on every notify
|
||||||
} else {
|
// regardless of step, and each notify sends at most one follow-up request.
|
||||||
pkt = this->codec_->get_read_device_status_request();
|
ESP_LOGW(TAG, "[%s] Poll cycle incomplete (step %u); restarting cycle", this->parent_->address_str(),
|
||||||
}
|
static_cast<uint8_t>(this->poll_step_));
|
||||||
auto status =
|
|
||||||
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
|
||||||
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
|
||||||
if (status) {
|
|
||||||
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
|
||||||
}
|
|
||||||
this->current_request_++;
|
|
||||||
}
|
}
|
||||||
|
// Re-assert the configured unit at the start of every poll cycle, then fall
|
||||||
|
// through the status/temperature reads via the notification handler. Always
|
||||||
|
// command the configured unit (want_fahrenheit_) -- never the last value the
|
||||||
|
// device reported, or a drift to 'c' would lock itself in.
|
||||||
|
this->poll_step_ = PollStep::SET_UNIT;
|
||||||
|
this->write_request_(this->codec_->get_set_unit_request(this->want_fahrenheit_ ? 'f' : 'c'));
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace esphome::anova
|
} // namespace esphome::anova
|
||||||
|
|||||||
@@ -37,11 +37,20 @@ class Anova final : public climate::Climate, public esphome::ble_client::BLEClie
|
|||||||
void set_unit_of_measurement(const char *unit);
|
void set_unit_of_measurement(const char *unit);
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
|
// A poll cycle re-asserts the configured unit, then reads device state.
|
||||||
|
// Re-asserting every cycle prevents the cooker from silently reverting to
|
||||||
|
// its default (Celsius); previously the unit was only set once on
|
||||||
|
// connection, so a drift persisted (and corrupted the F/C interpretation of
|
||||||
|
// subsequent readings) until the BLE link was re-established.
|
||||||
|
enum class PollStep : uint8_t { SET_UNIT, STATUS, TARGET, CURRENT, IDLE };
|
||||||
|
|
||||||
|
void write_request_(AnovaPacket *pkt);
|
||||||
|
|
||||||
std::unique_ptr<AnovaCodec> codec_;
|
std::unique_ptr<AnovaCodec> codec_;
|
||||||
void control(const climate::ClimateCall &call) override;
|
void control(const climate::ClimateCall &call) override;
|
||||||
uint16_t char_handle_;
|
uint16_t char_handle_;
|
||||||
uint8_t current_request_;
|
bool want_fahrenheit_{true}; // configured target unit; never overwritten by device replies
|
||||||
bool fahrenheit_;
|
PollStep poll_step_{PollStep::IDLE};
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace esphome::anova
|
} // namespace esphome::anova
|
||||||
|
|||||||
@@ -9,6 +9,10 @@ namespace esphome::atm90e32 {
|
|||||||
|
|
||||||
static const char *const TAG = "atm90e32";
|
static const char *const TAG = "atm90e32";
|
||||||
|
|
||||||
|
static const LogString *offset_calibration_name(bool power_offsets) {
|
||||||
|
return power_offsets ? LOG_STR("Power offset") : LOG_STR("Offset");
|
||||||
|
}
|
||||||
|
|
||||||
static uint32_t pref_hash(const char *prefix, const char *name_space) {
|
static uint32_t pref_hash(const char *prefix, const char *name_space) {
|
||||||
auto hash = fnv1_hash(prefix);
|
auto hash = fnv1_hash(prefix);
|
||||||
return fnv1_hash_extend(hash, name_space);
|
return fnv1_hash_extend(hash, name_space);
|
||||||
@@ -203,13 +207,12 @@ void ATM90E32Component::setup() {
|
|||||||
|
|
||||||
// Initialize flash storage for power offset calibrations
|
// Initialize flash storage for power offset calibrations
|
||||||
uint32_t po_hash = pref_hash("_power_offset_calibration_", cs);
|
uint32_t po_hash = pref_hash("_power_offset_calibration_", cs);
|
||||||
this->power_offset_pref_ = global_preferences->make_preference<PowerOffsetCalibration[3]>(po_hash, true);
|
this->power_offset_pref_ = global_preferences->make_preference<OffsetCalibration[3]>(po_hash, true);
|
||||||
bool migrated_power_offset = false;
|
bool migrated_power_offset = false;
|
||||||
if (has_distinct_legacy_namespace) {
|
if (has_distinct_legacy_namespace) {
|
||||||
uint32_t legacy_po_hash = pref_hash("_power_offset_calibration_", legacy_cs);
|
uint32_t legacy_po_hash = pref_hash("_power_offset_calibration_", legacy_cs);
|
||||||
auto legacy_power_offset_pref =
|
auto legacy_power_offset_pref = global_preferences->make_preference<OffsetCalibration[3]>(legacy_po_hash, true);
|
||||||
global_preferences->make_preference<PowerOffsetCalibration[3]>(legacy_po_hash, true);
|
OffsetCalibration power_offset_data[3]{};
|
||||||
PowerOffsetCalibration power_offset_data[3]{};
|
|
||||||
int migration_status =
|
int migration_status =
|
||||||
migrate_legacy_pref_if_needed(this->power_offset_pref_, legacy_power_offset_pref, &power_offset_data);
|
migrate_legacy_pref_if_needed(this->power_offset_pref_, legacy_power_offset_pref, &power_offset_data);
|
||||||
migrated_power_offset = migration_status > 0;
|
migrated_power_offset = migration_status > 0;
|
||||||
@@ -224,20 +227,20 @@ void ATM90E32Component::setup() {
|
|||||||
global_preferences->sync();
|
global_preferences->sync();
|
||||||
}
|
}
|
||||||
|
|
||||||
this->restore_offset_calibrations_();
|
this->restore_offset_calibrations_(OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
||||||
this->restore_power_offset_calibrations_();
|
this->restore_offset_calibrations_(OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
||||||
} else {
|
} else {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] Power & Voltage/Current offset calibration is disabled. Using config file values.",
|
ESP_LOGI(TAG, "[CALIBRATION][%s] Power & Voltage/Current offset calibration is disabled. Using config file values.",
|
||||||
cs);
|
cs);
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
for (uint8_t phase = 0; phase < 3; ++phase) {
|
||||||
this->write16_(this->voltage_offset_registers[phase],
|
this->write16_(this->voltage_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->offset_phase_[phase].voltage_offset_));
|
static_cast<uint16_t>(this->offset_phase_[phase].first_offset));
|
||||||
this->write16_(this->current_offset_registers[phase],
|
this->write16_(this->current_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->offset_phase_[phase].current_offset_));
|
static_cast<uint16_t>(this->offset_phase_[phase].second_offset));
|
||||||
this->write16_(this->power_offset_registers[phase],
|
this->write16_(this->power_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->power_offset_phase_[phase].active_power_offset));
|
static_cast<uint16_t>(this->power_offset_phase_[phase].first_offset));
|
||||||
this->write16_(this->reactive_power_offset_registers[phase],
|
this->write16_(this->reactive_power_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->power_offset_phase_[phase].reactive_power_offset));
|
static_cast<uint16_t>(this->power_offset_phase_[phase].second_offset));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -317,8 +320,8 @@ void ATM90E32Component::log_calibration_status_() {
|
|||||||
cs);
|
cs);
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
for (uint8_t phase = 0; phase < 3; ++phase) {
|
||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] | %c | %6d | %6d | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGW(TAG, "[CALIBRATION][%s] | %c | %6d | %6d | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->config_offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].voltage_offset_,
|
this->config_offset_phase_[phase].first_offset, this->offset_phase_[phase].first_offset,
|
||||||
this->config_offset_phase_[phase].current_offset_, this->offset_phase_[phase].current_offset_);
|
this->config_offset_phase_[phase].second_offset, this->offset_phase_[phase].second_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGW(TAG,
|
ESP_LOGW(TAG,
|
||||||
"[CALIBRATION][%s] ===============================================================================", cs);
|
"[CALIBRATION][%s] ===============================================================================", cs);
|
||||||
@@ -335,10 +338,8 @@ void ATM90E32Component::log_calibration_status_() {
|
|||||||
cs);
|
cs);
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
for (uint8_t phase = 0; phase < 3; ++phase) {
|
||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] | %c | %6d | %6d | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGW(TAG, "[CALIBRATION][%s] | %c | %6d | %6d | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->config_power_offset_phase_[phase].active_power_offset,
|
this->config_power_offset_phase_[phase].first_offset, this->power_offset_phase_[phase].first_offset,
|
||||||
this->power_offset_phase_[phase].active_power_offset,
|
this->config_power_offset_phase_[phase].second_offset, this->power_offset_phase_[phase].second_offset);
|
||||||
this->config_power_offset_phase_[phase].reactive_power_offset,
|
|
||||||
this->power_offset_phase_[phase].reactive_power_offset);
|
|
||||||
}
|
}
|
||||||
ESP_LOGW(TAG,
|
ESP_LOGW(TAG,
|
||||||
"[CALIBRATION][%s] ===============================================================================", cs);
|
"[CALIBRATION][%s] ===============================================================================", cs);
|
||||||
@@ -372,7 +373,7 @@ void ATM90E32Component::log_calibration_status_() {
|
|||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].current_offset_);
|
this->offset_phase_[phase].first_offset, this->offset_phase_[phase].second_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\\n", cs);
|
||||||
}
|
}
|
||||||
@@ -385,8 +386,7 @@ void ATM90E32Component::log_calibration_status_() {
|
|||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->power_offset_phase_[phase].active_power_offset,
|
this->power_offset_phase_[phase].first_offset, this->power_offset_phase_[phase].second_offset);
|
||||||
this->power_offset_phase_[phase].reactive_power_offset);
|
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
||||||
}
|
}
|
||||||
@@ -756,36 +756,68 @@ void ATM90E32Component::save_gain_calibration_to_memory_() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::save_offset_calibration_to_memory_() {
|
void ATM90E32Component::finish_offset_calibration_(const OffsetCalibration (&previous)[3], bool previous_restored,
|
||||||
|
bool previous_using_saved, OffsetCalibrationType type) {
|
||||||
|
const bool power_offsets = type == OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER;
|
||||||
const char *cs = this->get_calibration_id_();
|
const char *cs = this->get_calibration_id_();
|
||||||
bool success = this->offset_pref_.save(&this->offset_phase_);
|
const LogString *name = offset_calibration_name(power_offsets);
|
||||||
global_preferences->sync();
|
OffsetCalibration(*offsets)[3] = power_offsets ? &this->power_offset_phase_ : &this->offset_phase_;
|
||||||
if (success) {
|
ESPPreferenceObject *preference = power_offsets ? &this->power_offset_pref_ : &this->offset_pref_;
|
||||||
this->using_saved_calibrations_ = true;
|
bool *has_stored =
|
||||||
this->restored_offset_calibration_ = true;
|
power_offsets ? &this->has_stored_power_offset_calibration_ : &this->has_stored_offset_calibration_;
|
||||||
for (bool &phase : this->offset_calibration_mismatch_)
|
bool *restored = power_offsets ? &this->restored_power_offset_calibration_ : &this->restored_offset_calibration_;
|
||||||
phase = false;
|
bool *mismatches = power_offsets ? this->power_offset_calibration_mismatch_ : this->offset_calibration_mismatch_;
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] Offset calibration saved to memory.", cs);
|
|
||||||
} else {
|
|
||||||
this->using_saved_calibrations_ = false;
|
|
||||||
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to save offset calibration to memory!", cs);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void ATM90E32Component::save_power_offset_calibration_to_memory_() {
|
const bool writes_verified = this->verify_offset_writes_(type);
|
||||||
const char *cs = this->get_calibration_id_();
|
bool saved = false;
|
||||||
bool success = this->power_offset_pref_.save(&this->power_offset_phase_);
|
bool synced = false;
|
||||||
global_preferences->sync();
|
if (writes_verified) {
|
||||||
if (success) {
|
saved = preference->save(offsets);
|
||||||
this->using_saved_calibrations_ = true;
|
synced = global_preferences->sync();
|
||||||
this->restored_power_offset_calibration_ = true;
|
|
||||||
for (bool &phase : this->power_offset_calibration_mismatch_)
|
|
||||||
phase = false;
|
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] Power offset calibration saved to memory.", cs);
|
|
||||||
} else {
|
|
||||||
this->using_saved_calibrations_ = false;
|
|
||||||
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to save power offset calibration to memory!", cs);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (writes_verified && saved && synced) {
|
||||||
|
this->using_saved_calibrations_ = true;
|
||||||
|
*has_stored = true;
|
||||||
|
*restored = true;
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++)
|
||||||
|
mismatches[phase] = false;
|
||||||
|
ESP_LOGI(TAG, "[CALIBRATION][%s] %s calibration saved to memory. %s calibration completed and verified.", cs,
|
||||||
|
LOG_STR_ARG(name), LOG_STR_ARG(name));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (writes_verified) {
|
||||||
|
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to save %s calibration to memory!", cs, LOG_STR_ARG(name));
|
||||||
|
}
|
||||||
|
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
|
this->write_offsets_to_registers_(phase, previous[phase].first_offset, previous[phase].second_offset, type);
|
||||||
|
}
|
||||||
|
const bool rollback_verified = this->verify_offset_writes_(type);
|
||||||
|
|
||||||
|
bool rollback_persisted = false;
|
||||||
|
if (writes_verified) {
|
||||||
|
OffsetCalibration rollback[3]{};
|
||||||
|
prepare_offset_rollback(previous, previous_restored, rollback);
|
||||||
|
const bool rollback_saved = preference->save(&rollback);
|
||||||
|
const bool rollback_synced = global_preferences->sync();
|
||||||
|
rollback_persisted = rollback_saved && rollback_synced;
|
||||||
|
if (!rollback_saved || !rollback_synced) {
|
||||||
|
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to persist restored %s calibration values!", cs, LOG_STR_ARG(name));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
*restored = previous_restored;
|
||||||
|
if (rollback_persisted)
|
||||||
|
*has_stored = previous_restored;
|
||||||
|
this->using_saved_calibrations_ = previous_using_saved;
|
||||||
|
if (!rollback_verified) {
|
||||||
|
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration failed; rollback readback verification failed.", cs,
|
||||||
|
LOG_STR_ARG(name));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration failed; previous values restored.", cs, LOG_STR_ARG(name));
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::run_offset_calibrations() {
|
void ATM90E32Component::run_offset_calibrations() {
|
||||||
@@ -803,11 +835,16 @@ void ATM90E32Component::run_offset_calibrations() {
|
|||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_voltage | offset_current |", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_voltage | offset_current |", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ------------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ------------------------------------------------------------------", cs);
|
||||||
|
|
||||||
|
OffsetCalibration previous_offsets[3] = {this->offset_phase_[0], this->offset_phase_[1], this->offset_phase_[2]};
|
||||||
|
const bool previous_restored = this->restored_offset_calibration_;
|
||||||
|
const bool previous_using_saved = this->using_saved_calibrations_;
|
||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
int16_t voltage_offset = calibrate_offset(phase, true);
|
int16_t voltage_offset = calibrate_offset(phase, true);
|
||||||
int16_t current_offset = calibrate_offset(phase, false);
|
int16_t current_offset = calibrate_offset(phase, false);
|
||||||
|
|
||||||
this->write_offsets_to_registers_(phase, voltage_offset, current_offset);
|
this->write_offsets_to_registers_(phase, voltage_offset, current_offset,
|
||||||
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
||||||
|
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, voltage_offset,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, voltage_offset,
|
||||||
current_offset);
|
current_offset);
|
||||||
@@ -815,7 +852,8 @@ void ATM90E32Component::run_offset_calibrations() {
|
|||||||
|
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==================================================================\n", cs);
|
||||||
|
|
||||||
this->save_offset_calibration_to_memory_();
|
this->finish_offset_calibration_(previous_offsets, previous_restored, previous_using_saved,
|
||||||
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::run_power_offset_calibrations() {
|
void ATM90E32Component::run_power_offset_calibrations() {
|
||||||
@@ -834,18 +872,25 @@ void ATM90E32Component::run_power_offset_calibrations() {
|
|||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_active_power | offset_reactive_power |", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_active_power | offset_reactive_power |", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
||||||
|
|
||||||
|
OffsetCalibration previous_offsets[3] = {this->power_offset_phase_[0], this->power_offset_phase_[1],
|
||||||
|
this->power_offset_phase_[2]};
|
||||||
|
const bool previous_restored = this->restored_power_offset_calibration_;
|
||||||
|
const bool previous_using_saved = this->using_saved_calibrations_;
|
||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
for (uint8_t phase = 0; phase < 3; ++phase) {
|
||||||
int16_t active_offset = calibrate_power_offset(phase, false);
|
int16_t active_offset = calibrate_power_offset(phase, false);
|
||||||
int16_t reactive_offset = calibrate_power_offset(phase, true);
|
int16_t reactive_offset = calibrate_power_offset(phase, true);
|
||||||
|
|
||||||
this->write_power_offsets_to_registers_(phase, active_offset, reactive_offset);
|
this->write_offsets_to_registers_(phase, active_offset, reactive_offset,
|
||||||
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
||||||
|
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, active_offset,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, active_offset,
|
||||||
reactive_offset);
|
reactive_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
||||||
|
|
||||||
this->save_power_offset_calibration_to_memory_();
|
this->finish_offset_calibration_(previous_offsets, previous_restored, previous_using_saved,
|
||||||
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::write_gains_to_registers_() {
|
void ATM90E32Component::write_gains_to_registers_() {
|
||||||
@@ -859,35 +904,26 @@ void ATM90E32Component::write_gains_to_registers_() {
|
|||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x0000);
|
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x0000);
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset) {
|
void ATM90E32Component::write_offsets_to_registers_(uint8_t phase, int16_t first_offset, int16_t second_offset,
|
||||||
// Save to runtime
|
OffsetCalibrationType type) {
|
||||||
this->offset_phase_[phase].voltage_offset_ = voltage_offset;
|
const bool power_offsets = type == OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER;
|
||||||
this->phase_[phase].voltage_offset_ = voltage_offset;
|
OffsetCalibration &offsets = power_offsets ? this->power_offset_phase_[phase] : this->offset_phase_[phase];
|
||||||
|
offsets.first_offset = first_offset;
|
||||||
|
offsets.second_offset = second_offset;
|
||||||
|
if (power_offsets) {
|
||||||
|
this->phase_[phase].active_power_offset_ = first_offset;
|
||||||
|
this->phase_[phase].reactive_power_offset_ = second_offset;
|
||||||
|
} else {
|
||||||
|
this->phase_[phase].voltage_offset_ = first_offset;
|
||||||
|
this->phase_[phase].current_offset_ = second_offset;
|
||||||
|
}
|
||||||
|
|
||||||
// Save to flash-storable struct
|
const uint16_t *first_registers = power_offsets ? this->power_offset_registers : this->voltage_offset_registers;
|
||||||
this->offset_phase_[phase].current_offset_ = current_offset;
|
const uint16_t *second_registers =
|
||||||
this->phase_[phase].current_offset_ = current_offset;
|
power_offsets ? this->reactive_power_offset_registers : this->current_offset_registers;
|
||||||
|
|
||||||
// Write to registers
|
|
||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x55AA);
|
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x55AA);
|
||||||
this->write16_(voltage_offset_registers[phase], static_cast<uint16_t>(voltage_offset));
|
this->write16_(first_registers[phase], static_cast<uint16_t>(first_offset));
|
||||||
this->write16_(current_offset_registers[phase], static_cast<uint16_t>(current_offset));
|
this->write16_(second_registers[phase], static_cast<uint16_t>(second_offset));
|
||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x0000);
|
|
||||||
}
|
|
||||||
|
|
||||||
void ATM90E32Component::write_power_offsets_to_registers_(uint8_t phase, int16_t p_offset, int16_t q_offset) {
|
|
||||||
// Save to runtime
|
|
||||||
this->phase_[phase].active_power_offset_ = p_offset;
|
|
||||||
this->phase_[phase].reactive_power_offset_ = q_offset;
|
|
||||||
|
|
||||||
// Save to flash-storable struct
|
|
||||||
this->power_offset_phase_[phase].active_power_offset = p_offset;
|
|
||||||
this->power_offset_phase_[phase].reactive_power_offset = q_offset;
|
|
||||||
|
|
||||||
// Write to registers
|
|
||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x55AA);
|
|
||||||
this->write16_(this->power_offset_registers[phase], static_cast<uint16_t>(p_offset));
|
|
||||||
this->write16_(this->reactive_power_offset_registers[phase], static_cast<uint16_t>(q_offset));
|
|
||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x0000);
|
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x0000);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -947,89 +983,78 @@ void ATM90E32Component::restore_gain_calibrations_() {
|
|||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored gain calibrations found. Using config file values.", cs);
|
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored gain calibrations found. Using config file values.", cs);
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::restore_offset_calibrations_() {
|
void ATM90E32Component::restore_offset_calibrations_(OffsetCalibrationType type) {
|
||||||
|
const bool power_offsets = type == OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER;
|
||||||
const char *cs = this->get_calibration_id_();
|
const char *cs = this->get_calibration_id_();
|
||||||
|
const LogString *name = power_offsets ? LOG_STR("power offset") : LOG_STR("offset");
|
||||||
|
OffsetCalibration(*offsets)[3] = power_offsets ? &this->power_offset_phase_ : &this->offset_phase_;
|
||||||
|
OffsetCalibration(*config_offsets)[3] =
|
||||||
|
power_offsets ? &this->config_power_offset_phase_ : &this->config_offset_phase_;
|
||||||
|
ESPPreferenceObject *preference = power_offsets ? &this->power_offset_pref_ : &this->offset_pref_;
|
||||||
|
bool *has_stored =
|
||||||
|
power_offsets ? &this->has_stored_power_offset_calibration_ : &this->has_stored_offset_calibration_;
|
||||||
|
bool *restored = power_offsets ? &this->restored_power_offset_calibration_ : &this->restored_offset_calibration_;
|
||||||
|
bool *mismatches = power_offsets ? this->power_offset_calibration_mismatch_ : this->offset_calibration_mismatch_;
|
||||||
|
const bool *has_first = power_offsets ? this->has_config_active_power_offset_ : this->has_config_voltage_offset_;
|
||||||
|
const bool *has_second = power_offsets ? this->has_config_reactive_power_offset_ : this->has_config_current_offset_;
|
||||||
|
|
||||||
for (uint8_t i = 0; i < 3; ++i)
|
for (uint8_t i = 0; i < 3; ++i)
|
||||||
this->config_offset_phase_[i] = this->offset_phase_[i];
|
(*config_offsets)[i] = (*offsets)[i];
|
||||||
|
|
||||||
bool have_data = this->offset_pref_.load(&this->offset_phase_);
|
|
||||||
|
|
||||||
|
const bool have_data = preference->load(offsets);
|
||||||
bool all_zero = true;
|
bool all_zero = true;
|
||||||
if (have_data) {
|
if (have_data) {
|
||||||
for (auto &phase : this->offset_phase_) {
|
for (const auto &phase : *offsets) {
|
||||||
if (phase.voltage_offset_ != 0 || phase.current_offset_ != 0) {
|
if (phase.first_offset != 0 || phase.second_offset != 0) {
|
||||||
all_zero = false;
|
all_zero = false;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if (have_data && !all_zero) {
|
*has_stored = have_data && !all_zero;
|
||||||
this->restored_offset_calibration_ = true;
|
*restored = false;
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
auto &offset = this->offset_phase_[phase];
|
mismatches[phase] = false;
|
||||||
bool mismatch = false;
|
if (*has_stored) {
|
||||||
if (this->has_config_voltage_offset_[phase] &&
|
mismatches[phase] =
|
||||||
offset.voltage_offset_ != this->config_offset_phase_[phase].voltage_offset_)
|
(has_first[phase] && (*offsets)[phase].first_offset != (*config_offsets)[phase].first_offset) ||
|
||||||
mismatch = true;
|
(has_second[phase] && (*offsets)[phase].second_offset != (*config_offsets)[phase].second_offset);
|
||||||
if (this->has_config_current_offset_[phase] &&
|
|
||||||
offset.current_offset_ != this->config_offset_phase_[phase].current_offset_)
|
|
||||||
mismatch = true;
|
|
||||||
if (mismatch)
|
|
||||||
this->offset_calibration_mismatch_[phase] = true;
|
|
||||||
}
|
}
|
||||||
} else {
|
}
|
||||||
|
|
||||||
|
if (!*has_stored) {
|
||||||
for (uint8_t phase = 0; phase < 3; phase++)
|
for (uint8_t phase = 0; phase < 3; phase++)
|
||||||
this->offset_phase_[phase] = this->config_offset_phase_[phase];
|
(*offsets)[phase] = (*config_offsets)[phase];
|
||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored offset calibrations found. Using default values.", cs);
|
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored %s calibrations found. Using default values.", cs, LOG_STR_ARG(name));
|
||||||
}
|
}
|
||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
write_offsets_to_registers_(phase, this->offset_phase_[phase].voltage_offset_,
|
this->write_offsets_to_registers_(phase, (*offsets)[phase].first_offset, (*offsets)[phase].second_offset, type);
|
||||||
this->offset_phase_[phase].current_offset_);
|
|
||||||
}
|
}
|
||||||
}
|
const bool initial_values_verified = this->verify_offset_writes_(type);
|
||||||
|
if (initial_values_verified) {
|
||||||
void ATM90E32Component::restore_power_offset_calibrations_() {
|
const auto state = resolve_offset_restore_state(*has_stored, true, false);
|
||||||
const char *cs = this->get_calibration_id_();
|
*restored = state.restored;
|
||||||
for (uint8_t i = 0; i < 3; ++i)
|
ESP_LOGI(TAG, "[CALIBRATION][%s] %s calibration values verified.", cs, LOG_STR_ARG(name));
|
||||||
this->config_power_offset_phase_[i] = this->power_offset_phase_[i];
|
return;
|
||||||
|
|
||||||
bool have_data = this->power_offset_pref_.load(&this->power_offset_phase_);
|
|
||||||
|
|
||||||
bool all_zero = true;
|
|
||||||
if (have_data) {
|
|
||||||
for (auto &phase : this->power_offset_phase_) {
|
|
||||||
if (phase.active_power_offset != 0 || phase.reactive_power_offset != 0) {
|
|
||||||
all_zero = false;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (have_data && !all_zero) {
|
this->using_saved_calibrations_ = false;
|
||||||
this->restored_power_offset_calibration_ = true;
|
for (uint8_t phase = 0; phase < 3; phase++)
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
mismatches[phase] = false;
|
||||||
auto &offset = this->power_offset_phase_[phase];
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
bool mismatch = false;
|
(*offsets)[phase] = (*config_offsets)[phase];
|
||||||
if (this->has_config_active_power_offset_[phase] &&
|
this->write_offsets_to_registers_(phase, (*offsets)[phase].first_offset, (*offsets)[phase].second_offset, type);
|
||||||
offset.active_power_offset != this->config_power_offset_phase_[phase].active_power_offset)
|
}
|
||||||
mismatch = true;
|
const auto state = resolve_offset_restore_state(*has_stored, false, this->verify_offset_writes_(type));
|
||||||
if (this->has_config_reactive_power_offset_[phase] &&
|
*restored = state.restored;
|
||||||
offset.reactive_power_offset != this->config_power_offset_phase_[phase].reactive_power_offset)
|
if (state.values_verified) {
|
||||||
mismatch = true;
|
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration restore failed verification; config values verified.", cs,
|
||||||
if (mismatch)
|
LOG_STR_ARG(name));
|
||||||
this->power_offset_calibration_mismatch_[phase] = true;
|
|
||||||
}
|
|
||||||
} else {
|
} else {
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase)
|
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration restore and config fallback both failed verification.", cs,
|
||||||
this->power_offset_phase_[phase] = this->config_power_offset_phase_[phase];
|
LOG_STR_ARG(name));
|
||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored power offsets found. Using default values.", cs);
|
|
||||||
}
|
|
||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; ++phase) {
|
|
||||||
write_power_offsets_to_registers_(phase, this->power_offset_phase_[phase].active_power_offset,
|
|
||||||
this->power_offset_phase_[phase].reactive_power_offset);
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1084,14 +1109,14 @@ void ATM90E32Component::clear_gain_calibrations() {
|
|||||||
|
|
||||||
void ATM90E32Component::clear_offset_calibrations() {
|
void ATM90E32Component::clear_offset_calibrations() {
|
||||||
const char *cs = this->get_calibration_id_();
|
const char *cs = this->get_calibration_id_();
|
||||||
if (!this->restored_offset_calibration_) {
|
if (!this->has_stored_offset_calibration_) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] No stored offset calibrations to clear. Current values:", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] No stored offset calibrations to clear. Current values:", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_voltage | offset_current |", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_voltage | offset_current |", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] --------------------------------------------------------------", cs);
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].current_offset_);
|
this->offset_phase_[phase].first_offset, this->offset_phase_[phase].second_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\n", cs);
|
||||||
return;
|
return;
|
||||||
@@ -1104,10 +1129,11 @@ void ATM90E32Component::clear_offset_calibrations() {
|
|||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
int16_t voltage_offset =
|
int16_t voltage_offset =
|
||||||
this->has_config_voltage_offset_[phase] ? this->config_offset_phase_[phase].voltage_offset_ : 0;
|
this->has_config_voltage_offset_[phase] ? this->config_offset_phase_[phase].first_offset : 0;
|
||||||
int16_t current_offset =
|
int16_t current_offset =
|
||||||
this->has_config_current_offset_[phase] ? this->config_offset_phase_[phase].current_offset_ : 0;
|
this->has_config_current_offset_[phase] ? this->config_offset_phase_[phase].second_offset : 0;
|
||||||
this->write_offsets_to_registers_(phase, voltage_offset, current_offset);
|
this->write_offsets_to_registers_(phase, voltage_offset, current_offset,
|
||||||
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, voltage_offset,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, voltage_offset,
|
||||||
current_offset);
|
current_offset);
|
||||||
}
|
}
|
||||||
@@ -1117,6 +1143,7 @@ void ATM90E32Component::clear_offset_calibrations() {
|
|||||||
this->offset_pref_.save(&zero_offsets); // Clear stored values in flash
|
this->offset_pref_.save(&zero_offsets); // Clear stored values in flash
|
||||||
global_preferences->sync();
|
global_preferences->sync();
|
||||||
|
|
||||||
|
this->has_stored_offset_calibration_ = false;
|
||||||
this->restored_offset_calibration_ = false;
|
this->restored_offset_calibration_ = false;
|
||||||
for (bool &phase : this->offset_calibration_mismatch_)
|
for (bool &phase : this->offset_calibration_mismatch_)
|
||||||
phase = false;
|
phase = false;
|
||||||
@@ -1126,15 +1153,14 @@ void ATM90E32Component::clear_offset_calibrations() {
|
|||||||
|
|
||||||
void ATM90E32Component::clear_power_offset_calibrations() {
|
void ATM90E32Component::clear_power_offset_calibrations() {
|
||||||
const char *cs = this->get_calibration_id_();
|
const char *cs = this->get_calibration_id_();
|
||||||
if (!this->restored_power_offset_calibration_) {
|
if (!this->has_stored_power_offset_calibration_) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] No stored power offsets to clear. Current values:", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] No stored power offsets to clear. Current values:", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_active_power | offset_reactive_power |", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | Phase | offset_active_power | offset_reactive_power |", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ---------------------------------------------------------------------", cs);
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase,
|
||||||
this->power_offset_phase_[phase].active_power_offset,
|
this->power_offset_phase_[phase].first_offset, this->power_offset_phase_[phase].second_offset);
|
||||||
this->power_offset_phase_[phase].reactive_power_offset);
|
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
||||||
return;
|
return;
|
||||||
@@ -1147,20 +1173,21 @@ void ATM90E32Component::clear_power_offset_calibrations() {
|
|||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
int16_t active_offset =
|
int16_t active_offset =
|
||||||
this->has_config_active_power_offset_[phase] ? this->config_power_offset_phase_[phase].active_power_offset : 0;
|
this->has_config_active_power_offset_[phase] ? this->config_power_offset_phase_[phase].first_offset : 0;
|
||||||
int16_t reactive_offset = this->has_config_reactive_power_offset_[phase]
|
int16_t reactive_offset =
|
||||||
? this->config_power_offset_phase_[phase].reactive_power_offset
|
this->has_config_reactive_power_offset_[phase] ? this->config_power_offset_phase_[phase].second_offset : 0;
|
||||||
: 0;
|
this->write_offsets_to_registers_(phase, active_offset, reactive_offset,
|
||||||
this->write_power_offsets_to_registers_(phase, active_offset, reactive_offset);
|
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, active_offset,
|
ESP_LOGI(TAG, "[CALIBRATION][%s] | %c | %6d | %6d |", cs, 'A' + phase, active_offset,
|
||||||
reactive_offset);
|
reactive_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
||||||
|
|
||||||
PowerOffsetCalibration zero_power_offsets[3]{{0, 0}, {0, 0}, {0, 0}};
|
OffsetCalibration zero_power_offsets[3]{{0, 0}, {0, 0}, {0, 0}};
|
||||||
this->power_offset_pref_.save(&zero_power_offsets);
|
this->power_offset_pref_.save(&zero_power_offsets);
|
||||||
global_preferences->sync();
|
global_preferences->sync();
|
||||||
|
|
||||||
|
this->has_stored_power_offset_calibration_ = false;
|
||||||
this->restored_power_offset_calibration_ = false;
|
this->restored_power_offset_calibration_ = false;
|
||||||
for (bool &phase : this->power_offset_calibration_mismatch_)
|
for (bool &phase : this->power_offset_calibration_mismatch_)
|
||||||
phase = false;
|
phase = false;
|
||||||
@@ -1215,6 +1242,31 @@ bool ATM90E32Component::verify_gain_writes_() {
|
|||||||
return success; // Return true if all writes were successful, false otherwise
|
return success; // Return true if all writes were successful, false otherwise
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool ATM90E32Component::verify_offset_writes_(OffsetCalibrationType type) {
|
||||||
|
const bool power_offsets = type == OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER;
|
||||||
|
const char *cs = this->get_calibration_id_();
|
||||||
|
const LogString *name = offset_calibration_name(power_offsets);
|
||||||
|
const LogString *first_name = power_offsets ? LOG_STR("active") : LOG_STR("voltage");
|
||||||
|
const LogString *second_name = power_offsets ? LOG_STR("reactive") : LOG_STR("current");
|
||||||
|
const OffsetCalibration *offsets = power_offsets ? this->power_offset_phase_ : this->offset_phase_;
|
||||||
|
const uint16_t *first_registers = power_offsets ? this->power_offset_registers : this->voltage_offset_registers;
|
||||||
|
const uint16_t *second_registers =
|
||||||
|
power_offsets ? this->reactive_power_offset_registers : this->current_offset_registers;
|
||||||
|
bool success = true;
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
|
const uint16_t first = this->read16_(first_registers[phase]);
|
||||||
|
const uint16_t second = this->read16_(second_registers[phase]);
|
||||||
|
if (!offset_register_value_matches(first, offsets[phase].first_offset) ||
|
||||||
|
!offset_register_value_matches(second, offsets[phase].second_offset)) {
|
||||||
|
ESP_LOGE(TAG, "[CALIBRATION][%s] %s readback failed for Phase %s: %s %d/%d, %s %d/%d.", cs, LOG_STR_ARG(name),
|
||||||
|
phase_labels[phase], LOG_STR_ARG(first_name), static_cast<int16_t>(first), offsets[phase].first_offset,
|
||||||
|
LOG_STR_ARG(second_name), static_cast<int16_t>(second), offsets[phase].second_offset);
|
||||||
|
success = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return success;
|
||||||
|
}
|
||||||
|
|
||||||
#ifdef USE_TEXT_SENSOR
|
#ifdef USE_TEXT_SENSOR
|
||||||
void ATM90E32Component::check_phase_status() {
|
void ATM90E32Component::check_phase_status() {
|
||||||
uint16_t state0 = this->read16_(ATM90E32_REGISTER_EMMSTATE0);
|
uint16_t state0 = this->read16_(ATM90E32_REGISTER_EMMSTATE0);
|
||||||
|
|||||||
@@ -13,6 +13,40 @@
|
|||||||
|
|
||||||
namespace esphome::atm90e32 {
|
namespace esphome::atm90e32 {
|
||||||
|
|
||||||
|
inline bool offset_register_value_matches(uint16_t actual, int16_t expected) {
|
||||||
|
return actual == static_cast<uint16_t>(expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
struct OffsetCalibration {
|
||||||
|
int16_t first_offset{0};
|
||||||
|
int16_t second_offset{0};
|
||||||
|
};
|
||||||
|
|
||||||
|
static_assert(sizeof(OffsetCalibration[3]) == 12, "Offset calibration preference layout must remain compatible");
|
||||||
|
|
||||||
|
enum class OffsetCalibrationType : uint8_t {
|
||||||
|
OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT,
|
||||||
|
OFFSET_CALIBRATION_TYPE_POWER,
|
||||||
|
};
|
||||||
|
|
||||||
|
struct OffsetRestoreState {
|
||||||
|
bool restored;
|
||||||
|
bool values_verified;
|
||||||
|
};
|
||||||
|
|
||||||
|
inline OffsetRestoreState resolve_offset_restore_state(bool has_stored_values, bool initial_values_verified,
|
||||||
|
bool fallback_values_verified) {
|
||||||
|
if (initial_values_verified)
|
||||||
|
return {has_stored_values, true};
|
||||||
|
return {false, fallback_values_verified};
|
||||||
|
}
|
||||||
|
|
||||||
|
inline void prepare_offset_rollback(const OffsetCalibration (&previous)[3], bool had_stored_values,
|
||||||
|
OffsetCalibration (&rollback)[3]) {
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++)
|
||||||
|
rollback[phase] = had_stored_values ? previous[phase] : OffsetCalibration{};
|
||||||
|
}
|
||||||
|
|
||||||
class ATM90E32Component final : public PollingComponent,
|
class ATM90E32Component final : public PollingComponent,
|
||||||
public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH,
|
public spi::SPIDevice<spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_HIGH,
|
||||||
spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_1MHZ> {
|
spi::CLOCK_PHASE_TRAILING, spi::DATA_RATE_1MHZ> {
|
||||||
@@ -71,19 +105,19 @@ class ATM90E32Component final : public PollingComponent,
|
|||||||
this->has_config_current_gain_[phase] = true;
|
this->has_config_current_gain_[phase] = true;
|
||||||
}
|
}
|
||||||
void set_voltage_offset(uint8_t phase, int16_t offset) {
|
void set_voltage_offset(uint8_t phase, int16_t offset) {
|
||||||
this->offset_phase_[phase].voltage_offset_ = offset;
|
this->offset_phase_[phase].first_offset = offset;
|
||||||
this->has_config_voltage_offset_[phase] = true;
|
this->has_config_voltage_offset_[phase] = true;
|
||||||
}
|
}
|
||||||
void set_current_offset(uint8_t phase, int16_t offset) {
|
void set_current_offset(uint8_t phase, int16_t offset) {
|
||||||
this->offset_phase_[phase].current_offset_ = offset;
|
this->offset_phase_[phase].second_offset = offset;
|
||||||
this->has_config_current_offset_[phase] = true;
|
this->has_config_current_offset_[phase] = true;
|
||||||
}
|
}
|
||||||
void set_active_power_offset(uint8_t phase, int16_t offset) {
|
void set_active_power_offset(uint8_t phase, int16_t offset) {
|
||||||
this->power_offset_phase_[phase].active_power_offset = offset;
|
this->power_offset_phase_[phase].first_offset = offset;
|
||||||
this->has_config_active_power_offset_[phase] = true;
|
this->has_config_active_power_offset_[phase] = true;
|
||||||
}
|
}
|
||||||
void set_reactive_power_offset(uint8_t phase, int16_t offset) {
|
void set_reactive_power_offset(uint8_t phase, int16_t offset) {
|
||||||
this->power_offset_phase_[phase].reactive_power_offset = offset;
|
this->power_offset_phase_[phase].second_offset = offset;
|
||||||
this->has_config_reactive_power_offset_[phase] = true;
|
this->has_config_reactive_power_offset_[phase] = true;
|
||||||
}
|
}
|
||||||
void set_freq_sensor(sensor::Sensor *freq_sensor) { freq_sensor_ = freq_sensor; }
|
void set_freq_sensor(sensor::Sensor *freq_sensor) { freq_sensor_ = freq_sensor; }
|
||||||
@@ -171,16 +205,16 @@ class ATM90E32Component final : public PollingComponent,
|
|||||||
float get_chip_temperature_();
|
float get_chip_temperature_();
|
||||||
bool get_publish_interval_flag_() { return publish_interval_flag_; };
|
bool get_publish_interval_flag_() { return publish_interval_flag_; };
|
||||||
void set_publish_interval_flag_(bool flag) { publish_interval_flag_ = flag; };
|
void set_publish_interval_flag_(bool flag) { publish_interval_flag_ = flag; };
|
||||||
void restore_offset_calibrations_();
|
void restore_offset_calibrations_(OffsetCalibrationType type);
|
||||||
void restore_power_offset_calibrations_();
|
|
||||||
void restore_gain_calibrations_();
|
void restore_gain_calibrations_();
|
||||||
void save_offset_calibration_to_memory_();
|
|
||||||
void save_gain_calibration_to_memory_();
|
void save_gain_calibration_to_memory_();
|
||||||
void save_power_offset_calibration_to_memory_();
|
void finish_offset_calibration_(const OffsetCalibration (&previous)[3], bool previous_restored,
|
||||||
void write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset);
|
bool previous_using_saved, OffsetCalibrationType type);
|
||||||
void write_power_offsets_to_registers_(uint8_t phase, int16_t p_offset, int16_t q_offset);
|
void write_offsets_to_registers_(uint8_t phase, int16_t first_offset, int16_t second_offset,
|
||||||
|
OffsetCalibrationType type);
|
||||||
void write_gains_to_registers_();
|
void write_gains_to_registers_();
|
||||||
bool verify_gain_writes_();
|
bool verify_gain_writes_();
|
||||||
|
bool verify_offset_writes_(OffsetCalibrationType type);
|
||||||
bool validate_spi_read_(uint16_t expected, const char *context = nullptr);
|
bool validate_spi_read_(uint16_t expected, const char *context = nullptr);
|
||||||
void log_calibration_status_();
|
void log_calibration_status_();
|
||||||
const char *get_calibration_id_();
|
const char *get_calibration_id_();
|
||||||
@@ -219,19 +253,10 @@ class ATM90E32Component final : public PollingComponent,
|
|||||||
uint32_t cumulative_reverse_active_energy_{0};
|
uint32_t cumulative_reverse_active_energy_{0};
|
||||||
} phase_[3];
|
} phase_[3];
|
||||||
|
|
||||||
struct OffsetCalibration {
|
OffsetCalibration offset_phase_[3];
|
||||||
int16_t voltage_offset_{0};
|
|
||||||
int16_t current_offset_{0};
|
|
||||||
} offset_phase_[3];
|
|
||||||
|
|
||||||
OffsetCalibration config_offset_phase_[3];
|
OffsetCalibration config_offset_phase_[3];
|
||||||
|
OffsetCalibration power_offset_phase_[3];
|
||||||
struct PowerOffsetCalibration {
|
OffsetCalibration config_power_offset_phase_[3];
|
||||||
int16_t active_power_offset{0};
|
|
||||||
int16_t reactive_power_offset{0};
|
|
||||||
} power_offset_phase_[3];
|
|
||||||
|
|
||||||
PowerOffsetCalibration config_power_offset_phase_[3];
|
|
||||||
|
|
||||||
struct GainCalibration {
|
struct GainCalibration {
|
||||||
uint16_t voltage_gain{1};
|
uint16_t voltage_gain{1};
|
||||||
@@ -265,6 +290,8 @@ class ATM90E32Component final : public PollingComponent,
|
|||||||
bool enable_offset_calibration_{false};
|
bool enable_offset_calibration_{false};
|
||||||
bool enable_gain_calibration_{false};
|
bool enable_gain_calibration_{false};
|
||||||
const char *instance_id_{nullptr};
|
const char *instance_id_{nullptr};
|
||||||
|
bool has_stored_offset_calibration_{false};
|
||||||
|
bool has_stored_power_offset_calibration_{false};
|
||||||
bool restored_offset_calibration_{false};
|
bool restored_offset_calibration_{false};
|
||||||
bool restored_power_offset_calibration_{false};
|
bool restored_power_offset_calibration_{false};
|
||||||
bool restored_gain_calibration_{false};
|
bool restored_gain_calibration_{false};
|
||||||
|
|||||||
@@ -313,9 +313,10 @@ FileDecoderState AudioDecoder::decode_mp3_() {
|
|||||||
this->output_transfer_buffer_->increase_buffer_length(
|
this->output_transfer_buffer_->increase_buffer_length(
|
||||||
this->audio_stream_info_.value().frames_to_bytes(samples_decoded));
|
this->audio_stream_info_.value().frames_to_bytes(samples_decoded));
|
||||||
}
|
}
|
||||||
} else if (result == micro_mp3::MP3_STREAM_INFO_READY) {
|
} else if (result == micro_mp3::MP3_STREAM_INFO_READY || result == micro_mp3::MP3_STREAM_INFO_CHANGED) {
|
||||||
// First successful header parse: capture stream info and resize the output buffer to fit one full frame.
|
// Header parsed: capture stream info and resize the output buffer to fit one full frame.
|
||||||
// microMP3 always outputs 16-bit PCM.
|
// microMP3 always outputs 16-bit PCM. MP3_STREAM_INFO_CHANGED is handled identically: despite its
|
||||||
|
// negative value it is documented as recoverable, so it must not reach the catch-all below.
|
||||||
this->audio_stream_info_ =
|
this->audio_stream_info_ =
|
||||||
audio::AudioStreamInfo(16, this->mp3_decoder_->get_channels(), this->mp3_decoder_->get_sample_rate());
|
audio::AudioStreamInfo(16, this->mp3_decoder_->get_channels(), this->mp3_decoder_->get_sample_rate());
|
||||||
this->free_buffer_required_ =
|
this->free_buffer_required_ =
|
||||||
|
|||||||
@@ -22,6 +22,23 @@ class Automation {
|
|||||||
static const char *const TAG;
|
static const char *const TAG;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// Base for nodes that never read the parent's services.
|
||||||
|
// The parent releases its services only once every node reports Established, so a node that never
|
||||||
|
// reports it keeps that memory allocated for the life of the connection.
|
||||||
|
class BLEClientServicelessNode : public BLEClientNode {
|
||||||
|
public:
|
||||||
|
// Final so that Established is always reported on SEARCH_CMPL, before the derived node sees the event.
|
||||||
|
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) final {
|
||||||
|
if (event == ESP_GATTC_SEARCH_CMPL_EVT)
|
||||||
|
this->node_state = espbt::ClientState::ESTABLISHED;
|
||||||
|
this->on_gattc_event(event, gattc_if, param);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
// Derived nodes handle GATT events here rather than by overriding the handler above.
|
||||||
|
virtual void on_gattc_event(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) {}
|
||||||
|
};
|
||||||
|
|
||||||
// implement on_connect automation.
|
// implement on_connect automation.
|
||||||
class BLEClientConnectTrigger final : public Trigger<>, public BLEClientNode {
|
class BLEClientConnectTrigger final : public Trigger<>, public BLEClientNode {
|
||||||
public:
|
public:
|
||||||
@@ -61,7 +78,7 @@ class BLEClientDisconnectTrigger final : public Trigger<>, public BLEClientNode
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientNode {
|
class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientServicelessNode {
|
||||||
public:
|
public:
|
||||||
explicit BLEClientPasskeyRequestTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
explicit BLEClientPasskeyRequestTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
||||||
void loop() override {}
|
void loop() override {}
|
||||||
@@ -71,7 +88,7 @@ class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientN
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, public BLEClientNode {
|
class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, public BLEClientServicelessNode {
|
||||||
public:
|
public:
|
||||||
explicit BLEClientPasskeyNotificationTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
explicit BLEClientPasskeyNotificationTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
||||||
void loop() override {}
|
void loop() override {}
|
||||||
@@ -82,7 +99,7 @@ class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, publ
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientNumericComparisonRequestTrigger final : public Trigger<uint32_t>, public BLEClientNode {
|
class BLEClientNumericComparisonRequestTrigger final : public Trigger<uint32_t>, public BLEClientServicelessNode {
|
||||||
public:
|
public:
|
||||||
explicit BLEClientNumericComparisonRequestTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
explicit BLEClientNumericComparisonRequestTrigger(BLEClient *parent) { parent->register_ble_node(this); }
|
||||||
void loop() override {}
|
void loop() override {}
|
||||||
@@ -315,19 +332,17 @@ template<typename... Ts> class BLEClientRemoveBondAction final : public Action<T
|
|||||||
BLEClient *parent_{nullptr};
|
BLEClient *parent_{nullptr};
|
||||||
};
|
};
|
||||||
|
|
||||||
template<typename... Ts> class BLEClientConnectAction final : public Action<Ts...>, public BLEClientNode {
|
template<typename... Ts> class BLEClientConnectAction final : public Action<Ts...>, public BLEClientServicelessNode {
|
||||||
public:
|
public:
|
||||||
BLEClientConnectAction(BLEClient *ble_client) {
|
BLEClientConnectAction(BLEClient *ble_client) {
|
||||||
ble_client->register_ble_node(this);
|
ble_client->register_ble_node(this);
|
||||||
ble_client_ = ble_client;
|
ble_client_ = ble_client;
|
||||||
}
|
}
|
||||||
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
|
void on_gattc_event(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override {
|
||||||
esp_ble_gattc_cb_param_t *param) override {
|
|
||||||
if (this->num_running_ == 0)
|
if (this->num_running_ == 0)
|
||||||
return;
|
return;
|
||||||
switch (event) {
|
switch (event) {
|
||||||
case ESP_GATTC_SEARCH_CMPL_EVT:
|
case ESP_GATTC_SEARCH_CMPL_EVT:
|
||||||
this->node_state = espbt::ClientState::ESTABLISHED;
|
|
||||||
this->parent()->run_later([this]() { this->play_next_tuple_(this->var_); });
|
this->parent()->run_later([this]() { this->play_next_tuple_(this->var_); });
|
||||||
break;
|
break;
|
||||||
// if the connection is closed, terminate the automation chain.
|
// if the connection is closed, terminate the automation chain.
|
||||||
@@ -364,14 +379,13 @@ template<typename... Ts> class BLEClientConnectAction final : public Action<Ts..
|
|||||||
std::tuple<Ts...> var_{};
|
std::tuple<Ts...> var_{};
|
||||||
};
|
};
|
||||||
|
|
||||||
template<typename... Ts> class BLEClientDisconnectAction final : public Action<Ts...>, public BLEClientNode {
|
template<typename... Ts> class BLEClientDisconnectAction final : public Action<Ts...>, public BLEClientServicelessNode {
|
||||||
public:
|
public:
|
||||||
BLEClientDisconnectAction(BLEClient *ble_client) {
|
BLEClientDisconnectAction(BLEClient *ble_client) {
|
||||||
ble_client->register_ble_node(this);
|
ble_client->register_ble_node(this);
|
||||||
ble_client_ = ble_client;
|
ble_client_ = ble_client;
|
||||||
}
|
}
|
||||||
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
|
void on_gattc_event(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override {
|
||||||
esp_ble_gattc_cb_param_t *param) override {
|
|
||||||
if (this->num_running_ == 0)
|
if (this->num_running_ == 0)
|
||||||
return;
|
return;
|
||||||
switch (event) {
|
switch (event) {
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ import logging
|
|||||||
import esphome.codegen as cg
|
import esphome.codegen as cg
|
||||||
from esphome.components import web_server_base, wifi
|
from esphome.components import web_server_base, wifi
|
||||||
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
||||||
from esphome.config_helpers import filter_source_files_from_platform
|
|
||||||
import esphome.config_validation as cv
|
import esphome.config_validation as cv
|
||||||
from esphome.const import (
|
from esphome.const import (
|
||||||
CONF_AP,
|
CONF_AP,
|
||||||
@@ -15,7 +14,6 @@ from esphome.const import (
|
|||||||
PLATFORM_LN882X,
|
PLATFORM_LN882X,
|
||||||
PLATFORM_RP2,
|
PLATFORM_RP2,
|
||||||
PLATFORM_RTL87XX,
|
PLATFORM_RTL87XX,
|
||||||
PlatformFramework,
|
|
||||||
)
|
)
|
||||||
from esphome.core import CORE, coroutine_with_priority
|
from esphome.core import CORE, coroutine_with_priority
|
||||||
from esphome.coroutine import CoroPriority
|
from esphome.coroutine import CoroPriority
|
||||||
@@ -76,17 +74,7 @@ def _final_validate(config: ConfigType) -> None:
|
|||||||
"Add 'ap:' to your WiFi configuration to enable the captive portal."
|
"Add 'ap:' to your WiFi configuration to enable the captive portal."
|
||||||
)
|
)
|
||||||
|
|
||||||
# Register socket needs for DNS server and additional HTTP connections
|
web_server_base.consume_captive_dns_sockets(config, "captive_portal")
|
||||||
# - 1 UDP socket for DNS server
|
|
||||||
# - 3 TCP sockets for captive portal detection probes + configuration requests
|
|
||||||
# OS captive portal detection makes multiple probe requests that stay in TIME_WAIT.
|
|
||||||
# Need headroom for actual user configuration requests.
|
|
||||||
# LRU purging will reclaim idle sockets to prevent exhaustion from repeated attempts.
|
|
||||||
# The listening socket is registered by web_server_base (shared HTTP server).
|
|
||||||
from esphome.components import socket
|
|
||||||
|
|
||||||
socket.consume_sockets(3, "captive_portal")(config)
|
|
||||||
socket.consume_sockets(1, "captive_portal", socket.SocketType.UDP)(config)
|
|
||||||
|
|
||||||
|
|
||||||
FINAL_VALIDATE_SCHEMA = _final_validate
|
FINAL_VALIDATE_SCHEMA = _final_validate
|
||||||
@@ -106,16 +94,4 @@ async def to_code(config: ConfigType) -> None:
|
|||||||
if config[CONF_COMPRESSION] == "gzip":
|
if config[CONF_COMPRESSION] == "gzip":
|
||||||
cg.add_define("USE_CAPTIVE_PORTAL_GZIP")
|
cg.add_define("USE_CAPTIVE_PORTAL_GZIP")
|
||||||
|
|
||||||
if CORE.using_arduino and (CORE.is_esp8266 or CORE.is_libretiny or CORE.is_rp2):
|
web_server_base.add_captive_dns_library()
|
||||||
cg.add_library("DNSServer", None)
|
|
||||||
|
|
||||||
|
|
||||||
# Only compile the ESP-IDF DNS server when using ESP-IDF framework
|
|
||||||
FILTER_SOURCE_FILES = filter_source_files_from_platform(
|
|
||||||
{
|
|
||||||
"dns_server_esp32_idf.cpp": {
|
|
||||||
PlatformFramework.ESP32_ARDUINO,
|
|
||||||
PlatformFramework.ESP32_IDF,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -102,17 +102,7 @@ void CaptivePortal::start() {
|
|||||||
this->base_->add_handler_without_auth(this);
|
this->base_->add_handler_without_auth(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
network::IPAddress ip = wifi::global_wifi_component->wifi_soft_ap_ip();
|
this->dns_.start(wifi::global_wifi_component->wifi_soft_ap_ip());
|
||||||
|
|
||||||
#if defined(USE_ESP32)
|
|
||||||
// Create DNS server instance for ESP-IDF
|
|
||||||
this->dns_server_ = make_unique<DNSServer>();
|
|
||||||
this->dns_server_->start(ip);
|
|
||||||
#elif defined(USE_ARDUINO)
|
|
||||||
this->dns_server_ = make_unique<DNSServer>();
|
|
||||||
this->dns_server_->setErrorReplyCode(DNSReplyCode::NoError);
|
|
||||||
this->dns_server_->start(53, ESPHOME_F("*"), ip);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
this->initialized_ = true;
|
this->initialized_ = true;
|
||||||
this->active_ = true;
|
this->active_ = true;
|
||||||
|
|||||||
@@ -1,16 +1,11 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
#include "esphome/core/defines.h"
|
#include "esphome/core/defines.h"
|
||||||
#ifdef USE_CAPTIVE_PORTAL
|
#ifdef USE_CAPTIVE_PORTAL
|
||||||
#include <memory>
|
|
||||||
#if defined(USE_ESP32)
|
|
||||||
#include "dns_server_esp32_idf.h"
|
|
||||||
#elif defined(USE_ARDUINO)
|
|
||||||
#include <DNSServer.h>
|
|
||||||
#endif
|
|
||||||
#include "esphome/core/component.h"
|
#include "esphome/core/component.h"
|
||||||
#include "esphome/core/helpers.h"
|
#include "esphome/core/helpers.h"
|
||||||
#include "esphome/core/preferences.h"
|
#include "esphome/core/preferences.h"
|
||||||
#include "esphome/components/web_server_base/web_server_base.h"
|
#include "esphome/components/web_server_base/web_server_base.h"
|
||||||
|
#include "esphome/components/web_server_base/captive_dns.h"
|
||||||
|
|
||||||
namespace esphome::captive_portal {
|
namespace esphome::captive_portal {
|
||||||
|
|
||||||
@@ -19,17 +14,7 @@ class CaptivePortal final : public AsyncWebHandler, public Component {
|
|||||||
CaptivePortal(web_server_base::WebServerBase *base);
|
CaptivePortal(web_server_base::WebServerBase *base);
|
||||||
void setup() override;
|
void setup() override;
|
||||||
void dump_config() override;
|
void dump_config() override;
|
||||||
void loop() override {
|
void loop() override { this->dns_.loop(); }
|
||||||
#if defined(USE_ESP32)
|
|
||||||
if (this->dns_server_ != nullptr) {
|
|
||||||
this->dns_server_->process_next_request();
|
|
||||||
}
|
|
||||||
#elif defined(USE_ARDUINO)
|
|
||||||
if (this->dns_server_ != nullptr) {
|
|
||||||
this->dns_server_->processNextRequest();
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
float get_setup_priority() const override;
|
float get_setup_priority() const override;
|
||||||
void start();
|
void start();
|
||||||
bool is_active() const { return this->active_; }
|
bool is_active() const { return this->active_; }
|
||||||
@@ -37,10 +22,7 @@ class CaptivePortal final : public AsyncWebHandler, public Component {
|
|||||||
this->active_ = false;
|
this->active_ = false;
|
||||||
this->disable_loop(); // Stop processing DNS requests
|
this->disable_loop(); // Stop processing DNS requests
|
||||||
this->base_->deinit();
|
this->base_->deinit();
|
||||||
if (this->dns_server_ != nullptr) {
|
this->dns_.stop();
|
||||||
this->dns_server_->stop();
|
|
||||||
this->dns_server_ = nullptr;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
bool canHandle(AsyncWebServerRequest *request) const override {
|
bool canHandle(AsyncWebServerRequest *request) const override {
|
||||||
@@ -60,9 +42,7 @@ class CaptivePortal final : public AsyncWebHandler, public Component {
|
|||||||
web_server_base::WebServerBase *base_;
|
web_server_base::WebServerBase *base_;
|
||||||
bool initialized_{false};
|
bool initialized_{false};
|
||||||
bool active_{false};
|
bool active_{false};
|
||||||
#if defined(USE_ARDUINO) || defined(USE_ESP32)
|
web_server_base::CaptiveDNS dns_;
|
||||||
std::unique_ptr<DNSServer> dns_server_{nullptr};
|
|
||||||
#endif
|
|
||||||
};
|
};
|
||||||
|
|
||||||
extern CaptivePortal *global_captive_portal; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
extern CaptivePortal *global_captive_portal; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ namespace esphome::dallas_temp {
|
|||||||
static const char *const TAG = "dallas.temp.sensor";
|
static const char *const TAG = "dallas.temp.sensor";
|
||||||
|
|
||||||
static const uint8_t DALLAS_MODEL_DS18S20 = 0x10;
|
static const uint8_t DALLAS_MODEL_DS18S20 = 0x10;
|
||||||
|
static const uint8_t DALLAS_MODEL_DS18B20 = 0x28;
|
||||||
static const uint8_t DALLAS_COMMAND_START_CONVERSION = 0x44;
|
static const uint8_t DALLAS_COMMAND_START_CONVERSION = 0x44;
|
||||||
static const uint8_t DALLAS_COMMAND_READ_SCRATCH_PAD = 0xBE;
|
static const uint8_t DALLAS_COMMAND_READ_SCRATCH_PAD = 0xBE;
|
||||||
static const uint8_t DALLAS_COMMAND_WRITE_SCRATCH_PAD = 0x4E;
|
static const uint8_t DALLAS_COMMAND_WRITE_SCRATCH_PAD = 0x4E;
|
||||||
@@ -154,7 +155,14 @@ float DallasTemperatureSensor::get_temp_c_() {
|
|||||||
default:
|
default:
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
|
// undocumented test for powerup measurement of 85
|
||||||
|
// https://github.com/cpetrich/counterfeit_DS18B20#solution-to-the-85-c-problem
|
||||||
|
if ((this->address_ & 0xff) == DALLAS_MODEL_DS18B20) {
|
||||||
|
if ((temp == 85 * 16) && (this->scratch_pad_[6] == 0xc)) {
|
||||||
|
ESP_LOGD(TAG, "dropping reading caused by sensor reset");
|
||||||
|
return NAN;
|
||||||
|
}
|
||||||
|
}
|
||||||
return temp / 16.0f;
|
return temp / 16.0f;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -66,11 +66,15 @@ const char *DebugComponent::get_reset_reason_(std::span<char, RESET_REASON_BUFFE
|
|||||||
|
|
||||||
unsigned reason = esp_reset_reason();
|
unsigned reason = esp_reset_reason();
|
||||||
if (reason < sizeof(RESET_REASONS) / sizeof(RESET_REASONS[0])) {
|
if (reason < sizeof(RESET_REASONS) / sizeof(RESET_REASONS[0])) {
|
||||||
if (reason == ESP_RST_SW) {
|
if (reason == ESP_RST_SW || reason == ESP_RST_WDT) {
|
||||||
|
// On some ESP32-S3 configurations (e.g. SPIRAM with fetch-instructions/rodata),
|
||||||
|
// esp_restart() intermittently produces RTCWDT_RTC_RST (ESP_RST_WDT) instead of
|
||||||
|
// ESP_RST_SW. Check the stored reboot source for both reset reasons so a software
|
||||||
|
// reboot that ends up as WDT still reports the correct source.
|
||||||
auto pref = global_preferences->make_preference(REBOOT_MAX_LEN,
|
auto pref = global_preferences->make_preference(REBOOT_MAX_LEN,
|
||||||
fnv1_hash_extend(fnv1_hash(REBOOT_KEY), App.get_name().c_str()));
|
fnv1_hash_extend(fnv1_hash(REBOOT_KEY), App.get_name().c_str()));
|
||||||
char reboot_source[REBOOT_MAX_LEN]{};
|
char reboot_source[REBOOT_MAX_LEN]{};
|
||||||
if (pref.load(&reboot_source)) {
|
if (pref.load(&reboot_source) && reboot_source[0] != '\0') {
|
||||||
reboot_source[REBOOT_MAX_LEN - 1] = '\0';
|
reboot_source[REBOOT_MAX_LEN - 1] = '\0';
|
||||||
snprintf(buf, size, "Reboot request from %s", reboot_source);
|
snprintf(buf, size, "Reboot request from %s", reboot_source);
|
||||||
} else {
|
} else {
|
||||||
|
|||||||
@@ -23,11 +23,7 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.types import ConfigType
|
from esphome.types import ConfigType
|
||||||
|
|
||||||
from . import ( # noqa: F401 pylint: disable=unused-import
|
from . import CONF_DEBUG_ID, FILTER_SOURCE_FILES, DebugComponent # noqa: F401 pylint: disable=unused-import
|
||||||
CONF_DEBUG_ID,
|
|
||||||
FILTER_SOURCE_FILES,
|
|
||||||
DebugComponent,
|
|
||||||
)
|
|
||||||
|
|
||||||
DEPENDENCIES = ["debug"]
|
DEPENDENCIES = ["debug"]
|
||||||
|
|
||||||
|
|||||||
@@ -9,11 +9,7 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.types import ConfigType
|
from esphome.types import ConfigType
|
||||||
|
|
||||||
from . import ( # noqa: F401 pylint: disable=unused-import
|
from . import CONF_DEBUG_ID, FILTER_SOURCE_FILES, DebugComponent # noqa: F401 pylint: disable=unused-import
|
||||||
CONF_DEBUG_ID,
|
|
||||||
FILTER_SOURCE_FILES,
|
|
||||||
DebugComponent,
|
|
||||||
)
|
|
||||||
|
|
||||||
DEPENDENCIES = ["debug"]
|
DEPENDENCIES = ["debug"]
|
||||||
|
|
||||||
|
|||||||
@@ -3,18 +3,11 @@ import esphome.codegen as cg
|
|||||||
# Re-exported for the many esp32-side users; defined in esphome.const
|
# Re-exported for the many esp32-side users; defined in esphome.const
|
||||||
# and esphome.espidf so the upload/logs fast path can use them without
|
# and esphome.espidf so the upload/logs fast path can use them without
|
||||||
# importing this package.
|
# importing this package.
|
||||||
from esphome.const import ( # noqa: F401 # pylint: disable=unused-import
|
from esphome.const import KEY_ESP32, KEY_FLASH_SIZE, KEY_IDF_VERSION, KEY_VARIANT # noqa: F401 # pylint: disable=unused-import
|
||||||
KEY_ESP32,
|
|
||||||
KEY_FLASH_SIZE,
|
|
||||||
KEY_IDF_VERSION,
|
|
||||||
KEY_VARIANT,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Back compat for external components only; in-tree callers import it
|
# Back compat for external components only; in-tree callers import it
|
||||||
# from esphome.espidf directly.
|
# from esphome.espidf directly.
|
||||||
from esphome.espidf import ( # noqa: F401 # pylint: disable=unused-import
|
from esphome.espidf import variant_to_idf_target # noqa: F401 # pylint: disable=unused-import
|
||||||
variant_to_idf_target,
|
|
||||||
)
|
|
||||||
|
|
||||||
KEY_BOARD = "board"
|
KEY_BOARD = "board"
|
||||||
KEY_SDKCONFIG_OPTIONS = "sdkconfig_options"
|
KEY_SDKCONFIG_OPTIONS = "sdkconfig_options"
|
||||||
|
|||||||
@@ -91,7 +91,14 @@ void I2SAudioSpeakerBase::loop() {
|
|||||||
this->speaker_task_handle_ = nullptr;
|
this->speaker_task_handle_ = nullptr;
|
||||||
|
|
||||||
this->stop_i2s_driver_();
|
this->stop_i2s_driver_();
|
||||||
xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ALL_BITS);
|
// ALL_BITS includes COMMAND_START. Take the bits from the clear itself, not from the snapshot at
|
||||||
|
// the top of loop(): the audio source's task can raise a start at any point above, including
|
||||||
|
// during stop_i2s_driver_(), and nothing would ever re-issue it.
|
||||||
|
const EventBits_t bits_before_clear = xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ALL_BITS);
|
||||||
|
if (bits_before_clear & SpeakerEventGroupBits::COMMAND_START) {
|
||||||
|
ESP_LOGD(TAG, "Start requested while stopping; keeping the request");
|
||||||
|
xEventGroupSetBits(this->event_group_, SpeakerEventGroupBits::COMMAND_START);
|
||||||
|
}
|
||||||
this->status_clear_error();
|
this->status_clear_error();
|
||||||
|
|
||||||
this->on_task_stopped();
|
this->on_task_stopped();
|
||||||
|
|||||||
@@ -5,6 +5,7 @@
|
|||||||
#include <esp_log.h>
|
#include <esp_log.h>
|
||||||
|
|
||||||
#include <driver/uart.h>
|
#include <driver/uart.h>
|
||||||
|
#include <soc/soc_caps.h>
|
||||||
|
|
||||||
#ifdef USE_LOGGER_UART_SELECTION_USB_SERIAL_JTAG
|
#ifdef USE_LOGGER_UART_SELECTION_USB_SERIAL_JTAG
|
||||||
#include <driver/usb_serial_jtag.h>
|
#include <driver/usb_serial_jtag.h>
|
||||||
@@ -76,7 +77,11 @@ void init_uart(uart_port_t uart_num, uint32_t baud_rate, int tx_buffer_size) {
|
|||||||
uart_config.parity = UART_PARITY_DISABLE;
|
uart_config.parity = UART_PARITY_DISABLE;
|
||||||
uart_config.stop_bits = UART_STOP_BITS_1;
|
uart_config.stop_bits = UART_STOP_BITS_1;
|
||||||
uart_config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
|
uart_config.flow_ctrl = UART_HW_FLOWCTRL_DISABLE;
|
||||||
|
#if SOC_UART_SUPPORT_XTAL_CLK
|
||||||
|
uart_config.source_clk = UART_SCLK_XTAL;
|
||||||
|
#else
|
||||||
uart_config.source_clk = UART_SCLK_DEFAULT;
|
uart_config.source_clk = UART_SCLK_DEFAULT;
|
||||||
|
#endif
|
||||||
uart_param_config(uart_num, &uart_config);
|
uart_param_config(uart_num, &uart_config);
|
||||||
// The logger only writes to UART, never reads, so use the minimum RX buffer.
|
// The logger only writes to UART, never reads, so use the minimum RX buffer.
|
||||||
// ESP-IDF requires rx_buffer_size > UART_HW_FIFO_LEN (128 bytes).
|
// ESP-IDF requires rx_buffer_size > UART_HW_FIFO_LEN (128 bytes).
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ from ..defines import (
|
|||||||
from ..types import LvCompound, LvType
|
from ..types import LvCompound, LvType
|
||||||
from . import Widget, WidgetType, get_widgets
|
from . import Widget, WidgetType, get_widgets
|
||||||
from .buttonmatrix import CONF_BUTTONMATRIX
|
from .buttonmatrix import CONF_BUTTONMATRIX
|
||||||
|
from .label import CONF_LABEL
|
||||||
from .textarea import CONF_TEXTAREA, lv_textarea_t
|
from .textarea import CONF_TEXTAREA, lv_textarea_t
|
||||||
|
|
||||||
CONF_KEYBOARD = "keyboard"
|
CONF_KEYBOARD = "keyboard"
|
||||||
@@ -49,7 +50,7 @@ class KeyboardType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_KEYBOARD, CONF_TEXTAREA, CONF_BUTTONMATRIX
|
return CONF_KEYBOARD, CONF_TEXTAREA, CONF_BUTTONMATRIX, CONF_LABEL
|
||||||
|
|
||||||
async def to_code(self, w: Widget, config: dict):
|
async def to_code(self, w: Widget, config: dict):
|
||||||
add_lv_use("KEY_LISTENER")
|
add_lv_use("KEY_LISTENER")
|
||||||
|
|||||||
@@ -10,6 +10,7 @@ from ..types import lv_obj_t
|
|||||||
from . import Widget, WidgetType
|
from . import Widget, WidgetType
|
||||||
from .canvas import CONF_CANVAS
|
from .canvas import CONF_CANVAS
|
||||||
from .img import CONF_IMAGE
|
from .img import CONF_IMAGE
|
||||||
|
from .label import CONF_LABEL
|
||||||
|
|
||||||
CONF_QRCODE = "qrcode"
|
CONF_QRCODE = "qrcode"
|
||||||
CONF_DARK_COLOR = "dark_color"
|
CONF_DARK_COLOR = "dark_color"
|
||||||
@@ -41,7 +42,7 @@ class QrCodeType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_CANVAS, CONF_IMAGE
|
return CONF_CANVAS, CONF_IMAGE, CONF_LABEL
|
||||||
|
|
||||||
async def to_code(self, w: Widget, config):
|
async def to_code(self, w: Widget, config):
|
||||||
await w.set_property(
|
await w.set_property(
|
||||||
|
|||||||
@@ -28,6 +28,7 @@ from ..types import LV_EVENT, LvType, ObjUpdateAction, lv_obj_t, lv_obj_t_ptr
|
|||||||
from . import Widget, WidgetType, add_widgets, get_widgets, set_obj_properties
|
from . import Widget, WidgetType, add_widgets, get_widgets, set_obj_properties
|
||||||
from .button import button_spec
|
from .button import button_spec
|
||||||
from .buttonmatrix import CONF_BUTTONMATRIX, buttonmatrix_spec
|
from .buttonmatrix import CONF_BUTTONMATRIX, buttonmatrix_spec
|
||||||
|
from .label import CONF_LABEL
|
||||||
from .obj import obj_spec
|
from .obj import obj_spec
|
||||||
|
|
||||||
CONF_TABVIEW = "tabview"
|
CONF_TABVIEW = "tabview"
|
||||||
@@ -74,7 +75,7 @@ class TabviewType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_BUTTONMATRIX, TYPE_FLEX, CONF_BUTTON
|
return CONF_BUTTONMATRIX, TYPE_FLEX, CONF_BUTTON, CONF_LABEL
|
||||||
|
|
||||||
async def to_code(self, w: Widget, config: dict):
|
async def to_code(self, w: Widget, config: dict):
|
||||||
await w.set_property(
|
await w.set_property(
|
||||||
|
|||||||
@@ -67,6 +67,9 @@ void MQTTJSONLightComponent::send_discovery(JsonObject root, mqtt::SendDiscovery
|
|||||||
if (traits.supports_color_mode(ColorMode::RGB_COLD_WARM_WHITE))
|
if (traits.supports_color_mode(ColorMode::RGB_COLD_WARM_WHITE))
|
||||||
color_modes.add(ESPHOME_F("rgbww"));
|
color_modes.add(ESPHOME_F("rgbww"));
|
||||||
|
|
||||||
|
if (traits.supports_color_capability(ColorCapability::BRIGHTNESS))
|
||||||
|
root[ESPHOME_F("brightness")] = true;
|
||||||
|
|
||||||
if (traits.supports_color_mode(ColorMode::COLOR_TEMPERATURE) ||
|
if (traits.supports_color_mode(ColorMode::COLOR_TEMPERATURE) ||
|
||||||
traits.supports_color_mode(ColorMode::COLD_WARM_WHITE)) {
|
traits.supports_color_mode(ColorMode::COLD_WARM_WHITE)) {
|
||||||
root[MQTT_MIN_MIREDS] = traits.get_min_mireds();
|
root[MQTT_MIN_MIREDS] = traits.get_min_mireds();
|
||||||
|
|||||||
@@ -14,12 +14,7 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.core import CORE, TimePeriod
|
from esphome.core import CORE, TimePeriod
|
||||||
|
|
||||||
from . import ( # noqa: F401 pylint: disable=unused-import
|
from . import FILTER_SOURCE_FILES, Nextion, nextion_ns, nextion_ref # noqa: F401 pylint: disable=unused-import
|
||||||
FILTER_SOURCE_FILES,
|
|
||||||
Nextion,
|
|
||||||
nextion_ns,
|
|
||||||
nextion_ref,
|
|
||||||
)
|
|
||||||
from .base_component import (
|
from .base_component import (
|
||||||
CONF_AUTO_WAKE_ON_TOUCH,
|
CONF_AUTO_WAKE_ON_TOUCH,
|
||||||
CONF_COMMAND_SPACING,
|
CONF_COMMAND_SPACING,
|
||||||
|
|||||||
@@ -18,6 +18,16 @@ void RFBridgeComponent::ack_() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
bool RFBridgeComponent::parse_bridge_byte_(uint8_t byte) {
|
bool RFBridgeComponent::parse_bridge_byte_(uint8_t byte) {
|
||||||
|
if (this->bucket_frame_candidate_ && byte == RF_CODE_START) {
|
||||||
|
// A queued next frame proves the trailing 0x55 really was the bucket
|
||||||
|
// frame's terminator: Portisch builds pulse entries from alternating
|
||||||
|
// signal edges, so the two level bits inside one pulse byte are always
|
||||||
|
// opposite — 0xAA (two high-level nibbles) cannot occur in pulse data.
|
||||||
|
// Finalize before this byte starts the new frame, so back-to-back
|
||||||
|
// deliveries are split even when loop() never observed a quiet gap
|
||||||
|
// between them.
|
||||||
|
this->finish_bucket_frame_();
|
||||||
|
}
|
||||||
size_t at = this->rx_buffer_.size();
|
size_t at = this->rx_buffer_.size();
|
||||||
this->rx_buffer_.push_back(byte);
|
this->rx_buffer_.push_back(byte);
|
||||||
const uint8_t *raw = &this->rx_buffer_[0];
|
const uint8_t *raw = &this->rx_buffer_[0];
|
||||||
@@ -84,26 +94,21 @@ bool RFBridgeComponent::parse_bridge_byte_(uint8_t byte) {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case RF_CODE_RFIN_BUCKET: {
|
case RF_CODE_RFIN_BUCKET: {
|
||||||
if (byte != RF_CODE_STOP) {
|
if (at == 2) {
|
||||||
return true;
|
// The count byte: Portisch sends at most 7 buckets + sync, so 0 or
|
||||||
|
// >8 cannot be a genuine capture — reject before it can occupy the
|
||||||
|
// buffer for a full frame timeout.
|
||||||
|
return byte != 0 && byte <= B1_MAX_BUCKET_COUNT;
|
||||||
}
|
}
|
||||||
|
// 0x55 is legal DATA inside a B1 frame: bucket durations are sent
|
||||||
uint8_t buckets = raw[2] << 1;
|
// with only their HIGH byte masked to 7 bits, so a duration such as
|
||||||
std::string str;
|
// 0x0155 puts a raw 0x55 low byte inside the table — the first 0x55
|
||||||
char next_byte[3]; // 2 hex chars + null
|
// must therefore not end the capture. The header declares the table
|
||||||
|
// length (raw[2] pairs), so a 0x55 there is always data; one at or
|
||||||
for (uint32_t i = 0; i <= at; i++) {
|
// past the first pulse index is a terminator CANDIDATE, confirmed
|
||||||
buf_append_printf(next_byte, sizeof(next_byte), 0, "%02X", raw[i]);
|
// once the UART goes quiet (finish_bucket_frame_ in loop()).
|
||||||
str += next_byte;
|
this->bucket_frame_candidate_ = byte == RF_CODE_STOP && at >= 3 + static_cast<size_t>(raw[2]) * 2;
|
||||||
if ((i > 3) && buckets) {
|
return true;
|
||||||
buckets--;
|
|
||||||
}
|
|
||||||
if ((i < 3) || (buckets % 2) || (i == at - 1)) {
|
|
||||||
str += " ";
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ESP_LOGI(TAG, "Received RFBridge Bucket: %s", str.c_str());
|
|
||||||
break;
|
|
||||||
}
|
}
|
||||||
default:
|
default:
|
||||||
ESP_LOGW(TAG, "Unknown action: 0x%02X", action);
|
ESP_LOGW(TAG, "Unknown action: 0x%02X", action);
|
||||||
@@ -119,6 +124,47 @@ bool RFBridgeComponent::parse_bridge_byte_(uint8_t byte) {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
void RFBridgeComponent::finish_bucket_frame_() {
|
||||||
|
if (this->rx_buffer_.size() < 4) {
|
||||||
|
// The candidate flag requires a header + non-empty bucket table, so
|
||||||
|
// this cannot happen while flag and buffer stay consistent; guard the
|
||||||
|
// raw[2] / size-1 reads against any future divergence anyway.
|
||||||
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const uint8_t *raw = this->rx_buffer_.data();
|
||||||
|
const size_t at = this->rx_buffer_.size() - 1;
|
||||||
|
|
||||||
|
uint8_t buckets = raw[2] << 1;
|
||||||
|
std::string str;
|
||||||
|
char next_byte[3]; // 2 hex chars + null
|
||||||
|
|
||||||
|
for (uint32_t i = 0; i <= at; i++) {
|
||||||
|
buf_append_printf(next_byte, sizeof(next_byte), 0, "%02X", raw[i]);
|
||||||
|
str += next_byte;
|
||||||
|
if ((i > 3) && buckets) {
|
||||||
|
buckets--;
|
||||||
|
}
|
||||||
|
if ((i < 3) || (buckets % 2) || (i == at - 1)) {
|
||||||
|
str += " ";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
ESP_LOGI(TAG, "Received RFBridge Bucket: %s", str.c_str());
|
||||||
|
|
||||||
|
// Deliberately NOT ACKed: Portisch's B1 command handler leaves its
|
||||||
|
// last_sniffing_command at the previous mode (RF_CODE_RFIN), and its
|
||||||
|
// host-ACK handler re-arms sniffing from that stale value — so ACKing a
|
||||||
|
// bucket delivery silently reverts the radio to standard sniffing and
|
||||||
|
// ends bucket capture. Its delivery path is fire-and-forget and never
|
||||||
|
// waits for a host ACK. Stock Itead firmware never sends B1 frames, so
|
||||||
|
// suppressing this ACK cannot change stock-firmware behavior.
|
||||||
|
// https://github.com/esphome/esphome/issues/17682
|
||||||
|
|
||||||
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
|
}
|
||||||
|
|
||||||
void RFBridgeComponent::write_byte_str_(const std::string &codes) {
|
void RFBridgeComponent::write_byte_str_(const std::string &codes) {
|
||||||
uint8_t code;
|
uint8_t code;
|
||||||
int size = codes.length();
|
int size = codes.length();
|
||||||
@@ -130,12 +176,31 @@ void RFBridgeComponent::write_byte_str_(const std::string &codes) {
|
|||||||
|
|
||||||
void RFBridgeComponent::loop() {
|
void RFBridgeComponent::loop() {
|
||||||
const uint32_t now = App.get_loop_component_start_time();
|
const uint32_t now = App.get_loop_component_start_time();
|
||||||
if (now - this->last_bridge_byte_ > 50) {
|
size_t avail = this->available();
|
||||||
|
if (avail == 0 && this->bucket_frame_candidate_ && now - this->last_bridge_byte_ > BUCKET_CANDIDATE_QUIET_MS) {
|
||||||
|
// The trailing 0x55 was followed by UART quiet, so it really was the
|
||||||
|
// frame terminator and not an interior data byte.
|
||||||
|
this->finish_bucket_frame_();
|
||||||
|
this->last_bridge_byte_ = now;
|
||||||
|
}
|
||||||
|
const bool receiving_bucket = this->rx_buffer_.size() >= 2 && this->rx_buffer_[1] == RF_CODE_RFIN_BUCKET;
|
||||||
|
if (receiving_bucket) {
|
||||||
|
// Never declare an in-progress bucket frame dead while its continuation
|
||||||
|
// bytes are already queued: a stalled loop() otherwise discards a live
|
||||||
|
// frame that the UART buffer proves is still arriving.
|
||||||
|
if (avail == 0 && now - this->last_bridge_byte_ > BUCKET_FRAME_TIMEOUT_MS) {
|
||||||
|
ESP_LOGD(TAG, "Discarding incomplete RFBridge Bucket frame (%u bytes)",
|
||||||
|
static_cast<unsigned>(this->rx_buffer_.size()));
|
||||||
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
|
this->last_bridge_byte_ = now;
|
||||||
|
}
|
||||||
|
} else if (now - this->last_bridge_byte_ > 50) {
|
||||||
this->rx_buffer_.clear();
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
this->last_bridge_byte_ = now;
|
this->last_bridge_byte_ = now;
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t avail = this->available();
|
|
||||||
while (avail > 0) {
|
while (avail > 0) {
|
||||||
uint8_t buf[64];
|
uint8_t buf[64];
|
||||||
size_t to_read = std::min(avail, sizeof(buf));
|
size_t to_read = std::min(avail, sizeof(buf));
|
||||||
@@ -146,12 +211,14 @@ void RFBridgeComponent::loop() {
|
|||||||
for (size_t i = 0; i < to_read; i++) {
|
for (size_t i = 0; i < to_read; i++) {
|
||||||
if (this->rx_buffer_.size() > MAX_RX_BUFFER_SIZE) {
|
if (this->rx_buffer_.size() > MAX_RX_BUFFER_SIZE) {
|
||||||
this->rx_buffer_.clear();
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
}
|
}
|
||||||
if (this->parse_bridge_byte_(buf[i])) {
|
if (this->parse_bridge_byte_(buf[i])) {
|
||||||
ESP_LOGVV(TAG, "Parsed: 0x%02X", buf[i]);
|
ESP_LOGVV(TAG, "Parsed: 0x%02X", buf[i]);
|
||||||
this->last_bridge_byte_ = now;
|
this->last_bridge_byte_ = now;
|
||||||
} else {
|
} else {
|
||||||
this->rx_buffer_.clear();
|
this->rx_buffer_.clear();
|
||||||
|
this->bucket_frame_candidate_ = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -30,6 +30,17 @@ static const uint8_t RF_CODE_BEEP = 0xC0;
|
|||||||
static const uint8_t RF_CODE_STOP = 0x55;
|
static const uint8_t RF_CODE_STOP = 0x55;
|
||||||
static const uint8_t RF_DEBOUNCE = 200;
|
static const uint8_t RF_DEBOUNCE = 200;
|
||||||
static const size_t MAX_RX_BUFFER_SIZE = 512;
|
static const size_t MAX_RX_BUFFER_SIZE = 512;
|
||||||
|
// ~10 byte times at 19200 baud: long enough to prove the UART went quiet
|
||||||
|
// after a possible bucket-frame terminator, short enough to finish well
|
||||||
|
// before the next radio capture can be delivered.
|
||||||
|
static const uint32_t BUCKET_CANDIDATE_QUIET_MS = 5;
|
||||||
|
// Portisch drains a B1 frame's header, bucket table, and pulse data as
|
||||||
|
// separate UART writes, so an in-progress bucket frame tolerates a longer
|
||||||
|
// inter-region gap than the generic 50 ms inter-byte timeout.
|
||||||
|
static const uint32_t BUCKET_FRAME_TIMEOUT_MS = 250;
|
||||||
|
// Portisch's uart_put_RF_buckets sends at most 7 buckets plus the sync
|
||||||
|
// bucket, so a B1 count byte above 8 (or 0) is malformed for any protocol.
|
||||||
|
static const uint8_t B1_MAX_BUCKET_COUNT = 8;
|
||||||
|
|
||||||
struct RFBridgeData {
|
struct RFBridgeData {
|
||||||
uint16_t sync;
|
uint16_t sync;
|
||||||
@@ -67,10 +78,12 @@ class RFBridgeComponent final : public uart::UARTDevice, public Component {
|
|||||||
void ack_();
|
void ack_();
|
||||||
void decode_();
|
void decode_();
|
||||||
bool parse_bridge_byte_(uint8_t byte);
|
bool parse_bridge_byte_(uint8_t byte);
|
||||||
|
void finish_bucket_frame_();
|
||||||
void write_byte_str_(const std::string &codes);
|
void write_byte_str_(const std::string &codes);
|
||||||
|
|
||||||
std::vector<uint8_t> rx_buffer_;
|
std::vector<uint8_t> rx_buffer_;
|
||||||
uint32_t last_bridge_byte_{0};
|
uint32_t last_bridge_byte_{0};
|
||||||
|
bool bucket_frame_candidate_{false};
|
||||||
|
|
||||||
CallbackManager<void(RFBridgeData)> data_callback_;
|
CallbackManager<void(RFBridgeData)> data_callback_;
|
||||||
CallbackManager<void(RFBridgeAdvancedData)> advanced_data_callback_;
|
CallbackManager<void(RFBridgeAdvancedData)> advanced_data_callback_;
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
#include "tuya.h"
|
#include "tuya.h"
|
||||||
#include "esphome/components/network/util.h"
|
|
||||||
#include "esphome/core/gpio.h"
|
#include "esphome/core/gpio.h"
|
||||||
#include "esphome/core/helpers.h"
|
#include "esphome/core/helpers.h"
|
||||||
#include "esphome/core/log.h"
|
#include "esphome/core/log.h"
|
||||||
#include "esphome/core/util.h"
|
#include "esphome/core/util.h"
|
||||||
|
|
||||||
|
#ifdef USE_NETWORK
|
||||||
|
#include "esphome/components/network/util.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifdef USE_WIFI
|
#ifdef USE_WIFI
|
||||||
#include "esphome/components/wifi/wifi_component.h"
|
#include "esphome/components/wifi/wifi_component.h"
|
||||||
#endif
|
#endif
|
||||||
@@ -22,6 +25,14 @@ static const int MAX_RETRIES = 5;
|
|||||||
// Max bytes to log for datapoint values (larger values are truncated)
|
// Max bytes to log for datapoint values (larger values are truncated)
|
||||||
static constexpr size_t MAX_DATAPOINT_LOG_BYTES = 16;
|
static constexpr size_t MAX_DATAPOINT_LOG_BYTES = 16;
|
||||||
|
|
||||||
|
static bool network_is_connected() {
|
||||||
|
#ifdef USE_NETWORK
|
||||||
|
return network::is_connected();
|
||||||
|
#else
|
||||||
|
return false;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
void Tuya::setup() {
|
void Tuya::setup() {
|
||||||
this->set_interval("heartbeat", 15000, [this] { this->send_empty_command_(TuyaCommandType::HEARTBEAT); });
|
this->set_interval("heartbeat", 15000, [this] { this->send_empty_command_(TuyaCommandType::HEARTBEAT); });
|
||||||
if (this->status_pin_ != nullptr) {
|
if (this->status_pin_ != nullptr) {
|
||||||
@@ -554,14 +565,14 @@ void Tuya::send_empty_command_(TuyaCommandType command) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
void Tuya::set_status_pin_() {
|
void Tuya::set_status_pin_() {
|
||||||
bool is_network_ready = network::is_connected() && remote_is_connected();
|
bool is_network_ready = network_is_connected() && remote_is_connected();
|
||||||
this->status_pin_->digital_write(is_network_ready);
|
this->status_pin_->digital_write(is_network_ready);
|
||||||
}
|
}
|
||||||
|
|
||||||
uint8_t Tuya::get_wifi_status_code_() {
|
uint8_t Tuya::get_wifi_status_code_() {
|
||||||
uint8_t status = 0x02;
|
uint8_t status = 0x02;
|
||||||
|
|
||||||
if (network::is_connected()) {
|
if (network_is_connected()) {
|
||||||
status = 0x03;
|
status = 0x03;
|
||||||
|
|
||||||
// Protocol version 3 also supports specifying when connected to "the cloud"
|
// Protocol version 3 also supports specifying when connected to "the cloud"
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
from collections.abc import Callable
|
from typing import Any
|
||||||
from typing import Any, NoReturn
|
|
||||||
|
|
||||||
from esphome import automation
|
from esphome import automation
|
||||||
from esphome.automation import Trigger
|
from esphome.automation import Trigger
|
||||||
@@ -48,17 +47,10 @@ UDP_SCHEMA = cv.Schema(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def is_relocated(option: str) -> Callable[[Any], NoReturn]:
|
|
||||||
def validator(value: Any) -> NoReturn:
|
|
||||||
raise cv.Invalid(
|
|
||||||
f"The '{option}' option should now be configured in the 'packet_transport' component"
|
|
||||||
)
|
|
||||||
|
|
||||||
return validator
|
|
||||||
|
|
||||||
|
|
||||||
RELOCATED = {
|
RELOCATED = {
|
||||||
cv.Optional(x): is_relocated(x)
|
cv.Optional(x): cv.invalid(
|
||||||
|
f"The '{x}' option should now be configured in the 'packet_transport' component"
|
||||||
|
)
|
||||||
for x in (
|
for x in (
|
||||||
CONF_PROVIDERS,
|
CONF_PROVIDERS,
|
||||||
CONF_ENCRYPTION,
|
CONF_ENCRYPTION,
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ from esphome.components.logger import request_log_listener
|
|||||||
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
from esphome.components.web_server_base import CONF_WEB_SERVER_BASE_ID
|
||||||
import esphome.config_validation as cv
|
import esphome.config_validation as cv
|
||||||
from esphome.const import (
|
from esphome.const import (
|
||||||
|
CONF_AP,
|
||||||
CONF_AUTH,
|
CONF_AUTH,
|
||||||
CONF_COMPRESSION,
|
CONF_COMPRESSION,
|
||||||
CONF_CSS_INCLUDE,
|
CONF_CSS_INCLUDE,
|
||||||
@@ -23,15 +24,19 @@ from esphome.const import (
|
|||||||
CONF_JS_URL,
|
CONF_JS_URL,
|
||||||
CONF_LOCAL,
|
CONF_LOCAL,
|
||||||
CONF_LOG,
|
CONF_LOG,
|
||||||
|
CONF_MANUAL_IP,
|
||||||
CONF_NAME,
|
CONF_NAME,
|
||||||
|
CONF_NETWORKS,
|
||||||
CONF_OTA,
|
CONF_OTA,
|
||||||
CONF_PASSWORD,
|
CONF_PASSWORD,
|
||||||
CONF_PORT,
|
CONF_PORT,
|
||||||
|
CONF_STATIC_IP,
|
||||||
CONF_TYPE,
|
CONF_TYPE,
|
||||||
CONF_USERNAME,
|
CONF_USERNAME,
|
||||||
CONF_VERSION,
|
CONF_VERSION,
|
||||||
CONF_WEB_SERVER,
|
CONF_WEB_SERVER,
|
||||||
CONF_WEB_SERVER_ID,
|
CONF_WEB_SERVER_ID,
|
||||||
|
CONF_WIFI,
|
||||||
PLATFORM_BK72XX,
|
PLATFORM_BK72XX,
|
||||||
PLATFORM_ESP32,
|
PLATFORM_ESP32,
|
||||||
PLATFORM_ESP8266,
|
PLATFORM_ESP8266,
|
||||||
@@ -46,7 +51,23 @@ from esphome.types import ConfigType
|
|||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
AUTO_LOAD = ["json", "web_server_base"]
|
|
||||||
|
def AUTO_LOAD() -> list[str]:
|
||||||
|
# No config parameter on purpose: that would make this a late (dynamic) auto-load and
|
||||||
|
# ota.web_server's dependency on web_server_base would not be satisfied in time.
|
||||||
|
auto_load = ["json", "web_server_base"]
|
||||||
|
# The AP mode DNS server (web_server_base/dns_server_esp32_idf) uses socket; only
|
||||||
|
# configs with a WiFi access point can end up in AP mode. CORE.raw_config is set
|
||||||
|
# after package merging, so a wifi block from a package is visible here.
|
||||||
|
wifi = CORE.raw_config.get(CONF_WIFI) if CORE.raw_config else None
|
||||||
|
if (
|
||||||
|
CORE.is_esp32
|
||||||
|
and wifi is not None
|
||||||
|
and (not isinstance(wifi, dict) or CONF_AP in wifi)
|
||||||
|
):
|
||||||
|
auto_load.append("socket")
|
||||||
|
return auto_load
|
||||||
|
|
||||||
|
|
||||||
AUTH_TYPE_BASIC = "basic"
|
AUTH_TYPE_BASIC = "basic"
|
||||||
AUTH_TYPE_DIGEST = "digest"
|
AUTH_TYPE_DIGEST = "digest"
|
||||||
@@ -205,9 +226,6 @@ def _final_validate_sorting(config: ConfigType) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
FINAL_VALIDATE_SCHEMA = _final_validate_sorting
|
|
||||||
|
|
||||||
|
|
||||||
def _consume_web_server_sockets(config: ConfigType) -> ConfigType:
|
def _consume_web_server_sockets(config: ConfigType) -> ConfigType:
|
||||||
"""Register socket needs for web_server component."""
|
"""Register socket needs for web_server component."""
|
||||||
from esphome.components import socket
|
from esphome.components import socket
|
||||||
@@ -334,6 +352,95 @@ async def add_entity_config(entity: MockObj, config: ConfigType) -> None:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def wifi_is_ap_only(wifi_config: ConfigType | None) -> bool:
|
||||||
|
"""AP only: an access point and no network to join, so the device is only ever reached
|
||||||
|
through its own AP."""
|
||||||
|
return (
|
||||||
|
wifi_config is not None
|
||||||
|
and CONF_AP in wifi_config
|
||||||
|
and not wifi_config.get(CONF_NETWORKS)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def serve_local(config: ConfigType, wifi_config: ConfigType | None) -> bool:
|
||||||
|
"""Embed the interface unless ``local:`` says otherwise; AP only WiFi has no internet
|
||||||
|
for the hosted page. Version 1 has no local mode."""
|
||||||
|
if (local := config.get(CONF_LOCAL)) is not None:
|
||||||
|
return local
|
||||||
|
return config[CONF_VERSION] != 1 and wifi_is_ap_only(wifi_config)
|
||||||
|
|
||||||
|
|
||||||
|
def serve_captive(config: ConfigType, full_config: ConfigType) -> bool:
|
||||||
|
"""web_server runs its own captive portal while the AP is up: embedded interface plus
|
||||||
|
an access point, unless captive_portal (which owns that role) is configured. Only on
|
||||||
|
port 80: the OS captive portal probes and the DHCP portal URI always use port 80, so
|
||||||
|
a portal on another port could never be discovered."""
|
||||||
|
wifi_config = full_config.get(CONF_WIFI)
|
||||||
|
return (
|
||||||
|
"captive_portal" not in full_config
|
||||||
|
and config[CONF_PORT] == 80
|
||||||
|
and wifi_config is not None
|
||||||
|
and CONF_AP in wifi_config
|
||||||
|
and serve_local(config, wifi_config)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _final_validate_ap_mode(config: ConfigType) -> None:
|
||||||
|
full_config = fv.full_config.get()
|
||||||
|
wifi_config = full_config.get(CONF_WIFI)
|
||||||
|
captive = serve_captive(config, full_config)
|
||||||
|
local = serve_local(config, wifi_config)
|
||||||
|
if captive:
|
||||||
|
web_server_base.consume_captive_dns_sockets(config, "web_server")
|
||||||
|
# Surface behavior that the config does not spell out.
|
||||||
|
if local and CONF_LOCAL not in config:
|
||||||
|
_LOGGER.info(
|
||||||
|
"WiFi is AP only: embedding the web interface in the firmware "
|
||||||
|
"(local: true, roughly 13 KB of flash for version 2, 78 KB for version 3)%s. "
|
||||||
|
"Set 'local: false' to load it from the internet instead.",
|
||||||
|
" and serving it as a captive portal on the access point"
|
||||||
|
if captive
|
||||||
|
else "",
|
||||||
|
)
|
||||||
|
elif captive:
|
||||||
|
_LOGGER.info(
|
||||||
|
"web_server will act as a captive portal while the %saccess point is active.",
|
||||||
|
"" if wifi_is_ap_only(wifi_config) else "fallback ",
|
||||||
|
)
|
||||||
|
if not wifi_is_ap_only(wifi_config):
|
||||||
|
return
|
||||||
|
if not local:
|
||||||
|
_LOGGER.warning(
|
||||||
|
"WiFi is AP only and the web_server interface is loaded from the internet, "
|
||||||
|
"which browsers on the access point usually cannot reach; the page stays "
|
||||||
|
"blank. %s so the interface is embedded in the firmware.",
|
||||||
|
"Remove 'local: false'"
|
||||||
|
if config.get(CONF_LOCAL) is False
|
||||||
|
else "Migrate to version 2 or 3",
|
||||||
|
)
|
||||||
|
elif config[CONF_PORT] != 80:
|
||||||
|
ap_ip = "192.168.4.1"
|
||||||
|
if (manual_ip := wifi_config[CONF_AP].get(CONF_MANUAL_IP)) is not None:
|
||||||
|
ap_ip = str(manual_ip[CONF_STATIC_IP])
|
||||||
|
_LOGGER.warning(
|
||||||
|
"WiFi is AP only and web_server uses port %d. The interface cannot open "
|
||||||
|
"automatically on the access point (captive portal detection only works on "
|
||||||
|
"port 80); open http://%s:%d/ manually, or remove 'port:' to use 80.",
|
||||||
|
config[CONF_PORT],
|
||||||
|
ap_ip,
|
||||||
|
config[CONF_PORT],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _final_validate(config: ConfigType) -> None:
|
||||||
|
# Called one after the other rather than via cv.All: these return None.
|
||||||
|
_final_validate_sorting(config)
|
||||||
|
_final_validate_ap_mode(config)
|
||||||
|
|
||||||
|
|
||||||
|
FINAL_VALIDATE_SCHEMA = _final_validate
|
||||||
|
|
||||||
|
|
||||||
def build_index_html(config: ConfigType) -> str:
|
def build_index_html(config: ConfigType) -> str:
|
||||||
html = "<!DOCTYPE html><html><head><meta charset=UTF-8><link rel=icon href=data:>"
|
html = "<!DOCTYPE html><html><head><meta charset=UTF-8><link rel=icon href=data:>"
|
||||||
css_include = config.get(CONF_CSS_INCLUDE)
|
css_include = config.get(CONF_CSS_INCLUDE)
|
||||||
@@ -434,8 +541,12 @@ async def to_code(config: ConfigType) -> None:
|
|||||||
with path.open(encoding="utf-8") as js_file:
|
with path.open(encoding="utf-8") as js_file:
|
||||||
add_resource_as_progmem("JS_INCLUDE", js_file.read())
|
add_resource_as_progmem("JS_INCLUDE", js_file.read())
|
||||||
cg.add(var.set_include_internal(config[CONF_INCLUDE_INTERNAL]))
|
cg.add(var.set_include_internal(config[CONF_INCLUDE_INTERNAL]))
|
||||||
if CONF_LOCAL in config and config[CONF_LOCAL]:
|
if serve_local(config, CORE.config.get(CONF_WIFI)):
|
||||||
cg.add_define("USE_WEBSERVER_LOCAL")
|
cg.add_define("USE_WEBSERVER_LOCAL")
|
||||||
|
if serve_captive(config, CORE.config):
|
||||||
|
# AP mode: DNS server plus redirect of unknown URLs so phones open the interface
|
||||||
|
cg.add_define("USE_WEBSERVER_CAPTIVE")
|
||||||
|
web_server_base.add_captive_dns_library()
|
||||||
if config[CONF_COMPRESSION] == "gzip":
|
if config[CONF_COMPRESSION] == "gzip":
|
||||||
cg.add_define("USE_WEBSERVER_GZIP")
|
cg.add_define("USE_WEBSERVER_GZIP")
|
||||||
|
|
||||||
|
|||||||
@@ -44,6 +44,10 @@
|
|||||||
#include "esphome/components/radio_frequency/radio_frequency.h"
|
#include "esphome/components/radio_frequency/radio_frequency.h"
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
#include "esphome/components/wifi/wifi_component.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifdef USE_WEBSERVER_LOCAL
|
#ifdef USE_WEBSERVER_LOCAL
|
||||||
#if USE_WEBSERVER_VERSION == 2
|
#if USE_WEBSERVER_VERSION == 2
|
||||||
#include "server_index_v2.h"
|
#include "server_index_v2.h"
|
||||||
@@ -334,7 +338,15 @@ void DeferredUpdateEventSourceList::on_client_disconnect_(DeferredUpdateEventSou
|
|||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
WebServer::WebServer(web_server_base::WebServerBase *base) : base_(base) {}
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
WebServer *global_web_server = nullptr; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||||||
|
#endif
|
||||||
|
|
||||||
|
WebServer::WebServer(web_server_base::WebServerBase *base) : base_(base) {
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
global_web_server = this;
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
#ifdef USE_WEBSERVER_CSS_INCLUDE
|
#ifdef USE_WEBSERVER_CSS_INCLUDE
|
||||||
void WebServer::set_css_include(const char *css_include) { this->css_include_ = css_include; }
|
void WebServer::set_css_include(const char *css_include) { this->css_include_ = css_include; }
|
||||||
@@ -380,6 +392,11 @@ void WebServer::setup() {
|
|||||||
this->base_->add_handler(&this->events_);
|
this->base_->add_handler(&this->events_);
|
||||||
#endif
|
#endif
|
||||||
this->base_->add_handler(this);
|
this->base_->add_handler(this);
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
// Not-found fallback (outside the auth middleware): the OS captive portal probes hit
|
||||||
|
// arbitrary URLs and must get the redirect without credentials.
|
||||||
|
this->base_->get_server()->onNotFound([this](AsyncWebServerRequest *request) { this->handle_not_found_(request); });
|
||||||
|
#endif
|
||||||
|
|
||||||
// OTA is now handled by the web_server OTA platform
|
// OTA is now handled by the web_server OTA platform
|
||||||
|
|
||||||
@@ -395,16 +412,52 @@ void WebServer::setup() {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
void WebServer::loop() {
|
void WebServer::loop() {
|
||||||
// No SSE clients connected; stop looping until a new client connects via
|
bool keep_looping = this->events_.loop();
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
this->dns_.loop();
|
||||||
|
keep_looping |= this->dns_.is_running();
|
||||||
|
#endif
|
||||||
|
// No SSE clients connected (and no captive DNS to serve); stop looping until a new client connects via
|
||||||
// enable_loop_soon_any_context(). This is safe because:
|
// enable_loop_soon_any_context(). This is safe because:
|
||||||
// - set_interval/set_timeout/defer run via the Scheduler, independent of loop()
|
// - set_interval/set_timeout/defer run via the Scheduler, independent of loop()
|
||||||
// - deferrable_send_state early-outs when no clients are connected
|
// - deferrable_send_state early-outs when no clients are connected
|
||||||
// - try_send_nodefer (log, ping) iterates sessions which are empty
|
// - try_send_nodefer (log, ping) iterates sessions which are empty
|
||||||
// - REST API handlers use defer() which runs via the Scheduler
|
// - REST API handlers use defer() which runs via the Scheduler
|
||||||
if (!this->events_.loop())
|
if (!keep_looping)
|
||||||
this->disable_loop();
|
this->disable_loop();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
void WebServer::start_captive() {
|
||||||
|
// CaptiveDNS::start() no-ops too; this guard just avoids repeating the log and enable_loop
|
||||||
|
if (this->dns_.is_running())
|
||||||
|
return;
|
||||||
|
network::IPAddress ip = wifi::global_wifi_component->wifi_soft_ap_ip();
|
||||||
|
this->dns_.start(ip);
|
||||||
|
this->enable_loop();
|
||||||
|
char ip_buf[network::IP_ADDRESS_BUFFER_SIZE];
|
||||||
|
ESP_LOGI(TAG, "AP mode: serving the web interface as captive portal at http://%s/", ip.str_to(ip_buf));
|
||||||
|
}
|
||||||
|
|
||||||
|
void WebServer::end_captive() { this->dns_.stop(); }
|
||||||
|
|
||||||
|
void WebServer::handle_not_found_(AsyncWebServerRequest *request) {
|
||||||
|
// OS captive portal probe (or any other unknown page) while the AP is up: send the browser
|
||||||
|
// to the real page. A redirect rather than the page itself, because the interface resolves
|
||||||
|
// its /events and REST paths relative to the page URL.
|
||||||
|
if (this->dns_.is_running() && request->method() == HTTP_GET) {
|
||||||
|
// Captive mode requires port 80 (enforced at validation), so no port suffix is needed.
|
||||||
|
char location[7 + network::IP_ADDRESS_BUFFER_SIZE + 1];
|
||||||
|
size_t pos = buf_append_str(location, sizeof(location), 0, "http://");
|
||||||
|
wifi::global_wifi_component->wifi_soft_ap_ip().str_to(location + pos);
|
||||||
|
buf_append_str(location, sizeof(location), strlen(location), "/");
|
||||||
|
request->redirect(location);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
request->send(404);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifdef USE_LOGGER
|
#ifdef USE_LOGGER
|
||||||
void WebServer::on_log(uint8_t level, const char *tag, const char *message, size_t message_len) {
|
void WebServer::on_log(uint8_t level, const char *tag, const char *message, size_t message_len) {
|
||||||
(void) level;
|
(void) level;
|
||||||
|
|||||||
@@ -4,6 +4,9 @@
|
|||||||
|
|
||||||
#include "esphome/components/json/json_util.h"
|
#include "esphome/components/json/json_util.h"
|
||||||
#include "esphome/components/web_server_base/web_server_base.h"
|
#include "esphome/components/web_server_base/web_server_base.h"
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
#include "esphome/components/web_server_base/captive_dns.h"
|
||||||
|
#endif
|
||||||
#ifdef USE_WEBSERVER
|
#ifdef USE_WEBSERVER
|
||||||
#include "esphome/core/component.h"
|
#include "esphome/core/component.h"
|
||||||
#include "esphome/core/controller.h"
|
#include "esphome/core/controller.h"
|
||||||
@@ -276,6 +279,18 @@ class WebServer final : public Controller, public Component, public AsyncWebHand
|
|||||||
/// Handle an index request under '/'.
|
/// Handle an index request under '/'.
|
||||||
void handle_index_request(AsyncWebServerRequest *request);
|
void handle_index_request(AsyncWebServerRequest *request);
|
||||||
|
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
/** AP mode: run a DNS server that answers every name with the AP address and redirect any
|
||||||
|
* unknown URL to the interface, so a phone joining the AP opens it through the OS captive
|
||||||
|
* portal check. Started and ended by the wifi component with the access point. start may run
|
||||||
|
* before setup() (wifi sets up first): safe because enable_loop() is a no-op before setup;
|
||||||
|
* nothing but the DNS server may be touched, in particular not base_ or the handlers.
|
||||||
|
*/
|
||||||
|
void start_captive();
|
||||||
|
void end_captive();
|
||||||
|
bool is_captive() const { return this->dns_.is_running(); }
|
||||||
|
#endif
|
||||||
|
|
||||||
/// Return the webserver configuration as JSON.
|
/// Return the webserver configuration as JSON.
|
||||||
json::SerializationBuffer<> get_config_json();
|
json::SerializationBuffer<> get_config_json();
|
||||||
|
|
||||||
@@ -597,6 +612,10 @@ class WebServer final : public Controller, public Component, public AsyncWebHand
|
|||||||
#elif USE_ARDUINO
|
#elif USE_ARDUINO
|
||||||
DeferredUpdateEventSourceList events_;
|
DeferredUpdateEventSourceList events_;
|
||||||
#endif
|
#endif
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
void handle_not_found_(AsyncWebServerRequest *request);
|
||||||
|
web_server_base::CaptiveDNS dns_;
|
||||||
|
#endif
|
||||||
|
|
||||||
#if USE_WEBSERVER_VERSION == 1
|
#if USE_WEBSERVER_VERSION == 1
|
||||||
const char *css_url_{nullptr};
|
const char *css_url_{nullptr};
|
||||||
@@ -696,5 +715,9 @@ class WebServer final : public Controller, public Component, public AsyncWebHand
|
|||||||
#endif
|
#endif
|
||||||
};
|
};
|
||||||
|
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
extern WebServer *global_web_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||||||
|
#endif
|
||||||
|
|
||||||
} // namespace esphome::web_server
|
} // namespace esphome::web_server
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import esphome.codegen as cg
|
import esphome.codegen as cg
|
||||||
|
from esphome.config_helpers import filter_source_files_from_platform
|
||||||
import esphome.config_validation as cv
|
import esphome.config_validation as cv
|
||||||
from esphome.const import CONF_ID
|
from esphome.const import CONF_ID, PlatformFramework
|
||||||
from esphome.core import CORE, coroutine_with_priority
|
from esphome.core import CORE, coroutine_with_priority
|
||||||
from esphome.coroutine import CoroPriority
|
from esphome.coroutine import CoroPriority
|
||||||
from esphome.helpers import copy_file_if_changed
|
from esphome.helpers import copy_file_if_changed
|
||||||
@@ -26,6 +27,22 @@ WebServerBase = web_server_base_ns.class_("WebServerBase")
|
|||||||
CONF_WEB_SERVER_BASE_ID = "web_server_base_id"
|
CONF_WEB_SERVER_BASE_ID = "web_server_base_id"
|
||||||
|
|
||||||
|
|
||||||
|
def consume_captive_dns_sockets(config: ConfigType, name: str) -> None:
|
||||||
|
"""Register the sockets a captive portal needs on top of the shared HTTP server:
|
||||||
|
1 UDP socket for the DNS server and 3 TCP sockets for the OS captive portal probes,
|
||||||
|
which make several requests that linger in TIME_WAIT."""
|
||||||
|
from esphome.components import socket
|
||||||
|
|
||||||
|
socket.consume_sockets(3, name)(config)
|
||||||
|
socket.consume_sockets(1, name, socket.SocketType.UDP)(config)
|
||||||
|
|
||||||
|
|
||||||
|
def add_captive_dns_library() -> None:
|
||||||
|
"""Pull in the Arduino DNSServer library used by CaptiveDNS off ESP32."""
|
||||||
|
if CORE.using_arduino and (CORE.is_esp8266 or CORE.is_libretiny or CORE.is_rp2):
|
||||||
|
cg.add_library("DNSServer", None)
|
||||||
|
|
||||||
|
|
||||||
def _consume_web_server_base_sockets(config: ConfigType) -> ConfigType:
|
def _consume_web_server_base_sockets(config: ConfigType) -> ConfigType:
|
||||||
"""Register the shared listening socket for the HTTP server.
|
"""Register the shared listening socket for the HTTP server.
|
||||||
|
|
||||||
@@ -81,3 +98,15 @@ async def to_code(config: ConfigType) -> None:
|
|||||||
cg.add_platformio_option("extra_scripts", ["pre:fix_rp2040_hash.py"])
|
cg.add_platformio_option("extra_scripts", ["pre:fix_rp2040_hash.py"])
|
||||||
# https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/library.json
|
# https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/library.json
|
||||||
cg.add_library("ESP32Async/ESPAsyncWebServer", "3.9.6")
|
cg.add_library("ESP32Async/ESPAsyncWebServer", "3.9.6")
|
||||||
|
|
||||||
|
|
||||||
|
# The DNS server used for captive portals on ESP32; other platforms use the Arduino
|
||||||
|
# DNSServer library. Its source is also guarded by USE_CAPTIVE_PORTAL / USE_WEBSERVER_CAPTIVE.
|
||||||
|
FILTER_SOURCE_FILES = filter_source_files_from_platform(
|
||||||
|
{
|
||||||
|
"dns_server_esp32_idf.cpp": {
|
||||||
|
PlatformFramework.ESP32_ARDUINO,
|
||||||
|
PlatformFramework.ESP32_IDF,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,58 @@
|
|||||||
|
#pragma once
|
||||||
|
#include "esphome/core/defines.h"
|
||||||
|
// DNS server that answers every name with the access point address, so a phone joining the
|
||||||
|
// AP runs its captive portal check against the device. Shared by captive_portal and the
|
||||||
|
// web_server AP mode; hides the ESP32 (own implementation) vs Arduino (DNSServer library) split.
|
||||||
|
#if defined(USE_CAPTIVE_PORTAL) || defined(USE_WEBSERVER_CAPTIVE)
|
||||||
|
#include <memory>
|
||||||
|
|
||||||
|
#include "esphome/components/network/ip_address.h"
|
||||||
|
#include "esphome/core/helpers.h"
|
||||||
|
#include "esphome/core/progmem.h"
|
||||||
|
#if defined(USE_ESP32)
|
||||||
|
#include "dns_server_esp32_idf.h"
|
||||||
|
#elif defined(USE_ARDUINO)
|
||||||
|
#include <DNSServer.h>
|
||||||
|
#endif
|
||||||
|
|
||||||
|
namespace esphome::web_server_base {
|
||||||
|
|
||||||
|
// The server object only exists while running, so an idle owner (AP not up) pays one pointer.
|
||||||
|
class CaptiveDNS {
|
||||||
|
public:
|
||||||
|
void start(const network::IPAddress &ip) {
|
||||||
|
if (this->dns_server_ != nullptr)
|
||||||
|
return;
|
||||||
|
this->dns_server_ = make_unique<DNSServer>();
|
||||||
|
#if defined(USE_ESP32)
|
||||||
|
this->dns_server_->start(ip);
|
||||||
|
#elif defined(USE_ARDUINO)
|
||||||
|
this->dns_server_->setErrorReplyCode(DNSReplyCode::NoError);
|
||||||
|
this->dns_server_->start(53, ESPHOME_F("*"), ip);
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
void stop() {
|
||||||
|
if (this->dns_server_ == nullptr)
|
||||||
|
return;
|
||||||
|
this->dns_server_->stop();
|
||||||
|
this->dns_server_ = nullptr;
|
||||||
|
}
|
||||||
|
/// Answer one pending query; call from the owner's loop() while running.
|
||||||
|
void loop() {
|
||||||
|
if (this->dns_server_ == nullptr)
|
||||||
|
return;
|
||||||
|
#if defined(USE_ESP32)
|
||||||
|
this->dns_server_->process_next_request();
|
||||||
|
#elif defined(USE_ARDUINO)
|
||||||
|
this->dns_server_->processNextRequest();
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
bool is_running() const { return this->dns_server_ != nullptr; }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
// ESP32: web_server_base::DNSServer from dns_server_esp32_idf.h; Arduino: the library class.
|
||||||
|
std::unique_ptr<DNSServer> dns_server_;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace esphome::web_server_base
|
||||||
|
#endif // USE_CAPTIVE_PORTAL || USE_WEBSERVER_CAPTIVE
|
||||||
+5
-5
@@ -1,5 +1,5 @@
|
|||||||
#include "dns_server_esp32_idf.h"
|
#include "dns_server_esp32_idf.h"
|
||||||
#ifdef USE_ESP32
|
#if defined(USE_ESP32) && (defined(USE_CAPTIVE_PORTAL) || defined(USE_WEBSERVER_CAPTIVE))
|
||||||
|
|
||||||
#include "esphome/core/log.h"
|
#include "esphome/core/log.h"
|
||||||
#include "esphome/core/hal.h"
|
#include "esphome/core/hal.h"
|
||||||
@@ -7,9 +7,9 @@
|
|||||||
#include <lwip/sockets.h>
|
#include <lwip/sockets.h>
|
||||||
#include <lwip/inet.h>
|
#include <lwip/inet.h>
|
||||||
|
|
||||||
namespace esphome::captive_portal {
|
namespace esphome::web_server_base {
|
||||||
|
|
||||||
static const char *const TAG = "captive_portal.dns";
|
static const char *const TAG = "web_server_base.dns";
|
||||||
|
|
||||||
// DNS constants
|
// DNS constants
|
||||||
static constexpr uint16_t DNS_PORT = 53;
|
static constexpr uint16_t DNS_PORT = 53;
|
||||||
@@ -202,6 +202,6 @@ void DNSServer::process_next_request() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace esphome::captive_portal
|
} // namespace esphome::web_server_base
|
||||||
|
|
||||||
#endif // USE_ESP32
|
#endif // USE_ESP32 && (USE_CAPTIVE_PORTAL || USE_WEBSERVER_CAPTIVE)
|
||||||
+8
-4
@@ -1,11 +1,15 @@
|
|||||||
#pragma once
|
#pragma once
|
||||||
#ifdef USE_ESP32
|
#include "esphome/core/defines.h"
|
||||||
|
// Small DNS server that answers every query with the access point address, so a
|
||||||
|
// phone joining the AP opens the captive portal or web_server page on its own.
|
||||||
|
// Shared by captive_portal and the web_server AP mode.
|
||||||
|
#if defined(USE_ESP32) && (defined(USE_CAPTIVE_PORTAL) || defined(USE_WEBSERVER_CAPTIVE))
|
||||||
|
|
||||||
#include "esphome/core/helpers.h"
|
#include "esphome/core/helpers.h"
|
||||||
#include "esphome/components/network/ip_address.h"
|
#include "esphome/components/network/ip_address.h"
|
||||||
#include "esphome/components/socket/socket.h"
|
#include "esphome/components/socket/socket.h"
|
||||||
|
|
||||||
namespace esphome::captive_portal {
|
namespace esphome::web_server_base {
|
||||||
|
|
||||||
class DNSServer {
|
class DNSServer {
|
||||||
public:
|
public:
|
||||||
@@ -27,6 +31,6 @@ class DNSServer {
|
|||||||
uint8_t buffer_[DNS_BUFFER_SIZE];
|
uint8_t buffer_[DNS_BUFFER_SIZE];
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace esphome::captive_portal
|
} // namespace esphome::web_server_base
|
||||||
|
|
||||||
#endif // USE_ESP32
|
#endif // USE_ESP32 && (USE_CAPTIVE_PORTAL || USE_WEBSERVER_CAPTIVE)
|
||||||
@@ -325,9 +325,9 @@ StringRef AsyncWebServerRequest::url_to(std::span<char, URL_BUF_SIZE> buffer) co
|
|||||||
return StringRef(buffer.data(), decoded_len);
|
return StringRef(buffer.data(), decoded_len);
|
||||||
}
|
}
|
||||||
|
|
||||||
void AsyncWebServerRequest::redirect(const std::string &url) {
|
void AsyncWebServerRequest::redirect(const char *url) {
|
||||||
httpd_resp_set_status(*this, "302 Found");
|
httpd_resp_set_status(*this, "302 Found");
|
||||||
httpd_resp_set_hdr(*this, "Location", url.c_str());
|
httpd_resp_set_hdr(*this, "Location", url);
|
||||||
httpd_resp_set_hdr(*this, "Connection", "close");
|
httpd_resp_set_hdr(*this, "Connection", "close");
|
||||||
httpd_resp_send(*this, nullptr, 0);
|
httpd_resp_send(*this, nullptr, 0);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -126,7 +126,8 @@ class AsyncWebServerRequest {
|
|||||||
void requestAuthentication() const;
|
void requestAuthentication() const;
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
void redirect(const std::string &url);
|
void redirect(const char *url);
|
||||||
|
void redirect(const std::string &url) { this->redirect(url.c_str()); }
|
||||||
|
|
||||||
inline void ESPHOME_ALWAYS_INLINE send(AsyncWebServerResponse *response) {
|
inline void ESPHOME_ALWAYS_INLINE send(AsyncWebServerResponse *response) {
|
||||||
httpd_resp_send(*this, response->get_content_data(), response->get_content_size());
|
httpd_resp_send(*this, response->get_content_data(), response->get_content_size());
|
||||||
|
|||||||
@@ -36,6 +36,9 @@
|
|||||||
#ifdef USE_CAPTIVE_PORTAL
|
#ifdef USE_CAPTIVE_PORTAL
|
||||||
#include "esphome/components/captive_portal/captive_portal.h"
|
#include "esphome/components/captive_portal/captive_portal.h"
|
||||||
#endif
|
#endif
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
#include "esphome/components/web_server/web_server.h"
|
||||||
|
#endif
|
||||||
|
|
||||||
#ifdef USE_IMPROV
|
#ifdef USE_IMPROV
|
||||||
#include "esphome/components/esp32_improv/esp32_improv_component.h"
|
#include "esphome/components/esp32_improv/esp32_improv_component.h"
|
||||||
@@ -741,9 +744,9 @@ void WiFiComponent::start() {
|
|||||||
if (captive_portal::global_captive_portal != nullptr) {
|
if (captive_portal::global_captive_portal != nullptr) {
|
||||||
this->wifi_sta_pre_setup_();
|
this->wifi_sta_pre_setup_();
|
||||||
this->start_scanning();
|
this->start_scanning();
|
||||||
captive_portal::global_captive_portal->start();
|
|
||||||
}
|
}
|
||||||
#endif
|
#endif
|
||||||
|
this->start_ap_portal_();
|
||||||
#endif // USE_WIFI_AP
|
#endif // USE_WIFI_AP
|
||||||
}
|
}
|
||||||
#ifdef USE_IMPROV
|
#ifdef USE_IMPROV
|
||||||
@@ -804,8 +807,8 @@ void WiFiComponent::loop() {
|
|||||||
this->check_connecting_finished(now);
|
this->check_connecting_finished(now);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
// Use longer cooldown when captive portal/improv is active to avoid disrupting user config
|
// Use longer cooldown when a portal/improv is active to avoid disrupting a user on the AP
|
||||||
bool portal_active = this->is_captive_portal_active_() || this->is_esp32_improv_active_();
|
bool portal_active = this->is_ap_portal_active_() || this->is_esp32_improv_active_();
|
||||||
uint32_t cooldown_duration = portal_active ? WIFI_COOLDOWN_WITH_AP_ACTIVE_MS : WIFI_COOLDOWN_DURATION_MS;
|
uint32_t cooldown_duration = portal_active ? WIFI_COOLDOWN_WITH_AP_ACTIVE_MS : WIFI_COOLDOWN_DURATION_MS;
|
||||||
if (now - this->action_started_ > cooldown_duration) {
|
if (now - this->action_started_ > cooldown_duration) {
|
||||||
// After cooldown we either restarted the adapter because of
|
// After cooldown we either restarted the adapter because of
|
||||||
@@ -883,13 +886,11 @@ void WiFiComponent::loop() {
|
|||||||
ESP_LOGI(TAG, "Starting fallback AP");
|
ESP_LOGI(TAG, "Starting fallback AP");
|
||||||
this->setup_ap_config_();
|
this->setup_ap_config_();
|
||||||
#ifdef USE_CAPTIVE_PORTAL
|
#ifdef USE_CAPTIVE_PORTAL
|
||||||
if (captive_portal::global_captive_portal != nullptr) {
|
// Reset so we force one full scan after captive portal starts
|
||||||
// Reset so we force one full scan after captive portal starts
|
// (previous scans were filtered because captive portal wasn't active yet)
|
||||||
// (previous scans were filtered because captive portal wasn't active yet)
|
this->has_completed_scan_after_captive_portal_start_ = false;
|
||||||
this->has_completed_scan_after_captive_portal_start_ = false;
|
|
||||||
captive_portal::global_captive_portal->start();
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
|
this->start_ap_portal_();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
#endif // USE_WIFI_AP
|
#endif // USE_WIFI_AP
|
||||||
@@ -1636,10 +1637,8 @@ void WiFiComponent::check_connecting_finished(uint32_t now) {
|
|||||||
this->retry_phase_ = WiFiRetryPhase::INITIAL_CONNECT;
|
this->retry_phase_ = WiFiRetryPhase::INITIAL_CONNECT;
|
||||||
this->num_retried_ = 0;
|
this->num_retried_ = 0;
|
||||||
if (this->has_ap()) {
|
if (this->has_ap()) {
|
||||||
#ifdef USE_CAPTIVE_PORTAL
|
#ifdef USE_WIFI_AP
|
||||||
if (this->is_captive_portal_active_()) {
|
this->end_ap_portal_();
|
||||||
captive_portal::global_captive_portal->end();
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
ESP_LOGD(TAG, "Disabling AP");
|
ESP_LOGD(TAG, "Disabling AP");
|
||||||
this->wifi_mode_({}, false);
|
this->wifi_mode_({}, false);
|
||||||
@@ -1966,10 +1965,10 @@ bool WiFiComponent::transition_to_phase_(WiFiRetryPhase new_phase) {
|
|||||||
break;
|
break;
|
||||||
|
|
||||||
case WiFiRetryPhase::RESTARTING_ADAPTER:
|
case WiFiRetryPhase::RESTARTING_ADAPTER:
|
||||||
// Skip actual adapter restart if captive portal/improv is active
|
// Skip actual adapter restart if a portal/improv is active
|
||||||
// This allows state machine to reset num_retried_ and trigger fresh scan
|
// This allows state machine to reset num_retried_ and trigger fresh scan
|
||||||
// without disrupting the captive portal/improv connection
|
// without disrupting the portal/improv connection
|
||||||
if (!this->is_captive_portal_active_() && !this->is_esp32_improv_active_()) {
|
if (!this->is_ap_portal_active_() && !this->is_esp32_improv_active_()) {
|
||||||
this->restart_adapter();
|
this->restart_adapter();
|
||||||
} else {
|
} else {
|
||||||
// Even when skipping full restart, disconnect to clear driver state
|
// Even when skipping full restart, disconnect to clear driver state
|
||||||
@@ -2228,6 +2227,38 @@ bool WiFiComponent::is_captive_portal_active_() {
|
|||||||
return false;
|
return false;
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
|
|
||||||
|
bool WiFiComponent::is_ap_portal_active_() {
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
if (web_server::global_web_server->is_captive())
|
||||||
|
return true;
|
||||||
|
#endif
|
||||||
|
return this->is_captive_portal_active_();
|
||||||
|
}
|
||||||
|
|
||||||
|
#ifdef USE_WIFI_AP
|
||||||
|
// global_web_server needs no null check: codegen always instantiates WebServer when
|
||||||
|
// USE_WEBSERVER_CAPTIVE is defined, and the constructor assigns the global.
|
||||||
|
void WiFiComponent::start_ap_portal_() {
|
||||||
|
#ifdef USE_CAPTIVE_PORTAL
|
||||||
|
if (captive_portal::global_captive_portal != nullptr)
|
||||||
|
captive_portal::global_captive_portal->start();
|
||||||
|
#endif
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
web_server::global_web_server->start_captive();
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
|
||||||
|
void WiFiComponent::end_ap_portal_() {
|
||||||
|
#ifdef USE_CAPTIVE_PORTAL
|
||||||
|
if (this->is_captive_portal_active_())
|
||||||
|
captive_portal::global_captive_portal->end();
|
||||||
|
#endif
|
||||||
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
web_server::global_web_server->end_captive();
|
||||||
|
#endif
|
||||||
|
}
|
||||||
|
#endif // USE_WIFI_AP
|
||||||
bool WiFiComponent::is_esp32_improv_active_() {
|
bool WiFiComponent::is_esp32_improv_active_() {
|
||||||
#ifdef USE_IMPROV
|
#ifdef USE_IMPROV
|
||||||
return esp32_improv::global_improv_component != nullptr && esp32_improv::global_improv_component->is_active();
|
return esp32_improv::global_improv_component != nullptr && esp32_improv::global_improv_component->is_active();
|
||||||
|
|||||||
@@ -797,6 +797,12 @@ class WiFiComponent final : public Component {
|
|||||||
network::IPAddress wifi_dns_ip_(int num);
|
network::IPAddress wifi_dns_ip_(int num);
|
||||||
|
|
||||||
bool is_captive_portal_active_();
|
bool is_captive_portal_active_();
|
||||||
|
/// captive_portal or the web_server AP mode is serving a user on the access point
|
||||||
|
bool is_ap_portal_active_();
|
||||||
|
#ifdef USE_WIFI_AP
|
||||||
|
void start_ap_portal_();
|
||||||
|
void end_ap_portal_();
|
||||||
|
#endif
|
||||||
bool is_esp32_improv_active_();
|
bool is_esp32_improv_active_();
|
||||||
|
|
||||||
#ifdef USE_WIFI_FAST_CONNECT
|
#ifdef USE_WIFI_FAST_CONNECT
|
||||||
|
|||||||
@@ -1130,10 +1130,16 @@ bool WiFiComponent::wifi_ap_ip_config_(const optional<ManualIP> &manual_ip) {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
#if defined(USE_CAPTIVE_PORTAL) && ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0)
|
#if (defined(USE_CAPTIVE_PORTAL) || defined(USE_WEBSERVER_CAPTIVE)) && ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0)
|
||||||
// Configure DHCP Option 114 (Captive Portal URI) if captive portal is enabled
|
// Configure DHCP Option 114 (Captive Portal URI) if captive portal or the web_server AP
|
||||||
// This provides a standards-compliant way for clients to discover the captive portal
|
// mode is enabled. This provides a standards-compliant way for clients to discover the portal
|
||||||
if (captive_portal::global_captive_portal != nullptr) {
|
#ifdef USE_WEBSERVER_CAPTIVE
|
||||||
|
// web_server AP mode always serves the portal when compiled in
|
||||||
|
const bool has_portal = true;
|
||||||
|
#else
|
||||||
|
const bool has_portal = captive_portal::global_captive_portal != nullptr;
|
||||||
|
#endif
|
||||||
|
if (has_portal) {
|
||||||
// Buffer must be static - dhcps_set_option_info stores pointer, doesn't copy
|
// Buffer must be static - dhcps_set_option_info stores pointer, doesn't copy
|
||||||
static char captive_portal_uri[24]; // "http://" (7) + IPv4 max (15) + null
|
static char captive_portal_uri[24]; // "http://" (7) + IPv4 max (15) + null
|
||||||
memcpy(captive_portal_uri, "http://", 7); // NOLINT(bugprone-not-null-terminated-result) - str_to null-terminates
|
memcpy(captive_portal_uri, "http://", 7); // NOLINT(bugprone-not-null-terminated-result) - str_to null-terminates
|
||||||
|
|||||||
@@ -371,6 +371,7 @@
|
|||||||
#define USE_WEBSERVER
|
#define USE_WEBSERVER
|
||||||
#define USE_WEBSERVER_AUTH
|
#define USE_WEBSERVER_AUTH
|
||||||
#define USE_WEBSERVER_AUTH_DIGEST
|
#define USE_WEBSERVER_AUTH_DIGEST
|
||||||
|
#define USE_WEBSERVER_CAPTIVE
|
||||||
#define USE_WEBSERVER_OTA
|
#define USE_WEBSERVER_OTA
|
||||||
#define USE_WEBSERVER_PORT 80 // NOLINT
|
#define USE_WEBSERVER_PORT 80 // NOLINT
|
||||||
#define USE_WEBSERVER_GZIP
|
#define USE_WEBSERVER_GZIP
|
||||||
@@ -484,6 +485,7 @@
|
|||||||
#define USE_WEBSERVER
|
#define USE_WEBSERVER
|
||||||
#define USE_WEBSERVER_AUTH
|
#define USE_WEBSERVER_AUTH
|
||||||
#define USE_WEBSERVER_AUTH_DIGEST
|
#define USE_WEBSERVER_AUTH_DIGEST
|
||||||
|
#define USE_WEBSERVER_CAPTIVE
|
||||||
#define USE_WEBSERVER_PORT 80 // NOLINT
|
#define USE_WEBSERVER_PORT 80 // NOLINT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
@@ -541,6 +543,7 @@
|
|||||||
#define USE_WEBSERVER
|
#define USE_WEBSERVER
|
||||||
#define USE_WEBSERVER_AUTH
|
#define USE_WEBSERVER_AUTH
|
||||||
#define USE_WEBSERVER_AUTH_DIGEST
|
#define USE_WEBSERVER_AUTH_DIGEST
|
||||||
|
#define USE_WEBSERVER_CAPTIVE
|
||||||
#define USE_WEBSERVER_PORT 80 // NOLINT
|
#define USE_WEBSERVER_PORT 80 // NOLINT
|
||||||
#define USE_ESPHOME_TASK_LOG_BUFFER
|
#define USE_ESPHOME_TASK_LOG_BUFFER
|
||||||
#define ESPHOME_TASK_LOG_BUFFER_SIZE 768
|
#define ESPHOME_TASK_LOG_BUFFER_SIZE 768
|
||||||
|
|||||||
@@ -69,10 +69,7 @@ def _make_create_connection() -> Callable[..., socket.socket]:
|
|||||||
|
|
||||||
from aiohappyeyeballs import start_connection
|
from aiohappyeyeballs import start_connection
|
||||||
from urllib3.exceptions import LocationParseError
|
from urllib3.exceptions import LocationParseError
|
||||||
from urllib3.util.connection import ( # noqa: PLC2701
|
from urllib3.util.connection import _set_socket_options, allowed_gai_family # noqa: PLC2701
|
||||||
_set_socket_options,
|
|
||||||
allowed_gai_family,
|
|
||||||
)
|
|
||||||
from urllib3.util.timeout import _DEFAULT_TIMEOUT # noqa: PLC2701
|
from urllib3.util.timeout import _DEFAULT_TIMEOUT # noqa: PLC2701
|
||||||
|
|
||||||
from esphome import async_thread
|
from esphome import async_thread
|
||||||
|
|||||||
@@ -616,11 +616,15 @@ def _make_registry_client() -> Any:
|
|||||||
elsewhere, not by the PlatformIO registry.
|
elsewhere, not by the PlatformIO registry.
|
||||||
"""
|
"""
|
||||||
from platformio.package.manager._registry import PackageManagerRegistryMixin
|
from platformio.package.manager._registry import PackageManagerRegistryMixin
|
||||||
|
from platformio.registry.client import RegistryClient
|
||||||
|
|
||||||
class _Registry(PackageManagerRegistryMixin):
|
class _Registry(PackageManagerRegistryMixin):
|
||||||
def __init__(self) -> None:
|
def __init__(self) -> None:
|
||||||
self._registry_client = None
|
|
||||||
self.pkg_type = "library"
|
self.pkg_type = "library"
|
||||||
|
self._registry_client = RegistryClient()
|
||||||
|
# The probe sleeps ~500 ms per lookup (see runner.patch_registry_private_packages);
|
||||||
|
# instance-level so the ESPHome process never patches PlatformIO's class
|
||||||
|
self._registry_client.allowed_private_packages = lambda: False
|
||||||
|
|
||||||
@staticmethod
|
@staticmethod
|
||||||
def is_system_compatible(value: Any, custom_system: Any = None) -> bool:
|
def is_system_compatible(value: Any, custom_system: Any = None) -> bool:
|
||||||
|
|||||||
@@ -951,8 +951,10 @@ def main(argv: list[str]) -> int:
|
|||||||
"""Subprocess entry point: ``prefetch <build_dir> <env_name>``."""
|
"""Subprocess entry point: ``prefetch <build_dir> <env_name>``."""
|
||||||
from esphome.core import CORE
|
from esphome.core import CORE
|
||||||
from esphome.log import setup_log
|
from esphome.log import setup_log
|
||||||
|
from esphome.platformio.runner import patch_registry_private_packages
|
||||||
|
|
||||||
signal.signal(signal.SIGTERM, _sigterm)
|
signal.signal(signal.SIGTERM, _sigterm)
|
||||||
|
patch_registry_private_packages()
|
||||||
raw_level = os.environ.get("ESPHOME_PREFETCH_LOG_LEVEL")
|
raw_level = os.environ.get("ESPHOME_PREFETCH_LOG_LEVEL")
|
||||||
try:
|
try:
|
||||||
level = int(raw_level) if raw_level is not None else logging.INFO
|
level = int(raw_level) if raw_level is not None else logging.INFO
|
||||||
|
|||||||
@@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
Invoked via ``python -m esphome.platformio.runner`` instead of
|
Invoked via ``python -m esphome.platformio.runner`` instead of
|
||||||
``python -m platformio`` so that the patches (incremental rebuild
|
``python -m platformio`` so that the patches (incremental rebuild
|
||||||
preservation, download retries) apply inside the subprocess. Running
|
preservation, download retries, skipping the private-package probe) apply
|
||||||
|
inside the subprocess. Running
|
||||||
PlatformIO in a subprocess keeps its ``sys.path`` mutations and other
|
PlatformIO in a subprocess keeps its ``sys.path`` mutations and other
|
||||||
global state from leaking into the ESPHome process.
|
global state from leaking into the ESPHome process.
|
||||||
"""
|
"""
|
||||||
@@ -105,6 +106,16 @@ def patch_file_downloader() -> None:
|
|||||||
FileDownloader.__init__ = patched_init
|
FileDownloader.__init__ = patched_init
|
||||||
|
|
||||||
|
|
||||||
|
def patch_registry_private_packages() -> None:
|
||||||
|
"""Skip PlatformIO's private-package probe; it sleeps ~500 ms per lookup.
|
||||||
|
|
||||||
|
ESPHome never uses private packages, so the answer is always False.
|
||||||
|
"""
|
||||||
|
from platformio.registry.client import RegistryClient
|
||||||
|
|
||||||
|
RegistryClient.allowed_private_packages = staticmethod(lambda: False) # type: ignore[method-assign]
|
||||||
|
|
||||||
|
|
||||||
_IGNORE_LIB_WARNINGS = "(?:Hash|Update)"
|
_IGNORE_LIB_WARNINGS = "(?:Hash|Update)"
|
||||||
# Regex patterns matched against each line of PlatformIO output. Lines that
|
# Regex patterns matched against each line of PlatformIO output. Lines that
|
||||||
# match are dropped by RedirectText before they reach the parent process.
|
# match are dropped by RedirectText before they reach the parent process.
|
||||||
@@ -152,6 +163,7 @@ FILTER_PLATFORMIO_LINES = [
|
|||||||
def main() -> int:
|
def main() -> int:
|
||||||
patch_structhash()
|
patch_structhash()
|
||||||
patch_file_downloader()
|
patch_file_downloader()
|
||||||
|
patch_registry_private_packages()
|
||||||
|
|
||||||
# Wrap stdout/stderr with RedirectText before PlatformIO runs:
|
# Wrap stdout/stderr with RedirectText before PlatformIO runs:
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
# Useful stuff when working in a development environment
|
# Useful stuff when working in a development environment
|
||||||
clang-format==13.0.1 # also change in .pre-commit-config.yaml and Dockerfile when updating
|
clang-format==13.0.1 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
||||||
clang-tidy==22.1.8
|
clang-tidy==22.1.8
|
||||||
yamllint==1.38.0 # also change in .pre-commit-config.yaml when updating
|
yamllint==1.38.0 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
||||||
|
|||||||
@@ -1,8 +1,9 @@
|
|||||||
pylint==4.0.8
|
pylint==4.0.8
|
||||||
flake8==7.3.0 # also change in .pre-commit-config.yaml when updating
|
flake8==7.3.0 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
||||||
ruff==0.16.5 # also change in .pre-commit-config.yaml when updating
|
ruff==0.16.6 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
||||||
pyupgrade==3.21.2 # also change in .pre-commit-config.yaml when updating
|
pyupgrade==3.21.2 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
||||||
prek==0.5.1 # also change in .github/workflows/ci.yml when updating
|
prek==0.5.2 # .github/workflows/ci.yml reads this pin
|
||||||
|
yamlrocks==0.6.1 # used by script/sync_dependency_versions.py
|
||||||
|
|
||||||
# Unit tests
|
# Unit tests
|
||||||
pytest==9.1.1
|
pytest==9.1.1
|
||||||
|
|||||||
@@ -14,7 +14,31 @@ top=$(git rev-parse --show-toplevel 2>/dev/null) || exit 0
|
|||||||
[ -x "$top/venv/bin/python" ] && exit 0
|
[ -x "$top/venv/bin/python" ] && exit 0
|
||||||
[ -x "$top/script/setup" ] || exit 0
|
[ -x "$top/script/setup" ] || exit 0
|
||||||
|
|
||||||
|
# Every worktree shares the hooks directory of the checkout it was created
|
||||||
|
# from, and the script/setup run below is the one from whichever branch was just
|
||||||
|
# checked out. Older branches install their own pre-commit hook without checking
|
||||||
|
# for a worktree: that moves the shared hook aside as pre-commit.legacy and
|
||||||
|
# replaces it with one tied to this worktree's virtual environment, so commits
|
||||||
|
# break in every checkout. To rule that out, the hooks directory is copied
|
||||||
|
# before script/setup runs and put back exactly as it was afterwards, including
|
||||||
|
# removing any file script/setup added.
|
||||||
|
hooks=$(git rev-parse --path-format=absolute --git-path hooks 2>/dev/null) || exit 0
|
||||||
|
snap=$(mktemp -d "$hooks/.post-checkout.XXXXXX") || exit 0
|
||||||
|
cp -p "$hooks"/* "$snap"/ 2>/dev/null
|
||||||
|
|
||||||
# Clear VIRTUAL_ENV so a checkout made from a shell with an environment already
|
# Clear VIRTUAL_ENV so a checkout made from a shell with an environment already
|
||||||
# activated still gets its own, rather than having the active one repointed at
|
# activated still gets its own, rather than having the active one repointed at
|
||||||
# this working tree.
|
# this working tree.
|
||||||
exec env -u VIRTUAL_ENV "$top/script/setup"
|
env -u VIRTUAL_ENV "$top/script/setup"
|
||||||
|
status=$?
|
||||||
|
|
||||||
|
for f in "$hooks"/*; do
|
||||||
|
[ -e "$snap/${f##*/}" ] || rm -f "$f"
|
||||||
|
done
|
||||||
|
# Files are moved rather than copied so a hook that is still running, such as
|
||||||
|
# this one, is swapped out atomically instead of being rewritten in place.
|
||||||
|
for f in "$snap"/*; do
|
||||||
|
cmp -s "$f" "$hooks/${f##*/}" 2>/dev/null || mv -f "$f" "$hooks/${f##*/}"
|
||||||
|
done
|
||||||
|
rm -rf "$snap"
|
||||||
|
exit $status
|
||||||
|
|||||||
@@ -1104,6 +1104,10 @@ def get_components_per_integration_fixture() -> dict[str, set[str]]:
|
|||||||
|
|
||||||
|
|
||||||
_TEST_FUNC_RE = re.compile(r"async def (test_\w+)")
|
_TEST_FUNC_RE = re.compile(r"async def (test_\w+)")
|
||||||
|
# Any usage form (decorator, pytestmark assignment or list element); only
|
||||||
|
# test_*.py files are scanned, so the marker docs elsewhere cannot false-hit
|
||||||
|
_SHARED_YAML_USE_RE = re.compile(r"\bmark\.shared_yaml")
|
||||||
|
_SHARED_YAML_ARG_RE = re.compile(r"\(\s*[\"'](\w+)[\"']\s*\)")
|
||||||
|
|
||||||
|
|
||||||
@cache
|
@cache
|
||||||
@@ -1123,6 +1127,19 @@ def get_fixture_to_test_files() -> dict[str, frozenset[str]]:
|
|||||||
for func in _TEST_FUNC_RE.findall(content):
|
for func in _TEST_FUNC_RE.findall(content):
|
||||||
base_name = func.replace("test_", "").partition("[")[0]
|
base_name = func.replace("test_", "").partition("[")[0]
|
||||||
result.setdefault(base_name, set()).add(rel_path)
|
result.setdefault(base_name, set()).add(rel_path)
|
||||||
|
# Shared fixtures are named by marker, not by a test function; each
|
||||||
|
# decorator must carry a string literal or its fixture would silently
|
||||||
|
# map to no tests
|
||||||
|
for use in _SHARED_YAML_USE_RE.finditer(content):
|
||||||
|
arg = _SHARED_YAML_ARG_RE.match(content, use.end())
|
||||||
|
if arg is None:
|
||||||
|
line = content.count("\n", 0, use.start()) + 1
|
||||||
|
raise ValueError(
|
||||||
|
f"{rel_path}:{line}: shared_yaml marker must take a "
|
||||||
|
"single-line string literal so CI test selection can map "
|
||||||
|
"its fixture"
|
||||||
|
)
|
||||||
|
result.setdefault(arg.group(1), set()).add(rel_path)
|
||||||
|
|
||||||
return {k: frozenset(v) for k, v in result.items()}
|
return {k: frozenset(v) for k, v in result.items()}
|
||||||
|
|
||||||
|
|||||||
Executable
+164
@@ -0,0 +1,164 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Keep pre-commit hook revs in sync with the requirements files.
|
||||||
|
|
||||||
|
Dependabot only bumps the ``package==version`` pins in ``requirements*.txt``.
|
||||||
|
Some of those tools are pinned a second time as hook ``rev`` values in
|
||||||
|
``.pre-commit-config.yaml``. This script treats the requirements files as
|
||||||
|
the source of truth and rewrites the revs to match, editing the config
|
||||||
|
through yamlrocks so comments and layout survive.
|
||||||
|
|
||||||
|
Run without arguments to apply the changes in place, or with ``--check`` to
|
||||||
|
only report drift (exit status 1 when anything is out of sync).
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import argparse
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import yamlrocks
|
||||||
|
|
||||||
|
REPO_ROOT = Path(__file__).resolve().parent.parent
|
||||||
|
PRECOMMIT_CONFIG = ".pre-commit-config.yaml"
|
||||||
|
|
||||||
|
|
||||||
|
class SyncError(Exception):
|
||||||
|
"""A pin could not be located in a requirements file or the config."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass(frozen=True)
|
||||||
|
class SyncTarget:
|
||||||
|
"""A requirements pin and the pre-commit repo whose rev mirrors it."""
|
||||||
|
|
||||||
|
package: str
|
||||||
|
requirements_file: str
|
||||||
|
repo: str
|
||||||
|
|
||||||
|
|
||||||
|
SYNC_TARGETS: tuple[SyncTarget, ...] = (
|
||||||
|
SyncTarget(
|
||||||
|
"ruff", "requirements_test.txt", "https://github.com/astral-sh/ruff-pre-commit"
|
||||||
|
),
|
||||||
|
SyncTarget("flake8", "requirements_test.txt", "https://github.com/PyCQA/flake8"),
|
||||||
|
SyncTarget(
|
||||||
|
"pyupgrade", "requirements_test.txt", "https://github.com/asottile/pyupgrade"
|
||||||
|
),
|
||||||
|
SyncTarget(
|
||||||
|
"clang-format",
|
||||||
|
"requirements_dev.txt",
|
||||||
|
"https://github.com/pre-commit/mirrors-clang-format",
|
||||||
|
),
|
||||||
|
SyncTarget(
|
||||||
|
"yamllint",
|
||||||
|
"requirements_dev.txt",
|
||||||
|
"https://github.com/adrienverge/yamllint.git",
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def read_requirement_version(requirements: str, package: str) -> str | None:
|
||||||
|
"""Return the ``==`` pin for ``package`` or None when it is not pinned."""
|
||||||
|
pattern = re.compile(
|
||||||
|
rf"^{re.escape(package)}==(?P<version>[^\s#]+)",
|
||||||
|
re.MULTILINE | re.IGNORECASE,
|
||||||
|
)
|
||||||
|
match = pattern.search(requirements)
|
||||||
|
return match.group("version") if match else None
|
||||||
|
|
||||||
|
|
||||||
|
def find_repo_entry(doc: Any, repo: str) -> Any:
|
||||||
|
"""Return the single ``- repo:`` block for ``repo`` in a pre-commit doc."""
|
||||||
|
try:
|
||||||
|
entries = [entry for entry in doc["repos"] if entry["repo"] == repo]
|
||||||
|
except KeyError as err:
|
||||||
|
raise SyncError(f"malformed pre-commit config, missing key {err}") from None
|
||||||
|
if len(entries) != 1:
|
||||||
|
raise SyncError(
|
||||||
|
f"expected exactly one block for repo {repo}, found {len(entries)}"
|
||||||
|
)
|
||||||
|
return entries[0]
|
||||||
|
|
||||||
|
|
||||||
|
def current_rev(entry: Any, repo: str) -> tuple[str, str]:
|
||||||
|
"""Split the block's rev into its tag prefix (``v`` or empty) and version."""
|
||||||
|
if "rev" not in entry:
|
||||||
|
raise SyncError(f"repo {repo} has no rev")
|
||||||
|
rev = entry["rev"]
|
||||||
|
if not isinstance(rev, str):
|
||||||
|
# A rev such as ``1.0`` parses as a number and cannot be compared or
|
||||||
|
# rewritten safely; quote it in the config instead.
|
||||||
|
raise SyncError(f"rev of repo {repo} is not a string: {rev!r}")
|
||||||
|
prefix = "v" if rev.startswith("v") else ""
|
||||||
|
return prefix, rev.removeprefix("v")
|
||||||
|
|
||||||
|
|
||||||
|
def sync(root: Path, *, write: bool) -> list[str]:
|
||||||
|
"""Bring every hook rev in line with its requirements pin.
|
||||||
|
|
||||||
|
Returns one description per rev that was (or, when ``write`` is False,
|
||||||
|
would be) changed. Raises SyncError when a pin cannot be found, which
|
||||||
|
means SYNC_TARGETS has gone stale and needs updating by hand.
|
||||||
|
"""
|
||||||
|
config_path = root / PRECOMMIT_CONFIG
|
||||||
|
doc = yamlrocks.loads(config_path.read_bytes(), option=yamlrocks.OPT_ROUND_TRIP)
|
||||||
|
requirements: dict[str, str] = {}
|
||||||
|
changes: list[str] = []
|
||||||
|
for target in SYNC_TARGETS:
|
||||||
|
if target.requirements_file not in requirements:
|
||||||
|
requirements[target.requirements_file] = (
|
||||||
|
root / target.requirements_file
|
||||||
|
).read_text()
|
||||||
|
version = read_requirement_version(
|
||||||
|
requirements[target.requirements_file], target.package
|
||||||
|
)
|
||||||
|
if version is None:
|
||||||
|
raise SyncError(
|
||||||
|
f"{target.requirements_file}: no '{target.package}==' pin found"
|
||||||
|
)
|
||||||
|
|
||||||
|
entry = find_repo_entry(doc, target.repo)
|
||||||
|
prefix, current = current_rev(entry, target.repo)
|
||||||
|
if current == version:
|
||||||
|
continue
|
||||||
|
changes.append(f"{target.package}: {current} -> {version}")
|
||||||
|
entry["rev"] = f"{prefix}{version}"
|
||||||
|
|
||||||
|
if changes and write:
|
||||||
|
config_path.write_bytes(doc.to_yaml())
|
||||||
|
return changes
|
||||||
|
|
||||||
|
|
||||||
|
def main(argv: list[str] | None = None) -> int:
|
||||||
|
parser = argparse.ArgumentParser(description=__doc__.splitlines()[0])
|
||||||
|
parser.add_argument(
|
||||||
|
"--check",
|
||||||
|
action="store_true",
|
||||||
|
help="report drift without modifying any file; exit 1 if out of sync",
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--root",
|
||||||
|
type=Path,
|
||||||
|
default=REPO_ROOT,
|
||||||
|
help="repository checkout to operate on (default: this checkout)",
|
||||||
|
)
|
||||||
|
args = parser.parse_args(argv)
|
||||||
|
|
||||||
|
try:
|
||||||
|
changes = sync(args.root, write=not args.check)
|
||||||
|
except SyncError as err:
|
||||||
|
print(f"error: {err}", file=sys.stderr)
|
||||||
|
return 1
|
||||||
|
|
||||||
|
for change in changes:
|
||||||
|
print(change)
|
||||||
|
if args.check and changes:
|
||||||
|
return 1
|
||||||
|
return 0
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
sys.exit(main())
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
esphome:
|
||||||
|
name: test-keyboard-no-label
|
||||||
|
|
||||||
|
esp32:
|
||||||
|
board: esp32dev
|
||||||
|
framework:
|
||||||
|
type: esp-idf
|
||||||
|
|
||||||
|
spi:
|
||||||
|
- id: spi_bus
|
||||||
|
clk_pin: GPIO18
|
||||||
|
mosi_pin: GPIO23
|
||||||
|
|
||||||
|
display:
|
||||||
|
- platform: mipi_spi
|
||||||
|
spi_id: spi_bus
|
||||||
|
model: st7789v
|
||||||
|
id: tft_display
|
||||||
|
dimensions:
|
||||||
|
width: 240
|
||||||
|
height: 320
|
||||||
|
cs_pin: GPIO22
|
||||||
|
dc_pin: GPIO21
|
||||||
|
auto_clear_enabled: false
|
||||||
|
invert_colors: false
|
||||||
|
update_interval: never
|
||||||
|
|
||||||
|
lvgl:
|
||||||
|
displays: tft_display
|
||||||
|
widgets:
|
||||||
|
- keyboard:
|
||||||
|
id: keyboard_widget
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
esphome:
|
||||||
|
name: test-qrcode-no-label
|
||||||
|
|
||||||
|
esp32:
|
||||||
|
board: esp32dev
|
||||||
|
framework:
|
||||||
|
type: esp-idf
|
||||||
|
|
||||||
|
spi:
|
||||||
|
- id: spi_bus
|
||||||
|
clk_pin: GPIO18
|
||||||
|
mosi_pin: GPIO23
|
||||||
|
|
||||||
|
display:
|
||||||
|
- platform: mipi_spi
|
||||||
|
spi_id: spi_bus
|
||||||
|
model: st7789v
|
||||||
|
id: tft_display
|
||||||
|
dimensions:
|
||||||
|
width: 240
|
||||||
|
height: 320
|
||||||
|
cs_pin: GPIO22
|
||||||
|
dc_pin: GPIO21
|
||||||
|
auto_clear_enabled: false
|
||||||
|
invert_colors: false
|
||||||
|
update_interval: never
|
||||||
|
|
||||||
|
lvgl:
|
||||||
|
displays: tft_display
|
||||||
|
widgets:
|
||||||
|
- qrcode:
|
||||||
|
id: qr_widget
|
||||||
|
size: 100
|
||||||
|
text: "esphome.io"
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
esphome:
|
||||||
|
name: test-tabview-no-label
|
||||||
|
|
||||||
|
esp32:
|
||||||
|
board: esp32dev
|
||||||
|
framework:
|
||||||
|
type: esp-idf
|
||||||
|
|
||||||
|
spi:
|
||||||
|
- id: spi_bus
|
||||||
|
clk_pin: GPIO18
|
||||||
|
mosi_pin: GPIO23
|
||||||
|
|
||||||
|
display:
|
||||||
|
- platform: mipi_spi
|
||||||
|
spi_id: spi_bus
|
||||||
|
model: st7789v
|
||||||
|
id: tft_display
|
||||||
|
dimensions:
|
||||||
|
width: 240
|
||||||
|
height: 320
|
||||||
|
cs_pin: GPIO22
|
||||||
|
dc_pin: GPIO21
|
||||||
|
auto_clear_enabled: false
|
||||||
|
invert_colors: false
|
||||||
|
update_interval: never
|
||||||
|
|
||||||
|
lvgl:
|
||||||
|
displays: tft_display
|
||||||
|
widgets:
|
||||||
|
- tabview:
|
||||||
|
id: tabview_widget
|
||||||
|
tabs:
|
||||||
|
- name: "Tab 1"
|
||||||
|
id: tab_1
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
"""Widgets whose LVGL C implementation creates or references labels
|
||||||
|
internally (tab titles, key legends, the QR canvas fallback) must declare
|
||||||
|
the label dependency in ``get_uses()``. Otherwise a config that contains
|
||||||
|
no ``label`` widget of its own compiles LVGL without ``LV_USE_LABEL`` and
|
||||||
|
fails at C compile time with undefined ``lv_label_*`` symbols.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from collections.abc import Callable
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from esphome.components.lvgl import defines as df
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"yaml_file",
|
||||||
|
[
|
||||||
|
"qrcode_no_label.yaml",
|
||||||
|
"keyboard_no_label.yaml",
|
||||||
|
"tabview_no_label.yaml",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_label_less_config_enables_lv_use_label(
|
||||||
|
generate_main: Callable[[str | Path], str],
|
||||||
|
component_config_path: Callable[[str], Path],
|
||||||
|
yaml_file: str,
|
||||||
|
) -> None:
|
||||||
|
generate_main(component_config_path(yaml_file))
|
||||||
|
assert "LV_USE_LABEL" in df.get_defines()
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
from tests.testing_helpers import ComponentManifestOverride
|
||||||
|
|
||||||
|
|
||||||
|
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||||
|
manifest.dependencies = manifest.dependencies + ["sensor", "spi"]
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
#include <gtest/gtest.h>
|
||||||
|
|
||||||
|
#include "esphome/components/atm90e32/atm90e32.h"
|
||||||
|
|
||||||
|
namespace esphome::atm90e32::testing {
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRegisterVerification, AcceptsExactSignedReadback) {
|
||||||
|
EXPECT_TRUE(offset_register_value_matches(0x007B, 123));
|
||||||
|
EXPECT_TRUE(offset_register_value_matches(0xFF85, -123));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRegisterVerification, RejectsMismatchedReadback) {
|
||||||
|
EXPECT_FALSE(offset_register_value_matches(0x007C, 123));
|
||||||
|
EXPECT_FALSE(offset_register_value_matches(0xFF84, -123));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRestoreState, ReportsVerifiedStoredValuesAsRestored) {
|
||||||
|
const auto state = resolve_offset_restore_state(true, true, false);
|
||||||
|
|
||||||
|
EXPECT_TRUE(state.restored);
|
||||||
|
EXPECT_TRUE(state.values_verified);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRestoreState, ReportsVerifiedConfigFallbackAsNotRestored) {
|
||||||
|
const auto state = resolve_offset_restore_state(true, false, true);
|
||||||
|
|
||||||
|
EXPECT_FALSE(state.restored);
|
||||||
|
EXPECT_TRUE(state.values_verified);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRestoreState, ReportsFailedConfigFallbackAsUnverified) {
|
||||||
|
const auto state = resolve_offset_restore_state(true, false, false);
|
||||||
|
|
||||||
|
EXPECT_FALSE(state.restored);
|
||||||
|
EXPECT_FALSE(state.values_verified);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetRestoreState, ReportsConfigWithoutStoredValuesAsNotRestored) {
|
||||||
|
const auto state = resolve_offset_restore_state(false, true, false);
|
||||||
|
|
||||||
|
EXPECT_FALSE(state.restored);
|
||||||
|
EXPECT_TRUE(state.values_verified);
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(ATM90E32OffsetPersistence, RollsBackStoredValuesOrZeroSentinel) {
|
||||||
|
const OffsetCalibration previous[3]{{1, -1}, {2, -2}, {3, -3}};
|
||||||
|
OffsetCalibration rollback[3]{};
|
||||||
|
|
||||||
|
prepare_offset_rollback(previous, true, rollback);
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
|
EXPECT_EQ(rollback[phase].first_offset, previous[phase].first_offset);
|
||||||
|
EXPECT_EQ(rollback[phase].second_offset, previous[phase].second_offset);
|
||||||
|
}
|
||||||
|
|
||||||
|
prepare_offset_rollback(previous, false, rollback);
|
||||||
|
for (const auto &phase : rollback) {
|
||||||
|
EXPECT_EQ(phase.first_offset, 0);
|
||||||
|
EXPECT_EQ(phase.second_offset, 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
} // namespace esphome::atm90e32::testing
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# Tuya without any network component (no wifi/ethernet/api), as used on
|
||||||
|
# serial-only or BLE-only Tuya MCU boards. Regression test for
|
||||||
|
# https://github.com/esphome/esphome/issues/18942
|
||||||
|
substitutions:
|
||||||
|
status_pin: P6
|
||||||
|
|
||||||
|
packages:
|
||||||
|
uart: !include ../../test_build_components/common/uart/bk72xx-ard.yaml
|
||||||
|
|
||||||
|
tuya:
|
||||||
|
status_pin: ${status_pin}
|
||||||
|
|
||||||
|
binary_sensor:
|
||||||
|
- platform: tuya
|
||||||
|
id: tuya_presence
|
||||||
|
sensor_datapoint: 101
|
||||||
|
|
||||||
|
sensor:
|
||||||
|
- platform: tuya
|
||||||
|
id: tuya_light_intensity
|
||||||
|
sensor_datapoint: 103
|
||||||
|
|
||||||
|
number:
|
||||||
|
- platform: tuya
|
||||||
|
id: tuya_far_detection
|
||||||
|
number_datapoint: 109
|
||||||
|
min_value: 0
|
||||||
|
max_value: 600
|
||||||
|
step: 1
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
# STA with AP fallback plus local: true opts the fallback into captive AP mode; exercises
|
||||||
|
# the runtime start (fallback branch in wifi loop) and end (on STA connect) paths.
|
||||||
|
wifi:
|
||||||
|
ssid: MySSID
|
||||||
|
password: password1
|
||||||
|
ap:
|
||||||
|
ssid: "ESPHome-Test"
|
||||||
|
password: "Test1234!"
|
||||||
|
|
||||||
|
web_server:
|
||||||
|
local: true
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# AP mode: with a WiFi access point and the interface embedded in the firmware, web_server
|
||||||
|
# runs its own captive portal (DNS server, unknown URLs redirect to the page).
|
||||||
|
wifi:
|
||||||
|
ap:
|
||||||
|
ssid: "ESPHome-Test"
|
||||||
|
password: "Test1234!"
|
||||||
|
|
||||||
|
web_server:
|
||||||
|
local: true
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
packages:
|
||||||
|
web_server: !include common-ap-fallback.yaml
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
packages:
|
||||||
|
web_server: !include common-ap-mode.yaml
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
packages:
|
||||||
|
web_server: !include common-ap-mode.yaml
|
||||||
@@ -21,6 +21,13 @@ The `yaml_config` fixture automatically loads YAML configurations based on the t
|
|||||||
- The fixture file must exist or the test will fail with a clear error message
|
- The fixture file must exist or the test will fail with a clear error message
|
||||||
- The fixture automatically injects a dynamic port number into the API configuration
|
- The fixture automatically injects a dynamic port number into the API configuration
|
||||||
|
|
||||||
|
Tests marked `@pytest.mark.shared_yaml("name")` load `fixtures/name.yaml` instead
|
||||||
|
of the test-named file and compile it in a shared, hash-keyed build directory, so
|
||||||
|
the whole group pays one full compile and each test only a relink. The marker
|
||||||
|
argument must be a single-line string literal (CI test selection maps fixtures to
|
||||||
|
test files by scanning for it), and marked tests must hand the `yaml_config`
|
||||||
|
content to `run_compiled` unmodified.
|
||||||
|
|
||||||
### Key Fixtures
|
### Key Fixtures
|
||||||
|
|
||||||
- `run_compiled` - Combines write, compile, and run operations into a single context manager
|
- `run_compiled` - Combines write, compile, and run operations into a single context manager
|
||||||
|
|||||||
+335
-81
@@ -4,17 +4,22 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections.abc import AsyncGenerator, Callable, Generator
|
from collections.abc import AsyncGenerator, Callable, Generator
|
||||||
from contextlib import AbstractAsyncContextManager, asynccontextmanager
|
from contextlib import AbstractAsyncContextManager, asynccontextmanager, suppress
|
||||||
import fcntl
|
import fcntl
|
||||||
|
from functools import cache
|
||||||
|
import hashlib
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import platform
|
import platform
|
||||||
|
import re
|
||||||
|
import shutil
|
||||||
import signal
|
import signal
|
||||||
import socket
|
import socket
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
import tempfile
|
import tempfile
|
||||||
|
import time
|
||||||
from typing import TextIO
|
from typing import TextIO
|
||||||
|
|
||||||
from aioesphomeapi import APIClient, APIConnectionError, LogParser, ReconnectLogic
|
from aioesphomeapi import APIClient, APIConnectionError, LogParser, ReconnectLogic
|
||||||
@@ -23,7 +28,13 @@ import pytest_asyncio
|
|||||||
|
|
||||||
import esphome.config
|
import esphome.config
|
||||||
from esphome.core import CORE
|
from esphome.core import CORE
|
||||||
from esphome.helpers import get_usable_cpu_count
|
from esphome.helpers import (
|
||||||
|
get_usable_cpu_count,
|
||||||
|
read_file,
|
||||||
|
rmtree,
|
||||||
|
write_file,
|
||||||
|
write_file_if_changed,
|
||||||
|
)
|
||||||
from esphome.platformio.toolchain import get_idedata
|
from esphome.platformio.toolchain import get_idedata
|
||||||
|
|
||||||
from .const import (
|
from .const import (
|
||||||
@@ -56,6 +67,21 @@ import pty # not available on Windows
|
|||||||
pytest.register_assert_rewrite("tests.integration.entity_utils")
|
pytest.register_assert_rewrite("tests.integration.entity_utils")
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_configure(config: pytest.Config) -> None:
|
||||||
|
config.addinivalue_line(
|
||||||
|
"markers",
|
||||||
|
"shared_yaml(name): load fixtures/<name>.yaml and compile it in a shared, "
|
||||||
|
"hash-keyed incremental build directory",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
FIXTURES_DIR = Path(__file__).parent / "fixtures"
|
||||||
|
REPO_ROOT = Path(__file__).resolve().parent.parent.parent
|
||||||
|
|
||||||
|
# CI caches parts of this path; keep in sync with ci.yml integration-tests.
|
||||||
|
INTEGRATION_TESTS_ROOT = Path.home() / ".esphome-integration-tests"
|
||||||
|
|
||||||
|
|
||||||
def _get_platformio_env(cache_dir: Path) -> dict[str, str]:
|
def _get_platformio_env(cache_dir: Path) -> dict[str, str]:
|
||||||
"""Get environment variables for PlatformIO with shared cache."""
|
"""Get environment variables for PlatformIO with shared cache."""
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
@@ -78,7 +104,7 @@ def _get_platformio_env(cache_dir: Path) -> dict[str, str]:
|
|||||||
)
|
)
|
||||||
# Compile with THIS tree's esphome sources, not wherever the venv's editable
|
# Compile with THIS tree's esphome sources, not wherever the venv's editable
|
||||||
# install points (which may be a different git worktree or checkout).
|
# install points (which may be a different git worktree or checkout).
|
||||||
repo_root = str(Path(__file__).resolve().parent.parent.parent)
|
repo_root = str(REPO_ROOT)
|
||||||
existing = env.get("PYTHONPATH")
|
existing = env.get("PYTHONPATH")
|
||||||
env["PYTHONPATH"] = f"{repo_root}{os.pathsep}{existing}" if existing else repo_root
|
env["PYTHONPATH"] = f"{repo_root}{os.pathsep}{existing}" if existing else repo_root
|
||||||
return env
|
return env
|
||||||
@@ -88,8 +114,7 @@ def _get_platformio_env(cache_dir: Path) -> dict[str, str]:
|
|||||||
def shared_platformio_cache() -> Generator[Path]:
|
def shared_platformio_cache() -> Generator[Path]:
|
||||||
"""Initialize a shared PlatformIO cache for all integration tests."""
|
"""Initialize a shared PlatformIO cache for all integration tests."""
|
||||||
# Use a dedicated directory for integration tests to avoid conflicts.
|
# Use a dedicated directory for integration tests to avoid conflicts.
|
||||||
# CI caches parts of this path; keep in sync with ci.yml integration-tests.
|
test_cache_dir = INTEGRATION_TESTS_ROOT
|
||||||
test_cache_dir = Path.home() / ".esphome-integration-tests"
|
|
||||||
cache_dir = test_cache_dir / "platformio"
|
cache_dir = test_cache_dir / "platformio"
|
||||||
|
|
||||||
# Use a lock file in the home directory to ensure only one process initializes the cache
|
# Use a lock file in the home directory to ensure only one process initializes the cache
|
||||||
@@ -112,7 +137,9 @@ def shared_platformio_cache() -> Generator[Path]:
|
|||||||
init_dir = Path(tmpdir)
|
init_dir = Path(tmpdir)
|
||||||
fixture_path = Path(__file__).parent / "fixtures" / "cache_init.yaml"
|
fixture_path = Path(__file__).parent / "fixtures" / "cache_init.yaml"
|
||||||
config_path = init_dir / "cache_init.yaml"
|
config_path = init_dir / "cache_init.yaml"
|
||||||
config_path.write_text(fixture_path.read_text())
|
config_path.write_text(
|
||||||
|
fixture_path.read_text(encoding="utf-8"), encoding="utf-8"
|
||||||
|
)
|
||||||
|
|
||||||
# Run compilation to populate the cache
|
# Run compilation to populate the cache
|
||||||
# We must succeed here to avoid race conditions where multiple
|
# We must succeed here to avoid race conditions where multiple
|
||||||
@@ -162,13 +189,6 @@ def integration_test_dir() -> Generator[Path]:
|
|||||||
yield Path(tmpdir)
|
yield Path(tmpdir)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def isolated_preferences(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> None:
|
|
||||||
"""Host preferences persist per device name; give the test its own so a
|
|
||||||
provisioned key never leaks into another run."""
|
|
||||||
monkeypatch.setenv("ESPHOME_PREFDIR", str(tmp_path / "prefs"))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def reserved_tcp_port() -> Generator[tuple[int, socket.socket]]:
|
def reserved_tcp_port() -> Generator[tuple[int, socket.socket]]:
|
||||||
"""Reserve an unused TCP port by holding the socket open."""
|
"""Reserve an unused TCP port by holding the socket open."""
|
||||||
@@ -188,21 +208,29 @@ def unused_tcp_port(reserved_tcp_port: tuple[int, socket.socket]) -> int:
|
|||||||
return reserved_tcp_port[0]
|
return reserved_tcp_port[0]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def isolated_preferences(monkeypatch: pytest.MonkeyPatch, tmp_path: Path) -> Path:
|
||||||
|
"""Give every test its own host prefs dir; prefs are keyed only by device
|
||||||
|
name, which tests sharing a fixture also share."""
|
||||||
|
prefdir = tmp_path / "prefs"
|
||||||
|
monkeypatch.setenv("ESPHOME_PREFDIR", str(prefdir))
|
||||||
|
return prefdir
|
||||||
|
|
||||||
|
|
||||||
@pytest_asyncio.fixture
|
@pytest_asyncio.fixture
|
||||||
async def yaml_config(request: pytest.FixtureRequest, unused_tcp_port: int) -> str:
|
async def yaml_config(request: pytest.FixtureRequest, unused_tcp_port: int) -> str:
|
||||||
"""Load YAML configuration based on test name."""
|
"""Load YAML configuration based on test name."""
|
||||||
# Get the test function name
|
shared_name = _shared_yaml_name(request)
|
||||||
test_name: str = request.node.name
|
# Base test name: test_ prefix and any parametrization stripped
|
||||||
# Extract the base test name (remove test_ prefix and any parametrization)
|
base_name = shared_name or request.node.name.replace("test_", "").partition("[")[0]
|
||||||
base_name = test_name.replace("test_", "").partition("[")[0]
|
|
||||||
|
|
||||||
# Load the fixture file
|
# Load the fixture file
|
||||||
fixture_path = Path(__file__).parent / "fixtures" / f"{base_name}.yaml"
|
fixture_path = FIXTURES_DIR / f"{base_name}.yaml"
|
||||||
if not fixture_path.exists():
|
if not fixture_path.exists():
|
||||||
raise FileNotFoundError(f"Fixture file not found: {fixture_path}")
|
raise FileNotFoundError(f"Fixture file not found: {fixture_path}")
|
||||||
|
|
||||||
loop = asyncio.get_running_loop()
|
loop = asyncio.get_running_loop()
|
||||||
content = await loop.run_in_executor(None, fixture_path.read_text)
|
content = await loop.run_in_executor(None, read_file, fixture_path)
|
||||||
|
|
||||||
# Replace the port in the config if it contains api section
|
# Replace the port in the config if it contains api section
|
||||||
if "api:" in content:
|
if "api:" in content:
|
||||||
@@ -226,11 +254,13 @@ async def yaml_config(request: pytest.FixtureRequest, unused_tcp_port: int) -> s
|
|||||||
|
|
||||||
# Replace external component path placeholder if present
|
# Replace external component path placeholder if present
|
||||||
if "EXTERNAL_COMPONENT_PATH" in content:
|
if "EXTERNAL_COMPONENT_PATH" in content:
|
||||||
external_components_path = str(
|
external_components_path = str(FIXTURES_DIR / "external_components")
|
||||||
Path(__file__).parent / "fixtures" / "external_components"
|
|
||||||
)
|
|
||||||
content = content.replace("EXTERNAL_COMPONENT_PATH", external_components_path)
|
content = content.replace("EXTERNAL_COMPONENT_PATH", external_components_path)
|
||||||
|
|
||||||
|
if shared_name is not None:
|
||||||
|
# _compile verifies the marked test compiles this content unmodified
|
||||||
|
request.node._shared_yaml_content = content
|
||||||
|
|
||||||
return content
|
return content
|
||||||
|
|
||||||
|
|
||||||
@@ -240,24 +270,218 @@ async def write_yaml_config(
|
|||||||
) -> AsyncGenerator[ConfigWriter]:
|
) -> AsyncGenerator[ConfigWriter]:
|
||||||
"""Write YAML configuration to a file."""
|
"""Write YAML configuration to a file."""
|
||||||
# Get the test name for default filename
|
# Get the test name for default filename
|
||||||
test_name = request.node.name
|
base_name = request.node.name.replace("test_", "").partition("[")[0]
|
||||||
base_name = test_name.replace("test_", "").split("[")[0]
|
|
||||||
|
|
||||||
async def _write_config(content: str, filename: str | None = None) -> Path:
|
async def _write_config(content: str, filename: str | None = None) -> Path:
|
||||||
if filename is None:
|
if filename is None:
|
||||||
filename = f"{base_name}.yaml"
|
filename = f"{base_name}.yaml"
|
||||||
config_path = integration_test_dir / filename
|
config_path = integration_test_dir / filename
|
||||||
loop = asyncio.get_running_loop()
|
loop = asyncio.get_running_loop()
|
||||||
await loop.run_in_executor(None, config_path.write_text, content)
|
await loop.run_in_executor(None, write_file, config_path, content)
|
||||||
return config_path
|
return config_path
|
||||||
|
|
||||||
yield _write_config
|
yield _write_config
|
||||||
|
|
||||||
|
|
||||||
|
# Deliberately not CI-cached (ci.yml caches only platformio/ subpaths); stale
|
||||||
|
# dirs for a fixture are pruned when its content hash changes.
|
||||||
|
SHARED_BUILDS_ROOT = INTEGRATION_TESTS_ROOT / "builds"
|
||||||
|
|
||||||
|
# In the dir name (not just the hash) so pruning stays inside this checkout
|
||||||
|
_REPO_KEY = hashlib.sha256(str(REPO_ROOT).encode()).hexdigest()[:8]
|
||||||
|
|
||||||
|
# Give a contended shared build lock time for a full cold compile ahead of us
|
||||||
|
_SHARED_LOCK_TIMEOUT_S = 900
|
||||||
|
_SHARED_LOCK_POLL_S = 0.1
|
||||||
|
_SHARED_LOCK_REPORT_S = 30
|
||||||
|
|
||||||
|
# Reclaims dirs orphaned by fixture renames or deleted checkouts
|
||||||
|
_STALE_BUILD_MAX_AGE_S = 30 * 24 * 3600
|
||||||
|
|
||||||
|
# ELF path per shared build dir; constant once compiled, so resolve it only once
|
||||||
|
_shared_elf_paths: dict[Path, Path] = {}
|
||||||
|
|
||||||
|
# Dirs this process already swept; pruning is session-scoped work
|
||||||
|
_pruned_dirs: set[Path] = set()
|
||||||
|
|
||||||
|
|
||||||
|
def _shared_yaml_name(request: pytest.FixtureRequest) -> str | None:
|
||||||
|
"""Name passed to the shared_yaml marker, or None when unmarked."""
|
||||||
|
marker = request.node.get_closest_marker("shared_yaml")
|
||||||
|
if marker is None:
|
||||||
|
return None
|
||||||
|
# Exactly one \w+ positional arg: the name doubles as a build dir
|
||||||
|
# component, and CI test selection (script/helpers.py) parses the same shape
|
||||||
|
if (
|
||||||
|
len(marker.args) != 1
|
||||||
|
or marker.kwargs
|
||||||
|
or not re.fullmatch(r"\w+", str(marker.args[0]))
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
"shared_yaml marker requires exactly one \\w+ fixture name literal"
|
||||||
|
)
|
||||||
|
return marker.args[0]
|
||||||
|
|
||||||
|
|
||||||
|
def _shared_build_prefix(name: str) -> str:
|
||||||
|
return f"{name}-{_REPO_KEY}-"
|
||||||
|
|
||||||
|
|
||||||
|
@cache
|
||||||
|
def _shared_build_dir(name: str) -> Path:
|
||||||
|
"""Dir keyed by checkout and fixture source, before per-test injections."""
|
||||||
|
key = hashlib.sha256((FIXTURES_DIR / f"{name}.yaml").read_bytes()).hexdigest()[:16]
|
||||||
|
return SHARED_BUILDS_ROOT / (_shared_build_prefix(name) + key)
|
||||||
|
|
||||||
|
|
||||||
|
def _read_stamp(stamp: Path, shared_dir: Path) -> Path | None:
|
||||||
|
"""ELF path recorded by the last completed compile, or None."""
|
||||||
|
try:
|
||||||
|
text = stamp.read_text(encoding="utf-8").strip()
|
||||||
|
except FileNotFoundError:
|
||||||
|
return None
|
||||||
|
except OSError as err:
|
||||||
|
print(f"Cannot read {stamp}: {err}")
|
||||||
|
return None
|
||||||
|
if not text:
|
||||||
|
print(f"Ignoring empty stamp {stamp}")
|
||||||
|
return None
|
||||||
|
built = Path(text)
|
||||||
|
# Never trust a stamp pointing outside its own build dir as an unlink target
|
||||||
|
if shared_dir.resolve() in built.resolve().parents:
|
||||||
|
return built
|
||||||
|
print(f"Ignoring stamp {stamp} pointing outside {shared_dir}")
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def _unused_since(stale: Path, cutoff: float) -> bool:
|
||||||
|
"""Whether a build dir looks untouched since cutoff; unknown counts as used."""
|
||||||
|
# Newest of the .built stamp (rewritten by every completed compile) and the
|
||||||
|
# dir itself (freshened by a worker claiming the dir before locking)
|
||||||
|
newest: float | None = None
|
||||||
|
for probe in (stale / ".built", stale):
|
||||||
|
try:
|
||||||
|
mtime = probe.stat().st_mtime
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue
|
||||||
|
except NotADirectoryError:
|
||||||
|
return True # a stray file where a dir should be; reclaimable
|
||||||
|
except OSError as err:
|
||||||
|
print(f"Cannot age-probe {stale}: {err}")
|
||||||
|
return False # unknown never authorizes deletion
|
||||||
|
newest = mtime if newest is None else max(newest, mtime)
|
||||||
|
return newest is not None and newest < cutoff
|
||||||
|
|
||||||
|
|
||||||
|
def _prune_stale_builds(name: str, keep: Path) -> None:
|
||||||
|
"""Remove outdated build dirs (blocking, run in executor): this checkout's
|
||||||
|
other dirs for the fixture, plus anything untouched for 30 days. Tolerates
|
||||||
|
other workers pruning the same dirs concurrently."""
|
||||||
|
cutoff = time.time() - _STALE_BUILD_MAX_AGE_S
|
||||||
|
prefix = _shared_build_prefix(name)
|
||||||
|
for stale in SHARED_BUILDS_ROOT.iterdir():
|
||||||
|
if stale == keep:
|
||||||
|
continue
|
||||||
|
same_fixture = stale.name.startswith(prefix)
|
||||||
|
if not same_fixture and not _unused_since(stale, cutoff):
|
||||||
|
continue
|
||||||
|
# Creating .lock bumps the dir mtime, so remember whether the re-probe
|
||||||
|
# under the lock can trust it
|
||||||
|
lock_preexisting = (stale / ".lock").exists()
|
||||||
|
try:
|
||||||
|
lock_file = (stale / ".lock").open("w")
|
||||||
|
except FileNotFoundError:
|
||||||
|
continue # pruned by another worker meanwhile
|
||||||
|
except NotADirectoryError:
|
||||||
|
print(f"Removing stray file {stale}")
|
||||||
|
stale.unlink(missing_ok=True)
|
||||||
|
continue
|
||||||
|
except OSError as err:
|
||||||
|
print(f"Cannot prune {stale}: {err}")
|
||||||
|
continue
|
||||||
|
with lock_file:
|
||||||
|
try:
|
||||||
|
fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||||
|
except BlockingIOError:
|
||||||
|
continue # still in use by another run
|
||||||
|
# Re-probe under the lock: a worker freshens its dir before
|
||||||
|
# locking, so a just-claimed dir no longer looks unused. A dir
|
||||||
|
# whose .lock we just created cannot be held by anyone, and our
|
||||||
|
# own open bumped its mtime, so its pre-open probe stands
|
||||||
|
if (
|
||||||
|
lock_preexisting
|
||||||
|
and not same_fixture
|
||||||
|
and not _unused_since(stale, cutoff)
|
||||||
|
):
|
||||||
|
continue
|
||||||
|
# rmtree tolerates races; a leftover partial tree only costs a
|
||||||
|
# rebuild, since the ELF is deleted before every compile
|
||||||
|
try:
|
||||||
|
rmtree(stale)
|
||||||
|
except OSError as err:
|
||||||
|
print(f"Failed to prune {stale}: {err}")
|
||||||
|
|
||||||
|
|
||||||
|
async def _run_esphome_compile(
|
||||||
|
config_path: Path, cwd: Path, env: dict[str, str]
|
||||||
|
) -> None:
|
||||||
|
"""Run `esphome compile`, retrying up to 3 times on a segfault."""
|
||||||
|
max_retries = 3
|
||||||
|
for attempt in range(max_retries):
|
||||||
|
# Compile using subprocess, inheriting stdout/stderr to show progress
|
||||||
|
proc = await asyncio.create_subprocess_exec(
|
||||||
|
sys.executable,
|
||||||
|
"-m",
|
||||||
|
"esphome",
|
||||||
|
"compile",
|
||||||
|
str(config_path),
|
||||||
|
cwd=cwd,
|
||||||
|
stdout=None, # Inherit stdout
|
||||||
|
stderr=None, # Inherit stderr
|
||||||
|
stdin=asyncio.subprocess.DEVNULL,
|
||||||
|
# Start in a new process group to isolate signal handling
|
||||||
|
start_new_session=True,
|
||||||
|
env=env,
|
||||||
|
close_fds=False,
|
||||||
|
)
|
||||||
|
await proc.wait()
|
||||||
|
|
||||||
|
if proc.returncode == 0:
|
||||||
|
break
|
||||||
|
if proc.returncode == -11 and attempt < max_retries - 1:
|
||||||
|
# Segfault (-11 = SIGSEGV), retry
|
||||||
|
print(
|
||||||
|
f"Compilation segfaulted (attempt {attempt + 1}/{max_retries}), retrying..."
|
||||||
|
)
|
||||||
|
await asyncio.sleep(1) # Brief pause before retry
|
||||||
|
continue
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Failed to compile {config_path}, return code: {proc.returncode}. "
|
||||||
|
f"Run with 'pytest -s' to see compilation output."
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve_compiled_binary(config_path: Path) -> Path:
|
||||||
|
"""Load the config to learn the compiled ELF path (blocking, run in executor)."""
|
||||||
|
CORE.reset() # Reset CORE state between test runs
|
||||||
|
CORE.config_path = config_path
|
||||||
|
config = esphome.config.read_config(
|
||||||
|
{"command": "compile", "config": str(config_path)}
|
||||||
|
)
|
||||||
|
if config is None:
|
||||||
|
raise RuntimeError(f"Failed to read config from {config_path}")
|
||||||
|
idedata = get_idedata(config)
|
||||||
|
binary_path = Path(idedata.firmware_elf_path)
|
||||||
|
if not binary_path.exists():
|
||||||
|
raise RuntimeError(f"Compiled binary not found at {binary_path}")
|
||||||
|
return binary_path
|
||||||
|
|
||||||
|
|
||||||
@pytest_asyncio.fixture
|
@pytest_asyncio.fixture
|
||||||
async def compile_esphome(
|
async def compile_esphome(
|
||||||
integration_test_dir: Path,
|
integration_test_dir: Path,
|
||||||
shared_platformio_cache: Path,
|
shared_platformio_cache: Path,
|
||||||
|
request: pytest.FixtureRequest,
|
||||||
) -> AsyncGenerator[CompileFunction]:
|
) -> AsyncGenerator[CompileFunction]:
|
||||||
"""Compile an ESPHome configuration and return the binary path."""
|
"""Compile an ESPHome configuration and return the binary path."""
|
||||||
|
|
||||||
@@ -265,66 +489,96 @@ async def compile_esphome(
|
|||||||
# Use the shared PlatformIO cache for faster compilation
|
# Use the shared PlatformIO cache for faster compilation
|
||||||
# This avoids re-downloading dependencies for each test
|
# This avoids re-downloading dependencies for each test
|
||||||
env = _get_platformio_env(shared_platformio_cache)
|
env = _get_platformio_env(shared_platformio_cache)
|
||||||
|
|
||||||
# Retry compilation up to 3 times if we get a segfault
|
|
||||||
max_retries = 3
|
|
||||||
for attempt in range(max_retries):
|
|
||||||
# Compile using subprocess, inheriting stdout/stderr to show progress
|
|
||||||
proc = await asyncio.create_subprocess_exec(
|
|
||||||
sys.executable,
|
|
||||||
"-m",
|
|
||||||
"esphome",
|
|
||||||
"compile",
|
|
||||||
str(config_path),
|
|
||||||
cwd=integration_test_dir,
|
|
||||||
stdout=None, # Inherit stdout
|
|
||||||
stderr=None, # Inherit stderr
|
|
||||||
stdin=asyncio.subprocess.DEVNULL,
|
|
||||||
# Start in a new process group to isolate signal handling
|
|
||||||
start_new_session=True,
|
|
||||||
env=env,
|
|
||||||
close_fds=False,
|
|
||||||
)
|
|
||||||
await proc.wait()
|
|
||||||
|
|
||||||
if proc.returncode == 0:
|
|
||||||
# Success!
|
|
||||||
break
|
|
||||||
if proc.returncode == -11 and attempt < max_retries - 1:
|
|
||||||
# Segfault (-11 = SIGSEGV), retry
|
|
||||||
print(
|
|
||||||
f"Compilation segfaulted (attempt {attempt + 1}/{max_retries}), retrying..."
|
|
||||||
)
|
|
||||||
await asyncio.sleep(1) # Brief pause before retry
|
|
||||||
continue
|
|
||||||
# Other error or final retry
|
|
||||||
raise RuntimeError(
|
|
||||||
f"Failed to compile {config_path}, return code: {proc.returncode}. "
|
|
||||||
f"Run with 'pytest -s' to see compilation output."
|
|
||||||
)
|
|
||||||
|
|
||||||
# Load the config to get idedata (blocking call, must use executor)
|
|
||||||
loop = asyncio.get_running_loop()
|
loop = asyncio.get_running_loop()
|
||||||
|
|
||||||
def _read_config_and_get_binary():
|
name = _shared_yaml_name(request)
|
||||||
CORE.reset() # Reset CORE state between test runs
|
if name is None:
|
||||||
CORE.config_path = config_path
|
await _run_esphome_compile(config_path, integration_test_dir, env)
|
||||||
config = esphome.config.read_config(
|
return await loop.run_in_executor(
|
||||||
{"command": "compile", "config": str(config_path)}
|
None, _resolve_compiled_binary, config_path
|
||||||
)
|
)
|
||||||
if config is None:
|
|
||||||
raise RuntimeError(f"Failed to read config from {config_path}")
|
|
||||||
|
|
||||||
# Get the compiled binary path
|
# Shared fixture: build in a hash-keyed dir so tests sharing a config
|
||||||
idedata = get_idedata(config)
|
# pay one full compile and later only a main.cpp (port) rebuild + relink
|
||||||
return Path(idedata.firmware_elf_path)
|
shared_dir = _shared_build_dir(name)
|
||||||
|
shared_dir.mkdir(parents=True, exist_ok=True)
|
||||||
binary_path = await loop.run_in_executor(None, _read_config_and_get_binary)
|
# Freshen the dir before locking so a concurrent age sweep, which
|
||||||
|
# re-probes under the lock, never reaps a dir a worker just claimed;
|
||||||
if not binary_path.exists():
|
# if a peer reaped it already, the guarded lock open recreates it
|
||||||
raise RuntimeError(f"Compiled binary not found at {binary_path}")
|
with suppress(FileNotFoundError):
|
||||||
|
os.utime(shared_dir)
|
||||||
return binary_path
|
if shared_dir not in _pruned_dirs:
|
||||||
|
_pruned_dirs.add(shared_dir)
|
||||||
|
await loop.run_in_executor(None, _prune_stale_builds, name, shared_dir)
|
||||||
|
shared_config = shared_dir / f"{name}.yaml"
|
||||||
|
private_binary = integration_test_dir / f"{name}.elf"
|
||||||
|
content = await loop.run_in_executor(None, read_file, config_path)
|
||||||
|
if content != getattr(request.node, "_shared_yaml_content", None):
|
||||||
|
# The dir is keyed by the fixture source; a mutated config would be
|
||||||
|
# cached under a hash that does not describe it
|
||||||
|
raise RuntimeError(
|
||||||
|
"shared_yaml tests must compile the yaml_config content unmodified"
|
||||||
|
)
|
||||||
|
# flock serializes concurrent xdist workers; closing the fd releases it.
|
||||||
|
# Hand-rolled rather than filelock.FileLock: non-blocking retries keep
|
||||||
|
# the wait cancellable, while a blocking acquire in an executor thread
|
||||||
|
# would survive test cancellation holding the fd
|
||||||
|
try:
|
||||||
|
lock_file = (shared_dir / ".lock").open("w")
|
||||||
|
except FileNotFoundError:
|
||||||
|
# A peer run pruning divergent hashes reaped the dir between our
|
||||||
|
# mkdir and this open; recreate it and pay a full rebuild
|
||||||
|
shared_dir.mkdir(parents=True, exist_ok=True)
|
||||||
|
lock_file = (shared_dir / ".lock").open("w")
|
||||||
|
with lock_file:
|
||||||
|
start = time.monotonic()
|
||||||
|
last_report = start
|
||||||
|
while True:
|
||||||
|
try:
|
||||||
|
fcntl.flock(lock_file.fileno(), fcntl.LOCK_EX | fcntl.LOCK_NB)
|
||||||
|
break
|
||||||
|
except BlockingIOError:
|
||||||
|
now = time.monotonic()
|
||||||
|
if now - start > _SHARED_LOCK_TIMEOUT_S:
|
||||||
|
raise RuntimeError(
|
||||||
|
f"Timed out waiting for the {shared_dir} lock"
|
||||||
|
) from None
|
||||||
|
if now - last_report >= _SHARED_LOCK_REPORT_S:
|
||||||
|
last_report = now
|
||||||
|
print(
|
||||||
|
f"Waited {now - start:.0f}s for another worker's "
|
||||||
|
f"build of {shared_dir.name}"
|
||||||
|
)
|
||||||
|
await asyncio.sleep(_SHARED_LOCK_POLL_S)
|
||||||
|
# .built carries the ELF path of the last completed compile, so
|
||||||
|
# later workers skip the config re-read in _resolve_compiled_binary
|
||||||
|
stamp = shared_dir / ".built"
|
||||||
|
if (built := _shared_elf_paths.get(shared_dir)) is None:
|
||||||
|
built = await loop.run_in_executor(None, _read_stamp, stamp, shared_dir)
|
||||||
|
# Delete the ELF before compiling: whatever exists afterwards is
|
||||||
|
# this compile's output, so no staleness check is ever needed.
|
||||||
|
# With no usable stamp, sweep any leftover at the known layout
|
||||||
|
if built is not None:
|
||||||
|
built.unlink(missing_ok=True)
|
||||||
|
else:
|
||||||
|
# Layout-agnostic: ESPHOME_BUILD_PATH can move the build tree
|
||||||
|
for leftover in shared_dir.rglob("program"):
|
||||||
|
if leftover.is_file():
|
||||||
|
leftover.unlink()
|
||||||
|
await loop.run_in_executor(
|
||||||
|
None, write_file_if_changed, shared_config, content
|
||||||
|
)
|
||||||
|
await _run_esphome_compile(shared_config, shared_dir, env)
|
||||||
|
if built is None or not built.exists():
|
||||||
|
built = await loop.run_in_executor(
|
||||||
|
None, _resolve_compiled_binary, shared_config
|
||||||
|
)
|
||||||
|
_shared_elf_paths[shared_dir] = built
|
||||||
|
await loop.run_in_executor(None, write_file, stamp, str(built))
|
||||||
|
# Copy out before unlocking: another worker may relink firmware.elf
|
||||||
|
# while this test is still running its private copy
|
||||||
|
await loop.run_in_executor(None, shutil.copy2, built, private_binary)
|
||||||
|
return private_binary
|
||||||
|
|
||||||
yield _compile
|
yield _compile
|
||||||
|
|
||||||
|
|||||||
@@ -1,58 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: test-batch-window-filters
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
batch_delay: 0ms # Disable batching to receive all state updates
|
|
||||||
logger:
|
|
||||||
level: DEBUG
|
|
||||||
|
|
||||||
# Template sensor that we'll use to publish values
|
|
||||||
sensor:
|
|
||||||
- platform: template
|
|
||||||
name: "Source Sensor"
|
|
||||||
id: source_sensor
|
|
||||||
accuracy_decimals: 2
|
|
||||||
|
|
||||||
# Batch window filters (window_size == send_every) - use streaming filters
|
|
||||||
- platform: copy
|
|
||||||
source_id: source_sensor
|
|
||||||
name: "Min Sensor"
|
|
||||||
id: min_sensor
|
|
||||||
filters:
|
|
||||||
- min:
|
|
||||||
window_size: 5
|
|
||||||
send_every: 5
|
|
||||||
send_first_at: 1
|
|
||||||
|
|
||||||
- platform: copy
|
|
||||||
source_id: source_sensor
|
|
||||||
name: "Max Sensor"
|
|
||||||
id: max_sensor
|
|
||||||
filters:
|
|
||||||
- max:
|
|
||||||
window_size: 5
|
|
||||||
send_every: 5
|
|
||||||
send_first_at: 1
|
|
||||||
|
|
||||||
- platform: copy
|
|
||||||
source_id: source_sensor
|
|
||||||
name: "Moving Avg Sensor"
|
|
||||||
id: moving_avg_sensor
|
|
||||||
filters:
|
|
||||||
- sliding_window_moving_average:
|
|
||||||
window_size: 5
|
|
||||||
send_every: 5
|
|
||||||
send_first_at: 1
|
|
||||||
|
|
||||||
# Button to trigger publishing test values
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Publish Values Button"
|
|
||||||
id: publish_button
|
|
||||||
on_press:
|
|
||||||
- lambda: |-
|
|
||||||
// Publish 10 values: 1.0, 2.0, ..., 10.0
|
|
||||||
for (int i = 1; i <= 10; i++) {
|
|
||||||
id(source_sensor).publish_state(float(i));
|
|
||||||
}
|
|
||||||
@@ -1,111 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-cli-rw
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
# Two virtual buses looped back to each other: the client's transmissions reach the server and the
|
|
||||||
# server's replies reach the client. auto_start so forwarding is active before the button fires.
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_client
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_client
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
globals:
|
|
||||||
- id: stored_1
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "0"
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_client
|
|
||||||
id: virtual_modbus_client
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
registers:
|
|
||||||
# Writable + readable register: the read publishes what it returns, so the test can confirm the
|
|
||||||
# write half of the 0x17 ran before the read half (Modbus 6.17).
|
|
||||||
- address: 0x01
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: |-
|
|
||||||
id(srv_read_1).publish_state(id(stored_1));
|
|
||||||
return id(stored_1);
|
|
||||||
write_lambda: |-
|
|
||||||
id(stored_1) = x;
|
|
||||||
id(srv_write_1).publish_state(x);
|
|
||||||
return true;
|
|
||||||
# Read-only register, returned together with 0x01 by the 2-register read half.
|
|
||||||
- address: 0x02
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return 0x00AA;
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
# Server-side observations.
|
|
||||||
- platform: template
|
|
||||||
name: "srv_write_1"
|
|
||||||
id: srv_write_1
|
|
||||||
- platform: template
|
|
||||||
name: "srv_read_1"
|
|
||||||
id: srv_read_1
|
|
||||||
# Client-side read-back: the values the client's on_response received.
|
|
||||||
- platform: template
|
|
||||||
name: "client_read_0"
|
|
||||||
id: client_read_0
|
|
||||||
- platform: template
|
|
||||||
name: "client_read_1"
|
|
||||||
id: client_read_1
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
on_press:
|
|
||||||
# FC 0x17: write reg 0x0001 = 0x1234, then read regs 0x0001..0x0002 back in the same transaction.
|
|
||||||
- modbus_client.read_write_multiple_registers:
|
|
||||||
address: 0x01
|
|
||||||
read_address: 0x0001
|
|
||||||
read_count: 2
|
|
||||||
write_address: 0x0001
|
|
||||||
values: [0x1234]
|
|
||||||
on_response:
|
|
||||||
then:
|
|
||||||
- lambda: |-
|
|
||||||
// values is the read-back block: reg 0x0001 (must be the just-written 0x1234) and reg 0x0002.
|
|
||||||
if (values.size() >= 2) {
|
|
||||||
id(client_read_0).publish_state(values[0]);
|
|
||||||
id(client_read_1).publish_state(values[1]);
|
|
||||||
}
|
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-custom-pdu
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_controller
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_controller
|
|
||||||
id: modbus_controller_1
|
|
||||||
update_interval: 1s
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
|
||||||
- address: 0x01
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return 259;
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
# Plain read to confirm the controller <-> server link is up.
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "plain_read"
|
|
||||||
address: 0x01
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
# Custom PDU: read holding register 0x0001, count 1. The PDU is
|
|
||||||
# {function code, address hi, address lo, count hi, count lo}; the device
|
|
||||||
# address and CRC are added by the hub. The lambda parses the response payload
|
|
||||||
# (the register value, big-endian).
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "custom_read"
|
|
||||||
custom_pdu: [0x03, 0x00, 0x01, 0x00, 0x01]
|
|
||||||
lambda: |-
|
|
||||||
if (data.size() < 2) return {};
|
|
||||||
return (float) ((data[0] << 8) | data[1]);
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# This test does not have anything to start (mock is autostart)
|
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-dep-buffer
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
globals:
|
|
||||||
- id: reg10
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "0"
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_controller
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_controller
|
|
||||||
id: modbus_controller_1
|
|
||||||
update_interval: 1s
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
|
||||||
- address: 0x10
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg10);
|
|
||||||
write_lambda: |-
|
|
||||||
id(reg10) = x;
|
|
||||||
return true;
|
|
||||||
|
|
||||||
# A number whose write_lambda uses the DEPRECATED buffer parameter (fills `payload` with a legacy raw
|
|
||||||
# frame as words: device address + function code + data) instead of the new item->write_* API. The write
|
|
||||||
# must still land with its legacy semantics, and the one-time deprecation warning must fire only once per
|
|
||||||
# entity no matter how many writes happen.
|
|
||||||
number:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "buf_number"
|
|
||||||
id: buf_number
|
|
||||||
address: 0x10
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
min_value: 0
|
|
||||||
max_value: 1000
|
|
||||||
step: 1
|
|
||||||
write_lambda: |-
|
|
||||||
// Legacy raw frame as words: [addr 0x01 | fc 0x06], register 0x0010, value.
|
|
||||||
payload.push_back(0x0106);
|
|
||||||
payload.push_back(0x0010);
|
|
||||||
payload.push_back((uint16_t) x);
|
|
||||||
return {};
|
|
||||||
|
|
||||||
# Reports the server-side register so the test can observe that the deprecated buffer write landed.
|
|
||||||
sensor:
|
|
||||||
- platform: template
|
|
||||||
name: "written_value"
|
|
||||||
id: written_value
|
|
||||||
update_interval: 0.5s
|
|
||||||
lambda: "return id(reg10);"
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# The test drives the writes via number_command; the mock is autostart.
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-lambda-invert
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
globals:
|
|
||||||
- id: reg40
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "5"
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_controller
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_controller
|
|
||||||
id: modbus_controller_1
|
|
||||||
update_interval: 1s
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
|
||||||
- address: 0x40
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg40);
|
|
||||||
write_lambda: id(reg40) = x; return true;
|
|
||||||
|
|
||||||
# An active-low holding switch: the write_lambda inverts the wire value, but the entity must still
|
|
||||||
# report the REQUESTED state. assumed_state keeps the register unpolled, so the published state comes
|
|
||||||
# only from write_state() - turning ON writes 0x0000 yet the switch shows ON.
|
|
||||||
switch:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "invert_switch"
|
|
||||||
register_type: holding
|
|
||||||
address: 0x40
|
|
||||||
assumed_state: true
|
|
||||||
write_lambda: |-
|
|
||||||
return !x;
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_40"
|
|
||||||
address: 0x40
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# This test does not have anything to start (mock is autostart)
|
|
||||||
@@ -1,97 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-lambda-write
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
globals:
|
|
||||||
- id: reg30
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "0"
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_controller
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_controller
|
|
||||||
id: modbus_controller_1
|
|
||||||
update_interval: 1s
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
|
||||||
- address: 0x30
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg30);
|
|
||||||
write_lambda: id(reg30) = x; return true;
|
|
||||||
|
|
||||||
# A COIL-type switch (assumed_state, write-only) whose write_lambda ignores its own coil type and instead
|
|
||||||
# drives a HOLDING-REGISTER write on the mock server through the entity itself: `item` IS the command, so
|
|
||||||
# item->write_single_register() sends a register write from a coil entity (cross-type). Returning nothing
|
|
||||||
# (an empty optional) tells the write path the lambda already dispatched the frame - no default coil write.
|
|
||||||
switch:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "cross_switch"
|
|
||||||
register_type: coil
|
|
||||||
address: 0x00
|
|
||||||
assumed_state: true
|
|
||||||
write_lambda: |-
|
|
||||||
item->write_single_register(0x30, x ? 1234 : 0);
|
|
||||||
return {};
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_30"
|
|
||||||
address: 0x30
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# This test does not have anything to start (mock is autostart)
|
|
||||||
@@ -0,0 +1,233 @@
|
|||||||
|
esphome:
|
||||||
|
name: uart-mock-modbus-loopback
|
||||||
|
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: VERBOSE
|
||||||
|
|
||||||
|
external_components:
|
||||||
|
- source:
|
||||||
|
type: local
|
||||||
|
path: EXTERNAL_COMPONENT_PATH
|
||||||
|
|
||||||
|
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
||||||
|
# The actual UART bus used is the uart_mock component below
|
||||||
|
uart:
|
||||||
|
baud_rate: 115200
|
||||||
|
port: /dev/null
|
||||||
|
|
||||||
|
# Shared loopback fixture (see the shared_yaml markers in the test file);
|
||||||
|
# register spaces are disjoint so each test only observes its own entities.
|
||||||
|
uart_mock:
|
||||||
|
- id: virtual_uart_server
|
||||||
|
baud_rate: 9600
|
||||||
|
auto_start: true
|
||||||
|
debug:
|
||||||
|
on_tx:
|
||||||
|
- then:
|
||||||
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_controller
|
||||||
|
data: !lambda return data;
|
||||||
|
- id: virtual_uart_controller
|
||||||
|
baud_rate: 9600
|
||||||
|
auto_start: true
|
||||||
|
debug:
|
||||||
|
on_tx:
|
||||||
|
- then:
|
||||||
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_server
|
||||||
|
data: !lambda return data;
|
||||||
|
|
||||||
|
globals:
|
||||||
|
- id: reg10
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "100"
|
||||||
|
- id: reg11
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "200"
|
||||||
|
- id: reg12
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "300"
|
||||||
|
- id: reg13
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "0xABCD"
|
||||||
|
- id: reg30
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "0"
|
||||||
|
- id: reg40
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "5"
|
||||||
|
- id: reg50
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "0"
|
||||||
|
|
||||||
|
modbus:
|
||||||
|
- uart_id: virtual_uart_server
|
||||||
|
id: virtual_modbus_server
|
||||||
|
role: server
|
||||||
|
- uart_id: virtual_uart_controller
|
||||||
|
id: virtual_modbus_controller
|
||||||
|
role: client
|
||||||
|
turnaround_time: 10ms
|
||||||
|
|
||||||
|
modbus_controller:
|
||||||
|
- address: 1
|
||||||
|
modbus_id: virtual_modbus_controller
|
||||||
|
id: modbus_controller_1
|
||||||
|
update_interval: 1s
|
||||||
|
|
||||||
|
modbus_server:
|
||||||
|
- address: 1
|
||||||
|
modbus_id: virtual_modbus_server
|
||||||
|
registers:
|
||||||
|
- address: 0x01
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return 259;
|
||||||
|
- address: 0x10
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg10);
|
||||||
|
write_lambda: id(reg10) = x; return true;
|
||||||
|
- address: 0x11
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg11);
|
||||||
|
write_lambda: id(reg11) = x; return true;
|
||||||
|
- address: 0x12
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg12);
|
||||||
|
write_lambda: id(reg12) = x; return true;
|
||||||
|
- address: 0x13
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg13);
|
||||||
|
- address: 0x30
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg30);
|
||||||
|
write_lambda: id(reg30) = x; return true;
|
||||||
|
- address: 0x40
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg40);
|
||||||
|
write_lambda: id(reg40) = x; return true;
|
||||||
|
- address: 0x50
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(reg50);
|
||||||
|
write_lambda: id(reg50) = x; return true;
|
||||||
|
|
||||||
|
# Byte-based offset: 2 bytes -> register 0x11 (the old code folded it in as a
|
||||||
|
# register count, hitting 0x12). assumed_state keeps the switch write-only.
|
||||||
|
switch:
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "offset_switch"
|
||||||
|
register_type: holding
|
||||||
|
address: 0x10
|
||||||
|
offset: 2
|
||||||
|
assumed_state: true
|
||||||
|
# Reading switch, byte offset 6 -> register 0x13; the pre-fix resolution (0x16)
|
||||||
|
# would draw ILLEGAL_DATA_ADDRESS and never publish.
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "read_offset_switch"
|
||||||
|
register_type: holding
|
||||||
|
address: 0x10
|
||||||
|
offset: 6
|
||||||
|
bitmask: 0x1
|
||||||
|
# Coil switch whose write_lambda dispatches a holding-register write via `item`;
|
||||||
|
# returning an empty optional suppresses the default coil write.
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "cross_switch"
|
||||||
|
register_type: coil
|
||||||
|
address: 0x00
|
||||||
|
assumed_state: true
|
||||||
|
write_lambda: |-
|
||||||
|
item->write_single_register(0x30, x ? 1234 : 0);
|
||||||
|
return {};
|
||||||
|
# Active-low: the write_lambda inverts the wire value but the entity must still
|
||||||
|
# report the requested state (assumed_state keeps the register unpolled).
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "invert_switch"
|
||||||
|
register_type: holding
|
||||||
|
address: 0x40
|
||||||
|
assumed_state: true
|
||||||
|
write_lambda: |-
|
||||||
|
return !x;
|
||||||
|
|
||||||
|
# Uses the deprecated buffer parameter (legacy raw frame as words); the write
|
||||||
|
# must land and the deprecation warning must fire only once per entity.
|
||||||
|
number:
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "buf_number"
|
||||||
|
id: buf_number
|
||||||
|
address: 0x50
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
min_value: 0
|
||||||
|
max_value: 1000
|
||||||
|
step: 1
|
||||||
|
write_lambda: |-
|
||||||
|
// Legacy raw frame as words: [addr 0x01 | fc 0x06], register 0x0050, value.
|
||||||
|
payload.push_back(0x0106);
|
||||||
|
payload.push_back(0x0050);
|
||||||
|
payload.push_back((uint16_t) x);
|
||||||
|
return {};
|
||||||
|
|
||||||
|
sensor:
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "plain_read"
|
||||||
|
address: 0x01
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
# Custom PDU: read holding register 0x0001; device address and CRC are added
|
||||||
|
# by the hub. The lambda parses the big-endian register value.
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "custom_read"
|
||||||
|
custom_pdu: [0x03, 0x00, 0x01, 0x00, 0x01]
|
||||||
|
lambda: |-
|
||||||
|
if (data.size() < 2) return {};
|
||||||
|
return (float) ((data[0] << 8) | data[1]);
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "reg_10"
|
||||||
|
address: 0x10
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "reg_11"
|
||||||
|
address: 0x11
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "reg_12"
|
||||||
|
address: 0x12
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "reg_30"
|
||||||
|
address: 0x30
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_1
|
||||||
|
name: "reg_40"
|
||||||
|
address: 0x40
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
# Reports the server-side register so the test can observe that the deprecated buffer write landed.
|
||||||
|
- platform: template
|
||||||
|
name: "written_value"
|
||||||
|
id: written_value
|
||||||
|
update_interval: 0.5s
|
||||||
|
lambda: "return id(reg50);"
|
||||||
|
|
||||||
|
button:
|
||||||
|
- platform: template
|
||||||
|
name: "Start Scenario"
|
||||||
|
id: start_scenario_btn
|
||||||
|
# Nothing to start (mock is autostart); tests drive entities directly
|
||||||
+110
-11
@@ -1,5 +1,5 @@
|
|||||||
esphome:
|
esphome:
|
||||||
name: uart-mock-modbus-server-contro
|
name: uart-mock-modbus-mesh
|
||||||
|
|
||||||
host:
|
host:
|
||||||
api:
|
api:
|
||||||
@@ -17,13 +17,14 @@ uart:
|
|||||||
baud_rate: 115200
|
baud_rate: 115200
|
||||||
port: /dev/null
|
port: /dev/null
|
||||||
|
|
||||||
|
# Shared 3-bus mesh (see the shared_yaml markers): addr 1 = typed read-only
|
||||||
|
# registers, addr 5 = the read/write 0x17 target, addr 2/3 on the second
|
||||||
|
# server hub. auto_start everywhere: the controller polls at boot, so the
|
||||||
|
# forwarding must already be live or early requests generate warnings.
|
||||||
|
# Every test presses Start Scenario, so all merged actions fire in every test.
|
||||||
uart_mock:
|
uart_mock:
|
||||||
- id: virtual_uart_server
|
- id: virtual_uart_server
|
||||||
baud_rate: 9600
|
baud_rate: 9600
|
||||||
# auto_start must be true for loopback fixtures: the modbus controller
|
|
||||||
# polls on its update_interval immediately at boot, so the uart_mock
|
|
||||||
# forwarding must already be active or early requests are lost and
|
|
||||||
# generate modbus warnings.
|
|
||||||
auto_start: true
|
auto_start: true
|
||||||
debug:
|
debug:
|
||||||
on_tx:
|
on_tx:
|
||||||
@@ -31,35 +32,68 @@ uart_mock:
|
|||||||
- uart_mock.inject_rx:
|
- uart_mock.inject_rx:
|
||||||
id: virtual_uart_controller
|
id: virtual_uart_controller
|
||||||
data: !lambda return data;
|
data: !lambda return data;
|
||||||
- id: virtual_uart_controller
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_server_2
|
||||||
|
data: !lambda return data;
|
||||||
|
- id: virtual_uart_server_2
|
||||||
baud_rate: 9600
|
baud_rate: 9600
|
||||||
auto_start: true # See comment on virtual_uart_server above
|
auto_start: true
|
||||||
debug:
|
debug:
|
||||||
on_tx:
|
on_tx:
|
||||||
- then:
|
- then:
|
||||||
- uart_mock.inject_rx:
|
- uart_mock.inject_rx:
|
||||||
id: virtual_uart_server
|
id: virtual_uart_server
|
||||||
data: !lambda return data;
|
data: !lambda return data;
|
||||||
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_controller
|
||||||
|
data: !lambda return data;
|
||||||
|
- id: virtual_uart_controller
|
||||||
|
baud_rate: 9600
|
||||||
|
auto_start: true
|
||||||
|
debug:
|
||||||
|
on_tx:
|
||||||
|
- then:
|
||||||
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_server
|
||||||
|
data: !lambda return data;
|
||||||
|
- uart_mock.inject_rx:
|
||||||
|
id: virtual_uart_server_2
|
||||||
|
data: !lambda return data;
|
||||||
|
|
||||||
|
globals:
|
||||||
|
- id: stored_1
|
||||||
|
type: uint16_t
|
||||||
|
initial_value: "0"
|
||||||
|
|
||||||
modbus:
|
modbus:
|
||||||
- uart_id: virtual_uart_server
|
- uart_id: virtual_uart_server
|
||||||
id: virtual_modbus_server
|
id: virtual_modbus_server
|
||||||
role: server
|
role: server
|
||||||
|
- uart_id: virtual_uart_server_2
|
||||||
|
id: virtual_modbus_server_2
|
||||||
|
role: server
|
||||||
- uart_id: virtual_uart_controller
|
- uart_id: virtual_uart_controller
|
||||||
id: virtual_modbus_controller
|
id: virtual_modbus_client
|
||||||
role: client
|
role: client
|
||||||
turnaround_time: 10ms
|
turnaround_time: 10ms
|
||||||
|
|
||||||
modbus_controller:
|
modbus_controller:
|
||||||
- address: 1
|
- address: 1
|
||||||
modbus_id: virtual_modbus_controller
|
modbus_id: virtual_modbus_client
|
||||||
id: modbus_controller_1
|
id: modbus_controller_1
|
||||||
update_interval: 1s
|
update_interval: 1s
|
||||||
|
- address: 2
|
||||||
|
modbus_id: virtual_modbus_client
|
||||||
|
id: modbus_controller_2
|
||||||
|
update_interval: 1s
|
||||||
|
- address: 3
|
||||||
|
modbus_id: virtual_modbus_client
|
||||||
|
id: modbus_controller_3
|
||||||
|
update_interval: 1s
|
||||||
|
|
||||||
modbus_server:
|
modbus_server:
|
||||||
- address: 1
|
- address: 1
|
||||||
modbus_id: virtual_modbus_server
|
modbus_id: virtual_modbus_server
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
registers:
|
||||||
- address: 0x01
|
- address: 0x01
|
||||||
value_type: U_WORD
|
value_type: U_WORD
|
||||||
@@ -103,6 +137,34 @@ modbus_server:
|
|||||||
- address: 0x28
|
- address: 0x28
|
||||||
value_type: FP32_R
|
value_type: FP32_R
|
||||||
read_lambda: return 3.14;
|
read_lambda: return 3.14;
|
||||||
|
- address: 5
|
||||||
|
modbus_id: virtual_modbus_server
|
||||||
|
registers:
|
||||||
|
# Writable + readable register: srv_write_1 plus the client's read-back
|
||||||
|
# confirm the write half of the 0x17 ran before the read half (Modbus 6.17).
|
||||||
|
- address: 0x01
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return id(stored_1);
|
||||||
|
write_lambda: |-
|
||||||
|
id(stored_1) = x;
|
||||||
|
id(srv_write_1).publish_state(x);
|
||||||
|
return true;
|
||||||
|
# Read-only register, returned together with 0x01 by the 2-register read half.
|
||||||
|
- address: 0x02
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return 0x00AA;
|
||||||
|
- address: 2
|
||||||
|
modbus_id: virtual_modbus_server_2
|
||||||
|
registers:
|
||||||
|
- address: 0x01
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return 919;
|
||||||
|
- address: 3
|
||||||
|
modbus_id: virtual_modbus_server_2
|
||||||
|
registers:
|
||||||
|
- address: 0x01
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: return 929;
|
||||||
|
|
||||||
sensor:
|
sensor:
|
||||||
- platform: modbus_controller
|
- platform: modbus_controller
|
||||||
@@ -195,9 +257,46 @@ sensor:
|
|||||||
address: 0x28
|
address: 0x28
|
||||||
register_type: holding
|
register_type: holding
|
||||||
value_type: FP32_R
|
value_type: FP32_R
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_2
|
||||||
|
name: "multi_reg_a"
|
||||||
|
address: 0x01
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
- platform: modbus_controller
|
||||||
|
modbus_controller_id: modbus_controller_3
|
||||||
|
name: "multi_reg_b"
|
||||||
|
address: 0x01
|
||||||
|
register_type: holding
|
||||||
|
value_type: U_WORD
|
||||||
|
# client_read_write observations, server- and client-side.
|
||||||
|
- platform: template
|
||||||
|
name: "srv_write_1"
|
||||||
|
id: srv_write_1
|
||||||
|
- platform: template
|
||||||
|
name: "client_read_0"
|
||||||
|
id: client_read_0
|
||||||
|
- platform: template
|
||||||
|
name: "client_read_1"
|
||||||
|
id: client_read_1
|
||||||
|
|
||||||
button:
|
button:
|
||||||
- platform: template
|
- platform: template
|
||||||
name: "Start Scenario"
|
name: "Start Scenario"
|
||||||
id: start_scenario_btn
|
id: start_scenario_btn
|
||||||
# This test does not have anything to start (mock is autostart)
|
on_press:
|
||||||
|
# FC 0x17: write reg 0x0001 = 0x1234, then read regs 0x0001..0x0002 back in the same transaction.
|
||||||
|
- modbus_client.read_write_multiple_registers:
|
||||||
|
address: 5
|
||||||
|
read_address: 0x0001
|
||||||
|
read_count: 2
|
||||||
|
write_address: 0x0001
|
||||||
|
values: [0x1234]
|
||||||
|
on_response:
|
||||||
|
then:
|
||||||
|
- lambda: |-
|
||||||
|
// values is the read-back block: reg 0x0001 (must be the just-written 0x1234) and reg 0x0002.
|
||||||
|
if (values.size() >= 2) {
|
||||||
|
id(client_read_0).publish_state(values[0]);
|
||||||
|
id(client_read_1).publish_state(values[1]);
|
||||||
|
}
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-reg-offset
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
globals:
|
|
||||||
- id: reg10
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "100"
|
|
||||||
- id: reg11
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "200"
|
|
||||||
- id: reg12
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "300"
|
|
||||||
- id: reg13
|
|
||||||
type: uint16_t
|
|
||||||
initial_value: "0xABCD"
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_controller
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_controller
|
|
||||||
id: modbus_controller_1
|
|
||||||
update_interval: 1s
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
id: modbus_server_1
|
|
||||||
registers:
|
|
||||||
- address: 0x10
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg10);
|
|
||||||
write_lambda: id(reg10) = x; return true;
|
|
||||||
- address: 0x11
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg11);
|
|
||||||
write_lambda: id(reg11) = x; return true;
|
|
||||||
- address: 0x12
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg12);
|
|
||||||
write_lambda: id(reg12) = x; return true;
|
|
||||||
- address: 0x13
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return id(reg13);
|
|
||||||
write_lambda: id(reg13) = x; return true;
|
|
||||||
|
|
||||||
# A holding-register switch at 0x10 with a 2-BYTE offset. offset is byte-based, so the write must target
|
|
||||||
# register 0x10 + 2/2 = 0x11. The old (pre-fix) behavior folded offset into the address as a register
|
|
||||||
# count, hitting 0x12 instead. assumed_state keeps the switch write-only so it does not read any register.
|
|
||||||
switch:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "offset_switch"
|
|
||||||
register_type: holding
|
|
||||||
address: 0x10
|
|
||||||
offset: 2
|
|
||||||
assumed_state: true
|
|
||||||
# A holding-register switch that READS its state. Byte offset 6 -> register 0x10 + 6/2 = 0x13. Post-fix
|
|
||||||
# the switch itself resolves to 0x13 (the even byte offset folds into the address as whole registers) and
|
|
||||||
# joins the 0x10..0x13 range, so no separate 0x13 sensor is needed. Pre-fix the whole byte offset folds
|
|
||||||
# into the address (0x16), where the server answers ILLEGAL_DATA_ADDRESS and the switch never publishes.
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "read_offset_switch"
|
|
||||||
register_type: holding
|
|
||||||
address: 0x10
|
|
||||||
offset: 6
|
|
||||||
bitmask: 0x1
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_10"
|
|
||||||
address: 0x10
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_11"
|
|
||||||
address: 0x11
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_12"
|
|
||||||
address: 0x12
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# This test does not have anything to start (mock is autostart)
|
|
||||||
@@ -1,124 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-server-test
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_dev
|
|
||||||
baud_rate: 9600
|
|
||||||
rx_full_threshold: 120
|
|
||||||
rx_timeout: 2
|
|
||||||
auto_start: false
|
|
||||||
debug:
|
|
||||||
injections:
|
|
||||||
- delay: 100ms
|
|
||||||
inject_rx: [0x01, 0x03, 0x00, 0x03, 0x00, 0x01, 0x74, 0x0A] # Read holding register 3 on device 1 (basic_read)
|
|
||||||
- delay: 100ms
|
|
||||||
# Read holding register 7 on device 2
|
|
||||||
# Reply from device 2
|
|
||||||
# Read holding register 5 on device 1 (read_after_peer_response)
|
|
||||||
inject_rx:
|
|
||||||
[
|
|
||||||
0x02,
|
|
||||||
0x03,
|
|
||||||
0x00,
|
|
||||||
0x07,
|
|
||||||
0x00,
|
|
||||||
0x01,
|
|
||||||
0x35,
|
|
||||||
0xF8,
|
|
||||||
0x02,
|
|
||||||
0x03,
|
|
||||||
0x02,
|
|
||||||
0x00,
|
|
||||||
0xF0,
|
|
||||||
0xFC,
|
|
||||||
0x00,
|
|
||||||
0x01,
|
|
||||||
0x03,
|
|
||||||
0x00,
|
|
||||||
0x05,
|
|
||||||
0x00,
|
|
||||||
0x01,
|
|
||||||
0x94,
|
|
||||||
0x0B,
|
|
||||||
]
|
|
||||||
- delay: 100ms
|
|
||||||
inject_rx: [0x02, 0x03, 0x00, 0x07, 0x00, 0x01, 0x35, 0xF8] # Read holding register 7 on device 2, with no response
|
|
||||||
- delay: 100ms
|
|
||||||
# Read holding register 7 on device 2, with no response
|
|
||||||
# Read holding register A on device 1 (read_after_peer_timeout)
|
|
||||||
inject_rx:
|
|
||||||
[
|
|
||||||
0x02,
|
|
||||||
0x03,
|
|
||||||
0x00,
|
|
||||||
0x07,
|
|
||||||
0x00,
|
|
||||||
0x01,
|
|
||||||
0x35,
|
|
||||||
0xF8,
|
|
||||||
0x01,
|
|
||||||
0x03,
|
|
||||||
0x00,
|
|
||||||
0x0A,
|
|
||||||
0x00,
|
|
||||||
0x01,
|
|
||||||
0xA4,
|
|
||||||
0x08,
|
|
||||||
]
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
uart_id: virtual_uart_dev
|
|
||||||
role: server
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
registers:
|
|
||||||
- address: 0x03
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: |-
|
|
||||||
id(basic_read).publish_state(1);
|
|
||||||
return 1;
|
|
||||||
- address: 0x05
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: |-
|
|
||||||
id(read_after_peer_response).publish_state(1);
|
|
||||||
return 1;
|
|
||||||
- address: 0x0A
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: |-
|
|
||||||
id(read_after_peer_timeout).publish_state(1);
|
|
||||||
return 1;
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
- platform: template
|
|
||||||
name: "basic_read"
|
|
||||||
id: basic_read
|
|
||||||
- platform: template
|
|
||||||
name: "read_after_peer_response"
|
|
||||||
id: read_after_peer_response
|
|
||||||
- platform: template
|
|
||||||
name: "read_after_peer_timeout"
|
|
||||||
id: read_after_peer_timeout
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
on_press:
|
|
||||||
- lambda: "id(virtual_uart_dev).start_scenario();"
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: uart-mock-modbus-server-mult
|
|
||||||
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
logger:
|
|
||||||
level: VERBOSE
|
|
||||||
|
|
||||||
external_components:
|
|
||||||
- source:
|
|
||||||
type: local
|
|
||||||
path: EXTERNAL_COMPONENT_PATH
|
|
||||||
|
|
||||||
# Dummy uart entry to satisfy modbus's DEPENDENCIES = ["uart"]
|
|
||||||
# The actual UART bus used is the uart_mock component below
|
|
||||||
uart:
|
|
||||||
baud_rate: 115200
|
|
||||||
port: /dev/null
|
|
||||||
|
|
||||||
uart_mock:
|
|
||||||
- id: virtual_uart_server
|
|
||||||
baud_rate: 9600
|
|
||||||
# auto_start must be true for loopback fixtures: the modbus controller
|
|
||||||
# polls on its update_interval immediately at boot, so the uart_mock
|
|
||||||
# forwarding must already be active or early requests are lost and
|
|
||||||
# generate modbus warnings.
|
|
||||||
auto_start: true
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server_2
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_server_2
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true # See comment on virtual_uart_server above
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_controller
|
|
||||||
data: !lambda return data;
|
|
||||||
- id: virtual_uart_controller
|
|
||||||
baud_rate: 9600
|
|
||||||
auto_start: true # See comment on virtual_uart_server above
|
|
||||||
debug:
|
|
||||||
on_tx:
|
|
||||||
- then:
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server
|
|
||||||
data: !lambda return data;
|
|
||||||
- uart_mock.inject_rx:
|
|
||||||
id: virtual_uart_server_2
|
|
||||||
data: !lambda return data;
|
|
||||||
|
|
||||||
modbus:
|
|
||||||
- uart_id: virtual_uart_server
|
|
||||||
id: virtual_modbus_server
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_server_2
|
|
||||||
id: virtual_modbus_server_2
|
|
||||||
role: server
|
|
||||||
- uart_id: virtual_uart_controller
|
|
||||||
id: virtual_modbus_client
|
|
||||||
role: client
|
|
||||||
turnaround_time: 10ms
|
|
||||||
|
|
||||||
modbus_controller:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_client
|
|
||||||
update_interval: 1s
|
|
||||||
id: modbus_controller_1
|
|
||||||
- address: 2
|
|
||||||
modbus_id: virtual_modbus_client
|
|
||||||
update_interval: 1s
|
|
||||||
id: modbus_controller_2
|
|
||||||
|
|
||||||
modbus_server:
|
|
||||||
- address: 1
|
|
||||||
modbus_id: virtual_modbus_server
|
|
||||||
registers:
|
|
||||||
- address: 0x01
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return 919;
|
|
||||||
- address: 2
|
|
||||||
modbus_id: virtual_modbus_server_2
|
|
||||||
registers:
|
|
||||||
- address: 0x01
|
|
||||||
value_type: U_WORD
|
|
||||||
read_lambda: return 929;
|
|
||||||
|
|
||||||
sensor:
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_1
|
|
||||||
name: "reg_u_word"
|
|
||||||
address: 0x01
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
- platform: modbus_controller
|
|
||||||
modbus_controller_id: modbus_controller_2
|
|
||||||
name: "reg_u_word_2"
|
|
||||||
address: 0x01
|
|
||||||
register_type: holding
|
|
||||||
value_type: U_WORD
|
|
||||||
|
|
||||||
button:
|
|
||||||
- platform: template
|
|
||||||
name: "Start Scenario"
|
|
||||||
id: start_scenario_btn
|
|
||||||
# This test does not have anything to start (mock is autostart)
|
|
||||||
+47
-8
@@ -1,5 +1,5 @@
|
|||||||
esphome:
|
esphome:
|
||||||
name: uart-mock-modbus-srv-rw
|
name: uart-mock-modbus-srv-injected
|
||||||
|
|
||||||
host:
|
host:
|
||||||
api:
|
api:
|
||||||
@@ -17,6 +17,8 @@ uart:
|
|||||||
baud_rate: 115200
|
baud_rate: 115200
|
||||||
port: /dev/null
|
port: /dev/null
|
||||||
|
|
||||||
|
# Shared server-role fixture (see the shared_yaml markers in the test file);
|
||||||
|
# the injections concatenate and each test waits only on its own sensors.
|
||||||
uart_mock:
|
uart_mock:
|
||||||
- id: virtual_uart_dev
|
- id: virtual_uart_dev
|
||||||
baud_rate: 9600
|
baud_rate: 9600
|
||||||
@@ -25,18 +27,31 @@ uart_mock:
|
|||||||
auto_start: false
|
auto_start: false
|
||||||
debug:
|
debug:
|
||||||
injections:
|
injections:
|
||||||
# FC 0x17 Read/Write Multiple Registers on device 1:
|
- delay: 100ms
|
||||||
# write reg 0x0001 = 0x1234 (qty 1), then read regs 0x0001..0x0002 (qty 2).
|
inject_rx: [0x01, 0x03, 0x00, 0x03, 0x00, 0x01, 0x74, 0x0A] # Read holding register 3 on device 1 (basic_read)
|
||||||
# Per Modbus 6.17 the write is performed before the read, so reg 0x0001 must
|
- delay: 100ms
|
||||||
# read back the just-written 0x1234 in the same request.
|
# Read holding register 7 on device 2, its reply, then read holding
|
||||||
|
# register 5 on device 1 (read_after_peer_response)
|
||||||
|
inject_rx: [0x02, 0x03, 0x00, 0x07, 0x00, 0x01, 0x35, 0xF8,
|
||||||
|
0x02, 0x03, 0x02, 0x00, 0xF0, 0xFC,
|
||||||
|
0x00, 0x01, 0x03, 0x00, 0x05, 0x00, 0x01, 0x94, 0x0B]
|
||||||
|
- delay: 100ms
|
||||||
|
inject_rx: [0x02, 0x03, 0x00, 0x07, 0x00, 0x01, 0x35, 0xF8] # Read holding register 7 on device 2, with no response
|
||||||
|
- delay: 100ms
|
||||||
|
# Read holding register 7 on device 2 with no response, then read
|
||||||
|
# holding register A on device 1 (read_after_peer_timeout)
|
||||||
|
inject_rx: [0x02, 0x03, 0x00, 0x07, 0x00, 0x01, 0x35, 0xF8,
|
||||||
|
0x01, 0x03, 0x00, 0x0A, 0x00, 0x01, 0xA4, 0x08]
|
||||||
|
# FC 0x17 on device 1: write reg 0x0001 = 0x1234 then read 0x0001..0x0002;
|
||||||
|
# per Modbus 6.17 the write runs first, so 0x0001 must read back 0x1234.
|
||||||
- delay: 100ms
|
- delay: 100ms
|
||||||
inject_rx:
|
inject_rx:
|
||||||
[0x01, 0x17, 0x00, 0x01, 0x00, 0x02, 0x00, 0x01, 0x00, 0x01, 0x02, 0x12, 0x34, 0x49, 0xD8]
|
[0x01, 0x17, 0x00, 0x01, 0x00, 0x02, 0x00, 0x01, 0x00, 0x01, 0x02, 0x12, 0x34, 0x49, 0xD8]
|
||||||
# FC 0x17: write reg 0x0003 = 0x5678 (qty 1), then read reg 0x0003 (qty 1) -
|
# FC 0x17: write reg 0x0006 = 0x5678 (qty 1), then read reg 0x0006 (qty 1) -
|
||||||
# a write and read targeting a different register block.
|
# a write and read targeting a different register block.
|
||||||
- delay: 100ms
|
- delay: 100ms
|
||||||
inject_rx:
|
inject_rx:
|
||||||
[0x01, 0x17, 0x00, 0x03, 0x00, 0x01, 0x00, 0x03, 0x00, 0x01, 0x02, 0x56, 0x78, 0x9B, 0x10]
|
[0x01, 0x17, 0x00, 0x06, 0x00, 0x01, 0x00, 0x06, 0x00, 0x01, 0x02, 0x56, 0x78, 0x8B, 0x55]
|
||||||
|
|
||||||
globals:
|
globals:
|
||||||
- id: stored_1
|
- id: stored_1
|
||||||
@@ -70,8 +85,18 @@ modbus_server:
|
|||||||
read_lambda: |-
|
read_lambda: |-
|
||||||
id(rw_read_2).publish_state(0x00AA);
|
id(rw_read_2).publish_state(0x00AA);
|
||||||
return 0x00AA;
|
return 0x00AA;
|
||||||
# Second writable + readable register, targeted by the second request.
|
|
||||||
- address: 0x03
|
- address: 0x03
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: |-
|
||||||
|
id(basic_read).publish_state(1);
|
||||||
|
return 1;
|
||||||
|
- address: 0x05
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: |-
|
||||||
|
id(read_after_peer_response).publish_state(1);
|
||||||
|
return 1;
|
||||||
|
# Second writable + readable register, targeted by the second FC 0x17 request.
|
||||||
|
- address: 0x06
|
||||||
value_type: U_WORD
|
value_type: U_WORD
|
||||||
read_lambda: |-
|
read_lambda: |-
|
||||||
id(rw_read_3).publish_state(id(stored_3));
|
id(rw_read_3).publish_state(id(stored_3));
|
||||||
@@ -80,8 +105,22 @@ modbus_server:
|
|||||||
id(stored_3) = x;
|
id(stored_3) = x;
|
||||||
id(rw_write_3).publish_state(x);
|
id(rw_write_3).publish_state(x);
|
||||||
return true;
|
return true;
|
||||||
|
- address: 0x0A
|
||||||
|
value_type: U_WORD
|
||||||
|
read_lambda: |-
|
||||||
|
id(read_after_peer_timeout).publish_state(1);
|
||||||
|
return 1;
|
||||||
|
|
||||||
sensor:
|
sensor:
|
||||||
|
- platform: template
|
||||||
|
name: "basic_read"
|
||||||
|
id: basic_read
|
||||||
|
- platform: template
|
||||||
|
name: "read_after_peer_response"
|
||||||
|
id: read_after_peer_response
|
||||||
|
- platform: template
|
||||||
|
name: "read_after_peer_timeout"
|
||||||
|
id: read_after_peer_timeout
|
||||||
- platform: template
|
- platform: template
|
||||||
name: "rw_write_1"
|
name: "rw_write_1"
|
||||||
id: rw_write_1
|
id: rw_write_1
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
"""Helpers for manipulating the host platform's preferences file.
|
"""Helpers for manipulating the host platform's preferences file.
|
||||||
|
|
||||||
ESPHome's host platform stores preferences in
|
ESPHome's host platform stores preferences in
|
||||||
``~/.esphome/prefs/<app_name>.prefs`` using a simple binary layout that
|
``$ESPHOME_PREFDIR/<app_name>.prefs`` using a simple binary layout that
|
||||||
mirrors ``HostPreferences::sync()``:
|
mirrors ``HostPreferences::sync()``:
|
||||||
``[uint32_t key][uint8_t len][uint8_t data[len]]`` per entry.
|
``[uint32_t key][uint8_t len][uint8_t data[len]]`` per entry.
|
||||||
|
|
||||||
@@ -11,13 +11,21 @@ boot (e.g. forcing safe mode) or to clear stale state between runs.
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
import struct
|
import struct
|
||||||
|
|
||||||
|
|
||||||
def host_prefs_path(device_name: str) -> Path:
|
def host_prefs_path(device_name: str) -> Path:
|
||||||
"""Return the on-disk prefs file path for a host-platform device."""
|
"""Return the on-disk prefs file path for a host-platform device.
|
||||||
return Path.home() / ".esphome" / "prefs" / f"{device_name}.prefs"
|
|
||||||
|
Requires ESPHOME_PREFDIR, which the autouse isolated_preferences fixture
|
||||||
|
sets; refusing the ~/.esphome/prefs fallback keeps tests off real user
|
||||||
|
data if the fixture is ever bypassed."""
|
||||||
|
prefdir = os.environ.get("ESPHOME_PREFDIR")
|
||||||
|
if not prefdir:
|
||||||
|
raise RuntimeError("ESPHOME_PREFDIR is not set; refusing the real prefs dir")
|
||||||
|
return Path(prefdir) / f"{device_name}.prefs"
|
||||||
|
|
||||||
|
|
||||||
def clear_host_prefs(device_name: str) -> None:
|
def clear_host_prefs(device_name: str) -> None:
|
||||||
|
|||||||
@@ -24,7 +24,6 @@ from .types import (
|
|||||||
RunCompiledFunction,
|
RunCompiledFunction,
|
||||||
)
|
)
|
||||||
|
|
||||||
pytestmark = pytest.mark.usefixtures("isolated_preferences")
|
|
||||||
NEW_KEY = PROVISIONING_PSK
|
NEW_KEY = PROVISIONING_PSK
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -41,15 +41,6 @@ async def _poll_until_exists(path: Path) -> None:
|
|||||||
await asyncio.sleep(0.05)
|
await asyncio.sleep(0.05)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def isolated_preferences(monkeypatch: pytest.MonkeyPatch, tmp_path) -> Path:
|
|
||||||
"""Keep host preferences per-test so this test never touches the real
|
|
||||||
~/.esphome/prefs and never races other tests over ESPHOME_PREFDIR."""
|
|
||||||
prefdir = tmp_path / "prefs"
|
|
||||||
monkeypatch.setenv("ESPHOME_PREFDIR", str(prefdir))
|
|
||||||
return prefdir / f"{DEVICE_NAME}.prefs"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_host_preferences_suspend_resume(
|
async def test_host_preferences_suspend_resume(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -58,7 +49,7 @@ async def test_host_preferences_suspend_resume(
|
|||||||
isolated_preferences: Path,
|
isolated_preferences: Path,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Test that a running syncer flushes, a suspended one doesn't, and resume restores flushing."""
|
"""Test that a running syncer flushes, a suspended one doesn't, and resume restores flushing."""
|
||||||
pref_file = isolated_preferences
|
pref_file = isolated_preferences / f"{DEVICE_NAME}.prefs"
|
||||||
|
|
||||||
loop = asyncio.get_running_loop()
|
loop = asyncio.get_running_loop()
|
||||||
saved_in_memory = loop.create_future()
|
saved_in_memory = loop.create_future()
|
||||||
|
|||||||
@@ -11,14 +11,6 @@ from .state_utils import InitialStateHelper, require_entity
|
|||||||
from .types import APIClientConnectedFactory, RunCompiledFunction
|
from .types import APIClientConnectedFactory, RunCompiledFunction
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def isolated_preferences(monkeypatch: pytest.MonkeyPatch, tmp_path) -> None:
|
|
||||||
"""Keep host preferences per-test so RESTORE_AND_ON never loads a stale value left
|
|
||||||
behind by a previous run (host preferences otherwise persist to ~/.esphome/prefs,
|
|
||||||
keyed only by device name)."""
|
|
||||||
monkeypatch.setenv("ESPHOME_PREFDIR", str(tmp_path / "prefs"))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_light_initial_state(
|
async def test_light_initial_state(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
|
|||||||
@@ -173,6 +173,7 @@ async def test_uart_mock_modbus_no_threshold(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_server_injected")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_server(
|
async def test_uart_mock_modbus_server(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -203,6 +204,7 @@ async def test_uart_mock_modbus_server(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_server_injected")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_server_read_write(
|
async def test_uart_mock_modbus_server_read_write(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -231,8 +233,8 @@ async def test_uart_mock_modbus_server_read_write(
|
|||||||
"rw_write_1": 4660, # 0x1234 written to reg 0x0001
|
"rw_write_1": 4660, # 0x1234 written to reg 0x0001
|
||||||
"rw_read_1": 4660, # reg 0x0001 reads back the just-written value
|
"rw_read_1": 4660, # reg 0x0001 reads back the just-written value
|
||||||
"rw_read_2": 170, # 0x00AA read from reg 0x0002 in the same request
|
"rw_read_2": 170, # 0x00AA read from reg 0x0002 in the same request
|
||||||
"rw_write_3": 22136, # 0x5678 written to reg 0x0003
|
"rw_write_3": 22136, # 0x5678 written to reg 0x0006
|
||||||
"rw_read_3": 22136, # reg 0x0003 reads back the just-written value
|
"rw_read_3": 22136, # reg 0x0006 reads back the just-written value
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -241,7 +243,8 @@ async def test_uart_mock_modbus_server_read_write(
|
|||||||
api_client_connected() as client,
|
api_client_connected() as client,
|
||||||
):
|
):
|
||||||
await tracker.setup_and_start_scenario(client)
|
await tracker.setup_and_start_scenario(client)
|
||||||
await tracker.await_all(futures)
|
# The FC 0x17 injections fire last, behind four earlier 100ms delays
|
||||||
|
await tracker.await_all(futures, timeout=4.0)
|
||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
@@ -296,6 +299,7 @@ async def test_uart_mock_modbus_server_read_write_invalid(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_mesh")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_server_controller(
|
async def test_uart_mock_modbus_server_controller(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -485,6 +489,7 @@ async def test_uart_mock_modbus_server_controller_bits(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_mesh")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_server_controller_multiple(
|
async def test_uart_mock_modbus_server_controller_multiple(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -495,7 +500,7 @@ async def test_uart_mock_modbus_server_controller_multiple(
|
|||||||
|
|
||||||
line_callback, error_log_lines, warning_log_lines = _make_modbus_line_callback()
|
line_callback, error_log_lines, warning_log_lines = _make_modbus_line_callback()
|
||||||
|
|
||||||
expected_values = {"reg_u_word": 919, "reg_u_word_2": 929}
|
expected_values = {"multi_reg_a": 919, "multi_reg_b": 929}
|
||||||
tracker = SensorTracker(list(expected_values.keys()))
|
tracker = SensorTracker(list(expected_values.keys()))
|
||||||
futures = tracker.expect_all(expected_values)
|
futures = tracker.expect_all(expected_values)
|
||||||
|
|
||||||
@@ -706,6 +711,7 @@ async def test_uart_mock_modbus_shared_address(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_loopback")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_custom_pdu(
|
async def test_uart_mock_modbus_custom_pdu(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -932,6 +938,7 @@ async def test_uart_mock_modbus_broadcast_write(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_mesh")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_client_read_write(
|
async def test_uart_mock_modbus_client_read_write(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -947,9 +954,7 @@ async def test_uart_mock_modbus_client_read_write(
|
|||||||
"""
|
"""
|
||||||
line_callback, error_log_lines, warning_log_lines = _make_modbus_line_callback()
|
line_callback, error_log_lines, warning_log_lines = _make_modbus_line_callback()
|
||||||
|
|
||||||
tracker = SensorTracker(
|
tracker = SensorTracker(["srv_write_1", "client_read_0", "client_read_1"])
|
||||||
["srv_write_1", "srv_read_1", "client_read_0", "client_read_1"]
|
|
||||||
)
|
|
||||||
futures = tracker.expect_all(
|
futures = tracker.expect_all(
|
||||||
{
|
{
|
||||||
"srv_write_1": 4660, # server wrote 0x1234 to reg 0x0001
|
"srv_write_1": 4660, # server wrote 0x1234 to reg 0x0001
|
||||||
@@ -967,6 +972,7 @@ async def test_uart_mock_modbus_client_read_write(
|
|||||||
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
_assert_no_modbus_errors(error_log_lines, warning_log_lines)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_loopback")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_register_offset(
|
async def test_uart_mock_modbus_register_offset(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -1022,6 +1028,7 @@ async def test_uart_mock_modbus_register_offset(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_loopback")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_lambda_write(
|
async def test_uart_mock_modbus_lambda_write(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -1058,6 +1065,7 @@ async def test_uart_mock_modbus_lambda_write(
|
|||||||
await tracker.await_change(wrote_30, "reg_30", timeout=4.0)
|
await tracker.await_change(wrote_30, "reg_30", timeout=4.0)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_loopback")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_lambda_invert(
|
async def test_uart_mock_modbus_lambda_invert(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
@@ -1113,6 +1121,7 @@ async def test_uart_mock_modbus_lambda_invert(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.shared_yaml("uart_mock_modbus_loopback")
|
||||||
@pytest.mark.asyncio
|
@pytest.mark.asyncio
|
||||||
async def test_uart_mock_modbus_deprecated_write_buffer(
|
async def test_uart_mock_modbus_deprecated_write_buffer(
|
||||||
yaml_config: str,
|
yaml_config: str,
|
||||||
|
|||||||
@@ -2122,6 +2122,34 @@ def test_get_cpp_changed_components_independent_of_cwd(
|
|||||||
) == ["time"]
|
) == ["time"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_fixture_map_includes_shared_yaml_markers() -> None:
|
||||||
|
"""Fixtures named only by shared_yaml markers must map to their test file."""
|
||||||
|
helpers.get_fixture_to_test_files.cache_clear()
|
||||||
|
mapping = helpers.get_fixture_to_test_files()
|
||||||
|
for fixture in (
|
||||||
|
"uart_mock_modbus_loopback",
|
||||||
|
"uart_mock_modbus_mesh",
|
||||||
|
"uart_mock_modbus_server_injected",
|
||||||
|
):
|
||||||
|
assert mapping[fixture] == frozenset(
|
||||||
|
{"tests/integration/test_uart_mock_modbus.py"}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_no_orphan_integration_fixtures() -> None:
|
||||||
|
"""Every fixture must reach CI test selection; an orphan selects nothing."""
|
||||||
|
helpers.get_fixture_to_test_files.cache_clear()
|
||||||
|
mapping = helpers.get_fixture_to_test_files()
|
||||||
|
fixtures_dir = (Path(__file__).parent.parent / "integration" / "fixtures").resolve()
|
||||||
|
fixtures = list(fixtures_dir.glob("*.yaml"))
|
||||||
|
assert fixtures, f"no fixtures found under {fixtures_dir}"
|
||||||
|
# cache_init is covered via INTEGRATION_TESTS_TRIGGER_FILES instead
|
||||||
|
orphans = [
|
||||||
|
f.stem for f in fixtures if f.stem != "cache_init" and f.stem not in mapping
|
||||||
|
]
|
||||||
|
assert not orphans, f"fixtures invisible to CI test selection: {orphans}"
|
||||||
|
|
||||||
|
|
||||||
def test_lpt_partition_balances_skewed_weights() -> None:
|
def test_lpt_partition_balances_skewed_weights() -> None:
|
||||||
"""Heavy items spread across groups instead of clustering."""
|
"""Heavy items spread across groups instead of clustering."""
|
||||||
items = [f"i{n}" for n in range(6)]
|
items = [f"i{n}" for n in range(6)]
|
||||||
|
|||||||
@@ -0,0 +1,219 @@
|
|||||||
|
"""Unit tests for script/sync_dependency_versions.py."""
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import yamlrocks
|
||||||
|
|
||||||
|
sys.path.insert(0, str((Path(__file__).parent / ".." / ".." / "script").resolve()))
|
||||||
|
|
||||||
|
import sync_dependency_versions as sync_mod # noqa: E402
|
||||||
|
|
||||||
|
PRECOMMIT = """\
|
||||||
|
# See https://pre-commit.com for more information
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
|
# Ruff version.
|
||||||
|
rev: v0.1.0
|
||||||
|
hooks:
|
||||||
|
- id: ruff
|
||||||
|
- repo: https://github.com/PyCQA/flake8
|
||||||
|
rev: 7.0.0
|
||||||
|
hooks:
|
||||||
|
- id: flake8
|
||||||
|
- repo: https://github.com/asottile/pyupgrade
|
||||||
|
rev: v3.0.0
|
||||||
|
hooks:
|
||||||
|
- id: pyupgrade
|
||||||
|
- repo: https://github.com/pre-commit/mirrors-clang-format
|
||||||
|
rev: v13.0.1
|
||||||
|
hooks:
|
||||||
|
- id: clang-format
|
||||||
|
- repo: https://github.com/adrienverge/yamllint.git
|
||||||
|
rev: v1.0.0
|
||||||
|
hooks:
|
||||||
|
- id: yamllint
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: pylint
|
||||||
|
"""
|
||||||
|
|
||||||
|
REQ_TEST = """\
|
||||||
|
pylint==4.0.8
|
||||||
|
flake8==7.1.0
|
||||||
|
ruff==0.2.0 # comment
|
||||||
|
pyupgrade==3.0.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
REQ_DEV = """\
|
||||||
|
clang-format==13.0.1
|
||||||
|
yamllint==1.0.0
|
||||||
|
"""
|
||||||
|
|
||||||
|
RUFF_REPO = "https://github.com/astral-sh/ruff-pre-commit"
|
||||||
|
DUPLICATE_RUFF_BLOCK = f" - repo: {RUFF_REPO}\n rev: v0.3.0\n hooks: []\n"
|
||||||
|
|
||||||
|
EXPECTED_DRIFT = ["ruff: 0.1.0 -> 0.2.0", "flake8: 7.0.0 -> 7.1.0"]
|
||||||
|
EXPECTED_PRECOMMIT = PRECOMMIT.replace("rev: v0.1.0", "rev: v0.2.0").replace(
|
||||||
|
"rev: 7.0.0", "rev: 7.1.0"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def root(tmp_path: Path) -> Path:
|
||||||
|
"""A fake checkout where ruff (v-prefixed) and flake8 (bare) have drifted."""
|
||||||
|
(tmp_path / ".pre-commit-config.yaml").write_text(PRECOMMIT)
|
||||||
|
(tmp_path / "requirements_test.txt").write_text(REQ_TEST)
|
||||||
|
(tmp_path / "requirements_dev.txt").write_text(REQ_DEV)
|
||||||
|
return tmp_path
|
||||||
|
|
||||||
|
|
||||||
|
def _load(text: str) -> object:
|
||||||
|
return yamlrocks.loads(text.encode(), option=yamlrocks.OPT_ROUND_TRIP)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("requirements", "expected"),
|
||||||
|
[
|
||||||
|
("prek==0.5.1 # comment\n", "0.5.1"),
|
||||||
|
("Prek==0.5.1\n", "0.5.1"),
|
||||||
|
("other==1.0\nprek==0.5.1\n", "0.5.1"),
|
||||||
|
("prek>=0.5.1\n", None),
|
||||||
|
("prek-extra==0.5.1\n", None),
|
||||||
|
("", None),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_read_requirement_version(requirements: str, expected: str | None) -> None:
|
||||||
|
assert sync_mod.read_requirement_version(requirements, "prek") == expected
|
||||||
|
|
||||||
|
|
||||||
|
def test_find_repo_entry() -> None:
|
||||||
|
entry = sync_mod.find_repo_entry(_load(PRECOMMIT), RUFF_REPO)
|
||||||
|
assert entry["rev"] == "v0.1.0"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("text", "message"),
|
||||||
|
[
|
||||||
|
("hooks: []\n", "missing key 'repos'"),
|
||||||
|
("repos:\n - rev: 1.0.0\n", "missing key 'repo'"),
|
||||||
|
(PRECOMMIT + DUPLICATE_RUFF_BLOCK, "found 2"),
|
||||||
|
("repos:\n - repo: other\n rev: 1.0.0\n", "found 0"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_find_repo_entry_errors(text: str, message: str) -> None:
|
||||||
|
with pytest.raises(sync_mod.SyncError, match=message):
|
||||||
|
sync_mod.find_repo_entry(_load(text), RUFF_REPO)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("rev", "expected"),
|
||||||
|
[("v0.1.0", ("v", "0.1.0")), ("7.0.0", ("", "7.0.0")), ("'1.0'", ("", "1.0"))],
|
||||||
|
)
|
||||||
|
def test_current_rev(rev: str, expected: tuple[str, str]) -> None:
|
||||||
|
doc = _load(f"repos:\n - repo: {RUFF_REPO}\n rev: {rev}\n")
|
||||||
|
assert sync_mod.current_rev(doc["repos"][0], RUFF_REPO) == expected
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("block", "message"),
|
||||||
|
[(" hooks: []\n", "has no rev"), (" rev: 1.0\n", "not a string: 1.0")],
|
||||||
|
)
|
||||||
|
def test_current_rev_errors(block: str, message: str) -> None:
|
||||||
|
doc = _load(f"repos:\n - repo: {RUFF_REPO}\n{block}")
|
||||||
|
with pytest.raises(sync_mod.SyncError, match=message):
|
||||||
|
sync_mod.current_rev(doc["repos"][0], RUFF_REPO)
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_reports_without_writing(root: Path) -> None:
|
||||||
|
assert sync_mod.sync(root, write=False) == EXPECTED_DRIFT
|
||||||
|
assert (root / ".pre-commit-config.yaml").read_text() == PRECOMMIT
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_writes_keeps_layout_and_is_idempotent(root: Path) -> None:
|
||||||
|
assert sync_mod.sync(root, write=True) == EXPECTED_DRIFT
|
||||||
|
assert (root / ".pre-commit-config.yaml").read_text() == EXPECTED_PRECOMMIT
|
||||||
|
assert sync_mod.sync(root, write=True) == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_does_not_touch_a_config_that_matches(root: Path) -> None:
|
||||||
|
(root / ".pre-commit-config.yaml").write_text(EXPECTED_PRECOMMIT)
|
||||||
|
before = (root / ".pre-commit-config.yaml").stat().st_mtime_ns
|
||||||
|
assert sync_mod.sync(root, write=True) == []
|
||||||
|
assert (root / ".pre-commit-config.yaml").stat().st_mtime_ns == before
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_missing_requirement_pin(root: Path) -> None:
|
||||||
|
(root / "requirements_dev.txt").write_text("")
|
||||||
|
with pytest.raises(sync_mod.SyncError, match="no 'clang-format==' pin"):
|
||||||
|
sync_mod.sync(root, write=True)
|
||||||
|
|
||||||
|
|
||||||
|
def test_sync_propagates_config_errors(root: Path) -> None:
|
||||||
|
(root / ".pre-commit-config.yaml").write_text(PRECOMMIT + DUPLICATE_RUFF_BLOCK)
|
||||||
|
with pytest.raises(sync_mod.SyncError, match="found 2"):
|
||||||
|
sync_mod.sync(root, write=True)
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_check_reports_drift(
|
||||||
|
root: Path, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
assert sync_mod.main(["--check", "--root", str(root)]) == 1
|
||||||
|
assert capsys.readouterr().out.splitlines() == EXPECTED_DRIFT
|
||||||
|
assert (root / ".pre-commit-config.yaml").read_text() == PRECOMMIT
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_writes_then_check_is_clean(
|
||||||
|
root: Path, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
assert sync_mod.main(["--root", str(root)]) == 0
|
||||||
|
assert capsys.readouterr().out.splitlines() == EXPECTED_DRIFT
|
||||||
|
assert sync_mod.main(["--check", "--root", str(root)]) == 0
|
||||||
|
assert capsys.readouterr().out == ""
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_reports_sync_error(
|
||||||
|
root: Path, capsys: pytest.CaptureFixture[str]
|
||||||
|
) -> None:
|
||||||
|
(root / "requirements_dev.txt").write_text("")
|
||||||
|
assert sync_mod.main(["--root", str(root)]) == 1
|
||||||
|
assert (
|
||||||
|
"error: requirements_dev.txt: no 'clang-format==' pin"
|
||||||
|
in capsys.readouterr().err
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_defaults_to_repo_root(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
seen: dict[str, object] = {}
|
||||||
|
|
||||||
|
def fake_sync(root: Path, *, write: bool) -> list[str]:
|
||||||
|
seen["root"] = root
|
||||||
|
seen["write"] = write
|
||||||
|
return []
|
||||||
|
|
||||||
|
monkeypatch.setattr(sync_mod, "sync", fake_sync)
|
||||||
|
assert sync_mod.main([]) == 0
|
||||||
|
assert seen == {"root": sync_mod.REPO_ROOT, "write": True}
|
||||||
|
|
||||||
|
|
||||||
|
def test_repository_is_in_sync() -> None:
|
||||||
|
"""The real checkout must match; a failure here means a rev has drifted.
|
||||||
|
|
||||||
|
Also proves every SYNC_TARGETS entry still resolves in the real files.
|
||||||
|
"""
|
||||||
|
assert sync_mod.sync(sync_mod.REPO_ROOT, write=False) == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_cli_entry_point(root: Path) -> None:
|
||||||
|
"""Run the script the way the workflow does, as a subprocess."""
|
||||||
|
script = Path(sync_mod.__file__)
|
||||||
|
result = subprocess.run(
|
||||||
|
[sys.executable, str(script), "--check", "--root", str(root)],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
check=False,
|
||||||
|
)
|
||||||
|
assert result.returncode == 1
|
||||||
|
assert result.stdout.splitlines() == EXPECTED_DRIFT
|
||||||
@@ -0,0 +1,150 @@
|
|||||||
|
"""Tests for the web_server AP mode helpers."""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from esphome.components.web_server import (
|
||||||
|
_final_validate_ap_mode,
|
||||||
|
serve_captive,
|
||||||
|
serve_local,
|
||||||
|
)
|
||||||
|
from esphome.const import (
|
||||||
|
CONF_AP,
|
||||||
|
CONF_LOCAL,
|
||||||
|
CONF_NETWORKS,
|
||||||
|
CONF_PORT,
|
||||||
|
CONF_SSID,
|
||||||
|
CONF_VERSION,
|
||||||
|
CONF_WIFI,
|
||||||
|
)
|
||||||
|
import esphome.final_validate as fv
|
||||||
|
|
||||||
|
AP_ONLY = {CONF_AP: {}}
|
||||||
|
AP_FALLBACK = {CONF_AP: {}, CONF_NETWORKS: [{CONF_SSID: "x"}]}
|
||||||
|
STA_ONLY = {CONF_NETWORKS: [{CONF_SSID: "x"}]}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("web_server_config", "wifi_config", "expected"),
|
||||||
|
[
|
||||||
|
# AP only: embed the interface, the AP has no internet.
|
||||||
|
({CONF_VERSION: 2}, AP_ONLY, True),
|
||||||
|
({CONF_VERSION: 3}, AP_ONLY, True),
|
||||||
|
# Explicit setting always wins.
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: False}, AP_ONLY, False),
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: True}, STA_ONLY, True),
|
||||||
|
# AP fallback, no AP, no wifi, or version 1 (no local mode): hosted page.
|
||||||
|
({CONF_VERSION: 2}, AP_FALLBACK, False),
|
||||||
|
({CONF_VERSION: 2}, STA_ONLY, False),
|
||||||
|
({CONF_VERSION: 2}, None, False),
|
||||||
|
({CONF_VERSION: 1}, AP_ONLY, False),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_serve_local(
|
||||||
|
web_server_config: dict, wifi_config: dict | None, expected: bool
|
||||||
|
) -> None:
|
||||||
|
"""The interface is embedded for AP only WiFi unless local is set explicitly."""
|
||||||
|
assert serve_local(web_server_config, wifi_config) is expected
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("web_server_config", "full_config", "expected"),
|
||||||
|
[
|
||||||
|
# AP only: local is implied, web_server is the captive portal.
|
||||||
|
({CONF_VERSION: 2}, {CONF_WIFI: AP_ONLY}, True),
|
||||||
|
# Captive portal probes only work on port 80.
|
||||||
|
({CONF_VERSION: 2, CONF_PORT: 8080}, {CONF_WIFI: AP_ONLY}, False),
|
||||||
|
# AP fallback needs an explicit local: true to be captive.
|
||||||
|
({CONF_VERSION: 2}, {CONF_WIFI: AP_FALLBACK}, False),
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: True}, {CONF_WIFI: AP_FALLBACK}, True),
|
||||||
|
# captive_portal owns the role when configured.
|
||||||
|
({CONF_VERSION: 2}, {CONF_WIFI: AP_ONLY, "captive_portal": {}}, False),
|
||||||
|
# No AP, no wifi, hosted page, or version 1: never captive.
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: True}, {CONF_WIFI: STA_ONLY}, False),
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: True}, {}, False),
|
||||||
|
({CONF_VERSION: 2, CONF_LOCAL: False}, {CONF_WIFI: AP_ONLY}, False),
|
||||||
|
({CONF_VERSION: 1}, {CONF_WIFI: AP_ONLY}, False),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_serve_captive(
|
||||||
|
web_server_config: dict, full_config: dict, expected: bool
|
||||||
|
) -> None:
|
||||||
|
web_server_config.setdefault(CONF_PORT, 80)
|
||||||
|
assert serve_captive(web_server_config, full_config) is expected
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("web_server_config", "expect_warning"),
|
||||||
|
[
|
||||||
|
# Explicit local: false on an AP only device: the hosted page will stay blank.
|
||||||
|
({CONF_VERSION: 2, CONF_PORT: 80, CONF_LOCAL: False}, True),
|
||||||
|
# Default: embedded and captive, nothing to warn about.
|
||||||
|
({CONF_VERSION: 2, CONF_PORT: 80}, False),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_final_validate_ap_mode_warns_for_hosted_page(
|
||||||
|
web_server_config: dict, expect_warning: bool, caplog: pytest.LogCaptureFixture
|
||||||
|
) -> None:
|
||||||
|
token = fv.full_config.set({"web_server": web_server_config, CONF_WIFI: AP_ONLY})
|
||||||
|
try:
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
_final_validate_ap_mode(web_server_config)
|
||||||
|
finally:
|
||||||
|
fv.full_config.reset(token)
|
||||||
|
assert ("stays blank" in caplog.text) is expect_warning
|
||||||
|
|
||||||
|
|
||||||
|
def test_final_validate_ap_mode_warns_for_non_default_port(
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
"""Captive portal detection needs port 80; other ports get a hint, not captive mode."""
|
||||||
|
config = {CONF_VERSION: 2, CONF_PORT: 8080}
|
||||||
|
token = fv.full_config.set({"web_server": config, CONF_WIFI: AP_ONLY})
|
||||||
|
try:
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
_final_validate_ap_mode(config)
|
||||||
|
finally:
|
||||||
|
fv.full_config.reset(token)
|
||||||
|
assert "cannot open automatically" in caplog.text
|
||||||
|
assert "http://192.168.4.1:8080/" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
def test_final_validate_ap_mode_port_warning_uses_manual_ip(
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
"""The manual URL in the port warning honors wifi.ap.manual_ip."""
|
||||||
|
from esphome.const import CONF_MANUAL_IP, CONF_STATIC_IP
|
||||||
|
|
||||||
|
config = {CONF_VERSION: 2, CONF_PORT: 8080}
|
||||||
|
wifi = {CONF_AP: {CONF_MANUAL_IP: {CONF_STATIC_IP: "10.0.0.1"}}}
|
||||||
|
token = fv.full_config.set({"web_server": config, CONF_WIFI: wifi})
|
||||||
|
try:
|
||||||
|
with caplog.at_level(logging.WARNING):
|
||||||
|
_final_validate_ap_mode(config)
|
||||||
|
finally:
|
||||||
|
fv.full_config.reset(token)
|
||||||
|
assert "http://10.0.0.1:8080/" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("wifi_config", "expected"),
|
||||||
|
[
|
||||||
|
# Explicit local: true on a fallback AP: announce the captive fallback role.
|
||||||
|
(AP_FALLBACK, "fallback access point"),
|
||||||
|
# Explicit local: true on AP only skips the implied-local info; still announce.
|
||||||
|
(AP_ONLY, "captive portal while the access point"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_final_validate_ap_mode_informs_explicit_local_captive(
|
||||||
|
wifi_config: dict, expected: str, caplog: pytest.LogCaptureFixture
|
||||||
|
) -> None:
|
||||||
|
"""Explicit local: true logs that web_server becomes the captive portal."""
|
||||||
|
config = {CONF_VERSION: 2, CONF_PORT: 80, CONF_LOCAL: True}
|
||||||
|
token = fv.full_config.set({"web_server": config, CONF_WIFI: wifi_config})
|
||||||
|
try:
|
||||||
|
with caplog.at_level(logging.INFO):
|
||||||
|
_final_validate_ap_mode(config)
|
||||||
|
finally:
|
||||||
|
fv.full_config.reset(token)
|
||||||
|
assert expected in caplog.text
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
"""Tests for the udp component configuration schema."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from esphome.components import udp
|
||||||
|
from esphome.components.packet_transport import (
|
||||||
|
CONF_BINARY_SENSORS,
|
||||||
|
CONF_ENCRYPTION,
|
||||||
|
CONF_PING_PONG_ENABLE,
|
||||||
|
CONF_PROVIDERS,
|
||||||
|
CONF_ROLLING_CODE_ENABLE,
|
||||||
|
CONF_SENSORS,
|
||||||
|
)
|
||||||
|
import esphome.config_validation as cv
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"option",
|
||||||
|
[
|
||||||
|
CONF_PROVIDERS,
|
||||||
|
CONF_ENCRYPTION,
|
||||||
|
CONF_PING_PONG_ENABLE,
|
||||||
|
CONF_ROLLING_CODE_ENABLE,
|
||||||
|
CONF_SENSORS,
|
||||||
|
CONF_BINARY_SENSORS,
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_relocated_option_rejected(option: str) -> None:
|
||||||
|
"""Options that moved to packet_transport raise a pointing error."""
|
||||||
|
with pytest.raises(cv.Invalid) as exc_info:
|
||||||
|
udp.CONFIG_SCHEMA({option: True})
|
||||||
|
assert (
|
||||||
|
f"The '{option}' option should now be configured in the 'packet_transport' component"
|
||||||
|
in str(exc_info.value)
|
||||||
|
)
|
||||||
@@ -7,6 +7,7 @@ exercised in their own test modules)."""
|
|||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from unittest.mock import Mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
@@ -228,6 +229,24 @@ def test_resolve_registry_version_raises_without_pkg_file(monkeypatch):
|
|||||||
_resolve_registry_version("owner", "pkg", set())
|
_resolve_registry_version("owner", "pkg", set())
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_registry_client_skips_private_package_probe(monkeypatch):
|
||||||
|
"""Our client answers the probe locally without patching PlatformIO's class."""
|
||||||
|
from platformio.account.client import AccountClient
|
||||||
|
from platformio.registry.client import RegistryClient
|
||||||
|
|
||||||
|
pio_probe = RegistryClient.__dict__["allowed_private_packages"]
|
||||||
|
monkeypatch.setattr(
|
||||||
|
AccountClient,
|
||||||
|
"get_account_info",
|
||||||
|
Mock(side_effect=AssertionError("account probe must not run")),
|
||||||
|
)
|
||||||
|
|
||||||
|
client = lib._make_registry_client().get_registry_client_instance()
|
||||||
|
|
||||||
|
assert client.allowed_private_packages() is False
|
||||||
|
assert RegistryClient.__dict__["allowed_private_packages"] is pio_probe
|
||||||
|
|
||||||
|
|
||||||
def _patch_registry_resolve(monkeypatch: pytest.MonkeyPatch) -> None:
|
def _patch_registry_resolve(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
"""Stub the registry lookup so tests never touch the network."""
|
"""Stub the registry lookup so tests never touch the network."""
|
||||||
monkeypatch.setattr(
|
monkeypatch.setattr(
|
||||||
|
|||||||
@@ -1225,6 +1225,20 @@ def test_main_runs_prefetch(tmp_path: Path) -> None:
|
|||||||
mock_prefetch.assert_called_once_with(tmp_path, "testenv")
|
mock_prefetch.assert_called_once_with(tmp_path, "testenv")
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_skips_private_package_probe_before_prefetch(tmp_path: Path) -> None:
|
||||||
|
"""The registry probe patch is applied before any package manager runs."""
|
||||||
|
order: list[str] = []
|
||||||
|
with (
|
||||||
|
patch.object(pf, "_prefetch", side_effect=lambda *_: order.append("prefetch")),
|
||||||
|
patch(
|
||||||
|
"esphome.platformio.runner.patch_registry_private_packages",
|
||||||
|
side_effect=lambda: order.append("patch"),
|
||||||
|
),
|
||||||
|
):
|
||||||
|
assert pf.main([str(tmp_path), "testenv"]) == 0
|
||||||
|
assert order == ["patch", "prefetch"]
|
||||||
|
|
||||||
|
|
||||||
def test_main_bad_argv_is_a_distinct_exit(
|
def test_main_bad_argv_is_a_distinct_exit(
|
||||||
caplog: pytest.LogCaptureFixture,
|
caplog: pytest.LogCaptureFixture,
|
||||||
) -> None:
|
) -> None:
|
||||||
|
|||||||
@@ -6,7 +6,9 @@ from collections.abc import Callable
|
|||||||
import io
|
import io
|
||||||
import sys
|
import sys
|
||||||
from types import ModuleType
|
from types import ModuleType
|
||||||
|
from unittest.mock import Mock
|
||||||
|
|
||||||
|
from platformio.registry.client import RegistryClient
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from esphome.platformio import runner
|
from esphome.platformio import runner
|
||||||
@@ -30,6 +32,7 @@ def _prepare_main(
|
|||||||
monkeypatch.setattr(sys, "stderr", stream)
|
monkeypatch.setattr(sys, "stderr", stream)
|
||||||
monkeypatch.setattr(runner, "patch_structhash", lambda: None)
|
monkeypatch.setattr(runner, "patch_structhash", lambda: None)
|
||||||
monkeypatch.setattr(runner, "patch_file_downloader", lambda: None)
|
monkeypatch.setattr(runner, "patch_file_downloader", lambda: None)
|
||||||
|
monkeypatch.setattr(runner, "patch_registry_private_packages", lambda: None)
|
||||||
|
|
||||||
platformio = ModuleType("platformio")
|
platformio = ModuleType("platformio")
|
||||||
platformio_main = ModuleType("platformio.__main__")
|
platformio_main = ModuleType("platformio.__main__")
|
||||||
@@ -91,3 +94,40 @@ def test_main_still_filters_a_drained_partial_line(
|
|||||||
|
|
||||||
assert runner.main() == 0
|
assert runner.main() == 0
|
||||||
assert buf.getvalue() == b""
|
assert buf.getvalue() == b""
|
||||||
|
|
||||||
|
|
||||||
|
def test_main_applies_registry_private_packages_patch(
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""The probe is patched before PlatformIO runs."""
|
||||||
|
order: list[str] = []
|
||||||
|
_prepare_main(monkeypatch, lambda: order.append("pio") or 0)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
runner, "patch_registry_private_packages", lambda: order.append("patch")
|
||||||
|
)
|
||||||
|
|
||||||
|
assert runner.main() == 0
|
||||||
|
assert order == ["patch", "pio"]
|
||||||
|
|
||||||
|
|
||||||
|
# Snapshot PlatformIO's own probe at import, before any test can patch it
|
||||||
|
_PIO_PROBE = RegistryClient.__dict__["allowed_private_packages"]
|
||||||
|
|
||||||
|
|
||||||
|
def test_patch_registry_private_packages_skips_account_probe(
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> None:
|
||||||
|
"""Answers False without touching the account client."""
|
||||||
|
from platformio.account.client import AccountClient
|
||||||
|
|
||||||
|
monkeypatch.setattr(RegistryClient, "allowed_private_packages", _PIO_PROBE)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
AccountClient,
|
||||||
|
"get_account_info",
|
||||||
|
Mock(side_effect=AssertionError("account probe must not run")),
|
||||||
|
)
|
||||||
|
|
||||||
|
runner.patch_registry_private_packages()
|
||||||
|
|
||||||
|
assert RegistryClient.allowed_private_packages() is False
|
||||||
|
assert RegistryClient().allowed_private_packages() is False
|
||||||
|
|||||||
Reference in New Issue
Block a user