Changes
/* WinX External Scanner */
== RFID Configuration File ==
Information needed for communicating with an external Bluetooth RFID Reader are stored in a ".rfconfig file". This file has to be placed in the local RFIDConfiguration folder: ''{AppData}\LocalState\RFIDConfiguration\.rfconfig''. The name of the ".rfconfig" file is irrelevant. The configuration file contains the following information:
|-
|}
The ScannerIdentifier is typically the Bluetooth Name of the RFID Scanner. In some cases however it might deviate from the Bluetooth Name. The correct ScannerIdentifier can the be found in “Windows Settings>Devices and Printers>Right click on the Bluetooth Device>Properties>Services”.
Bluetooth Commands are ASCII Strings which can be send to the RFID Reader in the SPP Mode in order to configure the device. These commands can be found in the documentation of the respective RFID Reader. Often they are terminated with a stop character like “\r”.
An example of an .rfconfig file is given below. Note that elements of the configuration file have to be ordered alphabetically.
<source lang="xml">
<?xml version="1.0" encoding="utf-8"?>
<RFIDConfiguration
xmlns="UBIK.AR.RFID"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<DefaultScanning>true</DefaultScanning>
<IgnoreReply>true</IgnoreReply>
<ScannerIdentifier>RNI-SPP</ScannerIdentifier>
<Replace>),=</Replace>
<StartCommands>
<a:string>bs\r</a:string>
<a:string>cw 04,00\r</a:string>
<a:string>cw 0E,01\r</a:string>
</StartCommands>
<Substring>0,15</Substring>
<ScanningCommands></ScanningCommands>
<StopCommands>
<a:string>bh\r</a:string>
</StopCommands>
</RFIDConfiguration>
</source>
== Start Scanning ==
There are two possibilities to start scanning using the configured RFID Reader: Either scanning is active per default (see RFID Configuration) or by pressing the RFID Scan button in the GlobalAppBar. <br/>
[[File:NotConnected.PNG]]<br/>
When pressing the RFID Scan button UBIK tries to establish a Bluetooth connection to the RFID Reader. This is indicated by a Progress Ring on top of the RFID Scan button. If no connection could be established, the RFID Scan button falls back to its original state.<br/>
[[File:Connecting.PNG]]<br/>
If a connection was successful, the RFID Scan button appears toggled. Afterwards the StartCommands of the RFID Configuration are applied and UBIK starts to listen for Messages from the Bluetooth RFID Reader. That means one can use the application just as usually while UBIK® scans for RFID Tags in the background.<br/>
[[File:Connected.PNG]]<br/>
== Scanning ==
Once scanning was successfully started as described above, UBIK is continuously listening for new Messages from the RFID Reader. When a RFID Tag gets scanned, the result is received and manipulated based on the RFID Configuration. If the Substring option is configured properly, a substring of the Message is extracted and used for further processing. If the Replace option is configured properly specified characters are replaced. Afterwards processing an action is triggered for the received Message. If a string editor is currently opened, the Message is written into the property field of the editor (Teach-In). Otherwise an object search is triggered. UBIK is then searching for Objects classified as [[SYSCLS_OBJECTWITHRFIDTAG]] having the scanned content as the RFIDTag property value. Finally the ScanningCommands defined in the RFID Configuration are applied.
== Stop Scanning ==
Scanning can be stopped manually by pressing the RFID Scan button in the GlobalAppBar or simply by switching off the RFID Reader. UBIK will notice the device got disconnected and will indicate so using the RFID Scan button state. If the RFID Reader is disconnected by pressing the RFID Scan button manually, StopCommands defined in the RFID Configuration are applied.
== Troubleshooting ==
The RFID Scan Button is not visible. Check the following:
* Is there a .rfconfig file in the specified RFIDConfiguration folder?
* Is the .rfconfig file formatted properly?
* Are the elements of the .rfconfig file ordered alphabetically?
* Are the elements of the .rfconfig file of the correct type?
* Is the RFID Reader running in Bluetooth SPP Mode?
* Is the RFID Reader paired with the host device?
* In the .rfconfig file, does the specified ScannerIdentifier match the Bluetooth name of the RFID Reader?
Its not possible to start scanning. Check the following:
* Is the RFID Reader on and in the proximity of the host device?
* Try to restart scanning by again pressing the button
* Try to restart the RFID Reader
* Try to restart UBIK
UBIK does not find any RFID Objects. Check the following:
* Is the RFID Reader properly configured (Some readers need to get pre-configured using Bluetooth Commands in order to send scanned RFID Tags to UBIK – Check the manual)
* Try to open a String editor and scan a RFID Tag. Is the scanned message as expected?
* Are the Objects of interest classified as SYSCLS_OBJECTWITHRFIDCODE?
* Are the Objects of interest properly configured (property value equals the associated RFID Tag)?
* If no Online Query is defined, are the Objects of interest available locally?
<headertabs/>