renamed IRrecord example to ReceiveAndSend added SimpleReceiver example and changed two functions to static

Author: ArminJo

.github/workflows/LibraryBuild.yml

@@ -86,11 +86,11 @@ jobs:
 
           - arduino-boards-fqbn: digistump:avr:digispark-tiny:clock=clock1
             platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
-            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,IRsendDemo,IRrecord,IRreceiveDump,IRsendProntoDemo,MicroGirs,IRreceiveDemo,ReceiverTimingAnalysis,IRDispatcherDemo,LGAirConditionerSendDemo # Does not fit in FLASH or RAM # Comma separated list of example names to exclude in build
+            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,IRsendDemo,ReceiveAndSend,IRreceiveDump,IRsendProntoDemo,MicroGirs,IRreceiveDemo,ReceiverTimingAnalysis,IRDispatcherDemo,LGAirConditionerSendDemo # Does not fit in FLASH or RAM # Comma separated list of example names to exclude in build
 
           - arduino-boards-fqbn: ATTinyCore:avr:attinyx5:chip=85,clock=1internal
             platform-url: http://drazzy.com/package_drazzy.com_index.json
-            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,IRrecord,IRreceiveDumpV2,IRsendProntoDemo,MicroGirs,IRreceiveDemo,BoseWaveSendDemo,IRDispatcherDemo,LGAirConditionerSendDemo # Does not fit in FLASH or RAM
+            sketches-exclude: IR2Keyboard,IRUnitTest,IRrelay,ReceiveAndSend,IRreceiveDumpV2,IRsendProntoDemo,MicroGirs,IRreceiveDemo,BoseWaveSendDemo,IRDispatcherDemo,LGAirConditionerSendDemo # Does not fit in FLASH or RAM
 
           - arduino-boards-fqbn: TinyCore:avr:tiny32
             platform-url: https://raw.githubusercontent.com/xukangmin/TinyCore/master/avr/package/package_tinycore_index.json
@@ -107,7 +107,7 @@ jobs:
 
           - arduino-boards-fqbn: sandeepmistry:nRF5:BBCmicrobit
             platform-url: https://sandeepmistry.github.io/arduino-nRF5/package_nRF5_boards_index.json
-            sketches-exclude: BoseWaveSendDemo,IR2Keyboard,IRDispatcherDemo,IRreceiveDemo,IRrecord,IRsendDemo,IRsendProntoDemo,IRsendRawDemo,IRUnitTest,LGAirConditionerSendDemo,MicroGirs,MinimalReceiver,SimpleSender # no sending yet, no tone()
+            sketches-exclude: BoseWaveSendDemo,IR2Keyboard,IRDispatcherDemo,IRreceiveDemo,ReceiveAndSend,IRsendDemo,IRsendProntoDemo,IRsendRawDemo,IRUnitTest,LGAirConditionerSendDemo,MicroGirs,MinimalReceiver,SimpleSender # no sending yet, no tone()
 
 
       # Do not cancel all jobs / architectures if one job fails

examples/IRreceiveDemo/IRreceiveDemo.ino

@@ -87,12 +87,14 @@ void loop() {
         IrReceiver.resume(); // Enable receiving of the next value
 
         /*
-         * Finally check the received data and perform actions according to the received commands
+         * Finally check the received data and perform actions according to the received address and command
          */
-        if (IrReceiver.decodedIRData.command == 0x10) {
-            // do something
-        } else if (IrReceiver.decodedIRData.command == 0x11) {
-            // do something else
+        if (IrReceiver.decodedIRData.address == 0) {
+            if (IrReceiver.decodedIRData.command == 0x10) {
+                // do something
+            } else if (IrReceiver.decodedIRData.command == 0x11) {
+                // do something else
+            }
         }
     }
 }

examples/IRsendDemo/IRsendDemo.ino

@@ -76,7 +76,9 @@ void loop() {
                 "0017 0806"), 0); //stop bit, no repeat possible, because of missing repeat pattern
         delay(2000);
 
-        Serial.println(F("Send NECRaw 0xCC340102 with 16 bit address 0x102 and command 0x34 which results in a parity error, since CC != ~34"));
+        Serial.println(
+                F(
+                        "Send NECRaw 0xCC340102 with 16 bit address 0x102 and command 0x34 which results in a parity error, since CC != ~34"));
         IrSender.sendNECRaw(0xCC340102, sRepeats);
         delay(2000);
     }
@@ -117,16 +119,31 @@ void loop() {
     IrSender.sendRC6(sAddress, sCommand, sRepeats, true);
     delay(2000);
 
-    Serial.println(F("Send Samsung"));
-    IrSender.sendSamsung(sAddress, sCommand, sRepeats);
+    /*
+     * Next example how to use the IrSender.write function
+     */
+    IRData IRSendData;
+    // prepare data
+    IRSendData.address = sAddress;
+    IRSendData.command = sCommand;
+    IRSendData.flags = IRDATA_FLAGS_EMPTY;
+
+    IRSendData.protocol = SAMSUNG;
+    Serial.print(F("Send "));
+    Serial.println(getProtocolString(IRSendData.protocol));
+    IrSender.write(&IRSendData, sRepeats);
     delay(2000);
 
-    Serial.println(F("Send JVC"));
-    IrSender.sendJVC(sAddress, sCommand, sRepeats);
+    IRSendData.protocol = JVC; // switch protocol
+    Serial.print(F("Send "));
+    Serial.println(getProtocolString(IRSendData.protocol));
+    IrSender.write(&IRSendData, sRepeats);
     delay(2000);
 
-    Serial.println(F("Send LG"));
-    IrSender.sendLG((uint8_t) sAddress, sCommand, sRepeats);
+    IRSendData.protocol = LG;
+    Serial.print(F("Send "));
+    Serial.println(getProtocolString(IRSendData.protocol));
+    IrSender.write(&IRSendData, sRepeats);
     delay(2000);
 
     if (sRepeats == 0) {
@@ -142,8 +159,9 @@ void loop() {
     }
 
 #if !defined(__AVR_ATtiny85__) // code does not fit in program space of ATtiny85
-    Serial.println(F("Send Bosewave with 8 command bits"));
-    IrSender.sendBoseWave(sCommand, sRepeats);
+    IRSendData.protocol = BOSEWAVE;
+    Serial.println(F("Send Bosewave with no address and 8 command bits"));
+    IrSender.write(&IRSendData, sRepeats);
     delay(2000);
 
     /*

examples/MinimalReceiver/MinimalReceiver.ino

@@ -1,6 +1,8 @@
 /*
  *  MinimalReceiver.cpp
  *
+ *  Small memory footprint and no timer usage!
+ *
  *  Receives IR protocol data of NEC protocol using pin change interrupts.
  *  On complete received IR command the function handleReceivedIRData(uint16_t aAddress, uint8_t aCommand, bool isRepetition)
  *  is called in Interrupt context but with interrupts being enabled to enable use of delay() etc.
@@ -10,7 +12,7 @@
  *  !!!!!!!!!!!!!!!!!!!!!
  *
  *
- *  Copyright (C) 2021  Armin Joachimsmeyer
+ *  Copyright (C) 2020-2021  Armin Joachimsmeyer
  *  [email protected]
  *
  *  This file is part of IRMP https://github.com/ukw100/IRMP.

examples/IRrecord/IRrecord.ino renamed to examples/ReceiveAndSend/ReceiveAndSend.ino

@@ -1,5 +1,5 @@
 /*
- * IRrecord.cpp
+ * ReceiveAndSend.cpp
  *
  * Record and play back IR signals as a minimal
  * An IR detector/demodulator must be connected to the input RECV_PIN.
@@ -14,6 +14,30 @@
  * Initially coded 2009 Ken Shirriff http://www.righto.com
  *
  *  This file is part of Arduino-IRremote https://github.com/z3t0/Arduino-IRremote.
+ *
+ ************************************************************************************
+ * MIT License
+ *
+ * Copyright (c) 2020-2021 Armin Joachimsmeyer
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is furnished
+ * to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+ * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+ * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+ * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ ************************************************************************************
  */
 
 #include <IRremote.h>
@@ -37,6 +61,7 @@ int DELAY_BETWEEN_REPEAT = 50;
 // Storage for the recorded code
 struct storedIRDataStruct {
     IRData receivedIRData;
+    // extensions for sendRaw
     uint8_t rawCode[RAW_BUFFER_LENGTH]; // The durations if raw
     uint8_t rawCodeLength; // The length of the code
 } sStoredIRData;
@@ -160,10 +185,13 @@ void sendCode(storedIRDataStruct *aIRDataToSend) {
         Serial.println(F(" marks or spaces"));
     } else {
 
+        /*
+         * Use the write function, which does the switch for different protocols
+         */
         IrSender.write(&aIRDataToSend->receivedIRData, NO_REPEATS);
 
         Serial.print(F("Sent: "));
-        IrReceiver.printIRResultShort(&Serial, &aIRDataToSend->receivedIRData);
+        printIRResultShort(&Serial, &aIRDataToSend->receivedIRData);
     }
 }
 

examples/SimpleReceiver/SimpleReceiver.ino

@@ -0,0 +1,54 @@
+/*
+ * SimpleReceiver.cpp
+ *
+ * Demonstrates receiving NEC IR codes with IRrecv
+ *
+ *  Copyright (C) 2020-2021  Armin Joachimsmeyer
+ *  [email protected]
+ *
+ *  This file is part of Arduino-IRremote https://github.com/z3t0/Arduino-IRremote.
+ *
+ *  MIT License
+ */
+
+#include <IRremote.h>
+
+int IR_RECEIVE_PIN = 11;
+
+void setup() {
+    Serial.begin(115200);
+    // Just to know which program is running on my Arduino
+    Serial.println(F("START " __FILE__ " from " __DATE__ "\r\nUsing library version " VERSION_IRREMOTE));
+
+    IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK); // Start the receiver, enable feedback LED, take LED feedback pin from the internal boards definition
+
+    Serial.print(F("Ready to receive IR signals at pin "));
+    Serial.println(IR_RECEIVE_PIN);
+}
+
+void loop() {
+    /*
+     * Check if received data is available and if yes, try to decode it.
+     * Decoded result is in the IrReceiver.decodedIRData structure.
+     */
+    if (IrReceiver.decode()) {
+
+        // Print a short summary of received data
+        IrReceiver.printIRResultShort(&Serial);
+        if (IrReceiver.decodedIRData.protocol == UNKNOWN) {
+            // We have an unknown protocol, print more info
+            IrReceiver.printIRResultRawFormatted(&Serial, true);
+        }
+        Serial.println();
+        IrReceiver.resume(); // Enable receiving of the next value
+
+        /*
+         * Finally check the received data and perform actions according to the received commands
+         */
+        if (IrReceiver.decodedIRData.command == 0x10) {
+            // do something
+        } else if (IrReceiver.decodedIRData.command == 0x11) {
+            // do something else
+        }
+    }
+}