mirror of
https://github.com/esphome/esphome.git
synced 2026-11-16 10:06:00 +00:00
Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0f1f82ab6c | ||
|
|
c6f330458a | ||
|
|
dbb4ba769a | ||
|
|
0eb4a09935 | ||
|
|
ed9e5cff58 | ||
|
|
7acd023079 | ||
|
|
5623a5d511 | ||
|
|
4f8c2239dd |
No files matched your search
@@ -651,7 +651,9 @@ 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
|
||||
@@ -663,6 +665,8 @@ 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,10 +278,9 @@ APIError APINoiseFrameHelper::state_action_client_hello_() {
|
||||
state_ = State::FAILED;
|
||||
return APIError::OUT_OF_MEMORY;
|
||||
}
|
||||
dst[0] = (uint8_t) (rx_size >> 8);
|
||||
dst[1] = (uint8_t) rx_size;
|
||||
uint8_t *payload = put_be16(dst, rx_size);
|
||||
if (rx_size > 0) {
|
||||
std::memcpy(dst + 2, this->rx_buf_.data(), rx_size);
|
||||
std::memcpy(payload, this->rx_buf_.data(), rx_size);
|
||||
}
|
||||
|
||||
#ifdef USE_API_OUTGOING_CONNECTION
|
||||
@@ -464,10 +463,8 @@ 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;
|
||||
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
|
||||
put_be16(buf_start + msg_offset, message_type);
|
||||
put_be16(buf_start + msg_offset + 2, payload_size);
|
||||
// payload data is already in the buffer starting at offset + 7
|
||||
|
||||
// Encrypt the message in place
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#include "api_overflow_buffer.h"
|
||||
#ifdef USE_API
|
||||
#include <cstring>
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::api {
|
||||
|
||||
@@ -17,7 +18,7 @@ ssize_t APIOverflowBuffer::try_drain(socket::Socket *socket) {
|
||||
|
||||
while (this->count_ > 0) {
|
||||
uint8_t *msg = this->buf_.data() + this->head_;
|
||||
size_t len = msg[0] | (msg[1] << 8);
|
||||
size_t len = encode_value_le<uint16_t>(msg);
|
||||
|
||||
ssize_t sent = socket->write(msg + LEN_PREFIX, len);
|
||||
if (sent <= 0)
|
||||
|
||||
@@ -35,7 +35,11 @@ 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.4.5")
|
||||
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")
|
||||
elif CORE.is_esp8266:
|
||||
# https://github.com/ESP32Async/ESPAsyncTCP
|
||||
cg.add_library("ESP32Async/ESPAsyncTCP", "2.0.0")
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
#include <algorithm>
|
||||
#include <cstring>
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::ble_device_base {
|
||||
|
||||
@@ -163,8 +164,7 @@ 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};
|
||||
blk[0] = static_cast<uint8_t>((aad_len >> 8) & 0xff);
|
||||
blk[1] = static_cast<uint8_t>(aad_len & 0xff);
|
||||
put_be16(blk, aad_len);
|
||||
size_t ai = 0;
|
||||
size_t pos = 2;
|
||||
while (pos < 16 && ai < aad_len)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#include "cse7761.h"
|
||||
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::cse7761 {
|
||||
|
||||
@@ -104,8 +105,7 @@ void CSE7761Component::write_(uint8_t reg, uint16_t data) {
|
||||
buffer[2] = data & 0xFF;
|
||||
len = 3;
|
||||
} else {
|
||||
buffer[2] = (data >> 8) & 0xFF;
|
||||
buffer[3] = data & 0xFF;
|
||||
put_be16(buffer + 2, data);
|
||||
len = 4;
|
||||
}
|
||||
buffer[len] = ~sum_bytes(buffer, len);
|
||||
|
||||
@@ -173,7 +173,7 @@ void DFPlayer::loop() {
|
||||
}
|
||||
// Parse valid received command
|
||||
uint8_t cmd = this->read_buffer_[3];
|
||||
uint16_t argument = (this->read_buffer_[5] << 8) | this->read_buffer_[6];
|
||||
uint16_t argument = encode_uint16(this->read_buffer_[5], 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 = (serial_number[19] << 8) + serial_number[18];
|
||||
crc16_check = encode_value_le<uint16_t>(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_layers,
|
||||
interface_has_layer,
|
||||
interface_packet_size,
|
||||
)
|
||||
from esphome.components.packet_interface.layers import CONF_SESSION
|
||||
@@ -103,11 +103,13 @@ 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."""
|
||||
layers = interface_layers(config[CONF_PACKET_INTERFACE])
|
||||
if CONF_TIMEOUT in config and CONF_SESSION in layers:
|
||||
if CONF_TIMEOUT in config and interface_has_layer(
|
||||
config[CONF_PACKET_INTERFACE], CONF_SESSION
|
||||
):
|
||||
raise cv.Invalid(
|
||||
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",
|
||||
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",
|
||||
path=[CONF_TIMEOUT],
|
||||
)
|
||||
return config
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include <cstring>
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::entity_transport {
|
||||
|
||||
@@ -373,8 +374,7 @@ 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);
|
||||
record[0] = tag;
|
||||
record[1] = tag >> 8;
|
||||
put_le16(record, tag);
|
||||
return size;
|
||||
}
|
||||
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
#include "inkbird_ibsth1_mini.h"
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::inkbird_ibsth1_mini {
|
||||
|
||||
@@ -82,7 +83,7 @@ bool InkbirdIbstH1Mini::parse_device(const ble_device_base::ESPBTDevice &device)
|
||||
}
|
||||
|
||||
auto battery_level = mnf_data.data[5];
|
||||
auto humidity = ((mnf_data.data[1] << 8) + mnf_data.data[0]) / 100.0f;
|
||||
auto humidity = encode_value_le<uint16_t>(mnf_data.data.data()) / 100.0f;
|
||||
|
||||
// Send temperature only if the value is set
|
||||
if (!std::isnan(temperature) && this->temperature_sensor_ != nullptr) {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "modbus_helpers.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
#include "esphome/core/log.h"
|
||||
|
||||
#include <algorithm>
|
||||
@@ -471,7 +472,7 @@ PduBuffer create_client_pdu(FunctionCode function_code, uint16_t start_address,
|
||||
values[1]);
|
||||
return pdu;
|
||||
}
|
||||
append_pdu_header(pdu, function_code, start_address, uint16_t((values[0] << 8) | values[1]));
|
||||
append_pdu_header(pdu, function_code, start_address, encode_uint16(values[0], values[1]));
|
||||
return pdu;
|
||||
}
|
||||
// The quantity is spec-bounded above, so the data length just has to agree with it exactly
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
from collections.abc import Callable
|
||||
from collections.abc import Callable, Iterator
|
||||
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
|
||||
from esphome.const import CONF_ID, CONF_TIMEOUT
|
||||
from esphome.core import CORE, ID
|
||||
from esphome.cpp_generator import MockObj, MockObjClass
|
||||
import esphome.final_validate as fv
|
||||
@@ -19,16 +19,20 @@ 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"
|
||||
@@ -40,6 +44,9 @@ 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(),
|
||||
@@ -48,6 +55,7 @@ LINK_LAYER_SCHEMAS = {
|
||||
__all__ = [
|
||||
"CONF_MAX_PACKET_SIZE",
|
||||
"CONF_PACKET_INTERFACE",
|
||||
"interface_has_layer",
|
||||
"interface_layers",
|
||||
"interface_packet_size",
|
||||
"PacketInterface",
|
||||
@@ -142,6 +150,14 @@ 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."""
|
||||
|
||||
@@ -158,25 +174,73 @@ 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, 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,
|
||||
}
|
||||
"""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
|
||||
)
|
||||
.extend(cv.COMPONENT_SCHEMA)
|
||||
.add_extra(_validate_layers)
|
||||
)
|
||||
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)
|
||||
|
||||
|
||||
async def new_packet_interface(config: ConfigType, *args: Any) -> MockObj:
|
||||
|
||||
@@ -88,8 +88,12 @@ 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)) {
|
||||
// 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);
|
||||
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);
|
||||
}
|
||||
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_)
|
||||
if (this->vn_ == this->vs_ || (this->resend_held_ && this->vn_ != this->va_))
|
||||
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,6 +178,15 @@ 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_();
|
||||
}
|
||||
@@ -213,8 +222,8 @@ void HdlcReliability::on_timeout_() {
|
||||
return;
|
||||
}
|
||||
this->retries_++;
|
||||
ESP_LOGV(TAG, "%s: Timeout, resending %u frames", this->name_, this->outstanding_());
|
||||
this->resend_outstanding_();
|
||||
ESP_LOGV(TAG, "%s: Timeout, resending frame %u, %u unacknowledged", this->name_, this->va_, this->outstanding_());
|
||||
this->resend_oldest_();
|
||||
this->start_timer_();
|
||||
}
|
||||
|
||||
@@ -228,6 +237,7 @@ 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_();
|
||||
@@ -262,6 +272,11 @@ 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 {
|
||||
@@ -283,7 +298,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 = frame[length + 1] | (frame[length + 2] << 8);
|
||||
uint16_t crc = encode_value_le<uint16_t>(frame.data() + length + 1);
|
||||
if (frame_crc(control, payload, length) != crc) {
|
||||
ESP_LOGV(TAG, "%s: CRC error, frame dropped", this->name_);
|
||||
this->note_received_(false);
|
||||
|
||||
@@ -17,7 +17,8 @@ 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.
|
||||
* Unacknowledged frames are resent after the timeout; after max_retries the link is reset.
|
||||
* 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.
|
||||
*/
|
||||
class HdlcReliability : public PacketInterface {
|
||||
public:
|
||||
@@ -63,6 +64,7 @@ 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);
|
||||
@@ -96,6 +98,7 @@ 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,19 +176,24 @@ def stack_schema() -> dict:
|
||||
return {cv.Optional(kind.key): kind.schema() for kind in STACK_ORDER}
|
||||
|
||||
|
||||
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
|
||||
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."""
|
||||
for kind in STACK_ORDER:
|
||||
if (layer := config.get(kind.key)) is not None and kind.get_type(
|
||||
layer
|
||||
).needs_session(layer):
|
||||
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],
|
||||
)
|
||||
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],
|
||||
)
|
||||
|
||||
|
||||
def check_single_peer(config: ConfigType, destination: int) -> None:
|
||||
|
||||
@@ -22,18 +22,25 @@ 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 _ack_delay_within_timeout(config: ConfigType) -> ConfigType:
|
||||
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
|
||||
>= config[CONF_TIMEOUT].total_milliseconds
|
||||
):
|
||||
if config[CONF_ACK_DELAY].total_milliseconds >= timeout.total_milliseconds:
|
||||
raise cv.Invalid(
|
||||
f"Must be shorter than '{CONF_TIMEOUT}'", path=[CONF_ACK_DELAY]
|
||||
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)
|
||||
return config
|
||||
|
||||
|
||||
@@ -42,7 +49,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, default="200ms"): cv.All(
|
||||
cv.Optional(CONF_TIMEOUT): cv.All(
|
||||
cv.positive_time_period_milliseconds,
|
||||
cv.Range(min=cv.TimePeriod(milliseconds=50)),
|
||||
),
|
||||
@@ -76,7 +83,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[CONF_TIMEOUT]))
|
||||
cg.add(var.set_ack_timeout(config.get(CONF_TIMEOUT, DEFAULT_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)
|
||||
|
||||
@@ -0,0 +1,64 @@
|
||||
#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
|
||||
@@ -0,0 +1,70 @@
|
||||
#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
|
||||
@@ -0,0 +1,101 @@
|
||||
#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
|
||||
@@ -0,0 +1,311 @@
|
||||
"""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,6 +46,8 @@ 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,42 +434,31 @@ 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());
|
||||
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);
|
||||
uint8_t *p = buf;
|
||||
*p++ = '$';
|
||||
*p++ = 0; // interleaved channel 0
|
||||
p = put_be16(p, rtp_len);
|
||||
|
||||
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_);
|
||||
*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_);
|
||||
this->sequence_number_++;
|
||||
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_);
|
||||
p = put_be32(p, this->rtp_timestamp_);
|
||||
p = put_be32(p, this->ssrc_);
|
||||
|
||||
// RFC 2435 main JPEG header
|
||||
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);
|
||||
*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);
|
||||
|
||||
uint8_t count = 0;
|
||||
if (first_fragment) {
|
||||
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);
|
||||
*p++ = 0; // MBZ
|
||||
*p++ = 0; // 8-bit precision
|
||||
put_be16(p, 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,11 +145,9 @@ 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_) {
|
||||
this->buffer_[pos + 0] = static_cast<uint8_t>((rgb565 >> 8) & 0xFF);
|
||||
this->buffer_[pos + 1] = static_cast<uint8_t>(rgb565 & 0xFF);
|
||||
put_be16(this->buffer_ + pos, rgb565);
|
||||
} else {
|
||||
this->buffer_[pos + 0] = static_cast<uint8_t>(rgb565 & 0xFF);
|
||||
this->buffer_[pos + 1] = static_cast<uint8_t>((rgb565 >> 8) & 0xFF);
|
||||
put_le16(this->buffer_ + pos, rgb565);
|
||||
}
|
||||
if (this->transparency_ == image::TRANSPARENCY_ALPHA_CHANNEL) {
|
||||
const size_t alpha_pos = pos / 2 + this->buffer_width_ * this->buffer_height_ * 2;
|
||||
|
||||
@@ -48,17 +48,16 @@ bool SensirionI2CDevice::write_command_(uint16_t command, CommandLen command_len
|
||||
temp[raw_idx++] = command & 0xFF;
|
||||
} else {
|
||||
// command is 2 bytes
|
||||
temp[raw_idx++] = command >> 8;
|
||||
temp[raw_idx++] = command & 0xFF;
|
||||
put_be16(temp, command);
|
||||
raw_idx = 2;
|
||||
}
|
||||
// add parameters followed by crc
|
||||
// skipped if len == 0
|
||||
for (size_t i = 0; i < data_len; i++) {
|
||||
temp[raw_idx++] = data[i] >> 8;
|
||||
temp[raw_idx++] = data[i] & 0xFF;
|
||||
put_be16(temp + raw_idx, data[i]);
|
||||
// Use MSB first since Sensirion devices use CRC-8 with MSB first
|
||||
uint8_t crc = crc8(&temp[raw_idx - 2], 2, 0xFF, CRC_POLYNOMIAL, true);
|
||||
temp[raw_idx++] = crc;
|
||||
temp[raw_idx + 2] = crc8(temp + raw_idx, 2, 0xFF, CRC_POLYNOMIAL, true);
|
||||
raw_idx += 3;
|
||||
}
|
||||
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 = (buf[1] << 8) | buf[2];
|
||||
stm->pid = encode_uint16(buf[1], 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 = (buf[0] << 24) | (buf[1] << 16) | (buf[2] << 8) | buf[3];
|
||||
*crc = encode_uint32(buf[0], buf[1], buf[2], buf[3]);
|
||||
}
|
||||
|
||||
return STM32_ERR_OK;
|
||||
|
||||
@@ -123,8 +123,7 @@ 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;
|
||||
this->buffer_[pos++] = (color565 >> 8) & 0xff;
|
||||
this->buffer_[pos] = color565 & 0xff;
|
||||
put_be16(this->buffer_ + pos, color565);
|
||||
}
|
||||
void SSD1331::fill(Color color) {
|
||||
// If clipping is active, fall back to base implementation
|
||||
|
||||
@@ -155,8 +155,7 @@ 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;
|
||||
this->buffer_[pos++] = (color565 >> 8) & 0xff;
|
||||
this->buffer_[pos] = color565 & 0xff;
|
||||
put_be16(this->buffer_ + pos, color565);
|
||||
}
|
||||
void SSD1351::fill(Color color) {
|
||||
// If clipping is active, fall back to base implementation
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
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)
|
||||
@@ -0,0 +1,10 @@
|
||||
#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,6 +99,8 @@ 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,9 +61,7 @@ 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;
|
||||
buf[1] = (delay >> 16) & 0xFF;
|
||||
buf[2] = (delay >> 8) & 0xFF;
|
||||
buf[3] = (delay >> 0) & 0xFF;
|
||||
put_be24(buf + 1, delay);
|
||||
this->write_opcode_(RADIO_SET_TCXOMODE, buf, 4);
|
||||
buf[0] = 0x7F;
|
||||
this->write_opcode_(RADIO_CALIBRATE, buf, 1);
|
||||
@@ -99,10 +97,7 @@ ConfigurationResult SX126xCommands::configure(const RadioProfile &profile, std::
|
||||
|
||||
// set frequency
|
||||
uint64_t freq = ((uint64_t) profile.frequency << 25) / XTAL_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);
|
||||
put_be32(buf, static_cast<uint32_t>(freq));
|
||||
this->write_opcode_(RADIO_SET_RFFREQUENCY, buf, 4);
|
||||
|
||||
// configure pa
|
||||
@@ -152,23 +147,17 @@ 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;
|
||||
buf[0] = (bitrate >> 16) & 0xFF;
|
||||
buf[1] = (bitrate >> 8) & 0xFF;
|
||||
buf[2] = (bitrate >> 0) & 0xFF;
|
||||
put_be24(buf, bitrate);
|
||||
buf[3] = profile.shaping;
|
||||
buf[4] = progmem_read_byte(&BW_FSK[profile.bandwidth - SX126X_BW_4800]);
|
||||
buf[5] = (fdev >> 16) & 0xFF;
|
||||
buf[6] = (fdev >> 8) & 0xFF;
|
||||
buf[7] = (fdev >> 0) & 0xFF;
|
||||
put_be24(buf + 5, fdev);
|
||||
this->write_opcode_(RADIO_SET_MODULATIONPARAMS, buf, 8);
|
||||
|
||||
// set crc params
|
||||
if (profile.crc_enable) {
|
||||
buf[0] = profile.crc_initial >> 8;
|
||||
buf[1] = profile.crc_initial & 0xFF;
|
||||
put_be16(buf, profile.crc_initial);
|
||||
this->write_register_(REG_CRC_INITIAL, buf, 2);
|
||||
buf[0] = profile.crc_polynomial >> 8;
|
||||
buf[1] = profile.crc_polynomial & 0xFF;
|
||||
put_be16(buf, profile.crc_polynomial);
|
||||
this->write_register_(REG_CRC_POLYNOMIAL, buf, 2);
|
||||
}
|
||||
|
||||
@@ -203,8 +192,7 @@ 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) {
|
||||
buf[0] = (profile.preamble_size >> 8) & 0xFF;
|
||||
buf[1] = (profile.preamble_size >> 0) & 0xFF;
|
||||
put_be16(buf.data(), profile.preamble_size);
|
||||
buf[2] = (profile.payload_length > 0) ? 0x01 : 0x00;
|
||||
buf[3] = payload_length;
|
||||
buf[4] = (profile.crc_enable) ? 0x01 : 0x00;
|
||||
@@ -212,8 +200,7 @@ void SX126xCommands::encode_packet_params(const RadioProfile &profile, AppliedPr
|
||||
applied.packet_params_size = 6;
|
||||
} else {
|
||||
uint16_t preamble_size = profile.preamble_size * 8;
|
||||
buf[0] = (preamble_size >> 8) & 0xFF;
|
||||
buf[1] = (preamble_size >> 0) & 0xFF;
|
||||
put_be16(buf.data(), preamble_size);
|
||||
buf[2] = (profile.preamble_detect > 0) ? ((profile.preamble_detect - 1) | 0x04) : 0x00;
|
||||
buf[3] = profile.sync_size * 8;
|
||||
buf[4] = 0x00;
|
||||
@@ -259,20 +246,22 @@ void SX126xCommands::calibrate_image(uint32_t frequency) {
|
||||
}
|
||||
}
|
||||
|
||||
void SX126xCommands::receive() {
|
||||
// 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];
|
||||
|
||||
// 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;
|
||||
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[3];
|
||||
|
||||
// set timeout to 0
|
||||
buf[0] = 0x00;
|
||||
@@ -286,24 +275,12 @@ void SX126xCommands::receive() {
|
||||
}
|
||||
|
||||
void SX126xCommands::transmit(uint32_t timeout_ms) {
|
||||
uint8_t buf[8];
|
||||
this->set_dio_irq_params_(IRQ_TX_DONE | IRQ_RX_TX_TIMEOUT, IRQ_TX_DONE | IRQ_RX_TX_TIMEOUT);
|
||||
|
||||
// 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);
|
||||
uint8_t buf[3];
|
||||
|
||||
const uint32_t ticks = timeout_ms * 64;
|
||||
buf[0] = ticks >> 16;
|
||||
buf[1] = ticks >> 8;
|
||||
buf[2] = ticks;
|
||||
put_be24(buf, ticks);
|
||||
this->write_opcode_(RADIO_SET_TX, buf, 3);
|
||||
}
|
||||
|
||||
|
||||
@@ -41,6 +41,7 @@ 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,6 +195,26 @@ 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,6 +104,9 @@ 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);
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
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)
|
||||
@@ -0,0 +1,10 @@
|
||||
#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,12 +1,27 @@
|
||||
#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,
|
||||
@@ -47,35 +62,86 @@ void SX127x::read_fifo_(std::vector<uint8_t> &packet) {
|
||||
this->disable();
|
||||
}
|
||||
|
||||
void SX127x::write_fifo_(const uint8_t *data, size_t len) {
|
||||
// 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) {
|
||||
this->enable();
|
||||
this->write_byte(REG_FIFO | 0x80);
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
this->transfer_byte(data[i]);
|
||||
}
|
||||
this->write_byte(reg | 0x80);
|
||||
this->write_array(data, len);
|
||||
this->disable();
|
||||
}
|
||||
|
||||
void IRAM_ATTR SX127x::gpio_intr(SX127x *arg) { arg->enable_loop_soon_any_context(); }
|
||||
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 SX127x::setup() {
|
||||
// setup reset
|
||||
this->rst_pin_->setup();
|
||||
|
||||
// setup dio0
|
||||
if (this->dio0_pin_) {
|
||||
if (this->dio0_pin_ != nullptr) {
|
||||
this->dio0_pin_->setup();
|
||||
this->dio0_pin_->attach_interrupt(&SX127x::gpio_intr, this, gpio::INTERRUPT_RISING_EDGE);
|
||||
if (this->dio0_pin_->is_internal()) {
|
||||
static_cast<InternalGPIOPin *>(this->dio0_pin_)
|
||||
->attach_interrupt(&SX127x::gpio_intr, this, gpio::INTERRUPT_RISING_EDGE);
|
||||
}
|
||||
}
|
||||
|
||||
// start spi
|
||||
this->spi_setup();
|
||||
|
||||
// configure rf
|
||||
this->configure();
|
||||
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());
|
||||
}
|
||||
|
||||
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);
|
||||
@@ -84,35 +150,42 @@ void SX127x::configure() {
|
||||
|
||||
// check silicon version to make sure hw is ok
|
||||
if (this->read_register_(REG_VERSION) != 0x12) {
|
||||
this->mark_failed(LOG_STR("Unsupported chip version"));
|
||||
return;
|
||||
return LOG_STR("Unsupported chip version");
|
||||
}
|
||||
|
||||
// enter sleep mode
|
||||
this->set_mode_(MOD_FSK, MODE_SLEEP);
|
||||
if (!this->set_mode_(MOD_FSK, MODE_SLEEP)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
|
||||
// set freq
|
||||
uint64_t frf = ((uint64_t) this->frequency_ << 19) / FXOSC;
|
||||
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));
|
||||
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));
|
||||
|
||||
// enter standby mode
|
||||
this->set_mode_(MOD_FSK, MODE_STDBY);
|
||||
if (!this->set_mode_(MOD_FSK, MODE_STDBY)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
|
||||
// run image cal
|
||||
this->run_image_cal();
|
||||
const LogString *reason = this->image_cal_();
|
||||
if (reason != nullptr) {
|
||||
return reason;
|
||||
}
|
||||
|
||||
// go back to sleep
|
||||
this->set_mode_sleep();
|
||||
if (!this->set_mode_(this->modulation_, MODE_SLEEP)) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
|
||||
// config pa
|
||||
if (this->pa_pin_ == PA_PIN_BOOST) {
|
||||
this->pa_power_ = std::max(this->pa_power_, (uint8_t) 2);
|
||||
this->pa_power_ = std::min(this->pa_power_, (uint8_t) 17);
|
||||
this->pa_power_ = clamp(this->pa_power_, (uint8_t) 2, (uint8_t) 17);
|
||||
this->write_register_(REG_PA_CONFIG, (this->pa_power_ - 2) | this->pa_pin_ | PA_MAX_POWER);
|
||||
} else {
|
||||
this->pa_power_ = std::min(this->pa_power_, (uint8_t) 14);
|
||||
this->pa_power_ = clamp_at_most(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) {
|
||||
@@ -129,11 +202,10 @@ void SX127x::configure() {
|
||||
}
|
||||
|
||||
// switch to rx or sleep
|
||||
if (this->rx_start_) {
|
||||
this->set_mode_rx();
|
||||
} else {
|
||||
this->set_mode_sleep();
|
||||
if (!this->restore_()) {
|
||||
return set_mode_failure();
|
||||
}
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void SX127x::configure_fsk_ook_() {
|
||||
@@ -141,14 +213,12 @@ void SX127x::configure_fsk_ook_() {
|
||||
this->write_register_(REG_RX_BW, progmem_read_byte(&BW_FSK_OOK[this->bandwidth_]));
|
||||
|
||||
// set 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));
|
||||
uint16_t fdev = clamp_at_most((this->deviation_ * 4096) / 250000, uint32_t{0x3FFF});
|
||||
this->write_register16_(REG_FDEV_MSB, fdev);
|
||||
|
||||
// set 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));
|
||||
uint16_t bitrate = (FXOSC + this->bitrate_ / 2) / this->bitrate_; // round up
|
||||
this->write_register16_(REG_BITRATE_MSB, bitrate);
|
||||
|
||||
// configure rx and afc
|
||||
this->write_register_(REG_AFC_BW, progmem_read_byte(&BW_FSK_OOK[this->afc_bandwidth_]));
|
||||
@@ -168,7 +238,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() - 1);
|
||||
this->write_register_(REG_PAYLOAD_LENGTH_LSB, this->get_max_packet_size());
|
||||
this->write_register_(REG_PACKET_CONFIG_1, crc_mode | VARIABLE_LENGTH);
|
||||
}
|
||||
this->write_register_(REG_PACKET_CONFIG_2, PACKET_MODE);
|
||||
@@ -197,8 +267,7 @@ void SX127x::configure_fsk_ook_() {
|
||||
} else {
|
||||
this->write_register_(REG_PREAMBLE_DETECT, PREAMBLE_DETECTOR_OFF);
|
||||
}
|
||||
this->write_register_(REG_PREAMBLE_SIZE_MSB, this->preamble_size_ >> 8);
|
||||
this->write_register_(REG_PREAMBLE_SIZE_LSB, this->preamble_size_ & 0xFF);
|
||||
this->write_register16_(REG_PREAMBLE_SIZE_MSB, this->preamble_size_);
|
||||
|
||||
// config sync generation and setup ook threshold
|
||||
uint8_t bitsync = this->bitsync_ ? BIT_SYNC_ON : BIT_SYNC_OFF;
|
||||
@@ -226,8 +295,7 @@ void SX127x::configure_lora_() {
|
||||
|
||||
// config preamble
|
||||
if (this->preamble_size_ >= 6) {
|
||||
this->write_register_(REG_PREAMBLE_LEN_MSB, this->preamble_size_ >> 8);
|
||||
this->write_register_(REG_PREAMBLE_LEN_LSB, this->preamble_size_ & 0xFF);
|
||||
this->write_register16_(REG_PREAMBLE_LEN_MSB, this->preamble_size_);
|
||||
}
|
||||
|
||||
// optimize detection
|
||||
@@ -252,70 +320,167 @@ void SX127x::configure_lora_() {
|
||||
}
|
||||
|
||||
size_t SX127x::get_max_packet_size() {
|
||||
if (this->payload_length_ > 0) {
|
||||
return this->payload_length_;
|
||||
if (this->applied_.payload_length > 0) {
|
||||
return this->applied_.payload_length;
|
||||
}
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
if (this->applied_.modulation == MOD_LORA) {
|
||||
return SX127X_MAX_PACKET_SIZE;
|
||||
}
|
||||
return 64;
|
||||
// The 64 byte FIFO also holds the length byte
|
||||
return 63;
|
||||
}
|
||||
|
||||
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()) {
|
||||
ESP_LOGW(TAG, "Radio not ready, packet dropped");
|
||||
if (!this->is_ready() || this->state_ == RadioState::RADIO_STATE_NEEDS_CONFIGURATION) {
|
||||
return SX127xError::SX127X_ERROR_NOT_READY;
|
||||
}
|
||||
if (this->payload_length_ > 0 && this->payload_length_ != len) {
|
||||
ESP_LOGE(TAG, "Packet size does not match config");
|
||||
return SX127xError::INVALID_PARAMS;
|
||||
if (this->state_ != RadioState::RADIO_STATE_IDLE) {
|
||||
return SX127xError::SX127X_ERROR_BUSY;
|
||||
}
|
||||
if (len == 0 || len > this->get_max_packet_size()) {
|
||||
ESP_LOGE(TAG, "Packet size out of range");
|
||||
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 (this->dio0_pin_ == nullptr) {
|
||||
ESP_LOGE(TAG, "DIO0 pin not configured, cannot wait for transmit completion");
|
||||
return SX127xError::INVALID_PARAMS;
|
||||
return SX127xError::SX127X_ERROR_INVALID_PARAMS;
|
||||
}
|
||||
|
||||
SX127xError ret = SX127xError::NONE;
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_standby();
|
||||
if (this->payload_length_ == 0) {
|
||||
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) {
|
||||
this->write_register_(REG_PAYLOAD_LENGTH, len);
|
||||
}
|
||||
this->write_register_(REG_IRQ_FLAGS, 0xFF);
|
||||
this->write_register_(REG_FIFO_ADDR_PTR, 0);
|
||||
this->write_fifo_(data, len);
|
||||
this->set_mode_tx();
|
||||
} else {
|
||||
this->set_mode_standby();
|
||||
if (this->payload_length_ == 0) {
|
||||
this->write_register_(REG_FIFO, len);
|
||||
}
|
||||
this->write_fifo_(data, len);
|
||||
this->set_mode_tx();
|
||||
} 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;
|
||||
}
|
||||
|
||||
// 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;
|
||||
}
|
||||
bool SX127x::poll_transmit_(uint32_t now, SX127xError &result) {
|
||||
if (!this->is_transmitting()) {
|
||||
return false;
|
||||
}
|
||||
if (this->rx_start_) {
|
||||
this->set_mode_rx();
|
||||
// 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;
|
||||
} else {
|
||||
this->set_mode_sleep();
|
||||
return false;
|
||||
}
|
||||
return ret;
|
||||
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;
|
||||
}
|
||||
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;
|
||||
} else {
|
||||
this->fail_(set_mode_failure());
|
||||
}
|
||||
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;
|
||||
}
|
||||
|
||||
void SX127x::call_listeners_(const std::vector<uint8_t> &packet, float rssi, float snr) {
|
||||
@@ -326,43 +491,81 @@ void SX127x::call_listeners_(const std::vector<uint8_t> &packet, float rssi, flo
|
||||
}
|
||||
|
||||
void SX127x::loop() {
|
||||
this->disable_loop();
|
||||
if (this->dio0_pin_ == nullptr || !this->dio0_pin_->digital_read()) {
|
||||
return;
|
||||
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;
|
||||
}
|
||||
}
|
||||
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
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) {
|
||||
uint8_t status = this->read_register_(REG_IRQ_FLAGS);
|
||||
this->write_register_(REG_IRQ_FLAGS, 0xFF);
|
||||
if ((status & PAYLOAD_CRC_ERROR) == 0) {
|
||||
if ((status & RX_DONE) != 0 && (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 rssi = this->read_register_(REG_PKT_RSSI_VALUE);
|
||||
int8_t snr = (int8_t) this->read_register_(REG_PKT_SNR_VALUE);
|
||||
uint8_t raw_rssi = this->read_register_(REG_PKT_RSSI_VALUE);
|
||||
int8_t raw_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_);
|
||||
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);
|
||||
}
|
||||
rssi = (float) raw_rssi - (this->applied_.frequency > 700000000 ? RSSI_OFFSET_HF : RSSI_OFFSET_LF);
|
||||
snr = (float) raw_snr / 4;
|
||||
received = true;
|
||||
}
|
||||
} else if (this->packet_mode_) {
|
||||
uint8_t payload_length = this->payload_length_;
|
||||
} else if (this->applied_.packet_mode && (this->read_register_(REG_IRQ_FLAGS2) & PAYLOAD_READY) != 0) {
|
||||
uint8_t payload_length = this->applied_.payload_length;
|
||||
if (payload_length == 0) {
|
||||
payload_length = this->read_register_(REG_FIFO);
|
||||
}
|
||||
this->packet_.resize(payload_length);
|
||||
this->read_fifo_(this->packet_);
|
||||
this->call_listeners_(this->packet_, 0.0f, 0.0f);
|
||||
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);
|
||||
}
|
||||
}
|
||||
|
||||
void SX127x::run_image_cal() {
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_(MOD_FSK, MODE_SLEEP);
|
||||
this->set_mode_(MOD_FSK, MODE_STDBY);
|
||||
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();
|
||||
}
|
||||
}
|
||||
if (this->auto_cal_) {
|
||||
this->write_register_(REG_IMAGE_CAL, IMAGE_CAL_START | AUTO_IMAGE_CAL_ON | TEMP_THRESHOLD_10C);
|
||||
@@ -372,17 +575,29 @@ void SX127x::run_image_cal() {
|
||||
uint32_t start = millis();
|
||||
while (this->read_register_(REG_IMAGE_CAL) & IMAGE_CAL_RUNNING) {
|
||||
if (millis() - start > 20) {
|
||||
this->mark_failed(LOG_STR("Image cal failure"));
|
||||
break;
|
||||
return LOG_STR("Image cal failure");
|
||||
}
|
||||
}
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
this->set_mode_(this->modulation_, MODE_SLEEP);
|
||||
this->set_mode_(this->modulation_, MODE_STDBY);
|
||||
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);
|
||||
}
|
||||
}
|
||||
|
||||
void SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
bool SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
uint32_t start = millis();
|
||||
this->write_register_(REG_OP_MODE, modulation | mode);
|
||||
while (true) {
|
||||
@@ -391,34 +606,62 @@ void SX127x::set_mode_(uint8_t modulation, uint8_t mode) {
|
||||
if (mode == MODE_SLEEP) {
|
||||
this->write_register_(REG_OP_MODE, modulation | mode);
|
||||
}
|
||||
break;
|
||||
return true;
|
||||
}
|
||||
if (millis() - start > 20) {
|
||||
this->mark_failed(LOG_STR("Set mode failure"));
|
||||
return;
|
||||
if (millis() - start > MODE_TIMEOUT_MS) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void SX127x::set_mode_rx() {
|
||||
this->set_mode_(this->modulation_, MODE_RX);
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
bool SX127x::enter_rx_() {
|
||||
if (this->applied_.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);
|
||||
}
|
||||
|
||||
void SX127x::set_mode_tx() {
|
||||
this->set_mode_(this->modulation_, MODE_TX);
|
||||
if (this->modulation_ == MOD_LORA) {
|
||||
bool SX127x::enter_tx_() {
|
||||
if (this->applied_.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);
|
||||
}
|
||||
|
||||
void SX127x::set_mode_standby() { this->set_mode_(this->modulation_, MODE_STDBY); }
|
||||
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_sleep() { this->set_mode_(this->modulation_, MODE_SLEEP); }
|
||||
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::dump_config() {
|
||||
ESP_LOGCONFIG(TAG, "SX127x:");
|
||||
|
||||
@@ -36,10 +36,35 @@ enum SX127xBw : uint8_t {
|
||||
SX127X_BW_500_0,
|
||||
};
|
||||
|
||||
enum class SX127xError { NONE = 0, TIMEOUT, INVALID_PARAMS, SX127X_ERROR_NOT_READY };
|
||||
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,
|
||||
};
|
||||
|
||||
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;
|
||||
};
|
||||
|
||||
@@ -60,8 +85,9 @@ 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(InternalGPIOPin *dio0_pin) { this->dio0_pin_ = dio0_pin; }
|
||||
void set_dio0_pin(GPIOPin *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();
|
||||
@@ -76,27 +102,72 @@ 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(InternalGPIOPin *rst_pin) { this->rst_pin_ = rst_pin; }
|
||||
void set_rst_pin(GPIOPin *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:
|
||||
static void gpio_intr(SX127x *arg);
|
||||
// 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_();
|
||||
void configure_fsk_ook_();
|
||||
void configure_lora_();
|
||||
void set_mode_(uint8_t modulation, uint8_t mode);
|
||||
void write_fifo_(const uint8_t *data, size_t len);
|
||||
// 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 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);
|
||||
@@ -105,8 +176,10 @@ class SX127x final : public Component,
|
||||
std::vector<SX127xListener *> listeners_;
|
||||
std::vector<uint8_t> packet_;
|
||||
std::vector<uint8_t> sync_value_;
|
||||
InternalGPIOPin *dio0_pin_{nullptr};
|
||||
InternalGPIOPin *rst_pin_{nullptr};
|
||||
AppliedSettings applied_;
|
||||
TxOperation tx_;
|
||||
GPIOPin *dio0_pin_{nullptr};
|
||||
GPIOPin *rst_pin_{nullptr};
|
||||
SX127xBw afc_bandwidth_{SX127X_BW_50_0};
|
||||
SX127xBw bandwidth_;
|
||||
uint32_t bitrate_;
|
||||
@@ -130,6 +203,8 @@ 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,6 +46,8 @@ 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,
|
||||
@@ -260,6 +262,22 @@ 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,
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
"""TCP links. The packet_interface platform carries packets over a TCP connection."""
|
||||
|
||||
CODEOWNERS = ["@clydebarrow"]
|
||||
DOMAIN = "tcp"
|
||||
@@ -0,0 +1,132 @@
|
||||
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)
|
||||
@@ -0,0 +1,182 @@
|
||||
#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
|
||||
@@ -0,0 +1,93 @@
|
||||
#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,6 +1,7 @@
|
||||
#include "esphome/core/log.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "uart_transport.h"
|
||||
#include "esphome/core/helpers.h"
|
||||
|
||||
namespace esphome::uart {
|
||||
|
||||
@@ -23,7 +24,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 != (this->receive_buffer_[len - 2] | (this->receive_buffer_[len - 1] << 8))) {
|
||||
if (crc != encode_value_le<uint16_t>(this->receive_buffer_.data() + len - 2)) {
|
||||
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_ = (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];
|
||||
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);
|
||||
}
|
||||
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 = (this->buffer_[8] << 8) + this->buffer_[7];
|
||||
uint16_t id = encode_value_le<uint16_t>(this->buffer_.data() + 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,6 +220,34 @@ 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) {
|
||||
@@ -328,7 +356,13 @@ 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);
|
||||
|
||||
@@ -336,9 +370,10 @@ void DeferredUpdateEventSourceList::add_new_client(WebServer *ws, AsyncWebServer
|
||||
|
||||
es->onDisconnect([this, es](AsyncEventSourceClient *client) { this->on_client_disconnect_(es); });
|
||||
|
||||
es->handleRequest(request);
|
||||
new AsyncEventSourceClient(client, es); // NOLINT: owned by es
|
||||
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,9 +171,12 @@ 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.9.6")
|
||||
cg.add_library("ESP32Async/ESPAsyncWebServer", "3.12.1")
|
||||
|
||||
|
||||
# The DNS server used for captive portals on ESP32; other platforms use the Arduino
|
||||
|
||||
@@ -32,12 +32,9 @@ 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)
|
||||
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];
|
||||
// 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]);
|
||||
}
|
||||
#endif
|
||||
} // namespace esphome
|
||||
|
||||
+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.9.6 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; 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.9.6 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; 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.9.6 ; web_server_base
|
||||
ESP32Async/ESPAsyncWebServer@3.12.1 ; web_server_base
|
||||
esphome/wireguard@0.4.8 ; wireguard
|
||||
esphome/noise-c@0.1.31 ; noise (api, ota)
|
||||
ESP32Async/AsyncTCP@3.4.5 ; async_tcp
|
||||
ESP32Async/AsyncTCP@3.5.0 ; async_tcp
|
||||
DNSServer ; captive_portal
|
||||
heman/AsyncMqttClient-esphome@2.0.0 ; mqtt
|
||||
improv/Improv@1.2.7 ; improv_serial
|
||||
|
||||
Whitespace-only changes.
@@ -0,0 +1,20 @@
|
||||
"""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
|
||||
@@ -1,9 +1,11 @@
|
||||
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,6 +3,8 @@
|
||||
#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"
|
||||
@@ -26,6 +28,8 @@ 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;
|
||||
}
|
||||
@@ -39,6 +43,27 @@ 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 {
|
||||
@@ -167,6 +192,19 @@ 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,6 +257,65 @@ 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);
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
#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
|
||||
@@ -0,0 +1,213 @@
|
||||
#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,9 +29,11 @@ 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;
|
||||
@@ -93,6 +95,16 @@ 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);
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
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
|
||||
@@ -0,0 +1,59 @@
|
||||
#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
|
||||
@@ -0,0 +1,9 @@
|
||||
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
|
||||
@@ -0,0 +1,16 @@
|
||||
"""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
|
||||
@@ -0,0 +1,17 @@
|
||||
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
|
||||
@@ -0,0 +1,347 @@
|
||||
#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
|
||||
@@ -0,0 +1,64 @@
|
||||
#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
|
||||
@@ -0,0 +1,54 @@
|
||||
#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
|
||||
@@ -0,0 +1,30 @@
|
||||
#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
|
||||
@@ -0,0 +1,333 @@
|
||||
#pragma once
|
||||
#include <gtest/gtest.h>
|
||||
#include <array>
|
||||
#include <functional>
|
||||
#include <vector>
|
||||
#include "esphome/components/sx127x/sx127x.h"
|
||||
#include "esphome/core/application.h"
|
||||
|
||||
namespace esphome::sx127x::testing {
|
||||
|
||||
class TestPin : public GPIOPin {
|
||||
public:
|
||||
void setup() override {}
|
||||
void pin_mode(gpio::Flags flags) override {}
|
||||
gpio::Flags get_flags() const override { return gpio::FLAG_NONE; }
|
||||
size_t dump_summary(char *buffer, size_t len) const override { return snprintf(buffer, len, "test"); }
|
||||
bool digital_read() override { return this->on_read ? this->on_read() : this->level; }
|
||||
void digital_write(bool level) override {
|
||||
this->level = level;
|
||||
if (this->on_write) {
|
||||
this->on_write(level);
|
||||
}
|
||||
}
|
||||
|
||||
bool level{false};
|
||||
std::function<bool()> on_read;
|
||||
std::function<void(bool)> on_write;
|
||||
};
|
||||
|
||||
// An SX127x register file behind the real software SPI bus. The first byte of each
|
||||
// transaction is the address, with bit 7 set for a write; FIFO reads and writes stream, and
|
||||
// further bytes of any other write go to the next register.
|
||||
class RadioHardware {
|
||||
public:
|
||||
RadioHardware() {
|
||||
this->reset_();
|
||||
this->cs.level = true;
|
||||
this->cs.on_write = [this](bool high) {
|
||||
if (!high) {
|
||||
this->selected_ = true;
|
||||
this->pos_ = 0;
|
||||
this->bit_ = 0;
|
||||
this->byte_ = 0;
|
||||
} else {
|
||||
this->selected_ = false;
|
||||
}
|
||||
};
|
||||
this->miso.on_read = [this]() {
|
||||
EXPECT_TRUE(this->selected_);
|
||||
if (this->bit_ == 0) {
|
||||
this->reply_ = this->reply_byte_();
|
||||
}
|
||||
const bool bit = (this->reply_ >> (7 - this->bit_)) & 1;
|
||||
this->byte_ = (this->byte_ << 1) | this->mosi.level;
|
||||
if (++this->bit_ == 8) {
|
||||
this->byte_done_(this->byte_);
|
||||
this->byte_ = 0;
|
||||
this->bit_ = 0;
|
||||
this->pos_++;
|
||||
}
|
||||
return bit;
|
||||
};
|
||||
this->dio0.on_read = [this]() {
|
||||
this->finish_pending_send_();
|
||||
return this->dio0_level();
|
||||
};
|
||||
this->rst.on_write = [this](bool high) {
|
||||
if (!high) {
|
||||
this->reset_();
|
||||
}
|
||||
};
|
||||
this->spi.set_clk(&this->clk);
|
||||
this->spi.set_mosi(&this->mosi);
|
||||
this->spi.set_miso(&this->miso);
|
||||
// call() runs setup() and marks the bus set up, so it accepts devices
|
||||
this->spi.call();
|
||||
this->radio.set_spi_parent(&this->spi);
|
||||
this->radio.set_cs_pin(&this->cs);
|
||||
this->radio.set_dio0_pin(&this->dio0);
|
||||
this->radio.set_rst_pin(&this->rst);
|
||||
this->radio.set_frequency(433920000);
|
||||
this->radio.set_pa_pin(PA_PIN_BOOST);
|
||||
this->radio.set_pa_power(17);
|
||||
this->radio.set_pa_ramp(PA_RAMP_40);
|
||||
this->radio.set_spreading_factor(7);
|
||||
this->radio.set_coding_rate(CODING_RATE_4_5);
|
||||
this->radio.set_preamble_size(8);
|
||||
this->radio.set_crc_enable(true);
|
||||
this->radio.set_sync_value({0x12});
|
||||
this->radio.set_rx_floor(-94); // FSK setup converts it to an int, so it must be set
|
||||
}
|
||||
~RadioHardware() {
|
||||
// The configuration retry interval (id 0) must not outlive the radio
|
||||
App.scheduler.cancel_interval(&this->radio, uint32_t{0});
|
||||
this->radio.spi_teardown();
|
||||
}
|
||||
|
||||
void configure(bool lora, bool rx, bool fixed = false) {
|
||||
this->radio.set_modulation(lora ? MOD_LORA : MOD_FSK);
|
||||
this->radio.set_bandwidth(lora ? SX127X_BW_125_0 : SX127X_BW_50_0);
|
||||
this->radio.set_bitrate(4800);
|
||||
this->radio.set_deviation(5000);
|
||||
this->radio.set_packet_mode(true);
|
||||
this->radio.set_rx_start(rx);
|
||||
this->radio.set_payload_length(fixed ? 3 : 0);
|
||||
this->radio.call(); // The normal component lifecycle runs setup().
|
||||
}
|
||||
|
||||
bool lora() const { return (this->regs[REG_OP_MODE] & MOD_LORA) != 0; }
|
||||
uint8_t mode() const { return this->regs[REG_OP_MODE] & MODE_MASK; }
|
||||
bool receiving() const { return this->mode() == MODE_RX; }
|
||||
|
||||
// A packet arrives, as the chip reports it in its current modulation
|
||||
void receive(const std::vector<uint8_t> &data, bool crc_error = false) {
|
||||
this->rx_packet = data;
|
||||
this->rx_pos_ = 0;
|
||||
if (this->lora()) {
|
||||
this->irq |= RX_DONE | (crc_error ? PAYLOAD_CRC_ERROR : 0);
|
||||
} else if (!crc_error) {
|
||||
this->payload_ready = true;
|
||||
// A variable length FSK packet starts with its length
|
||||
this->fsk_length_pending_ = (this->regs[REG_PACKET_CONFIG_1] & VARIABLE_LENGTH) != 0;
|
||||
}
|
||||
}
|
||||
|
||||
bool dio0_level() const {
|
||||
if (this->lora()) {
|
||||
const uint8_t mapping = this->regs[REG_DIO_MAPPING1] & DIO0_MAPPING_11;
|
||||
return (this->irq & (mapping == DIO0_MAPPING_01 ? TX_DONE : RX_DONE)) != 0;
|
||||
}
|
||||
return this->mode() == MODE_TX ? this->packet_sent : this->payload_ready;
|
||||
}
|
||||
|
||||
SX127x radio;
|
||||
spi::SPIComponent spi;
|
||||
TestPin cs, dio0, rst, clk, mosi, miso;
|
||||
std::array<uint8_t, 128> regs{};
|
||||
std::vector<uint8_t> rx_packet{0x11, 0x22, 0x33};
|
||||
std::vector<uint8_t> packet{0x11, 0x22, 0x33};
|
||||
std::vector<uint8_t> fifo; // bytes written since the last send
|
||||
std::vector<std::vector<uint8_t>> sent;
|
||||
uint8_t irq{0};
|
||||
uint8_t version{0x12};
|
||||
bool payload_ready{false};
|
||||
bool packet_sent{false};
|
||||
// The chip completes a send as soon as it enters TX
|
||||
bool auto_complete{true};
|
||||
// Writes to the mode register are ignored, so set_mode_() times out
|
||||
bool stuck{false};
|
||||
|
||||
protected:
|
||||
void reset_() {
|
||||
this->regs.fill(0);
|
||||
this->regs[REG_OP_MODE] = MODE_STDBY;
|
||||
this->irq = 0;
|
||||
this->payload_ready = false;
|
||||
this->packet_sent = false;
|
||||
this->fifo.clear();
|
||||
}
|
||||
|
||||
uint8_t reply_byte_() {
|
||||
if (this->pos_ == 0) {
|
||||
return 0;
|
||||
}
|
||||
const uint8_t addr = this->addr_ & 0x7F;
|
||||
if (this->addr_ & 0x80) {
|
||||
return 0;
|
||||
}
|
||||
if (addr == REG_FIFO) {
|
||||
if (this->fsk_length_pending_) {
|
||||
this->fsk_length_pending_ = false;
|
||||
return this->rx_packet.size();
|
||||
}
|
||||
const uint8_t value = this->rx_pos_ < this->rx_packet.size() ? this->rx_packet[this->rx_pos_] : 0;
|
||||
this->rx_pos_++;
|
||||
if (!this->lora() && this->rx_pos_ >= this->rx_packet.size()) {
|
||||
this->payload_ready = false;
|
||||
}
|
||||
return value;
|
||||
}
|
||||
if (addr == REG_VERSION) {
|
||||
return this->version;
|
||||
}
|
||||
if (addr == REG_IRQ_FLAGS2 || (addr == REG_IRQ_FLAGS && this->lora())) {
|
||||
this->finish_pending_send_();
|
||||
}
|
||||
if (addr == REG_IRQ_FLAGS2) {
|
||||
return (this->payload_ready ? PAYLOAD_READY : 0) | (this->packet_sent ? PACKET_SENT : 0);
|
||||
}
|
||||
if (this->lora()) {
|
||||
switch (addr) {
|
||||
case REG_IRQ_FLAGS:
|
||||
return this->irq;
|
||||
case REG_NB_RX_BYTES:
|
||||
return this->rx_packet.size();
|
||||
case REG_FIFO_RX_CURR_ADDR:
|
||||
return 0;
|
||||
case REG_PKT_RSSI_VALUE:
|
||||
return 100;
|
||||
case REG_PKT_SNR_VALUE:
|
||||
return 20;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
return this->regs[addr];
|
||||
}
|
||||
|
||||
void byte_done_(uint8_t value) {
|
||||
if (this->pos_ == 0) {
|
||||
this->addr_ = value;
|
||||
return;
|
||||
}
|
||||
if (!(this->addr_ & 0x80)) {
|
||||
return;
|
||||
}
|
||||
const uint8_t addr = this->addr_ & 0x7F;
|
||||
if (addr == REG_FIFO) {
|
||||
this->fifo.push_back(value);
|
||||
return;
|
||||
}
|
||||
// As on the chip, each further byte of a burst goes to the next register
|
||||
this->addr_ = 0x80 | ((addr + 1) & 0x7F);
|
||||
if (addr == REG_OP_MODE) {
|
||||
this->write_mode_(value);
|
||||
return;
|
||||
}
|
||||
if (addr == REG_IRQ_FLAGS && this->lora()) {
|
||||
this->irq &= ~value;
|
||||
return;
|
||||
}
|
||||
if (addr == REG_FIFO_ADDR_PTR) {
|
||||
this->rx_pos_ = 0;
|
||||
}
|
||||
this->regs[addr] = value;
|
||||
}
|
||||
|
||||
void write_mode_(uint8_t value) {
|
||||
if (this->stuck) {
|
||||
return;
|
||||
}
|
||||
const uint8_t previous = this->mode();
|
||||
const uint8_t mode = value & MODE_MASK;
|
||||
// As on an SX1276, a send that is still going out can be stopped by standby or sleep only
|
||||
if (previous == MODE_TX && !this->send_done_() && mode != MODE_STDBY && mode != MODE_SLEEP) {
|
||||
return;
|
||||
}
|
||||
this->regs[REG_OP_MODE] = value;
|
||||
if (previous == MODE_TX && mode != MODE_TX) {
|
||||
this->packet_sent = false;
|
||||
this->send_pending_ = false; // Stopped before it finished
|
||||
}
|
||||
if (mode == MODE_SLEEP) {
|
||||
this->payload_ready = false;
|
||||
}
|
||||
if (mode == MODE_TX && previous != MODE_TX) {
|
||||
this->sent.push_back(this->fifo);
|
||||
this->fifo.clear();
|
||||
// Completes on the next poll, not before the mode reads back as TX
|
||||
this->send_pending_ = this->auto_complete;
|
||||
}
|
||||
}
|
||||
|
||||
bool send_done_() const { return this->lora() ? (this->irq & TX_DONE) != 0 : this->packet_sent; }
|
||||
|
||||
void finish_pending_send_() {
|
||||
if (this->send_pending_ && this->mode() == MODE_TX) {
|
||||
this->complete_send();
|
||||
}
|
||||
this->send_pending_ = false;
|
||||
}
|
||||
|
||||
public:
|
||||
// In LoRa the chip returns to standby by itself; in FSK it stays in TX
|
||||
void complete_send() {
|
||||
if (this->lora()) {
|
||||
this->irq |= TX_DONE;
|
||||
this->regs[REG_OP_MODE] = (this->regs[REG_OP_MODE] & ~MODE_MASK) | MODE_STDBY;
|
||||
} else {
|
||||
this->packet_sent = true;
|
||||
}
|
||||
}
|
||||
|
||||
protected:
|
||||
size_t pos_{0};
|
||||
size_t rx_pos_{0};
|
||||
uint8_t addr_{0};
|
||||
uint8_t bit_{0};
|
||||
uint8_t byte_{0};
|
||||
uint8_t reply_{0};
|
||||
bool selected_{false};
|
||||
bool fsk_length_pending_{false};
|
||||
bool send_pending_{false};
|
||||
};
|
||||
|
||||
class PacketListener : public SX127xListener {
|
||||
public:
|
||||
void on_packet(const std::vector<uint8_t> &packet, float rssi, float snr) override {
|
||||
this->packets.push_back(packet);
|
||||
this->rssi = rssi;
|
||||
this->snr = snr;
|
||||
if (this->on_receive) {
|
||||
this->on_receive();
|
||||
}
|
||||
}
|
||||
std::vector<std::vector<uint8_t>> packets;
|
||||
float rssi{};
|
||||
float snr{};
|
||||
std::function<void()> on_receive;
|
||||
};
|
||||
|
||||
class TransmitListener : public SX127xTransmitListener {
|
||||
public:
|
||||
void on_transmit_complete(SX127xError result) override {
|
||||
this->results.push_back(result);
|
||||
if (this->on_complete) {
|
||||
this->on_complete(result);
|
||||
}
|
||||
}
|
||||
std::vector<SX127xError> results;
|
||||
std::function<void(SX127xError)> on_complete;
|
||||
};
|
||||
|
||||
// Runs the scheduler for ms milliseconds of real time, as the main loop would
|
||||
inline void run_scheduler(uint32_t ms) {
|
||||
const uint32_t start = millis();
|
||||
while (millis() - start < ms) {
|
||||
App.scheduler.call(millis());
|
||||
delay(5);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace esphome::sx127x::testing
|
||||
@@ -0,0 +1,8 @@
|
||||
substitutions:
|
||||
cs_pin: GPIO12
|
||||
rst_pin: GPIO13
|
||||
dio0_pin: GPIO26
|
||||
|
||||
packages:
|
||||
spi: !include ../../test_build_components/common/spi/esp32-idf.yaml
|
||||
sx127x: !include common-packet-interface.yaml
|
||||
@@ -0,0 +1,18 @@
|
||||
from esphome.components import socket as socket_component
|
||||
from esphome.core import CORE
|
||||
from esphome.types import ConfigType
|
||||
from tests.testing_helpers import ComponentManifestOverride
|
||||
|
||||
|
||||
def override_manifest(manifest: ComponentManifestOverride) -> None:
|
||||
async def to_code_testing(config: ConfigType) -> None:
|
||||
socket_component.require_tcp_listener()
|
||||
# No entity platforms are configured, so count the connected sensor to emit USE_BINARY_SENSOR
|
||||
CORE.platform_counts["binary_sensor"] += 1
|
||||
|
||||
manifest.to_code = to_code_testing
|
||||
manifest.dependencies = manifest.dependencies + [
|
||||
"binary_sensor",
|
||||
"packet_interface",
|
||||
"socket",
|
||||
]
|
||||
@@ -0,0 +1,4 @@
|
||||
packet_interface:
|
||||
- platform: tcp
|
||||
role: server
|
||||
port: 6000
|
||||
@@ -0,0 +1,36 @@
|
||||
wifi:
|
||||
ssid: MySSID
|
||||
password: password1
|
||||
|
||||
packet_interface:
|
||||
- platform: tcp
|
||||
id: tcp_client_link
|
||||
host: 192.168.1.50
|
||||
port: 6060
|
||||
keep_alive: 5s
|
||||
encryption: Johnny Cash
|
||||
fragmentation:
|
||||
max_packet_size: 2048
|
||||
connected:
|
||||
name: TCP link connected
|
||||
- platform: tcp
|
||||
id: tcp_server_link
|
||||
role: server
|
||||
port: 6061
|
||||
allowed_ips:
|
||||
- 192.168.1.0/24
|
||||
|
||||
sensor:
|
||||
- platform: template
|
||||
id: tcp_sensor
|
||||
lambda: return 1.0;
|
||||
|
||||
packet_transport:
|
||||
- platform: packet_interface
|
||||
packet_interface: tcp_client_link
|
||||
sensors:
|
||||
- tcp_sensor
|
||||
- platform: packet_interface
|
||||
packet_interface: tcp_server_link
|
||||
sensors:
|
||||
- tcp_sensor
|
||||
@@ -0,0 +1,358 @@
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
#include <csignal>
|
||||
#include <cstddef>
|
||||
#include <fcntl.h>
|
||||
#include <cstdint>
|
||||
#include <memory>
|
||||
#include <netinet/in.h>
|
||||
#include <sys/socket.h>
|
||||
#include <unistd.h>
|
||||
#include <vector>
|
||||
|
||||
#include "esphome/components/tcp/packet_interface/tcp_packet_interface.h"
|
||||
#include "esphome/core/application.h"
|
||||
#include "esphome/core/wake.h"
|
||||
|
||||
#ifdef USE_HOST
|
||||
|
||||
namespace esphome::tcp::testing {
|
||||
|
||||
// Copies a packet into a vector, for comparing in tests
|
||||
static std::vector<uint8_t> to_vector(const esphome::packet_interface::PacketBuffer &data) {
|
||||
std::vector<uint8_t> result(data.size());
|
||||
data.copy_to(result.data(), result.size());
|
||||
return result;
|
||||
}
|
||||
|
||||
using packet_interface::PacketBuffer;
|
||||
using packet_interface::PacketMetaData;
|
||||
using Packet = std::vector<uint8_t>;
|
||||
|
||||
// The receive buffer is a base, so it is set up before the link's constructor sees it
|
||||
struct TcpBufferStorage {
|
||||
uint8_t rx_buffer_storage[64]{};
|
||||
};
|
||||
|
||||
class TestTcp : public TcpBufferStorage, public TcpPacketInterface {
|
||||
public:
|
||||
TestTcp() : TcpPacketInterface(this->rx_buffer_storage) {
|
||||
this->set_host("peer");
|
||||
this->set_port(1);
|
||||
}
|
||||
socket::TcpClientLink &link() { return this->link_; }
|
||||
};
|
||||
|
||||
// A layer stacked on the link, to check that the session state reaches it
|
||||
class UpperLayer : public packet_interface::PacketInterface {
|
||||
public:
|
||||
explicit UpperLayer(PacketInterface *lower) : packet_interface::PacketInterface(lower->get_max_packet_size()) {
|
||||
this->stack_on_(lower, packet_interface::CAPABILITY_ENCRYPTION);
|
||||
}
|
||||
bool send_to_interface(const PacketBuffer &, const PacketMetaData &) override { return true; }
|
||||
};
|
||||
|
||||
struct End {
|
||||
End() {
|
||||
this->link.add_packet_interface_listener(
|
||||
[this](const PacketBuffer &data, const PacketMetaData &) { this->received.push_back(to_vector(data)); });
|
||||
this->link.add_on_session_state_callback([this](bool connected) { this->states.push_back(connected); });
|
||||
this->link.setup();
|
||||
}
|
||||
bool send(const Packet &data) { return this->link.send_to_interface(PacketBuffer(data), {}); }
|
||||
|
||||
TestTcp link;
|
||||
std::vector<Packet> received;
|
||||
std::vector<bool> states;
|
||||
};
|
||||
|
||||
class TcpPacketInterfaceTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
signal(SIGPIPE, SIG_IGN);
|
||||
App.~Application();
|
||||
new (&App) Application();
|
||||
static char name[] = "tcp-tests";
|
||||
static char friendly_name[] = "";
|
||||
App.pre_setup(name, sizeof(name) - 1, friendly_name, 0);
|
||||
set_time(1000);
|
||||
int fds[2];
|
||||
ASSERT_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0);
|
||||
this->a.link.link().adopt(std::make_unique<socket::Socket>(fds[0]));
|
||||
this->b.link.link().adopt(std::make_unique<socket::Socket>(fds[1]));
|
||||
this->loops(1);
|
||||
}
|
||||
void TearDown() override {
|
||||
this->a.link.link().close();
|
||||
this->b.link.link().close();
|
||||
App.~Application();
|
||||
new (&App) Application(); // later tests and the test listener use App
|
||||
}
|
||||
static void set_time(uint32_t now) { LoopBlockingGuard guard{nullptr, nullptr, now}; }
|
||||
void loops(int count) {
|
||||
for (int i = 0; i != count; i++) {
|
||||
this->a.link.loop();
|
||||
this->b.link.loop();
|
||||
}
|
||||
}
|
||||
|
||||
End a, b;
|
||||
};
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, ProvidesReliabilitySessionAndAddressing) {
|
||||
for (auto capability : {packet_interface::CAPABILITY_RELIABILITY, packet_interface::CAPABILITY_SESSION,
|
||||
packet_interface::CAPABILITY_ADDRESSING})
|
||||
EXPECT_TRUE(this->a.link.has_capability(capability));
|
||||
EXPECT_EQ(this->a.states, std::vector<bool>{true});
|
||||
EXPECT_TRUE(this->a.link.is_connected());
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, PacketsBothWays) {
|
||||
Packet big(64);
|
||||
for (size_t i = 0; i != big.size(); i++)
|
||||
big[i] = i;
|
||||
ASSERT_TRUE(this->a.send({1, 2, 3}));
|
||||
ASSERT_TRUE(this->a.send(big));
|
||||
ASSERT_TRUE(this->b.send({9}));
|
||||
this->loops(3);
|
||||
EXPECT_EQ(this->b.received, (std::vector<Packet>{{1, 2, 3}, big}));
|
||||
EXPECT_EQ(this->a.received, std::vector<Packet>{{9}});
|
||||
EXPECT_FALSE(this->a.send(Packet(65)));
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, SessionReachesLayersAbove) {
|
||||
UpperLayer upper(&this->a.link);
|
||||
std::vector<bool> states;
|
||||
upper.add_on_session_state_callback([&states](bool connected) { states.push_back(connected); });
|
||||
EXPECT_TRUE(upper.has_capability(packet_interface::CAPABILITY_SESSION));
|
||||
this->b.link.link().close(); // the peer goes away
|
||||
this->loops(3);
|
||||
EXPECT_EQ(states, std::vector<bool>{false});
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, KeepAliveKeepsIdleLinkUp) {
|
||||
for (uint32_t now = 1000; now <= 61000; now += 5000) {
|
||||
set_time(now);
|
||||
this->loops(2);
|
||||
}
|
||||
EXPECT_TRUE(this->a.link.is_connected());
|
||||
EXPECT_TRUE(this->b.link.is_connected());
|
||||
EXPECT_TRUE(this->a.received.empty()); // keep-alives are not passed up
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, SilentPeerClosesLink) {
|
||||
set_time(1000 + 30001);
|
||||
this->a.link.loop(); // b has sent nothing for the default timeout of 30 s
|
||||
EXPECT_FALSE(this->a.link.is_connected());
|
||||
EXPECT_EQ(this->a.states, (std::vector<bool>{true, false}));
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, SlowerPeerMatchedByTimeout) {
|
||||
// b sends keep-alives every 20 s; three of a's own 5 s intervals would close the link
|
||||
this->a.link.set_keep_alive(5000);
|
||||
this->a.link.set_receive_timeout(60000);
|
||||
this->b.link.set_keep_alive(20000);
|
||||
this->b.link.set_receive_timeout(60000);
|
||||
for (uint32_t now = 1000; now <= 121000; now += 5000) {
|
||||
set_time(now);
|
||||
this->loops(2);
|
||||
}
|
||||
EXPECT_TRUE(this->a.link.is_connected());
|
||||
EXPECT_TRUE(this->b.link.is_connected());
|
||||
EXPECT_EQ(this->a.states, std::vector<bool>{true});
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, ConnectedSensorStartsFalse) {
|
||||
TestTcp link;
|
||||
binary_sensor::BinarySensor sensor;
|
||||
link.set_connected_binary_sensor(&sensor);
|
||||
link.setup();
|
||||
EXPECT_TRUE(sensor.has_state());
|
||||
EXPECT_FALSE(sensor.state);
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, OversizedLengthClosesLink) {
|
||||
End c;
|
||||
int fds[2];
|
||||
ASSERT_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0);
|
||||
c.link.link().adopt(std::make_unique<socket::Socket>(fds[0]));
|
||||
c.link.loop();
|
||||
uint8_t header[2] = {0xFF, 0x00}; // 255 bytes, more than 64
|
||||
ASSERT_EQ(::write(fds[1], header, sizeof(header)), 2);
|
||||
c.link.loop();
|
||||
EXPECT_FALSE(c.link.is_connected());
|
||||
EXPECT_EQ(c.states, (std::vector<bool>{true, false}));
|
||||
::close(fds[1]);
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, NotSentWhileDown) {
|
||||
this->a.link.link().close();
|
||||
this->a.link.loop();
|
||||
EXPECT_FALSE(this->a.send({1}));
|
||||
}
|
||||
|
||||
// A write that fails drops the link and the packet with it, so the packet is reported as not sent
|
||||
TEST_F(TcpPacketInterfaceTest, FailedWriteReportsNotSent) {
|
||||
this->b.link.link().close();
|
||||
EXPECT_FALSE(this->a.send({1}));
|
||||
}
|
||||
|
||||
TEST_F(TcpPacketInterfaceTest, FrameAssembledAcrossReads) {
|
||||
End c;
|
||||
int fds[2];
|
||||
ASSERT_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0);
|
||||
c.link.link().adopt(std::make_unique<socket::Socket>(fds[0]));
|
||||
c.link.loop();
|
||||
// A keep-alive, then a 3 byte packet in three writes: half the length, the rest of it, then the payload
|
||||
const uint8_t keep_alive[2] = {0x00, 0x00};
|
||||
ASSERT_EQ(::write(fds[1], keep_alive, 2), 2);
|
||||
c.link.loop();
|
||||
const uint8_t length_low = 0x03;
|
||||
ASSERT_EQ(::write(fds[1], &length_low, 1), 1);
|
||||
c.link.loop();
|
||||
const uint8_t length_high_and_start[2] = {0x00, 0xAA};
|
||||
ASSERT_EQ(::write(fds[1], length_high_and_start, 2), 2);
|
||||
c.link.loop();
|
||||
EXPECT_TRUE(c.received.empty());
|
||||
const uint8_t rest[2] = {0xBB, 0xCC};
|
||||
ASSERT_EQ(::write(fds[1], rest, 2), 2);
|
||||
c.link.loop();
|
||||
EXPECT_EQ(c.received, (std::vector<Packet>{{0xAA, 0xBB, 0xCC}}));
|
||||
EXPECT_TRUE(c.link.is_connected());
|
||||
::close(fds[1]);
|
||||
}
|
||||
|
||||
// A peer that sends without a pause is read a few frames at a time, so other components still run
|
||||
TEST_F(TcpPacketInterfaceTest, FramesReadPerLoopAreLimited) {
|
||||
End c;
|
||||
int fds[2];
|
||||
ASSERT_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0);
|
||||
c.link.link().adopt(std::make_unique<socket::Socket>(fds[0]));
|
||||
c.link.loop();
|
||||
const uint8_t frame[3] = {0x01, 0x00, 0x42};
|
||||
for (int i = 0; i != 10; i++)
|
||||
ASSERT_EQ(::write(fds[1], frame, sizeof(frame)), 3);
|
||||
c.link.loop();
|
||||
EXPECT_EQ(c.received.size(), 8u);
|
||||
c.link.loop();
|
||||
EXPECT_EQ(c.received.size(), 10u);
|
||||
::close(fds[1]);
|
||||
}
|
||||
|
||||
// Once frames wait for a peer that is not reading, the capacity reported is what still fits, so a fragmented packet
|
||||
// is not started only to be cut short
|
||||
TEST_F(TcpPacketInterfaceTest, CapacityFollowsBacklog) {
|
||||
End c;
|
||||
int fds[2];
|
||||
ASSERT_EQ(socketpair(AF_UNIX, SOCK_STREAM, 0, fds), 0);
|
||||
c.link.link().adopt(std::make_unique<socket::Socket>(fds[0]));
|
||||
c.link.loop();
|
||||
EXPECT_EQ(c.link.get_send_capacity(), SIZE_MAX);
|
||||
const Packet packet(c.link.get_max_packet_size(), 0x55);
|
||||
for (int i = 0; i != 100000 && c.link.get_send_capacity() == SIZE_MAX; i++)
|
||||
c.send(packet);
|
||||
ASSERT_NE(c.link.get_send_capacity(), SIZE_MAX);
|
||||
EXPECT_LT(c.link.get_send_capacity(), 1024 / (packet.size() + 2) + 1);
|
||||
// Once the peer reads everything, the link takes what is sent again
|
||||
ASSERT_EQ(fcntl(fds[1], F_SETFL, O_NONBLOCK), 0);
|
||||
uint8_t sink[4096];
|
||||
for (int i = 0; i != 1000 && c.link.get_send_capacity() != SIZE_MAX; i++) {
|
||||
while (::read(fds[1], sink, sizeof(sink)) > 0) {
|
||||
}
|
||||
c.link.loop();
|
||||
}
|
||||
EXPECT_EQ(c.link.get_send_capacity(), SIZE_MAX);
|
||||
::close(fds[1]);
|
||||
}
|
||||
|
||||
// Waits in the main loop's select(), which marks the sockets that are ready to read
|
||||
static void wait_for_sockets() { esphome::internal::wakeable_delay(5); }
|
||||
|
||||
// The server role, accepting connections on a loopback port
|
||||
class TcpServerTest : public ::testing::Test {
|
||||
protected:
|
||||
void SetUp() override {
|
||||
signal(SIGPIPE, SIG_IGN);
|
||||
App.~Application();
|
||||
new (&App) Application();
|
||||
static char name[] = "tcp-tests";
|
||||
static char friendly_name[] = "";
|
||||
App.pre_setup(name, sizeof(name) - 1, friendly_name, 0);
|
||||
set_time(1000);
|
||||
this->port = free_port();
|
||||
this->server.link.set_server(true);
|
||||
this->server.link.set_port(this->port);
|
||||
}
|
||||
void TearDown() override {
|
||||
this->server.link.on_shutdown();
|
||||
for (int fd : this->clients)
|
||||
::close(fd);
|
||||
App.~Application();
|
||||
new (&App) Application(); // later tests and the test listener use App
|
||||
}
|
||||
static void set_time(uint32_t now) { LoopBlockingGuard guard{nullptr, nullptr, now}; }
|
||||
static uint16_t free_port() {
|
||||
int fd = ::socket(AF_INET, SOCK_STREAM, 0);
|
||||
struct sockaddr_in addr{};
|
||||
addr.sin_family = AF_INET;
|
||||
addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
|
||||
socklen_t len = sizeof(addr);
|
||||
EXPECT_EQ(::bind(fd, reinterpret_cast<struct sockaddr *>(&addr), len), 0);
|
||||
EXPECT_EQ(::getsockname(fd, reinterpret_cast<struct sockaddr *>(&addr), &len), 0);
|
||||
::close(fd);
|
||||
return ntohs(addr.sin_port);
|
||||
}
|
||||
// Connects a client and runs the server's loop until it has accepted it
|
||||
int connect_client() {
|
||||
int fd = ::socket(AF_INET, SOCK_STREAM, 0);
|
||||
struct sockaddr_in addr{};
|
||||
addr.sin_family = AF_INET;
|
||||
addr.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
|
||||
addr.sin_port = htons(this->port);
|
||||
EXPECT_EQ(::connect(fd, reinterpret_cast<struct sockaddr *>(&addr), sizeof(addr)), 0);
|
||||
this->clients.push_back(fd);
|
||||
for (int i = 0; i != 100 && !this->server.link.is_connected(); i++) {
|
||||
this->server.link.loop();
|
||||
wait_for_sockets();
|
||||
}
|
||||
return fd;
|
||||
}
|
||||
|
||||
End server;
|
||||
uint16_t port{0};
|
||||
std::vector<int> clients;
|
||||
};
|
||||
|
||||
TEST_F(TcpServerTest, AcceptsClientAndReceives) {
|
||||
this->server.link.loop(); // starts listening
|
||||
int client = this->connect_client();
|
||||
ASSERT_TRUE(this->server.link.is_connected());
|
||||
EXPECT_EQ(this->server.states, std::vector<bool>{true});
|
||||
const uint8_t frame[3] = {0x01, 0x00, 0x42};
|
||||
ASSERT_EQ(::write(client, frame, sizeof(frame)), 3);
|
||||
for (int i = 0; i != 100 && this->server.received.empty(); i++) {
|
||||
this->server.link.loop();
|
||||
wait_for_sockets();
|
||||
}
|
||||
EXPECT_EQ(this->server.received, std::vector<Packet>{{0x42}});
|
||||
}
|
||||
|
||||
TEST_F(TcpServerTest, AcceptsNextClientAfterDisconnect) {
|
||||
this->server.link.loop();
|
||||
int first = this->connect_client();
|
||||
ASSERT_TRUE(this->server.link.is_connected());
|
||||
::close(first);
|
||||
this->clients.clear();
|
||||
for (int i = 0; i != 100 && this->server.link.is_connected(); i++) {
|
||||
this->server.link.loop();
|
||||
wait_for_sockets();
|
||||
}
|
||||
EXPECT_EQ(this->server.states, (std::vector<bool>{true, false}));
|
||||
this->connect_client();
|
||||
EXPECT_TRUE(this->server.link.is_connected());
|
||||
EXPECT_EQ(this->server.states, (std::vector<bool>{true, false, true}));
|
||||
}
|
||||
|
||||
} // namespace esphome::tcp::testing
|
||||
|
||||
#endif
|
||||
@@ -0,0 +1,2 @@
|
||||
packages:
|
||||
tcp: !include common.yaml
|
||||
@@ -1,230 +1,234 @@
|
||||
{
|
||||
"tests/integration/test_action_concurrent_reentry.py": 10.97,
|
||||
"tests/integration/test_addressable_light_transition.py": 12.18,
|
||||
"tests/integration/test_alarm_control_panel_state_transitions.py": 12.65,
|
||||
"tests/integration/test_api_action_metadata.py": 10.16,
|
||||
"tests/integration/test_api_action_responses.py": 15.49,
|
||||
"tests/integration/test_api_action_timeout.py": 14.17,
|
||||
"tests/integration/test_api_conditional_memory.py": 10.47,
|
||||
"tests/integration/test_api_cover_toggle.py": 11.06,
|
||||
"tests/integration/test_api_custom_services.py": 9.09,
|
||||
"tests/integration/test_api_decode_wire_types.py": 12.55,
|
||||
"tests/integration/test_api_empty_message_roundtrip.py": 11.24,
|
||||
"tests/integration/test_api_encode_boundaries.py": 12.26,
|
||||
"tests/integration/test_api_event_order_backpressure.py": 9.95,
|
||||
"tests/integration/test_api_get_time_response_timezone.py": 11.59,
|
||||
"tests/integration/test_api_homeassistant.py": 13.82,
|
||||
"tests/integration/test_api_homeassistant_action_no_subscriber.py": 9.5,
|
||||
"tests/integration/test_api_homeassistant_binary_sensor_initial_state.py": 9.11,
|
||||
"tests/integration/test_api_homeassistant_entities.py": 9.46,
|
||||
"tests/integration/test_api_homeassistant_light.py": 35.6,
|
||||
"tests/integration/test_api_list_entities_backpressure.py": 12.99,
|
||||
"tests/integration/test_api_message_size_batching.py": 8.92,
|
||||
"tests/integration/test_api_outgoing_connection.py": 21.77,
|
||||
"tests/integration/test_api_reboot_timeout.py": 11.09,
|
||||
"tests/integration/test_api_string_lambda.py": 9.35,
|
||||
"tests/integration/test_api_vv_logging.py": 7.54,
|
||||
"tests/integration/test_api_zero_psk_provisioning.py": 19.69,
|
||||
"tests/integration/test_areas_and_devices.py": 12.79,
|
||||
"tests/integration/test_automation_merged_actions.py": 12.57,
|
||||
"tests/integration/test_automation_wait_actions.py": 7.68,
|
||||
"tests/integration/test_automations.py": 22.18,
|
||||
"tests/integration/test_batch_delay_zero_rapid_transitions.py": 13.59,
|
||||
"tests/integration/test_binary_sensor_autorepeat_filter.py": 10.51,
|
||||
"tests/integration/test_binary_sensor_delay_filters.py": 12.32,
|
||||
"tests/integration/test_binary_sensor_invalidate_state.py": 7.91,
|
||||
"tests/integration/test_blocking_warning_log_time_not_charged_to_next_operation.py": 8.66,
|
||||
"tests/integration/test_branch_resume_async.py": 13.11,
|
||||
"tests/integration/test_build_info.py": 10.18,
|
||||
"tests/integration/test_camera_mock.py": 8.88,
|
||||
"tests/integration/test_canbus_on_frame.py": 11.18,
|
||||
"tests/integration/test_climate_control_action.py": 11.73,
|
||||
"tests/integration/test_climate_custom_modes.py": 9.79,
|
||||
"tests/integration/test_continuation_actions.py": 9.17,
|
||||
"tests/integration/test_copy_cover_toggle.py": 8.78,
|
||||
"tests/integration/test_copy_entity_state.py": 8.73,
|
||||
"tests/integration/test_copy_initially_off.py": 8.45,
|
||||
"tests/integration/test_copy_lock_open.py": 11.4,
|
||||
"tests/integration/test_core_automation_order.py": 9.56,
|
||||
"tests/integration/test_cover_control_action.py": 10.08,
|
||||
"tests/integration/test_cover_position_action_cancel.py": 16.82,
|
||||
"tests/integration/test_cover_stop_tilt_cancel.py": 12.4,
|
||||
"tests/integration/test_crc8_helper.py": 8.45,
|
||||
"tests/integration/test_device_id_in_state.py": 16.78,
|
||||
"tests/integration/test_duplicate_entities.py": 10.71,
|
||||
"tests/integration/test_entity_icon.py": 10.79,
|
||||
"tests/integration/test_entity_missing_state.py": 10.32,
|
||||
"tests/integration/test_fan_turn_on_action.py": 10.68,
|
||||
"tests/integration/test_fnv1_hash_object_id.py": 7.85,
|
||||
"tests/integration/test_fnv1a_hash.py": 10.71,
|
||||
"tests/integration/test_gpio_expander_cache.py": 6.86,
|
||||
"tests/integration/test_host_logger_thread_safety.py": 8.82,
|
||||
"tests/integration/test_host_mode_basic.py": 7.93,
|
||||
"tests/integration/test_host_mode_batch_delay.py": 9.54,
|
||||
"tests/integration/test_host_mode_climate_basic_state.py": 9.48,
|
||||
"tests/integration/test_host_mode_climate_control.py": 11.44,
|
||||
"tests/integration/test_host_mode_empty_string_options.py": 9.3,
|
||||
"tests/integration/test_host_mode_entity_fields.py": 11.0,
|
||||
"tests/integration/test_host_mode_fan_preset.py": 12.9,
|
||||
"tests/integration/test_host_mode_many_entities.py": 19.93,
|
||||
"tests/integration/test_host_mode_many_entities_multiple_connections.py": 10.24,
|
||||
"tests/integration/test_host_mode_noise_encryption.py": 20.34,
|
||||
"tests/integration/test_host_mode_reconnect.py": 8.4,
|
||||
"tests/integration/test_host_mode_sensor.py": 9.84,
|
||||
"tests/integration/test_host_ota.py": 106.68,
|
||||
"tests/integration/test_host_preferences.py": 9.21,
|
||||
"tests/integration/test_host_preferences_suspend_resume.py": 12.71,
|
||||
"tests/integration/test_host_write_after_peer_close.py": 8.15,
|
||||
"tests/integration/test_improv_serial_uart.py": 10.83,
|
||||
"tests/integration/test_in_range_conditions.py": 9.25,
|
||||
"tests/integration/test_includes_lambda_order.py": 9.19,
|
||||
"tests/integration/test_interval_startup_delay.py": 10.02,
|
||||
"tests/integration/test_ir_rf_transmit_complete.py": 14.13,
|
||||
"tests/integration/test_large_message_batching.py": 8.48,
|
||||
"tests/integration/test_legacy_area.py": 8.56,
|
||||
"tests/integration/test_light_automations.py": 10.6,
|
||||
"tests/integration/test_light_binary_effect_off_phase.py": 15.66,
|
||||
"tests/integration/test_light_calls.py": 15.34,
|
||||
"tests/integration/test_light_constant_brightness.py": 10.13,
|
||||
"tests/integration/test_light_control_action.py": 9.62,
|
||||
"tests/integration/test_light_dim_relative_action.py": 10.79,
|
||||
"tests/integration/test_light_effect_cycle_action.py": 11.64,
|
||||
"tests/integration/test_light_effect_zero_brightness.py": 12.02,
|
||||
"tests/integration/test_light_initial_state.py": 13.36,
|
||||
"tests/integration/test_light_repeat_effect.py": 20.4,
|
||||
"tests/integration/test_light_restore_state.py": 4.1,
|
||||
"tests/integration/test_light_resume_effect.py": 12.94,
|
||||
"tests/integration/test_light_toggle_action.py": 9.85,
|
||||
"tests/integration/test_light_transition_state_publish_interval.py": 40.3,
|
||||
"tests/integration/test_lock_automations.py": 9.37,
|
||||
"tests/integration/test_logger_buffered_recursion_guard.py": 10.38,
|
||||
"tests/integration/test_loop_disable_enable.py": 8.13,
|
||||
"tests/integration/test_loop_failed_before_setup.py": 9.22,
|
||||
"tests/integration/test_loop_interval_decoupling.py": 13.71,
|
||||
"tests/integration/test_loop_interval_default_not_pulled_forward.py": 14.17,
|
||||
"tests/integration/test_lvgl_color_picker_render.py": 80.88,
|
||||
"tests/integration/test_lvgl_headless_render.py": 74.94,
|
||||
"tests/integration/test_micros_to_millis.py": 9.88,
|
||||
"tests/integration/test_multi_click_trigger.py": 8.97,
|
||||
"tests/integration/test_multi_device_preferences.py": 10.2,
|
||||
"tests/integration/test_noise_encryption_key_protection.py": 16.06,
|
||||
"tests/integration/test_object_id_api_verification.py": 11.47,
|
||||
"tests/integration/test_object_id_friendly_name_no_mac_suffix.py": 13.0,
|
||||
"tests/integration/test_object_id_no_friendly_name.py": 15.04,
|
||||
"tests/integration/test_online_image_auto_detects_image_bmp_mime.py": 21.82,
|
||||
"tests/integration/test_online_image_auto_detects_redirected_image_bmp_mime.py": 17.86,
|
||||
"tests/integration/test_online_image_bmp.py": 16.2,
|
||||
"tests/integration/test_online_image_stalled_download.py": 15.45,
|
||||
"tests/integration/test_oversized_payloads.py": 29.9,
|
||||
"tests/integration/test_preference_key_stability.py": 10.4,
|
||||
"tests/integration/test_runtime_stats.py": 10.76,
|
||||
"tests/integration/test_safe_mode_loop_runs.py": 6.19,
|
||||
"tests/integration/test_scheduler_background_wake.py": 12.87,
|
||||
"tests/integration/test_scheduler_blocking_warning.py": 19.98,
|
||||
"tests/integration/test_scheduler_bulk_cleanup.py": 11.54,
|
||||
"tests/integration/test_scheduler_defer_cancel.py": 11.15,
|
||||
"tests/integration/test_scheduler_defer_cancel_regular.py": 8.25,
|
||||
"tests/integration/test_scheduler_defer_fifo_simple.py": 9.99,
|
||||
"tests/integration/test_scheduler_defer_stress.py": 9.2,
|
||||
"tests/integration/test_scheduler_heap_stress.py": 4.01,
|
||||
"tests/integration/test_scheduler_internal_id_no_collision.py": 8.82,
|
||||
"tests/integration/test_scheduler_interval_reschedule.py": 11.73,
|
||||
"tests/integration/test_scheduler_interval_zero_coerced.py": 9.65,
|
||||
"tests/integration/test_scheduler_loop_phase_timeout.py": 13.05,
|
||||
"tests/integration/test_scheduler_null_name.py": 3.48,
|
||||
"tests/integration/test_scheduler_numeric_id_test.py": 13.02,
|
||||
"tests/integration/test_scheduler_pool.py": 12.01,
|
||||
"tests/integration/test_scheduler_rapid_cancellation.py": 3.52,
|
||||
"tests/integration/test_scheduler_recursive_timeout.py": 3.88,
|
||||
"tests/integration/test_scheduler_removed_item_race.py": 12.1,
|
||||
"tests/integration/test_scheduler_self_keyed.py": 4.9,
|
||||
"tests/integration/test_scheduler_simultaneous_callbacks.py": 8.85,
|
||||
"tests/integration/test_scheduler_string_test.py": 11.49,
|
||||
"tests/integration/test_scheduler_verbose_log_on_message.py": 10.96,
|
||||
"tests/integration/test_script_array_params.py": 8.29,
|
||||
"tests/integration/test_script_delay_params.py": 4.37,
|
||||
"tests/integration/test_script_on_stop_and_choose.py": 11.33,
|
||||
"tests/integration/test_script_queued.py": 12.76,
|
||||
"tests/integration/test_script_queued_idle_loop.py": 8.03,
|
||||
"tests/integration/test_script_synchronous.py": 8.15,
|
||||
"tests/integration/test_script_wait_on_boot.py": 7.95,
|
||||
"tests/integration/test_sdl_headless_screenshot.py": 13.67,
|
||||
"tests/integration/test_select_stringref_trigger.py": 11.51,
|
||||
"tests/integration/test_sensor_filters_apply.py": 9.04,
|
||||
"tests/integration/test_sensor_filters_delta.py": 8.84,
|
||||
"tests/integration/test_sensor_filters_rh_correction.py": 11.57,
|
||||
"tests/integration/test_sensor_filters_ring_buffer.py": 10.91,
|
||||
"tests/integration/test_sensor_filters_sliding_window.py": 27.62,
|
||||
"tests/integration/test_sensor_filters_value_list.py": 10.87,
|
||||
"tests/integration/test_sensor_raw_state.py": 15.83,
|
||||
"tests/integration/test_sensor_timeout_filter.py": 9.98,
|
||||
"tests/integration/test_sensor_timeout_throttle_filter.py": 11.36,
|
||||
"tests/integration/test_set_internal_at_boot.py": 8.34,
|
||||
"tests/integration/test_snapshot_display.py": 11.19,
|
||||
"tests/integration/test_socket_ipv4_resolve.py": 9.59,
|
||||
"tests/integration/test_socket_tcp_client_link.py": 8.12,
|
||||
"tests/integration/test_socket_wake_gate_tcp.py": 11.4,
|
||||
"tests/integration/test_socket_wake_gate_udp.py": 10.33,
|
||||
"tests/integration/test_source_entity_follow.py": 10.25,
|
||||
"tests/integration/test_status_flags.py": 15.81,
|
||||
"tests/integration/test_status_momentary.py": 15.1,
|
||||
"tests/integration/test_store_yaml_recovery.py": 16.16,
|
||||
"tests/integration/test_strftime_to.py": 11.89,
|
||||
"tests/integration/test_syslog.py": 15.01,
|
||||
"tests/integration/test_tcp_uart_bridge.py": 13.24,
|
||||
"tests/integration/test_tcp_uart_server.py": 11.94,
|
||||
"tests/integration/test_template_alarm_control_panel_many_sensors.py": 9.41,
|
||||
"tests/integration/test_template_climate_basic.py": 9.35,
|
||||
"tests/integration/test_template_climate_custom_modes.py": 7.29,
|
||||
"tests/integration/test_template_climate_nonoptimistic.py": 10.02,
|
||||
"tests/integration/test_template_climate_on_control_ordering.py": 8.62,
|
||||
"tests/integration/test_template_climate_publish_all_fields.py": 9.65,
|
||||
"tests/integration/test_template_climate_sensor_push.py": 9.79,
|
||||
"tests/integration/test_template_climate_set_actions.py": 9.7,
|
||||
"tests/integration/test_template_climate_two_point_temperature.py": 9.82,
|
||||
"tests/integration/test_template_text_save.py": 12.72,
|
||||
"tests/integration/test_template_time.py": 7.72,
|
||||
"tests/integration/test_text_command.py": 10.2,
|
||||
"tests/integration/test_text_sensor_raw_state.py": 11.06,
|
||||
"tests/integration/test_uart_mock_bl0906_stray_rx.py": 9.79,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0395.py": 12.43,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0465.py": 18.59,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0609.py": 15.46,
|
||||
"tests/integration/test_uart_mock_duco.py": 32.44,
|
||||
"tests/integration/test_uart_mock_ld2410.py": 29.35,
|
||||
"tests/integration/test_uart_mock_ld2410_query_ack.py": 11.05,
|
||||
"tests/integration/test_uart_mock_ld2410_selects.py": 9.11,
|
||||
"tests/integration/test_uart_mock_ld2410s.py": 56.59,
|
||||
"tests/integration/test_uart_mock_ld2412.py": 118.06,
|
||||
"tests/integration/test_uart_mock_ld2420.py": 18.66,
|
||||
"tests/integration/test_uart_mock_ld2420_config_exit.py": 39.09,
|
||||
"tests/integration/test_uart_mock_ld2420_select_mode.py": 23.62,
|
||||
"tests/integration/test_uart_mock_ld2450.py": 14.29,
|
||||
"tests/integration/test_uart_mock_ld2450_has_target_only.py": 11.09,
|
||||
"tests/integration/test_uart_mock_ld2450_link_loss.py": 43.3,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zone_restore.py": 12.66,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zone_timeout.py": 13.91,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zones.py": 14.87,
|
||||
"tests/integration/test_uart_mock_ld2450_target_xy.py": 12.24,
|
||||
"tests/integration/test_uart_mock_ld2460.py": 9.0,
|
||||
"tests/integration/test_uart_mock_modbus.py": 221.56,
|
||||
"tests/integration/test_uart_mock_pipsolar_switches.py": 10.41,
|
||||
"tests/integration/test_uart_mock_pylontech.py": 10.67,
|
||||
"tests/integration/test_uart_mock_sim800l_callbacks.py": 11.0,
|
||||
"tests/integration/test_uart_mock_ufm01.py": 66.28,
|
||||
"tests/integration/test_uart_tcp_bridge.py": 10.65,
|
||||
"tests/integration/test_udp.py": 8.05,
|
||||
"tests/integration/test_udp_ipv6.py": 8.19,
|
||||
"tests/integration/test_udp_multicast.py": 9.88,
|
||||
"tests/integration/test_use_address_runtime.py": 17.43,
|
||||
"tests/integration/test_valve_control_action.py": 9.33,
|
||||
"tests/integration/test_varint_five_byte_device_id.py": 9.7,
|
||||
"tests/integration/test_vnc_client.py": 19.44,
|
||||
"tests/integration/test_vnc_client_auth.py": 19.49,
|
||||
"tests/integration/test_wait_until_mid_loop_timing.py": 12.29,
|
||||
"tests/integration/test_wait_until_on_boot.py": 12.05,
|
||||
"tests/integration/test_wait_until_ordering.py": 9.65,
|
||||
"tests/integration/test_wait_until_reentrant_restart.py": 9.36,
|
||||
"tests/integration/test_wake_loop_forces_phase_b.py": 9.94,
|
||||
"tests/integration/test_water_heater_template.py": 16.44
|
||||
"tests/integration/test_action_concurrent_reentry.py": 6.84,
|
||||
"tests/integration/test_addressable_light_transition.py": 4.79,
|
||||
"tests/integration/test_alarm_control_panel_state_transitions.py": 5.63,
|
||||
"tests/integration/test_api_action_metadata.py": 6.5,
|
||||
"tests/integration/test_api_action_responses.py": 5.15,
|
||||
"tests/integration/test_api_action_timeout.py": 7.0,
|
||||
"tests/integration/test_api_conditional_memory.py": 3.27,
|
||||
"tests/integration/test_api_cover_toggle.py": 4.89,
|
||||
"tests/integration/test_api_custom_services.py": 3.6,
|
||||
"tests/integration/test_api_decode_wire_types.py": 6.57,
|
||||
"tests/integration/test_api_empty_message_roundtrip.py": 3.25,
|
||||
"tests/integration/test_api_encode_boundaries.py": 3.9,
|
||||
"tests/integration/test_api_event_order_backpressure.py": 4.42,
|
||||
"tests/integration/test_api_get_time_response_timezone.py": 4.41,
|
||||
"tests/integration/test_api_homeassistant.py": 4.71,
|
||||
"tests/integration/test_api_homeassistant_action_no_subscriber.py": 3.56,
|
||||
"tests/integration/test_api_homeassistant_binary_sensor_initial_state.py": 3.61,
|
||||
"tests/integration/test_api_homeassistant_entities.py": 3.57,
|
||||
"tests/integration/test_api_homeassistant_light.py": 26.77,
|
||||
"tests/integration/test_api_list_entities_backpressure.py": 4.79,
|
||||
"tests/integration/test_api_message_size_batching.py": 2.95,
|
||||
"tests/integration/test_api_outgoing_connection.py": 27.8,
|
||||
"tests/integration/test_api_reboot_timeout.py": 2.92,
|
||||
"tests/integration/test_api_string_lambda.py": 3.79,
|
||||
"tests/integration/test_api_vv_logging.py": 3.85,
|
||||
"tests/integration/test_api_zero_psk_provisioning.py": 20.97,
|
||||
"tests/integration/test_areas_and_devices.py": 4.44,
|
||||
"tests/integration/test_automation_merged_actions.py": 4.18,
|
||||
"tests/integration/test_automation_wait_actions.py": 3.88,
|
||||
"tests/integration/test_automations.py": 7.54,
|
||||
"tests/integration/test_batch_delay_zero_rapid_transitions.py": 4.99,
|
||||
"tests/integration/test_binary_sensor_autorepeat_filter.py": 3.73,
|
||||
"tests/integration/test_binary_sensor_delay_filters.py": 5.07,
|
||||
"tests/integration/test_binary_sensor_invalidate_state.py": 2.74,
|
||||
"tests/integration/test_blocking_warning_log_time_not_charged_to_next_operation.py": 3.75,
|
||||
"tests/integration/test_branch_resume_async.py": 7.19,
|
||||
"tests/integration/test_build_info.py": 3.22,
|
||||
"tests/integration/test_camera_mock.py": 3.34,
|
||||
"tests/integration/test_canbus_on_frame.py": 3.37,
|
||||
"tests/integration/test_climate_control_action.py": 4.14,
|
||||
"tests/integration/test_climate_custom_modes.py": 3.94,
|
||||
"tests/integration/test_continuation_actions.py": 3.66,
|
||||
"tests/integration/test_copy_cover_toggle.py": 3.44,
|
||||
"tests/integration/test_copy_entity_state.py": 3.42,
|
||||
"tests/integration/test_copy_initially_off.py": 3.05,
|
||||
"tests/integration/test_copy_lock_open.py": 3.47,
|
||||
"tests/integration/test_core_automation_order.py": 3.2,
|
||||
"tests/integration/test_cover_control_action.py": 4.96,
|
||||
"tests/integration/test_cover_position_action_cancel.py": 11.43,
|
||||
"tests/integration/test_cover_stop_tilt_cancel.py": 7.2,
|
||||
"tests/integration/test_crc8_helper.py": 3.06,
|
||||
"tests/integration/test_device_id_in_state.py": 4.38,
|
||||
"tests/integration/test_duplicate_entities.py": 3.28,
|
||||
"tests/integration/test_entity_icon.py": 3.39,
|
||||
"tests/integration/test_entity_missing_state.py": 3.32,
|
||||
"tests/integration/test_fan_turn_on_action.py": 3.68,
|
||||
"tests/integration/test_fnv1_hash_object_id.py": 3.4,
|
||||
"tests/integration/test_fnv1a_hash.py": 2.76,
|
||||
"tests/integration/test_gpio_expander_cache.py": 3.07,
|
||||
"tests/integration/test_host_logger_thread_safety.py": 3.77,
|
||||
"tests/integration/test_host_mode_basic.py": 3.2,
|
||||
"tests/integration/test_host_mode_batch_delay.py": 3.02,
|
||||
"tests/integration/test_host_mode_climate_basic_state.py": 4.6,
|
||||
"tests/integration/test_host_mode_climate_control.py": 3.61,
|
||||
"tests/integration/test_host_mode_empty_string_options.py": 3.51,
|
||||
"tests/integration/test_host_mode_entity_fields.py": 3.14,
|
||||
"tests/integration/test_host_mode_fan_preset.py": 5.18,
|
||||
"tests/integration/test_host_mode_many_entities.py": 4.05,
|
||||
"tests/integration/test_host_mode_many_entities_multiple_connections.py": 3.38,
|
||||
"tests/integration/test_host_mode_noise_encryption.py": 7.82,
|
||||
"tests/integration/test_host_mode_reconnect.py": 2.85,
|
||||
"tests/integration/test_host_mode_sensor.py": 3.58,
|
||||
"tests/integration/test_host_ota.py": 79.09,
|
||||
"tests/integration/test_host_preferences.py": 2.95,
|
||||
"tests/integration/test_host_preferences_suspend_resume.py": 5.49,
|
||||
"tests/integration/test_host_write_after_peer_close.py": 3.37,
|
||||
"tests/integration/test_improv_serial_uart.py": 4.16,
|
||||
"tests/integration/test_in_range_conditions.py": 3.51,
|
||||
"tests/integration/test_includes_lambda_order.py": 2.97,
|
||||
"tests/integration/test_interval_startup_delay.py": 4.05,
|
||||
"tests/integration/test_ir_rf_transmit_complete.py": 4.25,
|
||||
"tests/integration/test_large_message_batching.py": 3.58,
|
||||
"tests/integration/test_legacy_area.py": 2.62,
|
||||
"tests/integration/test_light_automations.py": 3.91,
|
||||
"tests/integration/test_light_binary_effect_off_phase.py": 9.47,
|
||||
"tests/integration/test_light_calls.py": 8.37,
|
||||
"tests/integration/test_light_constant_brightness.py": 5.31,
|
||||
"tests/integration/test_light_control_action.py": 4.64,
|
||||
"tests/integration/test_light_dim_relative_action.py": 4.44,
|
||||
"tests/integration/test_light_effect_cycle_action.py": 4.4,
|
||||
"tests/integration/test_light_effect_zero_brightness.py": 5.45,
|
||||
"tests/integration/test_light_initial_state.py": 3.49,
|
||||
"tests/integration/test_light_repeat_effect.py": 12.46,
|
||||
"tests/integration/test_light_restore_state.py": 3.63,
|
||||
"tests/integration/test_light_resume_effect.py": 5.85,
|
||||
"tests/integration/test_light_toggle_action.py": 3.66,
|
||||
"tests/integration/test_light_transition_state_publish_interval.py": 18.86,
|
||||
"tests/integration/test_lock_automations.py": 2.93,
|
||||
"tests/integration/test_logger_buffered_recursion_guard.py": 3.17,
|
||||
"tests/integration/test_loop_disable_enable.py": 3.68,
|
||||
"tests/integration/test_loop_failed_before_setup.py": 2.88,
|
||||
"tests/integration/test_loop_interval_decoupling.py": 6.29,
|
||||
"tests/integration/test_loop_interval_default_not_pulled_forward.py": 5.71,
|
||||
"tests/integration/test_lvgl_color_picker_render.py": 82.81,
|
||||
"tests/integration/test_lvgl_headless_render.py": 72.6,
|
||||
"tests/integration/test_micros_to_millis.py": 3.01,
|
||||
"tests/integration/test_multi_click_trigger.py": 7.11,
|
||||
"tests/integration/test_multi_device_preferences.py": 3.74,
|
||||
"tests/integration/test_noise_encryption_key_protection.py": 6.03,
|
||||
"tests/integration/test_object_id_api_verification.py": 2.83,
|
||||
"tests/integration/test_object_id_friendly_name_no_mac_suffix.py": 3.02,
|
||||
"tests/integration/test_object_id_no_friendly_name.py": 6.9,
|
||||
"tests/integration/test_online_image_auto_detects_image_bmp_mime.py": 4.69,
|
||||
"tests/integration/test_online_image_auto_detects_redirected_image_bmp_mime.py": 10.89,
|
||||
"tests/integration/test_online_image_bmp.py": 5.16,
|
||||
"tests/integration/test_online_image_stalled_download.py": 5.18,
|
||||
"tests/integration/test_oversized_payloads.py": 17.75,
|
||||
"tests/integration/test_preference_key_stability.py": 3.94,
|
||||
"tests/integration/test_reboot_hook_order.py": 8.25,
|
||||
"tests/integration/test_runtime_stats.py": 5.26,
|
||||
"tests/integration/test_safe_mode_loop_runs.py": 3.08,
|
||||
"tests/integration/test_scheduler_background_wake.py": 8.49,
|
||||
"tests/integration/test_scheduler_blocking_warning.py": 10.27,
|
||||
"tests/integration/test_scheduler_bulk_cleanup.py": 3.12,
|
||||
"tests/integration/test_scheduler_defer_cancel.py": 3.62,
|
||||
"tests/integration/test_scheduler_defer_cancel_regular.py": 2.99,
|
||||
"tests/integration/test_scheduler_defer_fifo_simple.py": 2.89,
|
||||
"tests/integration/test_scheduler_defer_stress.py": 3.31,
|
||||
"tests/integration/test_scheduler_heap_stress.py": 3.0,
|
||||
"tests/integration/test_scheduler_internal_id_no_collision.py": 4.28,
|
||||
"tests/integration/test_scheduler_interval_reschedule.py": 7.2,
|
||||
"tests/integration/test_scheduler_interval_zero_coerced.py": 3.3,
|
||||
"tests/integration/test_scheduler_loop_phase_timeout.py": 8.31,
|
||||
"tests/integration/test_scheduler_null_name.py": 2.81,
|
||||
"tests/integration/test_scheduler_numeric_id_test.py": 4.23,
|
||||
"tests/integration/test_scheduler_pool.py": 4.72,
|
||||
"tests/integration/test_scheduler_rapid_cancellation.py": 3.77,
|
||||
"tests/integration/test_scheduler_recursive_timeout.py": 3.21,
|
||||
"tests/integration/test_scheduler_removed_item_race.py": 3.55,
|
||||
"tests/integration/test_scheduler_self_keyed.py": 4.28,
|
||||
"tests/integration/test_scheduler_simultaneous_callbacks.py": 3.4,
|
||||
"tests/integration/test_scheduler_string_test.py": 5.27,
|
||||
"tests/integration/test_scheduler_verbose_log_on_message.py": 3.16,
|
||||
"tests/integration/test_script_array_params.py": 3.54,
|
||||
"tests/integration/test_script_delay_params.py": 3.63,
|
||||
"tests/integration/test_script_on_stop_and_choose.py": 3.88,
|
||||
"tests/integration/test_script_queued.py": 5.6,
|
||||
"tests/integration/test_script_queued_idle_loop.py": 3.28,
|
||||
"tests/integration/test_script_synchronous.py": 4.17,
|
||||
"tests/integration/test_script_wait_on_boot.py": 2.97,
|
||||
"tests/integration/test_sdl_headless_screenshot.py": 10.29,
|
||||
"tests/integration/test_select_stringref_trigger.py": 3.29,
|
||||
"tests/integration/test_sensor_filters_apply.py": 4.08,
|
||||
"tests/integration/test_sensor_filters_delta.py": 4.13,
|
||||
"tests/integration/test_sensor_filters_rh_correction.py": 3.54,
|
||||
"tests/integration/test_sensor_filters_ring_buffer.py": 3.77,
|
||||
"tests/integration/test_sensor_filters_sliding_window.py": 9.43,
|
||||
"tests/integration/test_sensor_filters_value_list.py": 5.0,
|
||||
"tests/integration/test_sensor_raw_state.py": 6.81,
|
||||
"tests/integration/test_sensor_timeout_filter.py": 4.18,
|
||||
"tests/integration/test_sensor_timeout_throttle_filter.py": 5.85,
|
||||
"tests/integration/test_serial_proxy_backpressure.py": 6.22,
|
||||
"tests/integration/test_set_internal_at_boot.py": 3.59,
|
||||
"tests/integration/test_snapshot_display.py": 11.35,
|
||||
"tests/integration/test_socket_ipv4_resolve.py": 2.69,
|
||||
"tests/integration/test_socket_tcp_client_link.py": 3.84,
|
||||
"tests/integration/test_socket_wake_gate_tcp.py": 6.37,
|
||||
"tests/integration/test_socket_wake_gate_udp.py": 3.02,
|
||||
"tests/integration/test_source_entity_follow.py": 4.63,
|
||||
"tests/integration/test_status_flags.py": 8.6,
|
||||
"tests/integration/test_status_momentary.py": 6.18,
|
||||
"tests/integration/test_store_yaml_recovery.py": 21.71,
|
||||
"tests/integration/test_strftime_to.py": 3.69,
|
||||
"tests/integration/test_syslog.py": 7.12,
|
||||
"tests/integration/test_tcp_uart_bridge.py": 6.76,
|
||||
"tests/integration/test_tcp_uart_server.py": 2.75,
|
||||
"tests/integration/test_template_alarm_control_panel_many_sensors.py": 3.46,
|
||||
"tests/integration/test_template_climate_basic.py": 3.36,
|
||||
"tests/integration/test_template_climate_custom_modes.py": 4.52,
|
||||
"tests/integration/test_template_climate_nonoptimistic.py": 3.76,
|
||||
"tests/integration/test_template_climate_on_control_ordering.py": 4.25,
|
||||
"tests/integration/test_template_climate_publish_all_fields.py": 3.33,
|
||||
"tests/integration/test_template_climate_sensor_push.py": 3.66,
|
||||
"tests/integration/test_template_climate_set_actions.py": 3.28,
|
||||
"tests/integration/test_template_climate_two_point_temperature.py": 2.98,
|
||||
"tests/integration/test_template_text_save.py": 4.83,
|
||||
"tests/integration/test_template_time.py": 3.96,
|
||||
"tests/integration/test_text_command.py": 2.71,
|
||||
"tests/integration/test_text_sensor_raw_state.py": 4.22,
|
||||
"tests/integration/test_uart_mock_bl0906_stray_rx.py": 3.7,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0395.py": 4.63,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0465.py": 10.02,
|
||||
"tests/integration/test_uart_mock_dfrobot_sen0609.py": 4.61,
|
||||
"tests/integration/test_uart_mock_duco.py": 25.59,
|
||||
"tests/integration/test_uart_mock_ld2410.py": 17.8,
|
||||
"tests/integration/test_uart_mock_ld2410_query_ack.py": 4.4,
|
||||
"tests/integration/test_uart_mock_ld2410_selects.py": 3.63,
|
||||
"tests/integration/test_uart_mock_ld2410s.py": 31.84,
|
||||
"tests/integration/test_uart_mock_ld2412.py": 48.32,
|
||||
"tests/integration/test_uart_mock_ld2420.py": 12.7,
|
||||
"tests/integration/test_uart_mock_ld2420_config_exit.py": 36.34,
|
||||
"tests/integration/test_uart_mock_ld2420_select_mode.py": 11.81,
|
||||
"tests/integration/test_uart_mock_ld2450.py": 4.54,
|
||||
"tests/integration/test_uart_mock_ld2450_has_target_only.py": 5.65,
|
||||
"tests/integration/test_uart_mock_ld2450_link_loss.py": 29.62,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zone_restore.py": 4.18,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zone_timeout.py": 5.08,
|
||||
"tests/integration/test_uart_mock_ld2450_polygon_zones.py": 5.17,
|
||||
"tests/integration/test_uart_mock_ld2450_target_xy.py": 5.73,
|
||||
"tests/integration/test_uart_mock_ld2450_target_xy_unfiltered.py": 26.14,
|
||||
"tests/integration/test_uart_mock_ld2450_target_xy_unfiltered_raw_press.py": 3.56,
|
||||
"tests/integration/test_uart_mock_ld2460.py": 4.17,
|
||||
"tests/integration/test_uart_mock_modbus.py": 112.87,
|
||||
"tests/integration/test_uart_mock_pipsolar_switches.py": 4.39,
|
||||
"tests/integration/test_uart_mock_pylontech.py": 3.97,
|
||||
"tests/integration/test_uart_mock_sim800l_callbacks.py": 3.39,
|
||||
"tests/integration/test_uart_mock_ufm01.py": 56.92,
|
||||
"tests/integration/test_uart_tcp_bridge.py": 3.88,
|
||||
"tests/integration/test_udp.py": 4.73,
|
||||
"tests/integration/test_udp_ipv6.py": 3.29,
|
||||
"tests/integration/test_udp_multicast.py": 6.28,
|
||||
"tests/integration/test_use_address_runtime.py": 7.3,
|
||||
"tests/integration/test_valve_control_action.py": 3.92,
|
||||
"tests/integration/test_varint_five_byte_device_id.py": 3.4,
|
||||
"tests/integration/test_vnc_client.py": 17.8,
|
||||
"tests/integration/test_vnc_client_auth.py": 23.37,
|
||||
"tests/integration/test_wait_until_mid_loop_timing.py": 3.79,
|
||||
"tests/integration/test_wait_until_on_boot.py": 4.0,
|
||||
"tests/integration/test_wait_until_ordering.py": 3.68,
|
||||
"tests/integration/test_wait_until_reentrant_restart.py": 5.43,
|
||||
"tests/integration/test_wake_loop_forces_phase_b.py": 4.03,
|
||||
"tests/integration/test_water_heater_template.py": 9.07
|
||||
}
|
||||
@@ -116,6 +116,45 @@ def test_timeout_not_with_session_on_peer(setup_core) -> None:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
def test_timeout_not_with_link_session(setup_core) -> None:
|
||||
"""A link such as TCP does the session's job itself, so it has no session key but the same rule applies."""
|
||||
from esphome.components.tcp.packet_interface import TcpPacketInterface
|
||||
|
||||
token = fv.full_config.set(
|
||||
{
|
||||
"packet_interface": [
|
||||
{CONF_ID: ID("tcp_link", is_manual=True, type=TcpPacketInterface)}
|
||||
]
|
||||
}
|
||||
)
|
||||
try:
|
||||
with pytest.raises(cv.Invalid, match="session") as error:
|
||||
FINAL_VALIDATE_SCHEMA(
|
||||
CONFIG_SCHEMA({"packet_interface": "tcp_link", CONF_TIMEOUT: "1min"})
|
||||
)
|
||||
assert error.value.path == [CONF_TIMEOUT]
|
||||
finally:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
def test_timeout_not_with_link_session_on_peer(setup_core) -> None:
|
||||
"""An addressing peer has what its link provides, as well as its own layers."""
|
||||
from esphome.components.tcp.packet_interface import TcpPacketInterface
|
||||
|
||||
link = {
|
||||
CONF_ID: ID("session_link", is_manual=True, type=TcpPacketInterface),
|
||||
"addressing": {"peers": [{CONF_ID: ID("link_peer", is_manual=True)}]},
|
||||
}
|
||||
token = fv.full_config.set({"packet_interface": [link]})
|
||||
try:
|
||||
with pytest.raises(cv.Invalid, match="session"):
|
||||
FINAL_VALIDATE_SCHEMA(
|
||||
CONFIG_SCHEMA({"packet_interface": "link_peer", CONF_TIMEOUT: "1min"})
|
||||
)
|
||||
finally:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("layers", "allowed"),
|
||||
[
|
||||
|
||||
@@ -0,0 +1,330 @@
|
||||
"""Unit tests for the sx126x and sx127x packet interface platforms."""
|
||||
|
||||
import math
|
||||
|
||||
import pytest
|
||||
|
||||
from esphome import config_validation as cv
|
||||
from esphome.components.packet_interface import CONF_MAX_PACKET_SIZE, radio_link
|
||||
from esphome.components.sx126x import packet_interface as sx126x_packet_interface
|
||||
from esphome.components.sx127x import packet_interface as sx127x_packet_interface
|
||||
import esphome.final_validate as fv
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("schema", "radio_key"),
|
||||
[
|
||||
(sx126x_packet_interface.CONFIG_SCHEMA, "sx126x_id"),
|
||||
(sx127x_packet_interface.CONFIG_SCHEMA, "sx127x_id"),
|
||||
],
|
||||
)
|
||||
def test_max_packet_size_is_radio_limit(
|
||||
setup_core, schema: cv.Schema, radio_key: str
|
||||
) -> None:
|
||||
"""A radio packet holds at most 255 bytes, which is also the default."""
|
||||
assert schema({radio_key: "radio"})[CONF_MAX_PACKET_SIZE] == 255
|
||||
with pytest.raises(cv.Invalid):
|
||||
schema({radio_key: "radio", CONF_MAX_PACKET_SIZE: 256})
|
||||
|
||||
|
||||
def _lora(**options: object) -> dict:
|
||||
return {
|
||||
"modulation": "LORA",
|
||||
"spreading_factor": 7,
|
||||
"bandwidth": "125_0kHz",
|
||||
"coding_rate": "CR_4_5",
|
||||
"preamble_size": 8,
|
||||
"crc_enable": False,
|
||||
**options,
|
||||
}
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("radio", "airtime_ms"),
|
||||
[
|
||||
# Worked by hand from the Semtech formula, for a 255 byte packet with an explicit header
|
||||
(_lora(spreading_factor=7), 394.5),
|
||||
(_lora(spreading_factor=7, crc_enable=True), 399.6),
|
||||
(_lora(spreading_factor=10), 2254.8),
|
||||
# A symbol takes over 16 ms, so the low data rate optimization lengthens the packet
|
||||
(_lora(spreading_factor=12), 9019.4),
|
||||
],
|
||||
)
|
||||
def test_lora_airtime(radio: dict, airtime_ms: float) -> None:
|
||||
"""The airtime of the largest LoRa packet follows the Semtech formula."""
|
||||
assert radio_link.packet_airtime_ms(radio, 255) == pytest.approx(
|
||||
airtime_ms, abs=0.5
|
||||
)
|
||||
|
||||
|
||||
def test_max_busy_follows_airtime() -> None:
|
||||
"""Listen before talk waits at least 2 s, and longer than the largest packet takes."""
|
||||
assert radio_link.max_busy_ms(_lora(), 255) == 2000
|
||||
assert radio_link.max_busy_ms(_lora(spreading_factor=12), 255) > 9019
|
||||
fsk = {
|
||||
"modulation": "FSK",
|
||||
"preamble_size": 4,
|
||||
"bitrate": 1200,
|
||||
"sync_value": [1, 2],
|
||||
}
|
||||
assert radio_link.packet_airtime_ms(fsk, 64) == pytest.approx(
|
||||
(4 + 2 + 1 + 64 + 2) * 8 / 1200 * 1000
|
||||
)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("radio", "expected_ms"),
|
||||
[
|
||||
# (8 + 4.25 + 8) symbols of 8.192 ms, then 50 ms for the reply to start, with a quarter added
|
||||
(_lora(spreading_factor=10), 270),
|
||||
(_lora(spreading_factor=7), 89),
|
||||
# 6 bytes of preamble, sync word and length at 4800 bit/s
|
||||
(
|
||||
{
|
||||
"modulation": "FSK",
|
||||
"preamble_size": 4,
|
||||
"bitrate": 4800,
|
||||
"sync_value": [0x12],
|
||||
},
|
||||
75,
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_turnaround_covers_reply_header(radio: dict, expected_ms: int) -> None:
|
||||
"""After sending, the link waits until the peer's reply would have started and its header been received."""
|
||||
assert radio_link.turnaround_ms(radio) == expected_ms
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("config", "expected"),
|
||||
[
|
||||
({}, False),
|
||||
# A session's peer sends keep-alives on its own schedule, not a reply to each packet
|
||||
({"session": {}}, False),
|
||||
({"reliability": {}}, True),
|
||||
({"addressing": {"peers": [{"session": {}}, {"reliability": {}}]}}, True),
|
||||
],
|
||||
)
|
||||
def test_takes_turns_only_with_reliability(config: dict, expected: bool) -> None:
|
||||
"""Only a reliability layer's peer answers each packet, and it sends again what turn taking refuses."""
|
||||
assert radio_link.takes_turns(config) is expected
|
||||
|
||||
|
||||
def _fsk(**options: object) -> dict:
|
||||
return {
|
||||
"modulation": "FSK",
|
||||
"packet_mode": True,
|
||||
"payload_length": 0,
|
||||
"sync_value": [0x12],
|
||||
"preamble_size": 4,
|
||||
"bitrate": 4800,
|
||||
**options,
|
||||
}
|
||||
|
||||
|
||||
class _FullConfig(dict):
|
||||
"""Enough of the full configuration for the radio links' final validation."""
|
||||
|
||||
def __init__(self, domain: str, radio: dict) -> None:
|
||||
super().__init__({domain: [{"rx_start": True, **radio}]})
|
||||
self.domain = domain
|
||||
|
||||
def get_path_for_id(self, id_: object) -> list:
|
||||
return [self.domain, 0, "id"]
|
||||
|
||||
def get_config_for_path(self, path: list) -> dict:
|
||||
return self[path[0]][path[1]]
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("module", "domain", "radio", "link", "match", "fix"),
|
||||
[
|
||||
(
|
||||
sx126x_packet_interface,
|
||||
"sx126x",
|
||||
_lora(payload_length=10),
|
||||
{},
|
||||
"payload_length",
|
||||
{"payload_length": 0},
|
||||
),
|
||||
(
|
||||
sx127x_packet_interface,
|
||||
"sx127x",
|
||||
_lora(payload_length=10),
|
||||
{},
|
||||
"payload_length",
|
||||
{"payload_length": 0},
|
||||
),
|
||||
(
|
||||
sx127x_packet_interface,
|
||||
"sx127x",
|
||||
{
|
||||
**_fsk(modulation="FSK", packet_mode=False),
|
||||
},
|
||||
{},
|
||||
"packet_mode",
|
||||
{"packet_mode": True},
|
||||
),
|
||||
(
|
||||
sx127x_packet_interface,
|
||||
"sx127x",
|
||||
{
|
||||
**_fsk(modulation="OOK"),
|
||||
},
|
||||
{CONF_MAX_PACKET_SIZE: 64},
|
||||
"at most 63",
|
||||
None,
|
||||
),
|
||||
(
|
||||
sx127x_packet_interface,
|
||||
"sx127x",
|
||||
{
|
||||
**_fsk(sync_value=[]),
|
||||
},
|
||||
{},
|
||||
"sync_value",
|
||||
{"sync_value": [0x12]},
|
||||
),
|
||||
(
|
||||
sx126x_packet_interface,
|
||||
"sx126x",
|
||||
_fsk(sync_value=[]),
|
||||
{},
|
||||
"sync_value",
|
||||
{"sync_value": [0x12, 0x34]},
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_radio_settings_checked(
|
||||
module: object,
|
||||
domain: str,
|
||||
radio: dict,
|
||||
link: dict,
|
||||
match: str,
|
||||
fix: dict | None,
|
||||
) -> None:
|
||||
"""Packets vary in length; FSK or OOK on an SX127x needs packet mode and a sync word, and holds at most 63 bytes;
|
||||
FSK on an SX126x needs a sync word.
|
||||
"""
|
||||
config = {f"{domain}_id": "radio", CONF_MAX_PACKET_SIZE: 63, **link}
|
||||
token = fv.full_config.set(_FullConfig(domain, radio))
|
||||
try:
|
||||
with pytest.raises(cv.Invalid, match=match):
|
||||
module.FINAL_VALIDATE_SCHEMA(config)
|
||||
if fix is not None:
|
||||
fv.full_config.set(_FullConfig(domain, {**radio, **fix}))
|
||||
assert module.FINAL_VALIDATE_SCHEMA(config)
|
||||
finally:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("link", "match"),
|
||||
[
|
||||
({}, None),
|
||||
({"encryption": "secret"}, None),
|
||||
({"reliability": {}}, "reliability"),
|
||||
(
|
||||
{
|
||||
"addressing": {
|
||||
"address": 1,
|
||||
"peers": [
|
||||
{"id": "a", "destination": 2, "session": {}},
|
||||
{"id": "b", "destination": 3},
|
||||
],
|
||||
}
|
||||
},
|
||||
"session",
|
||||
),
|
||||
],
|
||||
)
|
||||
def test_rx_start_needed_for_replies(setup_core, link: dict, match: str | None) -> None:
|
||||
"""A radio that sleeps after sending suits only a link whose layers need no packets back."""
|
||||
sleeping = _lora(payload_length=0, rx_start=False)
|
||||
config = sx126x_packet_interface.CONFIG_SCHEMA({"sx126x_id": "radio", **link})
|
||||
token = fv.full_config.set(_FullConfig("sx126x", sleeping))
|
||||
try:
|
||||
if match is None:
|
||||
assert sx126x_packet_interface.FINAL_VALIDATE_SCHEMA(config)
|
||||
return
|
||||
with pytest.raises(cv.Invalid, match=f"'{match}'.*rx_start"):
|
||||
sx126x_packet_interface.FINAL_VALIDATE_SCHEMA(config)
|
||||
finally:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
def _final_validate(radio: dict, link: dict) -> None:
|
||||
config = sx126x_packet_interface.CONFIG_SCHEMA({"sx126x_id": "radio", **link})
|
||||
token = fv.full_config.set(_FullConfig("sx126x", {"payload_length": 0, **radio}))
|
||||
try:
|
||||
sx126x_packet_interface.FINAL_VALIDATE_SCHEMA(config)
|
||||
finally:
|
||||
fv.full_config.reset(token)
|
||||
|
||||
|
||||
def test_packet_must_fit_transmit_time(setup_core) -> None:
|
||||
"""The radios give up on a packet that takes longer than 4 s to send, so the largest packet must take less."""
|
||||
slow = _lora(spreading_factor=12)
|
||||
with pytest.raises(cv.Invalid, match=r"255 bytes takes 9019 ms.*to 7\d or less"):
|
||||
_final_validate(slow, {})
|
||||
_final_validate(slow, {CONF_MAX_PACKET_SIZE: 64})
|
||||
_final_validate(_lora(), {})
|
||||
|
||||
|
||||
def test_reliability_timeout_follows_airtime(setup_core) -> None:
|
||||
"""A reliability timeout must allow for the peer's largest packet and the acknowledgement."""
|
||||
needed = radio_link.reliability_timeout_ms(_lora(), 255, 0)
|
||||
assert needed == math.ceil(
|
||||
(
|
||||
radio_link.packet_airtime_ms(_lora(), 255)
|
||||
+ radio_link.packet_airtime_ms(_lora(), radio_link.ACK_PACKET_SIZE)
|
||||
)
|
||||
* radio_link.MARGIN
|
||||
)
|
||||
assert radio_link.reliability_timeout_ms(_lora(), 255, 100) == needed + 100
|
||||
with pytest.raises(cv.Invalid, match=f"at least {needed}ms"):
|
||||
_final_validate(_lora(), {"reliability": {"timeout": "200ms"}})
|
||||
# Left out, the link works it out when generating code
|
||||
_final_validate(_lora(), {"reliability": {}})
|
||||
_final_validate(_lora(), {"reliability": {"timeout": f"{needed}ms"}})
|
||||
# The worked out timeout allows for any ack_delay, so one longer than 200 ms needs no timeout set
|
||||
_final_validate(_lora(spreading_factor=9), {"reliability": {"ack_delay": "250ms"}})
|
||||
|
||||
|
||||
def test_suggested_size_is_allowed(setup_core) -> None:
|
||||
"""The suggested max_packet_size is never below the smallest one allowed."""
|
||||
slowest = _lora(spreading_factor=12, bandwidth="7_8kHz")
|
||||
with pytest.raises(cv.Invalid, match="use faster radio settings"):
|
||||
_final_validate(slowest, {CONF_MAX_PACKET_SIZE: 16})
|
||||
|
||||
|
||||
def test_channel_packet_size(setup_core) -> None:
|
||||
"""Other devices can send no more than the radio receives, nor more than their own checks allow."""
|
||||
assert radio_link.channel_packet_size(_lora(), 255) == 255
|
||||
assert radio_link.channel_packet_size(_lora(spreading_factor=12), 255) == 77
|
||||
assert radio_link.channel_packet_size(_fsk(), 63) == 63
|
||||
|
||||
|
||||
def test_reliability_timeout_allows_for_other_devices(setup_core) -> None:
|
||||
"""A small max_packet_size still needs a timeout that allows for the largest packet another device can send."""
|
||||
needed = radio_link.reliability_timeout_ms(_lora(), 255, 0)
|
||||
with pytest.raises(cv.Invalid, match=f"at least {needed}ms"):
|
||||
_final_validate(
|
||||
_lora(),
|
||||
{
|
||||
CONF_MAX_PACKET_SIZE: 16,
|
||||
"reliability": {
|
||||
"timeout": f"{radio_link.reliability_timeout_ms(_lora(), 16, 0)}ms"
|
||||
},
|
||||
},
|
||||
)
|
||||
|
||||
|
||||
def test_long_sends_warned(setup_core, caplog: pytest.LogCaptureFixture) -> None:
|
||||
"""A send of many radio packets, each waited for, is warned about."""
|
||||
slow = _lora(spreading_factor=10)
|
||||
_final_validate(slow, {CONF_MAX_PACKET_SIZE: 64})
|
||||
assert "radio packets in a row" not in caplog.text
|
||||
_final_validate(slow, {CONF_MAX_PACKET_SIZE: 64, "fragmentation": {}})
|
||||
# 1024 bytes in fragments of 62
|
||||
assert "can send 17 radio packets in a row" in caplog.text
|
||||
@@ -62,7 +62,8 @@ def test_reliability_defaults(setup_core) -> None:
|
||||
config = uart_packet_interface.CONFIG_SCHEMA({CONF_RELIABILITY: None})
|
||||
reliability = config[CONF_RELIABILITY]
|
||||
assert reliability["type"] == "hdlc"
|
||||
assert reliability["timeout"].total_milliseconds == 200
|
||||
# Left out, so that the link can choose one; otherwise the layer uses 200 ms
|
||||
assert "timeout" not in reliability
|
||||
assert reliability[CONF_MAX_QUEUE_LENGTH] == 4
|
||||
assert reliability["max_retries"] == 5
|
||||
|
||||
@@ -92,6 +93,9 @@ def test_ack_delay_shorter_than_timeout(setup_core) -> None:
|
||||
uart_packet_interface.CONFIG_SCHEMA(
|
||||
{CONF_RELIABILITY: {"timeout": "500ms", "ack_delay": "500ms"}}
|
||||
)
|
||||
# Without a timeout, the link's default of 200 ms applies
|
||||
with pytest.raises(cv.Invalid, match="shorter than 'timeout', which is 200ms"):
|
||||
uart_packet_interface.CONFIG_SCHEMA({CONF_RELIABILITY: {"ack_delay": "250ms"}})
|
||||
|
||||
|
||||
def test_layer_types_registered() -> None:
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
"""Unit tests for the tcp packet interface platform."""
|
||||
|
||||
import pytest
|
||||
|
||||
from esphome import config_validation as cv
|
||||
from esphome.components import socket
|
||||
from esphome.components.packet_interface import CONF_MAX_PACKET_SIZE
|
||||
from esphome.components.tcp import packet_interface as tcp_packet_interface
|
||||
from esphome.core import CORE
|
||||
|
||||
|
||||
def test_client_and_server(setup_core) -> None:
|
||||
"""A client needs a host; a server listens on its port."""
|
||||
client = tcp_packet_interface.CONFIG_SCHEMA({"host": "192.168.1.50", "port": 6060})
|
||||
assert client["role"] == "client"
|
||||
assert client[CONF_MAX_PACKET_SIZE] == 1022
|
||||
assert tcp_packet_interface.CONFIG_SCHEMA({"role": "server", "port": 6060})
|
||||
with pytest.raises(cv.Invalid):
|
||||
tcp_packet_interface.CONFIG_SCHEMA({"port": 6060})
|
||||
|
||||
|
||||
@pytest.mark.parametrize("layer", ["reliability", "session", "addressing"])
|
||||
def test_provided_layers_rejected(setup_core, layer: str) -> None:
|
||||
"""TCP provides these itself, so they cannot be configured on it."""
|
||||
with pytest.raises(cv.Invalid, match=f"provides '{layer}' itself"):
|
||||
tcp_packet_interface.CONFIG_SCHEMA(
|
||||
{"host": "192.168.1.50", "port": 6060, layer: {"address": 1}}
|
||||
)
|
||||
|
||||
|
||||
def test_rolling_code_rejected(setup_core) -> None:
|
||||
"""The rolling code needs the session's keep-alives, which TCP does not send through the layers."""
|
||||
with pytest.raises(cv.Invalid, match="cannot be used on this link"):
|
||||
tcp_packet_interface.CONFIG_SCHEMA(
|
||||
{
|
||||
"host": "192.168.1.50",
|
||||
"port": 6060,
|
||||
"encryption": {"key": "secret", "rolling_code_enable": True},
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
def test_auto_load_binary_sensor_for_connected(setup_core) -> None:
|
||||
"""The binary_sensor component is loaded only for the connected sensor."""
|
||||
assert tcp_packet_interface.AUTO_LOAD() == ["socket", "binary_sensor"]
|
||||
assert tcp_packet_interface.AUTO_LOAD({}) == ["socket", "binary_sensor"]
|
||||
config = {"host": "192.168.1.50", "port": 6060}
|
||||
assert tcp_packet_interface.AUTO_LOAD(config) == ["socket"]
|
||||
config["connected"] = {"name": "Link"}
|
||||
assert tcp_packet_interface.AUTO_LOAD(config) == ["socket", "binary_sensor"]
|
||||
|
||||
|
||||
def test_timeout(setup_core) -> None:
|
||||
"""The timeout follows keep_alive unless given, and must be longer than it."""
|
||||
base = {"host": "192.168.1.50", "port": 6060}
|
||||
config = tcp_packet_interface.CONFIG_SCHEMA({**base, "keep_alive": "2s"})
|
||||
assert config["timeout"].total_milliseconds == 6000
|
||||
# A peer that sends keep-alives less often is matched with a longer timeout
|
||||
config = tcp_packet_interface.CONFIG_SCHEMA({**base, "timeout": "90s"})
|
||||
assert config["timeout"].total_milliseconds == 90000
|
||||
with pytest.raises(cv.Invalid, match="longer than keep_alive"):
|
||||
tcp_packet_interface.CONFIG_SCHEMA(
|
||||
{**base, "keep_alive": "5s", "timeout": "5s"}
|
||||
)
|
||||
with pytest.raises(cv.Invalid):
|
||||
tcp_packet_interface.CONFIG_SCHEMA({**base, "keep_alive": "2h"})
|
||||
with pytest.raises(cv.Invalid):
|
||||
tcp_packet_interface.CONFIG_SCHEMA({**base, "timeout": "4h"})
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("role", "tcp", "listen"), [("client", 1, 0), ("server", 1, 1)]
|
||||
)
|
||||
def test_sockets_reserved(setup_core, role: str, tcp: int, listen: int) -> None:
|
||||
"""A client reserves one socket; a server also reserves a listener."""
|
||||
config = {"role": role, "port": 6060}
|
||||
if role == "client":
|
||||
config["host"] = "192.168.1.50"
|
||||
tcp_packet_interface.CONFIG_SCHEMA(config)
|
||||
name = "tcp.packet_interface"
|
||||
assert CORE.data[socket.KEY_SOCKET_CONSUMERS_TCP][name] == tcp
|
||||
assert (
|
||||
CORE.data.get(socket.KEY_SOCKET_CONSUMERS_TCP_LISTEN, {}).get(name, 0) == listen
|
||||
)
|
||||
Reference in new issue
Block a user