2539 lines
126 KiB
HTML
2539 lines
126 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.14"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Parola for Arduino: MD_Parola Class 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(initResizable);
|
|
/* @license-end */</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="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Parola for Arduino
|
|
 <span id="projectnumber">3.0</span>
|
|
</div>
|
|
<div id="projectbrief">Text effects for LED Matrix modular hardware</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.14 -->
|
|
<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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('class_m_d___parola.html','');});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_m_d___parola-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">MD_Parola Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <MD_Parola.h></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for MD_Parola:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_m_d___parola__inherit__graph.png" border="0" usemap="#_m_d___parola_inherit__map" alt="Inheritance graph"/></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for MD_Parola:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="class_m_d___parola__coll__graph.png" border="0" usemap="#_m_d___parola_coll__map" alt="Collaboration graph"/></div>
|
|
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a86d37f229d5294dee9bb2ec5ade42c5a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a86d37f229d5294dee9bb2ec5ade42c5a">MD_Parola</a> (MD_MAX72XX::moduleType_t mod, uint8_t dataPin, uint8_t clkPin, uint8_t csPin, uint8_t numDevices=1)</td></tr>
|
|
<tr class="separator:a86d37f229d5294dee9bb2ec5ade42c5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af13e292a19a8b72332268d923da4f588"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#af13e292a19a8b72332268d923da4f588">MD_Parola</a> (MD_MAX72XX::moduleType_t mod, uint8_t csPin, uint8_t numDevices=1)</td></tr>
|
|
<tr class="separator:af13e292a19a8b72332268d923da4f588"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aed2a8279a3bfe6f41add877fcf21456f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#aed2a8279a3bfe6f41add877fcf21456f">begin</a> (void)</td></tr>
|
|
<tr class="separator:aed2a8279a3bfe6f41add877fcf21456f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7539abd83f51423c76595b10fdaf911a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a7539abd83f51423c76595b10fdaf911a">begin</a> (uint8_t numZones)</td></tr>
|
|
<tr class="separator:a7539abd83f51423c76595b10fdaf911a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad65afea65fbbae8ff399d92072a3d1a5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ad65afea65fbbae8ff399d92072a3d1a5">~MD_Parola</a> (void)</td></tr>
|
|
<tr class="separator:ad65afea65fbbae8ff399d92072a3d1a5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Methods for core object control.</div></td></tr>
|
|
<tr class="memitem:add650d11e765d50f9d030dd98ae96e7f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#add650d11e765d50f9d030dd98ae96e7f">displayAnimate</a> (void)</td></tr>
|
|
<tr class="separator:add650d11e765d50f9d030dd98ae96e7f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a58696a833fb399fc68ed6152931baa94"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a58696a833fb399fc68ed6152931baa94">getZoneStatus</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a58696a833fb399fc68ed6152931baa94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f0368381f03ba2a6ee2704e47687829"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a7f0368381f03ba2a6ee2704e47687829">displayClear</a> (void)</td></tr>
|
|
<tr class="separator:a7f0368381f03ba2a6ee2704e47687829"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55e620af6a648e96121fdafdfd5c699b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a55e620af6a648e96121fdafdfd5c699b">displayClear</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a55e620af6a648e96121fdafdfd5c699b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2215961f392389a6ab9b17a5f098e4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ac2215961f392389a6ab9b17a5f098e4f">displayReset</a> (void)</td></tr>
|
|
<tr class="separator:ac2215961f392389a6ab9b17a5f098e4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b59392e8233a36b9d733a9b9a1fc4f5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a9b59392e8233a36b9d733a9b9a1fc4f5">displayReset</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a9b59392e8233a36b9d733a9b9a1fc4f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ce974c7eca26a5d25eb1e8e5be7b872"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a2ce974c7eca26a5d25eb1e8e5be7b872">displayShutdown</a> (bool b)</td></tr>
|
|
<tr class="separator:a2ce974c7eca26a5d25eb1e8e5be7b872"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4ebabd68838a04997d4b0493df59f998"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a4ebabd68838a04997d4b0493df59f998">displaySuspend</a> (bool b)</td></tr>
|
|
<tr class="separator:a4ebabd68838a04997d4b0493df59f998"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae94526b7b2fa5a40086dde50097e04d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ae94526b7b2fa5a40086dde50097e04d7">isAnimationAdvanced</a> (void)</td></tr>
|
|
<tr class="separator:ae94526b7b2fa5a40086dde50097e04d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a218bd5860a6023b58e5d00de2b1d976a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a218bd5860a6023b58e5d00de2b1d976a">setZone</a> (uint8_t z, uint8_t moduleStart, uint8_t moduleEnd)</td></tr>
|
|
<tr class="separator:a218bd5860a6023b58e5d00de2b1d976a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Methods for quick start displays.</div></td></tr>
|
|
<tr class="memitem:adf278c039b7313486420a8774250d751"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#adf278c039b7313486420a8774250d751">displayScroll</a> (char *pText, <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> align, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effect, uint16_t speed)</td></tr>
|
|
<tr class="separator:adf278c039b7313486420a8774250d751"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a53b4c922a283ce2304a91e970e56c45d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a53b4c922a283ce2304a91e970e56c45d">displayText</a> (char *pText, <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> align, uint16_t speed, uint16_t pause, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectIn, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectOut=<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86">PA_NO_EFFECT</a>)</td></tr>
|
|
<tr class="separator:a53b4c922a283ce2304a91e970e56c45d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5512bde50d6ee000d59a9bc46c1fb54b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a5512bde50d6ee000d59a9bc46c1fb54b">displayZoneText</a> (uint8_t z, char *pText, <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> align, uint16_t speed, uint16_t pause, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectIn, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectOut=<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86">PA_NO_EFFECT</a>)</td></tr>
|
|
<tr class="separator:a5512bde50d6ee000d59a9bc46c1fb54b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Support methods for visually adjusting the display.</div></td></tr>
|
|
<tr class="memitem:a8f68dc6cf4109c00f40cd2eb6df3bfde"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a8f68dc6cf4109c00f40cd2eb6df3bfde">getCharSpacing</a> (void)</td></tr>
|
|
<tr class="separator:a8f68dc6cf4109c00f40cd2eb6df3bfde"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acae7ac5d8d24280a3aeb00572c7ae789"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#acae7ac5d8d24280a3aeb00572c7ae789">getCharSpacing</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:acae7ac5d8d24280a3aeb00572c7ae789"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3029915ed2e456a47318e3f06a05d66b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a3029915ed2e456a47318e3f06a05d66b">getInvert</a> (void)</td></tr>
|
|
<tr class="separator:a3029915ed2e456a47318e3f06a05d66b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a862ad99377530902c2550a082a8629af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a862ad99377530902c2550a082a8629af">getInvert</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a862ad99377530902c2550a082a8629af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2e88fa0cad63e11f25fa52d1852c73c3"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a2e88fa0cad63e11f25fa52d1852c73c3">getPause</a> (void)</td></tr>
|
|
<tr class="separator:a2e88fa0cad63e11f25fa52d1852c73c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d925d5a975efe0d4d9a7d45e3004caa"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a2d925d5a975efe0d4d9a7d45e3004caa">getPause</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a2d925d5a975efe0d4d9a7d45e3004caa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abd0d9f2cd2f84381692d5cd9b8554f6a"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#abd0d9f2cd2f84381692d5cd9b8554f6a">getScrollSpacing</a> (void)</td></tr>
|
|
<tr class="separator:abd0d9f2cd2f84381692d5cd9b8554f6a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62ed6b65af45aef6e6a9bbad4d431e3d"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a62ed6b65af45aef6e6a9bbad4d431e3d">getSpeed</a> (void)</td></tr>
|
|
<tr class="separator:a62ed6b65af45aef6e6a9bbad4d431e3d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a77f476b4ffc195aec3c357f720903e38"><td class="memItemLeft" align="right" valign="top">uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a77f476b4ffc195aec3c357f720903e38">getSpeed</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a77f476b4ffc195aec3c357f720903e38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f51de612af3aad0b15de2386a599ec6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a7f51de612af3aad0b15de2386a599ec6">getTextAlignment</a> (void)</td></tr>
|
|
<tr class="separator:a7f51de612af3aad0b15de2386a599ec6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b485b580ee8e15b7ab11a73c6cd56ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a6b485b580ee8e15b7ab11a73c6cd56ff">getTextAlignment</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a6b485b580ee8e15b7ab11a73c6cd56ff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4285e8fdba021fde5973ab63348dafd9"><td class="memItemLeft" align="right" valign="top">boolean </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a4285e8fdba021fde5973ab63348dafd9">getZoneEffect</a> (uint8_t z, <a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a> ze)</td></tr>
|
|
<tr class="separator:a4285e8fdba021fde5973ab63348dafd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7ff7418d5b57162353f5fc5334a1112"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ad7ff7418d5b57162353f5fc5334a1112">setCharSpacing</a> (uint8_t cs)</td></tr>
|
|
<tr class="separator:ad7ff7418d5b57162353f5fc5334a1112"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acd33962d2013b7f0acc2297897bbb58b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#acd33962d2013b7f0acc2297897bbb58b">setCharSpacing</a> (uint8_t z, uint8_t cs)</td></tr>
|
|
<tr class="separator:acd33962d2013b7f0acc2297897bbb58b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa869921483a67899f9d06d84f5e537b4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#aa869921483a67899f9d06d84f5e537b4">setIntensity</a> (uint8_t intensity)</td></tr>
|
|
<tr class="separator:aa869921483a67899f9d06d84f5e537b4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45d97a582ca1adabfe5cb40d66c4bbd2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a45d97a582ca1adabfe5cb40d66c4bbd2">setIntensity</a> (uint8_t z, uint8_t intensity)</td></tr>
|
|
<tr class="separator:a45d97a582ca1adabfe5cb40d66c4bbd2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1d555db081a7766f3e7e79b8cc228794"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a1d555db081a7766f3e7e79b8cc228794">setInvert</a> (uint8_t invert)</td></tr>
|
|
<tr class="separator:a1d555db081a7766f3e7e79b8cc228794"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae5d024556b502a48e10f5fbe8c9c46e3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ae5d024556b502a48e10f5fbe8c9c46e3">setInvert</a> (uint8_t z, uint8_t invert)</td></tr>
|
|
<tr class="separator:ae5d024556b502a48e10f5fbe8c9c46e3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a535d4ba642406b02c26b6218e020c313"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause</a> (uint16_t pause)</td></tr>
|
|
<tr class="separator:a535d4ba642406b02c26b6218e020c313"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91a25b1e37741b75af08b90070682ee5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a91a25b1e37741b75af08b90070682ee5">setPause</a> (uint8_t z, uint16_t pause)</td></tr>
|
|
<tr class="separator:a91a25b1e37741b75af08b90070682ee5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9da2ed061c82a2278e19a72cd415f915"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a9da2ed061c82a2278e19a72cd415f915">setScrollSpacing</a> (uint16_t space)</td></tr>
|
|
<tr class="separator:a9da2ed061c82a2278e19a72cd415f915"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a148064778dfb85eb1fd73fe415fc1126"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed</a> (uint16_t speed)</td></tr>
|
|
<tr class="separator:a148064778dfb85eb1fd73fe415fc1126"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa92a0538ff725b970949231342ec6910"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#aa92a0538ff725b970949231342ec6910">setSpeed</a> (uint8_t z, uint16_t speed)</td></tr>
|
|
<tr class="separator:aa92a0538ff725b970949231342ec6910"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7407455c739aa60760b83d4f82142489"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a7407455c739aa60760b83d4f82142489">setSpriteData</a> (uint8_t z, uint8_t *inData, uint8_t inWidth, uint8_t inFrames, uint8_t *outData, uint8_t outWidth, uint8_t outFrames)</td></tr>
|
|
<tr class="separator:a7407455c739aa60760b83d4f82142489"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5a6fb6a69caf96bc9cc242082533e3ab"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a5a6fb6a69caf96bc9cc242082533e3ab">setSpriteData</a> (uint8_t *inData, uint8_t inWidth, uint8_t inFrames, uint8_t *outData, uint8_t outWidth, uint8_t outFrames)</td></tr>
|
|
<tr class="separator:a5a6fb6a69caf96bc9cc242082533e3ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6eb132905e5df99067e9716fd922d9ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a6eb132905e5df99067e9716fd922d9ed">setTextAlignment</a> (<a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> ta)</td></tr>
|
|
<tr class="separator:a6eb132905e5df99067e9716fd922d9ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a712ba7658c982c67e4a23ca0c4ef3ea8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a712ba7658c982c67e4a23ca0c4ef3ea8">setTextAlignment</a> (uint8_t z, <a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> ta)</td></tr>
|
|
<tr class="separator:a712ba7658c982c67e4a23ca0c4ef3ea8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b54fb1c05c976007031433439324739"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a1b54fb1c05c976007031433439324739">setTextBuffer</a> (char *pb)</td></tr>
|
|
<tr class="separator:a1b54fb1c05c976007031433439324739"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac13c9daea7b0f2ee1a837a4d23f7a776"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ac13c9daea7b0f2ee1a837a4d23f7a776">setTextBuffer</a> (uint8_t z, char *pb)</td></tr>
|
|
<tr class="separator:ac13c9daea7b0f2ee1a837a4d23f7a776"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af5c38fd43dbbb4169d5241ea17aa34bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect</a> (<a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectIn, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectOut)</td></tr>
|
|
<tr class="separator:af5c38fd43dbbb4169d5241ea17aa34bb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00c348909a79340e3c0bec1568f87ac7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a00c348909a79340e3c0bec1568f87ac7">setTextEffect</a> (uint8_t z, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectIn, <a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> effectOut)</td></tr>
|
|
<tr class="separator:a00c348909a79340e3c0bec1568f87ac7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa978891dd1382e933cb40c61c78c5956"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#aa978891dd1382e933cb40c61c78c5956">setZoneEffect</a> (uint8_t z, boolean b, <a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a> ze)</td></tr>
|
|
<tr class="separator:aa978891dd1382e933cb40c61c78c5956"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab3f9f4f3174555085d75faf987a3d398"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ab3f9f4f3174555085d75faf987a3d398">synchZoneStart</a> (void)</td></tr>
|
|
<tr class="separator:ab3f9f4f3174555085d75faf987a3d398"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Support methods for fonts and characters.</div></td></tr>
|
|
<tr class="memitem:ab43b189c71ffcde5f7af57b3d0df2da8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ab43b189c71ffcde5f7af57b3d0df2da8">addChar</a> (uint8_t code, uint8_t *data)</td></tr>
|
|
<tr class="separator:ab43b189c71ffcde5f7af57b3d0df2da8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee2338a32dc27a33e8c711bac5cecede"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#aee2338a32dc27a33e8c711bac5cecede">addChar</a> (uint8_t z, uint8_t code, uint8_t *data)</td></tr>
|
|
<tr class="separator:aee2338a32dc27a33e8c711bac5cecede"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a019ecf4d513920215f92ec435e8903df"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a019ecf4d513920215f92ec435e8903df">delChar</a> (uint8_t code)</td></tr>
|
|
<tr class="separator:a019ecf4d513920215f92ec435e8903df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4dc8e2d19fd6b344e1ca90c25de77a8"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#af4dc8e2d19fd6b344e1ca90c25de77a8">delChar</a> (uint8_t z, uint8_t code)</td></tr>
|
|
<tr class="separator:af4dc8e2d19fd6b344e1ca90c25de77a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8581c064f75185012b3b0b1a98561aab"><td class="memItemLeft" align="right" valign="top">MD_MAX72XX::fontType_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a8581c064f75185012b3b0b1a98561aab">getFont</a> (uint8_t z)</td></tr>
|
|
<tr class="separator:a8581c064f75185012b3b0b1a98561aab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af7c3f22e64a1b2b1a3c47ef410f481c8"><td class="memItemLeft" align="right" valign="top">MD_MAX72XX::fontType_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#af7c3f22e64a1b2b1a3c47ef410f481c8">getFont</a> (void)</td></tr>
|
|
<tr class="separator:af7c3f22e64a1b2b1a3c47ef410f481c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a619357fd65bc4b6a30a5d2e74b5d2140"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a619357fd65bc4b6a30a5d2e74b5d2140">setFont</a> (MD_MAX72XX::fontType_t *fontDef)</td></tr>
|
|
<tr class="separator:a619357fd65bc4b6a30a5d2e74b5d2140"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a97bf4988df87bb0d4a03dea69a32293c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a97bf4988df87bb0d4a03dea69a32293c">setFont</a> (uint8_t z, MD_MAX72XX::fontType_t *fontDef)</td></tr>
|
|
<tr class="separator:a97bf4988df87bb0d4a03dea69a32293c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Support methods for graphics.</div></td></tr>
|
|
<tr class="memitem:af6c70c27c6c631e1d71d60adf2ec1662"><td class="memItemLeft" align="right" valign="top">MD_MAX72XX * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#af6c70c27c6c631e1d71d60adf2ec1662">getGraphicObject</a> (void)</td></tr>
|
|
<tr class="separator:af6c70c27c6c631e1d71d60adf2ec1662"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb2ce8559e6d6382eb1d98d7ceb3126b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#acb2ce8559e6d6382eb1d98d7ceb3126b">getDisplayExtent</a> (uint16_t &startColumn, uint16_t &endColumn)</td></tr>
|
|
<tr class="separator:acb2ce8559e6d6382eb1d98d7ceb3126b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3008521a115ee792a7bc299563fba69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ae3008521a115ee792a7bc299563fba69">getDisplayExtent</a> (uint8_t z, uint16_t &startColumn, uint16_t &endColumn)</td></tr>
|
|
<tr class="separator:ae3008521a115ee792a7bc299563fba69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0711639574f70ce7bd8d88d7c117df0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ae0711639574f70ce7bd8d88d7c117df0">getTextExtent</a> (uint16_t &startColumn, uint16_t &endColumn)</td></tr>
|
|
<tr class="separator:ae0711639574f70ce7bd8d88d7c117df0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a254824704bd14dcfb897a407495699e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a254824704bd14dcfb897a407495699e4">getTextExtent</a> (uint8_t z, uint16_t &startColumn, uint16_t &endColumn)</td></tr>
|
|
<tr class="separator:a254824704bd14dcfb897a407495699e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Support methods for Print class extension.</div></td></tr>
|
|
<tr class="memitem:a6c5fe7373f27edf29abb639cf3cb1dfb"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a6c5fe7373f27edf29abb639cf3cb1dfb">write</a> (uint8_t c)</td></tr>
|
|
<tr class="separator:a6c5fe7373f27edf29abb639cf3cb1dfb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a933934ad1ec191419dad4ddceedb9fd6"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#a933934ad1ec191419dad4ddceedb9fd6">write</a> (const char *str)</td></tr>
|
|
<tr class="separator:a933934ad1ec191419dad4ddceedb9fd6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ace798ba32cb774792e602778654cd159"><td class="memItemLeft" align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_m_d___parola.html#ace798ba32cb774792e602778654cd159">write</a> (const uint8_t *buffer, size_t size)</td></tr>
|
|
<tr class="separator:ace798ba32cb774792e602778654cd159"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Core object for the Parola library. This class contains one or more zones for display. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a86d37f229d5294dee9bb2ec5ade42c5a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86d37f229d5294dee9bb2ec5ade42c5a">◆ </a></span>MD_Parola() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_Parola::MD_Parola </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MD_MAX72XX::moduleType_t </td>
|
|
<td class="paramname"><em>mod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>dataPin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>clkPin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>csPin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numDevices</em> = <code>1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Class Constructor - arbitrary output pins.</p>
|
|
<p>Instantiate a new instance of the class. The parameters passed are used to connect the software to the hardware using the MD_MAX72XX class.</p>
|
|
<p>See documentation for the MD_MAX72XX library for detailed explanation of parameters.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>the hardware module type used in the application. One of the MD_MAX72XX::moduleType_t values. </td></tr>
|
|
<tr><td class="paramname">dataPin</td><td>output on the Arduino where data gets shifted out. </td></tr>
|
|
<tr><td class="paramname">clkPin</td><td>output for the clock signal. </td></tr>
|
|
<tr><td class="paramname">csPin</td><td>output for selecting the device. </td></tr>
|
|
<tr><td class="paramname">numDevices</td><td>number of devices connected. Default is 1 if not supplied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af13e292a19a8b72332268d923da4f588"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af13e292a19a8b72332268d923da4f588">◆ </a></span>MD_Parola() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_Parola::MD_Parola </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MD_MAX72XX::moduleType_t </td>
|
|
<td class="paramname"><em>mod</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>csPin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numDevices</em> = <code>1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Class Constructor - SPI hardware interface.</p>
|
|
<p>Instantiate a new instance of the class. The parameters passed are used to connect the software to the hardware using the MD_MAX72XX class.</p>
|
|
<p>See documentation for the MD_MAX72XX library for detailed explanation of parameters.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>the hardware module type used in the application. One of the MD_MAX72XX::moduleType_t values. </td></tr>
|
|
<tr><td class="paramname">csPin</td><td>output for selecting the device. </td></tr>
|
|
<tr><td class="paramname">numDevices</td><td>number of devices connected. Default is 1 if not supplied. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad65afea65fbbae8ff399d92072a3d1a5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad65afea65fbbae8ff399d92072a3d1a5">◆ </a></span>~MD_Parola()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_Parola::~MD_Parola </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Class Destructor.</p>
|
|
<p>Release allocated memory and does the necessary to clean up once the object is no longer required. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ab43b189c71ffcde5f7af57b3d0df2da8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab43b189c71ffcde5f7af57b3d0df2da8">◆ </a></span>addChar() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::addChar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Add a user defined character to the replacement list for all zones.</p>
|
|
<p>Add a replacement characters to the user defined list. The character data must be the same as for a single character in the font definition file. If a character is specified with a code the same as an existing character the existing data will be substituted for the new data. A character code of 0 ('\0') is illegal as this denotes the end of string character for C++ and cannot be used in an actual string.</p>
|
|
<p>The library does not copy the data definition but only retains a pointer to the data, so any changes to the data storage in the calling program will be reflected into the library. The data must also remain in scope while it is being used.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">code</td><td>ASCII code for the character data. </td></tr>
|
|
<tr><td class="paramname">data</td><td>pointer to the character data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee2338a32dc27a33e8c711bac5cecede"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee2338a32dc27a33e8c711bac5cecede">◆ </a></span>addChar() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::addChar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>data</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Add a user defined character to the replacement specified zone.</p>
|
|
<p>See the comments for the 'all zones' variant of this method</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone specified </td></tr>
|
|
<tr><td class="paramname">code</td><td>ASCII code for the character data. </td></tr>
|
|
<tr><td class="paramname">data</td><td>pointer to the character data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true of the character was inserted in the substitution list. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aed2a8279a3bfe6f41add877fcf21456f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aed2a8279a3bfe6f41add877fcf21456f">◆ </a></span>begin() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialize the object.</p>
|
|
<p>Initialize the object data. This needs to be called during setup() to initialize new data for the class that cannot be done during the object creation. This form of the method is for backward compatibility and creates one zone for the entire display. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7539abd83f51423c76595b10fdaf911a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7539abd83f51423c76595b10fdaf911a">◆ </a></span>begin() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numZones</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Initialize the object.</p>
|
|
<p>Initialize the object data. This needs to be called during setup() to initialize new data for the class that cannot be done during the object creation. This form of the method allows specifying the number of zones used. The maximum number of zones is set by the MAX_ZONES constant which can be changed to allow more or fewer zones. The module limits for the zones need to be initialized separately using <a class="el" href="class_m_d___parola.html#a218bd5860a6023b58e5d00de2b1d976a">setZone()</a>.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">numZones</td><td>maximum number of zones [1..MAX_ZONES] </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a019ecf4d513920215f92ec435e8903df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a019ecf4d513920215f92ec435e8903df">◆ </a></span>delChar() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::delChar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>code</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Delete a user defined character to the replacement list for all zones.</p>
|
|
<p>Delete a reference to a replacement character in the user defined list.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">code</td><td>ASCII code for the character data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af4dc8e2d19fd6b344e1ca90c25de77a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af4dc8e2d19fd6b344e1ca90c25de77a8">◆ </a></span>delChar() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::delChar </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>code</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Delete a user defined character to the replacement list for the specified zone.</p>
|
|
<p>See the comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone specified </td></tr>
|
|
<tr><td class="paramname">code</td><td>ASCII code for the character data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true of the character was found in the substitution list. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add650d11e765d50f9d030dd98ae96e7f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add650d11e765d50f9d030dd98ae96e7f">◆ </a></span>displayAnimate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::displayAnimate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Animate the display.</p>
|
|
<p>Animate all the zones in the display using the currently specified text and animation parameters. This method needs to be invoked as often as possible to ensure smooth animation. The animation is governed by a time tick that is set by the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method and it will pause between entry and exit using the time set by the <a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause()</a> method.</p>
|
|
<p>The calling program should monitor the return value for 'true' in order to either reset the zone animation or supply another string for display. A 'true' return value means that one or more zones have completed their animation.</p>
|
|
<p>Not all calls to this method result in an animation, as this is governed by the timing parameters set for the animation. To determine when an animation has advanced during the call, the user code can call the <a class="el" href="class_m_d___parola.html#ae94526b7b2fa5a40086dde50097e04d7">isAnimationAdvanced()</a> method.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>bool true if at least one zone animation has completed, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f0368381f03ba2a6ee2704e47687829"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f0368381f03ba2a6ee2704e47687829">◆ </a></span>displayClear() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayClear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Clear the display.</p>
|
|
<p>Clear all the zones in the current display.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a55e620af6a648e96121fdafdfd5c699b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55e620af6a648e96121fdafdfd5c699b">◆ </a></span>displayClear() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayClear </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Clear one zone in the display.</p>
|
|
<p>Clear the specified zone in the current display.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>specified zone </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac2215961f392389a6ab9b17a5f098e4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac2215961f392389a6ab9b17a5f098e4f">◆ </a></span>displayReset() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reset the current animation to restart for all zones.</p>
|
|
<p>This method is used to reset all the zone animations an animation back to the start of their cycle current cycle. It is normally invoked after all the parameters for a display are set and the animation needs to be started (or restarted).</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b59392e8233a36b9d733a9b9a1fc4f5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b59392e8233a36b9d733a9b9a1fc4f5">◆ </a></span>displayReset() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Reset the current animation to restart for the specified zone.</p>
|
|
<p>See the comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>specified zone </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adf278c039b7313486420a8774250d751"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adf278c039b7313486420a8774250d751">◆ </a></span>displayScroll()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayScroll </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pText</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td>
|
|
<td class="paramname"><em>align</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effect</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Easy start for a scrolling text display.</p>
|
|
<p>This method is a convenient way to set up a scrolling display. All the data necessary for setup is passed through as parameters and the display animation is started. Assumes one zone only (zone 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pText</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a1b54fb1c05c976007031433439324739">setTextBuffer()</a> method. </td></tr>
|
|
<tr><td class="paramname">align</td><td>parameter suitable for the the <a class="el" href="class_m_d___parola.html#a6eb132905e5df99067e9716fd922d9ed">setTextAlignment()</a> method. </td></tr>
|
|
<tr><td class="paramname">effect</td><td>parameter suitable for the the <a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect()</a> method. </td></tr>
|
|
<tr><td class="paramname">speed</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ce974c7eca26a5d25eb1e8e5be7b872"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ce974c7eca26a5d25eb1e8e5be7b872">◆ </a></span>displayShutdown()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayShutdown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>b</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shutdown or restart display hardware.</p>
|
|
<p>Shutdown the display hardware to a low power state. The display will be blank during the shutdown. Calling animate() will continue to animate the display in the memory buffers but this will not be visible on the display (ie, the libraries still function but the display does not). To reset the animation back to the beginning, use the <a class="el" href="class_m_d___parola.html#ac2215961f392389a6ab9b17a5f098e4f">displayReset()</a> method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">b</td><td>boolean value to shutdown (true) or resume (false). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4ebabd68838a04997d4b0493df59f998"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4ebabd68838a04997d4b0493df59f998">◆ </a></span>displaySuspend()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displaySuspend </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>b</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Suspend or resume display updates.</p>
|
|
<p>Stop the current display animation. When pausing it leaves the display showing the current text. Resuming will restart the animation where it left off. To reset the animation back to the beginning, use the <a class="el" href="class_m_d___parola.html#ac2215961f392389a6ab9b17a5f098e4f">displayReset()</a> method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">b</td><td>boolean value to suspend (true) or resume (false). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a53b4c922a283ce2304a91e970e56c45d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a53b4c922a283ce2304a91e970e56c45d">◆ </a></span>displayText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayText </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pText</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td>
|
|
<td class="paramname"><em>align</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pause</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectOut</em> = <code><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86">PA_NO_EFFECT</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Easy start for a non-scrolling text display.</p>
|
|
<p>This method is a convenient way to set up a static text display. All the data necessary for setup is passed through as parameters and the display animation is started. Assumes one zone only (zone 0).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pText</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a1b54fb1c05c976007031433439324739">setTextBuffer()</a> method. </td></tr>
|
|
<tr><td class="paramname">align</td><td>parameter suitable for the the <a class="el" href="class_m_d___parola.html#a6eb132905e5df99067e9716fd922d9ed">setTextAlignment()</a> method. </td></tr>
|
|
<tr><td class="paramname">speed</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method. </td></tr>
|
|
<tr><td class="paramname">pause</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause()</a> method. </td></tr>
|
|
<tr><td class="paramname">effectIn</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect()</a> method. </td></tr>
|
|
<tr><td class="paramname">effectOut</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect()</a> method. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5512bde50d6ee000d59a9bc46c1fb54b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5512bde50d6ee000d59a9bc46c1fb54b">◆ </a></span>displayZoneText()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::displayZoneText </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pText</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td>
|
|
<td class="paramname"><em>align</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pause</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectOut</em> = <code><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82edaa65db4b21517eaca3a0011552dda00a86">PA_NO_EFFECT</a></code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Easy start for a non-scrolling zone text display.</p>
|
|
<p>This method is a convenient way to set up a static text display within the specified zone. All the data necessary for setup is passed through as parameters and the display animation is started.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone specified. </td></tr>
|
|
<tr><td class="paramname">pText</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a1b54fb1c05c976007031433439324739">setTextBuffer()</a> method. </td></tr>
|
|
<tr><td class="paramname">align</td><td>parameter suitable for the the <a class="el" href="class_m_d___parola.html#a6eb132905e5df99067e9716fd922d9ed">setTextAlignment()</a> method. </td></tr>
|
|
<tr><td class="paramname">speed</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method. </td></tr>
|
|
<tr><td class="paramname">pause</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause()</a> method. </td></tr>
|
|
<tr><td class="paramname">effectIn</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect()</a> method. </td></tr>
|
|
<tr><td class="paramname">effectOut</td><td>parameter suitable for the <a class="el" href="class_m_d___parola.html#af5c38fd43dbbb4169d5241ea17aa34bb">setTextEffect()</a> method. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8f68dc6cf4109c00f40cd2eb6df3bfde"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8f68dc6cf4109c00f40cd2eb6df3bfde">◆ </a></span>getCharSpacing() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t MD_Parola::getCharSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the inter-character spacing in columns.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the current setting for the space between characters in columns. Assumes one zone only. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acae7ac5d8d24280a3aeb00572c7ae789"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acae7ac5d8d24280a3aeb00572c7ae789">◆ </a></span>getCharSpacing() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t MD_Parola::getCharSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the inter-character spacing in columns for a specific zone.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the current setting for the space between characters in columns. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acb2ce8559e6d6382eb1d98d7ceb3126b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acb2ce8559e6d6382eb1d98d7ceb3126b">◆ </a></span>getDisplayExtent() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::getDisplayExtent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>startColumn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>endColumn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the start and end column numbers for the whole display.</p>
|
|
<p>Returns the start and end column numbers for the matrix display. This retains consistency between user code and library.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">startColumn</td><td>the by-reference parameter that will hold the return value for the start column. </td></tr>
|
|
<tr><td class="paramname">endColumn</td><td>the by-reference parameter that will hold the return value for the end column. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The start and end columns in the by-reference parameters. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3008521a115ee792a7bc299563fba69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3008521a115ee792a7bc299563fba69">◆ </a></span>getDisplayExtent() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::getDisplayExtent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>startColumn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>endColumn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the start and end column numbers for the required zone.</p>
|
|
<p>Returns the start and end column numbers for the zone display. This retains consistency between user code and library. The by-reference parameters remain unchanged if an invalid zone number is requested.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone specified </td></tr>
|
|
<tr><td class="paramname">startColumn</td><td>the by-reference parameter that will hold the return value for the start column. </td></tr>
|
|
<tr><td class="paramname">endColumn</td><td>the by-reference parameter that will hold the return value for the end column. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The start and end columns in the by-reference parameters. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8581c064f75185012b3b0b1a98561aab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8581c064f75185012b3b0b1a98561aab">◆ </a></span>getFont() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_MAX72XX::fontType_t* MD_Parola::getFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the display font for specified zone.</p>
|
|
<p>Get the current font table pointer for the specified zone.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>specified zone. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the font definition used. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af7c3f22e64a1b2b1a3c47ef410f481c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af7c3f22e64a1b2b1a3c47ef410f481c8">◆ </a></span>getFont() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_MAX72XX::fontType_t* MD_Parola::getFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the display font for single zone display.</p>
|
|
<p>Return the current font table pointer for single zone displays.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the font definition used. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af6c70c27c6c631e1d71d60adf2ec1662"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af6c70c27c6c631e1d71d60adf2ec1662">◆ </a></span>getGraphicObject()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">MD_MAX72XX* MD_Parola::getGraphicObject </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get a pointer to the instantiated graphics object.</p>
|
|
<p>Provides a pointer to the MD_MAX72XX object to allow access to the display graphics functions.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Pointer to the MD_MAX72xx object used by the library. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3029915ed2e456a47318e3f06a05d66b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3029915ed2e456a47318e3f06a05d66b">◆ </a></span>getInvert() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::getInvert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current display invert state.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a1d555db081a7766f3e7e79b8cc228794">setInvert()</a> method.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the display is inverted. Assumes one zone only. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a862ad99377530902c2550a082a8629af"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a862ad99377530902c2550a082a8629af">◆ </a></span>getInvert() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::getInvert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current display invert state for a specific zone.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a1d555db081a7766f3e7e79b8cc228794">setInvert()</a> method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the inverted boolean value for the specified zone. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2e88fa0cad63e11f25fa52d1852c73c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2e88fa0cad63e11f25fa52d1852c73c3">◆ </a></span>getPause() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t MD_Parola::getPause </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current pause time.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause()</a> method. Assumes one zone only.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the pause value in milliseconds. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2d925d5a975efe0d4d9a7d45e3004caa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d925d5a975efe0d4d9a7d45e3004caa">◆ </a></span>getPause() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t MD_Parola::getPause </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current pause time for a specific zone.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a535d4ba642406b02c26b6218e020c313">setPause()</a> method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the pause value in milliseconds for the specified zone. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abd0d9f2cd2f84381692d5cd9b8554f6a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abd0d9f2cd2f84381692d5cd9b8554f6a">◆ </a></span>getScrollSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t MD_Parola::getScrollSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the horizontal scrolling spacing.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a9da2ed061c82a2278e19a72cd415f915">setScrollSpacing()</a> method. Assumes one zone only</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the speed value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a62ed6b65af45aef6e6a9bbad4d431e3d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62ed6b65af45aef6e6a9bbad4d431e3d">◆ </a></span>getSpeed() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t MD_Parola::getSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current animation speed.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method. Assumes one zone only</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the speed value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a77f476b4ffc195aec3c357f720903e38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a77f476b4ffc195aec3c357f720903e38">◆ </a></span>getSpeed() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint16_t MD_Parola::getSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current animation speed for the specified zone.</p>
|
|
<p>See the <a class="el" href="class_m_d___parola.html#a148064778dfb85eb1fd73fe415fc1126">setSpeed()</a> method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the speed value for the specified zone. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f51de612af3aad0b15de2386a599ec6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f51de612af3aad0b15de2386a599ec6">◆ </a></span>getTextAlignment() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> MD_Parola::getTextAlignment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current text alignment specification.</p>
|
|
<p>Assumes one zone only.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>the current text alignment setting. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6b485b580ee8e15b7ab11a73c6cd56ff"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6b485b580ee8e15b7ab11a73c6cd56ff">◆ </a></span>getTextAlignment() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> MD_Parola::getTextAlignment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the current text alignment specification for the specified zone.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the current text alignment setting for the specified zone. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0711639574f70ce7bd8d88d7c117df0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0711639574f70ce7bd8d88d7c117df0">◆ </a></span>getTextExtent() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::getTextExtent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>startColumn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>endColumn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the start and end column numbers for the text displayed.</p>
|
|
<p>Returns the start and end column numbers for the text displayed in zone 0. This can be used for simplicity when the display is a single zone.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">startColumn</td><td>the by-reference parameter that will hold the return value for the start column. </td></tr>
|
|
<tr><td class="paramname">endColumn</td><td>the by-reference parameter that will hold the return value for the end column. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The start and end columns in the by-reference parameters. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a254824704bd14dcfb897a407495699e4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a254824704bd14dcfb897a407495699e4">◆ </a></span>getTextExtent() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::getTextExtent </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>startColumn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t & </td>
|
|
<td class="paramname"><em>endColumn</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the start and end column numbers for the text displayed.</p>
|
|
<p>Returns the start and end column numbers for the text displayed in the zone. This retains consistency between user code and library.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone specified </td></tr>
|
|
<tr><td class="paramname">startColumn</td><td>the by-reference parameter that will hold the return value for the start column. </td></tr>
|
|
<tr><td class="paramname">endColumn</td><td>the by-reference parameter that will hold the return value for the end column. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The start and end columns in the by-reference parameters. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4285e8fdba021fde5973ab63348dafd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4285e8fdba021fde5973ab63348dafd9">◆ </a></span>getZoneEffect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">boolean MD_Parola::getZoneEffect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a> </td>
|
|
<td class="paramname"><em>ze</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the value of specified display effect.</p>
|
|
<p>The display effect is one of the zoneEffect_t types. The returned value will be true if the attribute is set, false if the attribute is not set.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">ze</td><td>the required text alignment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if the value is set, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58696a833fb399fc68ed6152931baa94"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58696a833fb399fc68ed6152931baa94">◆ </a></span>getZoneStatus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::getZoneStatus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Get the completion status for a zone.</p>
|
|
<p>This method is to determine which zone has completed when <a class="el" href="class_m_d___parola.html#add650d11e765d50f9d030dd98ae96e7f">displayAnimate()</a> has returned a completion status.</p>
|
|
<p>The calling program should monitor the return value for 'true' in order to either reset the zone animation or supply another string for display. A 'true' return value means that the zone has completed its animation cycle.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>specified zone </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>bool true if the zone animation has completed, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae94526b7b2fa5a40086dde50097e04d7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae94526b7b2fa5a40086dde50097e04d7">◆ </a></span>isAnimationAdvanced()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::isAnimationAdvanced </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Check if animation frame has advanced.</p>
|
|
<p>Check if the last call to animate() resulted in the animation frame advancing by one or more frames in one or more zones. Useful to integrate graphics into the display as they may be affected by the text animation.</p>
|
|
<p>For displays with more than one zone, the user code will need to interrogate each zone to determine whether the animation advanced in that zone.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the animation frame advanced in any of the display zones. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad7ff7418d5b57162353f5fc5334a1112"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad7ff7418d5b57162353f5fc5334a1112">◆ </a></span>setCharSpacing() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setCharSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cs</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the inter-character spacing in columns for all zones.</p>
|
|
<p>Set the number of blank columns between characters when they are displayed.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">cs</td><td>space between characters in columns. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acd33962d2013b7f0acc2297897bbb58b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd33962d2013b7f0acc2297897bbb58b">◆ </a></span>setCharSpacing() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setCharSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>cs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the inter-character spacing in columns for the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">cs</td><td>space between characters in columns. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a619357fd65bc4b6a30a5d2e74b5d2140"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a619357fd65bc4b6a30a5d2e74b5d2140">◆ </a></span>setFont() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">MD_MAX72XX::fontType_t * </td>
|
|
<td class="paramname"><em>fontDef</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the display font for all zones.</p>
|
|
<p>Set the display font to a user defined font table. This can be created using the MD_MAX72xx font builder (refer to documentation for the tool and the MD_MAX72xx library). Passing nullptr resets to the library default font.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">fontDef</td><td>Pointer to the font definition to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a97bf4988df87bb0d4a03dea69a32293c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a97bf4988df87bb0d4a03dea69a32293c">◆ </a></span>setFont() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setFont </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">MD_MAX72XX::fontType_t * </td>
|
|
<td class="paramname"><em>fontDef</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the display font for a specific zone.</p>
|
|
<p>Set the display font to a user defined font table. This can be created using the MD_MAX72xx font builder (refer to documentation for the tool and the MD_MAX72xx library). Passing nullptr resets to the library default font.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>specified zone. </td></tr>
|
|
<tr><td class="paramname">fontDef</td><td>Pointer to the font definition to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa869921483a67899f9d06d84f5e537b4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa869921483a67899f9d06d84f5e537b4">◆ </a></span>setIntensity() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setIntensity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>intensity</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the display brightness for all the zones.</p>
|
|
<p>Set the intensity (brightness) of the display.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">intensity</td><td>the intensity to set the display (0-15). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a45d97a582ca1adabfe5cb40d66c4bbd2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45d97a582ca1adabfe5cb40d66c4bbd2">◆ </a></span>setIntensity() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setIntensity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>intensity</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the display brightness for the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">intensity</td><td>the intensity to set the display (0-15). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1d555db081a7766f3e7e79b8cc228794"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1d555db081a7766f3e7e79b8cc228794">◆ </a></span>setInvert() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setInvert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>invert</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Invert the display in all the zones.</p>
|
|
<p>Set the display to inverted (ON LED turns OFF and vice versa).</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">invert</td><td>true for inverted display, false for normal display </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae5d024556b502a48e10f5fbe8c9c46e3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae5d024556b502a48e10f5fbe8c9c46e3">◆ </a></span>setInvert() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setInvert </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>invert</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Invert the display in the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">invert</td><td>true for inverted display, false for normal display </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a535d4ba642406b02c26b6218e020c313"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a535d4ba642406b02c26b6218e020c313">◆ </a></span>setPause() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setPause </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pause</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the pause between ENTER and EXIT animations for all zones.</p>
|
|
<p>Between each entry and exit, the library will pause by the number of milliseconds specified to allow the viewer to read the message. For continuous scrolling displays this should be set to the same value as the display speed.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pause</td><td>the time, in milliseconds, between animations. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a91a25b1e37741b75af08b90070682ee5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a91a25b1e37741b75af08b90070682ee5">◆ </a></span>setPause() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setPause </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>pause</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the pause between ENTER and EXIT animations for the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">pause</td><td>the time, in milliseconds, between animations. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9da2ed061c82a2278e19a72cd415f915"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9da2ed061c82a2278e19a72cd415f915">◆ </a></span>setScrollSpacing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setScrollSpacing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>space</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the horizontal scrolling distance between messages for all the zones.</p>
|
|
<p>When scrolling horizontally, the distance between the end of one message and the start of the next can be set using this method. Default behavior is for the message to be fully off the display before the new message starts. Set to zero for default behavior.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">space</td><td>the spacing, in columns, between messages; zero for default behaviour.. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a148064778dfb85eb1fd73fe415fc1126"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a148064778dfb85eb1fd73fe415fc1126">◆ </a></span>setSpeed() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the animation frame speed for all zones.</p>
|
|
<p>The speed of the display is the 'tick' time between animation frames. The lower this time the faster the animation; set it to zero to run as fast as possible.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">speed</td><td>the time, in milliseconds, between animation frames. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa92a0538ff725b970949231342ec6910"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa92a0538ff725b970949231342ec6910">◆ </a></span>setSpeed() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>speed</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the animation frame speed for the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">speed</td><td>the time, in milliseconds, between animation frames. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7407455c739aa60760b83d4f82142489"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7407455c739aa60760b83d4f82142489">◆ </a></span>setSpriteData() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setSpriteData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>inData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>inWidth</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>inFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>outData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outWidth</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outFrames</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set data for user sprite effects (single zone).</p>
|
|
<p>This method is used to set up user data needed so that the library can display the sprite ahead of the entry/exit of text when the PA_SPRITE animation type is selected.</p>
|
|
<p>A sprite is made up of a number of frames that run sequentially to make make the animation on the display. Once the animation reaches the last frame it restarts from the first frame.</p>
|
|
<p>A sprite is defined similarly to a character in the font table. Each byte is a bit pattern defining a column in the sprite. A frame is xWidth bytes in size and there are xFrames in the animation.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">inData</td><td>pointer to the data table defining the entry sprite. </td></tr>
|
|
<tr><td class="paramname">inWidth</td><td>the width (in bytes) of each frame of the sprite. </td></tr>
|
|
<tr><td class="paramname">inFrames</td><td>the number of frames for the sprite. </td></tr>
|
|
<tr><td class="paramname">outData</td><td>pointer to the data table that is inWidth*InFrames in size. </td></tr>
|
|
<tr><td class="paramname">outWidth</td><td>the width (in bytes) of each frame of the sprite. </td></tr>
|
|
<tr><td class="paramname">outFrames</td><td>the number of frames for the sprite. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5a6fb6a69caf96bc9cc242082533e3ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5a6fb6a69caf96bc9cc242082533e3ab">◆ </a></span>setSpriteData() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setSpriteData </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>inData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>inWidth</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>inFrames</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>outData</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outWidth</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>outFrames</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set data for user sprite effect (whole display).</p>
|
|
<p>See the comments for single zone variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">inData</td><td>pointer to the data table defining the entry sprite. </td></tr>
|
|
<tr><td class="paramname">inWidth</td><td>the width (in bytes) of each frame of the sprite. </td></tr>
|
|
<tr><td class="paramname">inFrames</td><td>the number of frames for the sprite. </td></tr>
|
|
<tr><td class="paramname">outData</td><td>pointer to the data table that is inWidth*InFrames in size. </td></tr>
|
|
<tr><td class="paramname">outWidth</td><td>the width (in bytes) of each frame of the sprite. </td></tr>
|
|
<tr><td class="paramname">outFrames</td><td>the number of frames for the sprite. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6eb132905e5df99067e9716fd922d9ed"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6eb132905e5df99067e9716fd922d9ed">◆ </a></span>setTextAlignment() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextAlignment </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td>
|
|
<td class="paramname"><em>ta</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the text alignment for all zones.</p>
|
|
<p>Text alignment is specified as one of the values in textPosition_t.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">ta</td><td>the required text alignment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a712ba7658c982c67e4a23ca0c4ef3ea8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a712ba7658c982c67e4a23ca0c4ef3ea8">◆ </a></span>setTextAlignment() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextAlignment </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#abab52de9e46b83d0aa94f0e3439e224d">textPosition_t</a> </td>
|
|
<td class="paramname"><em>ta</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the text alignment for the specified zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">ta</td><td>the required text alignment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1b54fb1c05c976007031433439324739"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b54fb1c05c976007031433439324739">◆ </a></span>setTextBuffer() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pb</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the pointer to the text buffer.</p>
|
|
<p>Sets the text buffer to be a pointer to user data. The library does not allocate any memory for the text message, rather it is the calling program that supplies a pointer to a buffer. This reduces memory requirements and offers the flexibility to keep a single buffer or rotate buffers with different messages, all under calling program control, with no library limit to the size or numbers of buffers. The text placed in the buffer must be properly terminated by the NUL ('\0') character or processing will overrun the end of the message.</p>
|
|
<p>This form of the method assumes one zone only.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pb</td><td>pointer to the text buffer to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac13c9daea7b0f2ee1a837a4d23f7a776"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac13c9daea7b0f2ee1a837a4d23f7a776">◆ </a></span>setTextBuffer() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextBuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">char * </td>
|
|
<td class="paramname"><em>pb</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the pointer to the text buffer for the specified zone.</p>
|
|
<p>See comments for the single zone version of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">pb</td><td>pointer to the text buffer to be used. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af5c38fd43dbbb4169d5241ea17aa34bb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af5c38fd43dbbb4169d5241ea17aa34bb">◆ </a></span>setTextEffect() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextEffect </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectOut</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the entry and exit text effects for all zones.</p>
|
|
<p>The 'in' and 'out' text effects are specified using the textEffect_t enumerated type. If no effect is required, NO_EFFECT should be specified. NO_EFFECT is most useful when no exit effect is required (e.g., when DISSOLVE is used) and the entry effect is sufficient.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">effectIn</td><td>the entry effect, one of the textEffect_t enumerated values. </td></tr>
|
|
<tr><td class="paramname">effectOut</td><td>the exit effect, one of the textEffect_t enumerated values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a00c348909a79340e3c0bec1568f87ac7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a00c348909a79340e3c0bec1568f87ac7">◆ </a></span>setTextEffect() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setTextEffect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectIn</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#acf3b849a996dbbe48ca173d2b0b82eda">textEffect_t</a> </td>
|
|
<td class="paramname"><em>effectOut</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the entry and exit text effects for a specific zone.</p>
|
|
<p>See comments for the 'all zones' variant of this method.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">effectIn</td><td>the entry effect, one of the textEffect_t enumerated values. </td></tr>
|
|
<tr><td class="paramname">effectOut</td><td>the exit effect, one of the textEffect_t enumerated values. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a218bd5860a6023b58e5d00de2b1d976a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a218bd5860a6023b58e5d00de2b1d976a">◆ </a></span>setZone()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool MD_Parola::setZone </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>moduleStart</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>moduleEnd</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Define the module limits for a zone.</p>
|
|
<p>When multiple zones are defined, the library needs to know the contiguous module ranges that make up the different zones. If the library has been started with only one zone then it will automatically initialize the zone to be the entire range for the display modules, so calling this function is not required.</p>
|
|
<p>A module is a unit of 8x8 LEDs, as defined in the MD_MAX72xx library. Zones should not overlap or unexpected results will occur.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">moduleStart</td><td>the first module number for the zone [0..numZones-1]. </td></tr>
|
|
<tr><td class="paramname">moduleEnd</td><td>the last module number for the zone [0..numZones-1]. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true if set, false otherwise. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa978891dd1382e933cb40c61c78c5956"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa978891dd1382e933cb40c61c78c5956">◆ </a></span>setZoneEffect()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::setZoneEffect </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">boolean </td>
|
|
<td class="paramname"><em>b</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="_m_d___parola_8h.html#a8b150a33856e93a2596b6622117f08f5">zoneEffect_t</a> </td>
|
|
<td class="paramname"><em>ze</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Set the display effect for the specified zone.</p>
|
|
<p>The display effect is one of the zoneEffect_t types, and this will be set (true) or reset (false) depending on the boolean value. The resulting zone display will be modified as per the required effect.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">z</td><td>zone number. </td></tr>
|
|
<tr><td class="paramname">b</td><td>set the value if true, reset the value if false </td></tr>
|
|
<tr><td class="paramname">ze</td><td>the required text alignment. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab3f9f4f3174555085d75faf987a3d398"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab3f9f4f3174555085d75faf987a3d398">◆ </a></span>synchZoneStart()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void MD_Parola::synchZoneStart </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Synchronize the start of zone animations.</p>
|
|
<p>When zones are set up, the animation start time will default to the set-up time. If several zones need to be animated in synchronized fashion (eg, they are visually stacked vertically), this method will ensure that all the zones start at the same instant. The method should be invoked before the call to <a class="el" href="class_m_d___parola.html#add650d11e765d50f9d030dd98ae96e7f">displayAnimate()</a>.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6c5fe7373f27edf29abb639cf3cb1dfb"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c5fe7373f27edf29abb639cf3cb1dfb">◆ </a></span>write() <span class="overload">[1/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual size_t MD_Parola::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>c</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write a single character to the output display</p>
|
|
<p>Display a character when given the ASCII code for it. The character is converted to a string and the string printing function invoked. The LED display is designed for string based output, so it does not make much sense to do this. Creating the short string is a consistent way to way to handle single the character.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">c</td><td>ASCII code for the character to write. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the number of characters written. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a933934ad1ec191419dad4ddceedb9fd6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a933934ad1ec191419dad4ddceedb9fd6">◆ </a></span>write() <span class="overload">[2/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t MD_Parola::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>str</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write a nul terminated string to the output display.</p>
|
|
<p>Display a nul terminated string when given a pointer to the char array. Invokes an animation using PA_PRINT with all other settings (alignment, speed, etc) taken from current defaults. This method also invokes the animation for the print and returns when that has finished, so it blocks while the printing is happening, which should be at least one iteration of the wait loop.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">str</td><td>Pointer to the nul terminated char array. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the number of characters written. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ace798ba32cb774792e602778654cd159"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ace798ba32cb774792e602778654cd159">◆ </a></span>write() <span class="overload">[3/3]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t MD_Parola::write </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Write a character buffer to the output display.</p>
|
|
<p>Display a non-nul terminated string given a pointer to the buffer and the size of the buffer. The buffer is turned into a nul terminated string and the simple <a class="el" href="class_m_d___parola.html#a6c5fe7373f27edf29abb639cf3cb1dfb">write()</a> method is invoked. Memory is allocated and freed in this method to copy the string.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buffer</td><td>Pointer to the data buffer. </td></tr>
|
|
<tr><td class="paramname">size</td><td>The number of bytes to write. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="_m_d___parola_8h.html">MD_Parola.h</a></li>
|
|
<li>src/<a class="el" href="_m_d___parola_8cpp.html">MD_Parola.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_m_d___parola.html">MD_Parola</a></li>
|
|
<li class="footer">Generated on Tue Jul 10 2018 20:02:31 for Parola for Arduino by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|