v1.0.1 to add PWM_StepperControl example

Author: khoih-prog

CONTRIBUTING.md

@@ -10,6 +10,8 @@ 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/SAMD_PWM/issues/new).
 
+---
+
 ### How to submit a bug report
 
 Please ensure to specify the following:
@@ -24,14 +26,18 @@ Please ensure to specify the following:
   * 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 SAMD Core Version 1.8.13
 SAMD_NANO_33_IOT
 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 using this library.
@@ -77,3 +83,5 @@ xy@xy-Inspiron-3593:~/Arduino/xy/SAMD_PWM_GitHub$
 xy@xy-Inspiron-3593:~/Arduino/xy/SAMD_PWM_GitHub$ bash utils/restyle.sh
 ```
 
+
+

README.md

@@ -10,6 +10,7 @@
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
 
+
 ---
 ---
 
@@ -45,6 +46,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 SAMD_NANO_33_IOT](#1-PWM_DynamicDutyCycle-on-SAMD_NANO_33_IOT)
@@ -73,7 +75,7 @@
 
 This hardware-based PWM library enables you to use Hardware-PWM on **SAMD21/SAMD51 boards** such as `NANO_33_IOT`, `ITSYBITSY_M4`, `SEEED_XIAO_M0`, `SparkFun SAMD51_Thing_Plus`, etc., to create and output PWM. These purely hardware-based PWM channels can generate very high PWM frequencies, depending on CPU clock and acceptable accuracy. The maximum resolution can be **16-bit** for better accuracy when using Timer `TCCx`. With Timer `TCx`, only **8-bit** resolution is supported with lower accuracy.
 
-This library is using the **same or similar functions** as other FastPWM libraries, as follows, to enable you to **port your PWM code easily between platforms**
+This library is using the **same or similar functions** as other `FastPWM` sibling libraries, as follows, to enable you to **port your PWM code easily between platforms**
 
  1. [**RP2040_PWM**](https://github.com/khoih-prog/RP2040_PWM)
  2. [**AVR_PWM**](https://github.com/khoih-prog/AVR_PWM)
@@ -146,7 +148,6 @@ Functions using normal software-based PWMs, relying on `loop()` and calling `mil
  6. [Industruino SAMD core](https://github.com/Industruino/IndustruinoSAMD) for SAMD21/SAMD51 boards
 
 
-   
 ---
 ---
 
@@ -388,6 +389,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**
 
 
 ---
@@ -410,7 +412,7 @@ The following is the sample terminal output when running example [PWM_DynamicDut
 
 ```cpp
 Starting PWM_DynamicDutyCycle on SAMD_NANO_33_IOT
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCCPrescaler: OK pin = 11 , period = 200 , _prescaler = 1 , F_CPU = 48000000
 [PWM] calcTCCPrescaler: _dutycycle = 32768 , frequency = 5000.00 , _prescalerConfigBits = 0 , _compareValue = 9599
 [PWM] SAMD21 setPWM_Int: _tcNum = 2 , _tcChannel = 0 , _pinAttr = 28
@@ -451,7 +453,7 @@ The following is the sample terminal output when running example [**PWM_Multi**]
 
 ```cpp
 Starting PWM_Multi on SAMD_NANO_33_IOT
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCCPrescaler: OK pin = 4 , period = 500 , _prescaler = 1 , F_CPU = 48000000
 [PWM] calcTCCPrescaler: _dutycycle = 6553 , frequency = 2000.00 , _prescalerConfigBits = 0 , _compareValue = 23999
 [PWM] SAMD21 setPWM_Int: _tcNum = 1 , _tcChannel = 1 , _pinAttr = 28
@@ -501,7 +503,7 @@ The following is the sample terminal output when running example [**PWM_DynamicF
 
 ```cpp
 Starting PWM_DynamicFreq on ITSYBITSY_M4
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCCPrescaler: OK pin = 11 , period = 100 , _prescaler = 1 , F_CPU = 120000000
 [PWM] calcTCCPrescaler: _dutycycle = 32768 , frequency = 10000.00 , _prescalerConfigBits = 0 , _compareValue = 11999
 [PWM] SAMD51 setPWM_Int: _tcNum = 0 , _tcChannel = 1 , _pinAttr = 512
@@ -542,7 +544,7 @@ The following is the sample terminal output when running example [**PWM_Waveform
 
 ```cpp
 Starting PWM_Waveform on ITSYBITSY_M4
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCCPrescaler: OK pin = 11 , period = 1000 , _prescaler = 1 , F_CPU = 120000000
 [PWM] calcTCCPrescaler: _dutycycle = 0 , frequency = 1000.00 , _prescalerConfigBits = 0 , _compareValue = 119999
 [PWM] setPWM: _dutycycle = 655 , frequency = 1000.00
@@ -643,7 +645,7 @@ The following is the sample terminal output when running example [**PWM_Basic**]
 
 ```cpp
 Starting PWM_Basic on ITSYBITSY_M4
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCPrescaler: OK pin = 24 , period = 1000 , _prescaler = 1 , F_CPU = 120000000
 [PWM] calcTCPrescaler: _dutycycle = 0 , frequency = 1000.00 , _prescalerConfigBits = 0 , _compareValue = 119999
 [PWM] setPWM: _dutycycle = 13107 , frequency = 2000.00
@@ -684,7 +686,7 @@ The following is the sample terminal output when running example [**PWM_Basic**]
 
 ```cpp
 Starting PWM_Basic on SAMD_NANO_33_IOT
-SAMD_PWM v1.0.0
+SAMD_PWM v1.0.1
 [PWM] calcTCPrescaler: OK pin = 12 , period = 1000 , _prescaler = 1 , F_CPU = 48000000
 [PWM] calcTCPrescaler: _dutycycle = 0 , frequency = 1000.00 , _prescalerConfigBits = 0 , _compareValue = 47999
 [PWM] setPWM: _dutycycle = 13107 , frequency = 2000.00
@@ -759,6 +761,7 @@ Submit issues to: [SAMD_PWM issues](https://github.com/khoih-prog/SAMD_PWM/issue
 - [Sparkfun SAMD core](https://github.com/sparkfun/Arduino_Boards)
 - [Industruino SAMD core](https://github.com/Industruino/IndustruinoSAMD)
 - [Industruino SAMx core](https://github.com/Industruino/IndustruinoSAMx)
+ 2. Add example [PWM_StepperControl](https://github.com/khoih-prog/SAMD_PWM/tree/main/examples/PWM_StepperControl) to demo how to control Stepper Motor using PWM
 
 ---
 ---
@@ -767,12 +770,22 @@ Submit issues to: [SAMD_PWM issues](https://github.com/khoih-prog/SAMD_PWM/issue
 
 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>
+
 
 ---
 
 ## Contributing
 
 If you want to contribute to this project:
+
 - Report bugs and errors
 - Ask for enhancements
 - Create issues and pull requests

changelog.md

@@ -10,6 +10,7 @@
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
 
+
 ---
 ---
 
@@ -23,6 +24,9 @@
 
 ## Changelog
 
+### Releases v1.0.1
+
+1. Add example [PWM_StepperControl](https://github.com/khoih-prog/SAMD_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)
 
 ### Releases v1.0.0
 

examples/PWM_StepperControl/PWM_StepperControl.ino

@@ -0,0 +1,81 @@
+/****************************************************************************************************************************
+  PWM_StepperControl.ino
+  For SAMD21/SAMD51 boards using hardware-based PWM
+  Written by Khoi Hoang
+
+  Built by Khoi Hoang https://github.com/khoih-prog/SAMD_PWM
+  Licensed under MIT license
+
+  Credits of Paul van Dinther (https://github.com/dinther). Check https://github.com/khoih-prog/RP2040_PWM/issues/16
+*****************************************************************************************************************************/
+
+// Use with Stepper-Motor driver, such as TMC2209
+
+#define _PWM_LOGLEVEL_       4
+
+#include "SAMD_PWM.h"
+
+// Not OK for Nano_33_IoT (0, 1, 7, 8, 13, 14, 15 )
+// OK for Nano_33_IoT (2, 3, 4, 5, 6, 9, 10, 11, 12, 16, 17)
+// TCC OK => pin 4, 5, 6, 8, 9, 10, 11, 16/A2, 17/A3
+// TC OK  => pin 12
+// For ITSYBITSY_M4
+// 16-bit Higher accuracy, Lower Frequency, PWM Pin OK: TCCx: 0-2, 4, 5, 7, 9-13
+//  8-bit Lower  accuracy, Hi Frequency,    PWM Pin OK: TCx: 18-20, 24-25
+
+SAMD_PWM* stepper;
+
+#define STEP_PIN      9
+#define DIR_PIN       8
+
+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(SAMD_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 SAMD_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": "SAMD_PWM",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "keywords": "timing, device, control, timer, interrupt, hardware, isr, isr-based, hardware-timer, isr-timer, isr-based-timer, mission-critical, accuracy, precise, non-blocking, samd, samd21, samd51, nano-33-iot",
   "description": "This library enables you to use Hardware-based PWM channels on SAMD21/SAMD51-based boards to create and output PWM to pins. 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",
   "authors":

library.properties

@@ -1,5 +1,5 @@
 name=SAMD_PWM
-version=1.0.0
+version=1.0.1
 author=Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=This library enables you to use Hardware-based PWM channels on SAMD21/SAMD51-based boards to create and output PWM to pins.

src/PWM_Generic_Debug.h

@@ -7,11 +7,12 @@
   Built by Khoi Hoang https://github.com/khoih-prog/SAMD_PWM
   Licensed under MIT license
 
-  Version: 1.0.0
+  Version: 1.0.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K Hoang      01/11/2022 Initial coding for SAMD21/SAMD51 boards
+  1.0.1   K Hoang      22/01/2023 Add `PWM_StepperControl` example
  *****************************************************************************************************************************/
 
 #pragma once

src/SAMD_PWM.h

@@ -7,11 +7,12 @@
   Built by Khoi Hoang https://github.com/khoih-prog/SAMD_PWM
   Licensed under MIT license
 
-  Version: 1.0.0
+  Version: 1.0.1
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K Hoang      01/11/2022 Initial coding for SAMD21/SAMD51 boards
+  1.0.1   K Hoang      22/01/2023 Add `PWM_StepperControl` example
 *****************************************************************************************************************************/
 
 #pragma once
@@ -136,13 +137,13 @@
 #include "Arduino.h"
 
 #ifndef SAMD_PWM_VERSION
-  #define SAMD_PWM_VERSION             "SAMD_PWM v1.0.0"
+  #define SAMD_PWM_VERSION             "SAMD_PWM v1.0.1"
 
   #define SAMD_PWM_VERSION_MAJOR       1
   #define SAMD_PWM_VERSION_MINOR       0
-  #define SAMD_PWM_VERSION_PATCH       0
+  #define SAMD_PWM_VERSION_PATCH       1
 
-  #define SAMD_PWM_VERSION_INT         1000000
+  #define SAMD_PWM_VERSION_INT         1000001
 #endif
 
 #include "PWM_Generic_Debug.h"
@@ -859,7 +860,6 @@ class SAMD_PWM
         return false;
 
 #if defined(__SAMD51__)
-
       // Check which timer to use
       if (_tcNum >= TCC_INST_NUM)
       {
@@ -869,7 +869,7 @@ class SAMD_PWM
         //TCx->COUNT8.CC[_tcChannel].reg = (DCValue * _compareValue / 100) >> 8;
 
         //while (TCx->COUNT16.STATUS.bit.SYNCBUSY);
-
+        
         // Set the Dutycycle
         TCx->COUNT8.CC[_tcChannel].reg = (DCValue * _compareValue / 100) >> 8;
 
@@ -879,9 +879,7 @@ class SAMD_PWM
         PWM_LOGDEBUG3(F("setPWM_manual TC: New DCValue ="), DCValue * _compareValue / 100, F(", _compareValue ="),
                       _compareValue);
       }
-
 #else
-
       // Check which timer to use
       if (_tcNum >= TCC_INST_NUM)
       {
@@ -896,8 +894,7 @@ class SAMD_PWM
         PWM_LOGDEBUG3(F("setPWM_manual TC: New DCValue ="), DCValue * _compareValue / 100, F(", _compareValue ="),
                       _compareValue);
       }
-
-#endif
+#endif      
       else
       {
         Tcc* TCCx = (Tcc*) GetTC(_pinDesc.ulPWMChannel);