version 1.0.0

.github/workflows/build.yml

@@ -0,0 +1,92 @@
+name: Build Binarys
+
+on:
+  push:
+    paths:
+      - 'src/**'
+      - '.github/workflows/build.yml'
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:    
+  build_linux:
+    name: Build linux binaries
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: linux-binary
+        path: ${{github.workspace}}/build/src/libserialport.so
+
+  build_windows:
+    name: Build win64 binaries
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Configure CMake
+      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+
+    - name: Build
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@v3
+      with:
+        name: windows-binary
+        path: ${{github.workspace}}\build\src\Release\serialport.dll
+
+  commit:
+    needs: [build_windows, build_linux]
+    name: Commit binaries
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal access token.
+          fetch-depth: 0 # otherwise, there would be errors pushing refs to the destination repository.
+
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          path: ${{github.workspace}}/tmp
+
+      - name: Create bin folder if it does not exist
+        run: mkdir -p ${{github.workspace}}/lib/bin
+
+      - name: Move and rename linux binary
+        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/lib/bin/linux.so
+
+      - name: Move and rename windows binary
+        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/lib/bin/windows.dll
+
+      - name: Configure Git
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+
+      - name: Commit binaries
+        run: |
+          git add ${{github.workspace}}/lib/bin/*
+          git diff-index --quiet HEAD || git commit -m "Commited compiled binaries"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.RELEASE_TOKEN }}
+          branch: ${{ github.ref }}
+

.github/workflows/release.yml

@@ -2,17 +2,11 @@
 name: "Pre-Release"
 
 on:
-  push:
-    branches: [ "main" ]
-    paths:
-      - 'include/**'
-      - 'src/**'
-      - '.github/workflows/release.yml'
   pull_request:
     branches: [ "main" ]
     paths:
-      - 'include/**'
       - 'src/**'
+      - '.github/workflows/release.yml'
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
@@ -69,18 +63,18 @@ jobs:
           path: ${{github.workspace}}/tmp
 
       - name: Rename linux Binary
-        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/lib/dls/linux.so
+        run: mv ${{github.workspace}}/tmp/linux-binary/libserialport.so ${{github.workspace}}/lib/bin/linux.so
 
       - name: Rename windows Binary
-        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/lib/dls/windows.dll
+        run: mv ${{github.workspace}}/tmp/windows-binary/serialport.dll ${{github.workspace}}/lib/bin/windows.dll
 
       - run: cd ${{github.workspace}}
 
       - name: make .tar.gz file
-        run: tar -czvf lib.tar.gz ./lib
+        run: tar -czvf SerialLink-lib.tar.gz ./lib
 
       - name: make .zip
-        run: zip -r lib.zip ./lib
+        run: zip -r SerialLink-lib.zip ./lib
 
       - uses: "marvinpinto/action-automatic-releases@latest"
         with:
@@ -89,5 +83,5 @@ jobs:
           prerelease: true
           title: "Development Build"
           files: |
-            lib.tar.gz
-            lib.zip
+            SerialLink-lib.tar.gz
+            SerialLink-lib.zip

.gitignore

@@ -1,6 +1,5 @@
 #directories
 .vscode/
 .cache/
-.github/
 build/
 test/

CMakeLists.txt

@@ -1,46 +1,11 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.22)
 
 set(PROJECT_N serialport)
 project(${PROJECT_N} VERSION 1.0)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
 
-set(LIB true)
-
-file(GLOB_RECURSE SRCS ${PROJECT_SOURCE_DIR}/src/*.cpp)
-
-# a macro that gets all of the header containing directories. 
-MACRO(header_directories return_list includes_base_folder extention )
-    FILE(GLOB_RECURSE new_list ${includes_base_folder}/*.${extention})
-    SET(dir_list "")
-    FOREACH(file_path ${new_list})
-        GET_FILENAME_COMPONENT(dir_path ${file_path} PATH)
-        SET(dir_list ${dir_list} ${dir_path})
-    ENDFOREACH()
-    LIST(REMOVE_DUPLICATES dir_list)
-    SET(${return_list} ${dir_list})
-ENDMACRO()
-
-# using said macro.
-header_directories(INCLUDES ${PROJECT_SOURCE_DIR}/include/ hpp)
-
-message("src files:")
-foreach(file ${SRCS})
-        message(STATUS ${file})
-endforeach()
-
-message("include directories:")
-foreach(dir ${INCLUDES})
-        message(STATUS ${dir})
-endforeach()
-
-if(LIB)
-    add_library(${PROJECT_N} SHARED ${SRCS})
-else()
-    add_executable(${PROJECT_N} ${SRCS}) 
-endif(LIB)
+add_subdirectory(src)
 
 target_include_directories(${PROJECT_N} PUBLIC include)
-
-# set(CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS} "-shared -fPIC -Wall")

README.md

@@ -1,11 +1,9 @@
 <!-- Badges -->
-[Build Win32 DLL]: https://img.shields.io/github/actions/workflow/status/TypeScriptPlayground/Serial/build_windows.yml?label=Build%20Win32%20DLL&labelColor=343b42&logo=github&logoColor=959DA5 'Win32 Build'
-[Build Linux SO]: https://img.shields.io/github/actions/workflow/status/TypeScriptPlayground/Serial/build_linux.yml?label=Build%20Linux%20SO&labelColor=343b42&logo=github&logoColor=959DA5 'Linux Build'
+[Build binaries]: https://img.shields.io/github/actions/workflow/status/TypeScriptPlayground/Serial/build_windows.yml?label=Build%20binaries&labelColor=343b42&logo=github&logoColor=959DA5 'Build binaries'
 [Release Downloads]: https://img.shields.io/github/downloads/TypeScriptPlayground/Serial/total?label=Downloads%20&labelColor=343b42&logo=docusign&logoColor=959DA5 'Total Release Downloads'
 
 # Serial
-[![Build Win32 DLL]](https://github.com/TypeScriptPlayground/Serial/actions/workflows/build_windows.yml)
-[![Build Linux SO]](https://github.com/TypeScriptPlayground/Serial/actions/workflows/build_linux.yml)
+[![Build binaries]](https://github.com/TypeScriptPlayground/Serial/actions/workflows/build.yml)
 [![Release Downloads]](https://github.com/TypeScriptPlayground/Serial/releases)
 
 <a href="https://deno.land"><img align="right" src="https://deno.land/logo.svg" height="150px" alt="the deno mascot dinosaur standing in the rain"></a>
@@ -33,10 +31,10 @@ This library provides an interface for the communication with serial devices and
 - Works on different operating systems (check [compatibility](#compatibility) for mor info).
 
 ## Compatibility
-| OS      | Tested version   | Current state |
-|---------|------------------|---------------|
-| Windows | Windows 10 (x64) | implemented   |
-| Linux   | -                | in progress   |
+| OS      | Tested version          | Current state |
+|---------|-------------------------|---------------|
+| Windows | Windows 10 (x64)        | implemented   |
+| Linux   | Ubuntu Server 22.04 LTS | implemented   |
 
 ## Possible/Known issues
 - What happens if you open multiple connections from the same instance.
@@ -45,6 +43,10 @@ This library provides an interface for the communication with serial devices and
 - Linux write currently not working
 
 ## Examples - How to use
+To use this library you need the following flags to run it:
+- `--unstable`
+- `--allow-ffi`
+
 ### Ports
 Get a list with all serial ports and their info that are currently available on your system.
 
@@ -77,17 +79,17 @@ Send data to a serial device. For exampe to an [Arduino](https://www.arduino.cc/
 
 `main.ts`
 ```typescript
-import { Serial } from "./mod.ts";
+import { Serial, baudrate } from "./mod.ts";
 
 // create new instance of a serial object
 const serial = new Serial();
 
 // open the connection
-serial.open();
+serial.open('COM1', baudrate.B9600);
 
 // encode the message to a Uint8Array
-const textToSend = 'Hello from TypeScript!'
-const encodedTextToSend = new TextEncoder().encode(textToSend)
+const textToSend = 'Hello from TypeScript!';
+const encodedTextToSend = new TextEncoder().encode(textToSend);
 
 // send the message
 serial.send(encodedTextToSend, encodedTextToSend.length);
@@ -113,13 +115,13 @@ void loop() {
 
 `main.ts`
 ```typescript
-import { Serial } from "./mod.ts";
+import { Serial, baudrate } from "./mod.ts";
 
 // create new instance of a serial object
 const serial = new Serial();
 
 // open the connection
-serial.open();
+serial.open('COM1', baudrate.B9600);
 
 // create a new buffer to store incoming bytes,
 // in this example we want to read a maximum of 100 bytes