AdvanPay-120

Introduction

AdvanPay-120 features:

• All in one solution: reader, antenna, keyboard emulator software

• High power: 27 dBm

• Specific functionalities for point of sales at retail stores and for check-in/check-out stations

• Very easy and fast integration with point of sales without the need for software modification

• Powered by PoE

• Ethernet communication

• Complete loss prevention system, when used with AdvanSafe

For retailers:

• Queues reduction, thanks to a much faster payment process

• Improvement in the customer shopping experience, derived from a shorter payment time

• Reduction in employee costs

• Simultaneous item detection and EAS flag activation/deactivation

Getting Started

Helpful downloads:

• Download Datasheet (see download files section)

• Download User Manual (see download files section)

These are the minimum steps to start using AdvanPay:

1.Power AdvanPay unit

Connect the AdvanPay to a power supply (Switch PoE, PoE injector, etc..) through an Ethernet cable and wait until it beeps. It will take between 40 and 50 seconds to boot.

Using a PoE injector

Follow this diagram to connect AdvanPay through a PoE injector:

Connection micro-USB cable to PC

Connect the AdvanPay and your computer with the micro-USB (Type B) cable provided by Keonn.

AdvanPay uses the standard HID drivers, any PC should automatically detect the new device and install it as a regular keyboard.

USB emulation

Open a text editor (Notepad, Gedit, ...) in the PC where AdvanPay is connected to:

1. Make sure that the Led Green is flashing: that means the Payment mode is running (more in operation modes later on)

2. Put one of the sample tags over the AdvanPay:

   • A beep will be heard when the tag is sent through the USB.

   • The decoded GTIN will be printed on the active PC window.

   • The chapter Apply EPC change configuration explains how to configure AdvanPay to disable/enable an EPC after a Payment/Return operation.

Configuration

Almost on any installation, it is required to adjust the AdvanPay operation.

Discover Device

Configuration requires Ethernet access to the unit, as it uses a web application.

We need therefore to connect the AdvanPay unit to an Ethernet network and execute an IP discovery process. After the configuration process is finished, the Ethernet cable can be removed.

To be able to discover the AdvanPay IP address, use a PC in the same network as the computer.

Please see the discover devices for the 150/60 Series devices: series150/60-Discover-devices.

Enter AdvanNet Manager

The previous step will result in the IP that is assigned to the device. Let's named it <AdvanPay-IP-address>

1. Use a computer in the same network as the AdvanPay.

2. Open a Web Browser (Chrome or Firefox are required).

3. Go to the page: http://<AdvanPay-IP-address>:3161

4. Replace the <AdvanPay-IP-address> for the IP found in the discover devices.

5. Enter the following credentials:

• User: admin

• Password: admin

Select the only device in the drop-down list, if it is not selected, and connect to it:

Read Modes

Go to the RF & Antennas options to see the available AdvanPay read modes.

The AdvanPay Configuration has 3 Read Modes: ADVANPAY_PAYMENT, ADVANPAY_RETURN, ADVANPAY_READONLY.

The purpose of each Read Modes is the following:

1. ADVANPAY_PAYMENT: This read mode is used to read a tag and, if configured, deactivate it. For example, if the EPC in your tags begins with 0x3036, AdvanPay can be commanded to change this value with a 0x1111 header and beep if it was successful.

2. ADVANPAY_RETURN: This read mode is used to read a tag and, if configured, activate it. For example, if the active EPCs begins with 0x3036, AdvanPay will try to change the value of the tag to start with 0x3036.

3. ADVANPAY_READONLY: This read mode is used only to read the EPC from the tags.

Apply EPC change Configuration

Only available in the ADVANPAY_PAYMENT and ADVANPAY_RETURN read modes.

In the case the EPCs in use followed:

• EPC (SKU) begins with 0x3036.

• The password of these tags is 0x12345678.

A possible Enable/Disable configuration for the ADVANPAY_PAYMENT and ADVANPAY_RETURN read modes for these tags could be:

• ADVANPAY_PAYMENT: AdvanPay will change every EPC to begin with 0x1111 instead of beginning with 0x3036. It will only affect the tags with the password 0x12345678.

• ADVANPAY_RETURN: AdvanPay will change every EPC to begin with 0x3036. It will only affect the tags with the password 0x12345678.

Persist Configuration

Using the apply button only changes the runtime settings, in order to make those changes persistent follow the steps below:

• Remember to apply the configuration.

• Click the persist button (surrounded in red) to persist the configuration.

• In this case, the AdvanPay will start with ADVANPAY_PAYMENT configuration.

USB emulation with EPC change configuration

Open a text editor (Notepad, Gedit, ...) in the PC where AdvanPay is connected to:

1. Make sure that the Led Green is flashing: that means the Payment mode is running (more in operation modes later on)

2. Put one of the sample tags over the AdvanPay:

   • A beep will be heard when the tag is sent through the USB.

   • The decoded GTIN will be printed on the active PC window.

     • The EPC will be changed using the mask configured in the Apply EPC change configuration.

Mode Button

Once all three AdvanPay modes are configured, they can be easily switched by using the cover push button:

The behavior is as follows:

• If the button is just pressed (without holding it), it will make the AdvanPay:

  • Start reading: The led will start blinking.

  • Stop reading: The led will stay steady.

• If the button is pressed and held for more than 4 seconds, it will change the read mode. This will be reflected on the LEDs (read modes explanation):

  • Green LED: ADVANPAY_PAYMENT read mode.

  • Red LED: ADVANPAY_RETURN read mode.

  • Blue LED: ADVANPAY_READONLY read mode.

To disable the button:

• 1. Log into the reader operating system via SSH (http://wiki.keonn.com/advannet/development/embedded-development#TOC-Connect-to-the-Device)

  2. Edit the file connectors.xml. There can be several in the filesystem so the good one is:

     1. If the folder /home/keonn/kernel/module/app.AdvanNet/alternatives exists the file is located at: /home/keonn/kernel/module/app.AdvanNet/alternatives/{current_AdvanNet_version/META-INF/connectors.xml

     2. /home/keonn/kernel/module/app.AdvanNet/META-INF/connectors.xml otherwise

  3. Change

<CHANGE_MODE>
<class>com.keonn.device.impl.event.ChangeModeListener</class>
<gpiLine>2</gpiLine>
</CHANGE_MODE>

for

<CHANGE_MODE>
<class>com.keonn.device.impl.event.ChangeModeListener</class>
<gpiLine>0</gpiLine>
</CHANGE_MODE>

1. Save the file and reboot the reader. After it reboots you'll see that the button has no effect whatsoever.

Advanced configuration

Power and Sensitivity

The power and sensitivity of the AdvanPay its already being set for the best performance but in the RF & Antenna Options tab can be configured for more suitable performance. For more information about it look at this post: What-is-the-difference-between-Power-and-Sensitivity.

USB HID Service

Look into our wiki section: USB-HID-Service

AdvanCloud

To connect AdvanPay to the cloud using sCloud please follow these instructions.

Kill Tag Option

AdvanPay can be configured to kill a tag when doing a Payment/Return operation. Enable the "kill tag after reading it" and set the kill password of your tags in the "kill password (hex)" option.

Events & Actions

You can configure which actions will be triggered in the available events. For example, the most used events are:

• USB_SENT: This event is created when an EPC is sent through the USB.

• TAG_WRITE: This event is created when AdvanPay writes a tag successfully.

• TAG_READ: This event is created when AdvanPay reads a tag.

Normally these events will trigger a Buzzer action, where AdvanPay will make a beep kind of sound for each event:

Time Scan

AdvanPay can be configured to read for a period of time (time scan). Every time a user makes AdvanPay start reading, either from the AdvanNet Manager (Web Application) or from the physical button, AdvanPay will do a time scan. In the following picture the time scan is configured at 5 seconds:

Transparent mode

By transparent mode, we mean a mode where AdvanPay is completely controlled using the REST API.

AdvanPay would start without the RF on and will wait for commands to start operation.

In order to configure AdvanPay units in transparent mode, follow the steps below:

0. Stop RF operation

1. Configure Autonomous mode

2. Disable auto start (Start on boot)

3. Apply and persist settings (or Apply config and then Persist current device config)

Change AdvanPay LEDs

To change the LEDs configuration follow the steps here.

Disable AdvanPay LEDs

To disable the LEDs configuration follow the steps here.

System features

Access to device serial number

Any device contains a unique serial number. The serial number can be accessed with

• HTTP GET request at: http://{device_ip}:3161/devices/AdvanPay-cf-eu-120/serial

  • Other devices may use: AdvanPay-cf-us-120, AdvanPay-cf-jp-120, AdvanPay-cu-eu-120, AdvanPay-cu-us-120...

• The serial number is found inside the tag <result>

• Currently, this device serial number is based on the device MAC address.

Access CSV log

All system activity is logged into a CSV file. This file can be accessed at any time:

• • Retrieve CSV log file accessing the URL (HTTP GET request)

http://{device_ip}:3161/system/fs/retrieveFile/AdvanNetCSVS

• The CSV file is retrieved as a compressed file named

  • AdvanNetCSVS.zip

• The CSV file structure is self-explanatory. It contains events of the following type:

  • TAG_READ: a read event of a tag

  • TAG_ADPY_PAYMENT: a payment event

  • TAG_ADPY_RETURN: a return event

  • TAG_ADPY_READ: a read event while in ADVANPAY_READ mode

    • TAG_WRITE: a tag write event. Tag write events may be a side-effect of TAG_ADPY_PAYMENT and TAG_ADPY_RETURN. When the latter events involve a re-write of the EPC.

Clear CSV log

To clear the internal CSV log file, access the URL (HTTP GET request):

http://{device_ip}:3161/system/fs/removeFile/AdvanNetCSVS

Access real-time data

All system activity can be accessed at real-time by listening at TCP socket port 3177.

The protocol used is very similar to HTTP and the message format is XML. The following is a sample of a message:

ADVANNET/1.0

Content-Length:424

Content-Type:text/xml

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445522798763</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_READ</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>303602c25c0d879f5597d1b8</epc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

Important features:

• Header always contains

  • ADVANNET/1.0: protocol version

  • Content-Length: length of the message

  • Content-Type: type of message

• There is an empty line between the headers and the start of the message.

• Line separators are CRLF characters: this applies to header lines and the empty line between headers and content. The content itself (in case of TXT or XML type) may contain any form of line separator.

TAG messages

Possible TAG events that will be received are:

• INVENTORY

<?xml version="1.0" encoding="UTF-8"?>

<inventory>

<type>inventory</type>

<ts>1445500793000</ts>

<status>OK</status>

<msg-version>2.3.0</msg-version>

<op>inventory</op>

<data>

<advanNetId>AdvanNet-instance-78:a5:04:ed:a8:f2--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

<inventory>

<class>INVENTORY</class>

<deviceId>AdvanPay-cf-us-120</deviceId>

<size>1</size>

<timeWindow>-1</timeWindow>

<items>

<item>

<class>READ_EVENT</class>

<epc>30360000a1360008889d3604</epc>

<ts>1445500793789</ts>

<deviceId>AdvanPay-cf-us-120</deviceId>

<data>

<class>TAG_DATA</class>

<hexepc>30360000a1360008889d3604</hexepc>

<opMode>AdvanPay-cf-us-120.AdvanPay.ADVANPAY_PAYMENT</opMode>

<props>

<prop>TIME_STAMP:1445500793789</prop>

<prop>RF_PHASE:0</prop>

<prop>FREQ:866829</prop>

<prop>READ_COUNT:1</prop>

<prop>RSSI:-50</prop>

<prop>ANTENNA_PORT:1</prop>

</props>

</data>

<locationData>

<class>LOCATED_TAG_DATA</class>

<epc>30360000a1360008889d3604</epc>

<antenna>

<class>ANTENNA_DEFINITION</class>

<def>AdvanPay-cf-us-120,1,0,0,0,antenna1,1,0,0</def>

</antenna>

<location>

<class>LOCATION_DEFINITION</class>

<loc>antenna1,1,0,0</loc>

</location>

</locationData>

</item>

</items>

</inventory>

</data>

</inventory>

• TAG_ADPY_PAYMENT

Without EPC re-write

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445499657486</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_PAYMENT</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>30360000a1360011111d3604</epc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

With EPC re-write

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445499806460</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_PAYMENT</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>30360000a1360011111d3604</epc>

<newEpc>30360000a1360033331d3604</newEpc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

• TAG_ADPY_RETURN

Without EPC re-write

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445500248832</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_RETURN</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>30360000a1360033331d3604</epc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

With EPC re-write

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445500315211</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_RETURN</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>30360000a1360033331d3604</epc>

<newEpc>30360000a1360008889d3604</newEpc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

• TAG_ADPY_READ

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445522798763</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_READ</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>303602c25c0d879f5597d1b8</epc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

• TAG_WRITE

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445522798763</ts>

<status>OK</status>

<event>

<class>TAG_EVENT</class>

<type>TAG_ADPY_READ</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<deviceId>AdvanPay-cf-us-120</deviceId>

<epc>303602c25c0d879f5597d1b8</epc>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

• • DEVICE_ERROR

A common error found when the configured password do not match the tag password:

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445499839780</ts>

<status>ERROR</status>

<event>

<class>DEV_ERROR_EVENT</class>

<type>DEVICE_ERROR</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<advanNetId>AdvanNet-instance-78:a5:04:ed:a8:f2--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

<errors>

<error>

<code>25</code>

<humanCode>Error[0000040a] Changing EPC pattern in 30360000a1360033331d3604. Error msg: Password seems wrong.</humanCode>

<ts>1445499839774</ts>

</error>

</errors>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

A common error found when the write operation fails. Usual conditions are:

• • The tag does not stay the required time for the write operation

  • The write power is not high enough

<?xml version="1.0" encoding="UTF-8"?>

<deviceEventMessage>

<type>deviceEventMessage</type>

<ts>1445499840685</ts>

<status>ERROR</status>

<event>

<class>DEV_ERROR_EVENT</class>

<type>DEVICE_ERROR</type>

<typeclass>com.keonn.spec.event.DeviceEvent$EventType</typeclass>

<advanNetId>AdvanNet-instance-78:a5:04:ed:a8:f2--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

<errors>

<error>

<code>25</code>

<humanCode>Error[00000400] Changing EPC pattern in 30360000a1360033331d3604. Error msg: No tags found.</humanCode>

<ts>1445499840683</ts>

</error>

</errors>

</event>

<deviceId>AdvanPay-cf-us-120</deviceId>

</deviceEventMessage>

SYSTEM messages

Possible SYSTEM events that will be received are:

• • ADVANNET_INFO

<?xml version="1.0" encoding="UTF-8"?>

<eventMessage>

<type>eventMessage</type>

<ts>1409827170979</ts>

<status>OK</status>

<event>

<class>com.keonn.advannet.impl.event.DefaultAdvanNetEvent</class>

<type>ADVANNET_INFO</type>

<typeclass>com.keonn.spec.event.AdvanNetEvent$AdvanNetEventType</typeclass>

<advanNetId>AdvanNet-instance-00:1e:8c:25:0c:43--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

<msg>Device[AdvanPay-cf-us-120] started in mode: EPC_EAS_ALARM</msg>

</event>

</eventMessage>

• • ADVANNET_DEVICE_CONNECTED

<?xml version="1.0" encoding="UTF-8"?>

<eventMessage>

<type>eventMessage</type>

<ts>1398285635331</ts>

<status>OK</status>

<event>

<class>com.keonn.advannet.impl.event.DefaultAdvanNetEvent</class>

<type>ADVANNET_DEVICE_CONNECTED</type>

<typeclass>com.keonn.spec.event.AdvanNetEvent$AdvanNetEventType</typeclass>

<advanNetId>AdvanNet-instance-7c:66:9d:55:60:df--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

</event>

</eventMessage>

• • ADVANNET_DEVICE_DISCONNECTED

<?xml version="1.0" encoding="UTF-8"?>

<eventMessage>

<type>eventMessage</type>

<ts>1398285635331</ts>

<status>OK</status>

<event>

<class>com.keonn.advannet.impl.event.DefaultAdvanNetEvent</class>

<type>ADVANNET_DEVICE_DISCONNECTED</type>

<typeclass>com.keonn.spec.event.AdvanNetEvent$AdvanNetEventType</typeclass>

<advanNetId>AdvanNet-instance-7c:66:9d:55:60:df--1</advanNetId>

<deviceId>AdvanPay-cf-us-120</deviceId>

</event>

</eventMessage>

• • Also several error messages can be received.

Reset settings to default

It is possible to reset the system to factory defaults. That means:

• Any network settings are removed and the system is reverted to use DHCP

• Any persisted operation settings (AdvanNet settings) are removed

The procedure is as follows:

• Power the system and waits to hear the start-up beep.

• Use a paper clip or similar to press the Reset button for at least 12 seconds.

• The reset process will start when the reset button is released.

  • The system will be restarted.

  • Wait for the start-up beep.

Networking

AdvanPay devices feature two different network interfaces:

• • Ethernet

  • Ethernet over USB (not available in initial revisions)

Ethernet interface

The Ethernet interface has two different 2 IP addresses:

• Primary (user-defined): may be static or dynamic (DHCP). DHCP by default

• Secondary: statically defined 172.31.61.2

The 172.31.61.2 is used for example whenever the Primary is configured in DHCP and there is no DHCP server available. The device would then be reachable through the Secondary IP address.

Ethernet over USB - USB COMM

Please connect your computer to the AdvanPay-120 USB COMM port.

This interface only has one static IP: 192.168.7.2

Follow the instructions here to configure the Host PC to use this interface

Serial over USB - USB CONSOLE

AdvanPay-120 features an extra communications interface useful for troubleshooting issues when all other cases aren't available or already have failed.

Please connect your computer to the AdvanPay-120 USB Console USB port and start PuTTy up.

Please notice that if you're using Linux you will need to run PuTTy as sudo. The device name will be of the likes of /tty/USBx being x a number

If you are running windows please check at your device manager the COM port number that appears when connecting the AdvanPay to your computer, you should look up for something like this:

The next step is setting up putty as follows choosing the correct serial line value

And clicking connect, the window that will appear can either show data or not, not showing data does not mean that the connection is a failure. Try writing keonn and pressing enter to see if the device echoes the keypresses and prompts for a password.

Installation tips

Which conditions may interfere with the AdvanPay operation?

The most common cause of interference is another RFID system.

While AdvanPay uses by default a small conducted power (10 dBm -10 mW-), other neighboring RFID systems may help to power up tags. Once tags are powered up, no matter the source of the energy, they may respond strong enough for AdvanPay to detect them.

Solutions to this problem are:

• • Make sure other RFID systems' active area does not reach AdvanPay location.

  • Try reducing the conducted power from the possible interference source

Download files

Find the User Guide and other downloadable content below: