Files
esphome/tests/components/remote_base/ir_code_encoders_test.cpp
T

140 lines
7.7 KiB
C++

#include <gtest/gtest.h>
#include <iterator>
#include <vector>
#include "esphome/components/remote_base/aeha_protocol.h"
#include "esphome/components/remote_base/haier_protocol.h"
#include "esphome/components/remote_base/mirage_protocol.h"
namespace esphome::remote_base::testing {
namespace {
const uint8_t HAIER_CODE[] = {0xA6, 0x12, 0x00, 0x00, 0x40, 0x40, 0x00, 0x80, 0x00, 0x00, 0x00, 0x00, 0x05};
const uint8_t MIRAGE_CODE[] = {0x56, 0x75, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
const uint8_t AEHA_CODE[] = {0x80, 0x00, 0x00, 0x00, 0x00};
constexpr uint16_t AEHA_ADDRESS = 0x2002;
// Captured from the struct encoders before they gained the pointer and length overloads
const RawTimings HAIER_GOLDEN = {
3100, -3100, 3100, -4400, 540, -1650, 540, -580, 540, -1650, 540, -580, 540, -580, 540, -1650, 540, -1650,
540, -580, 540, -580, 540, -580, 540, -580, 540, -1650, 540, -580, 540, -580, 540, -1650, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -1650,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -1650, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -1650, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580, 540, -580,
540, -580, 540, -580, 540, -580, 540, -580, 540, -1650, 540, -580, 540, -1650, 540, -1650, 540, -580,
540, -1650, 540, -1650, 540, -1650, 540, -1650, 540, -580, 540, -1650, 540};
const RawTimings MIRAGE_GOLDEN = {
8360, -4248, 554, -545, 554, -1592, 554, -1592, 554, -545, 554, -1592, 554, -545, 554, -1592, 554, -545,
554, -1592, 554, -545, 554, -1592, 554, -545, 554, -1592, 554, -1592, 554, -1592, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -545,
554, -545, 554, -545, 554, -545, 554, -545, 554, -545, 554, -1592, 554, -1592, 554, -1592, 554, -545,
554, -1592, 554, -545, 554, -545, 554, -545, 554};
const RawTimings AEHA_GOLDEN = {
3400, -1700, 425, -425, 425, -425, 425, -1275, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425,
425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -1275, 425, -425, 425, -1275, 425, -425, 425, -425,
425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425,
425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425,
425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425,
425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425, -425, 425};
std::vector<uint8_t> haier_code() { return {std::begin(HAIER_CODE), std::end(HAIER_CODE)}; }
std::vector<uint8_t> mirage_code() { return {std::begin(MIRAGE_CODE), std::end(MIRAGE_CODE)}; }
std::vector<uint8_t> aeha_code() { return {std::begin(AEHA_CODE), std::end(AEHA_CODE)}; }
// The Haier and Mirage decoders expect an item after the last mark (pre-existing)
RawTimings with_trailing_space(RawTimings timings) {
timings.push_back(-10000);
return timings;
}
template<typename A> RawTimings encode(A &action) {
RemoteTransmitData dst;
action.encode(&dst);
return dst.get_data();
}
// Exposes the protected encode() of an action for testing
template<typename A> class Open : public A {
public:
using A::encode;
};
// A constant and a lambda code must both encode to the golden timings
template<typename A>
void expect_static_and_lambda_match(const uint8_t *code, size_t len, std::vector<uint8_t> (*lambda)(),
const RawTimings &golden) {
Open<A> fixed, from_lambda;
fixed.set_code_static(code, len);
from_lambda.set_code_template(lambda);
EXPECT_EQ(encode(fixed), golden);
EXPECT_EQ(encode(from_lambda), golden);
}
template<typename P> void expect_decodes_to(const RawTimings &timings, const std::vector<uint8_t> &code) {
auto decoded = P().decode(RemoteReceiveData(timings, 25, TOLERANCE_MODE_PERCENTAGE));
ASSERT_TRUE(decoded.has_value());
// clang-tidy's unchecked-optional-access models neither gtest's ASSERT_TRUE nor value() as a check
EXPECT_EQ(decoded.value_or(typename P::ProtocolData{}).data, code);
}
} // namespace
TEST(IrCodeEncodersTest, HaierStaticAndLambdaMatchGolden) {
expect_static_and_lambda_match<HaierAction<>>(HAIER_CODE, sizeof(HAIER_CODE), haier_code, HAIER_GOLDEN);
}
TEST(IrCodeEncodersTest, MirageStaticAndLambdaMatchGolden) {
expect_static_and_lambda_match<MirageAction<>>(MIRAGE_CODE, sizeof(MIRAGE_CODE), mirage_code, MIRAGE_GOLDEN);
}
TEST(IrCodeEncodersTest, AehaStaticAndLambdaMatchGolden) {
Open<AEHAAction<>> fixed, lambda;
for (auto *action : {&fixed, &lambda}) {
// TemplatableFn fields take functions, not raw constants
action->set_address([]() -> uint16_t { return AEHA_ADDRESS; });
action->set_carrier_frequency([]() -> uint32_t { return 38000; });
}
fixed.set_data_static(AEHA_CODE, sizeof(AEHA_CODE));
lambda.set_data_template(aeha_code);
EXPECT_EQ(encode(fixed), AEHA_GOLDEN);
EXPECT_EQ(encode(lambda), AEHA_GOLDEN);
}
TEST(IrCodeEncodersTest, StructEncodersMatchGolden) {
RemoteTransmitData haier, mirage, aeha;
HaierProtocol().encode(&haier, HaierData{haier_code()});
MirageProtocol().encode(&mirage, MirageData{mirage_code()});
AEHAData aeha_data;
aeha_data.address = AEHA_ADDRESS;
aeha_data.data = aeha_code();
AEHAProtocol().encode(&aeha, aeha_data);
EXPECT_EQ(haier.get_data(), HAIER_GOLDEN);
EXPECT_EQ(mirage.get_data(), MIRAGE_GOLDEN);
EXPECT_EQ(aeha.get_data(), AEHA_GOLDEN);
}
TEST(IrCodeEncodersTest, RoundTripDecodes) {
expect_decodes_to<HaierProtocol>(with_trailing_space(HAIER_GOLDEN), haier_code());
expect_decodes_to<MirageProtocol>(with_trailing_space(MIRAGE_GOLDEN), mirage_code());
expect_decodes_to<AEHAProtocol>(AEHA_GOLDEN, aeha_code());
auto aeha = AEHAProtocol().decode(RemoteReceiveData(AEHA_GOLDEN, 25, TOLERANCE_MODE_PERCENTAGE));
EXPECT_EQ(aeha.value_or(AEHAData{}).address, AEHA_ADDRESS);
}
} // namespace esphome::remote_base::testing