ir_rmt_items.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_INFRARED_IR_RMT_ITEMS_HPP
#define M5_UNIT_INFRARED_IR_RMT_ITEMS_HPP
 
#include "ir_codec.hpp"
 
namespace m5 {
namespace unit {
namespace ir {
 
inline gpio::m5_rmt_item_t makeItem(uint16_t mark_us, uint16_t space_us)
{
    gpio::m5_rmt_item_t item{};
    item.duration0 = mark_us;
    item.level0    = 1;  // Mark: carrier ON
    item.duration1 = space_us;
    item.level1    = 0;  // Space: carrier OFF
    return item;
}
 
inline gpio::m5_rmt_item_t makeTerminator(uint16_t mark_us)
{
    return makeItem(mark_us, 0);
}
 
inline bool matchDuration(uint16_t actual, uint16_t expected, uint16_t tolerance)
{
    return (actual >= expected - tolerance) && (actual <= expected + tolerance);
}
 
void encodePulseDistance(item_container_type& items, uint32_t data, uint8_t bits, uint16_t bit_mark, uint16_t one_space,
                         uint16_t zero_space, bool lsb_first = true);
 
uint32_t decodePulseDistance(const gpio::m5_rmt_item_t* items, uint32_t num, uint32_t& data, uint8_t bits,
                             uint16_t bit_mark, uint16_t one_space, uint16_t zero_space, uint16_t tolerance,
                             bool lsb_first = true);
 
void encodePulseWidth(item_container_type& items, uint32_t data, uint8_t bits, uint16_t one_mark, uint16_t zero_mark,
                      uint16_t bit_space, bool lsb_first = true);
 
uint32_t decodePulseWidth(const gpio::m5_rmt_item_t* items, uint32_t num, uint32_t& data, uint8_t bits,
                          uint16_t one_mark, uint16_t zero_mark, uint16_t bit_space, uint16_t tolerance,
                          bool lsb_first = true);
 
void encodeManchester(item_container_type& items, uint32_t data, uint8_t bits, uint16_t half_bit,
                      bool rc5_polarity = true, bool msb_first = true);
 
uint32_t decodeManchester(const gpio::m5_rmt_item_t* items, uint32_t num, uint32_t& data, uint8_t bits,
                          uint16_t half_bit, uint16_t tolerance, bool rc5_polarity = true, bool msb_first = true);
 
}  // namespace ir
}  // namespace unit
}  // namespace m5
#endif