M5UnitUnified.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_UNIFIED_HPP
#define M5_UNIT_UNIFIED_HPP
 
#include "M5UnitComponent.hpp"
#include <M5HAL.hpp>
#if defined(M5_UNIT_UNIFIED_USING_RMT_V2)
#else
#include <driver/rmt.h>
#endif
#include <vector>
#include <string>
 
#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
class TwoWire;
class HardwareSerial;
class SPIClass;
struct SPISettings;
#endif
 
namespace m5 {
class I2C_Class;
namespace unit {
class Component;
 
class UnitUnified {
public:
    using container_type = std::vector<Component*>;
 
    UnitUnified()                       = default;
    UnitUnified(const UnitUnified&)     = delete;
    UnitUnified(UnitUnified&&) noexcept = default;
 
    UnitUnified& operator=(const UnitUnified&) = delete;
 
    UnitUnified& operator=(UnitUnified&&) noexcept = default;
 
#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
    bool add(Component& u, TwoWire& wire);
#endif
#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && __has_include(<driver/i2c_master.h>))
    bool add(Component& u, i2c_master_bus_handle_t bus);
#endif
#if defined(DOXYGEN_PROCESS) || (defined(ESP_PLATFORM) && !__has_include(<driver/i2c_master.h>))
    bool add(Component& u, const i2c_port_t port, const gpio_num_t sda, const gpio_num_t scl);
#endif
    bool add(Component& u, m5::I2C_Class& i2c);
 
 
    bool add(Component& u, const int8_t rx_pin, const int8_t tx_pin);
 
#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
    bool add(Component& u, HardwareSerial& serial);
#endif
#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
    bool add(Component& u, const uart_port_t uart_num);
#endif
 
#if defined(ARDUINO) || defined(DOXYGEN_PROCESS)
    bool add(Component& u, SPIClass& spi, const SPISettings& settings);
#endif
#if defined(ESP_PLATFORM) || defined(DOXYGEN_PROCESS)
    bool add(Component& u, spi_device_handle_t handle, const gpio_num_t cs = GPIO_NUM_NC);
#endif
 
 
    bool add(Component& u, m5::hal::bus::Bus* bus);
 
    bool begin();
    void update(const bool force = false);
 
    std::string debugInfo() const;
 
protected:
    bool add_children(Component& u);
    std::string make_unit_info(const Component* u, const uint8_t indent = 0) const;
 
protected:
    container_type _units{};
 
private:
    static uint32_t _registerCount;
};
 
}  // namespace unit
}  // namespace m5
 
#endif