v1.1.1 to fix platform

### Releases v1.1.1 1. Fix platform in `library.json`
khoih-prog · Oct 22, 2021 · d897d40 · d897d40
1 parent 151c379
commit d897d40
Show file tree

Hide file tree

Showing 26 changed files with 93 additions and 150 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,8 +14,8 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 
 Please ensure to specify the following:
 
-* Arduino IDE version (e.g. 1.8.15) or Platform.io version
-* `RP2040` Core Version (e.g. RP2040 core v1.8.1)
+* Arduino IDE version (e.g. 1.8.16) or Platform.io version
+* `RP2040` Core Version (e.g. RP2040 core v1.9.5)
 * `RP2040` Board type (e.g. RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040, GENERIC_RP2040, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
@@ -27,11 +27,11 @@ Please ensure to specify the following:
 ### Example
 
 ```
-Arduino IDE version: 1.8.15
-RP2040 core v1.8.1
+Arduino IDE version: 1.8.16
+RP2040 core v1.9.5
 RASPBERRY_PI_PICO Module
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-74-generic #83-Ubuntu SMP Sat May 8 02:35:39 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-86-generic #97-Ubuntu SMP Fri Sep 17 19:19:40 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while using TimerInterrupt.

diff --git a/README.md b/README.md
@@ -16,10 +16,7 @@
   * [Why using ISR-based Hardware Timer Interrupt is better](#why-using-isr-based-hardware-timer-interrupt-is-better)
   * [Currently supported Boards](#currently-supported-boards)
   * [Important Notes about ISR](#important-notes-about-isr)
-* [Changelog](#changelog)
-  * [Releases v1.1.0](#releases-v110)
-  * [Releases v1.0.1](#releases-v101)
-  * [Initial Releases v1.0.0](#initial-releases-v100)
+* [Changelog](changelog.md)
 * [Prerequisites](#prerequisites)
 * [Installation](#installation)
   * [Use Arduino Library Manager](#use-arduino-library-manager)
@@ -60,7 +57,6 @@
   * [6. ISR_16_Timers_Array_Complex on ADAFRUIT_ITSYBITSY_RP2040](#6-isr_16_timers_array_complex-on-adafruit_itsybitsy_rp2040)
 * [Debug](#debug)
 * [Troubleshooting](#troubleshooting)
-* [Releases](#releases)
 * [Issues](#issues)
 * [TO DO](#to-do)
 * [DONE](#done)
@@ -129,30 +125,11 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
 ---
 ---
 
-## Changelog
-
-### Releases v1.1.0
-
-1. Add support to new boards (**ADAFRUIT_ITSYBITSY_RP2040, ADAFRUIT_QTPY_RP2040, ADAFRUIT_STEMMAFRIEND_RP2040, ADAFRUIT_TRINKEYQT_RP2040, ADAFRUIT_MACROPAD_RP2040, SPARKFUN_PROMICRO_RP2040, etc.**) using the arduino-pico core
-2. Add `ISR_16_Timers_Array_Complex` examples.
-3. Fix examples' bug
-
-### Releases v1.0.1
-
-1. Update README and Packages' Patches to match core arduino-pico core v1.4.0
-
-### Initial Releases v1.0.0
-
-1. Initial coding to support RP2040-based boards such as **RASPBERRY_PI_PICO**, etc. using [**Earle Philhower's arduino-pico** core](https://github.com/earlephilhower/arduino-pico)
-
-
----
----
 
 ## Prerequisites
 
-1. [`Arduino IDE 1.8.15+` for Arduino](https://www.arduino.cc/en/Main/Software)
-2. [`Earle Philhower's arduino-pico core v1.9.4+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [![GitHub release](https://img.shields.io/github/release/earlephilhower/arduino-pico.svg)](https://github.com/earlephilhower/arduino-pico/releases/latest)
+1. [`Arduino IDE 1.8.16+` for Arduino](https://www.arduino.cc/en/Main/Software)
+2. [`Earle Philhower's arduino-pico core v1.9.5+`](https://github.com/earlephilhower/arduino-pico) for RP2040-based boards such as **RASPBERRY_PI_PICO, ADAFRUIT_FEATHER_RP2040 and GENERIC_RP2040**, etc. [![GitHub release](https://img.shields.io/github/release/earlephilhower/arduino-pico.svg)](https://github.com/earlephilhower/arduino-pico/releases/latest)
 
 ---
 ---
@@ -609,7 +586,7 @@ While software timer, **programmed for 2s, is activated after more than 10.000s
 
 ```
 Starting ISR_Timers_Array_Simple on RASPBERRY_PI_PICO
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 1 , _fre = 1000000.00
 [TISR] _count = 0 - 1000
@@ -638,7 +615,7 @@ The following is the sample terminal output when running example [TimerInterrupt
 
 ```
 Starting TimerInterruptTest on RASPBERRY_PI_PICO
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 0 , _fre = 1000000.00
 [TISR] _count = 0 - 1000000
@@ -682,7 +659,7 @@ The following is the sample terminal output when running example [Change_Interva
 
 ```
 Starting Change_Interval on RASPBERRY_PI_PICO
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 0 , _fre = 1000000.00
 [TISR] _count = 0 - 2000000
@@ -763,7 +740,7 @@ The following is the sample terminal output when running example [SwitchDebounce
 
 ```
 Starting SwitchDebounce on RASPBERRY_PI_PICO
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 0 , _fre = 1000000.00
 [TISR] _count = 0 - 20000
@@ -789,7 +766,7 @@ The following is the sample terminal output when running example [ISR_Timers_Arr
 ```
 
 Starting ISR_Timers_Array_Simple on ADAFRUIT_FEATHER_RP2040
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 1 , _fre = 1000000.00
 [TISR] _count = 0 - 1000
@@ -813,7 +790,7 @@ The following is the sample terminal output when running example [ISR_16_Timers_
 ```
 
 Starting ISR_16_Timers_Array_Complex on ADAFRUIT_ITSYBITSY_RP2040
-RPi_Pico_TimerInterrupt v1.1.0
+RPi_Pico_TimerInterrupt v1.1.1
 CPU Frequency = 125 MHz
 [TISR] RPI_PICO_TimerInterrupt: _timerNo = 1 , _fre = 1000000.00
 [TISR] _count = 0 - 10000
@@ -983,25 +960,6 @@ If you get compilation errors, more often than not, you may need to install a ne
 Sometimes, the library will only work if you update the board core to the latest version because I am using newly added functions.
 
 
----
----
-
-## Releases
-
-### Releases v1.1.0
-
-1. Add support to new boards (**ADAFRUIT_ITSYBITSY_RP2040, ADAFRUIT_QTPY_RP2040, ADAFRUIT_STEMMAFRIEND_RP2040, ADAFRUIT_TRINKEYQT_RP2040, ADAFRUIT_MACROPAD_RP2040, SPARKFUN_PROMICRO_RP2040, etc.**) using the arduino-pico core
-2. Add `ISR_16_Timers_Array_Complex` examples.
-3. Fix examples' bug
-
-### Releases v1.0.1
-
-1. Update README and Packages' Patches to match core arduino-pico core v1.4.0
-
-### Initial Releases v1.0.0
-
-1. Initial coding to support **RP2040-based boards such as RASPBERRY_PI_PICO**, etc. using [**Earle Philhower's arduino-pico** core](https://github.com/earlephilhower/arduino-pico)
-
 ---
 ---
 

diff --git a/changelog.md b/changelog.md
@@ -0,0 +1,45 @@
+# RPI_PICO_TimerInterrupt Library
+
+[![arduino-library-badge](https://www.ardu-badge.com/badge/RPI_PICO_TimerInterrupt.svg?)](https://www.ardu-badge.com/RPI_PICO_TimerInterrupt)
+[![GitHub release](https://img.shields.io/github/release/khoih-prog/RPI_PICO_TimerInterrupt.svg)](https://github.com/khoih-prog/RPI_PICO_TimerInterrupt/releases)
+[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/khoih-prog/RPI_PICO_TimerInterrupt/blob/master/LICENSE)
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
+[![GitHub issues](https://img.shields.io/github/issues/khoih-prog/RPI_PICO_TimerInterrupt.svg)](http://github.com/khoih-prog/RPI_PICO_TimerInterrupt/issues)
+
+---
+---
+
+## Table of Contents
+
+* [Changelog](#changelog)
+  * [Releases v1.1.1](#releases-v111)
+  * [Releases v1.1.0](#releases-v110)
+  * [Releases v1.0.1](#releases-v101)
+  * [Initial Releases v1.0.0](#initial-releases-v100)
+
+
+---
+---
+
+## Changelog
+
+### Releases v1.1.1
+
+1. Fix platform in `library.json`
+
+### Releases v1.1.0
+
+1. Add support to new boards (**ADAFRUIT_ITSYBITSY_RP2040, ADAFRUIT_QTPY_RP2040, ADAFRUIT_STEMMAFRIEND_RP2040, ADAFRUIT_TRINKEYQT_RP2040, ADAFRUIT_MACROPAD_RP2040, SPARKFUN_PROMICRO_RP2040, etc.**) using the arduino-pico core
+2. Add `ISR_16_Timers_Array_Complex` examples.
+3. Fix examples' bug
+
+### Releases v1.0.1
+
+1. Update README and Packages' Patches to match core arduino-pico core v1.4.0
+
+### Initial Releases v1.0.0
+
+1. Initial coding to support RP2040-based boards such as **RASPBERRY_PI_PICO**, etc. using [**Earle Philhower's arduino-pico** core](https://github.com/earlephilhower/arduino-pico)
+
+
+
diff --git a/examples/Argument_Complex/Argument_Complex.ino b/examples/Argument_Complex/Argument_Complex.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 
 // These define's must be placed at the beginning before #include "TimerInterrupt_Generic.h"

diff --git a/examples/Argument_None/Argument_None.ino b/examples/Argument_None/Argument_None.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 
 /*

diff --git a/examples/Argument_Simple/Argument_Simple.ino b/examples/Argument_Simple/Argument_Simple.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
  *****************************************************************************************************************************/
 
 // These define's must be placed at the beginning before #include "TimerInterrupt_Generic.h"

diff --git a/examples/Change_Interval/Change_Interval.ino b/examples/Change_Interval/Change_Interval.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 
 /*

diff --git a/examples/ISR_16_Timers_Array_Complex/ISR_16_Timers_Array_Complex.ino b/examples/ISR_16_Timers_Array_Complex/ISR_16_Timers_Array_Complex.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 /*
    Notes:

diff --git a/examples/ISR_Timers_Array_Simple/ISR_Timers_Array_Simple.ino b/examples/ISR_Timers_Array_Simple/ISR_Timers_Array_Simple.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 
 // These define's must be placed at the beginning before #include "TimerInterrupt_Generic.h"

diff --git a/examples/RPM_Measure/RPM_Measure.ino b/examples/RPM_Measure/RPM_Measure.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 /*
    Notes:

diff --git a/examples/SwitchDebounce/SwitchDebounce.ino b/examples/SwitchDebounce/SwitchDebounce.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 /*
    Notes:

diff --git a/examples/TimerInterruptTest/TimerInterruptTest.ino b/examples/TimerInterruptTest/TimerInterruptTest.ino
@@ -25,14 +25,6 @@
 
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
-
-  Version: 1.1.0
-
-  Version Modified By   Date      Comments
-  ------- -----------  ---------- -----------
-  1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
-  1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
-  1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
 *****************************************************************************************************************************/
 /*
    Notes:

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
   "name": "RPI_PICO_TimerInterrupt",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "keywords": "timing, device, control, timer, interrupt, hardware, isr, isr-based, hardware-timer, mission-critical, accuracy, precise, non-blocking, raspberry-pico, rpi-pico, pico, rp2040, arduino-pico",
   "description": "This library enables you to use Interrupt from Hardware Timers on RP2040-based boards such as RASPBERRY_PI_PICO. It now supports 16 ISR-based timers, while consuming only 1 Hardware Timer. Timers' interval is very long (ulong millisecs). The most important feature is they're ISR-based timers. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These hardware timers, using interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's necessary if you need to measure some data requiring better accuracy.",
   "authors":
@@ -23,7 +23,7 @@
     ]
   },
   "frameworks": "*",
-  "platforms": "rp2040",
+  "platforms": ["raspberrypi"],
   "examples": "examples/*/*/*.ino",
   "license": "MIT"
 }
diff --git a/library.properties b/library.properties
@@ -1,10 +1,10 @@
 name=RPI_PICO_TimerInterrupt
-version=1.1.0
+version=1.1.1
 author=Khoi Hoang <[email protected]>
 maintainer=Khoi Hoang <[email protected]>
 sentence=This library enables you to use Interrupt from Hardware Timers on RP2040-based boards such as RASPBERRY_PI_PICO
 paragraph=These RPI_PICO_TimerInterrupt Hardware Timers, using Interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's mandatory if you need to measure some data requiring better accuracy. It now supports 16 ISR-based Timers, while consuming only 1 Hardware Timer. Timers' interval is very long (ulong millisecs). The most important feature is they're ISR-based Timers. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks.
-category=Timing, Control, Device, Time, Timer
+category=Device Control
 url=https://github.com/khoih-prog/RPI_PICO_TimerInterrupt
 architectures=rp2040
 repository=https://github.com/khoih-prog/RPI_PICO_TimerInterrupt

diff --git a/src/RPi_Pico_ISR_Timer-Impl.h b/src/RPi_Pico_ISR_Timer-Impl.h
@@ -25,13 +25,14 @@
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
 
-  Version: 1.1.0
+  Version: 1.1.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K Hoang      11/05/2021 Initial coding to support RP2040-based boards such as RASPBERRY_PI_PICO. etc.
   1.0.1   K Hoang      18/05/2021 Update README and Packages' Patches to match core arduino-pico core v1.4.0
   1.1.0   K Hoang      10/00/2021 Add support to new boards using the arduino-pico core
+  1.1.1   K Hoang      22/10/2021 Fix platform in library.json for PIO
 *****************************************************************************************************************************/
 
 #pragma once