Merge branch 'beta' of https://github.com/z3t0/Arduino-IRremote into beta

Merge branch 'LarsWH-master' into beta
Added support for RC5 extended
2025-12-24 07:16:15 +00:00 · 2017-09-23 23:16:52 -04:00 · 2017-09-23 23:15:34 -04:00 · 2017-09-23 21:03:07 -04:00 · 2017-09-14 22:13:50 -04:00 · 2017-09-14 21:57:46 -04:00
34 changed files with 2640 additions and 346 deletions
--- a/2417
+++ b/2417
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ This library enables you to send and receive using infra-red signals on an Ardui

 Tutorials and more information will be made available on [the official homepage](http://z3t0.github.io/Arduino-IRremote/).

-## Version - 2.4.0b
+## Version - 2.5.0b

 ## Installation
 1. Navigate to the [Releases](https://github.com/z3t0/Arduino-IRremote/releases) page.
@@ -19,7 +19,7 @@ Tutorials and more information will be made available on [the official homepage]


 ## FAQ
- IR does not work right when I use Neopixels (aka WS2811/WS2812/WS2812B)  
+- IR does not work right when I use Neopixels (aka WS2811/WS2812/WS2812B)
 Whether you use the Adafruit Neopixel lib, or FastLED, interrupts get disabled on many lower end CPUs like the basic arduinos. In turn, this stops the IR interrupt handler from running when it needs to. There are some solutions to this on some processors, [see this page from Marc MERLIN](http://marc.merlins.org/perso/arduino/post_2017-04-03_Arduino-328P-Uno-Teensy3_1-ESP8266-ESP32-IR-and-Neopixels.html)


@@ -43,7 +43,7 @@ We are open to suggestions for adding support to new boards, however we highly r
 | [ATtiny84](https://github.com/SpenceKonde/ATTinyCore)                    | **6**               | **1**             |
 | [ATtiny85](https://github.com/SpenceKonde/ATTinyCore)                    | **1**               | **TINY0**         |
 | [ATmega8](https://github.com/MCUdude/MiniCore)                           | **9**               | **1**             |
-| Atmega32u4                                                               | 5, 9, **13**        | 1, 3, **4**       |
+| Atmega32u4                                                               | 5, **9**, 13        | 1, 3, **4**       |
 | [ATmega48, ATmega88, ATmega168, ATmega328](https://github.com/MCUdude/MiniCore) | **3**, 9     | 1, **2**          |
 | [ATmega1284](https://github.com/MCUdude/MightyCore)                      | 13, 14, 6           | 1, **2**, 3       |
 | [ATmega164, ATmega324, ATmega644](https://github.com/MCUdude/MightyCore) | 13, **14**          | 1, **2**          |
@@ -68,6 +68,20 @@ The table above lists the currently supported timers and corresponding send pins
 ## Usage
 - TODO (Check examples for now)

+## API documentation
+This project documents the library API using [Doxygen](http://www.doxygen.org).
+It is planned to make generated and up-to-date API documentation available online.
+
+To generate the API documentation,
+Doxygen, as well as [Graphviz](http://www.graphviz.org/) should be installed.
+(Note that on Windows, it may be necessary to add the Graphviz binary directory
+(something like `C:\Program Files\Graphviz2.38\bin`)
+to the `PATH` variable manually.)
+With Doxygen and Graphviz installed, issue the command
+`doxygen` from the command line in the main project directory, which will
+generate the API documentation in HTML format.
+The just generated `api-doc/index.html` can now be opened in a browser.
+
 ## Contributing
 If you want to contribute to this project:
 - Report bugs and errors
--- a/arduino-irremote.sublime-workspace
+++ b/arduino-irremote.sublime-workspace
@@ -1,240 +0,0 @@
-{
-	"auto_complete":
-	{
-		"selected_items":
-		[
-			[
-				"vb",
-				"vboMatrix"
-			]
-		]
-	},
-	"buffers":
-	[
-	],
-	"build_system": "",
-	"build_system_choices":
-	[
-	],
-	"build_varint": "",
-	"command_palette":
-	{
-		"height": 275.0,
-		"last_filter": "blame",
-		"selected_items":
-		[
-			[
-				"blame",
-				"Git: Blame"
-			],
-			[
-				"install",
-				"Package Control: Install Package"
-			],
-			[
-				"diff",
-				"Git: Diff Current File"
-			],
-			[
-				"js",
-				"Set Syntax: JavaScript"
-			],
-			[
-				"i",
-				"Package Control: Install Package"
-			],
-			[
-				"instal",
-				"Package Control: Install Package"
-			]
-		],
-		"width": 510.0
-	},
-	"console":
-	{
-		"height": 126.0,
-		"history":
-		[
-			"import urllib.request,os,hashlib; h = '2915d1851351e5ee549c20394736b442' + '8bc59f460fa1548d1514676163dafc88'; pf = 'Package Control.sublime-package'; ipp = sublime.installed_packages_path(); urllib.request.install_opener( urllib.request.build_opener( urllib.request.ProxyHandler()) ); by = urllib.request.urlopen( 'http://packagecontrol.io/' + pf.replace(' ', '%20')).read(); dh = hashlib.sha256(by).hexdigest(); print('Error validating download (got %s instead of %s), please try manual install' % (dh, h)) if dh != h else open(os.path.join( ipp, pf), 'wb' ).write(by)"
-		]
-	},
-	"distraction_free":
-	{
-		"menu_visible": true,
-		"show_minimap": false,
-		"show_open_files": false,
-		"show_tabs": false,
-		"side_bar_visible": false,
-		"status_bar_visible": false
-	},
-	"expanded_folders":
-	[
-		"/C/Users/Rafi Khan/Documents/Arduino/libraries/Arduino-IRremote"
-	],
-	"file_history":
-	[
-		"/C/Users/Rafi Khan/Documents/Arduino/libraries/Arduino-IRremote/changelog.md",
-		"/C/Users/Rafi Khan/Documents/Development/Arduino-IRremote/arduino-irremote.sublime-project",
-		"/C/Users/Rafi Khan/Documents/Development/Arduino-IRremote/.gitignore",
-		"/C/Users/Rafi Khan/Documents/Development/magic/README.md",
-		"/C/Users/Rafi Khan/Documents/Development/magic/shader.frag",
-		"/C/Users/Rafi Khan/Documents/Development/magic/package.json",
-		"/C/Users/Rafi Khan/Documents/Development/magic/block.js",
-		"/C/Users/Rafi Khan/Documents/Development/magic/chunker.js",
-		"/C/Users/Rafi Khan/Documents/Development/magic/index.js",
-		"/C/Users/Rafi Khan/Documents/Development/magic/blocks",
-		"/C/Users/Rafi Khan/AppData/Roaming/Sublime Text 3/Packages/User/Preferences.sublime-settings",
-		"/C/Users/Rafi Khan/Documents/Development/magic/shader.vert",
-		"/C/Users/Rafi Khan/Documents/Development/magic/magic.sublime-project",
-		"/C/Users/Rafi Khan/Documents/Development/magic/node_modules/browserify/node_modules/syntax-error/node_modules/acorn/.tern-project",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/supermarket.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/takingavacation.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/TipCalculator.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/battleship.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/exam.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/pyglatin.py",
-		"/C/Users/Rafi Khan/OneDrive/Documents/School-RafiKhan/Grade 11/CS30/Python/student.py"
-	],
-	"find":
-	{
-		"height": 28.0
-	},
-	"find_in_files":
-	{
-		"height": 0.0,
-		"where_history":
-		[
-		]
-	},
-	"find_state":
-	{
-		"case_sensitive": false,
-		"find_history":
-		[
-			"i",
-			"Direction",
-			";",
-			";\n",
-			"north",
-			"cubeMatrix",
-			")\n",
-			"vec3.set",
-			"f",
-			";",
-			"();\n",
-			"render",
-			"this",
-			"y"
-		],
-		"highlight": true,
-		"in_selection": false,
-		"preserve_case": false,
-		"regex": false,
-		"replace_history":
-		[
-		],
-		"reverse": false,
-		"show_context": true,
-		"use_buffer2": true,
-		"whole_word": false,
-		"wrap": true
-	},
-	"groups":
-	[
-		{
-			"sheets":
-			[
-			]
-		}
-	],
-	"incremental_find":
-	{
-		"height": 28.0
-	},
-	"input":
-	{
-		"height": 66.0
-	},
-	"layout":
-	{
-		"cells":
-		[
-			[
-				0,
-				0,
-				1,
-				1
-			]
-		],
-		"cols":
-		[
-			0.0,
-			1.0
-		],
-		"rows":
-		[
-			0.0,
-			1.0
-		]
-	},
-	"menu_visible": true,
-	"output.find_results":
-	{
-		"height": 0.0
-	},
-	"pinned_build_system": "",
-	"project": "arduino-irremote.sublime-project",
-	"replace":
-	{
-		"height": 52.0
-	},
-	"save_all_on_build": true,
-	"select_file":
-	{
-		"height": 0.0,
-		"last_filter": "",
-		"selected_items":
-		[
-			[
-				"json",
-				"package.json"
-			],
-			[
-				"inde",
-				"index.js"
-			]
-		],
-		"width": 0.0
-	},
-	"select_project":
-	{
-		"height": 0.0,
-		"last_filter": "",
-		"selected_items":
-		[
-		],
-		"width": 0.0
-	},
-	"select_symbol":
-	{
-		"height": 0.0,
-		"last_filter": "",
-		"selected_items":
-		[
-		],
-		"width": 0.0
-	},
-	"selected_group": 0,
-	"settings":
-	{
-	},
-	"show_minimap": true,
-	"show_open_files": false,
-	"show_tabs": true,
-	"side_bar_visible": true,
-	"side_bar_width": 150.0,
-	"status_bar_visible": true,
-	"template_settings":
-	{
-	}
-}
--- a/changelog.md
+++ b/changelog.md
@@ -1,3 +1,6 @@
+## 2.5.0
+- Added Philips Extended RC-5 protocol support [PR #522] (https://github.com/z3t0/Arduino-IRremote/pull/522)
+
 ## 2.4.0 - 2017/08/10
 - Cleanup of hardware dependencies. Merge in SAM support [PR #437](https://github.com/z3t0/Arduino-IRremote/pull/437)

--- a/examples/IRtest/IRtest.ino
+++ b/examples/IRtest/IRtest.ino
@@ -10,7 +10,6 @@
 */

 #include <IRremote.h>
-#include <IRremoteInt.h>

 // Dumps out the decode_results structure.
 // Call this after IRrecv::decode()
--- a/examples/LegoPowerFunctionsSendDemo/LegoPowerFunctionsSendDemo.ino
+++ b/examples/LegoPowerFunctionsSendDemo/LegoPowerFunctionsSendDemo.ino
@@ -4,7 +4,6 @@
 */

 #include <IRremote.h>
-#include <IRremoteInt.h>

 IRsend irsend;

--- a/library.json
+++ b/library.json
@@ -7,7 +7,7 @@
    "type": "git",
    "url": "https://github.com/z3t0/Arduino-IRremote.git"
  },
-  "version": "2.3.3",
+  "version": "2.4.0",
  "frameworks": "arduino",
  "platforms": "atmelavr",
  "authors" :
--- a/library.properties
+++ b/library.properties
@@ -1,9 +1,9 @@
 name=IRremote
-version=2.2.3
-author=shirriff
-maintainer=shirriff
+version=2.4.0
+author=shirriff, z3t0
+maintainer=z3t0
 sentence=Send and receive infrared signals with multiple protocols
-paragraph=Send and receive infrared signals with multiple protocols
-category=Signal Input/Output
-url=https://github.com/shirriff/Arduino-IRremote.git
+paragraph=Find more information at https://github.com/z3t0/Arduino-IRremote
+category=Communication
+url=https://github.com/z3t0/Arduino-IRremote
 architectures=*
--- a/src/IRremote.cpp
+++ b/src/IRremote.cpp
@@ -20,8 +20,7 @@

 // Defining IR_GLOBAL here allows us to declare the instantiation of global variables
 #define IR_GLOBAL
-#	include "IRremote.h"
-#	include "IRremoteInt.h"
+#include "IRremote.h"
 #undef IR_GLOBAL

 #ifdef HAS_AVR_INTERRUPT_H
@@ -52,11 +51,12 @@ int  MATCH (int measured,  int desired)
 	DBG_PRINT(TICKS_HIGH(desired), DEC);

  bool passed = ((measured >= TICKS_LOW(desired)) && (measured <= TICKS_HIGH(desired)));
-  if (passed)
+  if (passed) {
    DBG_PRINTLN(F("?; passed"));
-  else
-    DBG_PRINTLN(F("?; FAILED")); 
- 	return passed;
+  } else {
+    DBG_PRINTLN(F("?; FAILED"));
+  }
+  return passed;
 }

 //+========================================================
@@ -68,7 +68,7 @@ int  MATCH_MARK (int measured_ticks,  int desired_us)
 	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
 	DBG_PRINT(F("us vs "));
 	DBG_PRINT(desired_us, DEC);
-	DBG_PRINT("us"); 
+	DBG_PRINT("us");
 	DBG_PRINT(": ");
 	DBG_PRINT(TICKS_LOW(desired_us + MARK_EXCESS) * USECPERTICK, DEC);
 	DBG_PRINT(F(" <= "));
@@ -78,11 +78,12 @@ int  MATCH_MARK (int measured_ticks,  int desired_us)

  bool passed = ((measured_ticks >= TICKS_LOW (desired_us + MARK_EXCESS))
                && (measured_ticks <= TICKS_HIGH(desired_us + MARK_EXCESS)));
-  if (passed)
+  if (passed) {
    DBG_PRINTLN(F("?; passed"));
-  else
-    DBG_PRINTLN(F("?; FAILED")); 
- 	return passed;
+  } else {
+    DBG_PRINTLN(F("?; FAILED"));
+  }
+  return passed;
 }

 //+========================================================
@@ -94,7 +95,7 @@ int  MATCH_SPACE (int measured_ticks,  int desired_us)
 	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
 	DBG_PRINT(F("us vs "));
 	DBG_PRINT(desired_us, DEC);
-	DBG_PRINT("us"); 
+	DBG_PRINT("us");
 	DBG_PRINT(": ");
 	DBG_PRINT(TICKS_LOW(desired_us - MARK_EXCESS) * USECPERTICK, DEC);
 	DBG_PRINT(F(" <= "));
@@ -104,11 +105,12 @@ int  MATCH_SPACE (int measured_ticks,  int desired_us)

  bool passed = ((measured_ticks >= TICKS_LOW (desired_us - MARK_EXCESS))
                && (measured_ticks <= TICKS_HIGH(desired_us - MARK_EXCESS)));
-  if (passed)
+  if (passed) {
    DBG_PRINTLN(F("?; passed"));
-  else
-    DBG_PRINTLN(F("?; FAILED")); 
- 	return passed;
+  } else {
+    DBG_PRINTLN(F("?; FAILED"));
+  }
+  return passed;
 }

 //+=============================================================================
--- a/src/IRremote.h
+++ b/src/IRremote.h
@@ -1,3 +1,7 @@
+/**
+ * @file IRremote.h
+ * @brief Public API to the library.
+ */

 //******************************************************************************
 // IRremote
@@ -21,7 +25,7 @@
 //------------------------------------------------------------------------------
 // The ISR header contains several useful macros the user may wish to use
 //
-#include "IRremoteInt.h"
+#include "private/IRremoteInt.h"

 //------------------------------------------------------------------------------
 // Supported IR protocols
@@ -94,10 +98,10 @@
 #define PRONTO_FALLBACK    true
 #define PRONTO_NOFALLBACK  false

-//------------------------------------------------------------------------------
-// An enumerated list of all supported formats
-// You do NOT need to remove entries from this list when disabling protocols!
-//
+/**
+ * An enum consisting of all supported formats.
+ * You do NOT need to remove entries from this list when disabling protocols!
+ */
 typedef
 	enum {
 		UNKNOWN      = -1,
@@ -122,9 +126,9 @@ typedef
 	}
 decode_type_t;

-//------------------------------------------------------------------------------
-// Set DEBUG to 1 for lots of lovely debug output
-//
+/**
+ * Set DEBUG to 1 for lots of lovely debug output.
+ */
 #define DEBUG  0

 //------------------------------------------------------------------------------
@@ -134,7 +138,13 @@ decode_type_t;
 #	define DBG_PRINT(...)    Serial.print(__VA_ARGS__)
 #	define DBG_PRINTLN(...)  Serial.println(__VA_ARGS__)
 #else
+/**
+ * If DEBUG, print the arguments, otherwise do nothing.
+ */
 #	define DBG_PRINT(...)
+/**
+ * If DEBUG, print the arguments as a line, otherwise do nothing.
+ */
 #	define DBG_PRINTLN(...)
 #endif

@@ -145,39 +155,71 @@ int  MATCH       (int measured, int desired) ;
 int  MATCH_MARK  (int measured_ticks, int desired_us) ;
 int  MATCH_SPACE (int measured_ticks, int desired_us) ;

-//------------------------------------------------------------------------------
-// Results returned from the decoder
-//
+/**
+ * Results returned from the decoder
+ */
 class decode_results
 {
 	public:
-		decode_type_t          decode_type;  // UNKNOWN, NEC, SONY, RC5, ...
-		unsigned int           address;      // Used by Panasonic & Sharp [16-bits]
-		unsigned long          value;        // Decoded value [max 32-bits]
-		int                    bits;         // Number of bits in decoded value
-		volatile unsigned int  *rawbuf;      // Raw intervals in 50uS ticks
-		int                    rawlen;       // Number of records in rawbuf
-		int                    overflow;     // true iff IR raw code too long
+		decode_type_t          decode_type;  ///< UNKNOWN, NEC, SONY, RC5, ...
+		unsigned int           address;      ///< Used by Panasonic & Sharp [16-bits]
+		unsigned long          value;        ///< Decoded value [max 32-bits]
+		int                    bits;         ///< Number of bits in decoded value
+		volatile unsigned int  *rawbuf;      ///< Raw intervals in 50uS ticks
+		int                    rawlen;       ///< Number of records in rawbuf
+		int                    overflow;     ///< true iff IR raw code too long
 };

-//------------------------------------------------------------------------------
-// Decoded value for NEC when a repeat code is received
-//
+/**
+ * Decoded value for NEC when a repeat code is received
+ */
 #define REPEAT 0xFFFFFFFF

-//------------------------------------------------------------------------------
-// Main class for receiving IR
-//
+/**
+ * Main class for receiving IR
+ */
 class IRrecv
 {
 	public:
+                /**
+                 * Instantiate the IRrecv class. Multiple instantiation is not supported.
+                 * @param recvpin Arduino pin to use. No sanity check is made.
+                 */
 		IRrecv (int recvpin) ;
+                /**
+                 * Instantiate the IRrecv class. Multiple instantiation is not supported.
+                 * @param recvpin Arduino pin to use, where a demodulating IR receiver is connected.
+                 * @param blinkpin pin to blink when receiving IR. Not supported by all hardware. No sanity check is made.
+                 */
 		IRrecv (int recvpin, int blinkpin);

+                /**
+                 * TODO: Why is this public???
+                 * @param blinkflag
+                 */
 		void  blink13    (int blinkflag) ;
+
+                /**
+                 * Attempt to decode the recently receive IR signal
+                 * @param results decode_results instance returning the decode, if any.
+                 * @return success of operation. TODO: convert to bool
+                 */
 		int   decode     (decode_results *results) ;
+
+                /**
+                 * Enable IR reception.
+                 */
 		void  enableIRIn ( ) ;
+
+                /**
+                 * Returns status of reception
+                 * @return true if no reception is on-going.
+                 */
 		bool  isIdle     ( ) ;
+
+                /**
+                 * Called to re-enable IR reception.
+                 */
 		void  resume     ( ) ;

 	private:
@@ -186,10 +228,17 @@ class IRrecv

 		//......................................................................
 #		if (DECODE_RC5 || DECODE_RC6)
-			// This helper function is shared by RC5 and RC6
+			/**
+                         *  This helper function is shared by RC5 and RC6
+                         */
 			int  getRClevel (decode_results *results,  int *offset,  int *used,  int t1) ;
 #		endif
 #		if DECODE_RC5
+                        /**
+                         * Try to decode the recently received IR signal as an RC5 signal-
+                         * @param results decode_results instance returning the decode, if any.
+                         * @return Success of the operation.
+                         */
 			bool  decodeRC5        (decode_results *results) ;
 #		endif
 #		if DECODE_RC6
@@ -253,9 +302,9 @@ class IRrecv
 #		endif
 } ;

-//------------------------------------------------------------------------------
-// Main class for sending IR
-//
+/**
+ * Main class for sending IR
+ */
 class IRsend
 {
 	public:
@@ -281,6 +330,7 @@ class IRsend
 		//......................................................................
 #		if SEND_RC5
 			void  sendRC5        (unsigned long data,  int nbits) ;
+			void  sendRC5ext     (unsigned long addr, unsigned long cmd, boolean toggle);
 #		endif
 #		if SEND_RC6
 			void  sendRC6        (unsigned long data,  int nbits) ;
@@ -357,7 +407,7 @@ class IRsend

 		unsigned int periodTime;
 		unsigned int periodOnTime;
-		
+
 		void sleepMicros(unsigned long us);
 		void sleepUntilMicros(unsigned long targetTime);

--- a/src/esp32.cpp
+++ b/src/esp32.cpp
@@ -3,7 +3,6 @@
 // This file contains functions specific to the ESP32.

 #include "IRremote.h"
-#include "IRremoteInt.h"

 // "Idiot check"
 #ifdef USE_DEFAULT_ENABLE_IR_IN
--- a/src/irPronto.cpp
+++ b/src/irPronto.cpp
--- a/src/irRecv.cpp
+++ b/src/irRecv.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //+=============================================================================
 // Decodes the received IR message
--- a/src/irSend.cpp
+++ b/src/irSend.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 #ifdef SENDING_SUPPORTED
 //+=============================================================================
@@ -136,4 +135,4 @@ void IRsend::custom_delay_usec(unsigned long uSecs) {
  //}
 }

-#endif // SENDING_SUPPORTED
+#endif // SENDING_SUPPORTED
--- a/src/ir_Aiwa.cpp
+++ b/src/ir_Aiwa.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                         AAA   IIIII  W   W   AAA
--- a/src/ir_Denon.cpp
+++ b/src/ir_Denon.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 // Reverse Engineered by looking at RAW dumps generated by IRremote

--- a/src/ir_Dish.cpp
+++ b/src/ir_Dish.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                       DDDD   IIIII   SSSS  H   H
--- a/src/ir_JVC.cpp
+++ b/src/ir_JVC.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                             JJJJJ  V   V   CCCC
--- a/src/ir_LG.cpp
+++ b/src/ir_LG.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                               L       GGGG
--- a/src/ir_Lego_PF.cpp
+++ b/src/ir_Lego_PF.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"
 #include "ir_Lego_PF_BitStreamEncoder.h"

 //==============================================================================
--- a/src/ir_Lego_PF_BitStreamEncoder.h
+++ b/src/ir_Lego_PF_BitStreamEncoder.h
--- a/src/ir_Mitsubishi.cpp
+++ b/src/ir_Mitsubishi.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //    MMMMM  IIIII TTTTT   SSSS  U   U  BBBB   IIIII   SSSS  H   H  IIIII
--- a/src/ir_NEC.cpp
+++ b/src/ir_NEC.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                           N   N  EEEEE   CCCC
--- a/src/ir_Panasonic.cpp
+++ b/src/ir_Panasonic.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //       PPPP    AAA   N   N   AAA    SSSS   OOO   N   N  IIIII   CCCC
--- a/src/ir_RC5_RC6.cpp
+++ b/src/ir_RC5_RC6.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //+=============================================================================
 // Gets one undecoded level at a time from the raw buffer.
@@ -78,6 +77,73 @@ void  IRsend::sendRC5 (unsigned long data,  int nbits)

 	space(0);  // Always end with the LED off
 }
+
+void  IRsend::sendRC5ext (unsigned long addr, unsigned long cmd, boolean toggle)
+{
+	// Set IR carrier frequency
+	enableIROut(36);
+	
+	unsigned long addressBits = 5;
+	unsigned long commandBits = 7;
+	unsigned long nbits = addressBits + commandBits;
+	
+	// Start
+	mark(RC5_T1);
+	
+	// Bit #6 of the command part, but inverted!
+	unsigned long cmdBit6 = (1UL << (commandBits-1)) & cmd;
+	if (cmdBit6) {
+		// Inverted (1 -> 0 = mark-to-space)
+		mark(RC5_T1);
+		space(RC5_T1);
+	} else {
+		space(RC5_T1);
+		mark(RC5_T1);
+	}
+	commandBits--;
+
+	// Toggle bit
+	static int toggleBit = 1;
+	if (toggle) {
+		if (toggleBit == 0) {
+			toggleBit = 1;
+		} else {
+			toggleBit = 0;
+		}
+	}
+	if (toggleBit) {
+		space(RC5_T1);
+		mark(RC5_T1);
+	} else {
+		mark(RC5_T1);
+		space(RC5_T1);
+	}
+
+	// Address
+	for (unsigned long  mask = 1UL << (addressBits - 1);  mask;  mask >>= 1) {
+		if (addr & mask) {
+			space(RC5_T1); // 1 is space, then mark
+			mark(RC5_T1);
+		} else {
+			mark(RC5_T1);
+			space(RC5_T1);
+		}
+	}
+	
+	// Command
+	for (unsigned long  mask = 1UL << (commandBits - 1);  mask;  mask >>= 1) {
+		if (cmd & mask) {
+			space(RC5_T1); // 1 is space, then mark
+			mark(RC5_T1);
+		} else {
+			mark(RC5_T1);
+			space(RC5_T1);
+		}
+	}
+
+	space(0);  // Always end with the LED off
+}
+
 #endif

 //+=============================================================================
--- a/src/ir_Samsung.cpp
+++ b/src/ir_Samsung.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //              SSSS   AAA    MMM    SSSS  U   U  N   N   GGGG
--- a/src/ir_Sanyo.cpp
+++ b/src/ir_Sanyo.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                      SSSS   AAA   N   N  Y   Y   OOO
--- a/src/ir_Sharp.cpp
+++ b/src/ir_Sharp.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                       SSSS  H   H   AAA   RRRR   PPPP
--- a/src/ir_Sony.cpp
+++ b/src/ir_Sony.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //                           SSSS   OOO   N   N  Y   Y
--- a/src/ir_Template.cpp
+++ b/src/ir_Template.cpp
@@ -92,7 +92,6 @@ Regards,
 */

 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //
--- a/src/ir_Whynter.cpp
+++ b/src/ir_Whynter.cpp
@@ -1,5 +1,4 @@
 #include "IRremote.h"
-#include "IRremoteInt.h"

 //==============================================================================
 //               W   W  H   H  Y   Y N   N TTTTT EEEEE  RRRRR
--- a/src/private/IRremoteInt.h
+++ b/src/private/IRremoteInt.h
@@ -18,15 +18,9 @@
 #define IRremoteint_h

 //------------------------------------------------------------------------------
-// Include the right Arduino header
+// Include the Arduino header
 //
-#if defined(ARDUINO) && (ARDUINO >= 100)
-#	include <Arduino.h>
-#else
-#	if !defined(IRPRONTO)
-#		include <WProgram.h>
-#	endif
-#endif
+#include <Arduino.h>

 //------------------------------------------------------------------------------
 // This handles definition and access to global variables
@@ -40,19 +34,22 @@
 //------------------------------------------------------------------------------
 // Information for the Interrupt Service Routine
 //
-#define RAWBUF  101  // Maximum length of raw duration buffer
+#define RAWBUF  101  ///< Maximum length of raw duration buffer. Must be odd.

+/**
+  * This struct is used to communicate with the ISR (interrupt service routine).
+  */
 typedef
 	struct {
 		// The fields are ordered to reduce memory over caused by struct-padding
-		uint8_t       rcvstate;        // State Machine state
-		uint8_t       recvpin;         // Pin connected to IR data from detector
+		uint8_t       rcvstate;        ///< State Machine state
+		uint8_t       recvpin;         ///< Pin connected to IR data from detector
 		uint8_t       blinkpin;
-		uint8_t       blinkflag;       // true -> enable blinking of pin on IR processing
-		uint8_t       rawlen;          // counter of entries in rawbuf
-		unsigned int  timer;           // State timer, counts 50uS ticks.
-		unsigned int  rawbuf[RAWBUF];  // raw data
-		uint8_t       overflow;        // Raw buffer overflow occurred
+		uint8_t       blinkflag;       ///< true -> enable blinking of pin on IR processing
+		uint8_t       rawlen;          ///< counter of entries in rawbuf
+		unsigned int  timer;           ///< State timer, counts 50uS ticks.
+		unsigned int  rawbuf[RAWBUF];  ///< raw data
+		uint8_t       overflow;        ///< Raw buffer overflow occurred
 	}
 irparams_t;

@@ -63,9 +60,11 @@ irparams_t;
 #define STATE_STOP      5
 #define STATE_OVERFLOW  6

-// Allow all parts of the code access to the ISR data
-// NB. The data can be changed by the ISR at any time, even mid-function
-// Therefore we declare it as "volatile" to stop the compiler/CPU caching it
+/**
+ * Allow all parts of the code access to the ISR data
+ * NB. The data can be changed by the ISR at any time, even mid-function
+ * Therefore we declare it as "volatile" to stop the compiler/CPU caching it
+ */
 EXTERN  volatile irparams_t  irparams;

 //------------------------------------------------------------------------------
@@ -85,8 +84,12 @@ EXTERN  volatile irparams_t  irparams;
 // Pulse parameters in uSec
 //

-// Due to sensor lag, when received, Marks  tend to be 100us too long and
-//                                   Spaces tend to be 100us too short
+/**
+ * When received, marks  tend to be too long and
+ * spaces tend to be too short.
+ * To compensate for this, MARK_EXCESS is subtracted from all marks,
+ * and added to all spaces.
+ */
 #define MARK_EXCESS    100

 // Upper and Lower percentage tolerances in measurements
--- a/src/private/boarddefs.h
+++ b/src/private/boarddefs.h
@@ -85,7 +85,7 @@
 #       undef HAS_AVR_INTERRUPT_H

        // Sending not implemented
-#       undef SENDING_SUPPORTED#
+#       undef SENDING_SUPPORTED

        // Supply own enbleIRIn
 #       undef USE_DEFAULT_ENABLE_IR_IN
@@ -131,8 +131,8 @@
 // Teensy 2.0
 #elif defined(__AVR_ATmega32U4__)
 	//#define IR_USE_TIMER1   // tx = pin 14
-	//#define IR_USE_TIMER3   // tx = pin 9
-	#define IR_USE_TIMER4_HS  // tx = pin 10
+	#define IR_USE_TIMER3   // tx = pin 9
+	//#define IR_USE_TIMER4_HS  // tx = pin 10

 // Teensy 3.0 / Teensy 3.1
 #elif defined(__MK20DX128__) || defined(__MK20DX256__) || defined(__MK64FX512__) || defined(__MK66FX1M0__)
@@ -161,7 +161,7 @@
 || defined(__AVR_ATmega164P__)
 	//#define IR_USE_TIMER1   // tx = pin 13
 	#define IR_USE_TIMER2     // tx = pin 14
-	
+
 //MegaCore - ATmega64, ATmega128
 #elif defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__)
 	#define IR_USE_TIMER1     // tx = pin 13
@@ -624,7 +624,7 @@
 #define TIMER_RESET
 #define TIMER_ENABLE_PWM     // Not presently used
 #define TIMER_DISABLE_PWM
-#define TIMER_ENABLE_INTR    NVIC_EnableIRQ(TC3_IRQn) // Not presently used    
+#define TIMER_ENABLE_INTR    NVIC_EnableIRQ(TC3_IRQn) // Not presently used
 #define TIMER_DISABLE_INTR   NVIC_DisableIRQ(TC3_IRQn)
 #define TIMER_INTR_NAME      TC3_Handler // Not presently used
 #define TIMER_CONFIG_KHZ(f)
@@ -645,7 +645,7 @@
 #ifndef SENDPIN_ON
 #define SENDPIN_ON(pin)  digitalWrite(pin, HIGH)
 #endif
-	
+
 #ifndef SENDPIN_OFF
 #define SENDPIN_OFF(pin) digitalWrite(pin, LOW)
 #endif
--- a/src/sam.cpp
+++ b/src/sam.cpp
@@ -1,7 +1,6 @@
 // Support routines for SAM processor boards

 #include "IRremote.h"
-#include "IRremoteInt.h"

 #if defined(ARDUINO_ARCH_SAM) || defined(ARDUINO_ARCH_SAMD)

@@ -99,4 +98,4 @@ void TC3_Handler(void)
 	}
 }

-#endif // defined(ARDUINO_ARCH_SAM) || defined(ARDUINO_ARCH_SAMD)
+#endif // defined(ARDUINO_ARCH_SAM) || defined(ARDUINO_ARCH_SAMD)
Author	SHA1	Message	Date
Rafi Khan	742f72fd0a	Merge branch 'beta' of https://github.com/z3t0/Arduino-IRremote into beta	2017-09-23 23:16:52 -04:00
Rafi Khan	3ab30887f4	Merge branch 'LarsWH-master' into beta	2017-09-23 23:15:34 -04:00
Rafi Khan	bdb9f1c1f5	Added support for RC5 extended Credits: https://github.com/LarsWH Excerpt from PR: ``` Hi, I added support for 'RC5 extended' in order to make this project: https://www.instructables.com/id/Remote-Control-for-Lava-mMotion-Swing-Mounting-Bra/ The modification is working nicely in this single application. It has not been tested elsewhere. (I am new to Git and this is my first pull request ever. So please excuse me if I have messed something up) Kind regards, Lars ``` Merged #522	2017-09-23 21:03:07 -04:00
Rafi Khan	71f6daca4f	Revert "Merge pull request #519 from PaulStoffregen/master" This reverts commit `20a4d97f61`, reversing changes made to `47aadf559d`.	2017-09-14 22:13:50 -04:00
Rafi Khan	2b3188e40a	Merge branch 'master' of https://github.com/z3t0/Arduino-IRremote	2017-09-14 21:57:46 -04:00
Rafi Khan	d719c27f95	Changed default send pin on ATmega32u4 from 13 to 9 The reason for this change is that I was informed by a community member that the Pro Micro board does not have the default pin 13. This causes many issues for beginners that are not familiar with the inner workings of the library. However, I am concerned about this being a breaking change. If there are serious issues I may just end up adding a tutorial in the FAQ for beginners, informing them how they may change the default pins.	2017-09-14 21:57:01 -04:00
Rafi Khan	20a4d97f61	Merge pull request #519 from PaulStoffregen/master Fix minor compiler warnings in examples	2017-09-09 17:53:45 -06:00
Rafi Khan	d2939e2366	Updated README.md for API doc. (#515 ) Credits: @bengtmartensson	2017-09-06 20:59:17 -06:00
PaulStoffregen	1154607b69	Fix minor compiler warnings in examples	2017-09-04 20:48:37 -07:00
Bengt Martensson	c6a2fcd8c9	Updated README.md for API doc.	2017-08-27 13:41:28 +02:00
Bengt Martensson	e206e122e5	Doxygen API documentation in the sense of #461 (#512 ) * new file: Doxyfile; #461. * Doxygen related documentation to two files. (Not complete.) #461.	2017-08-23 13:57:05 -06:00
Rafi Khan	5bbd55c650	Fix #510	2017-08-22 15:47:20 -06:00
Bengt Martensson	24dd940107	Moving private includes to sub-directory, #464 (#507 ) * Add missing "paragraph" to library.properties. * Move not-to-be-exported includes to subdirectory. Remove #include "IRremoteInt.h" from a number of files since it now does not work any more, and since IRremote.h #includes it already. This resolves #464. * Remove #include <IRremoteInt.h> from examples, too. * Make ir_Lego_PF_BitStreamEncoder.h exported (again). * Revoked fe24095 (paragraph) to keep 1-1 correspondance to #464.	2017-08-20 15:49:57 -06:00
Bengt Martensson	7245efd2f5	Fix some minor problems in boarddefs.h and IRremote.cpp (#505 ) * Removed some trailing spaces in IRremote.cpp. * IRremote.cpp: fix some compiler warnings (-Wall -Wextra). Remark: braces necessitated by the macro nature of DBG_PRINTLN. * boarddefs.h: removed spurious #. Nuked trailing spaces. Credits: bengtmartensson	2017-08-17 17:32:01 -06:00
Rafi Khan	4eb95a3272	Revert "Removed blinking led" This reverts commit `a406f3b9f9`.	2017-08-14 17:12:02 -06:00
Rafi Khan	542516f116	Revert "Removed pronto "protocol"" This reverts commit `563c82c6c4`.	2017-08-13 12:03:54 -06:00
Rafi Khan	563c82c6c4	Removed pronto "protocol" Fixes #466	2017-08-13 11:46:58 -06:00
Rafi Khan	a406f3b9f9	Removed blinking led It is difficult to maintain this over different architectures and also not entirely that useful. Fixes #462	2017-08-13 11:43:32 -06:00
Rafi Khan	31968a4875	Removed redundant preprocessor directives In the newer versions of the IDE it is sufficient to simply include the Arduino.h header file. Fixes #463	2017-08-13 11:30:06 -06:00
Rafi Khan	635e8a923d	Restructuring directory as per #464	2017-08-13 11:19:20 -06:00
Rafi Khan	b0d15b6020	Modified library.json	2017-08-13 11:05:50 -06:00
Rafi Khan	622e28bf69	Update library.properties	2017-08-13 11:05:12 -06:00