Housekeeping

IRMP-org · Dec 3, 2021 · 9de71e8 · 9de71e8
1 parent 0c7caca
commit 9de71e8
Show file tree

Hide file tree

Showing 34 changed files with 837 additions and 545 deletions.
diff --git a/.github/issue_template.md b/.github/issue_template.md
@@ -1,6 +1,6 @@
 ---
 name: 🐛 Bug Report
-about: If something isn't working as expected 🤔.
+about: Only if something isn't working as expected 🤔, otherwise please open a discussion.
 assignees: ArminJo
 ---
 

diff --git a/.github/workflows/LibraryBuild.yml b/.github/workflows/LibraryBuild.yml
@@ -13,8 +13,15 @@ on:
     - '**.ino'
     - '**.cpp'
     - '**.h'
+    - '**.hpp'
     - '**LibraryBuild.yml'
   pull_request:
+    paths:
+    - '**.ino'
+    - '**.cpp'
+    - '**.h'
+    - '**.hpp'
+    - '**LibraryBuild.yml'
 
 jobs:
   build:
@@ -30,7 +37,7 @@ jobs:
         # Examples: arduino:avr:uno, arduino:avr:leonardo, arduino:avr:nano, arduino:avr:mega
         # arduino:sam:arduino_due_x, arduino:samd:arduino_zero_native"
         # ATTinyCore:avr:attinyx5:chip=85,clock=1internal, digistump:avr:digispark-tiny, digistump:avr:digispark-pro
-        # STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
+        # STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8
         # esp8266:esp8266:huzzah:eesz=4M3M,xtal=80, esp32:esp32:featheresp32:FlashFreq=80
         # You may add a suffix behind the fqbn with "|" to specify one board for e.g. different compile options like arduino:avr:uno|trace
         #############################################################################################################
@@ -42,7 +49,6 @@ jobs:
           - arduino:samd:arduino_zero_native
           - arduino:mbed:nano33ble
           - digistump:avr:digispark-tiny:clock=clock16
-          - digistump:avr:digispark-pro
           - ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=8pll
           - ATTinyCore:avr:attinyx7micr:LTO=enable,sketchclock=16external,pinmapping=new,millis=enabled
           - TinyCore:avr:tiny32
@@ -51,8 +57,8 @@ jobs:
 #          - MegaCore:avr:128:bootloader=no_bootloader,eeprom=keep,BOD=2v7,LTO=Os,clock=8MHz_internal # ATmega128
           - esp8266:esp8266:d1_mini:eesz=4M3M,xtal=80
           - esp32:esp32:featheresp32:FlashFreq=80
-          - STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
-          - STM32:stm32:GenL0:pnum=THUNDERPACK_L072
+          - STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8
+          - STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072
           - stm32duino:STM32F1:genericSTM32F103C
           - SparkFun:apollo3:sfe_artemis_nano
 
@@ -68,11 +74,6 @@ jobs:
             required-libraries: ATtinySerialOut
             sketches-exclude: AllProtocols,SendAllProtocols,ReceiveAndSendDynamicPins,ReceiverTimingAnalysis # Does not fit in FLASH # Comma separated list of example names to exclude in build
 
-          - arduino-boards-fqbn: digistump:avr:digispark-pro
-            platform-url: https://raw.githubusercontent.com/ArminJo/DigistumpArduino/master/package_digistump_index.json
-            required-libraries: ATtinySerialOut
-            sketches-exclude: ReceiveAndSendDynamicPins # No Serial.available() function in ATtinySerialOut
-
           - arduino-boards-fqbn: ATTinyCore:avr:attinyx5micr:LTO=enable,sketchclock=8pll
             platform-url: http://drazzy.com/package_drazzy.com_index.json
             required-libraries: ATtinySerialOut
@@ -102,15 +103,15 @@ jobs:
             sketches-exclude: MinimalReceiver,AllProtocols # error ".text1' will not fit in region `iram1_0_seg'"
 
           - arduino-boards-fqbn: esp32:esp32:featheresp32:FlashFreq=80
-            platform-url: https://dl.espressif.com/dl/package_esp32_index.json
+            platform-url: https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
             sketches-exclude: MinimalReceiver
 
-          - arduino-boards-fqbn: STM32:stm32:GenF1:pnum=BLUEPILL_F103C8
-            platform-url: https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json
+          - arduino-boards-fqbn: STMicroelectronics:stm32:GenF1:pnum=BLUEPILL_F103C8
+            platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json
             sketches-exclude: MinimalReceiver
 
-          - arduino-boards-fqbn: STM32:stm32:GenL0:pnum=THUNDERPACK_L072
-            platform-url: https://github.com/stm32duino/BoardManagerFiles/raw/master/STM32/package_stm_index.json
+          - arduino-boards-fqbn: STMicroelectronics:stm32:GenL0:pnum=THUNDERPACK_L072
+            platform-url: https://raw.githubusercontent.com/stm32duino/BoardManagerFiles/main/package_stmicroelectronics_index.json
             sketches-exclude: MinimalReceiver,IRDispatcherDemo
 
           - arduino-boards-fqbn: stm32duino:STM32F1:genericSTM32F103C # Roger Clark version

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Available as Arduino library "IRMP"
 [![Installation instructions](https://www.ardu-badge.com/badge/irmp.svg?)](https://www.ardu-badge.com/IRMP)
 [![Commits since latest](https://img.shields.io/github/commits-since/ukw100/irmp/latest)](https://github.com/ukw100/irmp/commits/master)
 [![Build Status](https://github.com/ukw100/irmp/workflows/LibraryBuild/badge.svg)](https://github.com/ukw100/irmp/actions)
-[![Hit Counter](https://hitcounter.pythonanywhere.com/count/tag.svg?url=https%3A%2F%2Fgithub.com%2Fukw100%2FIRMP)](https://github.com/brentvollebregt/hit-counter)
+[![Hit Counter](https://hitcounter.pythonanywhere.com/count/tag.svg?url=https://github.com/ukw100/IRMP)](https://github.com/brentvollebregt/hit-counter)
 
 ## 50 IR protocols supported and low memory footprint
 - Only 39 protocols can be enabled for receive at the same time, because some of them are quite similar and conflicts with each other.
@@ -39,7 +39,7 @@ Available as Arduino library "IRMP"
 - Send IR frequency is fixed at 38 kHz.
 
 # Minimal version
-For applications only requiring NEC protocol, there is a receiver which has very **small codesize of 500 bytes and does NOT require any timer**. See the MinimalReceiver and IRDispatcherDemo example how to use it. Mapping of pins to interrupts can be found [here](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/src/TinyIRReceiver.hpp#L307).
+For applications only requiring NEC protocol, there is a receiver which has very **small codesize of 500 bytes and does NOT require any timer**. See the MinimalReceiver and IRDispatcherDemo example how to use it. Mapping of pins to interrupts can be found [here](https://github.com/Arduino-IRremote/Arduino-IRremote/tree/master/src/TinyIRReceiver.hpp#L259).
 
 # Schematic for Arduino UNO
 The VS1838B is used as receiver for all examples and tests. This module has a 120 µs on/low and a 100 µs off/high delay between received signal and output. So it shortens the mark and extends the space by 20 µs.
@@ -82,8 +82,8 @@ It is dated from **03.02.2021**. If you have complains about the data or request
 | FLASH usage (simple NEC example with 5 prints) | 1820<br/>(4300 for 15 main / 8000 for all 40 protocols)<br/>(+200 for callback)<br/>(+80 for interrupt at pin 2+3)| 1270<br/>(1400 for pin 2+3) | 4830 | 1770 | **900** |
 | RAM usage | 52<br/>(73 / 100 for 15 (main) / 40 protocols) | 62 | 334 | 227 | **19** |
 | Supported platforms | **avr, megaAVR, attiny, Digispark (Pro), esp8266, ESP32, STM32, SAMD 21, Apollo3<br/>(plus arm and pic for non Arduino IDE)** | avr, esp8266 | avr, SAMD 21, SAMD 51 | avr, attiny, [esp8266](https://github.com/crankyoldgit/IRremoteESP8266), esp32, SAM, SAMD | **All platforms with attachInterrupt()** |
-| Last library update | 2/2021 | 4/2018 | 9/2019 | 2/2021 | 2/2021 |
-| Remarks | Decodes 40 protocols concurrently.<br/>39 Protocols to send.<br/>Work in progress. | Only one protocol at a time. | Consists of 5 libraries. **Project containing bugs - 45 issues, no reaction for at least one year.** | Decoding and sending are easy to extend.<br/>Supports **Pronto** codes. | Requires no timer. |
+| Last library update | 2/2021 | 4/2018 | 9/2019 | 10/2021 | 10/2021 |
+| Remarks | Decodes 40 protocols concurrently.<br/>39 Protocols to send. | Only one protocol at a time. | Consists of 5 libraries. **Project containing bugs - 45 issues, no reaction for at least one year.** | Decoding and sending are easy to extend.<br/>Supports **Pronto** codes.<br/>Work in progress. | Requires no timer. |
 
 \* The Hash protocol gives you a hash as code, which may be sufficient to distinguish your keys on the remote, but may not work with some protocols like Mitsubishi
 
@@ -102,7 +102,7 @@ Sending the IR signal starts with saving current timer configuration, setting th
 # API
 ### IRMP
 
-```
+```c++
 // Init functions
 void irmp_init (void);
 void irmp_init(uint_fast8_t aIrmpInputPin);
@@ -123,7 +123,7 @@ void irmp_result_print(IRMP_DATA *aIRMPDataPtr);
 ```
 ### IRSND
 
-```
+```c++
 // Init functions
 void irsnd_init (void);
 // 3 additional init functions if IRMP_IRSND_ALLOW_DYNAMIC_PINS is defined
@@ -141,7 +141,7 @@ void irsnd_stop (void);
 ```
 ### IRMP and IRSND
 
-```
+```c++
 // LED feedback function
 void irmp_irsnd_LEDFeedback(bool aEnableBlinkLed);