eBARCODEDocumentation


The Android™ soft-keyboard, eBARCODE from ECOM Instruments GmbH, with an integrated barcode scanner / NFC reader, provides a fast and convenient way of scanning bar-codes or reading NFC tags with any application.

The scanned or read data will appear in the target app field as text. Manual typing and voice input is still supported.

License Models

  • Essential (supports Keyboard, ZXing and NFC Scanner)
  • Premium (supports Keyboard, HSM, ZXing and NFC Scanner)

Please also review the feature comparison and barcode support table for the decoder engines HSM (Swift) and ZXing).

Introduction

Image

eBARCODE provides an additional input method for your Android device. It offers a convenient keyboard for manual typing (or voice-input) which is extended by an additional key for fast barcode scanning (or NFC tag reading). Inconvenient app-switching or copy & paste is not required. For the target app there is no difference between user input or scanned data - in both cases, the data appears as typed by the user.

eBARCODE offers support for all common input languages. The suitable keyboard layout is manually configured or activated automatically depending on the system language of your handset.

eBARCODE is extremely easy to use and enables you to scan bar-codes/read NFC tags without leaving the target app.

Features
  • State-of-the-Art keyboard layout
  • Voice recognition, suggestions, dictionaries, fast keyboard switching
  • Multi-language support
  • Guided installation
  • Configurable scanner keys
  • Quicktext (custom text modules) support
  • Integrated camera scanner (portrait, landscape, automatic)
  • Integrated NFC reader capabilities
  • Versatile licensing capabilities
  • Google Play licensing, online activation without a Google account, bulk licensing with license files based on device id (serial number or IMEI)
  • Simple bulk configuration by files
  • Rule-based scanner behavior, adjustable initial keyboard layout
  • Automated barcode scanning / NFC reading in certain input fields
  • Uses version 3.2 of the ZXing barcode scanner engine
  • Uses version 5.2 of the Honeywell HSM barcode decoder engine

Installation

Image

The guided setup routine installs, enables and activates the eBARCODE automatically. No additional steps are required by the user.

Please perform the following steps to re-enable the eBARCODE if it was deactivated:

  • Navigate to Android Settings > Language & Input
  • Tap on Virtual Keyboard and Manage Keyboards, then select eBARCODE. You need to accept the standard security warning (see below).

For older Android versions you may need to navigate to Android Settings > Language/Keyboard, check eBARCODE Keyboard and confirm the security warning.

After enabling the keyboard it needs to be adjusted as active input method: touch an input field for some seconds until a menu appears. Select Input method and choose eBARCODE Keyboard.

The Keyboard

Image

The eBARCODE Keyboard is organized as follows:

  • Quicktext

    • Image
    • Long-tap the “A” icon to edit Quicktexts. A short tap inserts the defined Quicktext in the active input field.
  • Scanner Key

    • Image
    • A short tap on the barcode icon opens the camera bar-code scanner, the NFC tag reader - or both. The captured data is injected into the current input field after scanning.
  • Settings

    • Image
    • Tap on the cog wheel key or long-press the comma key to change keyboard settings.
  • Voice Input _ Image _ Tap on the microphone icon to activate the voice input.

Keyboard Settings

Image

To modify the eBARCODE Keyboard options, press either the cog wheel key or long-press the comma key. Alternatively, go to Android Settings -> Language & keyboard -> Virtual Keyboard -> eBARCODE Keyboard.

The following options are available if you tap on Keyboard preferences:

License State

Show license details

Depending on your license state, various information are displayed:

  • Status: Licensed / - Un-Licensed
  • Registered IMEI or Serial number
  • Licensed decoder: XZing Decoder or HSM Swift

For getting a valid license, please contact us at sales@ecom-ex.com or via our contact form at www.ecom-ex.com/contact/.

Common

This section is used to specify general eBARCODE options like if and where scan-/settings-key should be displayed and how to modify Quicktexts.

Operation mode

Choose the operation mode of the keyboard: select if the scan-key opens the camera barcode scanner, the NFC tag reader or both (first NFC tag reader, then camera scanner).

Clipboard

If checked the scanned data is copied into the clipboard.

Section for advanced settings:

Show scan-key

Adjust whether the scan-key is displayed in the suggestion bar or not.

Long tap on scan-key

Select the intent action string when long-tapping the scan key.

Show settings-key

Adjust whether the settings-key (cog wheel) is displayed in the suggestion bar or not.

Suggestion bar

If checked, the suggestion bar is displayed if the numeric keypad is active.

Bottom scan-key

If selected (this is the default), the scan-key is displayed on the left of the space bar.

Custom scan-keys

Define individual keys used for barcode scanning or tag reading. You have the possibility to extend the key-popup with barcode scanner functionality or to replace the key with the scanner functionality (the original key is still available in the popup with a long-tap). Configured scanner keys are marked with a thin red frame.

Show Quicktext-key

Define whether the Quicktext-key is displayed in the suggestion bar or not.

Quicktexts

Add, edit or delete own Quicktexts.

Image

Camera Scanner

This section is only enabled if the camera scanner is in use (see Operation mode).

Camera Scanner

Choose between the internal camera scanner (based on barcode scanner engine from ZXing) or HSM Swift Decoder which is a high performance industrial-grade scan engine.

For the built-in scanner it is possible to configure the preferred orientation used for barcode scanning (landscape, portrait or auto-mode).

Please be noted: For XZing or HSM decoder you need separate licenses. Please refer to the chapter License above.

Batch Scanning

If this option is selected, the barcode scanner works in batch mode and scans barcodes continuously until interrupted by the back key.

Pause Between Scans

This option is only available if the batch-mode is enabled. The specification of the waiting time between single scan operations in milliseconds (1000 milliseconds = 1 second).

Section for advanced settings:

Flashlight

If checked, the flashlight is enabled while scanning bar-codes (this option may not work on all devices).

Silent scan

If checked, no sound is emitted when scanning.

Invert scan

If checked, bright barcodes on dark background can be scanned.

Autofocus Mode

Choose between Normal, Legacy or Compatibility mode (useful if you are experiencing difficulties).

Permanent Autofocus

Enable or disable the permanent autofocus: If disabled, the focus is adjusted only once when a scan is initiated.

Autofocus Delay

This option is only available if “Permanent Autofocus” has been enabled. The delay between individual autofocus attempts is adjusted in milliseconds (1000 milliseconds = 1 second).

1D / Linear Bar Codes

Enable or disable the recognition of certain 1D or linear barcodes.

2D Bar Codes

Enable or disable the recognition of certain 2D barcodes.

Barcode Character Set

Use this option to ensure the correct decoding of bar-codes which are encoded using a special character set. The following character sets are available: automatic mode, ASCII, Latin Alphabet, UTF-8, UTF-16, Korean (949), Russian (20866), Japanese (Shift-JIS), Traditional Chinese (950), Traditional Chinese (Big5).

HSM Swift Decoder

Feedback on Success

If enabled, a sound is played after a barcode was scanned successfully.

Show Aimer

If enabled, a crosshair symbol is displayed while scanning.

Scan Region

Selects the region used for scanning barcodes.

Enable Front-Facing Camera

Selects the camera to be used for scanning. Tip: for better results use the camera with the higher resolution.

Support for AccessToGo

Enables better scan-support for the RDP app AccessToGo.

Silent Scan

If checked, no sound is emitted when scanning.

NFC Reader

This section is only enabled if the NFC reader is in use (see Operation mode).

Section for ISO 15693:

Specifies the parameters for reading ISO15693 (NfcV) tags.

Enabled

If this option is selected, ISO 15693 tags can be read.

User confirmation

If checked, the user must confirm a NFC reading. NFC data is injected only into the target app after a confirmation.

Group hex data

Select whether hexadecimal data should be grouped into blocks of 2 hex-digits.

Invert UID

Select the order for transmitting the single hex-digits of the UID. The UID is available via the placeholder ${INPUT} in the simulation rule (see below).

Start index for user data

Select the first byte position of the user data (starting with 0). The user data is available via the placeholder ${USERDATA} in the simulation rule (see below).

Length of for user data

Specify the length of the user data block in bytes. The user data is available via the placeholder ${USER_DATA} in the simulation rule (see below).

Address flag

Select whether the address flag should be set for reading user data (support depends on tag).

Option flag

Select whether the option flag should be set for reading user data (need to be supported by tags).

Multi block read

Select whether single or multi-block read methods should be used (need to be supported by tags).

Section for other tag technologies:

Specifies the parameters for reading NfcA, NfcB, NfcF, IsoDep and NDEF tags.

Enabled

If this option is selected, NfcA, NfcB, NfcF, IsoDep and NDEF tags can be read.

User confirmation

If checked, the user must confirm a NFC reading. NFC data is injected only into the target app after a confirmation.

Group hex data

Select whether hexadecimal data should be grouped into blocks of 2 hex-digits.

Invert UID

Select the order for transmitting the single hex-digits of the UID. The UID is available via the placeholder ${INPUT} in the simulation rule (see below).

Image

Keyboard Behavior

Define behavior (prefix, suffix,…) for target-apps. By the means of Simulation Rules the user is able to configure the keystroke simulation mode and cursor movements per target application.

Enable Automatic Scans

If disabled, the Autoscan feature is turned off for all Simulation Rules (see below for further instructions). This setting is only available for the internal camera-scanner.

Section for advanced settings:

Advanced parameters for hardware keyboards and swipe support.

Show soft keyboard

If enabled, the soft-keyboard is shown even if a hardware keyboard is connected.

Swipe keyboard layout

If enabled, swiping the keyboard left or right switches the keyboard layout to numeric or symbolic input.

Swipe to scan

If enabled, swiping down invokes the barcode scanner / NFC reader.

Swipe to clear all

If enabled, swiping up clears the current input field.

Import/Export

This section provides functions to import or export the configuration of the app from/to XML files. Whenever a configuration file is found in the Download folder, eBARCODE reads it, applies the settings and renames it thereafter.

Import

Import a configuration file (from Google Drive, a local storage location, etc.).

Export

Export the configuration to an XML-file (“BarcodeKeyboard.xml”).

Password Protection

Set a password to avoid unintended configuration changes. Clear the password to remove the protection.

About

This section provides commands for displaying the user manual, the software version and the copyright information. In addition you can display your license information or enter a manual license.

App permissions

Opens an activity which provides the possibility to selectively grant or deny app permissions.

User Manual

This command shows this web-page in your browser. Please contact us in case of questions, suggestions or if you want to report a bug.

Privacy policy

This command shows the privacy policy for this app.

Device ID

Displays the serial number of the device. Tap on the serial number to copy it into the clipboard.

About

Displays the current software version, a copyright notice and 3rd party credits.

Simulation Rules