Introduction

This document provides a comprehensive technical reference for the Lector8xx / CLV8xx Command Protocol, the command interface used to access configuration parameters, status information, diagnostic data, and executable actions of the reader. The protocol enables integration with PLCs, host computers, engineering tools, service applications, and custom software through a simple and human-readable command interface. The Text Command Protocol is available through multiple communication channels, including: * Ethernet TCP/IP * Serial (data) * Serial (service) * Fieldbus

All protocol messages use mandatory framing characters to ensure reliable command parsing and transmission. Every command sent to the device and every response returned by the device must be enclosed between a Start of Text (STX, Hex ASCII 0x02) character and an End of Text (ETX, Hex ASCII 0x03) character. The device will only process commands that are correctly framed with STX and ETX.

Command Types

The protocol supports three fundamental command types:

Read Commands

Read commands retrieve the current value of a device parameter.

Example: <STX>read DeviceName<ETX> Response: <STX>read DeviceName "Lector85x"<ETX>

Write Commands

Write commands modify the value of a writable parameter.

Example: <STX>write DeviceName "Reader01"<ETX> Response: <STX>written DeviceName<ETX>

Run Commands

Run commands execute device methods or actions.

Example: <STX>run ApplyParameterChanges<ETX> Response: <STX>run ApplyParameterChanges<ETX>

Parameter Change and Activation Concept

The protocol distinguishes between parameter modification and parameter activation. When parameters are written, the new values are first stored in the device configuration but are not yet active. Multiple parameters can therefore be modified consecutively without immediately affecting the running application. To make pending configuration changes effective, the following action must be executed:

<STX>run ApplyParameterChanges<ETX>

Only after successful execution of ApplyParameterChanges all pending parameter changes are transferred into the active device configuration and used by the running application. This mechanism allows several related parameters to be changed together and activated simultaneously, preventing inconsistent intermediate configurations.

Data Types

The protocol supports the following data types:

  • Boolean values
  • Signed and unsigned integers
  • Floating-point numbers
  • Enumerations
  • Strings
  • Arrays
  • Structured data types

Each parameter entry in this document contains the supported data type, valid value range and example command sequences.

Working with Complex Data Types

Many parameters use complex data structures such as arrays, structures. When modifying such parameters, it is highly recommended to first read the current parameter value from the device before performing a write operation.

Recommended workflow:

  1. Read the parameter from the device.
  2. Inspect the returned data structure and field names.
  3. Copy the returned response payload.
  4. Replace the command keyword read with write.
  5. Modify only the required values within the returned structure.
  6. Send the updated command back to the device.
  7. Execute ApplyParameterChanges to activate the modified configuration.
  8. Execute SavePermanent if the changes shall remain available after a reboot or power cycle.

Example:

  • Read the parameter from the device:
    <STX>read ExampleParameter<ETX>

  • Response:
    <STX>read ExampleParameter {"FieldA":1,"FieldB":true}<ETX>

  • Modify the structure and write it back:
    <STX>write ExampleParameter {"FieldA":5,"FieldB":true}<ETX>

  • Finally activate the changes:
    <STX>run ApplyParameterChanges<ETX>

  • Save the changed parameters permanently in the device:
    <STX>run SavePermanent<ETX>

This workflow ensures that the transmitted structure exactly matches the format expected by the device and minimizes the risk of syntax, structure, or data type errors.

Frequently Used Actions

In addition to parameter access, the protocol provides executable actions that perform device-level operations. The following actions are used during commissioning, maintenance, and remote administration:

ApplyParameterChanges

Activates all pending parameter modifications that have been written to the device. Modified parameters are temporarily stored immediately but do not affect device operation until this action is executed.

<STX>run ApplyParameterChanges<ETX>

SavePermanent

Stores the current parameter set in non-volatile memory so that the configuration is retained after a reboot or power cycle.

<STX>run SavePermanent<ETX>

RebootDevice

Performs a controlled restart of the device.

<STX>run RebootDevice<ETX>

LoadAppDefaults

Restores all application-related parameters to their default values while retaining device-specific settings and infrastructure configuration. The communication interfaces are not reset.

<STX>run LoadAppDefaults<ETX>

LoadFactoryDefaults

Restores the complete device configuration to factory-default settings. This action removes all user-specific and application-specific configurations.

<STX>run LoadFactoryDefaults<ETX>

Typical Configuration Workflow

A recommended sequence for parameter configuration is:

  1. Optional: Reset the device to factory or application defaults.
  2. Read existing parameter values.
  3. Modify the required parameters using write commands. For complex structures, use the returned data as the template for modifications.
  4. Execute ApplyParameterChanges.
  5. Recommended: Evaluate device responses and implement suitable error handling mechanisms.
  6. Optional: Verify the active configuration using read commands.
  7. Execute SavePermanent if the changes shall survive a reboot.
  8. Optional: Execute RebootDevice if required by the modified settings.

This workflow provides the safest and most reliable method for remote configuration and maintenance of Lector8xx and CLV8xx devices.

Error Handling

If a parameter access or action execution cannot be completed successfully, the device returns an error response. The following error types may be returned:

  • Parsing Failed – Command syntax could not be interpreted.
  • Invalid Data – Supplied data format is invalid.
  • Internal Server Error – Internal device error occurred.
  • Access Denied – Insufficient permissions for the requested operation.
  • Not Found – Parameter or action does not exist.
  • Out Of Range – Value exceeds the supported range.
  • Out Of Bounds – Array index or structure element is invalid.
  • Read Only – Attempt to modify a read-only parameter.
  • Illegal Value – Value is syntactically correct but not allowed.

Applications integrating the protocol should always evaluate responses and implement appropriate error handling and recovery mechanisms.

General Communication Recommendations

  • Always transmit commands enclosed within STX and ETX.
  • Wait for the corresponding device response before sending the next command.
  • Validate parameter ranges before performing write operations.
  • Group multiple parameter modifications and execute ApplyParameterChanges only after all changes have been written.
  • Evaluate all returned status and error messages to ensure successful command execution.
  • Use read commands to verify the active configuration after applying parameter changes.

This document serves as the authoritative reference for all parameters, methods, data types, access restrictions, and protocol conventions available through the Lector8xx / CLV8xx Command Protocol interface.

Device Layout and CAN

4 items

NetDeviceID

Variable Read/Write

This parameter sets the CAN ID for the Primary device in the CAN network. The value must be in the range of 1 to 63.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read NetDeviceID<ETX>
Response:
<STX>read NetDeviceID 1<ETX>
Write Parameter
Request:
<STX>write NetDeviceID 1<ETX>
Response:
<STX>written NetDeviceID<ETX>

DeviceRole

Variable Read/Write

This parameter specifies whether the device operates as a Standalone unit or as the Primary device in a CAN network. In case 'Primary' is selected, the parameters 'NetDeviceID' and 'DeviceMonitoringList' must be configured accordingly.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Standalone
  • 1 = Secondary
  • 2 = Primary
Read Parameter
Request:
<STX>read DeviceRole<ETX>
Response:
<STX>read DeviceRole 0<ETX>
Write Parameter
Request:
<STX>write DeviceRole 0<ETX>
Response:
<STX>written DeviceRole<ETX>

DeviceMonitoringList

Variable Read/Write

This parameter sets the secondary device CAN IDs that the Primary device will monitor in the CAN network. The IDs should be provided as a comma-separated list (e.g., '1,4,3'). Each ID must be in the range of 1 to 63. Twice the same ID is not allowed. The IDs have to match the CAN IDs configured in the secondary devices. Maximum of 6 IDs can be configured.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read DeviceMonitoringList<ETX>
Response:
<STX>read DeviceMonitoringList "example"<ETX>
Write Parameter
Request:
<STX>write DeviceMonitoringList "example"<ETX>
Response:
<STX>written DeviceMonitoringList<ETX>

CAN1Baudrate

Variable Read/Write

This parameter sets the CAN baud rate for communication in the CAN network. The available options range from 20 kBit/sec to 1000 kBit/sec, allowing selection based on network requirements and cable length considerations.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_1000kB
  • 1 = TX_800kB
  • 2 = TX_500kB
  • 3 = TX_250kB
  • 4 = TX_125kB
  • 5 = TX_100kB
  • 6 = TX_50kB
  • 7 = TX_20kB
Read Parameter
Request:
<STX>read CAN1Baudrate<ETX>
Response:
<STX>read CAN1Baudrate 2<ETX>
Write Parameter
Request:
<STX>write CAN1Baudrate 2<ETX>
Response:
<STX>written CAN1Baudrate<ETX>

Interfaces configuration

4 items

EtherIPAddress

Variable Read/Write

This parameter sets the static IP address for the Ethernet P1 TCP/IP interface. It is used when the addressing mode is set to 'Static'. The IP address should be provided in standard notation e.g. 192.168.0.1.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 4):
USINT (0 ... 255)
Read Parameter
Request:
<STX>read EtherIPAddress<ETX>
Response:
<STX>read EtherIPAddress [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write EtherIPAddress [0, 0, 0]<ETX>
Response:
<STX>written EtherIPAddress<ETX>

EtherIPGateAddress

Variable Read/Write

This parameter sets the default gateway for the Ethernet P1 TCP/IP interface. It is optionally used when the addressing mode is set to 'Static'. The default gateway address determines the path for network traffic destined for remote networks. The IP address should be provided in standard notation e.g. 192.168.0.1.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 4):
USINT (0 ... 255)
Read Parameter
Request:
<STX>read EtherIPGateAddress<ETX>
Response:
<STX>read EtherIPGateAddress [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write EtherIPGateAddress [0, 0, 0]<ETX>
Response:
<STX>written EtherIPGateAddress<ETX>

EtherIPMask

Variable Read/Write

This parameter sets the subnet mask for the Ethernet P1 TCP/IP interface. It is used when the addressing mode is set to 'Static'. The subnet mask should be provided in standard notation e.g. 255.255.255.0

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 4):
USINT (0 ... 255)
Read Parameter
Request:
<STX>read EtherIPMask<ETX>
Response:
<STX>read EtherIPMask [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write EtherIPMask [0, 0, 0]<ETX>
Response:
<STX>written EtherIPMask<ETX>

EtherAddressingMode

Variable Read/Write

This parameter defines the addressing mode for the Ethernet P1 TCP/IP interface. It allows selection between a static IP address configuration and dynamic IP assignment via DHCP. Choosing 'Static' requires manual entry of the IP address, subnet mask, and default gateway, while 'DHCP' enables automatic configuration by a DHCP server.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_IP_STATIC
  • 1 = TX_IP_DHCP
Read Parameter
Request:
<STX>read EtherAddressingMode<ETX>
Response:
<STX>read EtherAddressingMode 0<ETX>
Write Parameter
Request:
<STX>write EtherAddressingMode 0<ETX>
Response:
<STX>written EtherAddressingMode<ETX>

Device time server NTP

2 items

TimeClientServerName

Variable Read/Write

This parameter sets the IP address or hostname of the NTP server used for device time configuration. The device will synchronize its internal clock with the specified NTP server to ensure accurate timekeeping. The port number for NTP communication is fixed at 123 and cannot be changed.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read TimeClientServerName<ETX>
Response:
<STX>read TimeClientServerName "example"<ETX>
Write Parameter
Request:
<STX>write TimeClientServerName "example"<ETX>
Response:
<STX>written TimeClientServerName<ETX>

TimeZoneToUse

Variable Read/Write

This parameter sets the time zone for the device's internal clock. The time zone determines the offset from Coordinated Universal Time (UTC) and accounts for local time variations such as daylight saving time. Selecting the correct time zone is important for accurate timekeeping and scheduling of events based on local time.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read TimeZoneToUse<ETX>
Response:
<STX>read TimeZoneToUse "Etc/GMT"<ETX>
Write Parameter
Request:
<STX>write TimeZoneToUse "Etc/GMT"<ETX>
Response:
<STX>written TimeZoneToUse<ETX>

Application type

7 items

ConveyorType

Variable Read/Write

This parameter specifies the type of conveying equipment being used in the application. The options include 'Belt Conveyor' and 'Roller Conveyor'. Selecting the appropriate conveyor type is important for optimizing the device's performance and ensuring accurate measurements, as different conveyor types may have varying characteristics that can affect the operation of the device.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = BeltConveyor
  • 1 = WoodTray
  • 2 = MetalTray
  • 3 = Roller
  • 4 = CrossBelt
  • 5 = WorkpieceCarrier
Read Parameter
Request:
<STX>read ConveyorType<ETX>
Response:
<STX>read ConveyorType 0<ETX>
Write Parameter
Request:
<STX>write ConveyorType 0<ETX>
Response:
<STX>written ConveyorType<ETX>

ConveyorSpeedMax

Variable Read/Write

This parameter defines the maximum speed of the conveyor in meters per second. Setting the correct maximum speed is essential for camera reading settings optimization and ensuring accurate data capture. The device will adjust its parameters based on the specified speed to maintain optimal performance during operation.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read ConveyorSpeedMax<ETX>
Response:
<STX>read ConveyorSpeedMax 2.5<ETX>
Write Parameter
Request:
<STX>write ConveyorSpeedMax 2.5<ETX>
Response:
<STX>written ConveyorSpeedMax<ETX>

ReadingWidth

Variable Read/Write

This parameter sets the width of the conveying equipment in millimeters. The reading width is a parameter for ensuring that the camera can accurately capture and process data from objects passing over the conveyor. Setting the correct width helps optimize the device's camera reading performance and ensures reliable operation in conveyor applications.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read ReadingWidth<ETX>
Response:
<STX>read ReadingWidth 800<ETX>
Write Parameter
Request:
<STX>write ReadingWidth 800<ETX>
Response:
<STX>written ReadingWidth<ETX>

TransportSpeedMax

Variable Read/Write

This parameter defines the maximum speed of the robot or vehicle in meters per second. Setting the correct maximum speed is essential for optimizing camera reading settings and ensuring accurate data capture during operation. The device will adjust its parameters based on the specified speed to maintain optimal performance while the robot or vehicle is in motion.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read TransportSpeedMax<ETX>
Response:
<STX>read TransportSpeedMax 2.5<ETX>
Write Parameter
Request:
<STX>write TransportSpeedMax 2.5<ETX>
Response:
<STX>written TransportSpeedMax<ETX>

ReadingDistanceVariation

Variable Read/Write

This parameter sets the maximum variation in working distances for the moving robot or vehicle application type. Setting an appropriate value for this parameter is crucial for ensuring optimal camera reading performance, especially in environments where the distance between the device and the target may change frequently.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read ReadingDistanceVariation<ETX>
Response:
<STX>read ReadingDistanceVariation 500<ETX>
Write Parameter
Request:
<STX>write ReadingDistanceVariation 500<ETX>
Response:
<STX>written ReadingDistanceVariation<ETX>

FlickerFreeMode

Variable Read/Write

This parameter controls the illumination flicker behavior and should be used to avoid flashing when people are permanently within the illumination cone. The '60Hz' setting allows flickering, while the '80Hz' setting prevents flickering. Note: The 'Prevent flickering' setting reduces the maximum object distance and limits device performance. Enable it only if necessary.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Disabled
  • 1 = 60Hz
  • 2 = 80Hz
Read Parameter
Request:
<STX>read FlickerFreeMode<ETX>
Response:
<STX>read FlickerFreeMode 1<ETX>
Write Parameter
Request:
<STX>write FlickerFreeMode 1<ETX>
Response:
<STX>written FlickerFreeMode<ETX>

ImageFlipped

Variable Read/Write

This parameter enables image flipping for mirror reading scenarios. When enabled, the device will adjust its image processing settings to correctly interpret mirrored images.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ImageFlipped<ETX>
Response:
<STX>read ImageFlipped false<ETX>
Write Parameter
Request:
<STX>write ImageFlipped false<ETX>
Response:
<STX>written ImageFlipped<ETX>

Object

10 items

MaxObjectWidth

Variable Read/Write

This parameter sets the maximum width of objects in millimeters for conveyor applications. Defining the maximum object width is needed for optimizing camera settings and ensuring accurate detection and processing of items on the conveyor belt.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read MaxObjectWidth<ETX>
Response:
<STX>read MaxObjectWidth 300<ETX>
Write Parameter
Request:
<STX>write MaxObjectWidth 300<ETX>
Response:
<STX>written MaxObjectWidth<ETX>

MinObjectWidth

Variable Read/Write

This parameter sets the minimum width of objects in millimeters for conveyor applications. Defining the minimum object width is needed for optimizing camera settings and ensuring accurate detection and processing of items on the conveyor belt.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read MinObjectWidth<ETX>
Response:
<STX>read MinObjectWidth 100<ETX>
Write Parameter
Request:
<STX>write MinObjectWidth 100<ETX>
Response:
<STX>written MinObjectWidth<ETX>

MaxObjectHeight

Variable Read/Write

This parameter sets the maximum height of objects in millimeters for conveyor applications. Defining the maximum object height is needed optimizing camera settings and ensuring accurate detection and processing of items on the conveyor belt.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read MaxObjectHeight<ETX>
Response:
<STX>read MaxObjectHeight 800<ETX>
Write Parameter
Request:
<STX>write MaxObjectHeight 800<ETX>
Response:
<STX>written MaxObjectHeight<ETX>

MinObjectHeight

Variable Read/Write

This parameter sets the minimum height of objects in millimeters for conveyor applications. Defining the minimum object height is needed for optimizing camera settings and ensuring accurate detection and processing of items on the conveyor belt.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read MinObjectHeight<ETX>
Response:
<STX>read MinObjectHeight 50<ETX>
Write Parameter
Request:
<STX>write MinObjectHeight 50<ETX>
Response:
<STX>written MinObjectHeight<ETX>

ShippingBagsEnabled

Variable Read/Write

This parameter enables flat-type objects, such as shipping bags or envelopes. When enabled, the device will adjust its settings to effectively identify and process these types of items, which are typically thin.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ShippingBagsEnabled<ETX>
Response:
<STX>read ShippingBagsEnabled false<ETX>
Write Parameter
Request:
<STX>write ShippingBagsEnabled false<ETX>
Response:
<STX>written ShippingBagsEnabled<ETX>

OtherObjectsEnabled

Variable Read/Write

This parameter enables other types of objects that do not fall into the predefined categories. When enabled, the device will adjust its settings to effectively identify and process a variety of miscellaneous items.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OtherObjectsEnabled<ETX>
Response:
<STX>read OtherObjectsEnabled false<ETX>
Write Parameter
Request:
<STX>write OtherObjectsEnabled false<ETX>
Response:
<STX>written OtherObjectsEnabled<ETX>

ParcelsEnabled

Variable Read/Write

This parameter enables parcel-type objects. When enabled, the device will optimize its settings to accurately identify and process packages, which are typically box-shaped items.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ParcelsEnabled<ETX>
Response:
<STX>read ParcelsEnabled true<ETX>
Write Parameter
Request:
<STX>write ParcelsEnabled true<ETX>
Response:
<STX>written ParcelsEnabled<ETX>

ToteBoxesEnabled

Variable Read/Write

This parameter enables container-type objects, such as tote boxes. When enabled, the device will optimize its settings to accurately identify and process these types of items.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ToteBoxesEnabled<ETX>
Response:
<STX>read ToteBoxesEnabled false<ETX>
Write Parameter
Request:
<STX>write ToteBoxesEnabled false<ETX>
Response:
<STX>written ToteBoxesEnabled<ETX>

MaxNumberCodesPerObject

Variable Read/Write

This parameter defines the maximum number of codes that can be read per object. Setting this parameter helps optimize the camera's reading performance, especially in applications where multiple codes may be present on a single object.

Type Information

USINT (0 ... 255)
Read Parameter
Request:
<STX>read MaxNumberCodesPerObject<ETX>
Response:
<STX>read MaxNumberCodesPerObject 1<ETX>
Write Parameter
Request:
<STX>write MaxNumberCodesPerObject 1<ETX>
Response:
<STX>written MaxNumberCodesPerObject<ETX>

ReadingDistanceVariability

Variable Read/Write

This parameter allows users to specify the variability in object distance. It can be set to either constant or variable, depending on the application's requirements. A constant setting is suitable for scenarios where the distance between the device and the target remains unchanged, while a variable setting is ideal for applications where the distance may fluctuate.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Constant
  • 1 = Variable
Read Parameter
Request:
<STX>read ReadingDistanceVariability<ETX>
Response:
<STX>read ReadingDistanceVariability 1<ETX>
Write Parameter
Request:
<STX>write ReadingDistanceVariability 1<ETX>
Response:
<STX>written ReadingDistanceVariability<ETX>

Code settings

79 items

MinimumModuleSize1D

Variable Read/Write

This parameter defines the minimum module width for 1D codes in millimeters. The module width is a needed dimension that affects the readability and accuracy of code scanning. Setting an appropriate minimum module width helps optimize the camera's performance for reading 1D codes of varying sizes.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read MinimumModuleSize1D<ETX>
Response:
<STX>read MinimumModuleSize1D 0.33<ETX>
Write Parameter
Request:
<STX>write MinimumModuleSize1D 0.33<ETX>
Response:
<STX>written MinimumModuleSize1D<ETX>

CodeLabelSize1D

Variable Read/Write

This parameter sets the maximum length of 1D codes in millimeters. Defining the maximum code length is essential for optimizing the camera's reading performance, as it allows the device to adjust its settings to effectively capture and decode longer codes.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CodeLabelSize1D<ETX>
Response:
<STX>read CodeLabelSize1D 72<ETX>
Write Parameter
Request:
<STX>write CodeLabelSize1D 72<ETX>
Response:
<STX>written CodeLabelSize1D<ETX>

CBARStaStoIdent

Variable Read/Write

This parameter determines whether the Codabar barcodes use identical start and stop signs. When enabled, the device will expect the same character to be used for both the start and stop of the barcode, which is a common requirement in certain Codabar applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CBARStaStoIdent<ETX>
Response:
<STX>read CBARStaStoIdent false<ETX>
Write Parameter
Request:
<STX>write CBARStaStoIdent false<ETX>
Response:
<STX>written CBARStaStoIdent<ETX>

CBARStaStoTransmit

Variable Read/Write

This parameter controls whether the start and stop signs of Codabar barcodes are transmitted in the output data. When enabled, the device will include these signs in the scanned data, which can be useful for certain applications that require complete barcode information.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CBARStaStoTransmit<ETX>
Response:
<STX>read CBARStaStoTransmit false<ETX>
Write Parameter
Request:
<STX>write CBARStaStoTransmit false<ETX>
Response:
<STX>written CBARStaStoTransmit<ETX>

CBARCheckDigitTest

Variable Read/Write

This parameter specifies the type of check digit test to be applied for Codabar barcodes. It allows users to choose from different check digit algorithms, enhancing the accuracy and reliability of barcode scanning by ensuring data integrity.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_None
  • 1 = TX_Modulo_10
  • 2 = TX_7DR
  • 3 = TX_Modulo_16
  • 255 = TX_Specific
Read Parameter
Request:
<STX>read CBARCheckDigitTest<ETX>
Response:
<STX>read CBARCheckDigitTest 0<ETX>
Write Parameter
Request:
<STX>write CBARCheckDigitTest 0<ETX>
Response:
<STX>written CBARCheckDigitTest<ETX>

CBARLengthMode

Variable Read/Write

This parameter defines the mode for specifying the number of characters in Codabar barcodes. It allows the user to choose between free length, a specific range, or a fixed number of characters, enabling customization based on application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read CBARLengthMode<ETX>
Response:
<STX>read CBARLengthMode 0<ETX>
Write Parameter
Request:
<STX>write CBARLengthMode 0<ETX>
Response:
<STX>written CBARLengthMode<ETX>

CBARFixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for Codabar barcodes when the length mode is set to 'Fixed number'. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for their applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CBARFixLenList<ETX>
Response:
<STX>read CBARFixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write CBARFixLenList [0, 0, 0]<ETX>
Response:
<STX>written CBARFixLenList<ETX>

CBARIntLenList

Variable Read/Write

This parameter defines the range of character lengths for Codabar barcodes when the length mode is set to 'Range'. It allows users to specify minimum and maximum character counts, providing flexibility in barcode length while ensuring they fall within acceptable limits for their specific applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CBARIntLenList<ETX>
Response:
<STX>read CBARIntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write CBARIntLenList [0, 0]<ETX>
Response:
<STX>written CBARIntLenList<ETX>

C128Active

Variable Read/Write

This parameter specifies the activation of the standard Code 128 variant. When enabled, the device will be set to read and process standard Code 128 barcodes, which are commonly used for various applications including logistics and product labeling.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C128Active<ETX>
Response:
<STX>read C128Active true<ETX>
Write Parameter
Request:
<STX>write C128Active true<ETX>
Response:
<STX>written C128Active<ETX>

EAN128Active

Variable Read/Write

This parameter enables the GS1-128 variant of Code 128 barcodes. When activated, the device will be configured to read and process GS1-128 barcodes, which are commonly used in supply chain management and logistics for encoding additional data such as batch numbers and expiration dates.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EAN128Active<ETX>
Response:
<STX>read EAN128Active false<ETX>
Write Parameter
Request:
<STX>write EAN128Active false<ETX>
Response:
<STX>written EAN128Active<ETX>

C128LengthMode

Variable Read/Write

This parameter defines the mode for specifying the number of characters in Code 128 barcodes. It allows the user to choose between free length, a specific range, or a fixed number of characters, enabling customization based on application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read C128LengthMode<ETX>
Response:
<STX>read C128LengthMode 0<ETX>
Write Parameter
Request:
<STX>write C128LengthMode 0<ETX>
Response:
<STX>written C128LengthMode<ETX>

C128FixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for Code 128 barcodes when the length mode is set to 'Fixed number'. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for their applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C128FixLenList<ETX>
Response:
<STX>read C128FixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write C128FixLenList [0, 0, 0]<ETX>
Response:
<STX>written C128FixLenList<ETX>

C128IntLenList

Variable Read/Write

This parameter defines the range of character lengths for Code 128 barcodes when the length mode is set to 'Range'. It allows users to specify minimum and maximum character counts, providing flexibility in barcode length while ensuring they fall within acceptable limits for their specific applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C128IntLenList<ETX>
Response:
<STX>read C128IntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write C128IntLenList [0, 0]<ETX>
Response:
<STX>written C128IntLenList<ETX>

C25ILCheckDigitTestL1

Variable Read/Write

This parameter specifies the type of check digit test to be applied for 2 of 5 Interleaved barcodes. It allows users to choose from different check digit algorithms, enhancing the accuracy and reliability of barcode scanning by ensuring data integrity.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_None
  • 1 = TX_Modulo_10
  • 2 = TX_1R18
  • 3 = TX_W49M10
  • 5 = TX_W12CSM10
  • 6 = TX_ModModulo_11
Read Parameter
Request:
<STX>read C25ILCheckDigitTestL1<ETX>
Response:
<STX>read C25ILCheckDigitTestL1 0<ETX>
Write Parameter
Request:
<STX>write C25ILCheckDigitTestL1 0<ETX>
Response:
<STX>written C25ILCheckDigitTestL1<ETX>

C25ILFixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for 2 of 5 Interleaved barcodes when the length mode is set to 'Fixed number'. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for their applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C25ILFixLenList<ETX>
Response:
<STX>read C25ILFixLenList [2, 2, 2]<ETX>
Write Parameter
Request:
<STX>write C25ILFixLenList [2, 2, 2]<ETX>
Response:
<STX>written C25ILFixLenList<ETX>

C39StaStoTransmit

Variable Read/Write

This parameter controls whether the start and stop characters of Code 39 barcodes are transmitted in the output data. When enabled, the device will include these characters in the scanned data, which can be useful for certain applications that require complete barcode information.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C39StaStoTransmit<ETX>
Response:
<STX>read C39StaStoTransmit false<ETX>
Write Parameter
Request:
<STX>write C39StaStoTransmit false<ETX>
Response:
<STX>written C39StaStoTransmit<ETX>

C39FullASCII

Variable Read/Write

This parameter enables the full ASCII mode for Code 39 barcodes. When activated, the device will be able to read and process the extended character set of Code 39, which includes all 128 ASCII characters, allowing for greater flexibility in encoding data.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C39FullASCII<ETX>
Response:
<STX>read C39FullASCII false<ETX>
Write Parameter
Request:
<STX>write C39FullASCII false<ETX>
Response:
<STX>written C39FullASCII<ETX>

C39CheckDigitTest

Variable Read/Write

This parameter specifies the type of check digit test to be applied for Code 39 barcodes. It allows users to choose from different check digit algorithms, enhancing the accuracy and reliability of barcode scanning by ensuring data integrity.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_None
  • 1 = TX_Modulo_10
  • 2 = TX_Modulo_43
Read Parameter
Request:
<STX>read C39CheckDigitTest<ETX>
Response:
<STX>read C39CheckDigitTest 0<ETX>
Write Parameter
Request:
<STX>write C39CheckDigitTest 0<ETX>
Response:
<STX>written C39CheckDigitTest<ETX>

C39LengthMode

Variable Read/Write

This parameter defines the mode for specifying the number of characters in Code 39 barcodes. It allows the user to choose between free length, a specific range, or a fixed number of characters, enabling customization based on application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read C39LengthMode<ETX>
Response:
<STX>read C39LengthMode 0<ETX>
Write Parameter
Request:
<STX>write C39LengthMode 0<ETX>
Response:
<STX>written C39LengthMode<ETX>

C39FixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for Code 39 barcodes when the length mode is set to 'Fixed number'. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for their applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C39FixLenList<ETX>
Response:
<STX>read C39FixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write C39FixLenList [0, 0, 0]<ETX>
Response:
<STX>written C39FixLenList<ETX>

C39IntLenList

Variable Read/Write

This parameter defines the range of character lengths for Code 39 barcodes when the length mode is set to 'Range'. It allows users to specify minimum and maximum character counts, providing flexibility in barcode length while ensuring they fall within acceptable limits for their specific applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C39IntLenList<ETX>
Response:
<STX>read C39IntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write C39IntLenList [0, 0]<ETX>
Response:
<STX>written C39IntLenList<ETX>

C93LengthMode

Variable Read/Write

This parameter defines the mode for specifying the number of characters in Code 93 barcodes. It allows the user to choose between free length, a specific range, or a fixed number of characters, enabling customization based on application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read C93LengthMode<ETX>
Response:
<STX>read C93LengthMode 0<ETX>
Write Parameter
Request:
<STX>write C93LengthMode 0<ETX>
Response:
<STX>written C93LengthMode<ETX>

C93FixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for Code 93 barcodes when the length mode is set to 'Fixed number'. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for their applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C93FixLenList<ETX>
Response:
<STX>read C93FixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write C93FixLenList [0, 0, 0]<ETX>
Response:
<STX>written C93FixLenList<ETX>

C93IntLenList

Variable Read/Write

This parameter defines the range of character lengths for Code 93 barcodes when the length mode is set to 'Range'. It allows users to specify minimum and maximum character counts, providing flexibility in barcode length while ensuring they fall within acceptable limits for their specific applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C93IntLenList<ETX>
Response:
<STX>read C93IntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write C93IntLenList [0, 0]<ETX>
Response:
<STX>written C93IntLenList<ETX>

UPCAActive

Variable Read/Write

This parameter enables the UPC A code variant. When activated, the device will be able to read and process UPC A barcodes, which are commonly used in retail for product identification and pricing.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read UPCAActive<ETX>
Response:
<STX>read UPCAActive true<ETX>
Write Parameter
Request:
<STX>write UPCAActive true<ETX>
Response:
<STX>written UPCAActive<ETX>

UPCEActive

Variable Read/Write

This parameter enables the UPC E code variant. When activated, the device will be able to read and process UPC E barcodes, which are a compressed version of UPC A and are often used for smaller packages.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read UPCEActive<ETX>
Response:
<STX>read UPCEActive true<ETX>
Write Parameter
Request:
<STX>write UPCEActive true<ETX>
Response:
<STX>written UPCEActive<ETX>

UPCEExtended

Variable Read/Write

This parameter enables the UPC E Extended option. When activated, the device will be able to read and process UPC E barcodes that include an additional two-digit extension, which is often used for indicating item variations such as size or weight.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read UPCEExtended<ETX>
Response:
<STX>read UPCEExtended false<ETX>
Write Parameter
Request:
<STX>write UPCEExtended false<ETX>
Response:
<STX>written UPCEExtended<ETX>

UPCENumSystem

Variable Read/Write

This parameter controls the transmission of the UPC E Extended Number System digit. When enabled, the device will include this digit in the output data when reading UPC E barcodes with an extension, providing additional information that may be required for certain applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read UPCENumSystem<ETX>
Response:
<STX>read UPCENumSystem false<ETX>
Write Parameter
Request:
<STX>write UPCENumSystem false<ETX>
Response:
<STX>written UPCENumSystem<ETX>

EAN8Active

Variable Read/Write

This parameter enables the EAN 8 code variant. When activated, the device will be able to read and process EAN 8 barcodes, which are commonly used for small packages and items due to their compact size.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EAN8Active<ETX>
Response:
<STX>read EAN8Active true<ETX>
Write Parameter
Request:
<STX>write EAN8Active true<ETX>
Response:
<STX>written EAN8Active<ETX>

EAN13Active

Variable Read/Write

This parameter enables the EAN 13 code variant. When activated, the device will be able to read and process EAN 13 barcodes, which are widely used in retail for product identification and inventory management.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EAN13Active<ETX>
Response:
<STX>read EAN13Active true<ETX>
Write Parameter
Request:
<STX>write EAN13Active true<ETX>
Response:
<STX>written EAN13Active<ETX>

PharmaActive

Variable Read/Write

This parameter activates the Pharmacode codetype. When enabled, the device will be configured to read and process Pharmacode barcodes, which are specifically designed for pharmaceutical packaging and labeling to ensure accurate identification and tracking of medications. Note that with enabling Pharmacode all other code types have to be disabled!

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PharmaActive<ETX>
Response:
<STX>read PharmaActive false<ETX>
Write Parameter
Request:
<STX>write PharmaActive false<ETX>
Response:
<STX>written PharmaActive<ETX>

PharmLength

Variable Read/Write

This parameter specifies the fixed number of characters for Pharmacode barcodes. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for pharmaceutical applications.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read PharmLength<ETX>
Response:
<STX>read PharmLength 4<ETX>
Write Parameter
Request:
<STX>write PharmLength 4<ETX>
Response:
<STX>written PharmLength<ETX>

PharmReverse

Variable Read/Write

This parameter enables the reverse reading direction for Pharmacode barcodes. When activated, the device will read the barcodes from right to left instead of the standard left to right, accommodating specific labeling orientations and improving scanning accuracy in certain applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PharmReverse<ETX>
Response:
<STX>read PharmReverse false<ETX>
Write Parameter
Request:
<STX>write PharmReverse false<ETX>
Response:
<STX>written PharmReverse<ETX>

PharmDecimalOutput

Variable Read/Write

This parameter controls the output format for Pharmacode barcodes. When enabled, the device will output the decoded data in decimal format instead of binary, facilitating easier integration with systems that require decimal input for processing and analysis.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PharmDecimalOutput<ETX>
Response:
<STX>read PharmDecimalOutput false<ETX>
Write Parameter
Request:
<STX>write PharmDecimalOutput false<ETX>
Response:
<STX>written PharmDecimalOutput<ETX>

CBARActive

Variable Read/Write

This parameter activates the Codabar codetype. When enabled, the device will be configured to read and process Codabar barcodes, which are commonly used in libraries, blood banks, and air parcel tracking.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CBARActive<ETX>
Response:
<STX>read CBARActive false<ETX>
Write Parameter
Request:
<STX>write CBARActive false<ETX>
Response:
<STX>written CBARActive<ETX>

C128FamiliyActive

Variable Read/Write

This parameter activates the Code 128 codetype. When enabled, the device will be configured to read and process Code 128 barcodes, which are widely used in various industries for inventory management, shipping, and product identification.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C128FamiliyActive<ETX>
Response:
<STX>read C128FamiliyActive false<ETX>
Write Parameter
Request:
<STX>write C128FamiliyActive false<ETX>
Response:
<STX>written C128FamiliyActive<ETX>

C39Active

Variable Read/Write

This parameter activates the Code 39 codetype. When enabled, the device will be configured to read and process Code 39 barcodes, which are commonly used in various industries for inventory management, shipping, and product identification.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C39Active<ETX>
Response:
<STX>read C39Active false<ETX>
Write Parameter
Request:
<STX>write C39Active false<ETX>
Response:
<STX>written C39Active<ETX>

C93Active

Variable Read/Write

This parameter activates the Code 93 codetype. When enabled, the device will be configured to read and process Code 93 barcodes, which are commonly used in logistics and inventory management due to their high data density and error correction capabilities.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C93Active<ETX>
Response:
<STX>read C93Active false<ETX>
Write Parameter
Request:
<STX>write C93Active false<ETX>
Response:
<STX>written C93Active<ETX>

UPCEANActive

Variable Read/Write

This parameter activates the EAN / UPC codetype. When enabled, the device will be configured to read and process EAN and UPC barcodes, which are widely used in retail and inventory management for product identification.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read UPCEANActive<ETX>
Response:
<STX>read UPCEANActive false<ETX>
Write Parameter
Request:
<STX>write UPCEANActive false<ETX>
Response:
<STX>written UPCEANActive<ETX>

C25ILActive

Variable Read/Write

This parameter activates the 2 of 5 Interleaved codetype. When enabled, the device will be configured to read and process 2 of 5 Interleaved barcodes, which are widely used in logistics and inventory management due to their high data density and reliability.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C25ILActive<ETX>
Response:
<STX>read C25ILActive false<ETX>
Write Parameter
Request:
<STX>write C25ILActive false<ETX>
Response:
<STX>written C25ILActive<ETX>

C25ILLengthMode

Variable Read/Write

This parameter defines the mode for specifying the number of characters in 2 of 5 Interleaved barcodes. It allows the user to choose between free length, a specific range, or a fixed number of characters, enabling customization based on application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read C25ILLengthMode<ETX>
Response:
<STX>read C25ILLengthMode 0<ETX>
Write Parameter
Request:
<STX>write C25ILLengthMode 0<ETX>
Response:
<STX>written C25ILLengthMode<ETX>

C25ILIntLenList

Variable Read/Write

This parameter defines the range of character lengths for 2 of 5 Interleaved barcodes when the length mode is set to 'Range'. It allows users to specify minimum and maximum character counts, providing flexibility in barcode length while ensuring they fall within acceptable limits for their specific applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read C25ILIntLenList<ETX>
Response:
<STX>read C25ILIntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write C25ILIntLenList [0, 0]<ETX>
Response:
<STX>written C25ILIntLenList<ETX>

PostCodesActive

Variable Read/Write

This parameter activates the Postal code codetype. When enabled, the device will be configured to read and process various postal code barcodes used by postal services worldwide for mail sorting and delivery.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodesActive<ETX>
Response:
<STX>read PostCodesActive false<ETX>
Write Parameter
Request:
<STX>write PostCodesActive false<ETX>
Response:
<STX>written PostCodesActive<ETX>

PostCodesDependentSymbology

Variable Read/Write

This parameter allows users to select the specific postal code symbology to be used for barcode reading. It provides options for different postal code formats, enabling compatibility with various postal services.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 1 = TX_UNITED_STATES_POSTAL
  • 2 = TX_AUSTRALIA_POST
  • 4 = TX_ROYAL_MAIL
  • 5 = TX_KIX
  • 6 = TX_SWEDEN_POST
Read Parameter
Request:
<STX>read PostCodesDependentSymbology<ETX>
Response:
<STX>read PostCodesDependentSymbology 1<ETX>
Write Parameter
Request:
<STX>write PostCodesDependentSymbology 1<ETX>
Response:
<STX>written PostCodesDependentSymbology<ETX>

PostCodeLengthMode

Variable Read/Write

This parameter allows users to select the mode for specifying the number of characters in postal code barcodes. It provides options for free length, a defined range, or a fixed number of characters, enabling flexibility in barcode length requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Interval
  • 2 = TX_Fix
Read Parameter
Request:
<STX>read PostCodeLengthMode<ETX>
Response:
<STX>read PostCodeLengthMode 0<ETX>
Write Parameter
Request:
<STX>write PostCodeLengthMode 0<ETX>
Response:
<STX>written PostCodeLengthMode<ETX>

PostCodeFixLenList

Variable Read/Write

This parameter specifies the fixed number of characters for postal code barcodes. It allows users to define an exact character count, ensuring that the barcodes conform to specific length requirements for various postal applications.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read PostCodeFixLenList<ETX>
Response:
<STX>read PostCodeFixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write PostCodeFixLenList [0, 0, 0]<ETX>
Response:
<STX>written PostCodeFixLenList<ETX>

PostCodeIntLenList

Variable Read/Write

This parameter defines the range of characters for postal code barcodes. It allows users to set minimum and maximum character limits, providing flexibility to accommodate various postal code formats used by different postal services.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read PostCodeIntLenList<ETX>
Response:
<STX>read PostCodeIntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write PostCodeIntLenList [0, 0]<ETX>
Response:
<STX>written PostCodeIntLenList<ETX>

PostCodeUSPPostNetActive

Variable Read/Write

This parameter enables the PostNet symbology for US Postal Service barcodes. When activated, the device will be able to read and process PostNet barcodes, which are used for mail sorting and delivery in the United States.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodeUSPPostNetActive<ETX>
Response:
<STX>read PostCodeUSPPostNetActive false<ETX>
Write Parameter
Request:
<STX>write PostCodeUSPPostNetActive false<ETX>
Response:
<STX>written PostCodeUSPPostNetActive<ETX>

PostCodeUSPPlanetActive

Variable Read/Write

This parameter enables the Planet symbology for US Postal Service barcodes. When activated, the device will be able to read and process Planet barcodes, which are used for mail tracking and sorting in the United States.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodeUSPPlanetActive<ETX>
Response:
<STX>read PostCodeUSPPlanetActive false<ETX>
Write Parameter
Request:
<STX>write PostCodeUSPPlanetActive false<ETX>
Response:
<STX>written PostCodeUSPPlanetActive<ETX>

PostCodeUSPUsps4StateActive

Variable Read/Write

This parameter enables the USPS4SCB symbology for US Postal Service barcodes. When activated, the device will be able to read and process USPS4SCB barcodes, which are used for mail sorting and delivery in the United States.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodeUSPUsps4StateActive<ETX>
Response:
<STX>read PostCodeUSPUsps4StateActive false<ETX>
Write Parameter
Request:
<STX>write PostCodeUSPUsps4StateActive false<ETX>
Response:
<STX>written PostCodeUSPUsps4StateActive<ETX>

PostCodePostAustraliaAllowZeroFCC

Variable Read/Write

This parameter allows the use of a zero FCC (Fictitious Check Character) in Australia Post barcodes. When enabled, the device will accept barcodes with a zero FCC, which may be used in specific postal applications in Australia.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodePostAustraliaAllowZeroFCC<ETX>
Response:
<STX>read PostCodePostAustraliaAllowZeroFCC false<ETX>
Write Parameter
Request:
<STX>write PostCodePostAustraliaAllowZeroFCC false<ETX>
Response:
<STX>written PostCodePostAustraliaAllowZeroFCC<ETX>

PostCodePostAustraliaCustomerFormat

Variable Read/Write

This parameter enables the customer format for Australia Post barcodes, replacing commas with spaces. When activated, the device will read and process Australia Post barcodes that use spaces instead of commas, accommodating specific formatting requirements.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodePostAustraliaCustomerFormat<ETX>
Response:
<STX>read PostCodePostAustraliaCustomerFormat false<ETX>
Write Parameter
Request:
<STX>write PostCodePostAustraliaCustomerFormat false<ETX>
Response:
<STX>written PostCodePostAustraliaCustomerFormat<ETX>

PostCodePostSwedenCompressResultActive

Variable Read/Write

This parameter enables the compress result option for Post Sweden barcodes. When activated, the device will compress the decoded data from Post Sweden barcodes, reducing the amount of data transmitted and improving efficiency in data handling.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodePostSwedenCompressResultActive<ETX>
Response:
<STX>read PostCodePostSwedenCompressResultActive true<ETX>
Write Parameter
Request:
<STX>write PostCodePostSwedenCompressResultActive true<ETX>
Response:
<STX>written PostCodePostSwedenCompressResultActive<ETX>

PostCodeRoyalMailMailmarkActive

Variable Read/Write

This parameter enables the 4-State Mailmark symbology for Royal Mail barcodes. When activated, the device will be able to read and process 4-State Mailmark barcodes, which are used for mail tracking and sorting in the United Kingdom.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodeRoyalMailMailmarkActive<ETX>
Response:
<STX>read PostCodeRoyalMailMailmarkActive false<ETX>
Write Parameter
Request:
<STX>write PostCodeRoyalMailMailmarkActive false<ETX>
Response:
<STX>written PostCodeRoyalMailMailmarkActive<ETX>

PostCodeRoyalMail4SCCActive

Variable Read/Write

This parameter enables the RM4SCC symbology for Royal Mail barcodes. When activated, the device will be able to read and process RM4SCC barcodes, which are used for mail sorting and delivery in the United Kingdom.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PostCodeRoyalMail4SCCActive<ETX>
Response:
<STX>read PostCodeRoyalMail4SCCActive false<ETX>
Write Parameter
Request:
<STX>write PostCodeRoyalMail4SCCActive false<ETX>
Response:
<STX>written PostCodeRoyalMail4SCCActive<ETX>

PDF417Active

Variable Read/Write

This parameter activates the PDF417 codetype. When enabled, the device will be configured to read and process PDF417 barcodes, which are commonly used in applications such as identification cards, inventory management, and transportation due to their ability to encode large amounts of data in a compact format.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PDF417Active<ETX>
Response:
<STX>read PDF417Active false<ETX>
Write Parameter
Request:
<STX>write PDF417Active false<ETX>
Response:
<STX>written PDF417Active<ETX>

MinimumModuleSize2D

Variable Read/Write

This parameter defines the minimum cell (module) size for 2D codes in millimeters. The cell size is a needed dimension that affects the readability and accuracy of code scanning. Setting an appropriate minimum cell size helps optimize the camera's performance for reading 2D codes of varying sizes.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read MinimumModuleSize2D<ETX>
Response:
<STX>read MinimumModuleSize2D 0.5<ETX>
Write Parameter
Request:
<STX>write MinimumModuleSize2D 0.5<ETX>
Response:
<STX>written MinimumModuleSize2D<ETX>

MaximumModuleSize2D

Variable Read/Write

This parameter defines the maximum cell (module) size for 2D codes in millimeters. Setting an appropriate maximum cell size helps optimize the camera's performance for reading 2D codes of varying sizes.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read MaximumModuleSize2D<ETX>
Response:
<STX>read MaximumModuleSize2D 0.7<ETX>
Write Parameter
Request:
<STX>write MaximumModuleSize2D 0.7<ETX>
Response:
<STX>written MaximumModuleSize2D<ETX>

CodeLabelSize2D

Variable Read/Write

This parameter sets the maximum width of 2D codes in millimeters. Defining the maximum code width is essential for optimizing the camera's reading performance, as it allows the device to adjust its settings to effectively capture and decode 2D codes.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CodeLabelSize2D<ETX>
Response:
<STX>read CodeLabelSize2D 20<ETX>
Write Parameter
Request:
<STX>write CodeLabelSize2D 20<ETX>
Response:
<STX>written CodeLabelSize2D<ETX>

UPCEANAddOnMode

Variable Read/Write

This parameter specifies the mode for handling additional codes (add-ons) for EAN and UPC barcodes. It allows users to configure how the device processes and outputs data from add-on codes, which are often used to provide supplementary information such as pricing or product variations. Supplementary codes are additional codes that are assigned to a main mode. They comprise 2 or 5 digits and contain additional information.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_None
  • 1 = TX_Active
  • 2 = TX_Required
Read Parameter
Request:
<STX>read UPCEANAddOnMode<ETX>
Response:
<STX>read UPCEANAddOnMode 0<ETX>
Write Parameter
Request:
<STX>write UPCEANAddOnMode 0<ETX>
Response:
<STX>written UPCEANAddOnMode<ETX>

UPCEANAddOnLength

Variable Read/Write

This parameter defines the number of characters for the add-on codes associated with EAN and UPC barcodes. It allows users to specify whether the add-on code should consist of 2 or 5 digits, ensuring compatibility with various barcode standards and application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_2_Digits
  • 1 = TX_5_Digits
  • 2 = TX_2or5_Digits
Read Parameter
Request:
<STX>read UPCEANAddOnLength<ETX>
Response:
<STX>read UPCEANAddOnLength 0<ETX>
Write Parameter
Request:
<STX>write UPCEANAddOnLength 0<ETX>
Response:
<STX>written UPCEANAddOnLength<ETX>

DataMatrixActive

Variable Read/Write

This parameter activates the Data Matrix codetype. When enabled, the device will be configured to read and process Data Matrix 2D barcodes, which are widely used for encoding large amounts of data in a compact area for industrial marking, traceability and identification applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read DataMatrixActive<ETX>
Response:
<STX>read DataMatrixActive false<ETX>
Write Parameter
Request:
<STX>write DataMatrixActive false<ETX>
Response:
<STX>written DataMatrixActive<ETX>

DataMatrixLengthMode

Variable Read/Write

This parameter allows users to select the symbol size mode for Data Matrix codes. It provides the option of accepting any symbol size or restricting decoding to a fixed set of symbol sizes, enabling optimization of reading performance for known code dimensions.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Fix
Read Parameter
Request:
<STX>read DataMatrixLengthMode<ETX>
Response:
<STX>read DataMatrixLengthMode 0<ETX>
Write Parameter
Request:
<STX>write DataMatrixLengthMode 0<ETX>
Response:
<STX>written DataMatrixLengthMode<ETX>

DataMatrixFixLenList

Variable Read/Write

This parameter specifies the fixed symbol sizes for Data Matrix codes. It allows users to define a list of exact symbol dimensions, ensuring that only Data Matrix codes matching the configured sizes are decoded.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 10):
ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_NONE
  • 1 = TX_10_10
  • 2 = TX_12_12
  • 3 = TX_14_14
  • 4 = TX_16_16
  • 5 = TX_18_18
  • 6 = TX_20_20
  • 7 = TX_22_22
  • 8 = TX_24_24
  • 9 = TX_26_26
  • 10 = TX_32_32
  • 11 = TX_36_36
  • 12 = TX_40_40
  • 13 = TX_44_44
  • 14 = TX_48_48
  • 15 = TX_52_52
  • 16 = TX_64_64
  • 17 = TX_72_72
  • 18 = TX_80_80
  • 19 = TX_88_88
  • 20 = TX_96_96
  • 21 = TX_104_104
  • 22 = TX_120_120
  • 23 = TX_132_132
  • 24 = TX_144_144
  • 25 = TX_18_8
  • 26 = TX_32_8
  • 27 = TX_26_12
  • 28 = TX_36_12
  • 29 = TX_36_16
  • 30 = TX_48_16
  • 31 = TX_48_8
  • 32 = TX_64_8
  • 33 = TX_64_12
  • 34 = TX_64_16
  • 35 = TX_32_24
  • 36 = TX_36_24
  • 37 = TX_48_24
  • 38 = TX_64_24
  • 39 = TX_32_26
  • 40 = TX_40_26
  • 41 = TX_48_26
  • 42 = TX_64_26
Read Parameter
Request:
<STX>read DataMatrixFixLenList<ETX>
Response:
<STX>read DataMatrixFixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write DataMatrixFixLenList [0, 0, 0]<ETX>
Response:
<STX>written DataMatrixFixLenList<ETX>

DataMatrixCodeBackground

Variable Read/Write

This parameter specifies the expected background of the Data Matrix code. It allows selecting between white, black, or both backgrounds, enabling the device to reliably decode codes printed or marked with different contrast polarities.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = WHITE
  • 1 = BLACK
  • 2 = BOTH
Read Parameter
Request:
<STX>read DataMatrixCodeBackground<ETX>
Response:
<STX>read DataMatrixCodeBackground 0<ETX>
Write Parameter
Request:
<STX>write DataMatrixCodeBackground 0<ETX>
Response:
<STX>written DataMatrixCodeBackground<ETX>

MaxiCodeActive

Variable Read/Write

This parameter activates the Maxi Code codetype. When enabled, the device will be configured to read and process Maxi Code 2D barcodes, which are commonly used in transport and logistics applications for high-speed package sorting and tracking.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeActive<ETX>
Response:
<STX>read MaxiCodeActive false<ETX>
Write Parameter
Request:
<STX>write MaxiCodeActive false<ETX>
Response:
<STX>written MaxiCodeActive<ETX>

MaxiCodeMode2Active

Variable Read/Write

This parameter enables Maxi Code Mode 2. In this mode the code contains a structured carrier message with a numeric postal code, which is used for automated package routing and sorting in postal and logistics applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeMode2Active<ETX>
Response:
<STX>read MaxiCodeMode2Active true<ETX>
Write Parameter
Request:
<STX>write MaxiCodeMode2Active true<ETX>
Response:
<STX>written MaxiCodeMode2Active<ETX>

MaxiCodeMode3Active

Variable Read/Write

This parameter enables Maxi Code Mode 3. In this mode the code contains a structured carrier message with an alphanumeric postal code, which is used for automated package routing and sorting in international postal and logistics applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeMode3Active<ETX>
Response:
<STX>read MaxiCodeMode3Active true<ETX>
Write Parameter
Request:
<STX>write MaxiCodeMode3Active true<ETX>
Response:
<STX>written MaxiCodeMode3Active<ETX>

MaxiCodeMode4Active

Variable Read/Write

This parameter enables Maxi Code Mode 4. In this mode the code contains unformatted data with standard error correction, allowing general purpose data to be encoded without a structured carrier message.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeMode4Active<ETX>
Response:
<STX>read MaxiCodeMode4Active true<ETX>
Write Parameter
Request:
<STX>write MaxiCodeMode4Active true<ETX>
Response:
<STX>written MaxiCodeMode4Active<ETX>

MaxiCodeMode5Active

Variable Read/Write

This parameter enables Maxi Code Mode 5. In this mode the code contains unformatted data with extended error correction, providing increased robustness for reading in demanding conditions at the cost of reduced data capacity.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeMode5Active<ETX>
Response:
<STX>read MaxiCodeMode5Active true<ETX>
Write Parameter
Request:
<STX>write MaxiCodeMode5Active true<ETX>
Response:
<STX>written MaxiCodeMode5Active<ETX>

MaxiCodeMode6Active

Variable Read/Write

This parameter enables Maxi Code Mode 6. This mode is used for the programming of hardware products, encoding configuration or programming data for reader and scanner devices.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read MaxiCodeMode6Active<ETX>
Response:
<STX>read MaxiCodeMode6Active true<ETX>
Write Parameter
Request:
<STX>write MaxiCodeMode6Active true<ETX>
Response:
<STX>written MaxiCodeMode6Active<ETX>

PrimaryMessageOutputActive

Variable Read/Write

This parameter enables the output of the primary message of a Maxi Code. When activated, the device will include the primary message (containing the structured carrier information such as postal code, country code and service class) in the decoded output.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PrimaryMessageOutputActive<ETX>
Response:
<STX>read PrimaryMessageOutputActive true<ETX>
Write Parameter
Request:
<STX>write PrimaryMessageOutputActive true<ETX>
Response:
<STX>written PrimaryMessageOutputActive<ETX>

QRCodeActive

Variable Read/Write

This parameter activates the QR codetype. When enabled, the device will be configured to read and process QR 2D barcodes, which are widely used for encoding large amounts of data such as URLs, product information and traceability data in a compact area.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read QRCodeActive<ETX>
Response:
<STX>read QRCodeActive false<ETX>
Write Parameter
Request:
<STX>write QRCodeActive false<ETX>
Response:
<STX>written QRCodeActive<ETX>

QRLengthMode

Variable Read/Write

This parameter allows users to select the symbol size mode for QR codes. It provides the option of accepting any symbol size, restricting decoding to a fixed set of symbol sizes, or defining a range of symbol sizes, enabling optimization of reading performance for known code dimensions.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_Free
  • 1 = TX_Fix
  • 2 = TX_Interval
Read Parameter
Request:
<STX>read QRLengthMode<ETX>
Response:
<STX>read QRLengthMode 0<ETX>
Write Parameter
Request:
<STX>write QRLengthMode 0<ETX>
Response:
<STX>written QRLengthMode<ETX>

QRFixLenList

Variable Read/Write

This parameter specifies the fixed symbol sizes for QR codes. It allows users to define a list of exact symbol dimensions (QR versions), ensuring that only QR codes matching the configured sizes are decoded.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 5):
ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_NONE
  • 1 = TX_V1
  • 2 = TX_V2
  • 3 = TX_V3
  • 4 = TX_V4
  • 5 = TX_V5
  • 6 = TX_V6
  • 7 = TX_V7
  • 8 = TX_V8
  • 9 = TX_V9
  • 10 = TX_V10
  • 11 = TX_V11
  • 12 = TX_V12
  • 13 = TX_V13
  • 14 = TX_V14
  • 15 = TX_V15
  • 16 = TX_V16
  • 17 = TX_V17
  • 18 = TX_V18
  • 19 = TX_V19
  • 20 = TX_V20
  • 21 = TX_V21
  • 22 = TX_V22
  • 23 = TX_V23
  • 24 = TX_V24
  • 25 = TX_V25
  • 26 = TX_V26
  • 27 = TX_V27
  • 28 = TX_V28
  • 29 = TX_V29
  • 30 = TX_V30
  • 31 = TX_V31
  • 32 = TX_V32
  • 33 = TX_V33
  • 34 = TX_V34
  • 35 = TX_V35
  • 36 = TX_V36
  • 37 = TX_V37
  • 38 = TX_V38
  • 39 = TX_V39
  • 40 = TX_V40
Read Parameter
Request:
<STX>read QRFixLenList<ETX>
Response:
<STX>read QRFixLenList [0, 0, 0]<ETX>
Write Parameter
Request:
<STX>write QRFixLenList [0, 0, 0]<ETX>
Response:
<STX>written QRFixLenList<ETX>

QRIntLenList

Variable Read/Write

This parameter defines the range of symbol sizes for QR codes. It allows users to set minimum and maximum symbol dimensions (QR versions), providing flexibility to accommodate various QR code sizes while optimizing reading performance.

Type Information

FIX_ARRAY (Fixed-length array)
Array items (length: 2):
ENUM8 (8-bit enumeration)
Possible values:
  • 0 = TX_NONE
  • 1 = TX_V1
  • 2 = TX_V2
  • 3 = TX_V3
  • 4 = TX_V4
  • 5 = TX_V5
  • 6 = TX_V6
  • 7 = TX_V7
  • 8 = TX_V8
  • 9 = TX_V9
  • 10 = TX_V10
  • 11 = TX_V11
  • 12 = TX_V12
  • 13 = TX_V13
  • 14 = TX_V14
  • 15 = TX_V15
  • 16 = TX_V16
  • 17 = TX_V17
  • 18 = TX_V18
  • 19 = TX_V19
  • 20 = TX_V20
  • 21 = TX_V21
  • 22 = TX_V22
  • 23 = TX_V23
  • 24 = TX_V24
  • 25 = TX_V25
  • 26 = TX_V26
  • 27 = TX_V27
  • 28 = TX_V28
  • 29 = TX_V29
  • 30 = TX_V30
  • 31 = TX_V31
  • 32 = TX_V32
  • 33 = TX_V33
  • 34 = TX_V34
  • 35 = TX_V35
  • 36 = TX_V36
  • 37 = TX_V37
  • 38 = TX_V38
  • 39 = TX_V39
  • 40 = TX_V40
Read Parameter
Request:
<STX>read QRIntLenList<ETX>
Response:
<STX>read QRIntLenList [0, 0]<ETX>
Write Parameter
Request:
<STX>write QRIntLenList [0, 0]<ETX>
Response:
<STX>written QRIntLenList<ETX>

GS1DatamatrixActive

Variable Read/Write

This parameter activates the GS1 Data Matrix variant. When enabled, the device reads Data Matrix codes that follow the GS1 application identifier standard. Note that when this option is active, the normal (non-GS1) Data Matrix variant will not be read.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read GS1DatamatrixActive<ETX>
Response:
<STX>read GS1DatamatrixActive false<ETX>
Write Parameter
Request:
<STX>write GS1DatamatrixActive false<ETX>
Response:
<STX>written GS1DatamatrixActive<ETX>

GS1QRActive

Variable Read/Write

This parameter activates the GS1 QR variant. When enabled, the device reads QR codes that follow the GS1 application identifier standard. Note that when this option is active, the normal (non-GS1) QR variant will not be read.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read GS1QRActive<ETX>
Response:
<STX>read GS1QRActive false<ETX>
Write Parameter
Request:
<STX>write GS1QRActive false<ETX>
Response:
<STX>written GS1QRActive<ETX>

IsoGradingEnabled

Variable Read/Write

This parameter enables or disables the calculation of code quality in accordance with the ISO standard. When enabled, the device evaluates the quality of the read codes according to ISO grading. Note: The calculation of code quality may have a negative impact on device performance (e.g. read rate).

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read IsoGradingEnabled<ETX>
Response:
<STX>read IsoGradingEnabled false<ETX>
Write Parameter
Request:
<STX>write IsoGradingEnabled false<ETX>
Response:
<STX>written IsoGradingEnabled<ETX>

Object trigger

7 items

DigitalInputLogicInverted

Variable Read/Write

This parameter inverts the logic of the digital input signal used for triggering the start of the reading operation. When disabled, a change from low to high (rising edge) will trigger the start. When enabled, a change from high to low (falling edge) will trigger the start.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read DigitalInputLogicInverted<ETX>
Response:
<STX>read DigitalInputLogicInverted false<ETX>
Write Parameter
Request:
<STX>write DigitalInputLogicInverted false<ETX>
Response:
<STX>written DigitalInputLogicInverted<ETX>

TriggerSource

Variable Read/Write

This parameter allows users to select the source for triggering the start of the reading operation. It provides options for different trigger sources, enabling flexibility in how the reading process is initiated based on specific application requirements.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = DigitalInput
  • 1 = Fieldbus
  • 2 = UserDefinedCommand
  • 3 = CustomerProtocol
Read Parameter
Request:
<STX>read TriggerSource<ETX>
Response:
<STX>read TriggerSource 0<ETX>
Write Parameter
Request:
<STX>write TriggerSource 0<ETX>
Response:
<STX>written TriggerSource<ETX>

TriggerStopTimerTime

Variable Read/Write

This parameter allows users to set the duration of the timer used to trigger the stop of the reading operation. The timer value is specified in milliseconds (ms) and determines how long the timer will run before initiating the stop. Users can adjust this setting to control the timing of the stop operation according to their specific application needs.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read TriggerStopTimerTime<ETX>
Response:
<STX>read TriggerStopTimerTime 1000<ETX>
Write Parameter
Request:
<STX>write TriggerStopTimerTime 1000<ETX>
Response:
<STX>written TriggerStopTimerTime<ETX>

TrigInputDebouncingTimeManual

Variable Read/Write

This parameter allows users to manually set the debouncing time for the digital input used to trigger the start of the reading operation. This setting is only applicable when the automatic debouncing mode is disabled. The debouncing time helps filter out signal noise by defining a time interval (in milliseconds) during which subsequent signal changes are ignored.

Type Information

DINT (-2147483648 ... 2147483647)
Read Parameter
Request:
<STX>read TrigInputDebouncingTimeManual<ETX>
Response:
<STX>read TrigInputDebouncingTimeManual 10<ETX>
Write Parameter
Request:
<STX>write TrigInputDebouncingTimeManual 10<ETX>
Response:
<STX>written TrigInputDebouncingTimeManual<ETX>

TrigInputDebouncingTimeManualEditStatus

Variable Read/Write

This parameter allows users to disable the automatic debouncing time for the digital input used to trigger the start of the reading operation. When unchecked, the device will use an automatic timing mechanism to filter out signal noise. When checked, users can manually set the debouncing time below.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read TrigInputDebouncingTimeManualEditStatus<ETX>
Response:
<STX>read TrigInputDebouncingTimeManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write TrigInputDebouncingTimeManualEditStatus false<ETX>
Response:
<STX>written TrigInputDebouncingTimeManualEditStatus<ETX>

TriggerCommandEchoEnabled

Variable Read/Write

This parameter enables or disables the echoing of the user-defined command used to trigger the start/stop of the reading operation. When enabled, the device will send back an echo of the command, allowing users to verify that the command was received and processed correctly.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read TriggerCommandEchoEnabled<ETX>
Response:
<STX>read TriggerCommandEchoEnabled true<ETX>
Write Parameter
Request:
<STX>write TriggerCommandEchoEnabled true<ETX>
Response:
<STX>written TriggerCommandEchoEnabled<ETX>

TrigStopInputDebouncingTimeManualEditStatus

Variable Read/Write

This parameter allows users to disable the automatic debouncing time for the digital input used to trigger the stop of the reading operation. When this option is checked, users can manually set the debouncing time to suit their specific application needs. If unchecked, the device will use an automatic debouncing time to filter out any noise or false triggers on the digital input signal.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read TrigStopInputDebouncingTimeManualEditStatus<ETX>
Response:
<STX>read TrigStopInputDebouncingTimeManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write TrigStopInputDebouncingTimeManualEditStatus false<ETX>
Response:
<STX>written TrigStopInputDebouncingTimeManualEditStatus<ETX>

Data fragmentation and control (Handshake)

1 items

List of Entries

PROFINETHandshake

PROFINETHandshake

Variable Read Only

Enable fragmentation/handshake, the CLV waits for ACK for each new data, which is greater than the maximum process data size of the selected read result module.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read PROFINETHandshake<ETX>
Response:
<STX>read PROFINETHandshake false<ETX>

Output timing and interfaces

4 items

DataHostConditionName

Variable Read/Write

This parameter specifies the condition to be used for condition-based output of read results. The available options include 'Good Read' (predefined), 'Condition object 1' (defined in 'Condition configuration module'), 'Condition object 2' (defined in 'Condition configuration module'), and 'Condition object 3' (defined in 'Condition configuration module'). Each option represents a different condition that can trigger the output of a read result when the selected condition is met. The reading gate will be closed after the output is triggered by the condition.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read DataHostConditionName<ETX>
Response:
<STX>read DataHostConditionName "Good Read"<ETX>
Write Parameter
Request:
<STX>write DataHostConditionName "Good Read"<ETX>
Response:
<STX>written DataHostConditionName<ETX>

DataHostTimeManual

Variable Read/Write

This parameter specifies the manual output timing in milliseconds for read results. It is only active when automatic timing is disabled. This setting determines the delay before the read result output is triggered based on the selected reference event (trigger start or stop). Note that values below 50 ms may cause issues and are considered experimental.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read DataHostTimeManual<ETX>
Response:
<STX>read DataHostTimeManual 1250<ETX>
Write Parameter
Request:
<STX>write DataHostTimeManual 1250<ETX>
Response:
<STX>written DataHostTimeManual<ETX>

DataHostTimeManualEditStatus

Variable Read/Write

This parameter enables or disables manual output timing for read results. When enabled, the output timing is set manually based on the specified time in milliseconds. When disabled, automatic timing is used, which adjusts the output at the earliest possible moment based on the application parameters.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read DataHostTimeManualEditStatus<ETX>
Response:
<STX>read DataHostTimeManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write DataHostTimeManualEditStatus false<ETX>
Response:
<STX>written DataHostTimeManualEditStatus<ETX>

DataHostTimeReference

Variable Read/Write

This parameter defines the event to which the read result output timing is related. The available options include 'Referred to trigger stop' and 'Referred to trigger start', 'User defined condition'. Each option specifies a different condition for when the read result output should be triggered.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Referred_to_trigger_stop
  • 1 = Referred_to_trigger_start
  • 2 = User_defined_condition
  • 3 = User_defined_condition_multiple_output
Read Parameter
Request:
<STX>read DataHostTimeReference<ETX>
Response:
<STX>read DataHostTimeReference 0<ETX>
Write Parameter
Request:
<STX>write DataHostTimeReference 0<ETX>
Response:
<STX>written DataHostTimeReference<ETX>

Image acquisition timing

2 items

ReadingPeriodBegin

Variable Read/Write

This parameter defines the delay time for the start of image acquisition in milliseconds. It specifies how long to wait after receiving the trigger signal before beginning the image capture process. The value can be set between 0 ms and 50000 ms, allowing for flexibility in timing based on application requirements. This is useful for synchronizing image acquisition with other events or processes.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read ReadingPeriodBegin<ETX>
Response:
<STX>read ReadingPeriodBegin 0<ETX>
Write Parameter
Request:
<STX>write ReadingPeriodBegin 0<ETX>
Response:
<STX>written ReadingPeriodBegin<ETX>

ReadingPeriodEnd

Variable Read/Write

This parameter defines the delay time for the end of image acquisition in milliseconds. It specifies how long to wait after receiving the trigger stop signal before stopping the image capture process. The value can be set between 0 ms and 50000 ms, allowing for flexibility in timing based on application requirements. This is useful for ensuring that the image acquisition period aligns with specific events or processes.

Type Information

UINT (0 ... 65535)
Read Parameter
Request:
<STX>read ReadingPeriodEnd<ETX>
Response:
<STX>read ReadingPeriodEnd 0<ETX>
Write Parameter
Request:
<STX>write ReadingPeriodEnd 0<ETX>
Response:
<STX>written ReadingPeriodEnd<ETX>

Expert parameters

37 items

ReadAtImageBorders

Variable Read/Write

This parameter allows users to enable or disable the reading of 1D codes on image edges. When enabled, the device will attempt to read 1D codes located at the edges of the image, which may be useful in certain applications where codes are positioned near the image boundaries. When disabled, the device will ignore 1D codes on image edges, which may improve overall reading performance in standard applications.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ReadAtImageBorders<ETX>
Response:
<STX>read ReadAtImageBorders true<ETX>
Write Parameter
Request:
<STX>write ReadAtImageBorders true<ETX>
Response:
<STX>written ReadAtImageBorders<ETX>

ReadAtImageBordersManualEditStatus

Variable Read/Write

This parameter allows users to manually control the adjustment of 1D codes on image edges. When enabled, automatic adjustment is disabled, giving users full control over the adjustment settings. When disabled, the device will automatically adjust the 1D codes on image edges based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ReadAtImageBordersManualEditStatus<ETX>
Response:
<STX>read ReadAtImageBordersManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write ReadAtImageBordersManualEditStatus true<ETX>
Response:
<STX>written ReadAtImageBordersManualEditStatus<ETX>

FrameRate

Variable Read/Write

This parameter allows users to manually set the frame rate of the image capture. The value can be adjusted between 1.0 Hz and 158.0 Hz, providing flexibility to accommodate various application requirements. This manual control is particularly useful in scenarios where automatic frame rate adjustment may not yield the desired performance, allowing users to fine-tune the frame rate for optimal results.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read FrameRate<ETX>
Response:
<STX>read FrameRate 3.0<ETX>
Write Parameter
Request:
<STX>write FrameRate 3.0<ETX>
Response:
<STX>written FrameRate<ETX>

Gain

Variable Read/Write

This parameter allows users to manually set the brightness level of the image. The value can be adjusted between 1.0 and 50.0, providing a wide range of brightness levels to suit different lighting conditions and application requirements. This manual control is particularly useful in scenarios where automatic brightness adjustment may not yield the desired image quality, allowing users to fine-tune the brightness for optimal results.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read Gain<ETX>
Response:
<STX>read Gain 1.0<ETX>
Write Parameter
Request:
<STX>write Gain 1.0<ETX>
Response:
<STX>written Gain<ETX>

ShutterTime

Variable Read/Write

This parameter allows users to manually set the exposure time for image capture in microseconds (us). The value can be adjusted between 7 us and 240 us, providing flexibility to accommodate various lighting conditions and application requirements. This manual control is particularly useful in scenarios where automatic exposure time adjustment may not yield the desired image quality, allowing users to fine-tune the exposure time for optimal results.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read ShutterTime<ETX>
Response:
<STX>read ShutterTime 500<ETX>
Write Parameter
Request:
<STX>write ShutterTime 500<ETX>
Response:
<STX>written ShutterTime<ETX>

FrameRateManualEditStatus

Variable Read/Write

This parameter allows users to manually control the frame rate settings. When enabled, automatic frame rate adjustment is disabled, giving users full control over the frame rate. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the frame rate based on the application parameters to achieve optimal image quality and performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read FrameRateManualEditStatus<ETX>
Response:
<STX>read FrameRateManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write FrameRateManualEditStatus true<ETX>
Response:
<STX>written FrameRateManualEditStatus<ETX>

GainManualEditStatus

Variable Read/Write

This parameter allows users to manually control the brightness settings. When enabled, automatic brightness adjustment is disabled, giving users full control over the brightness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the brightness based on the application parameters to achieve optimal image quality.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read GainManualEditStatus<ETX>
Response:
<STX>read GainManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write GainManualEditStatus true<ETX>
Response:
<STX>written GainManualEditStatus<ETX>

ShutterTimeManualEditStatus

Variable Read/Write

This parameter allows users to manually control the exposure time settings. When enabled, automatic exposure time adjustment is disabled, giving users full control over the exposure time. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the exposure time based on the application parameters to achieve optimal image quality.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read ShutterTimeManualEditStatus<ETX>
Response:
<STX>read ShutterTimeManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write ShutterTimeManualEditStatus true<ETX>
Response:
<STX>written ShutterTimeManualEditStatus<ETX>

DecoderScanMode

Variable Read/Write

This parameter allows users to manually set the 1D code aggressiveness level. The value can be set to low, medium, or high, providing flexibility to accommodate various application requirements. This manual control is particularly useful in scenarios where automatic aggressiveness adjustment may not yield the desired decoding performance, allowing users to fine-tune the aggressiveness level for optimal results.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Full
  • 1 = Partial
  • 2 = Intelligent
Read Parameter
Request:
<STX>read DecoderScanMode<ETX>
Response:
<STX>read DecoderScanMode 2<ETX>
Write Parameter
Request:
<STX>write DecoderScanMode 2<ETX>
Response:
<STX>written DecoderScanMode<ETX>

BlurredCodes

Variable Read/Write

This parameter allows users to enable or disable the optimization for blurred 1D code decoding. When enabled, the device will apply additional processing to improve the decoding of blurred 1D codes, which may be beneficial in challenging reading conditions. When disabled, the device will not apply this optimization, which may result in faster processing but potentially lower decoding success rates for blurred codes.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read BlurredCodes<ETX>
Response:
<STX>read BlurredCodes true<ETX>
Write Parameter
Request:
<STX>write BlurredCodes true<ETX>
Response:
<STX>written BlurredCodes<ETX>

SuperResolution

Variable Read/Write

This parameter allows users to enable or disable the 1D code superresolution feature. When enabled, the device will apply superresolution to improve the decoding of 1D codes with low resolution, which may be beneficial in challenging reading conditions. When disabled, the device will not apply superresolution, which may result in faster processing but potentially lower decoding success rates for low-resolution codes.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read SuperResolution<ETX>
Response:
<STX>read SuperResolution true<ETX>
Write Parameter
Request:
<STX>write SuperResolution true<ETX>
Response:
<STX>written SuperResolution<ETX>

CodeContrast1D

Variable Read/Write

This parameter allows users to manually set the 1D code contrast threshold as a percentage. The value can be adjusted between 5% and 70%, providing flexibility to accommodate various application requirements. This manual control is particularly useful in scenarios where automatic contrast threshold adjustment may not yield the desired decoding performance, allowing users to fine-tune the contrast threshold for optimal results.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CodeContrast1D<ETX>
Response:
<STX>read CodeContrast1D 20<ETX>
Write Parameter
Request:
<STX>write CodeContrast1D 20<ETX>
Response:
<STX>written CodeContrast1D<ETX>

DecoderScanModeManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 1D code aggressiveness settings. When enabled, automatic adjustment of the 1D code aggressiveness is disabled, giving users full control over the aggressiveness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 1D code aggressiveness based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read DecoderScanModeManualEditStatus<ETX>
Response:
<STX>read DecoderScanModeManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write DecoderScanModeManualEditStatus true<ETX>
Response:
<STX>written DecoderScanModeManualEditStatus<ETX>

SuperResolutionManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 1D code superresolution settings. When enabled, automatic adjustment of the 1D code superresolution is disabled, giving users full control over the superresolution level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 1D code superresolution based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read SuperResolutionManualEditStatus<ETX>
Response:
<STX>read SuperResolutionManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write SuperResolutionManualEditStatus true<ETX>
Response:
<STX>written SuperResolutionManualEditStatus<ETX>

C128SingleErrorCorrection

Variable Read/Write

This parameter allows users to enable or disable the Code 128 single character correction. When enabled, the device will apply correction to Code 128 single characters to improve decoding accuracy. When disabled, the device will not apply correction, which may result in faster processing but potentially lower decoding success rates for Code 128 single characters.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C128SingleErrorCorrection<ETX>
Response:
<STX>read C128SingleErrorCorrection false<ETX>
Write Parameter
Request:
<STX>write C128SingleErrorCorrection false<ETX>
Response:
<STX>written C128SingleErrorCorrection<ETX>

C128SingleErrorCorrectionManualEditStatus

Variable Read/Write

This parameter allows users to manually control the Code 128 single character correction settings. When enabled, automatic adjustment of the Code 128 single character correction is disabled, giving users full control over the correction settings. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the Code 128 single character correction based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read C128SingleErrorCorrectionManualEditStatus<ETX>
Response:
<STX>read C128SingleErrorCorrectionManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write C128SingleErrorCorrectionManualEditStatus true<ETX>
Response:
<STX>written C128SingleErrorCorrectionManualEditStatus<ETX>

OptimizeBad1DDecoding

Variable Read/Write

This parameter allows users to enable or disable the optimization for poor quality 1D code decoding. When enabled, the device will apply additional processing to improve the decoding of low-quality 1D codes, which may be beneficial in challenging reading conditions. When disabled, the device will not apply this optimization, which may result in faster processing but potentially lower decoding success rates for poor quality codes.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OptimizeBad1DDecoding<ETX>
Response:
<STX>read OptimizeBad1DDecoding false<ETX>
Write Parameter
Request:
<STX>write OptimizeBad1DDecoding false<ETX>
Response:
<STX>written OptimizeBad1DDecoding<ETX>

CodeContrast2D

Variable Read/Write

This parameter allows users to manually set the 2D code contrast threshold as a percentage. The value can be adjusted between 0% and 70%, providing flexibility to accommodate various application requirements. This manual control is particularly useful in scenarios where automatic contrast threshold adjustment may not yield the desired decoding performance, allowing users to fine-tune the contrast threshold for optimal results.

Type Information

UDINT (0 ... 4294967295)
Read Parameter
Request:
<STX>read CodeContrast2D<ETX>
Response:
<STX>read CodeContrast2D 20<ETX>
Write Parameter
Request:
<STX>write CodeContrast2D 20<ETX>
Response:
<STX>written CodeContrast2D<ETX>

CodeSize2D

Variable Read/Write

This parameter allows users to manually set the expected 2D code size (module/cell size). The value can be set to small, medium, big, or very big, allowing the decoder to be optimized for the module size of the 2D codes used in the application. Selecting the appropriate size improves decoding performance and speed, whereas an unsuitable setting may lead to lower decoding success rates. This manual control is particularly useful in scenarios where automatic size adjustment may not yield the desired decoding performance.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = Small
  • 1 = Medium
  • 2 = Big
  • 3 = Verybig
Read Parameter
Request:
<STX>read CodeSize2D<ETX>
Response:
<STX>read CodeSize2D 0<ETX>
Write Parameter
Request:
<STX>write CodeSize2D 0<ETX>
Response:
<STX>written CodeSize2D<ETX>

EnableUpsampling2DManual

Variable Read/Write

This parameter enables or disables 2D upsampling. When enabled, 2D codes with a small cell size can be read at a large working distance, and the reading reliability for codes in poor condition is increased. Note: Upsampling may be disadvantageous in very fast applications or in applications with many codes per object, as the decoding time per image is higher.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EnableUpsampling2DManual<ETX>
Response:
<STX>read EnableUpsampling2DManual false<ETX>
Write Parameter
Request:
<STX>write EnableUpsampling2DManual false<ETX>
Response:
<STX>written EnableUpsampling2DManual<ETX>

EnableUpsampling2DManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 2D upsampling settings. When enabled, automatic adjustment of the 2D upsampling is disabled, giving users full control over the upsampling level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 2D upsampling based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EnableUpsampling2DManualEditStatus<ETX>
Response:
<STX>read EnableUpsampling2DManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write EnableUpsampling2DManualEditStatus false<ETX>
Response:
<STX>written EnableUpsampling2DManualEditStatus<ETX>

OptimizationLevelPdf

Variable Read/Write

This parameter allows users to manually set the PDF417 decoder aggressiveness level. The level can be increased from low to high to optimize the decoder for the condition of the PDF417 codes used in the application: low is intended for good, easy to read codes, medium for damaged codes, and high for bent and damaged codes. A higher aggressiveness improves the decoding of poor-quality codes but increases the decoding time, whereas a lower level enables faster processing for good-quality codes. This manual control is particularly useful in scenarios where automatic aggressiveness adjustment may not yield the desired decoding performance.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = GoodCodes
  • 1 = DamagedCodes
  • 2 = BendAndDamagedCodes
Read Parameter
Request:
<STX>read OptimizationLevelPdf<ETX>
Response:
<STX>read OptimizationLevelPdf 0<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelPdf 0<ETX>
Response:
<STX>written OptimizationLevelPdf<ETX>

OptimizationLevelDmx

Variable Read/Write

This parameter allows users to manually set the Data Matrix decoder aggressiveness level. The level can be increased from low to very high to optimize the decoder for the condition of the Data Matrix codes used in the application: low is intended for easy to read codes, medium for standard codes, high for direct part marking (DPM) or damaged codes, and very high (DPM+) for particularly challenging DPM codes. A higher aggressiveness improves the decoding of poor-quality codes but increases the decoding time, whereas a lower level enables faster processing for good-quality codes. This manual control is particularly useful in scenarios where automatic aggressiveness adjustment may not yield the desired decoding performance.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = HighspeedPrint
  • 1 = StandardCodes
  • 2 = DpmOrDamagedCodes
  • 3 = DpmPlus
Read Parameter
Request:
<STX>read OptimizationLevelDmx<ETX>
Response:
<STX>read OptimizationLevelDmx 1<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelDmx 1<ETX>
Response:
<STX>written OptimizationLevelDmx<ETX>

OptimizationLevelQr

Variable Read/Write

This parameter allows users to manually set the QR code decoder aggressiveness level. The level can be increased from low to high to optimize the decoder for the condition of the QR codes used in the application: low is intended for good, easy to read codes, medium for damaged codes, and high for bent and damaged codes. A higher aggressiveness improves the decoding of poor-quality codes but increases the decoding time, whereas a lower level enables faster processing for good-quality codes. This manual control is particularly useful in scenarios where automatic aggressiveness adjustment may not yield the desired decoding performance.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = GoodCodes
  • 1 = DamagedCodes
  • 2 = BendAndDamagedCodes
Read Parameter
Request:
<STX>read OptimizationLevelQr<ETX>
Response:
<STX>read OptimizationLevelQr 0<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelQr 0<ETX>
Response:
<STX>written OptimizationLevelQr<ETX>

OptimizationLevelMaxi

Variable Read/Write

This parameter allows users to manually set the Maxi code decoder aggressiveness level. The level can be increased from low to medium to optimize the decoder for the condition of the Maxi codes used in the application: low is intended for good, easy to read codes, and medium for damaged codes. A higher aggressiveness improves the decoding of poor-quality codes but increases the decoding time, whereas a lower level enables faster processing for good-quality codes. This manual control is particularly useful in scenarios where automatic aggressiveness adjustment may not yield the desired decoding performance.

Type Information

ENUM8 (8-bit enumeration)
Possible values:
  • 0 = GoodCodes
  • 1 = DamagedCodes
Read Parameter
Request:
<STX>read OptimizationLevelMaxi<ETX>
Response:
<STX>read OptimizationLevelMaxi 0<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelMaxi 0<ETX>
Response:
<STX>written OptimizationLevelMaxi<ETX>

LogisticSegmentationFilterEnabled

Variable Read/Write

This parameter improves code reading on heavily patterned backgrounds (e.g. special packaging in logistics). Such patterns can be confused with code structures by the device, which may lead to long decoding times or incorrect read results. When enabled, the following patterns are ignored: code or code-like structures that take up more than 40 % of the image, and barcode or barcode-like structures whose height is more than twice the length. Note: Deactivate this function for large, image-filling codes and unusually large barcode heights. These cases can be mistaken by the device for an interference pattern and ignored. They typically occur in factory automation.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read LogisticSegmentationFilterEnabled<ETX>
Response:
<STX>read LogisticSegmentationFilterEnabled true<ETX>
Write Parameter
Request:
<STX>write LogisticSegmentationFilterEnabled true<ETX>
Response:
<STX>written LogisticSegmentationFilterEnabled<ETX>

LogisticSegmentationFilterEnabledManualEditStatus

Variable Read/Write

This parameter allows users to manually control the pattern filter setting. When enabled, automatic adjustment of the pattern filter is disabled, giving users full control over the filter settings. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the pattern filter based on the application parameters to achieve optimal performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read LogisticSegmentationFilterEnabledManualEditStatus<ETX>
Response:
<STX>read LogisticSegmentationFilterEnabledManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write LogisticSegmentationFilterEnabledManualEditStatus false<ETX>
Response:
<STX>written LogisticSegmentationFilterEnabledManualEditStatus<ETX>

CodeSize2DManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 2D code size settings. When enabled, automatic adjustment of the 2D code size is disabled, giving users full control over the code size. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 2D code size based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CodeSize2DManualEditStatus<ETX>
Response:
<STX>read CodeSize2DManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write CodeSize2DManualEditStatus true<ETX>
Response:
<STX>written CodeSize2DManualEditStatus<ETX>

OptimizationLevelQrManualEditStatus

Variable Read/Write

This parameter allows users to manually control the QR code aggressiveness settings. When enabled, automatic adjustment of the QR code aggressiveness is disabled, giving users full control over the aggressiveness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the QR code aggressiveness based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OptimizationLevelQrManualEditStatus<ETX>
Response:
<STX>read OptimizationLevelQrManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelQrManualEditStatus true<ETX>
Response:
<STX>written OptimizationLevelQrManualEditStatus<ETX>

CodeContrast1DManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 1D code contrast threshold settings. When enabled, automatic adjustment of the 1D code contrast threshold is disabled, giving users full control over the contrast level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 1D code contrast threshold based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CodeContrast1DManualEditStatus<ETX>
Response:
<STX>read CodeContrast1DManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write CodeContrast1DManualEditStatus true<ETX>
Response:
<STX>written CodeContrast1DManualEditStatus<ETX>

CodeContrast2DManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 2D code contrast threshold settings. When enabled, automatic adjustment of the 2D code contrast threshold is disabled, giving users full control over the contrast level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 2D code contrast threshold based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CodeContrast2DManualEditStatus<ETX>
Response:
<STX>read CodeContrast2DManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write CodeContrast2DManualEditStatus true<ETX>
Response:
<STX>written CodeContrast2DManualEditStatus<ETX>

OptimizationLevelPdfManualEditStatus

Variable Read/Write

This parameter allows users to manually control the PDF417 aggressiveness settings. When enabled, automatic adjustment of the PDF417 aggressiveness is disabled, giving users full control over the aggressiveness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the PDF417 aggressiveness based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OptimizationLevelPdfManualEditStatus<ETX>
Response:
<STX>read OptimizationLevelPdfManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelPdfManualEditStatus true<ETX>
Response:
<STX>written OptimizationLevelPdfManualEditStatus<ETX>

OptimizationLevelDmxManualEditStatus

Variable Read/Write

This parameter allows users to manually control the Data Matrix aggressiveness settings. When enabled, automatic adjustment of the Data Matrix aggressiveness is disabled, giving users full control over the aggressiveness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the Data Matrix aggressiveness based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OptimizationLevelDmxManualEditStatus<ETX>
Response:
<STX>read OptimizationLevelDmxManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelDmxManualEditStatus true<ETX>
Response:
<STX>written OptimizationLevelDmxManualEditStatus<ETX>

OptimizationLevelMaxiManualEditStatus

Variable Read/Write

This parameter allows users to manually control the Maxi code aggressiveness settings. When enabled, automatic adjustment of the Maxi code aggressiveness is disabled, giving users full control over the aggressiveness level. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the Maxi code aggressiveness based on the application parameters to achieve optimal decoding performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read OptimizationLevelMaxiManualEditStatus<ETX>
Response:
<STX>read OptimizationLevelMaxiManualEditStatus true<ETX>
Write Parameter
Request:
<STX>write OptimizationLevelMaxiManualEditStatus true<ETX>
Response:
<STX>written OptimizationLevelMaxiManualEditStatus<ETX>

LocalBarcodeContrastSpreadingManual

Variable Read/Write

This parameter enables or disables local contrast spreading for 1D codes. When enabled, the device locally stretches the contrast within the barcode region, enhancing the difference between bars and spaces. This improves the decoding of 1D codes with low or uneven contrast, for example on reflective, low-quality, or poorly printed labels. When disabled, no local contrast spreading is applied, which may result in faster processing but potentially lower decoding success rates for codes with weak contrast.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read LocalBarcodeContrastSpreadingManual<ETX>
Response:
<STX>read LocalBarcodeContrastSpreadingManual false<ETX>
Write Parameter
Request:
<STX>write LocalBarcodeContrastSpreadingManual false<ETX>
Response:
<STX>written LocalBarcodeContrastSpreadingManual<ETX>

LocalBarcodeContrastSpreadingManualEditStatus

Variable Read/Write

This parameter allows users to manually control the 1D code contrast distribution setting. When enabled, automatic adjustment of the 1D code contrast distribution is disabled, giving users full control over the setting. This is useful in specific applications where the automatic adjustment may not be suitable. When disabled, the device will automatically adjust the 1D code contrast distribution based on the application parameters to achieve optimal performance.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read LocalBarcodeContrastSpreadingManualEditStatus<ETX>
Response:
<STX>read LocalBarcodeContrastSpreadingManualEditStatus false<ETX>
Write Parameter
Request:
<STX>write LocalBarcodeContrastSpreadingManualEditStatus false<ETX>
Response:
<STX>written LocalBarcodeContrastSpreadingManualEditStatus<ETX>

MotionBlurFactor

Variable Read/Write

Factor used to determine the optimal shutter time.

Type Information

REAL (32-bit IEEE 754 floating point)
Read Parameter
Request:
<STX>read MotionBlurFactor<ETX>
Response:
<STX>read MotionBlurFactor 1.0<ETX>
Write Parameter
Request:
<STX>write MotionBlurFactor 1.0<ETX>
Response:
<STX>written MotionBlurFactor<ETX>

Cybersecurity

9 items

CommandExecutionEnabled

Variable Read/Write

This parameter allows users to enable or disable the command configuration feature. When enabled, the device can be configured via commands sent through various interfaces. Disabling this feature may prevent accidental command execution but also removes the convenience of configuring the device through command-based methods.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CommandExecutionEnabled<ETX>
Response:
<STX>read CommandExecutionEnabled true<ETX>
Write Parameter
Request:
<STX>write CommandExecutionEnabled true<ETX>
Response:
<STX>written CommandExecutionEnabled<ETX>

CommandConfirmationEnabled

Variable Read/Write

This parameter allows users to enable or disable command confirmation. When enabled, the device will send a confirmation response after executing a command, providing feedback to the user or system that the command was successfully received and processed.

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read CommandConfirmationEnabled<ETX>
Response:
<STX>read CommandConfirmationEnabled true<ETX>
Write Parameter
Request:
<STX>write CommandConfirmationEnabled true<ETX>
Response:
<STX>written CommandConfirmationEnabled<ETX>

SetParameterCloningEnabled

Method

This parameter allows users to enable or disable the configuration cloning feature via the connection module. When enabled, the device can automatically transfer its configuration settings to a connected connection module, facilitating easier setup of different reading modules with the same configuration. Disabling this feature may prevent accidental configuration transfers but also removes the convenience of quickly replicating configurations across multiple devices.

Parameters

STRUCT (Composite structure)
Elements:
EnableParameterCloning (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetParameterCloningEnabled {'EnableParameterCloning': false}<ETX>
Response:
<STX>run SetParameterCloningEnabled<ETX>

SetButtonFactoryResetEnabled

Method

This parameter allows users to enable or disable the factory reset function via the device's function button. When enabled, it is possible to reset the device to its factory default settings by using the function button in a specific manner. Disabling this feature may prevent accidental resets but also removes the convenience of quickly restoring factory settings when needed.

Parameters

STRUCT (Composite structure)
Elements:
EnableButtonFactoryReset (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetButtonFactoryResetEnabled {'EnableButtonFactoryReset': false}<ETX>
Response:
<STX>run SetButtonFactoryResetEnabled<ETX>

SetButtonFirmwareUpdateEnabled

Method

This parameter allows users to enable or disable the firmware update function via the device's function button. When enabled, it is possible to initiate a firmware update from a USB stick by using the function button in a specific manner. Disabling this feature may prevent accidental firmware updates but also removes the convenience of quickly updating the firmware when needed.

Parameters

STRUCT (Composite structure)
Elements:
EnableButtonFirmwareUpdate (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetButtonFirmwareUpdateEnabled {'EnableButtonFirmwareUpdate': false}<ETX>
Response:
<STX>run SetButtonFirmwareUpdateEnabled<ETX>

SetUSBEnabled

Method

This parameter allows users to enable or disable the USB service interface for device parameterization. When enabled, the USB interface provides an additional method for configuring the device. Disabling this service may limit access to device configuration options, so it is recommended to keep it enabled unless there is a specific reason to disable it.

Parameters

STRUCT (Composite structure)
Elements:
EnableUSB (default: false)
BOOL (true / false)
SavePermanent (default: false)
BOOL (true / false)
RestartNow (default: false)
BOOL (true / false)

Return Values

STRUCT (Composite structure)
Elements:
Success (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetUSBEnabled {'EnableUSB': false, 'SavePermanent': false, 'RestartNow': false}<ETX>
Response:
<STX>run SetUSBEnabled {'Success': false}<ETX>

SetSSHEnabled

Method

This parameter allows users to enable or disable the SSH service on TCP Port 22. When enabled, SSH provides secure remote access to the device's operating system for expert users and developers. It is recommended to disable this service if it is not required, as leaving it enabled may pose a security risk by exposing the device to potential unauthorized access.

Parameters

STRUCT (Composite structure)
Elements:
EnableSSH (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetSSHEnabled {'EnableSSH': false}<ETX>
Response:
<STX>run SetSSHEnabled<ETX>

EtherCoLa2Enabled

Variable Read/Write

Selects if Ethernet CoLa2 (TCP port 2122) and CoLa2 Scan (UDP port 37018) are enabled

Type Information

BOOL (true / false)
Read Parameter
Request:
<STX>read EtherCoLa2Enabled<ETX>
Response:
<STX>read EtherCoLa2Enabled true<ETX>
Write Parameter
Request:
<STX>write EtherCoLa2Enabled true<ETX>
Response:
<STX>written EtherCoLa2Enabled<ETX>

SetCoLaScanEnabled

Method

Parameters

STRUCT (Composite structure)
Elements:
EnableCoLaScan (default: false)
BOOL (true / false)
SavePermanent (default: false)
BOOL (true / false)
RestartNow (default: false)
BOOL (true / false)

Return Values

STRUCT (Composite structure)
Elements:
Success (default: false)
BOOL (true / false)
Execute Action
Request:
<STX>run SetCoLaScanEnabled {'EnableCoLaScan': false, 'SavePermanent': false, 'RestartNow': false}<ETX>
Response:
<STX>run SetCoLaScanEnabled {'Success': false}<ETX>

Device Information

3 items

LocationName

Variable Read/Write

This parameter specifies the name of the location where the device is installed.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read LocationName<ETX>
Response:
<STX>read LocationName "here"<ETX>
Write Parameter
Request:
<STX>write LocationName "here"<ETX>
Response:
<STX>written LocationName<ETX>

FirmwareVersion

Variable Read Only

This parameter specifies the firmware version of the device.

Type Information

FLEX_STRING (Variable-length string)
Read Parameter
Request:
<STX>read FirmwareVersion<ETX>
Response:
<STX>read FirmwareVersion "XXXXXXXXXX"<ETX>

DeviceStatus

Variable Read Only

This parameter specifies the current status of the device.

Type Information

ENUM8 (8-bit enumeration) → DeviceStatus
Possible values:
  • 0 = DS_UnknownState
  • 1 = DS_Startup
  • 2 = DS_ServiceMode
  • 3 = DS_NormalOperation
  • 4 = DS_SuspendedOperation
  • 5 = DS_ServiceRecommended
  • 6 = DS_ServiceRequired
  • 7 = DS_RecoverableError
  • 8 = DS_FatalError
Read Parameter
Request:
<STX>read DeviceStatus<ETX>
Response:
<STX>read DeviceStatus 0<ETX>

Possible Error Responses

Error Code Description
Parsing Failed Command syntax is invalid
Invalid Data Parameter value format is incorrect
Internal Server Error Device encountered an internal error
Access Denied Insufficient permissions (login required)
Not Found Parameter or action does not exist
Out Of Range Numeric value exceeds allowed range
Out Of Bounds Array index out of bounds
Read Only Attempted to write a read-only parameter
Illegal Value Value not allowed for this parameter
Invalid Challenge Authentication challenge invalid