84 lines
15 KiB
HTML
84 lines
15 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>Adafruit E-Paper Display Library: Adafruit_IL0373.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">Adafruit E-Paper Display Library
|
|
</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>
|
|
</div><!-- top -->
|
|
<!-- 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 class="header">
|
|
<div class="headertitle">
|
|
<div class="title">Adafruit_IL0373.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#ifndef LIB_ADAFRUIT_IL0373</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define LIB_ADAFRUIT_IL0373</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> </div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "<a class="code" href="_adafruit___e_p_d_8h.html">Adafruit_EPD.h</a>"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include <Arduino.h></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#define EPD_RAM_BW 0x10</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define EPD_RAM_RED 0x13</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define IL0373_PANEL_SETTING 0x00</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define IL0373_POWER_SETTING 0x01</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define IL0373_POWER_OFF 0x02</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define IL0373_POWER_OFF_SEQUENCE 0x03</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define IL0373_POWER_ON 0x04</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define IL0373_POWER_ON_MEASURE 0x05</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define IL0373_BOOSTER_SOFT_START 0x06</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define IL0373_DEEP_SLEEP 0x07</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define IL0373_DTM1 0x10</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define IL0373_DATA_STOP 0x11</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define IL0373_DISPLAY_REFRESH 0x12</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define IL0373_PDTM1 0x14</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define IL0373_PDTM2 0x15</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define IL0373_PDRF 0x16</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define IL0373_LUT1 0x20</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define IL0373_LUTWW 0x21</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define IL0373_LUTBW 0x22</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define IL0373_LUTWB 0x23</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define IL0373_LUTBB 0x24</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define IL0373_PLL 0x30</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define IL0373_CDI 0x50</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define IL0373_RESOLUTION 0x61</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define IL0373_VCM_DC_SETTING 0x82</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">/**************************************************************************/</span></div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_adafruit___i_l0373.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="class_adafruit___i_l0373.html">Adafruit_IL0373</a> : <span class="keyword">public</span> <a class="code" href="class_adafruit___e_p_d.html">Adafruit_EPD</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="class_adafruit___i_l0373.html#afc815c803c1c125114860b47736d6281">Adafruit_IL0373</a>(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height, int8_t SID, int8_t SCLK, int8_t DC,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  int8_t RST, int8_t CS, int8_t SRCS, int8_t MISO,</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  int8_t BUSY = -1);</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="class_adafruit___i_l0373.html#afc815c803c1c125114860b47736d6281">Adafruit_IL0373</a>(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height, int8_t DC, int8_t RST, int8_t CS,</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  int8_t SRCS, int8_t BUSY = -1, SPIClass *spi = &SPI);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#a351b1ec3099305a14ab0559f565c2cd8">begin</a>(<span class="keywordtype">bool</span> reset = <span class="keyword">true</span>);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#ae317aa283349c3dc0faffbf8dec22e09">powerUp</a>();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#a4ff92fd9fbbd5509b60077f8111ea080">powerDown</a>();</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#aea0bc57a47b67a1dc58df0951a27efee">update</a>();</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  uint8_t <a class="code" href="class_adafruit___i_l0373.html#a417bd349173422791cd43ef3bdfae175">writeRAMCommand</a>(uint8_t index);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#a7b6cf5e271c5ef34f395f67fb78a2c76">setRAMAddress</a>(uint16_t x, uint16_t y);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">void</span> <a class="code" href="class_adafruit___i_l0373.html#af10144aa92429027c1a0aaf960d1bc13">busy_wait</a>();</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> };</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_adafruit___i_l0373_html_a417bd349173422791cd43ef3bdfae175"><div class="ttname"><a href="class_adafruit___i_l0373.html#a417bd349173422791cd43ef3bdfae175">Adafruit_IL0373::writeRAMCommand</a></div><div class="ttdeci">uint8_t writeRAMCommand(uint8_t index)</div><div class="ttdoc">Send the specific command to start writing to EPD display RAM. </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:190</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_af10144aa92429027c1a0aaf960d1bc13"><div class="ttname"><a href="class_adafruit___i_l0373.html#af10144aa92429027c1a0aaf960d1bc13">Adafruit_IL0373::busy_wait</a></div><div class="ttdeci">void busy_wait()</div><div class="ttdoc">wait for busy signal to end </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:78</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html"><div class="ttname"><a href="class_adafruit___i_l0373.html">Adafruit_IL0373</a></div><div class="ttdoc">Class for interfacing with IL0373 EPD drivers. </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.h:39</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_aea0bc57a47b67a1dc58df0951a27efee"><div class="ttname"><a href="class_adafruit___i_l0373.html#aea0bc57a47b67a1dc58df0951a27efee">Adafruit_IL0373::update</a></div><div class="ttdeci">void update()</div><div class="ttdoc">signal the display to update </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:107</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_a351b1ec3099305a14ab0559f565c2cd8"><div class="ttname"><a href="class_adafruit___i_l0373.html#a351b1ec3099305a14ab0559f565c2cd8">Adafruit_IL0373::begin</a></div><div class="ttdeci">void begin(bool reset=true)</div><div class="ttdoc">begin communication with and set up the display. </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:94</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_afc815c803c1c125114860b47736d6281"><div class="ttname"><a href="class_adafruit___i_l0373.html#afc815c803c1c125114860b47736d6281">Adafruit_IL0373::Adafruit_IL0373</a></div><div class="ttdeci">Adafruit_IL0373(int width, int height, int8_t SID, int8_t SCLK, int8_t DC, int8_t RST, int8_t CS, int8_t SRCS, int8_t MISO, int8_t BUSY=-1)</div><div class="ttdoc">constructor if using external SRAM chip and software SPI </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:21</div></div>
|
|
<div class="ttc" id="class_adafruit___e_p_d_html"><div class="ttname"><a href="class_adafruit___e_p_d.html">Adafruit_EPD</a></div><div class="ttdoc">Class for interfacing with Adafruit EPD display breakouts. </div><div class="ttdef"><b>Definition:</b> Adafruit_EPD.h:63</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_ae317aa283349c3dc0faffbf8dec22e09"><div class="ttname"><a href="class_adafruit___i_l0373.html#ae317aa283349c3dc0faffbf8dec22e09">Adafruit_IL0373::powerUp</a></div><div class="ttdeci">void powerUp()</div><div class="ttdoc">start up the display </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:123</div></div>
|
|
<div class="ttc" id="_adafruit___e_p_d_8h_html"><div class="ttname"><a href="_adafruit___e_p_d_8h.html">Adafruit_EPD.h</a></div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_a4ff92fd9fbbd5509b60077f8111ea080"><div class="ttname"><a href="class_adafruit___i_l0373.html#a4ff92fd9fbbd5509b60077f8111ea080">Adafruit_IL0373::powerDown</a></div><div class="ttdeci">void powerDown()</div><div class="ttdoc">wind down the display </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:168</div></div>
|
|
<div class="ttc" id="class_adafruit___i_l0373_html_a7b6cf5e271c5ef34f395f67fb78a2c76"><div class="ttname"><a href="class_adafruit___i_l0373.html#a7b6cf5e271c5ef34f395f67fb78a2c76">Adafruit_IL0373::setRAMAddress</a></div><div class="ttdeci">void setRAMAddress(uint16_t x, uint16_t y)</div><div class="ttdoc">Some displays require setting the RAM address pointer. </div><div class="ttdef"><b>Definition:</b> Adafruit_IL0373.cpp:207</div></div>
|
|
</div><!-- fragment --></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.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|