v1.0.1 to add PWM_StepperControl example

### Releases v1.0.1

1. Add example [PWM_StepperControl](https://github.com/khoih-prog/megaAVR_PWM/tree/main/examples/PWM_StepperControl) to demo how to control Stepper Motor using PWM

Author: khoih-prog

CONTRIBUTING.md

@@ -10,26 +10,32 @@ However, before reporting a bug please check through the following:
 
 If you don't find anything, please [open a new issue](https://github.com/khoih-prog/megaAVR_PWM/issues/new).
 
+---
+
 ### How to submit a bug report
 
 Please ensure to specify the following:
 
 * Arduino IDE version (e.g. 1.8.19) or Platform.io version
-* `Arduino megaAVR` or `MegaCoreX` Core Version (e.g. Arduino megaAVR core v1.8.7 or MegaCoreX core v1.1.0)
+* `Arduino megaAVR` or `MegaCoreX` Core Version (e.g. Arduino megaAVR core v1.8.7 or MegaCoreX core v1.1.1)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
   * Operating system (Windows, Ubuntu, etc.) and the output of `uname -a`
   * Network configuration
 
 
+Please be educated, civilized and constructive as you've always been. Disrespective posts against [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-event-code-of-conduct) will be ignored and deleted.
+
+---
+
 ### Example
 
 ```
 Arduino IDE version: 1.8.19
 Arduino megaAVR Core Version 1.8.7
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.15.0-53-generic #59~20.04.1-Ubuntu SMP Thu Oct 20 15:10:22 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.15.0-58-generic #64~20.04.1-Ubuntu SMP Fri Jan 6 16:42:31 UTC 2023 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while trying to use the Timer Interrupt.

README.md

@@ -42,6 +42,7 @@
   * [ 5. PWM_Multi](examples/PWM_Multi)
   * [ 6. PWM_MultiChannel](examples/PWM_MultiChannel)
   * [ 7. PWM_Waveform](examples/PWM_Waveform)
+  * [ 8. PWM_StepperControl](examples/PWM_StepperControl) **New**
 * [Example PWM_Multi](#example-PWM_Multi)
 * [Debug Terminal Output Samples](#debug-terminal-output-samples)
   * [1. PWM_DynamicDutyCycle on MegaCoreX Nano Every](#1-PWM_DynamicDutyCycle-on-MegaCoreX-Nano-Every)
@@ -131,7 +132,7 @@ Functions using normal software-based PWMs, relying on loop() and calling millis
 ## Prerequisites
 
 1. [`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [![GitHub release](https://img.shields.io/github/release/arduino/Arduino.svg)](https://github.com/arduino/Arduino/releases/latest)
-2. [`Arduino megaAVR core 1.8.7+`](https://github.com/arduino/ArduinoCore-megaavr/releases) for Arduino megaAVR boards. Use Arduino Board Manager to install.
+2. [`Arduino megaAVR core 1.8.7+`](https://github.com/arduino/ArduinoCore-megaavr/releases) for Arduino megaAVR boards. [![GitHub release](https://img.shields.io/github/release/arduino/ArduinoCore-megaavr.svg)](https://github.com/arduino/ArduinoCore-megaavr/releases/latest). Use Arduino Board Manager to install.
 3. [`MegaCoreX megaAVR core 1.1.0+`](https://github.com/MCUdude/MegaCoreX/releases) for Arduino megaAVR boards.  [![GitHub release](https://img.shields.io/github/release/MCUdude/MegaCoreX.svg)](https://github.com/MCUdude/MegaCoreX/releases/latest). Follow [**How to install**](https://github.com/MCUdude/MegaCoreX#how-to-install).
 
 
@@ -307,7 +308,7 @@ PWM_Instance->setPWM_manual(PWM_Pins, new_level);
  5. [PWM_Multi](examples/PWM_Multi)
  6. [PWM_MultiChannel](examples/PWM_MultiChannel)
  7. [PWM_Waveform](examples/PWM_Waveform)
-
+ 8. [PWM_StepperControl](examples/PWM_StepperControl) **New**
 
 ---
 ---
@@ -329,7 +330,7 @@ The following is the sample terminal output when running example [PWM_DynamicDut
 
 ```cpp
 Starting PWM_DynamicDutyCycle on MegaCoreX Nano Every
-megaAVR_PWM v1.0.0
+megaAVR_PWM v1.0.1
 [PWM] megaAVR_PWM: _dutycycle = 32767
 [PWM] setPWM_Int: input dutycycle = 127
 [PWM] setPWM_Int: _timer = 3
@@ -381,7 +382,7 @@ The following is the sample terminal output when running example [**PWM_Multi**]
 
 ```cpp
 Starting PWM_Multi on megaAVR Nano Every
-megaAVR_PWM v1.0.0
+megaAVR_PWM v1.0.1
 =====================================================================================
 Index	Pin	PWM_freq	DutyCycle	Actual Freq
 =====================================================================================
@@ -403,7 +404,7 @@ The following is the sample terminal output when running example [**PWM_DynamicF
 
 ```cpp
 Starting PWM_DynamicFreq on megaAVR Nano Every
-megaAVR_PWM v1.0.0
+megaAVR_PWM v1.0.1
 [PWM] megaAVR_PWM: _dutycycle = 32767
 [PWM] setPWM_Int: input dutycycle = 127
 [PWM] setPWM_Int: _timer = 3
@@ -446,7 +447,7 @@ The following is the sample terminal output when running example [**PWM_Waveform
 
 ```cpp
 Starting PWM_Waveform on megaAVR Nano Every
-megaAVR_PWM v1.0.0
+megaAVR_PWM v1.0.1
 [PWM] megaAVR_PWM: _dutycycle = 0
 [PWM] setPWM: _dutycycle = 0
 [PWM] setPWM_Int: input dutycycle = 0
@@ -537,7 +538,7 @@ Submit issues to: [megaAVR_PWM issues](https://github.com/khoih-prog/megaAVR_PWM
  1. Basic hardware-based multi-channel PWMs for **megaAVR-based boards** such as `UNO WiFi Rev2`, `AVR_Nano_Every`, etc.**, using either
  - [`Arduino megaAVR core`](https://github.com/arduino/ArduinoCore-megaavr) or
  - [`MegaCoreX megaAVR core`](https://github.com/MCUdude/MegaCoreX)
-
+ 2. Add example [PWM_StepperControl](examples/PWM_StepperControl) to demo how to control Stepper Motor using PWM
 
 
 ---
@@ -547,6 +548,15 @@ Submit issues to: [megaAVR_PWM issues](https://github.com/khoih-prog/megaAVR_PWM
 
 Many thanks for everyone for bug reporting, new feature suggesting, testing and contributing to the development of this library.
 
+1. Thanks to [Paul van Dinther](https://github.com/dinther) for proposing new way to use PWM to drive Stepper-Motor in [Using PWM to step a stepper driver #16](https://github.com/khoih-prog/RP2040_PWM/issues/16), leading to v2.0.3
+
+
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/dinther"><img src="https://github.com/dinther.png" width="100px;" alt="dinther"/><br /><sub><b>Paul van Dinther</b></sub></a><br /></td>
+  </tr>
+</table>
+
 
 ---
 

changelog.md

@@ -17,13 +17,18 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.0.1](#Releases-v101)
   * [Initial Releases v1.0.0](#Initial-Releases-v100)
 
 ---
 ---
 
 ## Changelog
 
+### Releases v1.0.1
+
+1. Add example [PWM_StepperControl](https://github.com/khoih-prog/megaAVR_PWM/tree/main/examples/PWM_StepperControl) to demo how to control Stepper Motor using PWM. Check [Using PWM to step a stepper driver #16](https://github.com/khoih-prog/RP2040_PWM/issues/16)
+
 ### Initial Releases v1.0.0
 
 1. Initial coding to support **megaAVR boards, such as UNO WiFi Rev2, AVR_Nano_Every, etc.**, using `Arduino megaAVR` or `MegaCoreX` core

examples/PWM_StepperControl/PWM_StepperControl.ino

@@ -0,0 +1,107 @@
+/****************************************************************************************************************************
+  PWM_StepperControl.ino
+  For Arduino megaAVR ATMEGA4809-based boards (UNO WiFi Rev2, NANO_EVERY, etc. )
+  Written by Khoi Hoang
+
+  Built by Khoi Hoang https://github.com/khoih-prog/megaAVR_PWM
+  Licensed under MIT license
+
+  This is pure hardware-based PWM
+*****************************************************************************************************************************/
+/******************************************************************************************************************************
+  Pins can be used for hardware-PWM
+  // For ATmega4809 (Nano Every, Uno WiFi Rev2, etc.)
+  TCA0 (16-bit) used by PWM generation on pins 5, 9 and 10
+  TCB0 (16-bit) used by PWM generation on pin 6
+  TCB1 (16-bit) used by PWM generation on pin 3
+  TCB2 (16-bit)
+  TCB3 (16-bit)
+  ////////////////////////////////////////////
+  // For ATmega4809 (Nano Every, Uno WiFi Rev2, etc.)
+  Pin  3 => TIMERB1,       //  3 PF5,  8-bit PWM, 16-bit counter
+  Pin  5 => TIMERA0,       //  5 PB2, 16-bit PWM, 16-bit counter
+  Pin  6 => TIMERB0,       //  6 PF4,  8-bit PWM, 16-bit counter
+  Pin  9 => TIMERA0,       //  9 PB0, 16-bit PWM, 16-bit counter
+  Pin 10 => TIMERA0,       // 10 PB1, 16-bit PWM, 16-bit counter
+  ////////////////////////////////////////////
+******************************************************************************************************************************/
+
+// Use with Stepper-Motor driver, such as TMC2209
+
+#define _PWM_LOGLEVEL_        4
+
+#include "megaAVR_PWM.h"
+
+#define USING_TIMERB        true
+
+#if USING_TIMERB
+  // Pins tested OK in Nano Every ATmega4809
+  #define STEP_PIN      3            // TimerB1, for higher frequencies, up to 100KHz
+  //#define STEP_PIN      6            // TimerB0, for higher frequencies, up to 100KHz
+#elif USING_ARDUINO_MEGA_AVR_CORE
+  // Pins tested OK in Nano Every ATmega4809 using Arduino megaAVR core
+  // TimerA0 somehow can't be used with MegaCoreX
+  #define STEP_PIN      5            // TimerA0, only accurate @ low frequencies (< 1KHz) because of low 250KHz clock
+  //#define STEP_PIN      9            // TimerA0, only accurate @ low frequencies (< 1KHz) because of low 250KHz clock
+  //#define STEP_PIN     10            // TimerA0, only accurate @ low frequencies (< 1KHz) because of low 250KHz clock
+#else
+  #error TimerA0 to be used with Arduino megaAVR Core
+#endif
+
+#define DIR_PIN       4
+
+////////////////////////////////////////////
+
+megaAVR_PWM* stepper;
+
+void setSpeed(int speed)
+{
+  if (speed == 0)
+  {
+    // Use DC = 0 to stop stepper
+    stepper->setPWM(STEP_PIN, 500, 0);
+  }
+  else
+  {
+    //  Set the frequency of the PWM output and a duty cycle of 50%
+    digitalWrite(DIR_PIN, (speed < 0));
+    stepper->setPWM(STEP_PIN, abs(speed), 50);
+  }
+}
+
+void setup() 
+{
+  pinMode(DIR_PIN, OUTPUT);
+  
+  Serial.begin(115200);
+
+  while (!Serial && millis() < 5000);
+
+  delay(100);
+
+  Serial.print(F("\nStarting PWM_StepperControl on "));
+  Serial.println(BOARD_NAME);
+  Serial.println(MEGA_AVR_PWM_VERSION);
+  
+  // Create PWM object and passed just a random frequency of 500
+  // The duty cycle is how you turn the motor on and off
+  stepper = new megaAVR_PWM(STEP_PIN, 500, 0);
+}
+
+void loop() 
+{
+  setSpeed(1000);
+  delay(3000);
+
+  // Stop before reversing
+  setSpeed(0);
+  delay(3000);
+
+  // Reversing
+  setSpeed(-500);
+  delay(3000);
+
+  // Stop before reversing
+  setSpeed(0);
+  delay(3000);
+}

library.json

@@ -1,6 +1,6 @@
 {
   "name": "megaAVR_PWM",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": "timing, device, control, timer, pwm, fast-pwm, hardware-based-pwm, high-frequency-pwm, hardware-pwm,  mission-critical, accuracy, precise, non-blocking, megaavr, mega-avr, atmega4809, nano-every, uno-wifi-rev2, megacorex",
   "description": "This library enables you to use Hardware-based PWM channels on megaAVR-based boards, such as UNO WiFi Rev2, AVR_Nano_Every, etc., to create and output PWM. The most important feature is they're purely hardware-based PWM channels, supporting very high PWM frequencies. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These hardware-based PWMs, still work even if other software functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software-based PWM using ISR, millis() or micros(). That's necessary if you need to control devices requiring high precision. New efficient setPWM_manual function to facilitate waveform creation using PWM. Supporting MegaCoreX.",
   "authors":

library.properties

@@ -1,5 +1,5 @@
 name=megaAVR_PWM
-version=1.0.0
+version=1.0.1
 author=Khoi Hoang
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=This library enables you to use Hardware-based PWM channels on megaAVR-based boards, such as UNO WiFi Rev2, AVR_Nano_Every, etc., to create and output PWM.

src/PWM_Generic_Debug.h

@@ -8,11 +8,12 @@
 
   This is pure hardware-based PWM
 
-  Version: 1.0.0
+  Version: 1.0.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      31/10/2022 Initial coding for megaAVR ATMEGA4809-based boards (UNO WiFi Rev2, NANO_EVERY, etc. )
+  1.0.1   K Hoang      22/01/2023 Add `PWM_StepperControl` example
  *****************************************************************************************************************************/
 
 #pragma once

src/megaAVR_PWM.h

@@ -8,11 +8,12 @@
 
   This is pure hardware-based PWM
 
-  Version: 1.0.0
+  Version: 1.0.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K.Hoang      31/10/2022 Initial coding for megaAVR ATMEGA4809-based boards (UNO WiFi Rev2, NANO_EVERY, etc. )
+  1.0.1   K Hoang      22/01/2023 Add `PWM_StepperControl` example
 *****************************************************************************************************************************/
 
 #pragma once
@@ -74,13 +75,13 @@
 ////////////////////////////////////////
 
 #ifndef MEGA_AVR_PWM_VERSION
-  #define MEGA_AVR_PWM_VERSION           F("megaAVR_PWM v1.0.0")
+  #define MEGA_AVR_PWM_VERSION           F("megaAVR_PWM v1.0.1")
 
   #define MEGA_AVR_PWM_VERSION_MAJOR     1
   #define MEGA_AVR_PWM_VERSION_MINOR     0
-  #define MEGA_AVR_PWM_VERSION_PATCH     0
+  #define MEGA_AVR_PWM_VERSION_PATCH     1
 
-  #define MEGA_AVR_PWM_VERSION_INT      1000000
+  #define MEGA_AVR_PWM_VERSION_INT      1000001
 #endif
 
 ////////////////////////////////////////