mirror of
https://github.com/esphome/esphome.git
synced 2026-09-09 06:18:46 +00:00
Compare commits
52
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3dea55368f | ||
|
|
76100fec58 | ||
|
|
4736550677 | ||
|
|
2d86ffec7e | ||
|
|
4509e5d388 | ||
|
|
0e3554f6f8 | ||
|
|
5ac2fa8811 | ||
|
|
e715696bd7 | ||
|
|
82d399400e | ||
|
|
a7bf937001 | ||
|
|
63b5331e47 | ||
|
|
4c72948575 | ||
|
|
77d850cbe2 | ||
|
|
a97e4ebc1c | ||
|
|
d09f642eb2 | ||
|
|
144cd419ad | ||
|
|
7910c372cd | ||
|
|
c2a4981e25 | ||
|
|
097d487261 | ||
|
|
89082c7b2d | ||
|
|
fb3befe377 | ||
|
|
4a3a787756 | ||
|
|
5aec93d7e8 | ||
|
|
a79cd1550c | ||
|
|
6d23e4c842 | ||
|
|
cbdcfe640c | ||
|
|
2bc20d8721 | ||
|
|
2dbb3e055b | ||
|
|
7549309ad3 | ||
|
|
e600180417 | ||
|
|
0641dae9d2 | ||
|
|
bcf812d62b | ||
|
|
b0ce7f58f3 | ||
|
|
455e1d6374 | ||
|
|
3af1d50bce | ||
|
|
842f354a05 | ||
|
|
af9b59d4bd | ||
|
|
55fc5a10de | ||
|
|
79927b918b | ||
|
|
1b070629bc | ||
|
|
c4e1360cdf | ||
|
|
7c774699d7 | ||
|
|
ea71a24a9b | ||
|
|
709a1e1eb6 | ||
|
|
822b701792 | ||
|
|
d2e4d2c46a | ||
|
|
adbbda4072 | ||
|
|
252bf6ea6a | ||
|
|
8ec9305688 | ||
|
|
490aca17e6 | ||
|
|
b77e2441d4 | ||
|
|
3b14f4dfc8 |
@@ -244,20 +244,11 @@ 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:
|
||||||
prek-version: ${{ steps.prek.outputs.version }}
|
# Keep in sync with requirements_test.txt.
|
||||||
|
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
|
||||||
|
|||||||
@@ -1,94 +0,0 @@
|
|||||||
# 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,6 +1,7 @@
|
|||||||
---
|
---
|
||||||
# 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
|
||||||
@@ -10,7 +11,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.6
|
rev: v0.16.3
|
||||||
hooks:
|
hooks:
|
||||||
# Run the linter.
|
# Run the linter.
|
||||||
- id: ruff
|
- id: ruff
|
||||||
@@ -41,7 +42,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.38.0
|
rev: v1.37.1
|
||||||
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.5
|
RUN uv pip install --no-cache-dir esphome-device-builder==1.14.4
|
||||||
|
|
||||||
RUN \
|
RUN \
|
||||||
platformio settings set enable_telemetry No \
|
platformio settings set enable_telemetry No \
|
||||||
|
|||||||
@@ -23,7 +23,9 @@ 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 SubscribeLogsResponse # pylint: disable=no-name-in-module
|
from aioesphomeapi.api_pb2 import (
|
||||||
|
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->poll_step_ = PollStep::IDLE;
|
this->current_request_ = 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
void Anova::loop() {
|
void Anova::loop() {
|
||||||
@@ -22,15 +22,6 @@ 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()) {
|
||||||
@@ -47,11 +38,22 @@ void Anova::control(const ClimateCall &call) {
|
|||||||
ESP_LOGW(TAG, "Unsupported mode: %d", mode);
|
ESP_LOGW(TAG, "Unsupported mode: %d", mode);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
this->write_request_(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);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
auto target_temp = call.get_target_temperature();
|
auto target_temp = call.get_target_temperature();
|
||||||
if (target_temp.has_value()) {
|
if (target_temp.has_value()) {
|
||||||
this->write_request_(this->codec_->get_set_target_temp_request(*target_temp));
|
auto *pkt = 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);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -60,7 +62,6 @@ 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;
|
||||||
}
|
}
|
||||||
@@ -82,8 +83,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->poll_step_ = PollStep::IDLE;
|
this->current_request_ = 0;
|
||||||
this->update(); // begin the first poll cycle immediately
|
this->update();
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case ESP_GATTC_NOTIFY_EVT: {
|
case ESP_GATTC_NOTIFY_EVT: {
|
||||||
@@ -100,30 +101,33 @@ 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()) {
|
||||||
ESP_LOGD(TAG, "Anova units is %s", (this->codec_->unit_ == 'f') ? "fahrenheit" : "celsius");
|
this->fahrenheit_ = (this->codec_->unit_ == 'f');
|
||||||
|
ESP_LOGD(TAG, "Anova units is %s", this->fahrenheit_ ? "fahrenheit" : "celsius");
|
||||||
|
this->current_request_++;
|
||||||
}
|
}
|
||||||
this->publish_state();
|
this->publish_state();
|
||||||
|
|
||||||
// Advance the poll cycle to its next request based on the reply we got.
|
if (this->current_request_ > 1) {
|
||||||
switch (this->poll_step_) {
|
AnovaPacket *pkt = nullptr;
|
||||||
case PollStep::SET_UNIT:
|
switch (this->current_request_++) {
|
||||||
this->poll_step_ = PollStep::STATUS;
|
case 2:
|
||||||
this->write_request_(this->codec_->get_read_device_status_request());
|
pkt = this->codec_->get_read_target_temp_request();
|
||||||
break;
|
break;
|
||||||
case PollStep::STATUS:
|
case 3:
|
||||||
this->poll_step_ = PollStep::TARGET;
|
pkt = this->codec_->get_read_current_temp_request();
|
||||||
this->write_request_(this->codec_->get_read_target_temp_request());
|
break;
|
||||||
break;
|
default:
|
||||||
case PollStep::TARGET:
|
this->current_request_ = 1;
|
||||||
this->poll_step_ = PollStep::CURRENT;
|
break;
|
||||||
this->write_request_(this->codec_->get_read_current_temp_request());
|
}
|
||||||
break;
|
if (pkt != nullptr) {
|
||||||
case PollStep::CURRENT:
|
auto status =
|
||||||
this->poll_step_ = PollStep::IDLE; // full cycle complete
|
esp_ble_gattc_write_char(this->parent_->get_gattc_if(), this->parent_->get_conn_id(), this->char_handle_,
|
||||||
break;
|
pkt->length, pkt->data, ESP_GATT_WRITE_TYPE_NO_RSP, ESP_GATT_AUTH_REQ_NONE);
|
||||||
default:
|
if (status) {
|
||||||
// A reply to an ad-hoc control() write, outside a managed cycle.
|
ESP_LOGW(TAG, "[%s] esp_ble_gattc_write_char failed, status=%d", this->parent_->address_str(), status);
|
||||||
break;
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
@@ -132,26 +136,27 @@ 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->want_fahrenheit_ = !strncmp(unit, "f", 1); }
|
void Anova::set_unit_of_measurement(const char *unit) { this->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) {
|
|
||||||
// The previous cycle never finished within a full polling interval -- a
|
if (this->current_request_ < 2) {
|
||||||
// reply was missed or a write failed. Restart the cycle rather than stall;
|
AnovaPacket *pkt;
|
||||||
// the polling interval itself acts as the timeout. A late reply from the
|
if (this->current_request_ == 0) {
|
||||||
// abandoned cycle is harmless: state decoding happens on every notify
|
pkt = this->codec_->get_set_unit_request(this->fahrenheit_ ? 'f' : 'c');
|
||||||
// regardless of step, and each notify sends at most one follow-up request.
|
} else {
|
||||||
ESP_LOGW(TAG, "[%s] Poll cycle incomplete (step %u); restarting cycle", this->parent_->address_str(),
|
pkt = this->codec_->get_read_device_status_request();
|
||||||
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,20 +37,11 @@ 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_;
|
||||||
bool want_fahrenheit_{true}; // configured target unit; never overwritten by device replies
|
uint8_t current_request_;
|
||||||
PollStep poll_step_{PollStep::IDLE};
|
bool fahrenheit_;
|
||||||
};
|
};
|
||||||
|
|
||||||
} // namespace esphome::anova
|
} // namespace esphome::anova
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ from typing import Any
|
|||||||
from esphome import automation
|
from esphome import automation
|
||||||
from esphome.automation import Condition
|
from esphome.automation import Condition
|
||||||
import esphome.codegen as cg
|
import esphome.codegen as cg
|
||||||
from esphome.components.const import CONF_DESCRIPTION, CONF_HOST
|
from esphome.components.const import CONF_DESCRIPTION
|
||||||
from esphome.components.logger import request_log_listener
|
from esphome.components.logger import request_log_listener
|
||||||
|
|
||||||
# ENCRYPTION_SCHEMA and validate_encryption_key are re-exported for external
|
# ENCRYPTION_SCHEMA and validate_encryption_key are re-exported for external
|
||||||
@@ -25,8 +25,6 @@ from esphome.const import (
|
|||||||
CONF_CAPTURE_RESPONSE,
|
CONF_CAPTURE_RESPONSE,
|
||||||
CONF_DATA,
|
CONF_DATA,
|
||||||
CONF_DATA_TEMPLATE,
|
CONF_DATA_TEMPLATE,
|
||||||
CONF_DELAY,
|
|
||||||
CONF_ENABLE_IPV6,
|
|
||||||
CONF_ENCRYPTION,
|
CONF_ENCRYPTION,
|
||||||
CONF_EVENT,
|
CONF_EVENT,
|
||||||
CONF_ID,
|
CONF_ID,
|
||||||
@@ -50,7 +48,6 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.core import CORE, ID, CoroPriority, EsphomeError, coroutine_with_priority
|
from esphome.core import CORE, ID, CoroPriority, EsphomeError, coroutine_with_priority
|
||||||
from esphome.cpp_generator import MockObj, TemplateArgsType
|
from esphome.cpp_generator import MockObj, TemplateArgsType
|
||||||
import esphome.final_validate as fv
|
|
||||||
from esphome.helpers import fnv1_hash
|
from esphome.helpers import fnv1_hash
|
||||||
from esphome.types import ConfigFragmentType, ConfigType
|
from esphome.types import ConfigFragmentType, ConfigType
|
||||||
|
|
||||||
@@ -137,7 +134,6 @@ CONF_HOMEASSISTANT_SERVICES = "homeassistant_services"
|
|||||||
CONF_HOMEASSISTANT_STATES = "homeassistant_states"
|
CONF_HOMEASSISTANT_STATES = "homeassistant_states"
|
||||||
CONF_LISTEN_BACKLOG = "listen_backlog"
|
CONF_LISTEN_BACKLOG = "listen_backlog"
|
||||||
CONF_MAX_SEND_QUEUE = "max_send_queue"
|
CONF_MAX_SEND_QUEUE = "max_send_queue"
|
||||||
CONF_OUTGOING_CONNECTION = "outgoing_connection"
|
|
||||||
CONF_STATE_SUBSCRIPTION_ONLY = "state_subscription_only"
|
CONF_STATE_SUBSCRIPTION_ONLY = "state_subscription_only"
|
||||||
|
|
||||||
|
|
||||||
@@ -289,44 +285,9 @@ def _consume_api_sockets(config: ConfigType) -> ConfigType:
|
|||||||
# (not max_connections, which is the upper limit rarely reached)
|
# (not max_connections, which is the upper limit rarely reached)
|
||||||
socket.consume_sockets(3, "api")(config)
|
socket.consume_sockets(3, "api")(config)
|
||||||
socket.consume_sockets(1, "api", socket.SocketType.TCP_LISTEN)(config)
|
socket.consume_sockets(1, "api", socket.SocketType.TCP_LISTEN)(config)
|
||||||
if CONF_OUTGOING_CONNECTION in config:
|
|
||||||
socket.consume_sockets(1, "api_outgoing_connection")(config)
|
|
||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def _validate_outgoing_connection(config: ConfigType) -> ConfigType:
|
|
||||||
if CONF_OUTGOING_CONNECTION not in config:
|
|
||||||
return config
|
|
||||||
if CONF_ENCRYPTION not in config:
|
|
||||||
raise cv.Invalid(
|
|
||||||
"outgoing_connection requires 'encryption' so the peer is verified by key",
|
|
||||||
path=[CONF_OUTGOING_CONNECTION],
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
_OUTGOING_CONNECTION_SCHEMA = cv.Schema(
|
|
||||||
{
|
|
||||||
cv.Optional(CONF_HOST): cv.ipaddress,
|
|
||||||
cv.Optional(CONF_PORT, default=6054): cv.port,
|
|
||||||
# Bounded to half the device's uint32 millisecond range so the wait
|
|
||||||
# always elapses under a wrapping clock
|
|
||||||
cv.Optional(CONF_DELAY, default="60s"): cv.All(
|
|
||||||
cv.positive_time_period_milliseconds,
|
|
||||||
cv.Range(max=cv.TimePeriod(milliseconds=2147483647)),
|
|
||||||
),
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _outgoing_connection_schema(config: ConfigType | None) -> ConfigType:
|
|
||||||
# A bare `outgoing_connection:` block is valid; without a host the device
|
|
||||||
# dials the remembered last dial-back client
|
|
||||||
if config is None:
|
|
||||||
config = {}
|
|
||||||
return _OUTGOING_CONNECTION_SCHEMA(config)
|
|
||||||
|
|
||||||
|
|
||||||
CONFIG_SCHEMA = cv.All(
|
CONFIG_SCHEMA = cv.All(
|
||||||
cv.Schema(
|
cv.Schema(
|
||||||
{
|
{
|
||||||
@@ -351,7 +312,6 @@ CONFIG_SCHEMA = cv.All(
|
|||||||
): ACTIONS_SCHEMA,
|
): ACTIONS_SCHEMA,
|
||||||
cv.Exclusive(CONF_ACTIONS, group_of_exclusion=CONF_ACTIONS): ACTIONS_SCHEMA,
|
cv.Exclusive(CONF_ACTIONS, group_of_exclusion=CONF_ACTIONS): ACTIONS_SCHEMA,
|
||||||
cv.Optional(CONF_ENCRYPTION): encryption_schema,
|
cv.Optional(CONF_ENCRYPTION): encryption_schema,
|
||||||
cv.Optional(CONF_OUTGOING_CONNECTION): _outgoing_connection_schema,
|
|
||||||
cv.Optional(CONF_BATCH_DELAY, default="100ms"): cv.All(
|
cv.Optional(CONF_BATCH_DELAY, default="100ms"): cv.All(
|
||||||
cv.positive_time_period_milliseconds,
|
cv.positive_time_period_milliseconds,
|
||||||
cv.Range(max=cv.TimePeriod(milliseconds=65535)),
|
cv.Range(max=cv.TimePeriod(milliseconds=65535)),
|
||||||
@@ -408,7 +368,6 @@ CONFIG_SCHEMA = cv.All(
|
|||||||
}
|
}
|
||||||
).extend(cv.COMPONENT_SCHEMA),
|
).extend(cv.COMPONENT_SCHEMA),
|
||||||
cv.rename_key(CONF_SERVICES, CONF_ACTIONS),
|
cv.rename_key(CONF_SERVICES, CONF_ACTIONS),
|
||||||
_validate_outgoing_connection,
|
|
||||||
_consume_api_sockets,
|
_consume_api_sockets,
|
||||||
_register_provisioning_source,
|
_register_provisioning_source,
|
||||||
)
|
)
|
||||||
@@ -465,52 +424,7 @@ def _validate_esp8266_action_strings(config: ConfigType) -> ConfigType:
|
|||||||
return config
|
return config
|
||||||
|
|
||||||
|
|
||||||
def _validate_outgoing_socket_implementation(config: ConfigType) -> ConfigType:
|
FINAL_VALIDATE_SCHEMA = _validate_esp8266_action_strings
|
||||||
"""Reject the raw lwip_tcp socket, the only option on ESP8266 and RP2040.
|
|
||||||
|
|
||||||
Checked against the resolved implementation so an explicit selection on
|
|
||||||
another platform is caught the same way as the platform default.
|
|
||||||
"""
|
|
||||||
if CONF_OUTGOING_CONNECTION not in config:
|
|
||||||
return config
|
|
||||||
from esphome.components import socket
|
|
||||||
|
|
||||||
socket_conf = fv.full_config.get().get("socket") or {}
|
|
||||||
if (
|
|
||||||
impl := socket_conf.get(socket.CONF_IMPLEMENTATION)
|
|
||||||
) in socket.IMPLEMENTATIONS_WITHOUT_CONNECT:
|
|
||||||
raise cv.Invalid(
|
|
||||||
f"outgoing_connection is not supported with the {impl} socket "
|
|
||||||
"implementation (the only one on ESP8266 and RP2040) because it "
|
|
||||||
"cannot make outgoing connections",
|
|
||||||
path=[CONF_OUTGOING_CONNECTION],
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
def _validate_outgoing_host_ipv6(config: ConfigType) -> ConfigType:
|
|
||||||
"""An IPv6 host can never be parsed, so never dialed, without IPv6."""
|
|
||||||
if (
|
|
||||||
(outgoing := config.get(CONF_OUTGOING_CONNECTION)) is None
|
|
||||||
or (host := outgoing.get(CONF_HOST)) is None
|
|
||||||
or host.version != 6
|
|
||||||
):
|
|
||||||
return config
|
|
||||||
network_conf = fv.full_config.get().get("network") or {}
|
|
||||||
if not network_conf.get(CONF_ENABLE_IPV6):
|
|
||||||
raise cv.Invalid(
|
|
||||||
"outgoing_connection host is an IPv6 address but IPv6 is not "
|
|
||||||
"enabled; set 'network: enable_ipv6: true'",
|
|
||||||
path=[CONF_OUTGOING_CONNECTION, CONF_HOST],
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
FINAL_VALIDATE_SCHEMA = cv.All(
|
|
||||||
_validate_esp8266_action_strings,
|
|
||||||
_validate_outgoing_socket_implementation,
|
|
||||||
_validate_outgoing_host_ipv6,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _add_action_strings(
|
def _add_action_strings(
|
||||||
@@ -692,13 +606,6 @@ async def to_code(config: ConfigType) -> None:
|
|||||||
else:
|
else:
|
||||||
cg.add_define("USE_API_PLAINTEXT")
|
cg.add_define("USE_API_PLAINTEXT")
|
||||||
|
|
||||||
if (outgoing := config.get(CONF_OUTGOING_CONNECTION)) is not None:
|
|
||||||
cg.add_define("USE_API_OUTGOING_CONNECTION")
|
|
||||||
if (host := outgoing.get(CONF_HOST)) is not None:
|
|
||||||
cg.add_define("API_OUTGOING_CONNECTION_HOST", str(host))
|
|
||||||
cg.add_define("API_OUTGOING_CONNECTION_PORT", outgoing[CONF_PORT])
|
|
||||||
cg.add_define("API_OUTGOING_CONNECTION_DELAY", outgoing[CONF_DELAY])
|
|
||||||
|
|
||||||
cg.add_define("USE_API")
|
cg.add_define("USE_API")
|
||||||
cg.add_global(api_ns.using)
|
cg.add_global(api_ns.using)
|
||||||
|
|
||||||
@@ -1085,7 +992,6 @@ _define_filter = filter_source_files_from_defines(
|
|||||||
"user_services.cpp": "USE_API_USER_DEFINED_ACTIONS",
|
"user_services.cpp": "USE_API_USER_DEFINED_ACTIONS",
|
||||||
"api_frame_helper_noise.cpp": "USE_API_NOISE",
|
"api_frame_helper_noise.cpp": "USE_API_NOISE",
|
||||||
"api_frame_helper_plaintext.cpp": "USE_API_PLAINTEXT",
|
"api_frame_helper_plaintext.cpp": "USE_API_PLAINTEXT",
|
||||||
"api_outgoing_connection.cpp": "USE_API_OUTGOING_CONNECTION",
|
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -112,11 +112,6 @@ message HelloRequest {
|
|||||||
string client_info = 1;
|
string client_info = 1;
|
||||||
uint32 api_version_major = 2;
|
uint32 api_version_major = 2;
|
||||||
uint32 api_version_minor = 3;
|
uint32 api_version_minor = 3;
|
||||||
|
|
||||||
// Set by clients that can accept connections the device opens to them
|
|
||||||
// (see api: outgoing_connection:). The device remembers this client's
|
|
||||||
// address as the target to dial when no such client is connected.
|
|
||||||
bool outgoing_connection_target = 4 [(field_ifdef) = "USE_API_OUTGOING_CONNECTION"];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Confirmation of successful connection request.
|
// Confirmation of successful connection request.
|
||||||
@@ -336,10 +331,6 @@ message DeviceInfoResponse {
|
|||||||
// all-zeros PSK, so the api encryption key can be provisioned without being
|
// all-zeros PSK, so the api encryption key can be provisioned without being
|
||||||
// sent in plaintext (protects against passive sniffing, not active MITM)
|
// sent in plaintext (protects against passive sniffing, not active MITM)
|
||||||
bool api_encryption_provisionable = 26 [(field_ifdef) = "USE_API_NOISE"];
|
bool api_encryption_provisionable = 26 [(field_ifdef) = "USE_API_NOISE"];
|
||||||
|
|
||||||
// Device is built with the api outgoing_connection option and can open
|
|
||||||
// the TCP connection to a dial-back target itself
|
|
||||||
bool api_outgoing_connection_supported = 27 [(field_ifdef) = "USE_API_OUTGOING_CONNECTION"];
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// ==================== DEVICE CAPABILITIES ====================
|
// ==================== DEVICE CAPABILITIES ====================
|
||||||
|
|||||||
@@ -1822,19 +1822,6 @@ bool APIConnection::send_hello_response_(const HelloRequest &msg) {
|
|||||||
// Auto-authenticate - password auth was removed in ESPHome 2026.1.0
|
// Auto-authenticate - password auth was removed in ESPHome 2026.1.0
|
||||||
this->complete_authentication_();
|
this->complete_authentication_();
|
||||||
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
// With a PSK set only key-verified transports reach hello: plaintext and
|
|
||||||
// zero-PSK are rejected, and pre-activation sessions are force-closed
|
|
||||||
if (msg.outgoing_connection_target && !this->flags_.outgoing_connection_target) {
|
|
||||||
if (this->parent_->get_noise_ctx().has_psk()) {
|
|
||||||
this->flags_.outgoing_connection_target = true;
|
|
||||||
this->parent_->on_outgoing_target_client(this);
|
|
||||||
} else {
|
|
||||||
this->log_client_(ESPHOME_LOG_LEVEL_WARN, LOG_STR("Dial-back target refused; no key active"));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
return this->send_message(resp);
|
return this->send_message(resp);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1957,9 +1944,6 @@ bool APIConnection::send_device_info_response_() {
|
|||||||
// one) so this advertisement survives the plaintext removal in 2027.2.0.
|
// one) so this advertisement survives the plaintext removal in 2027.2.0.
|
||||||
resp.api_encryption_provisionable = !this->parent_->get_noise_ctx().has_psk();
|
resp.api_encryption_provisionable = !this->parent_->get_noise_ctx().has_psk();
|
||||||
#endif
|
#endif
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
resp.api_outgoing_connection_supported = true;
|
|
||||||
#endif
|
|
||||||
#endif
|
#endif
|
||||||
#ifdef USE_DEVICES
|
#ifdef USE_DEVICES
|
||||||
size_t device_index = 0;
|
size_t device_index = 0;
|
||||||
@@ -2271,7 +2255,12 @@ bool APIConnection::send_message_(uint32_t payload_size, uint16_t message_type,
|
|||||||
// Capacity reserved above, cannot fail
|
// Capacity reserved above, cannot fail
|
||||||
(void) shared_buf.resize(write_start + payload_size);
|
(void) shared_buf.resize(write_start + payload_size);
|
||||||
ProtoWriteBuffer buffer{&shared_buf, write_start};
|
ProtoWriteBuffer buffer{&shared_buf, write_start};
|
||||||
encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
|
uint8_t *end = encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
|
||||||
|
#ifdef ESPHOME_DEBUG_API
|
||||||
|
assert(end == shared_buf.data() + shared_buf.size());
|
||||||
|
#else
|
||||||
|
(void) end;
|
||||||
|
#endif
|
||||||
return this->send_buffer(ProtoWriteBuffer{&shared_buf}, message_type);
|
return this->send_buffer(ProtoWriteBuffer{&shared_buf}, message_type);
|
||||||
}
|
}
|
||||||
// encode_to_buffer is defined inline in api_connection.h (ESPHOME_ALWAYS_INLINE)
|
// encode_to_buffer is defined inline in api_connection.h (ESPHOME_ALWAYS_INLINE)
|
||||||
|
|||||||
@@ -345,11 +345,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
/// Returns false as soon as the TCP buffer is full. Marked nodiscard so we
|
/// Returns false as soon as the TCP buffer is full. Marked nodiscard so we
|
||||||
/// have no silent failures: every caller must handle (or log) a refusal.
|
/// have no silent failures: every caller must handle (or log) a refusal.
|
||||||
template<typename T> [[nodiscard]] bool send_message(const T &msg) {
|
template<typename T> [[nodiscard]] bool send_message(const T &msg) {
|
||||||
if constexpr (T::ESTIMATED_SIZE == 0) {
|
return this->send_message_(T::calc_size_msg(&msg), T::MESSAGE_TYPE, &T::encode_msg, &msg);
|
||||||
return this->send_message_(0, T::MESSAGE_TYPE, &encode_msg_noop, &msg);
|
|
||||||
} else {
|
|
||||||
return this->send_message_(msg.calculate_size(), T::MESSAGE_TYPE, &proto_encode_msg<T>, &msg);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Clear the shared write buffer and reserve space for the first message.
|
/// Clear the shared write buffer and reserve space for the first message.
|
||||||
@@ -375,21 +371,6 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
return this->helper_->get_peername_to(buf);
|
return this->helper_->get_peername_to(buf);
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
/// Outgoing connection: send our server hello immediately so the peer can
|
|
||||||
/// pick the matching key. Outgoing connections are only dialed when a PSK
|
|
||||||
/// is set, so the helper is always the noise helper. Call after start().
|
|
||||||
void mark_outgoing() {
|
|
||||||
if (this->flags_.remove) {
|
|
||||||
return; // start() failed; the connection is already being torn down
|
|
||||||
}
|
|
||||||
APIError err = static_cast<APINoiseFrameHelper *>(this->helper_.get())->send_server_hello_first();
|
|
||||||
if (err != APIError::OK) {
|
|
||||||
this->fatal_error_with_log_(LOG_STR("Server hello failed"), err);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
protected:
|
protected:
|
||||||
bool try_to_clear_buffer_slow_(bool log_out_of_space);
|
bool try_to_clear_buffer_slow_(bool log_out_of_space);
|
||||||
|
|
||||||
@@ -420,16 +401,6 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
void process_state_subscriptions_();
|
void process_state_subscriptions_();
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Size thunk — converts void* back to concrete type for direct calculate_size() call
|
|
||||||
template<typename T> static uint32_t calc_size(const void *msg) {
|
|
||||||
return static_cast<const T *>(msg)->calculate_size();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Shared no-op encode thunk for empty messages (ESTIMATED_SIZE == 0)
|
|
||||||
static uint8_t *encode_msg_noop(const void *, ProtoWriteBuffer &buf PROTO_ENCODE_DEBUG_PARAM) {
|
|
||||||
return buf.get_pos();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Non-template buffer management for send_message
|
// Non-template buffer management for send_message
|
||||||
bool send_message_(uint32_t payload_size, uint16_t message_type, MessageEncodeFn encode_fn, const void *msg);
|
bool send_message_(uint32_t payload_size, uint16_t message_type, MessageEncodeFn encode_fn, const void *msg);
|
||||||
|
|
||||||
@@ -448,11 +419,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
// Hot paths (state/info) go through fill_and_encode_entity_state/info instead.
|
// Hot paths (state/info) go through fill_and_encode_entity_state/info instead.
|
||||||
// batch_message_type_ is already set by dispatch_message_ before reaching here.
|
// batch_message_type_ is already set by dispatch_message_ before reaching here.
|
||||||
template<typename T> static uint16_t encode_message_to_buffer(T &msg, APIConnection *conn, uint32_t remaining_size) {
|
template<typename T> static uint16_t encode_message_to_buffer(T &msg, APIConnection *conn, uint32_t remaining_size) {
|
||||||
if constexpr (T::ESTIMATED_SIZE == 0) {
|
return encode_to_buffer_slow(T::calc_size_msg(&msg), &T::encode_msg, &msg, conn, remaining_size);
|
||||||
return encode_to_buffer_slow(0, &encode_msg_noop, &msg, conn, remaining_size);
|
|
||||||
} else {
|
|
||||||
return encode_to_buffer_slow(msg.calculate_size(), &proto_encode_msg<T>, &msg, conn, remaining_size);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills state fields and encodes
|
// Non-template core — fills state fields and encodes
|
||||||
@@ -464,7 +431,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
static uint16_t fill_and_encode_entity_state(EntityBase *entity, T &msg, APIConnection *conn,
|
static uint16_t fill_and_encode_entity_state(EntityBase *entity, T &msg, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_state(entity, msg, &calc_size<T>, &proto_encode_msg<T>, conn, remaining_size);
|
return fill_and_encode_entity_state(entity, msg, &T::calc_size_msg, &T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills info fields, allocates buffers, and encodes
|
// Non-template core — fills info fields, allocates buffers, and encodes
|
||||||
@@ -476,7 +443,7 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
static uint16_t fill_and_encode_entity_info(EntityBase *entity, T &msg, APIConnection *conn,
|
static uint16_t fill_and_encode_entity_info(EntityBase *entity, T &msg, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_info(entity, msg, &calc_size<T>, &proto_encode_msg<T>, conn, remaining_size);
|
return fill_and_encode_entity_info(entity, msg, &T::calc_size_msg, &T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Non-template core — fills device_class, then delegates to fill_and_encode_entity_info
|
// Non-template core — fills device_class, then delegates to fill_and_encode_entity_info
|
||||||
@@ -490,8 +457,8 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
static uint16_t fill_and_encode_entity_info_with_device_class(EntityBase *entity, T &msg,
|
static uint16_t fill_and_encode_entity_info_with_device_class(EntityBase *entity, T &msg,
|
||||||
StringRef &device_class_field, APIConnection *conn,
|
StringRef &device_class_field, APIConnection *conn,
|
||||||
uint32_t remaining_size) {
|
uint32_t remaining_size) {
|
||||||
return fill_and_encode_entity_info_with_device_class(entity, msg, device_class_field, &calc_size<T>,
|
return fill_and_encode_entity_info_with_device_class(entity, msg, device_class_field, &T::calc_size_msg,
|
||||||
&proto_encode_msg<T>, conn, remaining_size);
|
&T::encode_msg, conn, remaining_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_VOICE_ASSISTANT
|
#ifdef USE_VOICE_ASSISTANT
|
||||||
@@ -760,9 +727,6 @@ class APIConnection final : public APIServerConnectionBase {
|
|||||||
uint8_t batch_first_message : 1; // For batch buffer allocation
|
uint8_t batch_first_message : 1; // For batch buffer allocation
|
||||||
uint8_t should_try_send_immediately : 1; // True after initial states are sent
|
uint8_t should_try_send_immediately : 1; // True after initial states are sent
|
||||||
uint8_t may_have_remaining_data : 1; // Read loop hit limit, retry without ready check
|
uint8_t may_have_remaining_data : 1; // Read loop hit limit, retry without ready check
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
uint8_t outgoing_connection_target : 1; // Client declared itself a dial-back target in its hello
|
|
||||||
#endif
|
|
||||||
#ifdef HAS_PROTO_MESSAGE_DUMP
|
#ifdef HAS_PROTO_MESSAGE_DUMP
|
||||||
uint8_t log_only_mode : 1;
|
uint8_t log_only_mode : 1;
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -46,7 +46,13 @@ inline uint16_t ESPHOME_ALWAYS_INLINE APIConnection::encode_to_buffer(uint32_t c
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
ProtoWriteBuffer buffer{&shared_buf, shared_buf.size() - calculated_size};
|
ProtoWriteBuffer buffer{&shared_buf, shared_buf.size() - calculated_size};
|
||||||
encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
|
uint8_t *end = encode_fn(msg, buffer PROTO_ENCODE_DEBUG_INIT(&shared_buf));
|
||||||
|
#ifdef ESPHOME_DEBUG_API
|
||||||
|
// A body that writes fewer bytes than calculate_size() promised would ship stale buffer bytes
|
||||||
|
assert(end == shared_buf.data() + shared_buf.size());
|
||||||
|
#else
|
||||||
|
(void) end;
|
||||||
|
#endif
|
||||||
|
|
||||||
return total_calculated_size;
|
return total_calculated_size;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -282,8 +282,7 @@ class APIFrameHelper {
|
|||||||
DATA = 5,
|
DATA = 5,
|
||||||
CLOSED = 6,
|
CLOSED = 6,
|
||||||
FAILED = 7,
|
FAILED = 7,
|
||||||
EXPLICIT_REJECT = 8, // Noise only
|
EXPLICIT_REJECT = 8, // Noise only
|
||||||
CLIENT_HELLO_OUTGOING = 9, // Noise only: like CLIENT_HELLO but the server hello already went out (outgoing conn)
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// Fast inline state check for read_packet/write_protobuf_messages hot path.
|
// Fast inline state check for read_packet/write_protobuf_messages hot path.
|
||||||
|
|||||||
@@ -81,13 +81,6 @@ APIError APINoiseFrameHelper::init() {
|
|||||||
state_ = State::CLIENT_HELLO;
|
state_ = State::CLIENT_HELLO;
|
||||||
return APIError::OK;
|
return APIError::OK;
|
||||||
}
|
}
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
APIError APINoiseFrameHelper::send_server_hello_first() {
|
|
||||||
// The peer needs our name and MAC to pick the key before its first message
|
|
||||||
this->state_ = State::CLIENT_HELLO_OUTGOING;
|
|
||||||
return this->send_server_hello_frame_();
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
#ifdef USE_API_PLAINTEXT
|
#ifdef USE_API_PLAINTEXT
|
||||||
APIError APINoiseFrameHelper::init_from_handoff(const uint8_t *header, uint8_t header_len) {
|
APIError APINoiseFrameHelper::init_from_handoff(const uint8_t *header, uint8_t header_len) {
|
||||||
APIError err = this->init();
|
APIError err = this->init();
|
||||||
@@ -260,9 +253,6 @@ APIError APINoiseFrameHelper::state_action_() {
|
|||||||
HELPER_LOG("Bad state for method: %d", (int) this->state_);
|
HELPER_LOG("Bad state for method: %d", (int) this->state_);
|
||||||
return APIError::BAD_STATE;
|
return APIError::BAD_STATE;
|
||||||
case State::CLIENT_HELLO:
|
case State::CLIENT_HELLO:
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
case State::CLIENT_HELLO_OUTGOING:
|
|
||||||
#endif
|
|
||||||
return this->state_action_client_hello_();
|
return this->state_action_client_hello_();
|
||||||
case State::SERVER_HELLO:
|
case State::SERVER_HELLO:
|
||||||
return this->state_action_server_hello_();
|
return this->state_action_server_hello_();
|
||||||
@@ -295,16 +285,11 @@ APIError APINoiseFrameHelper::state_action_client_hello_() {
|
|||||||
std::memcpy(this->prologue_.data() + old_size + 2, this->rx_buf_.data(), rx_size);
|
std::memcpy(this->prologue_.data() + old_size + 2, this->rx_buf_.data(), rx_size);
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
if (this->state_ == State::CLIENT_HELLO_OUTGOING) {
|
|
||||||
// Server hello already went out at handoff
|
|
||||||
return this->start_handshake_();
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
state_ = State::SERVER_HELLO;
|
state_ = State::SERVER_HELLO;
|
||||||
return APIError::OK;
|
return APIError::OK;
|
||||||
}
|
}
|
||||||
APIError APINoiseFrameHelper::send_server_hello_frame_() {
|
APIError APINoiseFrameHelper::state_action_server_hello_() {
|
||||||
|
// send server hello
|
||||||
const auto &name = App.get_name();
|
const auto &name = App.get_name();
|
||||||
char mac[MAC_ADDRESS_BUFFER_SIZE];
|
char mac[MAC_ADDRESS_BUFFER_SIZE];
|
||||||
get_mac_address_into_buffer(mac);
|
get_mac_address_into_buffer(mac);
|
||||||
@@ -328,18 +313,15 @@ APIError APINoiseFrameHelper::send_server_hello_frame_() {
|
|||||||
// node mac, terminated by null byte
|
// node mac, terminated by null byte
|
||||||
std::memcpy(msg + mac_offset, mac, MAC_ADDRESS_BUFFER_SIZE);
|
std::memcpy(msg + mac_offset, mac, MAC_ADDRESS_BUFFER_SIZE);
|
||||||
|
|
||||||
return write_frame_(msg, total_size);
|
APIError aerr = write_frame_(msg, total_size);
|
||||||
}
|
|
||||||
APIError APINoiseFrameHelper::state_action_server_hello_() {
|
|
||||||
APIError aerr = this->send_server_hello_frame_();
|
|
||||||
if (aerr != APIError::OK)
|
if (aerr != APIError::OK)
|
||||||
return aerr;
|
return aerr;
|
||||||
return this->start_handshake_();
|
|
||||||
}
|
// start handshake
|
||||||
APIError APINoiseFrameHelper::start_handshake_() {
|
aerr = init_handshake_();
|
||||||
APIError aerr = init_handshake_();
|
|
||||||
if (aerr != APIError::OK)
|
if (aerr != APIError::OK)
|
||||||
return aerr;
|
return aerr;
|
||||||
|
|
||||||
state_ = State::HANDSHAKE;
|
state_ = State::HANDSHAKE;
|
||||||
return APIError::OK;
|
return APIError::OK;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -28,12 +28,6 @@ class APINoiseFrameHelper final : public APIFrameHelper {
|
|||||||
// Seeds the already-read header bytes and pumps the handshake state machine
|
// Seeds the already-read header bytes and pumps the handshake state machine
|
||||||
// until it would block.
|
// until it would block.
|
||||||
APIError init_from_handoff(const uint8_t *header, uint8_t header_len);
|
APIError init_from_handoff(const uint8_t *header, uint8_t header_len);
|
||||||
#endif
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
// Send the server hello immediately so the peer can pick the key before
|
|
||||||
// its PSK-mixed message. Call after init(); the mode is tracked in state_
|
|
||||||
// so the helper does not grow.
|
|
||||||
APIError send_server_hello_first();
|
|
||||||
#endif
|
#endif
|
||||||
APIError loop() override;
|
APIError loop() override;
|
||||||
APIError read_packet(ReadPacketBuffer *buffer) override;
|
APIError read_packet(ReadPacketBuffer *buffer) override;
|
||||||
@@ -45,8 +39,6 @@ class APINoiseFrameHelper final : public APIFrameHelper {
|
|||||||
APIError state_action_();
|
APIError state_action_();
|
||||||
APIError state_action_client_hello_();
|
APIError state_action_client_hello_();
|
||||||
APIError state_action_server_hello_();
|
APIError state_action_server_hello_();
|
||||||
APIError send_server_hello_frame_();
|
|
||||||
APIError start_handshake_();
|
|
||||||
APIError state_action_handshake_();
|
APIError state_action_handshake_();
|
||||||
APIError state_action_handshake_read_();
|
APIError state_action_handshake_read_();
|
||||||
APIError state_action_handshake_write_();
|
APIError state_action_handshake_write_();
|
||||||
|
|||||||
@@ -1,236 +0,0 @@
|
|||||||
#include "api_outgoing_connection.h"
|
|
||||||
#if defined(USE_API) && defined(USE_API_OUTGOING_CONNECTION)
|
|
||||||
|
|
||||||
#include "api_connection.h"
|
|
||||||
#include "api_server.h"
|
|
||||||
#include "esphome/components/network/util.h"
|
|
||||||
#include "esphome/core/application.h"
|
|
||||||
#include "esphome/core/helpers.h"
|
|
||||||
#include "esphome/core/log.h"
|
|
||||||
|
|
||||||
#include <cerrno>
|
|
||||||
#include <cinttypes>
|
|
||||||
#include <cstring>
|
|
||||||
|
|
||||||
namespace esphome::api {
|
|
||||||
|
|
||||||
static const char *const TAG = "api.outgoing";
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::setup() {
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
this->target_pref_ = global_preferences->make_preference<SavedOutgoingTarget>(629847102UL, true);
|
|
||||||
if (this->target_pref_.load(&this->saved_)) {
|
|
||||||
// Defend against a corrupt or truncated blob before the first read
|
|
||||||
this->saved_.host[sizeof(this->saved_.host) - 1] = '\0';
|
|
||||||
this->host_persisted_ = true;
|
|
||||||
ESP_LOGD(TAG, "Loaded target %s", this->saved_.host);
|
|
||||||
} else {
|
|
||||||
// Never saved, or the blob failed its size/CRC check
|
|
||||||
ESP_LOGD(TAG, "No saved target");
|
|
||||||
this->saved_ = {};
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::loop(APIServer *server) {
|
|
||||||
if (server->has_outgoing_target_client_()) {
|
|
||||||
return; // on_target_client() already reset the dial state
|
|
||||||
}
|
|
||||||
if (this->dialed_conn_ != nullptr) {
|
|
||||||
// A live dialed session (flagged or not, e.g. a host: peer) is the
|
|
||||||
// target; a silent one dies on the handshake timeout
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const uint32_t now = App.get_loop_component_start_time();
|
|
||||||
switch (this->state_) {
|
|
||||||
case DialState::DIAL_STATE_IDLE:
|
|
||||||
#ifdef USE_DEEP_SLEEP
|
|
||||||
// A deep sleep wake window is too short to spend on the delay
|
|
||||||
this->schedule_wait_(now, BACKOFF_MIN_MS);
|
|
||||||
#else
|
|
||||||
// Target went away; give it the configured delay to reconnect first
|
|
||||||
this->schedule_wait_(now, API_OUTGOING_CONNECTION_DELAY);
|
|
||||||
#endif
|
|
||||||
break;
|
|
||||||
case DialState::DIAL_STATE_WAITING:
|
|
||||||
if (now - this->state_ts_ >= this->wait_) {
|
|
||||||
this->try_dial_(server, now);
|
|
||||||
}
|
|
||||||
break;
|
|
||||||
case DialState::DIAL_STATE_CONNECTING:
|
|
||||||
this->poll_connect_(server, now);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::try_dial_(APIServer *server, uint32_t now) {
|
|
||||||
if (!network::is_connected()) {
|
|
||||||
// Flips within seconds of boot; recheck fast so a deep sleep wake
|
|
||||||
// window is not spent waiting
|
|
||||||
this->schedule_wait_(now, NETWORK_RETRY_MS);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const char *host = this->target_host_();
|
|
||||||
if (host == nullptr) {
|
|
||||||
// The steady state until a dial-back client has ever connected
|
|
||||||
ESP_LOGV(TAG, "Not dialing: no target");
|
|
||||||
this->schedule_wait_(now, PRECONDITION_RETRY_MS);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
const bool at_limit = server->at_client_limit_();
|
|
||||||
if (at_limit || !server->noise_ctx_.has_psk()) {
|
|
||||||
ESP_LOGD(TAG, "Not dialing: %s", at_limit ? "max connections" : "no key");
|
|
||||||
// Not a dial failure; retry without escalating the backoff
|
|
||||||
this->schedule_wait_(now, PRECONDITION_RETRY_MS);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
struct sockaddr_storage addr;
|
|
||||||
socklen_t addr_len =
|
|
||||||
socket::set_sockaddr((struct sockaddr *) &addr, sizeof(addr), host, API_OUTGOING_CONNECTION_PORT);
|
|
||||||
if (addr_len == 0) {
|
|
||||||
ESP_LOGW(TAG, "Invalid target %s", host);
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
// A corrupt remembered value can never become dialable; forget it
|
|
||||||
// (covers an IPv6 literal left by an earlier enable_ipv6 build too)
|
|
||||||
this->saved_ = {};
|
|
||||||
if (!this->persist_target_()) {
|
|
||||||
ESP_LOGW(TAG, "Failed to clear target");
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
this->schedule_retry_(now);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this->dial_socket_ = socket::socket_loop_monitored(((struct sockaddr *) &addr)->sa_family, SOCK_STREAM, IPPROTO_TCP);
|
|
||||||
if (!this->dial_socket_ || this->dial_socket_->setblocking(false) != 0) {
|
|
||||||
ESP_LOGW(TAG, "Socket %s failed: errno %d", this->dial_socket_ ? "setblocking" : "create", errno);
|
|
||||||
this->schedule_retry_(now);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
ESP_LOGD(TAG, "Dialing %s:%u", host, API_OUTGOING_CONNECTION_PORT);
|
|
||||||
int err = this->dial_socket_->connect((struct sockaddr *) &addr, addr_len);
|
|
||||||
if (err == 0) {
|
|
||||||
// Immediate success (possible for localhost)
|
|
||||||
this->handoff_(server, now);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (errno != EINPROGRESS) {
|
|
||||||
ESP_LOGW(TAG, "Connect failed: errno %d", errno);
|
|
||||||
this->schedule_retry_(now);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this->state_ = DialState::DIAL_STATE_CONNECTING;
|
|
||||||
this->state_ts_ = now;
|
|
||||||
this->last_poll_ = now;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::poll_connect_(APIServer *server, uint32_t now) {
|
|
||||||
if (now - this->state_ts_ >= CONNECT_TIMEOUT_MS) {
|
|
||||||
ESP_LOGW(TAG, "Connect timeout");
|
|
||||||
this->schedule_retry_(now);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (now - this->last_poll_ < CONNECT_POLL_INTERVAL_MS) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this->last_poll_ = now;
|
|
||||||
int err = 0;
|
|
||||||
switch (socket::poll_connect(*this->dial_socket_, err)) {
|
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_PENDING:
|
|
||||||
break;
|
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_CONNECTED:
|
|
||||||
this->handoff_(server, now);
|
|
||||||
break;
|
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_ERROR:
|
|
||||||
ESP_LOGW(TAG, "Connect failed: %d", err);
|
|
||||||
this->schedule_retry_(now);
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::handoff_(APIServer *server, uint32_t now) {
|
|
||||||
this->dialed_conn_ = server->add_outgoing_client_(std::move(this->dial_socket_));
|
|
||||||
if (this->dialed_conn_ == nullptr) {
|
|
||||||
// Only preconditions (slot limit, key cleared) refuse the handoff; the
|
|
||||||
// peer is reachable, so do not escalate the backoff
|
|
||||||
this->schedule_wait_(now, PRECONDITION_RETRY_MS);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
// Connected; dialed_conn_ gates further dialing until the session settles
|
|
||||||
this->state_ = DialState::DIAL_STATE_IDLE;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::schedule_wait_(uint32_t now, uint32_t wait) {
|
|
||||||
this->dial_socket_.reset(); // no-op when the socket was handed off
|
|
||||||
this->state_ = DialState::DIAL_STATE_WAITING;
|
|
||||||
this->state_ts_ = now;
|
|
||||||
this->wait_ = wait;
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::schedule_retry_(uint32_t now) {
|
|
||||||
// +/-20% jitter so a fleet of devices does not retry one server in lockstep
|
|
||||||
const uint32_t jitter_span = this->backoff_ / 5;
|
|
||||||
this->schedule_wait_(now, this->backoff_ - jitter_span + (random_uint32() % (2 * jitter_span + 1)));
|
|
||||||
this->backoff_ = std::min(this->backoff_ * 2, BACKOFF_MAX_MS);
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::on_client_removed(APIConnection *conn, bool was_authenticated) {
|
|
||||||
if (conn != this->dialed_conn_) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
this->dialed_conn_ = nullptr;
|
|
||||||
if (was_authenticated) {
|
|
||||||
// A working peer (e.g. a host: target that never sends the flag)
|
|
||||||
// disconnected normally; state is IDLE, so loop() applies the delay
|
|
||||||
this->backoff_ = BACKOFF_MIN_MS;
|
|
||||||
} else {
|
|
||||||
this->schedule_retry_(App.get_loop_component_start_time());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::on_target_client(APIConnection *conn) {
|
|
||||||
// The target is connected; stop any dial in flight and reset the backoff.
|
|
||||||
// A dialed connection stays tracked unless it is this one: an inbound
|
|
||||||
// target must not orphan a still-open dial.
|
|
||||||
this->dial_socket_.reset();
|
|
||||||
if (conn == this->dialed_conn_) {
|
|
||||||
this->dialed_conn_ = nullptr;
|
|
||||||
}
|
|
||||||
this->state_ = DialState::DIAL_STATE_IDLE;
|
|
||||||
this->backoff_ = BACKOFF_MIN_MS;
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
SavedOutgoingTarget target{};
|
|
||||||
conn->get_peername_to(target.host);
|
|
||||||
if (target.host[0] == '\0') {
|
|
||||||
ESP_LOGW(TAG, "Could not read peer address; not remembering target");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (this->host_persisted_ && strcmp(target.host, this->saved_.host) == 0) {
|
|
||||||
return; // unchanged and already on flash; avoid flash wear
|
|
||||||
}
|
|
||||||
// Use the fresh address this boot even if the flash write fails; a failed
|
|
||||||
// write is retried on the next flagged hello via host_persisted_
|
|
||||||
this->saved_ = target;
|
|
||||||
if (!this->persist_target_()) {
|
|
||||||
ESP_LOGW(TAG, "Failed to save target");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
ESP_LOGD(TAG, "Saved %s as outgoing connection target", this->saved_.host);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
void OutgoingConnectionManager::dump_config() const {
|
|
||||||
const char *host = this->target_host_();
|
|
||||||
if (host == nullptr) {
|
|
||||||
host = "none remembered yet";
|
|
||||||
}
|
|
||||||
// The boot delay differs from delay: on deep sleep builds, so print the
|
|
||||||
// value that actually applies
|
|
||||||
ESP_LOGCONFIG(TAG,
|
|
||||||
" Outgoing connection port: %u\n"
|
|
||||||
" Outgoing connection host: %s\n"
|
|
||||||
" Outgoing connection boot delay: %" PRIu32 "ms",
|
|
||||||
API_OUTGOING_CONNECTION_PORT, host, BOOT_WAIT_MS);
|
|
||||||
}
|
|
||||||
|
|
||||||
} // namespace esphome::api
|
|
||||||
#endif // USE_API && USE_API_OUTGOING_CONNECTION
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
#pragma once
|
|
||||||
|
|
||||||
#include "esphome/core/defines.h"
|
|
||||||
#if defined(USE_API) && defined(USE_API_OUTGOING_CONNECTION)
|
|
||||||
|
|
||||||
#ifdef USE_SOCKET_IMPL_LWIP_TCP
|
|
||||||
#error "api outgoing_connection needs a socket implementation that can make outgoing connections"
|
|
||||||
#endif
|
|
||||||
#ifndef USE_API_NOISE
|
|
||||||
#error "api outgoing_connection needs noise encryption so the peer is verified by key"
|
|
||||||
#endif
|
|
||||||
|
|
||||||
#include "esphome/components/socket/socket.h"
|
|
||||||
#include "esphome/core/preferences.h"
|
|
||||||
|
|
||||||
#include <memory>
|
|
||||||
|
|
||||||
namespace esphome::api {
|
|
||||||
|
|
||||||
class APIServer;
|
|
||||||
class APIConnection;
|
|
||||||
|
|
||||||
// Follows the build's address family (ifdef'd in socket/headers.h): toggling
|
|
||||||
// enable_ipv6 changes the blob size, load() rejects the old blob, and the
|
|
||||||
// target is simply relearned
|
|
||||||
static constexpr size_t SAVED_TARGET_HOST_LEN = socket::SOCKADDR_STR_LEN;
|
|
||||||
|
|
||||||
struct SavedOutgoingTarget {
|
|
||||||
// IP as text so the socket component's v4-mapped-IPv6 normalization is
|
|
||||||
// reused on both ends; empty = none remembered
|
|
||||||
char host[SAVED_TARGET_HOST_LEN];
|
|
||||||
} PACKED; // NOLINT
|
|
||||||
|
|
||||||
/// Dials out when no dial-back target client is connected. Only the TCP
|
|
||||||
/// direction flips: the device stays the Noise responder, so both sides
|
|
||||||
/// still verify by key. Targets the YAML host or the last remembered client.
|
|
||||||
class OutgoingConnectionManager {
|
|
||||||
public:
|
|
||||||
void setup();
|
|
||||||
void loop(APIServer *server);
|
|
||||||
/// A key-verified client declared itself a dial-back target; last one wins
|
|
||||||
void on_target_client(APIConnection *conn);
|
|
||||||
/// Clears the dialed-connection gate; dying unauthenticated escalates the backoff
|
|
||||||
void on_client_removed(APIConnection *conn, bool was_authenticated);
|
|
||||||
void on_shutdown() { this->dial_socket_.reset(); }
|
|
||||||
void dump_config() const;
|
|
||||||
|
|
||||||
protected:
|
|
||||||
enum class DialState : uint8_t {
|
|
||||||
DIAL_STATE_IDLE,
|
|
||||||
DIAL_STATE_WAITING,
|
|
||||||
DIAL_STATE_CONNECTING,
|
|
||||||
};
|
|
||||||
|
|
||||||
static constexpr uint32_t BACKOFF_MIN_MS = 5000;
|
|
||||||
static constexpr uint32_t BACKOFF_MAX_MS = 300000;
|
|
||||||
static constexpr uint32_t CONNECT_TIMEOUT_MS = 10000;
|
|
||||||
static constexpr uint32_t CONNECT_POLL_INTERVAL_MS = 250;
|
|
||||||
static constexpr uint32_t NETWORK_RETRY_MS = 500;
|
|
||||||
static constexpr uint32_t PRECONDITION_RETRY_MS = 5000;
|
|
||||||
// Boot waits for the client to connect in first; a deep sleep wake window
|
|
||||||
// is short, so connecting out immediately is the wake state
|
|
||||||
#ifdef USE_DEEP_SLEEP
|
|
||||||
static constexpr uint32_t BOOT_WAIT_MS = 0;
|
|
||||||
#else
|
|
||||||
static constexpr uint32_t BOOT_WAIT_MS = API_OUTGOING_CONNECTION_DELAY;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
void try_dial_(APIServer *server, uint32_t now);
|
|
||||||
void poll_connect_(APIServer *server, uint32_t now);
|
|
||||||
// Hand the connected socket to the server and gate on the new connection
|
|
||||||
void handoff_(APIServer *server, uint32_t now);
|
|
||||||
// Close any half-open dial and wait a jittered backoff before retrying
|
|
||||||
void schedule_retry_(uint32_t now);
|
|
||||||
// Wait without escalating the backoff (used for unmet preconditions)
|
|
||||||
void schedule_wait_(uint32_t now, uint32_t wait);
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
// Write saved_ to flash, tracking success in host_persisted_
|
|
||||||
bool persist_target_() {
|
|
||||||
this->host_persisted_ = this->target_pref_.save(&this->saved_) && global_preferences->sync();
|
|
||||||
return this->host_persisted_;
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
const char *target_host_() const {
|
|
||||||
#ifdef API_OUTGOING_CONNECTION_HOST
|
|
||||||
return API_OUTGOING_CONNECTION_HOST;
|
|
||||||
#else
|
|
||||||
return this->saved_.host[0] != '\0' ? this->saved_.host : nullptr;
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
// Pointers first (4 bytes each on 32-bit)
|
|
||||||
std::unique_ptr<socket::Socket> dial_socket_;
|
|
||||||
// Compared only, never dereferenced
|
|
||||||
APIConnection *dialed_conn_{nullptr};
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
ESPPreferenceObject target_pref_;
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// 4-byte types
|
|
||||||
uint32_t backoff_{BACKOFF_MIN_MS};
|
|
||||||
uint32_t wait_{BOOT_WAIT_MS};
|
|
||||||
uint32_t state_ts_{0};
|
|
||||||
uint32_t last_poll_{0};
|
|
||||||
|
|
||||||
// Byte-aligned types last
|
|
||||||
#ifndef API_OUTGOING_CONNECTION_HOST
|
|
||||||
SavedOutgoingTarget saved_{};
|
|
||||||
// False while saved_ holds a value the flash write failed for; retried on
|
|
||||||
// the next flagged hello
|
|
||||||
bool host_persisted_{false};
|
|
||||||
#endif
|
|
||||||
DialState state_{DialState::DIAL_STATE_WAITING};
|
|
||||||
};
|
|
||||||
|
|
||||||
} // namespace esphome::api
|
|
||||||
#endif // USE_API && USE_API_OUTGOING_CONNECTION
|
|
||||||
+2651
-2639
File diff suppressed because it is too large
Load Diff
+873
-359
File diff suppressed because it is too large
Load Diff
@@ -885,9 +885,6 @@ const char *HelloRequest::dump_to(DumpBuffer &out) const {
|
|||||||
dump_field(out, ESPHOME_PSTR("client_info"), this->client_info);
|
dump_field(out, ESPHOME_PSTR("client_info"), this->client_info);
|
||||||
dump_field(out, ESPHOME_PSTR("api_version_major"), this->api_version_major);
|
dump_field(out, ESPHOME_PSTR("api_version_major"), this->api_version_major);
|
||||||
dump_field(out, ESPHOME_PSTR("api_version_minor"), this->api_version_minor);
|
dump_field(out, ESPHOME_PSTR("api_version_minor"), this->api_version_minor);
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
dump_field(out, ESPHOME_PSTR("outgoing_connection_target"), this->outgoing_connection_target);
|
|
||||||
#endif
|
|
||||||
return out.c_str();
|
return out.c_str();
|
||||||
}
|
}
|
||||||
const char *HelloResponse::dump_to(DumpBuffer &out) const {
|
const char *HelloResponse::dump_to(DumpBuffer &out) const {
|
||||||
@@ -1011,9 +1008,6 @@ const char *DeviceInfoResponse::dump_to(DumpBuffer &out) const {
|
|||||||
#endif
|
#endif
|
||||||
#ifdef USE_API_NOISE
|
#ifdef USE_API_NOISE
|
||||||
dump_field(out, ESPHOME_PSTR("api_encryption_provisionable"), this->api_encryption_provisionable);
|
dump_field(out, ESPHOME_PSTR("api_encryption_provisionable"), this->api_encryption_provisionable);
|
||||||
#endif
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
dump_field(out, ESPHOME_PSTR("api_outgoing_connection_supported"), this->api_outgoing_connection_supported);
|
|
||||||
#endif
|
#endif
|
||||||
return out.c_str();
|
return out.c_str();
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -34,46 +34,7 @@ APIServer::APIServer() { global_api_server = this; }
|
|||||||
void APIServer::socket_failed_(const LogString *msg) {
|
void APIServer::socket_failed_(const LogString *msg) {
|
||||||
ESP_LOGW(TAG, "Socket %s: errno %d", LOG_STR_ARG(msg), errno);
|
ESP_LOGW(TAG, "Socket %s: errno %d", LOG_STR_ARG(msg), errno);
|
||||||
this->destroy_socket_();
|
this->destroy_socket_();
|
||||||
}
|
this->mark_failed();
|
||||||
|
|
||||||
bool APIServer::create_listen_socket_() {
|
|
||||||
this->socket_ = socket::socket_ip_loop_monitored(SOCK_STREAM, 0).release(); // monitored for incoming connections
|
|
||||||
if (this->socket_ == nullptr) {
|
|
||||||
this->socket_failed_(LOG_STR("creation"));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
int enable = 1;
|
|
||||||
int err = this->socket_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(int));
|
|
||||||
if (err != 0) {
|
|
||||||
ESP_LOGW(TAG, "Socket reuseaddr: errno %d", errno);
|
|
||||||
// we can still continue
|
|
||||||
}
|
|
||||||
err = this->socket_->setblocking(false);
|
|
||||||
if (err != 0) {
|
|
||||||
this->socket_failed_(LOG_STR("nonblocking"));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
struct sockaddr_storage server;
|
|
||||||
|
|
||||||
socklen_t sl = socket::set_sockaddr_any((struct sockaddr *) &server, sizeof(server), this->port_);
|
|
||||||
if (sl == 0) {
|
|
||||||
this->socket_failed_(LOG_STR("set sockaddr"));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
err = this->socket_->bind((struct sockaddr *) &server, sl);
|
|
||||||
if (err != 0) {
|
|
||||||
this->socket_failed_(LOG_STR("bind"));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
err = this->socket_->listen(this->listen_backlog_);
|
|
||||||
if (err != 0) {
|
|
||||||
this->socket_failed_(LOG_STR("listen"));
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void APIServer::setup() {
|
void APIServer::setup() {
|
||||||
@@ -92,14 +53,41 @@ void APIServer::setup() {
|
|||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
if (!this->create_listen_socket_()) {
|
this->socket_ = socket::socket_ip_loop_monitored(SOCK_STREAM, 0).release(); // monitored for incoming connections
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
if (this->socket_ == nullptr) {
|
||||||
// Dial-out needs no listener; degrade instead of stopping the component
|
this->socket_failed_(LOG_STR("creation"));
|
||||||
this->status_set_error(LOG_STR("listen socket failed"));
|
return;
|
||||||
#else
|
}
|
||||||
this->mark_failed();
|
int enable = 1;
|
||||||
|
int err = this->socket_->setsockopt(SOL_SOCKET, SO_REUSEADDR, &enable, sizeof(int));
|
||||||
|
if (err != 0) {
|
||||||
|
ESP_LOGW(TAG, "Socket reuseaddr: errno %d", errno);
|
||||||
|
// we can still continue
|
||||||
|
}
|
||||||
|
err = this->socket_->setblocking(false);
|
||||||
|
if (err != 0) {
|
||||||
|
this->socket_failed_(LOG_STR("nonblocking"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
struct sockaddr_storage server;
|
||||||
|
|
||||||
|
socklen_t sl = socket::set_sockaddr_any((struct sockaddr *) &server, sizeof(server), this->port_);
|
||||||
|
if (sl == 0) {
|
||||||
|
this->socket_failed_(LOG_STR("set sockaddr"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
err = this->socket_->bind((struct sockaddr *) &server, sl);
|
||||||
|
if (err != 0) {
|
||||||
|
this->socket_failed_(LOG_STR("bind"));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
err = this->socket_->listen(this->listen_backlog_);
|
||||||
|
if (err != 0) {
|
||||||
|
this->socket_failed_(LOG_STR("listen"));
|
||||||
return;
|
return;
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_LOGGER
|
#ifdef USE_LOGGER
|
||||||
@@ -147,9 +135,6 @@ void APIServer::setup() {
|
|||||||
if (this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
if (this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
||||||
this->status_set_warning(LOG_STR("waiting for client connection"));
|
this->status_set_warning(LOG_STR("waiting for client connection"));
|
||||||
}
|
}
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
this->outgoing_conn_.setup();
|
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void APIServer::loop() {
|
void APIServer::loop() {
|
||||||
@@ -158,12 +143,6 @@ void APIServer::loop() {
|
|||||||
this->accept_new_connections_();
|
this->accept_new_connections_();
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
if (!this->shutting_down_) {
|
|
||||||
this->outgoing_conn_.loop(this);
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
if (this->api_connection_count_ == 0) {
|
if (this->api_connection_count_ == 0) {
|
||||||
// Check reboot timeout - done in loop to avoid scheduler heap churn
|
// Check reboot timeout - done in loop to avoid scheduler heap churn
|
||||||
// (cancelled scheduler items sit in heap memory until their scheduled time).
|
// (cancelled scheduler items sit in heap memory until their scheduled time).
|
||||||
@@ -172,12 +151,7 @@ void APIServer::loop() {
|
|||||||
if (this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
if (this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
||||||
const uint32_t now = App.get_loop_component_start_time();
|
const uint32_t now = App.get_loop_component_start_time();
|
||||||
if (now - this->last_connected_ > this->reboot_timeout_) {
|
if (now - this->last_connected_ > this->reboot_timeout_) {
|
||||||
// Distinguish a wrong-key peer from nothing connecting at all
|
ESP_LOGE(TAG, "No clients; rebooting");
|
||||||
if (this->saw_unauthenticated_client_) {
|
|
||||||
ESP_LOGE(TAG, "Clients connected but none authenticated; rebooting");
|
|
||||||
} else {
|
|
||||||
ESP_LOGE(TAG, "No clients; rebooting");
|
|
||||||
}
|
|
||||||
App.reboot();
|
App.reboot();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -229,15 +203,6 @@ void APIServer::remove_client_(uint8_t client_index) {
|
|||||||
std::string client_peername(client->get_peername_to(peername_buf));
|
std::string client_peername(client->get_peername_to(peername_buf));
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Read before the swap-and-reset below destroys the connection
|
|
||||||
const bool was_authenticated = client->is_authenticated();
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
if (client->flags_.outgoing_connection_target) {
|
|
||||||
this->outgoing_target_count_--;
|
|
||||||
}
|
|
||||||
this->outgoing_conn_.on_client_removed(client.get(), was_authenticated);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// Close socket now (was deferred from on_fatal_error to allow getpeername)
|
// Close socket now (was deferred from on_fatal_error to allow getpeername)
|
||||||
client->helper_->close();
|
client->helper_->close();
|
||||||
|
|
||||||
@@ -256,18 +221,9 @@ void APIServer::remove_client_(uint8_t client_index) {
|
|||||||
|
|
||||||
// Last client disconnected - set warning and start tracking for reboot timeout
|
// Last client disconnected - set warning and start tracking for reboot timeout
|
||||||
// (suppressed while provisioning is pending - see loop()).
|
// (suppressed while provisioning is pending - see loop()).
|
||||||
// Refresh on every authenticated removal, not just the last one, so an
|
|
||||||
// unauthenticated straggler removed later (e.g. a port scan, or a dial to
|
|
||||||
// a host that accepts TCP but never speaks the API) cannot discard a
|
|
||||||
// healthy session's timestamp and trigger a spurious reboot
|
|
||||||
if (was_authenticated) {
|
|
||||||
this->last_connected_ = App.get_loop_component_start_time();
|
|
||||||
this->saw_unauthenticated_client_ = false;
|
|
||||||
} else {
|
|
||||||
this->saw_unauthenticated_client_ = true;
|
|
||||||
}
|
|
||||||
if (this->api_connection_count_ == 0 && this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
if (this->api_connection_count_ == 0 && this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
||||||
this->status_set_warning(LOG_STR("waiting for client connection"));
|
this->status_set_warning(LOG_STR("waiting for client connection"));
|
||||||
|
this->last_connected_ = App.get_loop_component_start_time();
|
||||||
}
|
}
|
||||||
|
|
||||||
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
|
#ifdef USE_API_CLIENT_DISCONNECTED_TRIGGER
|
||||||
@@ -289,7 +245,7 @@ void __attribute__((flatten)) APIServer::accept_new_connections_() {
|
|||||||
sock->getpeername_to(peername);
|
sock->getpeername_to(peername);
|
||||||
|
|
||||||
// Check if we're at the connection limit
|
// Check if we're at the connection limit
|
||||||
if (this->at_client_limit_()) {
|
if (this->api_connection_count_ >= MAX_API_CONNECTIONS) {
|
||||||
ESP_LOGW(TAG, "Max connections (%d), rejecting %s", MAX_API_CONNECTIONS, peername);
|
ESP_LOGW(TAG, "Max connections (%d), rejecting %s", MAX_API_CONNECTIONS, peername);
|
||||||
// Immediately close - socket destructor will handle cleanup
|
// Immediately close - socket destructor will handle cleanup
|
||||||
sock.reset();
|
sock.reset();
|
||||||
@@ -298,54 +254,18 @@ void __attribute__((flatten)) APIServer::accept_new_connections_() {
|
|||||||
|
|
||||||
ESP_LOGD(TAG, "Accept %s", peername);
|
ESP_LOGD(TAG, "Accept %s", peername);
|
||||||
|
|
||||||
this->add_client_(new APIConnection(std::move(sock), this));
|
auto *conn = new APIConnection(std::move(sock), this);
|
||||||
|
this->clients_[this->api_connection_count_++].reset(conn);
|
||||||
|
conn->start();
|
||||||
|
|
||||||
|
// First client connected - clear warning and update timestamp
|
||||||
|
if (this->api_connection_count_ == 1 && this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
||||||
|
this->status_clear_warning();
|
||||||
|
this->last_connected_ = App.get_loop_component_start_time();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
bool APIServer::add_client_(APIConnection *conn) {
|
|
||||||
if (this->at_client_limit_()) {
|
|
||||||
// The accept path checks first to skip the allocation; the outgoing
|
|
||||||
// handoff relies on this check
|
|
||||||
ESP_LOGW(TAG, "Max connections (%d), dropping client", MAX_API_CONNECTIONS);
|
|
||||||
delete conn;
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
this->clients_[this->api_connection_count_++].reset(conn);
|
|
||||||
conn->start();
|
|
||||||
|
|
||||||
// First client connected - clear warning. The reboot watchdog timestamp is
|
|
||||||
// refreshed when an authenticated client is removed (see remove_client_),
|
|
||||||
// never on bare TCP connects.
|
|
||||||
if (this->api_connection_count_ == 1 && this->reboot_timeout_ != 0 && !this->provisioning_pending_()) {
|
|
||||||
this->status_clear_warning();
|
|
||||||
}
|
|
||||||
return true;
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
APIConnection *APIServer::add_outgoing_client_(std::unique_ptr<socket::Socket> sock) {
|
|
||||||
// Re-check at the handoff: the PSK may have been cleared since the dial
|
|
||||||
// started (mark_outgoing() needs the noise helper); add_client_ re-checks
|
|
||||||
// the slot limit
|
|
||||||
if (!this->noise_ctx_.has_psk()) {
|
|
||||||
ESP_LOGW(TAG, "Dropping outgoing connection (no key)");
|
|
||||||
return nullptr;
|
|
||||||
}
|
|
||||||
auto *conn = new APIConnection(std::move(sock), this);
|
|
||||||
if (!this->add_client_(conn)) {
|
|
||||||
return nullptr;
|
|
||||||
}
|
|
||||||
// After start(): sends our server hello first so the peer can pick the key
|
|
||||||
conn->mark_outgoing();
|
|
||||||
return conn;
|
|
||||||
}
|
|
||||||
|
|
||||||
void APIServer::on_outgoing_target_client(APIConnection *conn) {
|
|
||||||
this->outgoing_target_count_++;
|
|
||||||
this->outgoing_conn_.on_target_client(conn);
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
void APIServer::dump_config() {
|
void APIServer::dump_config() {
|
||||||
char addr_buf[network::USE_ADDRESS_BUFFER_SIZE];
|
char addr_buf[network::USE_ADDRESS_BUFFER_SIZE];
|
||||||
ESP_LOGCONFIG(TAG,
|
ESP_LOGCONFIG(TAG,
|
||||||
@@ -362,9 +282,6 @@ void APIServer::dump_config() {
|
|||||||
#else
|
#else
|
||||||
ESP_LOGCONFIG(TAG, " Noise encryption: NO");
|
ESP_LOGCONFIG(TAG, " Noise encryption: NO");
|
||||||
#endif
|
#endif
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
this->outgoing_conn_.dump_config();
|
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void APIServer::handle_disconnect(APIConnection *conn) {}
|
void APIServer::handle_disconnect(APIConnection *conn) {}
|
||||||
@@ -516,8 +433,9 @@ void APIServer::send_homeassistant_action(const HomeassistantActionRequest &call
|
|||||||
// Home Assistant subscribes to actions shortly *after* authenticating, so actions
|
// Home Assistant subscribes to actions shortly *after* authenticating, so actions
|
||||||
// fired right at connection time (on_client_connected, on_time_sync, ...) can
|
// fired right at connection time (on_client_connected, on_time_sync, ...) can
|
||||||
// arrive before the subscription and are lost - warn instead of failing silently.
|
// arrive before the subscription and are lost - warn instead of failing silently.
|
||||||
ESP_LOGW(TAG, "Home Assistant %s '%s' dropped; %s",
|
ESP_LOGW(TAG, "Home Assistant %s '%.*s' dropped; %s",
|
||||||
call.is_event ? LOG_STR_LITERAL("event") : LOG_STR_LITERAL("action"), call.service.c_str(),
|
call.is_event ? LOG_STR_LITERAL("event") : LOG_STR_LITERAL("action"),
|
||||||
|
static_cast<int>(call.service.size()), call.service.empty() ? "" : call.service.c_str(),
|
||||||
this->is_connected() ? LOG_STR_LITERAL("client has not subscribed to actions (yet)")
|
this->is_connected() ? LOG_STR_LITERAL("client has not subscribed to actions (yet)")
|
||||||
: LOG_STR_LITERAL("no client connected"));
|
: LOG_STR_LITERAL("no client connected"));
|
||||||
}
|
}
|
||||||
@@ -660,8 +578,6 @@ bool APIServer::update_noise_psk_(const SavedNoisePsk &new_psk, const LogString
|
|||||||
if (!c->send_message(req)) {
|
if (!c->send_message(req)) {
|
||||||
API_LOG_MSG_DROPPED(TAG, "Disconnect request");
|
API_LOG_MSG_DROPPED(TAG, "Disconnect request");
|
||||||
}
|
}
|
||||||
// Force it: a session from before the key was active must not survive
|
|
||||||
c->flags_.next_close = true;
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
@@ -763,9 +679,6 @@ void APIServer::on_shutdown() {
|
|||||||
|
|
||||||
// Close the listening socket to prevent new connections
|
// Close the listening socket to prevent new connections
|
||||||
this->destroy_socket_();
|
this->destroy_socket_();
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
this->outgoing_conn_.on_shutdown();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// Change batch delay to 5ms for quick flushing during shutdown
|
// Change batch delay to 5ms for quick flushing during shutdown
|
||||||
this->batch_delay_ = 5;
|
this->batch_delay_ = 5;
|
||||||
|
|||||||
@@ -11,7 +11,6 @@
|
|||||||
#endif
|
#endif
|
||||||
#include "api_pb2.h"
|
#include "api_pb2.h"
|
||||||
#include "api_pb2_service.h"
|
#include "api_pb2_service.h"
|
||||||
#include "api_outgoing_connection.h"
|
|
||||||
#include "esphome/components/socket/socket.h"
|
#include "esphome/components/socket/socket.h"
|
||||||
#include "esphome/core/automation.h"
|
#include "esphome/core/automation.h"
|
||||||
#include "esphome/core/component.h"
|
#include "esphome/core/component.h"
|
||||||
@@ -87,10 +86,6 @@ class APIServer final : public Component,
|
|||||||
void set_noise_psk(const uint8_t *psk) { this->noise_ctx_.set_psk(psk); }
|
void set_noise_psk(const uint8_t *psk) { this->noise_ctx_.set_psk(psk); }
|
||||||
noise::NoiseContext &get_noise_ctx() { return this->noise_ctx_; }
|
noise::NoiseContext &get_noise_ctx() { return this->noise_ctx_; }
|
||||||
#endif // USE_API_NOISE
|
#endif // USE_API_NOISE
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
// Called by APIConnection when a client declares itself a dial-back target in its hello
|
|
||||||
void on_outgoing_target_client(APIConnection *conn);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
void handle_disconnect(APIConnection *conn);
|
void handle_disconnect(APIConnection *conn);
|
||||||
#ifdef USE_BINARY_SENSOR
|
#ifdef USE_BINARY_SENSOR
|
||||||
@@ -268,16 +263,6 @@ class APIServer final : public Component,
|
|||||||
protected:
|
protected:
|
||||||
// Accept incoming socket connections. Only called when socket has pending connections.
|
// Accept incoming socket connections. Only called when socket has pending connections.
|
||||||
void __attribute__((noinline)) accept_new_connections_();
|
void __attribute__((noinline)) accept_new_connections_();
|
||||||
// Insert a constructed connection into the client slots and start it.
|
|
||||||
// Takes ownership; deletes the connection and returns false at the limit
|
|
||||||
bool add_client_(APIConnection *conn);
|
|
||||||
bool at_client_limit_() const { return this->api_connection_count_ >= MAX_API_CONNECTIONS; }
|
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
// Returns the new connection, or nullptr (socket dropped) when at the limit
|
|
||||||
APIConnection *add_outgoing_client_(std::unique_ptr<socket::Socket> sock);
|
|
||||||
bool has_outgoing_target_client_() const { return this->outgoing_target_count_ != 0; }
|
|
||||||
friend class OutgoingConnectionManager;
|
|
||||||
#endif
|
|
||||||
// Remove a disconnected client by index. Swaps with the last populated slot and resets it.
|
// Remove a disconnected client by index. Swaps with the last populated slot and resets it.
|
||||||
void __attribute__((noinline)) remove_client_(uint8_t client_index);
|
void __attribute__((noinline)) remove_client_(uint8_t client_index);
|
||||||
|
|
||||||
@@ -319,7 +304,6 @@ class APIServer final : public Component,
|
|||||||
this->socket_ = nullptr;
|
this->socket_ = nullptr;
|
||||||
}
|
}
|
||||||
void socket_failed_(const LogString *msg);
|
void socket_failed_(const LogString *msg);
|
||||||
bool create_listen_socket_();
|
|
||||||
// Pointers and pointer-like types first (4 bytes each)
|
// Pointers and pointer-like types first (4 bytes each)
|
||||||
socket::ListenSocket *socket_{nullptr};
|
socket::ListenSocket *socket_{nullptr};
|
||||||
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
|
#ifdef USE_API_CLIENT_CONNECTED_TRIGGER
|
||||||
@@ -372,16 +356,8 @@ class APIServer final : public Component,
|
|||||||
// Connection limits - these defaults will be overridden by config values
|
// Connection limits - these defaults will be overridden by config values
|
||||||
// from cv.SplitDefault in __init__.py which sets platform-specific defaults.
|
// from cv.SplitDefault in __init__.py which sets platform-specific defaults.
|
||||||
uint8_t listen_backlog_{4};
|
uint8_t listen_backlog_{4};
|
||||||
// Bit-packed so the two flags share one byte
|
bool shutting_down_ = false;
|
||||||
bool shutting_down_ : 1 = false;
|
|
||||||
// For the reboot log: whether any removal since the last watchdog refresh
|
|
||||||
// was an unauthenticated session (e.g. a wrong-key peer)
|
|
||||||
bool saw_unauthenticated_client_ : 1 = false;
|
|
||||||
uint8_t api_connection_count_{0};
|
uint8_t api_connection_count_{0};
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
// Connected clients whose hello declared them a dial-back target
|
|
||||||
uint8_t outgoing_target_count_{0};
|
|
||||||
#endif
|
|
||||||
#if defined(USE_PROVISIONING) && defined(USE_API_NOISE)
|
#if defined(USE_PROVISIONING) && defined(USE_API_NOISE)
|
||||||
// Index assigned by the provisioning manager for reporting this transport's state.
|
// Index assigned by the provisioning manager for reporting this transport's state.
|
||||||
uint8_t provisioning_source_{0};
|
uint8_t provisioning_source_{0};
|
||||||
@@ -394,9 +370,6 @@ class APIServer final : public Component,
|
|||||||
#endif
|
#endif
|
||||||
ESPPreferenceObject noise_pref_;
|
ESPPreferenceObject noise_pref_;
|
||||||
#endif // USE_API_NOISE
|
#endif // USE_API_NOISE
|
||||||
#ifdef USE_API_OUTGOING_CONNECTION
|
|
||||||
OutgoingConnectionManager outgoing_conn_;
|
|
||||||
#endif
|
|
||||||
};
|
};
|
||||||
|
|
||||||
extern APIServer *global_api_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
extern APIServer *global_api_server; // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
|
||||||
|
|||||||
@@ -210,77 +210,78 @@ void ProtoWriteBuffer::debug_check_encode_size_(uint32_t field_id, uint32_t expe
|
|||||||
|
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
void ProtoDecodableMessage::decode(const uint8_t *buffer, size_t length) {
|
void ProtoDecodableMessage::decode_fields(void *msg, const uint8_t *buffer, size_t length, DecodeFieldFn field) {
|
||||||
const uint8_t *ptr = buffer;
|
const uint8_t *ptr = buffer;
|
||||||
const uint8_t *end = buffer + length;
|
const uint8_t *end = buffer + length;
|
||||||
|
|
||||||
while (ptr < end) {
|
// Single-byte varints dominate, so that case advances the cursor inline.
|
||||||
// Parse field header - ptr < end guarantees len >= 1
|
auto read_varint = [&](proto_varint_value_t &value) ESPHOME_ALWAYS_INLINE {
|
||||||
|
if (ptr == end)
|
||||||
|
return false;
|
||||||
|
if (*ptr < 0x80) [[likely]] {
|
||||||
|
value = *ptr++;
|
||||||
|
return true;
|
||||||
|
}
|
||||||
auto res = ProtoVarInt::parse_non_empty(ptr, end - ptr);
|
auto res = ProtoVarInt::parse_non_empty(ptr, end - ptr);
|
||||||
if (!res.has_value()) {
|
if (!res.has_value())
|
||||||
|
return false;
|
||||||
|
value = res.value;
|
||||||
|
ptr += res.consumed;
|
||||||
|
return true;
|
||||||
|
};
|
||||||
|
|
||||||
|
while (ptr < end) {
|
||||||
|
proto_varint_value_t tag_value;
|
||||||
|
if (!read_varint(tag_value)) {
|
||||||
ESP_LOGV(TAG, "Invalid field start at offset %ld", (long) (ptr - buffer));
|
ESP_LOGV(TAG, "Invalid field start at offset %ld", (long) (ptr - buffer));
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
uint32_t tag = static_cast<uint32_t>(res.value);
|
uint32_t tag = static_cast<uint32_t>(tag_value);
|
||||||
uint32_t field_type = tag & WIRE_TYPE_MASK;
|
uint32_t field_type = tag & WIRE_TYPE_MASK;
|
||||||
uint32_t field_id = tag >> 3;
|
// Length-delimited fields move this past the length prefix
|
||||||
ptr += res.consumed;
|
const uint8_t *data = ptr;
|
||||||
|
proto_varint_value_t scalar;
|
||||||
|
|
||||||
switch (field_type) {
|
if (field_type == WIRE_TYPE_VARINT) [[likely]] {
|
||||||
case WIRE_TYPE_VARINT: { // VarInt
|
if (!read_varint(scalar)) {
|
||||||
res = ProtoVarInt::parse(ptr, end - ptr);
|
ESP_LOGV(TAG, "Invalid VarInt at offset %ld", (long) (ptr - buffer));
|
||||||
if (!res.has_value()) {
|
|
||||||
ESP_LOGV(TAG, "Invalid VarInt at offset %ld", (long) (ptr - buffer));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!this->decode_varint(field_id, res.value)) {
|
|
||||||
ESP_LOGV(TAG, "Cannot decode VarInt field %" PRIu32 " with value %" PRIu64 "!", field_id,
|
|
||||||
static_cast<uint64_t>(res.value));
|
|
||||||
}
|
|
||||||
ptr += res.consumed;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
case WIRE_TYPE_LENGTH_DELIMITED: { // Length-delimited
|
|
||||||
res = ProtoVarInt::parse(ptr, end - ptr);
|
|
||||||
if (!res.has_value()) {
|
|
||||||
ESP_LOGV(TAG, "Invalid Length Delimited at offset %ld", (long) (ptr - buffer));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
uint32_t field_length = static_cast<uint32_t>(res.value);
|
|
||||||
ptr += res.consumed;
|
|
||||||
if (field_length > static_cast<size_t>(end - ptr)) {
|
|
||||||
ESP_LOGV(TAG, "Out-of-bounds Length Delimited at offset %ld", (long) (ptr - buffer));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
if (!this->decode_length(field_id, ProtoLengthDelimited(ptr, field_length))) {
|
|
||||||
ESP_LOGV(TAG, "Cannot decode Length Delimited field %" PRIu32 "!", field_id);
|
|
||||||
}
|
|
||||||
ptr += field_length;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
case WIRE_TYPE_FIXED32: { // 32-bit
|
|
||||||
if (end - ptr < 4) {
|
|
||||||
ESP_LOGV(TAG, "Out-of-bounds Fixed32-bit at offset %ld", (long) (ptr - buffer));
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
uint32_t val;
|
|
||||||
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
|
|
||||||
// Protobuf fixed32 is little-endian — direct load on LE platforms
|
|
||||||
memcpy(&val, ptr, 4);
|
|
||||||
#else
|
|
||||||
val = encode_uint32(ptr[3], ptr[2], ptr[1], ptr[0]);
|
|
||||||
#endif
|
|
||||||
if (!this->decode_32bit(field_id, Proto32Bit(val))) {
|
|
||||||
ESP_LOGV(TAG, "Cannot decode 32-bit field %" PRIu32 " with value %" PRIu32 "!", field_id, val);
|
|
||||||
}
|
|
||||||
ptr += 4;
|
|
||||||
break;
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
ESP_LOGV(TAG, "Invalid field type %" PRIu32 " at offset %ld", field_type, (long) (ptr - buffer));
|
|
||||||
return;
|
return;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
switch (field_type) {
|
||||||
|
case WIRE_TYPE_LENGTH_DELIMITED: {
|
||||||
|
proto_varint_value_t length_value;
|
||||||
|
if (!read_varint(length_value)) {
|
||||||
|
ESP_LOGV(TAG, "Invalid Length Delimited at offset %ld", (long) (ptr - buffer));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
uint32_t field_length = static_cast<uint32_t>(length_value);
|
||||||
|
if (field_length > static_cast<size_t>(end - ptr)) {
|
||||||
|
ESP_LOGV(TAG, "Out-of-bounds Length Delimited at offset %ld", (long) (ptr - buffer));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
data = ptr;
|
||||||
|
scalar = field_length;
|
||||||
|
ptr += field_length;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
case WIRE_TYPE_FIXED32: {
|
||||||
|
if (end - ptr < 4) {
|
||||||
|
ESP_LOGV(TAG, "Out-of-bounds Fixed32-bit at offset %ld", (long) (ptr - buffer));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Byte loads instead of memcpy: ESP-IDF passes -fno-builtin-memcpy, which made this a call
|
||||||
|
scalar = encode_uint32(ptr[3], ptr[2], ptr[1], ptr[0]);
|
||||||
|
ptr += 4;
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
ESP_LOGV(TAG, "Invalid field type %" PRIu32 " at offset %ld", field_type, (long) (ptr - buffer));
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
field(msg, tag, data, scalar);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+240
-170
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
#include <cassert>
|
#include <cassert>
|
||||||
#include <cstring>
|
#include <cstring>
|
||||||
|
#include <type_traits>
|
||||||
#include <vector>
|
#include <vector>
|
||||||
|
|
||||||
#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
|
#ifdef ESPHOME_LOG_HAS_VERY_VERBOSE
|
||||||
@@ -170,40 +171,43 @@ class ProtoVarInt {
|
|||||||
class ProtoMessage;
|
class ProtoMessage;
|
||||||
class ProtoSize;
|
class ProtoSize;
|
||||||
|
|
||||||
class ProtoLengthDelimited {
|
/// Case label for decode_field(): the wire tag of a field, so a field that arrives with another wire
|
||||||
|
/// type matches no case.
|
||||||
|
constexpr uint32_t proto_tag(uint32_t field_id, uint32_t wire_type) { return (field_id << 3) | wire_type; }
|
||||||
|
|
||||||
|
/// One decoded field: the payload pointer and a scalar holding the varint or fixed32 value, or the
|
||||||
|
/// length of a length-delimited field. The wire type in the tag says which applies; accessors do not check.
|
||||||
|
class ProtoFieldValue {
|
||||||
public:
|
public:
|
||||||
explicit ProtoLengthDelimited(const uint8_t *value, size_t length) : value_(value), length_(length) {}
|
ProtoFieldValue(const uint8_t *data, proto_varint_value_t scalar) : data_(data), scalar_(scalar) {}
|
||||||
std::string as_string() const { return std::string(reinterpret_cast<const char *>(this->value_), this->length_); }
|
|
||||||
|
|
||||||
// Direct access to raw data without string allocation
|
proto_varint_value_t as_varint() const { return this->scalar_; }
|
||||||
const uint8_t *data() const { return this->value_; }
|
// A bool is sent as 0 or 1, so the low word is enough and saves a second compare with 64 bit varints
|
||||||
size_t size() const { return this->length_; }
|
bool as_bool() const { return static_cast<uint32_t>(this->scalar_) != 0; }
|
||||||
|
|
||||||
/// Decode the length-delimited data into a message instance.
|
// Length-delimited accessors
|
||||||
|
const uint8_t *data() const { return this->data_; }
|
||||||
|
size_t size() const { return static_cast<size_t>(this->scalar_); }
|
||||||
|
std::string as_string() const { return std::string(reinterpret_cast<const char *>(this->data_), this->size()); }
|
||||||
|
/// Decode the length-delimited payload into a message instance.
|
||||||
/// Template preserves concrete type so decode() resolves statically.
|
/// Template preserves concrete type so decode() resolves statically.
|
||||||
template<typename T> void decode_to_message(T &msg) const;
|
template<typename T> void decode_to_message(T &msg) const { msg.decode(this->data_, this->size()); }
|
||||||
|
|
||||||
protected:
|
// Fixed32 accessors
|
||||||
const uint8_t *const value_;
|
uint32_t as_fixed32() const { return static_cast<uint32_t>(this->scalar_); }
|
||||||
const size_t length_;
|
int32_t as_sfixed32() const { return static_cast<int32_t>(this->as_fixed32()); }
|
||||||
};
|
|
||||||
|
|
||||||
class Proto32Bit {
|
|
||||||
public:
|
|
||||||
explicit Proto32Bit(uint32_t value) : value_(value) {}
|
|
||||||
uint32_t as_fixed32() const { return this->value_; }
|
|
||||||
int32_t as_sfixed32() const { return static_cast<int32_t>(this->value_); }
|
|
||||||
float as_float() const {
|
float as_float() const {
|
||||||
union {
|
union {
|
||||||
uint32_t raw;
|
uint32_t raw;
|
||||||
float value;
|
float value;
|
||||||
} s{};
|
} s{};
|
||||||
s.raw = this->value_;
|
s.raw = this->as_fixed32();
|
||||||
return s.value;
|
return s.value;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected:
|
private:
|
||||||
const uint32_t value_;
|
const uint8_t *data_;
|
||||||
|
proto_varint_value_t scalar_;
|
||||||
};
|
};
|
||||||
|
|
||||||
// NOTE: Proto64Bit class removed - wire type 1 (64-bit fixed) not supported
|
// NOTE: Proto64Bit class removed - wire type 1 (64-bit fixed) not supported
|
||||||
@@ -252,7 +256,7 @@ class ProtoWriteBuffer {
|
|||||||
*
|
*
|
||||||
* Following https://protobuf.dev/programming-guides/encoding/#structure
|
* Following https://protobuf.dev/programming-guides/encoding/#structure
|
||||||
*/
|
*/
|
||||||
void encode_field_raw(uint32_t field_id, uint32_t type) { this->encode_varint_raw((field_id << 3) | type); }
|
void encode_field_raw(uint32_t field_id, uint32_t type) { this->encode_varint_raw(proto_tag(field_id, type)); }
|
||||||
/// Single-pass encode for repeated submessage elements.
|
/// Single-pass encode for repeated submessage elements.
|
||||||
/// Thin template wrapper; all buffer work is in the non-template core.
|
/// Thin template wrapper; all buffer work is in the non-template core.
|
||||||
template<typename T> void encode_sub_message(uint32_t field_id, const T &value);
|
template<typename T> void encode_sub_message(uint32_t field_id, const T &value);
|
||||||
@@ -287,19 +291,31 @@ class ProtoWriteBuffer {
|
|||||||
uint8_t *pos_;
|
uint8_t *pos_;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// A four byte unaligned store is a memcpy call on ESP-IDF (-fno-builtin-memcpy) and on ARM cores without
|
||||||
|
// unaligned access (Cortex-M0+, ARM9), so those targets share one outlined byte store helper per fixed32
|
||||||
|
// field. Elsewhere the write inlines to a single store, or on ESP8266 to a few stores that measured
|
||||||
|
// faster than a call, so it stays inline.
|
||||||
|
#if defined(USE_ESP32) || (defined(__arm__) && !defined(__ARM_FEATURE_UNALIGNED))
|
||||||
|
#define PROTO_OUTLINE_FOR_SIZE __attribute__((noinline))
|
||||||
|
#define PROTO_FIXED32_BYTE_STORES true
|
||||||
|
#else
|
||||||
|
#define PROTO_OUTLINE_FOR_SIZE inline
|
||||||
|
#define PROTO_FIXED32_BYTE_STORES false
|
||||||
|
#endif
|
||||||
|
|
||||||
// Varint encoding thresholds — used by both proto_encode_* free functions and ProtoSize.
|
// Varint encoding thresholds — used by both proto_encode_* free functions and ProtoSize.
|
||||||
constexpr uint32_t VARINT_MAX_1_BYTE = 1 << 7; // 128
|
constexpr uint32_t VARINT_MAX_1_BYTE = 1 << 7; // 128
|
||||||
constexpr uint32_t VARINT_MAX_2_BYTE = 1 << 14; // 16384
|
constexpr uint32_t VARINT_MAX_2_BYTE = 1 << 14; // 16384
|
||||||
|
|
||||||
/// Static encode helpers for generated encode() functions.
|
/// Static encode helpers for the generated encode bodies. Each takes the write cursor by value and
|
||||||
/// Generated code hoists buffer.pos_ into a local uint8_t *__restrict__ pos,
|
/// returns it advanced, so outlined calls at -Os chain through the return register instead of a
|
||||||
/// then calls these methods which take pos by reference. No struct, no overhead.
|
/// stack slot. Helpers without a _force suffix skip fields holding the proto3 default.
|
||||||
/// For sub-messages, pos is synced back to buffer before the call and reloaded after.
|
|
||||||
class ProtoEncode {
|
class ProtoEncode {
|
||||||
public:
|
public:
|
||||||
/// Write a multi-byte varint directly through a pos pointer.
|
/// Write a multi-byte varint directly through a pos pointer.
|
||||||
template<typename T>
|
template<typename T>
|
||||||
static inline void encode_varint_raw_loop(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, T value) {
|
[[nodiscard]] static inline uint8_t *encode_varint_raw_loop(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
T value) {
|
||||||
do {
|
do {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = static_cast<uint8_t>(value | 0x80);
|
*pos++ = static_cast<uint8_t>(value | 0x80);
|
||||||
@@ -307,48 +323,49 @@ class ProtoEncode {
|
|||||||
} while (value > 0x7F);
|
} while (value > 0x7F);
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = static_cast<uint8_t>(value);
|
*pos++ = static_cast<uint8_t>(value);
|
||||||
|
return pos;
|
||||||
}
|
}
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_varint_raw(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint32_t value) {
|
encode_varint_raw(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint32_t value) {
|
||||||
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = static_cast<uint8_t>(value);
|
*pos++ = static_cast<uint8_t>(value);
|
||||||
return;
|
return pos;
|
||||||
}
|
}
|
||||||
encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
return encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
}
|
}
|
||||||
/// Encode a varint that is expected to be 1-2 bytes (e.g. zigzag RSSI, small lengths).
|
/// Encode a varint that is expected to be 1-2 bytes (e.g. zigzag RSSI, small lengths).
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_varint_raw_short(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint32_t value) {
|
encode_varint_raw_short(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint32_t value) {
|
||||||
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = static_cast<uint8_t>(value);
|
*pos++ = static_cast<uint8_t>(value);
|
||||||
return;
|
return pos;
|
||||||
}
|
}
|
||||||
if (value < VARINT_MAX_2_BYTE) [[likely]] {
|
if (value < VARINT_MAX_2_BYTE) [[likely]] {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 2);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 2);
|
||||||
*pos++ = static_cast<uint8_t>(value | 0x80);
|
*pos++ = static_cast<uint8_t>(value | 0x80);
|
||||||
*pos++ = static_cast<uint8_t>(value >> 7);
|
*pos++ = static_cast<uint8_t>(value >> 7);
|
||||||
return;
|
return pos;
|
||||||
}
|
}
|
||||||
encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
return encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
}
|
}
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_varint_raw_64(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint64_t value) {
|
encode_varint_raw_64(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint64_t value) {
|
||||||
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
if (value < VARINT_MAX_1_BYTE) [[likely]] {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = static_cast<uint8_t>(value);
|
*pos++ = static_cast<uint8_t>(value);
|
||||||
return;
|
return pos;
|
||||||
}
|
}
|
||||||
encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
return encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
}
|
}
|
||||||
/// Encode a 48-bit MAC address (stored in a uint64) as varint.
|
/// Encode a 48-bit MAC address (stored in a uint64) as varint.
|
||||||
/// Real MAC addresses occupy the full 48 bits (OUI in upper 24), so the
|
/// Real MAC addresses occupy the full 48 bits (OUI in upper 24), so the
|
||||||
/// fast path -- any non-zero bit in the top 6 of 48 -- emits exactly 7 bytes
|
/// fast path -- any non-zero bit in the top 6 of 48 -- emits exactly 7 bytes
|
||||||
/// with no per-byte branch. Falls back to the general loop otherwise.
|
/// with no per-byte branch. Falls back to the general loop otherwise.
|
||||||
/// Caller must guarantee value fits in 48 bits (checked in debug builds).
|
/// Caller must guarantee value fits in 48 bits (checked in debug builds).
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_varint_raw_48bit(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint64_t value) {
|
encode_varint_raw_48bit(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint64_t value) {
|
||||||
#ifdef ESPHOME_DEBUG_API
|
#ifdef ESPHOME_DEBUG_API
|
||||||
assert(value < (1ULL << (MAC_ADDRESS_SIZE * 8)) && "encode_varint_raw_48bit: value exceeds 48 bits");
|
assert(value < (1ULL << (MAC_ADDRESS_SIZE * 8)) && "encode_varint_raw_48bit: value exceeds 48 bits");
|
||||||
#endif
|
#endif
|
||||||
@@ -363,38 +380,39 @@ class ProtoEncode {
|
|||||||
pos[4] = static_cast<uint8_t>((value >> 28) | 0x80);
|
pos[4] = static_cast<uint8_t>((value >> 28) | 0x80);
|
||||||
pos[5] = static_cast<uint8_t>((value >> 35) | 0x80);
|
pos[5] = static_cast<uint8_t>((value >> 35) | 0x80);
|
||||||
pos[6] = static_cast<uint8_t>(value >> 42);
|
pos[6] = static_cast<uint8_t>(value >> 42);
|
||||||
pos += 7;
|
return pos + 7;
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
encode_varint_raw_64(pos PROTO_ENCODE_DEBUG_ARG, value);
|
return encode_varint_raw_64(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
}
|
}
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_field_raw(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint32_t field_id, uint32_t type) {
|
encode_field_raw(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, uint32_t type) {
|
||||||
encode_varint_raw(pos PROTO_ENCODE_DEBUG_ARG, (field_id << 3) | type);
|
return encode_varint_raw(pos PROTO_ENCODE_DEBUG_ARG, proto_tag(field_id, type));
|
||||||
}
|
}
|
||||||
/// Write a single precomputed tag byte. Tag must be < 128.
|
/// Write a single precomputed tag byte. Tag must be < 128.
|
||||||
static inline void ESPHOME_ALWAYS_INLINE write_raw_byte(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
uint8_t b) {
|
write_raw_byte(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint8_t b) {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = b;
|
*pos++ = b;
|
||||||
|
return pos;
|
||||||
}
|
}
|
||||||
/// Reserve one byte for later backpatch (e.g., sub-message length).
|
/// Reserve one byte for later backpatch (e.g., sub-message length).
|
||||||
/// Advances pos past the reserved byte without writing a value.
|
/// Advances pos past the reserved byte without writing a value.
|
||||||
static inline void ESPHOME_ALWAYS_INLINE reserve_byte(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM) {
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
|
reserve_byte(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM) {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
pos++;
|
return pos + 1;
|
||||||
}
|
}
|
||||||
/// Write raw bytes to the buffer (no tag, no length prefix).
|
/// Write raw bytes to the buffer (no tag, no length prefix).
|
||||||
static inline void ESPHOME_ALWAYS_INLINE encode_raw(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *ESPHOME_ALWAYS_INLINE
|
||||||
const void *data, size_t len) {
|
encode_raw(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, const void *data, size_t len) {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, len);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, len);
|
||||||
std::memcpy(pos, data, len);
|
std::memcpy(pos, data, len);
|
||||||
pos += len;
|
return pos + len;
|
||||||
}
|
}
|
||||||
/// Encode tag + 1-byte length + raw string data. For strings with max_data_length < 128.
|
/// Encode tag + 1-byte length + raw string data. For strings with max_data_length < 128.
|
||||||
/// Tag must be a single-byte varint (< 128). Always encodes (no zero check).
|
/// Tag must be a single-byte varint (< 128). Always encodes (no zero check).
|
||||||
static inline void encode_short_string_force(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint8_t tag,
|
[[nodiscard]] static inline uint8_t *encode_short_string_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
const StringRef &ref) {
|
uint8_t tag, const StringRef &ref) {
|
||||||
#ifdef ESPHOME_DEBUG_API
|
#ifdef ESPHOME_DEBUG_API
|
||||||
assert(ref.size() < 128 && "encode_short_string_force: string exceeds max_data_length < 128");
|
assert(ref.size() < 128 && "encode_short_string_force: string exceeds max_data_length < 128");
|
||||||
#endif
|
#endif
|
||||||
@@ -402,137 +420,191 @@ class ProtoEncode {
|
|||||||
pos[0] = tag;
|
pos[0] = tag;
|
||||||
pos[1] = static_cast<uint8_t>(ref.size());
|
pos[1] = static_cast<uint8_t>(ref.size());
|
||||||
std::memcpy(pos + 2, ref.c_str(), ref.size());
|
std::memcpy(pos + 2, ref.c_str(), ref.size());
|
||||||
pos += 2 + ref.size();
|
return pos + 2 + ref.size();
|
||||||
}
|
}
|
||||||
/// Write a precomputed tag byte + 32-bit value in one operation.
|
/// Write a precomputed tag byte + 32-bit value. Outlined on embedded: one copy beats inline stores per field.
|
||||||
static inline void ESPHOME_ALWAYS_INLINE write_tag_and_fixed32(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static PROTO_OUTLINE_FOR_SIZE uint8_t *write_tag_and_fixed32(
|
||||||
uint8_t tag, uint32_t value) {
|
uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint8_t tag, uint32_t value) {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 5);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 5);
|
||||||
pos[0] = tag;
|
pos[0] = tag;
|
||||||
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
|
write_fixed32_le(pos + 1, value);
|
||||||
std::memcpy(pos + 1, &value, 4);
|
return pos + 5;
|
||||||
#else
|
|
||||||
pos[1] = static_cast<uint8_t>(value & 0xFF);
|
|
||||||
pos[2] = static_cast<uint8_t>((value >> 8) & 0xFF);
|
|
||||||
pos[3] = static_cast<uint8_t>((value >> 16) & 0xFF);
|
|
||||||
pos[4] = static_cast<uint8_t>((value >> 24) & 0xFF);
|
|
||||||
#endif
|
|
||||||
pos += 5;
|
|
||||||
}
|
}
|
||||||
static inline void encode_string(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_string_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
const char *string, size_t len, bool force = false) {
|
uint32_t field_id, const char *string, size_t len) {
|
||||||
if (len == 0 && !force)
|
pos = encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 2); // type 2: Length-delimited string
|
||||||
return;
|
|
||||||
encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 2); // type 2: Length-delimited string
|
|
||||||
// NOLINTNEXTLINE(readability-inconsistent-ifelse-braces) -- false positive on [[likely]] attribute
|
// NOLINTNEXTLINE(readability-inconsistent-ifelse-braces) -- false positive on [[likely]] attribute
|
||||||
if (len < VARINT_MAX_1_BYTE) [[likely]] {
|
if (len < VARINT_MAX_1_BYTE) [[likely]] {
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1 + len);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1 + len);
|
||||||
*pos++ = static_cast<uint8_t>(len);
|
*pos++ = static_cast<uint8_t>(len);
|
||||||
} else {
|
} else {
|
||||||
encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, len);
|
pos = encode_varint_raw_loop(pos PROTO_ENCODE_DEBUG_ARG, len);
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, len);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, len);
|
||||||
}
|
}
|
||||||
std::memcpy(pos, string, len);
|
std::memcpy(pos, string, len);
|
||||||
pos += len;
|
return pos + len;
|
||||||
}
|
}
|
||||||
static inline void encode_string(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_string(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
const std::string &value, bool force = false) {
|
uint32_t field_id, const char *string, size_t len) {
|
||||||
encode_string(pos PROTO_ENCODE_DEBUG_ARG, field_id, value.data(), value.size(), force);
|
if (len == 0)
|
||||||
|
return pos;
|
||||||
|
return encode_string_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, string, len);
|
||||||
}
|
}
|
||||||
static inline void encode_string(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_string_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
const StringRef &ref, bool force = false) {
|
uint32_t field_id, const std::string &value) {
|
||||||
encode_string(pos PROTO_ENCODE_DEBUG_ARG, field_id, ref.c_str(), ref.size(), force);
|
return encode_string_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value.data(), value.size());
|
||||||
}
|
}
|
||||||
static inline void encode_bytes(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_string(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
const uint8_t *data, size_t len, bool force = false) {
|
uint32_t field_id, const StringRef &ref) {
|
||||||
encode_string(pos PROTO_ENCODE_DEBUG_ARG, field_id, reinterpret_cast<const char *>(data), len, force);
|
return encode_string(pos PROTO_ENCODE_DEBUG_ARG, field_id, ref.c_str(), ref.size());
|
||||||
}
|
}
|
||||||
static inline void encode_uint32(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_string_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
uint32_t value, bool force = false) {
|
uint32_t field_id, const StringRef &ref) {
|
||||||
if (value == 0 && !force)
|
return encode_string_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, ref.c_str(), ref.size());
|
||||||
return;
|
|
||||||
encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
|
||||||
encode_varint_raw(pos PROTO_ENCODE_DEBUG_ARG, value);
|
|
||||||
}
|
}
|
||||||
static inline void encode_uint64(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_bytes(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
uint64_t value, bool force = false) {
|
uint32_t field_id, const uint8_t *data, size_t len) {
|
||||||
if (value == 0 && !force)
|
return encode_string(pos PROTO_ENCODE_DEBUG_ARG, field_id, reinterpret_cast<const char *>(data), len);
|
||||||
return;
|
|
||||||
encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
|
||||||
encode_varint_raw_64(pos PROTO_ENCODE_DEBUG_ARG, value);
|
|
||||||
}
|
}
|
||||||
static inline void encode_bool(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, bool value,
|
[[nodiscard]] static inline uint8_t *encode_bytes_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
bool force = false) {
|
uint32_t field_id, const uint8_t *data, size_t len) {
|
||||||
if (!value && !force)
|
return encode_string_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, reinterpret_cast<const char *>(data), len);
|
||||||
return;
|
}
|
||||||
encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
[[nodiscard]] static inline uint8_t *encode_uint32_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, uint32_t value) {
|
||||||
|
pos = encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
||||||
|
return encode_varint_raw(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_uint32(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, uint32_t value) {
|
||||||
|
if (value == 0)
|
||||||
|
return pos;
|
||||||
|
return encode_uint32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value);
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_uint64_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, uint64_t value) {
|
||||||
|
pos = encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
||||||
|
return encode_varint_raw_64(pos PROTO_ENCODE_DEBUG_ARG, value);
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_uint64(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, uint64_t value) {
|
||||||
|
if (value == 0)
|
||||||
|
return pos;
|
||||||
|
return encode_uint64_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value);
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_bool_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, bool value) {
|
||||||
|
pos = encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 0);
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 1);
|
||||||
*pos++ = value ? 0x01 : 0x00;
|
*pos++ = value ? 0x01 : 0x00;
|
||||||
|
return pos;
|
||||||
}
|
}
|
||||||
static inline void encode_fixed32(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_bool(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
uint32_t value, bool force = false) {
|
uint32_t field_id, bool value) {
|
||||||
if (value == 0 && !force)
|
if (!value)
|
||||||
return;
|
return pos;
|
||||||
encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 5);
|
return encode_bool_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value);
|
||||||
|
}
|
||||||
|
/// Tag + fixed32 for multi-byte tags; single-byte tags use write_tag_and_fixed32.
|
||||||
|
[[nodiscard]] static PROTO_OUTLINE_FOR_SIZE uint8_t *encode_fixed32_force(
|
||||||
|
uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, uint32_t value) {
|
||||||
|
pos = encode_field_raw(pos PROTO_ENCODE_DEBUG_ARG, field_id, 5);
|
||||||
PROTO_ENCODE_CHECK_BOUNDS(pos, 4);
|
PROTO_ENCODE_CHECK_BOUNDS(pos, 4);
|
||||||
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__
|
write_fixed32_le(pos, value);
|
||||||
std::memcpy(pos, &value, 4);
|
return pos + 4;
|
||||||
pos += 4;
|
}
|
||||||
#else
|
[[nodiscard]] static inline uint8_t *encode_fixed32(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
*pos++ = (value >> 0) & 0xFF;
|
uint32_t field_id, uint32_t value) {
|
||||||
*pos++ = (value >> 8) & 0xFF;
|
if (value == 0)
|
||||||
*pos++ = (value >> 16) & 0xFF;
|
return pos;
|
||||||
*pos++ = (value >> 24) & 0xFF;
|
return encode_fixed32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value);
|
||||||
#endif
|
|
||||||
}
|
}
|
||||||
// NOTE: Wire type 1 (64-bit fixed: double, fixed64, sfixed64) is intentionally
|
// NOTE: Wire type 1 (64-bit fixed: double, fixed64, sfixed64) is intentionally
|
||||||
// not supported to reduce overhead on embedded systems. All ESPHome devices are
|
// not supported to reduce overhead on embedded systems. All ESPHome devices are
|
||||||
// 32-bit microcontrollers where 64-bit operations are expensive. If 64-bit support
|
// 32-bit microcontrollers where 64-bit operations are expensive. If 64-bit support
|
||||||
// is needed in the future, the necessary encoding/decoding functions must be added.
|
// is needed in the future, the necessary encoding/decoding functions must be added.
|
||||||
static inline void encode_float(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, float value,
|
[[nodiscard]] static inline uint8_t *encode_float(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
bool force = false) {
|
uint32_t field_id, float value) {
|
||||||
uint32_t raw = float_to_raw(value);
|
return encode_fixed32(pos PROTO_ENCODE_DEBUG_ARG, field_id, float_to_raw(value));
|
||||||
if (raw == 0 && !force)
|
|
||||||
return;
|
|
||||||
encode_fixed32(pos PROTO_ENCODE_DEBUG_ARG, field_id, raw);
|
|
||||||
}
|
}
|
||||||
static inline void encode_int32(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, int32_t value,
|
[[nodiscard]] static inline uint8_t *encode_float_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
bool force = false) {
|
uint32_t field_id, float value) {
|
||||||
|
return encode_fixed32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, float_to_raw(value));
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_int32_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, int32_t value) {
|
||||||
if (value < 0) {
|
if (value < 0) {
|
||||||
// negative int32 is always 10 byte long
|
// negative int32 is always 10 byte long
|
||||||
encode_uint64(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint64_t>(value), force);
|
return encode_uint64_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint64_t>(value));
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
encode_uint32(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint32_t>(value), force);
|
return encode_uint32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint32_t>(value));
|
||||||
}
|
}
|
||||||
static inline void encode_int64(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id, int64_t value,
|
[[nodiscard]] static inline uint8_t *encode_int32(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
bool force = false) {
|
uint32_t field_id, int32_t value) {
|
||||||
encode_uint64(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint64_t>(value), force);
|
if (value == 0)
|
||||||
|
return pos;
|
||||||
|
return encode_int32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, value);
|
||||||
}
|
}
|
||||||
static inline void encode_sint32(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_int64(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
int32_t value, bool force = false) {
|
uint32_t field_id, int64_t value) {
|
||||||
encode_uint32(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag32(value), force);
|
return encode_uint64(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint64_t>(value));
|
||||||
}
|
}
|
||||||
static inline void encode_sint64(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, uint32_t field_id,
|
[[nodiscard]] static inline uint8_t *encode_int64_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
int64_t value, bool force = false) {
|
uint32_t field_id, int64_t value) {
|
||||||
encode_uint64(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag64(value), force);
|
return encode_uint64_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, static_cast<uint64_t>(value));
|
||||||
}
|
}
|
||||||
/// Sub-message encoding: sync pos to buffer, delegate, get pos from return value.
|
[[nodiscard]] static inline uint8_t *encode_sint32(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, int32_t value) {
|
||||||
|
return encode_uint32(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag32(value));
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_sint32_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, int32_t value) {
|
||||||
|
return encode_uint32_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag32(value));
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_sint64(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, int64_t value) {
|
||||||
|
return encode_uint64(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag64(value));
|
||||||
|
}
|
||||||
|
[[nodiscard]] static inline uint8_t *encode_sint64_force(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
|
uint32_t field_id, int64_t value) {
|
||||||
|
return encode_uint64_force(pos PROTO_ENCODE_DEBUG_ARG, field_id, encode_zigzag64(value));
|
||||||
|
}
|
||||||
|
/// Sub-message encoding: sync pos to buffer, delegate, read the cursor back.
|
||||||
template<typename T>
|
template<typename T>
|
||||||
static inline void encode_sub_message(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM, ProtoWriteBuffer &buffer,
|
[[nodiscard]] static inline uint8_t *encode_sub_message(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
uint32_t field_id, const T &value) {
|
ProtoWriteBuffer &buffer, uint32_t field_id, const T &value) {
|
||||||
buffer.set_pos(pos);
|
buffer.set_pos(pos);
|
||||||
buffer.encode_sub_message(field_id, value);
|
buffer.encode_sub_message(field_id, value);
|
||||||
pos = buffer.get_pos();
|
return buffer.get_pos();
|
||||||
}
|
}
|
||||||
template<typename T>
|
template<typename T>
|
||||||
static inline void encode_optional_sub_message(uint8_t *__restrict__ &pos PROTO_ENCODE_DEBUG_PARAM,
|
[[nodiscard]] static inline uint8_t *encode_optional_sub_message(uint8_t *__restrict__ pos PROTO_ENCODE_DEBUG_PARAM,
|
||||||
ProtoWriteBuffer &buffer, uint32_t field_id, const T &value) {
|
ProtoWriteBuffer &buffer, uint32_t field_id,
|
||||||
|
const T &value) {
|
||||||
buffer.set_pos(pos);
|
buffer.set_pos(pos);
|
||||||
buffer.encode_optional_sub_message(field_id, value);
|
buffer.encode_optional_sub_message(field_id, value);
|
||||||
pos = buffer.get_pos();
|
return buffer.get_pos();
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
/// Unaligned little endian store of four bytes: byte stores where the outlined helper lives (ESP-IDF, ARM
|
||||||
|
/// without unaligned access), otherwise a memcpy the compiler folds into one store. Callers bounds check
|
||||||
|
/// and advance the cursor themselves.
|
||||||
|
static inline void ESPHOME_ALWAYS_INLINE write_fixed32_le(uint8_t *__restrict__ pos, uint32_t value) {
|
||||||
|
if constexpr (PROTO_FIXED32_BYTE_STORES) {
|
||||||
|
// Spelled out so the outlined helper does not itself become a memcpy call
|
||||||
|
pos[0] = static_cast<uint8_t>(value);
|
||||||
|
pos[1] = static_cast<uint8_t>(value >> 8);
|
||||||
|
pos[2] = static_cast<uint8_t>(value >> 16);
|
||||||
|
pos[3] = static_cast<uint8_t>(value >> 24);
|
||||||
|
} else {
|
||||||
|
const uint32_t le = convert_little_endian(value);
|
||||||
|
__builtin_memcpy(pos, &le, 4);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
#undef PROTO_OUTLINE_FOR_SIZE
|
||||||
|
#undef PROTO_FIXED32_BYTE_STORES
|
||||||
|
|
||||||
#ifdef HAS_PROTO_MESSAGE_DUMP
|
#ifdef HAS_PROTO_MESSAGE_DUMP
|
||||||
/**
|
/**
|
||||||
@@ -624,11 +696,12 @@ class DumpBuffer {
|
|||||||
|
|
||||||
class ProtoMessage {
|
class ProtoMessage {
|
||||||
public:
|
public:
|
||||||
// Non-virtual defaults for messages with no fields.
|
// Non-virtual defaults for messages with no fields; generated classes hide all four. The
|
||||||
// Concrete message classes hide these with their own implementations.
|
// static encode_msg/calc_size_msg take const void * so &T::encode_msg needs no thunk.
|
||||||
// All call sites use templates to preserve the concrete type, so virtual
|
static uint8_t *encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) {
|
||||||
// dispatch is not needed. This eliminates per-message vtable entries for
|
return buffer.get_pos();
|
||||||
// encode/calculate_size, saving ~1.3 KB of flash across all message types.
|
}
|
||||||
|
static uint32_t calc_size_msg(const void *self) { return 0; }
|
||||||
uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const { return buffer.get_pos(); }
|
uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const { return buffer.get_pos(); }
|
||||||
uint32_t calculate_size() const { return 0; }
|
uint32_t calculate_size() const { return 0; }
|
||||||
#ifdef HAS_PROTO_MESSAGE_DUMP
|
#ifdef HAS_PROTO_MESSAGE_DUMP
|
||||||
@@ -648,7 +721,13 @@ class ProtoMessage {
|
|||||||
// Base class for messages that support decoding
|
// Base class for messages that support decoding
|
||||||
class ProtoDecodableMessage : public ProtoMessage {
|
class ProtoDecodableMessage : public ProtoMessage {
|
||||||
public:
|
public:
|
||||||
void decode(const uint8_t *buffer, size_t length);
|
/// Stores one decoded field into \p msg; generated per message type. \p scalar is the varint or
|
||||||
|
/// fixed32 value, or the length of the length-delimited payload at \p data. An unknown field or
|
||||||
|
/// wrong wire type matches no case and is skipped.
|
||||||
|
using DecodeFieldFn = void (*)(void *msg, uint32_t tag, const uint8_t *data, proto_varint_value_t scalar);
|
||||||
|
/// Walk \p buffer and hand every field to \p field. The generated decode() passes the message's
|
||||||
|
/// own decode_field, so decodable messages carry no vtable.
|
||||||
|
static void decode_fields(void *msg, const uint8_t *buffer, size_t length, DecodeFieldFn field);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Count occurrences of a repeated field in a protobuf buffer.
|
* Count occurrences of a repeated field in a protobuf buffer.
|
||||||
@@ -660,14 +739,15 @@ class ProtoDecodableMessage : public ProtoMessage {
|
|||||||
* @return Number of times the field appears in the buffer
|
* @return Number of times the field appears in the buffer
|
||||||
*/
|
*/
|
||||||
static uint32_t count_repeated_field(const uint8_t *buffer, size_t length, uint32_t target_field_id);
|
static uint32_t count_repeated_field(const uint8_t *buffer, size_t length, uint32_t target_field_id);
|
||||||
|
// The destructor stays accessible on purpose: the generated messages are aggregates that brace
|
||||||
protected:
|
// initialise sub message members, which copies a base temporary. That trades away the compile time
|
||||||
~ProtoDecodableMessage() = default;
|
// guard against deleting through this type; messages are stack locals and never owned through a base
|
||||||
virtual bool decode_varint(uint32_t field_id, proto_varint_value_t value) { return false; }
|
// pointer. ProtoMessage keeps its guard for the dump builds.
|
||||||
virtual bool decode_length(uint32_t field_id, ProtoLengthDelimited value) { return false; }
|
|
||||||
virtual bool decode_32bit(uint32_t field_id, Proto32Bit value) { return false; }
|
|
||||||
// NOTE: decode_64bit removed - wire type 1 not supported
|
|
||||||
};
|
};
|
||||||
|
#ifndef HAS_PROTO_MESSAGE_DUMP
|
||||||
|
// decode() passes decode_field explicitly, so nothing here may add a vtable
|
||||||
|
static_assert(!std::is_polymorphic_v<ProtoDecodableMessage>, "decodable messages carry no vtable");
|
||||||
|
#endif
|
||||||
|
|
||||||
class ProtoSize {
|
class ProtoSize {
|
||||||
public:
|
public:
|
||||||
@@ -792,7 +872,7 @@ class ProtoSize {
|
|||||||
* @return The number of bytes needed to encode the field ID and wire type
|
* @return The number of bytes needed to encode the field ID and wire type
|
||||||
*/
|
*/
|
||||||
static constexpr uint32_t field(uint32_t field_id, uint32_t type) {
|
static constexpr uint32_t field(uint32_t field_id, uint32_t type) {
|
||||||
uint32_t tag = (field_id << 3) | (type & WIRE_TYPE_MASK);
|
uint32_t tag = proto_tag(field_id, type & WIRE_TYPE_MASK);
|
||||||
return varint(tag);
|
return varint(tag);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -876,24 +956,14 @@ class ProtoSize {
|
|||||||
|
|
||||||
// Implementation of methods that depend on ProtoSize being fully defined
|
// Implementation of methods that depend on ProtoSize being fully defined
|
||||||
|
|
||||||
// Encode thunk — converts void* back to concrete type for direct encode() call
|
|
||||||
template<typename T> uint8_t *proto_encode_msg(const void *msg, ProtoWriteBuffer &buf PROTO_ENCODE_DEBUG_PARAM) {
|
|
||||||
return static_cast<const T *>(msg)->encode(buf PROTO_ENCODE_DEBUG_ARG);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Thin template wrapper; delegates to non-template core in proto.cpp.
|
// Thin template wrapper; delegates to non-template core in proto.cpp.
|
||||||
template<typename T> inline void ProtoWriteBuffer::encode_sub_message(uint32_t field_id, const T &value) {
|
template<typename T> inline void ProtoWriteBuffer::encode_sub_message(uint32_t field_id, const T &value) {
|
||||||
this->encode_sub_message(field_id, &value, &proto_encode_msg<T>);
|
this->encode_sub_message(field_id, &value, &T::encode_msg);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Thin template wrapper; delegates to non-template core.
|
// Thin template wrapper; delegates to non-template core.
|
||||||
template<typename T> inline void ProtoWriteBuffer::encode_optional_sub_message(uint32_t field_id, const T &value) {
|
template<typename T> inline void ProtoWriteBuffer::encode_optional_sub_message(uint32_t field_id, const T &value) {
|
||||||
this->encode_optional_sub_message(field_id, value.calculate_size(), &value, &proto_encode_msg<T>);
|
this->encode_optional_sub_message(field_id, T::calc_size_msg(&value), &value, &T::encode_msg);
|
||||||
}
|
|
||||||
|
|
||||||
// Template decode_to_message - preserves concrete type so decode() resolves statically
|
|
||||||
template<typename T> void ProtoLengthDelimited::decode_to_message(T &msg) const {
|
|
||||||
msg.decode(this->value_, this->length_);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
template<typename T> const char *proto_enum_to_string(T value);
|
template<typename T> const char *proto_enum_to_string(T value);
|
||||||
|
|||||||
@@ -42,16 +42,7 @@ bool AsyncClient::connect(const char *host, uint16_t port) {
|
|||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (socket_->setblocking(false) != 0) {
|
socket_->setblocking(false);
|
||||||
// Capture before the log and reset() below can clobber errno; a blocking
|
|
||||||
// connect()/read() would otherwise stall the whole loop
|
|
||||||
const int saved_errno = errno;
|
|
||||||
ESP_LOGE(TAG, "Failed to set nonblocking: errno %d", saved_errno);
|
|
||||||
socket_.reset();
|
|
||||||
if (error_cb_)
|
|
||||||
error_cb_(error_arg_, this, saved_errno);
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
int err = socket_->connect((struct sockaddr *) &addr, addrlen);
|
int err = socket_->connect((struct sockaddr *) &addr, addrlen);
|
||||||
if (err == 0) {
|
if (err == 0) {
|
||||||
@@ -106,22 +97,45 @@ void AsyncClient::loop() {
|
|||||||
return;
|
return;
|
||||||
|
|
||||||
if (connecting_) {
|
if (connecting_) {
|
||||||
int err = 0;
|
// For connecting, we need to check writability, not readability
|
||||||
switch (socket::poll_connect(*socket_, err)) {
|
// The Application's select() only monitors read FDs, so we do our own check here
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_PENDING:
|
// For ESP platforms lwip_select() might be faster, but this code isn't used
|
||||||
break;
|
// on those platforms anyway. If it was, we'd fix the Application select()
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_CONNECTED:
|
// to report writability instead of doing it this way.
|
||||||
|
int fd = socket_->get_fd();
|
||||||
|
if (fd < 0) {
|
||||||
|
ESP_LOGW(TAG, "Invalid socket fd");
|
||||||
|
close();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
fd_set writefds;
|
||||||
|
FD_ZERO(&writefds);
|
||||||
|
FD_SET(fd, &writefds);
|
||||||
|
|
||||||
|
struct timeval tv = {0, 0};
|
||||||
|
int ret = select(fd + 1, nullptr, &writefds, nullptr, &tv);
|
||||||
|
|
||||||
|
if (ret > 0 && FD_ISSET(fd, &writefds)) {
|
||||||
|
int error = 0;
|
||||||
|
socklen_t len = sizeof(error);
|
||||||
|
if (socket_->getsockopt(SOL_SOCKET, SO_ERROR, &error, &len) == 0 && error == 0) {
|
||||||
connecting_ = false;
|
connecting_ = false;
|
||||||
connected_ = true;
|
connected_ = true;
|
||||||
if (connect_cb_)
|
if (connect_cb_)
|
||||||
connect_cb_(connect_arg_, this);
|
connect_cb_(connect_arg_, this);
|
||||||
break;
|
} else {
|
||||||
case socket::ConnectPollResult::CONNECT_POLL_ERROR:
|
ESP_LOGW(TAG, "Connection failed: %d", error);
|
||||||
ESP_LOGW(TAG, "Connection failed: %d", err);
|
|
||||||
close();
|
close();
|
||||||
if (error_cb_)
|
if (error_cb_)
|
||||||
error_cb_(error_arg_, this, err);
|
error_cb_(error_arg_, this, error);
|
||||||
break;
|
}
|
||||||
|
} else if (ret < 0) {
|
||||||
|
const int err = errno;
|
||||||
|
ESP_LOGE(TAG, "Select error: %d", err);
|
||||||
|
close();
|
||||||
|
if (error_cb_)
|
||||||
|
error_cb_(error_arg_, this, err);
|
||||||
}
|
}
|
||||||
} else if (connected_) {
|
} else if (connected_) {
|
||||||
// For connected sockets, use the Application's select() results
|
// For connected sockets, use the Application's select() results
|
||||||
|
|||||||
@@ -9,10 +9,6 @@ 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);
|
||||||
@@ -207,12 +203,13 @@ 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<OffsetCalibration[3]>(po_hash, true);
|
this->power_offset_pref_ = global_preferences->make_preference<PowerOffsetCalibration[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 = global_preferences->make_preference<OffsetCalibration[3]>(legacy_po_hash, true);
|
auto legacy_power_offset_pref =
|
||||||
OffsetCalibration power_offset_data[3]{};
|
global_preferences->make_preference<PowerOffsetCalibration[3]>(legacy_po_hash, true);
|
||||||
|
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;
|
||||||
@@ -227,20 +224,20 @@ void ATM90E32Component::setup() {
|
|||||||
global_preferences->sync();
|
global_preferences->sync();
|
||||||
}
|
}
|
||||||
|
|
||||||
this->restore_offset_calibrations_(OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
this->restore_offset_calibrations_();
|
||||||
this->restore_offset_calibrations_(OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
this->restore_power_offset_calibrations_();
|
||||||
} 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].first_offset));
|
static_cast<uint16_t>(this->offset_phase_[phase].voltage_offset_));
|
||||||
this->write16_(this->current_offset_registers[phase],
|
this->write16_(this->current_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->offset_phase_[phase].second_offset));
|
static_cast<uint16_t>(this->offset_phase_[phase].current_offset_));
|
||||||
this->write16_(this->power_offset_registers[phase],
|
this->write16_(this->power_offset_registers[phase],
|
||||||
static_cast<uint16_t>(this->power_offset_phase_[phase].first_offset));
|
static_cast<uint16_t>(this->power_offset_phase_[phase].active_power_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].second_offset));
|
static_cast<uint16_t>(this->power_offset_phase_[phase].reactive_power_offset));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -320,8 +317,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].first_offset, this->offset_phase_[phase].first_offset,
|
this->config_offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].voltage_offset_,
|
||||||
this->config_offset_phase_[phase].second_offset, this->offset_phase_[phase].second_offset);
|
this->config_offset_phase_[phase].current_offset_, this->offset_phase_[phase].current_offset_);
|
||||||
}
|
}
|
||||||
ESP_LOGW(TAG,
|
ESP_LOGW(TAG,
|
||||||
"[CALIBRATION][%s] ===============================================================================", cs);
|
"[CALIBRATION][%s] ===============================================================================", cs);
|
||||||
@@ -338,8 +335,10 @@ 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].first_offset, this->power_offset_phase_[phase].first_offset,
|
this->config_power_offset_phase_[phase].active_power_offset,
|
||||||
this->config_power_offset_phase_[phase].second_offset, this->power_offset_phase_[phase].second_offset);
|
this->power_offset_phase_[phase].active_power_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);
|
||||||
@@ -373,7 +372,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].first_offset, this->offset_phase_[phase].second_offset);
|
this->offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].current_offset_);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\\n", cs);
|
||||||
}
|
}
|
||||||
@@ -386,7 +385,8 @@ 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].first_offset, this->power_offset_phase_[phase].second_offset);
|
this->power_offset_phase_[phase].active_power_offset,
|
||||||
|
this->power_offset_phase_[phase].reactive_power_offset);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] =====================================================================\n", cs);
|
||||||
}
|
}
|
||||||
@@ -756,68 +756,36 @@ void ATM90E32Component::save_gain_calibration_to_memory_() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::finish_offset_calibration_(const OffsetCalibration (&previous)[3], bool previous_restored,
|
void ATM90E32Component::save_offset_calibration_to_memory_() {
|
||||||
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_();
|
||||||
const LogString *name = offset_calibration_name(power_offsets);
|
bool success = this->offset_pref_.save(&this->offset_phase_);
|
||||||
OffsetCalibration(*offsets)[3] = power_offsets ? &this->power_offset_phase_ : &this->offset_phase_;
|
global_preferences->sync();
|
||||||
ESPPreferenceObject *preference = power_offsets ? &this->power_offset_pref_ : &this->offset_pref_;
|
if (success) {
|
||||||
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 writes_verified = this->verify_offset_writes_(type);
|
|
||||||
bool saved = false;
|
|
||||||
bool synced = false;
|
|
||||||
if (writes_verified) {
|
|
||||||
saved = preference->save(offsets);
|
|
||||||
synced = global_preferences->sync();
|
|
||||||
}
|
|
||||||
|
|
||||||
if (writes_verified && saved && synced) {
|
|
||||||
this->using_saved_calibrations_ = true;
|
this->using_saved_calibrations_ = true;
|
||||||
*has_stored = true;
|
this->restored_offset_calibration_ = true;
|
||||||
*restored = true;
|
for (bool &phase : this->offset_calibration_mismatch_)
|
||||||
for (uint8_t phase = 0; phase < 3; phase++)
|
phase = false;
|
||||||
mismatches[phase] = false;
|
ESP_LOGI(TAG, "[CALIBRATION][%s] Offset calibration saved to memory.", cs);
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] %s calibration saved to memory. %s calibration completed and verified.", cs,
|
} else {
|
||||||
LOG_STR_ARG(name), LOG_STR_ARG(name));
|
this->using_saved_calibrations_ = false;
|
||||||
return;
|
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to save offset calibration to memory!", cs);
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (writes_verified) {
|
void ATM90E32Component::save_power_offset_calibration_to_memory_() {
|
||||||
ESP_LOGE(TAG, "[CALIBRATION][%s] Failed to save %s calibration to memory!", cs, LOG_STR_ARG(name));
|
const char *cs = this->get_calibration_id_();
|
||||||
|
bool success = this->power_offset_pref_.save(&this->power_offset_phase_);
|
||||||
|
global_preferences->sync();
|
||||||
|
if (success) {
|
||||||
|
this->using_saved_calibrations_ = true;
|
||||||
|
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);
|
||||||
}
|
}
|
||||||
|
|
||||||
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() {
|
||||||
@@ -835,16 +803,11 @@ 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);
|
||||||
@@ -852,8 +815,7 @@ void ATM90E32Component::run_offset_calibrations() {
|
|||||||
|
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==================================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==================================================================\n", cs);
|
||||||
|
|
||||||
this->finish_offset_calibration_(previous_offsets, previous_restored, previous_using_saved,
|
this->save_offset_calibration_to_memory_();
|
||||||
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_VOLTAGE_CURRENT);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::run_power_offset_calibrations() {
|
void ATM90E32Component::run_power_offset_calibrations() {
|
||||||
@@ -872,25 +834,18 @@ 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_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);
|
||||||
|
|
||||||
this->finish_offset_calibration_(previous_offsets, previous_restored, previous_using_saved,
|
this->save_power_offset_calibration_to_memory_();
|
||||||
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
void ATM90E32Component::write_gains_to_registers_() {
|
void ATM90E32Component::write_gains_to_registers_() {
|
||||||
@@ -904,26 +859,35 @@ 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 first_offset, int16_t second_offset,
|
void ATM90E32Component::write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset) {
|
||||||
OffsetCalibrationType type) {
|
// Save to runtime
|
||||||
const bool power_offsets = type == OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER;
|
this->offset_phase_[phase].voltage_offset_ = voltage_offset;
|
||||||
OffsetCalibration &offsets = power_offsets ? this->power_offset_phase_[phase] : this->offset_phase_[phase];
|
this->phase_[phase].voltage_offset_ = voltage_offset;
|
||||||
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;
|
|
||||||
}
|
|
||||||
|
|
||||||
const uint16_t *first_registers = power_offsets ? this->power_offset_registers : this->voltage_offset_registers;
|
// Save to flash-storable struct
|
||||||
const uint16_t *second_registers =
|
this->offset_phase_[phase].current_offset_ = current_offset;
|
||||||
power_offsets ? this->reactive_power_offset_registers : this->current_offset_registers;
|
this->phase_[phase].current_offset_ = current_offset;
|
||||||
|
|
||||||
|
// Write to registers
|
||||||
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x55AA);
|
this->write16_(ATM90E32_REGISTER_CFGREGACCEN, 0x55AA);
|
||||||
this->write16_(first_registers[phase], static_cast<uint16_t>(first_offset));
|
this->write16_(voltage_offset_registers[phase], static_cast<uint16_t>(voltage_offset));
|
||||||
this->write16_(second_registers[phase], static_cast<uint16_t>(second_offset));
|
this->write16_(current_offset_registers[phase], static_cast<uint16_t>(current_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);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -983,78 +947,89 @@ 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_(OffsetCalibrationType type) {
|
void ATM90E32Component::restore_offset_calibrations_() {
|
||||||
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)
|
||||||
(*config_offsets)[i] = (*offsets)[i];
|
this->config_offset_phase_[i] = this->offset_phase_[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 (const auto &phase : *offsets) {
|
for (auto &phase : this->offset_phase_) {
|
||||||
if (phase.first_offset != 0 || phase.second_offset != 0) {
|
if (phase.voltage_offset_ != 0 || phase.current_offset_ != 0) {
|
||||||
all_zero = false;
|
all_zero = false;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
*has_stored = have_data && !all_zero;
|
if (have_data && !all_zero) {
|
||||||
*restored = false;
|
this->restored_offset_calibration_ = true;
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
|
auto &offset = this->offset_phase_[phase];
|
||||||
|
bool mismatch = false;
|
||||||
|
if (this->has_config_voltage_offset_[phase] &&
|
||||||
|
offset.voltage_offset_ != this->config_offset_phase_[phase].voltage_offset_)
|
||||||
|
mismatch = true;
|
||||||
|
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 {
|
||||||
|
for (uint8_t phase = 0; phase < 3; phase++)
|
||||||
|
this->offset_phase_[phase] = this->config_offset_phase_[phase];
|
||||||
|
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored offset calibrations found. Using default values.", cs);
|
||||||
|
}
|
||||||
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
for (uint8_t phase = 0; phase < 3; phase++) {
|
||||||
mismatches[phase] = false;
|
write_offsets_to_registers_(phase, this->offset_phase_[phase].voltage_offset_,
|
||||||
if (*has_stored) {
|
this->offset_phase_[phase].current_offset_);
|
||||||
mismatches[phase] =
|
}
|
||||||
(has_first[phase] && (*offsets)[phase].first_offset != (*config_offsets)[phase].first_offset) ||
|
}
|
||||||
(has_second[phase] && (*offsets)[phase].second_offset != (*config_offsets)[phase].second_offset);
|
|
||||||
|
void ATM90E32Component::restore_power_offset_calibrations_() {
|
||||||
|
const char *cs = this->get_calibration_id_();
|
||||||
|
for (uint8_t i = 0; i < 3; ++i)
|
||||||
|
this->config_power_offset_phase_[i] = this->power_offset_phase_[i];
|
||||||
|
|
||||||
|
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 (!*has_stored) {
|
if (have_data && !all_zero) {
|
||||||
for (uint8_t phase = 0; phase < 3; phase++)
|
this->restored_power_offset_calibration_ = true;
|
||||||
(*offsets)[phase] = (*config_offsets)[phase];
|
for (uint8_t phase = 0; phase < 3; ++phase) {
|
||||||
ESP_LOGW(TAG, "[CALIBRATION][%s] No stored %s calibrations found. Using default values.", cs, LOG_STR_ARG(name));
|
auto &offset = this->power_offset_phase_[phase];
|
||||||
}
|
bool mismatch = false;
|
||||||
|
if (this->has_config_active_power_offset_[phase] &&
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
offset.active_power_offset != this->config_power_offset_phase_[phase].active_power_offset)
|
||||||
this->write_offsets_to_registers_(phase, (*offsets)[phase].first_offset, (*offsets)[phase].second_offset, type);
|
mismatch = true;
|
||||||
}
|
if (this->has_config_reactive_power_offset_[phase] &&
|
||||||
const bool initial_values_verified = this->verify_offset_writes_(type);
|
offset.reactive_power_offset != this->config_power_offset_phase_[phase].reactive_power_offset)
|
||||||
if (initial_values_verified) {
|
mismatch = true;
|
||||||
const auto state = resolve_offset_restore_state(*has_stored, true, false);
|
if (mismatch)
|
||||||
*restored = state.restored;
|
this->power_offset_calibration_mismatch_[phase] = true;
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] %s calibration values verified.", cs, LOG_STR_ARG(name));
|
}
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
this->using_saved_calibrations_ = false;
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++)
|
|
||||||
mismatches[phase] = false;
|
|
||||||
for (uint8_t phase = 0; phase < 3; phase++) {
|
|
||||||
(*offsets)[phase] = (*config_offsets)[phase];
|
|
||||||
this->write_offsets_to_registers_(phase, (*offsets)[phase].first_offset, (*offsets)[phase].second_offset, type);
|
|
||||||
}
|
|
||||||
const auto state = resolve_offset_restore_state(*has_stored, false, this->verify_offset_writes_(type));
|
|
||||||
*restored = state.restored;
|
|
||||||
if (state.values_verified) {
|
|
||||||
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration restore failed verification; config values verified.", cs,
|
|
||||||
LOG_STR_ARG(name));
|
|
||||||
} else {
|
} else {
|
||||||
ESP_LOGE(TAG, "[CALIBRATION][%s] %s calibration restore and config fallback both failed verification.", cs,
|
for (uint8_t phase = 0; phase < 3; ++phase)
|
||||||
LOG_STR_ARG(name));
|
this->power_offset_phase_[phase] = this->config_power_offset_phase_[phase];
|
||||||
|
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);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1109,14 +1084,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->has_stored_offset_calibration_) {
|
if (!this->restored_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].first_offset, this->offset_phase_[phase].second_offset);
|
this->offset_phase_[phase].voltage_offset_, this->offset_phase_[phase].current_offset_);
|
||||||
}
|
}
|
||||||
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\n", cs);
|
ESP_LOGI(TAG, "[CALIBRATION][%s] ==============================================================\n", cs);
|
||||||
return;
|
return;
|
||||||
@@ -1129,11 +1104,10 @@ 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].first_offset : 0;
|
this->has_config_voltage_offset_[phase] ? this->config_offset_phase_[phase].voltage_offset_ : 0;
|
||||||
int16_t current_offset =
|
int16_t current_offset =
|
||||||
this->has_config_current_offset_[phase] ? this->config_offset_phase_[phase].second_offset : 0;
|
this->has_config_current_offset_[phase] ? this->config_offset_phase_[phase].current_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);
|
||||||
}
|
}
|
||||||
@@ -1143,7 +1117,6 @@ 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;
|
||||||
@@ -1153,14 +1126,15 @@ 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->has_stored_power_offset_calibration_) {
|
if (!this->restored_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].first_offset, this->power_offset_phase_[phase].second_offset);
|
this->power_offset_phase_[phase].active_power_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;
|
||||||
@@ -1173,21 +1147,20 @@ 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].first_offset : 0;
|
this->has_config_active_power_offset_[phase] ? this->config_power_offset_phase_[phase].active_power_offset : 0;
|
||||||
int16_t reactive_offset =
|
int16_t reactive_offset = this->has_config_reactive_power_offset_[phase]
|
||||||
this->has_config_reactive_power_offset_[phase] ? this->config_power_offset_phase_[phase].second_offset : 0;
|
? this->config_power_offset_phase_[phase].reactive_power_offset
|
||||||
this->write_offsets_to_registers_(phase, active_offset, reactive_offset,
|
: 0;
|
||||||
OffsetCalibrationType::OFFSET_CALIBRATION_TYPE_POWER);
|
this->write_power_offsets_to_registers_(phase, active_offset, reactive_offset);
|
||||||
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);
|
||||||
|
|
||||||
OffsetCalibration zero_power_offsets[3]{{0, 0}, {0, 0}, {0, 0}};
|
PowerOffsetCalibration 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;
|
||||||
@@ -1242,31 +1215,6 @@ 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,40 +13,6 @@
|
|||||||
|
|
||||||
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> {
|
||||||
@@ -105,19 +71,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].first_offset = offset;
|
this->offset_phase_[phase].voltage_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].second_offset = offset;
|
this->offset_phase_[phase].current_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].first_offset = offset;
|
this->power_offset_phase_[phase].active_power_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].second_offset = offset;
|
this->power_offset_phase_[phase].reactive_power_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; }
|
||||||
@@ -205,16 +171,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_(OffsetCalibrationType type);
|
void restore_offset_calibrations_();
|
||||||
|
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 finish_offset_calibration_(const OffsetCalibration (&previous)[3], bool previous_restored,
|
void save_power_offset_calibration_to_memory_();
|
||||||
bool previous_using_saved, OffsetCalibrationType type);
|
void write_offsets_to_registers_(uint8_t phase, int16_t voltage_offset, int16_t current_offset);
|
||||||
void write_offsets_to_registers_(uint8_t phase, int16_t first_offset, int16_t second_offset,
|
void write_power_offsets_to_registers_(uint8_t phase, int16_t p_offset, int16_t q_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_();
|
||||||
@@ -253,10 +219,19 @@ class ATM90E32Component final : public PollingComponent,
|
|||||||
uint32_t cumulative_reverse_active_energy_{0};
|
uint32_t cumulative_reverse_active_energy_{0};
|
||||||
} phase_[3];
|
} phase_[3];
|
||||||
|
|
||||||
OffsetCalibration offset_phase_[3];
|
struct OffsetCalibration {
|
||||||
|
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];
|
|
||||||
OffsetCalibration config_power_offset_phase_[3];
|
struct PowerOffsetCalibration {
|
||||||
|
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};
|
||||||
@@ -290,8 +265,6 @@ 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,10 +313,9 @@ 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 || result == micro_mp3::MP3_STREAM_INFO_CHANGED) {
|
} else if (result == micro_mp3::MP3_STREAM_INFO_READY) {
|
||||||
// Header parsed: capture stream info and resize the output buffer to fit one full frame.
|
// First successful header parse: capture stream info and resize the output buffer to fit one full frame.
|
||||||
// microMP3 always outputs 16-bit PCM. MP3_STREAM_INFO_CHANGED is handled identically: despite its
|
// microMP3 always outputs 16-bit PCM.
|
||||||
// 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,23 +22,6 @@ 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:
|
||||||
@@ -78,7 +61,7 @@ class BLEClientDisconnectTrigger final : public Trigger<>, public BLEClientNode
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientServicelessNode {
|
class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientNode {
|
||||||
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 {}
|
||||||
@@ -88,7 +71,7 @@ class BLEClientPasskeyRequestTrigger final : public Trigger<>, public BLEClientS
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, public BLEClientServicelessNode {
|
class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, public BLEClientNode {
|
||||||
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 {}
|
||||||
@@ -99,7 +82,7 @@ class BLEClientPasskeyNotificationTrigger final : public Trigger<uint32_t>, publ
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
class BLEClientNumericComparisonRequestTrigger final : public Trigger<uint32_t>, public BLEClientServicelessNode {
|
class BLEClientNumericComparisonRequestTrigger final : public Trigger<uint32_t>, public BLEClientNode {
|
||||||
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 {}
|
||||||
@@ -332,17 +315,19 @@ 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 BLEClientServicelessNode {
|
template<typename... Ts> class BLEClientConnectAction final : public Action<Ts...>, public BLEClientNode {
|
||||||
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 on_gattc_event(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override {
|
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
|
||||||
|
esp_ble_gattc_cb_param_t *param) override {
|
||||||
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.
|
||||||
@@ -379,13 +364,14 @@ 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 BLEClientServicelessNode {
|
template<typename... Ts> class BLEClientDisconnectAction final : public Action<Ts...>, public BLEClientNode {
|
||||||
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 on_gattc_event(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if, esp_ble_gattc_cb_param_t *param) override {
|
void gattc_event_handler(esp_gattc_cb_event_t event, esp_gatt_if_t gattc_if,
|
||||||
|
esp_ble_gattc_cb_param_t *param) override {
|
||||||
if (this->num_running_ == 0)
|
if (this->num_running_ == 0)
|
||||||
return;
|
return;
|
||||||
switch (event) {
|
switch (event) {
|
||||||
|
|||||||
@@ -23,7 +23,6 @@ CONF_ENABLE_OTA_DOWNGRADE_PROTECTION = "enable_ota_downgrade_protection"
|
|||||||
CONF_ENABLED = "enabled"
|
CONF_ENABLED = "enabled"
|
||||||
CONF_GYROSCOPE_ODR = "gyroscope_odr"
|
CONF_GYROSCOPE_ODR = "gyroscope_odr"
|
||||||
CONF_GYROSCOPE_RANGE = "gyroscope_range"
|
CONF_GYROSCOPE_RANGE = "gyroscope_range"
|
||||||
CONF_HOST = "host"
|
|
||||||
CONF_IAQ = "iaq"
|
CONF_IAQ = "iaq"
|
||||||
CONF_IGNORE_NOT_FOUND = "ignore_not_found"
|
CONF_IGNORE_NOT_FOUND = "ignore_not_found"
|
||||||
CONF_IS_WRGB = "is_wrgb"
|
CONF_IS_WRGB = "is_wrgb"
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ 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;
|
||||||
@@ -155,14 +154,7 @@ 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,15 +66,11 @@ 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 || reason == ESP_RST_WDT) {
|
if (reason == ESP_RST_SW) {
|
||||||
// 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) && reboot_source[0] != '\0') {
|
if (pref.load(&reboot_source)) {
|
||||||
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,7 +23,11 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.types import ConfigType
|
from esphome.types import ConfigType
|
||||||
|
|
||||||
from . import CONF_DEBUG_ID, FILTER_SOURCE_FILES, DebugComponent # noqa: F401 pylint: disable=unused-import
|
from . import ( # noqa: F401 pylint: disable=unused-import
|
||||||
|
CONF_DEBUG_ID,
|
||||||
|
FILTER_SOURCE_FILES,
|
||||||
|
DebugComponent,
|
||||||
|
)
|
||||||
|
|
||||||
DEPENDENCIES = ["debug"]
|
DEPENDENCIES = ["debug"]
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,11 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.types import ConfigType
|
from esphome.types import ConfigType
|
||||||
|
|
||||||
from . import CONF_DEBUG_ID, FILTER_SOURCE_FILES, DebugComponent # noqa: F401 pylint: disable=unused-import
|
from . import ( # noqa: F401 pylint: disable=unused-import
|
||||||
|
CONF_DEBUG_ID,
|
||||||
|
FILTER_SOURCE_FILES,
|
||||||
|
DebugComponent,
|
||||||
|
)
|
||||||
|
|
||||||
DEPENDENCIES = ["debug"]
|
DEPENDENCIES = ["debug"]
|
||||||
|
|
||||||
|
|||||||
@@ -3,11 +3,18 @@ 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 KEY_ESP32, KEY_FLASH_SIZE, KEY_IDF_VERSION, KEY_VARIANT # noqa: F401 # pylint: disable=unused-import
|
from esphome.const import ( # 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 variant_to_idf_target # noqa: F401 # pylint: disable=unused-import
|
from esphome.espidf import ( # 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"
|
||||||
|
|||||||
@@ -444,10 +444,7 @@ void ESPHomeOTAComponent::handle_data_() {
|
|||||||
tv.tv_usec = 0;
|
tv.tv_usec = 0;
|
||||||
this->client_->setsockopt(SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
|
this->client_->setsockopt(SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv));
|
||||||
this->client_->setsockopt(SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
|
this->client_->setsockopt(SOL_SOCKET, SO_SNDTIMEO, &tv, sizeof(tv));
|
||||||
if (this->client_->setblocking(true) != 0) {
|
this->client_->setblocking(true);
|
||||||
this->log_socket_error_(LOG_STR("blocking"));
|
|
||||||
goto error; // NOLINT(cppcoreguidelines-avoid-goto)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Acknowledge auth OK - 1 byte
|
// Acknowledge auth OK - 1 byte
|
||||||
this->data_write_byte_(ota::OTA_RESPONSE_AUTH_OK);
|
this->data_write_byte_(ota::OTA_RESPONSE_AUTH_OK);
|
||||||
|
|||||||
@@ -91,14 +91,7 @@ void I2SAudioSpeakerBase::loop() {
|
|||||||
this->speaker_task_handle_ = nullptr;
|
this->speaker_task_handle_ = nullptr;
|
||||||
|
|
||||||
this->stop_i2s_driver_();
|
this->stop_i2s_driver_();
|
||||||
// ALL_BITS includes COMMAND_START. Take the bits from the clear itself, not from the snapshot at
|
xEventGroupClearBits(this->event_group_, SpeakerEventGroupBits::ALL_BITS);
|
||||||
// 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,7 +5,6 @@
|
|||||||
#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>
|
||||||
@@ -77,11 +76,7 @@ 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,7 +15,6 @@ 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"
|
||||||
@@ -50,7 +49,7 @@ class KeyboardType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_KEYBOARD, CONF_TEXTAREA, CONF_BUTTONMATRIX, CONF_LABEL
|
return CONF_KEYBOARD, CONF_TEXTAREA, CONF_BUTTONMATRIX
|
||||||
|
|
||||||
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,7 +10,6 @@ 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"
|
||||||
@@ -42,7 +41,7 @@ class QrCodeType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_CANVAS, CONF_IMAGE, CONF_LABEL
|
return CONF_CANVAS, CONF_IMAGE
|
||||||
|
|
||||||
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,7 +28,6 @@ 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"
|
||||||
@@ -75,7 +74,7 @@ class TabviewType(WidgetType):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_uses(self):
|
def get_uses(self):
|
||||||
return CONF_BUTTONMATRIX, TYPE_FLEX, CONF_BUTTON, CONF_LABEL
|
return CONF_BUTTONMATRIX, TYPE_FLEX, CONF_BUTTON
|
||||||
|
|
||||||
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,9 +67,6 @@ 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,7 +14,12 @@ from esphome.const import (
|
|||||||
)
|
)
|
||||||
from esphome.core import CORE, TimePeriod
|
from esphome.core import CORE, TimePeriod
|
||||||
|
|
||||||
from . import FILTER_SOURCE_FILES, Nextion, nextion_ns, nextion_ref # noqa: F401 pylint: disable=unused-import
|
from . import ( # 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,16 +18,6 @@ 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];
|
||||||
@@ -94,21 +84,26 @@ bool RFBridgeComponent::parse_bridge_byte_(uint8_t byte) {
|
|||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
case RF_CODE_RFIN_BUCKET: {
|
case RF_CODE_RFIN_BUCKET: {
|
||||||
if (at == 2) {
|
if (byte != RF_CODE_STOP) {
|
||||||
// The count byte: Portisch sends at most 7 buckets + sync, so 0 or
|
return true;
|
||||||
// >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
|
|
||||||
// with only their HIGH byte masked to 7 bits, so a duration such as
|
uint8_t buckets = raw[2] << 1;
|
||||||
// 0x0155 puts a raw 0x55 low byte inside the table — the first 0x55
|
std::string str;
|
||||||
// must therefore not end the capture. The header declares the table
|
char next_byte[3]; // 2 hex chars + null
|
||||||
// length (raw[2] pairs), so a 0x55 there is always data; one at or
|
|
||||||
// past the first pulse index is a terminator CANDIDATE, confirmed
|
for (uint32_t i = 0; i <= at; i++) {
|
||||||
// once the UART goes quiet (finish_bucket_frame_ in loop()).
|
buf_append_printf(next_byte, sizeof(next_byte), 0, "%02X", raw[i]);
|
||||||
this->bucket_frame_candidate_ = byte == RF_CODE_STOP && at >= 3 + static_cast<size_t>(raw[2]) * 2;
|
str += next_byte;
|
||||||
return true;
|
if ((i > 3) && buckets) {
|
||||||
|
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);
|
||||||
@@ -124,47 +119,6 @@ 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();
|
||||||
@@ -176,31 +130,12 @@ 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();
|
||||||
size_t avail = this->available();
|
if (now - this->last_bridge_byte_ > 50) {
|
||||||
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));
|
||||||
@@ -211,14 +146,12 @@ 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,17 +30,6 @@ 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;
|
||||||
@@ -78,12 +67,10 @@ 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_;
|
||||||
|
|||||||
@@ -17,8 +17,6 @@ CONF_IMPLEMENTATION = "implementation"
|
|||||||
IMPLEMENTATION_LWIP_TCP = "lwip_tcp"
|
IMPLEMENTATION_LWIP_TCP = "lwip_tcp"
|
||||||
IMPLEMENTATION_LWIP_SOCKETS = "lwip_sockets"
|
IMPLEMENTATION_LWIP_SOCKETS = "lwip_sockets"
|
||||||
IMPLEMENTATION_BSD_SOCKETS = "bsd_sockets"
|
IMPLEMENTATION_BSD_SOCKETS = "bsd_sockets"
|
||||||
# Implementations whose sockets cannot make outgoing connections
|
|
||||||
IMPLEMENTATIONS_WITHOUT_CONNECT = frozenset({IMPLEMENTATION_LWIP_TCP})
|
|
||||||
|
|
||||||
# Socket tracking infrastructure
|
# Socket tracking infrastructure
|
||||||
# Components register their socket needs and platforms read this to configure appropriately
|
# Components register their socket needs and platforms read this to configure appropriately
|
||||||
|
|||||||
@@ -59,15 +59,13 @@ int BSDSocketImpl::close() {
|
|||||||
|
|
||||||
int BSDSocketImpl::setblocking(bool blocking) {
|
int BSDSocketImpl::setblocking(bool blocking) {
|
||||||
int fl = ::fcntl(this->fd_, F_GETFL, 0);
|
int fl = ::fcntl(this->fd_, F_GETFL, 0);
|
||||||
if (fl < 0) {
|
|
||||||
return fl;
|
|
||||||
}
|
|
||||||
if (blocking) {
|
if (blocking) {
|
||||||
fl &= ~O_NONBLOCK;
|
fl &= ~O_NONBLOCK;
|
||||||
} else {
|
} else {
|
||||||
fl |= O_NONBLOCK;
|
fl |= O_NONBLOCK;
|
||||||
}
|
}
|
||||||
return ::fcntl(this->fd_, F_SETFL, fl);
|
::fcntl(this->fd_, F_SETFL, fl);
|
||||||
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t BSDSocketImpl::getpeername_to(std::span<char, SOCKADDR_STR_LEN> buf) {
|
size_t BSDSocketImpl::getpeername_to(std::span<char, SOCKADDR_STR_LEN> buf) {
|
||||||
|
|||||||
@@ -49,15 +49,13 @@ int LwIPSocketImpl::close() {
|
|||||||
|
|
||||||
int LwIPSocketImpl::setblocking(bool blocking) {
|
int LwIPSocketImpl::setblocking(bool blocking) {
|
||||||
int fl = lwip_fcntl(this->fd_, F_GETFL, 0);
|
int fl = lwip_fcntl(this->fd_, F_GETFL, 0);
|
||||||
if (fl < 0) {
|
|
||||||
return fl;
|
|
||||||
}
|
|
||||||
if (blocking) {
|
if (blocking) {
|
||||||
fl &= ~O_NONBLOCK;
|
fl &= ~O_NONBLOCK;
|
||||||
} else {
|
} else {
|
||||||
fl |= O_NONBLOCK;
|
fl |= O_NONBLOCK;
|
||||||
}
|
}
|
||||||
return lwip_fcntl(this->fd_, F_SETFL, fl);
|
lwip_fcntl(this->fd_, F_SETFL, fl);
|
||||||
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t LwIPSocketImpl::getpeername_to(std::span<char, SOCKADDR_STR_LEN> buf) {
|
size_t LwIPSocketImpl::getpeername_to(std::span<char, SOCKADDR_STR_LEN> buf) {
|
||||||
|
|||||||
@@ -2,9 +2,6 @@
|
|||||||
#if defined(USE_SOCKET_IMPL_LWIP_TCP) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS) || defined(USE_SOCKET_IMPL_BSD_SOCKETS)
|
#if defined(USE_SOCKET_IMPL_LWIP_TCP) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS) || defined(USE_SOCKET_IMPL_BSD_SOCKETS)
|
||||||
#include <cerrno>
|
#include <cerrno>
|
||||||
#include <cstring>
|
#include <cstring>
|
||||||
#ifdef USE_SOCKET_IMPL_BSD_SOCKETS
|
|
||||||
#include <sys/select.h>
|
|
||||||
#endif
|
|
||||||
#include <string>
|
#include <string>
|
||||||
#include "esphome/core/log.h"
|
#include "esphome/core/log.h"
|
||||||
#include "esphome/core/application.h"
|
#include "esphome/core/application.h"
|
||||||
@@ -168,10 +165,7 @@ socklen_t set_sockaddr(struct sockaddr *addr, socklen_t addrlen, const char *ip_
|
|||||||
#else
|
#else
|
||||||
// Use LWIP-specific functions
|
// Use LWIP-specific functions
|
||||||
ip6_addr_t ip6;
|
ip6_addr_t ip6;
|
||||||
if (inet6_aton(ip_address, &ip6) == 0) {
|
inet6_aton(ip_address, &ip6);
|
||||||
errno = EINVAL;
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
memcpy(server->sin6_addr.un.u32_addr, ip6.addr, sizeof(ip6.addr));
|
memcpy(server->sin6_addr.un.u32_addr, ip6.addr, sizeof(ip6.addr));
|
||||||
#endif
|
#endif
|
||||||
return sizeof(sockaddr_in6);
|
return sizeof(sockaddr_in6);
|
||||||
@@ -191,58 +185,12 @@ socklen_t set_sockaddr(struct sockaddr *addr, socklen_t addrlen, const char *ip_
|
|||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
#else
|
#else
|
||||||
// Unlike inet_addr(), inet_aton() can signal failure while still
|
server->sin_addr.s_addr = inet_addr(ip_address);
|
||||||
// accepting the broadcast address 255.255.255.255
|
|
||||||
if (inet_aton(ip_address, &server->sin_addr) == 0) {
|
|
||||||
errno = EINVAL;
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
#endif
|
#endif
|
||||||
server->sin_port = htons(port);
|
server->sin_port = htons(port);
|
||||||
return sizeof(sockaddr_in);
|
return sizeof(sockaddr_in);
|
||||||
}
|
}
|
||||||
|
|
||||||
#if defined(USE_SOCKET_IMPL_BSD_SOCKETS) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS)
|
|
||||||
ConnectPollResult poll_connect(Socket &sock, int &err_out) {
|
|
||||||
int fd = sock.get_fd();
|
|
||||||
if (fd < 0 || fd >= FD_SETSIZE) {
|
|
||||||
// FD_SET on either is undefined behavior
|
|
||||||
err_out = EBADF;
|
|
||||||
return ConnectPollResult::CONNECT_POLL_ERROR;
|
|
||||||
}
|
|
||||||
// Connect completion is a write event; the main loop only selects on reads
|
|
||||||
fd_set writefds;
|
|
||||||
FD_ZERO(&writefds);
|
|
||||||
FD_SET(fd, &writefds);
|
|
||||||
struct timeval tv = {0, 0};
|
|
||||||
#ifdef USE_SOCKET_IMPL_LWIP_SOCKETS
|
|
||||||
// LWIP_COMPAT_SOCKETS may be off (LibreTiny), so use the lwip symbol directly
|
|
||||||
int ret = lwip_select(fd + 1, nullptr, &writefds, nullptr, &tv);
|
|
||||||
#else
|
|
||||||
// Global-scope select: the entity namespace esphome::select shadows it here
|
|
||||||
int ret = ::select(fd + 1, nullptr, &writefds, nullptr, &tv);
|
|
||||||
#endif
|
|
||||||
if (ret < 0) {
|
|
||||||
err_out = errno;
|
|
||||||
return ConnectPollResult::CONNECT_POLL_ERROR;
|
|
||||||
}
|
|
||||||
if (ret == 0 || !FD_ISSET(fd, &writefds)) {
|
|
||||||
return ConnectPollResult::CONNECT_POLL_PENDING;
|
|
||||||
}
|
|
||||||
int error = 0;
|
|
||||||
socklen_t len = sizeof(error);
|
|
||||||
if (sock.getsockopt(SOL_SOCKET, SO_ERROR, &error, &len) != 0) {
|
|
||||||
err_out = errno;
|
|
||||||
return ConnectPollResult::CONNECT_POLL_ERROR;
|
|
||||||
}
|
|
||||||
if (error != 0) {
|
|
||||||
err_out = error;
|
|
||||||
return ConnectPollResult::CONNECT_POLL_ERROR;
|
|
||||||
}
|
|
||||||
return ConnectPollResult::CONNECT_POLL_CONNECTED;
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
socklen_t set_sockaddr_any(struct sockaddr *addr, socklen_t addrlen, uint16_t port) {
|
socklen_t set_sockaddr_any(struct sockaddr *addr, socklen_t addrlen, uint16_t port) {
|
||||||
#if USE_NETWORK_IPV6
|
#if USE_NETWORK_IPV6
|
||||||
if (addrlen < sizeof(sockaddr_in6)) {
|
if (addrlen < sizeof(sockaddr_in6)) {
|
||||||
|
|||||||
@@ -145,19 +145,6 @@ inline socklen_t set_sockaddr(struct sockaddr *addr, socklen_t addrlen, const st
|
|||||||
/// Set a sockaddr to the any address and specified port for the IP version used by socket_ip().
|
/// Set a sockaddr to the any address and specified port for the IP version used by socket_ip().
|
||||||
socklen_t set_sockaddr_any(struct sockaddr *addr, socklen_t addrlen, uint16_t port);
|
socklen_t set_sockaddr_any(struct sockaddr *addr, socklen_t addrlen, uint16_t port);
|
||||||
|
|
||||||
#if defined(USE_SOCKET_IMPL_BSD_SOCKETS) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS)
|
|
||||||
enum class ConnectPollResult : uint8_t {
|
|
||||||
CONNECT_POLL_PENDING,
|
|
||||||
CONNECT_POLL_CONNECTED,
|
|
||||||
CONNECT_POLL_ERROR,
|
|
||||||
};
|
|
||||||
|
|
||||||
/// Check a non-blocking connect() for completion without blocking. On
|
|
||||||
/// CONNECT_POLL_ERROR, err_out holds the socket's SO_ERROR, or errno when the
|
|
||||||
/// poll itself failed.
|
|
||||||
ConnectPollResult poll_connect(Socket &sock, int &err_out);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/// Format sockaddr into caller-provided buffer, returns length written (excluding null)
|
/// Format sockaddr into caller-provided buffer, returns length written (excluding null)
|
||||||
size_t format_sockaddr_to(const struct sockaddr *addr_ptr, socklen_t len, std::span<char, SOCKADDR_STR_LEN> buf);
|
size_t format_sockaddr_to(const struct sockaddr *addr_ptr, socklen_t len, std::span<char, SOCKADDR_STR_LEN> buf);
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,5 @@
|
|||||||
import esphome.codegen as cg
|
import esphome.codegen as cg
|
||||||
from esphome.components import binary_sensor, sensor
|
from esphome.components import binary_sensor, sensor
|
||||||
from esphome.components.const import CONF_HOST
|
|
||||||
import esphome.config_validation as cv
|
import esphome.config_validation as cv
|
||||||
from esphome.const import (
|
from esphome.const import (
|
||||||
CONF_BINARY_SENSORS,
|
CONF_BINARY_SENSORS,
|
||||||
@@ -15,6 +14,7 @@ AUTO_LOAD = ["socket"]
|
|||||||
CODEOWNERS = ["@Links2004"]
|
CODEOWNERS = ["@Links2004"]
|
||||||
DEPENDENCIES = ["network"]
|
DEPENDENCIES = ["network"]
|
||||||
|
|
||||||
|
CONF_HOST = "host"
|
||||||
CONF_PREFIX = "prefix"
|
CONF_PREFIX = "prefix"
|
||||||
|
|
||||||
statsd_component_ns = cg.esphome_ns.namespace("statsd")
|
statsd_component_ns = cg.esphome_ns.namespace("statsd")
|
||||||
|
|||||||
@@ -1,13 +1,10 @@
|
|||||||
#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
|
||||||
@@ -25,14 +22,6 @@ 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) {
|
||||||
@@ -565,14 +554,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,4 +1,5 @@
|
|||||||
from typing import Any
|
from collections.abc import Callable
|
||||||
|
from typing import Any, NoReturn
|
||||||
|
|
||||||
from esphome import automation
|
from esphome import automation
|
||||||
from esphome.automation import Trigger
|
from esphome.automation import Trigger
|
||||||
@@ -47,10 +48,17 @@ 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): cv.invalid(
|
cv.Optional(x): is_relocated(x)
|
||||||
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,
|
||||||
|
|||||||
@@ -13,16 +13,9 @@ void UDPComponent::setup() {
|
|||||||
#if defined(USE_SOCKET_IMPL_BSD_SOCKETS) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS)
|
#if defined(USE_SOCKET_IMPL_BSD_SOCKETS) || defined(USE_SOCKET_IMPL_LWIP_SOCKETS)
|
||||||
for (const auto &address : this->addresses_) {
|
for (const auto &address : this->addresses_) {
|
||||||
struct sockaddr saddr {};
|
struct sockaddr saddr {};
|
||||||
if (socket::set_sockaddr(&saddr, sizeof(saddr), address, this->broadcast_port_) == 0) {
|
socket::set_sockaddr(&saddr, sizeof(saddr), address, this->broadcast_port_);
|
||||||
ESP_LOGW(TAG, "Invalid address %s", address);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
this->sockaddrs_.push_back(saddr);
|
this->sockaddrs_.push_back(saddr);
|
||||||
}
|
}
|
||||||
if (this->sockaddrs_.size() != this->addresses_.size()) {
|
|
||||||
// A dropped address silently receives nothing; surface the misconfiguration
|
|
||||||
this->status_set_warning(LOG_STR("invalid address"));
|
|
||||||
}
|
|
||||||
// set up broadcast socket
|
// set up broadcast socket
|
||||||
if (this->should_broadcast_) {
|
if (this->should_broadcast_) {
|
||||||
this->broadcast_socket_ = socket::socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);
|
this->broadcast_socket_ = socket::socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);
|
||||||
@@ -101,15 +94,9 @@ void UDPComponent::setup() {
|
|||||||
// 8266 and RP2040 `Duino
|
// 8266 and RP2040 `Duino
|
||||||
for (const auto &address : this->addresses_) {
|
for (const auto &address : this->addresses_) {
|
||||||
auto ipaddr = IPAddress();
|
auto ipaddr = IPAddress();
|
||||||
if (!ipaddr.fromString(address)) {
|
ipaddr.fromString(address);
|
||||||
ESP_LOGW(TAG, "Invalid address %s", address);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
this->ipaddrs_.push_back(ipaddr);
|
this->ipaddrs_.push_back(ipaddr);
|
||||||
}
|
}
|
||||||
if (this->ipaddrs_.size() != this->addresses_.size()) {
|
|
||||||
this->status_set_warning(LOG_STR("invalid address"));
|
|
||||||
}
|
|
||||||
if (this->should_listen_)
|
if (this->should_listen_)
|
||||||
this->udp_client_.begin(this->listen_port_);
|
this->udp_client_.begin(this->listen_port_);
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -34,10 +34,6 @@ void WakeOnLanButton::press_action() {
|
|||||||
struct sockaddr_storage saddr {};
|
struct sockaddr_storage saddr {};
|
||||||
auto addr_len =
|
auto addr_len =
|
||||||
socket::set_sockaddr(reinterpret_cast<sockaddr *>(&saddr), sizeof(saddr), "255.255.255.255", this->port_);
|
socket::set_sockaddr(reinterpret_cast<sockaddr *>(&saddr), sizeof(saddr), "255.255.255.255", this->port_);
|
||||||
if (addr_len == 0) {
|
|
||||||
ESP_LOGW(TAG, "Invalid broadcast address");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
uint8_t buffer[6 + sizeof this->macaddr_ * 16];
|
uint8_t buffer[6 + sizeof this->macaddr_ * 16];
|
||||||
memcpy(buffer, PREFIX, sizeof(PREFIX));
|
memcpy(buffer, PREFIX, sizeof(PREFIX));
|
||||||
for (size_t i = 0; i != 16; i++) {
|
for (size_t i = 0; i != 16; i++) {
|
||||||
|
|||||||
@@ -216,11 +216,6 @@
|
|||||||
#define USE_API_HOMEASSISTANT_SERVICES
|
#define USE_API_HOMEASSISTANT_SERVICES
|
||||||
#define USE_API_HOMEASSISTANT_STATES
|
#define USE_API_HOMEASSISTANT_STATES
|
||||||
#define USE_API_NOISE
|
#define USE_API_NOISE
|
||||||
#if !defined(USE_ESP8266) && !defined(USE_RP2) // raw-lwip sockets cannot make outgoing connections
|
|
||||||
#define USE_API_OUTGOING_CONNECTION
|
|
||||||
#define API_OUTGOING_CONNECTION_PORT 6054
|
|
||||||
#define API_OUTGOING_CONNECTION_DELAY 60000
|
|
||||||
#endif
|
|
||||||
#define USE_API_VARINT64
|
#define USE_API_VARINT64
|
||||||
#define USE_API_PLAINTEXT
|
#define USE_API_PLAINTEXT
|
||||||
#define USE_API_USER_DEFINED_ACTIONS
|
#define USE_API_USER_DEFINED_ACTIONS
|
||||||
|
|||||||
@@ -22,6 +22,10 @@ namespace esphome {
|
|||||||
* pointer. When it is default constructed, it has empty string. You can freely copy or move around this struct, but
|
* pointer. When it is default constructed, it has empty string. You can freely copy or move around this struct, but
|
||||||
* never free its pointer. str() function can be used to export the content as std::string. StringRef is adopted from
|
* never free its pointer. str() function can be used to export the content as std::string. StringRef is adopted from
|
||||||
* <https://github.com/nghttp2/nghttp2/blob/29cbf8b83ff78faf405d1086b16adc09a8772eca/src/template.h#L376>
|
* <https://github.com/nghttp2/nghttp2/blob/29cbf8b83ff78faf405d1086b16adc09a8772eca/src/template.h#L376>
|
||||||
|
*
|
||||||
|
* A StringRef may carry a null pointer while its length is zero (the generated api messages start their encode only
|
||||||
|
* string fields that way). Every member treats that as the empty string; only c_str() hands the null pointer on, so
|
||||||
|
* callers that print or copy through c_str() must check empty() first.
|
||||||
*/
|
*/
|
||||||
class StringRef {
|
class StringRef {
|
||||||
public:
|
public:
|
||||||
@@ -78,7 +82,7 @@ class StringRef {
|
|||||||
|
|
||||||
/// True if the view begins with the given prefix (std::string::starts_with-like)
|
/// True if the view begins with the given prefix (std::string::starts_with-like)
|
||||||
bool starts_with(const StringRef &prefix) const {
|
bool starts_with(const StringRef &prefix) const {
|
||||||
return len_ >= prefix.len_ && std::memcmp(base_, prefix.base_, prefix.len_) == 0;
|
return len_ >= prefix.len_ && (prefix.len_ == 0 || std::memcmp(base_, prefix.base_, prefix.len_) == 0);
|
||||||
}
|
}
|
||||||
bool starts_with(const char *prefix) const { return this->starts_with(StringRef(prefix)); }
|
bool starts_with(const char *prefix) const { return this->starts_with(StringRef(prefix)); }
|
||||||
bool starts_with(const std::string &prefix) const { return this->starts_with(StringRef(prefix)); }
|
bool starts_with(const std::string &prefix) const { return this->starts_with(StringRef(prefix)); }
|
||||||
@@ -92,14 +96,15 @@ class StringRef {
|
|||||||
return actual;
|
return actual;
|
||||||
}
|
}
|
||||||
|
|
||||||
std::string str() const { return std::string(base_, len_); }
|
std::string str() const { return std::string(base_, len_); } // fine for {nullptr, 0}: nothing is read
|
||||||
const uint8_t *byte() const { return reinterpret_cast<const uint8_t *>(base_); }
|
const uint8_t *byte() const { return reinterpret_cast<const uint8_t *>(base_); }
|
||||||
|
|
||||||
operator std::string() const { return str(); }
|
operator std::string() const { return str(); }
|
||||||
|
|
||||||
/// Compare (compatible with std::string::compare)
|
/// Compare (compatible with std::string::compare)
|
||||||
int compare(const StringRef &other) const {
|
int compare(const StringRef &other) const {
|
||||||
int result = std::memcmp(base_, other.base_, std::min(len_, other.len_));
|
size_type common = std::min(len_, other.len_);
|
||||||
|
int result = common == 0 ? 0 : std::memcmp(base_, other.base_, common);
|
||||||
if (result != 0)
|
if (result != 0)
|
||||||
return result;
|
return result;
|
||||||
if (len_ < other.len_)
|
if (len_ < other.len_)
|
||||||
@@ -258,7 +263,14 @@ inline double stod(const StringRef &str, size_t *pos = nullptr) {
|
|||||||
|
|
||||||
#ifdef USE_JSON
|
#ifdef USE_JSON
|
||||||
// NOLINTNEXTLINE(readability-identifier-naming)
|
// NOLINTNEXTLINE(readability-identifier-naming)
|
||||||
inline void convertToJson(const StringRef &src, JsonVariant dst) { dst.set(src.c_str()); }
|
inline void convertToJson(const StringRef &src, JsonVariant dst) {
|
||||||
|
// Bounded by the view length; a null, empty view becomes "" rather than JSON null
|
||||||
|
if (src.empty()) {
|
||||||
|
dst.set("");
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
dst.set(JsonString(src.c_str(), src.size()));
|
||||||
|
}
|
||||||
#endif // USE_JSON
|
#endif // USE_JSON
|
||||||
|
|
||||||
} // namespace esphome
|
} // namespace esphome
|
||||||
|
|||||||
@@ -69,7 +69,10 @@ 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 _set_socket_options, allowed_gai_family # noqa: PLC2701
|
from urllib3.util.connection import ( # 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,15 +616,11 @@ 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,10 +951,8 @@ 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,8 +2,7 @@
|
|||||||
|
|
||||||
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, skipping the private-package probe) apply
|
preservation, download retries) apply inside the subprocess. Running
|
||||||
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.
|
||||||
"""
|
"""
|
||||||
@@ -106,16 +105,6 @@ 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.
|
||||||
@@ -163,7 +152,6 @@ 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 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
clang-format==13.0.1 # also change in .pre-commit-config.yaml and Dockerfile when updating
|
||||||
clang-tidy==22.1.8
|
clang-tidy==22.1.8
|
||||||
yamllint==1.38.0 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
yamllint==1.38.0 # also change in .pre-commit-config.yaml when updating
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
pylint==4.0.8
|
pylint==4.0.8
|
||||||
flake8==7.3.0 # .pre-commit-config.yaml rev synced by script/sync_dependency_versions.py
|
flake8==7.3.0 # 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
|
ruff==0.16.5 # 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
|
pyupgrade==3.21.2 # also change in .pre-commit-config.yaml when updating
|
||||||
prek==0.5.2 # .github/workflows/ci.yml reads this pin
|
prek==0.5.1 # also change in .github/workflows/ci.yml when updating
|
||||||
yamlrocks==0.6.1 # used by script/sync_dependency_versions.py
|
|
||||||
|
|
||||||
# Unit tests
|
# Unit tests
|
||||||
pytest==9.1.1
|
pytest==9.1.1
|
||||||
|
|||||||
+286
-304
@@ -28,6 +28,11 @@ class WireType(IntEnum):
|
|||||||
END_GROUP = 4 # groups (deprecated)
|
END_GROUP = 4 # groups (deprecated)
|
||||||
FIXED32 = 5 # fixed32, sfixed32, float
|
FIXED32 = 5 # fixed32, sfixed32, float
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cpp_name(self) -> str:
|
||||||
|
"""The matching constant in proto.h."""
|
||||||
|
return f"WIRE_TYPE_{self.name}"
|
||||||
|
|
||||||
|
|
||||||
# Generate with
|
# Generate with
|
||||||
# protoc --python_out=script/api_protobuf -I esphome/components/api/ api_options.proto
|
# protoc --python_out=script/api_protobuf -I esphome/components/api/ api_options.proto
|
||||||
@@ -126,9 +131,10 @@ def camel_to_snake(name: str) -> str:
|
|||||||
return re.sub("([a-z0-9])([A-Z])", r"\1_\2", s1).lower()
|
return re.sub("([a-z0-9])([A-Z])", r"\1_\2", s1).lower()
|
||||||
|
|
||||||
|
|
||||||
def force_str(force: bool) -> str:
|
def _encode_call(func: str, *args: str, force: bool = False) -> str:
|
||||||
"""Convert a boolean force value to string format for C++ code."""
|
"""Emit one ProtoEncode call; every helper takes the cursor and returns it advanced."""
|
||||||
return str(force).lower()
|
suffix = "_force" if force else ""
|
||||||
|
return f"pos = ProtoEncode::{func}{suffix}({', '.join(('pos', *args))});"
|
||||||
|
|
||||||
|
|
||||||
class TypeInfo(ABC):
|
class TypeInfo(ABC):
|
||||||
@@ -223,55 +229,39 @@ class TypeInfo(ABC):
|
|||||||
def class_member(self) -> str:
|
def class_member(self) -> str:
|
||||||
return f"{self.cpp_type} {self.field_name}{{{self.default_value}}};"
|
return f"{self.cpp_type} {self.field_name}{{{self.default_value}}};"
|
||||||
|
|
||||||
@property
|
def decode_case(self, body: str) -> str:
|
||||||
def decode_varint_content(self) -> str:
|
"""Emit one decode_field() case, keyed on the field's wire tag."""
|
||||||
content = self.decode_varint
|
return f"case proto_tag({self.number}, {self.wire_type.cpp_name}):\n" + indent(
|
||||||
if content is None:
|
f"{body}\nbreak;"
|
||||||
return None
|
)
|
||||||
return f"case {self.number}: this->{self.field_name} = {content}; break;"
|
|
||||||
|
|
||||||
decode_varint = None
|
# Expression that reads this field from `value`; None when the type is never decoded.
|
||||||
|
decode_expr: str | None = None
|
||||||
|
|
||||||
|
def _decode_store(self, expr: str) -> str:
|
||||||
|
return f"this->{self.field_name} = {expr};"
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str:
|
def decode_content(self) -> str | None:
|
||||||
content = self.decode_length
|
"""The decode_field() case for this field, or None when it is never decoded."""
|
||||||
if content is None:
|
expr = self.decode_expr
|
||||||
return None
|
return None if expr is None else self.decode_case(self._decode_store(expr))
|
||||||
return f"case {self.number}: this->{self.field_name} = {content}; break;"
|
|
||||||
|
|
||||||
decode_length = None
|
|
||||||
|
|
||||||
@property
|
|
||||||
def decode_32bit_content(self) -> str:
|
|
||||||
content = self.decode_32bit
|
|
||||||
if content is None:
|
|
||||||
return None
|
|
||||||
return f"case {self.number}: this->{self.field_name} = {content}; break;"
|
|
||||||
|
|
||||||
decode_32bit = None
|
|
||||||
|
|
||||||
@property
|
|
||||||
def decode_64bit_content(self) -> str:
|
|
||||||
content = self.decode_64bit
|
|
||||||
if content is None:
|
|
||||||
return None
|
|
||||||
return f"case {self.number}: this->{self.field_name} = {content}; break;"
|
|
||||||
|
|
||||||
decode_64bit = None
|
|
||||||
|
|
||||||
# Mapping from encode_func to raw encode expression template.
|
# Mapping from encode_func to raw encode expression template.
|
||||||
# When a forced field has a single-byte tag, the code generator emits
|
# When a forced field has a single-byte tag, the code generator emits
|
||||||
# write_raw_byte(tag) + raw encode instead of the full encode_* method,
|
# write_raw_byte(tag) + raw encode instead of the full encode_* method,
|
||||||
# eliminating the zero-check branch and encode_field_raw indirection.
|
# eliminating the zero-check branch and encode_field_raw indirection.
|
||||||
# {value} is replaced with the actual field expression.
|
# {value} is replaced with the actual field expression.
|
||||||
RAW_ENCODE_MAP: dict[str, str] = {
|
RAW_ENCODE_MAP: dict[str, tuple[str, str]] = {
|
||||||
"encode_uint32": "ProtoEncode::encode_varint_raw(pos, {value});",
|
"encode_uint32": ("encode_varint_raw", "{value}"),
|
||||||
"encode_uint64": "ProtoEncode::encode_varint_raw_64(pos, {value});",
|
"encode_uint64": ("encode_varint_raw_64", "{value}"),
|
||||||
"encode_sint32": "ProtoEncode::encode_varint_raw_short(pos, encode_zigzag32({value}));",
|
"encode_sint32": ("encode_varint_raw_short", "encode_zigzag32({value})"),
|
||||||
"encode_sint64": "ProtoEncode::encode_varint_raw_64(pos, encode_zigzag64({value}));",
|
"encode_sint64": ("encode_varint_raw_64", "encode_zigzag64({value})"),
|
||||||
"encode_int64": "ProtoEncode::encode_varint_raw_64(pos, static_cast<uint64_t>({value}));",
|
"encode_int64": ("encode_varint_raw_64", "static_cast<uint64_t>({value})"),
|
||||||
"encode_bool": "ProtoEncode::write_raw_byte(pos, {value} ? 0x01 : 0x00);",
|
"encode_bool": ("write_raw_byte", "{value} ? 0x01 : 0x00"),
|
||||||
}
|
}
|
||||||
|
# Fixed32 value expression for the shared tag+fixed32 writer; None for other wire types
|
||||||
|
fixed32_value_template: str | None = None
|
||||||
|
|
||||||
def _encode_with_precomputed_tag(self, value_expr: str) -> str | None:
|
def _encode_with_precomputed_tag(self, value_expr: str) -> str | None:
|
||||||
"""Try to emit a precomputed-tag encode for a field.
|
"""Try to emit a precomputed-tag encode for a field.
|
||||||
@@ -288,12 +278,17 @@ class TypeInfo(ABC):
|
|||||||
return None
|
return None
|
||||||
max_val = self.max_value
|
max_val = self.max_value
|
||||||
# Only use RAW_ENCODE_MAP for forced fields or fields with max_value
|
# Only use RAW_ENCODE_MAP for forced fields or fields with max_value
|
||||||
raw_expr = None
|
raw = None
|
||||||
if self.force or max_val is not None:
|
if self.force or max_val is not None:
|
||||||
raw_expr = self.RAW_ENCODE_MAP.get(self.encode_func)
|
raw = self.RAW_ENCODE_MAP.get(self.encode_func)
|
||||||
if raw_expr is None:
|
if raw is None:
|
||||||
return None
|
return None
|
||||||
body = f"ProtoEncode::write_raw_byte(pos, {tag});\n{raw_expr.format(value=value_expr)}"
|
func, arg = raw
|
||||||
|
body = (
|
||||||
|
_encode_call("write_raw_byte", str(tag))
|
||||||
|
+ "\n"
|
||||||
|
+ _encode_call(func, arg.format(value=value_expr))
|
||||||
|
)
|
||||||
if self.force:
|
if self.force:
|
||||||
return body
|
return body
|
||||||
# Non-forced with max_value: inline zero-check + raw encode
|
# Non-forced with max_value: inline zero-check + raw encode
|
||||||
@@ -314,23 +309,44 @@ class TypeInfo(ABC):
|
|||||||
return None
|
return None
|
||||||
# When max_len < 128, length varint is always 1 byte
|
# When max_len < 128, length varint is always 1 byte
|
||||||
len_encode = (
|
len_encode = (
|
||||||
f"ProtoEncode::write_raw_byte(pos, static_cast<uint8_t>({len_expr}));"
|
_encode_call("write_raw_byte", f"static_cast<uint8_t>({len_expr})")
|
||||||
if max_len is not None and max_len < 128
|
if max_len is not None and max_len < 128
|
||||||
else f"ProtoEncode::encode_varint_raw(pos, {len_expr});"
|
else _encode_call("encode_varint_raw", len_expr)
|
||||||
)
|
)
|
||||||
|
return "\n".join(
|
||||||
|
(
|
||||||
|
_encode_call("write_raw_byte", str(tag)),
|
||||||
|
len_encode,
|
||||||
|
_encode_call("encode_raw", data_expr, len_expr),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
def _encode_fixed32_with_precomputed_tag(self, value: str) -> str | None:
|
||||||
|
"""Single-byte tag fixed32 write, or None for other types and multi-byte tags."""
|
||||||
|
tag = self.calculate_tag()
|
||||||
|
if self.fixed32_value_template is None or tag >= 128:
|
||||||
|
return None
|
||||||
|
value_expr = self.fixed32_value_template.format(value=value)
|
||||||
|
if self.force:
|
||||||
|
return _encode_call("write_tag_and_fixed32", str(tag), value_expr)
|
||||||
return (
|
return (
|
||||||
f"ProtoEncode::write_raw_byte(pos, {tag});\n"
|
f"if (uint32_t raw = {value_expr}; raw != 0) [[likely]] {{\n"
|
||||||
f"{len_encode}\n"
|
f" {_encode_call('write_tag_and_fixed32', str(tag), 'raw')}\n"
|
||||||
f"ProtoEncode::encode_raw(pos, {data_expr}, {len_expr});"
|
"}"
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
if result := self._encode_with_precomputed_tag(f"this->{self.field_name}"):
|
value = f"this->{self.field_name}"
|
||||||
|
if result := self._encode_with_precomputed_tag(value):
|
||||||
return result
|
return result
|
||||||
if self.force:
|
if result := self._encode_fixed32_with_precomputed_tag(value):
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, this->{self.field_name}, true);"
|
return result
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, this->{self.field_name});"
|
return _encode_call(self.encode_func, str(self.number), value, force=self.force)
|
||||||
|
|
||||||
|
def encode_element(self, number: int, element: str) -> str:
|
||||||
|
"""Encode one element of a repeated field; elements are always written."""
|
||||||
|
return _encode_call(self.encode_func, str(number), element, force=True)
|
||||||
|
|
||||||
encode_func = None
|
encode_func = None
|
||||||
|
|
||||||
@@ -550,17 +566,17 @@ def create_field_type_info(
|
|||||||
# For messages that decode (SOURCE_CLIENT or SOURCE_BOTH), use pointer
|
# For messages that decode (SOURCE_CLIENT or SOURCE_BOTH), use pointer
|
||||||
# for zero-copy access to the receive buffer
|
# for zero-copy access to the receive buffer
|
||||||
if needs_decode:
|
if needs_decode:
|
||||||
return PointerToBytesBufferType(field, None)
|
return PointerToBytesBufferType(field, needs_decode)
|
||||||
|
|
||||||
# For SOURCE_SERVER (encode only), explicit annotation is still needed
|
# For SOURCE_SERVER (encode only), explicit annotation is still needed
|
||||||
if get_field_opt(field, pb.pointer_to_buffer, False):
|
if get_field_opt(field, pb.pointer_to_buffer, False):
|
||||||
return PointerToBytesBufferType(field, None)
|
return PointerToBytesBufferType(field, needs_decode)
|
||||||
|
|
||||||
return BytesType(field, needs_decode, needs_encode)
|
return BytesType(field, needs_decode, needs_encode)
|
||||||
|
|
||||||
# Special handling for string fields - use StringRef for zero-copy
|
# Special handling for string fields - use StringRef for zero-copy
|
||||||
if field.type == 9:
|
if field.type == 9:
|
||||||
return PointerToStringBufferType(field, None)
|
return PointerToStringBufferType(field, needs_decode)
|
||||||
|
|
||||||
validate_field_type(field.type, field.name)
|
validate_field_type(field.type, field.name)
|
||||||
if field.type == 11:
|
if field.type == 11:
|
||||||
@@ -605,7 +621,6 @@ class DoubleType(FixedSizeTypeMixin, TypeInfo):
|
|||||||
# Unsupported but defined for completeness
|
# Unsupported but defined for completeness
|
||||||
cpp_type = "double"
|
cpp_type = "double"
|
||||||
default_value = "0.0"
|
default_value = "0.0"
|
||||||
decode_64bit = "value.as_double()"
|
|
||||||
encode_func = "encode_double"
|
encode_func = "encode_double"
|
||||||
wire_type = WireType.FIXED64 # Uses wire type 1 according to protobuf spec
|
wire_type = WireType.FIXED64 # Uses wire type 1 according to protobuf spec
|
||||||
|
|
||||||
@@ -631,10 +646,12 @@ class DoubleType(FixedSizeTypeMixin, TypeInfo):
|
|||||||
class FloatType(FixedSizeTypeMixin, TypeInfo):
|
class FloatType(FixedSizeTypeMixin, TypeInfo):
|
||||||
cpp_type = "float"
|
cpp_type = "float"
|
||||||
default_value = "0.0f"
|
default_value = "0.0f"
|
||||||
decode_32bit = "value.as_float()"
|
decode_expr = "value.as_float()"
|
||||||
encode_func = "encode_float"
|
encode_func = "encode_float"
|
||||||
wire_type = WireType.FIXED32 # Uses wire type 5
|
wire_type = WireType.FIXED32 # Uses wire type 5
|
||||||
|
|
||||||
|
fixed32_value_template = "float_to_raw({value})"
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
o = f'snprintf(buffer, sizeof(buffer), "%g", {name});\n'
|
o = f'snprintf(buffer, sizeof(buffer), "%g", {name});\n'
|
||||||
o += "out.append(buffer);"
|
o += "out.append(buffer);"
|
||||||
@@ -658,7 +675,7 @@ class Int64Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "int64_t"
|
cpp_type = "int64_t"
|
||||||
_varint_max_bits = 64
|
_varint_max_bits = 64
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "static_cast<int64_t>(value)"
|
decode_expr = "static_cast<int64_t>(value.as_varint())"
|
||||||
encode_func = "encode_int64"
|
encode_func = "encode_int64"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -679,7 +696,7 @@ class UInt64Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "uint64_t"
|
cpp_type = "uint64_t"
|
||||||
_varint_max_bits = 64
|
_varint_max_bits = 64
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "value"
|
decode_expr = "value.as_varint()"
|
||||||
encode_func = "encode_uint64"
|
encode_func = "encode_uint64"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -697,11 +714,11 @@ class UInt64Type(VarintTypeMixin, TypeInfo):
|
|||||||
return self._get_simple_size_calculation(name, force, "uint64")
|
return self._get_simple_size_calculation(name, force, "uint64")
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def RAW_ENCODE_MAP(self) -> dict[str, str]: # noqa: N802
|
def RAW_ENCODE_MAP(self) -> dict[str, tuple[str, str]]: # noqa: N802
|
||||||
if self.mac_address:
|
if self.mac_address:
|
||||||
return {
|
return {
|
||||||
**TypeInfo.RAW_ENCODE_MAP,
|
**TypeInfo.RAW_ENCODE_MAP,
|
||||||
"encode_uint64": "ProtoEncode::encode_varint_raw_48bit(pos, {value});",
|
"encode_uint64": ("encode_varint_raw_48bit", "{value}"),
|
||||||
}
|
}
|
||||||
return TypeInfo.RAW_ENCODE_MAP
|
return TypeInfo.RAW_ENCODE_MAP
|
||||||
|
|
||||||
@@ -714,7 +731,7 @@ class Int32Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "int32_t"
|
cpp_type = "int32_t"
|
||||||
_varint_max_bits = 64 # int32 is sign-extended to 64 bits in protobuf
|
_varint_max_bits = 64 # int32 is sign-extended to 64 bits in protobuf
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "static_cast<int32_t>(value)"
|
decode_expr = "static_cast<int32_t>(value.as_varint())"
|
||||||
encode_func = "encode_int32"
|
encode_func = "encode_int32"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -734,7 +751,6 @@ class Int32Type(VarintTypeMixin, TypeInfo):
|
|||||||
class Fixed64Type(FixedSizeTypeMixin, TypeInfo):
|
class Fixed64Type(FixedSizeTypeMixin, TypeInfo):
|
||||||
cpp_type = "uint64_t"
|
cpp_type = "uint64_t"
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_64bit = "value.as_fixed64()"
|
|
||||||
encode_func = "encode_fixed64"
|
encode_func = "encode_fixed64"
|
||||||
wire_type = WireType.FIXED64 # Uses wire type 1
|
wire_type = WireType.FIXED64 # Uses wire type 1
|
||||||
|
|
||||||
@@ -760,7 +776,7 @@ class Fixed64Type(FixedSizeTypeMixin, TypeInfo):
|
|||||||
class Fixed32Type(FixedSizeTypeMixin, TypeInfo):
|
class Fixed32Type(FixedSizeTypeMixin, TypeInfo):
|
||||||
cpp_type = "uint32_t"
|
cpp_type = "uint32_t"
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_32bit = "value.as_fixed32()"
|
decode_expr = "value.as_fixed32()"
|
||||||
encode_func = "encode_fixed32"
|
encode_func = "encode_fixed32"
|
||||||
wire_type = WireType.FIXED32 # Uses wire type 5
|
wire_type = WireType.FIXED32 # Uses wire type 5
|
||||||
|
|
||||||
@@ -769,15 +785,7 @@ class Fixed32Type(FixedSizeTypeMixin, TypeInfo):
|
|||||||
o += "out.append(buffer);"
|
o += "out.append(buffer);"
|
||||||
return o
|
return o
|
||||||
|
|
||||||
@property
|
fixed32_value_template = "{value}"
|
||||||
def encode_content(self) -> str:
|
|
||||||
tag = self.calculate_tag()
|
|
||||||
if self.force and tag < 128:
|
|
||||||
# Emit combined tag+value write: precomputed tag + direct memcpy
|
|
||||||
return f"ProtoEncode::write_tag_and_fixed32(pos, {tag}, this->{self.field_name});"
|
|
||||||
if self.force:
|
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, this->{self.field_name}, true);"
|
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, this->{self.field_name});"
|
|
||||||
|
|
||||||
def get_size_calculation(self, name: str, force: bool = False) -> str:
|
def get_size_calculation(self, name: str, force: bool = False) -> str:
|
||||||
field_id_size = self.calculate_field_id_size()
|
field_id_size = self.calculate_field_id_size()
|
||||||
@@ -797,7 +805,7 @@ class BoolType(VarintTypeMixin, TypeInfo):
|
|||||||
_varint_max_bits = 1
|
_varint_max_bits = 1
|
||||||
cpp_type = "bool"
|
cpp_type = "bool"
|
||||||
default_value = "false"
|
default_value = "false"
|
||||||
decode_varint = "value != 0"
|
decode_expr = "value.as_bool()"
|
||||||
encode_func = "encode_bool"
|
encode_func = "encode_bool"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -817,7 +825,7 @@ class StringType(TypeInfo):
|
|||||||
default_value = ""
|
default_value = ""
|
||||||
reference_type = "std::string &"
|
reference_type = "std::string &"
|
||||||
const_reference_type = "const std::string &"
|
const_reference_type = "const std::string &"
|
||||||
decode_length = "value.as_string()"
|
decode_expr = "value.as_string()"
|
||||||
encode_func = "encode_string"
|
encode_func = "encode_string"
|
||||||
wire_type = WireType.LENGTH_DELIMITED # Uses wire type 2
|
wire_type = WireType.LENGTH_DELIMITED # Uses wire type 2
|
||||||
|
|
||||||
@@ -851,9 +859,12 @@ class StringType(TypeInfo):
|
|||||||
f"this->{self.field_name}_ref_.size()",
|
f"this->{self.field_name}_ref_.size()",
|
||||||
):
|
):
|
||||||
return result
|
return result
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::encode_string(pos, {self.number}, this->{self.field_name}_ref_, true);"
|
"encode_string",
|
||||||
return f"ProtoEncode::encode_string(pos, {self.number}, this->{self.field_name}_ref_);"
|
str(self.number),
|
||||||
|
f"this->{self.field_name}_ref_",
|
||||||
|
force=self.force,
|
||||||
|
)
|
||||||
|
|
||||||
def dump(self, name):
|
def dump(self, name):
|
||||||
# If name is 'it', this is a repeated field element - always use string
|
# If name is 'it', this is a repeated field element - always use string
|
||||||
@@ -929,6 +940,9 @@ class MessageType(TypeInfo):
|
|||||||
def can_use_dump_field(cls) -> bool:
|
def can_use_dump_field(cls) -> bool:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
def encode_element(self, number: int, element: str) -> str:
|
||||||
|
return _encode_call("encode_sub_message", "buffer", str(number), element)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def cpp_type(self) -> str:
|
def cpp_type(self) -> str:
|
||||||
return self._field.type_name[1:]
|
return self._field.type_name[1:]
|
||||||
@@ -951,15 +965,9 @@ class MessageType(TypeInfo):
|
|||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
# Sub-message encoding needs buffer for backpatch/sync
|
# Sub-message encoding needs buffer for backpatch/sync
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, buffer, {self.number}, this->{self.field_name});"
|
return _encode_call(
|
||||||
|
self.encode_func, "buffer", str(self.number), f"this->{self.field_name}"
|
||||||
@property
|
)
|
||||||
def decode_length(self) -> str:
|
|
||||||
# Override to return None for message types because we can't use template-based
|
|
||||||
# decoding when the specific message type isn't known at compile time.
|
|
||||||
# Instead, we use the non-template decode_to_message() method which allows
|
|
||||||
# runtime polymorphism through virtual function calls.
|
|
||||||
return None
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def public_content(self) -> list[str]:
|
def public_content(self) -> list[str]:
|
||||||
@@ -976,19 +984,14 @@ class MessageType(TypeInfo):
|
|||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str:
|
def decode_content(self) -> str:
|
||||||
# Custom decode that doesn't use templates
|
body = f"value.decode_to_message(this->{self.field_name});"
|
||||||
if self._track_presence:
|
if self._track_presence:
|
||||||
# decode_to_message() cannot report failure, so setting the flag
|
# decode_to_message() cannot report failure, so setting the flag
|
||||||
# afterwards only documents intent; a status-returning decode could
|
# afterwards only documents intent; a status-returning decode could
|
||||||
# gate it for real without touching callers.
|
# gate it for real without touching callers.
|
||||||
return (
|
body += f"\nthis->has_{self.name} = true;"
|
||||||
f"case {self.number}:\n"
|
return self.decode_case(body)
|
||||||
f" value.decode_to_message(this->{self.field_name});\n"
|
|
||||||
f" this->has_{self.name} = true;\n"
|
|
||||||
f" break;"
|
|
||||||
)
|
|
||||||
return f"case {self.number}: value.decode_to_message(this->{self.field_name}); break;"
|
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
return f"{name}.dump_to(out);"
|
return f"{name}.dump_to(out);"
|
||||||
@@ -1027,7 +1030,7 @@ class BytesType(TypeInfo):
|
|||||||
reference_type = "std::string &"
|
reference_type = "std::string &"
|
||||||
const_reference_type = "const std::string &"
|
const_reference_type = "const std::string &"
|
||||||
encode_func = "encode_bytes"
|
encode_func = "encode_bytes"
|
||||||
decode_length = "value.as_string()"
|
decode_expr = "value.as_string()"
|
||||||
wire_type = WireType.LENGTH_DELIMITED # Uses wire type 2
|
wire_type = WireType.LENGTH_DELIMITED # Uses wire type 2
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -1058,9 +1061,13 @@ class BytesType(TypeInfo):
|
|||||||
f"this->{self.field_name}_ptr_", f"this->{self.field_name}_len_"
|
f"this->{self.field_name}_ptr_", f"this->{self.field_name}_len_"
|
||||||
):
|
):
|
||||||
return result
|
return result
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}_ptr_, this->{self.field_name}_len_, true);"
|
"encode_bytes",
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}_ptr_, this->{self.field_name}_len_);"
|
str(self.number),
|
||||||
|
f"this->{self.field_name}_ptr_",
|
||||||
|
f"this->{self.field_name}_len_",
|
||||||
|
force=self.force,
|
||||||
|
)
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
ptr_dump = f"format_hex_pretty(this->{self.field_name}_ptr_, this->{self.field_name}_len_)"
|
ptr_dump = f"format_hex_pretty(this->{self.field_name}_ptr_, this->{self.field_name}_len_)"
|
||||||
@@ -1127,16 +1134,12 @@ class PointerToBufferTypeBase(TypeInfo):
|
|||||||
def can_use_dump_field(cls) -> bool:
|
def can_use_dump_field(cls) -> bool:
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
# Only here to make needs_decode required: the null string default keys off it, so a call
|
||||||
|
# site must not fall back on the base class default
|
||||||
def __init__(
|
def __init__(
|
||||||
self, field: descriptor.FieldDescriptorProto, size: int | None = None
|
self, field: descriptor.FieldDescriptorProto, needs_decode: bool
|
||||||
) -> None:
|
) -> None:
|
||||||
super().__init__(field)
|
super().__init__(field, needs_decode)
|
||||||
self.array_size = 0
|
|
||||||
|
|
||||||
@property
|
|
||||||
def decode_length(self) -> str | None:
|
|
||||||
# This is handled in decode_length_content
|
|
||||||
return None
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def wire_type(self) -> WireType:
|
def wire_type(self) -> WireType:
|
||||||
@@ -1170,17 +1173,20 @@ class PointerToBytesBufferType(PointerToBufferTypeBase):
|
|||||||
f"this->{self.field_name}", f"this->{self.field_name}_len"
|
f"this->{self.field_name}", f"this->{self.field_name}_len"
|
||||||
):
|
):
|
||||||
return result
|
return result
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}, this->{self.field_name}_len, true);"
|
"encode_bytes",
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}, this->{self.field_name}_len);"
|
str(self.number),
|
||||||
|
f"this->{self.field_name}",
|
||||||
|
f"this->{self.field_name}_len",
|
||||||
|
force=self.force,
|
||||||
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str | None:
|
def decode_content(self) -> str:
|
||||||
return f"""case {self.number}: {{
|
return self.decode_case(
|
||||||
this->{self.field_name} = value.data();
|
f"this->{self.field_name} = value.data();\n"
|
||||||
this->{self.field_name}_len = value.size();
|
f"this->{self.field_name}_len = value.size();",
|
||||||
break;
|
)
|
||||||
}}"""
|
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
return (
|
return (
|
||||||
@@ -1214,34 +1220,53 @@ class PointerToStringBufferType(PointerToBufferTypeBase):
|
|||||||
def can_use_dump_field(cls) -> bool:
|
def can_use_dump_field(cls) -> bool:
|
||||||
return True
|
return True
|
||||||
|
|
||||||
|
@property
|
||||||
|
def _starts_null(self) -> bool:
|
||||||
|
"""A field that is only encoded, and skipped when empty, never has its pointer read
|
||||||
|
before it is set, so it can default to a null StringRef and the message constructs as
|
||||||
|
one zero fill. Any encode path that copies unconditionally must check this."""
|
||||||
|
return not self._needs_decode and not self.force
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def public_content(self) -> list[str]:
|
def public_content(self) -> list[str]:
|
||||||
|
if self._starts_null:
|
||||||
|
return [
|
||||||
|
f"StringRef {self.field_name}{{nullptr, 0}}; // null until set, encode only"
|
||||||
|
]
|
||||||
return [f"StringRef {self.field_name}{{}};"]
|
return [f"StringRef {self.field_name}{{}};"]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
max_len = self.max_data_length
|
max_len = self.max_data_length
|
||||||
if max_len is not None and max_len < 128 and self.force:
|
if max_len is not None and max_len < 128 and self.force:
|
||||||
|
assert not self._starts_null, (
|
||||||
|
"unconditional copy of a field that may start null"
|
||||||
|
)
|
||||||
tag = self.calculate_tag()
|
tag = self.calculate_tag()
|
||||||
if tag < 128:
|
if tag < 128:
|
||||||
return f"ProtoEncode::encode_short_string_force(pos, {tag}, this->{self.field_name});"
|
return _encode_call(
|
||||||
|
"encode_short_string_force", str(tag), f"this->{self.field_name}"
|
||||||
|
)
|
||||||
if result := self._encode_bytes_with_precomputed_tag(
|
if result := self._encode_bytes_with_precomputed_tag(
|
||||||
f"this->{self.field_name}.c_str()",
|
f"this->{self.field_name}.c_str()",
|
||||||
f"this->{self.field_name}.size()",
|
f"this->{self.field_name}.size()",
|
||||||
):
|
):
|
||||||
|
assert not self._starts_null, (
|
||||||
|
"unconditional copy of a field that may start null"
|
||||||
|
)
|
||||||
return result
|
return result
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::encode_string(pos, {self.number}, this->{self.field_name}, true);"
|
"encode_string",
|
||||||
return (
|
str(self.number),
|
||||||
f"ProtoEncode::encode_string(pos, {self.number}, this->{self.field_name});"
|
f"this->{self.field_name}",
|
||||||
|
force=self.force,
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str | None:
|
def decode_content(self) -> str:
|
||||||
return f"""case {self.number}: {{
|
return self.decode_case(
|
||||||
this->{self.field_name} = StringRef(reinterpret_cast<const char *>(value.data()), value.size());
|
f"this->{self.field_name} = StringRef(value.data(), value.size());",
|
||||||
break;
|
)
|
||||||
}}"""
|
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
# Not used since we use dump_field, but required by abstract base class
|
# Not used since we use dump_field, but required by abstract base class
|
||||||
@@ -1310,14 +1335,13 @@ class PackedBufferTypeInfo(TypeInfo):
|
|||||||
]
|
]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str:
|
def decode_content(self) -> str:
|
||||||
"""Store pointer to buffer and calculate count of packed varints."""
|
"""Store pointer to buffer and calculate count of packed varints."""
|
||||||
return f"""case {self.number}: {{
|
return self.decode_case(
|
||||||
this->{self.field_name}_data_ = value.data();
|
f"this->{self.field_name}_data_ = value.data();\n"
|
||||||
this->{self.field_name}_length_ = value.size();
|
f"this->{self.field_name}_length_ = value.size();\n"
|
||||||
this->{self.field_name}_count_ = count_packed_varints(value.data(), value.size());
|
f"this->{self.field_name}_count_ = count_packed_varints(value.data(), value.size());",
|
||||||
break;
|
)
|
||||||
}}"""
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
@@ -1402,17 +1426,11 @@ class FixedArrayBytesType(TypeInfo):
|
|||||||
]
|
]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str:
|
def decode_content(self) -> str:
|
||||||
o = f"case {self.number}: {{\n"
|
return self.decode_case(
|
||||||
o += " const std::string &data_str = value.as_string();\n"
|
f"this->{self.field_name}_len = std::min<size_t>(value.size(), {self.array_size});\n"
|
||||||
o += f" this->{self.field_name}_len = data_str.size();\n"
|
f"memcpy(this->{self.field_name}, value.data(), this->{self.field_name}_len);",
|
||||||
o += f" if (this->{self.field_name}_len > {self.array_size}) {{\n"
|
)
|
||||||
o += f" this->{self.field_name}_len = {self.array_size};\n"
|
|
||||||
o += " }\n"
|
|
||||||
o += f" memcpy(this->{self.field_name}, data_str.data(), this->{self.field_name}_len);\n"
|
|
||||||
o += " break;\n"
|
|
||||||
o += "}"
|
|
||||||
return o
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
@@ -1421,9 +1439,13 @@ class FixedArrayBytesType(TypeInfo):
|
|||||||
f"this->{self.field_name}", f"this->{self.field_name}_len", max_len=max_len
|
f"this->{self.field_name}", f"this->{self.field_name}_len", max_len=max_len
|
||||||
):
|
):
|
||||||
return result
|
return result
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}, this->{self.field_name}_len, true);"
|
"encode_bytes",
|
||||||
return f"ProtoEncode::encode_bytes(pos, {self.number}, this->{self.field_name}, this->{self.field_name}_len);"
|
str(self.number),
|
||||||
|
f"this->{self.field_name}",
|
||||||
|
f"this->{self.field_name}_len",
|
||||||
|
force=self.force,
|
||||||
|
)
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
return f"out.append(format_hex_pretty({name}, {name}_len));"
|
return f"out.append(format_hex_pretty({name}, {name}_len));"
|
||||||
@@ -1471,7 +1493,7 @@ class UInt32Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "uint32_t"
|
cpp_type = "uint32_t"
|
||||||
_varint_max_bits = 32
|
_varint_max_bits = 32
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "value"
|
decode_expr = "value.as_varint()"
|
||||||
encode_func = "encode_uint32"
|
encode_func = "encode_uint32"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -1494,13 +1516,21 @@ class UInt32Type(VarintTypeMixin, TypeInfo):
|
|||||||
class EnumType(VarintTypeMixin, TypeInfo):
|
class EnumType(VarintTypeMixin, TypeInfo):
|
||||||
_varint_max_bits = 32
|
_varint_max_bits = 32
|
||||||
|
|
||||||
|
def encode_element(self, number: int, element: str) -> str:
|
||||||
|
return _encode_call(
|
||||||
|
self.encode_func,
|
||||||
|
str(number),
|
||||||
|
f"static_cast<uint32_t>({element})",
|
||||||
|
force=True,
|
||||||
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def cpp_type(self) -> str:
|
def cpp_type(self) -> str:
|
||||||
return f"enums::{self._field.type_name[1:]}"
|
return f"enums::{self._field.type_name[1:]}"
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_varint(self) -> str:
|
def decode_expr(self) -> str:
|
||||||
return f"static_cast<{self.cpp_type}>(value)"
|
return f"static_cast<{self.cpp_type}>(value.as_varint())"
|
||||||
|
|
||||||
default_value = ""
|
default_value = ""
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
@@ -1520,9 +1550,9 @@ class EnumType(VarintTypeMixin, TypeInfo):
|
|||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
value_expr = f"static_cast<uint32_t>(this->{self.field_name})"
|
value_expr = f"static_cast<uint32_t>(this->{self.field_name})"
|
||||||
if self.force:
|
return _encode_call(
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, {value_expr}, true);"
|
self.encode_func, str(self.number), value_expr, force=self.force
|
||||||
return f"ProtoEncode::{self.encode_func}(pos, {self.number}, {value_expr});"
|
)
|
||||||
|
|
||||||
def dump(self, name: str) -> str:
|
def dump(self, name: str) -> str:
|
||||||
return f"out.append_p(proto_enum_to_string<{self.cpp_type}>({name}));"
|
return f"out.append_p(proto_enum_to_string<{self.cpp_type}>({name}));"
|
||||||
@@ -1547,7 +1577,7 @@ class EnumType(VarintTypeMixin, TypeInfo):
|
|||||||
class SFixed32Type(FixedSizeTypeMixin, TypeInfo):
|
class SFixed32Type(FixedSizeTypeMixin, TypeInfo):
|
||||||
cpp_type = "int32_t"
|
cpp_type = "int32_t"
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_32bit = "value.as_sfixed32()"
|
decode_expr = "value.as_sfixed32()"
|
||||||
encode_func = "encode_sfixed32"
|
encode_func = "encode_sfixed32"
|
||||||
wire_type = WireType.FIXED32 # Uses wire type 5
|
wire_type = WireType.FIXED32 # Uses wire type 5
|
||||||
|
|
||||||
@@ -1573,7 +1603,6 @@ class SFixed32Type(FixedSizeTypeMixin, TypeInfo):
|
|||||||
class SFixed64Type(FixedSizeTypeMixin, TypeInfo):
|
class SFixed64Type(FixedSizeTypeMixin, TypeInfo):
|
||||||
cpp_type = "int64_t"
|
cpp_type = "int64_t"
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_64bit = "value.as_sfixed64()"
|
|
||||||
encode_func = "encode_sfixed64"
|
encode_func = "encode_sfixed64"
|
||||||
wire_type = WireType.FIXED64 # Uses wire type 1
|
wire_type = WireType.FIXED64 # Uses wire type 1
|
||||||
|
|
||||||
@@ -1600,7 +1629,7 @@ class SInt32Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "int32_t"
|
cpp_type = "int32_t"
|
||||||
_varint_max_bits = 32 # zigzag encoding keeps it 32-bit
|
_varint_max_bits = 32 # zigzag encoding keeps it 32-bit
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "decode_zigzag32(static_cast<uint32_t>(value))"
|
decode_expr = "decode_zigzag32(static_cast<uint32_t>(value.as_varint()))"
|
||||||
encode_func = "encode_sint32"
|
encode_func = "encode_sint32"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -1621,7 +1650,7 @@ class SInt64Type(VarintTypeMixin, TypeInfo):
|
|||||||
cpp_type = "int64_t"
|
cpp_type = "int64_t"
|
||||||
_varint_max_bits = 64
|
_varint_max_bits = 64
|
||||||
default_value = "0"
|
default_value = "0"
|
||||||
decode_varint = "decode_zigzag64(value)"
|
decode_expr = "decode_zigzag64(value.as_varint())"
|
||||||
encode_func = "encode_sint64"
|
encode_func = "encode_sint64"
|
||||||
wire_type = WireType.VARINT # Uses wire type 0
|
wire_type = WireType.VARINT # Uses wire type 0
|
||||||
|
|
||||||
@@ -1701,9 +1730,9 @@ def _generate_inline_encode_block(
|
|||||||
|
|
||||||
lines = []
|
lines = []
|
||||||
lines.append(f"auto &sub_msg = {element};")
|
lines.append(f"auto &sub_msg = {element};")
|
||||||
lines.append(f"ProtoEncode::write_raw_byte(pos, {tag});")
|
lines.append(_encode_call("write_raw_byte", str(tag)))
|
||||||
lines.append("uint8_t *len_pos = pos;")
|
lines.append("uint8_t *len_pos = pos;")
|
||||||
lines.append("ProtoEncode::reserve_byte(pos);")
|
lines.append(_encode_call("reserve_byte"))
|
||||||
|
|
||||||
# Generate inline field encoding for each sub-message field
|
# Generate inline field encoding for each sub-message field
|
||||||
for field in sub_desc.field:
|
for field in sub_desc.field:
|
||||||
@@ -1774,18 +1803,11 @@ class FixedArrayRepeatedType(TypeInfo):
|
|||||||
|
|
||||||
def _encode_element(self, element: str) -> str:
|
def _encode_element(self, element: str) -> str:
|
||||||
"""Helper to generate encode statement for a single element."""
|
"""Helper to generate encode statement for a single element."""
|
||||||
if isinstance(self._ti, EnumType):
|
if isinstance(self._ti, MessageType) and _is_inline_encode(self._ti.cpp_type):
|
||||||
return f"ProtoEncode::{self._ti.encode_func}(pos, {self.number}, static_cast<uint32_t>({element}), true);"
|
return _generate_inline_encode_block(
|
||||||
# Repeated message elements use encode_sub_message (force=true is default)
|
self.number, self._ti.cpp_type, element
|
||||||
if isinstance(self._ti, MessageType):
|
)
|
||||||
if _is_inline_encode(self._ti.cpp_type):
|
return self._ti.encode_element(self.number, element)
|
||||||
return _generate_inline_encode_block(
|
|
||||||
self.number, self._ti.cpp_type, element
|
|
||||||
)
|
|
||||||
return f"ProtoEncode::encode_sub_message(pos, buffer, {self.number}, {element});"
|
|
||||||
return (
|
|
||||||
f"ProtoEncode::{self._ti.encode_func}(pos, {self.number}, {element}, true);"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def cpp_type(self) -> str:
|
def cpp_type(self) -> str:
|
||||||
@@ -2079,55 +2101,23 @@ class RepeatedTypeInfo(TypeInfo):
|
|||||||
return self._ti.wire_type
|
return self._ti.wire_type
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_varint_content(self) -> str:
|
def decode_expr(self) -> str | None:
|
||||||
# Pointer fields don't support decoding
|
return self._ti.decode_expr
|
||||||
if self._use_pointer:
|
|
||||||
return None
|
def _decode_store(self, expr: str) -> str:
|
||||||
content = self._ti.decode_varint
|
return f"this->{self.field_name}.push_back({expr});"
|
||||||
if content is None:
|
|
||||||
return None
|
|
||||||
return (
|
|
||||||
f"case {self.number}: this->{self.field_name}.push_back({content}); break;"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def decode_length_content(self) -> str:
|
def decode_content(self) -> str | None:
|
||||||
# Pointer fields don't support decoding
|
# Pointer fields don't support decoding
|
||||||
if self._use_pointer:
|
if self._use_pointer:
|
||||||
return None
|
return None
|
||||||
content = self._ti.decode_length
|
if isinstance(self._ti, MessageType):
|
||||||
if content is None and isinstance(self._ti, MessageType):
|
return self.decode_case(
|
||||||
# Special handling for non-template message decoding
|
f"this->{self.field_name}.emplace_back();\n"
|
||||||
return f"case {self.number}: this->{self.field_name}.emplace_back(); value.decode_to_message(this->{self.field_name}.back()); break;"
|
f"value.decode_to_message(this->{self.field_name}.back());"
|
||||||
if content is None:
|
)
|
||||||
return None
|
return super().decode_content
|
||||||
return (
|
|
||||||
f"case {self.number}: this->{self.field_name}.push_back({content}); break;"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def decode_32bit_content(self) -> str:
|
|
||||||
# Pointer fields don't support decoding
|
|
||||||
if self._use_pointer:
|
|
||||||
return None
|
|
||||||
content = self._ti.decode_32bit
|
|
||||||
if content is None:
|
|
||||||
return None
|
|
||||||
return (
|
|
||||||
f"case {self.number}: this->{self.field_name}.push_back({content}); break;"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
|
||||||
def decode_64bit_content(self) -> str:
|
|
||||||
# Pointer fields don't support decoding
|
|
||||||
if self._use_pointer:
|
|
||||||
return None
|
|
||||||
content = self._ti.decode_64bit
|
|
||||||
if content is None:
|
|
||||||
return None
|
|
||||||
return (
|
|
||||||
f"case {self.number}: this->{self.field_name}.push_back({content}); break;"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def _ti_is_bool(self) -> bool:
|
def _ti_is_bool(self) -> bool:
|
||||||
@@ -2135,15 +2125,7 @@ class RepeatedTypeInfo(TypeInfo):
|
|||||||
return isinstance(self._ti, BoolType)
|
return isinstance(self._ti, BoolType)
|
||||||
|
|
||||||
def _encode_element_call(self, element: str) -> str:
|
def _encode_element_call(self, element: str) -> str:
|
||||||
"""Helper to generate encode call for a single element."""
|
return self._ti.encode_element(self.number, element)
|
||||||
if isinstance(self._ti, EnumType):
|
|
||||||
return f"ProtoEncode::{self._ti.encode_func}(pos, {self.number}, static_cast<uint32_t>({element}), true);"
|
|
||||||
# Repeated message elements use encode_sub_message (force=true is default)
|
|
||||||
if isinstance(self._ti, MessageType):
|
|
||||||
return f"ProtoEncode::encode_sub_message(pos, buffer, {self.number}, {element});"
|
|
||||||
return (
|
|
||||||
f"ProtoEncode::{self._ti.encode_func}(pos, {self.number}, {element}, true);"
|
|
||||||
)
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def encode_content(self) -> str:
|
def encode_content(self) -> str:
|
||||||
@@ -2152,7 +2134,7 @@ class RepeatedTypeInfo(TypeInfo):
|
|||||||
# Special handling for const char* elements (when container_no_template contains "const char")
|
# Special handling for const char* elements (when container_no_template contains "const char")
|
||||||
if "const char" in self._container_no_template:
|
if "const char" in self._container_no_template:
|
||||||
o = f"for (const char *it : *this->{self.field_name}) {{\n"
|
o = f"for (const char *it : *this->{self.field_name}) {{\n"
|
||||||
o += f" ProtoEncode::{self._ti.encode_func}(pos, {self.number}, it, strlen(it), true);\n"
|
o += f" {_encode_call(self._ti.encode_func, str(self.number), 'it', 'strlen(it)', force=True)}\n"
|
||||||
else:
|
else:
|
||||||
o = f"for (const auto &it : *this->{self.field_name}) {{\n"
|
o = f"for (const auto &it : *this->{self.field_name}) {{\n"
|
||||||
o += f" {self._encode_element_call('it')}\n"
|
o += f" {self._encode_element_call('it')}\n"
|
||||||
@@ -2538,10 +2520,7 @@ def build_message_type(
|
|||||||
) -> tuple[str, str, str]:
|
) -> tuple[str, str, str]:
|
||||||
public_content: list[str] = []
|
public_content: list[str] = []
|
||||||
protected_content: list[str] = []
|
protected_content: list[str] = []
|
||||||
decode_varint: list[str] = []
|
decode: list[str] = []
|
||||||
decode_length: list[str] = []
|
|
||||||
decode_32bit: list[str] = []
|
|
||||||
decode_64bit: list[str] = []
|
|
||||||
encode: list[str] = []
|
encode: list[str] = []
|
||||||
dump: list[str] = []
|
dump: list[str] = []
|
||||||
size_calc: list[str] = []
|
size_calc: list[str] = []
|
||||||
@@ -2557,8 +2536,8 @@ def build_message_type(
|
|||||||
|
|
||||||
# Get source direction to determine if we need decode/encode methods
|
# Get source direction to determine if we need decode/encode methods
|
||||||
source = message_source_map[desc.name]
|
source = message_source_map[desc.name]
|
||||||
needs_decode = source in (SOURCE_BOTH, SOURCE_CLIENT)
|
needs_decode = message_needs_decode(source)
|
||||||
needs_encode = source in (SOURCE_BOTH, SOURCE_SERVER)
|
needs_encode = message_needs_encode(source)
|
||||||
|
|
||||||
# Add MESSAGE_TYPE method if this is a service message
|
# Add MESSAGE_TYPE method if this is a service message
|
||||||
if message_id is not None:
|
if message_id is not None:
|
||||||
@@ -2670,22 +2649,8 @@ def build_message_type(
|
|||||||
if field.options.HasExtension(pb.field_ifdef):
|
if field.options.HasExtension(pb.field_ifdef):
|
||||||
field_ifdef = field.options.Extensions[pb.field_ifdef]
|
field_ifdef = field.options.Extensions[pb.field_ifdef]
|
||||||
|
|
||||||
if ti.decode_varint_content:
|
if case := ti.decode_content:
|
||||||
decode_varint.extend(
|
decode.extend(wrap_with_ifdef(case, field_ifdef))
|
||||||
wrap_with_ifdef(ti.decode_varint_content, field_ifdef)
|
|
||||||
)
|
|
||||||
if ti.decode_length_content:
|
|
||||||
decode_length.extend(
|
|
||||||
wrap_with_ifdef(ti.decode_length_content, field_ifdef)
|
|
||||||
)
|
|
||||||
if ti.decode_32bit_content:
|
|
||||||
decode_32bit.extend(
|
|
||||||
wrap_with_ifdef(ti.decode_32bit_content, field_ifdef)
|
|
||||||
)
|
|
||||||
if ti.decode_64bit_content:
|
|
||||||
decode_64bit.extend(
|
|
||||||
wrap_with_ifdef(ti.decode_64bit_content, field_ifdef)
|
|
||||||
)
|
|
||||||
if ti.dump_content:
|
if ti.dump_content:
|
||||||
# Check for field_ifdef option for dump as well
|
# Check for field_ifdef option for dump as well
|
||||||
field_ifdef = None
|
field_ifdef = None
|
||||||
@@ -2695,50 +2660,23 @@ def build_message_type(
|
|||||||
dump.extend(wrap_with_ifdef(ti.dump_content, field_ifdef))
|
dump.extend(wrap_with_ifdef(ti.dump_content, field_ifdef))
|
||||||
|
|
||||||
cpp = ""
|
cpp = ""
|
||||||
if decode_varint:
|
if decode:
|
||||||
o = f"bool {desc.name}::decode_varint(uint32_t field_id, proto_varint_value_t value) {{\n"
|
o = f"void {desc.name}::decode_field(void *self, uint32_t tag, const uint8_t *data, proto_varint_value_t scalar) {{\n"
|
||||||
o += " switch (field_id) {\n"
|
o += f" auto &msg = *static_cast<{desc.name} *>(self);\n"
|
||||||
o += indent("\n".join(decode_varint), " ") + "\n"
|
o += " const ProtoFieldValue value(data, scalar);\n"
|
||||||
o += " default: return false;\n"
|
o += " switch (tag) {\n"
|
||||||
|
o += indent("\n".join(decode), " ").replace("this->", "msg.") + "\n"
|
||||||
o += " }\n"
|
o += " }\n"
|
||||||
o += " return true;\n"
|
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
prot = "bool decode_varint(uint32_t field_id, proto_varint_value_t value) override;"
|
prot = "static void decode_field(void *self, uint32_t tag, const uint8_t *data, proto_varint_value_t scalar);"
|
||||||
protected_content.insert(0, prot)
|
|
||||||
if decode_length:
|
|
||||||
o = f"bool {desc.name}::decode_length(uint32_t field_id, ProtoLengthDelimited value) {{\n"
|
|
||||||
o += " switch (field_id) {\n"
|
|
||||||
o += indent("\n".join(decode_length), " ") + "\n"
|
|
||||||
o += " default: return false;\n"
|
|
||||||
o += " }\n"
|
|
||||||
o += " return true;\n"
|
|
||||||
o += "}\n"
|
|
||||||
cpp += o
|
|
||||||
prot = "bool decode_length(uint32_t field_id, ProtoLengthDelimited value) override;"
|
|
||||||
protected_content.insert(0, prot)
|
|
||||||
if decode_32bit:
|
|
||||||
o = f"bool {desc.name}::decode_32bit(uint32_t field_id, Proto32Bit value) {{\n"
|
|
||||||
o += " switch (field_id) {\n"
|
|
||||||
o += indent("\n".join(decode_32bit), " ") + "\n"
|
|
||||||
o += " default: return false;\n"
|
|
||||||
o += " }\n"
|
|
||||||
o += " return true;\n"
|
|
||||||
o += "}\n"
|
|
||||||
cpp += o
|
|
||||||
prot = "bool decode_32bit(uint32_t field_id, Proto32Bit value) override;"
|
|
||||||
protected_content.insert(0, prot)
|
|
||||||
if decode_64bit:
|
|
||||||
o = f"bool {desc.name}::decode_64bit(uint32_t field_id, Proto64Bit value) {{\n"
|
|
||||||
o += " switch (field_id) {\n"
|
|
||||||
o += indent("\n".join(decode_64bit), " ") + "\n"
|
|
||||||
o += " default: return false;\n"
|
|
||||||
o += " }\n"
|
|
||||||
o += " return true;\n"
|
|
||||||
o += "}\n"
|
|
||||||
cpp += o
|
|
||||||
prot = "bool decode_64bit(uint32_t field_id, Proto64Bit value) override;"
|
|
||||||
protected_content.insert(0, prot)
|
protected_content.insert(0, prot)
|
||||||
|
if not fixed_vector_fields:
|
||||||
|
public_content.append(
|
||||||
|
"void decode(const uint8_t *buffer, size_t length) {\n"
|
||||||
|
" ProtoDecodableMessage::decode_fields(this, buffer, length, &decode_field);\n"
|
||||||
|
"}"
|
||||||
|
)
|
||||||
|
|
||||||
# Generate custom decode() override for messages with FixedVector fields
|
# Generate custom decode() override for messages with FixedVector fields
|
||||||
if fixed_vector_fields:
|
if fixed_vector_fields:
|
||||||
@@ -2748,8 +2686,8 @@ def build_message_type(
|
|||||||
for field_name, field_number in fixed_vector_fields:
|
for field_name, field_number in fixed_vector_fields:
|
||||||
o += f" uint32_t count_{field_name} = ProtoDecodableMessage::count_repeated_field(buffer, length, {field_number});\n"
|
o += f" uint32_t count_{field_name} = ProtoDecodableMessage::count_repeated_field(buffer, length, {field_number});\n"
|
||||||
o += f" this->{field_name}.init(count_{field_name});\n"
|
o += f" this->{field_name}.init(count_{field_name});\n"
|
||||||
# Call parent decode to populate the fields
|
# Then the shared loop fills them
|
||||||
o += " ProtoDecodableMessage::decode(buffer, length);\n"
|
o += " ProtoDecodableMessage::decode_fields(this, buffer, length, &decode_field);\n"
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
# Generate the decode() declaration in header (public method)
|
# Generate the decode() declaration in header (public method)
|
||||||
@@ -2784,28 +2722,36 @@ def build_message_type(
|
|||||||
)
|
)
|
||||||
for line in encode
|
for line in encode
|
||||||
]
|
]
|
||||||
o = f"{speed_attr}uint8_t *{desc.name}::encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const {{\n"
|
o = f"{speed_attr}uint8_t *{desc.name}::encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) {{\n"
|
||||||
|
o += f" const auto &msg = *static_cast<const {desc.name} *>(self);\n"
|
||||||
o += " uint8_t *__restrict__ pos = buffer.get_pos();\n"
|
o += " uint8_t *__restrict__ pos = buffer.get_pos();\n"
|
||||||
o += indent("\n".join(encode_debug)) + "\n"
|
o += indent("\n".join(encode_debug)).replace("this->", "msg.") + "\n"
|
||||||
o += " return pos;\n"
|
o += " return pos;\n"
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
prot = (
|
public_content.append(
|
||||||
"uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const;"
|
"static uint8_t *encode_msg(const void *self, ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM);"
|
||||||
|
)
|
||||||
|
public_content.append(
|
||||||
|
"uint8_t *encode(ProtoWriteBuffer &buffer PROTO_ENCODE_DEBUG_PARAM) const {\n"
|
||||||
|
" return encode_msg(this, buffer PROTO_ENCODE_DEBUG_ARG);\n"
|
||||||
|
"}"
|
||||||
)
|
)
|
||||||
public_content.append(prot)
|
|
||||||
# If no fields to encode or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
# If no fields to encode or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
||||||
|
|
||||||
# Add calculate_size method only if this message needs encoding and has fields
|
# Add calculate_size method only if this message needs encoding and has fields
|
||||||
if needs_encode and size_calc and not is_inline_only:
|
if needs_encode and size_calc and not is_inline_only:
|
||||||
o = f"{speed_attr}uint32_t {desc.name}::calculate_size() const {{\n"
|
o = f"{speed_attr}uint32_t {desc.name}::calc_size_msg(const void *self) {{\n"
|
||||||
|
o += f" const auto &msg = *static_cast<const {desc.name} *>(self);\n"
|
||||||
o += " uint32_t size = 0;\n"
|
o += " uint32_t size = 0;\n"
|
||||||
o += indent("\n".join(size_calc)) + "\n"
|
o += indent("\n".join(size_calc)).replace("this->", "msg.") + "\n"
|
||||||
o += " return size;\n"
|
o += " return size;\n"
|
||||||
o += "}\n"
|
o += "}\n"
|
||||||
cpp += o
|
cpp += o
|
||||||
prot = "uint32_t calculate_size() const;"
|
public_content.append("static uint32_t calc_size_msg(const void *self);")
|
||||||
public_content.append(prot)
|
public_content.append(
|
||||||
|
"uint32_t calculate_size() const { return calc_size_msg(this); }"
|
||||||
|
)
|
||||||
# If no fields to calculate size for or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
# If no fields to calculate size for or message doesn't need encoding, the default implementation in ProtoMessage will be used
|
||||||
|
|
||||||
# dump_to method declaration in header
|
# dump_to method declaration in header
|
||||||
@@ -2900,6 +2846,23 @@ def get_field_opt(
|
|||||||
return field.options.Extensions[opt]
|
return field.options.Extensions[opt]
|
||||||
|
|
||||||
|
|
||||||
|
def message_needs_decode(source: int) -> bool:
|
||||||
|
return source in (SOURCE_BOTH, SOURCE_CLIENT)
|
||||||
|
|
||||||
|
|
||||||
|
def message_needs_encode(source: int) -> bool:
|
||||||
|
return source in (SOURCE_BOTH, SOURCE_SERVER)
|
||||||
|
|
||||||
|
|
||||||
|
def is_decodable_class(desc: descriptor.DescriptorProto, source: int) -> bool:
|
||||||
|
"""Whether the generated class derives from ProtoDecodableMessage: decoded, and either on a
|
||||||
|
decodable base class or with at least one live field."""
|
||||||
|
return message_needs_decode(source) and (
|
||||||
|
get_base_class(desc) is not None
|
||||||
|
or any(not field.options.deprecated for field in desc.field)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def get_base_class(desc: descriptor.DescriptorProto) -> str | None:
|
def get_base_class(desc: descriptor.DescriptorProto) -> str | None:
|
||||||
"""Get the base_class option from a message descriptor."""
|
"""Get the base_class option from a message descriptor."""
|
||||||
if not desc.options.HasExtension(pb.base_class):
|
if not desc.options.HasExtension(pb.base_class):
|
||||||
@@ -3001,11 +2964,11 @@ def build_base_class(
|
|||||||
|
|
||||||
# Determine if any message using this base class needs decoding/encoding
|
# Determine if any message using this base class needs decoding/encoding
|
||||||
needs_decode = any(
|
needs_decode = any(
|
||||||
message_source_map.get(msg.name, SOURCE_BOTH) in (SOURCE_BOTH, SOURCE_CLIENT)
|
message_needs_decode(message_source_map.get(msg.name, SOURCE_BOTH))
|
||||||
for msg in messages
|
for msg in messages
|
||||||
)
|
)
|
||||||
needs_encode = any(
|
needs_encode = any(
|
||||||
message_source_map.get(msg.name, SOURCE_BOTH) in (SOURCE_BOTH, SOURCE_SERVER)
|
message_needs_encode(message_source_map.get(msg.name, SOURCE_BOTH))
|
||||||
for msg in messages
|
for msg in messages
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -3439,6 +3402,7 @@ static void dump_bytes_field(DumpBuffer &out, const char *field_name, const uint
|
|||||||
|
|
||||||
# Generate message types with base class information
|
# Generate message types with base class information
|
||||||
# Simple grouping by ifdef
|
# Simple grouping by ifdef
|
||||||
|
decodable_messages: list[tuple[str, str | None]] = []
|
||||||
current_ifdef = None
|
current_ifdef = None
|
||||||
|
|
||||||
for m in mt:
|
for m in mt:
|
||||||
@@ -3455,6 +3419,8 @@ static void dump_bytes_field(DumpBuffer &out, const char *field_name, const uint
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
s, c, dc = build_message_type(m, base_class_fields, message_source_map)
|
s, c, dc = build_message_type(m, base_class_fields, message_source_map)
|
||||||
|
if is_decodable_class(m, message_source_map[m.name]):
|
||||||
|
decodable_messages.append((m.name, message_ifdef_map.get(m.name)))
|
||||||
msg_ifdef = message_ifdef_map.get(m.name)
|
msg_ifdef = message_ifdef_map.get(m.name)
|
||||||
|
|
||||||
# Handle ifdef changes
|
# Handle ifdef changes
|
||||||
@@ -3481,6 +3447,22 @@ static void dump_bytes_field(DumpBuffer &out, const char *field_name, const uint
|
|||||||
cpp += "#endif\n"
|
cpp += "#endif\n"
|
||||||
dump_cpp += "#endif\n"
|
dump_cpp += "#endif\n"
|
||||||
|
|
||||||
|
# decode() passes decode_field explicitly, so without the dump virtuals no decodable message
|
||||||
|
# may carry a vtable; a build at any level below VERY_VERBOSE proves it
|
||||||
|
cpp += "#ifndef HAS_PROTO_MESSAGE_DUMP\n"
|
||||||
|
assert_ifdef = None
|
||||||
|
for name, msg_ifdef in decodable_messages:
|
||||||
|
if msg_ifdef != assert_ifdef:
|
||||||
|
if assert_ifdef is not None:
|
||||||
|
cpp += "#endif\n"
|
||||||
|
if msg_ifdef is not None:
|
||||||
|
cpp += _make_ifdef_line(msg_ifdef) + "\n"
|
||||||
|
assert_ifdef = msg_ifdef
|
||||||
|
cpp += f'static_assert(!std::is_polymorphic_v<{name}>, "decodable messages carry no vtable");\n'
|
||||||
|
if assert_ifdef is not None:
|
||||||
|
cpp += "#endif\n"
|
||||||
|
cpp += "#endif\n"
|
||||||
|
|
||||||
content += """\
|
content += """\
|
||||||
|
|
||||||
} // namespace esphome::api
|
} // namespace esphome::api
|
||||||
|
|||||||
@@ -14,31 +14,7 @@ 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.
|
||||||
env -u VIRTUAL_ENV "$top/script/setup"
|
exec 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,10 +1104,6 @@ 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
|
||||||
@@ -1127,19 +1123,6 @@ 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()}
|
||||||
|
|
||||||
|
|||||||
@@ -1,164 +0,0 @@
|
|||||||
#!/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())
|
|
||||||
@@ -249,7 +249,7 @@ static APIBuffer build_infrared_rf_transmit_wire() {
|
|||||||
std::memcpy(bytes + len, packed, packed_len);
|
std::memcpy(bytes + len, packed, packed_len);
|
||||||
len += packed_len;
|
len += packed_len;
|
||||||
// field 6: modulation = 1 (non-zero so it's actually emitted and exercises
|
// field 6: modulation = 1 (non-zero so it's actually emitted and exercises
|
||||||
// decode_varint for this field, matching the documented layout above).
|
// decode_field for this field, matching the documented layout above).
|
||||||
put_byte(0x30);
|
put_byte(0x30);
|
||||||
put_varint(1);
|
put_varint(1);
|
||||||
|
|
||||||
|
|||||||
@@ -1,148 +0,0 @@
|
|||||||
"""Tests for the api outgoing_connection option."""
|
|
||||||
|
|
||||||
from collections.abc import Callable
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from esphome.components import socket
|
|
||||||
from esphome.components.api import (
|
|
||||||
CONFIG_SCHEMA,
|
|
||||||
_validate_outgoing_host_ipv6,
|
|
||||||
_validate_outgoing_socket_implementation,
|
|
||||||
)
|
|
||||||
from esphome.components.esp32 import KEY_BOARD, KEY_VARIANT, VARIANT_ESP32
|
|
||||||
import esphome.config_validation as cv
|
|
||||||
from esphome.const import PlatformFramework
|
|
||||||
from esphome.core import CORE
|
|
||||||
import esphome.final_validate as fv
|
|
||||||
from esphome.types import ConfigType
|
|
||||||
from tests.component_tests.types import SetCoreConfigCallable
|
|
||||||
|
|
||||||
KEY = "bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU="
|
|
||||||
ESP32_PLATFORM_DATA = {KEY_BOARD: "esp32dev", KEY_VARIANT: VARIANT_ESP32}
|
|
||||||
|
|
||||||
|
|
||||||
def _api_config(outgoing: ConfigType, *, encryption: bool = True) -> ConfigType:
|
|
||||||
config: ConfigType = {"outgoing_connection": outgoing}
|
|
||||||
if encryption:
|
|
||||||
config["encryption"] = {"key": KEY}
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_generates_defines(
|
|
||||||
generate_main: Callable[[str | Path], str],
|
|
||||||
) -> None:
|
|
||||||
"""A valid config emits the compile-time defines with defaults applied."""
|
|
||||||
generate_main("tests/component_tests/api/test_outgoing_connection.yaml")
|
|
||||||
|
|
||||||
defines = {define.name: define.value for define in CORE.defines}
|
|
||||||
assert "USE_API_OUTGOING_CONNECTION" in defines
|
|
||||||
assert str(defines["API_OUTGOING_CONNECTION_HOST"]) == '"192.168.1.2"'
|
|
||||||
assert str(defines["API_OUTGOING_CONNECTION_PORT"]) == "6054"
|
|
||||||
assert str(defines["API_OUTGOING_CONNECTION_DELAY"]) == "60000"
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_defaults(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
config = CONFIG_SCHEMA(_api_config({"host": "192.168.1.2"}))
|
|
||||||
outgoing = config["outgoing_connection"]
|
|
||||||
assert outgoing["port"] == 6054
|
|
||||||
assert outgoing["delay"].total_milliseconds == 60000
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_bare_block(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
"""A bare outgoing_connection: block is valid; the device dials the
|
|
||||||
remembered last dial-back client."""
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
config = CONFIG_SCHEMA(_api_config(None))
|
|
||||||
outgoing = config["outgoing_connection"]
|
|
||||||
assert "host" not in outgoing
|
|
||||||
assert outgoing["port"] == 6054
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_delay_bounded(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
"""A delay past half the uint32 millisecond range is rejected, not wrapped."""
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
with pytest.raises(cv.Invalid, match="value must be at most"):
|
|
||||||
CONFIG_SCHEMA(_api_config({"delay": "60d"}))
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_requires_encryption(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
with pytest.raises(cv.Invalid, match="requires 'encryption'"):
|
|
||||||
CONFIG_SCHEMA(_api_config({"host": "192.168.1.2"}, encryption=False))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("platform_framework", "platform_data", "socket_conf"),
|
|
||||||
[
|
|
||||||
# The platform default on these two, resolved like AUTO_LOAD does
|
|
||||||
(PlatformFramework.ESP8266_ARDUINO, None, None),
|
|
||||||
(PlatformFramework.RP2040_ARDUINO, None, None),
|
|
||||||
# An explicit selection elsewhere
|
|
||||||
(
|
|
||||||
PlatformFramework.ESP32_IDF,
|
|
||||||
ESP32_PLATFORM_DATA,
|
|
||||||
{"implementation": "lwip_tcp"},
|
|
||||||
),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_outgoing_connection_rejects_lwip_tcp(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
platform_framework: PlatformFramework,
|
|
||||||
platform_data: ConfigType | None,
|
|
||||||
socket_conf: ConfigType | None,
|
|
||||||
) -> None:
|
|
||||||
"""The resolved lwip_tcp socket is rejected at final validate."""
|
|
||||||
set_core_config(platform_framework, platform_data=platform_data)
|
|
||||||
fv.full_config.set({"socket": socket_conf or socket.CONFIG_SCHEMA({})})
|
|
||||||
config = CONFIG_SCHEMA(_api_config({"host": "192.168.1.2"}))
|
|
||||||
with pytest.raises(cv.Invalid, match="lwip_tcp"):
|
|
||||||
_validate_outgoing_socket_implementation(config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_rejects_hostnames(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
with pytest.raises(cv.Invalid, match="not a valid IP address"):
|
|
||||||
CONFIG_SCHEMA(_api_config({"host": "homeassistant.local"}))
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_ipv6_host_requires_ipv6(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
set_core_config(PlatformFramework.ESP32_IDF, platform_data=ESP32_PLATFORM_DATA)
|
|
||||||
config = CONFIG_SCHEMA(_api_config({"host": "fd00::1"}))
|
|
||||||
with pytest.raises(cv.Invalid, match="IPv6 is not"):
|
|
||||||
_validate_outgoing_host_ipv6(config)
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_ipv6_host_passes_with_ipv6_enabled(
|
|
||||||
set_core_config: SetCoreConfigCallable,
|
|
||||||
) -> None:
|
|
||||||
set_core_config(
|
|
||||||
PlatformFramework.ESP32_IDF,
|
|
||||||
platform_data=ESP32_PLATFORM_DATA,
|
|
||||||
full_config={"network": {"enable_ipv6": True}},
|
|
||||||
)
|
|
||||||
config = CONFIG_SCHEMA(_api_config({"host": "fd00::1"}))
|
|
||||||
assert _validate_outgoing_host_ipv6(config) is config
|
|
||||||
|
|
||||||
|
|
||||||
def test_outgoing_connection_ipv6_host_with_ipv6(
|
|
||||||
generate_main: Callable[[str | Path], str],
|
|
||||||
) -> None:
|
|
||||||
generate_main("tests/component_tests/api/test_outgoing_connection_ipv6.yaml")
|
|
||||||
|
|
||||||
defines = {define.name: define.value for define in CORE.defines}
|
|
||||||
assert str(defines["API_OUTGOING_CONNECTION_HOST"]) == '"fd00::1"'
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: test
|
|
||||||
|
|
||||||
esp32:
|
|
||||||
board: esp32dev
|
|
||||||
|
|
||||||
wifi:
|
|
||||||
ssid: SomeNetwork
|
|
||||||
password: SomePassword
|
|
||||||
|
|
||||||
logger:
|
|
||||||
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
host: 192.168.1.2
|
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: test
|
|
||||||
|
|
||||||
esp32:
|
|
||||||
board: esp32dev
|
|
||||||
|
|
||||||
wifi:
|
|
||||||
ssid: SomeNetwork
|
|
||||||
password: SomePassword
|
|
||||||
|
|
||||||
network:
|
|
||||||
enable_ipv6: true
|
|
||||||
|
|
||||||
logger:
|
|
||||||
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
host: fd00::1
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
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"
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -1,32 +0,0 @@
|
|||||||
"""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()
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
packages:
|
|
||||||
common: !include common-base.yaml
|
|
||||||
|
|
||||||
wifi:
|
|
||||||
ssid: MySSID
|
|
||||||
password: password1
|
|
||||||
|
|
||||||
# Outgoing connection on the lwip_sockets implementation used by LibreTiny
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
host: 192.168.1.2
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
packages:
|
|
||||||
common: !include common-base.yaml
|
|
||||||
|
|
||||||
wifi:
|
|
||||||
ssid: MySSID
|
|
||||||
password: password1
|
|
||||||
|
|
||||||
# Outgoing connection: the device dials out when no dial-back client is
|
|
||||||
# connected. Requires encryption so the peer is verified by key.
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
host: 192.168.1.2
|
|
||||||
port: 6054
|
|
||||||
delay: 60s
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
packages:
|
|
||||||
common: !include common-base.yaml
|
|
||||||
|
|
||||||
network:
|
|
||||||
|
|
||||||
# No host set: the device dials the last remembered Home Assistant address
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
delay: 30s
|
|
||||||
@@ -59,7 +59,7 @@ static void verify_mac(uint64_t mac, size_t expected_bytes) {
|
|||||||
#ifdef ESPHOME_DEBUG_API
|
#ifdef ESPHOME_DEBUG_API
|
||||||
uint8_t *proto_debug_end_ = api_buf.data() + api_buf.size();
|
uint8_t *proto_debug_end_ = api_buf.data() + api_buf.size();
|
||||||
#endif
|
#endif
|
||||||
ProtoEncode::encode_varint_raw_48bit(pos PROTO_ENCODE_DEBUG_ARG, mac);
|
pos = ProtoEncode::encode_varint_raw_48bit(pos PROTO_ENCODE_DEBUG_ARG, mac);
|
||||||
size_t new_len = pos - api_buf.data();
|
size_t new_len = pos - api_buf.data();
|
||||||
|
|
||||||
EXPECT_EQ(new_len, expected_bytes) << "mac=0x" << std::hex << mac << std::dec;
|
EXPECT_EQ(new_len, expected_bytes) << "mac=0x" << std::hex << mac << std::dec;
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
from tests.testing_helpers import ComponentManifestOverride
|
|
||||||
|
|
||||||
|
|
||||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
|
||||||
manifest.dependencies = manifest.dependencies + ["sensor", "spi"]
|
|
||||||
@@ -1,62 +0,0 @@
|
|||||||
#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
|
|
||||||
@@ -59,4 +59,47 @@ TEST(StringRefStartsWith, RefOverloadComparesOnlyTheViewedLength) {
|
|||||||
EXPECT_TRUE(ref.starts_with(prefix));
|
EXPECT_TRUE(ref.starts_with(prefix));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The generated api messages start their encode only string fields as a null pointer with zero
|
||||||
|
// length; every member must treat that exactly like the default constructed empty string.
|
||||||
|
TEST(StringRefNullEmpty, BehavesAsEmptyString) {
|
||||||
|
const StringRef null_empty{nullptr, 0};
|
||||||
|
const StringRef empty;
|
||||||
|
EXPECT_TRUE(null_empty.empty());
|
||||||
|
EXPECT_EQ(null_empty.size(), 0u);
|
||||||
|
EXPECT_EQ(null_empty.c_str(), nullptr);
|
||||||
|
EXPECT_TRUE(null_empty == empty);
|
||||||
|
EXPECT_TRUE(null_empty == "");
|
||||||
|
EXPECT_TRUE(null_empty == std::string());
|
||||||
|
EXPECT_EQ(null_empty.compare(empty), 0);
|
||||||
|
EXPECT_EQ(null_empty.compare(""), 0);
|
||||||
|
EXPECT_LT(null_empty.compare("a"), 0);
|
||||||
|
EXPECT_TRUE(null_empty.starts_with(""));
|
||||||
|
EXPECT_FALSE(null_empty.starts_with("a"));
|
||||||
|
EXPECT_EQ(null_empty.str(), std::string());
|
||||||
|
EXPECT_EQ(null_empty.substr(0), std::string());
|
||||||
|
EXPECT_EQ(null_empty.find('a'), std::string::npos);
|
||||||
|
EXPECT_EQ(null_empty.find("a"), std::string::npos);
|
||||||
|
char buf[4] = "xyz";
|
||||||
|
EXPECT_EQ(null_empty.copy(buf, sizeof(buf)), 0u);
|
||||||
|
EXPECT_EQ(null_empty.begin(), null_empty.end());
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(StringRefNullEmpty, ComparesAgainstText) {
|
||||||
|
const StringRef null_empty{nullptr, 0};
|
||||||
|
const StringRef text("abc", 3);
|
||||||
|
EXPECT_FALSE(null_empty == text);
|
||||||
|
EXPECT_FALSE(text == null_empty);
|
||||||
|
EXPECT_LT(null_empty.compare(text), 0);
|
||||||
|
EXPECT_GT(text.compare(null_empty), 0);
|
||||||
|
EXPECT_TRUE(text.starts_with(null_empty));
|
||||||
|
}
|
||||||
|
|
||||||
|
TEST(StringRefNullEmpty, TwoNullViewsAreEqual) {
|
||||||
|
const StringRef a{nullptr, 0};
|
||||||
|
const StringRef b{nullptr, 0};
|
||||||
|
EXPECT_TRUE(a == b);
|
||||||
|
EXPECT_EQ(a.compare(b), 0);
|
||||||
|
EXPECT_TRUE(a.starts_with(b));
|
||||||
|
}
|
||||||
|
|
||||||
} // namespace esphome::core::testing
|
} // namespace esphome::core::testing
|
||||||
|
|||||||
@@ -1,29 +0,0 @@
|
|||||||
# 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
|
|
||||||
@@ -21,13 +21,6 @@ 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
|
||||||
|
|||||||
+81
-335
@@ -4,22 +4,17 @@ 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, suppress
|
from contextlib import AbstractAsyncContextManager, asynccontextmanager
|
||||||
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
|
||||||
@@ -28,13 +23,7 @@ import pytest_asyncio
|
|||||||
|
|
||||||
import esphome.config
|
import esphome.config
|
||||||
from esphome.core import CORE
|
from esphome.core import CORE
|
||||||
from esphome.helpers import (
|
from esphome.helpers import get_usable_cpu_count
|
||||||
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 (
|
||||||
@@ -67,21 +56,6 @@ 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()
|
||||||
@@ -104,7 +78,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(REPO_ROOT)
|
repo_root = str(Path(__file__).resolve().parent.parent.parent)
|
||||||
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
|
||||||
@@ -114,7 +88,8 @@ 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.
|
||||||
test_cache_dir = INTEGRATION_TESTS_ROOT
|
# CI caches parts of this path; keep in sync with ci.yml integration-tests.
|
||||||
|
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
|
||||||
@@ -137,9 +112,7 @@ 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(
|
config_path.write_text(fixture_path.read_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
|
||||||
@@ -189,6 +162,13 @@ 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."""
|
||||||
@@ -208,29 +188,21 @@ 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."""
|
||||||
shared_name = _shared_yaml_name(request)
|
# Get the test function name
|
||||||
# Base test name: test_ prefix and any parametrization stripped
|
test_name: str = request.node.name
|
||||||
base_name = shared_name or request.node.name.replace("test_", "").partition("[")[0]
|
# Extract the base test name (remove test_ prefix and any parametrization)
|
||||||
|
base_name = test_name.replace("test_", "").partition("[")[0]
|
||||||
|
|
||||||
# Load the fixture file
|
# Load the fixture file
|
||||||
fixture_path = FIXTURES_DIR / f"{base_name}.yaml"
|
fixture_path = Path(__file__).parent / "fixtures" / 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, read_file, fixture_path)
|
content = await loop.run_in_executor(None, fixture_path.read_text)
|
||||||
|
|
||||||
# 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:
|
||||||
@@ -254,13 +226,11 @@ 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(FIXTURES_DIR / "external_components")
|
external_components_path = str(
|
||||||
|
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
|
||||||
|
|
||||||
|
|
||||||
@@ -270,218 +240,24 @@ 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
|
||||||
base_name = request.node.name.replace("test_", "").partition("[")[0]
|
test_name = request.node.name
|
||||||
|
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, write_file, config_path, content)
|
await loop.run_in_executor(None, config_path.write_text, 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."""
|
||||||
|
|
||||||
@@ -489,96 +265,66 @@ 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()
|
||||||
|
|
||||||
name = _shared_yaml_name(request)
|
def _read_config_and_get_binary():
|
||||||
if name is None:
|
CORE.reset() # Reset CORE state between test runs
|
||||||
await _run_esphome_compile(config_path, integration_test_dir, env)
|
CORE.config_path = config_path
|
||||||
return await loop.run_in_executor(
|
config = esphome.config.read_config(
|
||||||
None, _resolve_compiled_binary, config_path
|
{"command": "compile", "config": str(config_path)}
|
||||||
)
|
)
|
||||||
|
if config is None:
|
||||||
|
raise RuntimeError(f"Failed to read config from {config_path}")
|
||||||
|
|
||||||
# Shared fixture: build in a hash-keyed dir so tests sharing a config
|
# Get the compiled binary path
|
||||||
# pay one full compile and later only a main.cpp (port) rebuild + relink
|
idedata = get_idedata(config)
|
||||||
shared_dir = _shared_build_dir(name)
|
return Path(idedata.firmware_elf_path)
|
||||||
shared_dir.mkdir(parents=True, exist_ok=True)
|
|
||||||
# Freshen the dir before locking so a concurrent age sweep, which
|
binary_path = await loop.run_in_executor(None, _read_config_and_get_binary)
|
||||||
# re-probes under the lock, never reaps a dir a worker just claimed;
|
|
||||||
# if a peer reaped it already, the guarded lock open recreates it
|
if not binary_path.exists():
|
||||||
with suppress(FileNotFoundError):
|
raise RuntimeError(f"Compiled binary not found at {binary_path}")
|
||||||
os.utime(shared_dir)
|
|
||||||
if shared_dir not in _pruned_dirs:
|
return binary_path
|
||||||
_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
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,43 @@
|
|||||||
|
esphome:
|
||||||
|
name: api-decode-wire-types-test
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: DEBUG
|
||||||
|
|
||||||
|
switch:
|
||||||
|
- platform: template
|
||||||
|
name: "Wire Switch"
|
||||||
|
optimistic: true
|
||||||
|
|
||||||
|
output:
|
||||||
|
- platform: template
|
||||||
|
id: wire_dim
|
||||||
|
type: float
|
||||||
|
write_action:
|
||||||
|
- lambda: ""
|
||||||
|
|
||||||
|
light:
|
||||||
|
- platform: monochromatic
|
||||||
|
name: "Wire Light"
|
||||||
|
output: wire_dim
|
||||||
|
default_transition_length: 0s
|
||||||
|
effects:
|
||||||
|
- pulse:
|
||||||
|
name: Pulse
|
||||||
|
|
||||||
|
text:
|
||||||
|
- platform: template
|
||||||
|
name: "Wire Text"
|
||||||
|
optimistic: true
|
||||||
|
mode: text
|
||||||
|
min_length: 0
|
||||||
|
max_length: 255
|
||||||
|
|
||||||
|
number:
|
||||||
|
- platform: template
|
||||||
|
name: "Wire Number"
|
||||||
|
optimistic: true
|
||||||
|
min_value: -1000
|
||||||
|
max_value: 1000
|
||||||
|
step: 0.5
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
esphome:
|
||||||
|
name: api-empty-message-test
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: DEBUG
|
||||||
|
|
||||||
|
switch:
|
||||||
|
- platform: template
|
||||||
|
name: "Empty Message Switch"
|
||||||
|
optimistic: true
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
esphome:
|
||||||
|
name: api-encode-boundaries-test
|
||||||
|
# Top-level area fills DeviceInfoResponse.suggested_area (field 16, a two-byte tag)
|
||||||
|
area:
|
||||||
|
id: kitchen_area
|
||||||
|
name: Kitchen
|
||||||
|
on_boot:
|
||||||
|
- sensor.template.publish:
|
||||||
|
id: zero_then_value
|
||||||
|
state: 0.0
|
||||||
|
|
||||||
|
host:
|
||||||
|
api:
|
||||||
|
logger:
|
||||||
|
level: DEBUG
|
||||||
|
|
||||||
|
sensor:
|
||||||
|
- platform: template
|
||||||
|
name: "Zero Then Value"
|
||||||
|
id: zero_then_value
|
||||||
|
# Negative int32 takes the ten byte varint path
|
||||||
|
accuracy_decimals: -2
|
||||||
|
update_interval: never
|
||||||
|
|
||||||
|
text_sensor:
|
||||||
|
- platform: template
|
||||||
|
name: "Long Text"
|
||||||
|
id: long_text
|
||||||
|
update_interval: never
|
||||||
|
|
||||||
|
number:
|
||||||
|
- platform: template
|
||||||
|
name: "Negative Number"
|
||||||
|
optimistic: true
|
||||||
|
min_value: -1000
|
||||||
|
max_value: 1000
|
||||||
|
step: 0.5
|
||||||
|
initial_value: -123.5
|
||||||
|
|
||||||
|
select:
|
||||||
|
- platform: template
|
||||||
|
name: "Long Option Select"
|
||||||
|
optimistic: true
|
||||||
|
options:
|
||||||
|
- short
|
||||||
|
- "option-with-a-name-long-enough-that-its-length-prefix-needs-two-varint-bytes-when-the-list-entities-response-is-encoded-xxxxxxxxxx"
|
||||||
|
initial_option: short
|
||||||
|
|
||||||
|
button:
|
||||||
|
- platform: template
|
||||||
|
name: "Publish Values"
|
||||||
|
on_press:
|
||||||
|
- sensor.template.publish:
|
||||||
|
id: zero_then_value
|
||||||
|
state: 12.5
|
||||||
|
- text_sensor.template.publish:
|
||||||
|
id: long_text
|
||||||
|
state: !lambda return std::string(200, 'y');
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: outgoing-conn-test
|
|
||||||
|
|
||||||
host:
|
|
||||||
|
|
||||||
logger:
|
|
||||||
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
host: 127.0.0.1
|
|
||||||
port: OUTGOING_PORT
|
|
||||||
delay: 1s
|
|
||||||
@@ -1,13 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: outgoing-conn-test
|
|
||||||
|
|
||||||
host:
|
|
||||||
|
|
||||||
logger:
|
|
||||||
|
|
||||||
api:
|
|
||||||
encryption:
|
|
||||||
key: bOFFzzvfpg5DB94DuBGLXD/hMnhpDKgP9UQyBulwWVU=
|
|
||||||
outgoing_connection:
|
|
||||||
port: OUTGOING_PORT
|
|
||||||
delay: 1s
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
esphome:
|
|
||||||
name: api-reboot-test
|
|
||||||
host:
|
|
||||||
api:
|
|
||||||
reboot_timeout: 2s # Headroom to connect and authenticate a client first
|
|
||||||
logger:
|
|
||||||
level: DEBUG
|
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
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));
|
||||||
|
}
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
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]);
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
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)
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
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.
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
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)
|
||||||
@@ -0,0 +1,97 @@
|
|||||||
|
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)
|
||||||
@@ -1,233 +0,0 @@
|
|||||||
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
|
|
||||||
@@ -0,0 +1,138 @@
|
|||||||
|
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)
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user