wled.h

Go to the documentation of this file.

#pragma once
 
#include "fl/remote/remote.h"
#include "fl/stl/vector.h"
#include "fl/stl/span.h"  // IWYU pragma: keep
#include "fl/stl/memory.h"  // IWYU pragma: keep
#include "fl/stl/shared_ptr.h"  // IWYU pragma: keep
 
// WLED subdirectory components (always available)
#include "fl/fx/wled/ifastled.h"  // IWYU pragma: keep
#include "fl/fx/wled/adapter.h"  // IWYU pragma: keep
#include "fl/fx/wled/client.h"  // IWYU pragma: keep
 
// WLED-specific Remote extension requires JSON support
#include "fl/fx/wled/segment.h"
#include "fl/fx/wled/json_helpers.h"  // IWYU pragma: keep
#include "fl/stl/noexcept.h"
 
namespace fl {

class WLED : public Remote {
public:
    WLED() FL_NOEXCEPT;

    WLED(RequestSource source, ResponseSink sink) : Remote(source, sink) {}

    void setState(const fl::json& wledState);

    fl::json getState() const;

    bool getOn() const { return mWledOn; }

    u8 getBrightness() const { return mWledBri; }

    u16 getTransition() const { return mTransition; }

    i16 getPreset() const { return mPreset; }

    i16 getPlaylist() const { return mPlaylist; }

    u8 getLiveOverride() const { return mLiveOverride; }

    u8 getMainSegment() const { return mMainSegment; }

    bool getNightlightOn() const { return mNightlightOn; }

    u8 getNightlightDuration() const { return mNightlightDuration; }

    u8 getNightlightMode() const { return mNightlightMode; }

    u8 getNightlightTargetBrightness() const { return mNightlightTargetBrightness; }

    fl::json getPlaylistConfig() const;

    bool hasPlaylistConfig() const { return !mPlaylistPresets.empty(); }

    bool getUdpSend() const { return mUdpSend; }

    bool getUdpReceive() const { return mUdpReceive; }

    size_t getSegmentCount() const { return mSegments.size(); }

    const WLEDSegment& getSegment(size_t index) const { return mSegments[index]; }

    const fl::vector<WLEDSegment>& getSegments() const { return mSegments; }

    const WLEDSegment* findSegmentById(u8 id) const;
 
private:
    fl::optional<fl::json> stubRequestSource();

    void stubResponseSink(const fl::json& response);
 
    // WLED state (runtime-only, no persistence)
    bool mWledOn = false;           // WLED on/off state
    u8 mWledBri = 255;         // WLED brightness (0-255)
    u16 mTransition = 7;       // Crossfade duration (×100ms, default 700ms)
    i16 mPreset = -1;           // Active preset ID (-1 = none)
    i16 mPlaylist = -1;         // Active playlist ID (-1 = none)
    u8 mLiveOverride = 0;      // Live data override (0=off, 1=override, 2=until reboot)
    u8 mMainSegment = 0;       // Main segment for global controls
 
    // Nightlight state
    bool mNightlightOn = false;          // Nightlight active
    u8 mNightlightDuration = 60;    // Nightlight duration in minutes (default 60)
    u8 mNightlightMode = 1;         // Nightlight mode (0=instant, 1=fade, 2=color, 3=sunrise)
    u8 mNightlightTargetBrightness = 0;  // Target brightness for nightlight end
 
    // Playlist configuration
    fl::vector<i16> mPlaylistPresets;      // Array of preset IDs to cycle through
    fl::vector<u16> mPlaylistDurations;   // Array of durations (seconds) for each preset
    fl::vector<u16> mPlaylistTransitions; // Array of transition times (×100ms) for each preset
    u16 mPlaylistRepeat = 0;              // Number of cycles (0=infinite)
    i16 mPlaylistEnd = -1;                 // End preset ID (after playlist completes, -1=none)
    bool mPlaylistRandomize = false;           // True for randomized playback order
 
    // UDP sync settings
    bool mUdpSend = false;    // Send UDP broadcast packets on state change
    bool mUdpReceive = true;  // Receive UDP broadcast packets
 
    // Segment configurations
    fl::vector<WLEDSegment> mSegments;  // Array of segment configurations
};
 
} // namespace fl