支持运行时指定重复次数

Author: Ebola-Chan-bot

README.md

@@ -3,7 +3,7 @@
 
 音响、方波、延迟任务、定时重复，这些任务都需要应用开发板上的计时器才能完成。有时你甚至需要多个计时器同步运行，实现多线程任务。但是，当前Arduino社区并没有提供比较完善的计时器运行库。它们能够执行的任务模式非常有限，而且用户无法指定具体要使用哪个计时器。其结果就是，经常有一些使用计时器的库发生冲突，或者和用户自己的应用发生冲突。本项目旨在将计时器可能需要使用的所有功能在所有计时器上实现，最关键的是允许用户手动指定要是用的硬件计时器，避免冲突。
 
-**由于作者精力有限，目前本项目所有函数，仅时长参数可以在运行时动态设置，其它参数必须为编译期常量，作为模板参数。后续有空会实现更多可以动态设置参数的API。当然更欢迎上GitHub主页贡献Pull request。**
+**由于作者精力有限，目前本项目所有函数，仅时长、重复次数参数可以在运行时动态设置，其它参数必须为编译期常量，作为模板参数。后续有空会实现更多可以动态设置参数的API。当然更欢迎上GitHub主页贡献Pull request。**
 # 硬件计时器
 本库所有公开API的第一个模板参数，都是计时器的编号。不同计时器之间完全独立运行，互不干扰。用户必须在代码中手动指定要使用哪个硬件计时器来执行功能。不同CPU中的计时器数目和属性各不相同，此处以Arduino Mega开发板上常用的ATMega2560系列CPU为例：
 ## 计时器0
@@ -24,7 +24,7 @@ Make full use of all your hardware timers on your Arduino board.
 
 The only library you can choose any hardware timer you like to use in your timing function. Tones, square waves, delayed tasks, timed repetitive tasks are provided as building blocks for your own sophisticated multi-timer tasks. My library hides hardware register details for you.
 
-**Currently, for all APIs, only time length arguments can be specified at runtime. Other arguments are all template arguments, i.e., they must be known as constexprs at compiling time. I'll implement more runtime arguments if I have more free time. Pull requests are fully welcomed on my GitHub site.**
+**Currently, for all APIs, only time length and RepeatTimes arguments can be specified at runtime. Other arguments are all template arguments, i.e., they must be known as constexprs at compiling time. I'll implement more runtime arguments if I have more free time. Pull requests are fully welcomed on my GitHub site.**
 # Timers
 All public APIs are under namespace TimersOneForAll, and require TimerCode as the first template argument. TimerCode indicates which hardware timer you want to use. Hardware timers vary by CPUs. For ATMega2560 (Arduino Mega), there're 6 timers:
 ## Timer 0
@@ -65,6 +65,9 @@ void RepeatAfter();
 //Specify milliseconds at runtime. After all repeats done, DoneCallback is called.
 template <uint8_t TimerCode, void (*DoTask)(), int32_t RepeatTimes, void (*DoneCallback)() = nullptr>
 void RepeatAfter(uint16_t IntervalMilliseconds);
+//每隔指定毫秒数重复执行任务。重复次数若为负数，或不指定重复次数，则默认无限重复
+template <uint8_t TimerCode, uint16_t IntervalMilliseconds, void (*DoTask)(), void (*DoneCallback)() = nullptr>
+void RepeatAfter(int32_t RepeatTimes);
 
 //将当前时刻设为0，计量经过的毫秒数。读取MillisecondsElapsed变量来获得经过的毫秒数。
 //Set the time now as 0 and start to record time elapsed. Read MillisecondsElapsed variable to get the time elapsed.
@@ -104,6 +107,10 @@ void SquareWave();
 //Specify milliseconds at runtime. After all cycles done, DoneCallback is called.
 template <uint8_t TimerCode, uint8_t PinCode, int16_t RepeatTimes, void (*DoneCallback)() = nullptr>
 void SquareWave(uint16_t HighMilliseconds, uint16_t LowMilliseconds);
+//允许运行时动态设置重复次数。重复次数不指定的话则为无限重复。
+//Specify RepeatTimes at runtime. Infinitely repeat if not specified.
+template <uint8_t TimerCode, uint8_t PinCode, uint16_t HighMilliseconds, uint16_t LowMilliseconds, void (*DoneCallback)() = nullptr>
+void SquareWave(int16_t RepeatTimes);
 
 //阻塞当前代码执行指定毫秒数
 //Block current code from running for DelayMilliseconds

library.properties

@@ -1,5 +1,5 @@
 name=TimersOneForAll
-version=1.3.0
+version=1.4.0
 author=EbolaChan <[email protected]>
 maintainer=EbolaChan <[email protected]>
 sentence=Make full use of all your hardware timers on your Arduino board. 充分利用你开发板上所有的硬件计时器

src/Internal/Kernel.h

@@ -450,6 +450,62 @@ namespace TimersOneForAll
 				}
 			}
 		}
+#pragma endregion
+#pragma region 重复次数可变实现
+		template <uint8_t TimerCode, uint32_t TCNT, uint8_t PrescalerBits, void (*DoTask)(), void (*DoneCallback)()>
+		void SLRepeaterSet(int32_t RepeatTimes)
+		{
+			TIMSK<TimerCode> = 0;
+			if (RepeatTimes != 0)
+			{
+				constexpr uint32_t TM = TimerMax[TimerCode];
+				constexpr uint16_t IdealRepeats = TCNT / (TM - (TimerCode == 0));
+				constexpr bool Timer02 = TimerCode == 0 || TimerCode == 2;
+				if (Timer02)
+					TCCRB<TimerCode> = PrescalerBits;
+				else
+					TCCRA<TimerCode> = 0;
+				if (RepeatTimes > 0)
+					LR<TimerCode> = RepeatTimes;
+				if (IdealRepeats * TM < TCNT || TimerCode == 0) //Timer0的OVF不可用
+				{
+					if (Timer02)
+						TCCRA<TimerCode> = 2;
+					else
+						TCCRB<TimerCode> = PrescalerBits + 8;
+					constexpr uint16_t ActualRepeats = IdealRepeats + 1;
+					constexpr uint16_t Tcnt1 = TCNT / ActualRepeats;
+					constexpr uint16_t Tcnt2 = Tcnt1 + 1;
+					constexpr uint16_t SR1 = ActualRepeats * Tcnt2 - TCNT; //必大于0
+					constexpr uint16_t SR2 = TCNT - ActualRepeats * Tcnt1;
+					SetOCRA<TimerCode>(Tcnt1);
+					SR<TimerCode> = SR1;
+					if (SR2)
+					{
+						COMPA<TimerCode> = RepeatTimes < 0 ? Compa1<TimerCode, DoTask, Tcnt1, Tcnt2, SR1, SR2, true, DoneCallback> : Compa1<TimerCode, DoTask, Tcnt1, Tcnt2, SR1, SR2, false, DoneCallback>;
+						if (Tcnt2 == TM)
+							OVF<TimerCode> = RepeatTimes < 0 ? Compa2<TimerCode, DoTask, Tcnt1, Tcnt2, SR1, SR2, true, DoneCallback> : Compa2<TimerCode, DoTask, Tcnt1, Tcnt2, SR1, SR2, false, DoneCallback>;
+					}
+					else
+						COMPA<TimerCode> = RepeatTimes < 0 ? Compa0<TimerCode, DoTask, SR1, true, DoneCallback> : Compa0<TimerCode, DoTask, SR1, false, DoneCallback>;
+					SetTCNT<TimerCode>(0);
+					TIFR<TimerCode> = 255;
+					TIMSK<TimerCode> = 2;
+				}
+				else
+				{
+					SR<TimerCode> = IdealRepeats;
+					OVF<TimerCode> = RepeatTimes < 0 ? Compa0<TimerCode, DoTask, IdealRepeats, true, DoneCallback> : Compa0<TimerCode, DoTask, IdealRepeats, false, DoneCallback>;
+					if (Timer02)
+						TCCRA<TimerCode> = 0;
+					else
+						TCCRB<TimerCode> = PrescalerBits;
+					SetTCNT<TimerCode>(0);
+					TIFR<TimerCode> = 255;
+					TIMSK<TimerCode> = 1;
+				}
+			}
+		}
 #pragma endregion
 	}
 }

src/Internal/RepeatAfter.h

@@ -16,4 +16,11 @@ namespace TimersOneForAll
 		Internal::TimerSetting TS = Internal::GetTimerSetting<TimerCode>(IntervalMilliseconds);
 		Internal::SLRepeaterSet<TimerCode, DoTask, RepeatTimes, DoneCallback>(TS.TCNT, TS.PrescalerBits);
 	}
+	//每隔指定毫秒数重复执行任务。重复次数若为负数，或不指定重复次数，则默认无限重复
+	template <uint8_t TimerCode, uint16_t IntervalMilliseconds, void (*DoTask)(), void (*DoneCallback)() = nullptr>
+	void RepeatAfter(int32_t RepeatTimes = -1)
+	{
+		constexpr Internal::TimerSetting TS = Internal::GetTimerSetting(TimerCode, IntervalMilliseconds);
+		Internal::SLRepeaterSet<TimerCode, TS.TCNT, TS.PrescalerBits, DoTask, DoneCallback>(RepeatTimes);
+	}
 }

src/Internal/SquareWave.h

@@ -183,6 +183,74 @@ namespace TimersOneForAll
 				}
 			}
 		}
+		//重复次数可变实现
+		template <uint8_t TimerCode, uint8_t PinCode, uint16_t HighMilliseconds, uint16_t LowMilliseconds, void (*DoneCallback)()>
+		void InternalSW(int32_t RepeatTimes)
+		{
+			switch (RepeatTimes)
+			{
+			case 0:
+				TIMSK<TimerCode> = 0;
+				if (DoneCallback)
+					DoneCallback();
+				break;
+			case 1:
+				Gifts::EfficientDigitalWrite<PinCode, HIGH>();
+				DoAfter<TimerCode, HighMilliseconds, OneShotSWDone<PinCode, DoneCallback>>();
+				break;
+			default:
+				if (HighMilliseconds == LowMilliseconds)
+				{
+					constexpr TimerSetting TS = GetTimerSetting(TimerCode, HighMilliseconds);
+					Gifts::EfficientDigitalWrite<PinCode, HIGH>();
+					SLRepeaterSet<TimerCode, TS.TCNT, TS.PrescalerBits, Gifts::EfficientDigitalToggle<PinCode>, DoneCallback>(RepeatTimes < 0 ? -1 : RepeatTimes * 2 - 1);
+				}
+				else
+				{
+					constexpr uint32_t TM = TimerMax[TimerCode];
+					constexpr uint32_t FullCycle = HighMilliseconds + LowMilliseconds;
+					constexpr TimerSetting TryTS = GetTimerSetting(TimerCode, FullCycle);
+					constexpr bool Timer02 = TimerCode == 0 || TimerCode == 2;
+					if (TryTS.TCNT < TM)
+					{
+						TIMSK<TimerCode> = 0;
+						if (Timer02)
+						{
+							TCCRA<TimerCode> = 2;
+							TCCRB<TimerCode> = TryTS.PrescalerBits;
+						}
+						else
+						{
+							TCCRA<TimerCode> = 0;
+							TCCRB<TimerCode> = TryTS.PrescalerBits + 8;
+						}
+						SetOCRA<TimerCode>(TryTS.TCNT);
+						SetOCRB<TimerCode>(TryTS.TCNT * HighMilliseconds / FullCycle);
+						LR<TimerCode> = RepeatTimes;
+						COMPA<TimerCode> = Gifts::EfficientDigitalWrite<PinCode, HIGH>;
+						COMPB<TimerCode> = RepeatTimes > 0 ? []
+						{
+							Gifts::EfficientDigitalWrite<PinCode, LOW>();
+							if (!--LR<TimerCode>)
+							{
+								TIMSK<TimerCode> = 0;
+								if (DoneCallback)
+									DoneCallback();
+							}
+						}
+														   : Gifts::EfficientDigitalWrite<PinCode, LOW>;
+						Gifts::EfficientDigitalWrite<PinCode, HIGH>();
+						SetTCNT<TimerCode>(0);
+						TIFR<TimerCode> = 255;
+						TIMSK<TimerCode> = 6;
+					}
+					else if (RepeatTimes < 0)
+						SquareWaveToHigh<TimerCode, PinCode, HighMilliseconds, LowMilliseconds, true, DoneCallback>();
+					else
+						SquareWaveToHigh<TimerCode, PinCode, HighMilliseconds, LowMilliseconds, false, DoneCallback>();
+				}
+			}
+		}
 	}
 	//生成循环数有限的方波。如不指定循环次数，默认无限循环
 	template <uint8_t TimerCode, uint8_t PinCode, uint16_t HighMilliseconds, uint16_t LowMilliseconds, int16_t RepeatTimes = -1, void (*DoneCallback)() = nullptr>
@@ -196,4 +264,10 @@ namespace TimersOneForAll
 	{
 		Internal::InternalSW<TimerCode, PinCode, RepeatTimes, DoneCallback>(HighMilliseconds, LowMilliseconds);
 	}
+	//生成循环数有限的方波。如不指定循环次数，默认无限循环
+	template <uint8_t TimerCode, uint8_t PinCode, uint16_t HighMilliseconds, uint16_t LowMilliseconds, void (*DoneCallback)() = nullptr>
+	void SquareWave(int16_t RepeatTimes = -1)
+	{
+		Internal::InternalSW<TimerCode, PinCode, HighMilliseconds, LowMilliseconds, DoneCallback>(RepeatTimes);
+	}
 }