Documentation

Author: ArminJo

README.md

@@ -4,6 +4,7 @@ Available as Arduino library "IRremote"
 ### [Version 2.7.0](https://github.com/z3t0/Arduino-IRremote/releases)
 
 [![License: GPL v2](https://img.shields.io/badge/License-GPLv2-blue.svg)](https://www.gnu.org/licenses/gpl-2.0)
+[![Commits since latest](https://img.shields.io/github.amrom.workers.devmits-since/z3t0/Arduino-IRremote/latest)](https://github.com/z3t0/Arduino-IRremote/commits/master)
 [![Installation instructions](https://www.ardu-badge.com/badge/IRremote.svg?)](https://www.ardu-badge.com/IRremote)
 [![Join the chat at https://gitter.im/z3t0/Arduino-IRremote](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/z3t0/Arduino-IRremote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![LibraryBuild](https://github.com/z3t0/Arduino-IRremote/workflows/LibraryBuild/badge.svg)](https://github.com/z3t0/Arduino-IRremote/actions)
@@ -30,8 +31,10 @@ Protocols can be switched off and on by changing the lines in *IRremote.h*:
 #define SEND_<PROTOCOL_NAME>    1
 ```
 
-# Useful defines
-You may modify the behavior of the library by changing this values in the source code or just defining a new value for compile (the latter is not possible with the Arduino IDE, so consider to use [sloeber](https://eclipse.baeyens.it).
+# Compile options / macros for this library
+To customize the library to different requirements, there are some compile options / makros available.<br/>
+Modify it by commenting them out or in, or change the values if applicable. Or define the macro with the -D compiler option for gobal compile (the latter is not possible with the Arduino IDE, so consider to use [sloeber](https://eclipse.baeyens.it).
+
 | Name | File | Default value | Description |
 |-|-|-|-|
 | `DEBUG` | IRremote.h | disabled | Enables lots of lovely debug output. |
@@ -53,12 +56,12 @@ The main reason is, that it was designed to fit inside MCUs with relatively low
 ## Hints
 If you do not know which protocol your IR transmitter uses, you have several choices.
 - Use the [IRreceiveDumpV2 example](examples/IRreceiveDumpV2) to dump out the IR timing. You can then reproduce/send this timing with the [IRsendRawDemo example](examples/IRsendRawDemo). For **long codes** like from air conditioners, you can **change the length of the input buffer** in [IRremoteInt.h](src/private/IRremoteInt.h#L30).
-- If you have a bigger Arduino board at hand (> 100 kByte program space) you can try the [IRremoteDecode example](https://github.com/bengtmartensson/Arduino-DecodeIR/blob/master/examples/IRremoteDecode/IRremoteDecode.ino) of the Arduino library DecodeIR.
+- If you have a bigger Arduino board at hand (> 100 kByte program space) you can try the [IRremoteDecode example](https://github.com/bengtmartensson/Arduino-DecodeIR/blob/master/examples/IRremoteDecode/IRremoteDecode.ino) of the Arduino library [DecodeIR](https://github.com/bengtmartensson/Arduino-DecodeIR).
 - Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html). It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote, the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino).
-- Use the [IRMP AllProtocol example](https://github.com/ukw100/IRMP#allprotocol-example) and check the serial output if the protocol is one of the 40 supported protocols.
+- Use the [IRMP AllProtocol example](https://github.com/ukw100/IRMP#allprotocol-example) and you will see some serial output if the protocol is one of the 40 supported protocols.
 
 ## Other IR libraries
-[Here](https://github.com/ukw100/IRMP#quick-comparison-of-4-arduino-ir-receiving-libraries) you find a short comparison matrix of 4 popular Arduino IR libraries.<br/>
+[Here](https://github.com/ukw100/IRMP#quick-comparison-of-4-arduino-ir-receiving-libraries) you find a **short comparison matrix** of 4 popular Arduino IR libraries.<br/>
 [Here](https://github.com/crankyoldgit/IRremoteESP8266) you find an **ESP8266/ESP32** version of IRremote with an **[impressive list of supported protocols](https://github.com/crankyoldgit/IRremoteESP8266/blob/master/SupportedProtocols.md)**.
 
 # Supported Boards

changelog.md

@@ -1,7 +1,7 @@
 ## 2.7.0 2020/09
 - Added ATmega328PB support.
 - Renamed hardware specific macro and function names.
-- Renamed `USE_SOFT_CARRIER` and `USE_NO_CARRIER` macros to `USE_SOFT_SEND_PWM` and `USE_NO_SEND_PWM`.
+- Renamed `USE_SOFT_CARRIER`, `USE_NO_CARRIER`, `DUTY_CYCLE` macros to `USE_SOFT_SEND_PWM`, `USE_NO_SEND_PWM`, `IR_SEND_DUTY_CYCLE`.
 - Removed blocking wait for ATmega32U4 Serial in examples.
 - Deactivated default debug output.
 - Optimized types in sendRC5ext and sendSharpAlt.

src/IRremote.h

@@ -181,10 +181,10 @@ struct decode_results {
     unsigned int magnitude;     ///< Used by MagiQuest [16-bits]
     bool isRepeat;              ///< True if repeat of value is detected
 
-    // next 3 values are copies of irparams values
+    // next 3 values are copies of irparams values - see IRremoteint.h
     unsigned int *rawbuf;       ///< Raw intervals in 50uS ticks
     unsigned int rawlen;        ///< Number of records in rawbuf
-    bool overflow;               ///< true if IR raw code too long
+    bool overflow;              ///< true if IR raw code too long
 };
 
 /**

src/ir_Denon.cpp

@@ -81,24 +81,6 @@ bool IRrecv::decodeDenon() {
 
     // Read the bits in
     data = decodePulseDistanceData(DENON_BITS, offset, DENON_BIT_MARK, DENON_ONE_SPACE, DENON_ZERO_SPACE);
-//    for (int i = 0; i < DENON_BITS; i++) {
-//        // Each bit looks like: MARK + SPACE_1 -> 1
-//        //                 or : MARK + SPACE_0 -> 0
-//        if (!MATCH_MARK(results.rawbuf[offset], DENON_BIT_MARK)) {
-//            return false;
-//        }
-//        offset++;
-//
-//        // IR data is big-endian, so we shuffle it in from the right:
-//        if (MATCH_SPACE(results.rawbuf[offset], DENON_ONE_SPACE)) {
-//            data = (data << 1) | 1;
-//        } else if (MATCH_SPACE(results.rawbuf[offset], DENON_ZERO_SPACE)) {
-//            data = (data << 1) | 0;
-//        } else {
-//            return false;
-//        }
-//        offset++;
-//    }
 
     // Success
     results.bits = DENON_BITS;

src/ir_LG.cpp

@@ -38,21 +38,6 @@ bool IRrecv::decodeLG() {
     offset++;
 
     data = decodePulseDistanceData(LG_BITS, offset, LG_BIT_MARK, LG_ONE_SPACE, LG_ZERO_SPACE);
-//    for (int i = 0; i < LG_BITS; i++) {
-//        if (!MATCH_MARK(results.rawbuf[offset], LG_BIT_MARK)) {
-//            return false;
-//        }
-//        offset++;
-//
-//        if (MATCH_SPACE(results.rawbuf[offset], LG_ONE_SPACE)) {
-//            data = (data << 1) | 1;
-//        } else if (MATCH_SPACE(results.rawbuf[offset], LG_ZERO_SPACE)) {
-//            data = (data << 1) | 0;
-//        } else {
-//            return false;
-//        }
-//        offset++;
-//    }
 
     // Stop bit
     if (!MATCH_MARK(results.rawbuf[offset], LG_BIT_MARK)) {

src/ir_NEC.cpp

@@ -113,7 +113,7 @@ void IRsend::sendNECStandard(uint16_t aAddress, uint8_t aCommand, uint8_t aNumbe
 #if DECODE_NEC
 bool IRrecv::decodeNEC() {
     long data = 0;  // We decode in to here; Start with nothing
-    int offset = 1;  // Index in to results; Skip first entry!?
+    int offset = 1;  // Index in to results; Skip first space.
 
 // Check header "mark"
     if (!MATCH_MARK(results.rawbuf[offset], NEC_HEADER_MARK)) {
@@ -163,7 +163,7 @@ bool IRrecv::decodeNEC(decode_results *aResults) {
 #if DECODE_NEC_STANDARD
 bool IRrecv::decodeNECStandard() {
     long data = 0;  // We decode in to here; Start with nothing
-    int offset = 1;  // Index in to results; Skip first entry!?
+    int offset = 1;  // Index in to results; Skip first space.
 
     // Check header "mark"
     if (!MATCH_MARK(results.rawbuf[offset], NEC_HEADER_MARK)) {

src/private/IRremoteInt.h

@@ -51,7 +51,7 @@ struct irparams_struct {
     uint8_t blinkflag;              ///< true -> enable blinking of pin on IR processing
     unsigned int rawlen;            ///< counter of entries in rawbuf
     unsigned int timer;             ///< State timer, counts 50uS ticks.
-    unsigned int rawbuf[RAW_BUFFER_LENGTH];  ///< raw data
+    unsigned int rawbuf[RAW_BUFFER_LENGTH];  ///< raw data, first entry is the length of the gap between previous and current command
     uint8_t overflow;               ///< Raw buffer overflow occurred
 };