123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842 |
- <!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.10"/>
- <title>CoffeePi: stripe.h File Reference</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 id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">CoffeePi
- </div>
- <div id="projectbrief">Coffee machine control for Raspberry Pi</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.10 -->
- <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="annotated.html"><span>Data Structures</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>Globals</span></a></li>
- </ul>
- </div>
- <!-- 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><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#define-members">Macros</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">stripe.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p><a href="stripe_8h_source.html">Go to the source code of this file.</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structstripe__color.html">stripe_color</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:a52f9fc93ce25c487d4f72b9f2f400545"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a52f9fc93ce25c487d4f72b9f2f400545">I2C_ADDRESS_STRIPE</a>   0x69</td></tr>
- <tr class="separator:a52f9fc93ce25c487d4f72b9f2f400545"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad06bb775e1f72bc21a5f17a19eb62e80"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ad06bb775e1f72bc21a5f17a19eb62e80">STRIPE_CMD_SETR</a>   0x01</td></tr>
- <tr class="separator:ad06bb775e1f72bc21a5f17a19eb62e80"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac62893e9f8f3793a3f6de3338a9a93ff"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ac62893e9f8f3793a3f6de3338a9a93ff">STRIPE_CMD_SETG</a>   0x02</td></tr>
- <tr class="separator:ac62893e9f8f3793a3f6de3338a9a93ff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a25c93d4301c3ad1064adfb9eff952211"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a25c93d4301c3ad1064adfb9eff952211">STRIPE_CMD_SETB</a>   0x03</td></tr>
- <tr class="separator:a25c93d4301c3ad1064adfb9eff952211"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3c5fd782e0479daf6bb272d5197c8877"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a3c5fd782e0479daf6bb272d5197c8877">STRIPE_CMD_SETW</a>   0x04</td></tr>
- <tr class="separator:a3c5fd782e0479daf6bb272d5197c8877"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aedb99f1c6b67c005f5a2cd6dea06c6b7"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aedb99f1c6b67c005f5a2cd6dea06c6b7">STRIPE_CMD_SETDIM</a>   0x05</td></tr>
- <tr class="separator:aedb99f1c6b67c005f5a2cd6dea06c6b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab495a56c339e141ecbecfd9872f81fbb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ab495a56c339e141ecbecfd9872f81fbb">STRIPE_CMD_SET</a>   0x06</td></tr>
- <tr class="separator:ab495a56c339e141ecbecfd9872f81fbb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aead1e6fe1bdc60cade5b071a293864cc"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aead1e6fe1bdc60cade5b071a293864cc">STRIPE_CMD_SET2</a>   0x07</td></tr>
- <tr class="separator:aead1e6fe1bdc60cade5b071a293864cc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0a2c9ea1a805ca03af6c43c107c98e8e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a0a2c9ea1a805ca03af6c43c107c98e8e">STRIPE_CMD_RESET</a>   0x09</td></tr>
- <tr class="separator:a0a2c9ea1a805ca03af6c43c107c98e8e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a14287ccb3789c724603c28910512a0b3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a14287ccb3789c724603c28910512a0b3">STRIPE_CMD_FADEOUT</a>   0x0A</td></tr>
- <tr class="separator:a14287ccb3789c724603c28910512a0b3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a80ccf336e21703504faf1b3acba2c98b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a80ccf336e21703504faf1b3acba2c98b">STRIPE_CMD_FADETO</a>   0x0B</td></tr>
- <tr class="separator:a80ccf336e21703504faf1b3acba2c98b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2e4a6f31f6823ec2592e9216a51232f2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a2e4a6f31f6823ec2592e9216a51232f2">STRIPE_CMD_FADESTOP</a>   0x0C</td></tr>
- <tr class="separator:a2e4a6f31f6823ec2592e9216a51232f2"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:aa761062faf633557e537e07a781965e9"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9">stripe_transient_t</a> { <a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9ad41450786f0c8b404231dfaff4c14931">TRANS_DIRECT</a> = 0,
- <a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9a37991877080c17224eaa0268947a545c">TRANS_FAST</a> = 6,
- <a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9a26be047607e612751d1979597dd21185">TRANS_MEDIUM</a> = 35,
- <a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9ad1105b7089df16f505a8c28ef4e31f04">TRANS_SLOW</a> = 200
- }<tr class="separator:aa761062faf633557e537e07a781965e9"><td class="memSeparator" colspan="2"> </td></tr>
- </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a914baf734bc672a910769802c1e882c8"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a914baf734bc672a910769802c1e882c8">stripeThread</a> (void *threadid)</td></tr>
- <tr class="memdesc:a914baf734bc672a910769802c1e882c8"><td class="mdescLeft"> </td><td class="mdescRight">Thread for the stripe control. <a href="#a914baf734bc672a910769802c1e882c8">More...</a><br /></td></tr>
- <tr class="separator:a914baf734bc672a910769802c1e882c8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a630b80b8bd1e8a0f535b21a720de76b8"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a630b80b8bd1e8a0f535b21a720de76b8">stripeTimerHandler</a> (void *threadid)</td></tr>
- <tr class="memdesc:a630b80b8bd1e8a0f535b21a720de76b8"><td class="mdescLeft"> </td><td class="mdescRight">This is the handler for time based stripe effects. <a href="#a630b80b8bd1e8a0f535b21a720de76b8">More...</a><br /></td></tr>
- <tr class="separator:a630b80b8bd1e8a0f535b21a720de76b8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aec214522cff28dc1b0f20c2ec2870189"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aec214522cff28dc1b0f20c2ec2870189">stripeInit</a> (void)</td></tr>
- <tr class="memdesc:aec214522cff28dc1b0f20c2ec2870189"><td class="mdescLeft"> </td><td class="mdescRight">Initializes i2c communication to stripe controller. <a href="#aec214522cff28dc1b0f20c2ec2870189">More...</a><br /></td></tr>
- <tr class="separator:aec214522cff28dc1b0f20c2ec2870189"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab58f9b853bd6c2deb11f6b64e6275cd7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ab58f9b853bd6c2deb11f6b64e6275cd7">stripeCommand</a> (int len, char *data)</td></tr>
- <tr class="memdesc:ab58f9b853bd6c2deb11f6b64e6275cd7"><td class="mdescLeft"> </td><td class="mdescRight">Sends out command data to the stripe controller via i2c. <a href="#ab58f9b853bd6c2deb11f6b64e6275cd7">More...</a><br /></td></tr>
- <tr class="separator:ab58f9b853bd6c2deb11f6b64e6275cd7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a79a7d75b45ddbb2b3324ec450658136c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a79a7d75b45ddbb2b3324ec450658136c">stripeUpdate</a> (void)</td></tr>
- <tr class="memdesc:a79a7d75b45ddbb2b3324ec450658136c"><td class="mdescLeft"> </td><td class="mdescRight">Updates the color data and prepares the stripe command. <a href="#a79a7d75b45ddbb2b3324ec450658136c">More...</a><br /></td></tr>
- <tr class="separator:a79a7d75b45ddbb2b3324ec450658136c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a849e5953dbdb82fb8405b1ab43067eed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a849e5953dbdb82fb8405b1ab43067eed">stripeUpdateDim</a> (void)</td></tr>
- <tr class="memdesc:a849e5953dbdb82fb8405b1ab43067eed"><td class="mdescLeft"> </td><td class="mdescRight">Updates the dimmer value of the stripe. <a href="#a849e5953dbdb82fb8405b1ab43067eed">More...</a><br /></td></tr>
- <tr class="separator:a849e5953dbdb82fb8405b1ab43067eed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a405699059b25eae6001d1e989a1da5d6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a405699059b25eae6001d1e989a1da5d6">stripeSetRGB</a> (int red, int green, int blue)</td></tr>
- <tr class="memdesc:a405699059b25eae6001d1e989a1da5d6"><td class="mdescLeft"> </td><td class="mdescRight">Updates the color of the stripe. <a href="#a405699059b25eae6001d1e989a1da5d6">More...</a><br /></td></tr>
- <tr class="separator:a405699059b25eae6001d1e989a1da5d6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32197a6a1a75aaf54a2a19dbc31be4e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a32197a6a1a75aaf54a2a19dbc31be4e0">stripeSetColor</a> (<a class="el" href="structstripe__color.html">stripe_color</a> color)</td></tr>
- <tr class="memdesc:a32197a6a1a75aaf54a2a19dbc31be4e0"><td class="mdescLeft"> </td><td class="mdescRight">Updates the color of the stripe. <a href="#a32197a6a1a75aaf54a2a19dbc31be4e0">More...</a><br /></td></tr>
- <tr class="separator:a32197a6a1a75aaf54a2a19dbc31be4e0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a26524f75c9d72587489d20bba6c61da6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a26524f75c9d72587489d20bba6c61da6">stripeSetTransient</a> (<a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9">stripe_transient_t</a> transient)</td></tr>
- <tr class="memdesc:a26524f75c9d72587489d20bba6c61da6"><td class="mdescLeft"> </td><td class="mdescRight">Updates the transient time for the stripe (fading) <a href="#a26524f75c9d72587489d20bba6c61da6">More...</a><br /></td></tr>
- <tr class="separator:a26524f75c9d72587489d20bba6c61da6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ade9bc3e5b3fabc99922d78df6ae96434"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ade9bc3e5b3fabc99922d78df6ae96434">stripeSetDim</a> (int dim)</td></tr>
- <tr class="memdesc:ade9bc3e5b3fabc99922d78df6ae96434"><td class="mdescLeft"> </td><td class="mdescRight">Updates the dimmer value of the stripe. <a href="#ade9bc3e5b3fabc99922d78df6ae96434">More...</a><br /></td></tr>
- <tr class="separator:ade9bc3e5b3fabc99922d78df6ae96434"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2ae73653f2098fdae40bb0916949e77e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a2ae73653f2098fdae40bb0916949e77e">stripeSetWhite</a> (int white)</td></tr>
- <tr class="memdesc:a2ae73653f2098fdae40bb0916949e77e"><td class="mdescLeft"> </td><td class="mdescRight">Updates the white value of the stripe (4th channel) <a href="#a2ae73653f2098fdae40bb0916949e77e">More...</a><br /></td></tr>
- <tr class="separator:a2ae73653f2098fdae40bb0916949e77e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9130dbeb208c1b9e5519834f7de6a530"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a9130dbeb208c1b9e5519834f7de6a530">stripeOn</a> (void)</td></tr>
- <tr class="memdesc:a9130dbeb208c1b9e5519834f7de6a530"><td class="mdescLeft"> </td><td class="mdescRight">Turns the stripe on (Sets dimmer to 100%) <a href="#a9130dbeb208c1b9e5519834f7de6a530">More...</a><br /></td></tr>
- <tr class="separator:a9130dbeb208c1b9e5519834f7de6a530"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a40d444a306464fa8547feea96737ae0d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a40d444a306464fa8547feea96737ae0d">stripeOff</a> (void)</td></tr>
- <tr class="memdesc:a40d444a306464fa8547feea96737ae0d"><td class="mdescLeft"> </td><td class="mdescRight">Turns the stripe on (Sets dimmer to 0%) <a href="#a40d444a306464fa8547feea96737ae0d">More...</a><br /></td></tr>
- <tr class="separator:a40d444a306464fa8547feea96737ae0d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac5379b3ade62c829d19654c22efd90de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ac5379b3ade62c829d19654c22efd90de">stripeGetRGB</a> (int *red, int *green, int *blue)</td></tr>
- <tr class="memdesc:ac5379b3ade62c829d19654c22efd90de"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current stripe color. <a href="#ac5379b3ade62c829d19654c22efd90de">More...</a><br /></td></tr>
- <tr class="separator:ac5379b3ade62c829d19654c22efd90de"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab479c1db854476cf80b86d1fe33a908e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#ab479c1db854476cf80b86d1fe33a908e">stripeGetDim</a> (int *dim)</td></tr>
- <tr class="memdesc:ab479c1db854476cf80b86d1fe33a908e"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current stripe dimmer value. <a href="#ab479c1db854476cf80b86d1fe33a908e">More...</a><br /></td></tr>
- <tr class="separator:ab479c1db854476cf80b86d1fe33a908e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa67941dfd018cc2e0ba62a76a3d9136d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aa67941dfd018cc2e0ba62a76a3d9136d">stripeGetWhite</a> (int *white)</td></tr>
- <tr class="memdesc:aa67941dfd018cc2e0ba62a76a3d9136d"><td class="mdescLeft"> </td><td class="mdescRight">Reads the current stripe white value (4th channel) <a href="#aa67941dfd018cc2e0ba62a76a3d9136d">More...</a><br /></td></tr>
- <tr class="separator:aa67941dfd018cc2e0ba62a76a3d9136d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a40cca6b9cc8aeca2f28442126528163b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a40cca6b9cc8aeca2f28442126528163b">stripeEffectDisable</a> (void)</td></tr>
- <tr class="memdesc:a40cca6b9cc8aeca2f28442126528163b"><td class="mdescLeft"> </td><td class="mdescRight">Stops current running effects. <a href="#a40cca6b9cc8aeca2f28442126528163b">More...</a><br /></td></tr>
- <tr class="separator:a40cca6b9cc8aeca2f28442126528163b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a97c35798100bbf3208fd15cc5615cd97"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#a97c35798100bbf3208fd15cc5615cd97">stripeEffectHeating</a> (int percent)</td></tr>
- <tr class="memdesc:a97c35798100bbf3208fd15cc5615cd97"><td class="mdescLeft"> </td><td class="mdescRight">Sets the stripe to a correspondending color to the heating status. <a href="#a97c35798100bbf3208fd15cc5615cd97">More...</a><br /></td></tr>
- <tr class="separator:a97c35798100bbf3208fd15cc5615cd97"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aea3ed8a6a2d07ed7f8f2ff59f6fa3a01"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="stripe_8h.html#aea3ed8a6a2d07ed7f8f2ff59f6fa3a01">stripeEffectPulse</a> (<a class="el" href="structstripe__color.html">stripe_color</a> color)</td></tr>
- <tr class="memdesc:aea3ed8a6a2d07ed7f8f2ff59f6fa3a01"><td class="mdescLeft"> </td><td class="mdescRight">Enables pulsing with a given color of the stripe. <a href="#aea3ed8a6a2d07ed7f8f2ff59f6fa3a01">More...</a><br /></td></tr>
- <tr class="separator:aea3ed8a6a2d07ed7f8f2ff59f6fa3a01"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <h2 class="groupheader">Macro Definition Documentation</h2>
- <a class="anchor" id="a52f9fc93ce25c487d4f72b9f2f400545"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define I2C_ADDRESS_STRIPE   0x69</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a14287ccb3789c724603c28910512a0b3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_FADEOUT   0x0A</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a2e4a6f31f6823ec2592e9216a51232f2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_FADESTOP   0x0C</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a80ccf336e21703504faf1b3acba2c98b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_FADETO   0x0B</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a0a2c9ea1a805ca03af6c43c107c98e8e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_RESET   0x09</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ab495a56c339e141ecbecfd9872f81fbb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SET   0x06</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="aead1e6fe1bdc60cade5b071a293864cc"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SET2   0x07</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a25c93d4301c3ad1064adfb9eff952211"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SETB   0x03</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="aedb99f1c6b67c005f5a2cd6dea06c6b7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SETDIM   0x05</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ac62893e9f8f3793a3f6de3338a9a93ff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SETG   0x02</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="ad06bb775e1f72bc21a5f17a19eb62e80"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SETR   0x01</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a class="anchor" id="a3c5fd782e0479daf6bb272d5197c8877"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">#define STRIPE_CMD_SETW   0x04</td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Enumeration Type Documentation</h2>
- <a class="anchor" id="aa761062faf633557e537e07a781965e9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9">stripe_transient_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aa761062faf633557e537e07a781965e9ad41450786f0c8b404231dfaff4c14931"></a>TRANS_DIRECT </td><td class="fielddoc">
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="aa761062faf633557e537e07a781965e9a37991877080c17224eaa0268947a545c"></a>TRANS_FAST </td><td class="fielddoc">
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="aa761062faf633557e537e07a781965e9a26be047607e612751d1979597dd21185"></a>TRANS_MEDIUM </td><td class="fielddoc">
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="aa761062faf633557e537e07a781965e9ad1105b7089df16f505a8c28ef4e31f04"></a>TRANS_SLOW </td><td class="fielddoc">
- </td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="ab58f9b853bd6c2deb11f6b64e6275cd7"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int stripeCommand </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>len</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char * </td>
- <td class="paramname"><em>data</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends out command data to the stripe controller via i2c. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">len</td><td>Length of the data array </td></tr>
- <tr><td class="paramname">*data</td><td>Pointer to data array </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Number of failed bytes, 0 if successful </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a40cca6b9cc8aeca2f28442126528163b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeEffectDisable </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Stops current running effects. </p>
- </div>
- </div>
- <a class="anchor" id="a97c35798100bbf3208fd15cc5615cd97"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeEffectHeating </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>percent</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the stripe to a correspondending color to the heating status. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">percent</td><td>Heating level (0-100%) </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="aea3ed8a6a2d07ed7f8f2ff59f6fa3a01"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeEffectPulse </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstripe__color.html">stripe_color</a> </td>
- <td class="paramname"><em>color</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Enables pulsing with a given color of the stripe. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">color</td><td>Effect color </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ab479c1db854476cf80b86d1fe33a908e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeGetDim </td>
- <td>(</td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>dim</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads the current stripe dimmer value. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">*dim</td><td>Pointer to dimmer variable </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ac5379b3ade62c829d19654c22efd90de"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeGetRGB </td>
- <td>(</td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>red</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>green</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>blue</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads the current stripe color. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">*red</td><td>Pointer to red variable </td></tr>
- <tr><td class="paramname">*green</td><td>Pointer to green variable </td></tr>
- <tr><td class="paramname">*blue</td><td>Pointer to blue variable </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="aa67941dfd018cc2e0ba62a76a3d9136d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeGetWhite </td>
- <td>(</td>
- <td class="paramtype">int * </td>
- <td class="paramname"><em>white</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Reads the current stripe white value (4th channel) </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">*white</td><td>Pointer to white variable </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="aec214522cff28dc1b0f20c2ec2870189"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeInit </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initializes i2c communication to stripe controller. </p>
- </div>
- </div>
- <a class="anchor" id="a40d444a306464fa8547feea96737ae0d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeOff </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Turns the stripe on (Sets dimmer to 0%) </p>
- </div>
- </div>
- <a class="anchor" id="a9130dbeb208c1b9e5519834f7de6a530"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeOn </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Turns the stripe on (Sets dimmer to 100%) </p>
- </div>
- </div>
- <a class="anchor" id="a32197a6a1a75aaf54a2a19dbc31be4e0"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeSetColor </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structstripe__color.html">stripe_color</a> </td>
- <td class="paramname"><em>color</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the color of the stripe. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">color</td><td>Color struct </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ade9bc3e5b3fabc99922d78df6ae96434"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeSetDim </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>dim</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the dimmer value of the stripe. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">dim</td><td>Dimmer value </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a405699059b25eae6001d1e989a1da5d6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeSetRGB </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>red</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>green</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>blue</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the color of the stripe. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">red</td><td>Red value (max 255) </td></tr>
- <tr><td class="paramname">green</td><td>Green value (max 255) </td></tr>
- <tr><td class="paramname">blue</td><td>Blue value (max 255) </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a26524f75c9d72587489d20bba6c61da6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeSetTransient </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="stripe_8h.html#aa761062faf633557e537e07a781965e9">stripe_transient_t</a> </td>
- <td class="paramname"><em>transient</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the transient time for the stripe (fading) </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">transient</td><td>Transient time in ticks </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a2ae73653f2098fdae40bb0916949e77e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeSetWhite </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>white</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the white value of the stripe (4th channel) </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">white</td><td>White value </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a914baf734bc672a910769802c1e882c8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void* stripeThread </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>threadid</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Thread for the stripe control. </p>
- <p>Requests data from other threads or HAL </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">*threadid</td><td>Thread ID </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a630b80b8bd1e8a0f535b21a720de76b8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void* stripeTimerHandler </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>threadid</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>This is the handler for time based stripe effects. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">*threadid</td><td>Thread ID </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a79a7d75b45ddbb2b3324ec450658136c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeUpdate </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the color data and prepares the stripe command. </p>
- </div>
- </div>
- <a class="anchor" id="a849e5953dbdb82fb8405b1ab43067eed"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void stripeUpdateDim </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Updates the dimmer value of the stripe. </p>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.10
- </small></address>
- </body>
- </html>
|