Readme files c wrapper

Kyrylo · cyrillicw · commit 651941185128 · 2025-08-06T13:02:49.000+02:00
diff --git a/examples/c/CMakeLists.txt b/examples/c/CMakeLists.txt
@@ -1,13 +1,22 @@
 cmake_minimum_required(VERSION 3.10)
 project(scanbotsdk_c_example C)
-
 set(CMAKE_C_STANDARD 99)
 
+# Find or download Scanbot SDK
+if(NOT SCANBOTSDK_VERSION)
+    message(FATAL_ERROR "SCANBOTSDK_VERSION is not set.")
+endif()
+if(NOT SCANBOTSDK_API_TOKEN)
+    message(FATAL_ERROR "SCANBOTSDK_API_TOKEN is not set.")
+endif()
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/")
 set(SCANBOTSDK_DIR "${CMAKE_CURRENT_BINARY_DIR}/scanbotsdk")
-set(SCANBOTSDK_API_TOKEN "<SCANBOTSDK_API_KEY>") # Replace with your actual API key
-set(SCANBOTSDK_VERSION "<SCANBOTSDK_VERSION>") # Replace with the desired version, e.g., "1.0.0"
-include(FindScanbotSDK.cmake)
+find_package(ScanbotSDK REQUIRED)
+
+add_library(scanbotsdk SHARED IMPORTED)
+set_target_properties(scanbotsdk PROPERTIES
+    IMPORTED_LOCATION "${ScanbotSDK_LIBS}"
+    INTERFACE_INCLUDE_DIRECTORIES "${ScanbotSDK_INCLUDE_DIRS}"
+)
 
-add_executable(scanbotsdk_c_example main.c)
-target_link_libraries(scanbotsdk_c_example PRIVATE ${ScanbotSDK_LIBS})
-target_include_directories(scanbotsdk_c_example PRIVATE ${ScanbotSDK_INCLUDE_DIRS})
+add_subdirectory(barcode)
diff --git a/examples/c/README.md b/examples/c/README.md
@@ -0,0 +1,50 @@
+# API Documentation
+The API documentation is accessible here:
+* [Scanbot SDK - C API](https://api-docs.scanbot.io/document-scanner-sdk/linux/c-api/index.html)
+
+# Installation
+
+## NVidia Jetson
+
+> Scanbot SDK requires Jetpack 6.1, CUDA 12.6 and TensorRT 10.3 to run with GPU acceleration.
+
+* Install a C compiler, CMake and wget:
+
+```bash
+sudo apt install -y cmake build-essential wget
+```
+
+* Optionally, install CUDA and TensorRT for GPU acceleration. Make sure that you're running a supported Jetpack version.
+
+```bash
+sudo apt install -y nvidia-l4t-cuda libnvinfer10 libnvinfer-plugin10 libnvonnxparsers10
+```
+
+* You're now ready to run the examples.
+
+----
+
+## Raspberry Pi OS, Ubuntu, Debian
+
+* Install a C compiler, CMake and wget:
+
+```bash
+sudo apt install -y cmake build-essential wget
+```
+
+* You're now ready to build the examples.
+
+# Building the Examples
+In order to build all examples, run the following commands:
+
+```bash
+mkdir build
+cd build
+cmake -DSCANBOTSDK_VERSION=<SCANBOTSDK_VERSION> -DSCANBOTSDK_API_TOKEN=<SCANBOTSDK_API_TOKEN> ..
+make
+```
+
+Replace `SCANBOTSDK_VERSION` and `SCANBOTSDK_API_TOKEN` with the avlues you received from us.
+
+# Running the Examples
+See the `README.md` files in the individual example directories for instructions on how to run them.
diff --git a/examples/c/barcode/CMakeLists.txt b/examples/c/barcode/CMakeLists.txt
@@ -0,0 +1,2 @@
+add_subdirectory(live)
+add_subdirectory(minimal)
diff --git a/examples/c/barcode/live/CMakeLists.txt b/examples/c/barcode/live/CMakeLists.txt
@@ -0,0 +1,7 @@
+cmake_minimum_required(VERSION 3.10)
+project(barcode_live C)
+
+file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/example.png" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
+
+add_executable(${PROJECT_NAME} main.c)
+target_link_libraries(${PROJECT_NAME} PRIVATE scanbotsdk)
diff --git a/examples/c/barcode/live/README.md b/examples/c/barcode/live/README.md
@@ -0,0 +1,11 @@
+# Barcode Scanner Live Mode Example
+
+This example demonstrates how to use barcode scanner functionality in live mode.
+It uses mock camera to simulate frames coming from a camera device.
+
+You should provide it with the image you want to be used as a camera frame.
+
+## Usage
+```bash
+<build_directory>/barcode/live/barcode_live <license_key> <image_path>
+```
diff --git a/examples/c/barcode/live/example.png b/examples/c/barcode/live/example.png
diff --git a/examples/c/barcode/live/main.c b/examples/c/barcode/live/main.c
@@ -217,11 +217,13 @@ int main(int argc, char *argv[]) {
     }
     // endregion
 
+    // region create barcode scanner
     ec = create_barcode_scanner(&barcode_scanner);
     if (ec != SCANBOTSDK_OK) {
         fprintf(stderr, "Failed to create barcode scanner: %d: %s\n", ec, error_message(ec));
         goto exit;
     }
+    // endregion
 
     // region create mock camera that always returns the same frame
     ec = init_camera(mock_frame_path, &camera);
diff --git a/examples/c/barcode/minimal/CMakeLists.txt b/examples/c/barcode/minimal/CMakeLists.txt
@@ -0,0 +1,7 @@
+cmake_minimum_required(VERSION 3.10)
+project(barcode_minimal C)
+
+file(COPY "${CMAKE_CURRENT_SOURCE_DIR}/example.png" DESTINATION "${CMAKE_CURRENT_BINARY_DIR}")
+
+add_executable(${PROJECT_NAME} main.c)
+target_link_libraries(${PROJECT_NAME} PRIVATE scanbotsdk)
diff --git a/examples/c/barcode/minimal/README.md b/examples/c/barcode/minimal/README.md
@@ -0,0 +1,8 @@
+# Barcode Scanner Minimal Example
+
+This example demonstrates the simplest way to use barcode scanner to process a single image.
+
+## Usage
+```bash
+<build_directory>/barcode/minimal/barcode_minimal <license_key> <image_path>
+```
diff --git a/examples/c/barcode/minimal/example.png b/examples/c/barcode/minimal/example.png
diff --git a/examples/c/barcode/minimal/main.c b/examples/c/barcode/minimal/main.c
@@ -0,0 +1,130 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <ScanbotSDK.h>
+
+const char *error_message(scanbotsdk_error_code_t ec) {
+    if (ec == SCANBOTSDK_ERROR_INVALID_LICENSE_STATUS) {
+        return "Invalid license status. Please check your license key.";
+    }
+    return scanbotsdk_error_message();
+}
+
+scanbotsdk_error_code_t process_image(scanbotsdk_barcode_scanner_t *scanner, const char *path) {
+    scanbotsdk_error_code_t ec = SCANBOTSDK_OK;
+    scanbotsdk_path_image_load_options_t *image_load_options = NULL;
+    scanbotsdk_image_t *image = NULL;
+    scanbotsdk_barcode_scanner_result_t *result = NULL;
+
+    // region create scanbotsdk_image_t from frame
+    bool image_is_live = true;
+    scanbotsdk_path_image_load_options_create_with_defaults(&image_load_options);
+
+    ec = scanbotsdk_image_create_from_path(path, image_load_options, &image);
+    if (ec != SCANBOTSDK_OK) {
+        goto exit;
+    }
+    // endregion
+
+    // region run barcode scanner on the image
+    ec = scanbotsdk_barcode_scanner_run(scanner, image, &result);
+
+    if (ec != SCANBOTSDK_OK) {
+        goto exit;
+    }
+    bool success = false;
+    scanbotsdk_barcode_scanner_result_get_success(result, &success);
+    if (!success) {
+        fprintf(stdout, "No barcodes found");
+    } else {
+        size_t barcodeCount = 0;
+        scanbotsdk_barcode_scanner_result_get_barcodes_size(result, &barcodeCount);
+        fprintf(stdout, "%zu barcodes found", barcodeCount);
+        scanbotsdk_barcode_item_t **barcodes = malloc(barcodeCount * sizeof(scanbotsdk_barcode_item_t *));
+        scanbotsdk_barcode_scanner_result_get_barcodes(result, barcodes, barcodeCount);
+        for (size_t i = 0; i < barcodeCount; i++) {
+            const char *text = NULL;
+            scanbotsdk_barcode_item_get_text(barcodes[i], &text);
+            fprintf(stdout, "Barcode %zu: %s\n", i, text);
+        }
+        free(barcodes);
+    }
+    // endregion
+
+    exit:
+    scanbotsdk_path_image_load_options_free(image_load_options);
+    scanbotsdk_image_free(image);
+    scanbotsdk_barcode_scanner_result_free(result);
+    return ec;
+}
+
+scanbotsdk_error_code_t create_barcode_scanner(scanbotsdk_barcode_scanner_t **barcode_scanner) {
+    scanbotsdk_error_code_t ec = SCANBOTSDK_OK;
+    scanbotsdk_barcode_scanner_configuration_t *barcode_scanner_configuration = NULL;
+
+    scanbotsdk_barcode_scanner_configuration_create_with_defaults(
+            &barcode_scanner_configuration);
+    ec = scanbotsdk_barcode_scanner_create(barcode_scanner_configuration, barcode_scanner);
+    if (ec != SCANBOTSDK_OK) {
+        goto exit;
+    }
+
+    exit:
+    scanbotsdk_barcode_scanner_configuration_free(barcode_scanner_configuration);
+    return ec;
+}
+
+int main(int argc, char *argv[]) {
+    if (argc < 3) {
+        fprintf(stderr, "Usage: %s <license_key> <path_to_camera_mock_image>\n", argv[0]);
+        return 1;
+    }
+
+    const int initialization_timeout_ms = 15000;
+    const int deregister_device_timeout_ms = 15000;
+
+    scanbotsdk_barcode_scanner_t *barcode_scanner = NULL;
+
+    const char *license_key = argv[1];
+    const char *image_path = argv[2];
+
+    // region initialize Scanbot SDK
+    scanbotsdk_init_params_t params;
+    params.license_key = license_key;
+    params.writeable_path = ".";
+
+    scanbotsdk_error_code_t ec;
+    ec = scanbotsdk_initialize(&params);
+    if (ec != SCANBOTSDK_OK) {
+        fprintf(stderr, "Failed to initialize Scanbot SDK: %d: %s\n", ec, error_message(ec));
+        goto exit;
+    }
+    ec = scanbotsdk_wait_for_online_license_check_completion(initialization_timeout_ms);
+    if (ec != SCANBOTSDK_OK) {
+        fprintf(stderr, "Failed to wait for online license check completion: %d: %s\n", ec,
+                error_message(ec));
+        goto exit;
+    }
+    // endregion
+
+    // region create barcode scanner
+    ec = create_barcode_scanner(&barcode_scanner);
+    if (ec != SCANBOTSDK_OK) {
+        fprintf(stderr, "Failed to create barcode scanner: %d: %s\n", ec, error_message(ec));
+        goto exit;
+    }
+    // endregion
+
+    // region process image
+    process_image(barcode_scanner, image_path);
+    // endregion
+
+    exit:
+    scanbotsdk_barcode_scanner_free(barcode_scanner);
+    // If you are not using floating license, it is not necessary to call device deregistration.
+    scanbotsdk_deregister_device();
+    scanbotsdk_wait_for_device_deregistration_completion(deregister_device_timeout_ms);
+
+    return (ec == SCANBOTSDK_OK) ? 0 : 1;
+}
+
diff --git a/examples/c/cmake/FindScanbotSDK.cmake b/examples/c/cmake/FindScanbotSDK.cmake

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+add_subdirectory(live)`
	`2`	`+add_subdirectory(minimal)`
Original file line number	Diff line number	Diff line change
`@@ -217,11 +217,13 @@ int main(int argc, char *argv[]) {`
`217`	`217`	`}`
`218`	`218`	`// endregion`
`219`	`219`
	`220`	`+ // region create barcode scanner`
`220`	`221`	`ec = create_barcode_scanner(&barcode_scanner);`
`221`	`222`	`if (ec != SCANBOTSDK_OK) {`
`222`	`223`	`fprintf(stderr, "Failed to create barcode scanner: %d: %s\n", ec, error_message(ec));`
`223`	`224`	`goto exit;`
`224`	`225`	`}`
	`226`	`+ // endregion`
`225`	`227`
`226`	`228`	`// region create mock camera that always returns the same frame`
`227`	`229`	`ec = init_camera(mock_frame_path, &camera);`