diff options
Diffstat (limited to 'power_mgt.h')
| -rw-r--r-- | power_mgt.h | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/power_mgt.h b/power_mgt.h new file mode 100644 index 00000000..60b92e95 --- /dev/null +++ b/power_mgt.h @@ -0,0 +1,48 @@ +#ifndef POWER_MGT_H +#define POWER_MGT_H + +#include "pixeltypes.h" + +// Power Control setup functions +// +// Example: +// set_max_power_in_volts_and_milliamps( 5, 400); +// +void set_max_power_in_volts_and_milliamps( uint8_t volts, uint32_t milliamps); +void set_max_power_in_milliwatts( uint32_t powerInmW); + +void set_max_power_indicator_LED( uint8_t pinNumber); // zero = no indicator LED + + +// Power Control 'show' and 'delay' functions +// +// These are drop-in replacements for FastLED.show() and FastLED.delay() +// In order to use these, you have to actually replace your calls to +// FastLED.show() and FastLED.delay() with these two functions. +// +// Example: +// // was: FastLED.show(); +// // now is: +// show_at_max_brightness_for_power(); +// +void show_at_max_brightness_for_power(); +void delay_at_max_brightness_for_power( uint16_t ms); + + +// Power Control internal helper functions +// +// calculate_unscaled_power_mW tells you how many milliwatts the current +// LED data would draw at brightness = 255. +// +// calculate_max_brightness_for_power_mW tells you the highest brightness +// level you can use and still stay under the specified power budget. It +// takes a 'target brightness' which is the brightness you'd ideally like +// to use. The result from this function will be no higher than the +// target_brightess you supply, but may be lower. +uint32_t calculate_unscaled_power_mW( const CRGB* ledbuffer, uint16_t numLeds); + +uint8_t calculate_max_brightness_for_power_mW( uint8_t target_brightness, uint32_t max_power_mW); + + +// POWER_MGT_H +#endif |