Merge pull request #49 from jonas-merkle/develop

Documentation update
jonas-merkle · Oct 19, 2024 · 52fcf76 · 52fcf76
2 parents a700107 + b42db63
commit 52fcf76
Show file tree

Hide file tree

Showing 16 changed files with 229 additions and 164 deletions.
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.1
+PROJECT_NUMBER         = 2.2.2
 
 # 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
diff --git a/examples/BasicReadAngle/BasicReadAngle.ino b/examples/BasicReadAngle/BasicReadAngle.ino
@@ -3,10 +3,10 @@
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @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.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 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] (jonas@jjm.one)
  * @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.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 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.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 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] (jonas@jjm.one)
  * @brief This is a example prints out the settings of the AS5047P sensor.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 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.1",
+    "version": "2.2.2",
     "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.1
+version=2.2.2
 author=Jonas Merkle [JJM] <jonas@jjm.one>
 maintainer=Jonas Merkle [JJM] <jonas@jjm.one>
 sentence=An Arduino library for the AS5047P high-resolution rotary position sensor.

diff --git a/src/AS5047P.cpp b/src/AS5047P.cpp
@@ -2,10 +2,10 @@
  * @file AS5047P.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This is the main source file of the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/AS5047P.h b/src/AS5047P.h
@@ -2,10 +2,10 @@
  * @file AS5047P.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This is the main header file of the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/spi/AS5047P_SPI_Arduino.cpp b/src/spi/AS5047P_SPI_Arduino.cpp
@@ -4,10 +4,10 @@
  * @file AS5047P_SPI_Arduino.cpp
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This soure file contains the implementation of the Arduino SPI bus handler for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/spi/AS5047P_SPI_Arduino.h b/src/spi/AS5047P_SPI_Arduino.h
@@ -2,10 +2,10 @@
  * @file AS5047P_SPI_Arduino.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This header file contains the Arduino SPI bus handler for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/types/AS5047P_Types.cpp b/src/types/AS5047P_Types.cpp
@@ -2,10 +2,10 @@
  * @file AS5047P_Types.cpp
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This source file contains the implementation of the type definitions for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/types/AS5047P_Types.h b/src/types/AS5047P_Types.h
@@ -2,10 +2,10 @@
  * @file AS5047P_Types.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This header file contains type definitions for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/util/AS5047P_Settings.h b/src/util/AS5047P_Settings.h
@@ -2,10 +2,10 @@
  * @file AS5047P_Settings.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This header file contains settings information for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */
 

diff --git a/src/util/AS5047P_Util.h b/src/util/AS5047P_Util.h
@@ -2,10 +2,10 @@
  * @file AS5047P_Util.h
  * @author Jonas Merkle [JJM] (jonas@jjm.one)
  * @brief This header file contains util functions for the AS5047P Library.
- * @version 2.2.1
- * @date 2023-07-04
+ * @version 2.2.2
+ * @date 2024-10-19
  * 
- * @copyright Copyright (c) 2023 Jonas Merkle. This project is released under the GPL-3.0 License License.
+ * @copyright Copyright (c) 2024 Jonas Merkle. This project is released under the GPL-3.0 License License.
  * 
  */