Nedap.HandheldApi
|
Presentation layer: high-level communication layer to communicate with Handheld Reader. More...
Public Member Functions | |
PresentationFacade (ISession session) | |
Constructor. | |
void | NfcReadStart () |
This method can be used to try to read NFC cards. It’ll enable the field, and continuously try to read cards in the field. | |
void | RfidInventoryStart () |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (Select select) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (String bufferName) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (String bufferName, Select select) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (bool highVolume) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (Select select, bool highVolume) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (String bufferName, bool highVolume) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q. | |
void | RfidInventoryStart (String bufferName, Select select, bool highVolume) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q. | |
void | RfidInventoryReset () |
Resets the RFID inventory 'seen' list of the "default" buffer. Please make sure that if a list is also kept in the application layer, clean it after the relevant notification is received. | |
void | RfidInventoryReset (String bufferName) |
Resets the RFID inventory 'seen' list of the given buffer. Please make sure that if a list is also kept in the application layer, clean it after the relevant notification is received. | |
void | RfidMonitorStart () |
Continously return tags in the field, together with their RSSI values. Can be used to implement 'search' functionality. | |
void | RfidMonitorStart (Select select) |
Monitors the tags in the field, with a select statement. | |
void | RfidReadSingle () |
Does a single read cycle of tags. | |
void | RfidReadSingle (Select select) |
Does a single read cycle of tags, with a select statement. | |
void | RfidReadTag () |
To obtain the tag manufacturer ID (MDID), the tag model number, or the tag’s extended identifier field (XTID), use this method. | |
void | RfidReadTag (EpcCode code) |
To obtain the tag manufacturer ID (MDID), the tag model number, or the tag’s extended identifier field (XTID), use this method. | |
void | RfidWriteEpc (EpcCode newEpcCode) |
Write a new EPC value to a tag. | |
void | SimulateButtonPush () |
This method simulates button push on the handheld reader. | |
bool | BarcodeHasReader () |
Check to see if the handheld reader has a barcode reader on-board. | |
void | BarcodeRead (BarcodeType barcodeType, int duration) |
Read a barcode with a specified type, and with a specified timeout. | |
void | BarcodeRead (Collection< BarcodeType > barcodeTypes, int duration) |
Read a barcode with a specified array of types, and with a specified timeout. | |
void | UIPlay (UITune tune) |
Let the beeper on the handheld play a tune. | |
void | UIVibrateTune (UITune tune) |
Let the vibration motor on the handheld vibrate with beeper playing a tune. | |
void | UIVibrate () |
Let the vibration motor on the handheld vibrate. | |
void | HandheldLogEnabled (bool enabled) |
Enables or disables the logging functionality with Flurry.com. The information logged to Flurry is anonymous. We’ll log the usages and performance of the !d hand (e.g. how long does an inventory take, how often will the user press the button, how many tags are read in an hour, how is the battery quality over time, etc.). This will help Nedap to improve the code, and gather information on the performance and usage of the !d hand in the field. We kindly ask you to leave this enabled (which is the default). If you’d prefer to turn this off, feel free to do so. | |
void | HandheldStop () |
Stop the current operation, e.g. inventory or monitoring. Can be used when switching from one view to another. | |
bool | HandheldIsConnected () |
Checks if the handheld is connected or not. | |
void | HandheldDisconnect () |
Will let the handheld kill the bluetooth connection. Can be used to pair the handheld with another device. | |
DeviceInfo | HandheldGetInformation () |
Get information on the handheld. | |
void | HandheldGetBatteryPercentage () |
Returns the current battery status in percentage. | |
void | Dispose () |
Dispose. | |
Events | |
EventHandler< EventArgs > | OnClearInventory |
This event is triggered when inventory list is cleared (All items from the inventory list are removed). | |
EventHandler < ReceiveBatteryPercentageEventArgs > | OnReceiveBatteryPercentage |
This event is triggered when battery percentage value is received from the handheld. | |
EventHandler< EventArgs > | OnLowBatteryWarning |
This event is triggered when low battery warning is received from the handheld. | |
EventHandler< EventArgs > | OnEmptyBatteryStatus |
This event is triggered when empty battery status is received from the handheld. | |
EventHandler< EventArgs > | OnChargingStatus |
This event is triggered when charging status is received from the handheld. | |
EventHandler < ReadRfidTagEventArgs > | OnReadRfidTag |
This event is triggered when one RFID tag is red using the handheld. | |
EventHandler < ReadRfidTagsEventArgs > | OnReadRfidTags |
This event is triggered when more than one RFID tags are red using the handheld. | |
EventHandler < ReadRfidTagsFilteredEventArgs > | OnReadRfidTagsFiltered |
This event is triggered when more than one new RFID tags are red using the handheld. | |
EventHandler < ReadDetailedTagInformationEventArgs > | OnReadDetailedTagInformation |
This event is triggered when detailed tag information is red using the handheld. | |
EventHandler < ReadBarcodeEventArgs > | OnReadBarcode |
This event is triggered when barcode is red using the handheld. | |
EventHandler< EventArgs > | OnNotReadBarcode |
This event is triggered when the handheld was not able to read barcode. | |
EventHandler< EventArgs > | OnPushButton |
This event is triggered when button on the handheld is pushed. | |
EventHandler< EventArgs > | OnShake |
This event is triggered when handheld is shaken. | |
EventHandler < ReadNfcCardEventArgs > | OnReadNfcCard |
This event is triggered when NFC card is red using the handheld. | |
EventHandler< EventArgs > | OnIsDisconnected |
This event is triggered when the handheld is disconnected and action is executed on the device. | |
EventHandler< EventArgs > | OnFinishSingleRead |
This event is triggered when single read of RFID is finished. | |
EventHandler< EventArgs > | OnContinue |
This event is triggered when when inventory process or monitor process are continued. | |
EventHandler< EventArgs > | OnPause |
This event is triggered when when inventory process or monitor process are paused. | |
EventHandler< EventArgs > | OnFailWriteEpcMultipleRead |
This event is triggered when writing of EPC has failed with multiple read. | |
EventHandler< EventArgs > | OnFailWriteEpcZeroRead |
This event is triggered when writing of EPC has failed with zero read. | |
EventHandler< EventArgs > | OnFailWriteEpcWriteFailed |
This event is triggered when writing of EPC has failed. Failure happened during the write of data. | |
EventHandler< EventArgs > | OnFailWriteEpcVerificationFailed |
This event is triggered when writing of EPC has failed. Failure happened during the verification of written of data. | |
EventHandler< EventArgs > | OnSucceedWriteEpc |
This event is triggered when writing of EPC has finished successfully. | |
EventHandler< EventArgs > | OnConnect |
This event is triggered when device is connected to the handheld. | |
EventHandler< EventArgs > | OnDisconnect |
This event is triggered when device is disconnected from the handheld. | |
EventHandler < ReceiveSupportedRegionsEventArgs > | OnReceiveSupportedRegions |
This event is triggered when supported regions are received from the handheld. |
Presentation layer: high-level communication layer to communicate with Handheld Reader.
Nedap.HandheldApi.PresentationFacade.PresentationFacade | ( | ISession | session | ) |
Constructor.
session |
bool Nedap.HandheldApi.PresentationFacade.BarcodeHasReader | ( | ) |
Check to see if the handheld reader has a barcode reader on-board.
void Nedap.HandheldApi.PresentationFacade.BarcodeRead | ( | BarcodeType | barcodeType, |
int | duration | ||
) |
Read a barcode with a specified type, and with a specified timeout.
barcodeType | Type of barcode |
duration | Timeout in seconds |
void Nedap.HandheldApi.PresentationFacade.BarcodeRead | ( | Collection< BarcodeType > | barcodeTypes, |
int | duration | ||
) |
Read a barcode with a specified array of types, and with a specified timeout.
barcodeTypes | Array of barcode types |
duration | Timeout in seconds |
void Nedap.HandheldApi.PresentationFacade.Dispose | ( | ) |
Dispose.
void Nedap.HandheldApi.PresentationFacade.HandheldDisconnect | ( | ) |
Will let the handheld kill the bluetooth connection. Can be used to pair the handheld with another device.
void Nedap.HandheldApi.PresentationFacade.HandheldGetBatteryPercentage | ( | ) |
Returns the current battery status in percentage.
DeviceInfo Nedap.HandheldApi.PresentationFacade.HandheldGetInformation | ( | ) |
Get information on the handheld.
bool Nedap.HandheldApi.PresentationFacade.HandheldIsConnected | ( | ) |
Checks if the handheld is connected or not.
void Nedap.HandheldApi.PresentationFacade.HandheldLogEnabled | ( | bool | enabled | ) |
Enables or disables the logging functionality with Flurry.com. The information logged to Flurry is anonymous. We’ll log the usages and performance of the !d hand (e.g. how long does an inventory take, how often will the user press the button, how many tags are read in an hour, how is the battery quality over time, etc.). This will help Nedap to improve the code, and gather information on the performance and usage of the !d hand in the field. We kindly ask you to leave this enabled (which is the default). If you’d prefer to turn this off, feel free to do so.
enabled | Enabled |
void Nedap.HandheldApi.PresentationFacade.HandheldStop | ( | ) |
Stop the current operation, e.g. inventory or monitoring. Can be used when switching from one view to another.
void Nedap.HandheldApi.PresentationFacade.NfcReadStart | ( | ) |
This method can be used to try to read NFC cards. It’ll enable the field, and continuously try to read cards in the field.
void Nedap.HandheldApi.PresentationFacade.RfidInventoryReset | ( | ) |
Resets the RFID inventory 'seen' list of the "default" buffer. Please make sure that if a list is also kept in the application layer, clean it after the relevant notification is received.
void Nedap.HandheldApi.PresentationFacade.RfidInventoryReset | ( | String | bufferName | ) |
Resets the RFID inventory 'seen' list of the given buffer. Please make sure that if a list is also kept in the application layer, clean it after the relevant notification is received.
bufferName |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | String | bufferName | ) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q.
bufferName |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | String | bufferName, |
bool | highVolume | ||
) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q.
bufferName | |
highVolume | If true session 2 is used, otherwise session 1 is used |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | String | bufferName, |
Select | select, | ||
bool | highVolume | ||
) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q.
bufferName | |
select | |
highVolume | If true session 2 is used, otherwise session 1 is used |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | String | bufferName, |
Select | select | ||
) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q.
bufferName | |
select |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | ) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q.
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | Select | select, |
bool | highVolume | ||
) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q.
select | Select statement |
highVolume | If true session 2 is used, otherwise session 1 is used |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | Select | select | ) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1, target A (no switching) and automatic Q.
select | Select statement |
void Nedap.HandheldApi.PresentationFacade.RfidInventoryStart | ( | bool | highVolume | ) |
The inventory methods provide an easy way to do inventory. It automatically filters ‘multiple’ reads in a buffer and generates a ‘beep’ on new tags. EPC air interface parameters are set automatically to session 1 or 2 depending on highVolume setting, target A (no switching) and automatic Q.
highVolume | If true session 2 is used, otherwise session 1 is used |
void Nedap.HandheldApi.PresentationFacade.RfidMonitorStart | ( | Select | select | ) |
Monitors the tags in the field, with a select statement.
select | Select statement |
void Nedap.HandheldApi.PresentationFacade.RfidMonitorStart | ( | ) |
Continously return tags in the field, together with their RSSI values. Can be used to implement 'search' functionality.
void Nedap.HandheldApi.PresentationFacade.RfidReadSingle | ( | Select | select | ) |
Does a single read cycle of tags, with a select statement.
select | Select statement |
void Nedap.HandheldApi.PresentationFacade.RfidReadSingle | ( | ) |
Does a single read cycle of tags.
void Nedap.HandheldApi.PresentationFacade.RfidReadTag | ( | ) |
To obtain the tag manufacturer ID (MDID), the tag model number, or the tag’s extended identifier field (XTID), use this method.
void Nedap.HandheldApi.PresentationFacade.RfidReadTag | ( | EpcCode | code | ) |
To obtain the tag manufacturer ID (MDID), the tag model number, or the tag’s extended identifier field (XTID), use this method.
code | Code |
void Nedap.HandheldApi.PresentationFacade.RfidWriteEpc | ( | EpcCode | newEpcCode | ) |
Write a new EPC value to a tag.
newEpcCode | The new EPC value |
void Nedap.HandheldApi.PresentationFacade.SimulateButtonPush | ( | ) |
This method simulates button push on the handheld reader.
void Nedap.HandheldApi.PresentationFacade.UIPlay | ( | UITune | tune | ) |
Let the beeper on the handheld play a tune.
tune | Type of tune |
void Nedap.HandheldApi.PresentationFacade.UIVibrate | ( | ) |
Let the vibration motor on the handheld vibrate.
void Nedap.HandheldApi.PresentationFacade.UIVibrateTune | ( | UITune | tune | ) |
Let the vibration motor on the handheld vibrate with beeper playing a tune.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnChargingStatus |
This event is triggered when charging status is received from the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnClearInventory |
This event is triggered when inventory list is cleared (All items from the inventory list are removed).
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnConnect |
This event is triggered when device is connected to the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnContinue |
This event is triggered when when inventory process or monitor process are continued.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnDisconnect |
This event is triggered when device is disconnected from the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnEmptyBatteryStatus |
This event is triggered when empty battery status is received from the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnFailWriteEpcMultipleRead |
This event is triggered when writing of EPC has failed with multiple read.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnFailWriteEpcVerificationFailed |
This event is triggered when writing of EPC has failed. Failure happened during the verification of written of data.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnFailWriteEpcWriteFailed |
This event is triggered when writing of EPC has failed. Failure happened during the write of data.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnFailWriteEpcZeroRead |
This event is triggered when writing of EPC has failed with zero read.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnFinishSingleRead |
This event is triggered when single read of RFID is finished.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnIsDisconnected |
This event is triggered when the handheld is disconnected and action is executed on the device.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnLowBatteryWarning |
This event is triggered when low battery warning is received from the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnNotReadBarcode |
This event is triggered when the handheld was not able to read barcode.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnPause |
This event is triggered when when inventory process or monitor process are paused.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnPushButton |
This event is triggered when button on the handheld is pushed.
EventHandler<ReadBarcodeEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadBarcode |
This event is triggered when barcode is red using the handheld.
EventHandler<ReadDetailedTagInformationEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadDetailedTagInformation |
This event is triggered when detailed tag information is red using the handheld.
EventHandler<ReadNfcCardEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadNfcCard |
This event is triggered when NFC card is red using the handheld.
EventHandler<ReadRfidTagEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadRfidTag |
This event is triggered when one RFID tag is red using the handheld.
EventHandler<ReadRfidTagsEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadRfidTags |
This event is triggered when more than one RFID tags are red using the handheld.
EventHandler<ReadRfidTagsFilteredEventArgs> Nedap.HandheldApi.PresentationFacade.OnReadRfidTagsFiltered |
This event is triggered when more than one new RFID tags are red using the handheld.
EventHandler<ReceiveBatteryPercentageEventArgs> Nedap.HandheldApi.PresentationFacade.OnReceiveBatteryPercentage |
This event is triggered when battery percentage value is received from the handheld.
EventHandler<ReceiveSupportedRegionsEventArgs> Nedap.HandheldApi.PresentationFacade.OnReceiveSupportedRegions |
This event is triggered when supported regions are received from the handheld.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnShake |
This event is triggered when handheld is shaken.
EventHandler<EventArgs> Nedap.HandheldApi.PresentationFacade.OnSucceedWriteEpc |
This event is triggered when writing of EPC has finished successfully.