regenerate doxygen

docs/doxygen_crawl.html

@@ -90,6 +90,7 @@
 <a href="tinylor_8c.html#ab6ce8df32486df8bb07576bef6b28fed"/>
 <a href="tinylor_8c.html#ac93a0236ee2cb3a98985b801d2776071"/>
 <a href="tinylor_8c.html#ae4cb99bc098c81c14dd0ba2edb2d5d44"/>
+<a href="tinylor_8c.html#afe05723e473135872bca01f760602054"/>
 <a href="tinylor_8h.html"/>
 <a href="tinylor_8h.html#a0188180c8b01a491c8f9746c0050e161"/>
 <a href="tinylor_8h.html#a0bf67fce0efbd914371633a37546e9dd"/>

docs/globals.html

@@ -117,7 +117,7 @@ <h3><a id="index_l" name="index_l"></a>- l -</h3><ul>
 <li>LOR_FMT_SINGLE&#160;:&#160;<a class="el" href="tinylor_8h.html#af1a01cca8cbddf9afb6ea3a90d03a149ac5c58258174013effc1ba59e632f833e">tinylor.h</a></li>
 <li>LOR_FMT_UNIT&#160;:&#160;<a class="el" href="tinylor_8h.html#af1a01cca8cbddf9afb6ea3a90d03a149a0db7c6f62cfefa8d606e62e95d5cb402">tinylor.h</a></li>
 <li>lor_get_cset_format()&#160;:&#160;<a class="el" href="tinylor_8c.html#a00e1c21c0422712e73d698429b8f51bb">tinylor.c</a></li>
-<li>lor_get_intensity()&#160;:&#160;<a class="el" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">tinylor.h</a></li>
+<li>lor_get_intensity()&#160;:&#160;<a class="el" href="tinylor_8c.html#afe05723e473135872bca01f760602054">tinylor.c</a>, <a class="el" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">tinylor.h</a></li>
 <li>LOR_HEARTBEAT_BYTES&#160;:&#160;<a class="el" href="tinylor_8h.html#a52b2adabc7288ee497f84bba3c61c078">tinylor.h</a></li>
 <li>LOR_HEARTBEAT_DELAY_MS&#160;:&#160;<a class="el" href="tinylor_8h.html#ad909c3eab45cccefa1676d34170acadc">tinylor.h</a></li>
 <li>LOR_HEARTBEAT_DELAY_NS&#160;:&#160;<a class="el" href="tinylor_8h.html#a3746c13772d28a8a1d5cbd255de37833">tinylor.h</a></li>

docs/globals_func.html

@@ -102,7 +102,7 @@
 <li>lor_encode_decis()&#160;:&#160;<a class="el" href="tinylor_8c.html#a8d8d0afbb593c3d6444cb012cdf4d074">tinylor.c</a></li>
 <li>lor_encode_effect()&#160;:&#160;<a class="el" href="tinylor_8c.html#a170a89a6274a97734b00f12ff1b6edb4">tinylor.c</a></li>
 <li>lor_get_cset_format()&#160;:&#160;<a class="el" href="tinylor_8c.html#a00e1c21c0422712e73d698429b8f51bb">tinylor.c</a></li>
-<li>lor_get_intensity()&#160;:&#160;<a class="el" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">tinylor.h</a></li>
+<li>lor_get_intensity()&#160;:&#160;<a class="el" href="tinylor_8c.html#afe05723e473135872bca01f760602054">tinylor.c</a>, <a class="el" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">tinylor.h</a></li>
 <li>lor_set_channel()&#160;:&#160;<a class="el" href="tinylor_8c.html#a566277d44fc02828619810c36a9d0554">tinylor.c</a>, <a class="el" href="tinylor_8h.html#a566277d44fc02828619810c36a9d0554">tinylor.h</a></li>
 <li>lor_set_channels()&#160;:&#160;<a class="el" href="tinylor_8c.html#a4c595977c627eb08ba9181af8d8e7f39">tinylor.c</a>, <a class="el" href="tinylor_8h.html#a17a2c33ca97f41b60a53f3322f5bda72">tinylor.h</a></li>
 <li>lor_set_effect()&#160;:&#160;<a class="el" href="tinylor_8c.html#ae4cb99bc098c81c14dd0ba2edb2d5d44">tinylor.c</a>, <a class="el" href="tinylor_8h.html#ad88c7bb1b90193d40ee1a7a2324d41ac">tinylor.h</a></li>

docs/navtreeindex0.js

@@ -28,17 +28,18 @@ var NAVTREEINDEX0 =
 "structlor__req.html#aa792e51f4e2198d0e26a31bcebfcde4e":[1,0,2,3],
 "structlor__req.html#ad567bff7aeaa5f24937780f45a98e44f":[1,0,2,1],
 "tinylor_8c.html":[2,0,0,0],
-"tinylor_8c.html#a006c7ebaa6a8830a21f9a2403c79ec10":[2,0,0,0,7],
+"tinylor_8c.html#a006c7ebaa6a8830a21f9a2403c79ec10":[2,0,0,0,8],
 "tinylor_8c.html#a00e1c21c0422712e73d698429b8f51bb":[2,0,0,0,3],
 "tinylor_8c.html#a0352eb57d0ea7972c5f976a289b3e147":[2,0,0,0,0],
 "tinylor_8c.html#a170a89a6274a97734b00f12ff1b6edb4":[2,0,0,0,2],
-"tinylor_8c.html#a3c3e73ba4428c615b43131ae8e597268":[2,0,0,0,8],
-"tinylor_8c.html#a4c595977c627eb08ba9181af8d8e7f39":[2,0,0,0,5],
-"tinylor_8c.html#a566277d44fc02828619810c36a9d0554":[2,0,0,0,4],
+"tinylor_8c.html#a3c3e73ba4428c615b43131ae8e597268":[2,0,0,0,9],
+"tinylor_8c.html#a4c595977c627eb08ba9181af8d8e7f39":[2,0,0,0,6],
+"tinylor_8c.html#a566277d44fc02828619810c36a9d0554":[2,0,0,0,5],
 "tinylor_8c.html#a8d8d0afbb593c3d6444cb012cdf4d074":[2,0,0,0,1],
-"tinylor_8c.html#ab6ce8df32486df8bb07576bef6b28fed":[2,0,0,0,10],
-"tinylor_8c.html#ac93a0236ee2cb3a98985b801d2776071":[2,0,0,0,9],
-"tinylor_8c.html#ae4cb99bc098c81c14dd0ba2edb2d5d44":[2,0,0,0,6],
+"tinylor_8c.html#ab6ce8df32486df8bb07576bef6b28fed":[2,0,0,0,11],
+"tinylor_8c.html#ac93a0236ee2cb3a98985b801d2776071":[2,0,0,0,10],
+"tinylor_8c.html#ae4cb99bc098c81c14dd0ba2edb2d5d44":[2,0,0,0,7],
+"tinylor_8c.html#afe05723e473135872bca01f760602054":[2,0,0,0,4],
 "tinylor_8h.html":[2,0,0,1],
 "tinylor_8h.html#a0188180c8b01a491c8f9746c0050e161":[2,0,0,1,11],
 "tinylor_8h.html#a0bf67fce0efbd914371633a37546e9dd":[2,0,0,1,18],

docs/tinylor_8c.html

@@ -154,6 +154,9 @@
 <tr class="memitem:ab6ce8df32486df8bb07576bef6b28fed" id="r_ab6ce8df32486df8bb07576bef6b28fed"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab6ce8df32486df8bb07576bef6b28fed">lor_write</a> (unsigned char *b, const size_t bs, const <a class="el" href="tinylor_8h.html#a21b6c8a1aeccc60b23dfe926c442fb9b">lor_req_s</a> *r, const size_t rs)</td></tr>
 <tr class="memdesc:ab6ce8df32486df8bb07576bef6b28fed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes and writes up to <code>rs</code> requests to the provided buffer <code>b</code> as binary data. Requests are first encoded into a scratch buffer to ensure the buffer has enough space to hold the encoded data. The function will attempt to write as many requests as possible to the buffer, up to the provided request count.  <br /></td></tr>
 <tr class="separator:ab6ce8df32486df8bb07576bef6b28fed"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:afe05723e473135872bca01f760602054" id="r_afe05723e473135872bca01f760602054"><td class="memItemLeft" align="right" valign="top"><a class="el" href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe05723e473135872bca01f760602054">lor_get_intensity</a> (const unsigned char b)</td></tr>
+<tr class="memdesc:afe05723e473135872bca01f760602054"><td class="mdescLeft">&#160;</td><td class="mdescRight">Encodes a [0,0xFF] value into a roughly equivalent LOR intensity value (precision is lossy) that is compatible with the protocol.  <br /></td></tr>
+<tr class="separator:afe05723e473135872bca01f760602054"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Protocol encoding functions implementation. </p>
@@ -384,6 +387,33 @@ <h2 class="memtitle"><span class="permalink"><a href="#a00e1c21c0422712e73d69842
 </map>
 </div>
 
+</div>
+</div>
+<a id="afe05723e473135872bca01f760602054" name="afe05723e473135872bca01f760602054"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#afe05723e473135872bca01f760602054">&#9670;&#160;</a></span>lor_get_intensity()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname"><a class="el" href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a> lor_get_intensity </td>
+          <td>(</td>
+          <td class="paramtype">unsigned char</td>          <td class="paramname"><span class="paramname"><em>b</em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Encodes a [0,0xFF] value into a roughly equivalent LOR intensity value (precision is lossy) that is compatible with the protocol. </p>
+<dl class="section note"><dt>Note</dt><dd>This is a default implementation of the lor_intensity_fn type. It operates via a known truth table from protocol documentation. Other or custom implementations may be ideal for your specific use case. </dd></dl>
+<dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">b</td><td>The byte value to convert. </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>The scaled intensity value. </dd></dl>
+
 </div>
 </div>
 <a id="a566277d44fc02828619810c36a9d0554" name="a566277d44fc02828619810c36a9d0554"></a>

docs/tinylor_8c.js

@@ -4,6 +4,7 @@ var tinylor_8c =
     [ "lor_encode_decis", "tinylor_8c.html#a8d8d0afbb593c3d6444cb012cdf4d074", null ],
     [ "lor_encode_effect", "tinylor_8c.html#a170a89a6274a97734b00f12ff1b6edb4", null ],
     [ "lor_get_cset_format", "tinylor_8c.html#a00e1c21c0422712e73d698429b8f51bb", null ],
+    [ "lor_get_intensity", "tinylor_8c.html#afe05723e473135872bca01f760602054", null ],
     [ "lor_set_channel", "tinylor_8c.html#a566277d44fc02828619810c36a9d0554", null ],
     [ "lor_set_channels", "tinylor_8c.html#a4c595977c627eb08ba9181af8d8e7f39", null ],
     [ "lor_set_effect", "tinylor_8c.html#ae4cb99bc098c81c14dd0ba2edb2d5d44", null ],

docs/tinylor_8h_source.html

@@ -198,7 +198,7 @@
 <div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span> </div>
 <div class="line"><a id="l00215" name="l00215"></a><span class="lineno"><a class="line" href="tinylor_8h.html#ad634d94e939aae009fab6256b4fb4161">  215</a></span><span class="keyword">typedef</span> <a class="code hl_typedef" href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a> (*<a class="code hl_typedef" href="tinylor_8h.html#ad634d94e939aae009fab6256b4fb4161">lor_intensity_fn</a>)(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> b);</div>
 <div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span> </div>
-<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"><a class="line" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">  224</a></span><a class="code hl_typedef" href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a> <a class="code hl_function" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">lor_get_intensity</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> b);</div>
+<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><a class="code hl_typedef" href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a> <a class="code hl_function" href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">lor_get_intensity</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> b);</div>
 <div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span> </div>
 <div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="preprocessor">#endif</span><span class="comment">// TINYLOR_H</span></div>
 <div class="ttc" id="astructlor__channel__set_html"><div class="ttname"><a href="structlor__channel__set.html">lor_channel_set</a></div><div class="ttdoc">Represents a grouping of 16 channels, as a bit set, aligned to a 16-channel boundary (via a multiplie...</div><div class="ttdef"><b>Definition</b> tinylor.h:33</div></div>
@@ -228,7 +228,7 @@
 <div class="ttc" id="atinylor_8h_html_a5a69a8a003629f152d4f46272a6c9f0c"><div class="ttname"><a href="tinylor_8h.html#a5a69a8a003629f152d4f46272a6c9f0c">lor_set_fade</a></div><div class="ttdeci">void lor_set_fade(lor_req_s *req, lor_intensity start, lor_intensity end, lor_decisec ds)</div><div class="ttdoc">Configures the request to fade from one intensity to another over a specified duration in deciseconds...</div><div class="ttdef"><b>Definition</b> tinylor.c:46</div></div>
 <div class="ttc" id="atinylor_8h_html_a701d6d90d919682936edf3118f4b067b"><div class="ttname"><a href="tinylor_8h.html#a701d6d90d919682936edf3118f4b067b">lor_write</a></div><div class="ttdeci">size_t lor_write(unsigned char *b, size_t bs, const lor_req_s *r, size_t rs)</div><div class="ttdoc">Encodes and writes up to rs requests to the provided buffer b as binary data. Requests are first enco...</div><div class="ttdef"><b>Definition</b> tinylor.c:139</div></div>
 <div class="ttc" id="atinylor_8h_html_a9ca5a7b907afcda321d37df3cd062b04"><div class="ttname"><a href="tinylor_8h.html#a9ca5a7b907afcda321d37df3cd062b04">lor_intensity</a></div><div class="ttdeci">unsigned char lor_intensity</div><div class="ttdoc">Represents a scaled intensity value used by the LOR protocol.</div><div class="ttdef"><b>Definition</b> tinylor.h:18</div></div>
-<div class="ttc" id="atinylor_8h_html_aa255e0c297a25245de7d3982838d0e75"><div class="ttname"><a href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">lor_get_intensity</a></div><div class="ttdeci">lor_intensity lor_get_intensity(unsigned char b)</div><div class="ttdoc">Encodes a [0,0xFF] value into a roughly equivalent LOR intensity value (precision is lossy) that is c...</div></div>
+<div class="ttc" id="atinylor_8h_html_aa255e0c297a25245de7d3982838d0e75"><div class="ttname"><a href="tinylor_8h.html#aa255e0c297a25245de7d3982838d0e75">lor_get_intensity</a></div><div class="ttdeci">lor_intensity lor_get_intensity(unsigned char b)</div><div class="ttdoc">Encodes a [0,0xFF] value into a roughly equivalent LOR intensity value (precision is lossy) that is c...</div><div class="ttdef"><b>Definition</b> tinylor.c:159</div></div>
 <div class="ttc" id="atinylor_8h_html_ab4ab54b1f33d059a043b6d231a2434ea"><div class="ttname"><a href="tinylor_8h.html#ab4ab54b1f33d059a043b6d231a2434ea">lor_set_intensity</a></div><div class="ttdeci">void lor_set_intensity(lor_req_s *req, lor_intensity i)</div><div class="ttdoc">Configures the request to set the intensity of the lights to the provided value.</div><div class="ttdef"><b>Definition</b> tinylor.c:41</div></div>
 <div class="ttc" id="atinylor_8h_html_ac6e8cd8c3cd2d1376e20119fdac44253"><div class="ttname"><a href="tinylor_8h.html#ac6e8cd8c3cd2d1376e20119fdac44253">lor_decisec</a></div><div class="ttdeci">unsigned short lor_decisec</div><div class="ttdoc">Represents a duration in deciseconds, which is 1/10th of a second.</div><div class="ttdef"><b>Definition</b> tinylor.h:28</div></div>
 <div class="ttc" id="atinylor_8h_html_ac926201d73d18b9f7fe0459982e8a847"><div class="ttname"><a href="tinylor_8h.html#ac926201d73d18b9f7fe0459982e8a847">lor_channel</a></div><div class="ttdeci">unsigned short lor_channel</div><div class="ttdoc">Represents a channel number, which is a unique identifier for a specific light or group of lights....</div><div class="ttdef"><b>Definition</b> tinylor.h:12</div></div>