m5_unit_unified_infrared_wiring.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_UNIFIED_INFRARED_WIRING_HPP
#define M5_UNIT_UNIFIED_INFRARED_WIRING_HPP
 
#include <wiring/m5_unit_unified_wiring.hpp>  // M5UU core wiring (UnitUnified/Component/Wire + addI2C/addGPIO)
#include "../unit/unit_IR.hpp"                // UnitIR (addBuiltinIrRx sets its rx_pull)
 
namespace m5 {
namespace unit {
namespace infrared {
namespace wiring {
 
#if defined(__M5UNIFIED_HPP__)
 
 
inline bool addHatPIR(UnitUnified& units, Component& unit)
{
    int in = -1;
    switch (M5.getBoard()) {
        case m5::board_t::board_M5StickC:
        case m5::board_t::board_M5StickCPlus:
        case m5::board_t::board_M5StickCPlus2:
        case m5::board_t::board_M5StackCoreInk:
            in = 36;
            break;
        case m5::board_t::board_M5StickS3:
            in = 1;
            break;
        case m5::board_t::board_ArduinoNessoN1:
            in = 2;
            break;
        default:
            M5_LIB_LOGE("wiring: addHatPIR unsupported board=0x%02x", (int)M5.getBoard());
            return false;
    }
    M5_LIB_LOGI("wiring: addHatPIR board=0x%02x in=%d", (int)M5.getBoard(), in);
    return units.add(unit, static_cast<int8_t>(in), static_cast<int8_t>(-1));
}
 
 
inline int8_t builtinIrTxPin()
{
    switch (M5.getBoard()) {
        case m5::board_t::board_M5StickC:
        case m5::board_t::board_M5StickCPlus:
        case m5::board_t::board_ArduinoNessoN1:
            return 9;
        case m5::board_t::board_M5StickCPlus2:
            return 19;
        case m5::board_t::board_M5StickS3:
            return 46;
        case m5::board_t::board_M5AtomLite:
        case m5::board_t::board_M5AtomMatrix:
        case m5::board_t::board_M5AtomU:
        case m5::board_t::board_M5AtomS3U:
            return 12;
        case m5::board_t::board_M5AtomS3:
        case m5::board_t::board_M5AtomS3Lite:
        case m5::board_t::board_M5Capsule:
            return 4;
        case m5::board_t::board_M5AtomS3R:
        case m5::board_t::board_M5AtomVoiceS3R:
            return 47;
        case m5::board_t::board_M5NanoC6:
        case m5::board_t::board_M5NanoH2:
            return 3;
        case m5::board_t::board_M5Cardputer:
        case m5::board_t::board_M5CardputerADV:
            return 44;
        default:
            return -1;
    }
}
 
inline int8_t builtinIrRxPin()
{
    switch (M5.getBoard()) {
        case m5::board_t::board_M5StickS3:
            return 42;
        default:
            return -1;
    }
}
 
inline bool addBuiltinIrTx(UnitUnified& units, Component& unit)
{
    const int8_t tx = builtinIrTxPin();
    if (tx < 0) {
        M5_LIB_LOGE("wiring: no built-in IR TX on board=0x%02x", (int)M5.getBoard());
        return false;
    }
    if (M5.getBoard() == m5::board_t::board_M5StickS3) {
        M5.Power.setExtOutput(true);
    }
    M5_LIB_LOGI("wiring: addBuiltinIrTx tx=%d", tx);
    return units.add(unit, static_cast<int8_t>(-1), tx);
}
 
inline bool addBuiltinIrRx(UnitUnified& units, UnitIR& unit)
{
    const int8_t rx = builtinIrRxPin();
    if (rx < 0) {
        M5_LIB_LOGE("wiring: no built-in IR RX on board=0x%02x", (int)M5.getBoard());
        return false;
    }
    if (M5.getBoard() == m5::board_t::board_M5StickS3) {
        M5.Speaker.end();
        M5.Power.setExtOutput(true);
        auto cfg    = unit.config();
        cfg.rx_pull = gpio::RxPull::Up;
        unit.config(cfg);
    }
    M5_LIB_LOGI("wiring: addBuiltinIrRx rx=%d", rx);
    return units.add(unit, rx, static_cast<int8_t>(-1));
}
 
#endif  // __M5UNIFIED_HPP__
 
}  // namespace wiring
}  // namespace infrared
}  // namespace unit
}  // namespace m5
#endif  // M5_UNIT_UNIFIED_INFRARED_WIRING_HPP