220 lines
36 KiB
HTML
220 lines
36 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/mcuhwc.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>
|
|
<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">libctru
|
|
 <span id="projectnumber">v2.4.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">mcuhwc.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="mcuhwc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file mcuhwc.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief mcuHwc service.</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3"> 7</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a052ec9418815c097e290abeb03f91c14"> 8</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a052ec9418815c097e290abeb03f91c14">LED_NORMAL</a> = 1, <span class="comment">///< The normal mode of the led</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ae9f8f9f5a62af88aac710a7bfa21bdd0"> 9</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ae9f8f9f5a62af88aac710a7bfa21bdd0">LED_SLEEP_MODE</a>, <span class="comment">///< The led pulses slowly as it does in the sleep mode</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3afc0ca8cc6cbe215fd3f1ae6d40255b40"> 10</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3afc0ca8cc6cbe215fd3f1ae6d40255b40">LED_OFF</a>, <span class="comment">///< Switch off power led</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ad80f13022b6d309268fadc7b1da89cb9"> 11</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ad80f13022b6d309268fadc7b1da89cb9">LED_RED</a>, <span class="comment">///< Red state of the led</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3aa67c57c0ff22a2772cb6a5751a3327bf"> 12</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3aa67c57c0ff22a2772cb6a5751a3327bf">LED_BLUE</a>, <span class="comment">///< Blue state of the led</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a05db5006cefc8596f609ed1efe3834d8"> 13</a></span>  <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a05db5006cefc8596f609ed1efe3834d8">LED_BLINK_RED</a>, <span class="comment">///< Blinking red state of power led and notification led</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> } <a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3">powerLedState</a>;</div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html"> 16</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structInfoLedPattern.html">InfoLedPattern</a></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#a2881d320c8af7ea7c3eab05e165880cb"> 18</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#a2881d320c8af7ea7c3eab05e165880cb">delay</a>; <span class="comment">///< Delay between pattern values, 1/16th of a second (1 second = 0x10)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#ae55c14822b91cfafdf9ce156c81ceba3"> 19</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#ae55c14822b91cfafdf9ce156c81ceba3">smoothing</a>; <span class="comment">///< Smoothing between pattern values (higher = smoother)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#a78f415cacf93273b538d273b19492422"> 20</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#a78f415cacf93273b538d273b19492422">loopDelay</a>; <span class="comment">///< Delay between pattern loops, 1/16th of a second (1 second = 0x10, 0xFF = pattern is played only once)</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#aaded6fd4e4719e7e711b4adf9bb6ba6f"> 21</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#aaded6fd4e4719e7e711b4adf9bb6ba6f">blinkSpeed</a>; <span class="comment">///< Blink speed, when smoothing == 0x00</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#ac8b3bcf036d150e8a61a61a8eb46afa0"> 22</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#ac8b3bcf036d150e8a61a61a8eb46afa0">redPattern</a>[32]; <span class="comment">///< Pattern for red component</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#ab47dd417407b2084d9ea9b8c95ddffe6"> 23</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#ab47dd417407b2084d9ea9b8c95ddffe6">greenPattern</a>[32]; <span class="comment">///< Pattern for green component</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structInfoLedPattern.html#ab596534cb43de51b86b3f3a5c0b08c1e"> 24</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structInfoLedPattern.html#ab596534cb43de51b86b3f3a5c0b08c1e">bluePattern</a>[32]; <span class="comment">///< Pattern for blue component</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> } <a class="code" href="structInfoLedPattern.html">InfoLedPattern</a>;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">/// Initializes mcuHwc.</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a45296be24ea40904294e466245052200"> 28</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a45296be24ea40904294e466245052200">mcuHwcInit</a>(<span class="keywordtype">void</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="comment">/// Exits mcuHwc.</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#adc434fe29cd5d664fe7559a904da5c07"> 31</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="mcuhwc_8h.html#adc434fe29cd5d664fe7559a904da5c07">mcuHwcExit</a>(<span class="keywordtype">void</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">/**</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * @brief Gets the current mcuHwc session handle.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @return A pointer to the current mcuHwc session handle.</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"><a class="line" href="mcuhwc_8h.html#ad8f961927d162f978bf37d5925e5608a"> 37</a></span> <a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* <a class="code" href="mcuhwc_8h.html#ad8f961927d162f978bf37d5925e5608a">mcuHwcGetSessionHandle</a>(<span class="keywordtype">void</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">/**</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> * @brief Reads data from an i2c device3 register</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @param data Pointer to write the data to.</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @param size Size of data to be read</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a2c3df587f208073b09386754c8c49cc7"> 45</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a2c3df587f208073b09386754c8c49cc7">MCUHWC_ReadRegister</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> reg, <span class="keywordtype">void</span> *data, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @brief Writes data to a i2c device3 register</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param reg Register number. See https://www.3dbrew.org/wiki/I2C_Registers#Device_3 for more info</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param data Pointer to write the data to.</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @param size Size of data to be written</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a5e720a5410b1dd0e65493b5332c587f2"> 53</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a5e720a5410b1dd0e65493b5332c587f2">MCUHWC_WriteRegister</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> reg, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @brief Gets the battery voltage</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param voltage Pointer to write the battery voltage to.</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a8d802328caeb7b975e92d8dc99ea8e5a"> 59</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a8d802328caeb7b975e92d8dc99ea8e5a">MCUHWC_GetBatteryVoltage</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *voltage);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> * @brief Gets the battery level</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> * @param level Pointer to write the current battery level to.</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a389c0cd8f4b0d664a72bd3b0ff40a359"> 65</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a389c0cd8f4b0d664a72bd3b0ff40a359">MCUHWC_GetBatteryLevel</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *level);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * @brief Gets the sound slider level</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * @param level Pointer to write the slider level to.</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a7bfe72c086ad88cae962c156fc8fdd18"> 71</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a7bfe72c086ad88cae962c156fc8fdd18">MCUHWC_GetSoundSliderLevel</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *level);</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @brief Sets Wifi LED state</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * @param state State of Wifi LED. (True/False)</span></div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#ada094d994f3ff3fb16c7084a0a109bc0"> 77</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#ada094d994f3ff3fb16c7084a0a109bc0">MCUHWC_SetWifiLedState</a>(<span class="keywordtype">bool</span> state);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * @brief Sets the notification LED pattern</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @param pattern Pattern for the notification LED.</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a8891b4698e691e5b839f349bcdb3e429"> 83</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a8891b4698e691e5b839f349bcdb3e429">MCUHWC_SetInfoLedPattern</a>(<span class="keyword">const</span> <a class="code" href="structInfoLedPattern.html">InfoLedPattern</a>* pattern);</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief Sets Power LED state</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> * @param state powerLedState State of power LED.</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a6193c9f5b52bf44c15b1456811137670"> 89</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a6193c9f5b52bf44c15b1456811137670">MCUHWC_SetPowerLedState</a>(<a class="code" href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3">powerLedState</a> state);</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @brief Gets 3d slider level</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @param level Pointer to write 3D slider level to.</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#aba220bd0c1621ac22d59a054b47dd7d9"> 95</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#aba220bd0c1621ac22d59a054b47dd7d9">MCUHWC_Get3dSliderLevel</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *level);</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @brief Gets the major MCU firmware version</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @param out Pointer to write the major firmware version to.</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a96c894a412095aed6ba108ff3ea0dcf4"> 101</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a96c894a412095aed6ba108ff3ea0dcf4">MCUHWC_GetFwVerHigh</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @brief Gets the minor MCU firmware version</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param out Pointer to write the minor firmware version to.</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="mcuhwc_8h.html#a38c45aafa4ff30ca18273d310b7bddaa"> 107</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="mcuhwc_8h.html#a38c45aafa4ff30ca18273d310b7bddaa">MCUHWC_GetFwVerLow</a>(<a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> *out);</div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a2c3df587f208073b09386754c8c49cc7"><div class="ttname"><a href="mcuhwc_8h.html#a2c3df587f208073b09386754c8c49cc7">MCUHWC_ReadRegister</a></div><div class="ttdeci">Result MCUHWC_ReadRegister(u8 reg, void *data, u32 size)</div><div class="ttdoc">Reads data from an i2c device3 register.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a389c0cd8f4b0d664a72bd3b0ff40a359"><div class="ttname"><a href="mcuhwc_8h.html#a389c0cd8f4b0d664a72bd3b0ff40a359">MCUHWC_GetBatteryLevel</a></div><div class="ttdeci">Result MCUHWC_GetBatteryLevel(u8 *level)</div><div class="ttdoc">Gets the battery level.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a38c45aafa4ff30ca18273d310b7bddaa"><div class="ttname"><a href="mcuhwc_8h.html#a38c45aafa4ff30ca18273d310b7bddaa">MCUHWC_GetFwVerLow</a></div><div class="ttdeci">Result MCUHWC_GetFwVerLow(u8 *out)</div><div class="ttdoc">Gets the minor MCU firmware version.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a45296be24ea40904294e466245052200"><div class="ttname"><a href="mcuhwc_8h.html#a45296be24ea40904294e466245052200">mcuHwcInit</a></div><div class="ttdeci">Result mcuHwcInit(void)</div><div class="ttdoc">Initializes mcuHwc.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3">powerLedState</a></div><div class="ttdeci">powerLedState</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:7</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3a052ec9418815c097e290abeb03f91c14"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a052ec9418815c097e290abeb03f91c14">LED_NORMAL</a></div><div class="ttdeci">@ LED_NORMAL</div><div class="ttdoc">The normal mode of the led.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:8</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3a05db5006cefc8596f609ed1efe3834d8"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3a05db5006cefc8596f609ed1efe3834d8">LED_BLINK_RED</a></div><div class="ttdeci">@ LED_BLINK_RED</div><div class="ttdoc">Blinking red state of power led and notification led.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:13</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3aa67c57c0ff22a2772cb6a5751a3327bf"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3aa67c57c0ff22a2772cb6a5751a3327bf">LED_BLUE</a></div><div class="ttdeci">@ LED_BLUE</div><div class="ttdoc">Blue state of the led.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:12</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3ad80f13022b6d309268fadc7b1da89cb9"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ad80f13022b6d309268fadc7b1da89cb9">LED_RED</a></div><div class="ttdeci">@ LED_RED</div><div class="ttdoc">Red state of the led.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:11</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3ae9f8f9f5a62af88aac710a7bfa21bdd0"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3ae9f8f9f5a62af88aac710a7bfa21bdd0">LED_SLEEP_MODE</a></div><div class="ttdeci">@ LED_SLEEP_MODE</div><div class="ttdoc">The led pulses slowly as it does in the sleep mode.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:9</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a4d0ecf130d757d1097b02791affd59f3afc0ca8cc6cbe215fd3f1ae6d40255b40"><div class="ttname"><a href="mcuhwc_8h.html#a4d0ecf130d757d1097b02791affd59f3afc0ca8cc6cbe215fd3f1ae6d40255b40">LED_OFF</a></div><div class="ttdeci">@ LED_OFF</div><div class="ttdoc">Switch off power led.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:10</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a5e720a5410b1dd0e65493b5332c587f2"><div class="ttname"><a href="mcuhwc_8h.html#a5e720a5410b1dd0e65493b5332c587f2">MCUHWC_WriteRegister</a></div><div class="ttdeci">Result MCUHWC_WriteRegister(u8 reg, const void *data, u32 size)</div><div class="ttdoc">Writes data to a i2c device3 register.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a6193c9f5b52bf44c15b1456811137670"><div class="ttname"><a href="mcuhwc_8h.html#a6193c9f5b52bf44c15b1456811137670">MCUHWC_SetPowerLedState</a></div><div class="ttdeci">Result MCUHWC_SetPowerLedState(powerLedState state)</div><div class="ttdoc">Sets Power LED state.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a7bfe72c086ad88cae962c156fc8fdd18"><div class="ttname"><a href="mcuhwc_8h.html#a7bfe72c086ad88cae962c156fc8fdd18">MCUHWC_GetSoundSliderLevel</a></div><div class="ttdeci">Result MCUHWC_GetSoundSliderLevel(u8 *level)</div><div class="ttdoc">Gets the sound slider level.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a8891b4698e691e5b839f349bcdb3e429"><div class="ttname"><a href="mcuhwc_8h.html#a8891b4698e691e5b839f349bcdb3e429">MCUHWC_SetInfoLedPattern</a></div><div class="ttdeci">Result MCUHWC_SetInfoLedPattern(const InfoLedPattern *pattern)</div><div class="ttdoc">Sets the notification LED pattern.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a8d802328caeb7b975e92d8dc99ea8e5a"><div class="ttname"><a href="mcuhwc_8h.html#a8d802328caeb7b975e92d8dc99ea8e5a">MCUHWC_GetBatteryVoltage</a></div><div class="ttdeci">Result MCUHWC_GetBatteryVoltage(u8 *voltage)</div><div class="ttdoc">Gets the battery voltage.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_a96c894a412095aed6ba108ff3ea0dcf4"><div class="ttname"><a href="mcuhwc_8h.html#a96c894a412095aed6ba108ff3ea0dcf4">MCUHWC_GetFwVerHigh</a></div><div class="ttdeci">Result MCUHWC_GetFwVerHigh(u8 *out)</div><div class="ttdoc">Gets the major MCU firmware version.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_aba220bd0c1621ac22d59a054b47dd7d9"><div class="ttname"><a href="mcuhwc_8h.html#aba220bd0c1621ac22d59a054b47dd7d9">MCUHWC_Get3dSliderLevel</a></div><div class="ttdeci">Result MCUHWC_Get3dSliderLevel(u8 *level)</div><div class="ttdoc">Gets 3d slider level.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_ad8f961927d162f978bf37d5925e5608a"><div class="ttname"><a href="mcuhwc_8h.html#ad8f961927d162f978bf37d5925e5608a">mcuHwcGetSessionHandle</a></div><div class="ttdeci">Handle * mcuHwcGetSessionHandle(void)</div><div class="ttdoc">Gets the current mcuHwc session handle.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_ada094d994f3ff3fb16c7084a0a109bc0"><div class="ttname"><a href="mcuhwc_8h.html#ada094d994f3ff3fb16c7084a0a109bc0">MCUHWC_SetWifiLedState</a></div><div class="ttdeci">Result MCUHWC_SetWifiLedState(bool state)</div><div class="ttdoc">Sets Wifi LED state.</div></div>
|
|
<div class="ttc" id="amcuhwc_8h_html_adc434fe29cd5d664fe7559a904da5c07"><div class="ttname"><a href="mcuhwc_8h.html#adc434fe29cd5d664fe7559a904da5c07">mcuHwcExit</a></div><div class="ttdeci">void mcuHwcExit(void)</div><div class="ttdoc">Exits mcuHwc.</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html"><div class="ttname"><a href="structInfoLedPattern.html">InfoLedPattern</a></div><div class="ttdef"><b>Definition:</b> mcuhwc.h:17</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_a2881d320c8af7ea7c3eab05e165880cb"><div class="ttname"><a href="structInfoLedPattern.html#a2881d320c8af7ea7c3eab05e165880cb">InfoLedPattern::delay</a></div><div class="ttdeci">u8 delay</div><div class="ttdoc">Delay between pattern values, 1/16th of a second (1 second = 0x10)</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:18</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_a78f415cacf93273b538d273b19492422"><div class="ttname"><a href="structInfoLedPattern.html#a78f415cacf93273b538d273b19492422">InfoLedPattern::loopDelay</a></div><div class="ttdeci">u8 loopDelay</div><div class="ttdoc">Delay between pattern loops, 1/16th of a second (1 second = 0x10, 0xFF = pattern is played only once)</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:20</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_aaded6fd4e4719e7e711b4adf9bb6ba6f"><div class="ttname"><a href="structInfoLedPattern.html#aaded6fd4e4719e7e711b4adf9bb6ba6f">InfoLedPattern::blinkSpeed</a></div><div class="ttdeci">u8 blinkSpeed</div><div class="ttdoc">Blink speed, when smoothing == 0x00.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:21</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_ab47dd417407b2084d9ea9b8c95ddffe6"><div class="ttname"><a href="structInfoLedPattern.html#ab47dd417407b2084d9ea9b8c95ddffe6">InfoLedPattern::greenPattern</a></div><div class="ttdeci">u8 greenPattern[32]</div><div class="ttdoc">Pattern for green component.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:23</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_ab596534cb43de51b86b3f3a5c0b08c1e"><div class="ttname"><a href="structInfoLedPattern.html#ab596534cb43de51b86b3f3a5c0b08c1e">InfoLedPattern::bluePattern</a></div><div class="ttdeci">u8 bluePattern[32]</div><div class="ttdoc">Pattern for blue component.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:24</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_ac8b3bcf036d150e8a61a61a8eb46afa0"><div class="ttname"><a href="structInfoLedPattern.html#ac8b3bcf036d150e8a61a61a8eb46afa0">InfoLedPattern::redPattern</a></div><div class="ttdeci">u8 redPattern[32]</div><div class="ttdoc">Pattern for red component.</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:22</div></div>
|
|
<div class="ttc" id="astructInfoLedPattern_html_ae55c14822b91cfafdf9ce156c81ceba3"><div class="ttname"><a href="structInfoLedPattern.html#ae55c14822b91cfafdf9ce156c81ceba3">InfoLedPattern::smoothing</a></div><div class="ttdeci">u8 smoothing</div><div class="ttdoc">Smoothing between pattern values (higher = smoother)</div><div class="ttdef"><b>Definition:</b> mcuhwc.h:19</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|