BIS Handheld Custom Template Software Operation Description, User s Guide and Manual

Size: px

Start display at page:

Download "BIS Handheld Custom Template Software Operation Description, User s Guide and Manual"

Lambert McKenzie
5 years ago
Views:

1 BIS Operation Description, User s Guide and Manual Balluff 1

2 Balluff 2

3 1 User Instructions Installation Instructions Operation Reading or Writing Tag Data Saving or Opening Tag Data Files Total Recall Backup for PSION OS and Files Custom Template File Creation Custom Template Shortcut/Icon Creation Appendix English Edition No. BIS Z-SW-C-87x_ E. Edition 0100 Subject to modification. Balluff 3

4 1 User Instructions About this guide This guide describes operation of the BIS together with the "Workabout Pro" handheld computer made by "PSION Teklogix. The present guide does not describe: Startup, operation and care of the "Workabout Pro" handheld computer, Installation and operation of accessories and expansion devices, Docking station and standard device interfaces. This information is found in the manuals from PSION Teklogix on its enclosed CD. The most current documentation can be found on the Internet at " The following conventions are used in this manual. Enumerations are shown as a list with en-dash. Entry 1, entry 2. Action instructions are indicated by a preceding triangle. The result of an action is indicated by an arrow. Action instruction 1. Action result. Action instruction 2. Cross-references indicate where additional information on the topic can be found (see Technical Data starting page 11). Buttons are set in brackets, e.g. [Write]. Menu commands are joined with a greater than symbol, e.g. "Start > Programs stands for the menu command <Programs> from the start menu. Keys are set in angle form, e.g. confirm by pressing Enter. Intended use The BIS _-870 Handheld Programmer is a component of the BIS identification systems. Within the identification system it is used for checking, correcting or initializing data carriers. The Handheld Programmer may be used only for this purpose in an industrial environment corresponding to Class A of the EMC Law. This description is valid for processors in series BIS _ or BIS _ Balluff 4

2 Installation Instructions Important Note: In order to load the BIS, you must have a copy of Microsoft ActiveSync installed on your PC. This software should have come with your PSION handheld unit.

5 2 Installation Instructions Important Note: In order to load the BIS, you must have a copy of Microsoft ActiveSync installed on your PC. This software should have come with your PSION handheld unit. If not available, use the following to acquire the latest version to install and use to load the Template software onto the handheld. Download and install Microsoft ActiveSync from the following link to your PC: Once you have installed ActiveSync on you PC, use the following instructions to load the Template software onto the handheld unit: Connect the handheld to your PC using either a direct USB cable connection or through the PSION handheld cradle USB connection. Follow the ActiveSync instructions to create the USB connection to your PC. Once the ActiveSync connection has been established, you will be asked to create a partnership with the handheld to your PC. This is not necessary to load the Template software, but can be done for future file transfer. If you wish to establish a partnership with your PC, follow the instructions in ActiveSync. If you wish to just load the Template software, following the following instructions. Press the [Cancel] button on this screen. You will be warned that a partnership has not been established. Simply select [OK]. Balluff 5

6 This will take you to the default window for ActiveSync. Press the [Explore] button icon to open the Explorer view of the PSION handheld. Once the Explorer button has been pressed, you will see the file system for the handheld unit. Balluff 6

Copy the following two files from the Template software CD to the Flash Drive folder of the handheld: BIS Template RFIDSetup.cab NETCFv35.wce.armv4.

7 Copy the following two files from the Template software CD to the Flash Drive folder of the handheld: BIS Template RFIDSetup.cab NETCFv35.wce.armv4.cab Once you paste these files, you will see the following message warning you that the files may need to be converted. When you see this message, press [OK]. The files will then be downloaded to the Flash Drive folder of the handheld unit. These files contain the.net Windows based CE libraries needed to run the Template software and the Template software itself in Windows CE based zipped or CAB files. When the files are done being copied, disconnect the handheld from the PC and use the handhelds stylus and screen to execute the following steps. Balluff 7

8 From the Desktop screen of the PSION handheld, double click the My Device icon to open the explorer window. In the Explorer window, double click or select the Flash Disk folder to see the folders content. Balluff 8

$Double click the file NETCFv35.wce.armv4 first to install the.net file libraries. A window will open asking to install these files in the \Program Files directory.$

9 In this folder, you will see the two files copied: BIS Template RFIDSetup NETCFv35.wce.armv4 IMPORTANT NOTE: You must install the.net files in the NETCFv35.wce.armv4 file before you install the Template software or the Template software will not execute properly. Double click the file NETCFv35.wce.armv4 first to install the.net file libraries. A window will open asking to install these files in the \Program Files directory. Click the [OK] button near the top right corner to initiate the installation. Once these files have been installed, double click the BIS Template RFIDSetup file to install the Template software. Follow the same process as the previous.net files. Once both software packages have been installed, you can close the Explorer window by clicking the [X] box in the top right corner of the screen. Balluff 9

10 3 Operation If the software has installed properly, you will now see an icon on the Desktop called Generic RFID _. The _ will designate either the C, L, M or U version of the software. You can begin to use the Template program by double clicking the icon for the template you created. Balluff 10

11 Depending on the handheld hardware version you have, you can adjust the default RFID hardware parameters by selecting Edit>RFID Settings from menu on the top of the Template software window. This will open a window showing all the default settings for the specific version of the BIS handheld RFID hardware unit you have. Balluff 11

12 (See the Balluff Handheld Programmer guide for the BIS _-87x handheld unit to determine and adjust any of the default operational parameters of the handheld reader.) Balluff 12

13 4 Reading or Writing Tag Data Read operation For operating the Template software to read a RFID tag, place the appropriate tag matching the handheld hardware version in front of the reader head and press the [Read] button on the Template software screen. The data will be read and displayed according to the template you have created and saved on the handheld. (See the Template creation section of this manual for details on how to create custom templates and icons.) Once the read process is started and completed, you will be notified by a bell tone and the Status window on the top right will turn green. * If an error occurs in the read or write process, the Status window will turn red and an error window message will be displayed with the indicated error description. Write operation For operating the Template software to write data to a RFID tag, enter the data to each of the corresponding data rows on the template following the template format you created. (See the Template creation section of this manual for details on how to create custom templates and icons.) Balluff 13

Once all of the changes have been made to the fields, press the [Write] button. Once the write button is pressed, you will be prompted to enter a password to complete the writing of data to the tag.

14 Once all of the changes have been made to the fields, press the [Write] button. Once the write button is pressed, you will be prompted to enter a password to complete the writing of data to the tag. Enter the password balluff and the handheld will proceed with completing the writing process. Once the write process is complete, you will be notified by a bell tone and the Status window on the top right will turn green. Balluff 14

5 Saving or Opening Tag Data Files Save a tag data file operation To save data read from a RFID tag, select File>Save from the Template software menu.

15 5 Saving or Opening Tag Data Files Save a tag data file operation To save data read from a RFID tag, select File>Save from the Template software menu. You will be prompted to enter a password to complete the file saving process. Enter the password and the handheld will proceed with completing the file saving process. By default, the Template software will use the date and time stamp as the default file name. This name can be changed or altered with the use us the handhelds interface. Opening a tag data file operation To open a previously saved tag data file, select File>Open from the Template software menu. A Windows file window will open allowing you to choose a file from any location on the handheld. Select or highlight the file you wish to open and select the [OK] button to open the file. Balluff 15

16 * Opening a file from within the handhelds memory will permanently overwrite the existing data in the displayed template with the newly opened files data. Be sure to save the data displayed in the template before opening a file. Balluff 16

6 Total Recall Backup for PSION OS and Files IMPROTANT NOTE: In order to be sure the programs and templates created or added to the PSION handheld will be saved after cycling power, a program called

17 6 Total Recall Backup for PSION OS and Files IMPROTANT NOTE: In order to be sure the programs and templates created or added to the PSION handheld will be saved after cycling power, a program called Total Recall must used to create a backup profile that includes all the newly added files. Please use these instructions or see the instructions included with your PSION Teklogix handheld. The PSION handheld provides a way to flash programs to the Flash Memory of the handheld so the programs will be saved and recalled when the handheld is powered down, the battery is removed or when a Cold Restart is executed. To create a Total Recall profile, go to the Start>Settings>Control Panel menu to access the configuration and settings programs for the handheld. Scroll down the open Control Panel window to locate the >Total Recall program. Double click the >Total Recall icon to execute this program. In the Total Recall window, select [Create Backup Profile] from the top drop down window and click the [Next] button. Balluff 17

$Use \Flash Disk as the default Profile Location: to save the newly created profile. Then press the [Next] button. Use the selected file types in the Add Files window. Press the [Next] button.$

18 Enter a profile name in the Profile Name: row. Then select AutoRestore for this device only from the Profile Type: drop down window. Use \Flash Disk as the default Profile Location: to save the newly created profile. Then press the [Next] button. Use the selected file types in the Add Files window. Press the [Next] button. Review the files to be saved in the View Selections windows list. Press the [Next] button. In the Perform the Operation window, press the [Backup] button to begin to create the profile. Once the profile has been created and the window indicates the operation has been completed successfully, press the [Finish] button to exit. Press the [X] button on the top right of the Control Panel screen to return to the handheld Desktop screen. Balluff 18

7 Custom Template File Creation Template description Templates files are XML documents that contain the definitions and necessary information for the Template software to properly parse the data

19 7 Custom Template File Creation Template description Templates files are XML documents that contain the definitions and necessary information for the Template software to properly parse the data collected from the RFID tag, convert the ASCII data read from the tag into the proper format for display and place the data into the proper display row. Template creation/modification A template file is an XML file that can be modified by a user using Microsoft Word. The generic template file can be found in the \Mobile Device\ Program Files\HandheldRFID folder on the PSION handheld or it can be located in the Root directory of the CD containing the Template software. Locate the file Generic_Template.xml using Microsoft Word. (Do not use an XML Editor unless experienced.) Once the Generic_Template.xml template file is opened, you will see the following commented file information: IMPROTANT NOTE: Do not change the format of this file or the order in which items appear in the file. If the formatting or the order in which items appear are changed, the template may not be read or displayed correctly by the handheld. Balluff 19

20 Anything contained between comment breaks are comments to help guide you through using the definitions contained in the file. Items contained between the brackets other then comment brackets should be edited to configure the information to be displayed on the handheld s screen. The template file is divided into the header section and individual fields. The header is only defined once at the beginning of the template file and is where the instructions are contained for how the handheld should read the RFID data or information from the tag. The information contained in the header is defined as the following: Balluff Demo Header name is the name that will appear at the top of the template screen representing the template name. 0 "dataoffset" is the starting location for reading/writing from the tag 25 "datalength" is the number of bytes to be read starting from the offset location 0 "byteorder" is the order in which all the bytes will be read by based on the following: "1" = Least significant byte first "0" = Most significant byte first The most common method for western based systems is "0" or most significant byte first Editing ONLY the data contained in between the brackets, change the data values to match what is contain on the tag in bytes. For example, if there are 26 bytes of data and you want to start to read from the beginning of the tag, the dataoffset is equal to 0 and the datalength is equal to 25. The reason is because the data always starts at position 0 on a RFID tag. The individual data rows to be displayed on the screen of the handheld are called fields. Each row or field is individually configured in a single field section. A field must be defined for every data element to be displayed on the handheld. Fields can be defined multiple times based on the number of displayed items desired. The purpose of a field is to also take the data read from the tag in the default ASCII format and convert it into the required display format. **Data is read by each field sequentially in the order in which the field appears in the file.** When a field is read, a file pointer is advanced to the next byte based on how many bytes where read by the previous field. For example, if the first field starts at byte 0 and has a length of 4, the next field will start reading from byte 3 in memory, advancing the pointer 4 bytes in memory. The information contained in a field is defined as the following: Balluff 20

21 ASCII Field Field "name" is the literal text to be displayed for each row of data on the display. This field should be limited to 16 characters or less. 4 "length" is the consecutive number of bytes to be read/written to for this Field true "visible" is used to set whether the Field will be displayed or not. "true" will display the Field defined, "false" will not display the defined Field. ascii "code" defines the format in which the tag data will be displayed in the row. **Each example below shows how the field can be used.** 60 "absoluteoffset" is an actual byte location you wish to move to next to start the next Field's reference location. You can move to any byte location within the total number of bytes defined in the headers "datalength". Eq. "128" would move to the next byte to be used from where ever you are in the present byte order to byte 128. The next Field definition will begin to extract data from this location moving forward to the next highest bytes based in the defined length. ***REMOVE OR EXCLUDE THIS PARAMETER FROM THE FIELD DEFINITION IF NOT NEEDED*** Editing ONLY the data contained in between the brackets, change the data values to match what you would like to display in each row on the handhelds screen. Each type of code display typically has a set number for the length. The following examples are provided to show how each of the available code types can be used: ASCII Field 4 true ascii ""ascii" is a literal value representing and ASCII character as it was written on the tag. Integer Field 4 true int "int" is an Integer numerical value representing a number up to with a minimum length value of 4. Float Field 4 true float Balluff 21

22 "float" is a Floating Point or Decimal numerical value that can be entered up to a value of 7 digits with a length of 4. BCD Field 2 true bcd "bcd" is a Binary Coded Decimal value each number is represented by a length value of 2 or more depending on the number of values being read together and is entered in a 4 digit binary format. Long Field 4 true long "long" is a Long Integer value and requires a minimum length value of 4. Byte Field 1 true byte "byte" is a single numerical value ranging from 0 to 255. To create new fields, copy an exiting field and past it in between 2 fields or past it at the end of the last field but BEFORE the last bracket. Template saving New or modified template files should be saved on your PC so they can be transferred to the handheld. Template XML files cannot be edited on the handheld. A template file must always be saved as an XML document. Use the following procedure to save a template file Balluff 22

23 Once a template XML file has been created or modified, use the [Save As] menu item under the [File] menu in Word to save the XML file. **It is recommended that when ever the generic template file is modified, that a new file name be used for the new template leaving the original Generic_Template file as a clean reference file.** After giving the template file a new name, click on the [Save] button. Template transfer to handheld Once a template file has been created or modified on the PC, it can be transferred to the PSION handheld for use with the Template software. Connect the handheld to your PC using either a direct USB cable or the PSION handheld cradle USB connection. Once the handheld is connected, you will use Microsoft ActiveSync to transfer the template files from the PC to the correct location on the handheld. (For details regarding ActiveSync, please see chapter 2.) After starting ActiveSync, press the [Explorer] button to open the Explorer window. Balluff 23

$The default location in the Explorer window will be Mobile Device. Change directories to \Program Files\HandheldRFID. Open another Explorer window on your PC to the location of your template XML file.$

24 The default location in the Explorer window will be Mobile Device. Change directories to \Program Files\HandheldRFID. Open another Explorer window on your PC to the location of your template XML file. Select your.xml document file, then copy and paste this document to the handhelds \Mobile Device\ Program Files\HandheldRFID folder. Once you paste the file, you will see the following message warning you that the file may need to be converted. Balluff 24

$When the file is done being copied, you can then proceed to chapter 8 to create and copy the shortcut\icon file to call your new template file when starting the Template software.$

25 When you see this message, press [OK]. The file will then be downloaded to the Flash Drive folder of the handheld unit. When the file is done being copied, you can then proceed to chapter 8 to create and copy the shortcut\icon file to call your new template file when starting the Template software. Once all the steps are completed, disconnect the handheld from the PC and use the handhelds stylus and screen to execute the Template program. Balluff 25

8 Custom Template Shortcut/Icon Creation Template shortcut/icon description A shortcut/icon file is a generic LNKX file that contains the definition and file call information that the Template

26 8 Custom Template Shortcut/Icon Creation Template shortcut/icon description A shortcut/icon file is a generic LNKX file that contains the definition and file call information that the Template software will use to properly begin execution and call the template file to be used by the program once the file has been changed and saved as an.lnk file. This file will contain the Template software icon data and the specific execution file call string used to open a template in the Template software. Shortcut/icon creation/modification A new shortcut file can be created by modifying the Generic_Template.lnkx file provided on the software CD. This allows the user to have a separate shortcut to call each template file uniquely. A shortcut file contains both a graphic icon element and a text string that executes the Template software and loads the template file noted into the memory of the handheld for execution. Go to the Root directory of the CD containing the handheld Template software. Right click on the file name Generic RFID C.lnkx and select the [Open with]. This will open a list of files you can select to open the shortcut file with. Choose the Notepad program to edit this file. Once you open the file, you will see a text string reading 64#"\Program Files\handheldrfid\handheldrfid.exe" generic_template.xml. Edit the text Balluff 26

27 generic_template.xml ONLY, replacing it with the name of the new template file you just saved. (Be sure to include the.xml extension at the end of the file name. DO NOT change the first part of the string as this is the name of the template software executable.) Shortcut/icon saving New or modified shortcut files should be saved on your PC so they can be transferred to the handheld. **Once a shortcut file is named and saved as an.lnk file, Windows will handle it as an icon shortcut and will not allow you to edit it again.** Use the following procedure to save a shortcut file Once a shortcut LNKX file has been created or modified, use the [Save As] menu item under the [File] menu in Notepad to save the LNKX file. Balluff 27

**It is recommended that when ever the generic shortcut LNKX file is modified, that a new file name be used for the new template leaving the original Generic RFID C.

28 **It is recommended that when ever the generic shortcut LNKX file is modified, that a new file name be used for the new template leaving the original Generic RFID C.lnkx file as a clean reference file again.** Give the shortcut file a new name and manually add the file extension.lnk to the end of the file name. (Once the shortcut is saved with the.lnk extension, it will automatically be compiled as a shortcut file and will not editable by Notepad again.) Click the [Save as type] drop down and select [All Files]. Encoding does not need to be changed. After giving the template file a new name, click on the [Save] button. Shortcut/icon transfer to handheld Once a shortcut/icon file has been created or modified on the PC, it can be transferred to the PSION handheld for use with the Template software. Connect the handheld to your PC using either a direct USB cable or the PSION handheld cradle USB connection. Once the handheld is connected, you will use Microsoft Balluff 28

$) After starting ActiveSync, press the [Explorer] button to open the Explorer window. The default location in the Explorer window will be Mobile Device. Change directories to \Windows\Desktop.$

29 ActiveSync to transfer the template files from the PC to the correct location on the handheld. (For details regarding ActiveSync, please see chapter 2.) After starting ActiveSync, press the [Explorer] button to open the Explorer window. The default location in the Explorer window will be Mobile Device. Change directories to \Windows\Desktop. Open another Explorer window on your PC to the location of your shortcut/icon.lnk file. (This file may also be shown in Explorer as a Shortcut file under the file Type column. Select your.lnk (Shortcut) file, then copy and paste this file to the handhelds \Mobile Device\Windows\Desktop folder. When the file is done being copied, you can then disconnect the handheld from the PC and use the new Shortcut icon copied to open the template file you wish to use by double clicking it on the Desktop screen of the handheld. Balluff 29

30 Appendix Software License The rights and ownership of this software code and intellectual property are reserved and claimed by Balluff Inc. exclusively. This software may not be distributed or used in anyway other then the expressed intended purpose without the consent of Balluff Inc. or Balluff GMBH. A copy of this software is licensed to a single handheld unit and may not be copied or used on any handhelds other then the handheld registered to a single copy. This software license is controlled by Balluff and any use other then for its stated intention must be authorized in writing by Balluff or the owner risks the removal of the licensee s right of use. Use of this software and all warranties are expressed in the standard General Terms and Conditions, section named: Additional Conditions regarding Software provided with this copy of software. For additional details about this software or its use, please contact Balluff. Balluff 30

31 Balluff 31

32 Balluff 32 Doc. No /Mat. No E Edition Subject to change without notice

BIS C-87_ Handheld Programmer

BIS C-87_ Handheld Programmer Technical Description, User's Guide english 1 2 3 4 5 6 User instructions 4 1.1 CE Declaration of Conformity and user safety 4 1.2 Scope of delivery 4 1.3 About this manual 4 1.4 Structure of the manual