Merge pull request Arduino-IRremote#3 from z3t0/master

syncing with latest master

Author: AnalysIR

.gitignore

@@ -1 +1,3 @@
 *.un~
+*.sublime-project
+*.sublime-workspace

.travis.yml

@@ -13,6 +13,7 @@ env:
     - PLATFORMIO_CI_SRC=examples/IRtest PLATFORMIO_BUILD_FLAGS="-DSEND_NEC -DSEND_SONY -DSEND_RC5 -DSEND_RC6"
     - PLATFORMIO_CI_SRC=examples/IRtest2 PLATFORMIO_BUILD_FLAGS="-DSEND_NEC -DSEND_SONY -DSEND_RC5 -DSEND_RC6"
     - PLATFORMIO_CI_SRC=examples/JVCPanasonicSendDemo PLATFORMIO_BUILD_FLAGS="-DSEND_JVC -DSEND_PANASONIC"
+    - PLATFORMIO_CI_SRC=examples/IRremoteInfo 
 
 install:
     - python -c "$(curl -fsSL https://raw.githubusercontent.com/platformio/platformio/master/scripts/get-platformio.py)"

Contributing.md

@@ -0,0 +1,11 @@
+# Contribution Guidlines
+
+This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/z3t0/Arduino-IRremote/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community.
+
+The following are some guidelines to observe when creating issues or PRs:
+- Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas
+- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); it helps us help you when we can read your code! On that note also refrain from pasting more than 30 lines of code in a post, instead [create a gist](https://gist.github.com/) if you need to share large snippets
+- Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile:
+- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library 
+
+If there is any need to contact me then you can find my email on the README, I do not mind responding to emails but it would be in your own interests to create issues if you need help with the library as responses would be from a larger community with greater knowledge!

Contributors.md

@@ -12,6 +12,9 @@ These are the active contributors of this project that you may contact if there
 - [Neco777](https://github.com/neco777) : Active contributor
 - [Lauszus](https://github.com/lauszus) : Active contributor
 - [csBlueChip](https://github.com/csbluechip) : Active contributor, who contributed major and vital changes to the code base.
+- [Sebazzz](https://github.com/sebazz): Contributor
+- [lumbric](https://github.com/lumbric): Contributor
+- [ElectricRCAircraftGuy](https://github.com/electricrcaircraftguy): Active Contributor
 
 Note: This list is being updated constantly so please let [z3t0](https://github.com/z3t0) know if you have been missed.
 

IRremote.cpp

@@ -41,54 +41,71 @@
 //
 int  MATCH (int measured,  int desired)
 {
- 	DBG_PRINT("Testing: ");
+ 	DBG_PRINT(F("Testing: "));
  	DBG_PRINT(TICKS_LOW(desired), DEC);
- 	DBG_PRINT(" <= ");
+ 	DBG_PRINT(F(" <= "));
  	DBG_PRINT(measured, DEC);
- 	DBG_PRINT(" <= ");
- 	DBG_PRINTLN(TICKS_HIGH(desired), DEC);
+ 	DBG_PRINT(F(" <= "));
+ 	DBG_PRINT(TICKS_HIGH(desired), DEC);
 
- 	return ((measured >= TICKS_LOW(desired)) && (measured <= TICKS_HIGH(desired)));
+  bool passed = ((measured >= TICKS_LOW(desired)) && (measured <= TICKS_HIGH(desired)));
+  if (passed)
+    DBG_PRINTLN(F("?; passed"));
+  else
+    DBG_PRINTLN(F("?; FAILED")); 
+ 	return passed;
 }
 
 //+========================================================
 // Due to sensor lag, when received, Marks tend to be 100us too long
 //
 int  MATCH_MARK (int measured_ticks,  int desired_us)
 {
-	DBG_PRINT("Testing mark ");
+	DBG_PRINT(F("Testing mark (actual vs desired): "));
 	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
-	DBG_PRINT(" vs ");
+	DBG_PRINT(F("us vs "));
 	DBG_PRINT(desired_us, DEC);
+	DBG_PRINT("us"); 
 	DBG_PRINT(": ");
-	DBG_PRINT(TICKS_LOW(desired_us + MARK_EXCESS), DEC);
-	DBG_PRINT(" <= ");
-	DBG_PRINT(measured_ticks, DEC);
-	DBG_PRINT(" <= ");
-	DBG_PRINTLN(TICKS_HIGH(desired_us + MARK_EXCESS), DEC);
+	DBG_PRINT(TICKS_LOW(desired_us + MARK_EXCESS) * USECPERTICK, DEC);
+	DBG_PRINT(F(" <= "));
+	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
+	DBG_PRINT(F(" <= "));
+	DBG_PRINT(TICKS_HIGH(desired_us + MARK_EXCESS) * USECPERTICK, DEC);
 
-	return ((measured_ticks >= TICKS_LOW (desired_us + MARK_EXCESS))
-	     && (measured_ticks <= TICKS_HIGH(desired_us + MARK_EXCESS)));
+  bool passed = ((measured_ticks >= TICKS_LOW (desired_us + MARK_EXCESS))
+                && (measured_ticks <= TICKS_HIGH(desired_us + MARK_EXCESS)));
+  if (passed)
+    DBG_PRINTLN(F("?; passed"));
+  else
+    DBG_PRINTLN(F("?; FAILED")); 
+ 	return passed;
 }
 
 //+========================================================
 // Due to sensor lag, when received, Spaces tend to be 100us too short
 //
 int  MATCH_SPACE (int measured_ticks,  int desired_us)
 {
-	DBG_PRINT("Testing space ");
+	DBG_PRINT(F("Testing space (actual vs desired): "));
 	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
-	DBG_PRINT(" vs ");
+	DBG_PRINT(F("us vs "));
 	DBG_PRINT(desired_us, DEC);
+	DBG_PRINT("us"); 
 	DBG_PRINT(": ");
-	DBG_PRINT(TICKS_LOW(desired_us - MARK_EXCESS), DEC);
-	DBG_PRINT(" <= ");
-	DBG_PRINT(measured_ticks, DEC);
-	DBG_PRINT(" <= ");
-	DBG_PRINTLN(TICKS_HIGH(desired_us - MARK_EXCESS), DEC);
+	DBG_PRINT(TICKS_LOW(desired_us - MARK_EXCESS) * USECPERTICK, DEC);
+	DBG_PRINT(F(" <= "));
+	DBG_PRINT(measured_ticks * USECPERTICK, DEC);
+	DBG_PRINT(F(" <= "));
+	DBG_PRINT(TICKS_HIGH(desired_us - MARK_EXCESS) * USECPERTICK, DEC);
 
-	return ((measured_ticks >= TICKS_LOW (desired_us - MARK_EXCESS))
-	     && (measured_ticks <= TICKS_HIGH(desired_us - MARK_EXCESS)));
+  bool passed = ((measured_ticks >= TICKS_LOW (desired_us - MARK_EXCESS))
+                && (measured_ticks <= TICKS_HIGH(desired_us - MARK_EXCESS)));
+  if (passed)
+    DBG_PRINTLN(F("?; passed"));
+  else
+    DBG_PRINTLN(F("?; FAILED")); 
+ 	return passed;
 }
 
 //+=============================================================================

IRremote.h

@@ -257,7 +257,7 @@ class IRsend
 		void  enableIROut 		(int khz) ;
 		void  mark        		(unsigned int usec) ;
 		void  space       		(unsigned int usec) ;
-		void  sendRaw     		(unsigned int buf[],  unsigned int len,  unsigned int hz) ;
+		void  sendRaw     		(const unsigned int buf[],  unsigned int len,  unsigned int hz) ;
 
 		//......................................................................
 #		if SEND_RC5

ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+**Board:** ARDUINO UNO
+**Library Version:** 2.1.0
+**Protocol:** Sony (if any)
+
+**Code Block:**
+```c
+
+#include <IRremote.h> 
+
+.....
+
+```
+
+Use [a gist](gist.github.com) if the code exceeds 30 lines
+
+**checklist:**
+- [] The latest [release](https://github.com/z3t0/Arduino-IRremote/releases/latest) is used
+- [] Any code referenced is provided
+- [] The title of the issue is helpful and relevant 
+
+The above is a short template allowing you to make detailed issues!

README.md

@@ -8,7 +8,7 @@ This library enables you to send and receive using infra-red signals on an Ardui
 
 Check [here](http://z3t0.github.io/Arduino-IRremote/) for tutorials and more information.
 
-## Version - 2.01
+## Version - 2.1.0
 
 ## Installation
 1. Navigate to the [Releases](https://github.com/z3t0/Arduino-IRremote/releases) page.
@@ -17,6 +17,33 @@ Check [here](http://z3t0.github.io/Arduino-IRremote/) for tutorials and more inf
 4. Move the "IRremote" folder that has been extracted to your libraries directory.
 5. 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.
 
+## Supported Boards
+- Arduino Uno / Mega / Leonardo / Duemilanove / Diecimila / LilyPad / Mini / Fio / Nano etc.
+- Teensy 1.0 / 1.0++ / 2.0 / 2++ / 3.0 / 3.1 / Teensy-LC; Credits: @PaulStoffregen (Teensy Team)
+- Sanguino
+- Atmega8
+- ATtiny 84 / 85
+
+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.
+
+### Hardware specifications
+
+| Board/CPU                                | Send Pin            | Timers            |
+|------------------------------------------|---------------------|-------------------|
+| Arduino Mega / ATmega 1280 / ATmega 2560 | 5, 6, **9**, 11, 46 | 1, **2**, 3, 4, 5 |
+| Teensy 1.0                               | **17**              | **1**             |
+| Teensy 2.0                               | 9, **10**, 14       | 1, 3, **4_HS**    |
+| Teensy++ 1.0 / 2.0                       | **1**, 16, 25       | 1, **2**, 3       |
+| Teensy 3.0 / 3.1                         | **5**               | **CMT**           |
+| Teensy-LC                                | **16**              | **TPM1**          |
+| Sanguino                                 | 13, **14**          | 1, **2**          |
+| Atmega8                                  | **9**               | **1**             |
+| ATtiny84                                 | **6**               | **1**             |
+| ATtiny85                                 | **1**               | **TINY0**         |
+| Arduino Duemilanove, UNO etc.            | **3**, 9            | 1, **2**          |
+
+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.
+
 ## Usage
 - TODO (Check examples for now)
 
@@ -27,7 +54,8 @@ If you want to contribute to this project:
 - Create issues and pull requests
 - Tell other people about this library
 - Contribute new protocols
-- 
+
+Check [here](Contributing.md) for some guidelines.
 
 ## Contact
 The only way to contact me at the moment is by email: [email protected]