<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: hal/architecture/MyHwHAL.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">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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_52c912f73dac9c4c0e442232e1b2bd80.html">hal</a></li><li class="navelem"><a class="el" href="dir_f2b50fdf5983ac8db5dbb1f1d585f6a3.html">architecture</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">MyHwHAL.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_my_hw_h_a_l_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"> * The MySensors Arduino library handles the wireless radio link and protocol</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * between your home built sensors/actuators and HA controller of choice.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The sensors forms a self healing radio network with optional repeaters. Each</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * repeater and gateway builds a routing tables in EEPROM which keeps track of the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * network topology allowing messages to be routed to nodes.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Created by Henrik Ekblad <henrik.ekblad@mysensors.org></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (C) 2013-2019 Sensnology AB</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Documentation: http://www.mysensors.org</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Support Forum: http://forum.mysensors.org</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * This program is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * modify it under the terms of the GNU General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * version 2 as published by the Free Software Foundation.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef MyHwHAL_h</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define MyHwHAL_h</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_my_hw_h_a_l_8h.html#ad3af9b2993e4ba889db63d5089b2013d"> 33</a></span> <span class="preprocessor">#define INVALID_INTERRUPT_NUM (0xFFu)</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="_my_hw_h_a_l_8h.html#a66193564024708e723203e37bb8bbf7e"> 39</a></span> <span class="preprocessor">#define MY_HWID_PADDING_BYTE (0xAAu)</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#if defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32)</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define IRQ_HANDLER_ATTR ICACHE_RAM_ATTR</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="_my_hw_h_a_l_8h.html#a773518011c640581f16cf5a261c81e9d"> 48</a></span> <span class="preprocessor">#define IRQ_HANDLER_ATTR</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">// Implement these as functions or macros</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"> 53</span> <span class="comment">#define hwInit() MY_SERIALDEVICE.begin(BAUD_RATE)</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">#define hwWatchdogReset() wdt_reset()</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">#define hwReboot() wdt_enable(WDTO_15MS); while (1)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">#define hwMillis() millis()</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment">#define hwDigitalWrite(__pin, __value)</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">#define hwDigitalRead(__pin)</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment">#define hwPinMode(__pin, __value)</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">void hwReadConfigBlock(void *buf, void *addr, size_t length);</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">void hwWriteConfigBlock(void *buf, void *addr, size_t length);</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">void hwWriteConfig(const int addr, uint8_t value);</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment">uint8_t hwReadConfig(const int addr);</span></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>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">//#define MY_HW_HAS_GETENTROPY</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c"> 77</a></span> <span class="keyword">typedef</span> uint8_t <a class="code" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a>[16];</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> int8_t <a class="code" href="_my_hw_h_a_l_8h.html#a5fbfd429e72b5ee85a7e6be9c8310edb">hwSleep</a>(uint32_t ms);</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> int8_t <a class="code" href="_my_hw_h_a_l_8h.html#a5fbfd429e72b5ee85a7e6be9c8310edb">hwSleep</a>(<span class="keyword">const</span> uint8_t interrupt, <span class="keyword">const</span> uint8_t mode, uint32_t ms);</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> int8_t <a class="code" href="_my_hw_h_a_l_8h.html#a5fbfd429e72b5ee85a7e6be9c8310edb">hwSleep</a>(<span class="keyword">const</span> uint8_t interrupt1, <span class="keyword">const</span> uint8_t mode1, <span class="keyword">const</span> uint8_t interrupt2,</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">const</span> uint8_t mode2,</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  uint32_t ms);</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="keywordtype">bool</span> <a class="code" href="_my_hw_h_a_l_8h.html#a143fdf678fc5920a2a53319365f3c089">hwUniqueID</a>(<a class="code" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a> *uniqueID);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> uint16_t <a class="code" href="_my_hw_h_a_l_8h.html#a943e5fae6d2a4461f16de76e3d8521c4">hwCPUVoltage</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> uint16_t <a class="code" href="_my_hw_h_a_l_8h.html#a326ae7cc863292e860623bc38de1c664">hwCPUFrequency</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> int8_t <a class="code" href="_my_hw_h_a_l_8h.html#a7a5c5f9d1f888aec7b4781c6ea67cbf6">hwCPUTemperature</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  </div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> uint16_t <a class="code" href="_my_hw_h_a_l_8h.html#a9e4b59ca4fa43dc12e24431f0e425d0f">hwFreeMem</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor">#if defined(DEBUG_OUTPUT_ENABLED)</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  </div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keywordtype">void</span> hwDebugPrint(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...);</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">static</span> <span class="keywordtype">void</span> hwDebugBuf2Str(<span class="keyword">const</span> uint8_t *buf, <span class="keywordtype">size_t</span> sz) <a class="code" href="union____attribute____.html">__attribute__</a>((unused));</div>
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  </div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="preprocessor">#ifdef DOXYGEN</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor">#define MY_CRITICAL_SECTION</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="preprocessor">#define MY_HW_HAS_GETENTROPY</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor">#endif </span><span class="comment">/* DOXYGEN */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#endif // #ifdef MyHw_h</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a9e4b59ca4fa43dc12e24431f0e425d0f"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a9e4b59ca4fa43dc12e24431f0e425d0f">hwFreeMem</a></div><div class="ttdeci">uint16_t hwFreeMem(void)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:365</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a5fbfd429e72b5ee85a7e6be9c8310edb"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a5fbfd429e72b5ee85a7e6be9c8310edb">hwSleep</a></div><div class="ttdeci">int8_t hwSleep(uint32_t ms)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:148</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a326ae7cc863292e860623bc38de1c664"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a326ae7cc863292e860623bc38de1c664">hwCPUFrequency</a></div><div class="ttdeci">uint16_t hwCPUFrequency(void)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:310</div></div>
<div class="ttc" id="aunion____attribute_____html"><div class="ttname"><a href="union____attribute____.html">__attribute__</a></div><div class="ttdoc">FW config structure, stored in eeprom.</div><div class="ttdef"><b>Definition:</b> MyMessage.h:619</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a636c78f44b21d19db62e011747f5a76c"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a></div><div class="ttdeci">uint8_t unique_id_t[16]</div><div class="ttdoc">unique ID</div><div class="ttdef"><b>Definition:</b> MyHwHAL.h:77</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a143fdf678fc5920a2a53319365f3c089"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a143fdf678fc5920a2a53319365f3c089">hwUniqueID</a></div><div class="ttdeci">bool hwUniqueID(unique_id_t *uniqueID)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:269</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a943e5fae6d2a4461f16de76e3d8521c4"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a943e5fae6d2a4461f16de76e3d8521c4">hwCPUVoltage</a></div><div class="ttdeci">uint16_t hwCPUVoltage(void)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:289</div></div>
<div class="ttc" id="a_my_hw_h_a_l_8h_html_a7a5c5f9d1f888aec7b4781c6ea67cbf6"><div class="ttname"><a href="_my_hw_h_a_l_8h.html#a7a5c5f9d1f888aec7b4781c6ea67cbf6">hwCPUTemperature</a></div><div class="ttdeci">int8_t hwCPUTemperature(void)</div><div class="ttdef"><b>Definition:</b> MyHwAVR.cpp:348</div></div>
<!-- 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.17
</small></address>
</body>
</html>