Advanced features #2

Katze719 · 2025-07-04T17:26:16Z

No description provided.

…ADME, CI, and examples

…g structure

… updating example and tests accordingly

… collecting USB device information and updating the callback mechanism; remove redundant implementation from serial.cpp

…from serial.cpp

…o examples, and usage guidelines

… enable position-independent code, link libraries statically, and update build steps in CI to use a container image.

…ng installation and build steps into a single command for improved efficiency.

…container for enhanced build capabilities.

…ontainer for improved build compatibility.

…and error handling; remove legacy serial and status_codes headers, and adjust CMake configuration to link cpp_core for improved modularity.

…criptions, error handling examples, and new convenience functions for serial communication, enhancing clarity and usability for developers.

Mqxx · 2025-07-07T06:07:10Z

.github/workflows/ci.yml

+          name: libcpp_unix_bindings
+          path: build/libcpp_unix_bindings.so


Suggested change

name: libcpp_unix_bindings

path: build/libcpp_unix_bindings.so

name: bindings_linux

path: build/bindings_linux.so

Mqxx · 2025-07-07T06:07:25Z

.github/workflows/ci.yml

        uses: softprops/action-gh-release@v1
        with:
-          files: build/libCPP-Unix-Bindings.so 
+          files: build/libcpp_unix_bindings.so 


Suggested change

files: build/libcpp_unix_bindings.so

files: build/bindings_linux.so

Mqxx · 2025-07-07T06:09:22Z

CMakeLists.txt

 set(VERSION_PATCH 0)

-set(PROJECT_N CPP-Unix-Bindings)
+set(PROJECT_N cpp_unix_bindings)


Suggested change

set(PROJECT_N cpp_unix_bindings)

set(PROJECT_N cpp_bindings_linux)

Mqxx · 2025-07-07T06:12:07Z

README.md

@@ -1,7 +1,7 @@
-# CPP-Unix-Bindings
+# cpp_unix_bindings


Suggested change

# cpp_unix_bindings

# C++ Bindings Linux

Mqxx · 2025-07-07T06:12:46Z

README.md


 A compact C++23 library for talking to serial devices on Linux (e.g. Arduino).  
-The project builds a **shared library `libCPP-Unix-Bindings.so`** that can be used via
+The project builds a **shared library `libcpp_unix_bindings.so`** that can be used via


Suggested change

The project builds a **shared library `libcpp_unix_bindings.so`** that can be used via

The project builds a **shared library `bindings_linux.so`** that can be used via

Mqxx · 2025-07-07T06:13:08Z

README.md


 # The resulting library will be located at
-#   build/libCPP-Unix-Bindings.so
+#   build/libcpp_unix_bindings.so


Suggested change

# build/libcpp_unix_bindings.so

# build/bindings_linux.so

Mqxx · 2025-07-07T06:13:24Z

README.md

 ```ts
 // serial_deno.ts
-const lib = Deno.dlopen('./build/libCPP-Unix-Bindings.so', {
+const lib = Deno.dlopen('./build/libcpp_unix_bindings.so', {


Suggested change

const lib = Deno.dlopen('./build/libcpp_unix_bindings.so', {

const lib = Deno.dlopen('./build/bindings_linux.so', {

all libs under linux are prefixed with a lib, would not go against the default here

go under /usr/lib or /usr/lib64 in any linux distro and show me one lib that has not the prefix lib and is not built by you.

…dular functions for serial communication, including read, write, and buffer management. Update CMake configuration to exclude serial.cpp and enhance project structure for improved maintainability.

…m 'function' to 'callback_fn' for improved clarity and consistency in naming conventions.

Introduce std::lock_guard to ensure thread-safe access to shared resources in serial communication functions, including buffer management and read/write operations. This change enhances the robustness of the API by preventing data races during concurrent access.

- Simplified CMakeLists.txt by removing redundant versioning variables and consolidating project setup. - Updated project to use C++23 standard and improved dependency management with CPM. - Introduced new source file `serial_list_ports.cpp` for enhanced USB port information retrieval. - Renamed `serialGetPortsInfo` to `serialListPorts` for clarity and consistency in the API. - Adjusted unit tests to reflect the new function name and ensure proper functionality.

- Updated function signatures across multiple serial API functions to improve clarity by aligning parameter formatting and spacing. - Enhanced error handling messages for better debugging and consistency in reporting invalid handles. - Adjusted unit tests to reflect changes in function signatures and maintain code quality.

…readability - Updated function signatures across multiple serial API functions to use 'auto' return type and improved parameter formatting. - Replaced std::lock_guard with std::scoped_lock for better mutex management. - Enhanced error handling messages for clarity and consistency in reporting invalid handles.

Mqxx · 2025-12-01T20:12:27Z

CMakeLists.txt

-
-set(PROJECT_N cpp_unix_bindings)
-project(${PROJECT_N} VERSION ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH})
+project(cpp_unix_bindings VERSION 1.0.0 LANGUAGES CXX)


Suggested change

project(cpp_unix_bindings VERSION 1.0.0 LANGUAGES CXX)

project(

cpp-bindings-linux

VERSION 1.0.0

DESCRIPTION "C++ Linux Bindings for the serial library"

LANGUAGES CXX

)

Also you should think about adding a VERSION variable.

yes, got something cooking for that right here https://github.com/Katze719/cmake-git-versioning

Mqxx · 2025-12-01T20:13:52Z

CMakeLists.txt

+    "GTEST_BUILD_TESTS OFF"
+    "GTEST_BUILD_EXAMPLES OFF"
+    "GTEST_BUILD_DOCS OFF"


Suggested change

"GTEST_BUILD_TESTS OFF"

"GTEST_BUILD_EXAMPLES OFF"

"GTEST_BUILD_DOCS OFF"

"GTEST_BUILD_TESTS OFF"

"GTEST_BUILD_EXAMPLES OFF"

"GTEST_BUILD_DOCS OFF"

Mqxx · 2025-12-01T20:14:59Z

CMakeLists.txt

+set_target_properties(${PROJECT_NAME} PROPERTIES
+    VERSION ${PROJECT_VERSION}
+    SOVERSION ${PROJECT_VERSION_MAJOR}
+)


Suggested change

set_target_properties(${PROJECT_NAME} PROPERTIES

VERSION ${PROJECT_VERSION}

SOVERSION ${PROJECT_VERSION_MAJOR}

)

set_target_properties(

${PROJECT_NAME}

PROPERTIES

VERSION ${PROJECT_VERSION}

SOVERSION ${PROJECT_VERSION_MAJOR}

)

Mqxx · 2025-12-01T20:15:14Z

CMakeLists.txt

+)
+
+# Test executable
 add_executable(tests


Suggested change

add_executable(tests

add_executable(

tests

Mqxx · 2025-12-01T20:15:36Z

CMakeLists.txt

 target_include_directories(tests PRIVATE ${PROJECT_SOURCE_DIR}/src)

+# Copy shared library next to test binary
 add_custom_command(TARGET tests POST_BUILD


Suggested change

add_custom_command(TARGET tests POST_BUILD

add_custom_command(

TARGET tests POST_BUILD

Mqxx · 2025-12-01T20:16:07Z

CMakeLists.txt

-    COMMENT "Copy shared library next to aggregated test binary")
+    $<TARGET_FILE:${PROJECT_NAME}>
+    $<TARGET_FILE_DIR:tests>
+    COMMENT "Copy shared library next to test binary"


What is this comment?

Mqxx · 2025-12-01T20:18:38Z

src/serial_list_ports.cpp

+extern "C" int serialListPorts(void (*callback_fn)(const char* port,
+                                                   const char* path,
+                                                   const char* manufacturer,
+                                                   const char* serialNumber,
+                                                   const char* pnpId,
+                                                   const char* locationId,
+                                                   const char* productId,
+                                                   const char* vendorId),
+                               ErrorCallbackT error_callback)


Why is this formatting still so f*ked up?

Suggested change

extern "C" int serialListPorts(void (*callback_fn)(const char* port,

const char* path,

const char* manufacturer,

const char* serialNumber,

const char* pnpId,

const char* locationId,

const char* productId,

const char* vendorId),

ErrorCallbackT error_callback)

extern "C" int serialListPorts(

void (*callback_fn)(

const char* port,

const char* path,

const char* manufacturer,

const char* serialNumber,

const char* pnpId,

const char* locationId,

const char* productId,

const char* vendorId

),

ErrorCallbackT error_callback

)

this is technically just one long type

will replace it with a using

Mqxx · 2025-12-01T20:20:10Z

Please fix the formatting like it was before.

Mqxx · 2025-12-02T14:02:56Z

docs/ffi_deno.md

Vibe coded and generated as f*ck bro 😅 No one would use … as ... in a description like that 😂

Mqxx · 2025-12-02T14:04:27Z

docs/ffi_deno.md

Also you can remove this example, since documenting this is my job 👍 You can also remove the whole TypeScript examples folder.

Mqxx · 2025-12-02T14:06:08Z

examples/serial_advanced.ts

Mqxx · 2025-12-02T14:06:17Z

examples/serial_callbacks.ts

Mqxx · 2025-12-02T14:06:26Z

examples/serial_echo.ts

Mqxx · 2025-12-02T14:27:54Z

src/serial_set_error_callback.cpp

+
+#include <cpp_core/interface/serial_set_error_callback.h>
+
+extern "C" void serialSetErrorCallback(ErrorCallbackT error_callback)


Not sure if this function is still usefull, if we have an error callback function that we pass to each function individually.

Mqxx · 2025-12-02T14:28:48Z

src/serial_set_read_callback.cpp

+
+#include <cpp_core/interface/serial_set_read_callback.h>
+
+extern "C" void serialSetReadCallback(void (*callback_fn)(int))


Same here. I am not sure if this function is usefull at all.

Mqxx · 2025-12-02T14:28:55Z

src/serial_set_write_callback.cpp

+
+#include <cpp_core/interface/serial_set_write_callback.h>
+
+extern "C" void serialSetWriteCallback(void (*callback_fn)(int))


Same here. I am not sure if this function is usefull at all.

Mqxx · 2025-12-02T14:29:38Z

src/serial_state.cpp

Why is this its own file, but the rest is crammed into one internal file (serial_internal.hpp) above?

Mqxx · 2025-12-02T14:34:35Z

tests/serial_unit_tests.cpp

Please refactor to individual unit test files next to the actual files.

Ex. File to test: serial_read.cpp, Unit test file next to it: serial_read.test.cpp

I know, for archiving this we(you) need to change the CMake again, but please do it that way. Adding/Changing/Removing indivitual tests that way is much easier and more clearer in terms of what you are doing/testing.

Katze719 added 2 commits July 4, 2025 16:59

add more functionaltity

24a0691

modernize

f0b6881

Katze719 requested a review from Mqxx July 4, 2025 17:26

Katze719 self-assigned this Jul 4, 2025

refactor project name to lowercase and update references in CMake, RE…

88149e6

…ADME, CI, and examples

Katze719 mentioned this pull request Jul 4, 2025

Full refactor, to many changes, to lazy to write commit messages #1

Closed

Katze719 added 10 commits July 5, 2025 23:21

refactor serial API to improve callback handling and update versionin…

ecca33e

…g structure

enhance serial API to provide detailed port information via callback,…

93d603b

… updating example and tests accordingly

remove unnecessary output for available serial ports in unit test

f2c3d92

implement serialGetPortsInfo in a new file, refactoring the logic for…

fc3e54a

… collecting USB device information and updating the callback mechanism; remove redundant implementation from serial.cpp

update version to 1.0.0 in CMakeLists.txt and remove unused includes …

a779b3b

…from serial.cpp

Add comprehensive documentation for C API, building instructions, Den…

dd728f4

…o examples, and usage guidelines

Enhance CMake configuration for improved portability and CI workflow;…

1cc1838

… enable position-independent code, link libraries statically, and update build steps in CI to use a container image.

Refactor CI workflow to build in manylinux2014 container, consolidati…

e843a65

…ng installation and build steps into a single command for improved efficiency.

Update CI workflow to include GCC and C++ compilers in manylinux2014 …

7794e36

…container for enhanced build capabilities.

Update CI workflow to use GCC 11 and C++ compilers in manylinux2014 c…

bb2e1ce

…ontainer for improved build compatibility.

Katze719 force-pushed the advanced-features branch from c36c1e2 to bb2e1ce Compare July 6, 2025 10:23

Katze719 added 2 commits July 6, 2025 17:18

Refactor serial API to integrate cpp_core library, updating includes …

b9f6dda

…and error handling; remove legacy serial and status_codes headers, and adjust CMake configuration to link cpp_core for improved modularity.

Update C API reference documentation to include detailed function des…

0f3ade2

…criptions, error handling examples, and new convenience functions for serial communication, enhancing clarity and usability for developers.

Mqxx reviewed Jul 7, 2025

View reviewed changes

Mqxx requested changes Jul 7, 2025

View reviewed changes

Mqxx reviewed Jul 7, 2025

View reviewed changes

README.md

@@ -1,7 +1,7 @@

# CPP-Unix-Bindings

# cpp_unix_bindings

Copy link

Member

Mqxx Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

# cpp_unix_bindings

# C++ Bindings Linux

Mqxx reviewed Jul 7, 2025

View reviewed changes

Katze719 added 5 commits July 10, 2025 20:43

Refactor serial API by removing legacy serial.cpp and implementing mo…

2420b65

…dular functions for serial communication, including read, write, and buffer management. Update CMake configuration to exclude serial.cpp and enhance project structure for improved maintainability.

Refactor serialGetPortsInfo function to rename callback parameter fro…

9d5476e

…m 'function' to 'callback_fn' for improved clarity and consistency in naming conventions.

Mqxx requested changes Dec 1, 2025

View reviewed changes

Mqxx requested changes Dec 2, 2025

View reviewed changes

Katze719 closed this Dec 2, 2025

Katze719 deleted the advanced-features branch December 2, 2025 18:31

		name: libcpp_unix_bindings
		path: build/libcpp_unix_bindings.so

	files: build/libcpp_unix_bindings.so
	files: build/bindings_linux.so

	set(PROJECT_N cpp_unix_bindings)
	set(PROJECT_N cpp_bindings_linux)

	The project builds a shared library `libcpp_unix_bindings.so` that can be used via
	The project builds a shared library `bindings_linux.so` that can be used via

	const lib = Deno.dlopen('./build/libcpp_unix_bindings.so', {
	const lib = Deno.dlopen('./build/bindings_linux.so', {

	add_custom_command(TARGET tests POST_BUILD
	add_custom_command(
	TARGET tests POST_BUILD


		#include <cpp_core/interface/serial_set_error_callback.h>

		extern "C" void serialSetErrorCallback(ErrorCallbackT error_callback)


		#include <cpp_core/interface/serial_set_read_callback.h>

		extern "C" void serialSetReadCallback(void (*callback_fn)(int))


		#include <cpp_core/interface/serial_set_write_callback.h>

		extern "C" void serialSetWriteCallback(void (*callback_fn)(int))

Advanced features #2

Advanced features #2

Uh oh!

Conversation

Katze719 commented Jul 4, 2025

Uh oh!

Mqxx Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mqxx commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Mqxx Jul 7, 2025 •

edited

Loading

Mqxx commented Dec 1, 2025 •

edited

Loading