You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,6 +107,7 @@ Protocols can be switched off and on by defining macros before the line `#includ
107
107
- Allows receiving and sending of **raw timing data**.
108
108
109
109
## New features with version 4.x
110
+
-**Since 4.3 `IrSender.begin(DISABLE_LED_FEEDBACK)` will no longer work**, use `IrSender.begin(DISABLE_LED_FEEDBACK, 0)` instead.
110
111
- New universal **Pulse Distance / Pulse Width decoder** added, which covers many previous unknown protocols.
111
112
- Printout of code how to send received command by `IrReceiver.printIRSendUsage(&Serial)`.
112
113
- RawData type is now 64 bit for 32 bit platforms and therefore `decodedIRData.decodedRawData` can contain complete frame information for more protocols than with 32 bit as before.
@@ -120,7 +121,7 @@ Protocols can be switched off and on by defining macros before the line `#includ
120
121
- The parameter `bool hasStopBit` is not longer required and removed e.g. for function `sendPulseDistanceWidth()`.
121
122
122
123
## New features with version 3.x
123
-
-**Any pin** can be used for sending -if `SEND_PWM_BY_TIMER` is not defined- and receiving.
124
+
-**Any pin** can be used for receiving and if `SEND_PWM_BY_TIMER` is not defined also for sending.
124
125
- Feedback LED can be activated for sending / receiving.
125
126
- An 8/16 bit ****command** value as well as an 16 bit **address** and a protocol number is provided for decoding (instead of the old 32 bit value).
126
127
- Protocol values comply to **protocol standards**.<br/>
@@ -147,7 +148,7 @@ If you use an (old) Arduino core that does not use the `-flto` flag for compile,
147
148
- Since the decoded values are now in `IrReceiver.decodedIRData` and not in `results` any more, remove the line `decode_results results` or similar.
148
149
- Like for the Serial object, call [`IrReceiver.begin(IR_RECEIVE_PIN, ENABLE_LED_FEEDBACK)`](https://github.com/Arduino-IRremote/Arduino-IRremote/blob/master/examples/ReceiveDemo/ReceiveDemo.ino#L106)
149
150
or `IrReceiver.begin(IR_RECEIVE_PIN, DISABLE_LED_FEEDBACK)` instead of the `IrReceiver.enableIRIn()` or `irrecv.enableIRIn()` in setup().<br/>
150
-
For sending, call `IrSender.begin();`or `IrSender.begin(DISABLE_LED_FEEDBACK);`in setup().<br/>
151
+
For sending, call `IrSender.begin();` in setup().<br/>
151
152
If IR_SEND_PIN is not defined (before the line `#include <IRremote.hpp>`) you must use e.g. `IrSender.begin(3, ENABLE_LED_FEEDBACK, USE_DEFAULT_FEEDBACK_LED_PIN);`
152
153
- Old `decode(decode_results *aResults)` function is replaced by simple `decode()`. So if you have a statement `if(irrecv.decode(&results))` replace it with `if (IrReceiver.decode())`.
153
154
- The decoded result is now in in `IrReceiver.decodedIRData` and not in `results` any more, therefore replace any occurrences of `results.value` and `results.decode_type` (and similar) to
@@ -292,6 +293,8 @@ The following macros will definitely be overridden with default values otherwise
Check for a **completly received IR frame** with:<br/>
296
299
`if (IrReceiver.decode()) {}`<br/>
297
300
This also decodes the received data.<br/>
@@ -711,7 +714,7 @@ Modify them by enabling / disabling them, or change the values if applicable.
711
714
| `USE_NO_SEND_PWM` | disabled | Uses no carrier PWM, just simulate an **active low** receiver signal. Used for transferring signal by cable instead of IR. Overrides `SEND_PWM_BY_TIMER` definition. |
712
715
| `IR_SEND_DUTY_CYCLE_PERCENT` | 30 | Duty cycle of IR send signal. |
713
716
| `USE_OPEN_DRAIN_OUTPUT_FOR_SEND_PIN` | disabled | Uses or simulates open drain output mode at send pin. **Attention, active state of open drain is LOW**, so connect the send LED between positive supply and send pin! |
714
-
| `DISABLE_CODE_FOR_RECEIVER` | disabled | Saves up to 450 bytes program memory and 269 bytes RAM if receiving functionality is not required. |
717
+
| `DISABLE_CODE_FOR_RECEIVER` | disabled | Disables static receiver code like receive timer ISR handler and static IRReceiver and irparams data. Saves 450 bytes program memory and 269 bytes RAM if receiving functions are not required. |
715
718
| `EXCLUDE_EXOTIC_PROTOCOLS` | disabled | Excludes BANG_OLUFSEN, BOSEWAVE, WHYNTER, FAST and LEGO_PF from `decode()` and from sending with `IrSender.write()`. Saves up to 650 bytes program memory. |
716
719
| `FEEDBACK_LED_IS_ACTIVE_LOW` | disabled | Required on some boards (like my BluePill and my ESP8266 board), where the feedback LED is active low. |
717
720
| `NO_LED_FEEDBACK_CODE` | disabled | Disables the LED feedback code for send and receive. Saves around 100 bytes program memory for receiving, around 500 bytes for sending and halving the receiver ISR (Interrupt Service Routine) processing time. |
0 commit comments