rfid reader compact communication protocol

www.noravel.com

RFID READER COMPACT

COMMUNICATION PROTOCOL

Revision 1.0.0

08.11.2016

Murat KAPLAN

Interface : RS-485

Baud rate : 9600

Parity : None

Data bits : 8

Stop bit : 1

Genel Açıklama

Protokol, standart Data-link yapısına dayanmakta olup Master tarafın kart okuyucuları

Poll(sorgu komutu) ile yokladığı “Stop and Wait” ilişkisi ile oluşturulmuştur. Master taraf, kart

okuyucuya bir veri gönderecek ise Poll yerine data paketi göndermelidir. Eğer kart okuyucu Master

‘a bir veri paketi gönderecek ise Master dan gönderilen Poll sorgusuna karşılık data paketi olarak

cevap vermelidir. Veri akışı half-dublex yapıdadır.

Her Slave(okuyucu) kendisine ait bağımsız birer adrese sahip olmalıdır. Adres aralığı 40h ile

C0h arasında ayarlanabilir. Dilenirse 128 adet okuyucu tek bir haberleşme hattı üzerinden

doğrudan kontrol edilebilir.

www.noravel.com

Data Frame Block

ADR CTRL CMD LNG DATA 1

DATA 2

DATA …

CRC-1 CRC-2 ETX SF

Data frame yapısı okuyucunun haberleşme adresi ile başlar ve paket sonunu gösteren

ETX(03h) ve SF(FAh) işaret byte ları ile son bulur. Data verileri ASCII karakterlerden oluşur. Kart

okuyucu için 256 byte’lık veri buffer’ı haberleşmeye ayrılmıştır ve tek seferde gönderilen veya

alınan paket veri uzunluğu bu sayıyı aşamaz. Veri hata kontrolü CRC16(CCITT) ile gerçekleştirilir.

ADR : Okuyucu adresi (40h - C0h) CMD : Transaction tanımı LNG : Transaction uzunluğu CTRL : Kontrol karakteri ve blok dizi numarası

CTRL

7 6 5 4 3 2 1 0

Data Blok dizi numarası : 0-Fh (Master tarafından başarıyla gönderilen her data bloğu için bir artırılır. Her okuyucu için ayrı bir data sequence numarası tutulur. Poll,ACK ve NACK komutları için 0 olarak gönderilir). CRC16 için ADR den, son DATA byte’na kadar olan kısım hesaplamaya dâhil edilir. CRC-1 : LSB of CRC16 CRC-2 : MSB of CRC16

Protokol Kontrol Karakterleri

ETX : 03h (End of Text) DLE : 10h (Data Link Escape) SF : FAh (Stop Flag) POLL : 20h (Polling to Slaves) DATA : 30h (Data Package Indicator) NAK : 50h (No Acknowledgement) EOT : 70h (Nothing to Send) ACK : C0h (Acknowledgement)

bits

Block sequence number 0-Fh

Control character

www.noravel.com

Mesaj Yapıları

Master’ dan Slave ‘ e gönderilen mesaj yapıları POLL : ADR+CTRL+SF DATA : ADR+CTRL+DATA1+DATAn+CRC-1+CRC-2+ETX+SF ACK : ADR+CTRL+SF NACK : ADR+CTRL+SF

Slave’ den Master’ a gönderilen mesaj yapıları

EOT : ADR+CTRL+SF DATA : ADR+CTRL+DATA1+DATAn+CRC-1+CRC-2+ETX+SF ACK : ADR+CTRL+SF NACK : ADR+CTRL+SF

Okuyucu durum değerlerinde bir değişiklik olduğu zaman yada kart okutulmuş ise Poll

komutunun ardından direk olarak GET STATUS yada CARD ID verileri gönderilir.

Gönderilen Data yapıları alıcı tarafından düzgün olarak alınıp değerlendirilmiş ise ACK ile

cevaplanır. ACK gönderilmez ise okuyucu data gönderimini 5 defa daha yineleyecektir.

Byte Stuffing

Kod berraklığının(Code Transparance) sağlanması için paket içerisinde Data Link Escape

(DLE) kontrolü yapılmalıdır. DLE kontrolü sadece SF işaret flag’i için yapılır. Eğer Data veya CRC byte larından biri SF ile aynı ise bu byte’ın önüne DLE(10h) eklenmelidir. DLE olarak eklenen byte, mesajı alan tarafca filtre edilerek yok sayılmalı ve CRC hesabına dahil edilmemelidir.

Bu işlemin amacı mesaj paketi içerisinde bulunan bir veri yada CRC byte’nın SF ile karıştırılmaması içindir.

Örnek :

Orijinal Data Frame

Byte st den sonra

… CRC1 CRC2 …

… 35h FAh …

… CRC1 DLE CRC2 …

… 35h 10h FAh …

Timming

Okuyucu, komutlara veri gönderimi sonunda 50 msn içerisinde cevap gönderir. İstisnai olarak SEND USER CARD komutu için bu süre 500 msn’dir. Okuyucudan gelen cevap ile yeni komut gönderimi arasında asgari bekleme süresi 2 msn olmalıdır.

www.noravel.com

COMMAND TO READER

Okuyucuya komut gönderilir. Komutun içeriği DCC byte’ı ile belirlenir.

Direction Master to Slave

CMD 01h

LNG 01 Gönderilen byte sayısı

DCC 00h – 04h Okuyucu komutları

Aşağıdaki komutlar gönderilir :

DCC Açıklama

00h Get Reader Status Okuyucu durumu istenir

01h Get Card ID Son okutulan kartın ID si istenir

02h Get Settings Okuyucu ayarları istenir

03h Get Diagnostic Çalışma durumu verileri istenir

04h Reset Okuyucuya son okutulan kart ID si okuyucu bufferın dan temizlenir.

05h Remove All User Cards Tanımlı tüm kullanıcı kartları okuyucu hafızasından silinir. “Send User Cards” komut dizisi ile okuyucuya kullanıcı kartları gönderilmeden önce okuyucu hafızası bu komut ile temizlenmelidir.

Örnek :

40h adresli okuyucuya durum sorulur.

ADR CTRL CMD LNG DCC CRC1 CRC2 ETX SF

40h 30h 01h 01h 00h 5Eh 9Fh 03h FAh

www.noravel.com

SEND RELAY

Röle konumu ayarlanır. Rölenin çekili kalacağı süre Relay On Duration değeri ile ayarlanır.


CMD 02h


DATA 1 xx Relay On Duration ASCII 1 (MSB)

DATA 2 xx Relay On Duration ASCII 2 (LSB)

Relay On Duration :

Röle verilen değer kadar saniye cinsinden enerjilenir ve süre sonunda kapatılır. Değer 1 ile 98

saniye arasında olmalıdır. Enerjilendirilen röle ivedi olarak kapatılmak isteniyor ise değer 0

gönderilir. Rölenin sürekli enerjilenmiş kalması isteniyor ise değer 99 olarak gönderilir. Bu sayede

röle “toggle”(aç-kapat) çalışmada da kullanılabilir.

Örnek:

40h adresli okuyucunun rölesi 5 saniyeliğine enerjilendirilir.

ADR CTRL CMD LNG Relay On Duration

CRC1 CRC2 ETX SF

40h 30h 02h 01h 30h 35h 03h FAh

40h adresli okuyucunun rölesi sürekli olarak enerjilendirilir.


CRC1 CRC2 ETX SF

40h 30h 02h 01h 39h 39h 03h FAh

40h adresli okuyucunun rölesi kapatılır.


CRC1 CRC2 ETX SF

40h 30h 02h 01h 30h 30h 03h FAh

www.noravel.com

SEND BEEP MESSAGE

Okuyucu dan sesli ikaz üretmesi istenir.


CMD 03h


DATA 1 xx Message Cycle ASCII

DATA 2 xx Beep Interval Period ASCII 1 (MSB)

DATA 3 xx Beep Interval Period ASCII 2

DATA 4 xx Beep Interval Period ASCII 3

DATA 5 xx Beep Interval Period ASCII 4 (LSB)

DATA 6 xx Beep On Ratio ASCII 1 (MSB)

DATA 7 xx Beep On Ratio ASCII 2 (LSB)

DATA 8 xx Indıcator Led ASCII

Message Cycle :

Ses ikazının kaç kere tekrarlanacağı seçilir. Değer 1 ile 8 arasında olmalıdır. Sürekli olarak ikaz

vermek isteniyor ise değer 9 olarak gönderilir.

Beep Interval Period :

İkaz süresi periyodu mili saniye cinsinden belirlenir. 50 mili saniye ile 9999 mili saniye arasında

değer alabilir.

Beep On Ratio :

Periyod süresinin yüzde kaçı oranında ikaz vereceği ayarlanır. 0 ile 99 arasında değer alabilir.

Indicator Led :

Ses ikazına Led lerin eşlik edip etmeyeceği seçilir.

‘0’ = Ses ile birlikte Led yanmaz

‘1’ = Ses ile birlikte Kırmızı Led yanar

‘2’ = Ses ile birlikte Yeşil Led yanar

Örnek:

40h adresli okuyucudan 400 mili saniye periyodunda 3 kez tekrarlayacak şekilde 200 mili saniyelik

sesli ikaz üretmesi istenir (Bu sinyal STANDALONE modun da verilen hata sinyali ile aynıdır).

ADR CTRL CMD LNG Msg Cycle

Beep Interval Period

Beep On Ratio

Ind. Led

CRC1 CRC2 ETX SF

40h 30h 03h 08h 31h 32h 30h 30h 30h 32h 30h 31h 03h FAh

www.noravel.com

SEND SETTINGS

Okuyucu için aşağıdaki ayarlar gönderilir


CMD 04h


DATA 1 xx Com Address ASCII 1 (MSB)

DATA 2 xx Com Address ASCII 2

DATA 3 xx Com Address ASCII 3 (LSB)

DATA 4 xx Working Mode ASCII

DATA 5 xx Relay On Contact Mode ASCII

DATA 6 xx Relay On Duration ASCII 1 (MSB)

DATA 7 xx Relay On Duration ASCII 2 (LSB)

DATA 8 xx Master Card ID ASCII 1 (MSB)

DATA 9 xx Master Card ID ASCII 2






DATA 15 xx Master Card ID ASCII 8 (LSB)

DATA 16 xx Manual Settings Lock ASCII

Com Address :

Okuyucunun haberleşme adresi değiştirilir. 0 ile 127 arasında değer atanabilir. Bu komuttan sonra

okuyucunun adresi değişeceği için Master taraf da bu değişikliği dikkate almalıdır. (Default : 0)

Working Mode :

Okuyucu 3 farklı çalışma şekline göre kullanılabilir. Çalışma modu STANDALONE seçilmiş ise

okuyucunun içerisindeki kart tanım listesine bağlı olarak röle çıkışı enerjilenir. AUTOMATION

olarak seçilmiş ise röle kontrolü haberleşmeden gönderilecek komut(SEND RELAY) ile sağlanır.

MIXED olarak seçilir ise okuyucu haberleşme var iken AUTOMATION modu seçiliymiş gibi

haberleşme yok iken ise STANDALONE seçilmiş gibi çalışır. Haberleşmenin olmadığını okuyucu

kendisine 10 dakika boyunca hiçbir sorgu/komut gelmez ise anlar ve çalışma durumunu

STANDALONE koşuluna göre ayarlar. Haberleşme sağlandığı an tekrar AUTOMATION koşulu aktif

olur.

‘0’ = STANDALONE (Default)

‘1’ = AUTOMATION

‘2’ = MIXED

www.noravel.com

Relay On Contact Mode:

Okuyucu rölesi enerjilendiğinde kontakları hangi konuma göre hareket edeceği seçilir.

‘0’ = N.O. NORMAL (Default)

‘1’ = N.C. INVERSE

Relay On Duration(STANDALONE):

Standalone çalışma durumu için röle enerjide kalma süresi saniye cinsinden ayarlanır. 1 ile 30

saniye arasında değer alabilir. (Default : 3 Saniye)

Master Card (STANDALONE):

Standalone çalışma durumu için Master kart tanımlaması yapılır. Master kart ile kullanıcı kartları

manual alarak tanımlanabilir veya silinebilir. Aynı zamanda röle enerjide kalma süresi

ayarlanabilir. (Default : ‘00000000’)

Manual Settings Lock(STANDALONE):

Okuyucu devresi üzerinde bulunan Pin leri kullanarak Master Card tanımlama, Röle enerjilenme

süresi ayarlama gibi ayarlara manual olarak erişim engellenebilir.

‘0’ : Manual ayar menüsüne erişilebilir. (Default)

‘1’: Manual ayar menüsüne erişilemez.

Örnek:

40h(‘0’) adresli okuyucunun haberleşme adresi 42h(‘2’) olarak değiştirilir ve Çalışma durumu

AUTOMATION olarak ayarlanır. Röle kontak ayarı, röle enerjilendiğinde N.O. kontağı kapalı devre

oluşturacak şekilde ayarlanır. Röle enerjilenme süresi ve Master Card ID parametreleri,

AUTOMATION çalışma durumu için bir önem taşımasa da parametreler sırasıyla, 3 saniye ve

0x00000000 olarak ayarlanır. Ayarlara Manual erişim ise kapatılmıştır. Böylece devre üzerindeki

pinler ile Master Card ve röle enerjilenme süresi ayarlanamaz.

ADR CTRL CMD LNG Com Address Working Mode

RelayOn Contact

Relay On Duration

Master Card ID…

40h 30h 03h 0Eh 30h 30h 32h 31h 30h 30h 33h 30h 30h 30h

Manual Lock

CRC1 CRC2 ETX SF

30h 30h 30h 30h 30h 30h 03h FAh

www.noravel.com

GET USER CARDS

Okuyucudan STANDALONE çalışma durumu için tanımlı kart listesi istenir. Okuyucu haberleşeme

buffer’ı limitinden dolayı tek bir seferde 30 adet kullanıcı kartını gönderir ya da alır (Herbir Card 8

byte’lık ID bilgisi içerir). Aşağıdaki listede görüldüğü üzere 1200 adet kart için 40 adet Page (sayfa)

ayrılmıştır.

Kullanıcı kartlarının tamamının Master tarafından alınabilmesi için Page ler sırayla okuyucudan

istenmelidir.


CMD 05h


DATA 1 xx Kart listesi sayfa no ASCII 1 (MSB)

DATA 2 xx Kart listesi sayfa no ASCII 2 (LSB)

Page

Tanımlı kullanıcı kartları sayfa numarasına göre gruplanmıştır. Sayfa numarası 1 ile 40 arasında

olmalıdır.

Örnek:

40h adresli okuyucudan Page1’de tanımlı kart listesi istenir.

ADR CTRL CMD LNG Page CRC1 CRC2 ETX SF

40h 30h 05h 02h 30h 31h 03h FAh

KART TANIMLAMALRI LİSTESİ

Card 1

Card 2

Card 3

Card 4

Card 5

Card 6

Card 7

Card 8

Card 9

Card 10

Card 11

Card 12

Card 13

Card 14

.

.

.

Card 30

Card 31

Card 32

Card 33

Card 34

Card 35

Card 36

Card 37

Card 38

Card 39

Card 30

Card 31

Card 32

Card 33

Card 34

.

.

.

Card 60

…

Card 1170

Card 1171

Card 1172

Card 1173

Card 1174

Card 1175

Card 1176

Card 1177

Card 1178

Card 1179

Card 1180

Card 1181

Card 1182

Card 1183

.

.

.

Card 1200

PA

GE 1

PA

GE 2

PA

GE 4

0

www.noravel.com

SEND USER CARDS

Okuyucuya STANDALONE çalışma durumu için tanımlı kullanıcı kart ID leri gönderilir (Page yapısı

GET USER CARDS komutu altında anlatılmıştır). Kayıtların düzgün şekilde yapılabilmesi için bu

komuttan önce “Remove All User Cards” komutu ile tüm kullanıcı kartları okuyucudan silinmelidir.

Daha sonra Page ler içerisinde tutulan kullanıcı ID leri Page 1 den başlanarak sırayla okuyucuya

gönderilmelidir.

Bu komut için dikkat edilecek bir diğer husus komutun işlem süresidir. Komut gönderildiğinde

kullanıcı kartlarının okuyucuya kaydedilme işleminden dolayı yeni bir komut için en az 500 msn

beklenmelidir.


CMD 06h




DATA 3 xx 1.User Card ID ASCII 1 (MSB)

DATA 4 xx 1.User Card ID ASCII 2

DATA 5 xx 1.User Card ASCII 3





DATA 10 xx 1.User Card ID ASCII 8 (LSB)


… …


Page

Tanımlı kullanıcı kartları sayfa numarasına göre gruplanmıştır. Sayfa numarası 1 ile 40 arasında

olmalıdır.

Örnek:

40h adresli okuyucuya Page1 için 30 adet kullanıcı kartı gönderilir.

ADR CTRL CMD LNG Page 1.User Card (00123456)

40h 30h 06h F2h 30h 31h 30h 30h 31h 32h 33h 34h 35h 36h

... 30.User Card (00ABCDEF) CRC1 CRC2 ETX SF

... 30h 30h 41h 42h 43h 44h 45h 46h 03h FAh

www.noravel.com

READER STATUS

Okuyucu durumunu gönderir.

Direction Slave to Master

CMD 20h


DATA 1 30h-31h Reader Status (ASCII)

DATA 2 30h-31h Relay Status (ASCII)

Reader Sta :

‘0’ = Ready (Okuyucu normal çalışma durumda)

‘1’ = Busy (Okuyucu meşgul)

Relay Sta :

‘0’ = Relay Off (Röle anlık durumu pasif)

‘1’ = Relay On (Röle anlık durumu enerjilenmiş)

Örnek:

40h adresli okuyucun durumu işleme hazır ve röle kapalı durumda.

ADR CTRL CMD LNG Reader STA

Relay STA

CRC1 CRC2 ETX SF

40h 30h 20h 01h 30h 30h 03h Fah

CARD ID

Okunan Card ID si, ASCII formattında 8 byte olarak gönderilir.


CMD 21h


DATA 1 xx CARD ID (ASCII 1 MSB)

DATA 2 xx CARD ID (ASCII 2)






DATA 8 xx CARD ID (ASCII 8 LSB)

www.noravel.com

Örnek:

40h adresli okuyucuya 0x12345678 ID’li bir kart okutulduğunu farz edersek. Data aşağıdaki gibi

alınacaktır.

ADR CTRL CMD LNG CARD ID CRC1 CRC2 ETX SF

40h 30h 21h 08h 31h 32h 33h 34h 35h 36h 37h 38h 03h FAh

SETTINGS

Okuyucunun ayarları gönderilir.


CMD 22h


DATA 1 xx Com Address (ASCII 1 MSB)

DATA 2 xx Com Address (ASCII 2)

DATA 3 xx Com Address (ASCII 3 LSB)

DATA 4 xx Working Mode (ASCII 1)

DATA 5 xx Relay Contact Mode (ASCII 1)

DATA 6 xx Relay On Duration (ASCII 1 MSB)

DATA 7 xx Relay On Duration (ASCII 2 LSB)

DATA 8 xx Master Card ID (ASCII 1 MSB)

DATA 9 xx Master Card ID (ASCII 2)






DATA 15 xx Master Card ID (ASCII 8 LSB)

DATA 16 xx Manual Settings Lock (ASCII 1)

Örnek:

40h adresli okuyucunun tüm ayarlarının default konumda olduğunu düşünürsek, okuyucuya GET

SETTINGS komutu ile ayarları sorulduğunda aşağıdaki gibi bir data paketi alınır.

ADR CTRL CMD LNG Com Address

Working Mode

Relay Contact

Relay On Duration

40h 30h 22h 16h 30h 30h 30h 30h 30h 30h 33h

Master Card ID CRC1 CRC2 ETX SF

30h 30h 30h 30h 30h 30h 30h 30h 03h FAh

www.noravel.com

READER DIAGNOSTIC

Okuyucu çalışma durumu ile ilgili bilgilerini gönderir.


CMD 23h


DATA 1 30h-39h Power On Duration ASCII 1 (MSB)

DATA 2 30h-39h Power On Duration ASCII 2



DATA 5 30h-39h Power On Duration ASCII 5 (LSB)

DATA 6 30h-39h Defined User Card ASCII 1 (MSB)

DATA 7 30h-39h Defined User Card ASCII 2

DATA 8 30h-39h Defined User Card ASCII 3

DATA 9 30h-39h Defined User Card ASCII 4 (LSB)

DATA 10 30h-39h Reader Error Code ASCII

DATA 11 30h-39h Firmware Version ASCII 1 (MSB)

DATA 12 30h-39h Firmware Version ASCII 2

DATA 13 30h-39h Firmware VErsion ASCII 3 (LSB)

Power On Duration :

Okuyucuya enerji geldiği andan itibaren geçen süre saniye cinsinden gönderilir (0 - 99999).

Defined User Card :

Tanımlı kullanıcı kartları sayısı (0 - 9999).

Reader Error Code

Okuyucu donanımında meydana gelmiş bir hata var ise gönderilir.

‘0’ = Hata Yok

‘1’ = Reader okuyucu entegresi iletişim arızası

‘2’ = EEPRROM hafıza entegresi iletişim arızası

‘3’ = EEPROM yazma arızası

Firmware Version :

Okuyucu Firmware versiyon bilgisi gönderilir.

www.noravel.com

USER CARD

Okuyucu içinde tanımlı olan kart listesi, sorulan Page numarasına göre gönderir.


CMD 24h





DATA 4 xx 1.User Card ID ASCII 2








… …


Örnek:

40h adresli okuyucuyadan Page1 de tutulan kullanıcı kartları alınır.

ADR CTRL CMD LNG Page 1.User Card (00123456)

40h 30h 24h F2h 30h 31h 30h 30h 31h 32h 33h 34h 35h 36h

... 30.User Card (00ABCDEF) CRC1 CRC2 ETX SF

... 30h 30h 41h 42h 43h 44h 45h 46h 03h FAh

“

STANDALONE çalışma durumu için okuyucu içerisine 1200 adet kullanıcı kartı tanımlanabilir yada

silinebilir. Bu işlem Master Card yardımı ile manual olarak yapılabileceği gibi Master tarafınca

gönderilen komutlar ile de gerçekleştirilebilir.

“

www.noravel.com

ÖRNEK HABERLEŞME LOGLARI

Master taraf dan kart okuyucuya gönderilen datalar “ TX > ” olarak, kart okuyucudan Master tarafa

gönderilen dataları ise ‘’ RX < ” olarak işaretlenmiştir.

Senaryo 1 :

Bu senaryoda hatta bağlı tekbir kart okuyucuya kart okutulmuş kart bilgisi Master tarafından

alındıktan sonra kart okuyucuya 3 saniye için rölesini çekmesi için komut gönderilmiştir.

TX > 40-20-FA // Kart okuyucu Poll ile yoklanır.

RX < 40-70-FA // Kart okuyucu gönderecek bir şeyi yoksa EOT ile cevap verir.

TX > 40-20-FA

RX < 40-30-21-08-35-31-41-44-37-35-45-45-38-BF-03-FA // Kart ID si

gönderilir.

TX > 40-C0-FA // Kart ID sinin alındığına dair ACK gönderilir.

TX > 40-30-02-02-30-33-BA-A9-03-FA // Okuyucudan 3 saniye rölesini çekmesi

istenir.

RX < 40-C0-FA // Komutun alındığına dair ACK gönderilir.

TX > 40-20-FA

RX < 40-30-20-02-30-31-31-10-03-FA // Röle çektiği için okuyucu röle durum

değişikliğini gönderir.

TX > 40-C0-FA // Durumun alındığına dair ACK gönderilir.

TX > 40-20-FA

RX < 40-70-FA

.

.

.

TX > 40-20-FA

RX < 40-30-20-02-30-30-F0-D0-03-FA // 3 saniye sonunda röle çekmeyi bırakacağı

için röle durum değişikliği gönderilir.

TX > 40-C0-FA // Durumun alındığına dair ACK gönderilir.

TX > 40-20-FA

RX < 40-70-FA

rfid reader compact communication protocol

Documents