Scribd
Upload
391 views

Quick Start Guide

The document provides a quick start guide for using the Toughpad API to access features of Panasonic Toughpad devices. It outlines system requirements, introduces the API functionality for barcode scanning, magnetic stripe reading, serial communication, and application buttons. It describes installing necessary drivers, services and accessories, and provides instructions for initializing and using the Toughpad API in Android applications.

Uploaded by

swornavidhya.mahadevan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
391 views

Quick Start Guide

The document provides a quick start guide for using the Toughpad API to access features of Panasonic Toughpad devices. It outlines system requirements, introduces the API functionality for barcode scanning, magnetic stripe reading, serial communication, and application buttons. It describes installing necessary drivers, services and accessories, and provides instructions for initializing and using the Toughpad API in Android applications.

Uploaded by

swornavidhya.mahadevan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Quick Start Guide – Toughpad API

System Requirements
 Android SDK with Platform 4.0.3
 Eclipse IDE with ADT plugin
 Panasonic Toughpad FZ-A1, JT-B1, or FZ-X1
 Compatible accessories:
o Baracoda Bluetooth barcode reader (FZ-A1, JT-B1, and FZ-X1)
o Jadak sled (FZ-A1 only)
o FTDI or Prolific USB-to-serial adapter (JT-B1 only)
o FZ-X1 Magstripe Reader Gadget (FZ-X1 only)

Introduction
Toughpad API provides access to Panasonic specific features on the FZ-A1, JT-B1 and FZ-X1 Toughpad devices
for developers to use. Currently access to the following features is provided:

1) Barcode Reader – Access and scan 1D and 2D barcodes via the FZ-A1 Jadak Sled accessory, the built-in
FZ-X1 barcode reader, or an external Baracoda Bluetooth barcode reader.
2) Magnetic Stripe Reader – Access and scan magstripe cards such as credit cards or debit cards via the FZ-
A1 Jadak sled accessory or FZ-X1 Magstripe Reader Gadget.
3) Serial Port – Communication with serial devices through a USB-to-serial converter with an FTDI or
Prolific chip. JT-B1 only.
4) Application Buttons – Taking control of the device’s application buttons (A1 – A3 & side buttons).

API Support Table


API \ Device FZ-A1 JT-B1 FZ-X1
Barcode Reader Sled or Bluetooth reader Bluetooth reader Built-in or Bluetooth reader
Magstripe Reader Sled N/A Magstripe reader gadget
Serial Port N/A FTDI or Prolific chipset N/A
Application Buttons N/A N/A Built-in
SDK Layout
The folder structure for the SDK is as follows:

 Library – Contains the Toughpad API JAR library that Android applications should link against to utilize
Toughpad API.
 Service – Contains the Toughpad API Service which must be installed on any Toughpad device before
the API can be used.
 Documentation – Contains this document and javadoc generated documentation for the Toughpad
API.
 Samples – Sample applications demonstrating use of Toughpad API.

Preparation for use

ADB Drivers
To begin development, the Toughpad device needs to be connected to the PC via a micro-USB cable and the
proper ADB drivers installed depending on the device.

ADB drivers for Toughpad are available on the URL below:

http://pc-dl.panasonic.co.jp/itn/drivers/d_menu_en.html#Toughpad

Follow these instructions to install the ADB driver:

http://developer.android.com/tools/extras/oem-usb.html#InstallingDriver

Toughpad API Installation


For FZ-A1 and JT-B1 devices, Toughpad API Service must be installed on the Toughpad before Toughpad SDK
can be used. On the FZ-X1, Toughpad API Service is preinstalled with the firmware.

From the “Service” folder in the SDK, execute the ADB command:

adb install ToughpadApiService.apk

Once Toughpad API Service is installed, applications that use the API will work on the device.

Jadak Sled Installation


For the Jadak sled to be available as a barcode and magstripe device, the Jadak sled service must be installed as
well (from the “Service” folder):

adb install JadakSledService.apk


Next, connect the Jadak sled to the FZ-A1 unit. You should hear a beeping sound indicating the connection has
been successful. The sled can be configured via the “Scanner Service” application that is now available on the
FZ-A1.

Baracoda Barcode Reader Installation


The Baracoda Bluetooth barcode reader needs to be paired with the tablet before it can be used with Toughpad
API. Go to Android Settings → Bluetooth → Search for devices, pair the device starting with the letters “BRR”
or “BDR”, when asked for the passcode, enter “0000”.

USB-to-serial Adapter Installation


NOTE: Currently only JT-B1 devices can communicate with serial devices via the micro-USB port.

The USB-to-serial adapter needs to be connected into a USB to micro-USB cable, which is then connected with
the JT-B1’s micro-USB port.

FZ-X1 Magstripe Reader Gadget Installation


Make sure the latest firmware is installed on the FZ-X1 device first. Go to Android Settings → About tablet →
System updates and select Update from server. Once the latest firmware is installed, attach the gadget to the
FZ-X1 (see instructions included in package). Once attached, Go to Android Settings → External Device and
select the Gadget enable option.

During the first time your application runs, a dialog will appear asking if you would like to allow Toughpad API
service to access the USB device, please select “Use by default for this USB device” and then click “OK”.

Using the API


Make sure you have followed the instructions under the “Preparation for use” section.

Copy the “Toughpad.jar” file from SDK “Library” folder into your Android project’s “libs” folder; this will cause
the compiler to statically link against the Toughpad SDK library, allowing it to interface with the “Toughpad API
service”.

The API must be initialized before use, and uninitialized when it will not be used anymore (or the application is
closed).

For this purpose, the ToughpadApi.initialize() and ToughpadApi.destroy() method calls are
available. It is recommended to call these methods in the onCreate() callback and onDestroy() callbacks in
the activity.

The initialize() method takes a ToughpadApiListener parameter which is invoked when the API has
been initialized. Only after the onApiConnected() callback has been called can the API be used.

For further information, please look into the provided samples that demonstrate usage of the various APIs.

You might also like