ASX series ASR series RFID DK Manual

ASX series ASR series RFID DK Manual
AsReader SDK Manual
ASX series
ASR series
RFID
DK Manual
1/1
AsReader SDK Manual
Notice
Update: 7 Sep 2015 : Support ASR series
© 2015 Asterisk, Inc. All rights reserved.
This user guide is made by Asterisk, Inc. and protected by copyright.
1/19
AsReader SDK Manual
1.Install SDK
• Add Framework
Add the below framework project
・ExternalAccessory.framework
• Add AsReader SDK
Click TARGETS -> Build phases -> Link Binary With Libraries Add Other
!
2/19
AsReader SDK Manual
Select and Open libAreteUart.a
Add the below files into the projects
・Eas.h
・UartMgr.h
・RcpBarcodeApi.h
・RcpRfidApi.h
• Set your project to support protocol of AsReader
Add the followings to Supported external accessory protocols
ASX-300R: jp.co.asx.asreader.rfid ASX-03xD: jp.co.asx.asreader.6dongle.rfid
3/19
AsReader SDK Manual
• Use AsReader
• Import RcpRfidApi.h
• Implement RcpRfidDelegate protocol
• Initialize RcpRfidApi and set Delegate
•
4/19
AsReader SDK Manual
1.2 APIs
1.2.1 Overview
API classes are layered as shown below.
View Controller
Call ↓↑delegate
RcpRfidApi
Call ↓↑delegate
UartMgr
Call ↓↑call back
External Accessary
Framework
1.2.2 API methods
Method
- (id)init
Description
Returns a newly initialized API.
Parameters
none
Return Value A newly initialized API object.
Method
- (BOOL)open
Description
Connection to the external device is started.
Parameters
none
Return Value
YES: Success
NO: Failure
Method
- (BOOL)isOpened
Description
Returns a Boolean value that indicating whether external device is connected.
Parameters
none
Return Value
YES: Start
NO: Not start
Method
Description
- (BOOL) setReaderPower :(BOOL)on;
Switch the power of AsReader
Parameters
YES: On
NO: Off
Return Value
YES: Success
NO: Failure
5/19
AsReader SDK Manual
Method
- (BOOL)startReadTags:(uint8_t)mtnu
mtime:(uint8_t)mtime
repeatCycle:(uint16_t)repeatCycle
Description
Start to read tags continuously
Parameters
Read tags until the blow settings;
mtnu: maximum number of tags
mtime: time (second)
repeatCycle: the number of times of Inventory round
Return Value
YES: Success
NO: Failure
Method
- (BOOL)startReadTagsWithRssi:(uint8_t)mtnu
mtime:(uint8_t)mtime repeatCycle:(uint16_t)repeatCycle
Description
Start to read tags continuously (with RSSI)
Parameters
Read tags until the blow settings;
mtnu: maximum number of tags
mtime: time (second)
repeatCycle: the number of times of Inventory round
Return Value
YES: Success
NO: Failure
Method
- (BOOL)stopReadTags
Description
Stop continuous reading
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)startedReadTags:(uint8_t)status
Description
Get the status of startReadTags running
Parameters
status
0x00: Start continuous reading
0x1F: Stop continuous reading
Return Value
Method
none
@optional
- (void)pcEpcReceived:(NSData *)pcEpc
Description
Parameters
Return Value
Get PC and EPC from the reading tag
PC + EPC
none
6/19
AsReader SDK Manual
Method
@optional
- (void)pcEpcRssiReceived:(NSData *)pcEpc rssi:(int8_t)rssi
Description
Get PC, EPC and RSSI from the reading tag
Parameters
pcEpc: PC + EPC
rssi: RSSI (dBm)
Return Value
Method
none
- (BOOL)getRegion
Description
Send command to get the current Region
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)regionReceived:(uint8_t)region
Description
Parameters
Return Value
Method
Description
Get region
- Korea (0x11)
- US (0x21)
- Europe (0x31)
- Japan (0x41)
- China1 (0x51)
- China2 (0x52)
none
- (BOOL)setRegion:(uint8_t)region
Send command to set Region
Parameters
- Korea (0x11)
- US (0x21)
- Europe (0x31)
- Japan (0x41)
- China1 (0x51)
- China2 (0x52)
Return Value
YES: Success
NO: Failure
7/19
AsReader SDK Manual
Method
@optional
- (void)setedRegionReceived:(uint8_t)statusCode;
Description
Parameters
Return Value
Method
Description
Integrate when setRegion method is succeed
- Success: 0x00
none
- (BOOL)getReaderInfo:(uint8_t)infoType
Send command to get information of AsReader
Parameters
- MODEL(0x00)
- SN(0x01)
- STATUS(0xB0)
- INFO(0xB1)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)readerInfoReceived:(NSData *)data
Description
Parameters
Get information of AsReader
Information demanded by the getReaderInfo method
Return Value
none
Method
- (BOOL)getSelectParam
Description
Send command to get parameter of “Select”
Parameters
Return Value
none
YES: Success
NO: Failure
Method
@optional
- (void)selectParamReceived:(NSData *)selParam
Description
Get select parameter
Parameters
- Target (3-bit): S0 (000), S1 (001), S2 (010), S3 (011), SL (100)
- Action (3-bit): Refer to ISO18000-6C
- Memory Bank (2-bit): 00 RFU, 01 EPC, 10 TID, 11 User
- Pointer (32-bit): start position of mask address
- Length (8-bit): length of mask
- Truncate (1-bit): Enable (1) and Disable (0)
- Reserve (7-bit): Reserved 0000000 value should be placed here.
- Mask (0~255 bits): Mask value
Return Value
none
8/19
AsReader SDK Manual
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
Send command to set ‘Select’ parameter
Parameters
- target: S0 (0), S1 (1), S2 (2), S3 (3), SL (4)
- action: Refer to ISO18000-6C
- memoryBank: RFU (0), EPC (1), TID (2), User (3)
- pointer: the start position of mask
- length: the length of mask
- truncate: Enable (1) and Disable (0)
- mask: Mask value
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedSelParamReceived:(uint8_t)statusCode;
Description
Integrate when setSelectParam method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)getQueryParam
Description
Send command to get ‘Query’ parameter
Parameters
Return Value
none
YES: Success
NO: Failure
Method
@optional
- (void)queryParamReceived:(NSData *)qryParam
Description
Get ‘Query’ parameter
Parameters
- DR (1-bit): DR=8 (0), DR=64/3 (1)
- M (2-bit): M=1 (00), M=2 (01), M=4 (10), M=8 (11)
- TRext (1-bit): without pilot tone(0), with pilot tone(1)
- Sel (2-bit): All (00 or 01), ~SL (10), SL (11)
- Session (2-bit): S0 (00), S1 (01), S2 (10), S3 (11)
- Target (1-bit): A (0), B (1)
- Q (4-bit): 0-15; the number of slots in the round.
Return Value
none
9/19
AsReader SDK Manual
Method
- (BOOL)setQueryParam:(uint8_t)dr
m:(uint8_t)m
trext:(uint8_t)trext
sel:(uint8_t)sel
session:(uint8_t)session
target:(uint8_t)target
q:(uint8_t)q
Description
Send command to set ‘Query’ parameter
Parameters
- dr: DR=8 (0), DR=64/3 (1)
- m: M=1 (0), M=2 (1), M=4 (2), M=8 (3)
- trext: without pilot tone(0), with pilot tone(1)
- sel: All (0 or 1), ~SL (2), SL (3)
- session (2-bit): S0 (0), S1 (1), S2 (2), S3 (3)
- target (1-bit): A (0), B (1)
- q: 0-15: the number of slots in the round.
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedQueryParamReceived:(uint8_t)statusCode;
Description
Integrate when setQueryParam method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)getChannel
Description
Send command to get frequency channel
Parameters
none
Return Value
YES: Success
NO: Failure
Method
Description
Parameters
@optional
- (void)channelReceived:(uint8_t)channel
channelOffset:(uint8_t)channelOffset
Receive channel
- channel: Channel number
- channelOffset: channel offset for miller subcarrier.
Return Value none
10/19
AsReader SDK Manual
Method
Description
- (BOOL)setChannel:(uint8_t)channel
channelOffset:(uint8_t)channelOffset
Send command to set channel
Parameters
- channel: channel number the width of channel number relys on the region
setting.
- channelOffset: channel offset for miller subcarrier.
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedChParamReceived:(uint8_t)statusCode;
Description
Integrate when setChannel method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)getFhLbtParam
Description
Send command to get FH(frequency hopping) and LBT(Listen Before Talk)
parameter
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)fhLbtReceived:(NSData *)fhLb
Description
Get FH and LBT parameter
Parameters
- RT (16-bit): Read Time (1 = 1ms)
- IT (16-bit): Idle Time (1 = 1ms)
- CST (16-bit): Carrier Sense Time (1 = 1ms)
- RFL (16-bit): Target RF power level (-dBm x 10)
- FH (8-bit): enable (0x01) / disable (0x00)
- LBT (8-bit): enable (0x01) / disable (0x00)
- CW (8-bit): enable (0x01) / disable (0x00)
Return Value
none
11/19
AsReader SDK Manual
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
- RT (16-bit): Read Time (1 = 1ms)
- IT (16-bit): Idle Time (1 = 1ms)
- CST (16-bit): Carrier Sense Time (1 = 1ms)
- RFL (16-bit): Target RF power level (-dBm x 10)
- FH (8-bit): enable (0x01) / disable (0x00)
- LBT (8-bit): enable (0x01) / disable (0x00)
- CW (8-bit): enable (0x01) / disable (0x00)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedFhLbtReceived:(uint8_t)statusCode;
Description
Integrate when setFhLbtParam method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)getOutputPowerLevel
Description
Send command to get output power level
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)txPowerLevelReceived:(uint8_t)power
Description
Parameters
Return Value
Method
Description
Get the current output power level
power : output power level (dBm x 10)
none
- (BOOL)setOutputPowerLevel:(uint16_t)power
Send command to set output power level
Parameters
power : output power level (dBm x 10)
Return Value
YES: Success
NO: Failure
12/19
AsReader SDK Manual
Method
@optional
- (void)setedTxPwrReceived:(uint8_t)statusCode;
Description
Integrate when setOutputPowerLevel method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)setRfCw:(uint8_t)on
Description
Send command to set ON/OFF for CW(continuous wave) signal
Enable when idol mode
Parameters
- On (0xFF)
- Off (0x00)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedCwReceived:(uint8_t)statusCode;
Description
Integrate when setRfCw method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)readFromTagMemory:(uint32_t)accessPassword
epc:(NSData*)epc
memoryBank:(uint8_t)memoryBank
startAddress:(uint16_t)startAddress
dataLength:(uint16_t)dataLength;
Description
Send command from the memory bank to read tags.
Parameters
- accessPassword: if password is not set, the value is 0x00000000.
- EPC: EPC of the tag
- memoryBank:the memory bank; RFU (0x00), EPC (0x01), TID (0x02), User
(0x03)
- startAddress: start address
- dataLength: data length (Word Count)
Return Value
YES: Success
NO: Failure
13/19
AsReader SDK Manual
Method
@optional
- (void)tagMemoryReceived:(NSData *)data
Description
Get tags from selected memory bank
Parameters
contents in memory
Return Value
none
Method
- (BOOL)getFreqHoppingTable
Description
Send command to get the current frequency hopping table
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)hoppingTableReceived:(NSData *)table
Description
Get the frequency hopping table
Parameters
- Table size (8-bit)
- Channel number (variable)
Return Value
none
Method
- (BOOL)setFreqHoppingTable:(uint8_t)tableSize
channels:(NSData*)channels;
Description
Send command to set the frequency hopping table
Parameters
- table size (8-bit)
- Channel number (valuable)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)setedHoppintTbleReceived:(uint8_t)statusCode;
Description
Integrate when setFreqHoppingTable method is succeed
Parameters
- Success (0x00)
Return Value
none
14/19
AsReader SDK Manual
Method
- (BOOL)writeToTagMemory:(uint32_t)accessPassword
epc:(NSData*)epc
memoryBank:(uint8_t)memoryBank
startAddress:(uint16_t)startAddress
dataToWrite:(NSData*)dataToWrite;
Description
Send command to write onto the tag
Parameters
-
Password (32-bit): if password is not set, the value is 0x00000000.
EPC length of the tag (16-bit)
EPC of the tag (valuable)
The memory bank (8-bit): 0x00 Reserved, 0x01 EPC, 0x02 TID, 0x03 User
start position of word pointer (16-bit)
the length of writing data (word count) (16-bit)
Writing data (valuable)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)writedReceived:(uint8_t)statusCode;
Description
Integrate when writeToTagMemory method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)killTag:(uint32_t)killPassword epc:(NSData*)epc
Description
Send command to kill tag
Parameters
- Kill password (32-bit): if 0x00000000, command will not run.
- EPC length of the tag (16-bit)
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)killedReceived:(uint8_t)statusCode;
Description
Integrate when killTag method is succeed
Parameters
- Success (0x00)
Return Value
none
15/19
AsReader SDK Manual
Method
Description
Parameters
Return Value
- (BOOL)lockTagMemory:(uint32_t)accessPassword
epc:(NSData*)epc
lockData:(uint32_t)lockData
Send command to lock the tag
-
Password (32-bit): if password is not set, the value is 0x00000000.
EPC length of the tag (16-bit)
EPC of the tag(variable)
Lock mask and action flag (24-bit): Set 0 on the first 4bits and the lest of 20 bits
are Lock mask and action flag
YES: Success
NO: Failure
Method
@optional
- (void)lockedReceived:(uint8_t)statusCode;
Description
Integrate when lockTagMemory method is succeed
Parameters
- Success (0x00)
Return Value
none
Method
- (BOOL)getRssi
Description
Send command to get RSSI level
Parameters
none
Return Value
YES: Success
NO: Failure
Method
@optional
- (void)rssiReceived:(uint16_t)rssi
Description
Get RSSI level
Parameters
RSSI: dBm x -10
Return Value
None
Method
- (void)adcReceived:(NSData*)data
Description
Get ADC value
Parameters
- current value (8-bit)
- the minimum value of ADC (8-bit)
- the maximum value of ADC (8-bit)
Return Value none
16/19
AsReader SDK Manual
Method
Description
Parameters
- (BOOL)setBeep:(uint8_t)on
setVibration:(uint8_t)vibrationOn
setIllumination:(uint8_t)illuminationOn;
Turn on or off beep
- On (0x01)
- Off (0x00)
300R: Ignore Vibration and illumination
030D: Ignore illumination
Return Value
YES: Success
NO: Failure
Method
- (void)batteryChargeReceived:(int)battery
Description
Get the battery status of AsReader (SDK Ver.2.2.0
Parameters
- Battery remaining (%)
)
Return Value none
17/19
AsReader SDK Manual
Method
- (BOOL)setAnticollision:(uint8_t)mode
Description
Set Anti-collision (For ASX-30xR)
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
• Anti-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 • Quickly resolve collision
‒ This algorithm is not suitable to read small tags
0x04
• Anti-Collision Mode 4 ‒ Dynamic Q, Session 2
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 the 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
Return Value
YES: Success
NO: Failure
18/19
AsReader SDK Manual
Method
- (BOOL)setAnticollision:(uint8_t)mode qStart:(uint8_t)
qStart qMax:(uint8_t)qMax qMin:(uint8_t)qMin
Description
Set Anti-collision (ASR-03xD)
Parameters
- fixed Q(0x00), dynamic Q(0x01) - Q Start (8-bit)
- Q Max (8-bit)
- Q Min (8-bit)
* if fixed, Q is fixed as 4
Return Value
YES: Success
NO: Failure
19/19
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising