power_mgt.h

Go to the documentation of this file.

#pragma once
 
#include "fl/system/fastled.h"
 
#include "pixeltypes.h"
#include "fl/gfx/rgbw.h"
#include "fl/channels/cled_controller.h"  // IWYU pragma: keep  (controller_unscaled_power_mW)
#include "fl/stl/noexcept.h"

 
 

 


struct PowerModelRGB {
    fl::u8 red_mW;    
    fl::u8 green_mW;  
    fl::u8 blue_mW;   
    fl::u8 dark_mW;   
    float  exponent;  

    constexpr PowerModelRGB()
        FL_NO_EXCEPT : red_mW(5 * 16), green_mW(5 * 11), blue_mW(5 * 15), dark_mW(5 * 1),
          exponent(1.0f) {}

    constexpr PowerModelRGB(fl::u8 r, fl::u8 g, fl::u8 b, fl::u8 d, float e = 1.0f)
        FL_NO_EXCEPT : red_mW(r), green_mW(g), blue_mW(b), dark_mW(d), exponent(e) {}
};

struct PowerModelRGBW {
    fl::u8 red_mW;    
    fl::u8 green_mW;  
    fl::u8 blue_mW;   
    fl::u8 white_mW;  
    fl::u8 dark_mW;   
    float  exponent;  

    constexpr PowerModelRGBW()
        FL_NO_EXCEPT : red_mW(90), green_mW(70), blue_mW(90), white_mW(100), dark_mW(5),
          exponent(1.0f) {}

    constexpr PowerModelRGBW(fl::u8 r, fl::u8 g, fl::u8 b, fl::u8 w, fl::u8 d,
                             float e = 1.0f)
        FL_NO_EXCEPT : red_mW(r), green_mW(g), blue_mW(b), white_mW(w), dark_mW(d),
          exponent(e) {}

    constexpr PowerModelRGB toRGB() const FL_NO_EXCEPT {
        return PowerModelRGB(red_mW, green_mW, blue_mW, dark_mW, exponent);
    }
};

struct PowerModelRGBWW {
    fl::u8 red_mW;        
    fl::u8 green_mW;      
    fl::u8 blue_mW;       
    fl::u8 white_mW;      
    fl::u8 warm_white_mW; 
    fl::u8 dark_mW;       
    float  exponent;      

    constexpr PowerModelRGBWW()
        FL_NO_EXCEPT : red_mW(85), green_mW(65), blue_mW(85),
          white_mW(95), warm_white_mW(95), dark_mW(5),
          exponent(1.0f) {}

    constexpr PowerModelRGBWW(fl::u8 r, fl::u8 g, fl::u8 b,
                              fl::u8 w, fl::u8 ww, fl::u8 d,
                              float e = 1.0f)
        FL_NO_EXCEPT : red_mW(r), green_mW(g), blue_mW(b),
          white_mW(w), warm_white_mW(ww), dark_mW(d),
          exponent(e) {}

    constexpr PowerModelRGB toRGB() const FL_NO_EXCEPT {
        // Distribute white-channel mW evenly across R/G/B. Clamp to 255 (u8
        // max) on overflow — a wrapping static_cast<u8> here would make the
        // brightness limiter *less* conservative on the highest-draw configs
        // (where it most needs to be conservative). The worst-case
        // under-budget per channel from the floor division is 2 mW.
        return PowerModelRGB(
            static_cast<fl::u8>(
                (red_mW + (white_mW + warm_white_mW) / 3) > 255
                    ? 255 : (red_mW + (white_mW + warm_white_mW) / 3)),
            static_cast<fl::u8>(
                (green_mW + (white_mW + warm_white_mW) / 3) > 255
                    ? 255 : (green_mW + (white_mW + warm_white_mW) / 3)),
            static_cast<fl::u8>(
                (blue_mW + (white_mW + warm_white_mW) / 3) > 255
                    ? 255 : (blue_mW + (white_mW + warm_white_mW) / 3)),
            dark_mW,
            exponent);
    }
};

void set_power_model(const PowerModelRGB& model) FL_NO_EXCEPT;

void set_power_scaling_exponent(float exponent) FL_NO_EXCEPT;

float get_power_scaling_exponent() FL_NO_EXCEPT;

void set_power_model(const PowerModelRGBW& model) FL_NO_EXCEPT;

void set_power_model(const PowerModelRGBWW& model) FL_NO_EXCEPT;

PowerModelRGB get_power_model() FL_NO_EXCEPT;

fl::u8 get_white_emitter_mW() FL_NO_EXCEPT;

fl::u32 calculate_unscaled_emitter_power_mW(fl::span<const fl::u8> codes,
                                            fl::u8 emitter_count) FL_NO_EXCEPT;

 


void set_max_power_in_volts_and_milliamps( fl::u8 volts, fl::u32 milliamps) FL_NO_EXCEPT;

void set_max_power_in_milliwatts( fl::u32 powerInmW) FL_NO_EXCEPT;

void set_max_power_indicator_LED( fl::u8 pinNumber) FL_NO_EXCEPT; // zero = no indicator LED

 


void show_at_max_brightness_for_power() FL_NO_EXCEPT;
void delay_at_max_brightness_for_power( fl::u16 ms) FL_NO_EXCEPT;

 


fl::u32 calculate_unscaled_power_mW( const CRGB* ledbuffer, fl::u16 numLeds) FL_NO_EXCEPT;

fl::u32 calculate_unscaled_power_mW(fl::span<const CRGB> leds) FL_NO_EXCEPT;

fl::u32 calculate_unscaled_power_mW(fl::span<const CRGB> leds, const fl::Rgbw& rgbw) FL_NO_EXCEPT;

fl::u32 controller_unscaled_power_mW(const fl::CLEDController& controller) FL_NO_EXCEPT;

fl::u32 dither_reserve_mW(fl::span<const CRGB> leds) FL_NO_EXCEPT;

fl::u32 controller_dither_reserve_mW(const fl::CLEDController& controller) FL_NO_EXCEPT;

fl::u32 scale_power_for_brightness(fl::u32 total_mW, fl::u8 brightness) FL_NO_EXCEPT;

fl::u8 calculate_max_brightness_for_power_mW(const CRGB* ledbuffer, fl::u16 numLeds, fl::u8 target_brightness, fl::u32 max_power_mW) FL_NO_EXCEPT;

fl::u8 calculate_max_brightness_for_power_vmA(const CRGB* ledbuffer, fl::u16 numLeds, fl::u8 target_brightness, fl::u32 max_power_V, fl::u32 max_power_mA) FL_NO_EXCEPT;

fl::u8  calculate_max_brightness_for_power_mW( fl::u8 target_brightness, fl::u32 max_power_mW) FL_NO_EXCEPT;

fl::u32 power_ratio_of_255(fl::u32 num, fl::u32 den) FL_NO_EXCEPT;