ZEBRA Cloud Connect for RFID Programmer Guide

Cloud Connect for RFID

Programmer Guide

MN-004018-01EN Rev. A

ZEBRA and the stylized Zebra head are trademarks of Zebra Technologies Corporation, registered in many jurisdictions worldwide. All other trademarks are the property of their respective owners. © 2020 Zebra Technologies Corporation and/or its affiliates. All rights reserved.

Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement or nondisclosure agreement. The software may be used or copied only in accordance with the terms of those agreements.

For further information regarding legal and proprietary statements, please go to:

SOFTWARE:www.zebra.com/linkoslegal COPYRIGHTS:www.zebra.com/copyright WARRANTY:www.zebra.com/warranty END USER LICENSE AGREEMENT: www.zebra.com/eula

Proprietary Statement

This manual contains proprietary information of Zebra Technologies Corporation and its subsidiaries (“Zebra Technologies”). It is intended solely for the information and use of parties operating and maintaining the equipment described herein. Such proprietary information may not be used, reproduced, or disclosed to any other parties for any other purpose without the express, written permission of Zebra Technologies.

Product Improvements

Continuous improvement of products is a policy of Zebra Technologies. All specifications and designs are subject to change without notice.

Liability Disclaimer

Zebra Technologies takes steps to ensure that its published Engineering specifications and manuals are correct; however, errors do occur. Zebra Technologies reserves the right to correct any such errors and disclaims liability resulting therefrom.

Limitation of Liability

In no event shall Zebra Technologies or anyone else involved in the creation, production, or delivery of the accompanying product (including hardware and software) be liable for any damages whatsoever (including, without limitation, consequential damages including loss of business profits, business interruption, or loss of business information) arising out of the use of, the results of use of, or inability to use such product, even if Zebra Technologies has been advised of the possibility of such damages. Some jurisdictions do not allow the exclusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to you.

Publication Date

September 22, 2020

List of Figures..................................................................................................................................... 5

About This Document ........................................................................................................................ 7

Introduction ...................................................................................................................... 7

Supported Readers.......................................................................................................... 7

Chapter Descriptions........................................................................................................ 7

Notational Conventions .................................................................................................... 7

Icon Conventions ............................................................................................................. 8

Related Documents and Software ................................................................................... 8

Service Information .......................................................................................................... 8

Overview............................................................................................................................................ 10

Introduction .................................................................................................................... 10

Operation Modes .............................................................................................................................. 11

Introduction .................................................................................................................... 11

Simple ............................................................................................................................ 11

Inventory ........................................................................................................................ 11

Portal.............................................................................................................................. 12

Conveyer........................................................................................................................ 12

Interface Overview............................................................................................................................ 13

Introduction .................................................................................................................... 13

Authentication Methods.................................................................................................. 13

Management Interface ................................................................................................... 13

GET /version........................................................................................................... 14

GET /status............................................................................................................. 17

GET /network.......................................................................................................... 20

PUT /network.......................................................................................................... 23

Contents

PUT /reboot ............................................................................................................ 24

PUT /gpo ................................................................................................................ 26

Example ........................................................................................................... 27

GET /app-led .......................................................................................................... 28

PUT /app-led .......................................................................................................... 29

GET /region ............................................................................................................ 31

GET /config............................................................................................................. 33

PUT /config............................................................................................................. 36

Control Interface............................................................................................................. 39

PUT /start ............................................................................................................... 39

PUT /stop................................................................................................................ 41

Example ........................................................................................................... 42

GET /mode ............................................................................................................. 43

PUT /mode ............................................................................................................. 45

Example ........................................................................................................... 46

Data Interface.................................................................................................................47

Tag Event Message Formats ......................................................................................... 47

List of Figures

Figure 1: GET /version - Response Schema ................................................................ 14

Figure 2: GET /version - Bad Request .......................................................................... 14

Figure 3: GET /version - Internal Device Error .............................................................. 15

Figure 4: GET /status - Request Successful ................................................................. 17

Figure 5: GET /status - Firmware Update in Progress .................................................. 18

Figure 6: GET /status - Bad Request ............................................................................ 18

Figure 7: GET /status - Response Schema Device Error ............................................. 18

Figure 8: GET /network - Request Successful .............................................................. 20

Figure 9: GET /network - Bad Request ......................................................................... 21

Figure 10: GET /network - Internal Device Error ........................................................... 21

Figure 11: PUT /network - Payload Schema ................................................................. 23

Figure 12: PUT /network - Request Successful ............................................................ 23

Figure 13: PUT /network - Bad Request ....................................................................... 23

Figure 14: PUT /network - Internal Device Error ........................................................... 23

Figure 15: PUT /reboot - Request Successful ............................................................... 24

Figure 16: PUT /reboot - Bad Request .......................................................................... 25

Figure 17: PUT /reboot - Internal Device Error ............................................................. 25

Figure 18: PUT /gpo - Set gpo State ............................................................................. 26

Figure 19: PUT /gpo - Request Successful ................................................................... 26

Figure 20: PUT /gpo - Bad Request .............................................................................. 27

Figure 21: PUT /gpo - Internal Device Error .................................................................. 27

Figure 22: GET /app-led - Request Successful ............................................................. 28

Figure 23: GET /app-led - Bad Request ........................................................................ 28

Figure 24: GET /app-led - Internal Device Error ........................................................... 28

Figure 25: PUT /app-led - Payload Schema ................................................................. 29

List of Figures

Figure 26: PUT /app-led - Request Successful ............................................................. 30

Figure 27: PUT /app-led - Bad Request ........................................................................ 30

Figure 28: PUT /app-led - Internal Device Error ............................................................ 30

Figure 29: GET /region - Request Successful ............................................................... 31

Figure 30: GET /region - Bad Request .......................................................................... 32

Figure 31: GET /region - Internal Device Error ............................................................. 32

Figure 32: GET /config - Request Successful ............................................................... 33

Figure 33: GET /config - Bad Request .......................................................................... 34

Figure 34: GET /config - Internal Device Error .............................................................. 34

Figure 35: PUT /config - Payload Schema .................................................................... 36

Figure 36: PUT /config - Request Successful ............................................................... 36

Figure 37: PUT /config - Bad Request .......................................................................... 36

Figure 38: PUT /config - Internal Device Error .............................................................. 37

Figure 39: PUT /start - Request Successful .................................................................. 39

Figure 40: PUT /start - Bad Request ............................................................................. 40

Figure 41: PUT /start - Internal Device Error ................................................................. 40

Figure 42: PUT /stop - Request Successful .................................................................. 41

Figure 43: PUT /stop - Bad Request ............................................................................. 41

Figure 44: PUT /stop - Internal Device Error ................................................................. 42

Figure 45: PUT /stop - Request Successful .................................................................. 43

Figure 46: PUT /stop - Bad Request ............................................................................. 43

Figure 47: PUT /stop - Internal Failure .......................................................................... 43

Figure 48: PUT /mode - Payload Schema .................................................................... 45

Figure 49: PUT /mode - Request Successful ................................................................ 45

Figure 50: PUT /mode - Bad Request ........................................................................... 45

Figure 51: PUT /mode - Internal Device Error ............................................................... 46

About This Document

Introduction

This guide provides information about the REST API provided by the Cloud Connect for RFID feature in the FX Series readers. The APIs listed in this guide are applicable only for local access. For more information about the cloud API, go to https://developer.zebra.com/apis/cloud-connect-rfid

IMPORTANT: If you have a problem with your equipment, contact Zebra Global Customer Support for your region. Contact information is available at: zebra.com/support

Supported Readers

• FX7500

• FX9600

Chapter Descriptions

Topics covered in this guide are as follows:

• Overview provides a summary of the Cloud Connect for RFID interfaces.

• Operation Modes provides information on Simple, Inventory, Portal, and Conveyer modes of operation.

• Interface Overview provides information on management and control interfaces.

Notational Conventions

The following conventions are used in this document:

•Bold text is used to highlight the following:

• Dialog box, window and screen names

• Drop-down list and list box names

• Check box and radio button names

• Icons on a screen

• Key names on a keypad

• Button names on a screen

• Bullets (•) indicate:

• Action items.

• Lists of alternatives.

• Lists of required steps that are not necessarily sequential.

• Sequential lists (such as those that describe step-by-step procedures) appear as numbered lists.

Icon Conventions

The documentation set is designed to give the reader more visual clues. The following graphic icons are used throughout the documentation set. These icons and their associated meanings are described below.

NOTE: The text here indicates information that is supplemental for the user to know and that is not required to complete a task.

IMPORTANT: The text here indicates information that is important for the user to know.

CAUTION: If the precaution is not heeded, the user could receive minor or moderate injury.

About This Document

WARNING: If danger is not avoided, the user CAN be seriously injured or killed.

Service Information

If you have a problem with your equipment, contact Zebra Global Customer Support for your region. Contact information is available at: zebra.com/support

When contacting support, please have the following information available:

• Serial number of the unit

• Model number or product name

• Software/firmware type or version number

Zebra responds to calls by email, telephone or fax within the time limits set forth in support agreements.

About This Document

If your problem cannot be solved by Zebra Customer Support, you may need to return your equipment for servicing and will be given specific directions. Zebra is not responsible for any damages incurred during shipment if the approved shipping container is not used. Shipping the units improperly can possibly void the warranty.

If you purchased your Zebra business product from a Zebra business partner, contact that business partner for support.

Overview

Introduction

This guide describes the Cloud Connect for RFID interfaces that is locally exposed from the reader. The APIs mentioned in the document can be used in on-premises deployments as described by the Hybrid or Local deployment modes. For more information on the deployment modes refer to the Cloud Connect for RFID Deployment Guide.

For information about the cloud REST API using the Zebra Data Services go to

https://developer.zebra.com/apis/cloud-connect-rfid

The Cloud Connect for RFID feature interfaces are divided into three categories

• Management interface: Used to perform management actions on the reader like firmware upgrade, get and set reader configuration, etc.

• Control interface: Used to perform control actions on the reader like configuring the radio mode, starting/stopping the tag reads.

• Data interface: Used to consume the RFID tag data from the reader.

Operation Modes

Introduction

Cloud Connect for RFID provides the ability to configure the radio to different modes of operation that optimize the radio configuration based on intended use case. Once configured, the mode can be started using the START REST API and will continue to operate until the STOP REST API is called. The following modes are supported in the Cloud Connect for RFID.

• Simple

• Inventory

• Portal

• Conveyer

Simple

Simple mode configures the radio to read and report all unique tags in the field of view of the radio.

Inventory

By default:

• The radio attempts to read tags on all antennas. This can be adjusted using the Antennas object when setting the mode.

• The radio reports all unique tags. This can be adjusted using the Filter object when setting the mode.

Inventory mode configures the radio to read tags and report all unique tags for each antenna on a periodic interval. Additional meta-data (i.e., peak RSSI and number of reads for each antenna during the interval) is reported.

By default:

• The radio attempts to read tags on all antennas. This can be adjusted using the Antennas object when setting the mode.

• The radio reports all unique tags once. This can be adjusted using the Filter object when setting the mode.

• The radio reports tags every second. This can be adjusted using the Interval object when setting the mode.

Portal

Conveyer

Operation Modes

Portal mode configures the radio to report all unique tags that pass by each antenna immediately following a GPI event. The GPI event signals the beginning of the read period. As soon as the GPI event triggers the radio, the radio continues to read tags until no new unique tags are read for a configurable stop interval. Once the radio stops reading tags, it waits for the next GPI event to start the process again.

By default:

• The radio attempts to read tags on all antennas. This can be adjusted using the Antennas object when setting the mode.

• The radio reports all unique tags once. This can be adjusted using the Filter object when setting the mode.

• The radio waits for a LOW signal on GPI 1. This can be adjusted using the StartTrigger object when setting the mode.

• The radio continues to read until no new unique tags have been read for 3 seconds. This can be adjusted using the StopInterval object when setting the mode.

Conveyer mode configures the radio to read tags and report all unique tags for each antenna.

By default:

• The radio attempts to read tags on all antennas. This can be adjusted using the Antennas object when setting the mode.

• The radio reports all unique tags once. This can be adjusted using the Filter object when setting the mode.

Interface Overview

Introduction

The on prem access to management and control interfaces is exposed over HTTPS/HTTP depending on the reader web service configuration. If the reader web server is configured to HTTP, then the REST API is accessible over HTTP. Similarly, if the reader web service is configured to HTTPS, then the REST API is accessible over HTTPS. All URLS referenced in this guide have the following base URL

http://<readerIP>/ or https://<readerIP>/

In a hybrid or local deployment, the data interface can be configured to send tag data to a HTTP/HTTPS server by configuring the data interface appropriately. For more information on configuring the Cloud Connect for RFID Interface for cloud or local access, refer to the Cloud Connect for RFID Deployment Guide.

Authentication Methods

The management and control interfaces, when configured to allow local access, do not require any authentication.

Management Interface

The Management interface includes the set of REST APIs listed in Table 1.

Table 1 Management Interface REST APIs

API Endpoints Management APIs Description Page

GET /version Retrieves reader component version information. 14

GET /status Retrieves reader operational statistics. 17

GET /network Retrieves reader network information. 20

PUT /network Changes the reader network configuration. 23

PUT /reboot Reboots the reader with the device id provided. 24

PUT /gpo Set the General Purpose Output (GPO) state on the specified port of

GET /app-led Retrieves a value indicating the current state of the application LED. 28

PUT /app-led Sets the application LED on the reader to the state specified. 29

the reader.

Table 1 Management Interface REST APIs (Continued)

API Endpoints Management APIs Description Page

GET /region Retrieves reader region information. 31

GET /config Retrieves the reader configuration. 33

PUT /config Changes the reader configuration. 36

GET /version

Retrieves reader component version information.

• Returns HTTP/1.1 status code 200 if the request was successful.

Figure 1 GET /version - Response Schema

Interface Overview

• Returns HTTP/1.1 status code 400 if the request is bad request.

Figure 2 GET /version - Bad Request

• Returns HTTP/1.1 status code 500 if internal device error.

Interface Overview

Figure 3 GET /version - Internal Device Error

+ 33 hidden pages