ZebraScanSDK Documentation

ZebraScanSDK is a library developed by Infomaniak Network SA for Android applications to easily integrate and manage Zebra barcode scanners using DataWedge. This documentation provides an overview of the library's features, installation instructions, and usage examples.

Installation

To use ZebraScanSDK in your Android project, follow these installation steps:

Gradle

Add the Jitpack repository to your project's build.gradle file's repositories section:

maven { url 'https://jitpack.io' }

Add the following dependency to your project's build.gradle file:

implementation 'com.github.infomaniak:ZebraScanSDK:1.0.0'

Sync your project with Gradle files to make sure the library is downloaded.

Usage

Using ZebraScanSDK in Compose

@Composable
fun MyComposable() {
    val scannerBinding = rememberScannerBinding(profileName = "MyScannerProfile")

    ZebraScannerCompose(
        scannerBinding = scannerBinding,
        onDecodedData = { data ->
            // Handle the decoded data
        },
        onErrorResulted = { error ->
            // Handle scanner errors
        },
        onStatusChanged = { status ->
            // Handle scanner status
        },
        onReceiveDataWedgeVersion = { dataWedgeVersion ->
            // Handle DataWedge version
        },
    )
}

Using ZebraScanSDK without Compose

class MyActivity : AppCompatActivity() {
    private val zebraScannerBinding: ZebraScannerBinding by lazy {
        ZebraScannerBinding(this, "MyScannerProfile")
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        zebraScannerBinding.bind(lifecycle = this)

        // Implement your scanner data and error handling logic here
    }
}

Example Project

To see ZebraScanSDK in action, you can explore the ZebraScanSDKDemo project available in the same repository. This open-source project provides a comprehensive example of how to integrate and use the library in a real-world Android application.

Contributions

We welcome contributions from the developer community. If you would like to contribute to ZebraScanSDK, please do so by creating a pull request. We appreciate your input in improving the library and making it more user-friendly.

License

Infomaniak ZebraScanSDK - Android
Copyright (C) 2023 Infomaniak Network SA

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.