power_mgt.h File Reference

Detailed Description

Functions to limit the power used by FastLED.

Definition in file power_mgt.h.

#include "FastLED.h"
#include "pixeltypes.h"

Go to the source code of this file.

Functions
Power Control Setup Functions
Functions to initialize the power control system
void	set_max_power_in_volts_and_milliamps (uint8_t volts, uint32_t milliamps)
	Set the maximum power used in milliamps for a given voltage.
void	set_max_power_in_milliwatts (uint32_t powerInmW)
	Set the maximum power used in watts.
void	set_max_power_indicator_LED (uint8_t pinNumber)
	Select a pin with an LED that will be flashed to indicate that power management is pulling down the brightness.
Power Control 'show()' and 'delay()' Functions
Power-limiting replacements of show() and delay(). These are drop-in replacements for CFastLED::show() and CFastLED::delay(). In order to use these, you have to actually replace your calls to CFastLED::show() and CFastLED::delay() with these two functions. Deprecated: These functions are deprecated as of 6ebcb64, circa 2015. Do not use them for new programs.
void	show_at_max_brightness_for_power ()
	Similar to CFastLED::show(), but pre-adjusts brightness to keep below the power threshold.
void	delay_at_max_brightness_for_power (uint16_t ms)
	Similar to CFastLED::delay(), but pre-adjusts brightness to keep below the power threshold.
Power Control Internal Helper Functions
Internal helper functions for power control.
uint32_t	calculate_unscaled_power_mW (const CRGB *ledbuffer, uint16_t numLeds)
	Determines how many milliwatts the current LED data would draw at max brightness (255)
uint8_t	calculate_max_brightness_for_power_mW (const CRGB *ledbuffer, uint16_t numLeds, uint8_t target_brightness, uint32_t max_power_mW)
	Determines the highest brightness level you can use and still stay under the specified power budget for a given set of LEDs.
uint8_t	calculate_max_brightness_for_power_vmA (const CRGB *ledbuffer, uint16_t numLeds, uint8_t target_brightness, uint32_t max_power_V, uint32_t max_power_mA)
	Determines the highest brightness level you can use and still stay under the specified power budget for a given set of LEDs.
uint8_t	calculate_max_brightness_for_power_mW (uint8_t target_brightness, uint32_t max_power_mW)
	Determines the highest brightness level you can use and still stay under the specified power budget for all sets of LEDs.