SDK Manual for Barcode

ASX-510R

ASX-520R

ASR-010D

ASR-020D

SDK Manual 2015-11-13      

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-510R,520R：jp.co.asx.asreader.barcode
• ASR-010D,020D：jp.co.asx.asreader.6dongle.barcode

Play AsReader

• Import RcpBarcodeApi.h

  #import "RcpBarcodeApi.h"

• Implement RcpBarcodeDelegate

  @interface AsReaderViewController ()<RcpBarcodeDelegate,RcpRfidDelegate>

• Initialize RcpBarcodeApi

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

• Implement RcpBarcodeDelegate

- (void)pluggedBarcode:(BOOL)plug{
    if(plug){
        if([self.rcp isOpened]){
            dispatch_async(dispatch_get_main_queue(),^{

                _statusLabel.text = @"Plugged";
                [self.rcp open];
                [self.rcp setReaderPowerOnWithBeep:false setVibration:true setIllumination:true];
            });
        }
    }else{
        dispatch_async(dispatch_get_main_queue(),^{
            _statusLabel.text = @"Unplugged";
            [self.rcp setReaderPower:NO];
            [self.rcp 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)pluggedBarcode:(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

Switch Power of AsReader.

Parameters

Yes : ON

No : OFF

Return value

YES : success

NO : failure

Response(in case of 010D,020D)

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

- (void)pluggedBarcode:(BOOL)plug{
    if(plug){
        if([self.rcp isOpened]){
            dispatch_async(dispatch_get_main_queue(),^{
                [self.rcp open];
                [self.rcp setReaderPower:YES];
            });
        }
    }else{
        dispatch_async(dispatch_get_main_queue(),^{
            [self.rcp setReaderPower:NO];
            [self.rcp close];
        });
    }
}

- (void)readerConnected:(uint8_t)status
{
    dispatch_async(dispatch_get_main_queue(),
                   ^{
                       switch (status)
                       {
                           case 0xff:
                           {
                               [self.rcp setBeep:0x01 setVibration:0x01 setIllumination:0x01];
                           }
                               break;
                            case 0x00:
                               break;
                       }
                   });
}

Response(in case of ASX-510R、ASX-520R)

Description

In case of ASX-510R,ASX-520R
There is no response of setReaderPower.
Please call other api methods after 0.5 seconds or more when this method was called.

◆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 : On (0x01) / Off (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 Reading barcodes

Method

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

Description

AsReader starts reading barcodes.

Parameters

• mtnu : 0x00
• mtime : 0x00
• repeatCycle : 0x00

Return value

• YES : success
• NO : failure

◆Get barcode value (NSData)

Method

- (void)barcodeReceived:(NSData *)barcode

Description

Get read barcode value

Parameters

barcode value (NSData)

Return value

None

Example

- (void)barcodeReceived:(NSData *)barcode{
    dispatch_async(dispatch_get_main_queue(), ^{        
        NSString *value = [[NSString alloc]initWithData:barcode encoding:NSShiftJISStringEncoding];
        [self addText:value];
    });
}

◆Get barcode value (NSString)

Method

- (void)barcodeStringReceived:(NSString *)barcode

Description

Get read barcode value

Parameters

barcode value (NSString)

Return value

None

Example

- (void)barcodeStringReceived:(NSString *)barcode{
    dispatch_async(dispatch_get_main_queue(), ^{
        [self addText:barcode];
    });
}

◆Stop reading barcodes

Method

- (BOOL)stopReadBarcodes

Description

stop reading barcodes

Parameters

None

Return value

• YES : success
• NO : failure

◆Receive battery level

Method

- (void)batteryChargeReceived:(int)battery

Description

Receive battery level

Parameters

• battery level（%）

  • can receive every 25%
  • continuously every several seconds



◆Settings of beep,viberation,illumination

Method

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

Description

set beep,viberation,illumination

Parameters

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