Table of Contents

BarCodeScanner Section

These are settings defining a bar code scanner.

  • Parent Sections
  • Full Section Key Path Examples
    • Workstation:BarCodeScanning:Scanners:0
    • Workstation:BarCodeScanning:Scanners:1

These settings apply to all bar code scanner types:

Key Value Type Default Value Description
Name string An optional name for the bar code scanner. This is not required, but if set will be used to identify the bar code scanner in health check problems and in the list of bar code scanners when testing local hardware.
IsFiltered boolean false Whether to filter bar code scans, which should normally be turned on for fixed automated scanners, and left off for manual scanners.
ReconnectDelay time span 0:00:03 The reconnect delay period, which is how long to pause before attempting to reconnect after losing a connection to the bar code scanner. This must be greater than or equal to 0:00:00. This applies to any scanner that must establish a connection to an external device (i.e., the bar code scanner class implements IConnectedDevice).
Type string The bar code scanner type. Acuit Pinpoint Workstation includes the built-in types listed below, but this can also be set to the class name of any custom bar code scanner type provided by a plug-in. Bar code scanners must implement IBarCodeScanner.

Additional settings are available, depending on the bar code scanner type, as detailed below. For custom bar code scanner types, additional settings correspond to public properties on the class.

Keyboard Type

This is a bar code scanner that looks like a keyboard to Windows. These additional settings apply to this type:

Key Value Type Default Value Description
MaxMessageLength integer 200 The maximum message length allowed. Messages from the scanner longer than this will be discarded. This must be greater than 0.
MultipleSeparator string The character(s) that separate multiple bar codes sent in one message from the scanner.
Prefix string The prefix character(s) that start each message from the scanner.
Suffix string The suffix character(s) that terminate each message from the scanner. This is required.
Timeout time span 0:00:01 The maximum time allowed between characters while receiving a message from the scanner. This must be greater than 0:00:00.
TranslateHoneywell4820ControlCharacters boolean true Whether to translate special keys that the Honeywell 4820i Industrial Cordless Area Imager sends for certain control characters. When bar codes contain certain control characters (i.e., outside of the normal printable ASCII character range), the Honeywell 4820i Industrial Cordless Area Imager will send special keys instead. When this property is true, these special keys will be translated to the appropriate control characters so that bar codes will be properly decoded.
TranslateMotorolaSymbolDS4208ControlCharacters boolean true Whether to translate special keys that the Motorola/Symbol DS4208 Digital Scanner sends for certain control characters. When bar codes contain certain control characters (i.e., outside of the normal printable ASCII character range), the Motorola/Symbol DS4208 Digital Scanner will send special keys instead. When this property is true, these special keys will be translated to the appropriate control characters so that bar codes will be properly decoded.

KeyenceEthernet Type

This is a Keyence Ethernet bar code scanner. These additional settings apply to this type:

Key Value Type Default Value Description
Address string The network address for the bar code scanner.
CommandOnConnect string LON␍ An optional command to be sent to the bar code scanner once a connection is established. If termination characters such as a carriage return are required, they must be included in this value (i.e., Prefix and Suffix are only used when reading).
MaxMessageLength integer 200 The maximum message length allowed. Messages from the scanner longer than this will be discarded. This must be greater than 0.
MultipleSeparator string The character(s) that separate multiple bar codes sent in one message from the scanner.
Port integer 9004 The network IP port number for the bar code scanner. This can be from 0 to 65535.
Prefix string The prefix character(s) that start each message from the scanner.
Suffix string ␍ The suffix character(s) that terminate each message from the scanner. This is required.
Timeout time span 0:00:01 The maximum time allowed between characters while receiving a message from the scanner. This must be greater than 0:00:00.

In the default values above, ␍ represents a carriage return, which is ASCII control character 13.

Serial Type

This is a serial port bar code scanner. Data is assumed to be encoded as ASCII. These additional settings apply to this type:

Key Value Type Default Value Description
CommandOnConnect string An optional command to be sent to the bar code scanner once a connection is established. If termination characters such as a carriage return are required, they must be included in this value (i.e., Prefix and Suffix are only used when reading).
MaxMessageLength integer 200 The maximum message length allowed. Messages from the scanner longer than this will be discarded. This must be greater than 0.
MultipleSeparator string The character(s) that separate multiple bar codes sent in one message from the scanner.
Prefix string The prefix character(s) that start each message from the scanner.
SerialPort SerialPortSettings Section n/a Settings for the serial port used for communication with the bar code scanner.
Suffix string The suffix character(s) that terminate each message from the scanner. This is required.
Timeout time span 0:00:01 The maximum time allowed between characters while receiving a message from the scanner. This must be greater than 0:00:00.

Tcp Type

This is a TCP connection bar code scanner. Data is assumed to be encoded as ASCII. These additional settings apply to this type:

Key Value Type Default Value Description
Address string The network address for the bar code scanner.
CommandOnConnect string An optional command to be sent to the bar code scanner once a connection is established. If termination characters such as a carriage return are required, they must be included in this value (i.e., Prefix and Suffix are only used when reading).
MaxMessageLength integer 200 The maximum message length allowed. Messages from the scanner longer than this will be discarded. This must be greater than 0.
MultipleSeparator string The character(s) that separate multiple bar codes sent in one message from the scanner.
Port integer 0 The network IP port number for the bar code scanner. This can be from 0 to 65535.
Prefix string The prefix character(s) that start each message from the scanner.
Suffix string The suffix character(s) that terminate each message from the scanner. This is required.
Timeout time span 0:00:01 The maximum time allowed between characters while receiving a message from the scanner. This must be greater than 0:00:00.