diff options
Diffstat (limited to 'docs/3.1/power__mgt_8h_source.html')
-rw-r--r-- | docs/3.1/power__mgt_8h_source.html | 87 |
1 files changed, 45 insertions, 42 deletions
diff --git a/docs/3.1/power__mgt_8h_source.html b/docs/3.1/power__mgt_8h_source.html index eee2ca56..cc4dbbfc 100644 --- a/docs/3.1/power__mgt_8h_source.html +++ b/docs/3.1/power__mgt_8h_source.html @@ -112,57 +112,60 @@ $(document).ready(function(){initNavTree('power__mgt_8h_source.html','');}); <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef POWER_MGT_H</span></div> <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define POWER_MGT_H</span></div> <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div> -<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "pixeltypes.h"</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="_fast_l_e_d_8h.html">FastLED.h</a>"</span></div> <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> </div> -<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> FASTLED_NAMESPACE_BEGIN</div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include "pixeltypes.h"</span></div> <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> </div> -<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div> -<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// Power Control setup functions</span></div> -<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">//</span></div> -<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// Example:</span></div> -<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// set_max_power_in_volts_and_milliamps( 5, 400);</span></div> -<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">//</span></div> -<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div> -<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">void</span> set_max_power_in_volts_and_milliamps( uint8_t volts, uint32_t milliamps);</div> -<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">void</span> set_max_power_in_milliwatts( uint32_t powerInmW);</div> -<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> -<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> set_max_power_indicator_LED( uint8_t pinNumber); <span class="comment">// zero = no indicator LED</span></div> -<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> -<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div> -<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Power Control 'show' and 'delay' functions</span></div> -<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">//</span></div> -<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// These are drop-in replacements for FastLED.show() and FastLED.delay()</span></div> -<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// In order to use these, you have to actually replace your calls to</span></div> -<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// FastLED.show() and FastLED.delay() with these two functions.</span></div> -<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">//</span></div> -<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// Example:</span></div> -<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// // was: FastLED.show();</span></div> -<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// // now is:</span></div> -<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// show_at_max_brightness_for_power();</span></div> -<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">//</span></div> -<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> -<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keywordtype">void</span> show_at_max_brightness_for_power();</div> -<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keywordtype">void</span> delay_at_max_brightness_for_power( uint16_t ms);</div> -<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> -<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> -<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Power Control internal helper functions</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> FASTLED_NAMESPACE_BEGIN</div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// Power Control setup functions</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">//</span></div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// Example:</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">// set_max_power_in_volts_and_milliamps( 5, 400);</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">//</span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">void</span> set_max_power_in_volts_and_milliamps( uint8_t volts, uint32_t milliamps);</div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">void</span> set_max_power_in_milliwatts( uint32_t powerInmW);</div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> set_max_power_indicator_LED( uint8_t pinNumber); <span class="comment">// zero = no indicator LED</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Power Control 'show' and 'delay' functions</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">//</span></div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// These are drop-in replacements for FastLED.show() and FastLED.delay()</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// In order to use these, you have to actually replace your calls to</span></div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// FastLED.show() and FastLED.delay() with these two functions.</span></div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Example:</span></div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// // was: FastLED.show();</span></div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// // now is:</span></div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// show_at_max_brightness_for_power();</span></div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">//</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">void</span> show_at_max_brightness_for_power();</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span> delay_at_max_brightness_for_power( uint16_t ms);</div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div> -<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> uint32_t calculate_unscaled_power_mW( <span class="keyword">const</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a>* ledbuffer, uint16_t numLeds);</div> -<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> -<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> uint8_t calculate_max_brightness_for_power_mW( uint8_t target_brightness, uint32_t max_power_mW);</div> -<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> -<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> FASTLED_NAMESPACE_END</div> -<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// POWER_MGT_H</span></div> -<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div> -<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="preprocessor">#endif</span></div> -<div class="ttc" id="struct_c_r_g_b_html"><div class="ttname"><a href="struct_c_r_g_b.html">CRGB</a></div><div class="ttdoc">Representation of an RGB pixel (Red, Green, Blue) </div><div class="ttdef"><b>Definition:</b> <a href="pixeltypes_8h_source.html#l00088">pixeltypes.h:88</a></div></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment">// Power Control internal helper functions</span></div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> uint32_t calculate_unscaled_power_mW( <span class="keyword">const</span> <a class="code" href="struct_c_r_g_b.html">CRGB</a>* ledbuffer, uint16_t numLeds);</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> uint8_t calculate_max_brightness_for_power_mW( uint8_t target_brightness, uint32_t max_power_mW);</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> FASTLED_NAMESPACE_END</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// POWER_MGT_H</span></div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif</span></div> +<div class="ttc" id="struct_c_r_g_b_html"><div class="ttname"><a href="struct_c_r_g_b.html">CRGB</a></div><div class="ttdoc">Representation of an RGB pixel (Red, Green, Blue) </div><div class="ttdef"><b>Definition:</b> <a href="pixeltypes_8h_source.html#l00090">pixeltypes.h:90</a></div></div> +<div class="ttc" id="_fast_l_e_d_8h_html"><div class="ttname"><a href="_fast_l_e_d_8h.html">FastLED.h</a></div><div class="ttdoc">central include file for FastLED, defines the CFastLED class/object </div></div> </div><!-- fragment --></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><b>power_mgt.h</b></li> - <li class="footer">Generated on Thu Dec 10 2015 14:02:36 for FastLED by + <li class="footer">Generated on Sat Feb 13 2016 13:28:34 for FastLED by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li> </ul> |