IDBLUE logo
Public Member Functions
IDBlueUhfApi Class Reference
Inheritance diagram for IDBlueUhfApi:
IDBlueCoreApi <IUhfResponseHandler> ResponseHandler <ISessionHandler> <IResponseHandler> <IResponseHandler>

Public Member Functions

(SendStatus *) - epcRead:withAddr:withNumWords:withHandler:
(SendStatus *) - epcRead:withAddr:withNumWords:
(SendStatus *) - epcWrite:withAddr:withNumWords:withData:withHandler:
(SendStatus *) - epcWrite:withAddr:withNumWords:withData:
(SendStatus *) - epcLock:withHandler:
(SendStatus *) - epcLock:
(SendStatus *) - epcKill:withHandler:
(SendStatus *) - epcKill:
(SendStatus *) - epcSetKillPassword:withHandler:
(SendStatus *) - epcSetKillPassword:
(SendStatus *) - epcWriteTagId:withHandler:
(SendStatus *) - epcWriteTagId:

Detailed Description

IDBlueUhfApi is used to issue EPC Gen 2 (UHF) commands to IDBLUE


Member Function Documentation

- (SendStatus *) epcKill: (CByteArray*)  password

epcKill -

Kill an EPC Gen 2 RFID tag

Parameters:
password
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcKill: (CByteArray*) password { SendStatus status = nil; status = [api epcKill: password withHandler: self]; if ([status successful]) { } else { } }

-(void) epcKillResponse: (IDBlueCommand*) command withResponse: (EpcKillResponse*) response { }

-(void) epcKillFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcKill: (CByteArray*)  password
withHandler: (id<IUhfResponseHandler>)  handler 

epcKill -

Kill an EPC Gen 2 RFID tag

Parameters:
password
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcKill: (CByteArray*) password { SendStatus status = nil; status = [api epcKill: password withHandler: self]; if ([status successful]) { } else { } }

-(void) epcKillResponse: (IDBlueCommand*) command withResponse: (EpcKillResponse*) response { }

-(void) epcKillFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcLock: (uint)  lockbits

epcLock -

Lock portions of an EPC Gen 2 RFID tag

Parameters:
lockbitsThe payload of the EPCGlobal UHF Class 1 Gen 2 Standard Lock command. Only the least significant 20 bits are used, so lockbits cannot be larger than 0x0FFFFF. See the EPCGlobal UHF Class 1 Gen 2 Standard to determine the appropriate value of lockbits.
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcLock: (uint) lockbits { SendStatus status = nil; status = [api epcLock: lockbits withHandler: self]; if ([status successful]) { } else { } }

-(void) epcLockResponse: (IDBlueCommand*) command withResponse: (EpcLockResponse*) response { }

-(void) epcLockFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcLock: (uint)  lockbits
withHandler: (id<IUhfResponseHandler>)  handler 

epcLock -

Lock portions of an EPC Gen 2 RFID tag

Parameters:
lockbitsThe payload of the EPCGlobal UHF Class 1 Gen 2 Standard Lock command. Only the least significant 20 bits are used, so lockbits cannot be larger than 0x0FFFFF. See the EPCGlobal UHF Class 1 Gen 2 Standard to determine the appropriate value of lockbits.
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcLock: (uint) lockbits { SendStatus status = nil; status = [api epcLock: lockbits withHandler: self]; if ([status successful]) { } else { } }

-(void) epcLockResponse: (IDBlueCommand*) command withResponse: (EpcLockResponse*) response { }

-(void) epcLockFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcRead: (EpcMemoryBank)  bank
withAddr: (byte)  addr
withNumWords: (byte)  numWords 

epcRead -

Read data from an EPC Gen 2 RFID tag

Parameters:
bank
addr
numWords
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcRead: (EpcMemoryBank) bank withAddr: (byte) addr withNumWords: (byte) numWords { SendStatus status = nil; status = [api epcRead: bank withAddr: addr withNumWords: withHandler: self]; if ([status successful]) { } else { } }

-(void) epcReadResponse: (IDBlueCommand*) command withResponse: (EpcReadTagResponse*) response { }

-(void) epcReadFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcRead: (EpcMemoryBank)  bank
withAddr: (byte)  addr
withNumWords: (byte)  numWords
withHandler: (id<IUhfResponseHandler>)  handler 

epcRead -

Read data from an EPC Gen 2 RFID tag

Parameters:
bank
addr
numWords
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcRead: (EpcMemoryBank) bank withAddr: (byte) addr withNumWords: (byte) numWords { SendStatus status = nil; status = [api epcRead: bank withAddr: addr withNumWords: withHandler: self]; if ([status successful]) { } else { } }

-(void) epcReadResponse: (IDBlueCommand*) command withResponse: (EpcReadTagResponse*) response { }

-(void) epcReadFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful

epcSetKillPassword -

Set the kill password of an EPC Gen 2 RFID tag

Parameters:
password
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcSetKillPassword: (CByteArray*) password { SendStatus status = nil; status = [api epcSetKillPassword: password withHandler: self]; if ([status successful]) { } else { } }

-(void) epcSetKillPasswordResponse: (IDBlueCommand*) command withResponse: (EpcSetKillPasswordResponse*) response { }

-(void) epcSetKillPasswordFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcSetKillPassword: (CByteArray*)  password
withHandler: (id<IUhfResponseHandler>)  handler 

epcSetKillPassword -

Set the kill password of an EPC Gen 2 RFID tag

Parameters:
password
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcSetKillPassword: (CByteArray*) password { SendStatus status = nil; status = [api epcSetKillPassword: password withHandler: self]; if ([status successful]) { } else { } }

-(void) epcSetKillPasswordResponse: (IDBlueCommand*) command withResponse: (EpcSetKillPasswordResponse*) response { }

-(void) epcSetKillPasswordFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcWrite: (EpcMemoryBank)  bank
withAddr: (byte)  addr
withNumWords: (byte)  numWords
withData: (CByteArray*)  data 

epcWrite -

Write data to an EPC Gen 2 RFID Tag

Parameters:
bank
addr
numWords
data
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcWrite: (EpcMemoryBank) bank withAddr: (byte) addr withNumWords: (byte) numWords withData:(CByteArray*) data { SendStatus status = nil; status = [api epcWrite: bank withAddr: addr withNumWords: numWords withData: data withHandler: self]; if ([status successful]) { } else { } }

-(void) epcWriteResponse: (IDBlueCommand*) command withResponse: (EpcWriteTagResponse*) respons { }

-(void) epcWriteFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
- (SendStatus *) epcWrite: (EpcMemoryBank)  bank
withAddr: (byte)  addr
withNumWords: (byte)  numWords
withData: (CByteArray*)  data
withHandler: (id<IUhfResponseHandler>)  handler 

epcWrite -

Write data to an EPC Gen 2 RFID Tag

Parameters:
bank
addr
numWords
data
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcWrite: (EpcMemoryBank) bank withAddr: (byte) addr withNumWords: (byte) numWords withData:(CByteArray*) data { SendStatus status = nil; status = [api epcWrite: bank withAddr: addr withNumWords: numWords withData: data withHandler: self]; if ([status successful]) { } else { } }

-(void) epcWriteResponse: (IDBlueCommand*) command withResponse: (EpcWriteTagResponse*) respons { }

-(void) epcWriteFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful

epcWriteTagId -

Writes the EPC identifier to the EPC Gen 2 RFID tag

Parameters:
tag
Remarks:
Handlers registered with addResponseHandler will receive response notifications.

For example:

IDBlueUhfApi* api; -(void) epcWriteTagId: (RfidTag*) tag { SendStatus status = nil; status = [api epcWriteTagId: tag withHandler: self]; if ([status successful]) { } else { } }

-(void) epcWriteResponse: (IDBlueCommand*) command withResponse: (EpcWriteTagResponse*) respons { }

-(void) epcWriteFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
Remarks:
epcWriteTagId is a wrapper around epcWrite, specifying the address of the EPC location on the tag
- (SendStatus *) epcWriteTagId: (RfidTag*)  tag
withHandler: (id<IUhfResponseHandler>)  handler 

epcWriteTagId -

Writes the EPC identifier to the EPC Gen 2 RFID tag

Parameters:
tag
handlerAn object implementing IUhfResponseHandler that will receive response notifications.
Remarks:
The given IResponseHandler will be notified of responses, along with any handlers registered with the addResponseHandler method

For example:

IDBlueUhfApi* api; -(void) epcWriteTagId: (RfidTag*) tag { SendStatus status = nil; status = [api epcWriteTagId: tag withHandler: self]; if ([status successful]) { } else { } }

-(void) epcWriteResponse: (IDBlueCommand*) command withResponse: (EpcWriteTagResponse*) respons { }

-(void) epcWriteFailed: (IDBlueCommand*) command withResponse: (NackResponse*) response { }

Returns:
A SendStatus indicating if the send was successful
Remarks:
epcWriteTagId is a wrapper around epcWrite, specifying the address of the EPC location on the tag

The documentation for this class was generated from the following files:

 

Generated on Mon Jan 19 2015 15:47:40
Copyright © 2015 Cathexis Innovations Inc. All Rights Reserved.