Adding Peripherals to DCS

Transcription

1 Adding Peripherals to DCS Data Collection Station Application Big Fin Scientific 1.0 4/20/2015 Initial Release 1.1 1/29/2016 Added Peripheral Troubleshooting Section 1.2 2/4/2016 Added Caliper Support Section /18/2016 Added in SATO Label Printer Section /09/2017 Updated Caliper Support Section with note on how to connect if running android /10/2017 Name Change from DFS to DCS /09/2017 Added in section on different jumper settings for RN-270M /21/2017 Added in Examples for HPR Plus and Biomark 601 Readers /22/2017 Added additional settings info for the HPR plus /23/2017 Added Graphic for HPR Output format in Device Settings /10/2017 Added Additional Info Covering BluePort XP Configurations For help, write to: or call FIN (0346)

2 Table of Contents INTRODUCTION... 3 BACKGROUND... 3 SERIAL SETTINGS... 3 BLUETOOTH SERIAL ADAPTERS... 3 BLUETOOTH ADAPTER DESCRIPTION... 4 CONFIGURING THE ADAPTER... 5 TURNING ON THE ADAPTER... 8 STATUS: SEEKING CONNECTION... 8 STATUS: CONNECTED... 8 CONNECTING A SCALE, PIT-TAG READER OR OTHER PERIPHERAL TO DCS... 9 CONNECTING AND USING A LABEL PRINTER USING YOUR PERIPHERALS IN DCS MEASUREMENT VIEW METHODOLOGY TROUBLESHOOTING CONNECTING THE BIOMARK 601 PIT TAG READER QUESTIONS AND COMMENTS For help, write to: support@bigfinscientific.com or call FIN (0346) Page 2

3 Introduction This document will explain the procedures necessary to add peripherals (scales, PIT-tag readers, etc) to the Data Collection Station Application. For instructions on the use of the Application in general, download the User Manual: DCS from Background Peripherals which transmit and/or receive serial data can be connected to the Data Collection Station Application. Examples of serial data protocols are: RS-232, RS-485, USB and Bluetooth Wireless, among others. The primary method by which to make the signal connection to the Data Collection Station application is via Bluetooth, since this method requires the least amount of additional hardware (sometimes none). The other available method is via USB, in-conjunction with the Big Fin I/O Hub and possibly RS-232-to-USB adapters, depending on your hardware. This document will cover how to connect to your devices using Bluetooth, or BT for short. If your serial peripherals (a scale, for example) does not have BT built-in, we ll use a USB or RS-232-to-Bluetooth adapter. Serial Settings For the DCS application, you ll need to use the following serial settings (which are set on each of your peripheral devices): Data bits: 8 Parity: None Stop bits: 1 (one) Flow control: none Bits per second: 9600 Bluetooth Serial Adapters In this document, we ll assume you have a scale which does *not* have Bluetooth built-in. In order to BT-enable your scale, we ll use a Bluetooth dongle or adapter which makes the translation from RS-232 (wired serial) and BT (wireless serial). It translates in both directions. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 3

4 Bluetooth Adapter Description We use the following adapter: Microchip RN-270M (previously Roving Networks, now Microchip). Technical information on this adapter can be found here: We chose this adapter chip because it can be powered either by DC adapter or by batteries, allowing for unplugged operation. The picture above shows the Firefly style of this adapter. There is also a BluePortXP style adapter that is shown in the picture below. Both adapters use the same internal Bluetooth chip. However, the jumpers are configured slightly differently which will be shown in the Configuring the Adapter section of this document below. WARNING: Do not use a DC power adapter with the module at the same time as using Alkaline batteries. Use only NiCad batteries in conjunction with a DC power adapter. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 4

5 Configuring the Adapter There are some dip-switches and some jumpers on the unit which you must set properly. If the unit comes from us, these switches and jumpers will already be set for you. Top dipswitch settings. Switch 4 is set to on. FireFly Dipswitch Configuration BluePortXP Dipswitch Configuration For help, write to: support@bigfinscientific.com or call FIN (0346) Page 5

6 Internal jumper settings. Position the jumpers as shown. FireFly Jumper Configuration BluePortXP Jumper Configuration The jumpers are accessed in the same fashion as accessing the batteries. On the Firefly devices, carefully remove the bottom cover and the jumpers will be accessible. On the BluePortXP devices, remove both Philips head screws on the back of the device with a small screwdriver and then carefully remove the back cover of the device. You may need some small pliers or screwdriver to remove the jumpers. Note: This is the default Female DB9 jumper setting that will most likely work with your peripherals. However, it is possible that you need to try an alternate jumper setting named Male DB9 described on the next page. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 6

7 The Male and Female DB9 connectors have different pin-outs. This can be seen in the diagram below. Since the Male and Female DB9 s pin-outs differ, it is possible that you need to try a different jumper setting if you are not getting any data out of your Firefly device. The jumper settings that we use are shown below. The one on the right (Female DB9) is the default setting. However, if this does not work, try using the Male DB9 configuration shown on the left. An orange LED on the RN-270M will flash when data is seen coming across the RS232 port. Firefly Jumper Configuration Diagrams For help, write to: support@bigfinscientific.com or call FIN (0346) Page 7

8 BluePortXP Jumper Configuration Diagrams If you are still not getting any data out of your device after trying both of these settings on the respective device. Contact for additional troubleshooting. Turning on the Adapter The adapter is turned on and off via the red button on the top of the unit on the Firefly devices. To turn the unit on, hold the red button until you start to see the LEDs start flashing (green and blue alternating), then release the button. Holding it further will cause the unit to go into a special mode, so release the button as soon as you see the lights. To turn the unit off, hold the button down until the lights flash and then turn off. For the BluePortXP devices, there is an ON/OFF switch located on the side of the unit that switches the unit on and off. Status: Seeking Connection After power-on, the unit will be in ready to connect mode. A green LED will blink, twice per second for about 15 seconds, then once-per-second for about 3 minutes. The twice-per-second is a special mode which is not used and which automatically turns off after the 15 seconds. If the unit does not create a connection within 3 minutes, it shuts itself off. The ability to connect is the same during both the twice-per-second and once-per-second period; you can treat them as the same status. Status: Connected When the unit has created a connection with another BT device (explained below), the green LED on the adapter lights solid (no blinking). If the adapter loses the connection, it will revert to blinking and seeking a connection for 3 minutes before shutting itself off. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 8

9 Connecting a Scale, PIT-Tag Reader or other Peripheral to DCS Currently supported peripherals are scales and PIT-tag readers, but more peripherals will be supported soon (GPS antennae, salinity readers, for example). Any peripheral with a serial output can be connected to the DCS application. We ll use a scale as our example peripheral, but the same connection methodology applies to the other peripheral types. In order for DCS to understand what your scale is sending (and to be able to send commands to your scale), DCS will need to know which scale you re using and need the command-set for that scale. Luckily, this is easy, after the first time. If you don t see your scale type on the selection list, please write us with a description of your scale and we ll add that scale command-set (or driver ) to the application, so the next time you update your DCS application, you ll see your scale in the list. The driver for your scale is independent of Bluetooth or other method of scale communication connection. Bluetooth / USB or other connection protocol is like establishing a phone line with your device, whereas the driver is akin to the language used when speaking over the phone line. Straight- Through Serial Cable A serial cable is not required, but allows the BT adapter to be located someplace removed from the scale. Often times, scales are exposed to the elements, in which case the BT adapter should be linked via a cable and located For help, write to: support@bigfinscientific.com or call FIN (0346) Page 9

10 away from the action, as the adapters are not waterproof. Wrapping a ziplock bag around the BT adapter and taping it or zip-tying it to a secure location is a typical approach. If you have a hardware configuration which does not allow for this type of approach, please contact us for help. We ll be able to advise you as to which adapters or cable combinations to consider. Note: Set your scale communication mode to print, wherein weight data is sent on-command. Other options, like continuous where weight data is sent continuously, will not work. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 10

11 Making the BT Connection in DCS Now that you have the hardware configured, here s how you connect your peripheral in the DCS application: Go to the General Settings Basic area of the application. Click on Select Scale A selection list of available scale types will appear. If yours is not on this list, please write to: support@bigfinscientific.com and include your make/model of scale. You ll then be presented with a list of available BT devices, similar to this: For help, write to: support@bigfinscientific.com or call FIN (0346) Page 11

12 The BT adapters we re using are called FireFly and BluePortXP devices. In this example, you would select the FireFlyBP device. If you have more than one FireFly, you can determine which FireFly is which using the 4-digit code to the right of the Hyphen in the BT name, shown above in this example as: 7FD9. That code will also be on a sticker on the side of the adapter, shown below. The code for the BluePortXP devices can be found on the barcode sticker on the top of the device. If this is the first time you ve attempted connection with the FireFly device, you will probably receive a message similar to this: Click on Pair. If the application asks for a pairing code, enter After the connection is completed, you ll see the device name under Select Scale. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 12

13 Repeat this process for other peripherals, such as a PIT-tag reader. In this example, our PIT-tag reader has BT built-in and is the Biomark HPR Plus reader. On the HPR Reader, change your settings to the following by going to the Device Settings: Note: The Tag Format can be put in HEX or DEC mode. Be sure to enable Bluetooth and set Tag Record Format to Tag Only. Also, remember to set the Baudrate to For help, write to: support@bigfinscientific.com or call FIN (0346) Page 13

14 Select Connect PIT-tag reader from the DCS General Settings menu. Select your device from the list. If your device is not available, please contact us (see above for contact info.) Now in order to make reads press on the READ button on the HPR Plus to activate continuous reading mode. For help, write to: or call FIN (0346) Page 14

15 Repeat a similar process to connect Bluetooth compatible calipers to the DCS Android application. Note: The following example uses calipers with built-in Bluetooth technology. If you are interested in purchasing these calipers, you can find them at the following link: Caliper pairing is only supported on Android OS 5.0 or higher. You can check the OS your tablet is running by navigating to About Device in the General Settings on your tablet Make sure your calipers are able to be found by turning on the Bluetooth signal. In this example, Bluetooth is turned on by pressing MODE several times to bring up the screen that says bt which stands for Bluetooth. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 15

16 For this particular set of calipers, Bluetooth is turned on by pressing SET while in this bt screen to navigate to the On/Off signal switch. A symbol for Bluetooth should appear on the Caliper screen to indicate that the Bluetooth signal is turned on. Typically, the symbol blinks when the device has the Bluetooth signal on but not paired and the symbol stays solid when there is a successful pairing. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 16

17 Select Connect Calipers from the DCS General Settings menu if you are running android 6.0 or higher. Note: If you are running Android OS 5.0, then you must first reset the Bluetooth on the calipers and then connect to them through the Tablet Bluetooth settings. The calipers will not work on Android OS 5.0 if they are just connected through the DCS General Settings. They must be paired/connected through the Tablet Settings first before connecting to the calipers through the DCS General Settings. Select your device from the list. If your device is not available, please contact us (see above for contact info.) Important Note Regarding Calipers: Caliper pairing ONLY works on Android OS 5.0 or higher. You can see what OS your tablet is running by navigating to your tablet s Settings -> About Device. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 17

18 Connecting and Using a Label Printer Another type of peripheral that can be connected to the Android application is a Bluetooth enabled printer. The process for connecting the printer is similar to the other peripherals. However, there is an additional step that the user must take to set up the label formatting. This printer is the SATO MB200i Bluetooth model. If you are using a SATO printer similar to this one, you may need to set initial printer settings to format for the correct label size, contrast, and off-set settings. This can be done by using the SATO All-In-One Tool which can be found at the following link: In order to connect the Bluetooth Label Printer, navigate to Application Settings in the Android application and find the option for Select SATO BT Printer For help, write to: support@bigfinscientific.com or call FIN (0346) Page 18

19 Once you have established a connection to the printer, open a study that you want to use the printer in by selecting the study from the Study List page. Now, create two fields named Sample ID and Sample Type in the measurement view of the study. These fields are NOT case-sensitive; however, they do need to contain those exact names for correct printer functionality. These two fields will be printed on each label along with a QR code containing the record information and are shown in the picture above. The Sample Type contains a custom value that the user can use for each record throughout the study. The Sample ID field will print out a generated unique alpha-numeric value that can be used as a record identifier. This field cannot be filled out with a custom value. The printer is currently configured to print out a new label for every specimen recorded. The picture above shows a printed example of one of the labels. Sample ID is located on the top line of the label, followed by the Study Name, Record Timestamp, and then finally the customizable Sample Type field. The printer is set to print on 1 x 2 labels. The QR code located on the left side of the label can be read with any QR reader and contains the information shown on the label. Using your Peripherals in DCS Measurement View For help, write to: support@bigfinscientific.com or call FIN (0346) Page 19

20 Now that you have your peripherals attached, here s how to use them during fish-data capture: Methodology During data-taking, in the Measurement View, you can take data from your peripheral via two general methods. We ll use a scale for our example. 1) Pushing data from scale (clicking print on many scales causes the weight data to be sent out the serial port.) This is useful if a person is operating the scale and wishes to control when the weight data is sent. 2) Pulling data from the scale (the DCS application will send a command to the scale, asking for the weight data and the scale responds). This is useful for remote operations of the scale, such that the fish-board operator can take scale data without an additional person or interacting w/ the scale. The DCS application is waiting on the communication channel which has been established with the scale, such that any push of data from the scale will be received and entered into the weight field of your current record. Subsequent pushes will erase that data and replace it with the new, without the need for deletion of the field value. In this example, the fish is placed on a scale and allowed to settle. The fish is shown below after having been moved to the fish-board for length-measurement. The order of operations is flexible. Zooming in on the DCS Measurement View, we see the weight value has been populated to the Weight field. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 20

21 Note that the PIT tag number had already been scanned. This was accomplished by waving the antenna wand over the fish containing the PIT tag. As with the scale, the DCS application is waiting on the communication channel which has been established with the Tag reader, looking for anything which looks like a tag number to come across. Once received, the tag number is populated to the Tag field of the current record. If the tag number is the last field required to finalize the fish record, the record is stored and a new record is started. If not, any further tag numbers received will overwrite the tag field value automatically. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 21

22 Troubleshooting Tablet won t connect to Peripheral Devices. 1.) Navigate to the Settings Application on your tablet. 2.) Tap on Bluetooth Tab to get into Bluetooth menu and then tap the On/Off button to toggle Bluetooth off and then back on for the tablet (this helps reset device pairing). Note: If your Bluetooth switch is stuck in the Off position and will not switch to On position when you click on it, then you need to Power your Tablet Off and back On then navigate back to your Bluetooth Settings in the Settings Application. This switch tends to get stuck on Logic Fieldbook Tablets. 3.) Once you have toggled your Bluetooth switch back to the On position, look for your Bluetooth peripheral (dongle) device under the Available Devices section of the page. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 22

23 Note: If you do not see your device, turn your Bluetooth device (dongle) off and back on by holding the red button located on the dongle for a few seconds. The dongle s LED light should begin blinking to indicate that it is ready to be paired with. If the device does not appear under Available Devices at this point, tap Search for Devices to look for the device. 4.) Tap on the Device under Available Devices to Pair it with your tablet once you have found the device. 5.) The following window should appear if this is the first time you have successfully paired your tablet with the Bluetooth device. The PIN for our Bluetooth devices is 1234 or Try 1234 first to pair with the device. Press OK after you have typed in the PIN and the device should pair successfully with the tablet For help, write to: support@bigfinscientific.com or call FIN (0346) Page 23

24 6.) After pairing with the device in your Settings Application, navigate back to the Big Fin Scientific Application. For help, write to: or call FIN (0346) Page 24

25 7.) Tap on the menu button in the top left corner of the application to show the drop-down menu. 8.) In the drop-down menu tap on Application Settings. For help, write to: or call FIN (0346) Page 25

26 9.) In the Application Settings under the Basic section, click on the type of device that your Bluetooth dongle is attached to. In this example, the type of device is a Scale. 10.) Allow the Big Fin Scientific Application some time to find your Bluetooth Device and then tap on the Bluetooth Device in the dialogue window. Note: If the Big Fin Scientific Application does not find your Bluetooth device after seconds, tap Cancel in the dialogue box and then toggle the Bluetooth Peripheral Device off and back on to reset it. After toggling the Bluetooth Peripheral Device back on, click on the type of device you are connecting to in the Basic section in the Application Settings again to begin searching for the Bluetooth signal again. If it still doesn t find the device, make sure your Bluetooth is turned on in your Settings Application on the Tablet. If you are having trouble turning Bluetooth on using the toggle button on your Tablet, reset the tablet. (Refer to Step 2 Note) For help, write to: support@bigfinscientific.com or call FIN (0346) Page 26

27 11.) A dialogue window will open which will tell you recommended Baud rate among other specifications. Press OK on this window. You are now successfully connected to the Bluetooth device and can make counts with it. Note: If you are still unable to connect to a certain Bluetooth peripheral device. Make sure to reset the tablet and repeat these troubleshooting steps again. If you reset your tablet and go through these steps again are still unable to connect to your Bluetooth device, please contact support@bigfinscientific.com Connecting the Biomark 601 Pit Tag Reader For help, write to: support@bigfinscientific.com or call FIN (0346) Page 27

28 The configuration you will use will be the male or female DB9 (default configurations) on the Firefly device (See page 6). There are settings on the Biomark 601 reader as well which can be accessed by tapping on the 'Menu' button on the reader. Keep pressing 'Menu' until you get to "RS-232 Settings." From here, press the DOWN arrow and make sure to change the settings on the reader to BR = 9600 bd, Databits = 8 bits, Parity = None, Flow Control = Off. Try both the Male and Female DB9 configuration on the Firefly Bluetooth converter and see which jumper setting gives you an orange LED when a Pit Tag is scanned. You can also connect Tag reader up to Bluetooth terminal and scan tags to make sure you are getting tag data out of it. There are a lot of different formats you can give the Biomark 601 reader to output tags. We need to make sure your settings will match with the settings within the Big Fin Scientific Application. For help, write to: support@bigfinscientific.com or call FIN (0346) Page 28

29 Press 'Menu' on Biomark 601 Pit Tag reader until you get to Mid-Code Format and then press the DOWN arrow. In the Mid-Code Format section change your settings to the following: # Format = Hex or Dec* (Either Should be Supported) City Code = Alpha Lead 0's = No Duplicts = Yes (Shouldn't matter, if you don't want to be able to grab the same tag value twice then set to NO) Delimitr =. (dot) DB Flag = Off TimeDate = OFF RSRV FLD = OFF C/M Code = ON 1st Char= None Tag Type = None Once these are set, connect to your Pit Tag reader through Application Settings in the DCS application. Select the Biomark HPR when you connect. Now the reader should work. Questions and Comments With so many hardware configurations available, it s impossible to cover all the possibilities. If the examples contained in this document are insufficient for your system setup, please contact us for help at the number or address below. Thank you for being a Big Fin Scientific customer! support@bigfinscientific.com or (8080-FIN). For help, write to: support@bigfinscientific.com or call FIN (0346) Page 29