<!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: core/MyGatewayTransport.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_4270bfced15e0e73154b13468c7c9ad9.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">MyGatewayTransport.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="_my_gateway_transport_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 Tomas Hozza <thozza@gmail.com></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (C) 2015 Tomas Hozza</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="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#ifndef MyGatewayTransport_h</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define MyGatewayTransport_h</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor">#include "MyProtocol.h"</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor">#include "<a class="code" href="_my_sensors_core_8h.html">MySensorsCore.h</a>"</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="group___my_gateway_transportgrp.html#ga2242ef0b0501953df6340d3a9653b5a4"> 80</a></span> <span class="preprocessor">#define MSG_GW_STARTUP_COMPLETE "Gateway startup complete." </span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span> </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor">#if defined(MY_DEBUG_VERBOSE_GATEWAY)</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#define GATEWAY_DEBUG(x,...) DEBUG_OUTPUT(x, ##__VA_ARGS__) </span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="group___my_gateway_transportgrp.html#gadea24e5d2033d48ef56620fb75dd3414"> 85</a></span> <span class="preprocessor">#define GATEWAY_DEBUG(x,...) </span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="keywordtype">void</span> <a class="code" href="group___my_gateway_transportgrp.html#ga7fbcbfe339136f2f19d4c7b6fc2c0d13">gatewayTransportProcess</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keywordtype">bool</span> <a class="code" href="group___my_gateway_transportgrp.html#gad1b38f7df8d6285bd06ca48dfa06e599">gatewayTransportInit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">bool</span> <a class="code" href="group___my_gateway_transportgrp.html#ga25c29fb269199682b8ff07da3861fd75">gatewayTransportSend</a>(MyMessage &message);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">bool</span> <a class="code" href="group___my_gateway_transportgrp.html#ga1aa23a7a4a7ab2a1347dfda97996fd66">gatewayTransportAvailable</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> MyMessage& <a class="code" href="group___my_gateway_transportgrp.html#ga0074dabf6983d559e05b755c87377994">gatewayTransportReceive</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif </span><span class="comment">/* MyGatewayTransportEthernet_h */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="agroup___my_gateway_transportgrp_html_ga0074dabf6983d559e05b755c87377994"><div class="ttname"><a href="group___my_gateway_transportgrp.html#ga0074dabf6983d559e05b755c87377994">gatewayTransportReceive</a></div><div class="ttdeci">MyMessage & gatewayTransportReceive(void)</div><div class="ttdoc">Pick up last message received from controller.</div><div class="ttdef"><b>Definition:</b> MyGatewayTransportEthernet.cpp:489</div></div>
<div class="ttc" id="agroup___my_gateway_transportgrp_html_gad1b38f7df8d6285bd06ca48dfa06e599"><div class="ttname"><a href="group___my_gateway_transportgrp.html#gad1b38f7df8d6285bd06ca48dfa06e599">gatewayTransportInit</a></div><div class="ttdeci">bool gatewayTransportInit(void)</div><div class="ttdoc">Initialize gateway transport driver.</div><div class="ttdef"><b>Definition:</b> MyGatewayTransportEthernet.cpp:169</div></div>
<div class="ttc" id="agroup___my_gateway_transportgrp_html_ga7fbcbfe339136f2f19d4c7b6fc2c0d13"><div class="ttname"><a href="group___my_gateway_transportgrp.html#ga7fbcbfe339136f2f19d4c7b6fc2c0d13">gatewayTransportProcess</a></div><div class="ttdeci">void gatewayTransportProcess(void)</div><div class="ttdoc">Process gateway-related messages.</div><div class="ttdef"><b>Definition:</b> MyGatewayTransport.cpp:28</div></div>
<div class="ttc" id="agroup___my_gateway_transportgrp_html_ga25c29fb269199682b8ff07da3861fd75"><div class="ttname"><a href="group___my_gateway_transportgrp.html#ga25c29fb269199682b8ff07da3861fd75">gatewayTransportSend</a></div><div class="ttdeci">bool gatewayTransportSend(MyMessage &message)</div><div class="ttdoc">Send message to controller.</div><div class="ttdef"><b>Definition:</b> MyGatewayTransportEthernet.cpp:248</div></div>
<div class="ttc" id="agroup___my_gateway_transportgrp_html_ga1aa23a7a4a7ab2a1347dfda97996fd66"><div class="ttname"><a href="group___my_gateway_transportgrp.html#ga1aa23a7a4a7ab2a1347dfda97996fd66">gatewayTransportAvailable</a></div><div class="ttdeci">bool gatewayTransportAvailable(void)</div><div class="ttdoc">Check if a new message is available from controller.</div><div class="ttdef"><b>Definition:</b> MyGatewayTransportEthernet.cpp:369</div></div>
<div class="ttc" id="a_my_sensors_core_8h_html"><div class="ttname"><a href="_my_sensors_core_8h.html">MySensorsCore.h</a></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>