M5UnitUnified 0.2.0 git rev:9e1ffe1
Loading...
Searching...
No Matches
M5UnitUnified.hpp
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
3 *
4 * SPDX-License-Identifier: MIT
5 */
16#ifndef M5_UNIT_UNIFIED_HPP
17#define M5_UNIT_UNIFIED_HPP
18
19#include "M5UnitComponent.hpp"
20#include <M5HAL.hpp>
21#if defined(M5_UNIT_UNIFIED_USING_RMT_V2)
22#else
23#include <driver/rmt.h>
24#endif
25#include <vector>
26#include <string>
27
28class TwoWire;
29class HardwareSerial;
30
35namespace m5 {
40namespace unit {
41class Component;
42
47class UnitUnified {
48public:
49 using container_type = std::vector<Component*>;
50
54 UnitUnified() = default;
55 UnitUnified(const UnitUnified&) = delete;
56 UnitUnified(UnitUnified&&) noexcept = default;
58
62 UnitUnified& operator=(const UnitUnified&) = delete;
63
64 UnitUnified& operator=(UnitUnified&&) noexcept = default;
66
69
75 bool add(Component& u, TwoWire& wire);
83 bool add(Component& u, const int8_t rx_pin, const int8_t tx_pin);
90 bool add(Component& u, HardwareSerial& wire);
97 bool add(Component& u, m5::hal::bus::Bus* bus);
99
101 bool begin();
103 void update(const bool force = false);
104
106 std::string debugInfo() const;
107
108protected:
109 bool add_children(Component& u);
110 std::string make_unit_info(const Component* u, const uint8_t indent = 0) const;
111
112protected:
113 container_type _units{};
114
115private:
116 static uint32_t _registerCount;
117};
118
119} // namespace unit
120} // namespace m5
121
122#endif
Main header of M5UnitComponent.
std::string debugInfo() const
Output information for debug.
Definition M5UnitUnified.cpp:146
bool begin()
Begin of all units under management.
Definition M5UnitUnified.cpp:124
void update(const bool force=false)
Update of all units under management.
Definition M5UnitUnified.cpp:136
bool add(Component &u, TwoWire &wire)
Adding unit to be managed (I2C)
Definition M5UnitUnified.cpp:41
Top level namespace of M5stack.
Definition test_helper.hpp:18
Unit-related namespace.