Files
Arduino-IRremote/index.html
2016-07-11 05:04:09 -05:00

234 lines
8.5 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="Arduino IRremote : Infrared remote library for Arduino: send and receive infrared signals with multiple protocols">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<title>Arduino IRremote</title>
</head>
<body>
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner">
<a id="forkme_banner" href="https://github.com/z3t0/Arduino-IRremote">View on GitHub</a>
<h1 id="project_title">Arduino IRremote</h1>
<h2 id="project_tagline">Infrared remote library for Arduino: send and receive infrared signals with multiple protocols</h2>
<section id="downloads">
<a class="zip_download_link" href="https://github.com/z3t0/Arduino-IRremote/zipball/master">Download this project as a .zip file</a>
<a class="tar_download_link" href="https://github.com/z3t0/Arduino-IRremote/tarball/master">Download this project as a tar.gz file</a>
</section>
</header>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section id="main_content" class="inner">
<h1>
<a id="irremote-arduino-library" class="anchor" href="#irremote-arduino-library" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>IRremote Arduino Library</h1>
<p><a href="https://travis-ci.org/z3t0/Arduino-IRremote"><img src="https://travis-ci.org/z3t0/Arduino-IRremote.svg?branch=master" alt="Build Status"></a></p>
<p><a href="https://gitter.im/z3t0/Arduino-IRremote?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/z3t0/Arduino-IRremote"></a></p>
<p>This library enables you to send and receive using infra-red signals on an Arduino.</p>
<p>Check <a href="http://z3t0.github.io/Arduino-IRremote/">here</a> for tutorials and more information.</p>
<h2>
<a id="version---220" class="anchor" href="#version---220" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Version - 2.2.0</h2>
<h2>
<a id="installation" class="anchor" href="#installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Installation</h2>
<ol>
<li>Navigate to the <a href="https://github.com/z3t0/Arduino-IRremote/releases">Releases</a> page.</li>
<li>Download the latest release.</li>
<li>Extract the zip file</li>
<li>Move the "IRremote" folder that has been extracted to your libraries directory.</li>
<li>Make sure to delete Arduino_Root/libraries/RobotIRremote. Where Arduino_Root refers to the install directory of Arduino. The library RobotIRremote has similar definitions to IRremote and causes errors.</li>
</ol>
<h2>
<a id="supported-boards" class="anchor" href="#supported-boards" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Supported Boards</h2>
<ul>
<li>Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc.</li>
<li>Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: <a href="https://github.com/PaulStoffregen" class="user-mention">@PaulStoffregen</a> (Teensy Team)</li>
<li>Sanguino</li>
<li>Atmega8535, 8, 16, 32, 164, 324, 644, 1284, 64, 128</li>
<li>ATtiny 84 / 85</li>
</ul>
<p>We are open to suggestions for adding support to new boards, however we highly recommend you contact your supplier first and ask them to provide support from their side.</p>
<h3>
<a id="hardware-specifications" class="anchor" href="#hardware-specifications" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Hardware specifications</h3>
<table>
<thead>
<tr>
<th>Board/CPU</th>
<th>Send Pin</th>
<th>Timers</th>
</tr>
</thead>
<tbody>
<tr>
<td><a href="https://github.com/SpenceKonde/ATTinyCore">ATtiny84</a></td>
<td><strong>6</strong></td>
<td><strong>1</strong></td>
</tr>
<tr>
<td><a href="https://github.com/SpenceKonde/ATTinyCore">ATtiny85</a></td>
<td><strong>1</strong></td>
<td><strong>TINY0</strong></td>
</tr>
<tr>
<td>ATmega8</td>
<td><strong>9</strong></td>
<td><strong>1</strong></td>
</tr>
<tr>
<td>Atmega32u4</td>
<td>5, 9, <strong>13</strong>
</td>
<td>1, 3, <strong>4</strong>
</td>
</tr>
<tr>
<td>ATmega168, ATmega328</td>
<td>
<strong>3</strong>, 9</td>
<td>1, <strong>2</strong>
</td>
</tr>
<tr>
<td><a href="https://github.com/MCUdude/MightyCore">ATmega1284</a></td>
<td>13, 14, 6</td>
<td>1, <strong>2</strong>, 3</td>
</tr>
<tr>
<td><a href="https://github.com/MCUdude/MightyCore">ATmega164, ATmega324, ATmega644</a></td>
<td>13, <strong>14</strong>
</td>
<td>1, <strong>2</strong>
</td>
</tr>
<tr>
<td><a href="https://github.com/MCUdude/MightyCore">ATmega8535 ATmega16, ATmega32</a></td>
<td><strong>13</strong></td>
<td><strong>1</strong></td>
</tr>
<tr>
<td><a href="https://github.com/MCUdude/MegaCore">ATmega64, ATmega128</a></td>
<td><strong>13</strong></td>
<td><strong>1</strong></td>
</tr>
<tr>
<td>ATmega1280, ATmega2560</td>
<td>5, 6, <strong>9</strong>, 11, 46</td>
<td>1, <strong>2</strong>, 3, 4, 5</td>
</tr>
<tr>
<td><a href="https://www.pjrc.com/teensy/">Teensy 1.0</a></td>
<td><strong>17</strong></td>
<td><strong>1</strong></td>
</tr>
<tr>
<td><a href="https://www.pjrc.com/teensy/">Teensy 2.0</a></td>
<td>9, <strong>10</strong>, 14</td>
<td>1, 3, <strong>4_HS</strong>
</td>
</tr>
<tr>
<td><a href="https://www.pjrc.com/teensy/">Teensy++ 1.0 / 2.0</a></td>
<td>
<strong>1</strong>, 16, 25</td>
<td>1, <strong>2</strong>, 3</td>
</tr>
<tr>
<td><a href="https://www.pjrc.com/teensy/">Teensy 3.0 / 3.1</a></td>
<td><strong>5</strong></td>
<td><strong>CMT</strong></td>
</tr>
<tr>
<td><a href="https://www.pjrc.com/teensy/">Teensy-LC</a></td>
<td><strong>16</strong></td>
<td><strong>TPM1</strong></td>
</tr>
</tbody>
</table>
<p>The table above lists the currently supported timers and corresponding send pins, many of these can have additional pins opened up and we are open to requests if a need arises for other pins.</p>
<h2>
<a id="usage" class="anchor" href="#usage" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Usage</h2>
<ul>
<li>TODO (Check examples for now)</li>
</ul>
<h2>
<a id="contributing" class="anchor" href="#contributing" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributing</h2>
<p>If you want to contribute to this project:</p>
<ul>
<li>Report bugs and errors</li>
<li>Ask for enhancements</li>
<li>Create issues and pull requests</li>
<li>Tell other people about this library</li>
<li>Contribute new protocols</li>
</ul>
<p>Check <a href="Contributing.md">here</a> for some guidelines.</p>
<h2>
<a id="contact" class="anchor" href="#contact" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contact</h2>
<p>The only way to contact me at the moment is by email: <a href="mailto:zetoslab@gmail.com">zetoslab@gmail.com</a>
I am not currently monitoring any PRs or Issues due to other issues but will respond to all emails. If anyone wants contributor access, feel free to email me. Or if you find any Issues/PRs to be of importance that my attention is needed please email me.</p>
<h2>
<a id="contributors" class="anchor" href="#contributors" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Contributors</h2>
<p>Check <a href="Contributors.md">here</a></p>
<h2>
<a id="copyright" class="anchor" href="#copyright" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Copyright</h2>
<p>Copyright 2009-2012 Ken Shirriff</p>
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p class="copyright">Arduino IRremote maintained by <a href="https://github.com/z3t0">z3t0</a></p>
<p>Published with <a href="https://pages.github.com">GitHub Pages</a></p>
</footer>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
try {
var pageTracker = _gat._getTracker("UA-60577106-2");
pageTracker._trackPageview();
} catch(err) {}
</script>
</body>
</html>