Skip to content

Commit 0b16ba4

Browse files
committed
Documentation
1 parent 5e1aac8 commit 0b16ba4

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ If you do not know which protocol your IR transmitter uses, you have several cho
137137
- Use [IrScrutinizer](http://www.harctoolbox.org/IrScrutinizer.html).
138138
It can automatically generate a send sketch for your protocol by exporting as "Arduino Raw". It supports IRremote,
139139
the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino).
140-
140+
141141
# Hints
142142
- To **increase strength of sent output signal** you can increase the current through the send diode, and/or use 2 diodes in series,
143143
since one IR diode requires only 1.5 volt.
@@ -160,7 +160,9 @@ ReceiveDemo + SendDemo in one program. **Receiving while sending**.
160160
Record and play back last received IR signal at button press.
161161

162162
### MinimalReceiver + SmallReceiver
163-
If code size matters, look at these examples.
163+
If code size matters, look at these examples.<br/>
164+
MinimalReceiver can be tested online with [WOKWI](https://wokwi.com/arduino/projects/299034264157028877).
165+
Click on the receiver while simulation is running to specify individual IR codes.
164166

165167
### IRDispatcherDemo
166168
Framework for calling different functions for different IR codes.
@@ -171,6 +173,13 @@ Control a relay (connected to an output pin) with your remote.
171173
### IRremoteExtensionTest
172174
Example for a user defined class, which itself uses the IRrecv class from IRremote.
173175

176+
### ReceiverTimingAnalysis
177+
This example analyzes the signal delivered by your IR receiver module.
178+
Values can be used to determine the stability of the received signal as well as a hint for determining the protocol.<br/>
179+
It also computes the MARK_EXCESS_MICROS value, which is the extension of the mark (pulse) duration introduced by the IR receiver module.<br/>
180+
It can be tested online with [WOKWI](https://wokwi.com/arduino/projects/299033930562011656).
181+
Click on the receiver while simulation is running to specify individual IR codes.
182+
174183
# Compile options / macros for this library
175184
To customize the library to different requirements, there are some compile options / macros available.<br/>
176185
Modify it by commenting them out or in, or change the values if applicable. Or define the macro with the -D compiler option for global compile (the latter is not possible with the Arduino IDE, so consider using [Sloeber](https://eclipse.baeyens.it).

examples/ReceiverTimingAnalysis/ReceiverTimingAnalysis.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ void loop()
174174
Serial.print(MarkAndShortSpaceAverage);
175175
Serial.print(F("us Delta (to NEC standard 560)="));
176176
Serial.print(MarkAndShortSpaceAverage - 560);
177-
Serial.print(F("us\r\n Mark - Average -> MarkExcess="));
177+
Serial.print(F("us\r\n Mark - Average -> MARK_EXCESS_MICROS="));
178178
Serial.print((int16_t) Mark.average - MarkAndShortSpaceAverage);
179179
Serial.print(F("us"));
180180
Serial.println();

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ sentence=Send and receive infrared signals with multiple protocols
66
paragraph=Currently included protocols: Denon / Sharp, JVC, LG, NEC / Onkyo / Apple, Panasonic / Kaseikyo, RC5, RC6, Samsung, Sony, (Pronto), BoseWave, Lego, Whynter, MagiQuest.<br/><br/><b>New: </b><a href="https://github.com/Arduino-IRremote/Arduino-IRremote#converting-your-program-to-the-31-version">3.x upgrade instructions</a><br/>Added universal decoder for pulse width or pulse distance protocols.<br/>For all 3.x: Generation of PWM is now done by software by default, thus saving the hardware timer and enabling abitrary output pins. Removed decode_results results. Renamed most irparams_struct values. The macros FEEDBACK_LED, SYSCLOCK, SENDPIN_ON and SENDPIN_OFF are not longer used / evaluated. Major refactoring of CPU dependent and feedback LED code. Support for more CPU's.<br/>
77
category=Communication
88
url=https://github.com/Arduino-IRremote/Arduino-IRremote
9-
architectures=avr,megaavr,samd,esp8266,esp32,mbed,stm32,STM32F1
9+
architectures=avr,megaavr,samd,esp8266,esp32,stm32,STM32F1,mbed,mbed_nano
1010
includes=IRremote.h

0 commit comments

Comments
 (0)