Files
ChameleonMini/Doc/Doxygen/html/_settings_8h_source.html
2018-01-17 21:06:28 +01:00

86 lines
13 KiB
HTML

<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Chameleon-Mini: Settings.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">Chameleon-Mini
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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_74b6a3b63f61c160c0f14b7a283a4c9b.html">Firmware</a></li><li class="navelem"><a class="el" href="dir_8465ec698d237f801ae9966d4551fcfa.html">Chameleon-Mini</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Settings.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_settings_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>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Settings.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Created on: 21.12.2013</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Author: skuser</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="preprocessor">#ifndef SETTINGS_H_</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#define SETTINGS_H_</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#include &quot;Button.h&quot;</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_configuration_8h.html">Configuration.h</a>&quot;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_log_8h.html">Log.h</a>&quot;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &quot;LED.h&quot;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;Memory.h&quot;</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#define SETTINGS_COUNT (MEMORY_SIZE / MEMORY_SIZE_PER_SETTING)</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#define SETTINGS_FIRST 1</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#define SETTINGS_LAST (SETTINGS_FIRST + SETTINGS_COUNT - 1)</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html"> 25</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; ButtonActionEnum ButtonActions[BUTTON_TYPE_COUNT]; </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html#a2de0f2e5da183f58d0a46c69e530905f"> 27</a></span>&#160; LogModeEnum <a class="code" href="struct_settings_entry_type.html#a2de0f2e5da183f58d0a46c69e530905f">LogMode</a>; </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html#a3356abc0d4b2c66663a998830ba810db"> 28</a></span>&#160; ConfigurationEnum <a class="code" href="struct_settings_entry_type.html#a3356abc0d4b2c66663a998830ba810db">Configuration</a>; </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html#abc547dcb36868b52ea63bad2905e8751"> 29</a></span>&#160; LEDHookEnum <a class="code" href="struct_settings_entry_type.html#abc547dcb36868b52ea63bad2905e8751">LEDRedFunction</a>; </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html#a178766edbb1fae270c733106c936ec5e"> 30</a></span>&#160; LEDHookEnum <a class="code" href="struct_settings_entry_type.html#a178766edbb1fae270c733106c936ec5e">LEDGreenFunction</a>; </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="struct_settings_entry_type.html#a8c13c87e174691cb0dbbbf555853829d"> 31</a></span>&#160; uint16_t <a class="code" href="struct_settings_entry_type.html#a8c13c87e174691cb0dbbbf555853829d">PendingTaskTimeout</a>; </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;} <a class="code" href="struct_settings_entry_type.html">SettingsEntryType</a>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; uint8_t ActiveSettingIdx;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="struct_settings_entry_type.html">SettingsEntryType</a>* ActiveSettingPtr;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="code" href="struct_settings_entry_type.html">SettingsEntryType</a> Settings[SETTINGS_COUNT];</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;} SettingsType;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">extern</span> SettingsType GlobalSettings;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keywordtype">void</span> SettingsLoad(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keywordtype">void</span> SettingsSave(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<span class="keywordtype">void</span> ActiveSettingNumberSave(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keywordtype">void</span> SettingsCycle(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="keywordtype">bool</span> SettingsSetActiveById(uint8_t Setting);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;uint8_t SettingsGetActiveById(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keywordtype">void</span> SettingsGetActiveByName(<span class="keywordtype">char</span>* SettingOut, uint16_t BufferSize);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keywordtype">bool</span> SettingsSetActiveByName(<span class="keyword">const</span> <span class="keywordtype">char</span>* Setting);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* SETTINGS_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="struct_settings_entry_type_html_a2de0f2e5da183f58d0a46c69e530905f"><div class="ttname"><a href="struct_settings_entry_type.html#a2de0f2e5da183f58d0a46c69e530905f">SettingsEntryType::LogMode</a></div><div class="ttdeci">LogModeEnum LogMode</div><div class="ttdoc">Button actions for this setting. </div><div class="ttdef"><b>Definition:</b> Settings.h:27</div></div>
<div class="ttc" id="_log_8h_html"><div class="ttname"><a href="_log_8h.html">Log.h</a></div></div>
<div class="ttc" id="struct_settings_entry_type_html"><div class="ttname"><a href="struct_settings_entry_type.html">SettingsEntryType</a></div><div class="ttdef"><b>Definition:</b> Settings.h:25</div></div>
<div class="ttc" id="struct_settings_entry_type_html_a178766edbb1fae270c733106c936ec5e"><div class="ttname"><a href="struct_settings_entry_type.html#a178766edbb1fae270c733106c936ec5e">SettingsEntryType::LEDGreenFunction</a></div><div class="ttdeci">LEDHookEnum LEDGreenFunction</div><div class="ttdoc">Red LED function for this setting. </div><div class="ttdef"><b>Definition:</b> Settings.h:30</div></div>
<div class="ttc" id="struct_settings_entry_type_html_a8c13c87e174691cb0dbbbf555853829d"><div class="ttname"><a href="struct_settings_entry_type.html#a8c13c87e174691cb0dbbbf555853829d">SettingsEntryType::PendingTaskTimeout</a></div><div class="ttdeci">uint16_t PendingTaskTimeout</div><div class="ttdoc">Green LED function for this setting. </div><div class="ttdef"><b>Definition:</b> Settings.h:31</div></div>
<div class="ttc" id="struct_settings_entry_type_html_a3356abc0d4b2c66663a998830ba810db"><div class="ttname"><a href="struct_settings_entry_type.html#a3356abc0d4b2c66663a998830ba810db">SettingsEntryType::Configuration</a></div><div class="ttdeci">ConfigurationEnum Configuration</div><div class="ttdoc">Log mode for this setting. </div><div class="ttdef"><b>Definition:</b> Settings.h:28</div></div>
<div class="ttc" id="struct_settings_entry_type_html_abc547dcb36868b52ea63bad2905e8751"><div class="ttname"><a href="struct_settings_entry_type.html#abc547dcb36868b52ea63bad2905e8751">SettingsEntryType::LEDRedFunction</a></div><div class="ttdeci">LEDHookEnum LEDRedFunction</div><div class="ttdoc">Active configuration for this setting. </div><div class="ttdef"><b>Definition:</b> Settings.h:29</div></div>
<div class="ttc" id="_configuration_8h_html"><div class="ttname"><a href="_configuration_8h.html">Configuration.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 17 2018 21:05:32 for Chameleon-Mini by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>