Skip to content

Commit 11b8832

Browse files
committed
Documentation
1 parent 052e160 commit 11b8832

File tree

4 files changed

+84
-66
lines changed

4 files changed

+84
-66
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ Protocols can be switched off and on by changing the lines in *IRremote.h*:
3030
#define DECODE_<PROTOCOL_NAME> 1
3131
#define SEND_<PROTOCOL_NAME> 1
3232
```
33+
# [Wiki](https://github.com/z3t0/Arduino-IRremote/wiki)
34+
[Here](https://github.com/z3t0/Arduino-IRremote/wiki) is a quite old but maybe useful wiki for this library.
3335

3436
# Compile options / macros for this library
3537
To customize the library to different requirements, there are some compile options / makros available.<br/>
36-
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).
38+
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).
3739

3840
| Name | File | Default value | Description |
3941
|-|-|-|-|
@@ -47,6 +49,15 @@ Modify it by commenting them out or in, or change the values if applicable. Or d
4749
| `IR_SEND_DUTY_CYCLE` | IRremoteBoardDefs.h | 30 | Duty cycle of IR send signal. |
4850
| `MICROS_PER_TICK` | IRremoteBoardDefs.h | 50 | Resolution of the raw input buffer data. |
4951

52+
### Modifying library properties with Arduino IDE
53+
First use *Sketch/Show Sketch Folder (Ctrl+K)*.<br/>
54+
If you did not yet stored the example as your own sketch, then you are instantly in the right library folder.<br/>
55+
Otherwise you have to navigate to the parallel `libraries` folder and select the library you want to access.<br/>
56+
In both cases the library files itself are located in the `src` directory.<br/>
57+
58+
### Modifying library properties with Sloeber IDE
59+
If you are using Sloeber as your IDE, you can easily define global symbols with *Properties/Arduino/CompileOptions*.<br/>
60+
![Sloeber settings](https://github.com/ArminJo/ServoEasing/blob/master/pictures/SloeberDefineSymbols.png)
5061

5162
# Handling unknown Protocols
5263
## Disclaimer
@@ -86,7 +97,7 @@ The timer and the pin usage can be adjusted in [IRremoteBoardDefs.h](src/private
8697
| Board/CPU | IR-Send (PWM) Pin | Timers |
8798
|--------------------------------------------------------------------------|---------------------|-------------------|
8899
| [ATtiny84](https://github.com/SpenceKonde/ATTinyCore) | **6** | **1** |
89-
| [ATtiny85 > 1 MHz](https://github.com/SpenceKonde/ATTinyCore) | **1** | **0** |
100+
| [ATtiny85 > 1 MHz](https://github.com/SpenceKonde/ATTinyCore) | **1**, 4 | **0**, 1 |
90101
| [ATmega8](https://github.com/MCUdude/MiniCore) | **9** | **1** |
91102
| [ATmega48, ATmega88, ATmega168, **ATmega328**](https://github.com/MCUdude/MiniCore) | **3**, 9 | 1, **2** |
92103
| [ATmega1284](https://github.com/MCUdude/MightyCore) | 13, 14, 6 | 1, **2**, 3 |
@@ -110,8 +121,7 @@ The timer and the pin usage can be adjusted in [IRremoteBoardDefs.h](src/private
110121
Please see [changelog.md](https://github.com/z3t0/Arduino-IRremote/blob/master/changelog.md).
111122

112123
## API documentation
113-
This project documents the library API using [Doxygen](http://www.doxygen.org).
114-
It is planned to make generated and up-to-date API documentation available online.
124+
See [API reference in wiki](https://github.com/z3t0/Arduino-IRremote/wiki/API-Reference).
115125

116126
To generate the API documentation,
117127
Doxygen, as well as [Graphviz](http://www.graphviz.org/) should be installed.

changelog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 2.7.1 2020/10
2+
- Added ATtiny timer 1 support.
3+
14
## 2.7.0 2020/09
25
- Added ATmega328PB support.
36
- Renamed hardware specific macro and function names.

src/nRF5.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#if defined (NRF5) || defined (ARDUINO_ARCH_NRF52840)
1+
#if defined(NRF5) || defined(ARDUINO_ARCH_NRF52840)
22

33
// This file contains functions specific to the nRF5.
44
// It uses Timer2 so you cannot use the Adafruit_Microbit display driver

0 commit comments

Comments
 (0)