Skip to content

Commit

Permalink
Module type now specified at run time.
Browse files Browse the repository at this point in the history
  • Loading branch information
MajicDesigns committed Jun 9, 2018
1 parent b45b75a commit 7c32de4
Show file tree
Hide file tree
Showing 103 changed files with 1,587 additions and 1,087 deletions.
2 changes: 1 addition & 1 deletion Doxyfile.dox
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = "MD_MAX72xx LED Matrix Arduino Library"
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 2.11
PROJECT_NUMBER = 3.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
502 changes: 502 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# MAX72xx LED Matrix Display Library

<i>IMPORTANT NOTE: Please make sure that you find and read the html documentation that comes with the library (open "docs/index.html") or use the link below. <b>You will need to edit the MAX72xx.h file to configure the type of matrix you are using</b>. This is the most asked support question so avoid frustration and READ THE MANUAL in the docs subfolder.</i>

The library implements functions that allow the MAX72xx to be used for LED matrices (64 individual LEDs), allowing the programmer to use the LED matrix as a pixel device, displaying graphics elements much like any other pixel addressable display.

In this scenario, it is convenient to abstract out the concept of the hardware device and create a uniform and consistent pixel address space, with the libraries determining device and device-element address. Similarly, control of the devices is uniform and abstracted to a system level.
Expand Down
4 changes: 2 additions & 2 deletions docs/_m_d___m_a_x72xx_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<td id="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MD_MAX72xx LED Matrix Arduino Library
&#160;<span id="projectnumber">2.11</span>
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Library to control connected MAX72XX devices as a pixel array</div>
</td>
Expand Down Expand Up @@ -118,7 +118,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_m_d___m_a_x72xx_8cpp.html">MD_MAX72xx.cpp</a></li>
<li class="footer">Generated on Tue Apr 3 2018 12:11:28 for MD_MAX72xx LED Matrix Arduino Library by
<li class="footer">Generated on Fri Jun 8 2018 19:31:24 for MD_MAX72xx LED Matrix Arduino Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
107 changes: 2 additions & 105 deletions docs/_m_d___m_a_x72xx_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<td id="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MD_MAX72xx LED Matrix Arduino Library
&#160;<span id="projectnumber">2.11</span>
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Library to control connected MAX72XX devices as a pixel array</div>
</td>
Expand Down Expand Up @@ -127,20 +127,8 @@
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a12b9c2a543bf9c31fa510d03bb457b32"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a12b9c2a543bf9c31fa510d03bb457b32">USE_PAROLA_HW</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a12b9c2a543bf9c31fa510d03bb457b32"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1448bfbd222d7c0987074dac2789e5df"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a1448bfbd222d7c0987074dac2789e5df">USE_GENERIC_HW</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a1448bfbd222d7c0987074dac2789e5df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07e90f8a93a74c627a90d2626be4e4e5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a07e90f8a93a74c627a90d2626be4e4e5">USE_ICSTATION_HW</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a07e90f8a93a74c627a90d2626be4e4e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a224263d4c71c1e381559a4f32876b35f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a224263d4c71c1e381559a4f32876b35f">USE_FC16_HW</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a224263d4c71c1e381559a4f32876b35f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d837f3d899ea2a710047ef3bef73814"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a8d837f3d899ea2a710047ef3bef73814">USE_OTHER_HW</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a8d837f3d899ea2a710047ef3bef73814"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a156ea396ee2a9dd550bc3a78ce65162b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a156ea396ee2a9dd550bc3a78ce65162b">USE_LOCAL_FONT</a>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a156ea396ee2a9dd550bc3a78ce65162b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d3f6d32a32d5038ca1f5b70b06ce494"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#a1d3f6d32a32d5038ca1f5b70b06ce494">USE_INDEX_FONT</a>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a1d3f6d32a32d5038ca1f5b70b06ce494"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4d030604a90c8d019d90fc721900d63"><td class="memItemLeft" align="right" valign="top"><a id="aa4d030604a90c8d019d90fc721900d63"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_m_d___m_a_x72xx_8h.html#aa4d030604a90c8d019d90fc721900d63">ROW_SIZE</a>&#160;&#160;&#160;8</td></tr>
<tr class="memdesc:aa4d030604a90c8d019d90fc721900d63"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size in pixels of a row in the device LED matrix array. <br /></td></tr>
Expand All @@ -161,67 +149,6 @@
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Main header file for the MD_MAX72xx library. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a224263d4c71c1e381559a4f32876b35f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a224263d4c71c1e381559a4f32876b35f">&#9670;&nbsp;</a></span>USE_FC16_HW</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_FC16_HW&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 to use FC16 hardware module kits. FC16 modules are similar in format to the ICStation modules but are wired differently. Modules are identified by a FC-16 designation on the PCB </p>

</div>
</div>
<a id="a1448bfbd222d7c0987074dac2789e5df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1448bfbd222d7c0987074dac2789e5df">&#9670;&nbsp;</a></span>USE_GENERIC_HW</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_GENERIC_HW&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 to use 'generic' hardware modules commonly available, with connectors at the top and bottom of the PCB, available from many sources. </p>

</div>
</div>
<a id="a07e90f8a93a74c627a90d2626be4e4e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07e90f8a93a74c627a90d2626be4e4e5">&#9670;&nbsp;</a></span>USE_ICSTATION_HW</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_ICSTATION_HW&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 to use ICStation DIY hardware module kits available from <a href="http://www.icstation.com/product_info.php?products_id=2609#.UxqVJyxWGHs">http://www.icstation.com/product_info.php?products_id=2609#.UxqVJyxWGHs</a> This hardware must be set up with the input on the RHS. </p>

</div>
</div>
<a id="a1d3f6d32a32d5038ca1f5b70b06ce494"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d3f6d32a32d5038ca1f5b70b06ce494">&#9670;&nbsp;</a></span>USE_INDEX_FONT</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_INDEX_FONT&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 to enable font indexing to speed up font lookups - usually disabled. This will trade off increased stack RAM usage for lookup speed if enabled. When disabled lookups will then become linear searches through PROGMEM. Uses ASCII_INDEX_SIZE elements of uint16_t (512 bytes) if enabled. For most purposes the increase in speed is not needed.</p>
<p>USE_LOCAL FONT must be enabled for this option to take effect. </p>

</div>
</div>
<a id="a156ea396ee2a9dd550bc3a78ce65162b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a156ea396ee2a9dd550bc3a78ce65162b">&#9670;&nbsp;</a></span>USE_LOCAL_FONT</h2>

Expand All @@ -235,36 +162,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a156ea396ee2a9dd550bc3a78
</div><div class="memdoc">
<p>Set to 1 (default) to enable local font in this library and enable loadChar() and related methods. If the library is just used for graphics some FLASH RAM can be saved by not including the code to process font data. The font file is stored in PROGMEM. </p>

</div>
</div>
<a id="a8d837f3d899ea2a710047ef3bef73814"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d837f3d899ea2a710047ef3bef73814">&#9670;&nbsp;</a></span>USE_OTHER_HW</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_OTHER_HW&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 to use other hardware not defined above. Module 0 (Data In) must be set up on the RHS and the CUSTOM hardware defines must be set up in the MD_MAD72xx_lib.h file under for this section, using the HW_Mapper utility to work out what the correct values to use are. </p>

</div>
</div>
<a id="a12b9c2a543bf9c31fa510d03bb457b32"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a12b9c2a543bf9c31fa510d03bb457b32">&#9670;&nbsp;</a></span>USE_PAROLA_HW</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define USE_PAROLA_HW&#160;&#160;&#160;1</td>
</tr>
</table>
</div><div class="memdoc">
<p>Set to 1 (default) to use the Parola hardware modules. The software was originally designed to operate with this hardware type. </p>

</div>
</div>
</div><!-- contents -->
Expand All @@ -273,7 +170,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a12b9c2a543bf9c31fa510d03
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_m_d___m_a_x72xx_8h.html">MD_MAX72xx.h</a></li>
<li class="footer">Generated on Tue Apr 3 2018 12:11:28 for MD_MAX72xx LED Matrix Arduino Library by
<li class="footer">Generated on Fri Jun 8 2018 19:31:24 for MD_MAX72xx LED Matrix Arduino Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
8 changes: 1 addition & 7 deletions docs/_m_d___m_a_x72xx_8h.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,5 @@ var _m_d___m_a_x72xx_8h =
[ "MAX_INTENSITY", "_m_d___m_a_x72xx_8h.html#a1d1d5e7ff16f25b68fdf779befd298f7", null ],
[ "MAX_SCANLIMIT", "_m_d___m_a_x72xx_8h.html#a79dd2935dc509b4e1f07cd1e8607be30", null ],
[ "ROW_SIZE", "_m_d___m_a_x72xx_8h.html#aa4d030604a90c8d019d90fc721900d63", null ],
[ "USE_FC16_HW", "_m_d___m_a_x72xx_8h.html#a224263d4c71c1e381559a4f32876b35f", null ],
[ "USE_GENERIC_HW", "_m_d___m_a_x72xx_8h.html#a1448bfbd222d7c0987074dac2789e5df", null ],
[ "USE_ICSTATION_HW", "_m_d___m_a_x72xx_8h.html#a07e90f8a93a74c627a90d2626be4e4e5", null ],
[ "USE_INDEX_FONT", "_m_d___m_a_x72xx_8h.html#a1d3f6d32a32d5038ca1f5b70b06ce494", null ],
[ "USE_LOCAL_FONT", "_m_d___m_a_x72xx_8h.html#a156ea396ee2a9dd550bc3a78ce65162b", null ],
[ "USE_OTHER_HW", "_m_d___m_a_x72xx_8h.html#a8d837f3d899ea2a710047ef3bef73814", null ],
[ "USE_PAROLA_HW", "_m_d___m_a_x72xx_8h.html#a12b9c2a543bf9c31fa510d03bb457b32", null ]
[ "USE_LOCAL_FONT", "_m_d___m_a_x72xx_8h.html#a156ea396ee2a9dd550bc3a78ce65162b", null ]
];
4 changes: 2 additions & 2 deletions docs/_m_d___m_a_x72xx__buf_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<td id="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MD_MAX72xx LED Matrix Arduino Library
&#160;<span id="projectnumber">2.11</span>
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Library to control connected MAX72XX devices as a pixel array</div>
</td>
Expand Down Expand Up @@ -117,7 +117,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_m_d___m_a_x72xx__buf_8cpp.html">MD_MAX72xx_buf.cpp</a></li>
<li class="footer">Generated on Tue Apr 3 2018 12:11:28 for MD_MAX72xx LED Matrix Arduino Library by
<li class="footer">Generated on Fri Jun 8 2018 19:31:24 for MD_MAX72xx LED Matrix Arduino Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/_m_d___m_a_x72xx__font_8cpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<td id="projectlogo"><img alt="Logo" src="MajicDesigns_Logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MD_MAX72xx LED Matrix Arduino Library
&#160;<span id="projectnumber">2.11</span>
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Library to control connected MAX72XX devices as a pixel array</div>
</td>
Expand Down Expand Up @@ -127,7 +127,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_m_d___m_a_x72xx__font_8cpp.html">MD_MAX72xx_font.cpp</a></li>
<li class="footer">Generated on Tue Apr 3 2018 12:11:28 for MD_MAX72xx LED Matrix Arduino Library by
<li class="footer">Generated on Fri Jun 8 2018 19:31:24 for MD_MAX72xx LED Matrix Arduino Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
Loading

0 comments on commit 7c32de4

Please sign in to comment.