Merge pull request #47 from jonas-merkle/develop

Version 2.2.1
jonas-merkle · Nov 20, 2023 · a517290 · a517290
2 parents 466d9b5 + 9f7417f
commit a517290
Show file tree

Hide file tree

Showing 17 changed files with 90 additions and 88 deletions.
diff --git a/.github/workflows/Arduino-Library-CI.yml b/.github/workflows/Arduino-Library-CI.yml
@@ -16,13 +16,14 @@ jobs:
     steps:
 
       - name: 📥📄 Clone current Library Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.5.3
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: 🔧🤖 Arduino CI Build
-        uses: Arduino-CI/[email protected]
+        uses: Arduino-CI/[email protected]
+
 
   deploy:
     name: Deploy ⚙️🚀
@@ -32,7 +33,7 @@ jobs:
     steps:
 
       - name: 📥📄 Clone current Library Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.5.3
         with:
           fetch-depth: 0  
           persist-credentials: false
@@ -49,7 +50,7 @@ jobs:
         uses: mattnotmitt/doxygen-action@v1
 
       - name: 📥🌐 Clone current gh-pages barnch of the Library Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3.5.3
         with:
           ref: 'gh-pages'
           path: './.gh-pages'

diff --git a/Doxyfile b/Doxyfile
@@ -38,7 +38,7 @@ PROJECT_NAME           = "AS5047P - Arduino Library"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.2.0
+PROJECT_NUMBER         = 2.2.1
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # AS5047P - Arduino Library
+
 ![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/jonas-merkle/AS5047P/Arduino-Library-CI.yml?branch=master&label=build%20master) ![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/jonas-merkle/AS5047P/Arduino-Library-CI.yml?branch=develop&label=build%20develop) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/jonas-merkle/AS5047P) ![GitHub](https://img.shields.io/github/license/jonas-merkle/AS5047P) ![GitHub issues](https://img.shields.io/github/issues/jonas-merkle/AS5047P) ![GitHub pull requests](https://img.shields.io/github/issues-pr/jonas-merkle/AS5047P) ![Maintenance](https://img.shields.io/maintenance/yes/2023)
 
 ## tl;dr
@@ -25,7 +26,7 @@
       - [Connect to a Teensy 3.6](#connect-to-a-teensy-36)
       - [Connect to a Teensy 4.0](#connect-to-a-teensy-40)
       - [Connect to a Teensy 4.1](#connect-to-a-teensy-41)
-  - [Project Status & ToDo's](#project-status--todos)
+  - [Project Status \& ToDo's](#project-status--todos)
 
 ## Supported Sensors
 
@@ -58,7 +59,7 @@ Documentation Deployment Status: ![GitHub deployments](https://img.shields.io/gi
 
 ### Install the library via the Arduino Library Manager
 
-The easiest way to install this library is to use the build in Arduino Library Manager. Just search for `AS5047P` an install the latest version available. You can also upgrade the library to the newest release via the Arduino Library Manager. For detailed infomation please read the section `Using the Library Manager` of [this](https://www.arduino.cc/en/guide/libraries) tutorial. (Pleas keep in mind you need at least version 1.6.2 of the Arduino IDE in order to use the Arduino Library Manager)
+The easiest way to install this library is to use the build in Arduino Library Manager. Just search for `AS5047P` an install the latest version available. You can also upgrade the library to the newest release via the Arduino Library Manager. For detailed information please read the section `Using the Library Manager` of [this](https://www.arduino.cc/en/guide/libraries) tutorial. (Pleas keep in mind you need at least version 1.6.2 of the Arduino IDE in order to use the Arduino Library Manager)
 
 ### Manually install a Arduino library
 
@@ -120,7 +121,7 @@ You can find this library [here](https://platformio.org/lib/show/12035/AS5047P)
 | MOSI | MOSI0 (Pin: 11) | - |
 | MISO | MISO0 (Pin: 12) | - |
 | CLK | SCK0 (Pin: 13) | - |
-| CSn | CS0 (Pin: 10) | Can be any unused digital pin on the teenys as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
+| CSn | CS0 (Pin: 10) | Can be any unused digital pin on the teensy as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
 
 **Please note that the sensor can no longer be operated with 5V, but must be operated with 3.3V, otherwise there is a risk of damaging the Teensy board!**
 
@@ -134,7 +135,7 @@ You can find this library [here](https://platformio.org/lib/show/12035/AS5047P)
 | MOSI | MOSI0 (Pin: 11) | - |
 | MISO | MISO0 (Pin: 12) | - |
 | CLK | SCK0 (Pin: 13) | - |
-| CSn | CS0 (Pin: 10) | Can be any unused digital pin on the teenys as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
+| CSn | CS0 (Pin: 10) | Can be any unused digital pin on the teensy as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
 
 **Please note that the sensor can no longer be operated with 5V, but must be operated with 3.3V, otherwise there is a risk of damaging the Teensy board!**
 
@@ -148,7 +149,7 @@ You can find this library [here](https://platformio.org/lib/show/12035/AS5047P)
 | MOSI | MOSI (Pin: 11) | - |
 | MISO | MISO (Pin: 12) | - |
 | CLK | SCK (Pin: 13) | - |
-| CSn | CS (Pin: 10) | Can be any unused digital pin on the teenys as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
+| CSn | CS (Pin: 10) | Can be any unused digital pin on the teensy as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
 
 **Please note that the sensor can no longer be operated with 5V, but must be operated with 3.3V, otherwise there is a risk of damaging the Teensy board!**
 
@@ -162,7 +163,7 @@ You can find this library [here](https://platformio.org/lib/show/12035/AS5047P)
 | MOSI | MOSI (Pin: 11) | - |
 | MISO | MISO (Pin: 12) | - |
 | CLK | SCK (Pin: 13) | - |
-| CSn | CS (Pin: 10) | Can be any unused digital pin on the teenys as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
+| CSn | CS (Pin: 10) | Can be any unused digital pin on the teensy as long as it's configured here `AS5047P as5047p(<ChipSelectPort>);` |
 
 **Please note that the sensor can no longer be operated with 5V, but must be operated with 3.3V, otherwise there is a risk of damaging the Teensy board!**
 

diff --git a/examples/BasicReadAngle/BasicReadAngle.ino b/examples/BasicReadAngle/BasicReadAngle.ino
@@ -3,10 +3,10 @@
  * @author Jonas Merkle [JJM] ([email protected])
  * @brief This is a basic example program to read the angle position from a AS5047 rotary encoder.
  *        The angle postion gets updated and printed to the serial consol once a second. 
- * @version 2.2.0
- * @date 2022-11-20
+ * @version 2.2.1
+ * @date 2023-07-04
  * 
- * @copyright Copyright (c) 2021 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  * More Information can be found here:
  * https://github.com/jonas-merkle/AS5047P

diff --git a/examples/BasicReadAngleAndDebugInfo/BasicReadAngleAndDebugInfo.ino b/examples/BasicReadAngleAndDebugInfo/BasicReadAngleAndDebugInfo.ino
@@ -3,10 +3,10 @@
  * @author Jonas Merkle [JJM] ([email protected])
  * @brief This is a basic example program to read the angle position and debug information from a AS5047 rotary encoder.
  *        The angle postion and debug information gets updated and printed to the serial consol once a second. 
- * @version 2.2.0
- * @date 2022-11-20
+ * @version 2.2.1
+ * @date 2023-07-04
  * 
- * @copyright Copyright (c) 2021 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  * More Information can be found here:
  * https://github.com/jonas-merkle/AS5047P

diff --git a/examples/BasicReadAngleWithErrorInfo/BasicReadAngleWithErrorInfo.ino b/examples/BasicReadAngleWithErrorInfo/BasicReadAngleWithErrorInfo.ino
@@ -4,10 +4,10 @@
  * @brief This is a basic example program to read the angle position from a AS5047 rotary encoder.
  *        The angle postion gets updated and printed to the serial consol once a second.
  *        In addition to the angle value the error information gets displayed.
- * @version 2.2.0
- * @date 2022-11-20
+ * @version 2.2.1
+ * @date 2023-07-04
  * 
- * @copyright Copyright (c) 2021 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  * More Information can be found here:
  * https://github.com/jonas-merkle/AS5047P

diff --git a/examples/PrintAllSettings/PrintAllSettings.ino b/examples/PrintAllSettings/PrintAllSettings.ino
@@ -2,10 +2,10 @@
  * @file PrintAllSettings.ino
  * @author Jonas Merkle [JJM] ([email protected])
  * @brief This is a example prints out the settings of the AS5047P sensor.
- * @version 2.2.0
- * @date 2022-11-20
+ * @version 2.2.1
+ * @date 2023-07-04
  * 
- * @copyright Copyright (c) 2021 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  * More Information can be found here:
  * https://github.com/jonas-merkle/AS5047P

diff --git a/library.json b/library.json
@@ -1,6 +1,6 @@
 {
     "name": "AS5047P",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "description": "An Arduino library for the AS5047P high-resolution rotary position sensor. Supporting also the following sensor types: AS5047D, AS5147, AS5147P, AS5247",
     "keywords": "arduino-library, as5047p, spi, sensor, rotary-encoder, high-resolution, rotary-position-sensor, as5x47, as5047d, as5147, as5147p, as5247, encoder, rotaty, angle, uvw, abi",
     "repository":

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=AS5047P
-version=2.2.0
+version=2.2.1
 author=Jonas Merkle [JJM] <[email protected]>
 maintainer=Jonas Merkle [JJM] <[email protected]>
 sentence=An Arduino library for the AS5047P high-resolution rotary position sensor.

diff --git a/src/AS5047P.cpp b/src/AS5047P.cpp
@@ -1,11 +1,11 @@
 /**
  * @file AS5047P.h
  * @author Jonas Merkle [JJM] ([email protected])
- * @brief This is the main sourcefile of the AS5047P Library.
- * @version 2.2.0
- * @date 2022-11-20
+ * @brief This is the main source file of the AS5047P Library.
+ * @version 2.2.1
+ * @date 2023-07-04
  * 
- * @copyright Copyright (c) 2021 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */