Release candidate 1 for version 1.0

.gitattributes

@@ -0,0 +1,5 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Never modify line endings of bash scripts
+*.sh text eol=lf

.gitignore

@@ -0,0 +1,11 @@
+# .gitignore
+.svn
+.objects
+build_no.h
+checker_*.txt
+Utilities/Driver
+Utilities/Binaries
+Utilities/can_moni/can_moni
+Utilities/can_test/can_test
+Utilities/can_moni/build_no.h
+Utilities/can_test/build_no.h

README.md

@@ -1,15 +1,17 @@
-### macOS® Utilities for PCAN-USB Interfaces
+### macOS® Utilities for PEAK-System PCAN USB Interfaces
 
-*Copyright © 2012-2024 by UV Software, Berlin.*\
-*All rights reserved.*
+*Copyright © 2005-2010 by Uwe Vogt, UV Software, Friedrichshafen.* \
+*Copyright © 2012-2024 by Uwe Vogt, UV Software, Berlin.*
+
+![macOS Build](https://github.com/mac-can/PCBUSB-Utilities/actions/workflows/macos-build.yml/badge.svg)
 
 # Running CAN and CAN FD on Mac®
 
-The PCBUSB library realizes a CAN to USB user-space driver under macOS for PCAN-USB interfaces from PEAK-System Technik, Darmstadt.
+The PCBUSB library realizes a CAN to USB user-space driver under macOS for PCAN USB interfaces from PEAK-System Technik, Darmstadt.
 It supports up to 8 PCAN-USB or PCAN-USB FD devices.
 
 The dynamic library libPCBUSB is running under macOS 10.13 and later (x86_64 architecture).
-Since version 0.10.1 it is running under macOS Big Sur (11.x) or macOS Monterey (12.x) as Universal macOS Binary.  
+Since version 0.10.1 it is running under macOS Big Sur (11.x) and later as Universal macOS Binary.  
 
 See the [MacCAN](https://www.mac-can.com/) website to learn more.
 
@@ -19,8 +21,6 @@ This repo offers two command line tools that are build upon the PCBUSB library:
 - `can_moni` to view incoming CAN messages
 - `can_test` to test CAN communication
 
-Both tools run as a standalone program, therefor it is not necessary to install the PCBUSB library to run them.
-
 ### can_moni
 
 `can_moni` is a command line tool to view incoming CAN messages.
@@ -39,45 +39,68 @@ Type `can_test --help` to display all program options.
 
 ### Target Platform
 
-- macOS 12.0 and later (Intel and Apple silicon)
+- macOS 13.0 and later (Intel and Apple silicon)
 
 ### Development Environment
 
-#### macOS Sonoma
+#### macOS Sequoia
 
-- macOS Sonoma (14.5) on a Mac mini (M1, 2020)
-- Apple clang version 15.0.0 (clang-1500.3.9.4)
-- Xcode Version 15.4 (15F31d)
+- macOS Sequoia (15.2) on a Mac mini (M1, 2020)
+- Apple clang version 16.0.0 (clang-1600.0.26.6)
 
-#### macOS Monterey
+#### macOS Ventura
 
-- macOS Monterey (12.7.5) on a MacBook Pro (2019)
-- Apple clang version 13.0.0 (clang-1300.0.29.30)
-- Xcode Version 13.2.1 (13C100)
+- macOS Ventura (13.7.1) on a MacBook Pro (2019)
+- Apple clang version 14.0.3 (clang-1403.0.22.14.1)
 
 ### Supported Devices
 
 Only the following devices from PEAK-System Technik are supported:
 - PCAN-USB (product code: IPEH-002021, IPEH-002022)
 - PCAN-USB FD (product code: IPEH-004022)
+- PCAN-USB Pro FD (item no. IPEH-004061), but only the first channel (CAN1)
 
 ### Known Bugs and Caveats
 
-For a list of known bugs and caveats in the underlying PCBUSB library read the documentation of the appropriated library version.
+- For a list of known bugs and caveats see tab [Issues](https://github.com/mac-can/PCBUSB-Utilities/issues) in the GitHub repo.
+- For a list of known bugs and caveats in the underlying PCBUSB library read the documentation of the appropriated library version.
+
+### Licenses
+
+This repository contains two versions of the PCBUSB utilities that are licensed under different licences:
+
+- **Standalone Version**:
+  This version of the utilities does not require the PCBUSB library to be installed.
+  The utilities are offered in binary form only.
+  This version can be found in the folder `$(PROJROOT)/Binaries`.
+- **Open-source Version**:
+  This version links the PCBUSB library at runtime.
+  The PCBUSB library itself is not part of this work.
+  See folder `$(PROJROOT)/Utilities`.
 
-PCAN-USB Pro FD devices are supported since version 0.10 of the PCBUSB library, but only the first channel (CAN1).
+#### Licence for the Standalone Version
 
-## This and That
+This program is freeware without any warranty or support! \
+Please note the copyright and license agreements.
 
-Since version 0.5.3 macOS 11 or newer is required to run the PCBUSB utilities as Universal macOS Binary.
+#### Licence for the Open-Source Version
 
-This repo contains only binaries files of the PCBUSB utilities.
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
 
-### License
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-The PCBUSB utilities are freeware without any warranty or support!
+You should have received a copy of the GNU General Public License along
+with this program; if not, see <https://www.gnu.org/licenses/>.
 
-Please note the copyright and license agreement.
+Note:  The libPCBUSB is licensed under a freeware license without any
+warranty or support.  The libPCBUSB is not part of this program.
+It can be downloaded from <https://www.mac-can.com/>.
 
 ### Trademarks
 

Utilities/Makefile

@@ -0,0 +1,45 @@
+#
+#	CAN Utilities for PEAK-System PCAN USB Interfaces (macOS, x86_64 & arm64)
+#
+#	Copyright (c) 2007-2010 Uwe Vogt, UV Software, Friedrichshafen
+#	Copyright (c) 2012-2024 Uwe Vogt, UV Software, Berlin (info@mac-can.com)
+#
+#	These utilities are free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	These utilities is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with these utilities.  If not, see <https://www.gnu.org/licenses/>.
+#
+all:
+	@rm -r build_no.h 2> /dev/null || true
+	@./build_no.sh
+	@echo "\033[1mBuilding my beloved CAN Utilities...\033[0m"
+	$(MAKE) -C can_test $@
+	$(MAKE) -C can_moni $@
+
+clean:
+	$(MAKE) -C can_test $@
+	$(MAKE) -C can_moni $@
+
+pristine:
+	$(MAKE) -C can_test $@
+	$(MAKE) -C can_moni $@
+
+install:
+#	$(MAKE) -C can_test $@
+#	$(MAKE) -C can_moni $@
+
+check:
+	$(MAKE) -C can_test $@ 2> checker_test.txt
+	$(MAKE) -C can_moni $@ 2> checker_moni.txt
+
+build_no:
+	@./build_no.sh
+	@cat ./build_no.h