Barcode Configuration¶

⚠️ Note: This document describes how to use the SDK's API to operate the scanning device and provides sample code in C language. Please note that the API is a synchronous operation and may block the main thread when used.

⚠️ Note: Before using the API, you need to connect the device and register for message notifications to receive messages from the device. For detailed steps, please refer to Message Notification.

1. Open All Barcodes¶

1.1 Write Command¶

To open all supported barcodes of the scanning device, use the following Bluetooth service and characteristic UUIDs for write without response operation:

Bluetooth	UUID
Service	0x0000ff0000001000800000805f9b34fb
Characteristic	0x0000ff0400001000800000805f9b34fb

Use the following command to get the data to write to the characteristic:

const char* result = inateck_scanner_cmd_open_all_code();

The return result is in JSON format. If the call is successful, result will return:

{
    "status": 0,
    "data": [0, 1, 2, 3],
}

If the call fails, result will return:

{
    "status": 1,
    "data": [],
}

1.2 Message Parsing¶

After waiting for the device to respond, you can use the following method to parse the data:

int result = inateck_scanner_cmd_check_result(data, data_length);

The return result is of type int. If the call is successful, result will return 0. If the call fails, result will return 1.

1.3 Sample Code¶

#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <unistd.h>
#include "inateck_scanner_ble.h"

int main() {
    const char* result = inateck_scanner_cmd_open_all_code();
    if (result) {
        // result is in JSON format, parse the data
        const unsigned char* data = (const unsigned char*)result;
        int data_length = strlen(result);

        // Send data via Bluetooth write without response
        // Assume there is a function send_data_via_bluetooth to send data
        send_data_via_bluetooth(data, data_length);

        // Wait for the device to respond, receive data
        // Assume there is a function receive_data_via_bluetooth to receive data
        receive_data_via_bluetooth();

        const unsigned char* data = get_received_data();
        int data_length = get_received_data_length();

        // Parse the data
        int result = inateck_scanner_cmd_check_result(data, data_length);
        if (result == 0) {
            printf("Open all code success\n");
        } else {
            printf("Open all code failed\n");
        }
    }
    return 0;
}

2. Close All Barcodes¶

2.1 Write Command¶

To close all supported barcodes of the scanning device, use the following Bluetooth service and characteristic UUIDs for write without response operation:

Bluetooth	UUID
Service	0x0000ff0000001000800000805f9b34fb
Characteristic	0x0000ff0400001000800000805f9b34fb

Use the following command to get the data to write to the characteristic:

const char* result = inateck_scanner_cmd_close_all_code();

The return result is in JSON format. If the call is successful, result will return:

{
    "status": 0,
    "data": [0, 1, 2, 3],
}

If the call fails, result will return:

{
    "status": 1,
    "data": [],
}

2.2 Message Parsing¶

After waiting for the device to respond, you can use the following method to parse the data:

int result = inateck_scanner_cmd_check_result(data, data_length);

The return result is of type int. If the call is successful, result will return 0. If the call fails, result will return 1.

2.3 Sample Code¶

#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <unistd.h>
#include "inateck_scanner_ble.h"

int main() {
    const char* result = inateck_scanner_cmd_close_all_code();
    if (result) {
        // result is in JSON format, parse the data
        const unsigned char* data = (const unsigned char*)result;
        int data_length = strlen(result);

        // Send data via Bluetooth write without response
        // Assume there is a function send_data_via_bluetooth to send data
        send_data_via_bluetooth(data, data_length);

        // Wait for the device to respond, receive data
        // Assume there is a function receive_data_via_bluetooth to receive data
        receive_data_via_bluetooth();

        const unsigned char* data = get_received_data();
        int data_length = get_received_data_length();

        // Parse the data
        int result = inateck_scanner_cmd_check_result(data, data_length);
        if (result == 0) {
            printf("Close all code success\n");
        } else {
            printf("Close all code failed\n");
        }
    }
    return 0;
}

3. Reset to Default Barcode State¶

3.1 Write Command¶

To reset the scanning device to its default barcode state, use the following Bluetooth service and characteristic UUIDs for write without response operation:

Bluetooth	UUID
Service	0x0000ff0000001000800000805f9b34fb
Characteristic	0x0000ff0400001000800000805f9b34fb

Use the following command to get the data to write to the characteristic:

const char* result = inateck_scanner_cmd_reset_all_code();

The return result is in JSON format. If the call is successful, result will return:

{
    "status": 0,
    "data": [0, 1, 2, 3],
}

If the call fails, result will return:

{
    "status": 1,
    "data": [],
}

3.2 Message Parsing¶

After waiting for the device to respond, you can use the following method to parse the data:

int result = inateck_scanner_cmd_check_result(data, data_length);

The return result is of type int. If the call is successful, result will return 0. If the call fails, result will return 1.

3.3 Sample Code¶

#include <stdio.h>
#include <string.h>
#include <stdbool.h>
#include <unistd.h>
#include "inateck_scanner_ble.h"

int main() {
    const char* result = inateck_scanner_cmd_reset_all_code();
    if (result) {
        // result is in JSON format, parse the data
        const unsigned char* data = (const unsigned char*)result;
        int data_length = strlen(result);

        // Send data via Bluetooth write without response
        // Assume there is a function send_data_via_bluetooth to send data
        send_data_via_bluetooth(data, data_length);

        // Wait for the device to respond, receive data
        // Assume there is a function receive_data_via_bluetooth to receive data
        receive_data_via_bluetooth();

        const unsigned char* data = get_received_data();
        int data_length = get_received_data_length();

        // Parse the data
        int result = inateck_scanner_cmd_check_result(data, data_length);
        if (result == 0) {
            printf("Reset all code success\n");
        } else {
            printf("Reset all code failed\n");
        }
    }
    return 0;
}