AirStick S-ID User Guide

Transcription

1 AirStick S-ID User Guide User Manual Version 1.0

2 Contents 1. Definition Introduction... 5 Description... 5 Install S-ID... 5 Launch S-ID software... 6 Connect AirStick reader to S-ID... 7 PC and Reader libraries Toolbar... 8 S-ID Configuration... 8 EID Format... 8 CSV Separator... 9 Library Folder Reader Remote Control Enabled Reader Backup Restore Update About Reader Configurations Reader name Alerts Default VID VID Editable VID = last EID digits Automatic shut-down time Reading time out Screen time out Runtime print enable Print EID only Keyboard layout Sessions Session operations Open and review a session Delete session Rename a session Export a session Edit a session Save and Save as Remove an item

3 Search Print Delete duplicates Export a session Export a session as a.csv or.xlsx file Export a session as a Masterfile Masterfile What is a Masterfile Create a Masterfile on S-ID Create a Masterfile importing a.csv or.xlsx file Masterfile operations Open a Masterfile Delete the Masterfile Rename the Masterfile Edit a Masterfile Save and Save as Add an EID Remove an EID Search Print Rename Notes Create a Search input file Add EIDs to the Search input file Save a Search input file EID, VID and Alert searches

4 1. Definition EID: Electronic IDentifier. Alphanumeric code up to 23-digits number which uniquely identifies a tag and it is detected and shown by the reader. VID: Visual IDentifier. Alphanumeric code up to 16 digits that can be associated with an EID on AirStick reader (manually entering the code) or by S-ID software. You can propose a default value or set the VID equal to the last digits, up to 12, of the EID (please refer to 4.4 paragraph). Alert: It is an alphanumeric code (up to 16 digits) that can be added to an EID to notify a specific condition met by an animal. An alert can be added, edited and deleted on the reader or on S-ID. Note: A note is any data (alphanumeric codes up to 16 digits) that can be added to an EID: It is possible to customize Up to 5 note fields. You can decide to classify each note to have consistent information for all EIDs (eg. Note 1 = Date of Birth, Note 2: Place of birth.) or use it in different ways for different EIDs. This data is read only on AirStick and can be added and edited in S-ID only. Reading session: It is a.csv file on which the reader records the tag s data (Date and Time, EID, VID, Alert and Custom Data) each time it is read. By default, a Reading Session it s named RS_Date_Time where date and time are those at the session creation time. Masterfile: It is a database that provide the equivalence of each EID to its VID, Alert or Custom Data. When you add at least one of VID, Alert or Custom Data to an EID, these data will be saved in the Masterfile, allowing the reader to recall them each time that specific EID is read. 4

5 2. Introduction Description Datamars S-ID software is designed to work specifically with Datamars companion animal and livestock readers to help simplify data transfer and reader management associated with electronic animal identification. This guide is aimed to specifically describe S-ID functionalities with AirStick reader. For more information on AirStick reader please refer to AirStick Reader - Quick Start Guide and AirStick Reader - User Manual. Install S-ID To successfully install S-ID on your PC, be sure that the following minimum system requirements for installation are satisfied: Windows 7 or higher Java v.1.7 or higher Run the.exe file and follow installation instructions (Figure 2-1): Figure 2-1 Read the End-User License Agreement and accept the terms (Figure 2-2). Figure 2-2 5

6 Then, click on Install (Figure 2-3): Figure 2-3 At the end of the installation procedure, S-ID icon appears on the desktop of your PC: Launch S-ID software Double-click on the S-ID icon and the S-ID window will be displayed on the PC screen (Figure 2-4) Figure 2-4 When you open S-ID for the first time, a PC library will be created on your PC. If you have already installed a previous version of S-ID, existing libraries will be saved in the S-ID folder on your PC, under Old library folder. 6

7 Connect AirStick reader to S-ID To connect AirStick to the PC: 1. Turn the reader off 2. Plug the USB cable in the USB device port of the reader 3. Connect the USB cable to the PC. PC and Reader libraries Each time S-ID is connected to the reader, it will show 2 libraries (Figure 2-5): The PC library (on the left): It contains imported and exported files stored in the PC, files copied from the reader and used as backups or working file. It is empty when you install S-ID for the first time. The PC library has a default name and can be renamed as desired selecting the Rename function available right clicking on the PC library name. The Reader library (on the right): This library is named according to the reader name (as default, the name is AirStick + Firmware version ). This library contains all information recorded on the reader and the configuration file. The Reader library can be renamed modifying the Reader name from the Configuration file (please refer to 4.1 paragraph). Figure 2-5 Files can be dragged and dropped from the reader library to the PC library and vice versa. To avoid undesired changes on the reader, some tasks (e.g. files saving ) are available on the PC library only. To add these changes on AirStick, move the created / changed files from the PC library to the Reader library. 7

8 3. Toolbar From the S-ID toolbar the following drop-down menus can be reached (Figure 3-1): 1. Configuration 2. Reader 3. About Figure 3-1 S-ID Configuration The Configuration menu provides the following options for S-ID (Figure 3-2): 1. EID format 2. CSV Separator 3. Library folder 4. Reader Remote Control Enabled EID Format Figure 3-2 The EID format allows to select the desired format to display the EIDs in S-ID. This format shall be consistent to that one used on the reader (please refer to AirStick Reader - User Manual). By default, the EID format is set on a country basis (Figure 3-3). Figure 3-3 To change the EID format, uncheck the on-screen option Country EID format and choose one of the available format available in the list (Figure 3-4): ISO Long ISO Short ISO TIRIS 8

9 F-210 BDN-Ita South America ISo Short (SA) HEX Bi-HEX Figure 3-4 ISO Long ISO Short ISO TIRIS (Texas Instruments Registration and Identification System) F-210 BDN-ITA South America ISO Short (SA) Hex Bi-Hex Animal: "A " (23 char) Industrial: "R " (21 char) Animal: " " (16 char) Industrial: " " (21 char) Animal: "A " (26 char) Industrial: "R " (23 char) Animal: "A " (27 char) Industrial: "R " (23 char) Animal: " " (23 char) Industrial: "R " (21 char) Animal: " " (15 char) Industrial: " " (21 char) Animal: 8000E1349EA72A50 (16 char) Industrial: (16 char) Animal: 900.E1349EA72A50 (16 char) Industrial: (14 char) CSV Separator The CSV separator is the character used to delimit the data and organizing them in different fields within a session file. By default, S-ID use the same CSV separator used on your PC system (Figure 3-5). S-ID shows the sessions recorded on the reader only if the CSV separator is the same used on AirStick (set on a country basis). 9

10 Figure 3-5 Library Folder S-ID sets by default the folder where the PC library is saved in (i.e. C:\ProgramData\Datamars\S-ID\Library). If you want to have libraries saved in a different place in your PC (e.g. on the desktop, for an easier access), you can browse in your PC, and change the path. Reader Remote Control Enabled This option is not available for AirStick. Reader The Reader menu provides the following options (Figure 3-6): 1. Backup 2. Restore 3. Update Figure 3-6 Backup We recommend to back-up your reader before modifying files saved in the Reader library. The backup will be saved in the PC library folder and it is not displayed on S-ID. S-ID also provides an automatic backup when you update AirStick to a new firmware version. Restore The Restore function allows to restore on the reader a backup previously created. 10

11 Update S-ID automatically notifies if a new update of AirStick firmware is available. Anyway, the Update function allows you to check if a new version of the firmware is available on the web, or to browse in your pc for the latest version of firmware already stored in a specific folder. About In this section you can verify the S-ID version and check Datamars website, (Figure 3-6). Figure

12 4. Reader Configurations The Reader Configuration can be set directly from the Reader library. Select the Configurations folder (Figure 4-1) and double-click the Configuration file (config.xml). Figure 4-1 The configuration window is displayed on the central window of S-ID (Figure 4-2). The following parameters can be edited and customized: 1. Reader name 2. Predefined alerts, Alert 1, Alert 2, Alert 3, Alert 4, Alert 5 3. Default VID 4. VID editable 5. VID=last EID digits 6. Automatic Shut Down Time [min] 7. Reading Timeout [s] 8. Screen timeout [s] 9. Runtime print enable 10. Print EID only 11. Keyboard layout 12

13 Figure 4-2 Just moving the mouse on the parameters name, a short description of them is shown in the Description bar down in the Configuration screen. Once the configuration is set, it is possible to Save it or Save as, naming the customized configuration and save it in the PC library. You can also create a copy dragging and dropping the configuration file under the PC library. This copy can be renamed, edited and changed, and it can be also used as a backup of the current configurations of your AirStick. Drag and drop the configuration file from the PC library to the Reader library to replace the current configurations with the latest one. Reader name Default value: None. The reader s name, if provided, will be part of the name of any session recorded by the reader; it will be shown on reader initial screen too, identifying such reader from others the user can have. Alerts Default value: ALERT1, ALERT2, ALERT3, ALERT4, ALERT5. These 5 items are available as quick selection when you want to add an alert to an EID read. You can customize default names as you need (e.g. Group1, Pregnant, Vaccinated ). The entered values will then be proposed as pre-defined Alerts on the reader. Default VID Default value: None 13

14 Enter a name/value in this field to show it as the one proposed by default on AirStick each time an EID is read. This VID can be anyway edited on the reader (Please refer to AirStick Reader - User Manual for more information). Selecting ON in the VID Editable field, it is possible to add the VID with the AirStick to an EID. VID Editable Default value: ON When you enter a VID linked to an EID read, you can edit this field on the reader only if this configuration is ON. To lock the VID once entered, turn this function off. In this case, you could edit the VID in the Masterfile on S-ID only. VID = last EID digits Default value: 0 Select a value from 1 to 12 to have the VID proposed on AirStick equal to the last digits (from 1 to 12) of the EID just read. Automatic shut-down time Default value: 5 minutes. The possible options are: 5 MIN 15 MIN 30 MIN NO TIMEOUT (Figure 4-3). An inactive reader will be turned off after this time if no buttons are pressed. This timeout applies to continuous readings too, meaning that the reader will continue reading until the shutdown time expires if no buttons are pressed and reading is not stopped. Figure 4-3 Reading time out Default value: 60 seconds. The Reading time out can be set for a minimum of 1 second, up to 255 seconds. In single reading mode the reader tries to detect an EID until the reading time out occurs. After that time, if no EID are detected, the reader will provide the message Not found. 14

15 Screen time out Default value: 60 seconds. The Screen time out can be set for a minimum of 1 second, up to 255 seconds. After this time the reader goes in low power mode (dimmed screen) if no button is pressed. Any button press will bring the reader in full power mode. Runtime print enable Default value: ON With the Runtime print enable function ON, every time AirStick detects an EID it can send data to a connected device. Be sure to have AirStick connected to the desired device either via USB or Bluetooth, using the proper profile (SPP or Keyboard wedge). If this configuration is OFF, single data will not be sent on the fly but it would be possible to send the full session data when needed (please refer to AirStick Reader - User Manual). Print EID only Default value: ON With the Print EID only function ON, only the EID will be sent to the connected device (both on the fly or when sending full session data). Turn this configuration OFF to send all the information related to the EID (i.e. VID and Alert) to the desired device. Keyboard layout There are two possible keyboard layouts: QWERTY and AZERTY. This function configures the layout of the keyboard emulated by the reader when: 1. Bluetooth is connected to an external device via Keyboard Wedge profile 2. USB is connected to an external device via Keyboard Wedge profile 15

16 5. Sessions A Reading Session is a.csv file where AirStick records data (Date and Time, EID, VID, Alert and Notes) each time an EID is detected. By default, a Reading Session it s named RS dd-mm-yy.csv, where the date is that at the session creation. An indefinite number of sessions can be created. Each session can contain a maximum of 4000 EIDs with all the related information. Sessions stored in AirStick are saved in the Sessions folder in the Reader library A Session folder is also available in the PC library. It is possible back up the sessions dragging and dropping them from the Reader library to the Session folder on the PC library. Once a session is opened on S-ID, both in the PC or Reader library, it is possible to review it and perform some operations. Session operations The following operations can be performed on a Session (Figure 5-1): 1. Open the session 2. Delete the session 3. Rename the session 4. Export the session Some of these operations (i.e. Delete, Export) are available by right-click the mouse and from the session toolbar Figure 5-1 Open and review a session To display the available sessions in the Reader library or PC library in the central window of S-ID: Double-click the Sessions folder (Figure 5-2, 1.A) or click on the + button on the left of the folder icon (Figure 5-2, - 1.B) 16

17 Double-click the desired session (Figure 5-2, 2) 1.B 1.A 2 Figure 5-2 Once the session is displayed on the central window (Figure 5-3), you can see: Figure all the recorded EIDs with their related information - the number of EIDs recorded - duplicates (highlighted in red) Data can be also sorted by alphanumeric and numeric order clicking on the title of the desired column. Delete session To delete the session from the current library you can select the Delete icon from the toolbar, or select Delete function from the right-click menu. Rename a session Select the session you want to rename and select Rename function from the right-click menu. Type the new session name and press OK. 17

18 Export a session A session can be exported to have some of the recorded data available in a specific format (Please refer to 5-3 paragraph) for a complete description of this functionality. Edit a session When a session is displayed in S-ID, the following functions are available on the toolbar of the session window (Figure 4-4): 1. Save and Save as 2. Remove an item 3. Search 4. Print 5. Delete duplicates Figure 5-4 Save and Save as You can save modified session or save it with a different name or in a different folder. Remove an item Place the cursor on the row containing the item you want to remove and select this function to delete the EID and related data. Search Select the Search icon and type the information you want to search. Select the up or down arrow to choose searching direction. S-ID will highlight the field where the information will be found. 18

19 Print It is possible to print the session s contents to a printer connected to your PC or as PDF file. Delete duplicates Select this functions to delete duplicate EIDs. The duplicates are highlighted in red in the list (Figure 5-5). S-ID will keep the last entry and will notify the number of items deleted. Figure 5-5 Export a session A session can be exported as (Figure 5-6): 1..csv file or.xlsx file 2. Masterfile Figure

20 Export a session as a.csv or.xlsx file 1. Select the session file By default, all session s items will be exported. To export specific EIDs only: - Click once on the desired items: these lines become blue and S-ID notifies the number of EID selected. - Click again on selected items to remove the selection. 2. Select Export function in the toolbar tab or from the right-click menu (Figure 5-7) Figure Choose Export to.csv or Export to XLSX option and select OK 4. A pop-up window will ask you to uncheck data you do not want to export, and sort items dragging and dropping each field. This allows you to have only data you need in the.csv or.xlsx file (Figure 5-8) Figure 5-7 Select OK and save the new.csv or.xlsx file in the Exports folder in the PC library. 20

21 Export a session as a Masterfile 1. Select the session file 2. Select Export function in the toolbar tab (or from the right-click menu) 3. Choose Export to Masterfile option and select OK 4. Select OK and save the new Masterfile in the Masterfile folder in the PC library 21

22 6. Masterfile What is a Masterfile A Masterfile is a database that associates EID to the corresponding data (VID, Alerts and Notes). This association allows to retrieve data related to an EID every time an EID is read, no matter the session where information is recorded. A Masterfile can be edited in S-ID only, and it can be populated both automatically on AirStick, when you add a VID and/or an Alert after the EID detection, and by S-ID. Only one Masterfile (named mst) is available in the Reader Library while you can save and rename several Masterfiles in the PC library. Create a Masterfile on S-ID A new Masterfile can be created and saved in the PC library on S-ID in 2 ways: 1. Importing data previously saved on your PC as.csv file or.xlsx file 2. Exporting a Session as a Masterfile (please refer to paragraph). Create a Masterfile importing a.csv or.xlsx file To import an existing.csv file: 1. Place the cursor on the Masterfile folder icon in the PC Library 2. Select Import Masterfile function in the toolbar tab (Figure 6-1) Figure Browse in your PC and select the.csv or.xlsx file containing data you want to import 4. Select Open (Figure 6-2) 22

23 Figure 6-2 To successfully import your Masterfile, the.csv file or.xlsx file must follow these requirements: It shall be organized in columns with a header It shall have at least one EID (mandatory data) and at least one additional information of VID, Alert and Notes (Figure 6-3) Figure 6-3 It shall use the same separator configured on S-ID It shall have EIDs expressed in the ISO format selected on SID The information shall be sorted as in the Master file columns (i.e. EID VID ALERT Note 1, Note 2, Note 3, Note 4, Note 5). S-ID will show: Allowed data in the right sequence (Masterfile columns) Data in the file you want to import (Imported file columns) Data in the imported file can be named in a different way. Corresponding information shall be in the right format and shall be sorted as required. In case the items are not sorted as needed (as show in the example in the Figure 6-4 the order is VID-ALERT-EID), drag and drop them according to the order of the Master file columns. 23

24 Figure 6-4 Once opened, the.csv file is displayed in S-ID (Figure 6-5). It is possible to save it as a Masterfile. Figure 6-5 The proposed folder is the Masterfile folder in the PC library. To import the Masterfile saved in the PC library to the Reader library, drag and drop it from the Masterfile folder in the PC library to the Masterfile folder in the reader library. Dragging and dropping the file, 2 possible options are available: - Merge files: The Masterfile imported from the PC library will be merged with the Masterfile currently available on the reader. This option is the first one proposed. If you accept it, S-ID will notify duplicates eventually detected and will add the new data to the already existing ones. - Overwrite files: The Masterfile imported from the PC library will be overwritten to the Masterfile currently available on the reader. This option will be available selecting NO at the question Do you want to merge Masterfile? 24

25 Masterfile operations The following operations can be performed on a Masterfile 1. Open the Masterfile 2. Delete the Masterfile 3. Rename the Masterfile Once the desired Masterfile is selected, some of these operations are reachable both by the right-click and from the Masterfile toolbar (i.e. Delete, Import). Open a Masterfile To display a Masterfile, double-click it or select Open function from the right-click menu. When the Masterfile is open, you can see in anytime the path to the folder where the file is saved displayed on the top of the window (Figure 6-6). Figure 6-6 The name of the columns containing the Notes can be edited in anytime, selecting the Rename column function from the right-click menu (Refer to the paragraph). 25

26 Delete the Masterfile This function allows to delete the Masterfile from the PC library. You can select the Delete icon from the toolbar or, alternatively, you can select Delete function from the right-click menu (Figure 6-7). Rename the Masterfile Select the Masterfile you want to rename and select Rename function from the right-click menu. Type the new Masterfile name and press OK. Figure 6-7 Edit a Masterfile Information included in the Masterfile except for EIDs can be edited and modified. To do this, double click in the cell you want to update and type the new data. The following functions are available on a Masterfile:

27 1. Add an EID and related data 2. Remove an EID 3. Save and Save as 4. Search 5. Print Save and Save as You can simply save a modified Masterfile or save it with a different name or in a different folder. The proposed folder to save a Masterfile is the Masterfile folder in the PC library. Add an EID To add an EID and its related information (Figure 6-8): 1. Select the Add row icon in the toolbar tab 2. Type the EID 1 2 Figure 6-8 Once entered the EID, it is possible to add related data (VID, Alert, Notes) double-clicking in the corresponding field and typing the desired information. 27

28 Remove an EID Place the cursor on the row containing the item you want to remove and select the Remove function to delete the EID and its related data. Search Select the Search icon and type the information you want to search. Select the up or down arrow to choose searching direction. S-ID will highlight the field where the information will be found. Print It is possible to print the contents of the Masterfile from your pc with a printer connected to it or as PDF file. Rename Notes It is possible to customize the notes name. Select the note title and select the Rename column function from the right-click menu (Figure 6-9). Figure

29 7. Create a Search input file A Search input file is a list of EIDs you want to search while reading (please refer to AirStick Reader - User Manual for more information) While this file input can be a reading session previously recorded on AirStick, S-ID allows you to create file adding or importing EIDs you need. A search input file is named as SearchEID/VID/Alert_date_time and has the same structure of a Reading Session. To create a new search input file (Figure 7-1): 1. Click on the Search Input folder in the PC library 2. Select New Search Input function from the toolbar A new empty search input file is displayed on the central window of S-ID (3) Figure 7-1 Add EIDs to the Search input file Once a new search input file is created, there are 2 possible ways to add EIDs to this file: 1. Enter EIDs manually 2. Importing EIDs from a Reading Session already available in the PC or in the Reader library. To add EID manually one per time (Figure 7-2): 1. Select Add Row icon 29

30 2. Type EIDs you want to search in the Add row window and press OK 1 2 Figure 7-2 To import EIDs from a Reading Session the steps below shall be followed: 1. Select the Reading Session containing EIDs you want to search (they can be items matching a specific condition, e.g. Alert1) 2. Minimize windows to display New Search Input file near the selected Reading Session 3. Select items you want to search clicking once on them (lines will become blue) 4. Drag and drop the selected items from the Reading Session to the Search Input file (Figure 7-3) Save a Search input file Figure 7-3 The New Search Input file is saved in the Search_Inputs folder in the PC library. Please, note that saving the New Search Input file directly on the reader is not permitted. To import the Search Input file into the reader, drag it from the Search_Inputs folder in the PC library and drop it in the Search_Inputs folder in the Reader library. 30

31 8. EID, VID and Alert searches When you run a search of a list of EIDs, or of a specific VID or Alert on AirStick (please refer to AirStick Reader - User Manual for more information), the output of this search is saved in a file available in S-ID only, under eid_searches folder, vid_searches folder or alr_searches folder respectively. Each Search file output is named Search EID/VID/Alert_Date_Time, where date and time are those of the search done on AirStick (Figure 8-1). The search output file contains the list of all items searched, with the indication if they have been found (highlighted in red) or not- (Figure 8-2). Figure 8-1 Figure