MorphoAccess 500 Series RS422 Communication Protocol

Produced by Sagem Scurit

Copyright 2009 Sagem Scurit

www.sagem-securite.com

MorphoAccessTM 500 Series RS422 Communication Protocol SSE-0000067765-02

September 2009

MorphoAccess 500 Series

RS422 Communication Protocol

2 Sagem Scurit document. Reproduction and disclosure forbidden SSE-0000067765-02

Table of Contents

INTRODUCTION 3

SCOPE OF THE DOCUMENT 4

REFERENCES 5

RS422 PROTOCOL 6 DEFINITION 6 FRAMES SEQUENCE 8 TIMING CHARACTERISTICS 8 COMMUNICATION ERROR CASE 8 REQUEST COUNTER MANAGEMENT 8 RETRANSMISSION 9 ERROR CASES 9 TYPICAL TRANSACTIONS WORKFLOW 10 EXAMPLES 12

SUPPORT 13 CUSTOMER SERVICE 13 HOTLINE 13

SSE-0000067765-02 Sagem Scurit document. Reproduction and disclosure forbidden. 3

IINNTTRROODDUUCCTTIIOONN

This document describes the protocol used to send remote commands (ILV) to the MorphoAccess using the serial link (RS422).This protocol is only available on MorphoAccess 500 Series.


SSCCOOPPEE OOFF TTHHEE DDOOCCUUMMEENNTT

This guide relates to the use of MorphoAccessTM 500 Series terminals. MorphoAccessTM 500 Series is a generic appellation which gathers MorphoAccessTM terminals belonging to MA 500+ Series, OMA 500 Series and MA 500 Series. Corresponding list of products is depicted in the table below.

Contactless Smartcard Reader

Biometrics MIFARETM DESFireTM

False Finger

Detection Outdoor

MA 500+ MA 520+ D MA 500+ Series MA 521+ D OMA 520 D OMA 521 D OMA 520

OMA 500 Series

OMA 521 MA 500 MA 520 MA 500 Series MA 521


RREEFFEERREENNCCEESS

Reading the following manuals may be useful to understand the functionalities presented in this document:

MorphoAccessTM Installation Guide, MorphoAccessTM Host System Interface Specification.


RRSS442222 PPRROOTTOOCCOOLL

DDeeffiinniittiioonn

DDaattaa PPaacckkeett SSttrruuccttuurree The packet format is:

STX ID RC DATA CRC DLE ETX

Start Of Packet End Of Packet

AAbbbbrreevviiaattiioonn

Fields name Definition Size (Bytes) Value Start Text 1 0x02

Packet Identifier 1 --

Request Counter 1 --

Data value Up to 1024 --

Transmission error control 2 --

Data Link Escape 1 0x1B

End Text 1 0x03 The maximum size allowed for a packet is 2 058 bytes: (STX+ID+DLE+ETX+(RC+DATA+CRC)*2 [if stuffed]) BByyttee OOrrddeerr The packet byte order is Little Endian: multi bytes data are sent to the Least Significant Byte first (LSB). DDaattaa Data are formatted as ILV packets.

SSttuuffffiinngg Software handshake capabilities (XON-XOFF) are preserved by replacing, in the , all XON(0x11) / XOFF(0x13) characters by the couple (0x12) or (0x14).


To prevent confusion with the frames sequences and , every byte in the is preceded by an extra byte (stuffing). Stuffing must be processed before sending a packet and removed (unstuffed) after receiving the packet. NOTE: a simple sequence does not necessarily signify

the end of the packet, as these can be bytes in the middle of a data string.

The end of a packet is preceded by an odd number of bytes.

CCRRCC CCaallccuullaattiioonn The type of the CRC is CRC16 V41. The CRC is computed as a function of the Data part before Stuffing. The initial value is 0x0000.

PPaacckkeett IIddeennttiiffiieerr The identifier is formatted as follow:

Bit 7 (MSB) Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0 (LSB) IN/OUT First Last Reserved 0 Packet Type

The MSB (Bit 7) is reserved for packet direction. Setting this bit set the direction to IN. Clear this bit to set the direction to OUT. An OUT packet is a packet sent by the Host to the MorphoAccess. An IN packet is a packet sent by the MorphoAccess to the Host. Bit 6 is reserved for Packet Order information. Set this bit when it is the first packet when transmitting a set of packets. Bit 5 is reserved for Packet Order information. Set this bit when it is the last packet when transmitting a set of packets. Bit 4 is a reserved bit and must be cleared. Bits 3 to 0 are used for Packet Identification: The following packet types are implemented:

ID Value Description

0x1 Data Packet

0x2 ACK Packet

0x4 NACK Packet


FFrraammeess sseeqquueennccee

Frame creation Frame process

CRC calculation CRC verification

DLE Stuffing DLE Unstuffing

XON / XOFF replacement

/

replacement

TTiimmiinngg CChhaarraacctteerriissttiiccss The maximum elapsed time between transmission of two bytes of a frame is 100ms. The maximum elapsed time between the emission of a Packet Data and the reception of the ACK is 500ms.

CCoommmmuunniiccaattiioonn EErrrroorr CCaassee The following error cases must be detected:

Timeout between the reception of two bytes (the timeout starts after the reception of STX),

Bad CRC check, Unstuffing error ( is followed by an unexpected character).

RReeqquueesstt CCoouunntteerr mmaannaaggeemmeenntt The following rules have to be implemented:

the RC of a data is filled with the current Counter value, the RC of an ACK/NACK packet is filled with the RC of the data

packet to ACK/NACK, on the reception of an ACK/NACK packet, the RC is compare to the

latest data packet sent. If it is an ACK, the counter is increased on a hit. If several packets are received with the same RC, only one ACK is send.


RReettrraannssmmiissssiioonn

In case of NACK reception or Timeout, the transmitter tries to send the same packet again. A packet can be retransmitted 3 times. After, another NACK reception or Timeout event leads to ERROR of the transmission.

EErrrroorr ccaasseess

When a frame is not valid (Bad CRC, Unstuffing error, Rx timeout), the receiver must send a NACK packet.

When the transmitter is waiting an ACK/NACK packet, all other received packet must be ignored.


TTyyppiiccaall TTrraannssaaccttiioonnss wwoorrkkffllooww

Emission of a data packet that contain less than 1 024 bytes of effective data:

Emission of a data packet that contain more than 1 024 bytes of effective data:

Transmitter Receiver RC

RC+1

HIT

Packet Type:

DATA

RC value:

RC

Bit F:

1

Bit L:

1

ACK(RC)

Transmitter Receiver RC

RC+1

HIT

Packet Type:

DATA

RC value:

RC

Bit F:

1

Bit L:

0

ACK(RC)

Transmitter Receiver RC+1

RC+2

HIT

Packet Type:

DATA

RC value:

RC+1

Bit F:

0

Bit L:

0

ACK(RC+1)

Transmitter Receiver RC+i

RC+i+1

HIT

Packet Type:

DATA

RC value:

RC+i

Bit F:

0

Bit L:

1

ACK(RC+i)


An Error occurred while transmitting the data packet:

The data packet is transmitted but the receiver does not transmit ACK or NACK:

Transmitter Receiver

RC

Nb attempts = 0

RC

Nb attempts = 1

HIT

DATA (RC)

NACK (RC)

ERROR


RC

Nb attempts = 2

RC

Nb attempts = 3

HIT

DATA (RC)

NACK (RC)


RC

Nb attempts = 0

RC

Nb attempts = 1

DATA (RC)

Wait ACK or NACK 500ms

TIMEOUT


RC

Nb attempts = 2

RC

Nb attempts = 3

HIT

DATA (RC)

Wait ACK or NACK 500ms


EExxaammpplleess

PPCC sseennddss aa ppiinngg rreeqquueesstt ttoo tthhee MMoorrpphhooAAcccceessss

STX ID RC Data: ILV CRC CRC DLE ETX

02 61 XX 08 00 00 XX XX 1B 03

AAnnsswweerr ffrroomm tthhee MMoorrpphhooAAcccceessss ttoo tthhee PPCC


02 61 XX 08 01 00 00 XX XX 1B 03

PPCC aasskkss ffoorr tthhee llooggss ssttaattuuss


02 61 XX 5D 01 00 00 XX XX 1B 03

AAnnsswweerr ffrroomm tthhee MMoorrpphhooAAcccceessss


02 61 XX 5D 0A 00 00 01 09 00 40 1F 40 00 01 12 XX XX 1B 03


SSUUPPPPOORRTT

CCuussttoommeerr sseerrvviiccee Sagem Scurit SAV Terminaux Biomtriques Boulevard Lnine - BP428 76805 Saint Etienne du Rouvray FRANCE Phone: +33 2 35 64 55 05

HHoottlliinnee

Sagem Scurit Support Terminaux Biomtriques 18, Chausse Jules Csar 95520 Osny FRANCE [email protected] Phone: +33 1 58 11 39 19 http://www.biometric-terminals.com/

Copyright 2009 Sagem Scurit http://www.sagem-securite.com/

Head office: Le Ponant de Paris

27, rue Leblanc - 75512 PARIS CEDEX 15 - FRANCE

MorphoAccess 500 Series RS422 Communication Protocol

Documents

Transcript of MorphoAccess 500 Series RS422 Communication Protocol