Nedap.HandheldApi
|
Session layer interface: low-level communication layer interface that can be used to communicate with Handheld Reader. More...
Public Member Functions | |
bool | BarcodeHasReader () |
Check to see if the handheld reader has a barcode reader on-board. | |
void | BarcodeSetStatusForType (Nedap.HandheldApi.BarcodeType barcodeType, bool enabled) |
Enables or disable a certain type of barcode. | |
void | BarcodeTryDecode (int duration) |
Try to read a barcode for a defined number of seconds. | |
void | Dispose () |
Disposes private objects. | |
void | HandheldDisconnect () |
Will let the handheld kill the bluetooth connection. Can be used to pair the handheld with another device. | |
void | HandheldGetBatteryPercentage () |
Returns the current battery status in percentage. | |
DeviceInfo | HandheldGetInformation () |
Get information on the handheld. | |
bool | HandheldIsConnected () |
Checks if the handheld is connected or not. | |
void | NfcTryToReadCard () |
The handheld will try to read a NFC card. | |
void | RfidGetSupportedRegions () |
Gets the supported regions by the handheld reader. | |
void | RfidReadData (Nedap.HandheldApi.RfidEpcMemoryBank memoryBank, int addressInWords, int lengthInWords, int timeout, int power, Nedap.HandheldApi.Select select, Nedap.HandheldApi.Password password) |
Will read specific data from a RFID tag. | |
void | RfidReadEpcs (int timeout, int power, Nedap.HandheldApi.Select select) |
Will read RFID tags in the field, for a specified duration, with a specific power and with a select to select a subset of tags. | |
void | RfidSetCWSignal (bool enabled, int antenna) |
Enables Continuous Wave (CW) signal, used for testing and measurement purposes. | |
void | RfidSetFrequencyHopTable (System.Collections.Generic.List< Nedap.HandheldApi.RfidFrequency > frequencies) |
Set frequency hop table. | |
void | RfidSetMValue (Nedap.HandheldApi.RfidEpcMValue mValue) |
Sets the miller value for the EPC Gen2 protocol. | |
void | RfidSetQValue (int qValue, bool dynamic) |
Sets the Q value for the EPC Gen2 protocol. | |
void | RfidSetRegion (Nedap.HandheldApi.RfidRegion region) |
Sets the region that the handheld reader operates in. The supported regions can be obtained by using +(void)rfidGetSupportedRegions. | |
void | RfidSetSession (Nedap.HandheldApi.RfidEpcSession session) |
Sets the session for the EPC Gen2 protocol. | |
void | RfidSetTarget (Nedap.HandheldApi.RfidEpcTarget target, bool toggle) |
Sets the target for the EPC Gen2 protocol. | |
void | RfidWriteData (byte[] dataToWrite, Nedap.HandheldApi.RfidEpcMemoryBank memoryBank, int addressInWords, int timeout, int power, Nedap.HandheldApi.Select select, Nedap.HandheldApi.Password password) |
Write data to a specified memory bank and address in a tag. | |
void | RfidWriteEpc (Nedap.EPC.TDT.EpcCode epc) |
Writes a new EPC code to a tag. | |
void | UILedSetBlinking (bool blinking) |
Let the white status led on the handheld blink or not. | |
void | UIPlay (Nedap.HandheldApi.UITune tune) |
The beeper on the handheld will play the defined tune. | |
void | UIVibrate () |
The vibration motor on the handheld will vibrate. | |
void | UIVibrate (int timeout) |
The vibration motor on the handheld will vibrate for a specified duration. | |
void | UIVibrateTune (UITune tune) |
The vibration motor on the handheld will vibrate and the beeper on the handheld will play the defined tune. | |
Events | |
EventHandler< EventArgs > | OnSessionBarcodeNotRead |
This event is triggered after handheld fails to read a barcode. | |
EventHandler < RfidReadABarcodeEventArgs > | OnSessionBarcodeRead |
This event is triggered after handheld reads a barcode. | |
EventHandler< EventArgs > | OnSessionHandheldConnect |
This event is triggered after handheld device connects. | |
EventHandler< EventArgs > | OnSessionHandheldDisconnect |
This event is triggered after handheld device disconnects. | |
EventHandler < HandheldReceiveBatteryPercentageEventArgs > | OnSessionHandheldReceiveBatteryPercentage |
This event is triggered after battery charge percentage is received. | |
EventHandler< EventArgs > | OnSessionHandheldReceiveChargingStatus |
This event is triggered after charging status responce is received. | |
EventHandler< EventArgs > | OnSessionHandheldReceiveEmptyBatteryStatus |
This event is triggered after empty battery status responce is received. | |
EventHandler< EventArgs > | OnSessionHandheldReceiveLowBatteryWarning |
This event is triggered after handheld device battery reaches minimal level. | |
EventHandler < HandheldReceiveErrorEventArgs > | OnSessionHandheldReceiveError |
This event is triggered after error responce is received. | |
EventHandler< EventArgs > | OnSessionNfcCardNotFound |
This event is triggered after handheld device fails to found a card. | |
EventHandler < RfidReadCardEventArgs > | OnSessionNfcCardRead |
This event is triggered after handheld device reads a card. | |
EventHandler < RfidFailButTagsAvailableEventArgs > | OnSessionRfidFailButTagsAvailable |
This event is triggered after handheld device read fails but tags are available. | |
EventHandler< EventArgs > | OnSessionRfidFinishReadCycle |
This event is triggered after handheld device finished read cycle. | |
EventHandler < RfidReadDataEventArgs > | OnSessionRfidReadData |
This event is triggered after handheld device reads data. | |
EventHandler < RfidReadTagEventArgs > | OnSessionRfidReadTag |
This event is triggered after handheld device reads tag. | |
EventHandler < RfidReceiveSupportedRegionsEventArgs > | OnSessionRfidReceiveSupportedRegions |
This event is triggered after supported regions responce is received.. | |
EventHandler < RfidWriteDataMoreTagsAvailableEventArgs > | OnSessionRfidWriteDataMoreTagsAvailable |
This event is triggered after handheld device writes data and more tags are available. | |
EventHandler< EventArgs > | OnSessionRfidWriteNoTagsInField |
This event is triggered after handheld device tries to write EPC and there are no tags in the field. | |
EventHandler< EventArgs > | OnSessionRfidWriteTooMuchTagsInField |
This event is triggered after handheld device tries to write EPC and there are too much tags in the field. | |
EventHandler< EventArgs > | OnSessionRfidWriteToTagFailed |
This event is triggered after handheld device tries to write EPC and fails. | |
EventHandler< EventArgs > | OnSessionRfidWriteSuccess |
This event is triggered after handheld device tries to write EPC and succeeds. | |
EventHandler< EventArgs > | OnSessionUIPushButton |
This event is triggered after button is pushed on the handheld device. | |
EventHandler< EventArgs > | OnSessionUIShake |
This event is triggered after the handheld device is shaken. |
Session layer interface: low-level communication layer interface that can be used to communicate with Handheld Reader.
bool Nedap.HandheldApi.ISession.BarcodeHasReader | ( | ) |
Check to see if the handheld reader has a barcode reader on-board.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.BarcodeSetStatusForType | ( | Nedap.HandheldApi.BarcodeType | barcodeType, |
bool | enabled | ||
) |
Enables or disable a certain type of barcode.
barcodeType | NHBarcodeType |
enabled | enabled or disabled |
void Nedap.HandheldApi.ISession.BarcodeTryDecode | ( | int | duration | ) |
Try to read a barcode for a defined number of seconds.
duration | duration in seconds |
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.Dispose | ( | ) |
Disposes private objects.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.HandheldDisconnect | ( | ) |
Will let the handheld kill the bluetooth connection. Can be used to pair the handheld with another device.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.HandheldGetBatteryPercentage | ( | ) |
Returns the current battery status in percentage.
Implemented in Nedap.HandheldApi.Session.
DeviceInfo Nedap.HandheldApi.ISession.HandheldGetInformation | ( | ) |
Get information on the handheld.
Implemented in Nedap.HandheldApi.Session.
bool Nedap.HandheldApi.ISession.HandheldIsConnected | ( | ) |
Checks if the handheld is connected or not.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.NfcTryToReadCard | ( | ) |
The handheld will try to read a NFC card.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.RfidGetSupportedRegions | ( | ) |
Gets the supported regions by the handheld reader.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.RfidReadData | ( | Nedap.HandheldApi.RfidEpcMemoryBank | memoryBank, |
int | addressInWords, | ||
int | lengthInWords, | ||
int | timeout, | ||
int | power, | ||
Nedap.HandheldApi.Select | select, | ||
Nedap.HandheldApi.Password | password | ||
) |
Will read specific data from a RFID tag.
memoryBank | the memory bank to read data from |
addressInWords | the address to read data from (in words) |
lengthInWords | the length of the data to read (in words) |
timeout | timeout in milliseconds |
power | the power, possible values range from 10 to 23 dBm |
select | select statement, can also be set to null |
password | password, can also be set to null |
void Nedap.HandheldApi.ISession.RfidReadEpcs | ( | int | timeout, |
int | power, | ||
Nedap.HandheldApi.Select | select | ||
) |
Will read RFID tags in the field, for a specified duration, with a specific power and with a select to select a subset of tags.
timeout | timeout in milliseconds |
power | the power, possible values range from 10 to 23 dBm |
select | select statement, can also be set to null |
void Nedap.HandheldApi.ISession.RfidSetCWSignal | ( | bool | enabled, |
int | antenna | ||
) |
Enables Continuous Wave (CW) signal, used for testing and measurement purposes.
enabled | CW enabled |
antenna | select antenna one or two |
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.RfidSetFrequencyHopTable | ( | System.Collections.Generic.List< Nedap.HandheldApi.RfidFrequency > | frequencies | ) |
Set frequency hop table.
frequencies | frequencies array with frequencies (NSNumber containing NHRFIDFrequency) |
void Nedap.HandheldApi.ISession.RfidSetMValue | ( | Nedap.HandheldApi.RfidEpcMValue | mValue | ) |
Sets the miller value for the EPC Gen2 protocol.
mValue | mValue miller value |
void Nedap.HandheldApi.ISession.RfidSetQValue | ( | int | qValue, |
bool | dynamic | ||
) |
Sets the Q value for the EPC Gen2 protocol.
qValue | qValue the Q value |
dynamic | dynamic whether the Q value is dynamically adjusted or not |
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.RfidSetRegion | ( | Nedap.HandheldApi.RfidRegion | region | ) |
Sets the region that the handheld reader operates in. The supported regions can be obtained by using +(void)rfidGetSupportedRegions.
region | RfidRegion to set |
void Nedap.HandheldApi.ISession.RfidSetSession | ( | Nedap.HandheldApi.RfidEpcSession | session | ) |
Sets the session for the EPC Gen2 protocol.
session | session session (S0, S1, S2 or S3) |
void Nedap.HandheldApi.ISession.RfidSetTarget | ( | Nedap.HandheldApi.RfidEpcTarget | target, |
bool | toggle | ||
) |
Sets the target for the EPC Gen2 protocol.
target | target target (A or B) |
toggle | toggle toggle between A and B |
void Nedap.HandheldApi.ISession.RfidWriteData | ( | byte[] | dataToWrite, |
Nedap.HandheldApi.RfidEpcMemoryBank | memoryBank, | ||
int | addressInWords, | ||
int | timeout, | ||
int | power, | ||
Nedap.HandheldApi.Select | select, | ||
Nedap.HandheldApi.Password | password | ||
) |
Write data to a specified memory bank and address in a tag.
dataToWrite | the data to write. |
memoryBank | the memory bank where to write the data to |
addressInWords | the address in words where the data needs to be written |
timeout | the address in words where the data needs to be written |
power | the power, possible values range from 10 to 23 dBm |
select | select statement, can also be set to null |
password | password, can also be set to null |
void Nedap.HandheldApi.ISession.RfidWriteEpc | ( | Nedap.EPC.TDT.EpcCode | epc | ) |
Writes a new EPC code to a tag.
epc | new EPC code |
void Nedap.HandheldApi.ISession.UILedSetBlinking | ( | bool | blinking | ) |
Let the white status led on the handheld blink or not.
blinking | blinking enabled |
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.UIPlay | ( | Nedap.HandheldApi.UITune | tune | ) |
The beeper on the handheld will play the defined tune.
tune |
void Nedap.HandheldApi.ISession.UIVibrate | ( | ) |
The vibration motor on the handheld will vibrate.
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.UIVibrate | ( | int | timeout | ) |
The vibration motor on the handheld will vibrate for a specified duration.
timeout | vibrate duration in tens of a second |
Implemented in Nedap.HandheldApi.Session.
void Nedap.HandheldApi.ISession.UIVibrateTune | ( | UITune | tune | ) |
The vibration motor on the handheld will vibrate and the beeper on the handheld will play the defined tune.
tune |
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionBarcodeNotRead |
This event is triggered after handheld fails to read a barcode.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidReadABarcodeEventArgs> Nedap.HandheldApi.ISession.OnSessionBarcodeRead |
This event is triggered after handheld reads a barcode.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldConnect |
This event is triggered after handheld device connects.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldDisconnect |
This event is triggered after handheld device disconnects.
Implemented in Nedap.HandheldApi.Session.
EventHandler<HandheldReceiveBatteryPercentageEventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldReceiveBatteryPercentage |
This event is triggered after battery charge percentage is received.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldReceiveChargingStatus |
This event is triggered after charging status responce is received.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldReceiveEmptyBatteryStatus |
This event is triggered after empty battery status responce is received.
Implemented in Nedap.HandheldApi.Session.
EventHandler<HandheldReceiveErrorEventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldReceiveError |
This event is triggered after error responce is received.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionHandheldReceiveLowBatteryWarning |
This event is triggered after handheld device battery reaches minimal level.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionNfcCardNotFound |
This event is triggered after handheld device fails to found a card.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidReadCardEventArgs> Nedap.HandheldApi.ISession.OnSessionNfcCardRead |
This event is triggered after handheld device reads a card.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidFailButTagsAvailableEventArgs> Nedap.HandheldApi.ISession.OnSessionRfidFailButTagsAvailable |
This event is triggered after handheld device read fails but tags are available.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionRfidFinishReadCycle |
This event is triggered after handheld device finished read cycle.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidReadDataEventArgs> Nedap.HandheldApi.ISession.OnSessionRfidReadData |
This event is triggered after handheld device reads data.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidReadTagEventArgs> Nedap.HandheldApi.ISession.OnSessionRfidReadTag |
This event is triggered after handheld device reads tag.
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidReceiveSupportedRegionsEventArgs> Nedap.HandheldApi.ISession.OnSessionRfidReceiveSupportedRegions |
This event is triggered after supported regions responce is received..
Implemented in Nedap.HandheldApi.Session.
EventHandler<RfidWriteDataMoreTagsAvailableEventArgs> Nedap.HandheldApi.ISession.OnSessionRfidWriteDataMoreTagsAvailable |
This event is triggered after handheld device writes data and more tags are available.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionRfidWriteNoTagsInField |
This event is triggered after handheld device tries to write EPC and there are no tags in the field.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionRfidWriteSuccess |
This event is triggered after handheld device tries to write EPC and succeeds.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionRfidWriteTooMuchTagsInField |
This event is triggered after handheld device tries to write EPC and there are too much tags in the field.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionRfidWriteToTagFailed |
This event is triggered after handheld device tries to write EPC and fails.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionUIPushButton |
This event is triggered after button is pushed on the handheld device.
Implemented in Nedap.HandheldApi.Session.
EventHandler<EventArgs> Nedap.HandheldApi.ISession.OnSessionUIShake |
This event is triggered after the handheld device is shaken.
Implemented in Nedap.HandheldApi.Session.