Zebra FX User Manual

Zebra FX Series Embedded Java SDK User Guide
Zebra FX Series Embedded Java SDK User Guide
Zebra FX Series Embedded Java SDK User Guide Zebra FX Series Embedded Java SDK User Guide
Windows
Windows
Version 1.0.1
Version 1.0.1
Version 1.0.1Version 1.0.1
ZEBRA TECHNOLOGIES 1
ABOUT THIS GUIDE
Table of Content
1.0 Introduction ................................................................................................................................ 3
2.0 Revision History .......................................................................................................................... 4
3.0 Pre- Requisites ............................................................................................................................ 5
4.0 SDK Install ................................................................................................................................... 6
4.1 Install SDK zip file .......................................................................................................................... 6
4.2 Setup System Variable – User Path ............................................................................................... 8
5.0 Starting SDK............................................................................................................................... 11
6.0 Setup Remote Connection for Remote Debugging ................................................................... 13
7.0 Java Sample Application Build and Debug ................................................................................ 21
7.1 Import RFID3 API Java Library to Embedded Java Project. ................................................... 22
7.2 Building Java Executable Class File(s).................................................................................... 25
7.3 Setup Java Remote Debug Configuration. ............................................................................ 27
7.3.1 Setup Java Remote Build Path. ..................................................................................... 27
7.4 Debug Embedded Java Application ....................................................................................... 34
7.4.1 Remote SSH Terminal Setup ......................................................................................... 37
8.0 Embedded Java Application ...................................................................................................... 43
8.1 Creating an Embedded Java Project ........................................................................................... 43
8.2 Adding Source File to Embedded Java Project ............................................................................ 45
8.3 Import RFID3 API Java Library to Embedded Java Project. ................................................... 47
8.4 Building Java Executable Class File(s).................................................................................... 49
8.5 Setup Java Remote Debug Configuration. ............................................................................ 51
8.5.1 Setup Java Remote Build Path. ..................................................................................... 51
8.6 Debug Embedded Java Application ....................................................................................... 59
8.6.1 Remote SSH Terminal Setup ......................................................................................... 62
8.7 Create Java JAR Executable ................................................................................................... 67
8.7.1 Create the Manifest file of the project. ........................................................................ 67
8.7.2 Create and export the JAR executable: ......................................................................... 70
9.0 Embedded Application Installation Package Creation .............................................................. 76
ZEBRA TECHNOLOGIES 2
8.8 Create Start and Stop Scripts of Java Installation Package ................................................... 75
9.1 Creating an FX RFID Reader Embedded Application Installation Package ............................ 76
9.2 Install and Uninstall Application Package on Zebra RFID Reader ......................................... 78
Introduction
1.0 Introduction
The Zebra FX Series Embedded Java SDK User Guide for Windows describes the detailed steps about
how to use the FX Series Embedded Java SDK to develop, debug and package Embedded application
using fixed RFID reader FX9600 and FX7500 on Windows.
This user guide covers the following topics
Zebra Java SDK describes how to create, build, and debug an embedded Java application,
and how to create Start and Stop script files for the deployment packages used to install the
application onto the FX RFID Readers on Windows 10 and windows 7 OS.
Embedded Sample RFID Java Application from scratch, create, build and debug
JAR File creation using Manifest file
Sample Hello world Example from scratch, create, build and debug
Note: Uninstall any older Zebra SDK if installed on Windows host machine.
ZEBRA TECHNOLOGIES 3
Execution steps on sample app.
REVISION
HISTORY
2.0 Revision History
REV DESCRIPTION DATE AUTHOR
1.0 Steps and procedure to develop,
debug and package embedded
application for Zebra sample
application
1.1 Updated the SDK file names in
new format
Java 8 installation added in
prerequisites
1.2 ‘dos2unix’ tool information
added for script file format conversion.
At reader after installation.
19-June-2019
24 June 2019
30 April 2020
ZEBRA TECHNOLOGIES 4
PRE
-
REQUISITE
3.0 Pre- Requisites
Host Machine running with Windows 10 Pro or Windows 7.
Host Machine with 16GB Ram preferred with 40GB free space, Intel Core I7 CPU.
Zebra-FXSeries-Embedded-SDK-Java-Windows_V1.0.1.zip file provided by Zebra.
Install 7-Zip in the host machine. This is required to unzip file.
RFID Reader FX Series Firmware Version 3.x.x or higher
Ensure latest Java (Java 8) is installed in the host machine
ZEBRA TECHNOLOGIES 5
JAVA SDK INSTALL
4.0 SDK Install
This section describes the steps involved for installing Zebra Java SDK on Windows host machine.
4.1 Install SDK zip file
Copy the Zebra-FXSeries-Embedded-SDK-Java-Windows_V1.0.0.zip file provided by Zebra in any of
the drives folder.
Figure 1 : Zipped File
Right Click on the zip file, select 7-zip and select Extract files.
Figure 2 : 7-Zip
ZEBRA TECHNOLOGIES 6
Select the folder where the zip file needs to be extracted to, for example, the following screenshot
shows the zip file being extracted to C:\ drive user path.
Note : Please make sure the checkbox under “Extract to” is unchecked. Also, in Windows 7, there is no text box beside the highlighted checkbox below, please proceed further and click OK. Figure 3 : 7-Zip extraction
Click on the unzipped folder of Zebra-FXSeries-Embedded-SDK.
Figure 4 : Unzipped Folder
ZEBRA TECHNOLOGIES 7
Navigate to Zebra-FXSeries-Embedded-SDK-> eclipse folder to verify that required files are available
as per following screenshot.
Figure 5 : Eclipse Folder
4.2 Setup System Variable – User Path
Set up system variable on the host machine.
The following screenshots will help in setting up the variable path.
Right Click on This PC (Windows 10) or Computer (Windows 7) and click on properties.
Figure 6 : System Properties
ZEBRA TECHNOLOGIES 8
Click on Advanced properties
Figure 7 : Advanced System Settings
Click on Environment Variables
Figure 8 : Environment Variables
ZEBRA TECHNOLOGIES 9
Click On New
Figure 9 : System Variable
Enter Variable name as “FXSERIES_EMBEDDED_SDK_WORKING_DIR”
Enter Variable value as the path of the extracted zip, for example
Variable value as “C:\Zebra-FXSeries-Embedded-SDK”
Note : There should not be any spaces in Variable name and Variable value fields.
Figure 10 : System Variable Pop up
Next, click on OK for 3 times and close the system properties window.
ZEBRA TECHNOLOGIES 10
STARTING SDK
5.0 Starting SDK
To start the SDK
Double click on the eclipse.exe file inside eclipse folder as mentioned in Figure 5.
Figure 11 : Eclipse Screen
In the Workspace field, select the folder for project settings and project file storage.
For Ex: ‘[install-path]’\samples\java and click on select.
Click on Launch button. In the following example, the path has been set to “C:\ Zebra-FXSeries-
Embedded-SDK\samples\java” folder based on current installation path in the host.
Figure 12 : Workspace Popup
ZEBRA TECHNOLOGIES 11
Close the welcome window if it appears.
Figure 13 : Eclipse Welcome Screen
Note: The following instructions shows Microsoft Windows 10 Pro screens.
RFIDSample4App can be found on the Package Explorer view.
Figure 14 : RFIDSample4App Package
Note : If there is an exclamation sign against RFIDSample4App just like the following screenshot,
then there is a mismatch in API library. This can be rectified by removing the API3 jar, this has been
explained down in section 7.1.
ZEBRA TECHNOLOGIES 12
SETUP REMOTE CONNECTION FOR REMOTE DEBUGGING
6.0 Setup Remote Connection for Remote Debugging
The following steps describes how to setup a remote connection to a device in order to run a debug
session of the embedded application for JAVA or access a terminal session on the device to execute
the Linux commands or any applications.
On eclipse tool bar menu, please Select window-> perspective ->open perspective-> other
Figure 15 : Java Perspective
Select Remote System Explorer, Select open
Figure 16 : Package Explorer View
ZEBRA TECHNOLOGIES 13
Select the remote system explorer button if available
Figure 17 : Remote System Explorer View
Right click on Local in the remote system view and select new-> Connection.
Figure 18 : Connection View
Select Linux in the New Connection and click on Next.
Figure 19 : Remote System View
ZEBRA TECHNOLOGIES 14
In the New Connection or Remote Linux System Connection,
In the Host field, enter the host (the device IP address or network name).
Connection name as ‘Test’, Description as ‘Demo’’ and select Next.
Note: Deselect Verify host name if the device is not accessible during setup.
Figure 20 : Remote Linux System Connection View
ZEBRA TECHNOLOGIES 15
Note: Display over parent profile may change. Still provide connection information.
In the New Connection or Files window, select ssh.files in the configuration section and select Next.
ZEBRA TECHNOLOGIES 16
Figure 21 : ssh Files View
In the New Connection or Processes window select processes.shell.linux in the configuration section
and select Next.
Figure 22 : Process Shell Linux View
ZEBRA TECHNOLOGIES 17
In the New Connection or Shells window select ssh.shells in the configuration section and Select
Finish.
Figure 23 : ssh shells View
The new entry appears in the Remote System view.
Figure 24 : Test Connection View
ZEBRA TECHNOLOGIES 18
To connect to the device, Right click on the remote connection (Test) and select Connect.
Figure 25 : Test Connection Connect
ZEBRA TECHNOLOGIES 19
In the Enter Password window:
In the User ID field, Enter User ID as “rfidadm”
Leave the Password (optional ) field blank.
Select Save User ID and Save Password checkboxes.
Select OK.
Figure 26 : Password Popup View
Note: Select Yes or OK for any warning messages regarding authentication and missing folders for
SSH Handling.
If Password Security Hint warning window appears, select No
ZEBRA TECHNOLOGIES 20
JAVA SAMPLE APPLICATION BUILD AND DEBUG
7.0 Java Sample Application Build and Debug
This section describes the build and debug steps for the RFIDSample4App which is given as part of
the zip package. This helps in understanding the steps and procedure to debug the given sample
application.
Note : If default perspective is not java in eclipse, then we can enable by 2 methods
Method 1 :
Click on the following icon in eclipse.
Figure 27 : Java Perspective Icon
Method 2 :
Click on open perspective.
Figure 28 : Open Perspective Icon
ZEBRA TECHNOLOGIES 21
Select java and click Open.
Figure 29 : Java Selection View
7.1 Import RFID3 API Java Library to Embedded Java Project.
This section describes the steps on how to import RFID Symbol library for embedded java RFID
application.
Note : In case if the zip file was unzipped to “C:\” folder as mentioned in Figure 3 above and if there
is no exclamation mark on RFIDSample4App project, skip this 7.1 section.
In the Package Explorer view, Right click on the Project and select Properties.
ZEBRA TECHNOLOGIES 22
Figure 30 : RFID Sample Properties
Select Java Build Path. Click on Libraries Tab.
Note : If Symbol.RFID.API3.jar shows an error message saying missing or If Symbol.RFID.API3.jar is
not pointing to the selected workspace, then please remove it clicking Remove button, click on Add
External JARs and continue further.
Figure 31 : Java Build Path Selection
ZEBRA TECHNOLOGIES 23
In the Jar selection window, Browse UP/Back the folder to >>Zebra-FXSeries-Embedded-SDK,
then browse down to >>RFID_JAVA_API of the SDK Installation and select Symbol.RFID.API3.jar
Click Open.
Figure 32 : JAR Selection
Click on Apply and Close.
Figure 33 : Java Build Path Select wiion
ZEBRA TECHNOLOGIES 24
Loading...
+ 54 hidden pages