Skip to content

Commit e8e8e10

Browse files
committed
Documentation
1 parent 0b75958 commit e8e8e10

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

.github/issue_template.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you have handling problems or questions, consider to open a discussion https://github.com/ukw100/IRMP/discussions instead of an issue.
1+
If you have handling problems or questions, consider to open a discussion https://github.com/Arduino-IRremote/Arduino-IRremote/discussions instead of an issue.
22

33
### Board
44
* [ ] Arduino ATmega328* board (UNO, Nano)
@@ -42,7 +42,7 @@ If you have handling problems or questions, consider to open a discussion https:
4242
* [ ] Other - please specify
4343

4444
### Version
45-
* [ ] Yes I use the [latest repo version](https://github.com/ukw100/IRMP/archive/master.zip) and verified this!
45+
* [ ] Yes I use the [latest repo version](https://github.com/Arduino-IRremote/Arduino-IRremote/archive/master.zip) and verified this!
4646
* [ ] Other - please specify
4747

4848
Please delete all unchecked lines above :-)

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ If you do not know which protocol your IR transmitter uses, you have several cho
8181
the old [IRLib](https://github.com/cyborg5/IRLib) and [Infrared4Arduino](https://github.com/bengtmartensson/Infrared4Arduino).
8282
- To **increase strength of sent output signal** you can increase the current through the send diode, and/or use 2 diodes in series,
8383
since one IR diode requires only 1.5 volt.
84-
- Activating line #include "ATtinySerialOut.h" in PinDefinitionsAndMore.h (requires the library to be installed) saves 370 bytes program space and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
84+
- The line #include "ATtinySerialOut.h" in PinDefinitionsAndMore.h (requires the library to be installed) saves 370 bytes program space and 38 bytes RAM for **Digispark boards** as well as enables serial output at 8MHz.
8585
- The default software generated PWM has **problems on ATtinies running with 8 MHz**. The PWM frequency is around 30 instead of 38 kHz and RC6 is not reliable. You can switch to timer PWM generation by `#define SEND_PWM_BY_TIMER`.
8686

8787
# Examples
@@ -93,8 +93,11 @@ This examples are a good starting point.
9393
### ReceiveDemo + SendDemo
9494
More complete examples for the advanced user.
9595

96+
### UnitTest
97+
ReceiveDemo + SendDemo in one program. Receiving while sending.
98+
9699
### ReceiveAndSend
97-
Like the name states...
100+
Record and play back last received IR signal at button press.
98101

99102
### MinimalReceiver + SmallReceiver
100103
If code size matters look at these examples.

examples/ReceiveAndSend/ReceiveAndSend.ino

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
/*
22
* ReceiveAndSend.cpp
33
*
4-
* Record and play back IR signals as a minimal
4+
* Record and play back last received IR signal at button press.
5+
* The logic is:
6+
* If the button is pressed, send the IR code.
7+
* If an IR code is received, record it.
8+
*
9+
* An example for simultaneous receiving and sending is in the UnitTest example.
10+
*
511
* An IR detector/demodulator must be connected to the input IR_RECEIVE_PIN.
6-
12+
*
713
* A button must be connected between the input SEND_BUTTON_PIN and ground.
814
* A visible LED can be connected to STATUS_PIN to provide status.
915
*
10-
* The logic is:
11-
* If the button is pressed, send the IR code.
12-
* If an IR code is received, record it.
1316
*
1417
* Initially coded 2009 Ken Shirriff http://www.righto.com
1518
*

0 commit comments

Comments
 (0)