Merge pull request #21 from uv-software/development

Release candidate 1 for version 0.5.1

Author: uv-software

Deployment.md

@@ -1,4 +1,4 @@
-### CAN API V3 Wrapper Library for Peak-System PCAN® Interfaces (Windows®)
+### CAN API V3 Wrapper Library for PEAK-System PCAN® Interfaces (Windows®)
 
 _Copyright © 2005-2024 Uwe Vogt, UV Software, Berlin ([email protected])_ \
 _All rights reserved._

Doxygen/Doxyfile

@@ -54,7 +54,7 @@ PROJECT_NUMBER         = v0.5
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "CAN API V3 Wrapper Library for Peak-System PCAN Interfaces (Windows)"
+PROJECT_BRIEF          = "CAN API V3 Wrapper Library for PEAK-System PCAN Interfaces (Windows)"
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55

Libraries/CANAPI/uvcanpcb.rc

@@ -1,4 +1,4 @@
-### CAN API V3 Wrapper Library for Peak-System PCAN® Interfaces (Windows®)
+### CAN API V3 Wrapper Library for PEAK-System PCAN® Interfaces (Windows®)
 
 _Copyright © 2005-2024  Uwe Vogt, UV Software, Berlin ([email protected])_
 
@@ -10,14 +10,14 @@ CAN API V3 is a wrapper specification to have a uniform CAN Interface API for va
 
 ## PCANBasic-Wrapper
 
-This repo contains the source code for a CAN API V3 compatible wrapper library under Windows for PCAN Interfaces from Peak-System Technik GmbH.
+This repo contains the source code for a CAN API V3 compatible wrapper library under Windows for PCAN Interfaces from PEAK-System Technik GmbH.
 The wrapper library is build upon Peak´s PCANBasic DLL.
 
 ### CAN Interface API, Version 3
 
 ```C++
 /// \name   PeakCAN API
-/// \brief  CAN API V3 driver for Peak-System PCAN interfaces
+/// \brief  CAN API V3 driver for PEAK-System PCAN interfaces
 /// \note   See CCanApi for a description of the overridden methods
 /// \{
 class CPeakCAN : public CCanApi {
@@ -146,7 +146,7 @@ For a list of known bugs and caveats see tab [Issues](https://github.com/uv-soft
 
 ### PCANBasic DLL for Windows®
 
-The PCANBasic DLL can be downloaded form [Peak-System](https://www.peak-system.com/) website. \
+The PCANBasic DLL can be downloaded form [PEAK-System](https://www.peak-system.com/) website. \
 Please note the copyright and license agreements.
 
 ### Wrapper Library for macOS® and Linux®
@@ -168,7 +168,7 @@ You can choose between one of them if you use these portions of this work in who
 ### Trademarks
 
 Windows is a registered trademark of Microsoft Corporation in the United States and/or other countries. \
-PCAN is a registered trademark of Peak-System Technik GmbH, Darmstadt, Germany. \
+PCAN is a registered trademark of PEAK-System Technik GmbH, Darmstadt, Germany. \
 Mac and macOS are trademarks of Apple Inc., registered in the U.S. and other countries. \
 Linux is a registered trademark of Linus Torvalds. \
 All other company, product and service names mentioned herein may be trademarks, registered trademarks, or service marks of their respective owners.

Libraries/PeakCAN/PeakCAN.rc

@@ -2,3 +2,7 @@
 # we don't use the JSON files yet
 can_dev.?
 vanilla.?
+# other blacklisted files
+SerialCAN_Defines.h
+SocketCAN_Defines.h
+RocketCAN_Defines.h

README.md

@@ -75,7 +75,7 @@
 ///
 /// \author      $Author: quaoar $
 //
-/// \version     $Rev: 1286 $
+/// \version     $Rev: 1294 $
 //
 /// \defgroup    can_api CAN Interface API, Version 3
 /// \{
@@ -477,8 +477,16 @@ class CANCPP CCanApi {
     //
     virtual char *GetFirmwareVersion() = 0;  // deprecated
 
-    /// \brief       retrieves version information of the CAN API V3 driver
-    ///              as a zero-terminated string.
+#if (OPTION_CANAPI_LIBRARY != 0)
+    /// \brief       retrieves version information of the CAN API V3 wrapper
+    ///              library as a zero-terminated string.
+    //
+    /// \returns     pointer to a zero-terminated string, or NULL on error.
+    //
+    virtual char *GetSoftwareVersion() = 0;  // deprecated
+#endif
+    /// \brief       retrieves version information of the CAN API V3 wrapper
+    ///              (or loader) library as a zero-terminated string.
     //
     /// \returns     pointer to a zero-terminated string, or NULL on error.
     //
@@ -528,4 +536,4 @@ class CANCPP CCanApi {
 /// \}
 #endif // CANAPI_H_INCLUDED
 /// \}
-// $Id: CANAPI.h 1286 2024-05-10 17:03:31Z quaoar $  Copyright (c) UV Software //
+// $Id: CANAPI.h 1294 2024-05-16 19:50:25Z quaoar $  Copyright (c) UV Software //

Sources/CANAPI/.gitignore

@@ -49,9 +49,9 @@
  *
  *  @brief       CAN API V3 for generic CAN Interfaces - Definitions and Options
  *
- *  @author      $Author: eris $
+ *  @author      $Author: quaoar $
  *
- *  @version     $Rev: 1270 $
+ *  @version     $Rev: 1293 $
  *
  *  @addtogroup  can_api
  *  @{
@@ -79,23 +79,25 @@ extern "C" {
 
 /** @name  Library IDs
  *  @brief Unique IDs to identify a CAN API library (CAN API V1 compatible)
+ *  @note  These defines are still valid, but IDs are taken from JSON files.
  *  @{ */
 #define CANLIB_IXXAT_VCI        100     /**< IXXAT Virtual CAN interfaces */
 #define CANLIB_IXXAT_CAC        800     /**< IXXAT canAnalyzer/32 Client */
-#define CANLIB_PEAK_PCAN        200     /**< PEAK PCAN interfaces */
+#define CANLIB_PEAK_PCAN        200     /**< PEAK PCAN-Light interfaces */
 #define CANLIB_VECTOR_XL        300     /**< Vector XL-Driver library */
 #define CANLIB_PCANBASIC        400     /**< PEAK PCAN-Basic interfaces */
-#define CANLIB_RUSOKU_LT        500     /**< Rusuko TouCAN interfaces */
+#define CANLIB_RUSOKU_LT        500     /**< Rusoku TouCAN interfaces */
 #define CANLIB_KVASER_32        600     /**< Kvaser CANLIB (canlib32) */
 #define CANLIB_ROCKETCAN        700     /**< CAN-over-IP (RocketCAN) */
 #define CANLIB_SERIALCAN        900     /**< Serial-Line (SerialCAN) */
-#define CANLIB_SOCKETCAN        1000    /**< Linux CAN (SocketCAN) */
+#define CANLIB_SOCKETCAN        1000    /**< Linux-CAN (SocketCAN) */
 #define CANLIB_CANAPILIB        (-1)    /**< CAN API Main Library */
-/** @note  Peak's PCAN-Light DLL is outdated, so the library ID can be reused.
+/** @note  PCAN-Light is outdated, its ID is reused by macCAN-PeakCAN.
  *  @} */
 
 /** @name  Library Names
  *  @brief Filenames of the CAN API libraries (depending on the platform)
+ *  @note  Theses defines are outdated. DLL names are taken from JSON files.
  *  @{ */
 #if defined(__linux__)
  #define CANAPI_PLATFORM       "Linux"
@@ -154,9 +156,9 @@ extern "C" {
 #define CAN_API_WEBSITE        "www.uv-software.com"
 #define CAN_API_CONTACT        "[email protected]"
 #define CAN_API_LICENSE        "BSD-2-Clause OR GPL-3.0-or-later"
-#define CAN_API_COPYRIGHT      "Copyright (c) 2005-20%02u, UV Software, Berlin"
-#define CAN_API_HAZARD_NOTE    "Do not connect your CAN device to a real CAN network when using this program.\n" \
-                               "This can damage your application."
+#define CAN_API_COPYRIGHT      "Copyright (c) 2004-20%02u, UV Software, Berlin"
+#define CAN_API_HAZARD_NOTE    "If you connect your CAN device to a real CAN network when using this library,\n" \
+                               "you might damage your application."
 /** @} */
 
 

Sources/CANAPI/CANAPI.h

@@ -3,7 +3,7 @@
 _Copyright © 2004-2024 Uwe Vogt, UV Software, Berlin ([email protected])_ \
 _All rights reserved._
 
-Version $Rev: 1289 $
+Version $Rev: 1312 $
 
 # A CAN Interface Wrapper Specification
 

Sources/CANAPI/CANAPI_Defines.h

@@ -53,7 +53,6 @@
 #endif
 #endif
 #include "PeakCAN.h"
-#include "Version.h"
 
 #include "can_defs.h"
 #include "can_api.h"