enf0000an017 - rfid integration -v1!03!2013oct30

ENF0000AN017

RFID Integration

Application Note

Version: 1.03 30 October, 2013

i novatelwireless.com

Copyright© 2013 Novatel Wireless, Inc. All rights reserved. Complying with all applicable copyright lawsis the responsibility of the user. Without limiting the rights under copyright, no part of thisdocument may be reproduced, stored in or introduced into a retrieval system, or transmittedin any form or by any means (electronic, mechanical, photocopying, recording or otherwise),or for any purpose, without the express written permission of Novatel Wireless, Inc.

Novatel Wireless M2M and the Novatel Wireless M2M logo are either registered trademarks ortrademarks of Novatel Wireless, Inc. in the United States.

251 Renner Pkwy

Richardson, TX 75080 USA

Phone: (972) 633-4400

Fax: (972) 633-4444

Email: [email protected]

www.novatelwireless.com

ii novatelwireless.com

GeneralTERMS OF USE OF NEWMATERIALS - PLEASE READ CAREFULLY

From time to time, Novatel Wireless M2M, in its sole discretion, may make available fordownload on its website (www.novatelwireless.com), or may transmit via mail or email,updates or upgrades to, or new releases of, the firmware, software or documentation for itsproducts (collectively, 'New Materials'). Use of such New Materials is subject to the terms andconditions set forth below, and may be subject to additional terms and conditions as set forthin Novatel Wireless M2M's Technical Support Policy (posted on its website) and/or anywritten agreement between the user and Novatel Wireless M2M.

All New Materials are provided AS IS. Novatel Wireless M2M makes no warranty orrepresentation with respect to the merchantability, suitability, functionality, accuracy orcompleteness of any such New Materials. The user of such New Materials assumes all risk(known or unknown) of such use. Novatel Wireless M2M reserves all rights in such NewMaterials. The user shall have only a revocable and limited license to use such New Materialsin connection with the products for which they are intended. Distribution or modification ofany New Materials without Novatel Wireless M2M's consent is strictly prohibited.

IN NO EVENT WILL Novatel Wireless M2M BE RESPONSIBLE FOR ANY INCIDENTAL,INDIRECT, CONSEQUENTIAL OR SPECIAL DAMAGES AS A RESULT OF THE USE OF ANYNEW MATERIALS. Novatel Wireless M2M'S MAXIMUM LIABILITY FOR ANY CLAIM BASEDON THE NEWMATERIALS SHALL NOT EXCEED FIFTY U.S. DOLLARS ($50).

Version Verification

Please ensure you have the latest version of this document by downloading it fromwww.novatelwireless.com

http://documentation.nvtl.com/

iii novatelwireless.com

Table of Contents

1 Introduction 1

2 Connecting The RFID 4

Connecting The RFID To A PC (Optional) 6

Connecting The RFID To An Novatel Wireless M2M Device 8

3 Configuring Novatel Wireless M2M Device For RFID Usage 9

RFID AT Commands 11

AT$UAMCFG 11

AT$UAUCFG 11

AT$UALIST 12

AT$UALTO 13

AT$UAEN 13

AT$UAUCOM 14

Sample Script 14

Sample Script To Maintain AT$UAEN=1 16

Method 1 16

Method 2 18

Testing On The Novatel Wireless M2M Server 18

Interpreting Data From The Novatel Wireless M2M Test Server 19

Param3 Not In Optional Header 19

Param3 In Optional Header 19

1 novatelwireless.com

1Introduction


This application note shows the end user how to integrate and test a serial based (RS232)RFID reader using the serial (RS232) interface provided on the Novatel Wireless M2M device.The RFID tested is a PROMAG RFID Reader (Model MF7-20).

The following Novatel Wireless M2M devices support RS232 (Rx, Tx and GND) and have thefeature that supports sending the data from the RFID readers:

l GSM2358l GSM2438l GSM2448l GSM1318 (For future integration)

You should load a minimum of PKG53 on these devices.

Although this document specifically addresses the MF7-20 model, this information cantransfer to other RFID models. Your Novatel Wireless M2M device can integrate with anyserial based RFID reader providing that it supports RS232 +/- voltage signals and supportsthree-wire serial (Rx, Tx and GND).

In this document, we refer to the PROMAG RFID Reader (Model MF7-20) as MF7.

In order to find out whether you can use a different model of serial RFID readerwith your Novatel Wireless M2M device, please contact your Novatel WirelessM2M technical support team.

The Novatel Wireless M2M device does not send any serial data to the RFIDreader.

The RFID data sent to Novatel Wireless M2M device is converted to Binaryformat before sending to server end. The Enfora device supports ASCII or Binarydata format from the RFID device.

Currently, only Binary data is supported via the Param2 bit mask. The support forASCII via Param2 bit mask is for future release of firmware


Current implementation of this feature does not allow power saving mode ofAT%SLEEP =4 to be used or Low Power Sleep (MT4000)


2Connecting The RFID

Connecting the RFID to a PC (Optional)

Connecting the RFID to an Novatel Wireless M2M Device


We recommend that until you are familiar with the MF7, that you use it as a standalone devicewith a PC running a terminal application (hyperterminal or similar).

This is to establish two things;

l Verify that the MF7 reader is workingl To read the RFID tag serial numbers so as to populate the RFID whitelist (if required) onan Novatel Wireless M2M device. See Section 3.1.3 for more information.

Connecting the RFID to a PC (Optional)

Connecting the RFID to an Novatel Wireless M2M Device


Connecting The RFID To A PC (Optional)Using the MF7 as a standalone device connected to a PC running a terminal application willhelp you verify that the MF7 reader is working and will read the RFID tag serial numbers topopulate the RFID whitelist (if required) on the Novatel Wireless M2M device.

You should read the MF7 instruction manual to fully understand the interface andget familiar with its specific settings.

The following figure shows the MF7 interface connected to a PC. The shaded part on the PCdepicts a dedicated COM port on the PC, or a USB to serial convertor. Pin 3 and GND refer tothe pins on a D9 serial connector that has been attached to the cabling from the MF7. A nullmodem will be required when connecting to PC.

Alternatively, the user can connect the TX Data line from MF7 to Pin 2 of the COM port or USBto serial convertor from PC. Once MF7 is tested with PC, it is recommended that Pin 3 beused if an Enfora programming cable (e.g. CAB2448-02, CAB2238-01) is used for testing MF7with Enfora device. Otherwise, direct connection as per section 2.2 can be used.

Figure 2-1 MF7 to PC Connection

Connect the MF7 to the appropriate DC voltage range (5-18 Volts). The green LED on thefront of the MF7 reader will light up when powered on.

Set the following parameters once you power the MF7 on and connect it to a PC runningHyperterminal (or similar):

Baud Rate 9600

Flow control No

Data Bit 8

Stop Bit 1

Parity No


The MF7 is now ready to scan RFID tags. When a RFID Tag is near the MF7 reader, you willhear an audible beep and the RFID tag serial number will appear on the terminal applicationwindow.

The MF7 sends data in the following format:

STX (02 HEX) DATA (8 HEX CHARACTERS) CR LF ETX (03 HEX)

You will not see the STX and CR, LF and ETX characters in a serial application.Refer to the MF7 instruction manual for more information.

The following is an example of data for 6 scanned RFID tags (ignore the unreadablecharacters).

Figure 2-2 RFID Tags


Connecting The RFID To An Novatel Wireless M2MDeviceThe following figure shows the two wires required to connect MF7 to an Novatel WirelessM2M device (i.e., TX Data and Ground).

The Novatel Wireless M2M device does not supply power to the MF7 reader. Youwill need a separate power supply. This could be the same power supply that youuse for the Novatel Wireless M2M device. For example, when you install both anNovatel Wireless M2M device and a MF7 reader in a car, you could power bothdevices from the car battery.

Figure 2-3 MF7 to Novatel Wireless M2MDevice Connection

The following table shows the pins on an Novatel Wireless M2M device and how they connectto a MF7 device.

MF7

Novatel Wireless M2M Device TX Data Ground

GSM2448 Pin 21 Pin 6 or 7

GSM2358/2438 Pin 2 Pin 4

Table 2-1 Enfora device connection


3Configuring Novatel WirelessM2M Device For RFID Usage

RFID AT Commands

Sample Script

Testing on the Novatel Wireless M2M Server


RFID AT Commands

Sample Script

Testing on the Novatel Wireless M2M Server


RFID AT CommandsSet the following AT Commands in the Novatel Wireless M2M device to fully integrate theMF7. For more information on the exact parameter settings, refer to the Novatel WirelessM2M device's AT Command document.

Use 211 as the input event when receiving the data via the event engine (see the sample scriptlater in this document).

AT$UAMCFG

This command sets the Header and Footer associated with the data sent from the MF7 to theNovatel Wireless M2M device.In this case, set as:

AT$UAMCFG=1,"02","0D0A03"where 1 is for Binary format for Header and Footer.02=STX, 0D=CR, 0A=LF and ETX=03.

This command does not affect the data format between the Header and Footer.

If the AT$UAMCFG is set to null header or footer i.e. AT$UAMCFG=1,””,”” thenany data that is received on the serial port will be sent to server.

The maximum data length for Header and Footer is 10 Bytes ASCII or Binary.

AT$UAUCFG

This command sets the serial communication parameters of the MF7.In this case, set as:

AT$UAUCFG=9600,8,0,1


To save this value, you must input AT&W.

The default value is 115200,8,0,1.

AT$UALIST

This command creates a whitelist (max 100 list items) for RFID tags. For example, if youallowed the first three tags, then you should send the following to the Novatel Wireless M2Mdevice. To send all scanned RFID tag serial numbers to the server, you may opt to create alist. If you create a list, you would need to input AT&W to save the list.

For RFID Tag 1:

AT$UALIST=1,0,"B8A31DEE"

For RFID Tag 2:

AT$UALIST=2,0,"B7637B9E"

For RFID Tag 3:

AT$UALIST=3,0,"293750FA"

Where for RFID Tag 1; 1=Memory location, 0=ASCII, “Message”= RFID ID tag number. Refer toAT command guide.

If you must erase an individual item in the list (say Tag 3), then you should use the followingformat:

AT$UALIST=3,0,""

The entry location will remain in device memory but the data will be null.

To save the values of AT$UALIST, you must input AT&W.


The maximum data length (“Message” in AT$UALIST) that can be stored is 100bytes ASCII or Binary

AT&F will erase the entire list.

AT$UALTO

Use this command to set a timeout value (0-3600s) that tells the device when to fire inputevent 211 with a value of -1 (see sample script in this application note).

AT$UAEN

Use this command to enable or disable the Serial port on the Novatel Wireless M2M device. Inthis case, send the following AT Command(s) associated with setting up the Novatel WirelessM2M device for MF7 usage:

AT$UALIST (optional)

AT$UAEN=1

If you have completed all of the steps up to this point, you have successfully reserved theserial port on Novatel Wireless M2M device for the MF7 reader.

The AT$UAEN command is not persistent via a reset. Therefore, AT&W has to be used tomake the AT$UAEN=1 persistent. The user can choose to not make AT$UAEN=1 persistent viaa stored event in a script. Refer to the methods explained in the Scripts section of thisapplication note to ensure AT$UAEN=1 is reinstated automatically.

Optionally, both AT$UAEN=1 and AT&W commands can be sent over the air from the serverside.

Follow the steps below if you need to reinstate the serial port on the Enfora device back toAT command mode:


1. Disconnect MF7 serial interface and connect Enfora device serial interface to serialterminal application on PC

2. Change the baud rate (via serial terminal application) to 9600 (since the Enfora devicedefault was 115200 and, via AT$UAUCFG, the default for the MF7 was set to 9600)Remove the power from the device for 5 seconds and reinstate power again. See Notebelow if internal battery is used.

3. As the Enfora device is powering up, send AT$UAEN=0 (there is a 5-6 second windowto send this command serially before the serial port is reserved again).Alternatively, ifthe device is already reporting to a server, AT$UAEN=0 can be sent over the air(providing device is reporting into server already)

4. Once the AT$UAEN=0 has been sent via step 3. Change the baud rate of the serialterminal application to 115200 and normal AT command mode will be resumed.

When power cycling the device to reinstate the serial port, the internal batterywill have to be disabled (if used). Refer to device user guide on how to do this.

A

T$UAUCOM

On modems with multiple serial ports, use this command to configure which UART themodem will use to receive data from the UART Application.

By default, the modem will use UART#1. If UART#2 is desired, use the following command:

AT:UAUCOM=2

Sample ScriptTo validate your MF7 reader, you can program this sample script to an Novatel Wireless M2Mdevice and then test it on the Novatel Wireless M2M Test Server. The AT$UAEN=1 is sentmanually via serial port.

AT&F

AT&W

AT+CGDCONT=1,"IP","your APN"

AT%CGPCO=1,"username,password",

AT$FRIEND=1,1,"apitest.nvtl.com"

AT$MDMID="IMEI or your ownunique ID"

/* UDP port


AT$APIOPT=1,1,4 /* Optional Header

/* Set Baud RateAT$UAUCFG=9600,8,0,1 /* For MF7 reader

/* Create a LISTAT$UALIST=1,0,"B8A31DEE" /* RFID Tag 1AT$UALIST=2,0,"B7637B9E" /* RFID Tag 2AT$UALIST=3,0,"293750FA" /* RFID Tag 3

/* Set Header and Footer

/*Send a message when RFID is in the listAT$UAMCFG=1,"02","0D0A03"

AT$EVENT=12,1,211,1,100 /* If RFID tag is detected & is one of the 100 lis-ted items

AT$EVENT=12,3,40,30,3014655,2 /* Send a message to Test Server

/*Send a message when RFID is NOT in the listAT$EVENT=13,1,211,0,0 /* If RFID tag is detected & is not in the listAT$EVENT=13,3,40,31,135,2 /* Send a message to Test ServerAT$AREG=2

AT&W /*****End of Script*****

In order to use the AT$UALTO, change the above script to the script below. Please note thatthis usess a GPIO3, which you could use to control a relay. For such a script: when the scannedRFID tag is in the list, trigger GPIO3 to go high. The UALTO timer will start simultaneously.The GPIO3 is set low when the UALTO expires.

For example, you may want to try starting a car using RFID. Once you scan the RFID and thetag is on the list, the GPIO3 will enable the relay for 30 seconds to start the car. If you do notstart the car within 30 seconds, relay will be disabled via GPIO3 going low and the RFID tagwould then need to be scanned again.

AT&F

AT&W



AT$FRIEND=1,1,"apitest.enfora.com"

AT$MDMID="IMEI or your own uniqueID"AT$UDPAPI=,1721 /* UDP portAT$APIOPT=1,1,4 /* Optional Header


/* Create a LISTAT$UALIST=1,0,"B8A31DEE" /* RFID Tag 1AT$UALIST=2,0,"B7637B9E" /* RFID Tag 2


AT$UALIST=3,0,"293750FA" /* RFID Tag 3

/* Set Header and FooterAT$UAMCFG=1,"02","0D0A03" /* Send a message when the RFID is in the listAT$EVENT=12,1,211,1,100 /* If RFID tag is detected & is one of the 100 listed itemsAT$EVENT=12,3,40,30,3014655,2 /* Send a message to Test ServerAT$EVENT=12,3,2,1,1 /* Set GPIO 3 to High

/* When UALTO times out set GPIO3 to lowAT$UALTO=30 /* Set to 30sAT$EVENT=14,1,211,-1,-1 /* When timer UALTO expiresAT$EVENT=14,3,2,0,0 /* Set GPIO 3 to lowAT$AREG=2

AT&W /*****End of Script*****

Sample Script To Maintain AT$UAEN=1

You can use the sample script below to ensure that after a reset of the device, AT$UAEN=1 isreinstated automatically. The sample script below shows twomethods you can employ basedon user preference. Use either Method 1 or Method 2.

Method 1

This example uses stored events to send the AT$UAEN=1 and AT&W via a dummy geofenceevent. If the user wants to recover serial port when using this script then the device wouldneed to be power cycled and the AT$UAEN=0 sent within 5-6 seconds at 9600 baud (due toAT$UAUCFG=9600,8,0,1).AT&F

AT&W







/* Set Header and FooterAT$UAMCFG=1,"02","0D0A03" /* Send a message when the RFID is in the listAT$EVENT=12,1,211,1,100 /* If RFID tag is detected & is one of the 100 listed itemsAT$EVENT=12,3,40,30,3014655,2 /* Send a message to Test Server


/* Send a message when the RFID is NOT in the listAT$EVENT=13,1,211,0,0 /* If RFID tag is detected & is not in the listAT$EVENT=13,3,40,31,135,2 /* Send a message to Test Server

/* Reinstate AT$UAEN=1 after a reset (Method 1)AT$EVENT=15,1,50,1,1 /* Geofence #25AT$EVENT=15,3,44,1 /* Execute stored AT command #1AT$EVENT=15,3,44,2 /* Execute stored AT command #2AT$EVENT=15,3,44,3 /* Execute stored AT command #3AT$STOATEV=1,AT$UAEN=1 /* Send command from slot1 to lock the serial portAT$STOATEV=2,AT&W /* Set to saveAT$STOATEV=3, AT$RESET /* Send a resetAT$AREG=2

AT$EVTEST=50,1 /* Executes event 15 via a dummy Geofence. After this pointthe serial port will be locked.

/*****End of Script*****


Method 2

This example uses Timer 2 to reinstate the AT$UAEN=1 after a reset via stored commands,which allows the user a window of about 6 sec to send commands to the modem before it isreserved again. Timer 2 can be increased, but any large increase could impact theperformance of the RFID tag reading capability.AT&F

AT&W







/* Set Header and FooterAT$UAMCFG=1,"02","0D0A03" /*Send a message when the RFID is in the listAT$EVENT=12,1,211,1,100 /* If RFID tag is detected & is one of the 100 listed itemsAT$EVENT=12,3,40,30,3014655,2 /* Send a message to Test Server

/*Send a message when the RFID is NOT in the listAT$EVENT=13,1,211,0,0 /* If RFID tag is detected is not in the listAT$EVENT=13,3,40,31,135,2 /* Send a message to Test Server

/* Reinstate AT$UAEN=1 after a reset (Method 2)AT$EVTIM2=6 /* Timer set to 6 seconds. In these six seconds you can send

AT commands to modem.AT$EVENT=16,1,13,1,1 /* When timer 2 expiresAT$EVENT=16,3,44,1,0 /* Execute stored AT command #1AT$EVENT=16,3,44,2,0 /* Execute stored AT command #2AT$STOATEV=1, AT$UAEN=1 /* Send command from slot1 to lock the serial portAT$STOATEV=2, AT$EVTIM2=0 /* Set Timer 2 to 0AT$AREG=2

AT&W

AT$RESET /*****End of Script*****

Testing On The Novatel Wireless M2M ServerUntil you have access to a server, you may temporarily use the Novatel Wireless M2M TestServer to test and verify MF7.


The Novatel Wireless M2M test server is for testing only. Novatel Wireless M2Mdoes not keep a backup of data sent to this server.

Access the Novatel Wireless M2M Server at the following Web address:

http://apitest.nvtl.com/udpapp/

Use the previous example script to program an Novatel Wireless M2M device, then test it onthis Novatel Wireless M2M Test Server to validate the MF7 reader.

Interpreting Data From The Novatel Wireless M2M Test Server

The example data strings (below) show only the RFID ID and the Param3 value as set in theoptional header information (AT$APIOPT command). It is left as an exercise for the user todecode the full string. The user can use the Novatel Wireless M2M Toolbox or refer to the APIreference guide to decode the full string.

Param3 Not In Optional Header

Using the example scripts above, the Novatel Wireless M2M test server shows the followingraw data when the optional header is set to:

AT$APIOPT=1,1,4

The following data displays on the Novatel Wireless M2M Test server:

The highlighted part of the payload data contains the RFID ID data:

09 42 38 41 33 31 44 45 45

Reading from left to right:

09 = the length of bytes representing RFID ID including the length parameter.

The RFID ID is 42 38 41 33 31 44 45 45 = B8A31DEE which is the first ID in the AT$UALIST perthe script.

Param3 In Optional Header

To include the optional header with the Param3 data, use any of the example scripts aboveand change the optional header command to:


AT$APIOPT=1,1,4,0,0,0,1

Where the 7th parameter is a 1 for enabling Param3, for GSM2358 or GSM2438 device.

If GSM2448 device is used, an 8th parameter is set to 1 as the 7th parameter is reserved forDriver ID.

The following data is sent to Novatel Wireless M2M test server using GSM2358 device anddisplays as:

The optional header part is decoded as:

06 = the total length of bytes (i.e., 06 09 00 00 00 02)

09 = the type 9 field of the optional header which includes the Param3 value. (Refer to APIreference for more information.)

00 00 00 02 = the value of Param3 used, which in this case is 2 (as per Event 12 or 13 in theabove scripts)

The RFID ID data is decoded as:

09 42 38 41 33 31 44 45 45

Reading from left to right:

09 = the length of bytes representing RFID ID including the length parameter

The RFID ID is 42 38 41 33 31 44 45 45 = B8A31DEE which is the first ID in the AT$UALIST

enf0000an017 - rfid integration -v1!03!2013oct30

Documents

novatel wireless m2m

novatel wireless m2m

novatel wireless m2m

novatel wireless m2ms

new releases

use of anynew materials

new materialsin connection

rfid usage