Skip to content

Latest commit

 

History

History
90 lines (79 loc) · 5.16 KB

README.md

File metadata and controls

90 lines (79 loc) · 5.16 KB

IRLib – an Arduino library for infrared encoding and decoding

Version 1.51 March 2015 Copyright 2013-2015 by Chris Young http://tech.cyborg5.com/irlib/

NOTICE: This library is no longer being maintained. It has been superseded by IRLib2 which is a major restructuring of the code with many new features. Unfortunately we were not able to maintain backwards compatibility with this library. It should however be relatively easy to update sketches to the new code. We will leave this repository available for those who do not wish to update their code. Please do not submit pull requests or raise issues with this repository. All such issues should be handled with IRLib2 which is available at

IRLib2 on GitHub

This library is a major rewrite of IRemote by Ken Shirriff which was covered by GNU LESSER GENERAL PUBLIC LICENSE which as I read it allows me to make modified versions. That same license applies to this modified version. See his original copyright below.

The latest Ken Shirriff code can be found at https://github.com/shirriff/Arduino-IRremote

My purpose was to reorganize the code to make it easier to add or remove protocols. As a result I have separated the act of receiving a set of raw timing codes from the act of decoding them by making them separate classes. That way the receiving aspect can be more black box and implementers of decoders and senders can just deal with the decoding of protocols.

Also added provisions to make the classes base classes that could be extended with new protocols which would not require recompiling of the original library nor understanding of its detailed contents. Some of the changes were made to reduce code size such as unnecessary use of long versus bool. Some changes were just my weird programming style. Also extended debugging information added.

IRremote Version 0.1 July, 2009 Copyright 2009 Ken Shirriff For details, see http://arcfn.com/2009/08/multi-protocol-infrared-remote-library.htm http://arcfn.com

Interrupt code based on NECIRrcv by Joe Knapp http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1210243556 Also influenced by http://zovirl.com/2008/11/12/building-a-universal-remote-with-an-arduino/


The package contains: IRLib.cpp Code for the library written in object C++ IRLib.h Header file which you will include in your sketch IRLibMatch.h Match macros used internally. Need not include this unless you implement your own protocols iRLibTimer.h Attempts to detect type of Arduino board and allows you to modify which interrupt timer you will use. Defaults to timer 2 as did the original KS library. Alternate board and timer information based on a fork of the original KS library. That for can be found here. https://github.com/TKJElectronics/Arduino-IRremote IRLibRData.h Moved irparams structure and related data to this header to facilitate user created extensions to IRrecvBase.

Note: there is no "IRremoteInt.h" header as in the original library. Those values were moved elsewhere.

The examples directory contains: IRanalyze Dumps detailed information about a recent signal. Useful for analyzing unknown protocols IRfreq Reports modulation frequency of IR signal. Requires TSMP58000 IR learner IRhashdecode Demonstrates hash decoder. IRrecord Recording incoming signal and play it back when a character is sent through the serial console. By using the console you no longer need to wire up a pushbutton to run this code. IRrecvDump Receives a code, attempts to decode it, produces well formatted output of the results using the new "dump" method. IRsendDemo Simplistic demo to send a Sony DVD power signal every time a character is received from the serial monitor. IRsendJVC Demonstrates sending a code using JVC protocol which is tricky. IRservo Demonstrates controlling a servo motor using an IR remote IRserial_remote Demonstrates a Python application that runs on your PC and sends serial data to Arduino which in turn sends IR remote signals. Samsung36 Demonstrates how to expand the library without recompiling it. Also demonstrates how to handle codes that are longer than 32 bits. DirecTV Demonstrates additional protocol for DirecTV GIcable Demonstrates additional protocol for GIcable used by Motorola cable boxes rcmm Additional protocol Phillips RCMM used by AT&T U-Verse boxes pinoccio Demo sketches for Pinoccio Scout platform using ATmega256RFR2 Arduino compatible platform. See readme.txt in pinoccio folder for details. Note: I did not port any of the other demo sketches although I may add IRTest later. The manuals directory contains: IRLibReference.docx Reference manual in Microsoft Word format IRLibReference.pdf Reference manual in Adobe PDF format Online version of this manual is also available at: http://tech.cyborg5.com/irlib/docs/


The library handles the following protocols: NEC, Sony, RC5, RC6, Raw all of which were supported in the KS version. Additionally added Panasonic_Old, JVC, NECx. Also added KS hash code routines which he released separately. Example code included but not in the library: Samsung36, DirecTV, GIcable. rcmm (U-Verse)