addDriver()

void fl::ChannelManager::addDriver	(	int	priority,
		fl::shared_ptr< IChannelDriver >	driver )

Add a driver with priority (higher priority = preferred)

Parameters

priority	Driver priority (higher values = higher priority)
driver	Shared driver implementation (allows caller to retain reference for testing)

Note

Platform-specific code calls this during static initialization

Drivers are automatically sorted by priority on each insertion

Driver name is obtained via driver->getName()

If driver->getName() returns empty string, driver is rejected (emits FL_WARN and returns)

If a driver with the same name already exists, it will be replaced:

1. FL_WARN emitted about replacement
2. All drivers polled until READY state (1 second timeout)
3. Old driver removed (shared_ptr may trigger deletion)
4. New driver added with specified priority

Definition at line 138 of file manager.cpp.hpp.

                                                                                {
    if (!driver) {
        (void)addDriverSlow(priority, driver, nullptr, AddDriverSlowReason::NULL_DRIVER);
        return;
    }
 
    // Get driver name from the driver itself
    fl::string engineName = driver->getName();
 
    // Reject drivers with empty names
    if (engineName.empty()) {
        (void)addDriverSlow(priority, driver, &engineName, AddDriverSlowReason::EMPTY_NAME);
        return;
    }
 
    // A duplicate name takes the uncommon replacement/idempotency path.
    for (const auto& entry : mDrivers) {
        if (entry.name == engineName) {
            if (!addDriverSlow(priority, driver, &engineName, AddDriverSlowReason::DUPLICATE_NAME)) {
                return;
            }
            break;
        }
    }
 
    // Respect exclusive driver mode: auto-disable if name doesn't match exclusive driver
    bool enabled = true;  // Default: enabled
    if (!mExclusiveDriver.empty()) {
        enabled = (engineName == mExclusiveDriver);  // Only enable if matches exclusive driver
    }
 
    mDrivers.push_back({priority, driver, engineName, enabled});
    driver->setPollNeededCallback(mPollNeededCallback);
 
    // Build capability string for debug output. Gate the entire block behind
    // FASTLED_HAS_DBG because the `capStr` exists ONLY to feed the FL_DBG
    // line below. On release builds (FASTLED_HAS_DBG=0 — i.e. the default
    // SKETCH_HAS_LARGE_MEMORY=0 path AND any -DFASTLED_LOG_VERBOSITY=0
    // opt-in build via the gating in fl/log/log.h) the FL_DBG itself is a
    // no-op, but without this guard the `fl::string capStr` allocation +
    // two `if` branches still emitted code. See #2773 item 2.3 follow-up.
#if FASTLED_HAS_DBG
    IChannelDriver::Capabilities caps = driver->getCapabilities();
    fl::string capStr;
    if (caps.supportsClockless) {
        capStr += "CLOCKLESS";
    }
    if (caps.supportsSpi) {
        if (!capStr.empty()) capStr += "|";
        capStr += "SPI";
    }
    if (capStr.empty()) {
        capStr = "NONE";
    }
 
    FL_DBG("ChannelManager: Added driver '" << engineName.c_str() << "' (priority " << priority << ", caps: " << capStr.c_str() << ")");
#endif
 
    // Sort drivers by priority descending (higher values first) after each insertion
    // Higher priority values = higher precedence (e.g., priority 50 selected over priority 10)
    // Only 1-4 drivers expected — sort_small skips the quicksort_impl
    // instantiation entirely (see #2907 for the bloat motivation).
    fl::sort_small(mDrivers.begin(), mDrivers.end());
}

References addDriverSlow(), fl::basic_string::c_str(), DUPLICATE_NAME, fl::basic_string::empty(), EMPTY_NAME, FL_DBG, mDrivers, mExclusiveDriver, mPollNeededCallback, NULL_DRIVER, fl::sort_small(), fl::IChannelDriver::Capabilities::supportsClockless, and fl::IChannelDriver::Capabilities::supportsSpi.

Referenced by setExclusiveDriver().

Here is the call graph for this function:

Here is the caller graph for this function: