Th3maz1ng/projet3_temperature
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
c32791ecfc
projet3_temperature/lib/I2CDeviceLib/html/class_i2_c_device.html
anschrammh c32791ecfc Ajout des documentations doxygen
2020-05-14 16:15:09 +02:00

193 lines
9.7 KiB
HTML
Raw Blame History

<!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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>STS21 et LTC2497: Référence de la classe I2CDevice</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">STS21 et LTC2497
</div>
<div id="projectbrief">Cette bibliothèque propose deux pilotes différent : un pilote pour le STS21 et un pilote pour LTC2497 qui sont deux périphériques I2C.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Généré par Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Recherche');
/* @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&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Recherche');
$(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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Fonctions membres publiques</a> &#124;
<a href="#pro-methods">Fonctions membres protégées</a> &#124;
<a href="#pro-attribs">Attributs protégés</a> &#124;
<a href="class_i2_c_device-members.html">Liste de tous les membres</a> </div>
<div class="headertitle">
<div class="title">Référence de la classe I2CDevice<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>La classe <a class="el" href="class_i2_c_device.html" title="La classe I2CDevice est une classe abstraite servant de modèle pour le développement de pilote pour p...">I2CDevice</a> est une classe abstraite servant de modèle pour le développement de pilote pour périphérique I2C.
<a href="class_i2_c_device.html#details">Plus de détails...</a></p>
<p><code>#include &lt;<a class="el" href="_i2_c_device_8h_source.html">I2CDevice.h</a>&gt;</code></p>
<div class="dynheader">
Graphe d'héritage de I2CDevice:</div>
<div class="dyncontent">
<div class="center">
<img src="class_i2_c_device.png" usemap="#I2CDevice_map" alt=""/>
<map id="I2CDevice_map" name="I2CDevice_map">
<area href="class_l_t_c2497.html" title="La classe LTC2497 permet de dialoguer avec l&#39;ADC LTC2497 de Linear Technology Cette ADC à 16 entrées ..." alt="LTC2497" shape="rect" coords="0,56,71,80"/>
<area href="class_s_t_s21.html" title="La classe STS21 permetant de dialoguer avec le STS21. " alt="STS21" shape="rect" coords="81,56,152,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Fonctions membres publiques</h2></td></tr>
<tr class="memitem:a5b3b03732462a6249a9d857e6ca47fdc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i2_c_device.html#a5b3b03732462a6249a9d857e6ca47fdc">I2CDevice</a> (const uint8_t address, TwoWire *twi=&amp;Wire)</td></tr>
<tr class="separator:a5b3b03732462a6249a9d857e6ca47fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Fonctions membres protégées</h2></td></tr>
<tr class="memitem:a8cfc5caa379a9d7a9eee0087c152b7a4"><td class="memItemLeft" align="right" valign="top">virtual boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_i2_c_device.html#a8cfc5caa379a9d7a9eee0087c152b7a4">begin</a> ()=0</td></tr>
<tr class="separator:a8cfc5caa379a9d7a9eee0087c152b7a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Attributs protégés</h2></td></tr>
<tr class="memitem:ac9d5359af30d52400f87428787cd74ec"><td class="memItemLeft" align="right" valign="top"><a id="ac9d5359af30d52400f87428787cd74ec"></a>
const uint8_t&#160;</td><td class="memItemRight" valign="bottom"><b>address</b></td></tr>
<tr class="separator:ac9d5359af30d52400f87428787cd74ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a051542d37cc42a51dd38a4df6d766fd2"><td class="memItemLeft" align="right" valign="top"><a id="a051542d37cc42a51dd38a4df6d766fd2"></a>
TwoWire *&#160;</td><td class="memItemRight" valign="bottom"><b>twi</b></td></tr>
<tr class="separator:a051542d37cc42a51dd38a4df6d766fd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5a7ba1a3dd144fbb040751ce0b3c20c"><td class="memItemLeft" align="right" valign="top"><a id="ac5a7ba1a3dd144fbb040751ce0b3c20c"></a>
boolean&#160;</td><td class="memItemRight" valign="bottom"><b>isPresent</b></td></tr>
<tr class="separator:ac5a7ba1a3dd144fbb040751ce0b3c20c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description détaillée</h2>
<div class="textblock"><p>La classe <a class="el" href="class_i2_c_device.html" title="La classe I2CDevice est une classe abstraite servant de modèle pour le développement de pilote pour p...">I2CDevice</a> est une classe abstraite servant de modèle pour le développement de pilote pour périphérique I2C. </p>
<p>Cette classe n'est donc pas instanciable directement. </p>
</div><h2 class="groupheader">Documentation des constructeurs et destructeur</h2>
<a id="a5b3b03732462a6249a9d857e6ca47fdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b3b03732462a6249a9d857e6ca47fdc">&#9670;&nbsp;</a></span>I2CDevice()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">I2CDevice::I2CDevice </td>
<td>(</td>
<td class="paramtype">const uint8_t&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TwoWire *&#160;</td>
<td class="paramname"><em>twi</em> = <code>&amp;Wire</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Le constructeur de la classe prend en paramètres : </p><dl class="params"><dt>Paramètres</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>: l'address du périphérique sur le bis I2C. (sur 7 bits) </td></tr>
<tr><td class="paramname">twi</td><td>: une adresse de l'instance de classe Wire faisant partie de l'écosystème Arduino. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Documentation des fonctions membres</h2>
<a id="a8cfc5caa379a9d7a9eee0087c152b7a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cfc5caa379a9d7a9eee0087c152b7a4">&#9670;&nbsp;</a></span>begin()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boolean I2CDevice::begin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialise le périphérique. </p><dl class="section return"><dt>Renvoie</dt><dd>boolean : true si l'initialisation a fonctionnée, false sinon. </dd></dl>
<p>Implémenté dans <a class="el" href="class_s_t_s21.html#ad9347225af3a665d37aaff5078c99624">STS21</a>, et <a class="el" href="class_l_t_c2497.html#acaaa6aedc2ea64be8a5768c2bf937034">LTC2497</a>.</p>
</div>
</div>
<hr/>La documentation de cette classe a été générée à partir des fichiers suivants :<ul>
<li><a class="el" href="_i2_c_device_8h_source.html">I2CDevice.h</a></li>
<li>I2CDevice.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Généré par &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink