From 95f3c4a756c21d1c69ee6cbb090b06df4a62848d Mon Sep 17 00:00:00 2001 From: virskl Date: Wed, 11 Nov 2026 14:50:51 +0100 Subject: [PATCH] TimerTwo points to AtmegaTimer, and leaves the Library Manager to it AtmegaTimer continues TimerTwo 2.0.0 and goes into the Library Manager in its stead, as two libraries for Timer2 there would leave a user to guess. The README says so at its top, installs from the .zip of a release only, and names the Uno and the Nano as the boards TimerTwo is for. OIL 4, 5 and 6 are dropped, as AtmegaTimer takes them; 7 is done in #8; 8 is this. OIL 8. --- OIL.md | 29 +++++++++++++++++++++++++---- README.md | 17 ++++++++++++++--- 2 files changed, 39 insertions(+), 7 deletions(-) diff --git a/OIL.md b/OIL.md index 3ba3b36..757e734 100644 --- a/OIL.md +++ b/OIL.md @@ -13,10 +13,11 @@ Status: `open`, `in progress`, `done`, `dropped` (with the reason in the item). | 1 | On the template embedded-cpp-template | – | done | #4 | | 2 | The known bugs, each shown by a test first | 1 | done | #5 | | 3 | Version 2.0.0: a namespace, constants for macros, the template's checks | 2 | done | #6 | -| 4 | Release 2.0.0 and the Library Manager | 3 | in progress | #7 | -| 5 | SelfCheck in simavr | 1 | open | | -| 6 | Only the AVRs whose Timer2 has OC2B on pin 3 | 3 | open | | -| 7 | A callback attached while stopped is called after Resume() | 3 | in progress | #8 | +| 4 | Release 2.0.0 and the Library Manager | 3 | dropped | #7, #9 | +| 5 | SelfCheck in simavr | 1 | dropped | #9 | +| 6 | Only the AVRs whose Timer2 has OC2B on pin 3 | 3 | dropped | #9 | +| 7 | A callback attached while stopped is called after Resume() | 3 | done | #8 | +| 8 | TimerTwo points to AtmegaTimer | 7 | in progress | #9 | ### 1 On the template embedded-cpp-template @@ -90,6 +91,11 @@ hardware. The README of 2.0.0 with the table of flash and RAM between `` markers, the tag, `release.yml`, and the request to the Arduino Library Manager. +*Dropped* on 2026-11-11: TimerTwo is continued as +[AtmegaTimer](https://github.com/theAndreas/AtmegaTimer), which goes into the Library Manager +instead (its roadmap, A-8 and A-9); two libraries for Timer2 there would leave a user to guess +which. The version and the README of #7 stay, and the tag `v2.0.0` marks the last state, see 8. + ### 5 SelfCheck in simavr `examples/SelfCheck`, which tools/self_check.sh runs in simavr: the period counted in callbacks @@ -114,6 +120,8 @@ come out the same in two programs. Reported with a program that shows it in `SIMAVR_MCU` in `tools/project.sh` stays empty, and this item waits for a simavr release that models phase correct PWM as the chip does; the template's image would then need it too. +*Dropped* on 2026-11-11: AtmegaTimer takes it, with these measurements, as A-7 of its roadmap. + ### 6 Only the AVRs whose Timer2 has OC2B on pin 3 `library.properties` names every AVR with `architectures=avr`, and nothing in `src/` asks which @@ -128,6 +136,9 @@ on 2026-11-11 while going through the README for 4: Either the library refuses those chips with an `#error` that says why, or it hands each its pin; which is to be decided. The README then names the boards it runs on. +*Dropped* on 2026-11-11: AtmegaTimer hands each chip its pins, the ATmega2560 among them, as A-4 +of its roadmap. The README of TimerTwo names the Uno and the Nano as its boards, see 8. + ### 7 A callback attached while stopped is called after Resume() `AttachInterrupt()` enabled the overflow interrupt only while the timer ran, and `Resume()` does @@ -135,3 +146,13 @@ not touch it: a callback attached while the timer was stopped was never called. 2026-11-11 in AtmegaTimer, which took the code of 3 (its roadmap, A-10), and shown here by a test first. The interrupt is enabled while the timer is stopped as well, where the counter stands and comes to no bottom before `Resume()`. + +### 8 TimerTwo points to AtmegaTimer + +AtmegaTimer, public since 2026-11-11, continues TimerTwo 2.0.0 and goes into the Library Manager +in its stead. The README says so at its top, no longer points to the Library Manager, and names +the boards TimerTwo is for, the Uno and the Nano, as 6 is dropped; the merge of #9 is tagged +`v2.0.0`, so that the state AtmegaTimer starts from has a name and a release with its .zip. The +repository is archived once AtmegaTimer 1.0.0 is out. + +*Done when* the repository is archived. diff --git a/README.md b/README.md index 3530b86..ada1778 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # TimerTwo +> **TimerTwo is continued as [AtmegaTimer](https://github.com/theAndreas/AtmegaTimer)**, which +> brings Timer1 as well, and Timer3 to Timer5 of the ATmega2560, each with a PWM on every channel +> it leaves free and a duty of 0 to 1023. TimerTwo 2.0.0 stays as it is: it gets no new features +> and does not go into the Library Manager, and this repository is archived once AtmegaTimer +> 1.0.0 is out. Please open issues and pull requests there. + A periodic interrupt, a PWM and a time readout on Timer/Counter2 of the ATmega328P, as on the Arduino Uno and Nano: the Timer2 counterpart of the Arduino library [TimerOne](https://playground.arduino.cc/Code/Timer1/). @@ -31,10 +37,13 @@ checks each call and reads the time. ## Installation -In the Arduino IDE, the Library Manager finds TimerTwo by its name; with arduino-cli, it is -`arduino-cli lib install TimerTwo`. Each release on GitHub also carries the library as a .zip, +TimerTwo is not in the Library Manager. Each release on GitHub carries the library as a .zip, for *Sketch > Include Library > Add .ZIP Library*. +It is for the ATmega328P of the Uno and the Nano. On the ATmega2560 of the Mega the PWM comes out +on pin 9, while TimerTwo makes pin 3 an output, and the ATmega32U4 of the Leonardo has no Timer2; +AtmegaTimer runs on both the Uno and the Mega. + ## API Everything lies in the namespace `timer_two`; `timer2` is the timer. A call that can refuse @@ -123,7 +132,9 @@ What also changed: TimerTwo is built and checked as the projects made from [embedded-cpp-template](https://github.com/theAndreas/embedded-cpp-template) are: `make` lists every build and check, `make check` is what CI runs. -[OIL.md](https://github.com/theAndreas/TimerTwo/blob/main/OIL.md) is what is planned, and +[OIL.md](https://github.com/theAndreas/TimerTwo/blob/main/OIL.md) is what was planned here, and +the [roadmap of AtmegaTimer](https://github.com/theAndreas/AtmegaTimer/blob/main/ROADMAP.md) what +comes next; [AGENTS.md](https://github.com/theAndreas/TimerTwo/blob/main/AGENTS.md) what a contributor has to know.