mirror of
https://github.com/esphome/esphome.git
synced 2026-11-16 01:55:59 +00:00
Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7acd023079 | ||
|
|
5623a5d511 | ||
|
|
4f8c2239dd |
No files matched your search
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -283,7 +283,7 @@ void HdlcReliability::receive_(const PacketBuffer &data, const PacketMetaData &m
|
||||
size_t length = frame.size() - FRAME_OVERHEAD;
|
||||
uint8_t control = frame[0];
|
||||
const uint8_t *payload = frame.data() + 1;
|
||||
uint16_t crc = 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);
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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,20 @@ void SX126xCommands::calibrate_image(uint32_t frequency) {
|
||||
}
|
||||
}
|
||||
|
||||
void SX126xCommands::receive() {
|
||||
// The IRQ mask also routes to DIO1; DIO2 and DIO3 stay unused.
|
||||
void SX126xCommands::set_dio_irq_params_(uint16_t irq) {
|
||||
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, irq);
|
||||
put_be16(buf + 2, irq);
|
||||
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() {
|
||||
this->set_dio_irq_params_(IRQ_RX_DONE | IRQ_RX_TX_TIMEOUT | IRQ_CRC_ERROR);
|
||||
|
||||
uint8_t buf[3];
|
||||
|
||||
// set timeout to 0
|
||||
buf[0] = 0x00;
|
||||
@@ -286,24 +273,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);
|
||||
|
||||
// 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 irq);
|
||||
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);
|
||||
|
||||
@@ -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,
|
||||
@@ -56,26 +71,72 @@ void SX127x::write_fifo_(const uint8_t *data, size_t len) {
|
||||
this->disable();
|
||||
}
|
||||
|
||||
void IRAM_ATTR SX127x::gpio_intr(SX127x *arg) { arg->enable_loop_soon_any_context(); }
|
||||
|
||||
void SX127x::setup() {
|
||||
// setup reset
|
||||
this->rst_pin_->setup();
|
||||
|
||||
// setup dio0
|
||||
if (this->dio0_pin_) {
|
||||
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,12 +145,13 @@ 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;
|
||||
@@ -98,21 +160,27 @@ void SX127x::configure() {
|
||||
this->write_register_(REG_FRF_LSB, (uint8_t) ((frf >> 0) & 0xFF));
|
||||
|
||||
// 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 +197,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_() {
|
||||
@@ -252,70 +319,144 @@ 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;
|
||||
}
|
||||
|
||||
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_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::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 +467,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 +551,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 +582,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,26 +102,68 @@ 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); }
|
||||
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);
|
||||
// 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_fifo_(const uint8_t *data, size_t len);
|
||||
void read_fifo_(std::vector<uint8_t> &packet);
|
||||
void write_register_(uint8_t reg, uint8_t value);
|
||||
@@ -105,8 +173,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 +200,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,7 @@ enum SX127xReg : uint8_t {
|
||||
REG_PAYLOAD_LENGTH_LSB = 0x32,
|
||||
REG_FIFO_THRESH = 0x35,
|
||||
REG_IMAGE_CAL = 0x3B,
|
||||
REG_IRQ_FLAGS2 = 0x3F,
|
||||
// LoRa registers
|
||||
REG_FIFO_ADDR_PTR = 0x0D,
|
||||
REG_FIFO_TX_BASE_ADDR = 0x0E,
|
||||
@@ -260,6 +261,11 @@ enum SX127xIrqFlags : uint8_t {
|
||||
CAD_DETECTED = 0x01,
|
||||
};
|
||||
|
||||
enum SX127xIrqFlags2 : uint8_t {
|
||||
PACKET_SENT = 0x08,
|
||||
PAYLOAD_READY = 0x04,
|
||||
};
|
||||
|
||||
enum SX127xModemCfg1 : uint8_t {
|
||||
BW_7_8 = 0x00,
|
||||
BW_10_4 = 0x10,
|
||||
|
||||
@@ -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
|
||||
@@ -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,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,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,329 @@
|
||||
#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.
|
||||
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});
|
||||
}
|
||||
~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;
|
||||
}
|
||||
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
|
||||
Reference in new issue
Block a user