mirror of
https://github.com/esphome/esphome.git
synced 2026-11-16 10:06:00 +00:00
Compare commits
7
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f25821caba | ||
|
|
890c300125 | ||
|
|
a5bb8a0cbc | ||
|
|
ecd14a2ea7 | ||
|
|
a9bf6f9f10 | ||
|
|
1fbd657cbc | ||
|
|
0f1899e921 |
No files matched your search
@@ -146,7 +146,6 @@ esphome/components/cover/* @esphome/core
|
||||
esphome/components/cs5460a/* @balrog-kun
|
||||
esphome/components/cse7761/* @berfenger
|
||||
esphome/components/cst226/* @clydebarrow
|
||||
esphome/components/cst3240/* @tpruvot
|
||||
esphome/components/cst328/* @latonita
|
||||
esphome/components/cst816/* @clydebarrow
|
||||
esphome/components/cst9220/* @clydebarrow
|
||||
@@ -468,7 +467,6 @@ esphome/components/nfc/* @jesserockz @kbx81
|
||||
esphome/components/noblex/* @AGalfra
|
||||
esphome/components/noise/* @esphome/core
|
||||
esphome/components/npi19/* @bakerkj
|
||||
esphome/components/npm1300/* @tomaszduda23
|
||||
esphome/components/nrf52/* @tomaszduda23
|
||||
esphome/components/ns2009/* @tchilov
|
||||
esphome/components/ns2009/touchscreen/* @tchilov
|
||||
@@ -651,9 +649,7 @@ esphome/components/sun_gtil2/* @Mat931
|
||||
esphome/components/switch/* @esphome/core
|
||||
esphome/components/switch/binary_sensor/* @ssieb
|
||||
esphome/components/sx126x/* @swoboda1337
|
||||
esphome/components/sx126x/packet_interface/* @clydebarrow
|
||||
esphome/components/sx127x/* @swoboda1337
|
||||
esphome/components/sx127x/packet_interface/* @clydebarrow
|
||||
esphome/components/sy6970/* @linkedupbits
|
||||
esphome/components/syslog/* @clydebarrow
|
||||
esphome/components/systa_bus/* @Mat931
|
||||
@@ -665,8 +661,6 @@ esphome/components/tca8418/* @zebble
|
||||
esphome/components/tca9548a/* @andreashergert1984
|
||||
esphome/components/tca9555/* @mobrembski
|
||||
esphome/components/tcl112/* @glmnet
|
||||
esphome/components/tcp/* @clydebarrow
|
||||
esphome/components/tcp/packet_interface/* @clydebarrow
|
||||
esphome/components/tcp_uart/* @Bascht74
|
||||
esphome/components/tee501/* @Stock-M
|
||||
esphome/components/teleinfo/* @0hax @FredM67
|
||||
|
||||
@@ -278,9 +278,10 @@ APIError APINoiseFrameHelper::state_action_client_hello_() {
|
||||
state_ = State::FAILED;
|
||||
return APIError::OUT_OF_MEMORY;
|
||||
}
|
||||
uint8_t *payload = put_be16(dst, rx_size);
|
||||
dst[0] = (uint8_t) (rx_size >> 8);
|
||||
dst[1] = (uint8_t) rx_size;
|
||||
if (rx_size > 0) {
|
||||
std::memcpy(payload, this->rx_buf_.data(), rx_size);
|
||||
std::memcpy(dst + 2, this->rx_buf_.data(), rx_size);
|
||||
}
|
||||
|
||||
#ifdef USE_API_OUTGOING_CONNECTION
|
||||
@@ -463,8 +464,10 @@ APIError APINoiseFrameHelper::encrypt_noise_message_(uint8_t *buf_start, uint16_
|
||||
|
||||
// Write message header (to be encrypted)
|
||||
constexpr uint8_t msg_offset = noise::FRAME_HEADER_SIZE;
|
||||
put_be16(buf_start + msg_offset, message_type);
|
||||
put_be16(buf_start + msg_offset + 2, payload_size);
|
||||
buf_start[msg_offset] = static_cast<uint8_t>(message_type >> 8); // type high byte
|
||||
buf_start[msg_offset + 1] = static_cast<uint8_t>(message_type); // type low byte
|
||||
buf_start[msg_offset + 2] = static_cast<uint8_t>(payload_size >> 8); // data_len high byte
|
||||
buf_start[msg_offset + 3] = static_cast<uint8_t>(payload_size); // data_len low byte
|
||||
// payload data is already in the buffer starting at offset + 7
|
||||
|
||||
// Encrypt the message in place
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
#include "api_overflow_buffer.h"
|
||||
#ifdef USE_API
|
||||
#include <cstring>
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::api {
|
||||
|
||||
@@ -18,7 +17,7 @@ ssize_t APIOverflowBuffer::try_drain(socket::Socket *socket) {
|
||||
|
||||
while (this->count_ > 0) {
|
||||
uint8_t *msg = this->buf_.data() + this->head_;
|
||||
size_t len = encode_value_le<uint16_t>(msg);
|
||||
size_t len = msg[0] | (msg[1] << 8);
|
||||
|
||||
ssize_t sent = socket->write(msg + LEN_PREFIX, len);
|
||||
if (sent <= 0)
|
||||
|
||||
@@ -35,11 +35,7 @@ async def to_code(config: ConfigType) -> None:
|
||||
add_idf_component(name="esp32async/asynctcp", ref="3.4.91")
|
||||
elif CORE.is_libretiny:
|
||||
# https://github.com/ESP32Async/AsyncTCP
|
||||
cg.add_library("ESP32Async/AsyncTCP", "3.5.0")
|
||||
# AsyncTCP 3.5.0 debug logs call xPortGetCoreID(), which LibreTiny (single core) lacks; they are compiled
|
||||
# in by LibreTiny's debug level or CONFIG_ASYNC_TCP_DEBUG, so the call always expands to int(), which is 0
|
||||
# (a function-like -D does not survive PlatformIO's build flags)
|
||||
cg.add_build_flag("-DxPortGetCoreID=int")
|
||||
cg.add_library("ESP32Async/AsyncTCP", "3.4.5")
|
||||
elif CORE.is_esp8266:
|
||||
# https://github.com/ESP32Async/ESPAsyncTCP
|
||||
cg.add_library("ESP32Async/ESPAsyncTCP", "2.0.0")
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstring>
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::ble_device_base {
|
||||
|
||||
@@ -164,7 +163,8 @@ bool aes_ccm_auth_decrypt(const uint8_t key[16], const uint8_t *nonce, size_t no
|
||||
if (aad_len > 0) {
|
||||
// Only the < 2^16-2^8 encoding is needed for BLE-sized AAD.
|
||||
uint8_t blk[16] = {0};
|
||||
put_be16(blk, aad_len);
|
||||
blk[0] = static_cast<uint8_t>((aad_len >> 8) & 0xff);
|
||||
blk[1] = static_cast<uint8_t>(aad_len & 0xff);
|
||||
size_t ai = 0;
|
||||
size_t pos = 2;
|
||||
while (pos < 16 && ai < aad_len)
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
#include "cse7761.h"
|
||||
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::cse7761 {
|
||||
|
||||
@@ -105,7 +104,8 @@ void CSE7761Component::write_(uint8_t reg, uint16_t data) {
|
||||
buffer[2] = data & 0xFF;
|
||||
len = 3;
|
||||
} else {
|
||||
put_be16(buffer + 2, data);
|
||||
buffer[2] = (data >> 8) & 0xFF;
|
||||
buffer[3] = data & 0xFF;
|
||||
len = 4;
|
||||
}
|
||||
buffer[len] = ~sum_bytes(buffer, len);
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
import esphome.codegen as cg
|
||||
|
||||
CODEOWNERS = ["@tpruvot"]
|
||||
DEPENDENCIES = ["i2c"]
|
||||
DOMAIN = "cst3240"
|
||||
|
||||
cst3240_ns = cg.esphome_ns.namespace("cst3240")
|
||||
@@ -1,14 +0,0 @@
|
||||
from esphome.components import cstxxx
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from .. import cst3240_ns
|
||||
|
||||
AUTO_LOAD = ["cstxxx"]
|
||||
|
||||
CST3240Touchscreen = cst3240_ns.class_("CST3240Touchscreen", cstxxx.CSTTouchscreen)
|
||||
|
||||
CONFIG_SCHEMA = cstxxx.cst_touchscreen_schema(CST3240Touchscreen, 0x5A)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
await cstxxx.new_cst_touchscreen(config)
|
||||
@@ -1,112 +0,0 @@
|
||||
#include "cst3240_touchscreen.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
#include <utility>
|
||||
|
||||
namespace esphome::cst3240 {
|
||||
|
||||
ESPHOME_LOG_TAG(TAG, "cst3240.touchscreen");
|
||||
|
||||
void CST3240Touchscreen::setup() {
|
||||
if (this->reset_pin_ == nullptr) {
|
||||
this->continue_setup_();
|
||||
return;
|
||||
}
|
||||
pulse_reset(this->reset_pin_, {.high_before_ms = 5, .low_ms = 5});
|
||||
this->set_timeout(30, [this] { this->continue_setup_(); });
|
||||
}
|
||||
|
||||
void CST3240Touchscreen::continue_setup_() {
|
||||
if (!this->enter_command_mode_())
|
||||
return;
|
||||
if (!this->setup_check(this->read_words_(cstxxx::REG_CHIP_INFO, this->project_id_, this->chip_id_),
|
||||
LOG_STR("Failed to read chip ID")))
|
||||
return;
|
||||
// Only warn: the chip ID has not been confirmed on enough boards to fail setup on it
|
||||
if (this->chip_id_ != CST3240_CHIP_ID) {
|
||||
ESP_LOGW(TAG, "Unexpected chip ID 0x%04X", this->chip_id_);
|
||||
}
|
||||
this->read_words_(cstxxx::REG_FW_VERSION, this->fw_build_, this->fw_version_);
|
||||
|
||||
if (this->x_raw_max_ == this->x_raw_min_ || this->y_raw_max_ == this->y_raw_min_) {
|
||||
uint16_t x_max, y_max;
|
||||
if (this->read_words_(cstxxx::REG_RESOLUTION, x_max, y_max)) {
|
||||
this->x_raw_max_ = x_max;
|
||||
this->y_raw_max_ = y_max;
|
||||
if (this->swap_x_y_)
|
||||
std::swap(this->x_raw_max_, this->y_raw_max_);
|
||||
} else {
|
||||
this->x_raw_max_ = this->display_->get_native_width();
|
||||
this->y_raw_max_ = this->display_->get_native_height();
|
||||
}
|
||||
}
|
||||
|
||||
this->status_comm_check(this->write_register16(cstxxx::REG_NORMAL_MODE, nullptr, 0) == i2c::ERROR_OK);
|
||||
this->setup_interrupt_pin_(gpio::INTERRUPT_RISING_EDGE);
|
||||
this->setup_complete_ = true;
|
||||
}
|
||||
|
||||
void CST3240Touchscreen::update_touches() {
|
||||
if (!this->setup_complete_) {
|
||||
this->skip_update_ = true;
|
||||
return;
|
||||
}
|
||||
uint8_t data[CST3240_REPORT_SIZE];
|
||||
if (!this->status_comm_result(this->read_register16(cstxxx::REG_TOUCH_DATA, data, sizeof(data)) == i2c::ERROR_OK)) {
|
||||
this->skip_update_ = true;
|
||||
return;
|
||||
}
|
||||
|
||||
const uint8_t sync = data[cstxxx::SYNC_IDX];
|
||||
if (sync != cstxxx::SYNC_BYTE) {
|
||||
this->skip_update_ = true;
|
||||
if (sync != 0) {
|
||||
ESP_LOGV(TAG, "Skipping report, sync byte 0x%02X", sync);
|
||||
this->clear_report_();
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
const uint8_t count = data[cstxxx::FINGER_COUNT_IDX] & 0x0F;
|
||||
if (count <= CST3240_MAX_TOUCHES) {
|
||||
for (uint8_t i = 0; i < count; i++) {
|
||||
auto touch = cstxxx::decode_touch(data, i);
|
||||
// A released finger is still listed once, with both press bits clear
|
||||
if ((touch.event & TOUCH_EVENT_PRESSED) == 0)
|
||||
continue;
|
||||
this->add_raw_touch_position_(touch.id, touch.x, touch.y, touch.z);
|
||||
}
|
||||
}
|
||||
|
||||
if (this->interrupt_pin_ == nullptr) {
|
||||
this->clear_report_();
|
||||
} else if (!this->write_byte_reg16(cstxxx::REG_FINGER_COUNT, 0) ||
|
||||
!this->write_byte_reg16(cstxxx::REG_TOUCH_DATA, cstxxx::SYNC_BYTE)) {
|
||||
ESP_LOGW(TAG, "Failed to acknowledge the report");
|
||||
}
|
||||
}
|
||||
|
||||
void CST3240Touchscreen::clear_report_() {
|
||||
// Built on the stack: write_register16() heap allocates a frame this long
|
||||
uint8_t frame[2 + CST3240_REPORT_SIZE]{};
|
||||
put_be16(frame, cstxxx::REG_TOUCH_DATA);
|
||||
if (this->write(frame, sizeof(frame)) != i2c::ERROR_OK) {
|
||||
ESP_LOGW(TAG, "Failed to clear the report");
|
||||
}
|
||||
}
|
||||
|
||||
void CST3240Touchscreen::dump_config() {
|
||||
ESP_LOGCONFIG(TAG,
|
||||
"CST3240 Touchscreen:\n"
|
||||
" Chip ID: 0x%04X, Project ID: 0x%04X\n"
|
||||
" FW version: %d.%d.%d\n"
|
||||
" X/Y resolution: %d/%d",
|
||||
this->chip_id_, this->project_id_, this->fw_version_ >> 8, this->fw_version_ & 0xFF, this->fw_build_,
|
||||
this->x_raw_max_, this->y_raw_max_);
|
||||
LOG_I2C_DEVICE(this);
|
||||
LOG_PIN(" Interrupt Pin: ", this->interrupt_pin_);
|
||||
LOG_PIN(" Reset Pin: ", this->reset_pin_);
|
||||
}
|
||||
|
||||
} // namespace esphome::cst3240
|
||||
@@ -1,31 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include "esphome/components/cstxxx/cstxxx.h"
|
||||
#include "esphome/core/component.h"
|
||||
#include "esphome/core/hal.h"
|
||||
|
||||
namespace esphome::cst3240 {
|
||||
|
||||
static constexpr uint16_t CST3240_CHIP_ID = 0x3240;
|
||||
static constexpr uint8_t CST3240_MAX_TOUCHES = 5;
|
||||
static constexpr uint8_t CST3240_REPORT_SIZE = cstxxx::report_size(CST3240_MAX_TOUCHES);
|
||||
static constexpr uint8_t TOUCH_EVENT_PRESSED = 0x06;
|
||||
|
||||
class CST3240Touchscreen : public cstxxx::CSTTouchscreen {
|
||||
public:
|
||||
void setup() override;
|
||||
void dump_config() override;
|
||||
|
||||
protected:
|
||||
void update_touches() override;
|
||||
void continue_setup_();
|
||||
/// Zeroes the touch report block, which polling relies on to tell new reports from old.
|
||||
void clear_report_();
|
||||
|
||||
uint16_t chip_id_{};
|
||||
uint16_t project_id_{};
|
||||
uint16_t fw_version_{};
|
||||
uint16_t fw_build_{};
|
||||
};
|
||||
|
||||
} // namespace esphome::cst3240
|
||||
@@ -1,5 +1,6 @@
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import logger
|
||||
from esphome.components.nrf52.framework import include_west_project
|
||||
from esphome.components.zephyr import zephyr_add_prj_conf
|
||||
from esphome.config_helpers import filter_source_files_from_platform
|
||||
import esphome.config_validation as cv
|
||||
@@ -52,9 +53,6 @@ CONFIG_SCHEMA = cv.All(
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
if CORE.using_zephyr:
|
||||
# Imported here so configs for other platforms do not load the nrf52 package
|
||||
from esphome.components.nrf52.framework import include_west_project
|
||||
|
||||
zephyr_add_prj_conf("HWINFO", True)
|
||||
# gdb thread support
|
||||
zephyr_add_prj_conf("DEBUG_THREAD_INFO", True)
|
||||
|
||||
@@ -173,7 +173,7 @@ void DFPlayer::loop() {
|
||||
}
|
||||
// Parse valid received command
|
||||
uint8_t cmd = this->read_buffer_[3];
|
||||
uint16_t argument = encode_uint16(this->read_buffer_[5], this->read_buffer_[6]);
|
||||
uint16_t argument = (this->read_buffer_[5] << 8) | this->read_buffer_[6];
|
||||
|
||||
ESP_LOGV(TAG, "Received message cmd: %#02x arg %#04x", cmd, argument);
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ void EE895Component::setup() {
|
||||
uint8_t serial_number[20];
|
||||
this->read(serial_number, 20);
|
||||
|
||||
crc16_check = encode_value_le<uint16_t>(serial_number + 18);
|
||||
crc16_check = (serial_number[19] << 8) + serial_number[18];
|
||||
if (!this->setup_check(crc16_check == calc_crc16_(serial_number, 18), LOG_STR("CRC check failed")))
|
||||
return;
|
||||
#if ESPHOME_LOG_LEVEL >= ESPHOME_LOG_LEVEL_VERBOSE
|
||||
|
||||
@@ -10,7 +10,7 @@ from esphome.components.const import CONF_PROVIDER, CONF_REMOTE_ID
|
||||
from esphome.components.packet_interface import (
|
||||
CONF_PACKET_INTERFACE,
|
||||
final_validate_interface,
|
||||
interface_has_layer,
|
||||
interface_layers,
|
||||
interface_packet_size,
|
||||
)
|
||||
from esphome.components.packet_interface.layers import CONF_SESSION
|
||||
@@ -103,13 +103,11 @@ CONFIG_SCHEMA = cv.Schema(
|
||||
|
||||
def _final_validate(config: ConfigType) -> ConfigType:
|
||||
"""With a session layer, which clears the states when the peer is lost, nothing would refresh an unchanged state."""
|
||||
if CONF_TIMEOUT in config and interface_has_layer(
|
||||
config[CONF_PACKET_INTERFACE], CONF_SESSION
|
||||
):
|
||||
layers = interface_layers(config[CONF_PACKET_INTERFACE])
|
||||
if CONF_TIMEOUT in config and CONF_SESSION in layers:
|
||||
raise cv.Invalid(
|
||||
f"Not allowed with a '{CONF_SESSION}' layer, or a link that does its job, which already clears the "
|
||||
"states when the other device cannot be reached; unchanged states may never be sent again, so they "
|
||||
"would time out on a working link",
|
||||
f"Not allowed with a '{CONF_SESSION}' layer, which already clears the states when the other device "
|
||||
"cannot be reached; unchanged states may never be sent again, so they would time out on a working link",
|
||||
path=[CONF_TIMEOUT],
|
||||
)
|
||||
return config
|
||||
|
||||
@@ -4,7 +4,6 @@
|
||||
#include <cstring>
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::entity_transport {
|
||||
|
||||
@@ -374,7 +373,8 @@ size_t EntityTransport::write_record_(const LocalEntity &entity, uint8_t *record
|
||||
#endif
|
||||
uint16_t tag =
|
||||
entity.number | (type << TAG_TYPE_SHIFT) | (payload << TAG_PAYLOAD_SHIFT) | (value ? TAG_VALUE_BIT : 0);
|
||||
put_le16(record, tag);
|
||||
record[0] = tag;
|
||||
record[1] = tag >> 8;
|
||||
return size;
|
||||
}
|
||||
|
||||
|
||||
@@ -56,6 +56,7 @@ from esphome.const import (
|
||||
from esphome.core import CORE, EsphomeError, HexInt
|
||||
from esphome.core.config import BOARD_MAX_LENGTH
|
||||
from esphome.coroutine import CoroPriority, coroutine_with_priority
|
||||
from esphome.espidf import sbom
|
||||
from esphome.espidf.component import IDFComponent, generate_idf_components
|
||||
import esphome.final_validate as fv
|
||||
from esphome.helpers import copy_file_if_changed, rmtree, write_file_if_changed
|
||||
@@ -4032,9 +4033,6 @@ def copy_files():
|
||||
CORE.relative_build_path("version.txt"),
|
||||
__version__,
|
||||
)
|
||||
# Imported here: sbom loads git and urllib helpers that config validation does not need
|
||||
from esphome.espidf import sbom
|
||||
|
||||
sbom.write_manifests()
|
||||
|
||||
# Remote extra build files are fetched into the shared download cache in
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
#include "inkbird_ibsth1_mini.h"
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::inkbird_ibsth1_mini {
|
||||
|
||||
@@ -83,7 +82,7 @@ bool InkbirdIbstH1Mini::parse_device(const ble_device_base::ESPBTDevice &device)
|
||||
}
|
||||
|
||||
auto battery_level = mnf_data.data[5];
|
||||
auto humidity = encode_value_le<uint16_t>(mnf_data.data.data()) / 100.0f;
|
||||
auto humidity = ((mnf_data.data[1] << 8) + mnf_data.data[0]) / 100.0f;
|
||||
|
||||
// Send temperature only if the value is set
|
||||
if (!std::isnan(temperature) && this->temperature_sensor_ != nullptr) {
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
#include "modbus_helpers.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
#include <algorithm>
|
||||
@@ -472,7 +471,7 @@ PduBuffer create_client_pdu(FunctionCode function_code, uint16_t start_address,
|
||||
values[1]);
|
||||
return pdu;
|
||||
}
|
||||
append_pdu_header(pdu, function_code, start_address, encode_uint16(values[0], values[1]));
|
||||
append_pdu_header(pdu, function_code, start_address, uint16_t((values[0] << 8) | values[1]));
|
||||
return pdu;
|
||||
}
|
||||
// The quantity is spec-bounded above, so the data length just has to agree with it exactly
|
||||
|
||||
@@ -1,303 +0,0 @@
|
||||
from collections.abc import Callable
|
||||
|
||||
from esphome import automation
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import i2c
|
||||
from esphome.components.const import CONF_CHARGE_CURRENT, CONF_ENABLED
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import CONF_DURATION, CONF_ID, CONF_MODE, CONF_VOLTAGE
|
||||
from esphome.types import ConfigType
|
||||
|
||||
CODEOWNERS = ["@tomaszduda23"]
|
||||
DEPENDENCIES = ["i2c"]
|
||||
DOMAIN = "npm1300"
|
||||
MULTI_CONF = True
|
||||
|
||||
CONF_NPM1300_ID = "npm1300_id"
|
||||
CONF_VBUS_CURRENT_LIMIT = "vbus_current_limit"
|
||||
CONF_THERMISTOR_RESISTANCE = "thermistor_resistance"
|
||||
CONF_THERMISTOR_BETA = "thermistor_beta"
|
||||
CONF_CHARGER = "charger"
|
||||
CONF_TERMINATION_VOLTAGE = "termination_voltage"
|
||||
CONF_WARM_TERMINATION_VOLTAGE = "warm_termination_voltage"
|
||||
CONF_TERMINATION_CURRENT = "termination_current"
|
||||
CONF_TRICKLE_VOLTAGE = "trickle_voltage"
|
||||
CONF_DISCHARGE_CURRENT_LIMIT = "discharge_current_limit"
|
||||
CONF_RECHARGE = "recharge"
|
||||
CONF_BUCK1 = "buck1"
|
||||
CONF_BUCK2 = "buck2"
|
||||
CONF_LDO1 = "ldo1"
|
||||
CONF_LDO2 = "ldo2"
|
||||
|
||||
npm1300_ns = cg.esphome_ns.namespace("npm1300")
|
||||
NPM1300Component = npm1300_ns.class_(
|
||||
"NPM1300Component", cg.PollingComponent, i2c.I2CDevice
|
||||
)
|
||||
NPM1300Output = npm1300_ns.enum("NPM1300Output", is_class=True)
|
||||
NPM1300OutputConfig = npm1300_ns.struct("NPM1300OutputConfig")
|
||||
NPM1300ChargerConfig = npm1300_ns.struct("NPM1300ChargerConfig")
|
||||
NPM1300Config = npm1300_ns.struct("NPM1300Config")
|
||||
|
||||
NPM1300_CHILD_SCHEMA = cv.Schema(
|
||||
{cv.GenerateID(CONF_NPM1300_ID): cv.use_id(NPM1300Component)}
|
||||
)
|
||||
|
||||
# Status registers read on each update: VBUSINSTATUS, BCHGCHARGESTATUS and BCHGERRREASON
|
||||
STATUS_PUBLISHER = cg.HubFunction(
|
||||
"status",
|
||||
cg.void,
|
||||
[
|
||||
(cg.uint8, "vbus_status"),
|
||||
(cg.uint8, "charge_status"),
|
||||
(cg.uint8, "error_reason"),
|
||||
],
|
||||
define="USE_NPM1300_STATUS_PUBLISHER",
|
||||
)
|
||||
VBUS_STATUS = STATUS_PUBLISHER.param("vbus_status")
|
||||
CHARGE_STATUS = STATUS_PUBLISHER.param("charge_status")
|
||||
ERROR_REASON = STATUS_PUBLISHER.param("error_reason")
|
||||
# The ADC results and the amperes per code of the battery current
|
||||
DATA_PUBLISHER = cg.HubFunction(
|
||||
"data",
|
||||
cg.void,
|
||||
[(cg.uint8.operator("const").operator("ptr"), "adc"), (cg.float_, "ibat_scale")],
|
||||
define="USE_NPM1300_DATA_PUBLISHER",
|
||||
)
|
||||
ADC = DATA_PUBLISHER.param("adc")
|
||||
IBAT_SCALE = DATA_PUBLISHER.param("ibat_scale")
|
||||
# The dump lines of the children decoded by the two functions above
|
||||
DUMP = cg.HubFunction("dump", cg.void, [(cg.const_char_ptr, "tag")])
|
||||
DUMP_TAG = DUMP.param("tag")
|
||||
|
||||
# Config key of each regulator and its NPM1300Output enumerator
|
||||
OUTPUTS = NPM1300Output.options(
|
||||
CONF_BUCK1, CONF_BUCK2, CONF_LDO1, CONF_LDO2, prefix="NPM1300_OUTPUT_"
|
||||
)
|
||||
|
||||
# Written for a field the YAML leaves out
|
||||
NPM1300_UNSET = 0xFF
|
||||
# ADCNTCRSEL codes, by kiloohms
|
||||
THERMISTOR_RESISTANCES = {10: 1, 47: 2, 100: 3}
|
||||
LDO_MODES = {"load_switch": 0, "ldo": 1}
|
||||
TERMINATION_CURRENTS = {"10%": 0, "20%": 1}
|
||||
# BCHGVTRICKLESEL, by millivolts
|
||||
TRICKLE_VOLTAGES = {2900: 0, 2500: 1}
|
||||
# BCHGISETDISCHARGE codes, by milliamperes
|
||||
DISCHARGE_CURRENT_LIMITS = {200: 84, 1000: 415}
|
||||
# BCHGVTERM: 3.50 V to 3.65 V, then 4.00 V to 4.45 V, both in 50 mV steps
|
||||
TERMINATION_VOLTAGES = [3500 + 50 * i for i in range(4)] + [
|
||||
4000 + 50 * i for i in range(10)
|
||||
]
|
||||
# The wake-up timer counts 16 ms ticks in a 24-bit register
|
||||
HIBERNATE_TICK_MS = 16
|
||||
HIBERNATE_MAX_TICKS = 0xFFFFFF
|
||||
|
||||
|
||||
def _millis(value: float) -> int:
|
||||
return round(value * 1000)
|
||||
|
||||
|
||||
def _one_of_units(
|
||||
validator: Callable[[object], float],
|
||||
allowed: list[int],
|
||||
unit: str,
|
||||
scale: float = 1000,
|
||||
) -> Callable[[object], float]:
|
||||
"""Validate a quantity with `validator` and accept only the listed values, given in units * `scale`."""
|
||||
|
||||
def validate(value: object) -> float:
|
||||
value = validator(value)
|
||||
if round(value * scale) not in allowed:
|
||||
options = ", ".join(f"{v / scale:g}{unit}" for v in allowed)
|
||||
raise cv.Invalid(f"Must be one of {options}")
|
||||
return value
|
||||
|
||||
return validate
|
||||
|
||||
|
||||
def _stepped(
|
||||
validator: Callable[[object], float],
|
||||
minimum: int,
|
||||
maximum: int,
|
||||
step: int,
|
||||
unit: str,
|
||||
) -> Callable[[object], float]:
|
||||
"""Validate a quantity in a range of milli-units, in steps of `step`."""
|
||||
allowed = list(range(minimum, maximum + 1, step))
|
||||
in_range = cv.All(validator, cv.Range(min=minimum / 1000, max=maximum / 1000))
|
||||
|
||||
def validate(value: object) -> float:
|
||||
value = in_range(value)
|
||||
if _millis(value) not in allowed:
|
||||
raise cv.Invalid(f"Must be a multiple of {step}m{unit}")
|
||||
return value
|
||||
|
||||
return validate
|
||||
|
||||
|
||||
OUTPUT_VOLTAGE = _stepped(cv.voltage, 1000, 3300, 100, "V")
|
||||
VBUS_CURRENT_LIMIT = _stepped(cv.current, 100, 1500, 100, "A")
|
||||
|
||||
BUCK_SCHEMA = cv.Schema(
|
||||
{
|
||||
cv.Optional(CONF_VOLTAGE): OUTPUT_VOLTAGE,
|
||||
cv.Optional(CONF_ENABLED): cv.boolean,
|
||||
}
|
||||
)
|
||||
LDO_SCHEMA = BUCK_SCHEMA.extend(
|
||||
{
|
||||
cv.Optional(CONF_MODE): cv.enum(LDO_MODES, lower=True),
|
||||
}
|
||||
)
|
||||
|
||||
CHARGER_SCHEMA = cv.Schema(
|
||||
{
|
||||
cv.Required(CONF_CHARGE_CURRENT): _stepped(cv.current, 32, 800, 2, "A"),
|
||||
cv.Optional(CONF_TERMINATION_VOLTAGE, default="4.2V"): _one_of_units(
|
||||
cv.voltage, TERMINATION_VOLTAGES, "V"
|
||||
),
|
||||
cv.Optional(CONF_WARM_TERMINATION_VOLTAGE): _one_of_units(
|
||||
cv.voltage, TERMINATION_VOLTAGES, "V"
|
||||
),
|
||||
cv.Optional(CONF_TERMINATION_CURRENT, default="10%"): cv.enum(
|
||||
TERMINATION_CURRENTS
|
||||
),
|
||||
cv.Optional(CONF_TRICKLE_VOLTAGE, default="2.9V"): _one_of_units(
|
||||
cv.voltage, list(TRICKLE_VOLTAGES), "V"
|
||||
),
|
||||
cv.Optional(CONF_DISCHARGE_CURRENT_LIMIT, default="1000mA"): _one_of_units(
|
||||
cv.current, list(DISCHARGE_CURRENT_LIMITS), "A"
|
||||
),
|
||||
cv.Optional(CONF_RECHARGE, default=True): cv.boolean,
|
||||
cv.Optional(CONF_ENABLED, default=True): cv.boolean,
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
CONFIG_SCHEMA = (
|
||||
cv.Schema(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(NPM1300Component),
|
||||
cv.Optional(CONF_VBUS_CURRENT_LIMIT): VBUS_CURRENT_LIMIT,
|
||||
cv.Optional(CONF_THERMISTOR_RESISTANCE): _one_of_units(
|
||||
cv.resistance, list(THERMISTOR_RESISTANCES), "kOhm", scale=0.001
|
||||
),
|
||||
cv.Optional(CONF_THERMISTOR_BETA, default=3380): cv.int_range(
|
||||
min=1, max=65535
|
||||
),
|
||||
cv.Optional(CONF_CHARGER): CHARGER_SCHEMA,
|
||||
cv.Optional(CONF_BUCK1): BUCK_SCHEMA,
|
||||
cv.Optional(CONF_BUCK2): BUCK_SCHEMA,
|
||||
cv.Optional(CONF_LDO1): LDO_SCHEMA,
|
||||
cv.Optional(CONF_LDO2): LDO_SCHEMA,
|
||||
}
|
||||
)
|
||||
.extend(cv.polling_component_schema("60s"))
|
||||
.extend(i2c.i2c_device_schema(0x6B))
|
||||
)
|
||||
|
||||
|
||||
def _termination_voltage_code(volts: float) -> int:
|
||||
return TERMINATION_VOLTAGES.index(_millis(volts))
|
||||
|
||||
|
||||
def _vbus_current_limit_code(amps: float) -> int:
|
||||
"""VBUSINILIM0: 100 mA per step of the code."""
|
||||
return _millis(amps) // 100
|
||||
|
||||
|
||||
def _charger_config(config: ConfigType) -> cg.StructInitializer:
|
||||
termination = _termination_voltage_code(config[CONF_TERMINATION_VOLTAGE])
|
||||
warm = config.get(CONF_WARM_TERMINATION_VOLTAGE)
|
||||
return cg.StructInitializer(
|
||||
NPM1300ChargerConfig,
|
||||
("current", _millis(config[CONF_CHARGE_CURRENT]) // 2),
|
||||
(
|
||||
"discharge_limit",
|
||||
DISCHARGE_CURRENT_LIMITS[_millis(config[CONF_DISCHARGE_CURRENT_LIMIT])],
|
||||
),
|
||||
("termination_voltage", termination),
|
||||
(
|
||||
"warm_termination_voltage",
|
||||
termination if warm is None else _termination_voltage_code(warm),
|
||||
),
|
||||
("trickle_voltage", TRICKLE_VOLTAGES[_millis(config[CONF_TRICKLE_VOLTAGE])]),
|
||||
("termination_current", TERMINATION_CURRENTS[config[CONF_TERMINATION_CURRENT]]),
|
||||
("recharge", config[CONF_RECHARGE]),
|
||||
("enabled", config[CONF_ENABLED]),
|
||||
)
|
||||
|
||||
|
||||
def _output_config(config: ConfigType | None) -> cg.StructInitializer:
|
||||
config = config or {}
|
||||
voltage = config.get(CONF_VOLTAGE)
|
||||
mode = config.get(CONF_MODE)
|
||||
enabled = config.get(CONF_ENABLED)
|
||||
return cg.StructInitializer(
|
||||
NPM1300OutputConfig,
|
||||
(
|
||||
"voltage",
|
||||
NPM1300_UNSET if voltage is None else (_millis(voltage) - 1000) // 100,
|
||||
),
|
||||
("ldo_mode", NPM1300_UNSET if mode is None else LDO_MODES[mode]),
|
||||
("enabled", NPM1300_UNSET if enabled is None else int(enabled)),
|
||||
)
|
||||
|
||||
|
||||
def _config(config: ConfigType) -> cg.StructInitializer:
|
||||
charger = config.get(CONF_CHARGER)
|
||||
resistance = config.get(CONF_THERMISTOR_RESISTANCE)
|
||||
return cg.StructInitializer(
|
||||
NPM1300Config,
|
||||
(
|
||||
"outputs",
|
||||
cg.ArrayInitializer(*(_output_config(config.get(key)) for key in OUTPUTS)),
|
||||
),
|
||||
("charger", None if charger is None else _charger_config(charger)),
|
||||
("thermistor_beta", config[CONF_THERMISTOR_BETA]),
|
||||
(
|
||||
"thermistor",
|
||||
NPM1300_UNSET
|
||||
if resistance is None
|
||||
else THERMISTOR_RESISTANCES[round(resistance / 1000)],
|
||||
),
|
||||
("charger_configured", charger is not None),
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
# In flash: only setup() and dump_config() read it
|
||||
table = cg.shared_progmem_array(
|
||||
"npm1300_config", NPM1300Config, cg.ArrayInitializer(_config(config))
|
||||
)
|
||||
var = await i2c.new_i2c_component(config, table)
|
||||
if (limit := config.get(CONF_VBUS_CURRENT_LIMIT)) is not None:
|
||||
cg.add(var.set_vbus_current_limit(_vbus_current_limit_code(limit)))
|
||||
|
||||
|
||||
automation.register_apply_action(
|
||||
"npm1300.enter_ship_mode",
|
||||
automation.maybe_simple_id({cv.Required(CONF_ID): cv.use_id(NPM1300Component)}),
|
||||
automation.ApplyCall("enter_ship_mode()"),
|
||||
)
|
||||
|
||||
automation.register_apply_action(
|
||||
"npm1300.hibernate",
|
||||
cv.Schema(
|
||||
{
|
||||
cv.Required(CONF_ID): cv.use_id(NPM1300Component),
|
||||
cv.Required(CONF_DURATION): cv.templatable(
|
||||
cv.All(
|
||||
cv.positive_time_period_milliseconds,
|
||||
cv.Range(
|
||||
min=cv.TimePeriod(milliseconds=HIBERNATE_TICK_MS),
|
||||
max=cv.TimePeriod(
|
||||
milliseconds=HIBERNATE_TICK_MS * HIBERNATE_MAX_TICKS
|
||||
),
|
||||
),
|
||||
)
|
||||
),
|
||||
}
|
||||
),
|
||||
automation.ApplyField(CONF_DURATION, "hibernate", cg.uint32),
|
||||
)
|
||||
@@ -1,106 +0,0 @@
|
||||
from dataclasses import dataclass
|
||||
|
||||
from esphome.automation import parent_ref
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import binary_sensor
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import (
|
||||
DEVICE_CLASS_BATTERY_CHARGING,
|
||||
DEVICE_CLASS_POWER,
|
||||
DEVICE_CLASS_PROBLEM,
|
||||
ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
)
|
||||
from esphome.cpp_generator import HexIntLiteral
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from . import (
|
||||
CHARGE_STATUS,
|
||||
CONF_NPM1300_ID,
|
||||
DUMP,
|
||||
DUMP_TAG,
|
||||
ERROR_REASON,
|
||||
NPM1300_CHILD_SCHEMA,
|
||||
STATUS_PUBLISHER,
|
||||
VBUS_STATUS,
|
||||
)
|
||||
|
||||
DEPENDENCIES = ["npm1300"]
|
||||
|
||||
|
||||
@dataclass(frozen=True, kw_only=True)
|
||||
class _StatusBits:
|
||||
"""On when any bit of mask is set in the status register."""
|
||||
|
||||
key: str
|
||||
register: cg.MockObj
|
||||
mask: int
|
||||
name: str
|
||||
device_class: str = cv.UNDEFINED
|
||||
entity_category: str = cv.UNDEFINED
|
||||
|
||||
|
||||
_FIELDS = (
|
||||
_StatusBits(
|
||||
key="vbus_present",
|
||||
register=VBUS_STATUS,
|
||||
mask=0x01,
|
||||
name="VBUS Present",
|
||||
device_class=DEVICE_CLASS_POWER,
|
||||
),
|
||||
_StatusBits(
|
||||
key="vbus_current_limit_active",
|
||||
register=VBUS_STATUS,
|
||||
mask=0x02,
|
||||
name="VBUS Current Limit Active",
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
),
|
||||
# Trickle, constant current or constant voltage charging
|
||||
_StatusBits(
|
||||
key="charging",
|
||||
register=CHARGE_STATUS,
|
||||
mask=0x1C,
|
||||
name="Charging",
|
||||
device_class=DEVICE_CLASS_BATTERY_CHARGING,
|
||||
),
|
||||
_StatusBits(
|
||||
key="charge_complete",
|
||||
register=CHARGE_STATUS,
|
||||
mask=0x02,
|
||||
name="Charge Complete",
|
||||
),
|
||||
_StatusBits(
|
||||
key="charger_error",
|
||||
register=ERROR_REASON,
|
||||
mask=0xFF,
|
||||
name="Charger Error",
|
||||
device_class=DEVICE_CLASS_PROBLEM,
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
),
|
||||
)
|
||||
|
||||
CONFIG_SCHEMA = NPM1300_CHILD_SCHEMA.extend(
|
||||
{
|
||||
cv.Optional(field.key): binary_sensor.binary_sensor_schema(
|
||||
device_class=field.device_class, entity_category=field.entity_category
|
||||
)
|
||||
for field in _FIELDS
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
hub = await cg.get_variable(config[CONF_NPM1300_ID])
|
||||
sensors = binary_sensor.sub_binary_sensors(config)
|
||||
for field in _FIELDS:
|
||||
if (var := await sensors(field.key, None)) is not None:
|
||||
state = (field.register & HexIntLiteral(field.mask)) != 0
|
||||
STATUS_PUBLISHER.add(hub, parent_ref(var).publish_state(state))
|
||||
DUMP.add(
|
||||
hub,
|
||||
binary_sensor.binary_sensor_ns.log_binary_sensor(
|
||||
DUMP_TAG,
|
||||
" ",
|
||||
cg.RawExpression(f'LOG_STR_LITERAL("{field.name}")'),
|
||||
parent_ref(var),
|
||||
),
|
||||
)
|
||||
@@ -1,483 +0,0 @@
|
||||
#include "npm1300.h"
|
||||
#include <algorithm>
|
||||
#include <cinttypes>
|
||||
#include <cmath>
|
||||
#include "esphome/core/hal.h"
|
||||
#include "esphome/core/log.h"
|
||||
#ifdef USE_TEXT_SENSOR
|
||||
#include "esphome/core/progmem.h"
|
||||
#endif
|
||||
|
||||
namespace esphome::npm1300 {
|
||||
|
||||
ESPHOME_LOG_TAG(TAG, "npm1300");
|
||||
|
||||
// Registers: the base address of the peripheral in the high byte, the offset in the low byte
|
||||
static constexpr uint16_t REG_VBUSIN_TASK_UPDATE_ILIM = 0x0200;
|
||||
static constexpr uint16_t REG_VBUSIN_ILIM0 = 0x0201;
|
||||
static constexpr uint16_t REG_VBUSIN_ILIM_STARTUP = 0x0202;
|
||||
static constexpr uint16_t REG_VBUSIN_STATUS = 0x0207;
|
||||
static constexpr uint16_t REG_BCHG_TASK_RELEASE_ERR = 0x0300;
|
||||
static constexpr uint16_t REG_BCHG_TASK_CLEAR_CHG_ERR = 0x0301;
|
||||
static constexpr uint16_t REG_BCHG_ENABLE_SET = 0x0304;
|
||||
static constexpr uint16_t REG_BCHG_ENABLE_CLR = 0x0305;
|
||||
static constexpr uint16_t REG_BCHG_DISABLE_SET = 0x0306;
|
||||
static constexpr uint16_t REG_BCHG_DISABLE_CLR = 0x0307;
|
||||
static constexpr uint16_t REG_BCHG_ISET_MSB = 0x0308;
|
||||
static constexpr uint16_t REG_BCHG_ISET_DISCHARGE_MSB = 0x030A;
|
||||
static constexpr uint16_t REG_BCHG_VTERM = 0x030C;
|
||||
static constexpr uint16_t REG_BCHG_VTERM_R = 0x030D;
|
||||
static constexpr uint16_t REG_BCHG_VTRICKLE_SEL = 0x030E;
|
||||
static constexpr uint16_t REG_BCHG_ITERM_SEL = 0x030F;
|
||||
static constexpr uint16_t REG_BCHG_CHARGE_STATUS = 0x0334;
|
||||
static constexpr uint16_t REG_BCHG_ERR_REASON = 0x0336;
|
||||
static constexpr uint16_t REG_BUCK1_ENA_SET = 0x0400;
|
||||
static constexpr uint16_t REG_BUCK1_NORM_VOUT = 0x0408;
|
||||
static constexpr uint16_t REG_BUCK_SW_CTRL_SEL = 0x040F;
|
||||
static constexpr uint16_t REG_BUCK_STATUS = 0x0434;
|
||||
static constexpr uint16_t REG_ADC_TASK_VBAT = 0x0500;
|
||||
static constexpr uint16_t REG_ADC_TASK_VBUS = 0x0507;
|
||||
static constexpr uint16_t REG_ADC_NTC_R_SEL = 0x050A;
|
||||
static constexpr uint16_t REG_ADC_TASK_AUTO_TIM_UPDATE = 0x050C;
|
||||
static constexpr uint16_t REG_ADC_RESULTS = 0x0510;
|
||||
static constexpr uint16_t REG_ADC_IBAT_MEAS_EN = 0x0524;
|
||||
static constexpr uint16_t REG_TIMER_TARGET_STROBE = 0x0703;
|
||||
static constexpr uint16_t REG_TIMER_CONFIG = 0x0705;
|
||||
static constexpr uint16_t REG_TIMER_HI_BYTE = 0x0708;
|
||||
static constexpr uint16_t REG_LDSW1_TASK_SET = 0x0800;
|
||||
static constexpr uint16_t REG_LDSW_STATUS = 0x0804;
|
||||
static constexpr uint16_t REG_LDSW1_LDO_SEL = 0x0808;
|
||||
static constexpr uint16_t REG_LDSW1_VOUT_SEL = 0x080C;
|
||||
static constexpr uint16_t REG_SHIP_TASK_HIBERNATE = 0x0B00;
|
||||
static constexpr uint16_t REG_SHIP_TASK_SHIP_MODE = 0x0B02;
|
||||
|
||||
// VBUSINSTATUS
|
||||
static constexpr uint8_t VBUS_PRESENT = 0x01;
|
||||
// BCHGCHARGESTATUS; bit 0 (battery detected) is reserved since C00 silicon
|
||||
static constexpr uint8_t CHARGE_STATUS_COMPLETED = 0x02;
|
||||
static constexpr uint8_t CHARGE_STATUS_TRICKLE = 0x04;
|
||||
static constexpr uint8_t CHARGE_STATUS_CONSTANT_CURRENT = 0x08;
|
||||
static constexpr uint8_t CHARGE_STATUS_CONSTANT_VOLTAGE = 0x10;
|
||||
static constexpr uint8_t CHARGE_STATUS_DIE_TEMP_HIGH = 0x40;
|
||||
// BCHGDISABLESET and BCHGDISABLECLR
|
||||
static constexpr uint8_t CHARGER_DISABLE_RECHARGE = 0x01;
|
||||
static constexpr uint8_t CHARGER_DISABLE_NTC = 0x02;
|
||||
// BUCKSTATUS power good, LDSWSTATUS powered up as load switch or as LDO
|
||||
static constexpr uint8_t BUCK_POWER_GOOD[2] = {0x04, 0x40};
|
||||
static constexpr uint8_t LDSW_POWERED[2] = {0x03, 0x0C};
|
||||
// TIMERCONFIG: wake-up timer with the 16 ms prescaler
|
||||
static constexpr uint8_t TIMER_CONFIG_WAKEUP = 0x04;
|
||||
static constexpr uint32_t TIMER_TICK_MS = 16;
|
||||
static constexpr uint32_t TIMER_MAX_TICKS = 0xFFFFFF;
|
||||
|
||||
// BCHGISETDISCHARGE codes up to this one select the 200 mA discharge limit, the others 1000 mA
|
||||
static constexpr uint16_t DISCHARGE_LIMIT_200MA_CODE = 84;
|
||||
|
||||
static uint16_t discharge_limit_ma(uint16_t code) { return code <= DISCHARGE_LIMIT_200MA_CODE ? 200 : 1000; }
|
||||
|
||||
// BCHGISET and BCHGISETDISCHARGE hold a 9-bit code: the high 8 bits, then bit 0 in the next register
|
||||
static void split_9bit(uint16_t code, uint8_t *out) {
|
||||
out[0] = code >> 1;
|
||||
out[1] = code & 1;
|
||||
}
|
||||
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
static uint16_t join_9bit(const uint8_t *in) { return (in[0] << 1) | (in[1] & 1); }
|
||||
|
||||
// ADCIBATMEASSTATUS
|
||||
static constexpr uint8_t IBAT_MEAS_INVALID = 0x10;
|
||||
static constexpr uint8_t IBAT_MODE_SHIFT = 2;
|
||||
static constexpr uint8_t IBAT_MODE_DISCHARGE = 0x01;
|
||||
static constexpr uint8_t IBAT_MODE_CHARGE = 0x03;
|
||||
// Full scale of the battery current measurement per milliampere of the charge and discharge limits
|
||||
static constexpr float CHARGE_FULL_SCALE_FACTOR = 1.25f;
|
||||
static constexpr float DISCHARGE_FULL_SCALE_FACTOR = 1.12f;
|
||||
static constexpr float ADC_MAX_CODE = 1023.0f;
|
||||
// Five conversions of 250 us each; the loop runs the timeout later than this anyway
|
||||
static constexpr uint32_t CONVERSION_TIME_MS = 2;
|
||||
|
||||
static constexpr uint32_t READ_TIMEOUT_ID = 0;
|
||||
|
||||
float ntc_temperature(uint16_t code, float inv_beta) {
|
||||
if (code == 0)
|
||||
return NAN;
|
||||
// The NTC divider gives code = 1024 * R / (R + R_nominal)
|
||||
return 1.0f / (1.0f / 298.15f - logf(1024.0f / code - 1.0f) * inv_beta) - 273.15f;
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef USE_TEXT_SENSOR
|
||||
PROGMEM_STRING_TABLE(ChargerStatusStrings, "Error", "Paused, Die Too Hot", "Charge Complete", "Trickle Charge",
|
||||
"Constant Current", "Constant Voltage", "Discharging", "Not Charging");
|
||||
// BCHGCHARGESTATUS bits in order of priority; bit i is reported as string i + 1
|
||||
static const uint8_t CHARGER_STATUS_BITS[] PROGMEM = {CHARGE_STATUS_DIE_TEMP_HIGH, CHARGE_STATUS_COMPLETED,
|
||||
CHARGE_STATUS_TRICKLE, CHARGE_STATUS_CONSTANT_CURRENT,
|
||||
CHARGE_STATUS_CONSTANT_VOLTAGE};
|
||||
|
||||
static uint8_t charger_status_index(uint8_t vbus_status, uint8_t charge_status, uint8_t error_reason) {
|
||||
if (error_reason != 0)
|
||||
return 0;
|
||||
for (size_t i = 0; i < sizeof(CHARGER_STATUS_BITS); i++) {
|
||||
if ((charge_status & progmem_read_byte(&CHARGER_STATUS_BITS[i])) != 0)
|
||||
return i + 1;
|
||||
}
|
||||
return (vbus_status & VBUS_PRESENT) == 0 ? 6 : 7;
|
||||
}
|
||||
|
||||
void publish_charger_status(text_sensor::TextSensor *sensor, uint8_t &last, uint8_t vbus_status, uint8_t charge_status,
|
||||
uint8_t error_reason) {
|
||||
const uint8_t index = charger_status_index(vbus_status, charge_status, error_reason);
|
||||
if (index == last)
|
||||
return;
|
||||
last = index;
|
||||
sensor->publish_state(ChargerStatusStrings::get_progmem_str(index, ChargerStatusStrings::LAST_INDEX));
|
||||
}
|
||||
#endif
|
||||
|
||||
NPM1300Config NPM1300Component::load_config_() const {
|
||||
NPM1300Config config;
|
||||
progmem_memcpy(&config, this->config_, sizeof(config));
|
||||
return config;
|
||||
}
|
||||
|
||||
void NPM1300Component::setup() {
|
||||
uint8_t status;
|
||||
if (!this->setup_check(this->read_byte_reg16(REG_BCHG_CHARGE_STATUS, &status)))
|
||||
return;
|
||||
|
||||
// Raise the VBUS current limit before anything turns on a regulator: at the power-on limit of 100 mA the
|
||||
// inrush current of a regulator can trip the over-current protection and brown out the board
|
||||
if (this->vbus_current_limit_ != NPM1300_UNSET &&
|
||||
!this->setup_check(this->write_byte_reg16(REG_VBUSIN_ILIM_STARTUP, this->vbus_current_limit_) &&
|
||||
this->apply_vbus_current_limit_()))
|
||||
return;
|
||||
|
||||
const NPM1300Config config = this->load_config_();
|
||||
if (config.thermistor != NPM1300_UNSET &&
|
||||
!this->setup_check(this->write_byte_reg16(REG_ADC_NTC_R_SEL, config.thermistor)))
|
||||
return;
|
||||
|
||||
if (config.charger_configured && !this->setup_check(this->configure_charger_(config)))
|
||||
return;
|
||||
|
||||
for (uint8_t i = 0; i < NPM1300_OUTPUT_COUNT; i++) {
|
||||
if (!this->setup_check(this->configure_output_(i, config.outputs[i])))
|
||||
return;
|
||||
}
|
||||
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
if (this->data_publisher_ != nullptr) {
|
||||
// The battery current is measured after every battery voltage measurement
|
||||
if (!this->setup_check(this->write_byte_reg16(REG_ADC_IBAT_MEAS_EN, 1)))
|
||||
return;
|
||||
if (config.charger_configured) {
|
||||
this->charge_code_ = config.charger.current;
|
||||
this->discharge_limit_high_ = discharge_limit_ma(config.charger.discharge_limit) == 1000;
|
||||
} else if (!this->setup_check(this->read_charge_currents_())) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
this->update();
|
||||
}
|
||||
|
||||
bool NPM1300Component::apply_vbus_current_limit_() {
|
||||
return this->write_byte_reg16(REG_VBUSIN_ILIM0, this->vbus_current_limit_) &&
|
||||
this->write_byte_reg16(REG_VBUSIN_TASK_UPDATE_ILIM, 1);
|
||||
}
|
||||
|
||||
bool NPM1300Component::configure_charger_(const NPM1300Config &config) {
|
||||
const NPM1300ChargerConfig &charger = config.charger;
|
||||
// The charge settings are only taken while the charger is off
|
||||
if (!this->write_byte_reg16(REG_BCHG_ENABLE_CLR, 1))
|
||||
return false;
|
||||
uint8_t current[2];
|
||||
uint8_t discharge[2];
|
||||
split_9bit(charger.current, current);
|
||||
split_9bit(charger.discharge_limit, discharge);
|
||||
uint8_t disable = charger.recharge ? 0 : CHARGER_DISABLE_RECHARGE;
|
||||
// Without a thermistor the charger reports an NTC error and does not charge
|
||||
if (config.thermistor == NPM1300_UNSET)
|
||||
disable |= CHARGER_DISABLE_NTC;
|
||||
const uint8_t enable = (CHARGER_DISABLE_RECHARGE | CHARGER_DISABLE_NTC) & ~disable;
|
||||
if (this->write_register16(REG_BCHG_ISET_MSB, current, sizeof(current)) != i2c::ERROR_OK ||
|
||||
this->write_register16(REG_BCHG_ISET_DISCHARGE_MSB, discharge, sizeof(discharge)) != i2c::ERROR_OK ||
|
||||
!this->write_byte_reg16(REG_BCHG_VTERM, charger.termination_voltage) ||
|
||||
!this->write_byte_reg16(REG_BCHG_VTERM_R, charger.warm_termination_voltage) ||
|
||||
!this->write_byte_reg16(REG_BCHG_VTRICKLE_SEL, charger.trickle_voltage) ||
|
||||
!this->write_byte_reg16(REG_BCHG_ITERM_SEL, charger.termination_current) ||
|
||||
!this->write_byte_reg16(REG_BCHG_DISABLE_SET, disable) || !this->write_byte_reg16(REG_BCHG_DISABLE_CLR, enable) ||
|
||||
// Measure the battery temperature automatically while charging
|
||||
!this->write_byte_reg16(REG_ADC_TASK_AUTO_TIM_UPDATE, 1))
|
||||
return false;
|
||||
return !charger.enabled || this->set_charger_enabled(true);
|
||||
}
|
||||
|
||||
bool NPM1300Component::configure_output_(uint8_t index, const NPM1300OutputConfig &config) {
|
||||
const uint8_t channel = index & 1;
|
||||
if (index < 2) {
|
||||
// The software voltage replaces the one set by the VSET pin only once its SWCTRLSEL bit is set
|
||||
if (config.voltage != NPM1300_UNSET &&
|
||||
(!this->write_byte_reg16(REG_BUCK1_NORM_VOUT + channel * 2, config.voltage) ||
|
||||
!this->update_register16(REG_BUCK_SW_CTRL_SEL, 1 << channel, 1 << channel)))
|
||||
return false;
|
||||
} else if ((config.voltage != NPM1300_UNSET &&
|
||||
!this->write_byte_reg16(REG_LDSW1_VOUT_SEL + channel, config.voltage)) ||
|
||||
(config.ldo_mode != NPM1300_UNSET &&
|
||||
!this->write_byte_reg16(REG_LDSW1_LDO_SEL + channel, config.ldo_mode))) {
|
||||
return false;
|
||||
}
|
||||
return config.enabled == NPM1300_UNSET ||
|
||||
this->set_output_enabled(static_cast<NPM1300Output>(index), config.enabled != 0);
|
||||
}
|
||||
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
bool NPM1300Component::read_charge_currents_() {
|
||||
uint8_t charge[2];
|
||||
uint8_t discharge[2];
|
||||
if (this->read_register16(REG_BCHG_ISET_MSB, charge, sizeof(charge)) != i2c::ERROR_OK ||
|
||||
this->read_register16(REG_BCHG_ISET_DISCHARGE_MSB, discharge, sizeof(discharge)) != i2c::ERROR_OK)
|
||||
return false;
|
||||
this->charge_code_ = join_9bit(charge);
|
||||
this->discharge_limit_high_ = discharge_limit_ma(join_9bit(discharge)) == 1000;
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
|
||||
bool NPM1300Component::set_charger_enabled(bool enabled) {
|
||||
if (this->is_failed())
|
||||
return false;
|
||||
if (!enabled)
|
||||
return this->write_byte_reg16(REG_BCHG_ENABLE_CLR, 1);
|
||||
// A charger error stops the charger until the error is cleared and the charger released
|
||||
return this->write_byte_reg16(REG_BCHG_TASK_CLEAR_CHG_ERR, 1) &&
|
||||
this->write_byte_reg16(REG_BCHG_TASK_RELEASE_ERR, 1) && this->write_byte_reg16(REG_BCHG_ENABLE_SET, 1);
|
||||
}
|
||||
|
||||
bool NPM1300Component::set_output_enabled(NPM1300Output output, bool enabled) {
|
||||
if (this->is_failed())
|
||||
return false;
|
||||
const uint8_t index = static_cast<uint8_t>(output);
|
||||
// A pair of SET and CLR task registers per output
|
||||
const uint16_t base = index < 2 ? REG_BUCK1_ENA_SET : REG_LDSW1_TASK_SET;
|
||||
const uint16_t reg = base + (index & 1) * 2 + (enabled ? 0 : 1);
|
||||
if (!this->write_byte_reg16(reg, 1)) {
|
||||
ESP_LOGW(TAG, "Turning output %u %s failed", index, enabled ? LOG_STR_LITERAL("on") : LOG_STR_LITERAL("off"));
|
||||
return false;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
void NPM1300Component::enter_ship_mode() {
|
||||
ESP_LOGI(TAG, "Entering ship mode");
|
||||
this->write_byte_reg16(REG_SHIP_TASK_SHIP_MODE, 1);
|
||||
}
|
||||
|
||||
void NPM1300Component::hibernate(uint32_t duration_ms) {
|
||||
// A zero period would never wake the chip
|
||||
const uint32_t ticks = std::clamp<uint32_t>(duration_ms / TIMER_TICK_MS, 1, TIMER_MAX_TICKS);
|
||||
uint8_t timer[3];
|
||||
put_be24(timer, ticks);
|
||||
ESP_LOGI(TAG, "Hibernating for %" PRIu32 " ms", ticks * TIMER_TICK_MS);
|
||||
if (!this->write_byte_reg16(REG_TIMER_CONFIG, TIMER_CONFIG_WAKEUP) ||
|
||||
this->write_register16(REG_TIMER_HI_BYTE, timer, sizeof(timer)) != i2c::ERROR_OK ||
|
||||
!this->write_byte_reg16(REG_TIMER_TARGET_STROBE, 1)) {
|
||||
ESP_LOGW(TAG, "Setting the wake-up timer failed");
|
||||
return;
|
||||
}
|
||||
// The timer needs a moment to load the new period
|
||||
delay(1);
|
||||
this->write_byte_reg16(REG_SHIP_TASK_HIBERNATE, 1);
|
||||
}
|
||||
|
||||
void NPM1300Component::update() {
|
||||
uint8_t vbus_status;
|
||||
uint8_t charge_status;
|
||||
uint8_t error_reason;
|
||||
if (!this->status_comm_check(this->read_byte_reg16(REG_VBUSIN_STATUS, &vbus_status) &&
|
||||
this->read_byte_reg16(REG_BCHG_CHARGE_STATUS, &charge_status) &&
|
||||
this->read_byte_reg16(REG_BCHG_ERR_REASON, &error_reason)))
|
||||
return;
|
||||
|
||||
// The chip goes back to its default VBUS current limit whenever VBUS is removed
|
||||
const bool vbus_present = (vbus_status & VBUS_PRESENT) != 0;
|
||||
if (vbus_present && !this->vbus_present_ && this->vbus_current_limit_ != NPM1300_UNSET &&
|
||||
!this->status_comm_check(this->apply_vbus_current_limit_()))
|
||||
return;
|
||||
this->vbus_present_ = vbus_present;
|
||||
|
||||
if (error_reason != this->last_error_reason_) {
|
||||
this->last_error_reason_ = error_reason;
|
||||
if (error_reason != 0) {
|
||||
ESP_LOGW(TAG, "Charger error, BCHGERRREASON 0x%02X", error_reason);
|
||||
}
|
||||
}
|
||||
#ifdef USE_NPM1300_STATUS_PUBLISHER
|
||||
if (this->status_publisher_ != nullptr)
|
||||
this->status_publisher_(vbus_status, charge_status, error_reason);
|
||||
#endif
|
||||
#ifdef USE_SWITCH
|
||||
if (!this->status_comm_check(this->publish_switches_()))
|
||||
return;
|
||||
#endif
|
||||
|
||||
#ifdef USE_SENSOR
|
||||
if (this->vbus_current_limit_sensor_ != nullptr) {
|
||||
uint8_t code;
|
||||
if (!this->status_comm_check(this->read_byte_reg16(REG_VBUSIN_ILIM0, &code)))
|
||||
return;
|
||||
// 100 mA per step of the code, but code 0 is 500 mA
|
||||
const uint16_t milliamps = code == 0 ? 500 : code * 100;
|
||||
this->vbus_current_limit_sensor_->publish_state(milliamps / 1000.0f);
|
||||
}
|
||||
#endif
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
if (this->data_publisher_ != nullptr) {
|
||||
// Start the battery voltage (followed by the battery current), NTC, die temperature and system voltage
|
||||
// conversions, then the VBUS one
|
||||
static constexpr uint8_t START[4] = {1, 1, 1, 1};
|
||||
if (!this->status_comm_check(this->write_register16(REG_ADC_TASK_VBAT, START, sizeof(START)) == i2c::ERROR_OK &&
|
||||
this->write_byte_reg16(REG_ADC_TASK_VBUS, 1)))
|
||||
return;
|
||||
this->set_timeout(READ_TIMEOUT_ID, CONVERSION_TIME_MS, [this]() { this->read_measurements_(); });
|
||||
return;
|
||||
}
|
||||
#endif
|
||||
this->status_comm_result(true);
|
||||
}
|
||||
|
||||
#ifdef USE_SWITCH
|
||||
bool NPM1300Component::publish_switches_() {
|
||||
uint8_t value;
|
||||
bool ok = true;
|
||||
if (this->charger_switch_ != nullptr) {
|
||||
if (this->read_byte_reg16(REG_BCHG_ENABLE_SET, &value)) {
|
||||
this->charger_switch_->publish_state((value & 1) != 0);
|
||||
} else {
|
||||
ok = false;
|
||||
}
|
||||
}
|
||||
switch_::Switch *const bucks[2] = {this->buck1_switch_, this->buck2_switch_};
|
||||
if (bucks[0] != nullptr || bucks[1] != nullptr) {
|
||||
if (this->read_byte_reg16(REG_BUCK_STATUS, &value)) {
|
||||
for (uint8_t i = 0; i < 2; i++)
|
||||
PUBLISH_STATE(bucks[i], (value & BUCK_POWER_GOOD[i]) != 0);
|
||||
} else {
|
||||
ok = false;
|
||||
}
|
||||
}
|
||||
switch_::Switch *const ldos[2] = {this->ldo1_switch_, this->ldo2_switch_};
|
||||
if (ldos[0] != nullptr || ldos[1] != nullptr) {
|
||||
if (this->read_byte_reg16(REG_LDSW_STATUS, &value)) {
|
||||
for (uint8_t i = 0; i < 2; i++)
|
||||
PUBLISH_STATE(ldos[i], (value & LDSW_POWERED[i]) != 0);
|
||||
} else {
|
||||
ok = false;
|
||||
}
|
||||
}
|
||||
return ok;
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
void NPM1300Component::read_measurements_() {
|
||||
// ADCIBATMEASSTATUS, then the VBAT, NTC, TEMP and VSYS results, their low bits, VBAT0 to VBAT3 (VBAT2 holds the
|
||||
// battery current and VBAT3 the VBUS voltage) and their low bits
|
||||
uint8_t adc[11];
|
||||
if (!this->status_comm_result(this->read_register16(REG_ADC_RESULTS, adc, sizeof(adc)) == i2c::ERROR_OK))
|
||||
return;
|
||||
// Amperes per code of the battery current, positive while charging and negative while discharging
|
||||
float ibat_scale = NAN;
|
||||
// Any other mode means the system runs from VBUS and the battery current is not measured
|
||||
const uint8_t mode = (adc[0] >> IBAT_MODE_SHIFT) & 0x03;
|
||||
if ((adc[0] & IBAT_MEAS_INVALID) == 0) {
|
||||
if (mode == IBAT_MODE_CHARGE) {
|
||||
ibat_scale = this->charge_code_ * (2 * CHARGE_FULL_SCALE_FACTOR) / (ADC_MAX_CODE * 1000.0f);
|
||||
} else if (mode == IBAT_MODE_DISCHARGE) {
|
||||
ibat_scale = -(this->discharge_limit_high_ ? 1000 : 200) * DISCHARGE_FULL_SCALE_FACTOR / (ADC_MAX_CODE * 1000.0f);
|
||||
}
|
||||
}
|
||||
if (this->data_publisher_ != nullptr)
|
||||
this->data_publisher_(adc, ibat_scale);
|
||||
}
|
||||
#endif
|
||||
|
||||
// BCHGVTERM: 3.50 V to 3.65 V, then 4.00 V to 4.45 V, both in 50 mV steps
|
||||
static uint16_t termination_voltage_mv(uint8_t code) { return code < 4 ? 3500 + 50 * code : 4000 + 50 * (code - 4); }
|
||||
|
||||
static const LogString *output_name(uint8_t index) {
|
||||
switch (static_cast<NPM1300Output>(index)) {
|
||||
case NPM1300Output::NPM1300_OUTPUT_BUCK1:
|
||||
return LOG_STR("BUCK1");
|
||||
case NPM1300Output::NPM1300_OUTPUT_BUCK2:
|
||||
return LOG_STR("BUCK2");
|
||||
case NPM1300Output::NPM1300_OUTPUT_LDO1:
|
||||
return LOG_STR("LDO1");
|
||||
default:
|
||||
return LOG_STR("LDO2");
|
||||
}
|
||||
}
|
||||
|
||||
void NPM1300Component::dump_config() {
|
||||
ESP_LOGCONFIG(TAG, "nPM1300:");
|
||||
LOG_I2C_DEVICE(this);
|
||||
LOG_UPDATE_INTERVAL(this);
|
||||
if (this->vbus_current_limit_ != NPM1300_UNSET) {
|
||||
// 100 mA per step of the code
|
||||
ESP_LOGCONFIG(TAG, " VBUS current limit: %u mA", this->vbus_current_limit_ * 100u);
|
||||
}
|
||||
const NPM1300Config config = this->load_config_();
|
||||
if (config.charger_configured) {
|
||||
const NPM1300ChargerConfig &charger = config.charger;
|
||||
ESP_LOGCONFIG(TAG,
|
||||
" Charger:\n"
|
||||
" Current: %u mA\n"
|
||||
" Discharge limit: %u mA\n"
|
||||
" Termination voltage: %u mV\n"
|
||||
" Warm termination voltage: %u mV\n"
|
||||
" Termination current: %u%%\n"
|
||||
" Trickle voltage: %u mV\n"
|
||||
" Enabled: %s\n"
|
||||
" Recharge: %s",
|
||||
charger.current * 2u, discharge_limit_ma(charger.discharge_limit),
|
||||
termination_voltage_mv(charger.termination_voltage),
|
||||
termination_voltage_mv(charger.warm_termination_voltage), charger.termination_current ? 20u : 10u,
|
||||
charger.trickle_voltage ? 2500u : 2900u, YESNO(charger.enabled), YESNO(charger.recharge));
|
||||
}
|
||||
for (uint8_t i = 0; i < NPM1300_OUTPUT_COUNT; i++) {
|
||||
const NPM1300OutputConfig &output = config.outputs[i];
|
||||
if (output.voltage == NPM1300_UNSET && output.ldo_mode == NPM1300_UNSET && output.enabled == NPM1300_UNSET)
|
||||
continue;
|
||||
ESP_LOGCONFIG(TAG, " %s:", LOG_STR_ARG(output_name(i)));
|
||||
if (output.voltage != NPM1300_UNSET) {
|
||||
ESP_LOGCONFIG(TAG, " Voltage: %u mV", 1000u + output.voltage * 100u);
|
||||
}
|
||||
if (output.ldo_mode != NPM1300_UNSET) {
|
||||
ESP_LOGCONFIG(TAG, " Mode: %s",
|
||||
output.ldo_mode != 0 ? LOG_STR_LITERAL("LDO") : LOG_STR_LITERAL("load switch"));
|
||||
}
|
||||
if (output.enabled != NPM1300_UNSET) {
|
||||
ESP_LOGCONFIG(TAG, " Enabled at boot: %s", YESNO(output.enabled != 0));
|
||||
}
|
||||
}
|
||||
if (config.thermistor != NPM1300_UNSET) {
|
||||
ESP_LOGCONFIG(TAG, " Thermistor B constant: %u", config.thermistor_beta);
|
||||
}
|
||||
#ifdef USE_SENSOR
|
||||
LOG_SENSOR(" ", "VBUS Current Limit", this->vbus_current_limit_sensor_);
|
||||
#endif
|
||||
#ifdef USE_SWITCH
|
||||
LOG_SWITCH(" ", "Charger", this->charger_switch_);
|
||||
LOG_SWITCH(" ", "BUCK1", this->buck1_switch_);
|
||||
LOG_SWITCH(" ", "BUCK2", this->buck2_switch_);
|
||||
LOG_SWITCH(" ", "LDO1", this->ldo1_switch_);
|
||||
LOG_SWITCH(" ", "LDO2", this->ldo2_switch_);
|
||||
#endif
|
||||
#if defined(USE_NPM1300_STATUS_PUBLISHER) || defined(USE_NPM1300_DATA_PUBLISHER)
|
||||
if (this->dump_publisher_ != nullptr)
|
||||
this->dump_publisher_(TAG);
|
||||
#endif
|
||||
}
|
||||
|
||||
} // namespace esphome::npm1300
|
||||
@@ -1,145 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
// Product specification: https://docs.nordicsemi.com/bundle/ps_npm1300/page/keyfeatures_html5.html
|
||||
|
||||
#include "esphome/components/i2c/i2c.h"
|
||||
#include "esphome/core/component.h"
|
||||
#include "esphome/core/defines.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#ifdef USE_SENSOR
|
||||
#include "esphome/components/sensor/sensor.h"
|
||||
#endif
|
||||
#ifdef USE_TEXT_SENSOR
|
||||
#include "esphome/components/text_sensor/text_sensor.h"
|
||||
#endif
|
||||
#ifdef USE_SWITCH
|
||||
#include "esphome/components/switch/switch.h"
|
||||
#endif
|
||||
|
||||
namespace esphome::npm1300 {
|
||||
|
||||
/// The regulators, in the order of their enable task registers
|
||||
enum class NPM1300Output : uint8_t {
|
||||
NPM1300_OUTPUT_BUCK1 = 0,
|
||||
NPM1300_OUTPUT_BUCK2 = 1,
|
||||
NPM1300_OUTPUT_LDO1 = 2,
|
||||
NPM1300_OUTPUT_LDO2 = 3,
|
||||
};
|
||||
static constexpr uint8_t NPM1300_OUTPUT_COUNT = 4;
|
||||
|
||||
/// A configuration field the YAML leaves out, so the chip keeps its own value
|
||||
static constexpr uint8_t NPM1300_UNSET = 0xFF;
|
||||
|
||||
/// Register codes for one regulator, NPM1300_UNSET where the YAML leaves the field out
|
||||
struct NPM1300OutputConfig {
|
||||
uint8_t voltage; // VOUT: (millivolts - 1000) / 100
|
||||
uint8_t ldo_mode; // LDSWxLDOSEL, LDO1 and LDO2 only: 1 LDO, 0 load switch
|
||||
uint8_t enabled; // turned on (1) or off (0) at boot
|
||||
};
|
||||
|
||||
/// Register codes for the battery charger
|
||||
struct NPM1300ChargerConfig {
|
||||
uint16_t current; // BCHGISET: milliamperes / 2
|
||||
uint16_t discharge_limit; // BCHGISETDISCHARGE: 84 for 200 mA, 415 for 1000 mA
|
||||
uint8_t termination_voltage; // BCHGVTERM
|
||||
uint8_t warm_termination_voltage; // BCHGVTERMR
|
||||
uint8_t trickle_voltage; // BCHGVTRICKLESEL: 0 for 2.9 V, 1 for 2.5 V
|
||||
uint8_t termination_current; // BCHGITERMSEL: 0 for 10 %, 1 for 20 %
|
||||
bool recharge;
|
||||
bool enabled;
|
||||
};
|
||||
|
||||
/// The settings applied in setup(), built by code generation into a PROGMEM table
|
||||
struct NPM1300Config {
|
||||
NPM1300OutputConfig outputs[NPM1300_OUTPUT_COUNT];
|
||||
NPM1300ChargerConfig charger; // only applied when charger_configured
|
||||
uint16_t thermistor_beta;
|
||||
uint8_t thermistor; // ADCNTCRSEL code: 1 for 10 kOhm, 2 for 47 kOhm, 3 for 100 kOhm, or NPM1300_UNSET
|
||||
bool charger_configured;
|
||||
};
|
||||
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
/// The 10-bit ADC result whose high 8 bits are adc[msb] and low 2 bits are at `shift` in adc[lsbs]
|
||||
inline uint16_t adc_code(const uint8_t *adc, uint8_t msb, uint8_t lsbs, uint8_t shift) {
|
||||
return (adc[msb] << 2) | ((adc[lsbs] >> shift) & 0x03);
|
||||
}
|
||||
/// Battery temperature in degrees Celsius from the NTC code and 1 / B constant of the thermistor
|
||||
float ntc_temperature(uint16_t code, float inv_beta);
|
||||
#endif
|
||||
#ifdef USE_TEXT_SENSOR
|
||||
/// Publish the charger status text, only when it differs from `last`
|
||||
void publish_charger_status(text_sensor::TextSensor *sensor, uint8_t &last, uint8_t vbus_status, uint8_t charge_status,
|
||||
uint8_t error_reason);
|
||||
#endif
|
||||
|
||||
class NPM1300Component : public PollingComponent, public i2c::I2CDevice {
|
||||
#ifdef USE_SENSOR
|
||||
SUB_SENSOR(vbus_current_limit)
|
||||
#endif
|
||||
#ifdef USE_SWITCH
|
||||
SUB_SWITCH(charger)
|
||||
SUB_SWITCH(buck1)
|
||||
SUB_SWITCH(buck2)
|
||||
SUB_SWITCH(ldo1)
|
||||
SUB_SWITCH(ldo2)
|
||||
#endif
|
||||
|
||||
public:
|
||||
/// `config` points into PROGMEM
|
||||
explicit NPM1300Component(const NPM1300Config *config) : config_(config) {}
|
||||
|
||||
void setup() override;
|
||||
void update() override;
|
||||
void dump_config() override;
|
||||
// Right after the I2C bus: the regulators may power other peripherals
|
||||
float get_setup_priority() const override { return setup_priority::BUS - 1.0f; }
|
||||
|
||||
#ifdef USE_NPM1300_STATUS_PUBLISHER
|
||||
HUB_PUBLISHER(status, uint8_t, uint8_t, uint8_t)
|
||||
#endif
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
HUB_PUBLISHER(data, const uint8_t *, float)
|
||||
#endif
|
||||
#if defined(USE_NPM1300_STATUS_PUBLISHER) || defined(USE_NPM1300_DATA_PUBLISHER)
|
||||
HUB_PUBLISHER(dump, const char *)
|
||||
#endif
|
||||
|
||||
/// VBUSINILIM0 code: 100 mA per step (code 0, the reset value, is 500 mA)
|
||||
void set_vbus_current_limit(uint8_t code) { this->vbus_current_limit_ = code; }
|
||||
|
||||
/// Turn the battery charger on or off; turning it on also clears a charger error
|
||||
bool set_charger_enabled(bool enabled);
|
||||
/// Turn a regulator on or off
|
||||
bool set_output_enabled(NPM1300Output output, bool enabled);
|
||||
/// Enter ship mode: every output is turned off until the SHPHLD button is pressed or VBUS is connected
|
||||
void enter_ship_mode();
|
||||
/// Enter hibernate mode: every output is turned off for `duration_ms`, or until the SHPHLD button is
|
||||
/// pressed or VBUS is connected
|
||||
void hibernate(uint32_t duration_ms);
|
||||
|
||||
protected:
|
||||
NPM1300Config load_config_() const;
|
||||
bool apply_vbus_current_limit_();
|
||||
bool configure_charger_(const NPM1300Config &config);
|
||||
bool configure_output_(uint8_t index, const NPM1300OutputConfig &config);
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
bool read_charge_currents_();
|
||||
void read_measurements_();
|
||||
#endif
|
||||
#ifdef USE_SWITCH
|
||||
/// Returns false when a status read failed
|
||||
bool publish_switches_();
|
||||
#endif
|
||||
|
||||
const NPM1300Config *config_;
|
||||
#ifdef USE_NPM1300_DATA_PUBLISHER
|
||||
// BCHGISET code and discharge limit, for the full scale of the battery current measurement
|
||||
uint16_t charge_code_{0};
|
||||
bool discharge_limit_high_{false};
|
||||
#endif
|
||||
uint8_t vbus_current_limit_{NPM1300_UNSET};
|
||||
uint8_t last_error_reason_{0};
|
||||
bool vbus_present_{false};
|
||||
};
|
||||
|
||||
} // namespace esphome::npm1300
|
||||
@@ -1,151 +0,0 @@
|
||||
from esphome.automation import parent_ref
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import sensor
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import (
|
||||
CONF_BATTERY_VOLTAGE,
|
||||
CONF_ID,
|
||||
DEVICE_CLASS_CURRENT,
|
||||
DEVICE_CLASS_TEMPERATURE,
|
||||
DEVICE_CLASS_VOLTAGE,
|
||||
ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
STATE_CLASS_MEASUREMENT,
|
||||
UNIT_AMPERE,
|
||||
UNIT_CELSIUS,
|
||||
UNIT_VOLT,
|
||||
)
|
||||
from esphome.core import CORE
|
||||
import esphome.final_validate as fv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from . import (
|
||||
ADC,
|
||||
CONF_NPM1300_ID,
|
||||
CONF_THERMISTOR_BETA,
|
||||
CONF_THERMISTOR_RESISTANCE,
|
||||
CONF_VBUS_CURRENT_LIMIT,
|
||||
DATA_PUBLISHER,
|
||||
DOMAIN,
|
||||
DUMP,
|
||||
DUMP_TAG,
|
||||
IBAT_SCALE,
|
||||
NPM1300_CHILD_SCHEMA,
|
||||
npm1300_ns,
|
||||
)
|
||||
|
||||
DEPENDENCIES = ["npm1300"]
|
||||
|
||||
CONF_BATTERY_CURRENT = "battery_current"
|
||||
CONF_BATTERY_TEMPERATURE = "battery_temperature"
|
||||
CONF_DIE_TEMPERATURE = "die_temperature"
|
||||
CONF_SYSTEM_VOLTAGE = "system_voltage"
|
||||
CONF_VBUS_VOLTAGE = "vbus_voltage"
|
||||
|
||||
ADC_MAX_CODE = 1023
|
||||
|
||||
|
||||
def _adc(msb: int, lsbs: int, shift: int) -> cg.MockObj:
|
||||
"""The 10-bit result in adc[msb] and bits shift..shift+1 of adc[lsbs]."""
|
||||
return npm1300_ns.adc_code(ADC, msb, lsbs, shift)
|
||||
|
||||
|
||||
# The decoded value and the dump name of each ADC sensor but the battery temperature, which needs the hub config.
|
||||
# Voltages scale by their full scale (product specification, section ADC).
|
||||
STATES = {
|
||||
CONF_BATTERY_VOLTAGE: (_adc(1, 5, 0) * (5.0 / ADC_MAX_CODE), "Battery Voltage"),
|
||||
CONF_BATTERY_CURRENT: (_adc(8, 10, 4) * IBAT_SCALE, "Battery Current"),
|
||||
# Product specification: T = 394.67 - 0.7926 * code
|
||||
CONF_DIE_TEMPERATURE: (394.67 - 0.7926 * _adc(3, 5, 4), "Die Temperature"),
|
||||
CONF_SYSTEM_VOLTAGE: (_adc(4, 5, 6) * (6.375 / ADC_MAX_CODE), "System Voltage"),
|
||||
CONF_VBUS_VOLTAGE: (_adc(9, 10, 6) * (7.5 / ADC_MAX_CODE), "VBUS Voltage"),
|
||||
}
|
||||
|
||||
|
||||
def _voltage_schema() -> cv.Schema:
|
||||
return sensor.sensor_schema(
|
||||
unit_of_measurement=UNIT_VOLT,
|
||||
accuracy_decimals=3,
|
||||
device_class=DEVICE_CLASS_VOLTAGE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
)
|
||||
|
||||
|
||||
def _temperature_schema(**extra: str) -> cv.Schema:
|
||||
return sensor.sensor_schema(
|
||||
unit_of_measurement=UNIT_CELSIUS,
|
||||
accuracy_decimals=1,
|
||||
device_class=DEVICE_CLASS_TEMPERATURE,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
**extra,
|
||||
)
|
||||
|
||||
|
||||
CONFIG_SCHEMA = NPM1300_CHILD_SCHEMA.extend(
|
||||
{
|
||||
cv.Optional(CONF_BATTERY_VOLTAGE): _voltage_schema(),
|
||||
cv.Optional(CONF_BATTERY_CURRENT): sensor.sensor_schema(
|
||||
unit_of_measurement=UNIT_AMPERE,
|
||||
accuracy_decimals=3,
|
||||
device_class=DEVICE_CLASS_CURRENT,
|
||||
state_class=STATE_CLASS_MEASUREMENT,
|
||||
),
|
||||
cv.Optional(CONF_BATTERY_TEMPERATURE): _temperature_schema(),
|
||||
cv.Optional(CONF_DIE_TEMPERATURE): _temperature_schema(
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC
|
||||
),
|
||||
cv.Optional(CONF_SYSTEM_VOLTAGE): _voltage_schema(),
|
||||
cv.Optional(CONF_VBUS_VOLTAGE): _voltage_schema(),
|
||||
cv.Optional(CONF_VBUS_CURRENT_LIMIT): sensor.sensor_schema(
|
||||
unit_of_measurement=UNIT_AMPERE,
|
||||
accuracy_decimals=1,
|
||||
device_class=DEVICE_CLASS_CURRENT,
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def _final_validate(config: ConfigType) -> None:
|
||||
if CONF_BATTERY_TEMPERATURE not in config:
|
||||
return
|
||||
hub = fv.get_declaring_config(config[CONF_NPM1300_ID])
|
||||
if CONF_THERMISTOR_RESISTANCE not in hub:
|
||||
raise cv.Invalid(
|
||||
f"'{CONF_BATTERY_TEMPERATURE}' needs '{CONF_THERMISTOR_RESISTANCE}' "
|
||||
"set on the npm1300 component",
|
||||
path=[CONF_BATTERY_TEMPERATURE],
|
||||
)
|
||||
|
||||
|
||||
FINAL_VALIDATE_SCHEMA = _final_validate
|
||||
|
||||
|
||||
def _add_adc_sensor(
|
||||
hub: cg.MockObj, var: cg.MockObj, state: cg.MockObj, name: str
|
||||
) -> None:
|
||||
DATA_PUBLISHER.add(hub, parent_ref(var).publish_state(state))
|
||||
DUMP.add(
|
||||
hub,
|
||||
sensor.sensor_ns.log_sensor(
|
||||
DUMP_TAG,
|
||||
" ",
|
||||
cg.RawExpression(f'LOG_STR_LITERAL("{name}")'),
|
||||
parent_ref(var),
|
||||
),
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
hub_id = config[CONF_NPM1300_ID]
|
||||
hub = await cg.get_variable(hub_id)
|
||||
sensors = sensor.sub_sensors(config)
|
||||
for key, (state, name) in STATES.items():
|
||||
if (var := await sensors(key, None)) is not None:
|
||||
_add_adc_sensor(hub, var, state, name)
|
||||
if (var := await sensors(CONF_BATTERY_TEMPERATURE, None)) is not None:
|
||||
hub_config = next(c for c in CORE.config[DOMAIN] if c[CONF_ID] == hub_id)
|
||||
state = npm1300_ns.ntc_temperature(
|
||||
_adc(2, 5, 2), 1.0 / hub_config[CONF_THERMISTOR_BETA]
|
||||
)
|
||||
_add_adc_sensor(hub, var, state, "Battery Temperature")
|
||||
await sensors(CONF_VBUS_CURRENT_LIMIT, hub.set_vbus_current_limit_sensor)
|
||||
@@ -1,95 +0,0 @@
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import switch
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import ENTITY_CATEGORY_CONFIG
|
||||
import esphome.final_validate as fv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from . import (
|
||||
CONF_BUCK1,
|
||||
CONF_BUCK2,
|
||||
CONF_CHARGER,
|
||||
CONF_LDO1,
|
||||
CONF_LDO2,
|
||||
CONF_NPM1300_ID,
|
||||
CONF_THERMISTOR_RESISTANCE,
|
||||
NPM1300_CHILD_SCHEMA,
|
||||
OUTPUTS,
|
||||
)
|
||||
|
||||
DEPENDENCIES = ["npm1300"]
|
||||
|
||||
|
||||
def _switch_schema() -> cv.Schema:
|
||||
# The switches show the state of the chip, so nothing is restored at boot
|
||||
return switch.switch_schema(
|
||||
switch.ApplySwitch,
|
||||
default_restore_mode="DISABLED",
|
||||
entity_category=ENTITY_CATEGORY_CONFIG,
|
||||
)
|
||||
|
||||
|
||||
CONFIG_SCHEMA = NPM1300_CHILD_SCHEMA.extend(
|
||||
{
|
||||
cv.Optional(CONF_CHARGER): _switch_schema(),
|
||||
cv.Optional(CONF_BUCK1): _switch_schema(),
|
||||
cv.Optional(CONF_BUCK2): _switch_schema(),
|
||||
cv.Optional(CONF_LDO1): _switch_schema(),
|
||||
cv.Optional(CONF_LDO2): _switch_schema(),
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def _final_validate(config: ConfigType) -> None:
|
||||
if CONF_CHARGER not in config:
|
||||
return
|
||||
hub = fv.get_declaring_config(config[CONF_NPM1300_ID])
|
||||
# Only the charger block turns off the NTC check, without which the charger never starts
|
||||
if CONF_CHARGER not in hub and CONF_THERMISTOR_RESISTANCE not in hub:
|
||||
raise cv.Invalid(
|
||||
f"The '{CONF_CHARGER}' switch needs a '{CONF_CHARGER}' block or "
|
||||
f"'{CONF_THERMISTOR_RESISTANCE}' on the npm1300 component",
|
||||
path=[CONF_CHARGER],
|
||||
)
|
||||
|
||||
|
||||
FINAL_VALIDATE_SCHEMA = _final_validate
|
||||
|
||||
|
||||
def _output_apply(key: str) -> str:
|
||||
return f"set_output_enabled({OUTPUTS[key]}, state)"
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
hub = await cg.get_variable(config[CONF_NPM1300_ID])
|
||||
switches = switch.sub_switches(config, parent=hub)
|
||||
await switches(
|
||||
CONF_CHARGER,
|
||||
hub.set_charger_switch,
|
||||
apply="set_charger_enabled(state)",
|
||||
publish="on_success",
|
||||
)
|
||||
await switches(
|
||||
CONF_BUCK1,
|
||||
hub.set_buck1_switch,
|
||||
apply=_output_apply(CONF_BUCK1),
|
||||
publish="on_success",
|
||||
)
|
||||
await switches(
|
||||
CONF_BUCK2,
|
||||
hub.set_buck2_switch,
|
||||
apply=_output_apply(CONF_BUCK2),
|
||||
publish="on_success",
|
||||
)
|
||||
await switches(
|
||||
CONF_LDO1,
|
||||
hub.set_ldo1_switch,
|
||||
apply=_output_apply(CONF_LDO1),
|
||||
publish="on_success",
|
||||
)
|
||||
await switches(
|
||||
CONF_LDO2,
|
||||
hub.set_ldo2_switch,
|
||||
apply=_output_apply(CONF_LDO2),
|
||||
publish="on_success",
|
||||
)
|
||||
@@ -1,63 +0,0 @@
|
||||
from esphome.automation import parent_ref
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import text_sensor
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import ICON_BATTERY
|
||||
from esphome.cpp_generator import (
|
||||
AssignmentExpression,
|
||||
HexIntLiteral,
|
||||
VariableDeclarationExpression,
|
||||
)
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from . import (
|
||||
CHARGE_STATUS,
|
||||
CONF_NPM1300_ID,
|
||||
DUMP,
|
||||
DUMP_TAG,
|
||||
ERROR_REASON,
|
||||
NPM1300_CHILD_SCHEMA,
|
||||
STATUS_PUBLISHER,
|
||||
VBUS_STATUS,
|
||||
npm1300_ns,
|
||||
)
|
||||
|
||||
DEPENDENCIES = ["npm1300"]
|
||||
|
||||
CONF_CHARGER_STATUS = "charger_status"
|
||||
|
||||
CONFIG_SCHEMA = NPM1300_CHILD_SCHEMA.extend(
|
||||
{
|
||||
cv.Optional(CONF_CHARGER_STATUS): text_sensor.text_sensor_schema(
|
||||
icon=ICON_BATTERY,
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
hub = await cg.get_variable(config[CONF_NPM1300_ID])
|
||||
text_sensors = text_sensor.sub_text_sensors(config)
|
||||
if (var := await text_sensors(CONF_CHARGER_STATUS, None)) is None:
|
||||
return
|
||||
last = cg.MockObj(f"esphome__{var}__last")
|
||||
# 0xFF so the first update publishes
|
||||
declaration = VariableDeclarationExpression(cg.uint8, "", last, static=True)
|
||||
STATUS_PUBLISHER.add(
|
||||
hub, AssignmentExpression(None, None, declaration, HexIntLiteral(0xFF))
|
||||
)
|
||||
STATUS_PUBLISHER.add(
|
||||
hub,
|
||||
npm1300_ns.publish_charger_status(
|
||||
parent_ref(var), last, VBUS_STATUS, CHARGE_STATUS, ERROR_REASON
|
||||
),
|
||||
)
|
||||
DUMP.add(
|
||||
hub,
|
||||
text_sensor.text_sensor_ns.log_text_sensor(
|
||||
DUMP_TAG,
|
||||
" ",
|
||||
cg.RawExpression('LOG_STR_LITERAL("Charger Status")'),
|
||||
parent_ref(var),
|
||||
),
|
||||
)
|
||||
@@ -1,4 +1,4 @@
|
||||
from collections.abc import Callable, Iterator
|
||||
from collections.abc import Callable
|
||||
import importlib
|
||||
import pkgutil
|
||||
from typing import Any
|
||||
@@ -6,7 +6,7 @@ from typing import Any
|
||||
import esphome.codegen as cg
|
||||
from esphome.components.const import CONF_MAX_PACKET_SIZE
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import CONF_ID, CONF_TIMEOUT
|
||||
from esphome.const import CONF_ID
|
||||
from esphome.core import CORE, ID
|
||||
from esphome.cpp_generator import MockObj, MockObjClass
|
||||
import esphome.final_validate as fv
|
||||
@@ -19,20 +19,16 @@ from .layers import (
|
||||
CONF_ADDRESSING,
|
||||
CONF_DESTINATION,
|
||||
CONF_PEERS,
|
||||
CONF_RELIABILITY,
|
||||
CONF_SESSION,
|
||||
STACK_ORDER,
|
||||
PacketInterface,
|
||||
build_stack,
|
||||
check_packet_sizes,
|
||||
check_session,
|
||||
check_single_peer,
|
||||
layer_needing_session,
|
||||
packet_interface_ns,
|
||||
stack_auto_load,
|
||||
stack_schema,
|
||||
)
|
||||
from .layers.hdlc_reliability import DEFAULT_TIMEOUT, check_ack_delay
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DOMAIN = "packet_interface"
|
||||
@@ -44,9 +40,6 @@ CONF_PACKET_INTERFACE = "packet_interface"
|
||||
for module_info in pkgutil.iter_modules(layers.__path__):
|
||||
importlib.import_module(f".layers.{module_info.name}", package=__package__)
|
||||
|
||||
# The layer keys that each link class does itself, by class name
|
||||
_PROVIDED_LAYERS: dict[str, tuple[str, ...]] = {}
|
||||
|
||||
LINK_LAYER_SCHEMAS = {
|
||||
cv.Optional(CONF_ADDRESSING): ADDRESSING.schema(),
|
||||
**stack_schema(),
|
||||
@@ -55,7 +48,6 @@ LINK_LAYER_SCHEMAS = {
|
||||
__all__ = [
|
||||
"CONF_MAX_PACKET_SIZE",
|
||||
"CONF_PACKET_INTERFACE",
|
||||
"interface_has_layer",
|
||||
"interface_layers",
|
||||
"interface_packet_size",
|
||||
"PacketInterface",
|
||||
@@ -150,14 +142,6 @@ def interface_packet_size(interface_id: ID) -> int:
|
||||
return check_packet_sizes(layers_config, size)
|
||||
|
||||
|
||||
def interface_has_layer(interface_id: ID, key: str) -> bool:
|
||||
"""During final validation, whether the packet interface with this id has the layer, configured or done by its link."""
|
||||
link, layers_config = _find_interface(interface_id, fv.full_config.get())
|
||||
return key in layers_config or key in _PROVIDED_LAYERS.get(
|
||||
str(link[CONF_ID].type), ()
|
||||
)
|
||||
|
||||
|
||||
def final_validate_interface(key: str) -> Callable[[ConfigType], ConfigType]:
|
||||
"""Final validation for an application: a link with peers must be used through one of the peers."""
|
||||
|
||||
@@ -174,73 +158,25 @@ def final_validate_interface(key: str) -> Callable[[ConfigType], ConfigType]:
|
||||
return validator
|
||||
|
||||
|
||||
def _check_provided_session(config: ConfigType) -> ConfigType:
|
||||
"""A link's own session does not send packets through the layers, so none can need them from the peer."""
|
||||
if key := layer_needing_session(config):
|
||||
raise cv.Invalid(
|
||||
f"This '{key}' needs packets from the peer, which this link does not send through its layers, "
|
||||
"so it cannot be used on this link",
|
||||
path=[key],
|
||||
)
|
||||
return config
|
||||
|
||||
|
||||
def reliability_layers(config: ConfigType) -> Iterator[tuple[list, ConfigType]]:
|
||||
"""The reliability layers on a link and in its peers, each with its path in the link's configuration."""
|
||||
if (layer := config.get(CONF_RELIABILITY)) is not None:
|
||||
yield [CONF_RELIABILITY], layer
|
||||
for index, peer in enumerate(config.get(CONF_ADDRESSING, {}).get(CONF_PEERS, [])):
|
||||
if (layer := peer.get(CONF_RELIABILITY)) is not None:
|
||||
yield [CONF_ADDRESSING, CONF_PEERS, index, CONF_RELIABILITY], layer
|
||||
|
||||
|
||||
def _check_default_ack_delays(config: ConfigType) -> ConfigType:
|
||||
"""A reliability layer without a timeout uses the default one on this link."""
|
||||
for path, layer in reliability_layers(config):
|
||||
if CONF_TIMEOUT not in layer:
|
||||
try:
|
||||
check_ack_delay(layer, DEFAULT_TIMEOUT)
|
||||
except cv.Invalid as err:
|
||||
err.prepend(path)
|
||||
raise
|
||||
return config
|
||||
|
||||
|
||||
def packet_interface_schema(
|
||||
class_: MockObjClass,
|
||||
default_max_packet_size: int,
|
||||
max_packet_size_limit: int = 4096,
|
||||
provides: tuple[str, ...] = (),
|
||||
chooses_reliability_timeout: bool = False,
|
||||
) -> cv.Schema:
|
||||
"""Schema for a link platform; provides names the layer keys, such as reliability, that the link does itself.
|
||||
|
||||
chooses_reliability_timeout is for a link that works out a reliability timeout of its own, when none is set.
|
||||
"""
|
||||
if provides:
|
||||
_PROVIDED_LAYERS[str(class_)] = provides
|
||||
link_layers = {
|
||||
key: (
|
||||
cv.invalid(f"This link provides '{key}' itself, so it cannot be configured")
|
||||
if key in provides
|
||||
else schema
|
||||
"""Schema for a link platform, with the layers that can be stacked on it."""
|
||||
return (
|
||||
cv.Schema(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(class_),
|
||||
cv.Optional(
|
||||
CONF_MAX_PACKET_SIZE, default=default_max_packet_size
|
||||
): cv.int_range(16, max_packet_size_limit),
|
||||
**LINK_LAYER_SCHEMAS,
|
||||
}
|
||||
)
|
||||
for key, schema in LINK_LAYER_SCHEMAS.items()
|
||||
}
|
||||
schema = cv.Schema(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(class_),
|
||||
cv.Optional(
|
||||
CONF_MAX_PACKET_SIZE, default=default_max_packet_size
|
||||
): cv.int_range(16, max_packet_size_limit),
|
||||
**link_layers,
|
||||
}
|
||||
).extend(cv.COMPONENT_SCHEMA)
|
||||
if CONF_SESSION in provides:
|
||||
schema = schema.add_extra(_check_provided_session)
|
||||
if not chooses_reliability_timeout:
|
||||
schema = schema.add_extra(_check_default_ack_delays)
|
||||
return schema.add_extra(_validate_layers)
|
||||
.extend(cv.COMPONENT_SCHEMA)
|
||||
.add_extra(_validate_layers)
|
||||
)
|
||||
|
||||
|
||||
async def new_packet_interface(config: ConfigType, *args: Any) -> MockObj:
|
||||
|
||||
@@ -88,12 +88,8 @@ bool BasicFragmentation::send_(const PacketBuffer &data, const PacketMetaData &m
|
||||
header[1] = index | (index + 1 == fragments ? LAST_FRAGMENT : 0);
|
||||
PacketBuffer body(this->tx_buffer_, length);
|
||||
if (!this->lower_->send_to_interface(PacketBuffer(header, HEADER_SIZE, &body, nullptr, 0), meta_data)) {
|
||||
if (index == 0) {
|
||||
ESP_LOGV(TAG, "%s: Fragment 0 of %zu not accepted", this->name_, fragments);
|
||||
} else {
|
||||
// The peer drops the part already sent when the next packet starts
|
||||
ESP_LOGW(TAG, "%s: Packet cut short, fragment %zu of %zu not accepted", this->name_, index, fragments);
|
||||
}
|
||||
// The peer drops the part already sent when the next packet starts
|
||||
ESP_LOGV(TAG, "%s: Fragment %zu of %zu not accepted", this->name_, index, fragments);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -161,7 +161,7 @@ bool HdlcReliability::send_supervisory_(uint8_t type) {
|
||||
// components run between frames: on a radio, sending blocks, and the peer's frames are received in between. If the
|
||||
// lower layer refuses the frame, it is sent again shortly.
|
||||
bool HdlcReliability::send_pending_() {
|
||||
if (this->vn_ == this->vs_ || (this->resend_held_ && this->vn_ != this->va_))
|
||||
if (this->vn_ == this->vs_)
|
||||
return true;
|
||||
uint8_t control = (this->vn_ << 1) | (this->vr_ << 5);
|
||||
if (!this->send_frame_(control, this->slot_(this->vn_), this->tx_lengths_[this->slot_index_(this->vn_)])) {
|
||||
@@ -178,15 +178,6 @@ bool HdlcReliability::send_pending_() {
|
||||
}
|
||||
|
||||
void HdlcReliability::resend_outstanding_() {
|
||||
this->resend_held_ = false;
|
||||
this->vn_ = this->va_;
|
||||
this->send_pending_();
|
||||
}
|
||||
|
||||
// Resending the whole queue after every timeout lets two peers whose acknowledgements were lost keep sending long
|
||||
// bursts that collide again. The peer answers the oldest frame with its N(R), which also covers frames it already has.
|
||||
void HdlcReliability::resend_oldest_() {
|
||||
this->resend_held_ = true;
|
||||
this->vn_ = this->va_;
|
||||
this->send_pending_();
|
||||
}
|
||||
@@ -222,8 +213,8 @@ void HdlcReliability::on_timeout_() {
|
||||
return;
|
||||
}
|
||||
this->retries_++;
|
||||
ESP_LOGV(TAG, "%s: Timeout, resending frame %u, %u unacknowledged", this->name_, this->va_, this->outstanding_());
|
||||
this->resend_oldest_();
|
||||
ESP_LOGV(TAG, "%s: Timeout, resending %u frames", this->name_, this->outstanding_());
|
||||
this->resend_outstanding_();
|
||||
this->start_timer_();
|
||||
}
|
||||
|
||||
@@ -237,7 +228,6 @@ void HdlcReliability::start_reset_() {
|
||||
this->vr_ = 0;
|
||||
this->retries_ = 0;
|
||||
this->rej_sent_ = false;
|
||||
this->resend_held_ = false;
|
||||
this->ack_sent_();
|
||||
this->cancel_timeout(RETRANSMIT_TIMER_ID);
|
||||
this->request_loop_();
|
||||
@@ -272,11 +262,6 @@ void HdlcReliability::process_ack_(uint8_t nr) {
|
||||
this->head_ = (this->head_ + acked) % this->max_queue_length_;
|
||||
this->va_ = nr;
|
||||
this->retries_ = 0;
|
||||
if (this->resend_held_) {
|
||||
this->resend_held_ = false;
|
||||
if (this->vn_ != this->vs_)
|
||||
this->request_loop_();
|
||||
}
|
||||
if (this->outstanding_() == 0) {
|
||||
this->cancel_timeout(RETRANSMIT_TIMER_ID);
|
||||
} else {
|
||||
@@ -298,7 +283,7 @@ void HdlcReliability::receive_(const PacketBuffer &data, const PacketMetaData &m
|
||||
size_t length = frame.size() - FRAME_OVERHEAD;
|
||||
uint8_t control = frame[0];
|
||||
const uint8_t *payload = frame.data() + 1;
|
||||
uint16_t crc = encode_value_le<uint16_t>(frame.data() + length + 1);
|
||||
uint16_t crc = frame[length + 1] | (frame[length + 2] << 8);
|
||||
if (frame_crc(control, payload, length) != crc) {
|
||||
ESP_LOGV(TAG, "%s: CRC error, frame dropped", this->name_);
|
||||
this->note_received_(false);
|
||||
|
||||
@@ -17,8 +17,7 @@ namespace esphome::packet_interface {
|
||||
* - SABM resets both peers' sequence numbers, and UA answers it.
|
||||
*
|
||||
* Each frame is the HDLC control byte, the payload, then a CRC-16 of both in little endian order.
|
||||
* After the timeout the oldest unacknowledged frame is resent, and the rest follow once the peer answers it, so
|
||||
* a lost acknowledgement costs one frame of airtime. After max_retries the link is reset.
|
||||
* Unacknowledged frames are resent after the timeout; after max_retries the link is reset.
|
||||
*/
|
||||
class HdlcReliability : public PacketInterface {
|
||||
public:
|
||||
@@ -64,7 +63,6 @@ class HdlcReliability : public PacketInterface {
|
||||
bool send_supervisory_(uint8_t type);
|
||||
bool send_pending_();
|
||||
void resend_outstanding_();
|
||||
void resend_oldest_();
|
||||
void retry_send_();
|
||||
/// An RR is owed: at once, or after the ack delay unless an I-frame carries it first.
|
||||
void owe_ack_(bool now);
|
||||
@@ -98,7 +96,6 @@ class HdlcReliability : public PacketInterface {
|
||||
bool ack_pending_ : 1 {false}; // an RR is owed
|
||||
bool ack_due_ : 1 {false}; // and should be sent now
|
||||
bool rej_sent_ : 1 {false};
|
||||
bool resend_held_ : 1 {false}; // only the oldest frame is resent until the peer acknowledges something
|
||||
bool peer_frame_seen_ : 1 {false}; // a numbered frame has arrived since the link came up
|
||||
bool oversize_warned_ : 1 {false};
|
||||
bool reset_wait_logged_ : 1 {false}; // the queue filled while waiting for this reset to be answered
|
||||
|
||||
@@ -176,24 +176,19 @@ def stack_schema() -> dict:
|
||||
return {cv.Optional(kind.key): kind.schema() for kind in STACK_ORDER}
|
||||
|
||||
|
||||
def layer_needing_session(config: ConfigType) -> str | None:
|
||||
"""The key of the first layer in this stack that needs packets back from the peer, if any."""
|
||||
def check_session(config: ConfigType) -> None:
|
||||
"""Layers that need packets back from the peer need a session layer, whose keep-alives send them."""
|
||||
if CONF_SESSION in config:
|
||||
return
|
||||
for kind in STACK_ORDER:
|
||||
if (layer := config.get(kind.key)) is not None and kind.get_type(
|
||||
layer
|
||||
).needs_session(layer):
|
||||
return kind.key
|
||||
return None
|
||||
|
||||
|
||||
def check_session(config: ConfigType) -> None:
|
||||
"""Layers that need packets back from the peer need a session layer, whose keep-alives send them."""
|
||||
if CONF_SESSION not in config and (key := layer_needing_session(config)):
|
||||
raise cv.Invalid(
|
||||
f"This '{key}' needs packets from the peer, so it needs a '{CONF_SESSION}' layer, whose "
|
||||
"keep-alives make sure they are sent",
|
||||
path=[key],
|
||||
)
|
||||
raise cv.Invalid(
|
||||
f"This '{kind.key}' needs packets from the peer, so it needs a '{CONF_SESSION}' layer, whose "
|
||||
"keep-alives make sure they are sent",
|
||||
path=[kind.key],
|
||||
)
|
||||
|
||||
|
||||
def check_single_peer(config: ConfigType, destination: int) -> None:
|
||||
|
||||
@@ -22,25 +22,18 @@ CONF_MAX_RETRIES = "max_retries"
|
||||
# The control byte and the CRC-16
|
||||
FRAME_OVERHEAD = 3
|
||||
|
||||
# Unless the link works out a longer one from how long its packets take, as a radio link does
|
||||
DEFAULT_TIMEOUT = cv.TimePeriodMilliseconds(milliseconds=200)
|
||||
|
||||
HdlcReliability = packet_interface_ns.class_("HdlcReliability", PacketInterface)
|
||||
|
||||
|
||||
def check_ack_delay(config: ConfigType, timeout: cv.TimePeriod) -> None:
|
||||
"""The peer, configured the same, must hear the acknowledgement before its timeout."""
|
||||
if config[CONF_ACK_DELAY].total_milliseconds >= timeout.total_milliseconds:
|
||||
raise cv.Invalid(
|
||||
f"Must be shorter than '{CONF_TIMEOUT}', which is {timeout.total_milliseconds}ms",
|
||||
path=[CONF_ACK_DELAY],
|
||||
)
|
||||
|
||||
|
||||
def _ack_delay_within_timeout(config: ConfigType) -> ConfigType:
|
||||
# Without a timeout, the link checks against the one it chooses
|
||||
if (timeout := config.get(CONF_TIMEOUT)) is not None:
|
||||
check_ack_delay(config, timeout)
|
||||
"""The peer, configured the same, must hear the acknowledgement before its timeout."""
|
||||
if (
|
||||
config[CONF_ACK_DELAY].total_milliseconds
|
||||
>= config[CONF_TIMEOUT].total_milliseconds
|
||||
):
|
||||
raise cv.Invalid(
|
||||
f"Must be shorter than '{CONF_TIMEOUT}'", path=[CONF_ACK_DELAY]
|
||||
)
|
||||
return config
|
||||
|
||||
|
||||
@@ -49,7 +42,7 @@ HDLC_SCHEMA = cv.All(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(HdlcReliability),
|
||||
# Retransmitting more often than the main loop runs would exhaust the retries at once
|
||||
cv.Optional(CONF_TIMEOUT): cv.All(
|
||||
cv.Optional(CONF_TIMEOUT, default="200ms"): cv.All(
|
||||
cv.positive_time_period_milliseconds,
|
||||
cv.Range(min=cv.TimePeriod(milliseconds=50)),
|
||||
),
|
||||
@@ -83,7 +76,7 @@ async def build_hdlc(
|
||||
psram=True,
|
||||
)
|
||||
var = cg.new_Pvariable(config[CONF_ID], lower, tx_slots, queue_length)
|
||||
cg.add(var.set_ack_timeout(config.get(CONF_TIMEOUT, DEFAULT_TIMEOUT)))
|
||||
cg.add(var.set_ack_timeout(config[CONF_TIMEOUT]))
|
||||
cg.add(var.set_ack_delay(config[CONF_ACK_DELAY]))
|
||||
cg.add(var.set_max_retries(config[CONF_MAX_RETRIES]))
|
||||
await cg.register_component(var, config)
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
|
||||
namespace esphome::packet_interface {
|
||||
|
||||
/**
|
||||
* Decides whether a half-duplex radio link may send while its radio reports that it is receiving a packet.
|
||||
*
|
||||
* Sending is refused while the radio is busy, so the packet being received is not lost. A busy period starts when a
|
||||
* send first finds the radio busy, and ends when a send finds it free or end_busy() is called. Once a busy period has
|
||||
* lasted max_busy_ms, sends go ahead, so a busy flag that never clears cannot stop sending for good, however often
|
||||
* sends are tried. Code generation sets max_busy_ms from the time the radio takes to receive the largest packet.
|
||||
*
|
||||
* On a link whose peer replies, sending also takes turns: after a send, a send in a later loop pass waits up to
|
||||
* turnaround_ms, the time the peer takes to start a reply and the radio to notice it, unless a packet arrives first.
|
||||
* Without this, the next frame of a burst goes out on top of the peer's acknowledgement. Sends in the same loop pass,
|
||||
* such as the fragments of one packet, are not held back.
|
||||
*/
|
||||
class ListenBeforeTalk {
|
||||
public:
|
||||
static constexpr uint32_t DEFAULT_MAX_BUSY_MS = 2000;
|
||||
|
||||
void set_max_busy(uint32_t max_busy_ms) { this->max_busy_ms_ = max_busy_ms; }
|
||||
uint32_t get_max_busy() const { return this->max_busy_ms_; }
|
||||
void set_turnaround(uint32_t turnaround_ms) { this->turnaround_ms_ = turnaround_ms; }
|
||||
|
||||
/// True if a packet may be sent at \p now, in the loop pass that started at \p pass; \p busy says whether the
|
||||
/// radio is receiving.
|
||||
bool may_send(bool busy, uint32_t now, uint32_t pass) {
|
||||
if (!busy) {
|
||||
this->busy_ = false;
|
||||
return !this->turn_held_ || pass == this->sent_pass_ || now - this->sent_ms_ >= this->turnaround_ms_;
|
||||
}
|
||||
if (!this->busy_) {
|
||||
this->busy_ = true;
|
||||
this->busy_since_ms_ = now;
|
||||
}
|
||||
return now - this->busy_since_ms_ >= this->max_busy_ms_;
|
||||
}
|
||||
/// Ends the busy period, when the radio is seen to be free other than by a send.
|
||||
void end_busy() { this->busy_ = false; }
|
||||
/// A packet was sent, ending at \p now, in the loop pass that started at \p pass.
|
||||
void sent(uint32_t now, uint32_t pass) {
|
||||
this->turn_held_ = this->turnaround_ms_ != 0;
|
||||
this->sent_ms_ = now;
|
||||
this->sent_pass_ = pass;
|
||||
}
|
||||
/// A packet arrived, so the peer has taken its turn.
|
||||
void received() { this->turn_held_ = false; }
|
||||
/// How long the current busy period has lasted at \p now.
|
||||
uint32_t busy_for(uint32_t now) const { return now - this->busy_since_ms_; }
|
||||
|
||||
protected:
|
||||
uint32_t busy_since_ms_{0};
|
||||
uint32_t max_busy_ms_{DEFAULT_MAX_BUSY_MS};
|
||||
uint32_t sent_ms_{0};
|
||||
uint32_t sent_pass_{0};
|
||||
uint32_t turnaround_ms_{0};
|
||||
bool busy_{false};
|
||||
bool turn_held_{false};
|
||||
};
|
||||
|
||||
} // namespace esphome::packet_interface
|
||||
@@ -1,70 +0,0 @@
|
||||
#include "radio_link.h"
|
||||
#include <cinttypes>
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
namespace esphome::packet_interface {
|
||||
|
||||
ESPHOME_LOG_TAG(TAG, "packet_interface.radio");
|
||||
|
||||
bool RadioLinkBase::check_size_(size_t size) const {
|
||||
if (size <= this->max_packet_size_)
|
||||
return true;
|
||||
ESP_LOGW(TAG, "Packet of %zu bytes is larger than %zu", size, this->max_packet_size_);
|
||||
return false;
|
||||
}
|
||||
|
||||
bool RadioLinkBase::may_send_(bool busy) {
|
||||
if (busy)
|
||||
this->enable_loop();
|
||||
return this->listen_before_talk_.may_send(busy, this->current_time_ms(), App.get_loop_component_start_time());
|
||||
}
|
||||
|
||||
bool RadioLinkBase::sent_(bool sent, bool busy) {
|
||||
if (busy) {
|
||||
uint32_t busy_ms = this->listen_before_talk_.busy_for(this->current_time_ms());
|
||||
// The radio listens again, and a reception that starts now must be waited for afresh
|
||||
this->listen_before_talk_.end_busy();
|
||||
// The limit is longer than any packet takes, so the radio's busy indication is stuck or the channel is jammed
|
||||
ESP_LOGW(TAG, "Radio busy for %" PRIu32 "ms, %s", busy_ms,
|
||||
sent ? LOG_STR_LITERAL("sent anyway") : LOG_STR_LITERAL("tried to send anyway, which failed"));
|
||||
}
|
||||
if (sent)
|
||||
this->listen_before_talk_.sent(this->current_time_ms(), App.get_loop_component_start_time());
|
||||
return sent;
|
||||
}
|
||||
|
||||
bool RadioLinkBase::skip_empty_() const {
|
||||
ESP_LOGV(TAG, "Empty packet not sent");
|
||||
return true;
|
||||
}
|
||||
|
||||
void RadioLinkBase::radio_not_ready_(bool failed) {
|
||||
if (!failed || this->failed_warned_)
|
||||
return;
|
||||
this->failed_warned_ = true;
|
||||
ESP_LOGW(TAG, "%s: The radio failed to set up, so nothing can be sent", this->name_);
|
||||
}
|
||||
|
||||
void RadioLinkBase::radio_free_() {
|
||||
this->listen_before_talk_.end_busy();
|
||||
this->disable_loop();
|
||||
}
|
||||
|
||||
void RadioLinkBase::receive_(const std::vector<uint8_t> &packet, float rssi, float snr) {
|
||||
// The radio takes packets up to its own limit, so a larger one is from a device configured differently
|
||||
if (packet.size() > this->max_packet_size_) {
|
||||
ESP_LOGV(TAG, "%s: Packet of %zu bytes is larger than %zu, dropped", this->name_, packet.size(),
|
||||
this->max_packet_size_);
|
||||
this->note_received_(false);
|
||||
return;
|
||||
}
|
||||
this->note_received_(true);
|
||||
this->listen_before_talk_.received();
|
||||
PacketMetaData meta_data;
|
||||
meta_data.rssi = rssi;
|
||||
meta_data.snr = snr;
|
||||
this->on_receive_from_interface_(PacketBuffer(packet.data(), packet.size()), meta_data);
|
||||
}
|
||||
|
||||
} // namespace esphome::packet_interface
|
||||
@@ -1,101 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <vector>
|
||||
|
||||
#include "esphome/components/packet_interface/listen_before_talk.h"
|
||||
#include "esphome/components/packet_interface/packet_interface.h"
|
||||
#include "esphome/core/hal.h"
|
||||
|
||||
namespace esphome::packet_interface {
|
||||
|
||||
/// The parts of RadioLink that do not depend on the radio.
|
||||
class RadioLinkBase : public PacketInterface {
|
||||
public:
|
||||
void set_max_busy(uint32_t max_busy_ms) { this->listen_before_talk_.set_max_busy(max_busy_ms); }
|
||||
void set_turnaround(uint32_t turnaround_ms) { this->listen_before_talk_.set_turnaround(turnaround_ms); }
|
||||
|
||||
protected:
|
||||
explicit RadioLinkBase(size_t max_packet_size) : PacketInterface(max_packet_size) {}
|
||||
/// The time now, not the loop's start: earlier sends in the same loop pass may have waited seconds for the radio.
|
||||
virtual uint32_t current_time_ms() const { return millis(); }
|
||||
/// False if a packet of this size is too large.
|
||||
bool check_size_(size_t size) const;
|
||||
/// False if sending must wait, as the radio is busy or the peer may be about to reply; starts loop() to watch a
|
||||
/// busy radio.
|
||||
bool may_send_(bool busy);
|
||||
/**
|
||||
* Returns \p sent, after ending the busy period and warning if the packet was sent over a radio that seemed busy.
|
||||
* Called only once the radio has the packet, as a log line can run an automation that sends again and overwrites
|
||||
* the buffer it came from.
|
||||
*/
|
||||
bool sent_(bool sent, bool busy);
|
||||
/// Returns true for an empty packet, which the radios cannot send, so there is nothing to retry.
|
||||
bool skip_empty_() const;
|
||||
/// Warns once when a send finds the radio failed; until its setup has run, sends are refused quietly.
|
||||
void radio_not_ready_(bool failed);
|
||||
/// Ends the busy period when loop() finds the radio free.
|
||||
void radio_free_();
|
||||
void receive_(const std::vector<uint8_t> &packet, float rssi, float snr);
|
||||
|
||||
// First, so it fills the spare byte at the end of PacketInterface
|
||||
bool failed_warned_{false};
|
||||
ListenBeforeTalk listen_before_talk_;
|
||||
};
|
||||
|
||||
/**
|
||||
* A packet interface link over a packet radio: each packet is one radio packet, with the RSSI and SNR of received
|
||||
* packets in the metadata. Sending waits for the radio to finish transmitting. A radio cannot hear while it sends, so
|
||||
* sending is refused while the radio is receiving a packet. A reliability layer sends the packet again shortly, and
|
||||
* entity_transport after a delay; other callers drop it, logging at debug level at most. While a busy period lasts,
|
||||
* loop() watches the radio and ends the period as soon as the radio is free, so a later reception starts a new one.
|
||||
*
|
||||
* Radio provides is_receiving(), register_listener(Listener *) and transmit_packet(const uint8_t *, size_t), which
|
||||
* returns an Error whose value 0 means success. Listener declares on_packet(packet, rssi, snr). MaxPacketSize is the
|
||||
* radio's limit.
|
||||
*/
|
||||
template<typename Radio, typename Listener, typename Error, size_t MaxPacketSize>
|
||||
class RadioLink : public RadioLinkBase, public Listener {
|
||||
public:
|
||||
RadioLink(Radio *radio, size_t max_packet_size) : RadioLinkBase(max_packet_size), radio_(radio) {}
|
||||
|
||||
void setup() override {
|
||||
this->radio_->register_listener(this);
|
||||
this->disable_loop();
|
||||
}
|
||||
// Runs only during a busy period; a busy flag that never clears keeps it running. A radio that failed meanwhile
|
||||
// is not read again, as reading it may wait on the radio every time
|
||||
void loop() override {
|
||||
if (!this->radio_->is_ready() || !this->radio_->is_receiving())
|
||||
this->radio_free_();
|
||||
}
|
||||
|
||||
bool send_to_interface(const PacketBuffer &data, const PacketMetaData &meta_data) override {
|
||||
// The radio is set up after the layers above, which may send from their own setup
|
||||
if (!this->radio_->is_ready()) {
|
||||
this->radio_not_ready_(this->radio_->is_failed());
|
||||
return false;
|
||||
}
|
||||
size_t size = data.size();
|
||||
if (size == 0)
|
||||
return this->skip_empty_();
|
||||
bool busy = this->radio_->is_receiving();
|
||||
if (!this->check_size_(size) || !this->may_send_(busy))
|
||||
return false;
|
||||
if (data.is_contiguous()) {
|
||||
auto span = data.as_span();
|
||||
return this->sent_(this->radio_->transmit_packet(span.data(), span.size()) == Error{}, busy);
|
||||
}
|
||||
uint8_t buf[MaxPacketSize];
|
||||
data.copy_to(buf, size);
|
||||
return this->sent_(this->radio_->transmit_packet(buf, size) == Error{}, busy);
|
||||
}
|
||||
|
||||
void on_packet(const std::vector<uint8_t> &packet, float rssi, float snr) override {
|
||||
this->receive_(packet, rssi, snr);
|
||||
}
|
||||
|
||||
protected:
|
||||
Radio *radio_;
|
||||
};
|
||||
|
||||
} // namespace esphome::packet_interface
|
||||
@@ -1,311 +0,0 @@
|
||||
"""Shared code generation for the packet interface links over packet radios, such as the SX126x and SX127x."""
|
||||
|
||||
from collections.abc import Callable, Iterator
|
||||
import logging
|
||||
import math
|
||||
|
||||
import esphome.codegen as cg
|
||||
from esphome.components.const import CONF_MAX_PACKET_SIZE
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import CONF_FRAGMENTATION, CONF_ID, CONF_TIMEOUT
|
||||
from esphome.core import CORE
|
||||
from esphome.cpp_generator import MockObjClass
|
||||
import esphome.final_validate as fv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from . import new_packet_interface, packet_interface_schema, reliability_layers
|
||||
from .layers import (
|
||||
ADDRESSING,
|
||||
CONF_ADDRESSING,
|
||||
CONF_PEERS,
|
||||
CONF_RELIABILITY,
|
||||
STACK_ORDER,
|
||||
)
|
||||
from .layers.basic_fragmentation import HEADER_SIZE as FRAGMENT_HEADER_SIZE
|
||||
from .layers.hdlc_reliability import (
|
||||
CONF_ACK_DELAY,
|
||||
CONF_MAX_QUEUE_LENGTH,
|
||||
DEFAULT_TIMEOUT,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
# The largest packet a radio receives, from any device on the channel, given the radio's settings
|
||||
ReceiveLimit = Callable[[ConfigType], int]
|
||||
|
||||
# The radios' payload length register is 8 bits
|
||||
MAX_PACKET_SIZE = 255
|
||||
# The smallest max_packet_size that packet_interface_schema() takes
|
||||
MIN_PACKET_SIZE = 16
|
||||
|
||||
# Listen before talk holds a send back for at most the airtime of the largest packet, and never less than this
|
||||
MIN_MAX_BUSY_MS = 2000
|
||||
# Room for the preamble detection and the radio's own delays
|
||||
MARGIN = 1.25
|
||||
# The radio drivers stop waiting for a packet to be sent after this long
|
||||
TRANSMIT_TIMEOUT_MS = 4000
|
||||
# An acknowledgement, with room for the layers below the reliability layer, such as addressing and the rolling code
|
||||
ACK_PACKET_SIZE = 32
|
||||
# From the end of a packet to the start of the peer's reply: a loop pass to read the packet, one to answer it, and the
|
||||
# radio's start-up
|
||||
REPLY_START_MS = 50
|
||||
# A LoRa packet's explicit header is in its first 8 symbols
|
||||
LORA_HEADER_SYMBOLS = 8
|
||||
|
||||
|
||||
def _lora_symbol_s(radio: ConfigType) -> float:
|
||||
bandwidth_hz = (
|
||||
float(str(radio["bandwidth"]).removesuffix("kHz").replace("_", ".")) * 1000
|
||||
)
|
||||
return (1 << radio["spreading_factor"]) / bandwidth_hz
|
||||
|
||||
|
||||
def packet_airtime_ms(radio: ConfigType, size: int) -> float:
|
||||
"""The time a radio configured as in radio takes to send a packet of size bytes.
|
||||
|
||||
LoRa follows the Semtech formula for an explicit header; the low data rate optimization is assumed when a symbol
|
||||
takes more than 16 ms, as the drivers enable it. Other modulations count the preamble, sync word, length byte,
|
||||
payload and CRC at the bitrate, treating the preamble size as bytes, which gives the longer time.
|
||||
"""
|
||||
if str(radio["modulation"]) == "LORA":
|
||||
spreading_factor = radio["spreading_factor"]
|
||||
coding_rate = int(str(radio["coding_rate"])[-1]) - 4
|
||||
symbol_s = _lora_symbol_s(radio)
|
||||
low_data_rate = 1 if symbol_s > 0.016 else 0
|
||||
crc = 16 if radio.get("crc_enable", False) else 0
|
||||
payload_symbols = 8 + max(
|
||||
math.ceil(
|
||||
(8 * size - 4 * spreading_factor + 28 + crc)
|
||||
/ (4 * (spreading_factor - 2 * low_data_rate))
|
||||
)
|
||||
* (coding_rate + 4),
|
||||
0,
|
||||
)
|
||||
return (radio["preamble_size"] + 4.25 + payload_symbols) * symbol_s * 1000
|
||||
bytes_sent = (
|
||||
radio["preamble_size"] + len(radio.get("sync_value", [])) + 1 + size + 2
|
||||
)
|
||||
return bytes_sent * 8 / radio["bitrate"] * 1000
|
||||
|
||||
|
||||
def turnaround_ms(radio: ConfigType) -> int:
|
||||
"""How long, after sending, to wait for the peer's reply to start and for the radio to receive its header, so
|
||||
the peer's reply is not sent over.
|
||||
"""
|
||||
if str(radio["modulation"]) == "LORA":
|
||||
symbols = radio["preamble_size"] + 4.25 + LORA_HEADER_SYMBOLS
|
||||
header_ms = symbols * _lora_symbol_s(radio) * 1000
|
||||
else:
|
||||
header_bytes = radio["preamble_size"] + len(radio.get("sync_value", [])) + 1
|
||||
header_ms = header_bytes * 8 / radio["bitrate"] * 1000
|
||||
return math.ceil((header_ms + REPLY_START_MS) * MARGIN)
|
||||
|
||||
|
||||
def max_busy_ms(radio: ConfigType, max_packet_size: int) -> int:
|
||||
"""How long listen before talk may hold a send back, for packets of up to max_packet_size bytes."""
|
||||
return max(
|
||||
MIN_MAX_BUSY_MS, math.ceil(packet_airtime_ms(radio, max_packet_size) * MARGIN)
|
||||
)
|
||||
|
||||
|
||||
def _fits_transmit_time(radio: ConfigType, size: int) -> bool:
|
||||
return packet_airtime_ms(radio, size) * MARGIN <= TRANSMIT_TIMEOUT_MS
|
||||
|
||||
|
||||
def _largest_sendable(radio: ConfigType, limit: int) -> int | None:
|
||||
"""The largest max_packet_size, up to limit, whose packets the radio sends within the drivers' wait."""
|
||||
return next(
|
||||
(
|
||||
size
|
||||
for size in range(limit, MIN_PACKET_SIZE - 1, -1)
|
||||
if _fits_transmit_time(radio, size)
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
|
||||
def channel_packet_size(radio: ConfigType, receive_limit: int) -> int:
|
||||
"""The largest packet any device on the channel can send: no more than the radio receives, and no more than a
|
||||
device with these radio settings is allowed to send.
|
||||
"""
|
||||
return _largest_sendable(radio, receive_limit) or receive_limit
|
||||
|
||||
|
||||
def reliability_timeout_ms(
|
||||
radio: ConfigType, packet_size: int, ack_delay_ms: int
|
||||
) -> int:
|
||||
"""The shortest reliability timeout: before acknowledging, the peer may be sending, or receiving from another
|
||||
device, a packet of packet_size bytes.
|
||||
"""
|
||||
airtime = packet_airtime_ms(radio, packet_size) + packet_airtime_ms(
|
||||
radio, ACK_PACKET_SIZE
|
||||
)
|
||||
return math.ceil(airtime * MARGIN) + ack_delay_ms
|
||||
|
||||
|
||||
def _check_transmit_time(config: ConfigType, radio: ConfigType) -> None:
|
||||
"""The radio drivers give up on a packet that takes longer to send than they wait."""
|
||||
size = config[CONF_MAX_PACKET_SIZE]
|
||||
if _fits_transmit_time(radio, size):
|
||||
return
|
||||
largest = _largest_sendable(radio, size - 1)
|
||||
advice = (
|
||||
f"set '{CONF_MAX_PACKET_SIZE}' to {largest} or less"
|
||||
if largest is not None
|
||||
else "use faster radio settings"
|
||||
)
|
||||
raise cv.Invalid(
|
||||
f"With these radio settings a packet of {size} bytes takes {packet_airtime_ms(radio, size):.0f} ms to "
|
||||
f"send, longer than the radio waits for; {advice}",
|
||||
path=[CONF_MAX_PACKET_SIZE],
|
||||
)
|
||||
|
||||
|
||||
def _check_reliability_timeouts(
|
||||
config: ConfigType, radio: ConfigType, packet_size: int
|
||||
) -> None:
|
||||
"""A reliability timeout shorter than a packet and its acknowledgement take would send packets again too soon."""
|
||||
for path, layer in reliability_layers(config):
|
||||
if (timeout := layer.get(CONF_TIMEOUT)) is None:
|
||||
continue
|
||||
needed = reliability_timeout_ms(
|
||||
radio, packet_size, layer[CONF_ACK_DELAY].total_milliseconds
|
||||
)
|
||||
if timeout.total_milliseconds < needed:
|
||||
raise cv.Invalid(
|
||||
f"With these radio settings a packet and its acknowledgement can take {needed} ms, so this must be "
|
||||
f"at least {needed}ms; leave it out to use that",
|
||||
path=[*path, CONF_TIMEOUT],
|
||||
)
|
||||
|
||||
|
||||
def _stacks(config: ConfigType) -> Iterator[tuple[ConfigType, int]]:
|
||||
"""The link's stacks of layers, on the link or in each peer, each with the largest packet below it."""
|
||||
size = config[CONF_MAX_PACKET_SIZE]
|
||||
if (addressing := config.get(CONF_ADDRESSING)) is None:
|
||||
yield config, size
|
||||
return
|
||||
size = ADDRESSING.get_type(addressing).packet_size(addressing, size)
|
||||
yield from ((stack, size) for stack in addressing.get(CONF_PEERS, [config]))
|
||||
|
||||
|
||||
def _radio_packets_per_send(stack: ConfigType, size: int) -> int:
|
||||
"""How many radio packets one send through the stack can send one after another, each waited for in turn."""
|
||||
if (reliability := stack.get(CONF_RELIABILITY)) is not None:
|
||||
# It sends, and after a timeout sends again, every packet in its queue at once
|
||||
return reliability[CONF_MAX_QUEUE_LENGTH]
|
||||
if (fragmentation := stack.get(CONF_FRAGMENTATION)) is None:
|
||||
return 1
|
||||
for kind in STACK_ORDER:
|
||||
if kind.key == CONF_FRAGMENTATION:
|
||||
break
|
||||
if (layer := stack.get(kind.key)) is not None:
|
||||
size = kind.get_type(layer).packet_size(layer, size)
|
||||
fragment = size - FRAGMENT_HEADER_SIZE
|
||||
if fragment <= 0:
|
||||
return 1
|
||||
return math.ceil(fragmentation[CONF_MAX_PACKET_SIZE] / fragment)
|
||||
|
||||
|
||||
def _warn_long_sends(config: ConfigType, radio: ConfigType) -> None:
|
||||
"""The radio drivers wait for each packet to be sent, so a send of several packets holds up everything else."""
|
||||
airtime = packet_airtime_ms(radio, config[CONF_MAX_PACKET_SIZE])
|
||||
for stack, size in _stacks(config):
|
||||
count = _radio_packets_per_send(stack, size)
|
||||
if count > 1 and count * airtime > TRANSMIT_TIMEOUT_MS:
|
||||
_LOGGER.warning(
|
||||
"A send through '%s' can send %d radio packets in a row, holding up other components for about "
|
||||
"%.1f s while the radio sends them; reduce '%s' or the reliability '%s', or use faster radio "
|
||||
"settings",
|
||||
stack[CONF_ID].id,
|
||||
count,
|
||||
count * airtime / 1000,
|
||||
CONF_MAX_PACKET_SIZE,
|
||||
CONF_MAX_QUEUE_LENGTH,
|
||||
)
|
||||
|
||||
|
||||
def radio_link_schema(
|
||||
class_: MockObjClass, radio_id_key: str, radio_class: MockObjClass
|
||||
) -> cv.Schema:
|
||||
"""Schema for a radio link, referring to its radio by radio_id_key."""
|
||||
return packet_interface_schema(
|
||||
class_, MAX_PACKET_SIZE, MAX_PACKET_SIZE, chooses_reliability_timeout=True
|
||||
).extend({cv.GenerateID(radio_id_key): cv.use_id(radio_class)})
|
||||
|
||||
|
||||
def _two_way_layer(config: ConfigType) -> str | None:
|
||||
"""The first layer on the link or in a peer that keeps state for one peer, so needs packets back from it."""
|
||||
for stack in (config, *config.get(CONF_ADDRESSING, {}).get(CONF_PEERS, [])):
|
||||
for kind in STACK_ORDER:
|
||||
if (layer := stack.get(kind.key)) is not None and kind.get_type(
|
||||
layer
|
||||
).single_peer(layer):
|
||||
return kind.key
|
||||
return None
|
||||
|
||||
|
||||
def takes_turns(config: ConfigType) -> bool:
|
||||
"""Whether sends wait for the peer to reply: only a reliability layer's peer answers each packet at once."""
|
||||
return next(reliability_layers(config), None) is not None
|
||||
|
||||
|
||||
def radio_link_final_validate(
|
||||
radio_id_key: str,
|
||||
payload_length_key: str,
|
||||
rx_start_key: str,
|
||||
check: Callable[[ConfigType, ConfigType], None] | None = None,
|
||||
receive_limit: ReceiveLimit = lambda radio: MAX_PACKET_SIZE,
|
||||
) -> Callable[[ConfigType], ConfigType]:
|
||||
"""Final validation for a radio link: packets vary in length, the radio listens after sending when a layer needs
|
||||
replies, and check(link, radio) checks the rest.
|
||||
"""
|
||||
|
||||
def validator(config: ConfigType) -> ConfigType:
|
||||
radio = fv.get_declaring_config(config[radio_id_key])
|
||||
if radio[payload_length_key] != 0:
|
||||
raise cv.Invalid(
|
||||
f"Packets vary in length, so the radio's '{payload_length_key}' must be 0",
|
||||
path=[radio_id_key],
|
||||
)
|
||||
if not radio[rx_start_key] and (layer := _two_way_layer(config)) is not None:
|
||||
raise cv.Invalid(
|
||||
f"This '{layer}' needs packets from the peer, but the radio sleeps after sending unless "
|
||||
f"'{rx_start_key}' is true",
|
||||
path=[radio_id_key],
|
||||
)
|
||||
if check is not None:
|
||||
check(config, radio)
|
||||
_check_transmit_time(config, radio)
|
||||
_check_reliability_timeouts(
|
||||
config, radio, channel_packet_size(radio, receive_limit(radio))
|
||||
)
|
||||
_warn_long_sends(config, radio)
|
||||
return config
|
||||
|
||||
return validator
|
||||
|
||||
|
||||
async def new_radio_link(
|
||||
config: ConfigType,
|
||||
radio_id_key: str,
|
||||
receive_limit: ReceiveLimit = lambda radio: MAX_PACKET_SIZE,
|
||||
) -> None:
|
||||
"""Create a radio link, with timings worked out from the radio's settings and the largest packet on the channel."""
|
||||
radio_config = fv.get_declaring_config(config[radio_id_key], CORE.config)
|
||||
packet_size = channel_packet_size(radio_config, receive_limit(radio_config))
|
||||
# A reliability layer without a timeout gets one long enough for a packet and its acknowledgement
|
||||
for _, layer in reliability_layers(config):
|
||||
if CONF_TIMEOUT not in layer:
|
||||
needed = reliability_timeout_ms(
|
||||
radio_config, packet_size, layer[CONF_ACK_DELAY].total_milliseconds
|
||||
)
|
||||
layer[CONF_TIMEOUT] = cv.TimePeriodMilliseconds(
|
||||
milliseconds=max(DEFAULT_TIMEOUT.total_milliseconds, needed)
|
||||
)
|
||||
radio = await cg.get_variable(config[radio_id_key])
|
||||
var = await new_packet_interface(config, radio, config[CONF_MAX_PACKET_SIZE])
|
||||
cg.add(var.set_max_busy(max_busy_ms(radio_config, packet_size)))
|
||||
# Taking turns would hold up a run of one-way sends, and a reliability layer sends again what it refuses
|
||||
if takes_turns(config):
|
||||
cg.add(var.set_turnaround(turnaround_ms(radio_config)))
|
||||
@@ -46,8 +46,6 @@ class XxteaEncryption : public PacketInterface {
|
||||
void setup() override;
|
||||
void dump_config() override;
|
||||
bool send_to_interface(const PacketBuffer &data, const PacketMetaData &meta_data) override;
|
||||
// One encrypted packet per packet, so a fragmentation layer above sees the link's room
|
||||
size_t get_send_capacity() const override { return this->lower_->get_send_capacity(); }
|
||||
|
||||
void set_key(std::initializer_list<uint32_t> key);
|
||||
|
||||
|
||||
@@ -434,31 +434,42 @@ bool RTSPSession::queue_next_packet_() {
|
||||
const size_t rtp_len = header_len - INTERLEAVED_HEADER_LEN + qtables_len + payload_len;
|
||||
|
||||
auto *buf = reinterpret_cast<uint8_t *>(this->send_buf_.data());
|
||||
uint8_t *p = buf;
|
||||
*p++ = '$';
|
||||
*p++ = 0; // interleaved channel 0
|
||||
p = put_be16(p, rtp_len);
|
||||
size_t pos = 0;
|
||||
buf[pos++] = '$';
|
||||
buf[pos++] = 0; // interleaved channel 0
|
||||
buf[pos++] = static_cast<uint8_t>(rtp_len >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(rtp_len);
|
||||
|
||||
*p++ = 0x80; // V=2, P=0, X=0, CC=0
|
||||
*p++ = static_cast<uint8_t>((last_fragment ? 0x80 : 0x00) | RTP_PAYLOAD_TYPE_JPEG);
|
||||
p = put_be16(p, this->sequence_number_);
|
||||
buf[pos++] = 0x80; // V=2, P=0, X=0, CC=0
|
||||
buf[pos++] = static_cast<uint8_t>((last_fragment ? 0x80 : 0x00) | RTP_PAYLOAD_TYPE_JPEG);
|
||||
buf[pos++] = static_cast<uint8_t>(this->sequence_number_ >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(this->sequence_number_);
|
||||
this->sequence_number_++;
|
||||
p = put_be32(p, this->rtp_timestamp_);
|
||||
p = put_be32(p, this->ssrc_);
|
||||
buf[pos++] = static_cast<uint8_t>(this->rtp_timestamp_ >> 24);
|
||||
buf[pos++] = static_cast<uint8_t>(this->rtp_timestamp_ >> 16);
|
||||
buf[pos++] = static_cast<uint8_t>(this->rtp_timestamp_ >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(this->rtp_timestamp_);
|
||||
buf[pos++] = static_cast<uint8_t>(this->ssrc_ >> 24);
|
||||
buf[pos++] = static_cast<uint8_t>(this->ssrc_ >> 16);
|
||||
buf[pos++] = static_cast<uint8_t>(this->ssrc_ >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(this->ssrc_);
|
||||
|
||||
// RFC 2435 main JPEG header
|
||||
*p++ = 0; // type-specific
|
||||
p = put_be24(p, this->frame_sent_);
|
||||
*p++ = this->jpeg_.type;
|
||||
*p++ = 255; // Q >= 128: the quantization tables follow in the first packet
|
||||
*p++ = static_cast<uint8_t>(this->jpeg_.width / 8);
|
||||
*p++ = static_cast<uint8_t>(this->jpeg_.height / 8);
|
||||
buf[pos++] = 0; // type-specific
|
||||
buf[pos++] = static_cast<uint8_t>(this->frame_sent_ >> 16);
|
||||
buf[pos++] = static_cast<uint8_t>(this->frame_sent_ >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(this->frame_sent_);
|
||||
buf[pos++] = this->jpeg_.type;
|
||||
buf[pos++] = 255; // Q >= 128: the quantization tables follow in the first packet
|
||||
buf[pos++] = static_cast<uint8_t>(this->jpeg_.width / 8);
|
||||
buf[pos++] = static_cast<uint8_t>(this->jpeg_.height / 8);
|
||||
|
||||
uint8_t count = 0;
|
||||
if (first_fragment) {
|
||||
*p++ = 0; // MBZ
|
||||
*p++ = 0; // 8-bit precision
|
||||
put_be16(p, qtables_len);
|
||||
buf[pos++] = 0; // MBZ
|
||||
buf[pos++] = 0; // 8-bit precision
|
||||
buf[pos++] = static_cast<uint8_t>(qtables_len >> 8);
|
||||
buf[pos++] = static_cast<uint8_t>(qtables_len);
|
||||
this->iov_[0] = {buf, header_len};
|
||||
this->iov_[1] = {const_cast<uint8_t *>(this->jpeg_.qtable0), QTABLE_LEN};
|
||||
this->iov_[2] = {const_cast<uint8_t *>(this->jpeg_.qtable1), QTABLE_LEN};
|
||||
|
||||
@@ -145,9 +145,11 @@ void RuntimeImage::draw_pixel(int x, int y, const Color &color) {
|
||||
this->map_chroma_key(mapped_color);
|
||||
uint16_t rgb565 = display::ColorUtil::color_to_565(mapped_color);
|
||||
if (this->big_endian_) {
|
||||
put_be16(this->buffer_ + pos, rgb565);
|
||||
this->buffer_[pos + 0] = static_cast<uint8_t>((rgb565 >> 8) & 0xFF);
|
||||
this->buffer_[pos + 1] = static_cast<uint8_t>(rgb565 & 0xFF);
|
||||
} else {
|
||||
put_le16(this->buffer_ + pos, rgb565);
|
||||
this->buffer_[pos + 0] = static_cast<uint8_t>(rgb565 & 0xFF);
|
||||
this->buffer_[pos + 1] = static_cast<uint8_t>((rgb565 >> 8) & 0xFF);
|
||||
}
|
||||
if (this->transparency_ == image::TRANSPARENCY_ALPHA_CHANNEL) {
|
||||
const size_t alpha_pos = pos / 2 + this->buffer_width_ * this->buffer_height_ * 2;
|
||||
|
||||
@@ -48,16 +48,17 @@ bool SensirionI2CDevice::write_command_(uint16_t command, CommandLen command_len
|
||||
temp[raw_idx++] = command & 0xFF;
|
||||
} else {
|
||||
// command is 2 bytes
|
||||
put_be16(temp, command);
|
||||
raw_idx = 2;
|
||||
temp[raw_idx++] = command >> 8;
|
||||
temp[raw_idx++] = command & 0xFF;
|
||||
}
|
||||
// add parameters followed by crc
|
||||
// skipped if len == 0
|
||||
for (size_t i = 0; i < data_len; i++) {
|
||||
put_be16(temp + raw_idx, data[i]);
|
||||
temp[raw_idx++] = data[i] >> 8;
|
||||
temp[raw_idx++] = data[i] & 0xFF;
|
||||
// Use MSB first since Sensirion devices use CRC-8 with MSB first
|
||||
temp[raw_idx + 2] = crc8(temp + raw_idx, 2, 0xFF, CRC_POLYNOMIAL, true);
|
||||
raw_idx += 3;
|
||||
uint8_t crc = crc8(&temp[raw_idx - 2], 2, 0xFF, CRC_POLYNOMIAL, true);
|
||||
temp[raw_idx++] = crc;
|
||||
}
|
||||
this->last_error_ = this->write(temp, raw_idx);
|
||||
return this->last_error_ == i2c::ERROR_OK;
|
||||
|
||||
@@ -611,7 +611,7 @@ stm32_unique_ptr stm32_init(uart::UARTDevice *stream, const uint8_t flags, const
|
||||
ESP_LOGD(TAG, "Only %d bytes sent in the PID, unknown/unsupported device", returned);
|
||||
return make_stm32_with_deletor(nullptr);
|
||||
}
|
||||
stm->pid = encode_uint16(buf[1], buf[2]);
|
||||
stm->pid = (buf[1] << 8) | buf[2];
|
||||
if (returned > 2) {
|
||||
ESP_LOGD(TAG, "This bootloader returns %d extra bytes in PID:", returned);
|
||||
for (auto i = 2; i <= returned; i++) {
|
||||
@@ -952,7 +952,7 @@ stm32_err_t stm32_crc_memory(const stm32_unique_ptr &stm, const uint32_t address
|
||||
if (buf[4] != xor_bytes(buf, 4))
|
||||
return STM32_ERR_UNKNOWN;
|
||||
|
||||
*crc = encode_uint32(buf[0], buf[1], buf[2], buf[3]);
|
||||
*crc = (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
|
||||
}
|
||||
|
||||
return STM32_ERR_OK;
|
||||
|
||||
@@ -123,7 +123,8 @@ void HOT SSD1331::draw_absolute_pixel_internal(int x, int y, Color color) {
|
||||
const uint32_t color565 = display::ColorUtil::color_to_565(color);
|
||||
// where should the bits go in the big buffer array? math...
|
||||
uint16_t pos = (x + y * this->get_width_internal()) * SSD1331_BYTESPERPIXEL;
|
||||
put_be16(this->buffer_ + pos, color565);
|
||||
this->buffer_[pos++] = (color565 >> 8) & 0xff;
|
||||
this->buffer_[pos] = color565 & 0xff;
|
||||
}
|
||||
void SSD1331::fill(Color color) {
|
||||
// If clipping is active, fall back to base implementation
|
||||
|
||||
@@ -155,7 +155,8 @@ void HOT SSD1351::draw_absolute_pixel_internal(int x, int y, Color color) {
|
||||
const uint32_t color565 = display::ColorUtil::color_to_565(color);
|
||||
// where should the bits go in the big buffer array? math...
|
||||
uint16_t pos = (x + y * this->get_width_internal()) * SSD1351_BYTESPERPIXEL;
|
||||
put_be16(this->buffer_ + pos, color565);
|
||||
this->buffer_[pos++] = (color565 >> 8) & 0xff;
|
||||
this->buffer_[pos] = color565 & 0xff;
|
||||
}
|
||||
void SSD1351::fill(Color color) {
|
||||
// If clipping is active, fall back to base implementation
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
from esphome.components import packet_interface
|
||||
from esphome.components.packet_interface.radio_link import (
|
||||
new_radio_link,
|
||||
radio_link_final_validate,
|
||||
radio_link_schema,
|
||||
)
|
||||
import esphome.config_validation as cv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from .. import (
|
||||
CONF_MODULATION,
|
||||
CONF_PAYLOAD_LENGTH,
|
||||
CONF_RX_START,
|
||||
CONF_SX126X_ID,
|
||||
CONF_SYNC_VALUE,
|
||||
SX126x,
|
||||
SX126xListener,
|
||||
sx126x_ns,
|
||||
)
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DEPENDENCIES = ["sx126x"]
|
||||
|
||||
SX126xPacketInterface = sx126x_ns.class_(
|
||||
"SX126xPacketInterface", packet_interface.PacketInterface, SX126xListener
|
||||
)
|
||||
|
||||
CONFIG_SCHEMA = radio_link_schema(SX126xPacketInterface, CONF_SX126X_ID, SX126x)
|
||||
|
||||
|
||||
def _check_fsk(config: ConfigType, radio: ConfigType) -> None:
|
||||
"""Without LoRa, the radio can tell that a packet is arriving only from its sync word, which listen before talk
|
||||
needs.
|
||||
"""
|
||||
if radio[CONF_MODULATION] != "LORA" and not radio[CONF_SYNC_VALUE]:
|
||||
raise cv.Invalid(
|
||||
f"Without LoRa modulation the radio needs a '{CONF_SYNC_VALUE}', so that the link can tell when a packet "
|
||||
"is arriving and not send over it",
|
||||
path=[CONF_SX126X_ID],
|
||||
)
|
||||
|
||||
|
||||
FINAL_VALIDATE_SCHEMA = radio_link_final_validate(
|
||||
CONF_SX126X_ID, CONF_PAYLOAD_LENGTH, CONF_RX_START, _check_fsk
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
await new_radio_link(config, CONF_SX126X_ID)
|
||||
@@ -1,10 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include "esphome/components/packet_interface/radio_link.h"
|
||||
#include "esphome/components/sx126x/sx126x.h"
|
||||
|
||||
namespace esphome::sx126x {
|
||||
|
||||
using SX126xPacketInterface = packet_interface::RadioLink<SX126x, SX126xListener, SX126xError, SX126X_MAX_PACKET_SIZE>;
|
||||
|
||||
} // namespace esphome::sx126x
|
||||
@@ -99,8 +99,6 @@ class SX126x final : public Component {
|
||||
bool cancel_transmit_async(SX126xTransmitListener *listener);
|
||||
bool is_transmitting() const { return this->radio_.is_transmitting(); }
|
||||
void register_listener(SX126xListener *listener) { this->listeners_.push_back(listener); }
|
||||
// True while a packet is being received, or has been received and not yet read; sending would lose it.
|
||||
bool is_receiving() { return this->radio_.is_receiving(); }
|
||||
Trigger<std::vector<uint8_t>, float, float> *get_packet_trigger() { return &this->packet_trigger_; }
|
||||
|
||||
private:
|
||||
|
||||
@@ -61,7 +61,9 @@ ConfigurationResult SX126xCommands::configure(const RadioProfile &profile, std::
|
||||
if (profile.tcxo_voltage != TCXO_CTRL_NONE) {
|
||||
uint32_t delay = profile.tcxo_delay >> 6;
|
||||
buf[0] = profile.tcxo_voltage;
|
||||
put_be24(buf + 1, delay);
|
||||
buf[1] = (delay >> 16) & 0xFF;
|
||||
buf[2] = (delay >> 8) & 0xFF;
|
||||
buf[3] = (delay >> 0) & 0xFF;
|
||||
this->write_opcode_(RADIO_SET_TCXOMODE, buf, 4);
|
||||
buf[0] = 0x7F;
|
||||
this->write_opcode_(RADIO_CALIBRATE, buf, 1);
|
||||
@@ -97,7 +99,10 @@ ConfigurationResult SX126xCommands::configure(const RadioProfile &profile, std::
|
||||
|
||||
// set frequency
|
||||
uint64_t freq = ((uint64_t) profile.frequency << 25) / XTAL_FREQ;
|
||||
put_be32(buf, static_cast<uint32_t>(freq));
|
||||
buf[0] = (uint8_t) ((freq >> 24) & 0xFF);
|
||||
buf[1] = (uint8_t) ((freq >> 16) & 0xFF);
|
||||
buf[2] = (uint8_t) ((freq >> 8) & 0xFF);
|
||||
buf[3] = (uint8_t) (freq & 0xFF);
|
||||
this->write_opcode_(RADIO_SET_RFFREQUENCY, buf, 4);
|
||||
|
||||
// configure pa
|
||||
@@ -147,17 +152,23 @@ ConfigurationResult SX126xCommands::configure(const RadioProfile &profile, std::
|
||||
// set modulation params
|
||||
uint32_t bitrate = ((uint64_t) XTAL_FREQ * 32) / profile.bitrate;
|
||||
uint32_t fdev = ((uint64_t) profile.deviation << 25) / XTAL_FREQ;
|
||||
put_be24(buf, bitrate);
|
||||
buf[0] = (bitrate >> 16) & 0xFF;
|
||||
buf[1] = (bitrate >> 8) & 0xFF;
|
||||
buf[2] = (bitrate >> 0) & 0xFF;
|
||||
buf[3] = profile.shaping;
|
||||
buf[4] = progmem_read_byte(&BW_FSK[profile.bandwidth - SX126X_BW_4800]);
|
||||
put_be24(buf + 5, fdev);
|
||||
buf[5] = (fdev >> 16) & 0xFF;
|
||||
buf[6] = (fdev >> 8) & 0xFF;
|
||||
buf[7] = (fdev >> 0) & 0xFF;
|
||||
this->write_opcode_(RADIO_SET_MODULATIONPARAMS, buf, 8);
|
||||
|
||||
// set crc params
|
||||
if (profile.crc_enable) {
|
||||
put_be16(buf, profile.crc_initial);
|
||||
buf[0] = profile.crc_initial >> 8;
|
||||
buf[1] = profile.crc_initial & 0xFF;
|
||||
this->write_register_(REG_CRC_INITIAL, buf, 2);
|
||||
put_be16(buf, profile.crc_polynomial);
|
||||
buf[0] = profile.crc_polynomial >> 8;
|
||||
buf[1] = profile.crc_polynomial & 0xFF;
|
||||
this->write_register_(REG_CRC_POLYNOMIAL, buf, 2);
|
||||
}
|
||||
|
||||
@@ -192,7 +203,8 @@ void SX126xCommands::encode_packet_params(const RadioProfile &profile, AppliedPr
|
||||
auto &buf = applied.packet_params;
|
||||
const uint8_t payload_length = profile.max_packet_size();
|
||||
if (profile.modulation == PACKET_TYPE_LORA) {
|
||||
put_be16(buf.data(), profile.preamble_size);
|
||||
buf[0] = (profile.preamble_size >> 8) & 0xFF;
|
||||
buf[1] = (profile.preamble_size >> 0) & 0xFF;
|
||||
buf[2] = (profile.payload_length > 0) ? 0x01 : 0x00;
|
||||
buf[3] = payload_length;
|
||||
buf[4] = (profile.crc_enable) ? 0x01 : 0x00;
|
||||
@@ -200,7 +212,8 @@ void SX126xCommands::encode_packet_params(const RadioProfile &profile, AppliedPr
|
||||
applied.packet_params_size = 6;
|
||||
} else {
|
||||
uint16_t preamble_size = profile.preamble_size * 8;
|
||||
put_be16(buf.data(), preamble_size);
|
||||
buf[0] = (preamble_size >> 8) & 0xFF;
|
||||
buf[1] = (preamble_size >> 0) & 0xFF;
|
||||
buf[2] = (profile.preamble_detect > 0) ? ((profile.preamble_detect - 1) | 0x04) : 0x00;
|
||||
buf[3] = profile.sync_size * 8;
|
||||
buf[4] = 0x00;
|
||||
@@ -246,22 +259,20 @@ void SX126xCommands::calibrate_image(uint32_t frequency) {
|
||||
}
|
||||
}
|
||||
|
||||
// Only the dio1 interrupts are routed to DIO1; DIO2 and DIO3 stay unused.
|
||||
void SX126xCommands::set_dio_irq_params_(uint16_t flags, uint16_t dio1) {
|
||||
uint8_t buf[8];
|
||||
put_be16(buf, flags);
|
||||
put_be16(buf + 2, dio1);
|
||||
put_be16(buf + 4, IRQ_RADIO_NONE);
|
||||
put_be16(buf + 6, IRQ_RADIO_NONE);
|
||||
this->write_opcode_(RADIO_SET_DIOIRQPARAMS, buf, 8);
|
||||
}
|
||||
|
||||
void SX126xCommands::receive() {
|
||||
// A valid header or sync word is flagged for SX126xRadio::is_receiving(), but not signalled on DIO1
|
||||
const uint16_t irq = IRQ_RX_DONE | IRQ_RX_TX_TIMEOUT | IRQ_CRC_ERROR;
|
||||
this->set_dio_irq_params_(irq | IRQ_HEADER_VALID | IRQ_SYNCWORD_VALID, irq);
|
||||
uint8_t buf[8];
|
||||
|
||||
uint8_t buf[3];
|
||||
// configure irq params
|
||||
uint16_t irq = IRQ_RX_DONE | IRQ_RX_TX_TIMEOUT | IRQ_CRC_ERROR;
|
||||
buf[0] = (irq >> 8) & 0xFF;
|
||||
buf[1] = (irq >> 0) & 0xFF;
|
||||
buf[2] = (irq >> 8) & 0xFF;
|
||||
buf[3] = (irq >> 0) & 0xFF;
|
||||
buf[4] = (IRQ_RADIO_NONE >> 8) & 0xFF;
|
||||
buf[5] = (IRQ_RADIO_NONE >> 0) & 0xFF;
|
||||
buf[6] = (IRQ_RADIO_NONE >> 8) & 0xFF;
|
||||
buf[7] = (IRQ_RADIO_NONE >> 0) & 0xFF;
|
||||
this->write_opcode_(RADIO_SET_DIOIRQPARAMS, buf, 8);
|
||||
|
||||
// set timeout to 0
|
||||
buf[0] = 0x00;
|
||||
@@ -275,12 +286,24 @@ void SX126xCommands::receive() {
|
||||
}
|
||||
|
||||
void SX126xCommands::transmit(uint32_t timeout_ms) {
|
||||
this->set_dio_irq_params_(IRQ_TX_DONE | IRQ_RX_TX_TIMEOUT, IRQ_TX_DONE | IRQ_RX_TX_TIMEOUT);
|
||||
uint8_t buf[8];
|
||||
|
||||
uint8_t buf[3];
|
||||
// configure irq params
|
||||
uint16_t irq = IRQ_TX_DONE | IRQ_RX_TX_TIMEOUT;
|
||||
buf[0] = (irq >> 8) & 0xFF;
|
||||
buf[1] = (irq >> 0) & 0xFF;
|
||||
buf[2] = (irq >> 8) & 0xFF;
|
||||
buf[3] = (irq >> 0) & 0xFF;
|
||||
buf[4] = (IRQ_RADIO_NONE >> 8) & 0xFF;
|
||||
buf[5] = (IRQ_RADIO_NONE >> 0) & 0xFF;
|
||||
buf[6] = (IRQ_RADIO_NONE >> 8) & 0xFF;
|
||||
buf[7] = (IRQ_RADIO_NONE >> 0) & 0xFF;
|
||||
this->write_opcode_(RADIO_SET_DIOIRQPARAMS, buf, 8);
|
||||
|
||||
const uint32_t ticks = timeout_ms * 64;
|
||||
put_be24(buf, ticks);
|
||||
buf[0] = ticks >> 16;
|
||||
buf[1] = ticks >> 8;
|
||||
buf[2] = ticks;
|
||||
this->write_opcode_(RADIO_SET_TX, buf, 3);
|
||||
}
|
||||
|
||||
|
||||
@@ -41,7 +41,6 @@ class SX126xCommands {
|
||||
private:
|
||||
void read_opcode_(uint8_t opcode, uint8_t *data, uint8_t size);
|
||||
void write_opcode_(uint8_t opcode, const uint8_t *data, uint8_t size);
|
||||
void set_dio_irq_params_(uint16_t flags, uint16_t dio1);
|
||||
void read_register_(uint16_t reg, uint8_t *data, uint8_t size);
|
||||
void write_register_(uint16_t reg, const uint8_t *data, uint8_t size);
|
||||
static void encode_packet_params(const RadioProfile &profile, AppliedProfile &applied);
|
||||
|
||||
@@ -195,26 +195,6 @@ bool SX126xRadio::restore_() {
|
||||
return this->bus().ok();
|
||||
}
|
||||
|
||||
bool SX126xRadio::is_receiving() {
|
||||
if (this->state_ == RadioState::RADIO_STATE_HOLDING_RX) {
|
||||
return true;
|
||||
}
|
||||
// A radio that sleeps after sending is not listening, and reading it would wake it
|
||||
if (this->busy_ || this->state_ != RadioState::RADIO_STATE_IDLE || !this->applied_.rx_start) {
|
||||
return false;
|
||||
}
|
||||
// DIO1 signals a received packet that loop() has not read yet
|
||||
if (this->pending_irq_ != 0 || this->dio1_pin_->digital_read()) {
|
||||
return true;
|
||||
}
|
||||
this->busy_ = true;
|
||||
this->bus().begin();
|
||||
const uint16_t status = this->commands_.read_irq();
|
||||
this->busy_ = false;
|
||||
// A failed read counts as receiving, so the link holds the send and warns if the radio stays unreadable
|
||||
return !this->bus().ok() || (status & (IRQ_HEADER_VALID | IRQ_SYNCWORD_VALID)) != 0;
|
||||
}
|
||||
|
||||
RadioEffects SX126xRadio::poll(uint32_t now, std::vector<uint8_t> &packet) {
|
||||
if (this->busy_) {
|
||||
return {};
|
||||
|
||||
@@ -104,9 +104,6 @@ class SX126xRadio {
|
||||
bool can_configure() const { return !this->busy_ && !this->is_transmitting(); }
|
||||
bool can_change_mode() const { return !this->busy_ && this->state_ == RadioState::RADIO_STATE_IDLE; }
|
||||
size_t max_packet_size() const { return this->applied_.max_packet_size(); }
|
||||
// True while a packet is being received, or has been received and not yet read, so a send would lose it.
|
||||
// Reads the chip only when the radio is idle and listening; any other state reports false, a failed read true.
|
||||
bool is_receiving();
|
||||
|
||||
// Requires can_configure(). Resets the chip and applies the requested profile.
|
||||
RadioEffects configure(const RadioProfile &requested, std::span<char, 16> version);
|
||||
|
||||
@@ -1,72 +0,0 @@
|
||||
from esphome.components import packet_interface
|
||||
from esphome.components.packet_interface import CONF_MAX_PACKET_SIZE
|
||||
from esphome.components.packet_interface.radio_link import (
|
||||
MAX_PACKET_SIZE,
|
||||
new_radio_link,
|
||||
radio_link_final_validate,
|
||||
radio_link_schema,
|
||||
)
|
||||
import esphome.config_validation as cv
|
||||
from esphome.types import ConfigType
|
||||
|
||||
from .. import (
|
||||
CONF_MODULATION,
|
||||
CONF_PACKET_MODE,
|
||||
CONF_PAYLOAD_LENGTH,
|
||||
CONF_RX_START,
|
||||
CONF_SX127X_ID,
|
||||
CONF_SYNC_VALUE,
|
||||
SX127x,
|
||||
SX127xListener,
|
||||
sx127x_ns,
|
||||
)
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DEPENDENCIES = ["sx127x"]
|
||||
|
||||
# Outside LoRa mode the 64 byte FIFO also holds the length byte
|
||||
FSK_MAX_PACKET_SIZE = 63
|
||||
|
||||
SX127xPacketInterface = sx127x_ns.class_(
|
||||
"SX127xPacketInterface", packet_interface.PacketInterface, SX127xListener
|
||||
)
|
||||
|
||||
CONFIG_SCHEMA = radio_link_schema(SX127xPacketInterface, CONF_SX127X_ID, SX127x)
|
||||
|
||||
|
||||
def _check_fsk(config: ConfigType, radio: ConfigType) -> None:
|
||||
"""Without LoRa, the radio must send packets, not a continuous bit stream, and holds fewer bytes.
|
||||
|
||||
It can tell that a packet is arriving only from its sync word, which listen before talk needs.
|
||||
"""
|
||||
if radio[CONF_MODULATION] == "LORA":
|
||||
return
|
||||
if not radio.get(CONF_PACKET_MODE, False):
|
||||
raise cv.Invalid(
|
||||
f"Without LoRa modulation the radio's '{CONF_PACKET_MODE}' must be true, as a link sends packets",
|
||||
path=[CONF_SX127X_ID],
|
||||
)
|
||||
if not radio.get(CONF_SYNC_VALUE):
|
||||
raise cv.Invalid(
|
||||
f"Without LoRa modulation the radio needs a '{CONF_SYNC_VALUE}', so that the link can tell when a "
|
||||
"packet is arriving and not send over it",
|
||||
path=[CONF_SX127X_ID],
|
||||
)
|
||||
if config[CONF_MAX_PACKET_SIZE] > FSK_MAX_PACKET_SIZE:
|
||||
raise cv.Invalid(
|
||||
f"Without LoRa modulation the radio sends at most {FSK_MAX_PACKET_SIZE} bytes",
|
||||
path=[CONF_MAX_PACKET_SIZE],
|
||||
)
|
||||
|
||||
|
||||
def _receive_limit(radio: ConfigType) -> int:
|
||||
return MAX_PACKET_SIZE if radio[CONF_MODULATION] == "LORA" else FSK_MAX_PACKET_SIZE
|
||||
|
||||
|
||||
FINAL_VALIDATE_SCHEMA = radio_link_final_validate(
|
||||
CONF_SX127X_ID, CONF_PAYLOAD_LENGTH, CONF_RX_START, _check_fsk, _receive_limit
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
await new_radio_link(config, CONF_SX127X_ID, _receive_limit)
|
||||
@@ -1,10 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include "esphome/components/packet_interface/radio_link.h"
|
||||
#include "esphome/components/sx127x/sx127x.h"
|
||||
|
||||
namespace esphome::sx127x {
|
||||
|
||||
using SX127xPacketInterface = packet_interface::RadioLink<SX127x, SX127xListener, SX127xError, SX127X_MAX_PACKET_SIZE>;
|
||||
|
||||
} // namespace esphome::sx127x
|
||||
@@ -1,27 +1,12 @@
|
||||
#include "sx127x.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/hal.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/progmem.h"
|
||||
#include <cmath>
|
||||
#include <utility>
|
||||
|
||||
namespace esphome::sx127x {
|
||||
|
||||
ESPHOME_LOG_TAG(TAG, "sx127x");
|
||||
static const uint32_t FXOSC = 32000000u;
|
||||
static constexpr uint32_t TRANSMIT_TIMEOUT_MS = 4000;
|
||||
static constexpr uint32_t MAX_TRANSMIT_TIMEOUT_MS = 262143; // the same range as SX126x
|
||||
static constexpr uint32_t MODE_TIMEOUT_MS = 20;
|
||||
static constexpr uint32_t RECONFIGURE_INTERVAL_ID = 0;
|
||||
static constexpr uint32_t RECONFIGURE_INTERVAL_MS = 1000;
|
||||
|
||||
// Indexed by SX127xError
|
||||
PROGMEM_STRING_TABLE(SX127xErrorStrings, "none", "timeout", "invalid parameters", "radio not ready", "radio busy",
|
||||
"cancelled");
|
||||
|
||||
static const LogString *set_mode_failure() { return LOG_STR("Set mode failure"); }
|
||||
static constexpr uint16_t RAMP[16] PROGMEM = {3400, 2000, 1000, 500, 250, 125, 100, 62, 50, 40, 31, 25, 20, 15, 12, 10};
|
||||
// Aligned 32 bit loads from flash are safe on ESP8266, so this table is read directly
|
||||
static constexpr uint32_t BW_HZ[22] PROGMEM = {2604, 3125, 3906, 5208, 6250, 7812, 10416, 12500,
|
||||
@@ -62,86 +47,35 @@ void SX127x::read_fifo_(std::vector<uint8_t> &packet) {
|
||||
this->disable();
|
||||
}
|
||||
|
||||
// Burst write: the radio moves to the next register after each byte, except for REG_FIFO
|
||||
void SX127x::write_registers_(uint8_t reg, const uint8_t *data, size_t len) {
|
||||
void SX127x::write_fifo_(const uint8_t *data, size_t len) {
|
||||
this->enable();
|
||||
this->write_byte(reg | 0x80);
|
||||
this->write_array(data, len);
|
||||
this->write_byte(REG_FIFO | 0x80);
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
this->transfer_byte(data[i]);
|
||||
}
|
||||
this->disable();
|
||||
}
|
||||
|
||||
void SX127x::write_register16_(uint8_t msb_reg, uint16_t value) {
|
||||
uint8_t bytes[2];
|
||||
put_be16(bytes, value);
|
||||
this->write_registers_(msb_reg, bytes, sizeof(bytes));
|
||||
}
|
||||
void IRAM_ATTR SX127x::gpio_intr(SX127x *arg) { arg->enable_loop_soon_any_context(); }
|
||||
|
||||
void SX127x::setup() {
|
||||
// setup reset
|
||||
this->rst_pin_->setup();
|
||||
|
||||
// setup dio0
|
||||
if (this->dio0_pin_ != nullptr) {
|
||||
if (this->dio0_pin_) {
|
||||
this->dio0_pin_->setup();
|
||||
if (this->dio0_pin_->is_internal()) {
|
||||
static_cast<InternalGPIOPin *>(this->dio0_pin_)
|
||||
->attach_interrupt(&SX127x::gpio_intr, this, gpio::INTERRUPT_RISING_EDGE);
|
||||
}
|
||||
this->dio0_pin_->attach_interrupt(&SX127x::gpio_intr, this, gpio::INTERRUPT_RISING_EDGE);
|
||||
}
|
||||
|
||||
// start spi
|
||||
this->spi_setup();
|
||||
|
||||
// configure rf
|
||||
const LogString *reason = this->configure_radio_();
|
||||
if (reason != nullptr) {
|
||||
this->mark_failed(reason);
|
||||
return;
|
||||
}
|
||||
this->state_ = RadioState::RADIO_STATE_IDLE;
|
||||
// Sized once so later packet reads do not reallocate
|
||||
this->packet_.reserve(this->get_max_packet_size());
|
||||
this->configure();
|
||||
}
|
||||
|
||||
void SX127x::configure() {
|
||||
// Nothing to configure before setup() or after a failed setup
|
||||
if (!this->is_ready()) {
|
||||
return;
|
||||
}
|
||||
if (this->is_transmitting()) {
|
||||
ESP_LOGW(TAG, "Radio operation in progress, configuration ignored");
|
||||
return;
|
||||
}
|
||||
const LogString *reason = this->configure_radio_();
|
||||
if (reason != nullptr) {
|
||||
this->fail_(reason);
|
||||
return;
|
||||
}
|
||||
this->state_ = RadioState::RADIO_STATE_IDLE;
|
||||
if (this->reconfigure_pending_) {
|
||||
this->reconfigure_pending_ = false;
|
||||
this->cancel_interval(RECONFIGURE_INTERVAL_ID);
|
||||
}
|
||||
this->status_clear_warning();
|
||||
this->enable_loop();
|
||||
}
|
||||
|
||||
void SX127x::fail_(const LogString *reason) {
|
||||
this->state_ = RadioState::RADIO_STATE_NEEDS_CONFIGURATION;
|
||||
// Nothing else configures the radio again
|
||||
if (!this->reconfigure_pending_) {
|
||||
this->reconfigure_pending_ = true;
|
||||
this->set_interval(RECONFIGURE_INTERVAL_ID, RECONFIGURE_INTERVAL_MS, [this]() { this->configure(); });
|
||||
}
|
||||
// Last: a log listener may call configure(), which cancels the retry
|
||||
this->status_set_warning(reason);
|
||||
}
|
||||
|
||||
const LogString *SX127x::configure_radio_() {
|
||||
// Until this succeeds; a held packet is discarded
|
||||
this->state_ = RadioState::RADIO_STATE_NEEDS_CONFIGURATION;
|
||||
this->applied_ = {this->frequency_, this->payload_length_, this->modulation_, this->packet_mode_, this->rx_start_};
|
||||
|
||||
// toggle chip reset
|
||||
this->rst_pin_->digital_write(false);
|
||||
delayMicroseconds(1000);
|
||||
@@ -150,42 +84,35 @@ const LogString *SX127x::configure_radio_() {
|
||||
|
||||
// check silicon version to make sure hw is ok
|
||||
if (this->read_register_(REG_VERSION) != 0x12) {
|
||||
return LOG_STR("Unsupported chip version");
|
||||
this->mark_failed(LOG_STR("Unsupported chip version"));
|
||||
return;
|
||||
}
|
||||
|
||||
// enter sleep mode
|
||||
if (!this->set_mode_(MOD_FSK, MODE_SLEEP)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
this->set_mode_(MOD_FSK, MODE_SLEEP);
|
||||
|
||||
// set freq
|
||||
uint64_t frf = ((uint64_t) this->frequency_ << 19) / FXOSC;
|
||||
uint8_t frf_bytes[3];
|
||||
put_be24(frf_bytes, static_cast<uint32_t>(frf));
|
||||
this->write_registers_(REG_FRF_MSB, frf_bytes, sizeof(frf_bytes));
|
||||
this->write_register_(REG_FRF_MSB, (uint8_t) ((frf >> 16) & 0xFF));
|
||||
this->write_register_(REG_FRF_MID, (uint8_t) ((frf >> 8) & 0xFF));
|
||||
this->write_register_(REG_FRF_LSB, (uint8_t) ((frf >> 0) & 0xFF));
|
||||
|
||||
// enter standby mode
|
||||
if (!this->set_mode_(MOD_FSK, MODE_STDBY)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
this->set_mode_(MOD_FSK, MODE_STDBY);
|
||||
|
||||
// run image cal
|
||||
const LogString *reason = this->image_cal_();
|
||||
if (reason != nullptr) {
|
||||
return reason;
|
||||
}
|
||||
this->run_image_cal();
|
||||
|
||||
// go back to sleep
|
||||
if (!this->set_mode_(this->modulation_, MODE_SLEEP)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
this->set_mode_sleep();
|
||||
|
||||
// config pa
|
||||
if (this->pa_pin_ == PA_PIN_BOOST) {
|
||||
this->pa_power_ = clamp(this->pa_power_, (uint8_t) 2, (uint8_t) 17);
|
||||
this->pa_power_ = std::max(this->pa_power_, (uint8_t) 2);
|
||||
this->pa_power_ = std::min(this->pa_power_, (uint8_t) 17);
|
||||
this->write_register_(REG_PA_CONFIG, (this->pa_power_ - 2) | this->pa_pin_ | PA_MAX_POWER);
|
||||
} else {
|
||||
this->pa_power_ = clamp_at_most(this->pa_power_, (uint8_t) 14);
|
||||
this->pa_power_ = std::min(this->pa_power_, (uint8_t) 14);
|
||||
this->write_register_(REG_PA_CONFIG, (this->pa_power_ - 0) | this->pa_pin_ | PA_MAX_POWER);
|
||||
}
|
||||
if (this->modulation_ != MOD_LORA) {
|
||||
@@ -202,10 +129,11 @@ const LogString *SX127x::configure_radio_() {
|
||||
}
|
||||
|
||||
// switch to rx or sleep
|
||||
if (!this->restore_()) {
|
||||
return set_mode_failure();
|
||||
if (this->rx_start_) {
|
||||
this->set_mode_rx();
|
||||
} else {
|
||||
this->set_mode_sleep();
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void SX127x::configure_fsk_ook_() {
|
||||
@@ -213,12 +141,14 @@ void SX127x::configure_fsk_ook_() {
|
||||
this->write_register_(REG_RX_BW, progmem_read_byte(&BW_FSK_OOK[this->bandwidth_]));
|
||||
|
||||
// set fdev
|
||||
uint16_t fdev = clamp_at_most((this->deviation_ * 4096) / 250000, uint32_t{0x3FFF});
|
||||
this->write_register16_(REG_FDEV_MSB, fdev);
|
||||
uint32_t fdev = std::min((this->deviation_ * 4096) / 250000, (uint32_t) 0x3FFF);
|
||||
this->write_register_(REG_FDEV_MSB, (uint8_t) ((fdev >> 8) & 0xFF));
|
||||
this->write_register_(REG_FDEV_LSB, (uint8_t) ((fdev >> 0) & 0xFF));
|
||||
|
||||
// set bitrate
|
||||
uint16_t bitrate = (FXOSC + this->bitrate_ / 2) / this->bitrate_; // round up
|
||||
this->write_register16_(REG_BITRATE_MSB, bitrate);
|
||||
uint64_t bitrate = (FXOSC + this->bitrate_ / 2) / this->bitrate_; // round up
|
||||
this->write_register_(REG_BITRATE_MSB, (uint8_t) ((bitrate >> 8) & 0xFF));
|
||||
this->write_register_(REG_BITRATE_LSB, (uint8_t) ((bitrate >> 0) & 0xFF));
|
||||
|
||||
// configure rx and afc
|
||||
this->write_register_(REG_AFC_BW, progmem_read_byte(&BW_FSK_OOK[this->afc_bandwidth_]));
|
||||
@@ -238,7 +168,7 @@ void SX127x::configure_fsk_ook_() {
|
||||
this->write_register_(REG_PAYLOAD_LENGTH_LSB, this->payload_length_);
|
||||
this->write_register_(REG_PACKET_CONFIG_1, crc_mode | FIXED_LENGTH);
|
||||
} else {
|
||||
this->write_register_(REG_PAYLOAD_LENGTH_LSB, this->get_max_packet_size());
|
||||
this->write_register_(REG_PAYLOAD_LENGTH_LSB, this->get_max_packet_size() - 1);
|
||||
this->write_register_(REG_PACKET_CONFIG_1, crc_mode | VARIABLE_LENGTH);
|
||||
}
|
||||
this->write_register_(REG_PACKET_CONFIG_2, PACKET_MODE);
|
||||
@@ -267,7 +197,8 @@ void SX127x::configure_fsk_ook_() {
|
||||
} else {
|
||||
this->write_register_(REG_PREAMBLE_DETECT, PREAMBLE_DETECTOR_OFF);
|
||||
}
|
||||
this->write_register16_(REG_PREAMBLE_SIZE_MSB, this->preamble_size_);
|
||||
this->write_register_(REG_PREAMBLE_SIZE_MSB, this->preamble_size_ >> 8);
|
||||
this->write_register_(REG_PREAMBLE_SIZE_LSB, this->preamble_size_ & 0xFF);
|
||||
|
||||
// config sync generation and setup ook threshold
|
||||
uint8_t bitsync = this->bitsync_ ? BIT_SYNC_ON : BIT_SYNC_OFF;
|
||||
@@ -295,7 +226,8 @@ void SX127x::configure_lora_() {
|
||||
|
||||
// config preamble
|
||||
if (this->preamble_size_ >= 6) {
|
||||
this->write_register16_(REG_PREAMBLE_LEN_MSB, this->preamble_size_);
|
||||
this->write_register_(REG_PREAMBLE_LEN_MSB, this->preamble_size_ >> 8);
|
||||
this->write_register_(REG_PREAMBLE_LEN_LSB, this->preamble_size_ & 0xFF);
|
||||
}
|
||||
|
||||
// optimize detection
|
||||
@@ -320,167 +252,70 @@ void SX127x::configure_lora_() {
|
||||
}
|
||||
|
||||
size_t SX127x::get_max_packet_size() {
|
||||
if (this->applied_.payload_length > 0) {
|
||||
return this->applied_.payload_length;
|
||||
if (this->payload_length_ > 0) {
|
||||
return this->payload_length_;
|
||||
}
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
return SX127X_MAX_PACKET_SIZE;
|
||||
}
|
||||
// The 64 byte FIFO also holds the length byte
|
||||
return 63;
|
||||
return 64;
|
||||
}
|
||||
|
||||
SX127xError SX127x::transmit_packet(const uint8_t *data, size_t len) {
|
||||
SX127xError result = this->start_transmit_(nullptr, data, len, TRANSMIT_TIMEOUT_MS);
|
||||
if (result == SX127xError::SX127X_ERROR_NONE) {
|
||||
// Without a listener this send cannot be cancelled or replaced
|
||||
result = SX127xError::SX127X_ERROR_NOT_READY;
|
||||
while (this->is_transmitting() && !this->poll_transmit_(millis(), result)) {
|
||||
App.feed_wdt();
|
||||
}
|
||||
}
|
||||
if (result != SX127xError::SX127X_ERROR_NONE) {
|
||||
ESP_LOGW(
|
||||
TAG, "Packet send failed: %s",
|
||||
LOG_STR_ARG(SX127xErrorStrings::get_log_str(static_cast<uint8_t>(result), SX127xErrorStrings::LAST_INDEX)));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
SX127xError SX127x::start_transmit_async(SX127xTransmitListener *listener, const uint8_t *data, size_t len,
|
||||
uint32_t timeout_ms) {
|
||||
if (listener == nullptr || timeout_ms == 0 || timeout_ms > MAX_TRANSMIT_TIMEOUT_MS) {
|
||||
return SX127xError::SX127X_ERROR_INVALID_PARAMS;
|
||||
}
|
||||
return this->start_transmit_(listener, data, len, timeout_ms);
|
||||
}
|
||||
|
||||
SX127xError SX127x::start_transmit_(SX127xTransmitListener *listener, const uint8_t *data, size_t len,
|
||||
uint32_t timeout_ms) {
|
||||
// Callers such as a template number's on_value can run before setup() or after a failed setup
|
||||
if (!this->is_ready() || this->state_ == RadioState::RADIO_STATE_NEEDS_CONFIGURATION) {
|
||||
if (!this->is_ready()) {
|
||||
ESP_LOGW(TAG, "Radio not ready, packet dropped");
|
||||
return SX127xError::SX127X_ERROR_NOT_READY;
|
||||
}
|
||||
if (this->state_ != RadioState::RADIO_STATE_IDLE) {
|
||||
return SX127xError::SX127X_ERROR_BUSY;
|
||||
if (this->payload_length_ > 0 && this->payload_length_ != len) {
|
||||
ESP_LOGE(TAG, "Packet size does not match config");
|
||||
return SX127xError::INVALID_PARAMS;
|
||||
}
|
||||
if (data == nullptr || len == 0 || len > this->get_max_packet_size() ||
|
||||
(this->applied_.payload_length > 0 && this->applied_.payload_length != len)) {
|
||||
return SX127xError::SX127X_ERROR_INVALID_PARAMS;
|
||||
if (len == 0 || len > this->get_max_packet_size()) {
|
||||
ESP_LOGE(TAG, "Packet size out of range");
|
||||
return SX127xError::INVALID_PARAMS;
|
||||
}
|
||||
|
||||
if (this->dio0_pin_ == nullptr) {
|
||||
ESP_LOGE(TAG, "DIO0 pin not configured, cannot wait for transmit completion");
|
||||
return SX127xError::SX127X_ERROR_INVALID_PARAMS;
|
||||
return SX127xError::INVALID_PARAMS;
|
||||
}
|
||||
|
||||
if (!this->set_mode_(this->applied_.modulation, MODE_STDBY)) {
|
||||
this->fail_(set_mode_failure());
|
||||
return SX127xError::SX127X_ERROR_NOT_READY;
|
||||
}
|
||||
// A packet received before standby stays in the FIFO for loop()
|
||||
if (this->packet_waiting_()) {
|
||||
this->state_ = RadioState::RADIO_STATE_HOLDING_RX;
|
||||
this->enable_loop();
|
||||
return SX127xError::SX127X_ERROR_BUSY;
|
||||
}
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
if (this->applied_.payload_length == 0) {
|
||||
SX127xError ret = SX127xError::NONE;
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_standby();
|
||||
if (this->payload_length_ == 0) {
|
||||
this->write_register_(REG_PAYLOAD_LENGTH, len);
|
||||
}
|
||||
this->write_register_(REG_IRQ_FLAGS, 0xFF);
|
||||
this->write_register_(REG_FIFO_ADDR_PTR, 0);
|
||||
} else if (this->applied_.payload_length == 0) {
|
||||
this->write_register_(REG_FIFO, len);
|
||||
}
|
||||
this->write_registers_(REG_FIFO, data, len);
|
||||
if (!this->enter_tx_()) {
|
||||
this->fail_(set_mode_failure());
|
||||
return SX127xError::SX127X_ERROR_NOT_READY;
|
||||
}
|
||||
this->tx_ = {listener, millis(), timeout_ms};
|
||||
this->state_ = RadioState::RADIO_STATE_TRANSMITTING;
|
||||
this->enable_loop();
|
||||
return SX127xError::SX127X_ERROR_NONE;
|
||||
}
|
||||
|
||||
bool SX127x::poll_transmit_(uint32_t now, SX127xError &result) {
|
||||
if (!this->is_transmitting()) {
|
||||
return false;
|
||||
}
|
||||
// DIO0 is TX_DONE in LoRa, and PacketSent in FSK and OOK while transmitting
|
||||
if (this->dio0_pin_->digital_read()) {
|
||||
result = SX127xError::SX127X_ERROR_NONE;
|
||||
} else if (static_cast<int32_t>(now - this->tx_.started_ms) >= static_cast<int32_t>(this->tx_.timeout_ms)) {
|
||||
// Signed, as the cached loop time can precede the start
|
||||
result = SX127xError::SX127X_ERROR_TIMEOUT;
|
||||
this->write_fifo_(data, len);
|
||||
this->set_mode_tx();
|
||||
} else {
|
||||
return false;
|
||||
this->set_mode_standby();
|
||||
if (this->payload_length_ == 0) {
|
||||
this->write_register_(REG_FIFO, len);
|
||||
}
|
||||
this->write_fifo_(data, len);
|
||||
this->set_mode_tx();
|
||||
}
|
||||
result = this->finish_transmit_(result);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool SX127x::cancel_transmit_async(SX127xTransmitListener *listener) {
|
||||
if (!this->is_transmitting() || listener == nullptr || listener != this->tx_.listener) {
|
||||
return false;
|
||||
// wait until transmit completes, typically the delay will be less than 100 ms
|
||||
uint32_t start = millis();
|
||||
while (!this->dio0_pin_->digital_read()) {
|
||||
App.feed_wdt();
|
||||
if (millis() - start > 4000) {
|
||||
ESP_LOGE(TAG, "Transmit packet failure");
|
||||
ret = SX127xError::TIMEOUT;
|
||||
break;
|
||||
}
|
||||
}
|
||||
this->finish_transmit_(SX127xError::SX127X_ERROR_CANCELLED);
|
||||
return true;
|
||||
}
|
||||
|
||||
// The only place a send ends; state is committed before the listener runs
|
||||
SX127xError SX127x::finish_transmit_(SX127xError result) {
|
||||
SX127xTransmitListener *listener = std::exchange(this->tx_.listener, nullptr);
|
||||
if (this->restore_()) {
|
||||
this->state_ = RadioState::RADIO_STATE_IDLE;
|
||||
if (this->rx_start_) {
|
||||
this->set_mode_rx();
|
||||
} else {
|
||||
this->fail_(set_mode_failure());
|
||||
this->set_mode_sleep();
|
||||
}
|
||||
if (listener != nullptr) {
|
||||
listener->on_transmit_complete(result);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
bool SX127x::restore_() {
|
||||
// Via standby: the chip ignores RX while a packet is still going out
|
||||
if (!this->set_mode_(this->applied_.modulation, MODE_STDBY)) {
|
||||
return false;
|
||||
}
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
this->write_register_(REG_IRQ_FLAGS, 0xFF);
|
||||
}
|
||||
return this->applied_.rx_start ? this->enter_rx_() : this->set_mode_(this->applied_.modulation, MODE_SLEEP);
|
||||
}
|
||||
|
||||
bool SX127x::is_receiving() {
|
||||
if (this->state_ == RadioState::RADIO_STATE_HOLDING_RX) {
|
||||
return true;
|
||||
}
|
||||
// A radio that sleeps after sending is not listening
|
||||
if (this->state_ != RadioState::RADIO_STATE_IDLE || !this->applied_.rx_start || this->dio0_pin_ == nullptr) {
|
||||
return false;
|
||||
}
|
||||
const bool lora = this->applied_.modulation == MOD_LORA;
|
||||
// In receive mode DIO0 signals a received packet that loop() has not read yet. In LoRa it also signals TX_DONE
|
||||
// after the TX mode action.
|
||||
if (this->dio0_pin_->digital_read() && (!lora || (this->read_register_(REG_IRQ_FLAGS) & RX_DONE) != 0)) {
|
||||
return true;
|
||||
}
|
||||
if (!lora) {
|
||||
// Set from the sync word until the packet has been read; the preamble flag stays set when no sync word follows
|
||||
return (this->read_register_(REG_IRQ_FLAGS_1) & IRQ_FLAGS_1_SYNC_ADDRESS_MATCH) != 0;
|
||||
}
|
||||
return (this->read_register_(REG_MODEM_STAT) &
|
||||
(MODEM_STAT_SIGNAL_DETECTED | MODEM_STAT_SIGNAL_SYNCHRONIZED | MODEM_STAT_HEADER_VALID)) != 0;
|
||||
}
|
||||
|
||||
bool SX127x::packet_waiting_() {
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
const uint8_t flags = this->read_register_(REG_IRQ_FLAGS);
|
||||
return (flags & RX_DONE) != 0 && (flags & PAYLOAD_CRC_ERROR) == 0;
|
||||
}
|
||||
return this->applied_.packet_mode && (this->read_register_(REG_IRQ_FLAGS2) & PAYLOAD_READY) != 0;
|
||||
return ret;
|
||||
}
|
||||
|
||||
void SX127x::call_listeners_(const std::vector<uint8_t> &packet, float rssi, float snr) {
|
||||
@@ -491,81 +326,43 @@ void SX127x::call_listeners_(const std::vector<uint8_t> &packet, float rssi, flo
|
||||
}
|
||||
|
||||
void SX127x::loop() {
|
||||
switch (this->state_) {
|
||||
case RadioState::RADIO_STATE_TRANSMITTING: {
|
||||
SX127xError result;
|
||||
this->poll_transmit_(App.get_loop_component_start_time(), result);
|
||||
return;
|
||||
}
|
||||
case RadioState::RADIO_STATE_HOLDING_RX:
|
||||
this->receive_();
|
||||
return;
|
||||
case RadioState::RADIO_STATE_IDLE:
|
||||
if (this->dio0_pin_ == nullptr) {
|
||||
this->disable_loop();
|
||||
return;
|
||||
}
|
||||
// DIO0's interrupt wakes the loop
|
||||
if (this->dio0_pin_->is_internal()) {
|
||||
this->disable_loop();
|
||||
}
|
||||
if (this->dio0_pin_->digital_read()) {
|
||||
this->receive_();
|
||||
}
|
||||
return;
|
||||
default:
|
||||
// configure() wakes the loop
|
||||
this->disable_loop();
|
||||
return;
|
||||
this->disable_loop();
|
||||
if (this->dio0_pin_ == nullptr || !this->dio0_pin_->digital_read()) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
void SX127x::receive_() {
|
||||
const bool holding = this->state_ == RadioState::RADIO_STATE_HOLDING_RX;
|
||||
bool received = false;
|
||||
float rssi = 0.0f;
|
||||
float snr = NAN; // FSK and OOK have no SNR
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
uint8_t status = this->read_register_(REG_IRQ_FLAGS);
|
||||
this->write_register_(REG_IRQ_FLAGS, 0xFF);
|
||||
if ((status & RX_DONE) != 0 && (status & PAYLOAD_CRC_ERROR) == 0) {
|
||||
if ((status & PAYLOAD_CRC_ERROR) == 0) {
|
||||
uint8_t bytes = this->read_register_(REG_NB_RX_BYTES);
|
||||
uint8_t addr = this->read_register_(REG_FIFO_RX_CURR_ADDR);
|
||||
uint8_t raw_rssi = this->read_register_(REG_PKT_RSSI_VALUE);
|
||||
int8_t raw_snr = (int8_t) this->read_register_(REG_PKT_SNR_VALUE);
|
||||
uint8_t rssi = this->read_register_(REG_PKT_RSSI_VALUE);
|
||||
int8_t snr = (int8_t) this->read_register_(REG_PKT_SNR_VALUE);
|
||||
this->packet_.resize(bytes);
|
||||
this->write_register_(REG_FIFO_ADDR_PTR, addr);
|
||||
this->read_fifo_(this->packet_);
|
||||
rssi = (float) raw_rssi - (this->applied_.frequency > 700000000 ? RSSI_OFFSET_HF : RSSI_OFFSET_LF);
|
||||
snr = (float) raw_snr / 4;
|
||||
received = true;
|
||||
if (this->frequency_ > 700000000) {
|
||||
this->call_listeners_(this->packet_, (float) rssi - RSSI_OFFSET_HF, (float) snr / 4);
|
||||
} else {
|
||||
this->call_listeners_(this->packet_, (float) rssi - RSSI_OFFSET_LF, (float) snr / 4);
|
||||
}
|
||||
}
|
||||
} else if (this->applied_.packet_mode && (this->read_register_(REG_IRQ_FLAGS2) & PAYLOAD_READY) != 0) {
|
||||
uint8_t payload_length = this->applied_.payload_length;
|
||||
} else if (this->packet_mode_) {
|
||||
uint8_t payload_length = this->payload_length_;
|
||||
if (payload_length == 0) {
|
||||
payload_length = this->read_register_(REG_FIFO);
|
||||
}
|
||||
this->packet_.resize(payload_length);
|
||||
this->read_fifo_(this->packet_);
|
||||
received = true;
|
||||
}
|
||||
if (holding) {
|
||||
if (this->restore_()) {
|
||||
this->state_ = RadioState::RADIO_STATE_IDLE;
|
||||
} else {
|
||||
this->fail_(set_mode_failure());
|
||||
}
|
||||
}
|
||||
if (received) {
|
||||
this->call_listeners_(this->packet_, rssi, snr);
|
||||
this->call_listeners_(this->packet_, 0.0f, 0.0f);
|
||||
}
|
||||
}
|
||||
|
||||
const LogString *SX127x::image_cal_() {
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
if (!this->set_mode_(MOD_FSK, MODE_SLEEP) || !this->set_mode_(MOD_FSK, MODE_STDBY)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
void SX127x::run_image_cal() {
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_(MOD_FSK, MODE_SLEEP);
|
||||
this->set_mode_(MOD_FSK, MODE_STDBY);
|
||||
}
|
||||
if (this->auto_cal_) {
|
||||
this->write_register_(REG_IMAGE_CAL, IMAGE_CAL_START | AUTO_IMAGE_CAL_ON | TEMP_THRESHOLD_10C);
|
||||
@@ -575,29 +372,17 @@ const LogString *SX127x::image_cal_() {
|
||||
uint32_t start = millis();
|
||||
while (this->read_register_(REG_IMAGE_CAL) & IMAGE_CAL_RUNNING) {
|
||||
if (millis() - start > 20) {
|
||||
return LOG_STR("Image cal failure");
|
||||
this->mark_failed(LOG_STR("Image cal failure"));
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
if (!this->set_mode_(this->applied_.modulation, MODE_SLEEP) ||
|
||||
!this->set_mode_(this->applied_.modulation, MODE_STDBY)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void SX127x::run_image_cal() {
|
||||
if (!this->can_change_mode_()) {
|
||||
return;
|
||||
}
|
||||
const LogString *reason = this->image_cal_();
|
||||
if (reason != nullptr) {
|
||||
this->fail_(reason);
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_(this->modulation_, MODE_SLEEP);
|
||||
this->set_mode_(this->modulation_, MODE_STDBY);
|
||||
}
|
||||
}
|
||||
|
||||
bool SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
void SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
uint32_t start = millis();
|
||||
this->write_register_(REG_OP_MODE, modulation | mode);
|
||||
while (true) {
|
||||
@@ -606,62 +391,34 @@ bool SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
if (mode == MODE_SLEEP) {
|
||||
this->write_register_(REG_OP_MODE, modulation | mode);
|
||||
}
|
||||
return true;
|
||||
break;
|
||||
}
|
||||
if (millis() - start > MODE_TIMEOUT_MS) {
|
||||
return false;
|
||||
if (millis() - start > 20) {
|
||||
this->mark_failed(LOG_STR("Set mode failure"));
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool SX127x::enter_rx_() {
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
void SX127x::set_mode_rx() {
|
||||
this->set_mode_(this->modulation_, MODE_RX);
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->write_register_(REG_IRQ_FLAGS_MASK, 0x00);
|
||||
this->write_register_(REG_DIO_MAPPING1, DIO0_MAPPING_00);
|
||||
}
|
||||
return this->set_mode_(this->applied_.modulation, MODE_RX);
|
||||
}
|
||||
|
||||
bool SX127x::enter_tx_() {
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
void SX127x::set_mode_tx() {
|
||||
this->set_mode_(this->modulation_, MODE_TX);
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->write_register_(REG_IRQ_FLAGS_MASK, 0x00);
|
||||
this->write_register_(REG_DIO_MAPPING1, DIO0_MAPPING_01);
|
||||
}
|
||||
return this->set_mode_(this->applied_.modulation, MODE_TX);
|
||||
}
|
||||
|
||||
bool SX127x::can_change_mode_() {
|
||||
if (this->state_ == RadioState::RADIO_STATE_IDLE) {
|
||||
return true;
|
||||
}
|
||||
ESP_LOGW(TAG, "Radio unavailable, mode change ignored");
|
||||
return false;
|
||||
}
|
||||
void SX127x::set_mode_standby() { this->set_mode_(this->modulation_, MODE_STDBY); }
|
||||
|
||||
void SX127x::change_mode_(uint8_t mode) {
|
||||
if (!this->can_change_mode_()) {
|
||||
return;
|
||||
}
|
||||
bool ok;
|
||||
if (mode == MODE_RX) {
|
||||
ok = this->enter_rx_();
|
||||
} else if (mode == MODE_TX) {
|
||||
ok = this->enter_tx_();
|
||||
} else {
|
||||
ok = this->set_mode_(this->applied_.modulation, mode);
|
||||
}
|
||||
if (!ok) {
|
||||
this->fail_(set_mode_failure());
|
||||
}
|
||||
}
|
||||
|
||||
void SX127x::set_mode_rx() { this->change_mode_(MODE_RX); }
|
||||
|
||||
void SX127x::set_mode_tx() { this->change_mode_(MODE_TX); }
|
||||
|
||||
void SX127x::set_mode_standby() { this->change_mode_(MODE_STDBY); }
|
||||
|
||||
void SX127x::set_mode_sleep() { this->change_mode_(MODE_SLEEP); }
|
||||
void SX127x::set_mode_sleep() { this->set_mode_(this->modulation_, MODE_SLEEP); }
|
||||
|
||||
void SX127x::dump_config() {
|
||||
ESP_LOGCONFIG(TAG, "SX127x:");
|
||||
|
||||
@@ -36,35 +36,10 @@ enum SX127xBw : uint8_t {
|
||||
SX127X_BW_500_0,
|
||||
};
|
||||
|
||||
enum class SX127xError {
|
||||
SX127X_ERROR_NONE = 0,
|
||||
SX127X_ERROR_TIMEOUT,
|
||||
SX127X_ERROR_INVALID_PARAMS,
|
||||
SX127X_ERROR_NOT_READY,
|
||||
SX127X_ERROR_BUSY,
|
||||
SX127X_ERROR_CANCELLED,
|
||||
};
|
||||
|
||||
class SX127xTransmitListener {
|
||||
public:
|
||||
virtual void on_transmit_complete(SX127xError result) = 0;
|
||||
};
|
||||
|
||||
// Driver state, not the chip's mode
|
||||
enum class RadioState : uint8_t {
|
||||
// Before setup or after a failed mode change; configure() is retried every second
|
||||
RADIO_STATE_NEEDS_CONFIGURATION,
|
||||
// Receiving or sleeping as configured, or sending after the TX mode action (untracked)
|
||||
RADIO_STATE_IDLE,
|
||||
// A send is on air
|
||||
RADIO_STATE_TRANSMITTING,
|
||||
// A send found a received packet waiting; loop() delivers it
|
||||
RADIO_STATE_HOLDING_RX,
|
||||
};
|
||||
enum class SX127xError { NONE = 0, TIMEOUT, INVALID_PARAMS, SX127X_ERROR_NOT_READY };
|
||||
|
||||
class SX127xListener {
|
||||
public:
|
||||
// Called from loop(); the packet is only valid until this returns
|
||||
virtual void on_packet(const std::vector<uint8_t> &packet, float rssi, float snr) = 0;
|
||||
};
|
||||
|
||||
@@ -85,9 +60,8 @@ class SX127x final : public Component,
|
||||
void set_coding_rate(uint8_t coding_rate) { this->coding_rate_ = coding_rate; }
|
||||
void set_crc_enable(bool crc_enable) { this->crc_enable_ = crc_enable; }
|
||||
void set_deviation(uint32_t deviation) { this->deviation_ = deviation; }
|
||||
void set_dio0_pin(GPIOPin *dio0_pin) { this->dio0_pin_ = dio0_pin; }
|
||||
void set_dio0_pin(InternalGPIOPin *dio0_pin) { this->dio0_pin_ = dio0_pin; }
|
||||
void set_frequency(uint32_t frequency) { this->frequency_ = frequency; }
|
||||
// Ignored unless the radio is idle
|
||||
void set_mode_rx();
|
||||
void set_mode_tx();
|
||||
void set_mode_standby();
|
||||
@@ -102,72 +76,27 @@ class SX127x final : public Component,
|
||||
void set_preamble_polarity(uint8_t preamble_polarity) { this->preamble_polarity_ = preamble_polarity; }
|
||||
void set_preamble_size(uint16_t preamble_size) { this->preamble_size_ = preamble_size; }
|
||||
void set_preamble_detect(uint8_t preamble_detect) { this->preamble_detect_ = preamble_detect; }
|
||||
void set_rst_pin(GPIOPin *rst_pin) { this->rst_pin_ = rst_pin; }
|
||||
void set_rst_pin(InternalGPIOPin *rst_pin) { this->rst_pin_ = rst_pin; }
|
||||
void set_rx_floor(float floor) { this->rx_floor_ = floor; }
|
||||
void set_rx_start(bool start) { this->rx_start_ = start; }
|
||||
void set_shaping(uint8_t shaping) { this->shaping_ = shaping; }
|
||||
void set_spreading_factor(uint8_t spreading_factor) { this->spreading_factor_ = spreading_factor; }
|
||||
void set_sync_value(const std::vector<uint8_t> &sync_value) { this->sync_value_ = sync_value; }
|
||||
void run_image_cal();
|
||||
// Ignored while a send is on air; discards a held packet
|
||||
void configure();
|
||||
SX127xError transmit_packet(const uint8_t *data, size_t len);
|
||||
SX127xError transmit_packet(const std::vector<uint8_t> &packet) {
|
||||
return this->transmit_packet(packet.data(), packet.size());
|
||||
}
|
||||
// On SX127X_ERROR_NONE, the listener is called once from loop()
|
||||
[[nodiscard]] SX127xError start_transmit_async(SX127xTransmitListener *listener, const uint8_t *data, size_t len,
|
||||
uint32_t timeout_ms = 4000);
|
||||
[[nodiscard]] SX127xError start_transmit_async(SX127xTransmitListener *listener, const std::vector<uint8_t> &packet,
|
||||
uint32_t timeout_ms = 4000) {
|
||||
return this->start_transmit_async(listener, packet.data(), packet.size(), timeout_ms);
|
||||
}
|
||||
// Completes the send with SX127X_ERROR_CANCELLED; false if the listener has none
|
||||
bool cancel_transmit_async(SX127xTransmitListener *listener);
|
||||
bool is_transmitting() const { return this->state_ == RadioState::RADIO_STATE_TRANSMITTING; }
|
||||
void register_listener(SX127xListener *listener) { this->listeners_.push_back(listener); }
|
||||
// True while a packet is being received, or has been received and not yet read; sending would lose it.
|
||||
bool is_receiving();
|
||||
Trigger<std::vector<uint8_t>, float, float> *get_packet_trigger() { return &this->packet_trigger_; }
|
||||
|
||||
protected:
|
||||
// Settings as last applied by configure(), used by sends and reception
|
||||
struct AppliedSettings {
|
||||
uint32_t frequency{0};
|
||||
uint32_t payload_length{0};
|
||||
uint8_t modulation{0};
|
||||
bool packet_mode{false};
|
||||
bool rx_start{false};
|
||||
};
|
||||
struct TxOperation {
|
||||
SX127xTransmitListener *listener{nullptr};
|
||||
uint32_t started_ms{0};
|
||||
uint32_t timeout_ms{0};
|
||||
};
|
||||
static void IRAM_ATTR gpio_intr(SX127x *arg) { arg->enable_loop_soon_any_context(); }
|
||||
// Each returns the failure reason, or nullptr
|
||||
const LogString *configure_radio_();
|
||||
const LogString *image_cal_();
|
||||
static void gpio_intr(SX127x *arg);
|
||||
void configure_fsk_ook_();
|
||||
void configure_lora_();
|
||||
// False if the chip did not enter the mode
|
||||
bool set_mode_(uint8_t modulation, uint8_t mode);
|
||||
bool enter_rx_();
|
||||
bool enter_tx_();
|
||||
bool can_change_mode_();
|
||||
void change_mode_(uint8_t mode);
|
||||
// Puts the radio back in RX or sleep after a send or a held packet
|
||||
bool restore_();
|
||||
// Retries configure() every second
|
||||
void fail_(const LogString *reason);
|
||||
bool packet_waiting_();
|
||||
void receive_();
|
||||
SX127xError start_transmit_(SX127xTransmitListener *listener, const uint8_t *data, size_t len, uint32_t timeout_ms);
|
||||
// True once the send has ended, with its outcome in result
|
||||
bool poll_transmit_(uint32_t now, SX127xError &result);
|
||||
SX127xError finish_transmit_(SX127xError result);
|
||||
void write_registers_(uint8_t reg, const uint8_t *data, size_t len);
|
||||
void write_register16_(uint8_t msb_reg, uint16_t value);
|
||||
void set_mode_(uint8_t modulation, uint8_t mode);
|
||||
void write_fifo_(const uint8_t *data, size_t len);
|
||||
void read_fifo_(std::vector<uint8_t> &packet);
|
||||
void write_register_(uint8_t reg, uint8_t value);
|
||||
void call_listeners_(const std::vector<uint8_t> &packet, float rssi, float snr);
|
||||
@@ -176,10 +105,8 @@ class SX127x final : public Component,
|
||||
std::vector<SX127xListener *> listeners_;
|
||||
std::vector<uint8_t> packet_;
|
||||
std::vector<uint8_t> sync_value_;
|
||||
AppliedSettings applied_;
|
||||
TxOperation tx_;
|
||||
GPIOPin *dio0_pin_{nullptr};
|
||||
GPIOPin *rst_pin_{nullptr};
|
||||
InternalGPIOPin *dio0_pin_{nullptr};
|
||||
InternalGPIOPin *rst_pin_{nullptr};
|
||||
SX127xBw afc_bandwidth_{SX127X_BW_50_0};
|
||||
SX127xBw bandwidth_;
|
||||
uint32_t bitrate_;
|
||||
@@ -203,8 +130,6 @@ class SX127x final : public Component,
|
||||
bool crc_enable_{false};
|
||||
bool packet_mode_{false};
|
||||
bool rx_start_{false};
|
||||
bool reconfigure_pending_{false};
|
||||
RadioState state_{RadioState::RADIO_STATE_NEEDS_CONFIGURATION};
|
||||
};
|
||||
|
||||
} // namespace esphome::sx127x
|
||||
@@ -46,8 +46,6 @@ enum SX127xReg : uint8_t {
|
||||
REG_PAYLOAD_LENGTH_LSB = 0x32,
|
||||
REG_FIFO_THRESH = 0x35,
|
||||
REG_IMAGE_CAL = 0x3B,
|
||||
REG_IRQ_FLAGS_1 = 0x3E,
|
||||
REG_IRQ_FLAGS2 = 0x3F,
|
||||
// LoRa registers
|
||||
REG_FIFO_ADDR_PTR = 0x0D,
|
||||
REG_FIFO_TX_BASE_ADDR = 0x0E,
|
||||
@@ -262,22 +260,6 @@ enum SX127xIrqFlags : uint8_t {
|
||||
CAD_DETECTED = 0x01,
|
||||
};
|
||||
|
||||
enum SX127xIrqFlags1 : uint8_t {
|
||||
IRQ_FLAGS_1_PREAMBLE_DETECT = 0x02,
|
||||
IRQ_FLAGS_1_SYNC_ADDRESS_MATCH = 0x01,
|
||||
};
|
||||
|
||||
enum SX127xModemStat : uint8_t {
|
||||
MODEM_STAT_SIGNAL_DETECTED = 0x01,
|
||||
MODEM_STAT_SIGNAL_SYNCHRONIZED = 0x02,
|
||||
MODEM_STAT_HEADER_VALID = 0x08,
|
||||
};
|
||||
|
||||
enum SX127xIrqFlags2 : uint8_t {
|
||||
PACKET_SENT = 0x08,
|
||||
PAYLOAD_READY = 0x04,
|
||||
};
|
||||
|
||||
enum SX127xModemCfg1 : uint8_t {
|
||||
BW_7_8 = 0x00,
|
||||
BW_10_4 = 0x10,
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
"""TCP links. The packet_interface platform carries packets over a TCP connection."""
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DOMAIN = "tcp"
|
||||
@@ -1,132 +0,0 @@
|
||||
import esphome.codegen as cg
|
||||
from esphome.components import binary_sensor, packet_interface, socket
|
||||
from esphome.components.const import (
|
||||
CONF_ALLOWED_IPS,
|
||||
CONF_CONNECTED,
|
||||
CONF_HOST,
|
||||
CONF_RECONNECT_INTERVAL,
|
||||
CONF_ROLE,
|
||||
)
|
||||
from esphome.components.packet_interface import (
|
||||
CONF_MAX_PACKET_SIZE,
|
||||
new_packet_interface,
|
||||
packet_interface_schema,
|
||||
)
|
||||
from esphome.components.packet_interface.layers import (
|
||||
CONF_ADDRESSING,
|
||||
CONF_RELIABILITY,
|
||||
CONF_SESSION,
|
||||
)
|
||||
from esphome.components.packet_interface.layers.basic_session import CONF_KEEP_ALIVE
|
||||
import esphome.config_validation as cv
|
||||
from esphome.const import (
|
||||
CONF_ID,
|
||||
CONF_PORT,
|
||||
CONF_TIMEOUT,
|
||||
DEVICE_CLASS_CONNECTIVITY,
|
||||
ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
)
|
||||
from esphome.types import ConfigType
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DEPENDENCIES = ["network"]
|
||||
|
||||
|
||||
def AUTO_LOAD(config: ConfigType | None = None) -> list[str]:
|
||||
"""The binary_sensor component only for the connected sensor; without a config, as tooling calls it, both."""
|
||||
if not config or CONF_CONNECTED in config:
|
||||
return ["socket", "binary_sensor"]
|
||||
return ["socket"]
|
||||
|
||||
|
||||
# Each packet and its 2 byte length must fit the socket link's 1024 byte send buffer
|
||||
MAX_PACKET_SIZE = 1022
|
||||
|
||||
tcp_ns = cg.esphome_ns.namespace("tcp")
|
||||
TcpPacketInterface = tcp_ns.class_(
|
||||
"TcpPacketInterface", packet_interface.PacketInterface
|
||||
)
|
||||
|
||||
|
||||
def _timeout(config: ConfigType) -> ConfigType:
|
||||
"""Default the timeout to three keep-alive intervals, and require it to be longer than one."""
|
||||
keep_alive = config[CONF_KEEP_ALIVE].total_milliseconds
|
||||
if (timeout := config.get(CONF_TIMEOUT)) is None:
|
||||
config[CONF_TIMEOUT] = cv.positive_time_period_milliseconds(
|
||||
f"{keep_alive * 3}ms"
|
||||
)
|
||||
elif timeout.total_milliseconds <= keep_alive:
|
||||
raise cv.Invalid("Must be longer than keep_alive", path=[CONF_TIMEOUT])
|
||||
return config
|
||||
|
||||
|
||||
BASE_SCHEMA = packet_interface_schema(
|
||||
TcpPacketInterface,
|
||||
MAX_PACKET_SIZE,
|
||||
MAX_PACKET_SIZE,
|
||||
# TCP resends what is lost, joins exactly two devices, and its connection state is the session
|
||||
provides=(CONF_ADDRESSING, CONF_RELIABILITY, CONF_SESSION),
|
||||
).extend(
|
||||
{
|
||||
cv.Required(CONF_PORT): cv.port,
|
||||
cv.Optional(
|
||||
CONF_RECONNECT_INTERVAL, default="5s"
|
||||
): cv.positive_time_period_milliseconds,
|
||||
cv.Optional(CONF_KEEP_ALIVE, default="10s"): cv.All(
|
||||
cv.positive_time_period_milliseconds,
|
||||
cv.Range(min=cv.TimePeriod(seconds=1), max=cv.TimePeriod(hours=1)),
|
||||
),
|
||||
# Nothing received for this long closes the connection; it must be longer than the peer's keep_alive
|
||||
cv.Optional(CONF_TIMEOUT): cv.All(
|
||||
cv.positive_time_period_milliseconds,
|
||||
cv.Range(max=cv.TimePeriod(hours=3)),
|
||||
),
|
||||
cv.Optional(CONF_CONNECTED): binary_sensor.binary_sensor_schema(
|
||||
device_class=DEVICE_CLASS_CONNECTIVITY,
|
||||
entity_category=ENTITY_CATEGORY_DIAGNOSTIC,
|
||||
),
|
||||
}
|
||||
)
|
||||
|
||||
CONFIG_SCHEMA = cv.All(
|
||||
cv.typed_schema(
|
||||
{
|
||||
"client": cv.All(
|
||||
BASE_SCHEMA.extend({cv.Required(CONF_HOST): socket.ipv4_host}),
|
||||
_timeout,
|
||||
),
|
||||
"server": cv.All(
|
||||
BASE_SCHEMA.extend(
|
||||
{cv.Optional(CONF_ALLOWED_IPS): socket.IPV4_ALLOW_SCHEMA}
|
||||
),
|
||||
_timeout,
|
||||
),
|
||||
},
|
||||
key=CONF_ROLE,
|
||||
default_type="client",
|
||||
),
|
||||
# A client uses one socket; a server one listener and one accepted socket
|
||||
socket.consume_role_sockets("tcp.packet_interface"),
|
||||
)
|
||||
|
||||
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
rx_buffer = cg.static_buffer(
|
||||
config[CONF_ID], cg.uint8, config[CONF_MAX_PACKET_SIZE]
|
||||
)
|
||||
var = await new_packet_interface(config, rx_buffer)
|
||||
if config[CONF_ROLE] == "server":
|
||||
socket.require_tcp_listener()
|
||||
cg.add(var.set_server(True))
|
||||
socket.add_ipv4_allow(
|
||||
var.set_allow, config.get(CONF_ALLOWED_IPS), config[CONF_ID]
|
||||
)
|
||||
else:
|
||||
socket.require_tcp_client_link()
|
||||
cg.add(var.set_host(config[CONF_HOST]))
|
||||
cg.add(var.set_port(config[CONF_PORT]))
|
||||
cg.add(var.set_reconnect_interval(config[CONF_RECONNECT_INTERVAL]))
|
||||
cg.add(var.set_keep_alive(config[CONF_KEEP_ALIVE]))
|
||||
cg.add(var.set_receive_timeout(config[CONF_TIMEOUT]))
|
||||
binary_sensors = binary_sensor.sub_binary_sensors(config)
|
||||
await binary_sensors(CONF_CONNECTED, var.set_connected_binary_sensor)
|
||||
@@ -1,182 +0,0 @@
|
||||
#include "tcp_packet_interface.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
namespace esphome::tcp {
|
||||
|
||||
using packet_interface::PacketBuffer;
|
||||
using packet_interface::PacketMetaData;
|
||||
|
||||
ESPHOME_LOG_TAG(TAG, "tcp.packet_interface");
|
||||
|
||||
// The packet length before each packet
|
||||
static constexpr size_t LENGTH_SIZE = 2;
|
||||
// A peer that sends without a pause must not hold the main loop here; a frame being read carries over to the next pass
|
||||
static constexpr uint8_t MAX_FRAMES_PER_LOOP = 8;
|
||||
|
||||
TcpPacketInterface::TcpPacketInterface(std::span<uint8_t> rx_buffer)
|
||||
: packet_interface::PacketInterface(rx_buffer.size()), rx_buffer_(rx_buffer) {
|
||||
this->capabilities_ = packet_interface::CAPABILITY_RELIABILITY | packet_interface::CAPABILITY_SESSION |
|
||||
packet_interface::CAPABILITY_ADDRESSING;
|
||||
}
|
||||
|
||||
void TcpPacketInterface::setup() {
|
||||
this->link_.begin(TAG);
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
this->listener_.begin(TAG);
|
||||
#endif
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
if (this->connected_binary_sensor_ != nullptr)
|
||||
this->connected_binary_sensor_->publish_initial_state(false);
|
||||
#endif
|
||||
}
|
||||
|
||||
void TcpPacketInterface::dump_config() {
|
||||
bool server = false;
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
server = this->server_;
|
||||
#endif
|
||||
ESP_LOGCONFIG(TAG,
|
||||
"TCP Packet Interface '%s':\n"
|
||||
" Role: %s\n"
|
||||
" Address: %s:%u\n"
|
||||
" Reconnect Interval: %" PRIu32 "ms\n"
|
||||
" Keep Alive: %" PRIu32 "ms\n"
|
||||
" Timeout: %" PRIu32 "ms\n"
|
||||
" Max Packet Size: %zu",
|
||||
this->name_, server ? LOG_STR_LITERAL("server") : LOG_STR_LITERAL("client"),
|
||||
server ? LOG_STR_LITERAL("*") : this->link_.host(), this->link_.port(),
|
||||
this->link_.reconnect_interval(), this->keep_alive_ms_, this->timeout_ms_, this->max_packet_size_);
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
this->listener_.dump_config();
|
||||
#endif
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
LOG_BINARY_SENSOR(" ", "Connected", this->connected_binary_sensor_);
|
||||
#endif
|
||||
}
|
||||
|
||||
void TcpPacketInterface::on_shutdown() {
|
||||
this->link_.close();
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
this->listener_.close();
|
||||
#endif
|
||||
}
|
||||
|
||||
void TcpPacketInterface::loop() {
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
if (this->server_) {
|
||||
// A new client is accepted only once the drop of the last has been reported
|
||||
this->listener_.poll(this->link_, !this->connected_);
|
||||
} else {
|
||||
this->link_.poll();
|
||||
}
|
||||
#else
|
||||
this->link_.poll();
|
||||
#endif
|
||||
if (this->link_.connected() != this->connected_)
|
||||
this->on_connection_(this->link_.connected());
|
||||
if (!this->connected_)
|
||||
return;
|
||||
this->read_();
|
||||
if (!this->connected_)
|
||||
return;
|
||||
uint32_t now = App.get_loop_component_start_time();
|
||||
if (now - this->last_rx_ms_ > this->timeout_ms_) {
|
||||
ESP_LOGW(TAG, "%s: Nothing received for %" PRIu32 "ms, closing the connection", this->name_, this->timeout_ms_);
|
||||
this->link_.close();
|
||||
this->link_.note_attempt();
|
||||
this->on_connection_(false);
|
||||
return;
|
||||
}
|
||||
if (now - this->last_tx_ms_ >= this->keep_alive_ms_)
|
||||
this->queue_frame_(nullptr, 0);
|
||||
this->flush_();
|
||||
}
|
||||
|
||||
void TcpPacketInterface::flush_() { this->tx_waiting_ = !this->link_.flush_tx(); }
|
||||
|
||||
size_t TcpPacketInterface::get_send_capacity() const {
|
||||
if (!this->tx_waiting_)
|
||||
return SIZE_MAX;
|
||||
return this->link_.tx_free() / (this->max_packet_size_ + LENGTH_SIZE);
|
||||
}
|
||||
|
||||
void TcpPacketInterface::on_connection_(bool connected) {
|
||||
ESP_LOGD(TAG, "%s: Connection %s", this->name_, connected ? LOG_STR_LITERAL("up") : LOG_STR_LITERAL("down"));
|
||||
this->connected_ = connected;
|
||||
this->tx_waiting_ = false;
|
||||
this->rx_have_ = 0;
|
||||
this->last_rx_ms_ = this->last_tx_ms_ = App.get_loop_component_start_time();
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
if (this->connected_binary_sensor_ != nullptr)
|
||||
this->connected_binary_sensor_->publish_state(connected);
|
||||
#endif
|
||||
this->session_callback_.call(connected);
|
||||
}
|
||||
|
||||
void TcpPacketInterface::read_() {
|
||||
for (uint8_t frames = 0; frames != MAX_FRAMES_PER_LOOP;) {
|
||||
ssize_t count;
|
||||
if (this->rx_have_ < LENGTH_SIZE) {
|
||||
count = this->link_.read(this->rx_header_ + this->rx_have_, LENGTH_SIZE - this->rx_have_);
|
||||
} else {
|
||||
count = this->link_.read(this->rx_buffer_.data() + this->rx_have_ - LENGTH_SIZE,
|
||||
this->rx_length_ + LENGTH_SIZE - this->rx_have_);
|
||||
}
|
||||
// Nothing more for now; a dropped link is seen on the next loop
|
||||
if (count <= 0)
|
||||
return;
|
||||
this->last_rx_ms_ = App.get_loop_component_start_time();
|
||||
this->rx_have_ += count;
|
||||
if (this->rx_have_ < LENGTH_SIZE)
|
||||
continue;
|
||||
if (this->rx_have_ == LENGTH_SIZE) {
|
||||
this->rx_length_ = encode_uint16(this->rx_header_[1], this->rx_header_[0]);
|
||||
if (this->rx_length_ > this->max_packet_size_) {
|
||||
// The stream cannot be resynchronised, so start a new connection
|
||||
ESP_LOGW(TAG, "%s: Packet of %u bytes is larger than %zu, closing the connection", this->name_,
|
||||
this->rx_length_, this->max_packet_size_);
|
||||
this->link_.close();
|
||||
this->link_.note_attempt();
|
||||
this->on_connection_(false);
|
||||
return;
|
||||
}
|
||||
}
|
||||
if (this->rx_have_ == this->rx_length_ + LENGTH_SIZE) {
|
||||
this->rx_have_ = 0;
|
||||
frames++;
|
||||
// A zero length packet is a keep-alive
|
||||
if (this->rx_length_ != 0)
|
||||
this->on_receive_from_interface_(PacketBuffer(this->rx_buffer_.data(), this->rx_length_), {});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
bool TcpPacketInterface::queue_frame_(const PacketBuffer *data, size_t size) {
|
||||
if (this->link_.tx_free() < size + LENGTH_SIZE)
|
||||
return false;
|
||||
uint8_t *tail = this->link_.tx_tail();
|
||||
tail[0] = static_cast<uint8_t>(size);
|
||||
tail[1] = static_cast<uint8_t>(size >> 8);
|
||||
if (data != nullptr)
|
||||
data->copy_to(tail + LENGTH_SIZE, size);
|
||||
this->link_.tx_commit(size + LENGTH_SIZE);
|
||||
this->last_tx_ms_ = App.get_loop_component_start_time();
|
||||
return true;
|
||||
}
|
||||
|
||||
bool TcpPacketInterface::send_to_interface(const PacketBuffer &data, const PacketMetaData &meta_data) {
|
||||
size_t size = data.size();
|
||||
if (size > this->max_packet_size_) {
|
||||
ESP_LOGW(TAG, "%s: Packet of %zu bytes is larger than %zu", this->name_, size, this->max_packet_size_);
|
||||
return false;
|
||||
}
|
||||
if (!this->connected_ || !this->queue_frame_(&data, size))
|
||||
return false;
|
||||
// A write that fails closes the link and discards what was queued, this packet included
|
||||
this->flush_();
|
||||
return this->link_.connected();
|
||||
}
|
||||
|
||||
} // namespace esphome::tcp
|
||||
@@ -1,93 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <cstdint>
|
||||
#include <span>
|
||||
|
||||
#include "esphome/components/packet_interface/packet_interface.h"
|
||||
#include "esphome/components/socket/tcp_client_link.h"
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
#include "esphome/components/socket/tcp_listener.h"
|
||||
#endif
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
#include "esphome/components/binary_sensor/binary_sensor.h"
|
||||
#endif
|
||||
|
||||
namespace esphome::tcp {
|
||||
|
||||
/**
|
||||
* A packet interface link over one TCP connection, as a client that connects to a host, or a server that accepts
|
||||
* one client at a time.
|
||||
*
|
||||
* Each packet is sent as a 2 byte length, little endian, then the packet. TCP delivers the stream in order and
|
||||
* resends what is lost, and the connection joins exactly two devices, so the link provides the reliability,
|
||||
* addressing and session capabilities itself. Its connection state is the session state.
|
||||
*
|
||||
* Each packet is written to the socket as it is sent, so the link takes packets as fast as the socket does and keeps
|
||||
* the default, unlimited, send capacity; a packet is refused only while the connection is down or the socket is full.
|
||||
*
|
||||
* A zero length packet is a keep-alive, sent when nothing else has been sent for keep_alive. TCP can take minutes to
|
||||
* notice a peer that has gone without closing the connection, so the link closes it, and reconnects or accepts again,
|
||||
* when nothing has been received for the timeout, which must be longer than the peer's keep-alive interval.
|
||||
*/
|
||||
class TcpPacketInterface : public packet_interface::PacketInterface {
|
||||
public:
|
||||
/// @param rx_buffer Holds the packet being received; its size is the largest packet, and it must outlive the link
|
||||
explicit TcpPacketInterface(std::span<uint8_t> rx_buffer);
|
||||
|
||||
void setup() override;
|
||||
void loop() override;
|
||||
void dump_config() override;
|
||||
void on_shutdown() override;
|
||||
bool send_to_interface(const packet_interface::PacketBuffer &data,
|
||||
const packet_interface::PacketMetaData &meta_data) override;
|
||||
/**
|
||||
* Unlimited while the socket takes what is sent. Once frames wait for it, how many more full frames fit. A socket
|
||||
* that stalls part way through a fragmented packet still cuts it short.
|
||||
*/
|
||||
size_t get_send_capacity() const override;
|
||||
|
||||
void set_host(const char *host) { this->link_.set_host(host); }
|
||||
void set_port(uint16_t port) { this->link_.set_port(port); }
|
||||
void set_reconnect_interval(uint32_t interval_ms) { this->link_.set_reconnect_interval(interval_ms); }
|
||||
void set_keep_alive(uint32_t keep_alive_ms) { this->keep_alive_ms_ = keep_alive_ms; }
|
||||
/// The connection is closed when nothing has been received for this long; the peer's keep_alive sets the pace.
|
||||
void set_receive_timeout(uint32_t timeout_ms) { this->timeout_ms_ = timeout_ms; }
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
void set_server(bool server) { this->server_ = server; }
|
||||
#ifdef USE_SOCKET_IPV4_ALLOW
|
||||
void set_allow(const socket::Ipv4AllowEntry *entries, size_t count) { this->listener_.set_allow(entries, count); }
|
||||
#endif
|
||||
#endif
|
||||
#ifdef USE_BINARY_SENSOR
|
||||
SUB_BINARY_SENSOR(connected)
|
||||
#endif
|
||||
|
||||
bool is_connected() const { return this->connected_; }
|
||||
|
||||
protected:
|
||||
void on_connection_(bool connected);
|
||||
void read_();
|
||||
bool queue_frame_(const packet_interface::PacketBuffer *data, size_t size);
|
||||
void flush_();
|
||||
|
||||
socket::TcpClientLink link_;
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
socket::TcpListener listener_;
|
||||
#endif
|
||||
const std::span<uint8_t> rx_buffer_;
|
||||
uint32_t keep_alive_ms_{10000};
|
||||
uint32_t timeout_ms_{30000};
|
||||
uint32_t last_rx_ms_{0};
|
||||
uint32_t last_tx_ms_{0};
|
||||
uint16_t rx_length_{0};
|
||||
// Bytes of the current frame received so far, counting the 2 byte length
|
||||
uint16_t rx_have_{0};
|
||||
uint8_t rx_header_[2]{};
|
||||
bool connected_ : 1 {false};
|
||||
bool tx_waiting_ : 1 {false}; // frames are queued that the socket has not taken yet
|
||||
#ifdef USE_SOCKET_TCP_LISTENER
|
||||
bool server_ : 1 {false};
|
||||
#endif
|
||||
};
|
||||
|
||||
} // namespace esphome::tcp
|
||||
@@ -1,7 +1,6 @@
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "uart_transport.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::uart {
|
||||
|
||||
@@ -24,7 +23,7 @@ void UARTTransport::loop() {
|
||||
if (this->rx_started_ && this->receive_buffer_.size() > 6) {
|
||||
auto len = this->receive_buffer_.size();
|
||||
auto crc = crc16(this->receive_buffer_.data(), len - 2);
|
||||
if (crc != encode_value_le<uint16_t>(this->receive_buffer_.data() + len - 2)) {
|
||||
if (crc != (this->receive_buffer_[len - 2] | (this->receive_buffer_[len - 1] << 8))) {
|
||||
ESP_LOGD(TAG, "CRC mismatch, discarding packet");
|
||||
this->rx_started_ = false;
|
||||
this->receive_buffer_.clear();
|
||||
|
||||
@@ -45,9 +45,9 @@ void VBus::loop() {
|
||||
this->buffer_.push_back(c);
|
||||
if (this->buffer_.size() == 7) {
|
||||
this->protocol_ = this->buffer_[4];
|
||||
this->source_ = encode_value_le<uint16_t>(this->buffer_.data() + 2);
|
||||
this->dest_ = encode_value_le<uint16_t>(this->buffer_.data());
|
||||
this->command_ = encode_value_le<uint16_t>(this->buffer_.data() + 5);
|
||||
this->source_ = (this->buffer_[3] << 8) + this->buffer_[2];
|
||||
this->dest_ = (this->buffer_[1] << 8) + this->buffer_[0];
|
||||
this->command_ = (this->buffer_[6] << 8) + this->buffer_[5];
|
||||
}
|
||||
if ((this->protocol_ == 0x20) && (this->buffer_.size() == 15)) {
|
||||
this->state_ = 0;
|
||||
@@ -56,7 +56,7 @@ void VBus::loop() {
|
||||
return;
|
||||
}
|
||||
septet_spread(this->buffer_.data(), 7, 6, this->buffer_[13]);
|
||||
uint16_t id = encode_value_le<uint16_t>(this->buffer_.data() + 7);
|
||||
uint16_t id = (this->buffer_[8] << 8) + this->buffer_[7];
|
||||
uint32_t value = encode_uint32(this->buffer_[12], this->buffer_[11], this->buffer_[10], this->buffer_[9]);
|
||||
ESP_LOGV(TAG, "P1 C%04x %04x->%04x: %04x %04" PRIx32 " (%" PRIu32 ")", this->command_, this->source_,
|
||||
this->dest_, id, value, value);
|
||||
|
||||
@@ -220,34 +220,6 @@ EntityMatchResult UrlMatch::match_entity(EntityBase *entity) const {
|
||||
}
|
||||
|
||||
#if !defined(USE_ESP32) && defined(USE_ARDUINO)
|
||||
// BEGIN ESPAsyncWebServer 3.12.1 workaround: remove once a release containing upstream commit
|
||||
// 880c97068abb0f0e63f803cd3c0cac84fa5cd7bb is out and we bump to it.
|
||||
// 3.12.1 creates the SSE client before the head is ACKed and credits the head's ACK to its first queued messages,
|
||||
// dropping or truncating them. Create the client once the head is ACKed instead, as 3.9.6 did.
|
||||
class HeadAckedEventSourceResponse final : public AsyncEventSourceResponse {
|
||||
public:
|
||||
HeadAckedEventSourceResponse(DeferredUpdateEventSourceList *list, WebServer *ws)
|
||||
: AsyncEventSourceResponse(nullptr), list_(list), ws_(ws) {}
|
||||
void _respond(AsyncWebServerRequest *request) override {
|
||||
String head;
|
||||
this->_assembleHead(head, request->version());
|
||||
request->client()->write(head.c_str(), this->_headLength);
|
||||
}
|
||||
// Every ACK until clientRelease() is the head's, and clientRelease() unhooks this. _state must stay
|
||||
// RESPONSE_SETUP: past RESPONSE_WAIT_ACK the request would close its released (null) client after this returns.
|
||||
size_t _ack(AsyncWebServerRequest *request, size_t len, uint32_t time) override {
|
||||
this->_ackedLength += len;
|
||||
if (this->_ackedLength >= this->_headLength)
|
||||
this->list_->add_client_(this->ws_, request->clientRelease());
|
||||
return 0;
|
||||
}
|
||||
|
||||
private:
|
||||
DeferredUpdateEventSourceList *list_;
|
||||
WebServer *ws_;
|
||||
};
|
||||
// END ESPAsyncWebServer 3.12.1 workaround
|
||||
|
||||
// helper for allowing only unique entries in the queue
|
||||
void __attribute__((flatten)) DeferredUpdateEventSource::deq_push_back_with_dedup_(
|
||||
void *source, message_generator_t *message_generator) {
|
||||
@@ -356,13 +328,7 @@ void DeferredUpdateEventSourceList::try_send_nodefer(const char *message, size_t
|
||||
}
|
||||
}
|
||||
|
||||
// BEGIN ESPAsyncWebServer 3.12.1 workaround (see HeadAckedEventSourceResponse): once removed, add_new_client creates
|
||||
// the source as add_client_ does and ends with es->handleRequest(request); add_client_ goes away.
|
||||
void DeferredUpdateEventSourceList::add_new_client(WebServer *ws, AsyncWebServerRequest *request) {
|
||||
request->send(new HeadAckedEventSourceResponse(this, ws)); // NOLINT
|
||||
}
|
||||
|
||||
void DeferredUpdateEventSourceList::add_client_(WebServer *ws, AsyncClient *client) {
|
||||
DeferredUpdateEventSource *es = new DeferredUpdateEventSource(ws, ESPHOME_F("/events"));
|
||||
this->push_back(es);
|
||||
|
||||
@@ -370,10 +336,9 @@ void DeferredUpdateEventSourceList::add_client_(WebServer *ws, AsyncClient *clie
|
||||
|
||||
es->onDisconnect([this, es](AsyncEventSourceClient *client) { this->on_client_disconnect_(es); });
|
||||
|
||||
new AsyncEventSourceClient(client, es); // NOLINT: owned by es
|
||||
es->handleRequest(request);
|
||||
ws->enable_loop_soon_any_context();
|
||||
}
|
||||
// END ESPAsyncWebServer 3.12.1 workaround
|
||||
|
||||
void DeferredUpdateEventSourceList::on_client_connect_(DeferredUpdateEventSource *source) {
|
||||
WebServer *ws = source->web_server_;
|
||||
|
||||
@@ -171,12 +171,9 @@ class DeferredUpdateEventSource final : public AsyncEventSource {
|
||||
};
|
||||
|
||||
class DeferredUpdateEventSourceList final : public std::list<DeferredUpdateEventSource *> {
|
||||
friend class HeadAckedEventSourceResponse; // ESPAsyncWebServer 3.12.1 workaround, remove with it
|
||||
|
||||
protected:
|
||||
void on_client_connect_(DeferredUpdateEventSource *source);
|
||||
void on_client_disconnect_(DeferredUpdateEventSource *source);
|
||||
void add_client_(WebServer *ws, AsyncClient *client); // ESPAsyncWebServer 3.12.1 workaround, remove with it
|
||||
|
||||
public:
|
||||
/// Returns true if there are event sources remaining (including pending cleanup).
|
||||
|
||||
@@ -132,7 +132,7 @@ async def to_code(config: ConfigType) -> None:
|
||||
)
|
||||
cg.add_platformio_option("extra_scripts", ["pre:fix_rp2040_hash.py"])
|
||||
# https://github.com/ESP32Async/ESPAsyncWebServer/blob/main/library.json
|
||||
cg.add_library("ESP32Async/ESPAsyncWebServer", "3.12.1")
|
||||
cg.add_library("ESP32Async/ESPAsyncWebServer", "3.9.6")
|
||||
|
||||
|
||||
# The DNS server used for captive portals on ESP32; other platforms use the Arduino
|
||||
|
||||
@@ -32,9 +32,12 @@ bool random_bytes(uint8_t *data, size_t len) {
|
||||
|
||||
#ifdef USE_NRF52
|
||||
void get_mac_address_raw(uint8_t *mac) { // NOLINT(readability-non-const-parameter)
|
||||
// The top two bits of a random static address are set
|
||||
put_be16(mac, NRF_FICR->DEVICEADDR[1] | 0xC000);
|
||||
put_be32(mac + 2, NRF_FICR->DEVICEADDR[0]);
|
||||
mac[0] = ((NRF_FICR->DEVICEADDR[1] & 0xFFFF) >> 8) | 0xC0;
|
||||
mac[1] = NRF_FICR->DEVICEADDR[1] & 0xFFFF;
|
||||
mac[2] = NRF_FICR->DEVICEADDR[0] >> 24;
|
||||
mac[3] = NRF_FICR->DEVICEADDR[0] >> 16;
|
||||
mac[4] = NRF_FICR->DEVICEADDR[0] >> 8;
|
||||
mac[5] = NRF_FICR->DEVICEADDR[0];
|
||||
}
|
||||
#endif
|
||||
} // namespace esphome
|
||||
|
||||
@@ -320,8 +320,6 @@
|
||||
#define USE_NEXTION_TRIGGER_CUSTOM_SWITCH
|
||||
#define USE_NEXTION_TRIGGER_CUSTOM_TEXT_SENSOR
|
||||
#define USE_NEXTION_WAVEFORM
|
||||
#define USE_NPM1300_DATA_PUBLISHER
|
||||
#define USE_NPM1300_STATUS_PUBLISHER
|
||||
#define USE_NUMBER
|
||||
#define USE_OTA_STATE_LISTENER
|
||||
#define USE_OUTPUT
|
||||
|
||||
@@ -18,6 +18,7 @@ from pathlib import Path
|
||||
import re
|
||||
from typing import Any, NamedTuple
|
||||
from urllib.parse import urlparse
|
||||
from urllib.request import url2pathname
|
||||
|
||||
from esphome import loader, yaml_util
|
||||
from esphome.components.external_components import ExternalSource, get_sources
|
||||
@@ -200,8 +201,6 @@ def _esphome_vcs() -> _Source | None:
|
||||
if commit:
|
||||
return _Source(strip_url_credentials(url), commit)
|
||||
if "dir_info" in info and url.startswith("file:"):
|
||||
from urllib.request import url2pathname
|
||||
|
||||
# An editable or local install may be a fork or a patched clone
|
||||
if (
|
||||
source := _checkout_vcs(Path(url2pathname(urlparse(url).path)))
|
||||
|
||||
@@ -17,6 +17,7 @@ import threading
|
||||
import time
|
||||
from typing import IO, TYPE_CHECKING
|
||||
from urllib.parse import urlparse
|
||||
from urllib.request import url2pathname
|
||||
|
||||
from esphome.helpers import ProgressBar, get_usable_cpu_count, rmtree
|
||||
from esphome.net_retry import (
|
||||
@@ -1362,9 +1363,6 @@ def local_path_from_url(url: str) -> Path:
|
||||
Handles ``file:///home/me/x`` and ``file:///C:/x`` (no host), ``file://localhost/x``
|
||||
and ``file://server/share/x`` (a UNC path).
|
||||
"""
|
||||
# urllib.request loads http.client and the email parser, which config validation does not need
|
||||
from urllib.request import url2pathname
|
||||
|
||||
from esphome.core import EsphomeError
|
||||
|
||||
try:
|
||||
|
||||
@@ -26,6 +26,7 @@ from pathlib import Path, PurePosixPath
|
||||
import re
|
||||
from typing import Any
|
||||
from urllib.parse import urlsplit, urlunsplit
|
||||
from urllib.request import url2pathname
|
||||
|
||||
from esphome import git
|
||||
from esphome.core import CORE, EsphomeError, Library
|
||||
@@ -960,8 +961,6 @@ def _node_key(
|
||||
f"{scheme}:// library URL '{repository}' must be an absolute "
|
||||
f"directory path, e.g. {scheme}:///path/to/lib"
|
||||
)
|
||||
from urllib.request import url2pathname
|
||||
|
||||
path = url2pathname(url_path)
|
||||
return (name or PurePosixPath(url_path).name), "local", (path, None)
|
||||
key = str(split_result.path).strip("/").removesuffix(".git")
|
||||
|
||||
+4
-4
@@ -125,7 +125,7 @@ lib_deps =
|
||||
ESP8266WiFi ; wifi (Arduino built-in)
|
||||
Update ; ota (Arduino built-in)
|
||||
ESP32Async/ESPAsyncTCP@2.0.0 ; async_tcp
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.9.6 ; web_server_base
|
||||
makuna/NeoPixelBus@2.7.3 ; neopixelbus
|
||||
ESP8266HTTPClient ; http_request (Arduino built-in)
|
||||
ESP8266mDNS ; mdns (Arduino built-in)
|
||||
@@ -217,7 +217,7 @@ lib_deps =
|
||||
${common:arduino.lib_deps}
|
||||
${common:idf-component-libs.lib_deps}
|
||||
https://github.com/esphome-libs/RPAsyncTCP.git#1.3.2-esphome.1 ; async_tcp
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.9.6 ; web_server_base
|
||||
WiFi ; wifi (arduino-pico built-in)
|
||||
lwIP_CYW43 ; wifi (arduino-pico built-in, WiFi dependency)
|
||||
HTTPClient ; http_request (arduino-pico built-in)
|
||||
@@ -245,10 +245,10 @@ lib_compat_mode = soft
|
||||
lib_deps =
|
||||
${common.lib_deps_base}
|
||||
${common:idf-component-libs.lib_deps}
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.9.6 ; web_server_base
|
||||
esphome/wireguard@0.4.8 ; wireguard
|
||||
esphome/noise-c@0.1.31 ; noise (api, ota)
|
||||
ESP32Async/AsyncTCP@3.5.0 ; async_tcp
|
||||
ESP32Async/AsyncTCP@3.4.5 ; async_tcp
|
||||
DNSServer ; captive_portal
|
||||
heman/AsyncMqttClient-esphome@2.0.0 ; mqtt
|
||||
improv/Improv@1.2.7 ; improv_serial
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
from tests.testing_helpers import ComponentManifestOverride, add_defines_to_code
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
manifest.enable_codegen()
|
||||
# The filter benchmarks need filter.cpp, which is only built with this define
|
||||
add_defines_to_code(manifest, "USE_BINARY_SENSOR_FILTER")
|
||||
@@ -0,0 +1,101 @@
|
||||
#include <benchmark/benchmark.h>
|
||||
|
||||
#include "esphome/components/binary_sensor/binary_sensor.h"
|
||||
#include "esphome/components/binary_sensor/filter.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/hal.h"
|
||||
|
||||
namespace esphome::binary_sensor::benchmarks {
|
||||
|
||||
static constexpr int kInnerIterations = 2000;
|
||||
// Long enough that no delay fires during a run, so every publish is a bounce
|
||||
static constexpr uint32_t DELAY_MS = 3600000;
|
||||
|
||||
// Alternate the input with one scheduler pass per publish, like a bouncing GPIO polled each loop
|
||||
static void publish_bounce(benchmark::State &state, BinarySensor &sensor, bool run_scheduler, bool bounce) {
|
||||
sensor.publish_initial_state(false);
|
||||
const uint32_t now = millis();
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
sensor.publish_state(bounce && i % 2 == 0);
|
||||
if (run_scheduler)
|
||||
App.scheduler.call(now);
|
||||
}
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
// Resetting the filters cancels their pending timers before the filter leaves scope
|
||||
sensor.invalidate_state();
|
||||
App.scheduler.call(now);
|
||||
}
|
||||
|
||||
// Benchmark: no filter, unchanged input; subtract from the delayed filters that hold their output
|
||||
static void BinarySensorFilter_SchedulerBaseline(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/false);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_SchedulerBaseline);
|
||||
|
||||
// Benchmark: invert, no scheduler pass since it schedules nothing, so not comparable to the five below
|
||||
static void BinarySensorFilter_Invert(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
InvertFilter filter;
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/false, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_Invert);
|
||||
|
||||
// Benchmark: delayed_on bounce, set_timeout on press and cancel on release
|
||||
static void BinarySensorFilter_DelayedOn(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
DelayedOnFilter filter;
|
||||
filter.set_delay([]() -> uint32_t { return DELAY_MS; });
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_DelayedOn);
|
||||
|
||||
// Benchmark: delayed_off bounce, cancel on press and set_timeout on release
|
||||
static void BinarySensorFilter_DelayedOff(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
DelayedOffFilter filter;
|
||||
filter.set_delay([]() -> uint32_t { return DELAY_MS; });
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_DelayedOff);
|
||||
|
||||
// Same shape as the function codegen emits for delayed_on_off with time_on and time_off
|
||||
static optional<bool> delayed_on_off_fn(Filter *filter, bool x) {
|
||||
return delay_output(filter, x ? DELAY_MS : DELAY_MS / 2, x);
|
||||
}
|
||||
|
||||
// Benchmark: delayed_on_off bounce, every edge replaces the pending timeout
|
||||
static void BinarySensorFilter_DelayedOnOff(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
ApplyFilter<delayed_on_off_fn> filter;
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_DelayedOnOff);
|
||||
|
||||
// Benchmark: settle bounce, every edge re-arms the timeout
|
||||
static void BinarySensorFilter_Settle(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
SettleFilter filter;
|
||||
filter.set_delay([]() -> uint32_t { return DELAY_MS; });
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_Settle);
|
||||
|
||||
// Benchmark: autorepeat, passes every press and release, so it also pays a state change per publish
|
||||
static void BinarySensorFilter_Autorepeat(benchmark::State &state) {
|
||||
BinarySensor sensor;
|
||||
AutorepeatFilter<1> filter({{DELAY_MS, 100, 900}});
|
||||
sensor.add_filter(&filter);
|
||||
publish_bounce(state, sensor, /*run_scheduler=*/true, /*bounce=*/true);
|
||||
}
|
||||
BENCHMARK(BinarySensorFilter_Autorepeat);
|
||||
|
||||
} // namespace esphome::binary_sensor::benchmarks
|
||||
@@ -2,10 +2,57 @@
|
||||
|
||||
#include "esphome/components/sensor/sensor.h"
|
||||
#include "esphome/components/sensor/filter.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/hal.h"
|
||||
|
||||
#include <iterator>
|
||||
#include <limits>
|
||||
|
||||
namespace esphome::sensor::benchmarks {
|
||||
|
||||
static constexpr int kInnerIterations = 2000;
|
||||
// Long enough that interval filters never fire during a run
|
||||
static constexpr uint32_t NEVER_FIRE_MS = 3600000;
|
||||
|
||||
static constexpr float NO_MAX_DELTA = std::numeric_limits<float>::infinity();
|
||||
static constexpr uint32_t LOOP_TICK_MS = 16;
|
||||
|
||||
static inline void advance_ramp(float &value) {
|
||||
value += 0.1f;
|
||||
if (value > 1000.0f)
|
||||
value = 0.0f;
|
||||
}
|
||||
|
||||
// Publish a 0..1000 ramp in 0.1 steps
|
||||
static void publish_ramp(benchmark::State &state, Sensor &sensor) {
|
||||
float value = 0.0f;
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
sensor.publish_state(value);
|
||||
advance_ramp(value);
|
||||
}
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
}
|
||||
|
||||
// Publish the ramp one loop tick apart from t=1, then restore the cached loop time for later benchmarks
|
||||
static void publish_ramp_ticked(benchmark::State &state, Sensor &sensor) {
|
||||
const uint32_t saved = App.get_loop_component_start_time();
|
||||
uint32_t now = 1;
|
||||
float value = 0.0f;
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
LoopBlockingGuard tick{nullptr, nullptr, now};
|
||||
sensor.publish_state(value);
|
||||
now += LOOP_TICK_MS;
|
||||
advance_ramp(value);
|
||||
}
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
LoopBlockingGuard restore{nullptr, nullptr, saved};
|
||||
}
|
||||
|
||||
// Benchmark: sensor publish through a SlidingWindowMovingAverageFilter (window=5, send_every=1)
|
||||
static void SensorFilter_SlidingWindowAvg(benchmark::State &state) {
|
||||
@@ -15,17 +62,7 @@ static void SensorFilter_SlidingWindowAvg(benchmark::State &state) {
|
||||
auto *filter = new SlidingWindowMovingAverageFilter(5, 1, 1);
|
||||
sensor.add_filter(filter);
|
||||
|
||||
float value = 0.0f;
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
sensor.publish_state(value);
|
||||
value += 0.1f;
|
||||
if (value > 1000.0f)
|
||||
value = 0.0f;
|
||||
}
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_SlidingWindowAvg);
|
||||
|
||||
@@ -37,17 +74,7 @@ static void SensorFilter_ExponentialMovingAvg(benchmark::State &state) {
|
||||
auto *filter = new ExponentialMovingAverageFilter(0.1f, 1, 1);
|
||||
sensor.add_filter(filter);
|
||||
|
||||
float value = 0.0f;
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
sensor.publish_state(value);
|
||||
value += 0.1f;
|
||||
if (value > 1000.0f)
|
||||
value = 0.0f;
|
||||
}
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_ExponentialMovingAvg);
|
||||
|
||||
@@ -61,18 +88,97 @@ static void SensorFilter_Chain3(benchmark::State &state) {
|
||||
new SlidingWindowMovingAverageFilter(5, 1, 1),
|
||||
});
|
||||
|
||||
float value = 0.0f;
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Chain3);
|
||||
|
||||
// Benchmark: throttle 1s, one publish per 16ms loop tick (1 in 63 passes)
|
||||
static void SensorFilter_Throttle(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new ThrottleFilter(1000));
|
||||
publish_ramp_ticked(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Throttle);
|
||||
|
||||
// Benchmark: delta 0.5 on a 0.1 ramp (1 in 5 passes)
|
||||
static void SensorFilter_Delta(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new DeltaFilter(0.5f, 0.0f, NO_MAX_DELTA, 0.0f));
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Delta);
|
||||
|
||||
// Fixed zig-zag so the median window is rarely already sorted
|
||||
static constexpr float MEDIAN_INPUT[] = {3.0f, 9.0f, 1.0f, 7.0f, 4.0f, 8.0f, 2.0f, 6.0f,
|
||||
5.0f, 0.0f, 9.5f, 1.5f, 7.5f, 3.5f, 8.5f, 2.5f};
|
||||
|
||||
// Benchmark: median of 5, computed on every publish
|
||||
static void SensorFilter_Median(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new MedianFilter(5, 1, 1));
|
||||
for (auto _ : state) {
|
||||
for (int i = 0; i < kInnerIterations; i++) {
|
||||
sensor.publish_state(value);
|
||||
value += 0.1f;
|
||||
if (value > 1000.0f)
|
||||
value = 0.0f;
|
||||
}
|
||||
for (int i = 0; i < kInnerIterations; i++)
|
||||
sensor.publish_state(MEDIAN_INPUT[i % std::size(MEDIAN_INPUT)]);
|
||||
benchmark::DoNotOptimize(sensor.state);
|
||||
}
|
||||
state.SetItemsProcessed(state.iterations() * kInnerIterations);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Chain3);
|
||||
BENCHMARK(SensorFilter_Median);
|
||||
|
||||
// Cancel the interval so it never fires into the sensor after it leaves scope
|
||||
static void publish_ramp_then_cancel(benchmark::State &state, Sensor &sensor, Filter *filter) {
|
||||
publish_ramp(state, sensor);
|
||||
App.scheduler.cancel_interval(filter);
|
||||
App.scheduler.call(millis());
|
||||
}
|
||||
|
||||
// Benchmark: throttle_average accumulate path (interval never fires)
|
||||
static void SensorFilter_ThrottleAverage(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
auto *filter = new ThrottleAverageFilter(NEVER_FIRE_MS);
|
||||
sensor.add_filter(filter);
|
||||
publish_ramp_then_cancel(state, sensor, filter);
|
||||
}
|
||||
BENCHMARK(SensorFilter_ThrottleAverage);
|
||||
|
||||
// Benchmark: heartbeat store path (interval never fires)
|
||||
static void SensorFilter_Heartbeat(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
auto *filter = new HeartbeatFilter(NEVER_FIRE_MS);
|
||||
sensor.add_filter(filter);
|
||||
publish_ramp_then_cancel(state, sensor, filter);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Heartbeat);
|
||||
|
||||
// Same shape as the function codegen emits for a lambda filter
|
||||
static optional<float> lambda_filter_fn(float x) {
|
||||
if (x < 0.0f)
|
||||
return {};
|
||||
return x * 1.8f + 32.0f;
|
||||
}
|
||||
|
||||
// Benchmark: lambda filter as generated (ApplyFilter)
|
||||
static void SensorFilter_Lambda(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new ApplyFilter<lambda_filter_fn>());
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Lambda);
|
||||
|
||||
// Benchmark: round to 1 decimal
|
||||
static void SensorFilter_Round(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new RoundFilter(1));
|
||||
publish_ramp(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Round);
|
||||
|
||||
// Benchmark: throttle 60s or delta 0.5 ("on change or every minute"), one publish per tick
|
||||
static void SensorFilter_Or(benchmark::State &state) {
|
||||
Sensor sensor;
|
||||
sensor.add_filter(new OrFilter<2>(new ThrottleFilter(60000), new DeltaFilter(0.5f, 0.0f, NO_MAX_DELTA, 0.0f)));
|
||||
publish_ramp_ticked(state, sensor);
|
||||
}
|
||||
BENCHMARK(SensorFilter_Or);
|
||||
|
||||
} // namespace esphome::sensor::benchmarks
|
||||
Whitespace-only changes.
@@ -1,20 +0,0 @@
|
||||
"""LibreTiny always gets the xPortGetCoreID stand-in, whatever its log level."""
|
||||
|
||||
from collections.abc import Callable
|
||||
from pathlib import Path
|
||||
|
||||
from esphome.core import CORE
|
||||
|
||||
|
||||
def test_libretiny_adds_core_id_flag(
|
||||
generate_main: Callable[[str | Path], str], tmp_path: Path
|
||||
) -> None:
|
||||
config = tmp_path / "test.yaml"
|
||||
config.write_text(
|
||||
"esphome:\n name: test\n\n"
|
||||
"bk72xx:\n board: generic-bk7231n-qfn32-tuya\n\n"
|
||||
"wifi:\n ssid: test\n password: testtest12\n\n"
|
||||
"async_tcp:\n"
|
||||
)
|
||||
generate_main(config)
|
||||
assert "-DxPortGetCoreID=int" in CORE.build_flags
|
||||
Whitespace-only changes.
@@ -1,114 +0,0 @@
|
||||
"""Tests for the npm1300 register encoders and validators."""
|
||||
|
||||
import pytest
|
||||
|
||||
from esphome import config_validation as cv
|
||||
from esphome.components.const import CONF_ENABLED
|
||||
from esphome.components.npm1300 import (
|
||||
CHARGER_SCHEMA,
|
||||
NPM1300_UNSET,
|
||||
OUTPUT_VOLTAGE,
|
||||
VBUS_CURRENT_LIMIT,
|
||||
_charger_config,
|
||||
_output_config,
|
||||
_termination_voltage_code,
|
||||
_vbus_current_limit_code,
|
||||
)
|
||||
from esphome.const import CONF_MODE, CONF_VOLTAGE
|
||||
from esphome.cpp_generator import StructInitializer
|
||||
from esphome.types import ConfigType
|
||||
|
||||
|
||||
def _fields(init: StructInitializer) -> dict[str, str]:
|
||||
return {key: str(value) for key, value in init.args.items()}
|
||||
|
||||
|
||||
def _charger(config: ConfigType) -> dict[str, str]:
|
||||
return _fields(_charger_config(CHARGER_SCHEMA(config)))
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("current", "code"), [("32mA", 16), ("150mA", 75), ("800mA", 400)]
|
||||
)
|
||||
def test_charge_current_code(current: str, code: int) -> None:
|
||||
assert _charger({"charge_current": current})["current"] == str(code)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("current", ["30mA", "802mA", "151mA"])
|
||||
def test_charge_current_rejected(current: str) -> None:
|
||||
with pytest.raises(cv.Invalid):
|
||||
CHARGER_SCHEMA({"charge_current": current})
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("voltage", "code"),
|
||||
[(3.5, 0), (3.65, 3), (4.0, 4), (4.2, 8), (4.45, 13)],
|
||||
)
|
||||
def test_termination_voltage_code(voltage: float, code: int) -> None:
|
||||
assert _termination_voltage_code(voltage) == code
|
||||
|
||||
|
||||
@pytest.mark.parametrize("voltage", ["3.7V", "3.95V", "4.5V"])
|
||||
def test_termination_voltage_gap_rejected(voltage: str) -> None:
|
||||
with pytest.raises(cv.Invalid):
|
||||
CHARGER_SCHEMA({"charge_current": "100mA", "termination_voltage": voltage})
|
||||
|
||||
|
||||
def test_warm_termination_defaults_to_termination() -> None:
|
||||
fields = _charger({"charge_current": "100mA", "termination_voltage": "4.1V"})
|
||||
assert fields["termination_voltage"] == "6"
|
||||
assert fields["warm_termination_voltage"] == "6"
|
||||
|
||||
|
||||
def test_warm_termination_code() -> None:
|
||||
fields = _charger(
|
||||
{
|
||||
"charge_current": "100mA",
|
||||
"termination_voltage": "4.2V",
|
||||
"warm_termination_voltage": "3.6V",
|
||||
}
|
||||
)
|
||||
assert fields["termination_voltage"] == "8"
|
||||
assert fields["warm_termination_voltage"] == "2"
|
||||
|
||||
|
||||
@pytest.mark.parametrize(("voltage", "code"), [("1.0V", 0), ("1.8V", 8), ("3.3V", 23)])
|
||||
def test_output_voltage_code(voltage: str, code: int) -> None:
|
||||
config = {CONF_VOLTAGE: OUTPUT_VOLTAGE(voltage)}
|
||||
assert _fields(_output_config(config))["voltage"] == str(code)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("voltage", ["0.9V", "3.4V", "1.85V"])
|
||||
def test_output_voltage_rejected(voltage: str) -> None:
|
||||
with pytest.raises(cv.Invalid):
|
||||
OUTPUT_VOLTAGE(voltage)
|
||||
|
||||
|
||||
@pytest.mark.parametrize("config", [None, {}])
|
||||
def test_unset_output_fields(config: ConfigType | None) -> None:
|
||||
unset = str(NPM1300_UNSET)
|
||||
assert _fields(_output_config(config)) == {
|
||||
"voltage": unset,
|
||||
"ldo_mode": unset,
|
||||
"enabled": unset,
|
||||
}
|
||||
|
||||
|
||||
def test_output_mode_and_enabled() -> None:
|
||||
fields = _fields(_output_config({CONF_MODE: "load_switch", CONF_ENABLED: True}))
|
||||
assert fields["ldo_mode"] == "0"
|
||||
assert fields["enabled"] == "1"
|
||||
assert fields["voltage"] == str(NPM1300_UNSET)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("limit", "code"), [("100mA", 1), ("300mA", 3), ("500mA", 5), ("1.5A", 15)]
|
||||
)
|
||||
def test_vbus_current_limit_code(limit: str, code: int) -> None:
|
||||
assert _vbus_current_limit_code(VBUS_CURRENT_LIMIT(limit)) == code
|
||||
|
||||
|
||||
@pytest.mark.parametrize("limit", ["50mA", "1600mA", "550mA"])
|
||||
def test_vbus_current_limit_rejected(limit: str) -> None:
|
||||
with pytest.raises(cv.Invalid):
|
||||
VBUS_CURRENT_LIMIT(limit)
|
||||
@@ -1,6 +0,0 @@
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
# touchscreen.h includes display.h
|
||||
manifest.dependencies = manifest.dependencies + ["display"]
|
||||
@@ -1,50 +0,0 @@
|
||||
#pragma once
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstring>
|
||||
#include <map>
|
||||
#include <vector>
|
||||
|
||||
#include "esphome/components/cst3240/touchscreen/cst3240_touchscreen.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::cst3240::testing {
|
||||
|
||||
struct Write {
|
||||
uint16_t reg;
|
||||
size_t size;
|
||||
};
|
||||
|
||||
// Answers 16-bit register reads from a map; every write succeeds and is recorded.
|
||||
class RegisterBus final : public i2c::I2CBus {
|
||||
public:
|
||||
std::map<uint16_t, std::vector<uint8_t>> registers;
|
||||
std::vector<Write> writes;
|
||||
|
||||
i2c::ErrorCode write_readv(uint8_t address, const uint8_t *data, size_t size, uint8_t *out,
|
||||
size_t out_size) override {
|
||||
if (size < 2)
|
||||
return i2c::ERROR_NOT_ACKNOWLEDGED;
|
||||
const uint16_t reg = encode_uint16(data[0], data[1]);
|
||||
if (out_size == 0) {
|
||||
this->writes.push_back({reg, size});
|
||||
return i2c::ERROR_OK;
|
||||
}
|
||||
auto &value = this->registers[reg];
|
||||
value.resize(std::max(value.size(), out_size));
|
||||
std::memcpy(out, value.data(), out_size);
|
||||
return i2c::ERROR_OK;
|
||||
}
|
||||
|
||||
// Lists `count` fingers with ids 0..count-1, each with the given event bits.
|
||||
void set_report(uint8_t count, uint8_t sync = cstxxx::SYNC_BYTE, uint8_t event = TOUCH_EVENT_PRESSED) {
|
||||
std::vector<uint8_t> data(CST3240_REPORT_SIZE);
|
||||
for (uint8_t i = 0; i < std::min(count, CST3240_MAX_TOUCHES); i++)
|
||||
data[i * 5 + (i == 0 ? 0 : 2)] = i << 4 | event;
|
||||
data[cstxxx::FINGER_COUNT_IDX] = count;
|
||||
data[cstxxx::SYNC_IDX] = sync;
|
||||
this->registers[cstxxx::REG_TOUCH_DATA] = data;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace esphome::cst3240::testing
|
||||
@@ -1,18 +0,0 @@
|
||||
display:
|
||||
- platform: ssd1306_i2c
|
||||
i2c_id: i2c_bus
|
||||
id: cst3240_ssd1306_i2c_display
|
||||
model: SSD1306_128X64
|
||||
reset_pin: ${display_reset_pin}
|
||||
pages:
|
||||
- id: cst3240_page1
|
||||
lambda: |-
|
||||
it.rectangle(0, 0, it.get_width(), it.get_height());
|
||||
|
||||
touchscreen:
|
||||
- platform: cst3240
|
||||
i2c_id: i2c_bus
|
||||
id: cst3240_touchscreen
|
||||
display: cst3240_ssd1306_i2c_display
|
||||
interrupt_pin: ${interrupt_pin}
|
||||
reset_pin: ${reset_pin}
|
||||
@@ -1,8 +0,0 @@
|
||||
substitutions:
|
||||
display_reset_pin: "4"
|
||||
interrupt_pin: "20"
|
||||
reset_pin: "21"
|
||||
|
||||
packages:
|
||||
i2c: !include ../../test_build_components/common/i2c/esp32-idf.yaml
|
||||
cst3240: !include common.yaml
|
||||
@@ -1,103 +0,0 @@
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include "esphome/components/cst3240/touchscreen/cst3240_touchscreen.h"
|
||||
#include "esphome/core/gpio.h"
|
||||
#include "../common.h"
|
||||
|
||||
namespace esphome::cst3240::testing {
|
||||
|
||||
class TestableCST3240 : public CST3240Touchscreen {
|
||||
public:
|
||||
using CST3240Touchscreen::chip_id_;
|
||||
using CST3240Touchscreen::is_touched_;
|
||||
using CST3240Touchscreen::setup_complete_;
|
||||
using CST3240Touchscreen::skip_update_;
|
||||
using CST3240Touchscreen::update_touches;
|
||||
using CST3240Touchscreen::x_raw_max_;
|
||||
using CST3240Touchscreen::y_raw_max_;
|
||||
};
|
||||
|
||||
class CST3240Test : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
this->bus_.registers[cstxxx::REG_CHIP_INFO] = {0x01, 0x00, 0x40, 0x32};
|
||||
this->bus_.registers[cstxxx::REG_RESOLUTION] = {0x40, 0x01, 0xF0, 0x00};
|
||||
this->hub_.set_i2c_bus(&this->bus_);
|
||||
this->hub_.setup();
|
||||
this->bus_.writes.clear();
|
||||
}
|
||||
|
||||
void update_() {
|
||||
this->hub_.skip_update_ = false;
|
||||
this->hub_.is_touched_ = false;
|
||||
this->hub_.update_touches();
|
||||
}
|
||||
|
||||
bool cleared_() const {
|
||||
return this->bus_.writes.size() == 1 && this->bus_.writes[0].reg == cstxxx::REG_TOUCH_DATA &&
|
||||
this->bus_.writes[0].size == 2u + CST3240_REPORT_SIZE;
|
||||
}
|
||||
|
||||
RegisterBus bus_;
|
||||
TestableCST3240 hub_;
|
||||
};
|
||||
|
||||
TEST_F(CST3240Test, SetupReadsTheChipAndResolutionWithoutAFirmwareCheck) {
|
||||
EXPECT_TRUE(this->hub_.setup_complete_);
|
||||
EXPECT_FALSE(this->hub_.is_failed());
|
||||
EXPECT_EQ(this->hub_.chip_id_, CST3240_CHIP_ID);
|
||||
EXPECT_EQ(this->hub_.x_raw_max_, 320);
|
||||
EXPECT_EQ(this->hub_.y_raw_max_, 240);
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, ReportWithoutTheSyncByteIsSkippedAndCleared) {
|
||||
this->bus_.set_report(1, 0x55);
|
||||
this->update_();
|
||||
EXPECT_TRUE(this->hub_.skip_update_);
|
||||
EXPECT_FALSE(this->hub_.is_touched_);
|
||||
EXPECT_TRUE(this->cleared_());
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, IdleBlockIsNotRewritten) {
|
||||
this->bus_.set_report(0, 0);
|
||||
this->update_();
|
||||
EXPECT_TRUE(this->hub_.skip_update_);
|
||||
EXPECT_TRUE(this->bus_.writes.empty());
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, ReleasedRecordIsNotATouch) {
|
||||
this->bus_.set_report(1, cstxxx::SYNC_BYTE, 0);
|
||||
this->update_();
|
||||
EXPECT_FALSE(this->hub_.skip_update_);
|
||||
EXPECT_FALSE(this->hub_.is_touched_);
|
||||
EXPECT_TRUE(this->hub_.get_touches().empty());
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, PollingClearsTheReport) {
|
||||
this->bus_.set_report(1);
|
||||
this->update_();
|
||||
EXPECT_TRUE(this->hub_.is_touched_);
|
||||
EXPECT_TRUE(this->cleared_());
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, InterruptAcknowledgesTheReport) {
|
||||
InternalGPIOPin pin;
|
||||
this->hub_.set_interrupt_pin(&pin);
|
||||
this->bus_.set_report(1);
|
||||
this->update_();
|
||||
ASSERT_EQ(this->bus_.writes.size(), 2u);
|
||||
EXPECT_EQ(this->bus_.writes[0].reg, cstxxx::REG_FINGER_COUNT);
|
||||
EXPECT_EQ(this->bus_.writes[1].reg, cstxxx::REG_TOUCH_DATA);
|
||||
EXPECT_EQ(this->bus_.writes[1].size, 3u);
|
||||
}
|
||||
|
||||
TEST_F(CST3240Test, ReportsUpToFiveFingers) {
|
||||
this->bus_.set_report(5);
|
||||
this->update_();
|
||||
EXPECT_EQ(this->hub_.get_touches().size(), 5u);
|
||||
this->bus_.set_report(6);
|
||||
this->update_();
|
||||
EXPECT_FALSE(this->hub_.is_touched_);
|
||||
}
|
||||
|
||||
} // namespace esphome::cst3240::testing
|
||||
@@ -1,84 +0,0 @@
|
||||
npm1300:
|
||||
id: pmic
|
||||
i2c_id: i2c_bus
|
||||
vbus_current_limit: 500mA
|
||||
thermistor_resistance: 10kOhm
|
||||
thermistor_beta: 3380
|
||||
charger:
|
||||
charge_current: 150mA
|
||||
termination_voltage: 4.2V
|
||||
warm_termination_voltage: 4.0V
|
||||
termination_current: 20%
|
||||
trickle_voltage: 2.5V
|
||||
discharge_current_limit: 1000mA
|
||||
recharge: true
|
||||
buck2:
|
||||
voltage: 3.3V
|
||||
ldo1:
|
||||
voltage: 3.3V
|
||||
mode: ldo
|
||||
enabled: true
|
||||
ldo2:
|
||||
mode: load_switch
|
||||
enabled: false
|
||||
|
||||
sensor:
|
||||
- platform: npm1300
|
||||
battery_voltage:
|
||||
name: Battery Voltage
|
||||
battery_current:
|
||||
name: Battery Current
|
||||
battery_temperature:
|
||||
name: Battery Temperature
|
||||
die_temperature:
|
||||
name: PMIC Temperature
|
||||
system_voltage:
|
||||
name: System Voltage
|
||||
vbus_voltage:
|
||||
name: VBUS Voltage
|
||||
vbus_current_limit:
|
||||
name: VBUS Current Limit
|
||||
|
||||
binary_sensor:
|
||||
- platform: npm1300
|
||||
vbus_present:
|
||||
name: VBUS Present
|
||||
vbus_current_limit_active:
|
||||
name: VBUS Current Limit Active
|
||||
charging:
|
||||
name: Charging
|
||||
charge_complete:
|
||||
name: Charge Complete
|
||||
charger_error:
|
||||
name: Charger Error
|
||||
|
||||
text_sensor:
|
||||
- platform: npm1300
|
||||
charger_status:
|
||||
name: Charger Status
|
||||
|
||||
switch:
|
||||
- platform: npm1300
|
||||
charger:
|
||||
name: Charger
|
||||
buck1:
|
||||
name: BUCK1
|
||||
ldo1:
|
||||
name: LDO1
|
||||
ldo2:
|
||||
name: LDO2
|
||||
|
||||
button:
|
||||
- platform: template
|
||||
name: Ship Mode
|
||||
on_press:
|
||||
- npm1300.enter_ship_mode: pmic
|
||||
- platform: template
|
||||
name: Hibernate
|
||||
on_press:
|
||||
- npm1300.hibernate:
|
||||
id: pmic
|
||||
duration: 1h
|
||||
- npm1300.hibernate:
|
||||
id: pmic
|
||||
duration: !lambda return 60000;
|
||||
@@ -1,3 +0,0 @@
|
||||
packages:
|
||||
i2c: !include ../../test_build_components/common/i2c/esp32-idf.yaml
|
||||
npm1300: !include common.yaml
|
||||
@@ -1,3 +0,0 @@
|
||||
packages:
|
||||
i2c: !include ../../test_build_components/common/i2c/host.yaml
|
||||
npm1300: !include common.yaml
|
||||
@@ -1,3 +0,0 @@
|
||||
packages:
|
||||
i2c: !include ../../test_build_components/common/i2c/nrf52.yaml
|
||||
npm1300: !include common.yaml
|
||||
@@ -1,11 +1,9 @@
|
||||
import esphome.codegen as cg
|
||||
from esphome.components.logger import request_log_listener
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
async def to_code_testing(config: object) -> None:
|
||||
request_log_listener()
|
||||
cg.add_define("PACKET_INTERFACE_ADDRESSING_PORT_COUNT", 4)
|
||||
cg.add_define("USE_PACKET_INTERFACE_BASIC_ADDRESSING")
|
||||
cg.add_define("USE_PACKET_INTERFACE_BASIC_FRAGMENTATION")
|
||||
|
||||
@@ -3,8 +3,6 @@
|
||||
#include <functional>
|
||||
#include <memory>
|
||||
#include <vector>
|
||||
#include <string>
|
||||
#include "esphome/components/logger/logger.h"
|
||||
#include "esphome/components/packet_interface/basic_fragmentation.h"
|
||||
#include "esphome/components/packet_interface/hdlc_reliability.h"
|
||||
#include "esphome/core/application.h"
|
||||
@@ -28,8 +26,6 @@ class MockLink : public PacketInterface {
|
||||
// Before the packet is read, as a log line in a real link would run it
|
||||
if (this->on_send)
|
||||
this->on_send();
|
||||
if (this->sent.size() == this->accept)
|
||||
return false;
|
||||
this->sent.push_back(to_vector(data));
|
||||
return true;
|
||||
}
|
||||
@@ -43,27 +39,6 @@ class MockLink : public PacketInterface {
|
||||
std::vector<Packet> sent;
|
||||
std::function<void()> on_send;
|
||||
size_t capacity{SIZE_MAX};
|
||||
// Packets taken before the link refuses more
|
||||
size_t accept{SIZE_MAX};
|
||||
};
|
||||
|
||||
// Collects each warning logged
|
||||
class Warnings {
|
||||
public:
|
||||
Warnings() : previous_(logger::global_logger) {
|
||||
this->logger_.pre_setup();
|
||||
this->logger_.set_log_level(ESPHOME_LOG_LEVEL_WARN);
|
||||
this->logger_.add_log_callback(this, [](void *instance, uint8_t, const char *, const char *message, size_t len) {
|
||||
static_cast<Warnings *>(instance)->lines.emplace_back(message, len);
|
||||
});
|
||||
}
|
||||
~Warnings() { logger::global_logger = this->previous_; }
|
||||
|
||||
std::vector<std::string> lines;
|
||||
|
||||
private:
|
||||
logger::Logger *previous_;
|
||||
logger::Logger logger_{0};
|
||||
};
|
||||
|
||||
struct BufferHolder {
|
||||
@@ -192,19 +167,6 @@ TEST_F(BasicFragmentationTest, NotStartedWithoutRoomForAllFragments) {
|
||||
EXPECT_FALSE(a.send(make_packet(101)));
|
||||
}
|
||||
|
||||
TEST_F(BasicFragmentationTest, PacketCutShortIsWarned) {
|
||||
Peer a(&this->link_a_);
|
||||
Warnings warnings;
|
||||
this->link_a_.accept = 0;
|
||||
EXPECT_FALSE(a.send(make_packet(30)));
|
||||
EXPECT_TRUE(warnings.lines.empty()); // nothing was sent
|
||||
this->link_a_.accept = 1;
|
||||
EXPECT_FALSE(a.send(make_packet(30)));
|
||||
EXPECT_EQ(this->link_a_.sent.size(), 1u);
|
||||
ASSERT_EQ(warnings.lines.size(), 1u);
|
||||
EXPECT_NE(warnings.lines[0].find("Packet cut short, fragment 1 of 3"), std::string::npos);
|
||||
}
|
||||
|
||||
TEST_F(BasicFragmentationTest, InterleavedSourcesNotMixed) {
|
||||
Peer a(&this->link_a_), c(&this->link_a_), b(&this->link_b_);
|
||||
a.send(make_packet(20));
|
||||
|
||||
@@ -257,65 +257,6 @@ TEST_F(HdlcReliabilityTest, LostAckDoesNotDuplicate) {
|
||||
EXPECT_TRUE(a.send({0x01}));
|
||||
}
|
||||
|
||||
// Runs a layer's loop until it stops asking, without delivering what it sends
|
||||
static void run_until_idle(TestHdlc &hdlc) {
|
||||
for (int i = 0; i != 10 && !hdlc.is_idle(); i++)
|
||||
hdlc.loop();
|
||||
}
|
||||
|
||||
static size_t count_info(const std::vector<Frame> &frames) {
|
||||
size_t count = 0;
|
||||
for (const auto &frame : frames)
|
||||
count += is_info(frame);
|
||||
return count;
|
||||
}
|
||||
|
||||
TEST_F(HdlcReliabilityTest, TimeoutResendsOnlyOldestFrame) {
|
||||
Peer a, b;
|
||||
pump(a, b);
|
||||
for (uint8_t i = 0; i != 3; i++)
|
||||
ASSERT_TRUE(a.send({i}));
|
||||
pump(a, b, nullptr, [](const Frame &frame) { return is_ack(frame); });
|
||||
ASSERT_EQ(b.received.size(), 3);
|
||||
ASSERT_EQ(a.hdlc->outstanding_(), 3);
|
||||
a.hdlc->on_timeout_();
|
||||
run_until_idle(*a.hdlc);
|
||||
EXPECT_EQ(count_info(a.link.sent), 1);
|
||||
// The peer's answer to the duplicate acknowledges all three
|
||||
pump(a, b);
|
||||
EXPECT_EQ(b.received.size(), 3);
|
||||
EXPECT_EQ(a.hdlc->outstanding_(), 0);
|
||||
}
|
||||
|
||||
TEST_F(HdlcReliabilityTest, RestFollowOnceOldestAcknowledged) {
|
||||
Peer a, b;
|
||||
pump(a, b);
|
||||
for (uint8_t i = 0; i != 3; i++)
|
||||
ASSERT_TRUE(a.send({i}));
|
||||
pump(a, b, [](const Frame &frame) { return is_info(frame); });
|
||||
ASSERT_TRUE(b.received.empty());
|
||||
a.hdlc->on_timeout_();
|
||||
run_until_idle(*a.hdlc);
|
||||
EXPECT_EQ(count_info(a.link.sent), 1);
|
||||
pump(a, b);
|
||||
EXPECT_EQ(b.received, (std::vector<Frame>{{0}, {1}, {2}}));
|
||||
EXPECT_EQ(a.hdlc->outstanding_(), 0);
|
||||
}
|
||||
|
||||
TEST_F(HdlcReliabilityTest, NewFrameWaitsWhileOldestIsResent) {
|
||||
Peer a, b;
|
||||
pump(a, b);
|
||||
ASSERT_TRUE(a.send({0}));
|
||||
pump(a, b, [](const Frame &frame) { return is_info(frame); });
|
||||
a.hdlc->on_timeout_();
|
||||
run_until_idle(*a.hdlc);
|
||||
ASSERT_TRUE(a.send({1}));
|
||||
run_until_idle(*a.hdlc);
|
||||
EXPECT_EQ(count_info(a.link.sent), 1);
|
||||
pump(a, b);
|
||||
EXPECT_EQ(b.received, (std::vector<Frame>{{0}, {1}}));
|
||||
}
|
||||
|
||||
TEST_F(HdlcReliabilityTest, QueueFull) {
|
||||
Peer a(2), b(2);
|
||||
pump(a, b);
|
||||
|
||||
@@ -1,94 +0,0 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include "esphome/components/packet_interface/listen_before_talk.h"
|
||||
|
||||
namespace esphome::packet_interface::lbt_testing {
|
||||
|
||||
static constexpr uint32_t START = 10000;
|
||||
static constexpr uint32_t MAX_BUSY = ListenBeforeTalk::DEFAULT_MAX_BUSY_MS;
|
||||
|
||||
TEST(ListenBeforeTalkTest, SendsWhenNotBusy) {
|
||||
ListenBeforeTalk lbt;
|
||||
EXPECT_TRUE(lbt.may_send(false, START, START));
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, RefusesWhileBusyUpToLimit) {
|
||||
ListenBeforeTalk lbt;
|
||||
EXPECT_FALSE(lbt.may_send(true, START, START));
|
||||
// Refused every 50 ms, as the reliability layer retries
|
||||
uint32_t now = START;
|
||||
while (now - START < MAX_BUSY - 50) {
|
||||
now += 50;
|
||||
EXPECT_FALSE(lbt.may_send(true, now, now));
|
||||
}
|
||||
now += 50;
|
||||
EXPECT_TRUE(lbt.may_send(true, now, now));
|
||||
EXPECT_EQ(lbt.busy_for(now), MAX_BUSY);
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, BusyFlagThatNeverClearsReleasedForSlowSends) {
|
||||
ListenBeforeTalk lbt;
|
||||
// A send every 10 s, as session keep-alives, always finding the radio busy
|
||||
EXPECT_FALSE(lbt.may_send(true, START, START));
|
||||
EXPECT_TRUE(lbt.may_send(true, START + 10000, START + 10000));
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, FreeRadioEndsBusyPeriod) {
|
||||
ListenBeforeTalk lbt;
|
||||
EXPECT_FALSE(lbt.may_send(true, START, START));
|
||||
EXPECT_TRUE(lbt.may_send(false, START + 1500, START + 1500));
|
||||
// A new busy period starts, so the earlier one does not count
|
||||
EXPECT_FALSE(lbt.may_send(true, START + MAX_BUSY + 100, START + MAX_BUSY + 100));
|
||||
EXPECT_EQ(lbt.busy_for(START + MAX_BUSY + 100), 0);
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, EndBusyStartsNewPeriod) {
|
||||
ListenBeforeTalk lbt;
|
||||
EXPECT_FALSE(lbt.may_send(true, START, START));
|
||||
// The link saw the radio free between sends, so a later reception is a new busy period
|
||||
lbt.end_busy();
|
||||
EXPECT_FALSE(lbt.may_send(true, START + MAX_BUSY + 100, START + MAX_BUSY + 100));
|
||||
EXPECT_EQ(lbt.busy_for(START + MAX_BUSY + 100), 0);
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, LimitCanBeLonger) {
|
||||
ListenBeforeTalk lbt;
|
||||
lbt.set_max_busy(8000);
|
||||
EXPECT_FALSE(lbt.may_send(true, START, START));
|
||||
EXPECT_FALSE(lbt.may_send(true, START + 7999, START + 7999));
|
||||
EXPECT_TRUE(lbt.may_send(true, START + 8000, START + 8000));
|
||||
}
|
||||
|
||||
static constexpr uint32_t TURNAROUND = 250;
|
||||
|
||||
TEST(ListenBeforeTalkTest, SendInLaterPassWaitsForTurnaround) {
|
||||
ListenBeforeTalk lbt;
|
||||
lbt.set_turnaround(TURNAROUND);
|
||||
lbt.sent(START + 300, START);
|
||||
EXPECT_FALSE(lbt.may_send(false, START + 320, START + 320));
|
||||
EXPECT_FALSE(lbt.may_send(false, START + 300 + TURNAROUND - 1, START + 520));
|
||||
EXPECT_TRUE(lbt.may_send(false, START + 300 + TURNAROUND, START + 540));
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, SendInSamePassNotHeld) {
|
||||
ListenBeforeTalk lbt;
|
||||
lbt.set_turnaround(TURNAROUND);
|
||||
// The next fragment of the same packet
|
||||
lbt.sent(START + 300, START);
|
||||
EXPECT_TRUE(lbt.may_send(false, START + 301, START));
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, ReceptionEndsTurnaround) {
|
||||
ListenBeforeTalk lbt;
|
||||
lbt.set_turnaround(TURNAROUND);
|
||||
lbt.sent(START + 300, START);
|
||||
lbt.received();
|
||||
EXPECT_TRUE(lbt.may_send(false, START + 320, START + 320));
|
||||
}
|
||||
|
||||
TEST(ListenBeforeTalkTest, NoTurnaroundByDefault) {
|
||||
ListenBeforeTalk lbt;
|
||||
lbt.sent(START + 300, START);
|
||||
EXPECT_TRUE(lbt.may_send(false, START + 320, START + 320));
|
||||
}
|
||||
|
||||
} // namespace esphome::packet_interface::lbt_testing
|
||||
@@ -1,213 +0,0 @@
|
||||
#include <gtest/gtest.h>
|
||||
#include <cstdint>
|
||||
#include <vector>
|
||||
#include "esphome/components/packet_interface/radio_link.h"
|
||||
#include "esphome/core/application.h"
|
||||
|
||||
namespace esphome::packet_interface::radio_link_testing {
|
||||
|
||||
using Packet = std::vector<uint8_t>;
|
||||
|
||||
static constexpr uint32_t START = 10000;
|
||||
static constexpr uint32_t MAX_BUSY = ListenBeforeTalk::DEFAULT_MAX_BUSY_MS;
|
||||
|
||||
class FakeListener {
|
||||
public:
|
||||
virtual void on_packet(const std::vector<uint8_t> &packet, float rssi, float snr) = 0;
|
||||
};
|
||||
|
||||
enum class FakeError { NONE, BUSY };
|
||||
|
||||
class FakeRadio : public Component {
|
||||
public:
|
||||
bool is_receiving() { return this->receiving; }
|
||||
void register_listener(FakeListener *listener) { this->listener = listener; }
|
||||
void fail() { this->mark_failed(); }
|
||||
FakeError transmit_packet(const uint8_t *data, size_t length) {
|
||||
this->sent.emplace_back(data, data + length);
|
||||
return this->result;
|
||||
}
|
||||
|
||||
FakeListener *listener{nullptr};
|
||||
std::vector<Packet> sent;
|
||||
bool receiving{false};
|
||||
FakeError result{FakeError::NONE};
|
||||
};
|
||||
|
||||
// Reads the time that set_time() sets
|
||||
class TestLink : public RadioLink<FakeRadio, FakeListener, FakeError, 16> {
|
||||
public:
|
||||
using RadioLink::RadioLink;
|
||||
uint8_t not_understood_count() const { return this->not_understood_count_; }
|
||||
|
||||
protected:
|
||||
uint32_t current_time_ms() const override { return App.get_loop_component_start_time(); }
|
||||
};
|
||||
|
||||
static void set_time(uint32_t now) { LoopBlockingGuard guard{nullptr, nullptr, now}; }
|
||||
|
||||
class RadioLinkTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
this->radio_.call();
|
||||
this->link_.call();
|
||||
}
|
||||
bool send_() {
|
||||
static const Packet PACKET{1, 2, 3};
|
||||
return this->link_.send_to_interface(PacketBuffer(PACKET), {});
|
||||
}
|
||||
|
||||
FakeRadio radio_;
|
||||
TestLink link_{&radio_, 16};
|
||||
};
|
||||
|
||||
TEST_F(RadioLinkTest, LoopRunsOnlyWhileBusy) {
|
||||
EXPECT_EQ(this->radio_.listener, &this->link_);
|
||||
EXPECT_TRUE(this->link_.is_idle());
|
||||
set_time(START);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_TRUE(this->link_.is_in_loop_state());
|
||||
this->link_.loop();
|
||||
EXPECT_TRUE(this->link_.is_in_loop_state());
|
||||
this->radio_.receiving = false;
|
||||
this->link_.loop();
|
||||
EXPECT_TRUE(this->link_.is_idle());
|
||||
EXPECT_TRUE(this->radio_.sent.empty());
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, ReceptionAfterStalePeriodIsNotSentOver) {
|
||||
set_time(START);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
// The reception ends with no send to see it
|
||||
this->radio_.receiving = false;
|
||||
this->link_.loop();
|
||||
// A new reception, longer after the first than the limit, still holds the send back
|
||||
set_time(START + MAX_BUSY + 100);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_TRUE(this->radio_.sent.empty());
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, BusyFlagThatNeverClearsIsSentOver) {
|
||||
set_time(START);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
this->link_.loop();
|
||||
set_time(START + MAX_BUSY);
|
||||
EXPECT_TRUE(this->send_());
|
||||
ASSERT_EQ(this->radio_.sent.size(), 1u);
|
||||
EXPECT_EQ(this->radio_.sent[0], (Packet{1, 2, 3}));
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, EmptyPacketCountsAsSentWithoutTransmitting) {
|
||||
static const Packet EMPTY;
|
||||
EXPECT_TRUE(this->link_.send_to_interface(PacketBuffer(EMPTY), {}));
|
||||
EXPECT_TRUE(this->radio_.sent.empty());
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, FailedRadioRefusesSends) {
|
||||
this->radio_.fail();
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_TRUE(this->radio_.sent.empty());
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, RadioFailingWhileBusyEndsBusyPeriod) {
|
||||
set_time(START);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_TRUE(this->link_.is_in_loop_state());
|
||||
this->radio_.fail();
|
||||
this->link_.loop();
|
||||
EXPECT_TRUE(this->link_.is_idle());
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, ReceivedPacketCarriesSignal) {
|
||||
Packet received;
|
||||
PacketMetaData meta;
|
||||
this->link_.add_packet_interface_listener([&](const PacketBuffer &data, const PacketMetaData &meta_data) {
|
||||
received.resize(data.size());
|
||||
data.copy_to(received.data(), received.size());
|
||||
meta = meta_data;
|
||||
});
|
||||
this->link_.on_packet({4, 5}, -80.0f, 7.5f);
|
||||
EXPECT_EQ(received, (Packet{4, 5}));
|
||||
EXPECT_FLOAT_EQ(meta.rssi, -80.0f);
|
||||
EXPECT_FLOAT_EQ(meta.snr, 7.5f);
|
||||
}
|
||||
|
||||
// After a send, a send in a later loop pass waits for the peer's reply, which may come at once
|
||||
TEST_F(RadioLinkTest, LaterSendWaitsForPeerToReply) {
|
||||
this->link_.set_turnaround(250);
|
||||
set_time(START);
|
||||
EXPECT_TRUE(this->send_());
|
||||
EXPECT_TRUE(this->send_()); // the same loop pass, as the fragments of one packet
|
||||
set_time(START + 100);
|
||||
EXPECT_FALSE(this->send_());
|
||||
set_time(START + 250);
|
||||
EXPECT_TRUE(this->send_());
|
||||
set_time(START + 300);
|
||||
this->radio_.listener->on_packet(Packet{4, 5}, -50, 5);
|
||||
EXPECT_TRUE(this->send_());
|
||||
EXPECT_EQ(this->radio_.sent.size(), 4u);
|
||||
}
|
||||
|
||||
// A packet in two parts, as a layer adds its header, is joined before it goes to the radio
|
||||
TEST_F(RadioLinkTest, SplitPacketIsJoined) {
|
||||
static const Packet HEADER{9, 8};
|
||||
static const Packet BODY{1, 2, 3};
|
||||
PacketBuffer body(BODY);
|
||||
EXPECT_TRUE(this->link_.send_to_interface(PacketBuffer(HEADER.data(), HEADER.size(), &body, nullptr, 0), {}));
|
||||
ASSERT_EQ(this->radio_.sent.size(), 1u);
|
||||
EXPECT_EQ(this->radio_.sent[0], (Packet{9, 8, 1, 2, 3}));
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, OversizedPacketRefused) {
|
||||
static const Packet LARGEST(16, 0x55);
|
||||
static const Packet OVERSIZED(17, 0x55);
|
||||
EXPECT_FALSE(this->link_.send_to_interface(PacketBuffer(OVERSIZED), {}));
|
||||
EXPECT_TRUE(this->radio_.sent.empty());
|
||||
EXPECT_TRUE(this->link_.send_to_interface(PacketBuffer(LARGEST), {}));
|
||||
EXPECT_EQ(this->radio_.sent.size(), 1u);
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, TransmitErrorIsReported) {
|
||||
this->radio_.result = FakeError::BUSY;
|
||||
EXPECT_FALSE(this->send_());
|
||||
this->radio_.result = FakeError::NONE;
|
||||
EXPECT_TRUE(this->send_());
|
||||
}
|
||||
|
||||
// The radio receives packets up to its own limit, which can be more than the link's
|
||||
TEST_F(RadioLinkTest, OversizedReceptionDropped) {
|
||||
std::vector<size_t> sizes;
|
||||
this->link_.add_packet_interface_listener(
|
||||
[&](const PacketBuffer &data, const PacketMetaData &) { sizes.push_back(data.size()); });
|
||||
this->link_.on_packet(Packet(17, 0x55), -80.0f, 7.5f);
|
||||
this->link_.on_packet(Packet(16, 0x55), -80.0f, 7.5f);
|
||||
EXPECT_EQ(sizes, std::vector<size_t>{16});
|
||||
}
|
||||
|
||||
// A send made over a busy flag that seemed stuck lets the radio listen again, so a reception that starts before
|
||||
// loop() runs is waited for in a new busy period
|
||||
TEST_F(RadioLinkTest, ForcedSendEndsBusyPeriod) {
|
||||
set_time(START);
|
||||
this->radio_.receiving = true;
|
||||
EXPECT_FALSE(this->send_());
|
||||
set_time(START + MAX_BUSY);
|
||||
EXPECT_TRUE(this->send_());
|
||||
set_time(START + MAX_BUSY + 100);
|
||||
EXPECT_FALSE(this->send_());
|
||||
EXPECT_EQ(this->radio_.sent.size(), 1u);
|
||||
}
|
||||
|
||||
TEST_F(RadioLinkTest, AcceptedPacketEndsRunOfOversizedOnes) {
|
||||
this->link_.on_packet(Packet(17, 0x55), -80.0f, 7.5f);
|
||||
EXPECT_EQ(this->link_.not_understood_count(), 1);
|
||||
this->link_.on_packet(Packet(16, 0x55), -80.0f, 7.5f);
|
||||
EXPECT_EQ(this->link_.not_understood_count(), 0);
|
||||
}
|
||||
|
||||
} // namespace esphome::packet_interface::radio_link_testing
|
||||
@@ -29,11 +29,9 @@ class MockLink : public PacketInterface {
|
||||
return true;
|
||||
}
|
||||
void inject(const Packet &packet) { this->on_receive_from_interface_(PacketBuffer(packet), {}); }
|
||||
size_t get_send_capacity() const override { return this->capacity; }
|
||||
|
||||
std::vector<Packet> sent;
|
||||
std::function<void()> on_send;
|
||||
size_t capacity{SIZE_MAX};
|
||||
};
|
||||
|
||||
static constexpr size_t ROLLING_TRAILER_SIZE = 16;
|
||||
@@ -95,16 +93,6 @@ TEST_F(XxteaEncryptionTest, MaxPacketSizeAllowsForTrailerAndWords) {
|
||||
EXPECT_EQ(c.encryption->get_max_packet_size(), 64 - TRAILER_SIZE);
|
||||
}
|
||||
|
||||
// A link such as TCP can run out of room; a fragmentation layer above must see that
|
||||
TEST_F(XxteaEncryptionTest, ForwardsTheLinksSendCapacity) {
|
||||
Peer a;
|
||||
EXPECT_EQ(a.encryption->get_send_capacity(), SIZE_MAX);
|
||||
a.link.capacity = 1;
|
||||
EXPECT_EQ(a.encryption->get_send_capacity(), 1u);
|
||||
a.link.capacity = 0;
|
||||
EXPECT_EQ(a.encryption->get_send_capacity(), 0u);
|
||||
}
|
||||
|
||||
static void round_trip_all_sizes(bool rolling_code, size_t trailer_size) {
|
||||
Peer a(0x12345678, 64, rolling_code), b(0x12345678, 64, rolling_code);
|
||||
a.introduce(b);
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
sx126x:
|
||||
cs_pin: ${cs_pin}
|
||||
rst_pin: ${rst_pin}
|
||||
busy_pin: ${busy_pin}
|
||||
dio1_pin: ${dio1_pin}
|
||||
hw_version: sx1262
|
||||
rf_switch: true
|
||||
frequency: 917MHz
|
||||
modulation: LORA
|
||||
crc_enable: true
|
||||
|
||||
packet_interface:
|
||||
- platform: sx126x
|
||||
id: sx126x_packet_interface
|
||||
addressing:
|
||||
address: 0x0001
|
||||
destination: 0x0002
|
||||
reliability:
|
||||
ack_delay: 100ms
|
||||
@@ -1,59 +0,0 @@
|
||||
#include "sx126x_test_helpers.h"
|
||||
|
||||
namespace esphome::sx126x::testing {
|
||||
|
||||
// The radio link refuses to send while is_receiving(), as a send would lose the packet
|
||||
TEST(SX126xReceiving, ReportsAPacketOnTheWayOrWaiting) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
hw.irq = IRQ_HEADER_VALID;
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.irq = IRQ_SYNCWORD_VALID;
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.irq = IRQ_RX_DONE;
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
// Held by a send that found it waiting
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX126xError::SX126X_ERROR_BUSY);
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.radio.loop();
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
}
|
||||
|
||||
// The link would otherwise send over a reception it could not see
|
||||
TEST(SX126xReceiving, FailedReadCountsAsReceiving) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
hw.clear_trace();
|
||||
hw.fail_at = 1; // BUSY stays high for the IRQ read
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.clear_trace();
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
}
|
||||
|
||||
TEST(SX126xReceiving, NotWhileSendingOrAsleep) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, false);
|
||||
hw.irq = IRQ_HEADER_VALID;
|
||||
hw.clear_trace();
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
EXPECT_TRUE(hw.transactions.empty()); // A sleeping radio is not woken to ask
|
||||
}
|
||||
|
||||
// A valid header or sync word is flagged, but only the end of a packet is signalled on DIO1
|
||||
TEST(SX126xReceiving, ReceiveFlagsHeaderAndSyncWithoutSignallingThem) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
const auto params = std::find_if(hw.transactions.rbegin(), hw.transactions.rend(), [](const auto &command) {
|
||||
return !command.empty() && command[0] == RADIO_SET_DIOIRQPARAMS;
|
||||
});
|
||||
ASSERT_NE(params, hw.transactions.rend());
|
||||
ASSERT_GE(params->size(), 5u);
|
||||
const uint16_t flags = encode_uint16((*params)[1], (*params)[2]);
|
||||
const uint16_t dio1 = encode_uint16((*params)[3], (*params)[4]);
|
||||
EXPECT_EQ(flags & (IRQ_HEADER_VALID | IRQ_SYNCWORD_VALID), IRQ_HEADER_VALID | IRQ_SYNCWORD_VALID);
|
||||
EXPECT_EQ(dio1 & (IRQ_HEADER_VALID | IRQ_SYNCWORD_VALID), 0);
|
||||
EXPECT_NE(dio1 & IRQ_RX_DONE, 0);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx126x::testing
|
||||
@@ -1,9 +0,0 @@
|
||||
substitutions:
|
||||
cs_pin: GPIO12
|
||||
rst_pin: GPIO13
|
||||
busy_pin: GPIO25
|
||||
dio1_pin: GPIO26
|
||||
|
||||
packages:
|
||||
spi: !include ../../test_build_components/common/spi/esp32-idf.yaml
|
||||
sx126x: !include common-packet-interface.yaml
|
||||
@@ -1,16 +0,0 @@
|
||||
"""Build the SX127x C++ tests against a software SPI bus, with real logger callbacks."""
|
||||
|
||||
import esphome.codegen as cg
|
||||
from esphome.components.logger import request_log_listener
|
||||
from esphome.types import ConfigType
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
async def to_code(config: ConfigType) -> None:
|
||||
request_log_listener()
|
||||
# The tests build a software SPI bus in C++, which no configured bus asks for
|
||||
cg.add_define("USE_SPI_SOFTWARE")
|
||||
|
||||
manifest.multi_conf = False
|
||||
manifest.to_code = to_code
|
||||
@@ -1,17 +0,0 @@
|
||||
sx127x:
|
||||
cs_pin: ${cs_pin}
|
||||
rst_pin: ${rst_pin}
|
||||
dio0_pin: ${dio0_pin}
|
||||
frequency: 917MHz
|
||||
modulation: LORA
|
||||
preamble_size: 8
|
||||
crc_enable: true
|
||||
|
||||
packet_interface:
|
||||
- platform: sx127x
|
||||
id: sx127x_packet_interface
|
||||
addressing:
|
||||
address: 0x0001
|
||||
destination: 0x0002
|
||||
reliability:
|
||||
ack_delay: 100ms
|
||||
@@ -1,347 +0,0 @@
|
||||
#include "sx127x_test_helpers.h"
|
||||
#include <cmath>
|
||||
#include <tuple>
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
static std::vector<uint8_t> expected_fifo(const RadioHardware &hw, bool lora, bool fixed) {
|
||||
std::vector<uint8_t> fifo;
|
||||
if (!lora && !fixed) {
|
||||
fifo.push_back(hw.packet.size()); // A variable length FSK packet starts with its length
|
||||
}
|
||||
fifo.insert(fifo.end(), hw.packet.begin(), hw.packet.end());
|
||||
return fifo;
|
||||
}
|
||||
|
||||
class SX127xAsyncModes : public ::testing::TestWithParam<std::tuple<bool, bool, bool>> {};
|
||||
|
||||
TEST_P(SX127xAsyncModes, ReturnsBeforeCompletionAndRestoresMode) {
|
||||
const auto [lora, rx, fixed] = GetParam();
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
hw.configure(lora, rx, fixed);
|
||||
ASSERT_FALSE(hw.radio.is_failed());
|
||||
hw.auto_complete = false;
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&listener, hw.packet, 1234), SX127xError::SX127X_ERROR_NONE);
|
||||
EXPECT_TRUE(hw.radio.is_transmitting());
|
||||
EXPECT_EQ(hw.mode(), MODE_TX);
|
||||
ASSERT_EQ(hw.sent.size(), 1u);
|
||||
EXPECT_EQ(hw.sent[0], expected_fifo(hw, lora, fixed));
|
||||
hw.radio.loop();
|
||||
EXPECT_TRUE(listener.results.empty());
|
||||
hw.complete_send();
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(listener.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_NONE});
|
||||
EXPECT_FALSE(hw.radio.is_transmitting());
|
||||
EXPECT_EQ(hw.mode(), rx ? MODE_RX : MODE_SLEEP);
|
||||
if (lora) {
|
||||
EXPECT_EQ(hw.irq, 0); // TX_DONE is cleared, so DIO0 is low again
|
||||
}
|
||||
}
|
||||
|
||||
TEST_P(SX127xAsyncModes, BlockingSendWaitsForCompletion) {
|
||||
const auto [lora, rx, fixed] = GetParam();
|
||||
RadioHardware hw;
|
||||
hw.configure(lora, rx, fixed);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
EXPECT_FALSE(hw.radio.is_transmitting());
|
||||
ASSERT_EQ(hw.sent.size(), 1u);
|
||||
EXPECT_EQ(hw.sent[0], expected_fifo(hw, lora, fixed));
|
||||
EXPECT_EQ(hw.mode(), rx ? MODE_RX : MODE_SLEEP);
|
||||
}
|
||||
|
||||
INSTANTIATE_TEST_SUITE_P(Modes, SX127xAsyncModes,
|
||||
::testing::Combine(::testing::Bool(), ::testing::Bool(), ::testing::Bool()));
|
||||
|
||||
// Modulation and fixed length; only a receiving radio has a packet waiting
|
||||
class SX127xHeldPacket : public ::testing::TestWithParam<std::tuple<bool, bool>> {};
|
||||
|
||||
TEST_P(SX127xHeldPacket, PacketWaitingWhenASendStartsIsDeliveredFirst) {
|
||||
const auto [lora, fixed] = GetParam();
|
||||
const bool rx = true;
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
TransmitListener listener;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(lora, rx, fixed);
|
||||
hw.receive({0x44, 0x55, 0x66});
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_BUSY);
|
||||
EXPECT_TRUE(hw.sent.empty());
|
||||
hw.radio.set_mode_sleep(); // Ignored while the packet is held
|
||||
EXPECT_EQ(hw.mode(), MODE_STDBY);
|
||||
hw.radio.loop();
|
||||
ASSERT_EQ(packets.packets.size(), 1u);
|
||||
EXPECT_EQ(packets.packets[0], (std::vector<uint8_t>{0x44, 0x55, 0x66}));
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(listener.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_NONE});
|
||||
EXPECT_EQ(hw.sent.size(), 1u);
|
||||
}
|
||||
|
||||
INSTANTIATE_TEST_SUITE_P(Modes, SX127xHeldPacket, ::testing::Combine(::testing::Bool(), ::testing::Bool()));
|
||||
|
||||
TEST(SX127xAsync, OneSendAtATime) {
|
||||
RadioHardware hw;
|
||||
TransmitListener first, second;
|
||||
hw.configure(true, true);
|
||||
hw.auto_complete = false;
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&first, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&second, hw.packet), SX127xError::SX127X_ERROR_BUSY);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_BUSY);
|
||||
hw.radio.set_mode_rx();
|
||||
hw.radio.run_image_cal();
|
||||
hw.radio.configure();
|
||||
EXPECT_EQ(hw.mode(), MODE_TX);
|
||||
EXPECT_EQ(hw.sent.size(), 1u);
|
||||
hw.complete_send();
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(first.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_NONE});
|
||||
EXPECT_TRUE(second.results.empty());
|
||||
}
|
||||
|
||||
TEST(SX127xAsync, SendWithoutCompletionTimesOut) {
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
hw.configure(true, true);
|
||||
hw.auto_complete = false;
|
||||
const uint32_t start = millis();
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&listener, hw.packet, 1000), SX127xError::SX127X_ERROR_NONE);
|
||||
{
|
||||
LoopBlockingGuard clock{nullptr, nullptr, start + 500};
|
||||
hw.radio.loop();
|
||||
}
|
||||
EXPECT_TRUE(listener.results.empty());
|
||||
{
|
||||
LoopBlockingGuard clock{nullptr, nullptr, start + 1100};
|
||||
hw.radio.loop();
|
||||
}
|
||||
EXPECT_EQ(listener.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_TIMEOUT});
|
||||
EXPECT_FALSE(hw.radio.status_has_warning());
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
}
|
||||
|
||||
// The chip leaves a send that is still going out for standby or sleep, but not for RX
|
||||
class SX127xCancel : public ::testing::TestWithParam<std::tuple<bool, bool>> {};
|
||||
|
||||
TEST_P(SX127xCancel, CancelEndsOnlyTheListenersOwnSend) {
|
||||
const auto [lora, rx] = GetParam();
|
||||
RadioHardware hw;
|
||||
TransmitListener owner, other;
|
||||
hw.configure(lora, rx);
|
||||
hw.auto_complete = false;
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&owner, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
EXPECT_FALSE(hw.radio.cancel_transmit_async(&other));
|
||||
EXPECT_FALSE(hw.radio.cancel_transmit_async(nullptr));
|
||||
EXPECT_TRUE(hw.radio.cancel_transmit_async(&owner));
|
||||
EXPECT_EQ(owner.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_CANCELLED});
|
||||
EXPECT_FALSE(hw.radio.is_transmitting());
|
||||
EXPECT_FALSE(hw.radio.status_has_warning());
|
||||
EXPECT_EQ(hw.mode(), rx ? MODE_RX : MODE_SLEEP);
|
||||
EXPECT_FALSE(hw.radio.cancel_transmit_async(&owner));
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(owner.results.size(), 1u);
|
||||
EXPECT_TRUE(other.results.empty());
|
||||
}
|
||||
|
||||
INSTANTIATE_TEST_SUITE_P(Modes, SX127xCancel, ::testing::Combine(::testing::Bool(), ::testing::Bool()));
|
||||
|
||||
TEST(SX127xAsync, CompletionMayStartTheNextSend) {
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
hw.configure(true, true);
|
||||
listener.on_complete = [&](SX127xError result) {
|
||||
if (listener.results.size() == 1) {
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
}
|
||||
};
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
hw.radio.loop();
|
||||
EXPECT_TRUE(hw.radio.is_transmitting());
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(listener.results.size(), 2u);
|
||||
EXPECT_EQ(hw.sent.size(), 2u);
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
}
|
||||
|
||||
TEST(SX127xAsync, PacketListenerMaySend) {
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(true, true);
|
||||
packets.on_receive = [&]() { EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE); };
|
||||
hw.receive({0x01, 0x02});
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(packets.packets.size(), 1u);
|
||||
EXPECT_EQ(hw.sent.size(), 1u);
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
}
|
||||
|
||||
TEST(SX127xAsync, InvalidRequestsAreRefused) {
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
hw.configure(true, true, true);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(nullptr, hw.packet), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet, 0), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet, 262144), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, nullptr, 3), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet.data(), 0), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet.data(), 2), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_TRUE(hw.sent.empty());
|
||||
EXPECT_TRUE(listener.results.empty());
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
}
|
||||
|
||||
TEST(SX127xAsync, SendWithoutDio0IsRefused) {
|
||||
RadioHardware hw;
|
||||
hw.radio.set_dio0_pin(nullptr);
|
||||
hw.configure(true, true);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
EXPECT_TRUE(hw.sent.empty());
|
||||
}
|
||||
|
||||
TEST(SX127xReceive, LoRaPacketHasRssiAndSnr) {
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(true, true);
|
||||
hw.receive({0x01, 0x02, 0x03, 0x04});
|
||||
hw.radio.loop();
|
||||
ASSERT_EQ(packets.packets.size(), 1u);
|
||||
EXPECT_EQ(packets.packets[0], (std::vector<uint8_t>{0x01, 0x02, 0x03, 0x04}));
|
||||
EXPECT_FLOAT_EQ(packets.rssi, 100.0f - 164.0f);
|
||||
EXPECT_FLOAT_EQ(packets.snr, 5.0f);
|
||||
EXPECT_EQ(hw.irq, 0);
|
||||
}
|
||||
|
||||
TEST(SX127xReceive, FskPacketHasNoSnr) {
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(false, true);
|
||||
hw.receive({0x01, 0x02, 0x03, 0x04});
|
||||
hw.radio.loop();
|
||||
ASSERT_EQ(packets.packets.size(), 1u);
|
||||
EXPECT_EQ(packets.packets[0], (std::vector<uint8_t>{0x01, 0x02, 0x03, 0x04}));
|
||||
EXPECT_TRUE(std::isnan(packets.snr));
|
||||
}
|
||||
|
||||
TEST(SX127xReceive, PacketThatFailedItsCrcIsDroppedAndDoesNotHoldUpASend) {
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(true, true);
|
||||
hw.receive({0x01}, true);
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
hw.radio.loop();
|
||||
EXPECT_TRUE(packets.packets.empty());
|
||||
}
|
||||
|
||||
// The TX mode action sends whatever the FIFO holds without tracking it; its completion
|
||||
// is not taken for a received packet
|
||||
TEST(SX127xReceive, RawTxModeIsNotAPacket) {
|
||||
for (const bool lora : {true, false}) {
|
||||
RadioHardware hw;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(lora, true);
|
||||
hw.radio.set_mode_tx();
|
||||
EXPECT_EQ(hw.mode(), MODE_TX);
|
||||
EXPECT_TRUE(hw.dio0.digital_read());
|
||||
hw.radio.loop();
|
||||
EXPECT_TRUE(packets.packets.empty()) << (lora ? "LoRa" : "FSK");
|
||||
hw.radio.set_mode_rx();
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
}
|
||||
}
|
||||
|
||||
TEST(SX127xRecovery, FailedModeChangeIsReconfiguredWithoutBeingAsked) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
hw.stuck = true;
|
||||
hw.radio.set_mode_standby();
|
||||
EXPECT_FALSE(hw.radio.is_failed());
|
||||
EXPECT_TRUE(hw.radio.status_has_warning());
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NOT_READY);
|
||||
hw.radio.set_mode_sleep(); // Ignored until configured again
|
||||
hw.stuck = false;
|
||||
EXPECT_EQ(hw.mode(), MODE_RX);
|
||||
run_scheduler(1100);
|
||||
EXPECT_FALSE(hw.radio.status_has_warning());
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
// Once configured, the retry stops
|
||||
hw.radio.set_mode_sleep();
|
||||
run_scheduler(1100);
|
||||
EXPECT_EQ(hw.mode(), MODE_SLEEP);
|
||||
}
|
||||
|
||||
TEST(SX127xRecovery, FailedSendStartIsReconfiguredWithoutBeingAsked) {
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
hw.configure(true, true);
|
||||
hw.stuck = true;
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NOT_READY);
|
||||
EXPECT_FALSE(hw.radio.is_transmitting());
|
||||
EXPECT_TRUE(listener.results.empty());
|
||||
hw.stuck = false;
|
||||
run_scheduler(1100);
|
||||
EXPECT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
}
|
||||
|
||||
TEST(SX127xRecovery, UnsupportedChipFailsSetup) {
|
||||
RadioHardware hw;
|
||||
hw.version = 0x22;
|
||||
hw.configure(true, true);
|
||||
EXPECT_TRUE(hw.radio.is_failed());
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NOT_READY);
|
||||
}
|
||||
|
||||
TEST(SX127xRecovery, NothingHappensBeforeSetup) {
|
||||
RadioHardware hw;
|
||||
unsigned resets = 0;
|
||||
hw.rst.on_write = [&](bool high) { resets += high ? 0 : 1; };
|
||||
hw.radio.configure();
|
||||
hw.radio.set_mode_rx();
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_NOT_READY);
|
||||
EXPECT_EQ(resets, 0u);
|
||||
EXPECT_EQ(hw.mode(), MODE_STDBY);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
// configure() is refused during a send, so settings changed then are not used until it succeeds
|
||||
TEST(SX127xSettings, SettingsChangedDuringASendWaitForConfigure) {
|
||||
RadioHardware hw;
|
||||
TransmitListener listener;
|
||||
PacketListener packets;
|
||||
hw.radio.register_listener(&packets);
|
||||
hw.configure(false, true, true);
|
||||
hw.auto_complete = false;
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
hw.radio.set_payload_length(4);
|
||||
hw.radio.set_rx_start(false);
|
||||
hw.radio.set_modulation(MOD_LORA);
|
||||
hw.radio.configure(); // Refused: a send is on air
|
||||
hw.complete_send();
|
||||
hw.radio.loop();
|
||||
EXPECT_EQ(listener.results, std::vector<SX127xError>{SX127xError::SX127X_ERROR_NONE});
|
||||
EXPECT_TRUE(hw.receiving()); // Still the applied rx_start
|
||||
EXPECT_FALSE(hw.lora());
|
||||
EXPECT_EQ(hw.radio.get_max_packet_size(), 3u);
|
||||
const std::vector<uint8_t> four{0x01, 0x02, 0x03, 0x04};
|
||||
EXPECT_EQ(hw.radio.transmit_packet(four), SX127xError::SX127X_ERROR_INVALID_PARAMS);
|
||||
hw.receive({0x07, 0x08, 0x09});
|
||||
hw.radio.loop();
|
||||
ASSERT_EQ(packets.packets.size(), 1u);
|
||||
EXPECT_EQ(packets.packets[0], (std::vector<uint8_t>{0x07, 0x08, 0x09}));
|
||||
// Once applied, they are used
|
||||
hw.radio.configure();
|
||||
EXPECT_TRUE(hw.lora());
|
||||
EXPECT_EQ(hw.mode(), MODE_SLEEP);
|
||||
EXPECT_EQ(hw.radio.get_max_packet_size(), 4u);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
@@ -1,64 +0,0 @@
|
||||
#include "sx127x_test_helpers.h"
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
// The radio link refuses to send while is_receiving(), as a send would lose the packet
|
||||
TEST(SX127xReceiving, LoRaReportsAPacketOnTheWayOrWaiting) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
for (const uint8_t stat : {MODEM_STAT_SIGNAL_DETECTED, MODEM_STAT_SIGNAL_SYNCHRONIZED, MODEM_STAT_HEADER_VALID}) {
|
||||
hw.regs[REG_MODEM_STAT] = stat;
|
||||
EXPECT_TRUE(hw.radio.is_receiving()) << int(stat);
|
||||
}
|
||||
hw.regs[REG_MODEM_STAT] = 0;
|
||||
hw.receive({0x01, 0x02});
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
// Held by a send that found it waiting
|
||||
EXPECT_EQ(hw.radio.transmit_packet(hw.packet), SX127xError::SX127X_ERROR_BUSY);
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.radio.loop();
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
}
|
||||
|
||||
TEST(SX127xReceiving, FskReportsAMatchedSyncWord) {
|
||||
RadioHardware hw;
|
||||
hw.configure(false, true);
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
hw.regs[REG_IRQ_FLAGS_1] = IRQ_FLAGS_1_PREAMBLE_DETECT;
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
hw.regs[REG_IRQ_FLAGS_1] = IRQ_FLAGS_1_SYNC_ADDRESS_MATCH;
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
hw.regs[REG_IRQ_FLAGS_1] = 0;
|
||||
hw.receive({0x01, 0x02});
|
||||
EXPECT_TRUE(hw.radio.is_receiving());
|
||||
}
|
||||
|
||||
TEST(SX127xReceiving, NotAfterRawTxOrWhileSendingOrAsleep) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, true);
|
||||
hw.radio.set_mode_tx(); // Its TX_DONE raises DIO0, which is not a packet
|
||||
EXPECT_TRUE(hw.dio0.digital_read());
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
hw.radio.set_mode_rx();
|
||||
TransmitListener listener;
|
||||
hw.auto_complete = false;
|
||||
ASSERT_EQ(hw.radio.start_transmit_async(&listener, hw.packet), SX127xError::SX127X_ERROR_NONE);
|
||||
hw.regs[REG_MODEM_STAT] = MODEM_STAT_HEADER_VALID;
|
||||
EXPECT_FALSE(hw.radio.is_receiving());
|
||||
EXPECT_TRUE(hw.radio.cancel_transmit_async(&listener));
|
||||
|
||||
RadioHardware asleep;
|
||||
asleep.configure(true, false);
|
||||
asleep.regs[REG_MODEM_STAT] = MODEM_STAT_HEADER_VALID;
|
||||
EXPECT_FALSE(asleep.radio.is_receiving());
|
||||
}
|
||||
|
||||
TEST(SX127xReceiving, FskFifoHoldsTheLengthByte) {
|
||||
RadioHardware hw;
|
||||
hw.configure(false, true);
|
||||
EXPECT_EQ(hw.radio.get_max_packet_size(), 63u);
|
||||
EXPECT_EQ(hw.regs[REG_PAYLOAD_LENGTH_LSB], 63);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
@@ -1,54 +0,0 @@
|
||||
#include "sx127x_test_helpers.h"
|
||||
#include "esphome/components/logger/logger.h"
|
||||
#include <string>
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
// Runs a callback for each warning logged, as a logger on_message automation would
|
||||
class LogCallback {
|
||||
public:
|
||||
LogCallback() : previous_(logger::global_logger) {
|
||||
this->logger_.pre_setup();
|
||||
this->logger_.set_log_level(ESPHOME_LOG_LEVEL_WARN);
|
||||
this->logger_.add_log_callback(this,
|
||||
[](void *instance, uint8_t level, const char *tag, const char *message, size_t len) {
|
||||
auto *self = static_cast<LogCallback *>(instance);
|
||||
if (self->callback_) {
|
||||
self->callback_(std::string(message, len));
|
||||
}
|
||||
});
|
||||
}
|
||||
~LogCallback() { logger::global_logger = this->previous_; }
|
||||
void set_callback(std::function<void(const std::string &)> callback) { this->callback_ = std::move(callback); }
|
||||
|
||||
private:
|
||||
std::function<void(const std::string &)> callback_;
|
||||
logger::Logger *previous_;
|
||||
logger::Logger logger_{0};
|
||||
};
|
||||
|
||||
// A configure() from the warning's log callback recovers the radio, and no retry is left
|
||||
// behind to reset it again later
|
||||
TEST(SX127xReentry, ConfigureFromTheFailureWarningLeavesNoRetry) {
|
||||
RadioHardware hw;
|
||||
LogCallback log;
|
||||
hw.configure(true, true);
|
||||
bool reentered = false;
|
||||
log.set_callback([&](const std::string &message) {
|
||||
if (!reentered && message.find("set Warning flag") != std::string::npos) {
|
||||
reentered = true;
|
||||
hw.stuck = false;
|
||||
hw.radio.configure();
|
||||
}
|
||||
});
|
||||
hw.stuck = true;
|
||||
hw.radio.set_mode_standby();
|
||||
ASSERT_TRUE(reentered);
|
||||
EXPECT_FALSE(hw.radio.status_has_warning());
|
||||
EXPECT_TRUE(hw.receiving());
|
||||
hw.radio.set_mode_sleep();
|
||||
run_scheduler(1100);
|
||||
EXPECT_EQ(hw.mode(), MODE_SLEEP);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
@@ -1,30 +0,0 @@
|
||||
#include "sx127x_test_helpers.h"
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
// Values from the datasheet formulas for the RadioHardware defaults (433.92 MHz, 4800 bps,
|
||||
// 5 kHz deviation, 8 symbol preamble), independent of the code under test
|
||||
static constexpr uint32_t FRF = 0x6C7AE1; // 433920000 * 2^19 / 32 MHz
|
||||
static constexpr uint16_t BITRATE = 0x1A0B; // 32 MHz / 4800, rounded
|
||||
static constexpr uint16_t FDEV = 0x0051; // 5000 * 2^19 / 32 MHz
|
||||
static constexpr uint16_t PREAMBLE = 8;
|
||||
|
||||
static uint32_t reg16(const RadioHardware &hw, uint8_t msb) { return (hw.regs[msb] << 8) | hw.regs[msb + 1]; }
|
||||
|
||||
TEST(SX127xRegisters, FskWritesEachByteOfTheMultiByteSettings) {
|
||||
RadioHardware hw;
|
||||
hw.configure(false, false);
|
||||
EXPECT_EQ((hw.regs[REG_FRF_MSB] << 16) | reg16(hw, REG_FRF_MID), FRF);
|
||||
EXPECT_EQ(reg16(hw, REG_BITRATE_MSB), BITRATE);
|
||||
EXPECT_EQ(reg16(hw, REG_FDEV_MSB), FDEV);
|
||||
EXPECT_EQ(reg16(hw, REG_PREAMBLE_SIZE_MSB), PREAMBLE);
|
||||
}
|
||||
|
||||
TEST(SX127xRegisters, LoraWritesEachByteOfTheMultiByteSettings) {
|
||||
RadioHardware hw;
|
||||
hw.configure(true, false);
|
||||
EXPECT_EQ((hw.regs[REG_FRF_MSB] << 16) | reg16(hw, REG_FRF_MID), FRF);
|
||||
EXPECT_EQ(reg16(hw, REG_PREAMBLE_LEN_MSB), PREAMBLE);
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
Loaded 100 of 112 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user