<!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 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>
<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="summary">
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">MyHwHAL.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="_my_hw_h_a_l_8h__dep__incl.png" border="0" usemap="#hal_2architecture_2_my_hw_h_a_l_8hdep" alt=""/></div>
<map name="hal_2architecture_2_my_hw_h_a_l_8hdep" id="hal_2architecture_2_my_hw_h_a_l_8hdep">
<area shape="rect" title=" " alt="" coords="5,5,212,32"/>
<area shape="rect" href="_my_sensors_8h.html" title="API declaration for MySensors." alt="" coords="56,80,161,107"/>
</map>
</div>
</div>
<p><a href="_my_hw_h_a_l_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="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad3af9b2993e4ba889db63d5089b2013d"><td class="memItemLeft" align="right" valign="top"><a id="ad3af9b2993e4ba889db63d5089b2013d"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#ad3af9b2993e4ba889db63d5089b2013d">INVALID_INTERRUPT_NUM</a>   (0xFFu)</td></tr>
<tr class="memdesc:ad3af9b2993e4ba889db63d5089b2013d"><td class="mdescLeft"> </td><td class="mdescRight">Invalid interrupt. <br /></td></tr>
<tr class="separator:ad3af9b2993e4ba889db63d5089b2013d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66193564024708e723203e37bb8bbf7e"><td class="memItemLeft" align="right" valign="top"><a id="a66193564024708e723203e37bb8bbf7e"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a66193564024708e723203e37bb8bbf7e">MY_HWID_PADDING_BYTE</a>   (0xAAu)</td></tr>
<tr class="memdesc:a66193564024708e723203e37bb8bbf7e"><td class="mdescLeft"> </td><td class="mdescRight">HwID padding byte. <br /></td></tr>
<tr class="separator:a66193564024708e723203e37bb8bbf7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a773518011c640581f16cf5a261c81e9d"><td class="memItemLeft" align="right" valign="top"><a id="a773518011c640581f16cf5a261c81e9d"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a773518011c640581f16cf5a261c81e9d">IRQ_HANDLER_ATTR</a></td></tr>
<tr class="memdesc:a773518011c640581f16cf5a261c81e9d"><td class="mdescLeft"> </td><td class="mdescRight">ESP8266/ESP32 IRQ handlers need to be stored in IRAM. <br /></td></tr>
<tr class="separator:a773518011c640581f16cf5a261c81e9d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a636c78f44b21d19db62e011747f5a76c"><td class="memItemLeft" align="right" valign="top"><a id="a636c78f44b21d19db62e011747f5a76c"></a>
typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a>[16]</td></tr>
<tr class="memdesc:a636c78f44b21d19db62e011747f5a76c"><td class="mdescLeft"> </td><td class="mdescRight">unique ID <br /></td></tr>
<tr class="separator:a636c78f44b21d19db62e011747f5a76c"><td class="memSeparator" colspan="2"> </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:a5fbfd429e72b5ee85a7e6be9c8310edb"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a5fbfd429e72b5ee85a7e6be9c8310edb">hwSleep</a> (uint32_t ms)</td></tr>
<tr class="separator:a5fbfd429e72b5ee85a7e6be9c8310edb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f35c7c602efa6d406faa0be5da62237"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a4f35c7c602efa6d406faa0be5da62237">hwSleep</a> (const uint8_t interrupt, const uint8_t mode, uint32_t ms)</td></tr>
<tr class="separator:a4f35c7c602efa6d406faa0be5da62237"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4a36c47466df62533a501cadb4905148"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a4a36c47466df62533a501cadb4905148">hwSleep</a> (const uint8_t interrupt1, const uint8_t mode1, const uint8_t interrupt2, const uint8_t mode2, uint32_t ms)</td></tr>
<tr class="separator:a4a36c47466df62533a501cadb4905148"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a143fdf678fc5920a2a53319365f3c089"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a143fdf678fc5920a2a53319365f3c089">hwUniqueID</a> (<a class="el" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a> *uniqueID)</td></tr>
<tr class="separator:a143fdf678fc5920a2a53319365f3c089"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a943e5fae6d2a4461f16de76e3d8521c4"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a943e5fae6d2a4461f16de76e3d8521c4">hwCPUVoltage</a> (void)</td></tr>
<tr class="separator:a943e5fae6d2a4461f16de76e3d8521c4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a326ae7cc863292e860623bc38de1c664"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a326ae7cc863292e860623bc38de1c664">hwCPUFrequency</a> (void)</td></tr>
<tr class="separator:a326ae7cc863292e860623bc38de1c664"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a5c5f9d1f888aec7b4781c6ea67cbf6"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a7a5c5f9d1f888aec7b4781c6ea67cbf6">hwCPUTemperature</a> (void)</td></tr>
<tr class="separator:a7a5c5f9d1f888aec7b4781c6ea67cbf6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9e4b59ca4fa43dc12e24431f0e425d0f"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_my_hw_h_a_l_8h.html#a9e4b59ca4fa43dc12e24431f0e425d0f">hwFreeMem</a> (void)</td></tr>
<tr class="separator:a9e4b59ca4fa43dc12e24431f0e425d0f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>MySensors hardware abstraction layer </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a326ae7cc863292e860623bc38de1c664"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a326ae7cc863292e860623bc38de1c664">◆ </a></span>hwCPUFrequency()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t hwCPUFrequency </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>CPU frequency </p><dl class="section return"><dt>Returns</dt><dd>CPU frequency in 1/10Mhz </dd></dl>
</div>
</div>
<a id="a7a5c5f9d1f888aec7b4781c6ea67cbf6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a5c5f9d1f888aec7b4781c6ea67cbf6">◆ </a></span>hwCPUTemperature()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t hwCPUTemperature </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>CPU temperature (if available) Adjust calibration parameters via MY_<ARCH>_TEMPERATURE_OFFSET and MY_<ARCH>_TEMPERATURE_GAIN </p><dl class="section return"><dt>Returns</dt><dd>CPU temperature in °C, -127 if not available </dd></dl>
</div>
</div>
<a id="a943e5fae6d2a4461f16de76e3d8521c4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a943e5fae6d2a4461f16de76e3d8521c4">◆ </a></span>hwCPUVoltage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t hwCPUVoltage </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>CPU voltage </p><dl class="section return"><dt>Returns</dt><dd>CPU voltage in mV </dd></dl>
</div>
</div>
<a id="a9e4b59ca4fa43dc12e24431f0e425d0f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e4b59ca4fa43dc12e24431f0e425d0f">◆ </a></span>hwFreeMem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t hwFreeMem </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Report free memory (if function available) </p><dl class="section return"><dt>Returns</dt><dd>free memory in bytes </dd></dl>
</div>
</div>
<a id="a4f35c7c602efa6d406faa0be5da62237"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f35c7c602efa6d406faa0be5da62237">◆ </a></span>hwSleep() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t hwSleep </td>
<td>(</td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>interrupt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>ms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep for a defined time, using minimum power, or until woken by interrupt. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">interrupt</td><td>Interrupt number, which can wake the mcu from sleep. </td></tr>
<tr><td class="paramname">mode</td><td>Interrupt mode, as passed to attachInterrupt. </td></tr>
<tr><td class="paramname">ms</td><td>Time to sleep, in [ms]. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MY_WAKE_UP_BY_TIMER when woken by timer, or interrupt number when woken by interrupt. </dd></dl>
</div>
</div>
<a id="a4a36c47466df62533a501cadb4905148"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a36c47466df62533a501cadb4905148">◆ </a></span>hwSleep() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t hwSleep </td>
<td>(</td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>interrupt1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>mode1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>interrupt2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t </td>
<td class="paramname"><em>mode2</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>ms</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep for a defined time, using minimum power, or until woken by one of the interrupts. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">interrupt1</td><td>Interrupt1 number, which can wake the mcu from sleep. </td></tr>
<tr><td class="paramname">mode1</td><td>Interrupt1 mode, as passed to attachInterrupt. </td></tr>
<tr><td class="paramname">interrupt2</td><td>Interrupt2 number, which can wake the mcu from sleep. </td></tr>
<tr><td class="paramname">mode2</td><td>Interrupt2 mode, as passed to attachInterrupt. </td></tr>
<tr><td class="paramname">ms</td><td>Time to sleep, in [ms]. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MY_WAKE_UP_BY_TIMER when woken by timer, or interrupt number when woken by interrupt. </dd></dl>
</div>
</div>
<a id="a5fbfd429e72b5ee85a7e6be9c8310edb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fbfd429e72b5ee85a7e6be9c8310edb">◆ </a></span>hwSleep() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int8_t hwSleep </td>
<td>(</td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep for a defined time, using minimum power. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ms</td><td>Time to sleep, in [ms]. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MY_WAKE_UP_BY_TIMER. </dd></dl>
</div>
</div>
<a id="a143fdf678fc5920a2a53319365f3c089"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a143fdf678fc5920a2a53319365f3c089">◆ </a></span>hwUniqueID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hwUniqueID </td>
<td>(</td>
<td class="paramtype"><a class="el" href="_my_hw_h_a_l_8h.html#a636c78f44b21d19db62e011747f5a76c">unique_id_t</a> * </td>
<td class="paramname"><em>uniqueID</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve unique hardware ID </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">uniqueID</td><td>unique ID </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if unique ID successfully retrieved </dd></dl>
</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.17
</small></address>
</body>
</html>