eBARCODE-MLDocumentation
Install eBARCODE-ML
eBARCODE-ML comes preinstalled in Android as Virtual Preload APK and requires data connection and Google Play Store account to download full application.
Instructions
- Connect device to internet
- Login to Google Play Store
- Open eBARCODE-ML VPL application and download full application from the Play Store
Dashboard
Dashboard shows the status of license and necessary permissions for eBARCODE-ML to work properly. The application asks for all permissions and presents their reasoning when launched for the first time. If any permission is declined it can be revisited by clicking the corresponding permission in the Dashboard.
Some vital permissions are not given and hence dashboard is showing indication that actions are needed. Application cannot be used without addressing these actions.
Dashboard indicates if there are recommended actions for optimal use of eBARCODE-ML. User experience may be limited if recommended actions are ignored.
When everything is up and running dashboard indicates that no further actions are needed.
Dashboard also shows what scanner application is currently using for scanning. And relevant tips to end user.
Needed Actions
Privacy Policy
Display Over Other Apps Permission
Camera permissions
Notification Permission
Recommended Actions
Accessibility Service
Enabling of the accessibility service is needed for enabling recommended functionality of the application. Please note that enabling shortcut is not required for accessibility service to function properly, it is only required if user needs to disable/enable accessibility functions during use.
Android Notifications Menu
The barcode scanning widget can be shown from Android notifications menu by clicking the notification.
After device restart eBARCODE-ML needs to be initialized from the top down menu for widget to work. Alternately launching the eBARCODE-ML application also initializes the widget.
When using external scanner notification offer option to enable and disable the floating bubble button.
If Android notification is swiped and removed it can be re-enabled from the Dashboard Notifications section.
Setup Programmable key to control eBARCODE-ML
Programmable keys can be used to launch and close the widget and to start and stop scanning operation.
Access Custom Features from Android Settings.
Access Programmable keys from the menu.
Assign eBARCODE-ML for the preferred button. Above PTT key is used for controlling the Widget.
Direct link to the programmable keys menu is also provided from application dashboard under Tips section.
Use
- When using device camera as a scanner:
- Launching and closing the widget is done with Long press of the programmed button.
- When widget is visible scanning operation can be started and stopped with short press of the programmed button.
- When using external scanner
- Scan is active when programmed button is being pressed.
Scanning widget
Widget when using camera as a scanner
Widget when minimized, clicking the floating button re-opens the widget
When using external scanner floating button widget is used to trigger scan.
Up row controls
-
Minimizes widget to an overlay bubble that enables to reopen widget easily between multiple scan operations with minimum delay. -
Resize tool shows preview rectangle that can be adjusted to resize the widget size. -
Close the widget.
Down row controls:
-
Torch on/off. -
Scan button to start and stop scanning. -
Focus lock, will lock the focus to current position. This is useful for example when batch scanning from same distance.
Other
Widget can be relocated by pressing from widget area and moving it around to preferred location.
For best performance scanned barcode should be inside the scanning rectangle in the middle of the widget. Before scanning is active rectangle is shown for barcode that is going to be scanned if scan is started.
Settings
Settings can be accessed from hamburger menu on the top left corner of the application.
Settings that are currently not usable are indicated by exclamation icon and explanation what is causing the setting to be not available. If no explanation is given clicking the exclamation icon provides pop up message with additional details. Below main functionality aspects causing some features to be unavailable.
Setting requires accessibility service
Settings affected by scanner type
Settings grayed out and unavailable when using
external scanner.
Unavailable settings grayed out in
scanning settings. Tapping the ‘i’
icon reveals the reason.
Barcode Types
Barcode types can be toggled on and off to for example improve scanning speed.
User License
eBARCODE-ML requires a license for barcode scanning. After initial provisioning, the app starts in trial mode, which is 28 days. After that, a license needs to be entered.
The license is managed in User license settings, which can be found by navigating to Settings → User license.
Entering user license
User license can be set by clicking ENTER LICENSE button. After a license key is entered, the application attempts to activate it. The activation result is shown to the user.
If license is time-bound, then remaining days is shown.
User license in trial mode.
User license input dialog. License can be input manually or by reading a QR code.
User license activated.
Revoking a license
To revoke a license, navigate to User license and click REVOKE LICENSE.
Renewing a license
If a time-bound license has expired, and it has been renewed in the server side (e.g. more time is purchased), then the application can renew the existing license without re-typing the license key. To do this, navigate to User license and click RENEW LICENSE.
Settings Simulation rules
Simulation rules can be added by clicking buttons, and edited directly from the text box (remember to Save after editing).
Remember to enable simulation rule via toggle switch.
Scanning Settings
After widget opened (require device camera to be used as scanner)
- Scanning can be set to start automatically after widget is started.
- By default torch is disabled and can be enabled from Widget UI. With this setting torch can be enabled to be on when widget is launched.
After barcode scanned
- Inject barcode (requires accessibility service to be enabled)
- Barcode is injected directly to the active application with no further user interaction needed.
- Copy barcode to clipboard
- By default scanned barcode is copied to clipboard. In case accessibility service is used barcode data is input directly to active input, and clipboard can be disabled.
- Play audio feedback
- By default widget produces audio feedback when barcode is successfully scanned, audio can be disabled with this setting.
- Widget (require device camera to be used as scanner)
- Stay open
- default functionality, widget stays open after scan.
- Minimize, widget is minimized to floating bubble button.
- Close, widget is completely closed.
- Stay open
Scanning widget controls
- Zoom in/out with volume keys (requires accessibility service to be enabled and device camera to be used as scanner)
- Volume up and down keys control the zoom level of the widget preview.
- Close timeout in seconds
- In order to optimize device power consumption the scanner can be set to close automatically after certain period without scanning.
Scanner
- Camera scanner
- Device internal back camera is used for widget and scanning.
- External scanner
- External scanner unit is used for scanning.
Smart-Ex® 203
Smart-Ex® 203 can be operated with scanner module accessory. Switch to “External scanner“ in scanning settings to start
using it, no license is required.
The scanner automatically powers on when a scan is triggered. Close timeout setting can be used to conserve device
battery. If scan is not triggered within the close timeout, the scanner is powered off.
External scanner enabled in scanning settings with 60 second close timeout.
Scan trigger starts powering on the scanner, if needed.
Check the accessory scanner connection if it was not detected.