AutoResearchFlexIo.h

Go to the documentation of this file.

 
#pragma once
 
#include "FastLED.h"
#include "fl/channels/bus.h"
#include "fl/channels/manager.h"
#include "fl/stl/int.h"
#include "fl/stl/json.h"
#include "fl/stl/string.h"
#include "platforms/is_platform.h"
 
namespace autoresearch {
namespace flex_io {

inline fl::string siliconName() FL_NO_EXCEPT {
#if defined(FL_IS_ESP_32DEV)
    return fl::string::from_literal("ESP32");
#elif defined(FL_IS_ESP_32S2)
    return fl::string::from_literal("ESP32-S2");
#elif defined(FL_IS_ESP_32S3)
    return fl::string::from_literal("ESP32-S3");
#elif defined(FL_IS_ESP_32C3)
    return fl::string::from_literal("ESP32-C3");
#elif defined(FL_IS_ESP_32C5)
    return fl::string::from_literal("ESP32-C5");
#elif defined(FL_IS_ESP_32C6)
    return fl::string::from_literal("ESP32-C6");
#elif defined(FL_IS_ESP_32H2)
    return fl::string::from_literal("ESP32-H2");
#elif defined(FL_IS_ESP_32P4)
    return fl::string::from_literal("ESP32-P4");
#elif defined(FL_IS_TEENSY_4X)
    return fl::string::from_literal("Teensy-4.x");
#elif defined(FL_IS_STUB)
    return fl::string::from_literal("Host-stub");
#else
    return fl::string::from_literal("Unknown");
#endif
}

inline fl::string idfVersion() FL_NO_EXCEPT {
#if defined(FL_IS_ESP32) && defined(ESP_IDF_VERSION_MAJOR)
    fl::sstream s;
    s << ESP_IDF_VERSION_MAJOR;
#if defined(ESP_IDF_VERSION_MINOR)
    s << '.' << ESP_IDF_VERSION_MINOR;
#endif
#if defined(ESP_IDF_VERSION_PATCH)
    s << '.' << ESP_IDF_VERSION_PATCH;
#endif
    return s.str();
#else
    return fl::string::from_literal("n/a");
#endif
}

inline fl::vector<fl::string> registeredDriverNames() FL_NO_EXCEPT {
    fl::vector<fl::string> names;
    auto& manager = fl::channelManager();
    auto infos = manager.getDriverInfos();
    for (const auto& info : infos) {
        if (!info.name.empty()) {
            names.push_back(info.name);
        }
    }
    return names;
}

inline fl::string firstDriverName() FL_NO_EXCEPT {
    auto names = registeredDriverNames();
    if (names.empty()) {
        return fl::string::from_literal("<none>");
    }
    return names[0];
}

inline fl::json buildDeviceInfo(fl::u8 instance) FL_NO_EXCEPT {
    fl::json info = fl::json::object();
    info.set("bus", "FLEX_IO");
    info.set("instance", static_cast<int64_t>(instance));
    // firstDriverName gives the most-preferred registered driver's
    // name — on classic ESP32 this is typically "I2S_SPI" for the
    // FLEX_IO slot; on P4/C6/etc. "PARLIO"; on S3 "LCD_CLOCKLESS".
    info.set("driverName", firstDriverName());
    // Full driver list so the host can pick the FLEX_IO-bound one by
    // name if firstDriverName isn't the FLEX_IO owner.
    fl::json names_arr = fl::json::array();
    for (const auto& n : registeredDriverNames()) {
        names_arr.push_back(n);
    }
    info.set("registeredDriverNames", names_arr);
    info.set("silicon", siliconName());
    info.set("idfVersion", idfVersion());
    info.set("supportedByBuild",
             firstDriverName() != fl::string::from_literal("<none>"));
    return info;
}
 
}  // namespace flex_io
}  // namespace autoresearch