SDK Manual for RFID

ASX-300R

ASX-301R

ASR-030D

ASR-031D

SDK Manual 2016-01-18      

Introduction of SDK

Add Framework

Add ExternalAccessory.framework to project

Add AsReader SDK

TARGET -> Build phases -> Link Binary With Libraries

### Select “Add Other”

Select "libAreteUart.a" in downloaded SDK files

Add following files to project

• Eas.h
• UartMgr.h
• RcpBarcodeApi.h
• RcpRfidApi.h

Add AsReader protocol

Add following identifiers to Supported external accessory protocols in plist

• ASX-300R, ASX-301R：jp.co.asx.asreader.rfid
• ASR-030D, ASR-031D：jp.co.asx.asreader.6dongle.rfid

Play AsReader

• Import RcpRfidApi.h

  #import "RcpRfidApi.h"

• Implement RcpRfidDelegate

  @interface AsReaderViewController ()<RcpBarcodeDelegate,RcpRfidDelegate>

• Initialize RcpRfidApi

        - (RcpRfidApi *)rcpRfid{
            static dispatch_once_t pred = 0;
            __strong static id _sharedObject = nil;
            
            dispatch_once(&pred,^{
                _sharedObject = [[RcpRfidApi alloc] init];
                _rcpRfid = _sharedObject;
                _rcpRfid.delegate = self;
                [_rcpRfid open];
            });
            return _sharedObject;
        }

• Implement RcpRfidDelegate

- (void)pluggedRfid:(BOOL)plug{
    plugged = plug;
    
    if(plug){
        if([self.rcpRfid isOpened]){
            dispatch_async(dispatch_get_main_queue(),^{
                _statusLabel.text = @"Plugged";
                [self.rcpRfid setReaderPower:YES];
            });
        }
    }else{
        dispatch_async(dispatch_get_main_queue(),^{
            _statusLabel.text = @"Unplugged";
            [self.rcpRfid setReaderPower:NO];
            [self.rcpRfid close];
        });
    }
}

API Methods

◆Initialize

Method

- (id)init

Description

Initialize API class

Parameters

None

Return value

initialized API object

◆Connection process

Method

- (BOOL)open

Description

open connection to AsReader

Parameters

None

Return value

• YES : success
• NO : failure

◆Receive a change of connection state with AsReader

Method

- (void)pluggedRfid:(BOOL)plug

Description

called when connection state with AsReader changes

Parameters

• YES : success
• NO : failure

Return value

None

◆Receive connection state with AsReader

Method

- (BOOL)isOpened

Description

receive connection state with AsReader

Parameters

None

Return value

• YES : connected
  
• NO : not connected

◆AsReader Power (1)

Request

Method

- (BOOL) setReaderPower :(BOOL)on

Description

send command to switch Power of AsReader

Parameters

Yes : ON No : OFF

Return value

YES : success
NO : failure

Response(in case of 300R, 301R)

Method

- (void)readerConnected

Description

Called when AsReader turnes on.
Please don't call other api methods until this method is called.

Parameters

None

Return value

None

Response(in case of 030D)

Method

- (void)readerConnected:(uint8_t)status

Description

Please don't call other api methods until this method is called.

Parameters

• 0xFF : success
• 0X00 : failure

Return value

None

Example

//300R, 301R
- (void)readerConnected{
    [self readerConnected:0xff];
}

//030D, 031D
- (void)readerConnected:(uint8_t)status
{
    NSLog(@"readerConnected\n");
    
    dispatch_async(dispatch_get_main_queue(),
                   ^{
                       switch (status)
                       {
                           case 0xff:
                           {
                               self.olStatus.text = @"Connected\n";
                               [self.olSwitch setEnabled:YES];
                               
                               NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
                               BOOL beep = [defaults boolForKey:@"beep"];
                               BOOL Vibration = [defaults boolForKey:@"viberation"];
                               
                               [self.rcp setBeep:(uint8_t)beep setVibration:(uint8_t)Vibration setIllumination:(uint8_t)0x00];
                           }
                               break;
                            case 0x00:
                               break;
                       }
                   });
}

◆AsReader Power (2)

Request

Method

- (void)setReaderPowerOnWithBeep:(uint8_t)beepOn setVibration:(uint8_t)vibrationOn setIllumination:(uint8_t)illuminationOn

Description

1. Set power of AsReader
   
2. Set beep,vibration,illumination

※Please call this method when you want to call above setting continuously.

Parameters

• beep : On (0x01) / Off (0x00)
• vibration : On (0x01) / Off (0x00)
• illumination : (0x00)

Return value

None

Response

Method

- (void)readerConnected:(uint8_t)status

Description

Please don't call other api methods until this method is called.

Parameters

• 0xFF : success
• 0X00 : failure

Return value

None

◆Start automatic reading tags operation

(Request)

Method

(BOOL)startReadTags:(uint8_t)mtnu mtime:(uint8_t)mtime repeatCycle:(uint16_t)repeatCycle

Description

Start reading tags.
Parameters show the condition of the reading stop.

Parameters

• mtnu: maximum number of tag to read
• mtime: maximum elapsed time to tagging (sec)
• repeatCycle (16-bit): Repeat cycle (how many times reader perform inventory round).

Return value

• YES : success
  
• NO : failure

Example

- (IBAction)btnRead:(UIBarButtonItem *)sender{

    if(![self.rcp isOpened])
        return;

    int stopTagCount = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopTagCount"];
    int stopTime = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopTime"];
    int stopCycle = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopCycle"];
    
    [self.rcp startReadTags:stopTagCount mtime:stopTime repeatCycle:stopCycle];
}

(Response)

Method

- (void)startedReadTags:(uint8_t)status

Parameters

• 0x00：Read Started
• 0x1F：Read Complete(when finish reading by stop condition.)

Return value

None

Example

- (void)startedReadTags:(uint8_t)status;
{
    switch (status)
    {
        case 0x00:
        {
            NSLog(@"Read Tags Started\n");
            dispatch_async(dispatch_get_main_queue(),
            ^{
                self.olBtnRead.enabled = NO;
            });
        }
            break;
        case 0x1F:
        {
            NSLog(@"Read Tags Completed\n");
            dispatch_async(dispatch_get_main_queue(),
            ^{
                self.olBtnRead.enabled = YES;
            });
        }
            break;
        default:
            break;
    }
}

◆Called when stop reading tags

Method

- (void)stoppedReadTags:(uint8_t)statusCode

Description

Called when stop reading tags

Parameters

• 0x00：Read Stopped

Return value

None

Example

- (void)stoppedReadTags:(uint8_t)statusCode{
    
    if (statusCode == 0x00) {
        dispatch_async(dispatch_get_main_queue(), ^{
            self.olBtnRead.enabled = YES;
        });
    }
}

◆Receive EPC Block (PC + EPC)

Method

- (void)pcEpcReceived:(NSData *)pcEpc

Description

Receive EPC Block(PC + EPC)

Parameters

PC + EPC

Return value

None

Example

- (void)pcEpcReceived:(NSData*)pcEpc{
    
    dispatch_async(dispatch_get_main_queue(),^{        

        NSMutableString* tag = [[NSMutableString alloc] init];
        unsigned char* ptr= (unsigned char*) [pcEpc bytes];
        for(int i = 0; i < pcEpc.length; i++)
            [tag appendFormat:@"%02X", *ptr++ & 0xFF ];            
        
        NSLog(@"PC+EPC:%@",tag);
    });
}

◆Receive EPC

Method

- (void)epcReceived:(NSData *)epc

Description

Receive EPC

Parameters

EPC

Return value

None

Example

- (void)epcReceived:(NSData *)epc{
    dispatch_async(dispatch_get_main_queue(),^{        
        NSMutableString* tag = [[NSMutableString alloc] init];
        unsigned char* ptr= (unsigned char*) [epc bytes];
        
        for(int i = 0; i < epc.length; i++)
            [tag appendFormat:@"%02X", *ptr++ & 0xFF ];
        
        [self addText:tag];
    });
}

◆Start automatic reading tags operation(RSSI)

(Request)

Method

- (BOOL)startReadTagsWithRssi:(uint8_t)mtnu mtime:(uint8_t)mtime repeatCycle:(uint16_t)repeatCycle

Description

Start reading tags with RSSI. Parameters show the condition of the reading stop.

Parameters

• mtnu: maximum number of tag to read
• mtime: maximum elapsed time to tagging (sec)
• repeatCycle (16-bit): Repeat cycle (how many times reader perform inventory round).

Return value

• YES : success
• NO : failure

Example

- (IBAction)btnRead:(UIBarButtonItem *)sender{
    if(![self.rcp isOpened])
        return;

    int stopTagCount = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopTagCount"];
    int stopTime = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopTime"];
    int stopCycle = (int)[[NSUserDefaults standardUserDefaults] integerForKey:@"stopCycle"];
    BOOL rssiOn = [[NSUserDefaults standardUserDefaults] boolForKey:@"tagRssi"];
    
    if(!rssiOn){
        [self.rcp startReadTags:stopTagCount mtime:stopTime repeatCycle:stopCycle];
    }else{
        [self.rcp startReadTagsWithRssi:stopTagCount mtime:stopTime repeatCycle:stopCycle];
    }
}

(Response)

Method

In case of ASR-030D
- (void)startedReadTagsWithRssi:(uint8_t)statusCode

In case of ASX-300R
- (void)startedReadTags:(uint8_t)status

Parameters

• 0x00：Read Started
• 0x1F：Read Complete(when finish reading by stop condition.)

Return value

None

◆Receive EPC Block(PC + EPC) with RSSI

Method

- (void)pcEpcRssiReceived:(NSData *)pcEpc rssi:(int8_t)rssi

Description

Receive EPC Block(PC + EPC) with RSSI

Parameters

Return value

なし

Example

- (void)pcEpcRssiReceived:(NSData*)pcEpc rssi:(int8_t)rssi
    
    dispatch_async(dispatch_get_main_queue(),^{        

        NSMutableString* tag = [[NSMutableString alloc] init];
        unsigned char* ptr= (unsigned char*) [pcEpc bytes];
        for(int i = 0; i < pcEpc.length; i++)
            [tag appendFormat:@"%02X", *ptr++ & 0xFF ];            
        
        NSLog(@"PC+EPC:%@ RSSI:%@",tag),[NSNumber numberWithInt:(rssi)];
    });
}

◆ Receive EPC with RSSI

Method

- (void)epcReceived:(NSData *)epc rssi:(int8_t)rssi;

Description

Receive EPC with RSSI

Parameters

Return value

None

Example

- (void)epcReceived:(NSData *)epc rssi:(int8_t)rssi{
    
    dispatch_async(dispatch_get_main_queue(),^{
        NSMutableString* tag = [[NSMutableString alloc] init];
        unsigned char* ptr= (unsigned char*) [epc bytes];
        
        for(int i = 0; i < epc.length; i++)
            [tag appendFormat:@"%02X", *ptr++ & 0xFF ];
        
        [self addText:[NSString stringWithFormat:@"%@::%@",[NSNumber numberWithInt:(rssi)],tag]];
    });
}

◆Start an automatic tag read operation(TID)

Method

- (BOOL)startReadTagsWithTid:(uint8_t)mtnu mtime:(uint8_t)mtime repeatCycle:(uint16_t)repeatCycle

Description

Start reading tags with TID. Parameters show the condition of the reading stop.

Parameters

• mtnu: maximum number of tag to read
• mtime: maximum elapsed time to tagging (sec)
• repeatCycle (16-bit): Repeat cycle (how many times reader perform inventory round).

Return value

• YES : success
• NO : failure

◆Receive EPC with TID

Method

- (void)epcReceived:(NSData *)epc rssi:(int8_t)rssi

Description

Receive EPC with TID

Parameters

Return value

None

Example

- (void)epcReceived:(NSData *)epc tid:(NSData *)tid
{
     dispatch_async(dispatch_get_main_queue(), ^{
         NSMutableString* tag = [[NSMutableString alloc] init];
         unsigned char* ptr= (unsigned char*) [epc bytes];

         NSMutableString* tidStr = [[NSMutableString alloc] init];
         unsigned char* tidPtr= (unsigned char*) [tid bytes];
         
         for(int i = 0; i < epc.length; i++)
             [tag appendFormat:@"%02X", *ptr++ & 0xFF ];
         
         for(int i = 0; i < tid.length; i++)
             [tidStr appendFormat:@"%02X", *tidPtr++ & 0xFF ];
         
         NSLog(@"%@",tidStr);
     });
}

◆Stop automatic reading tags operation

Method

- (BOOL)stopReadTags

Description

Stop automatic reading tags operation

Parameters

None

Return value

• YES : success
  
• NO : failure

Example

- (IBAction)btnStop:(UIBarButtonItem *)sender {    
       
    if(![self.rcp isOpened])
        return;

    [self.rcp stopReadTags];
}

◆Receive reader information

(Request)

Method

- (BOOL)getReaderInfo:(uint8_t)infoType

Description

Receive basic information from the reader

Parameters

• 0xB0

Return value

• YES : success
  
• NO : failure

(Response)

Method

- (void)readerInfoReceived:(NSData *)data

Description

Receive basic information from the reader.

Parameters

（in case of 300R, 301R）

（in case of 030D, 031D）

Return value

None

◆Receive current Region

(Request)

Method

- (BOOL)getRegion

Description

Receive the current region.

Parameters

None

Return value

YES : success
NO : failre

(Response)

Method

- (void)regionReceived:(uint8_t)region

Parameters

List of region code follows below.

Return value

None

◆Set Region

(Request)

Method

- (BOOL)setRegion:(uint8_t)region

Description

Set the current region

Parameters

List of region code follows below.

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetRegionReceived:(uint8_t)statusCode

Parameters

0x00 : 成功

Return value

None

◆Receive ‘Select’ parameters

(Request)

Method

- (BOOL)getSelectParam

Description

Receive ‘Select’ parameters

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)selectParamReceived:(NSData *)selParam

Parameters

Return value

None

◆Set ‘Select’ parameters

(Request)

Method

- (BOOL)setSelectParam:(uint8_t)target action:(uint8_t)action memoryBank:(uint8_t)memoryBank pointer:(uint32_t)pointer length:(uint8_t)length truncate:(uint8_t)truncate mask:(NSData *)mask;

Description

Set ‘Select’ parameters

Parameters

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetSelParamReceived:(uint8_t)statusCode

Parameters

success : 0x00

Return value

None

◆Receive current RF Channel

(Request)

Method

- (BOOL)getChannel

Description

Receive current RF Channel

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)channelReceived:(uint8_t)channel channelOffset:(uint8_t)channelOffset

Parameters

Return value

None

◆Set current RF Channel

(Request)

Method

- (BOOL)setChannel:(uint8_t)channel channelOffset:(uint8_t)channelOffset

Description

Set current RF Channel

Parameters

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetChParamReceived:(uint8_t)statusCode

Parameters

success : 0x00

Return value

None

◆Receive FH and LBT Parameters

(Request)

Method

- (BOOL)getFhLbtParam

Description

Receive FH and LBT ParametersGet FH and LBT Parameters.

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)fhLbtReceived:(NSData *)fhLb

Parameters

Return value

None

◆Set FH and LBT Parameters

(Request)

Method

- (BOOL)setFhLbtParam:(uint16_t)readTime idleTime:(uint16_t)idleTime carrierSenseTime:(uint16_t) carrierSenseTime rfLevel:(uint16_t)rfLevel frequencyHopping:(uint8_t)frequencyHopping listenBeforeTalk:(uint8_t)listenBeforeTalk continuousWave:(uint8_t)continuousWave;

Description

Set FH and LBT Parameters

Parameters

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetFhLbtReceived:(uint8_t)statusCode

Parameters

success: 0x00

Return value

None

◆Receive Tx Power Level

(Request)

Method

- (BOOL)getOutputPowerLevel

Description

Receive Tx Power Level

Parameters

None

Return value

• YES : success
  
• NO : failure

(Response)

Method

- (void)txPowerLevelReceived:(NSData*)power

Parameters

Return value

None

Example

- (void)txPowerLevelReceived:(NSData*)power{
    dispatch_async(dispatch_get_main_queue(), ^{
        
        Byte *b = (Byte*)[power bytes];
        
        power1 = (b[0] << 8) | b[1];
        powerMin = (b[2] << 8) | b[3];
        powerMax = (b[4] << 8) | b[5];
        
        self.olPowerLevel.text = [NSString stringWithFormat:@"%02.1f", (float)power1/10];        
    });
}

◆Set Tx power level.

(Request)

Method

- (BOOL)setOutputPowerLevel:(uint16_t)power

Description

Set Tx power level

Parameters

Tx Power（16bit）

Return value

• YES : success
  
• NO : failure

(Response)

Method

- (void)didSetOutputPowerLevel:(uint8_t)status

Parameters

success : 0x00

Return value

None

◆Read tag data from specified memory bank

(Request)

Method

- (BOOL)readFromTagMemory:(uint32_t)accessPassword epc:(NSData*)epc memoryBank:(uint8_t)memoryBank startAddress:(uint16_t)startAddress dataLength:(uint16_t)dataLength

Description

Read tag data from specified memory bank

Parameters

• accessPassword (32-bit): Access Password if target memory bank was password protected. Otherwise, set AP filled to 0x00000000.
• epc (variable): Target tag’s EPC
• memoryBank (8-bit): Target memory bank; RFU (0x00), EPC (0x01), TID (0x02), User (0x03)
• startAddres (16-bit): Starting Address word pointer
• dataLength (16-bit): Data Length (Word Count)

Return value

YES : success
NO : failure

(Response)

Method

- (void)tagMemoryReceived:(NSData *)data

Parameters

tag data

Return value

None

◆Write tag data to specified memory bank

(Request)

Method

- (BOOL)writeToTagMemory:(uint32_t)accessPassword epc:(NSData*)epc memoryBank:(uint8_t)memoryBank startAddress:(uint16_t)startAddress dataToWrite:(NSData*)dataToWrite

Description

Write tag data to specified memory bank

Parameters

• accessPassword (32-bit): Access Password if target memory bank was password protected. Otherwise, set AP filled to 0x00000000.
• epc (variable): Target tag’s EPC
• memoryBank (8-bit): Target memory bank; 0x00 Reserved, 0x01 EPC, 0x02 TID, 0x03 User
• startAddress (16-bit): Starting Address word pointer
• dataToWrite (variable): Data to write

Return value

YES : success
NO : failure

(Response)

Method

- (void)writedReceived:(uint8_t)statusCode

Parameters

success (0x00)

Return value

None

◆Kill Tag

(Request)

Method

- (BOOL)killTag:(uint32_t)killPassword epc:(NSData*)epc

Description

Kill tag

Parameters

• killPassword (32-bit): Kill Password. If KP filed set to 0x00000000, ‘Kill Tag’ command do not work. The target tag ignores it.
• epc (variable): Target tag’s EPC

Return value

YES : success
NO : failure

(Response)

Method

- (void)killedReceived:(uint8_t)statusCode

Parameters

success (0x00)

Return value

None

◆Lock Tag

(Request)

Method

- (BOOL)lockTagMemory:(uint32_t)accessPassword epc:(NSData*)epc lockData:(uint32_t)lockData

Description

Lock tag

Parameters

• accessPassword (32-bit): Access Password if memory bank was password protected. Otherwise, set AP filled to 0x00000000.
• epc (variable): Target tag’s EPC
• lockData (24-bit): Lock mask and action flags. Pad 4-bit zeros (dummy) to the left of 20-bit lock mask and associated action flags.

Return value

YES :success NO : failure

(Response)

Method

- (void)lockedReceived:(uint8_t)statusCode

Parameters

success (0x00)

Return value

None

◆Receive Frequency Hopping Table

(Request)

Method

- (BOOL)getFreqHoppingTable

Description

Receive Frequency Hopping Table

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)hoppingTableReceived:(NSData *)table

Parameters

• Table Size (8-bit)
• Channel Number (variable)

Return value

None

◆Set Frequency Hopping Table

(Request)

Method

- (BOOL)setFreqHoppingTable:(uint8_t)tableSize channels:(NSData*)channels

Description

Set Frequency Hopping Table

Parameters

• Table Size (8-bit)
• Channel Numbers (variable)

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetHoppintTbleReceived:(uint8_t)statusCode

Parameters

success : 0x00

Return value

None

◆Receive RSSI

(Request)

Method

- (BOOL)getRssi

Description

Receive RSSI level

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)rssiReceived:(uint16_t)rssi

Parameters

rssi: (-dBm x 10, decimal value) 

Return value

None

◆Receive battery level

Method

- (void)batteryChargeReceived:(int)battery

Description

Receive battery level

Parameters

• battery level（%）

  • can receive every 25%
  • continuously every several seconds



◆Set beep, vibration

Method

- (BOOL)setBeep:(uint8_t)beepOn setVibration:(uint8_t)vibrationOn setIllumination:(uint8_t)illuminationOn

Description

Set beep,vibration

Parameters

• ASX-300R, 301R
  • beep : On (0x01) / Off (0x00)
  • vibration : 0x00（fixed）
  • illumination : 0x00（fixed）
• ASR-030D, 031D
  • beep : On (0x01) / Off (0x00)
  • vibration : On (0x01) / Off (0x00)
  • illumination : 0x00（fixed）

◆Receive Session

(Request)

Method

- (BOOL)getSession

Description

Receive session.

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)sessionReceived:(uint8_t)session

Parameters

Session (8-bit): S0(0x00), S1(0x01), S2(0x02), S3(0x03) 

Return value

None

◆Set Session

(Request)

Method

- (BOOL)setSession:(uint8_t)session

Description

Set session

Parameters

Session (8-bit): S0(0x00), S1(0x01), S2(0x02), S3(0x03)

Return value

YES : success
NO : failure

(Response)

Method

- (void)didSetSession:(uint8_t)statusCode

Parameters

success : 0x00 

Return value

None

◆Receive Anti-Collision Mode

(Request)

Method

- (BOOL)getAnticollision

Description

Receive Anti-Collision Algorithm

Parameters

None

Return value

YES : success
NO : failure

(Response)

Method

- (void)anticolParamReceived:(uint8_t)mode start:(uint8_t)start max:(uint8_t)max max:(uint8_t)min

Parameters

• mode (8-bit): fixed Q(0x00), dynamic Q(0x01)
• start (8-bit)
• max (8-bit)
• min (8-bit)  #### Return value None
  

◆Set Anti-Collision Mode

in case of ASX-300R, 301R

Method

- (BOOL)setAnticollision:(uint8_t)mode

Description

Set Anti-collision algorithm

Parameters

• 0x00 : Anti-Collision Mode 0
  • Default mode
  • Fixed Q (default 4)
  • Re-read tags every inventory round
• 0x01 : Anti-Collision Mode 1
  
  • Fixed Q (default 4)
  • Use session 1

• 0x02 : nti-Collision Mode 2

  • Fixed Q (default 4)
  • Use Session 2

• 0x03 : Anti-Collision Mode 3

  • Dynamic Q, Use Session 2
  • When the collision occurred, increase the Q value
  • This algorithm is not suitable to read small tags

• 0x04 : Anti-Collision Mode 4
  • Dynamic Q, Session 2
  • Example slot-count(Q) selection algorithm of EPC Gen 2 (Annex D)
  • Qpf : floating-point representation of Q
  • C : 0.1 < C < 0.5 (Phychips uses fixed 0.3 for C value)
  • When Q is large : use small value of C
  • When Q is small : use large value of C

• 0x05 : Anti-Collision Mode 5
  • Dynamic Q, Session 2
  • If the number of collided slots is more than the number of no reply slots, Increase the Q value.
  • Otherwise, decrease Q value.

• 0x06 : Anti-Collision Mode 6
  • Dynamic Q, Session 2
  • If the number of collided slots is more than half of entire slots, increase Q value.
  • Otherwise, decrease Q value.

in case of ASR-030D, 031D

Method

- (BOOL)setAnticollision:(uint8_t)mode qStart:(uint8_t)qStart qMax:(uint8_t)qMax qMin:(uint8_t)qMin

Description

Set Anti-collision algorithm

Parameters

mode

• 0x00 : fixed Q

  • Default mode
  • Fixed Q (default 4)
  • Re-read tags every inventory round

• 0x01 : dynamic

  • Dynamic Q, Session 2
  • If the number of collided slots is more than the number of no reply slots, Increase the Q value.
  • Otherwise, decrease Q value.

qStart(8-bit) : Q Start

qMax(8-bit) : Q Max

qMin(8-bit) : Q Min

◆Receive Anti-Collision Mode

Request

Method

- (BOOL)getAnticollision

Description

Receive Anti-Collision Algorithm

Parameters

None

Return value

YES : success
NO : failure

Response(in case of ASR-030D, 031D)

Method

- (void)anticolParamReceived:(uint8_t)mode start:(uint8_t)start max:(uint8_t)max max:(uint8_t)min

Parameters

• mode (8-bit): fixed Q(0x00), dynamic Q(0x01)
• start (8-bit)
• max (8-bit)
• min (8-bit) 

Return value

None

Response(in case of ASX-300R, 301R)

Method

- (BOOL)setAnticollision:(uint8_t)mode;

Parameters

• mode (8-bit): Anti-collision Mode  #### Return value None
  

◆Update Registry

(Request)

Method

- (BOOL)updateRegistry

Description

Set Registry Update function

（Excluding some settings like setBeep...）

Parameters

None

Return value

• YES : success
  
• NO : failure

(Response)

Method

- (void)updatedRegistry:(uint8_t)statusCode

Parameters

success : 0x00

Return value

None

◆Received error code

in case of 300R, 301R

Method

- (void)errReceived:(uint8_t)errCode

Description

Receive error code

Parameters

Error codes (8-bit)

• 0x09 : Failure to read the tag memory
• 0x10 : Failure to write data
• 0x0B : ‘Read Type C Tag ID Multiple’ in Operation
• 0x0D : Not in mode ‘Read Type C Tag ID Multiple’
• 0x0E : Invalid parameter
• 0x12 : Failure to kill a tag
• 0x13 : Failure to lock a tag
• 0x15 : Failure to read a tag
• 0x18 : Not supported command
• 0xFF : CRC Error

Return value

None

in case of 030D, 031D

Method

- (void)errDetailReceived:(NSData *)errCode

Description

Receive error code

Parameters

Error code (8-bit)

• 0x01 : Failure of Reader power control
• 0x02 : Failure of Reader control
• 0x03 : Failure to get the Reader Information
• 0x07 : Failure to get region
• 0x08 : Failure to set region
• 0x09 : Failure to read the tag memory
• 0x0A : Failure of automatic read operation
• 0x0B : Automatic read in operation
• 0x0C : Cannot stop automatic read
• 0x0D : Not in automatic read mode
• 0x0E : Invalid parameter
• 0x10 : Failure to write data
• 0x11 : Failure to erase data
• 0x12 : Failure to kill a tag
• 0x13 : Failure to lock a tag
• 0x15 : No tag detected
• 0x17 : Not supported command
• 0x18 : Undefined command
• 0x19 : Failure to reset Reader
• 0xFF : CRC error

Sub Error code (8-bit)

• 0x01 : Not supported
• 0x02 : Insufficient privileges
• 0x03 : Memory overrun
• 0x04 : Memory locked
• 0x05 : Crypto suite error
• 0x06 : Command not encapsulated
• 0x07 : ResponseBuffer overflow
• 0x08 : Security timeout
• 0x0B : Insufficient power
• 0x0F : Non-specific error
• 0x11 : Sensor Scheduling configuration
• 0x12 : Tag Busy
• 0x13 : Measurement type not supported
• 0x80 : No tag detected
• 0x81 : Handle acquisition failure
• 0x82 : Access password failure
• 0x90 : CRC error
• 0x91 : Registry erase failure
• 0xA1 : SPI failure
• 0xA2 : Rx Timeout
• 0xB1 : Registry update failure
• 0xB2 : Registry write failure
• 0xA0 : Registry not exist
• 0xA3 : UART failure
• 0xB0 : I2C failure
• 0xB3 : GPIO failure
• 0xE0 : Not supported command
• 0xE1 : Undefined command
• 0xE2 : Invalid parameter
• 0xE3 : Too high parameter
• 0xE4 : Too low parameter
• 0xE5 : Failure automatic read operation
• 0xE6 : Not automatic read mode
• 0xE7 : Failure to get last response
• 0xE8 : Failure to control test
• 0xE9 : Failure to reset Reader
• 0xEA : Rfidblock control failure

Return value

None