m5_unit_unified_rs485_wiring.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_UNIFIED_RS485_WIRING_HPP
#define M5_UNIT_UNIFIED_RS485_WIRING_HPP
 
#include "../unit/unit_SIT3088.hpp"
#include <M5UnitUnified.hpp>
#include <wiring/m5_unit_unified_wiring.hpp>  // core wiring: defaultUartSerial / uartPortHandle / defaultUartPort
 
#if defined(ARDUINO)
#include <HardwareSerial.h>
#endif
 
namespace m5 {
namespace unit {
namespace rs485 {
namespace wiring {
 
#if defined(__M5UNIFIED_HPP__)
 
struct AtomicBasePinPair {
    int8_t rx;  
    int8_t tx;  
};
 
inline AtomicBasePinPair atomicBaseUartPins()
{
    switch (M5.getBoard()) {
        case m5::board_t::board_M5AtomLite:
        case m5::board_t::board_M5AtomMatrix:
            return {22, 19};
        case m5::board_t::board_M5AtomS3:
        case m5::board_t::board_M5AtomS3Lite:
        case m5::board_t::board_M5AtomS3R:
        case m5::board_t::board_M5AtomEchoS3R:
        case m5::board_t::board_M5AtomS3RCam:
        case m5::board_t::board_M5AtomS3RExt:
            return {5, 6};
        default:
            return {-1, -1};
    }
}
 
#if defined(ARDUINO)
inline bool addAtomicBaseUART(UnitUnified& units, Component& unit, const uint32_t baud = 115200,
                              const uint32_t config = SERIAL_8N1)
{
    const auto p = atomicBaseUartPins();
    if (p.rx < 0 || p.tx < 0) {
        M5_LIB_LOGE("wiring: addAtomicBaseUART unsupported board=0x%02x", static_cast<int>(M5.getBoard()));
        return false;
    }
    M5_LIB_LOGI("wiring: addAtomicBaseUART board=0x%02x rx=%d tx=%d baud=%lu", static_cast<int>(M5.getBoard()),
                static_cast<int>(p.rx), static_cast<int>(p.tx), static_cast<unsigned long>(baud));
 
    HardwareSerial& serial = m5::unit::wiring::defaultUartSerial();
    serial.end();
    serial.begin(baud, config, p.rx, p.tx);
    return units.add(unit, serial);
}
#else   // ESP-IDF native
inline bool addAtomicBaseUART(UnitUnified& units, Component& unit, const uint32_t baud = 115200,
                              const m5::unit::wiring::UartConfig config = m5::unit::wiring::UartConfig::Default)
{
    const auto p = atomicBaseUartPins();
    if (p.rx < 0 || p.tx < 0) {
        M5_LIB_LOGE("wiring: addAtomicBaseUART unsupported board=0x%02x", static_cast<int>(M5.getBoard()));
        return false;
    }
    M5_LIB_LOGI("wiring(ESP-IDF): addAtomicBaseUART board=0x%02x rx=%d tx=%d baud=%u", static_cast<int>(M5.getBoard()),
                static_cast<int>(p.rx), static_cast<int>(p.tx), static_cast<unsigned>(baud));
 
    auto port = m5::unit::wiring::uartPortHandle(m5::unit::wiring::defaultUartPort(), static_cast<gpio_num_t>(p.rx),
                                                 static_cast<gpio_num_t>(p.tx), baud, config);
    if (port == UART_NUM_MAX) {
        return false;
    }
    return units.add(unit, port);
}
#endif  // ARDUINO
 
 
struct Tab5BuiltinRS485Pins {
    int8_t rx;   
    int8_t tx;   
    int8_t dir;  
};
 
inline Tab5BuiltinRS485Pins tab5BuiltinRS485Pins()
{
    switch (M5.getBoard()) {
        case m5::board_t::board_M5Tab5:
            return {21, 20, 34};
        default:
            return {-1, -1, -1};
    }
}
 
#if defined(ARDUINO)
inline bool addTab5BuiltinRS485UART(UnitUnified& units, UnitSIT3088& unit, const uint32_t baud = 115200,
                                    const uint32_t config = SERIAL_8N1)
{
    const auto p = tab5BuiltinRS485Pins();
    if (p.rx < 0 || p.tx < 0 || p.dir < 0) {
        M5_LIB_LOGE("wiring: addTab5BuiltinRS485UART unsupported board=0x%02x", static_cast<int>(M5.getBoard()));
        return false;
    }
    M5_LIB_LOGI("wiring: addTab5BuiltinRS485UART board=0x%02x rx=%d tx=%d dir=%d baud=%lu",
                static_cast<int>(M5.getBoard()), static_cast<int>(p.rx), static_cast<int>(p.tx),
                static_cast<int>(p.dir), static_cast<unsigned long>(baud));
 
    auto cfg    = unit.config();
    cfg.dir_pin = p.dir;
    unit.config(cfg);
 
    HardwareSerial& serial = m5::unit::wiring::defaultUartSerial();
    serial.end();
    serial.begin(baud, config, p.rx, p.tx);
    return units.add(unit, serial);
}
#else   // ESP-IDF native
inline bool addTab5BuiltinRS485UART(UnitUnified& units, UnitSIT3088& unit, const uint32_t baud = 115200,
                                    const m5::unit::wiring::UartConfig config = m5::unit::wiring::UartConfig::Default)
{
    (void)units;
    (void)unit;
    (void)baud;
    (void)config;
    M5_LIB_LOGE("wiring(ESP-IDF): addTab5BuiltinRS485UART is not yet supported");
    return false;
}
#endif  // ARDUINO
 
#endif  // __M5UNIFIED_HPP__
 
}  // namespace wiring
}  // namespace rs485
}  // namespace unit
}  // namespace m5
#endif  // M5_UNIT_UNIFIED_RS485_WIRING_HPP