blob: c40566dfa5a259c1ddbe607f5b2e41d131ce0a38 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9.1"/>
<title>FastLED: power_mgt.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FastLED
 <span id="projectnumber">3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">power_mgt.h</div> </div>
</div><!--header-->
<div class="contents">
<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="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="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Power Control setup functions</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">//</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// Example:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// set_max_power_in_volts_and_milliamps( 5, 400);</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="keywordtype">void</span> set_max_power_in_volts_and_milliamps( uint8_t volts, uint32_t milliamps);</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="keywordtype">void</span> set_max_power_in_milliwatts( uint32_t powerInmW);</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</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="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Power Control 'show' and 'delay' functions</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">//</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// These are drop-in replacements for FastLED.show() and FastLED.delay()</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// In order to use these, you have to actually replace your calls to</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// FastLED.show() and FastLED.delay() with these two functions.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">//</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">// Example:</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// // was: FastLED.show();</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// // now is:</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// show_at_max_brightness_for_power();</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">//</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">void</span> show_at_max_brightness_for_power();</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">void</span> delay_at_max_brightness_for_power( uint16_t ms);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Power Control internal helper functions</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">//</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// calculate_unscaled_power_mW tells you how many milliwatts the current</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// LED data would draw at brightness = 255.</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">//</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// calculate_max_brightness_for_power_mW tells you the highest brightness</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// level you can use and still stay under the specified power budget. It</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// takes a 'target brightness' which is the brightness you'd ideally like</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// to use. The result from this function will be no higher than the</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// target_brightess you supply, but may be lower.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</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="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> uint8_t calculate_max_brightness_for_power_mW( uint8_t target_brightness, uint32_t max_power_mW);</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> FASTLED_NAMESPACE_END</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> <span class="comment">// POWER_MGT_H</span></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> <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="ttdef"><b>Definition:</b> pixeltypes.h:83</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 10 2015 22:36:07 for FastLED by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>
|
